blob: 834a1cfa2f9413ba17afc06cefd2030479fd94cc [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
Chris Lattner4bd55962008-03-30 23:03:07 +000017#include "clang/AST/Type.h"
Argyrios Kyrtzidis07052352008-09-10 02:36:38 +000018#include "clang/AST/ExprCXX.h"
Ted Kremenek08e17112008-06-17 02:43:46 +000019#include "clang/AST/ExprObjC.h"
Ken Dyck40775002010-01-11 17:06:35 +000020#include "clang/AST/CharUnits.h"
Peter Collingbourne0ff0b372011-01-13 18:57:25 +000021#include "clang/Basic/ABI.h"
Chris Lattner2739d2b2009-03-31 22:17:44 +000022#include "clang/Basic/TargetInfo.h"
23#include "llvm/ADT/DenseMap.h"
24#include "llvm/ADT/SmallVector.h"
25#include "llvm/Support/ValueHandle.h"
Owen Andersonae86c192009-07-13 04:10:07 +000026#include "CodeGenModule.h"
Mike Stumpedb252a2009-03-04 15:32:52 +000027#include "CGBlocks.h"
Daniel Dunbarcb463852008-11-01 01:53:16 +000028#include "CGBuilder.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000029#include "CGCall.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000030#include "CGValue.h"
31
Chris Lattnerbed31442007-05-28 01:07:47 +000032namespace llvm {
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000033 class BasicBlock;
Benjamin Kramer9cd050a2009-08-11 17:46:57 +000034 class LLVMContext;
David Chisnall9eecafa2010-05-01 11:15:56 +000035 class MDNode;
Chris Lattnerbed31442007-05-28 01:07:47 +000036 class Module;
Daniel Dunbar2efd5382008-09-30 01:06:03 +000037 class SwitchInst;
Daniel Dunbarb5aacc22009-10-19 01:21:05 +000038 class Twine;
Daniel Dunbar9b1335e2008-11-19 09:36:46 +000039 class Value;
John McCallbd309292010-07-06 01:34:17 +000040 class CallSite;
Chris Lattner23b7eb62007-06-15 23:05:46 +000041}
42
Chris Lattnerbed31442007-05-28 01:07:47 +000043namespace clang {
Devang Patele03edfd2010-08-10 07:24:25 +000044 class APValue;
Chris Lattnerbed31442007-05-28 01:07:47 +000045 class ASTContext;
Anders Carlsson0a637412009-05-29 21:03:38 +000046 class CXXDestructorDecl;
Anders Carlsson52d78a52009-09-27 18:58:34 +000047 class CXXTryStmt;
Chris Lattner84915fa2007-06-02 04:16:21 +000048 class Decl;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000049 class EnumConstantDecl;
Chris Lattnerbed31442007-05-28 01:07:47 +000050 class FunctionDecl;
Douglas Gregordeaad8c2009-02-26 23:50:07 +000051 class FunctionProtoType;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000052 class LabelStmt;
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +000053 class ObjCContainerDecl;
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +000054 class ObjCInterfaceDecl;
55 class ObjCIvarDecl;
Chris Lattner4bd55962008-03-30 23:03:07 +000056 class ObjCMethodDecl;
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +000057 class ObjCImplementationDecl;
Daniel Dunbar89654ee2008-08-26 08:29:31 +000058 class ObjCPropertyImplDecl;
Chris Lattner2ccb73b2007-06-16 00:16:26 +000059 class TargetInfo;
John McCalld4f4b7f2010-03-03 04:15:11 +000060 class TargetCodeGenInfo;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000061 class VarDecl;
Chris Lattnerf0b64d72009-04-26 01:32:48 +000062 class ObjCForCollectionStmt;
63 class ObjCAtTryStmt;
64 class ObjCAtThrowStmt;
65 class ObjCAtSynchronizedStmt;
Devang Patel3e11cce2007-10-23 02:10:49 +000066
Chris Lattnerbed31442007-05-28 01:07:47 +000067namespace CodeGen {
Devang Patel3e11cce2007-10-23 02:10:49 +000068 class CodeGenTypes;
Anders Carlsson63784f42009-02-13 08:11:52 +000069 class CGDebugInfo;
Daniel Dunbar7633cbf2009-02-02 21:43:58 +000070 class CGFunctionInfo;
Mike Stumpfc496822009-02-08 23:14:22 +000071 class CGRecordLayout;
John McCall9d42f0f2010-05-21 04:11:14 +000072 class CGBlockInfo;
John McCall5d865c322010-08-31 07:33:07 +000073 class CGCXXABI;
Mike Stumpfc496822009-02-08 23:14:22 +000074
John McCallbd309292010-07-06 01:34:17 +000075/// A branch fixup. These are required when emitting a goto to a
76/// label which hasn't been emitted yet. The goto is optimistically
77/// emitted as a branch to the basic block for the label, and (if it
78/// occurs in a scope with non-trivial cleanups) a fixup is added to
79/// the innermost cleanup. When a (normal) cleanup is popped, any
80/// unresolved fixups in that scope are threaded through the cleanup.
81struct BranchFixup {
John McCallad5d61e2010-07-23 21:56:41 +000082 /// The block containing the terminator which needs to be modified
83 /// into a switch if this fixup is resolved into the current scope.
84 /// If null, LatestBranch points directly to the destination.
85 llvm::BasicBlock *OptimisticBranchBlock;
John McCallbd309292010-07-06 01:34:17 +000086
John McCallad5d61e2010-07-23 21:56:41 +000087 /// The ultimate destination of the branch.
John McCallbd309292010-07-06 01:34:17 +000088 ///
89 /// This can be set to null to indicate that this fixup was
90 /// successfully resolved.
91 llvm::BasicBlock *Destination;
92
John McCallad5d61e2010-07-23 21:56:41 +000093 /// The destination index value.
94 unsigned DestinationIndex;
95
96 /// The initial branch of the fixup.
97 llvm::BranchInst *InitialBranch;
John McCallbd309292010-07-06 01:34:17 +000098};
99
John McCallce1de612011-01-26 04:00:11 +0000100/// A metaprogramming class which decides whether a type is a subclass
101/// of llvm::Value that needs to be saved if it's used in a
102/// conditional cleanup.
103template
104 <class T,
105 bool mustSave =
106 llvm::is_base_of<llvm::Value, llvm::remove_pointer<T> >::value
107 && !llvm::is_base_of<llvm::Constant, llvm::remove_pointer<T> >::value
108 && !llvm::is_base_of<llvm::BasicBlock, llvm::remove_pointer<T> >::value>
109struct SavedValueInCond {
110 typedef T type;
111 typedef T saved_type;
112 static bool needsSaving(type value) { return false; }
113 static saved_type save(CodeGenFunction &CGF, type value) { return value; }
114 static type restore(CodeGenFunction &CGF, saved_type value) { return value; }
115};
116// Partial specialization for true arguments at end of file.
117
John McCall612942d2010-08-13 21:20:51 +0000118enum CleanupKind {
119 EHCleanup = 0x1,
120 NormalCleanup = 0x2,
121 NormalAndEHCleanup = EHCleanup | NormalCleanup,
122
123 InactiveCleanup = 0x4,
124 InactiveEHCleanup = EHCleanup | InactiveCleanup,
125 InactiveNormalCleanup = NormalCleanup | InactiveCleanup,
126 InactiveNormalAndEHCleanup = NormalAndEHCleanup | InactiveCleanup
127};
John McCall2b7fc382010-07-13 20:32:21 +0000128
John McCallbd309292010-07-06 01:34:17 +0000129/// A stack of scopes which respond to exceptions, including cleanups
130/// and catch blocks.
131class EHScopeStack {
132public:
133 /// A saved depth on the scope stack. This is necessary because
134 /// pushing scopes onto the stack invalidates iterators.
135 class stable_iterator {
136 friend class EHScopeStack;
137
138 /// Offset from StartOfData to EndOfBuffer.
139 ptrdiff_t Size;
140
141 stable_iterator(ptrdiff_t Size) : Size(Size) {}
142
143 public:
144 static stable_iterator invalid() { return stable_iterator(-1); }
145 stable_iterator() : Size(-1) {}
146
147 bool isValid() const { return Size >= 0; }
148
John McCall324277852010-08-14 07:46:19 +0000149 /// Returns true if this scope encloses I.
150 /// Returns false if I is invalid.
151 /// This scope must be valid.
John McCallad5d61e2010-07-23 21:56:41 +0000152 bool encloses(stable_iterator I) const { return Size <= I.Size; }
John McCall324277852010-08-14 07:46:19 +0000153
154 /// Returns true if this scope strictly encloses I: that is,
155 /// if it encloses I and is not I.
156 /// Returns false is I is invalid.
157 /// This scope must be valid.
John McCallad5d61e2010-07-23 21:56:41 +0000158 bool strictlyEncloses(stable_iterator I) const { return Size < I.Size; }
John McCall8f510412010-07-21 00:40:03 +0000159
John McCallbd309292010-07-06 01:34:17 +0000160 friend bool operator==(stable_iterator A, stable_iterator B) {
161 return A.Size == B.Size;
162 }
163 friend bool operator!=(stable_iterator A, stable_iterator B) {
164 return A.Size != B.Size;
165 }
166 };
167
John McCallcda666c2010-07-21 07:22:38 +0000168 /// Information for lazily generating a cleanup. Subclasses must be
169 /// POD-like: cleanups will not be destructed, and they will be
170 /// allocated on the cleanup stack and freely copied and moved
171 /// around.
John McCall2b7fc382010-07-13 20:32:21 +0000172 ///
John McCallcda666c2010-07-21 07:22:38 +0000173 /// Cleanup implementations should generally be declared in an
John McCall2b7fc382010-07-13 20:32:21 +0000174 /// anonymous namespace.
John McCallcda666c2010-07-21 07:22:38 +0000175 class Cleanup {
John McCall2b7fc382010-07-13 20:32:21 +0000176 public:
John McCall11e577b2010-07-13 23:19:49 +0000177 // Anchor the construction vtable. We use the destructor because
178 // gcc gives an obnoxious warning if there are virtual methods
179 // with an accessible non-virtual destructor. Unfortunately,
180 // declaring this destructor makes it non-trivial, but there
181 // doesn't seem to be any other way around this warning.
182 //
183 // This destructor will never be called.
John McCallcda666c2010-07-21 07:22:38 +0000184 virtual ~Cleanup();
John McCall11e577b2010-07-13 23:19:49 +0000185
John McCall2b7fc382010-07-13 20:32:21 +0000186 /// Emit the cleanup. For normal cleanups, this is run in the
187 /// same EH context as when the cleanup was pushed, i.e. the
188 /// immediately-enclosing context of the cleanup scope. For
189 /// EH cleanups, this is run in a terminate context.
190 ///
191 // \param IsForEHCleanup true if this is for an EH cleanup, false
192 /// if for a normal cleanup.
193 virtual void Emit(CodeGenFunction &CGF, bool IsForEHCleanup) = 0;
194 };
195
John McCallce1de612011-01-26 04:00:11 +0000196 /// A helper class for cleanups that execute conditionally.
197 class ConditionalCleanup : public Cleanup {
198 /// Either an i1 which directly indicates whether the cleanup
199 /// should be run or an i1* from which that should be loaded.
200 llvm::Value *cond;
201
202 public:
203 virtual void Emit(CodeGenFunction &CGF, bool IsForEHCleanup);
204
205 protected:
206 ConditionalCleanup(llvm::Value *cond) : cond(cond) {}
207
208 /// Emit the non-conditional code for the cleanup.
209 virtual void EmitImpl(CodeGenFunction &CGF, bool IsForEHCleanup) = 0;
210 };
211
212 /// UnconditionalCleanupN stores its N parameters and just passes
213 /// them to the real cleanup function.
214 template <class T, class A0, class A1>
215 class UnconditionalCleanup2 : public Cleanup {
216 A0 a0; A1 a1;
John McCallf256eb52011-01-26 19:15:39 +0000217 public:
John McCallce1de612011-01-26 04:00:11 +0000218 UnconditionalCleanup2(A0 a0, A1 a1) : a0(a0), a1(a1) {}
219 void Emit(CodeGenFunction &CGF, bool IsForEHCleanup) {
220 T::Emit(CGF, IsForEHCleanup, a0, a1);
221 }
222 };
223
224 /// ConditionalCleanupN stores the saved form of its N parameters,
225 /// then restores them and performs the cleanup.
226 template <class T, class A0, class A1>
227 class ConditionalCleanup2 : public ConditionalCleanup {
228 typedef typename SavedValueInCond<A0>::saved_type A0_saved;
229 typedef typename SavedValueInCond<A1>::saved_type A1_saved;
John McCallf256eb52011-01-26 19:15:39 +0000230 A0_saved a0_saved;
231 A1_saved a1_saved;
John McCallce1de612011-01-26 04:00:11 +0000232
233 void EmitImpl(CodeGenFunction &CGF, bool IsForEHCleanup) {
John McCallf256eb52011-01-26 19:15:39 +0000234 A0 a0 = SavedValueInCond<A0>::restore(CGF, a0_saved);
235 A1 a1 = SavedValueInCond<A1>::restore(CGF, a1_saved);
John McCallce1de612011-01-26 04:00:11 +0000236 T::Emit(CGF, IsForEHCleanup, a0, a1);
237 }
238
239 public:
240 ConditionalCleanup2(llvm::Value *cond, A0_saved a0, A1_saved a1)
John McCallf256eb52011-01-26 19:15:39 +0000241 : ConditionalCleanup(cond), a0_saved(a0), a1_saved(a1) {}
John McCallce1de612011-01-26 04:00:11 +0000242 };
243
John McCallbd309292010-07-06 01:34:17 +0000244private:
245 // The implementation for this class is in CGException.h and
246 // CGException.cpp; the definition is here because it's used as a
247 // member of CodeGenFunction.
248
249 /// The start of the scope-stack buffer, i.e. the allocated pointer
250 /// for the buffer. All of these pointers are either simultaneously
251 /// null or simultaneously valid.
252 char *StartOfBuffer;
253
254 /// The end of the buffer.
255 char *EndOfBuffer;
256
257 /// The first valid entry in the buffer.
258 char *StartOfData;
259
260 /// The innermost normal cleanup on the stack.
261 stable_iterator InnermostNormalCleanup;
262
263 /// The innermost EH cleanup on the stack.
264 stable_iterator InnermostEHCleanup;
265
266 /// The number of catches on the stack.
267 unsigned CatchDepth;
268
John McCallad5d61e2010-07-23 21:56:41 +0000269 /// The current EH destination index. Reset to FirstCatchIndex
270 /// whenever the last EH cleanup is popped.
271 unsigned NextEHDestIndex;
272 enum { FirstEHDestIndex = 1 };
273
John McCallbd309292010-07-06 01:34:17 +0000274 /// The current set of branch fixups. A branch fixup is a jump to
275 /// an as-yet unemitted label, i.e. a label for which we don't yet
276 /// know the EH stack depth. Whenever we pop a cleanup, we have
277 /// to thread all the current branch fixups through it.
278 ///
279 /// Fixups are recorded as the Use of the respective branch or
280 /// switch statement. The use points to the final destination.
281 /// When popping out of a cleanup, these uses are threaded through
282 /// the cleanup and adjusted to point to the new cleanup.
283 ///
284 /// Note that branches are allowed to jump into protected scopes
285 /// in certain situations; e.g. the following code is legal:
286 /// struct A { ~A(); }; // trivial ctor, non-trivial dtor
287 /// goto foo;
288 /// A a;
289 /// foo:
290 /// bar();
291 llvm::SmallVector<BranchFixup, 8> BranchFixups;
292
293 char *allocate(size_t Size);
294
John McCallcda666c2010-07-21 07:22:38 +0000295 void *pushCleanup(CleanupKind K, size_t DataSize);
John McCall2b7fc382010-07-13 20:32:21 +0000296
John McCallbd309292010-07-06 01:34:17 +0000297public:
298 EHScopeStack() : StartOfBuffer(0), EndOfBuffer(0), StartOfData(0),
299 InnermostNormalCleanup(stable_end()),
300 InnermostEHCleanup(stable_end()),
John McCallad5d61e2010-07-23 21:56:41 +0000301 CatchDepth(0), NextEHDestIndex(FirstEHDestIndex) {}
John McCallbd309292010-07-06 01:34:17 +0000302 ~EHScopeStack() { delete[] StartOfBuffer; }
303
John McCall2b7fc382010-07-13 20:32:21 +0000304 // Variadic templates would make this not terrible.
305
306 /// Push a lazily-created cleanup on the stack.
John McCall5c08ab92010-07-13 22:12:14 +0000307 template <class T>
John McCallcda666c2010-07-21 07:22:38 +0000308 void pushCleanup(CleanupKind Kind) {
309 void *Buffer = pushCleanup(Kind, sizeof(T));
310 Cleanup *Obj = new(Buffer) T();
John McCall5c08ab92010-07-13 22:12:14 +0000311 (void) Obj;
312 }
313
314 /// Push a lazily-created cleanup on the stack.
315 template <class T, class A0>
John McCallcda666c2010-07-21 07:22:38 +0000316 void pushCleanup(CleanupKind Kind, A0 a0) {
317 void *Buffer = pushCleanup(Kind, sizeof(T));
318 Cleanup *Obj = new(Buffer) T(a0);
John McCall5c08ab92010-07-13 22:12:14 +0000319 (void) Obj;
320 }
321
322 /// Push a lazily-created cleanup on the stack.
John McCall2b7fc382010-07-13 20:32:21 +0000323 template <class T, class A0, class A1>
John McCallcda666c2010-07-21 07:22:38 +0000324 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1) {
325 void *Buffer = pushCleanup(Kind, sizeof(T));
326 Cleanup *Obj = new(Buffer) T(a0, a1);
John McCall2b7fc382010-07-13 20:32:21 +0000327 (void) Obj;
328 }
329
330 /// Push a lazily-created cleanup on the stack.
331 template <class T, class A0, class A1, class A2>
John McCallcda666c2010-07-21 07:22:38 +0000332 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2) {
333 void *Buffer = pushCleanup(Kind, sizeof(T));
334 Cleanup *Obj = new(Buffer) T(a0, a1, a2);
John McCall2b7fc382010-07-13 20:32:21 +0000335 (void) Obj;
336 }
337
338 /// Push a lazily-created cleanup on the stack.
339 template <class T, class A0, class A1, class A2, class A3>
John McCallcda666c2010-07-21 07:22:38 +0000340 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3) {
341 void *Buffer = pushCleanup(Kind, sizeof(T));
342 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3);
John McCall2b7fc382010-07-13 20:32:21 +0000343 (void) Obj;
344 }
345
John McCall906da4b2010-07-21 05:47:49 +0000346 /// Push a lazily-created cleanup on the stack.
347 template <class T, class A0, class A1, class A2, class A3, class A4>
John McCallcda666c2010-07-21 07:22:38 +0000348 void pushCleanup(CleanupKind Kind, A0 a0, A1 a1, A2 a2, A3 a3, A4 a4) {
349 void *Buffer = pushCleanup(Kind, sizeof(T));
350 Cleanup *Obj = new(Buffer) T(a0, a1, a2, a3, a4);
John McCall906da4b2010-07-21 05:47:49 +0000351 (void) Obj;
352 }
353
John McCall824c2f52010-09-14 07:57:04 +0000354 // Feel free to add more variants of the following:
355
356 /// Push a cleanup with non-constant storage requirements on the
357 /// stack. The cleanup type must provide an additional static method:
358 /// static size_t getExtraSize(size_t);
359 /// The argument to this method will be the value N, which will also
360 /// be passed as the first argument to the constructor.
361 ///
362 /// The data stored in the extra storage must obey the same
363 /// restrictions as normal cleanup member data.
364 ///
365 /// The pointer returned from this method is valid until the cleanup
366 /// stack is modified.
367 template <class T, class A0, class A1, class A2>
368 T *pushCleanupWithExtra(CleanupKind Kind, size_t N, A0 a0, A1 a1, A2 a2) {
369 void *Buffer = pushCleanup(Kind, sizeof(T) + T::getExtraSize(N));
370 return new (Buffer) T(N, a0, a1, a2);
371 }
372
John McCallbd309292010-07-06 01:34:17 +0000373 /// Pops a cleanup scope off the stack. This should only be called
374 /// by CodeGenFunction::PopCleanupBlock.
375 void popCleanup();
376
377 /// Push a set of catch handlers on the stack. The catch is
378 /// uninitialized and will need to have the given number of handlers
379 /// set on it.
380 class EHCatchScope *pushCatch(unsigned NumHandlers);
381
382 /// Pops a catch scope off the stack.
383 void popCatch();
384
385 /// Push an exceptions filter on the stack.
386 class EHFilterScope *pushFilter(unsigned NumFilters);
387
388 /// Pops an exceptions filter off the stack.
389 void popFilter();
390
391 /// Push a terminate handler on the stack.
392 void pushTerminate();
393
394 /// Pops a terminate handler off the stack.
395 void popTerminate();
396
397 /// Determines whether the exception-scopes stack is empty.
398 bool empty() const { return StartOfData == EndOfBuffer; }
399
400 bool requiresLandingPad() const {
401 return (CatchDepth || hasEHCleanups());
402 }
403
404 /// Determines whether there are any normal cleanups on the stack.
405 bool hasNormalCleanups() const {
406 return InnermostNormalCleanup != stable_end();
407 }
408
409 /// Returns the innermost normal cleanup on the stack, or
410 /// stable_end() if there are no normal cleanups.
411 stable_iterator getInnermostNormalCleanup() const {
412 return InnermostNormalCleanup;
413 }
John McCall324277852010-08-14 07:46:19 +0000414 stable_iterator getInnermostActiveNormalCleanup() const; // CGException.h
John McCallbd309292010-07-06 01:34:17 +0000415
416 /// Determines whether there are any EH cleanups on the stack.
417 bool hasEHCleanups() const {
418 return InnermostEHCleanup != stable_end();
419 }
420
421 /// Returns the innermost EH cleanup on the stack, or stable_end()
422 /// if there are no EH cleanups.
423 stable_iterator getInnermostEHCleanup() const {
424 return InnermostEHCleanup;
425 }
John McCall324277852010-08-14 07:46:19 +0000426 stable_iterator getInnermostActiveEHCleanup() const; // CGException.h
John McCallbd309292010-07-06 01:34:17 +0000427
428 /// An unstable reference to a scope-stack depth. Invalidated by
429 /// pushes but not pops.
430 class iterator;
431
432 /// Returns an iterator pointing to the innermost EH scope.
433 iterator begin() const;
434
435 /// Returns an iterator pointing to the outermost EH scope.
436 iterator end() const;
437
438 /// Create a stable reference to the top of the EH stack. The
439 /// returned reference is valid until that scope is popped off the
440 /// stack.
441 stable_iterator stable_begin() const {
442 return stable_iterator(EndOfBuffer - StartOfData);
443 }
444
445 /// Create a stable reference to the bottom of the EH stack.
446 static stable_iterator stable_end() {
447 return stable_iterator(0);
448 }
449
450 /// Translates an iterator into a stable_iterator.
451 stable_iterator stabilize(iterator it) const;
452
453 /// Finds the nearest cleanup enclosing the given iterator.
454 /// Returns stable_iterator::invalid() if there are no such cleanups.
455 stable_iterator getEnclosingEHCleanup(iterator it) const;
456
457 /// Turn a stable reference to a scope depth into a unstable pointer
458 /// to the EH stack.
459 iterator find(stable_iterator save) const;
460
461 /// Removes the cleanup pointed to by the given stable_iterator.
462 void removeCleanup(stable_iterator save);
463
464 /// Add a branch fixup to the current cleanup scope.
465 BranchFixup &addBranchFixup() {
466 assert(hasNormalCleanups() && "adding fixup in scope without cleanups");
467 BranchFixups.push_back(BranchFixup());
468 return BranchFixups.back();
469 }
470
471 unsigned getNumBranchFixups() const { return BranchFixups.size(); }
472 BranchFixup &getBranchFixup(unsigned I) {
473 assert(I < getNumBranchFixups());
474 return BranchFixups[I];
475 }
476
John McCallad5d61e2010-07-23 21:56:41 +0000477 /// Pops lazily-removed fixups from the end of the list. This
478 /// should only be called by procedures which have just popped a
479 /// cleanup or resolved one or more fixups.
480 void popNullFixups();
481
482 /// Clears the branch-fixups list. This should only be called by
John McCallf09d96f2010-09-18 02:24:39 +0000483 /// ResolveAllBranchFixups.
John McCallad5d61e2010-07-23 21:56:41 +0000484 void clearFixups() { BranchFixups.clear(); }
485
486 /// Gets the next EH destination index.
487 unsigned getNextEHDestIndex() { return NextEHDestIndex++; }
John McCallbd309292010-07-06 01:34:17 +0000488};
489
Chris Lattnerbed31442007-05-28 01:07:47 +0000490/// CodeGenFunction - This class organizes the per-function state that is used
491/// while generating LLVM code.
Mike Stump95435672009-03-04 18:17:45 +0000492class CodeGenFunction : public BlockFunction {
Anders Carlsson729a8202009-02-24 04:21:31 +0000493 CodeGenFunction(const CodeGenFunction&); // DO NOT IMPLEMENT
494 void operator=(const CodeGenFunction&); // DO NOT IMPLEMENT
John McCall5d865c322010-08-31 07:33:07 +0000495
496 friend class CGCXXABI;
Chris Lattnerbda69f82007-08-26 23:13:56 +0000497public:
John McCallad5d61e2010-07-23 21:56:41 +0000498 /// A jump destination is an abstract label, branching to which may
499 /// require a jump out through normal cleanups.
John McCallbd309292010-07-06 01:34:17 +0000500 struct JumpDest {
John McCallad5d61e2010-07-23 21:56:41 +0000501 JumpDest() : Block(0), ScopeDepth(), Index(0) {}
502 JumpDest(llvm::BasicBlock *Block,
503 EHScopeStack::stable_iterator Depth,
504 unsigned Index)
505 : Block(Block), ScopeDepth(Depth), Index(Index) {}
506
507 bool isValid() const { return Block != 0; }
508 llvm::BasicBlock *getBlock() const { return Block; }
509 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
510 unsigned getDestIndex() const { return Index; }
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000511
John McCallad5d61e2010-07-23 21:56:41 +0000512 private:
John McCallbd309292010-07-06 01:34:17 +0000513 llvm::BasicBlock *Block;
514 EHScopeStack::stable_iterator ScopeDepth;
John McCallad5d61e2010-07-23 21:56:41 +0000515 unsigned Index;
516 };
517
518 /// An unwind destination is an abstract label, branching to which
519 /// may require a jump out through EH cleanups.
520 struct UnwindDest {
521 UnwindDest() : Block(0), ScopeDepth(), Index(0) {}
522 UnwindDest(llvm::BasicBlock *Block,
523 EHScopeStack::stable_iterator Depth,
524 unsigned Index)
525 : Block(Block), ScopeDepth(Depth), Index(Index) {}
526
527 bool isValid() const { return Block != 0; }
528 llvm::BasicBlock *getBlock() const { return Block; }
529 EHScopeStack::stable_iterator getScopeDepth() const { return ScopeDepth; }
530 unsigned getDestIndex() const { return Index; }
531
532 private:
533 llvm::BasicBlock *Block;
534 EHScopeStack::stable_iterator ScopeDepth;
535 unsigned Index;
John McCallbd309292010-07-06 01:34:17 +0000536 };
537
Chris Lattnerbed31442007-05-28 01:07:47 +0000538 CodeGenModule &CGM; // Per-module state.
Daniel Dunbar1b444192009-11-13 05:51:54 +0000539 const TargetInfo &Target;
Mike Stumpfc496822009-02-08 23:14:22 +0000540
Chris Lattner96d72562007-08-21 16:57:55 +0000541 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbarcb463852008-11-01 01:53:16 +0000542 CGBuilderTy Builder;
Mike Stumpfc496822009-02-08 23:14:22 +0000543
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000544 /// CurFuncDecl - Holds the Decl for the current function or ObjC method.
545 /// This excludes BlockDecls.
Chris Lattner5696e7b2008-06-17 18:05:57 +0000546 const Decl *CurFuncDecl;
Chris Lattner28ec0cf2009-04-23 05:30:27 +0000547 /// CurCodeDecl - This is the inner-most code context, which includes blocks.
548 const Decl *CurCodeDecl;
Daniel Dunbard931a872009-02-02 22:03:45 +0000549 const CGFunctionInfo *CurFnInfo;
Chris Lattner4bd55962008-03-30 23:03:07 +0000550 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +0000551 llvm::Function *CurFn;
552
Mike Stumpbee78dd2009-12-04 23:26:17 +0000553 /// CurGD - The GlobalDecl for the current function being compiled.
554 GlobalDecl CurGD;
Mike Stumpbee78dd2009-12-04 23:26:17 +0000555
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000556 /// ReturnBlock - Unified return block.
John McCallbd309292010-07-06 01:34:17 +0000557 JumpDest ReturnBlock;
558
Mike Stumpfc496822009-02-08 23:14:22 +0000559 /// ReturnValue - The temporary alloca to hold the return value. This is null
560 /// iff the function has no return value.
Eli Friedman4b1942c2009-12-04 02:43:40 +0000561 llvm::Value *ReturnValue;
Mike Stumpfc496822009-02-08 23:14:22 +0000562
John McCallad5d61e2010-07-23 21:56:41 +0000563 /// RethrowBlock - Unified rethrow block.
564 UnwindDest RethrowBlock;
565
Chris Lattner03df1222007-06-02 04:53:11 +0000566 /// AllocaInsertPoint - This is an instruction in the entry block before which
567 /// we prefer to insert allocas.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000568 llvm::AssertingVH<llvm::Instruction> AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000569
Chris Lattner5e016ae2010-06-27 07:15:29 +0000570 // intptr_t, i32, i64
571 const llvm::IntegerType *IntPtrTy, *Int32Ty, *Int64Ty;
Hartmut Kaiser7078da82007-10-17 15:00:17 +0000572 uint32_t LLVMPointerWidth;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000573
Mike Stumpaff69af2009-12-09 03:35:49 +0000574 bool Exceptions;
Mike Stumpd9546382009-12-12 01:27:46 +0000575 bool CatchUndefined;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000576
Douglas Gregor9154b5d2010-05-17 15:52:46 +0000577 /// \brief A mapping from NRVO variables to the flags used to indicate
578 /// when the NRVO has been applied to this variable.
579 llvm::DenseMap<const VarDecl *, llvm::Value *> NRVOFlags;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000580
Fariborz Jahanian5bbd1b02010-09-17 15:51:28 +0000581 /// \brief A mapping from 'Save' expression in a conditional expression
582 /// to the IR for this expression. Used to implement IR gen. for Gnu
583 /// extension's missing LHS expression in a conditional operator expression.
584 llvm::DenseMap<const Expr *, llvm::Value *> ConditionalSaveExprs;
Fariborz Jahanian8162d4a2010-09-20 23:50:22 +0000585 llvm::DenseMap<const Expr *, ComplexPairTy> ConditionalSaveComplexExprs;
Fariborz Jahaniancb750212010-09-21 18:32:21 +0000586 llvm::DenseMap<const Expr *, LValue> ConditionalSaveLValueExprs;
John McCallbd309292010-07-06 01:34:17 +0000587
588 EHScopeStack EHStack;
589
John McCallad5d61e2010-07-23 21:56:41 +0000590 /// i32s containing the indexes of the cleanup destinations.
591 llvm::AllocaInst *NormalCleanupDest;
592 llvm::AllocaInst *EHCleanupDest;
593
594 unsigned NextCleanupDestIndex;
595
John McCallbd309292010-07-06 01:34:17 +0000596 /// The exception slot. All landing pads write the current
597 /// exception pointer into this alloca.
598 llvm::Value *ExceptionSlot;
599
600 /// Emits a landing pad for the current EH stack.
601 llvm::BasicBlock *EmitLandingPad();
602
603 llvm::BasicBlock *getInvokeDestImpl();
604
John McCallce1de612011-01-26 04:00:11 +0000605 /// Sets up a condition for a full-expression cleanup.
606 llvm::Value *initFullExprCleanup();
607
608 template <class T>
609 typename SavedValueInCond<T>::saved_type saveValueInCond(T value) {
610 return SavedValueInCond<T>::save(*this, value);
611 }
612
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000613public:
Anders Carlsson33c1b652009-02-10 06:07:49 +0000614 /// ObjCEHValueStack - Stack of Objective-C exception values, used for
615 /// rethrows.
Anders Carlssonbf8a1be2009-02-07 21:37:21 +0000616 llvm::SmallVector<llvm::Value*, 8> ObjCEHValueStack;
Mike Stumpfc496822009-02-08 23:14:22 +0000617
John McCallbd309292010-07-06 01:34:17 +0000618 // A struct holding information about a finally block's IR
619 // generation. For now, doesn't actually hold anything.
620 struct FinallyInfo {
Anders Carlsson66c384a2009-02-08 07:46:24 +0000621 };
622
John McCallbd309292010-07-06 01:34:17 +0000623 FinallyInfo EnterFinallyBlock(const Stmt *Stmt,
624 llvm::Constant *BeginCatchFn,
625 llvm::Constant *EndCatchFn,
626 llvm::Constant *RethrowFn);
627 void ExitFinallyBlock(FinallyInfo &FinallyInfo);
Mike Stumpaff69af2009-12-09 03:35:49 +0000628
John McCallce1de612011-01-26 04:00:11 +0000629 /// pushFullExprCleanup - Push a cleanup to be run at the end of the
630 /// current full-expression. Safe against the possibility that
631 /// we're currently inside a conditionally-evaluated expression.
632 template <class T, class A0, class A1>
633 void pushFullExprCleanup(CleanupKind kind, A0 a0, A1 a1) {
634 // If we're not in a conditional branch, or if none of the
635 // arguments requires saving, then use the unconditional cleanup.
636 if (!(isInConditionalBranch() ||
637 SavedValueInCond<A0>::needsSaving(a0) ||
638 SavedValueInCond<A1>::needsSaving(a1))) {
639 typedef EHScopeStack::UnconditionalCleanup2<T, A0, A1> CleanupType;
640 return EHStack.pushCleanup<CleanupType>(kind, a0, a1);
641 }
642
643 llvm::Value *condVar = initFullExprCleanup();
644 typename SavedValueInCond<A0>::saved_type a0_saved = saveValueInCond(a0);
645 typename SavedValueInCond<A1>::saved_type a1_saved = saveValueInCond(a1);
646
647 typedef EHScopeStack::ConditionalCleanup2<T, A0, A1> CleanupType;
648 EHStack.pushCleanup<CleanupType>(kind, condVar, a0_saved, a1_saved);
649 }
650
John McCallbd309292010-07-06 01:34:17 +0000651 /// PushDestructorCleanup - Push a cleanup to call the
652 /// complete-object destructor of an object of the given type at the
653 /// given address. Does nothing if T is not a C++ class type with a
654 /// non-trivial destructor.
655 void PushDestructorCleanup(QualType T, llvm::Value *Addr);
656
John McCall8680f872010-07-21 06:29:51 +0000657 /// PushDestructorCleanup - Push a cleanup to call the
658 /// complete-object variant of the given destructor on the object at
659 /// the given address.
660 void PushDestructorCleanup(const CXXDestructorDecl *Dtor,
661 llvm::Value *Addr);
662
John McCallbd309292010-07-06 01:34:17 +0000663 /// PopCleanupBlock - Will pop the cleanup entry on the stack and
664 /// process all branch fixups.
John McCallad5d61e2010-07-23 21:56:41 +0000665 void PopCleanupBlock(bool FallThroughIsBranchThrough = false);
John McCallbd309292010-07-06 01:34:17 +0000666
John McCall824c2f52010-09-14 07:57:04 +0000667 /// DeactivateCleanupBlock - Deactivates the given cleanup block.
668 /// The block cannot be reactivated. Pops it if it's the top of the
669 /// stack.
670 void DeactivateCleanupBlock(EHScopeStack::stable_iterator Cleanup);
671
672 /// ActivateCleanupBlock - Activates an initially-inactive cleanup.
673 /// Cannot be used to resurrect a deactivated cleanup.
674 void ActivateCleanupBlock(EHScopeStack::stable_iterator Cleanup);
John McCall612942d2010-08-13 21:20:51 +0000675
John McCallbd309292010-07-06 01:34:17 +0000676 /// \brief Enters a new scope for capturing cleanups, all of which
677 /// will be executed once the scope is exited.
678 class RunCleanupsScope {
Douglas Gregor965f4502009-11-24 16:43:22 +0000679 CodeGenFunction& CGF;
John McCallbd309292010-07-06 01:34:17 +0000680 EHScopeStack::stable_iterator CleanupStackDepth;
Douglas Gregor965f4502009-11-24 16:43:22 +0000681 bool OldDidCallStackSave;
Douglas Gregor680f8612009-11-24 21:15:44 +0000682 bool PerformCleanup;
Douglas Gregor965f4502009-11-24 16:43:22 +0000683
John McCallbd309292010-07-06 01:34:17 +0000684 RunCleanupsScope(const RunCleanupsScope &); // DO NOT IMPLEMENT
685 RunCleanupsScope &operator=(const RunCleanupsScope &); // DO NOT IMPLEMENT
Douglas Gregor965f4502009-11-24 16:43:22 +0000686
687 public:
688 /// \brief Enter a new cleanup scope.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000689 explicit RunCleanupsScope(CodeGenFunction &CGF)
690 : CGF(CGF), PerformCleanup(true)
Douglas Gregor680f8612009-11-24 21:15:44 +0000691 {
John McCallbd309292010-07-06 01:34:17 +0000692 CleanupStackDepth = CGF.EHStack.stable_begin();
Douglas Gregor965f4502009-11-24 16:43:22 +0000693 OldDidCallStackSave = CGF.DidCallStackSave;
Argyrios Kyrtzidis9efa1ce2010-09-14 00:42:34 +0000694 CGF.DidCallStackSave = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000695 }
696
697 /// \brief Exit this cleanup scope, emitting any accumulated
698 /// cleanups.
John McCallbd309292010-07-06 01:34:17 +0000699 ~RunCleanupsScope() {
Douglas Gregor680f8612009-11-24 21:15:44 +0000700 if (PerformCleanup) {
701 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallbd309292010-07-06 01:34:17 +0000702 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor680f8612009-11-24 21:15:44 +0000703 }
704 }
705
706 /// \brief Determine whether this scope requires any cleanups.
707 bool requiresCleanups() const {
John McCallbd309292010-07-06 01:34:17 +0000708 return CGF.EHStack.stable_begin() != CleanupStackDepth;
Douglas Gregor680f8612009-11-24 21:15:44 +0000709 }
710
711 /// \brief Force the emission of cleanups now, instead of waiting
712 /// until this object is destroyed.
713 void ForceCleanup() {
714 assert(PerformCleanup && "Already forced cleanup");
Douglas Gregor965f4502009-11-24 16:43:22 +0000715 CGF.DidCallStackSave = OldDidCallStackSave;
John McCallbd309292010-07-06 01:34:17 +0000716 CGF.PopCleanupBlocks(CleanupStackDepth);
Douglas Gregor680f8612009-11-24 21:15:44 +0000717 PerformCleanup = false;
Douglas Gregor965f4502009-11-24 16:43:22 +0000718 }
719 };
720
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000721
John McCallbd309292010-07-06 01:34:17 +0000722 /// PopCleanupBlocks - Takes the old cleanup stack size and emits
723 /// the cleanup blocks that have been added.
724 void PopCleanupBlocks(EHScopeStack::stable_iterator OldCleanupStackSize);
Anders Carlssonb9fd57f2010-03-30 03:14:41 +0000725
John McCallad5d61e2010-07-23 21:56:41 +0000726 void ResolveBranchFixups(llvm::BasicBlock *Target);
727
John McCallbd309292010-07-06 01:34:17 +0000728 /// The given basic block lies in the current EH scope, but may be a
729 /// target of a potentially scope-crossing jump; get a stable handle
730 /// to which we can perform this jump later.
John McCallad5d61e2010-07-23 21:56:41 +0000731 JumpDest getJumpDestInCurrentScope(llvm::BasicBlock *Target) {
John McCallba803902010-07-28 01:07:35 +0000732 return JumpDest(Target,
733 EHStack.getInnermostNormalCleanup(),
734 NextCleanupDestIndex++);
John McCallbd309292010-07-06 01:34:17 +0000735 }
Anders Carlssonbe0f76a2009-02-07 23:50:39 +0000736
John McCallbd309292010-07-06 01:34:17 +0000737 /// The given basic block lies in the current EH scope, but may be a
738 /// target of a potentially scope-crossing jump; get a stable handle
739 /// to which we can perform this jump later.
740 JumpDest getJumpDestInCurrentScope(const char *Name = 0) {
John McCallad5d61e2010-07-23 21:56:41 +0000741 return getJumpDestInCurrentScope(createBasicBlock(Name));
John McCallbd309292010-07-06 01:34:17 +0000742 }
743
744 /// EmitBranchThroughCleanup - Emit a branch from the current insert
745 /// block through the normal cleanup handling code (if any) and then
746 /// on to \arg Dest.
747 void EmitBranchThroughCleanup(JumpDest Dest);
748
749 /// EmitBranchThroughEHCleanup - Emit a branch from the current
750 /// insert block through the EH cleanup handling code (if any) and
751 /// then on to \arg Dest.
John McCallad5d61e2010-07-23 21:56:41 +0000752 void EmitBranchThroughEHCleanup(UnwindDest Dest);
753
754 /// getRethrowDest - Returns the unified outermost-scope rethrow
755 /// destination.
756 UnwindDest getRethrowDest();
Mike Stumpfc496822009-02-08 23:14:22 +0000757
John McCallce1de612011-01-26 04:00:11 +0000758 /// An object to manage conditionally-evaluated expressions.
759 class ConditionalEvaluation {
760 llvm::BasicBlock *StartBB;
Mike Stump11289f42009-09-09 15:08:12 +0000761
John McCallce1de612011-01-26 04:00:11 +0000762 public:
763 ConditionalEvaluation(CodeGenFunction &CGF)
764 : StartBB(CGF.Builder.GetInsertBlock()) {}
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000765
John McCallce1de612011-01-26 04:00:11 +0000766 void begin(CodeGenFunction &CGF) {
767 assert(CGF.OutermostConditional != this);
768 if (!CGF.OutermostConditional)
769 CGF.OutermostConditional = this;
770 }
771
772 void end(CodeGenFunction &CGF) {
773 assert(CGF.OutermostConditional != 0);
774 if (CGF.OutermostConditional == this)
775 CGF.OutermostConditional = 0;
776 }
777
778 /// Returns a block which will be executed prior to each
779 /// evaluation of the conditional code.
780 llvm::BasicBlock *getStartingBlock() const {
781 return StartBB;
782 }
783 };
Mike Stump11289f42009-09-09 15:08:12 +0000784
John McCall7f9c92a2010-09-17 00:50:28 +0000785 /// isInConditionalBranch - Return true if we're currently emitting
786 /// one branch or the other of a conditional expression.
John McCallce1de612011-01-26 04:00:11 +0000787 bool isInConditionalBranch() const { return OutermostConditional != 0; }
788
789 /// An RAII object to record that we're evaluating a statement
790 /// expression.
791 class StmtExprEvaluation {
792 CodeGenFunction &CGF;
793
794 /// We have to save the outermost conditional: cleanups in a
795 /// statement expression aren't conditional just because the
796 /// StmtExpr is.
797 ConditionalEvaluation *SavedOutermostConditional;
798
799 public:
800 StmtExprEvaluation(CodeGenFunction &CGF)
801 : CGF(CGF), SavedOutermostConditional(CGF.OutermostConditional) {
802 CGF.OutermostConditional = 0;
803 }
804
805 ~StmtExprEvaluation() {
806 CGF.OutermostConditional = SavedOutermostConditional;
807 CGF.EnsureInsertPoint();
808 }
809 };
Fariborz Jahaniana3e54bd2010-11-16 19:29:39 +0000810
811 /// getByrefValueFieldNumber - Given a declaration, returns the LLVM field
812 /// number that holds the value.
813 unsigned getByRefValueLLVMField(const ValueDecl *VD) const;
Fariborz Jahanian2f2fa722011-01-26 23:08:27 +0000814
815 /// BuildBlockByrefAddress - Computes address location of the
816 /// variable which is declared as __block.
817 llvm::Value *BuildBlockByrefAddress(llvm::Value *BaseAddr,
818 const VarDecl *V);
Chris Lattner2da04b32007-08-24 05:35:26 +0000819private:
Chris Lattner6c4d2552009-10-28 23:59:40 +0000820 CGDebugInfo *DebugInfo;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000821
Mike Stumpe5311b02009-11-30 20:08:49 +0000822 /// IndirectBranch - The first time an indirect goto is seen we create a block
823 /// with an indirect branch. Every time we see the address of a label taken,
824 /// we add the label to the indirect goto. Every subsequent indirect goto is
825 /// codegen'd as a jump to the IndirectBranch's basic block.
Chris Lattner6c4d2552009-10-28 23:59:40 +0000826 llvm::IndirectBrInst *IndirectBranch;
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000827
Mike Stumpfc496822009-02-08 23:14:22 +0000828 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
829 /// decls.
Chris Lattner23b7eb62007-06-15 23:05:46 +0000830 llvm::DenseMap<const Decl*, llvm::Value*> LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000831
Chris Lattnerac248202007-05-30 00:13:02 +0000832 /// LabelMap - This keeps track of the LLVM basic block for each C label.
John McCallbd309292010-07-06 01:34:17 +0000833 llvm::DenseMap<const LabelStmt*, JumpDest> LabelMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000834
Mike Stumpfc496822009-02-08 23:14:22 +0000835 // BreakContinueStack - This keeps track of where break and continue
Anders Carlsson33747b62009-02-10 05:52:02 +0000836 // statements should jump to.
Chris Lattnere73e4322007-07-16 21:28:45 +0000837 struct BreakContinue {
John McCallbd309292010-07-06 01:34:17 +0000838 BreakContinue(JumpDest Break, JumpDest Continue)
839 : BreakBlock(Break), ContinueBlock(Continue) {}
Mike Stumpfc496822009-02-08 23:14:22 +0000840
John McCallbd309292010-07-06 01:34:17 +0000841 JumpDest BreakBlock;
842 JumpDest ContinueBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000843 };
Chris Lattnere73e4322007-07-16 21:28:45 +0000844 llvm::SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000845
Mike Stumpfc496822009-02-08 23:14:22 +0000846 /// SwitchInsn - This is nearest current switch instruction. It is null if if
847 /// current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000848 llvm::SwitchInst *SwitchInsn;
849
Mike Stumpfc496822009-02-08 23:14:22 +0000850 /// CaseRangeBlock - This block holds if condition check for last case
Devang Patel49a44f32007-10-09 17:08:50 +0000851 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000852 llvm::BasicBlock *CaseRangeBlock;
853
Mike Stumpfc496822009-02-08 23:14:22 +0000854 // VLASizeMap - This keeps track of the associated size for each VLA type.
Eli Friedman04fddf02009-08-15 02:50:32 +0000855 // We track this by the size expression rather than the type itself because
856 // in certain situations, like a const qualifier applied to an VLA typedef,
857 // multiple VLA types can share the same size expression.
Mike Stumpfc496822009-02-08 23:14:22 +0000858 // FIXME: Maybe this could be a stack of maps that is pushed/popped as we
859 // enter/leave scopes.
Eli Friedman04fddf02009-08-15 02:50:32 +0000860 llvm::DenseMap<const Expr*, llvm::Value*> VLASizeMap;
Mike Stumpfc496822009-02-08 23:14:22 +0000861
Anders Carlssonf4478e92009-02-09 20:20:56 +0000862 /// DidCallStackSave - Whether llvm.stacksave has been called. Used to avoid
863 /// calling llvm.stacksave for multiple VLAs in the same scope.
864 bool DidCallStackSave;
Mike Stumpc6ea7c12009-02-17 17:00:02 +0000865
John McCallbd309292010-07-06 01:34:17 +0000866 /// A block containing a single 'unreachable' instruction. Created
867 /// lazily by getUnreachableBlock().
868 llvm::BasicBlock *UnreachableBlock;
Mike Stumpfc496822009-02-08 23:14:22 +0000869
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000870 /// CXXThisDecl - When generating code for a C++ member function,
871 /// this will hold the implicit 'this' declaration.
Anders Carlsson468fa632009-04-04 20:47:02 +0000872 ImplicitParamDecl *CXXThisDecl;
John McCall347132b2010-02-16 22:04:33 +0000873 llvm::Value *CXXThisValue;
Mike Stump11289f42009-09-09 15:08:12 +0000874
Anders Carlsson82ba57c2009-11-25 03:15:49 +0000875 /// CXXVTTDecl - When generating code for a base object constructor or
876 /// base object destructor with virtual bases, this will hold the implicit
877 /// VTT parameter.
878 ImplicitParamDecl *CXXVTTDecl;
John McCall347132b2010-02-16 22:04:33 +0000879 llvm::Value *CXXVTTValue;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000880
John McCallce1de612011-01-26 04:00:11 +0000881 /// OutermostConditional - Points to the outermost active
882 /// conditional control. This is used so that we know if a
883 /// temporary should be destroyed conditionally.
884 ConditionalEvaluation *OutermostConditional;
Mike Stump11289f42009-09-09 15:08:12 +0000885
Anders Carlsson0168f4b2009-09-12 02:14:24 +0000886
887 /// ByrefValueInfoMap - For each __block variable, contains a pair of the LLVM
888 /// type as well as the field number that contains the actual data.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000889 llvm::DenseMap<const ValueDecl *, std::pair<const llvm::Type *,
Anders Carlsson0168f4b2009-09-12 02:14:24 +0000890 unsigned> > ByRefValueInfo;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000891
John McCallbd309292010-07-06 01:34:17 +0000892 llvm::BasicBlock *TerminateLandingPad;
Mike Stumpf5cbb082009-12-10 00:02:42 +0000893 llvm::BasicBlock *TerminateHandler;
Chris Lattnerf2f38702010-07-20 21:07:09 +0000894 llvm::BasicBlock *TrapBB;
Eli Friedmand5bc94e2009-12-10 02:21:21 +0000895
Chris Lattnerbed31442007-05-28 01:07:47 +0000896public:
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000897 CodeGenFunction(CodeGenModule &cgm);
Mike Stumpfc496822009-02-08 23:14:22 +0000898
John McCall8ed55a52010-09-02 09:58:18 +0000899 CodeGenTypes &getTypes() const { return CGM.getTypes(); }
Chris Lattner6db1fb82007-06-02 22:49:07 +0000900 ASTContext &getContext() const;
Anders Carlsson63784f42009-02-13 08:11:52 +0000901 CGDebugInfo *getDebugInfo() { return DebugInfo; }
Chris Lattner6db1fb82007-06-02 22:49:07 +0000902
John McCallbd309292010-07-06 01:34:17 +0000903 /// Returns a pointer to the function's exception object slot, which
904 /// is assigned in every landing pad.
905 llvm::Value *getExceptionSlot();
906
John McCallad5d61e2010-07-23 21:56:41 +0000907 llvm::Value *getNormalCleanupDestSlot();
908 llvm::Value *getEHCleanupDestSlot();
909
John McCallbd309292010-07-06 01:34:17 +0000910 llvm::BasicBlock *getUnreachableBlock() {
911 if (!UnreachableBlock) {
912 UnreachableBlock = createBasicBlock("unreachable");
913 new llvm::UnreachableInst(getLLVMContext(), UnreachableBlock);
914 }
915 return UnreachableBlock;
916 }
917
918 llvm::BasicBlock *getInvokeDest() {
919 if (!EHStack.requiresLandingPad()) return 0;
920 return getInvokeDestImpl();
921 }
Daniel Dunbar12347492009-02-23 17:26:39 +0000922
Owen Anderson170229f2009-07-14 23:10:40 +0000923 llvm::LLVMContext &getLLVMContext() { return VMContext; }
Owen Andersonae86c192009-07-13 04:10:07 +0000924
Daniel Dunbar12347492009-02-23 17:26:39 +0000925 //===--------------------------------------------------------------------===//
926 // Objective-C
927 //===--------------------------------------------------------------------===//
928
Chris Lattner4bd55962008-03-30 23:03:07 +0000929 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000930
Mike Stumpfc496822009-02-08 23:14:22 +0000931 void StartObjCMethod(const ObjCMethodDecl *MD,
Fariborz Jahanian0196a1c2009-01-10 21:06:09 +0000932 const ObjCContainerDecl *CD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000933
Mike Stumpfc496822009-02-08 23:14:22 +0000934 /// GenerateObjCGetter - Synthesize an Objective-C property getter function.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000935 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
936 const ObjCPropertyImplDecl *PID);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +0000937 void GenerateObjCCtorDtorMethod(ObjCImplementationDecl *IMP,
938 ObjCMethodDecl *MD, bool ctor);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000939
Mike Stumpfc496822009-02-08 23:14:22 +0000940 /// GenerateObjCSetter - Synthesize an Objective-C property setter function
941 /// for the given property.
Fariborz Jahanian3d8552a2008-12-09 20:23:04 +0000942 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
943 const ObjCPropertyImplDecl *PID);
Fariborz Jahanian08b0f662010-04-13 00:38:05 +0000944 bool IndirectObjCSetterArg(const CGFunctionInfo &FI);
Fariborz Jahanian7e9d52a2010-04-13 18:32:24 +0000945 bool IvarTypeWithAggrGCObjects(QualType Ty);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000946
Mike Stumpcb2fbcb2009-02-21 20:00:35 +0000947 //===--------------------------------------------------------------------===//
948 // Block Bits
949 //===--------------------------------------------------------------------===//
950
Mike Stumpb750d922009-02-25 23:33:13 +0000951 llvm::Value *BuildBlockLiteralTmp(const BlockExpr *);
Blaine Garstfc83aa02010-02-23 21:51:17 +0000952 llvm::Constant *BuildDescriptorBlockDecl(const BlockExpr *,
Fariborz Jahanianc05349e2010-08-04 16:57:49 +0000953 const CGBlockInfo &Info,
Mike Stumpaeb0ffd2009-03-07 02:35:30 +0000954 const llvm::StructType *,
Fariborz Jahanianafa3c0a2010-08-04 18:44:59 +0000955 llvm::Constant *BlockVarLayout,
Mike Stumpaeb0ffd2009-03-07 02:35:30 +0000956 std::vector<HelperInfo> *);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +0000957
Fariborz Jahanian9b5528d2010-06-24 00:08:06 +0000958 llvm::Function *GenerateBlockFunction(GlobalDecl GD,
959 const BlockExpr *BExpr,
John McCall9d42f0f2010-05-21 04:11:14 +0000960 CGBlockInfo &Info,
Mike Stump692c6e32009-03-20 21:53:12 +0000961 const Decl *OuterFuncDecl,
Fariborz Jahanianafa3c0a2010-08-04 18:44:59 +0000962 llvm::Constant *& BlockVarLayout,
John McCall9d42f0f2010-05-21 04:11:14 +0000963 llvm::DenseMap<const Decl*, llvm::Value*> ldm);
Mike Stumpcb2fbcb2009-02-21 20:00:35 +0000964
965 llvm::Value *LoadBlockStruct();
966
John McCall87fe5d52010-05-20 01:18:31 +0000967 void AllocateBlockCXXThisPointer(const CXXThisExpr *E);
968 void AllocateBlockDecl(const BlockDeclRefExpr *E);
John McCall9d42f0f2010-05-21 04:11:14 +0000969 llvm::Value *GetAddrOfBlockDecl(const BlockDeclRefExpr *E) {
970 return GetAddrOfBlockDecl(E->getDecl(), E->isByRef());
971 }
972 llvm::Value *GetAddrOfBlockDecl(const ValueDecl *D, bool ByRef);
Anders Carlsson71d1d922009-09-09 02:51:03 +0000973 const llvm::Type *BuildByRefType(const ValueDecl *D);
Mike Stump97d01d52009-03-04 03:23:46 +0000974
Anders Carlsson73fcc952009-09-11 00:07:24 +0000975 void GenerateCode(GlobalDecl GD, llvm::Function *Fn);
976 void StartFunction(GlobalDecl GD, QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000977 llvm::Function *Fn,
Daniel Dunbar354d2782008-10-18 18:22:23 +0000978 const FunctionArgList &Args,
979 SourceLocation StartLoc);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000980
John McCallb81884d2010-02-19 09:25:03 +0000981 void EmitConstructorBody(FunctionArgList &Args);
982 void EmitDestructorBody(FunctionArgList &Args);
983 void EmitFunctionBody(FunctionArgList &Args);
John McCall89b12b32010-02-18 03:17:58 +0000984
Mike Stumpfc496822009-02-08 23:14:22 +0000985 /// EmitReturnBlock - Emit the unified return block, trying to avoid its
986 /// emission when possible.
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000987 void EmitReturnBlock();
988
Mike Stumpfc496822009-02-08 23:14:22 +0000989 /// FinishFunction - Complete IR generation of the current function. It is
990 /// legal to call this function even if there is no current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000991 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +0000992
Anders Carlssonbad991d2010-03-24 00:39:18 +0000993 /// GenerateThunk - Generate a thunk for the given method.
994 void GenerateThunk(llvm::Function *Fn, GlobalDecl GD, const ThunkInfo &Thunk);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +0000995
Douglas Gregor94f9a482010-05-05 05:51:00 +0000996 void EmitCtorPrologue(const CXXConstructorDecl *CD, CXXCtorType Type,
997 FunctionArgList &Args);
Mike Stump11289f42009-09-09 15:08:12 +0000998
Anders Carlssone87fae92010-03-28 19:40:00 +0000999 /// InitializeVTablePointer - Initialize the vtable pointer of the given
1000 /// subobject.
1001 ///
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001002 void InitializeVTablePointer(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001003 const CXXRecordDecl *NearestVBase,
Anders Carlssonc4d0d0f2010-05-03 00:07:07 +00001004 uint64_t OffsetFromNearestVBase,
Anders Carlssone87fae92010-03-28 19:40:00 +00001005 llvm::Constant *VTable,
1006 const CXXRecordDecl *VTableClass);
1007
1008 typedef llvm::SmallPtrSet<const CXXRecordDecl *, 4> VisitedVirtualBasesSetTy;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001009 void InitializeVTablePointers(BaseSubobject Base,
Anders Carlsson652758c2010-04-20 05:22:15 +00001010 const CXXRecordDecl *NearestVBase,
Anders Carlssonc4d0d0f2010-05-03 00:07:07 +00001011 uint64_t OffsetFromNearestVBase,
Anders Carlssond5895932010-03-28 21:07:49 +00001012 bool BaseIsNonVirtualPrimaryBase,
1013 llvm::Constant *VTable,
1014 const CXXRecordDecl *VTableClass,
1015 VisitedVirtualBasesSetTy& VBases);
Eli Friedmanbb5008a2009-12-08 06:46:18 +00001016
Anders Carlssond5895932010-03-28 21:07:49 +00001017 void InitializeVTablePointers(const CXXRecordDecl *ClassDecl);
Anders Carlssone87fae92010-03-28 19:40:00 +00001018
Dan Gohman8fc50c22010-10-26 18:44:08 +00001019 /// GetVTablePtr - Return the Value of the vtable pointer member pointed
1020 /// to by This.
1021 llvm::Value *GetVTablePtr(llvm::Value *This, const llvm::Type *Ty);
Anders Carlssone87fae92010-03-28 19:40:00 +00001022
John McCallf99a6312010-07-21 05:30:47 +00001023 /// EnterDtorCleanups - Enter the cleanups necessary to complete the
1024 /// given phase of destruction for a destructor. The end result
1025 /// should call destructors on members and base classes in reverse
1026 /// order of their construction.
1027 void EnterDtorCleanups(const CXXDestructorDecl *Dtor, CXXDtorType Type);
Mike Stump11289f42009-09-09 15:08:12 +00001028
Chris Lattner3c77a352010-06-22 00:03:40 +00001029 /// ShouldInstrumentFunction - Return true if the current function should be
1030 /// instrumented with __cyg_profile_func_* calls
1031 bool ShouldInstrumentFunction();
1032
1033 /// EmitFunctionInstrumentation - Emit LLVM code to call the specified
1034 /// instrumentation function with the current function and the call site, if
1035 /// function instrumentation is enabled.
1036 void EmitFunctionInstrumentation(const char *Fn);
1037
Mike Stumpfc496822009-02-08 23:14:22 +00001038 /// EmitFunctionProlog - Emit the target specific LLVM code to load the
1039 /// arguments for the given function. This is also responsible for naming the
1040 /// LLVM function arguments.
Daniel Dunbard931a872009-02-02 22:03:45 +00001041 void EmitFunctionProlog(const CGFunctionInfo &FI,
1042 llvm::Function *Fn,
Daniel Dunbar613855c2008-09-09 23:27:19 +00001043 const FunctionArgList &Args);
1044
Mike Stumpfc496822009-02-08 23:14:22 +00001045 /// EmitFunctionEpilog - Emit the target specific LLVM code to return the
1046 /// given temporary.
Chris Lattner3fcc7902010-06-27 01:06:27 +00001047 void EmitFunctionEpilog(const CGFunctionInfo &FI);
Daniel Dunbar613855c2008-09-09 23:27:19 +00001048
Mike Stump1d849212009-12-07 23:38:24 +00001049 /// EmitStartEHSpec - Emit the start of the exception spec.
1050 void EmitStartEHSpec(const Decl *D);
1051
1052 /// EmitEndEHSpec - Emit the end of the exception spec.
1053 void EmitEndEHSpec(const Decl *D);
1054
John McCallbd309292010-07-06 01:34:17 +00001055 /// getTerminateLandingPad - Return a landing pad that just calls terminate.
1056 llvm::BasicBlock *getTerminateLandingPad();
1057
1058 /// getTerminateHandler - Return a handler (not a landing pad, just
1059 /// a catch handler) that just calls terminate. This is used when
1060 /// a terminate scope encloses a try.
Mike Stump2b488872009-12-09 22:59:31 +00001061 llvm::BasicBlock *getTerminateHandler();
1062
Daniel Dunbaree3da872009-02-03 23:03:55 +00001063 const llvm::Type *ConvertTypeForMem(QualType T);
Chris Lattnerf033c142007-06-22 19:05:19 +00001064 const llvm::Type *ConvertType(QualType T);
John McCall6ce74722010-02-16 04:15:37 +00001065 const llvm::Type *ConvertType(const TypeDecl *T) {
1066 return ConvertType(getContext().getTypeDeclType(T));
1067 }
Chris Lattner5506f8c2008-04-04 04:07:35 +00001068
Mike Stumpfc496822009-02-08 23:14:22 +00001069 /// LoadObjCSelf - Load the value of self. This function is only valid while
1070 /// generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +00001071 llvm::Value *LoadObjCSelf();
Mike Stumpfc496822009-02-08 23:14:22 +00001072
1073 /// TypeOfSelfObject - Return type of object that this self represents.
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001074 QualType TypeOfSelfObject();
Chris Lattner5696e7b2008-06-17 18:05:57 +00001075
Chris Lattner54fb19e2007-06-22 22:02:34 +00001076 /// hasAggregateLLVMType - Return true if the specified AST type will map into
1077 /// an aggregate LLVM type or is void.
1078 static bool hasAggregateLLVMType(QualType T);
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001079
1080 /// createBasicBlock - Create an LLVM basic block.
Mike Stumpfc496822009-02-08 23:14:22 +00001081 llvm::BasicBlock *createBasicBlock(const char *Name="",
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001082 llvm::Function *Parent=0,
1083 llvm::BasicBlock *InsertBefore=0) {
Daniel Dunbar851eec12008-11-12 00:01:12 +00001084#ifdef NDEBUG
Owen Anderson41a75022009-08-13 21:57:51 +00001085 return llvm::BasicBlock::Create(VMContext, "", Parent, InsertBefore);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001086#else
Owen Anderson41a75022009-08-13 21:57:51 +00001087 return llvm::BasicBlock::Create(VMContext, Name, Parent, InsertBefore);
Daniel Dunbar851eec12008-11-12 00:01:12 +00001088#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +00001089 }
Mike Stumpfc496822009-02-08 23:14:22 +00001090
Chris Lattnerac248202007-05-30 00:13:02 +00001091 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
1092 /// label maps to.
John McCallbd309292010-07-06 01:34:17 +00001093 JumpDest getJumpDestForLabel(const LabelStmt *S);
Mike Stumpfc496822009-02-08 23:14:22 +00001094
Mike Stumpe5311b02009-11-30 20:08:49 +00001095 /// SimplifyForwardingBlocks - If the given basic block is only a branch to
1096 /// another basic block, simplify it. This assumes that no other code could
1097 /// potentially reference the basic block.
Daniel Dunbarf77e2922009-04-01 04:37:47 +00001098 void SimplifyForwardingBlocks(llvm::BasicBlock *BB);
1099
Mike Stumpfc496822009-02-08 23:14:22 +00001100 /// EmitBlock - Emit the given block \arg BB and set it as the insert point,
1101 /// adding a fall-through branch from the current insert block if
1102 /// necessary. It is legal to call this function even if there is no current
1103 /// insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001104 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001105 /// IsFinished - If true, indicates that the caller has finished emitting
1106 /// branches to the given block and does not expect to emit code into it. This
1107 /// means the block can be ignored if it is unreachable.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +00001108 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +00001109
Mike Stumpfc496822009-02-08 23:14:22 +00001110 /// EmitBranch - Emit a branch to the specified basic block from the current
1111 /// insert block, taking care to avoid creation of branches from dummy
1112 /// blocks. It is legal to call this function even if there is no current
1113 /// insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +00001114 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001115 /// This function clears the current insertion point. The caller should follow
1116 /// calls to this function with calls to Emit*Block prior to generation new
1117 /// code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +00001118 void EmitBranch(llvm::BasicBlock *Block);
1119
Mike Stumpfc496822009-02-08 23:14:22 +00001120 /// HaveInsertPoint - True if an insertion point is defined. If not, this
1121 /// indicates that the current code being emitted is unreachable.
1122 bool HaveInsertPoint() const {
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001123 return Builder.GetInsertBlock() != 0;
1124 }
1125
Mike Stumpfc496822009-02-08 23:14:22 +00001126 /// EnsureInsertPoint - Ensure that an insertion point is defined so that
1127 /// emitted IR has a place to go. Note that by definition, if this function
1128 /// creates a block then that block is unreachable; callers may do better to
1129 /// detect when no insertion point is defined and simply skip IR generation.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001130 void EnsureInsertPoint() {
1131 if (!HaveInsertPoint())
1132 EmitBlock(createBasicBlock());
1133 }
Mike Stumpfc496822009-02-08 23:14:22 +00001134
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001135 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001136 /// specified stmt yet.
Daniel Dunbarf2cf6d12008-09-04 03:43:08 +00001137 void ErrorUnsupported(const Stmt *S, const char *Type,
1138 bool OmitOnError=false);
Chris Lattner84915fa2007-06-02 04:16:21 +00001139
Chris Lattnere9a64532007-06-22 21:44:33 +00001140 //===--------------------------------------------------------------------===//
1141 // Helpers
1142 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001143
Daniel Dunbar5c816372010-08-21 04:20:22 +00001144 LValue MakeAddrLValue(llvm::Value *V, QualType T, unsigned Alignment = 0) {
Dan Gohman947c9af2010-10-14 23:06:10 +00001145 return LValue::MakeAddr(V, T, Alignment, getContext(),
1146 CGM.getTBAAInfo(T));
Daniel Dunbar93b00a92010-08-21 02:53:44 +00001147 }
1148
Chris Lattnere9a64532007-06-22 21:44:33 +00001149 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
Daniel Dunbara7566f12010-02-09 02:48:28 +00001150 /// block. The caller is responsible for setting an appropriate alignment on
1151 /// the alloca.
Chris Lattnere9a64532007-06-22 21:44:33 +00001152 llvm::AllocaInst *CreateTempAlloca(const llvm::Type *Ty,
Daniel Dunbarb5aacc22009-10-19 01:21:05 +00001153 const llvm::Twine &Name = "tmp");
Mike Stumpfc496822009-02-08 23:14:22 +00001154
John McCall2e6567a2010-04-22 01:10:34 +00001155 /// InitTempAlloca - Provide an initial value for the given alloca.
1156 void InitTempAlloca(llvm::AllocaInst *Alloca, llvm::Value *Value);
1157
Daniel Dunbard0049182010-02-16 19:44:13 +00001158 /// CreateIRTemp - Create a temporary IR object of the given type, with
1159 /// appropriate alignment. This routine should only be used when an temporary
1160 /// value needs to be stored into an alloca (for example, to avoid explicit
1161 /// PHI construction), but the type is the IR type, not the type appropriate
1162 /// for storing in memory.
Chris Lattnerc401de92010-07-05 20:21:00 +00001163 llvm::AllocaInst *CreateIRTemp(QualType T, const llvm::Twine &Name = "tmp");
Daniel Dunbard0049182010-02-16 19:44:13 +00001164
Daniel Dunbara7566f12010-02-09 02:48:28 +00001165 /// CreateMemTemp - Create a temporary memory object of the given type, with
1166 /// appropriate alignment.
Chris Lattnerc401de92010-07-05 20:21:00 +00001167 llvm::AllocaInst *CreateMemTemp(QualType T, const llvm::Twine &Name = "tmp");
Daniel Dunbara7566f12010-02-09 02:48:28 +00001168
John McCall7a626f62010-09-15 10:14:12 +00001169 /// CreateAggTemp - Create a temporary memory object for the given
1170 /// aggregate type.
1171 AggValueSlot CreateAggTemp(QualType T, const llvm::Twine &Name = "tmp") {
1172 return AggValueSlot::forAddr(CreateMemTemp(T, Name), false, false);
1173 }
1174
Chris Lattner8394d792007-06-05 20:53:16 +00001175 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
1176 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +00001177 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +00001178
John McCalla2342eb2010-12-05 02:00:02 +00001179 /// EmitIgnoredExpr - Emit an expression in a context which ignores the result.
1180 void EmitIgnoredExpr(const Expr *E);
1181
Chris Lattner4647a212007-08-31 22:49:20 +00001182 /// EmitAnyExpr - Emit code to compute the specified expression which can have
1183 /// any type. The result is returned as an RValue struct. If this is an
1184 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
1185 /// the result should be returned.
Mike Stumpec3cbfe2009-05-26 22:03:21 +00001186 ///
1187 /// \param IgnoreResult - True if the resulting value isn't used.
John McCall7a626f62010-09-15 10:14:12 +00001188 RValue EmitAnyExpr(const Expr *E,
1189 AggValueSlot AggSlot = AggValueSlot::ignored(),
1190 bool IgnoreResult = false);
Devang Patel8ec4f832007-09-28 21:49:18 +00001191
Mike Stumpfc496822009-02-08 23:14:22 +00001192 // EmitVAListRef - Emit a "reference" to a va_list; this is either the address
1193 // or the value of the expression, depending on how va_list is defined.
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001194 llvm::Value *EmitVAListRef(const Expr *E);
1195
Mike Stumpfc496822009-02-08 23:14:22 +00001196 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result will
1197 /// always be accessible even if no aggregate location is provided.
John McCall7a626f62010-09-15 10:14:12 +00001198 RValue EmitAnyExprToTemp(const Expr *E);
Daniel Dunbar41cf9de2008-09-09 01:06:48 +00001199
John McCall21886962010-04-21 10:05:39 +00001200 /// EmitsAnyExprToMem - Emits the code necessary to evaluate an
1201 /// arbitrary expression into the given memory location.
1202 void EmitAnyExprToMem(const Expr *E, llvm::Value *Location,
John McCall7a626f62010-09-15 10:14:12 +00001203 bool IsLocationVolatile,
1204 bool IsInitializer);
John McCall21886962010-04-21 10:05:39 +00001205
Mike Stump5e9e61b2009-05-23 22:29:41 +00001206 /// EmitAggregateCopy - Emit an aggrate copy.
1207 ///
1208 /// \param isVolatile - True iff either the source or the destination is
1209 /// volatile.
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001210 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Mike Stump5e9e61b2009-05-23 22:29:41 +00001211 QualType EltTy, bool isVolatile=false);
Daniel Dunbar0bc8e862008-09-09 20:49:46 +00001212
Devang Patelda5d6bb2007-10-04 23:45:31 +00001213 /// StartBlock - Start new block named N. If insert block is a dummy block
1214 /// then reuse it.
1215 void StartBlock(const char *N);
1216
Lauro Ramos Venancio01a72ff2008-02-26 21:41:45 +00001217 /// GetAddrOfStaticLocalVar - Return the address of a static local variable.
John McCall5d865c322010-08-31 07:33:07 +00001218 llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD) {
1219 return cast<llvm::Constant>(GetAddrOfLocalVar(BVD));
1220 }
Dan Gohman75d69da2008-05-22 00:50:06 +00001221
Anders Carlsson9396a892008-09-11 09:15:33 +00001222 /// GetAddrOfLocalVar - Return the address of a local variable.
John McCall5d865c322010-08-31 07:33:07 +00001223 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD) {
1224 llvm::Value *Res = LocalDeclMap[VD];
1225 assert(Res && "Invalid argument to GetAddrOfLocalVar(), no decl!");
1226 return Res;
1227 }
Mike Stumpfc496822009-02-08 23:14:22 +00001228
Dan Gohman75d69da2008-05-22 00:50:06 +00001229 /// getAccessedFieldNo - Given an encoded value and a result number, return
1230 /// the input field number being accessed.
1231 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
1232
Chris Lattner6c4d2552009-10-28 23:59:40 +00001233 llvm::BlockAddress *GetAddrOfLabel(const LabelStmt *L);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001234 llvm::BasicBlock *GetIndirectGotoBlock();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001235
Anders Carlssonc0964b62010-05-22 17:35:42 +00001236 /// EmitNullInitialization - Generate code to set a value of the given type to
1237 /// null, If the type contains data member pointers, they will be initialized
1238 /// to -1 in accordance with the Itanium C++ ABI.
1239 void EmitNullInitialization(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001240
1241 // EmitVAArg - Generate code to get an argument from the passed in pointer
1242 // and update it accordingly. The return value is a pointer to the argument.
1243 // FIXME: We should be able to get rid of this method and use the va_arg
Mike Stumpfc496822009-02-08 23:14:22 +00001244 // instruction in LLVM instead once it works well enough.
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001245 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001246
Mike Stumpe5311b02009-11-30 20:08:49 +00001247 /// EmitVLASize - Generate code for any VLA size expressions that might occur
1248 /// in a variably modified type. If Ty is a VLA, will return the value that
1249 /// corresponds to the size in bytes of the VLA type. Will return 0 otherwise.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001250 ///
1251 /// This function can be called with a null (unreachable) insert point.
Anders Carlsson8a01b792008-12-20 20:46:34 +00001252 llvm::Value *EmitVLASize(QualType Ty);
Mike Stumpfc496822009-02-08 23:14:22 +00001253
Anders Carlssonccbe9202008-12-12 07:19:02 +00001254 // GetVLASize - Returns an LLVM value that corresponds to the size in bytes
1255 // of a variable length array type.
1256 llvm::Value *GetVLASize(const VariableArrayType *);
1257
Anders Carlssona5d077d2009-04-14 16:58:56 +00001258 /// LoadCXXThis - Load the value of 'this'. This function is only valid while
1259 /// generating code for an C++ member function.
John McCall347132b2010-02-16 22:04:33 +00001260 llvm::Value *LoadCXXThis() {
1261 assert(CXXThisValue && "no 'this' value for this function");
1262 return CXXThisValue;
1263 }
Mike Stump11289f42009-09-09 15:08:12 +00001264
Anders Carlssone36a6b32010-01-02 01:01:18 +00001265 /// LoadCXXVTT - Load the VTT parameter to base constructors/destructors have
1266 /// virtual bases.
John McCall347132b2010-02-16 22:04:33 +00001267 llvm::Value *LoadCXXVTT() {
1268 assert(CXXVTTValue && "no VTT value for this function");
1269 return CXXVTTValue;
1270 }
John McCall6ce74722010-02-16 04:15:37 +00001271
1272 /// GetAddressOfBaseOfCompleteClass - Convert the given pointer to a
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001273 /// complete class to the given direct base.
1274 llvm::Value *
1275 GetAddressOfDirectBaseInCompleteClass(llvm::Value *Value,
1276 const CXXRecordDecl *Derived,
1277 const CXXRecordDecl *Base,
1278 bool BaseIsVirtual);
Anders Carlssonbea9e742010-04-24 21:51:08 +00001279
Mike Stumpe5311b02009-11-30 20:08:49 +00001280 /// GetAddressOfBaseClass - This function will add the necessary delta to the
1281 /// load of 'this' and returns address of the base class.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001282 llvm::Value *GetAddressOfBaseClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001283 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001284 CastExpr::path_const_iterator PathBegin,
1285 CastExpr::path_const_iterator PathEnd,
Anders Carlssond829a022010-04-24 21:06:20 +00001286 bool NullCheckValue);
1287
Anders Carlsson8c793172009-11-23 17:57:54 +00001288 llvm::Value *GetAddressOfDerivedClass(llvm::Value *Value,
Anders Carlssonc4ba0cd2010-04-24 23:01:49 +00001289 const CXXRecordDecl *Derived,
John McCallcf142162010-08-07 06:22:56 +00001290 CastExpr::path_const_iterator PathBegin,
1291 CastExpr::path_const_iterator PathEnd,
Anders Carlsson8c793172009-11-23 17:57:54 +00001292 bool NullCheckValue);
1293
Anders Carlsson84673e22010-01-31 01:36:53 +00001294 llvm::Value *GetVirtualBaseClassOffset(llvm::Value *This,
1295 const CXXRecordDecl *ClassDecl,
1296 const CXXRecordDecl *BaseClassDecl);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001297
John McCallf8ff7b92010-02-23 00:48:20 +00001298 void EmitDelegateCXXConstructorCall(const CXXConstructorDecl *Ctor,
1299 CXXCtorType CtorType,
1300 const FunctionArgList &Args);
Anders Carlssone11f9ce2010-05-02 23:20:53 +00001301 void EmitCXXConstructorCall(const CXXConstructorDecl *D, CXXCtorType Type,
1302 bool ForVirtualBase, llvm::Value *This,
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001303 CallExpr::const_arg_iterator ArgBeg,
1304 CallExpr::const_arg_iterator ArgEnd);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001305
1306 void EmitSynthesizedCXXCopyCtorCall(const CXXConstructorDecl *D,
1307 llvm::Value *This, llvm::Value *Src,
1308 CallExpr::const_arg_iterator ArgBeg,
1309 CallExpr::const_arg_iterator ArgEnd);
Mike Stump11289f42009-09-09 15:08:12 +00001310
Fariborz Jahanian431c8832009-08-19 20:55:16 +00001311 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
Anders Carlssond49844b2009-09-23 02:45:36 +00001312 const ConstantArrayType *ArrayTy,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001313 llvm::Value *ArrayPtr,
1314 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001315 CallExpr::const_arg_iterator ArgEnd,
1316 bool ZeroInitialization = false);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001317
Anders Carlssond49844b2009-09-23 02:45:36 +00001318 void EmitCXXAggrConstructorCall(const CXXConstructorDecl *D,
1319 llvm::Value *NumElements,
Anders Carlsson3a202f62009-11-24 18:43:52 +00001320 llvm::Value *ArrayPtr,
1321 CallExpr::const_arg_iterator ArgBeg,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001322 CallExpr::const_arg_iterator ArgEnd,
1323 bool ZeroInitialization = false);
Anders Carlssonb7f8f592009-04-17 00:06:03 +00001324
Fariborz Jahanian9c837202009-08-20 20:54:15 +00001325 void EmitCXXAggrDestructorCall(const CXXDestructorDecl *D,
1326 const ArrayType *Array,
1327 llvm::Value *This);
Mike Stump11289f42009-09-09 15:08:12 +00001328
Fariborz Jahanian6814eaa2009-11-13 19:27:47 +00001329 void EmitCXXAggrDestructorCall(const CXXDestructorDecl *D,
1330 llvm::Value *NumElements,
1331 llvm::Value *This);
1332
Anders Carlsson165ec0a2010-06-08 22:14:59 +00001333 llvm::Function *GenerateCXXAggrDestructorHelper(const CXXDestructorDecl *D,
1334 const ArrayType *Array,
1335 llvm::Value *This);
Fariborz Jahanian1254a092009-11-10 19:24:06 +00001336
Anders Carlsson0a637412009-05-29 21:03:38 +00001337 void EmitCXXDestructorCall(const CXXDestructorDecl *D, CXXDtorType Type,
Anders Carlssonf8a71f02010-05-02 23:29:11 +00001338 bool ForVirtualBase, llvm::Value *This);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001339
Fariborz Jahaniand5202e02010-06-25 18:26:07 +00001340 void EmitNewArrayInitializer(const CXXNewExpr *E, llvm::Value *NewPtr,
1341 llvm::Value *NumElements);
Mike Stump11289f42009-09-09 15:08:12 +00001342
John McCallbd309292010-07-06 01:34:17 +00001343 void EmitCXXTemporary(const CXXTemporary *Temporary, llvm::Value *Ptr);
Mike Stump11289f42009-09-09 15:08:12 +00001344
Anders Carlsson4a7b49b2009-05-31 01:40:14 +00001345 llvm::Value *EmitCXXNewExpr(const CXXNewExpr *E);
Anders Carlsson81f0df92009-08-16 21:13:42 +00001346 void EmitCXXDeleteExpr(const CXXDeleteExpr *E);
Mike Stump11289f42009-09-09 15:08:12 +00001347
Eli Friedman24f55432009-11-18 00:57:03 +00001348 void EmitDeleteCall(const FunctionDecl *DeleteFD, llvm::Value *Ptr,
1349 QualType DeleteTy);
1350
Mike Stumpc9b231c2009-11-15 08:09:41 +00001351 llvm::Value* EmitCXXTypeidExpr(const CXXTypeidExpr *E);
Mike Stump65511702009-11-16 06:50:58 +00001352 llvm::Value *EmitDynamicCast(llvm::Value *V, const CXXDynamicCastExpr *DCE);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001353
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001354 void EmitCheck(llvm::Value *, unsigned Size);
1355
Chris Lattner116ce8f2010-01-09 21:40:03 +00001356 llvm::Value *EmitScalarPrePostIncDec(const UnaryOperator *E, LValue LV,
1357 bool isInc, bool isPre);
1358 ComplexPairTy EmitComplexPrePostIncDec(const UnaryOperator *E, LValue LV,
1359 bool isInc, bool isPre);
Chris Lattner8394d792007-06-05 20:53:16 +00001360 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +00001361 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +00001362 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001363
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001364 /// EmitDecl - Emit a declaration.
1365 ///
1366 /// This function can be called with a null (unreachable) insert point.
Chris Lattner1ad38f82007-06-09 01:20:56 +00001367 void EmitDecl(const Decl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001368
John McCall1c9c3fd2010-10-15 04:57:14 +00001369 /// EmitVarDecl - Emit a local variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001370 ///
1371 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001372 void EmitVarDecl(const VarDecl &D);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001373
John McCallbd309292010-07-06 01:34:17 +00001374 typedef void SpecialInitFn(CodeGenFunction &Init, const VarDecl &D,
1375 llvm::Value *Address);
1376
John McCall1c9c3fd2010-10-15 04:57:14 +00001377 /// EmitAutoVarDecl - Emit an auto variable declaration.
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001378 ///
1379 /// This function can be called with a null (unreachable) insert point.
John McCall1c9c3fd2010-10-15 04:57:14 +00001380 void EmitAutoVarDecl(const VarDecl &D, SpecialInitFn *SpecialInit = 0);
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001381
John McCall1c9c3fd2010-10-15 04:57:14 +00001382 void EmitStaticVarDecl(const VarDecl &D,
1383 llvm::GlobalValue::LinkageTypes Linkage);
Daniel Dunbara94ecd22008-08-16 03:19:19 +00001384
1385 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
1386 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg);
Mike Stumpfc496822009-02-08 23:14:22 +00001387
Chris Lattner84915fa2007-06-02 04:16:21 +00001388 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +00001389 // Statement Emission
1390 //===--------------------------------------------------------------------===//
1391
Mike Stumpfc496822009-02-08 23:14:22 +00001392 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug info.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001393 void EmitStopPoint(const Stmt *S);
1394
Mike Stumpfc496822009-02-08 23:14:22 +00001395 /// EmitStmt - Emit the code for the statement \arg S. It is legal to call
1396 /// this function even if there is no current insertion point.
1397 ///
1398 /// This function may clear the current insertion point; callers should use
1399 /// EnsureInsertPoint if they wish to subsequently generate code without first
1400 /// calling EmitBlock, EmitBranch, or EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +00001401 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001402
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001403 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
Mike Stumpfc496822009-02-08 23:14:22 +00001404 /// necessarily require an insertion point or debug information; typically
1405 /// because the statement amounts to a jump or a container of other
1406 /// statements.
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001407 ///
1408 /// \return True if the statement was handled.
1409 bool EmitSimpleStmt(const Stmt *S);
1410
Chris Lattner4647a212007-08-31 22:49:20 +00001411 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
John McCall7a626f62010-09-15 10:14:12 +00001412 AggValueSlot AVS = AggValueSlot::ignored());
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001413
Mike Stumpfc496822009-02-08 23:14:22 +00001414 /// EmitLabel - Emit the block for the given label. It is legal to call this
1415 /// function even if there is no current insertion point.
Chris Lattner7e800972008-07-26 20:23:23 +00001416 void EmitLabel(const LabelStmt &S); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +00001417
Chris Lattnerac248202007-05-30 00:13:02 +00001418 void EmitLabelStmt(const LabelStmt &S);
1419 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001420 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +00001421 void EmitIfStmt(const IfStmt &S);
Chris Lattner946aa312007-06-05 03:59:43 +00001422 void EmitWhileStmt(const WhileStmt &S);
Chris Lattner8394d792007-06-05 20:53:16 +00001423 void EmitDoStmt(const DoStmt &S);
1424 void EmitForStmt(const ForStmt &S);
Chris Lattner3f3dbee2007-06-02 03:19:07 +00001425 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +00001426 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +00001427 void EmitBreakStmt(const BreakStmt &S);
1428 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +00001429 void EmitSwitchStmt(const SwitchStmt &S);
1430 void EmitDefaultStmt(const DefaultStmt &S);
1431 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +00001432 void EmitCaseStmtRange(const CaseStmt &S);
Anders Carlsson952a9952008-02-05 16:35:33 +00001433 void EmitAsmStmt(const AsmStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001434
Anders Carlsson2e744e82008-08-30 19:51:14 +00001435 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +00001436 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
1437 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +00001438 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
Mike Stumpfc496822009-02-08 23:14:22 +00001439
Douglas Gregor51150ab2010-05-16 01:24:12 +00001440 llvm::Constant *getUnwindResumeOrRethrowFn();
John McCallb609d3f2010-07-07 06:56:46 +00001441 void EnterCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
1442 void ExitCXXTryStmt(const CXXTryStmt &S, bool IsFnTryBlock = false);
John McCallb81884d2010-02-19 09:25:03 +00001443
Anders Carlsson52d78a52009-09-27 18:58:34 +00001444 void EmitCXXTryStmt(const CXXTryStmt &S);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001445
Chris Lattner208ae962007-05-30 17:57:17 +00001446 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +00001447 // LValue Expression Emission
1448 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +00001449
Daniel Dunbarc79407f2009-02-05 07:09:07 +00001450 /// GetUndefRValue - Get an appropriate 'undef' rvalue for the given type.
1451 RValue GetUndefRValue(QualType Ty);
1452
Daniel Dunbarbb197e42009-01-09 16:50:52 +00001453 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
1454 /// and issue an ErrorUnsupported style diagnostic (using the
1455 /// provided Name).
1456 RValue EmitUnsupportedRValue(const Expr *E,
1457 const char *Name);
1458
Mike Stumpfc496822009-02-08 23:14:22 +00001459 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E and issue
1460 /// an ErrorUnsupported style diagnostic (using the provided Name).
Daniel Dunbarf2e69882008-08-25 20:45:57 +00001461 LValue EmitUnsupportedLValue(const Expr *E,
1462 const char *Name);
1463
Chris Lattner8394d792007-06-05 20:53:16 +00001464 /// EmitLValue - Emit code to compute a designator that specifies the location
1465 /// of the expression.
1466 ///
1467 /// This can return one of two things: a simple address or a bitfield
1468 /// reference. In either case, the LLVM Value* in the LValue structure is
1469 /// guaranteed to be an LLVM pointer type.
1470 ///
1471 /// If this returns a bitfield reference, nothing about the pointee type of
1472 /// the LLVM value is known: For example, it may not be a pointer to an
1473 /// integer.
1474 ///
1475 /// If this returns a normal address, and if the lvalue's C type is fixed
1476 /// size, this method guarantees that the returned pointer type will point to
1477 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
1478 /// variable length type, this is not possible.
1479 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +00001480 LValue EmitLValue(const Expr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00001481
Mike Stump3f6f9fe2009-12-16 02:57:00 +00001482 /// EmitCheckedLValue - Same as EmitLValue but additionally we generate
1483 /// checking code to guard against undefined behavior. This is only
1484 /// suitable when we know that the address will be used to access the
1485 /// object.
1486 LValue EmitCheckedLValue(const Expr *E);
1487
John McCall3a7f6922010-10-27 20:58:56 +00001488 /// EmitToMemory - Change a scalar value from its value
1489 /// representation to its in-memory representation.
1490 llvm::Value *EmitToMemory(llvm::Value *Value, QualType Ty);
1491
1492 /// EmitFromMemory - Change a scalar value from its memory
1493 /// representation to its value representation.
1494 llvm::Value *EmitFromMemory(llvm::Value *Value, QualType Ty);
1495
Daniel Dunbar1d425462009-02-10 00:57:50 +00001496 /// EmitLoadOfScalar - Load a scalar value from an address, taking
1497 /// care to appropriately convert from the memory representation to
1498 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001499 llvm::Value *EmitLoadOfScalar(llvm::Value *Addr, bool Volatile,
Dan Gohman947c9af2010-10-14 23:06:10 +00001500 unsigned Alignment, QualType Ty,
1501 llvm::MDNode *TBAAInfo = 0);
Daniel Dunbar1d425462009-02-10 00:57:50 +00001502
1503 /// EmitStoreOfScalar - Store a scalar value to an address, taking
1504 /// care to appropriately convert from the memory representation to
1505 /// the LLVM value representation.
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001506 void EmitStoreOfScalar(llvm::Value *Value, llvm::Value *Addr,
Dan Gohman947c9af2010-10-14 23:06:10 +00001507 bool Volatile, unsigned Alignment, QualType Ty,
1508 llvm::MDNode *TBAAInfo = 0);
Daniel Dunbar1d425462009-02-10 00:57:50 +00001509
Chris Lattner8394d792007-06-05 20:53:16 +00001510 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
1511 /// this method emits the address of the lvalue, then loads the result as an
1512 /// rvalue, returning the rvalue.
Chris Lattner9369a562007-06-29 16:31:29 +00001513 RValue EmitLoadOfLValue(LValue V, QualType LVType);
Nate Begemance4d7fc2008-04-18 23:10:10 +00001514 RValue EmitLoadOfExtVectorElementLValue(LValue V, QualType LVType);
Lauro Ramos Venancio2ddcb25a32008-01-22 20:17:04 +00001515 RValue EmitLoadOfBitfieldLValue(LValue LV, QualType ExprType);
John McCallf3eb96f2010-12-04 02:32:38 +00001516 RValue EmitLoadOfPropertyRefLValue(LValue LV,
1517 ReturnValueSlot Return = ReturnValueSlot());
Mike Stumpfc496822009-02-08 23:14:22 +00001518
Chris Lattner8394d792007-06-05 20:53:16 +00001519 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
1520 /// lvalue, where both are guaranteed to the have the same type, and that type
1521 /// is 'Ty'.
1522 void EmitStoreThroughLValue(RValue Src, LValue Dst, QualType Ty);
Nate Begemance4d7fc2008-04-18 23:10:10 +00001523 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst,
1524 QualType Ty);
John McCallf3eb96f2010-12-04 02:32:38 +00001525 void EmitStoreThroughPropertyRefLValue(RValue Src, LValue Dst);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00001526
Mike Stumpfc496822009-02-08 23:14:22 +00001527 /// EmitStoreThroughLValue - Store Src into Dst with same constraints as
1528 /// EmitStoreThroughLValue.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00001529 ///
Mike Stumpfc496822009-02-08 23:14:22 +00001530 /// \param Result [out] - If non-null, this will be set to a Value* for the
1531 /// bit-field contents after the store, appropriate for use as the result of
1532 /// an assignment to the bit-field.
Daniel Dunbar9b1335e2008-11-19 09:36:46 +00001533 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst, QualType Ty,
1534 llvm::Value **Result=0);
Mike Stumpfc496822009-02-08 23:14:22 +00001535
John McCall4f29b492010-11-16 23:07:28 +00001536 /// Emit an l-value for an assignment (simple or compound) of complex type.
1537 LValue EmitComplexAssignmentLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00001538 LValue EmitComplexCompoundAssignmentLValue(const CompoundAssignOperator *E);
John McCall4f29b492010-11-16 23:07:28 +00001539
Christopher Lambd91c3d42007-12-29 05:02:41 +00001540 // Note: only availabe for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +00001541 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
John McCalla2342eb2010-12-05 02:00:02 +00001542 LValue EmitCompoundAssignmentLValue(const CompoundAssignOperator *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00001543 // Note: only available for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +00001544 LValue EmitCallExprLValue(const CallExpr *E);
Daniel Dunbar8d9dc4a2009-02-11 20:59:32 +00001545 // Note: only available for agg return types
1546 LValue EmitVAArgExprLValue(const VAArgExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +00001547 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +00001548 LValue EmitStringLiteralLValue(const StringLiteral *E);
Chris Lattnerd7e7b8e2009-02-24 22:18:39 +00001549 LValue EmitObjCEncodeExprLValue(const ObjCEncodeExpr *E);
Chris Lattner6307f192008-08-10 01:53:14 +00001550 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00001551 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Chris Lattnerd9d2fb12007-06-08 23:31:14 +00001552 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
Nate Begemance4d7fc2008-04-18 23:10:10 +00001553 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +00001554 LValue EmitMemberExpr(const MemberExpr *E);
Fariborz Jahanian531c16f2009-12-09 23:35:29 +00001555 LValue EmitObjCIsaExpr(const ObjCIsaExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +00001556 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Anders Carlsson1450adb2009-09-15 16:35:24 +00001557 LValue EmitConditionalOperatorLValue(const ConditionalOperator *E);
Chris Lattner28bcf1a2009-03-18 18:28:57 +00001558 LValue EmitCastLValue(const CastExpr *E);
Douglas Gregor747eb782010-07-08 06:14:04 +00001559 LValue EmitNullInitializationLValue(const CXXScalarValueInitExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001560
Daniel Dunbar722f4242009-04-22 05:08:15 +00001561 llvm::Value *EmitIvarOffset(const ObjCInterfaceDecl *Interface,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00001562 const ObjCIvarDecl *Ivar);
John McCallc4094932010-05-21 01:18:57 +00001563 LValue EmitLValueForAnonRecordField(llvm::Value* Base,
Francois Pichetd583da02010-12-04 09:14:42 +00001564 const IndirectFieldDecl* Field,
John McCallc4094932010-05-21 01:18:57 +00001565 unsigned CVRQualifiers);
Anders Carlssoncfd30122009-11-17 03:57:07 +00001566 LValue EmitLValueForField(llvm::Value* Base, const FieldDecl* Field,
Anders Carlsson5d8645b2010-01-29 05:05:36 +00001567 unsigned CVRQualifiers);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001568
Anders Carlssondb78f0a2010-01-29 05:24:29 +00001569 /// EmitLValueForFieldInitialization - Like EmitLValueForField, except that
1570 /// if the Field is a reference, this will return the address of the reference
1571 /// and not the address of the value stored in the reference.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001572 LValue EmitLValueForFieldInitialization(llvm::Value* Base,
Anders Carlssondb78f0a2010-01-29 05:24:29 +00001573 const FieldDecl* Field,
1574 unsigned CVRQualifiers);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001575
Fariborz Jahanianc88a70d2009-02-03 00:09:52 +00001576 LValue EmitLValueForIvar(QualType ObjectTy,
1577 llvm::Value* Base, const ObjCIvarDecl *Ivar,
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00001578 unsigned CVRQualifiers);
1579
Anders Carlssoncfd30122009-11-17 03:57:07 +00001580 LValue EmitLValueForBitfield(llvm::Value* Base, const FieldDecl* Field,
Fariborz Jahanian712bfa62009-02-03 19:03:09 +00001581 unsigned CVRQualifiers);
Fariborz Jahanianb517e902008-12-15 20:35:07 +00001582
Mike Stump1db7d042009-02-28 09:07:16 +00001583 LValue EmitBlockDeclRefLValue(const BlockDeclRefExpr *E);
1584
Anders Carlsson3be22e22009-05-30 23:23:33 +00001585 LValue EmitCXXConstructLValue(const CXXConstructExpr *E);
Anders Carlssonfd2af0c2009-05-30 23:30:54 +00001586 LValue EmitCXXBindTemporaryLValue(const CXXBindTemporaryExpr *E);
John McCall5d413782010-12-06 08:20:24 +00001587 LValue EmitExprWithCleanupsLValue(const ExprWithCleanups *E);
Mike Stumpc9b231c2009-11-15 08:09:41 +00001588 LValue EmitCXXTypeidLValue(const CXXTypeidExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001589
Daniel Dunbarc8317a42008-08-23 10:51:21 +00001590 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +00001591 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Daniel Dunbar9e22c0d2008-08-29 08:11:39 +00001592 LValue EmitObjCPropertyRefLValue(const ObjCPropertyRefExpr *E);
Chris Lattnera4185c52009-04-25 19:35:26 +00001593 LValue EmitStmtExprLValue(const StmtExpr *E);
Fariborz Jahanianffba6622009-10-22 22:57:31 +00001594 LValue EmitPointerToDataMemberBinaryExpr(const BinaryOperator *E);
Fariborz Jahanian9240f3d2010-06-17 19:56:20 +00001595 LValue EmitObjCSelectorLValue(const ObjCSelectorExpr *E);
John McCalla2fabff2010-10-09 01:34:31 +00001596 void EmitDeclRefExprDbgValue(const DeclRefExpr *E, llvm::Constant *Init);
Chris Lattnerd7f58862007-06-02 05:24:33 +00001597 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +00001598 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +00001599 //===--------------------------------------------------------------------===//
1600
Mike Stumpfc496822009-02-08 23:14:22 +00001601 /// EmitCall - Generate a call of the given function, expecting the given
1602 /// result type, and using the given argument list which specifies both the
1603 /// LLVM arguments and the types they were derived from.
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00001604 ///
Mike Stumpe5311b02009-11-30 20:08:49 +00001605 /// \param TargetDecl - If given, the decl of the function in a direct call;
1606 /// used to set attributes on the call (noreturn, etc.).
Daniel Dunbard931a872009-02-02 22:03:45 +00001607 RValue EmitCall(const CGFunctionInfo &FnInfo,
1608 llvm::Value *Callee,
Anders Carlsson61a401c2009-12-24 19:25:24 +00001609 ReturnValueSlot ReturnValue,
Daniel Dunbarcdbb5e32009-02-20 18:06:48 +00001610 const CallArgList &Args,
David Chisnall9eecafa2010-05-01 11:15:56 +00001611 const Decl *TargetDecl = 0,
David Chisnallff5f88c2010-05-02 13:41:58 +00001612 llvm::Instruction **callOrInvoke = 0);
Mike Stump11289f42009-09-09 15:08:12 +00001613
Anders Carlsson0435ed52009-12-24 19:08:58 +00001614 RValue EmitCall(QualType FnType, llvm::Value *Callee,
Anders Carlsson17490832009-12-24 20:40:36 +00001615 ReturnValueSlot ReturnValue,
Anders Carlsson3a9463b2009-05-27 01:22:39 +00001616 CallExpr::const_arg_iterator ArgBeg,
1617 CallExpr::const_arg_iterator ArgEnd,
1618 const Decl *TargetDecl = 0);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001619 RValue EmitCallExpr(const CallExpr *E,
Anders Carlsson17490832009-12-24 20:40:36 +00001620 ReturnValueSlot ReturnValue = ReturnValueSlot());
Mike Stump11289f42009-09-09 15:08:12 +00001621
John McCallbd309292010-07-06 01:34:17 +00001622 llvm::CallSite EmitCallOrInvoke(llvm::Value *Callee,
1623 llvm::Value * const *ArgBegin,
1624 llvm::Value * const *ArgEnd,
1625 const llvm::Twine &Name = "");
1626
Anders Carlssone828c362009-11-13 04:45:41 +00001627 llvm::Value *BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
Mike Stumpa5588bf2009-08-26 20:46:33 +00001628 const llvm::Type *Ty);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001629 llvm::Value *BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
Anders Carlsson3378d872010-11-28 17:53:32 +00001630 llvm::Value *This, const llvm::Type *Ty);
Fariborz Jahanian47609b02011-01-20 17:19:02 +00001631 llvm::Value *BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
1632 NestedNameSpecifier *Qual,
1633 llvm::Value *This,
1634 const llvm::Type *Ty);
Anders Carlssone828c362009-11-13 04:45:41 +00001635
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00001636 RValue EmitCXXMemberCall(const CXXMethodDecl *MD,
1637 llvm::Value *Callee,
Anders Carlssonbfb36712009-12-24 21:13:40 +00001638 ReturnValueSlot ReturnValue,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00001639 llvm::Value *This,
Anders Carlssone36a6b32010-01-02 01:01:18 +00001640 llvm::Value *VTT,
Anders Carlssonbd7d11f2009-05-11 23:37:08 +00001641 CallExpr::const_arg_iterator ArgBeg,
1642 CallExpr::const_arg_iterator ArgEnd);
Anders Carlssonbfb36712009-12-24 21:13:40 +00001643 RValue EmitCXXMemberCallExpr(const CXXMemberCallExpr *E,
1644 ReturnValueSlot ReturnValue);
1645 RValue EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
1646 ReturnValueSlot ReturnValue);
Ted Kremenek08e17112008-06-17 02:43:46 +00001647
Anders Carlsson4034a952009-05-27 04:18:27 +00001648 RValue EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
Anders Carlssonbfb36712009-12-24 21:13:40 +00001649 const CXXMethodDecl *MD,
1650 ReturnValueSlot ReturnValue);
Mike Stump11289f42009-09-09 15:08:12 +00001651
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001652
Mike Stump11289f42009-09-09 15:08:12 +00001653 RValue EmitBuiltinExpr(const FunctionDecl *FD,
Daniel Dunbar8eb018a2009-02-16 22:43:43 +00001654 unsigned BuiltinID, const CallExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +00001655
Anders Carlssonbfb36712009-12-24 21:13:40 +00001656 RValue EmitBlockCallExpr(const CallExpr *E, ReturnValueSlot ReturnValue);
Mike Stumpc6ea7c12009-02-17 17:00:02 +00001657
Mike Stumpfc496822009-02-08 23:14:22 +00001658 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0 if the call
1659 /// is unhandled by the current target.
Daniel Dunbareca513d2008-10-10 00:24:54 +00001660 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
1661
Chris Lattner5cc15e02010-03-03 19:03:45 +00001662 llvm::Value *EmitARMBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001663 llvm::Value *EmitNeonCall(llvm::Function *F,
Nate Begemanae6b1d82010-06-08 06:03:01 +00001664 llvm::SmallVectorImpl<llvm::Value*> &O,
Bob Wilson482afae2010-12-08 22:37:56 +00001665 const char *name,
Nate Begeman91e1fea2010-06-14 05:21:25 +00001666 unsigned shift = 0, bool rightshift = false);
Bob Wilson210f6dd2010-12-07 22:40:02 +00001667 llvm::Value *EmitNeonSplat(llvm::Value *V, llvm::Constant *Idx);
Nate Begeman8ed060b2010-06-11 22:57:12 +00001668 llvm::Value *EmitNeonShiftVector(llvm::Value *V, const llvm::Type *Ty,
Nate Begeman91e1fea2010-06-14 05:21:25 +00001669 bool negateForRightShift);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001670
Bill Wendling65b2a962010-10-09 08:47:25 +00001671 llvm::Value *BuildVector(const llvm::SmallVectorImpl<llvm::Value*> &Ops);
Anders Carlsson895af082007-12-09 23:17:02 +00001672 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
1673 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Mike Stumpfc496822009-02-08 23:14:22 +00001674
Daniel Dunbar66912a12008-08-20 00:28:19 +00001675 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +00001676 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Chris Lattnerb1d329d2008-06-24 17:04:18 +00001677 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
John McCall78a15112010-05-22 01:48:05 +00001678 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E,
1679 ReturnValueSlot Return = ReturnValueSlot());
Chris Lattnerb1d329d2008-06-24 17:04:18 +00001680
Anders Carlsson6f5a0152009-05-20 00:24:07 +00001681 /// EmitReferenceBindingToExpr - Emits a reference binding to the passed in
1682 /// expression. Will emit a temporary variable if E is not an LValue.
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001683 RValue EmitReferenceBindingToExpr(const Expr* E,
Anders Carlsson04775f82010-06-26 16:35:32 +00001684 const NamedDecl *InitializedDecl);
Anders Carlssonab0ddb52010-01-31 18:34:51 +00001685
Chris Lattner6278e6a2007-08-11 00:04:45 +00001686 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00001687 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +00001688 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +00001689
1690 // Expressions are broken into three classes: scalar, complex, aggregate.
Mike Stumpfc496822009-02-08 23:14:22 +00001691
1692 /// EmitScalarExpr - Emit the computation of the specified expression of LLVM
1693 /// scalar type, returning the result.
Anders Carlsson5b106a72009-08-16 07:36:22 +00001694 llvm::Value *EmitScalarExpr(const Expr *E , bool IgnoreResultAssign = false);
Mike Stumpfc496822009-02-08 23:14:22 +00001695
Chris Lattner3474c202007-08-26 06:48:56 +00001696 /// EmitScalarConversion - Emit a conversion from the specified type to the
1697 /// specified destination type, both of which are LLVM scalar types.
1698 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
1699 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00001700
Chris Lattner42e6b812007-08-26 16:34:22 +00001701 /// EmitComplexToScalarConversion - Emit a conversion from the specified
Mike Stumpfc496822009-02-08 23:14:22 +00001702 /// complex type to the specified destination type, where the destination type
1703 /// is an LLVM scalar type.
Chris Lattner42e6b812007-08-26 16:34:22 +00001704 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
1705 QualType DstTy);
Mike Stumpfc496822009-02-08 23:14:22 +00001706
1707
John McCall7a626f62010-09-15 10:14:12 +00001708 /// EmitAggExpr - Emit the computation of the specified expression
1709 /// of aggregate type. The result is computed into the given slot,
1710 /// which may be null to indicate that the value is not needed.
Fariborz Jahanianb60e70f2010-09-16 00:20:07 +00001711 void EmitAggExpr(const Expr *E, AggValueSlot AS, bool IgnoreResult = false);
Mike Stumpfc496822009-02-08 23:14:22 +00001712
Daniel Dunbard0bc7b92010-02-05 19:38:31 +00001713 /// EmitAggExprToLValue - Emit the computation of the specified expression of
1714 /// aggregate type into a temporary LValue.
1715 LValue EmitAggExprToLValue(const Expr *E);
1716
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00001717 /// EmitGCMemmoveCollectable - Emit special API for structs with object
1718 /// pointers.
1719 void EmitGCMemmoveCollectable(llvm::Value *DestPtr, llvm::Value *SrcPtr,
Fariborz Jahanian879d7262009-08-31 19:33:16 +00001720 QualType Ty);
Fariborz Jahanian5f21d2f2009-07-08 01:18:33 +00001721
Chris Lattnercbfc73b2007-08-21 05:54:00 +00001722 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +00001723 /// complex type, returning the result.
John McCall07bb1962010-11-16 10:08:07 +00001724 ComplexPairTy EmitComplexExpr(const Expr *E,
1725 bool IgnoreReal = false,
1726 bool IgnoreImag = false);
Mike Stumpfc496822009-02-08 23:14:22 +00001727
Chris Lattner08b15df2007-08-23 23:43:33 +00001728 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
1729 /// of complex type, storing into the specified Value*.
Chris Lattnerb84bb952007-08-26 16:22:13 +00001730 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
1731 bool DestIsVolatile);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +00001732
1733 /// StoreComplexToAddr - Store a complex number into the specified address.
1734 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
1735 bool DestIsVolatile);
Chris Lattner4647a212007-08-31 22:49:20 +00001736 /// LoadComplexFromAddr - Load a complex number from the specified address.
1737 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
Chris Lattnerb781dc792008-05-08 05:58:21 +00001738
John McCall1c9c3fd2010-10-15 04:57:14 +00001739 /// CreateStaticVarDecl - Create a zero-initialized LLVM global for
1740 /// a static local variable.
1741 llvm::GlobalVariable *CreateStaticVarDecl(const VarDecl &D,
1742 const char *Separator,
Mike Stumpe5311b02009-11-30 20:08:49 +00001743 llvm::GlobalValue::LinkageTypes Linkage);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001744
John McCall1c9c3fd2010-10-15 04:57:14 +00001745 /// AddInitializerToStaticVarDecl - Add the initializer for 'D' to the
Chris Lattnere99c1102009-12-05 08:22:11 +00001746 /// global variable that has already been created for it. If the initializer
1747 /// has a different type than GV does, this may free GV and return a different
1748 /// one. Otherwise it just returns GV.
1749 llvm::GlobalVariable *
John McCall1c9c3fd2010-10-15 04:57:14 +00001750 AddInitializerToStaticVarDecl(const VarDecl &D,
1751 llvm::GlobalVariable *GV);
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001752
Daniel Dunbar22a87f92009-02-25 19:24:29 +00001753
Anders Carlssonf40886a2009-08-08 21:45:14 +00001754 /// EmitCXXGlobalVarDeclInit - Create the initializer for a C++
1755 /// variable with global storage.
1756 void EmitCXXGlobalVarDeclInit(const VarDecl &D, llvm::Constant *DeclPtr);
1757
1758 /// EmitCXXGlobalDtorRegistration - Emits a call to register the global ptr
1759 /// with the C++ runtime so that its destructor will be called at exit.
Fariborz Jahanian1254a092009-11-10 19:24:06 +00001760 void EmitCXXGlobalDtorRegistration(llvm::Constant *DtorFn,
Anders Carlssonf40886a2009-08-08 21:45:14 +00001761 llvm::Constant *DeclPtr);
Mike Stump11289f42009-09-09 15:08:12 +00001762
John McCallcdf7ef52010-11-06 09:44:32 +00001763 /// Emit code in this function to perform a guarded variable
1764 /// initialization. Guarded initializations are used when it's not
1765 /// possible to prove that an initialization will be done exactly
1766 /// once, e.g. with a static local variable or a static data member
1767 /// of a class template.
1768 void EmitCXXGuardedInit(const VarDecl &D, llvm::GlobalVariable *DeclPtr);
John McCall68ff0372010-09-08 01:44:27 +00001769
Daniel Dunbarfe06df42010-03-20 04:15:41 +00001770 /// GenerateCXXGlobalInitFunc - Generates code for initializing global
1771 /// variables.
1772 void GenerateCXXGlobalInitFunc(llvm::Function *Fn,
1773 llvm::Constant **Decls,
1774 unsigned NumDecls);
1775
1776 /// GenerateCXXGlobalDtorFunc - Generates code for destroying global
1777 /// variables.
1778 void GenerateCXXGlobalDtorFunc(llvm::Function *Fn,
Chris Lattner87233f72010-06-19 05:52:45 +00001779 const std::vector<std::pair<llvm::WeakVH,
Daniel Dunbarfe06df42010-03-20 04:15:41 +00001780 llvm::Constant*> > &DtorsAndObjects);
1781
John McCallcdf7ef52010-11-06 09:44:32 +00001782 void GenerateCXXGlobalVarDeclInitFunc(llvm::Function *Fn, const VarDecl *D,
1783 llvm::GlobalVariable *Addr);
Daniel Dunbarfe06df42010-03-20 04:15:41 +00001784
John McCall7a626f62010-09-15 10:14:12 +00001785 void EmitCXXConstructExpr(const CXXConstructExpr *E, AggValueSlot Dest);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001786
1787 void EmitSynthesizedCXXCopyCtor(llvm::Value *Dest, llvm::Value *Src,
Fariborz Jahanian50198092010-12-02 17:02:11 +00001788 const Expr *Exp);
Mike Stump11289f42009-09-09 15:08:12 +00001789
John McCall5d413782010-12-06 08:20:24 +00001790 RValue EmitExprWithCleanups(const ExprWithCleanups *E,
1791 AggValueSlot Slot =AggValueSlot::ignored());
Mike Stump11289f42009-09-09 15:08:12 +00001792
Anders Carlsson4b08db72009-10-30 01:42:31 +00001793 void EmitCXXThrowExpr(const CXXThrowExpr *E);
Douglas Gregorc278d1b2010-05-16 00:44:00 +00001794
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001795 //===--------------------------------------------------------------------===//
1796 // Internal Helpers
1797 //===--------------------------------------------------------------------===//
Mike Stumpfc496822009-02-08 23:14:22 +00001798
Chris Lattner5b1964b2008-11-11 07:41:27 +00001799 /// ContainsLabel - Return true if the statement contains a label in it. If
1800 /// this statement is not executed normally, it not containing a label means
1801 /// that we can just remove the code.
1802 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
Mike Stumpfc496822009-02-08 23:14:22 +00001803
Daniel Dunbar682712c2008-11-12 10:12:14 +00001804 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattnercd439292008-11-12 08:04:58 +00001805 /// to a constant, or if it does but contains a label, return 0. If it
1806 /// constant folds to 'true' and does not contain a label, return 1, if it
1807 /// constant folds to 'false' and does not contain a label, return -1.
1808 int ConstantFoldsToSimpleInteger(const Expr *Cond);
Mike Stumpfc496822009-02-08 23:14:22 +00001809
Chris Lattnercd439292008-11-12 08:04:58 +00001810 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
1811 /// if statement) to the specified blocks. Based on the condition, this might
1812 /// try to simplify the codegen of the conditional based on the branch.
Chris Lattnerb7a9e162008-11-12 07:46:33 +00001813 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar682712c2008-11-12 10:12:14 +00001814 llvm::BasicBlock *FalseBlock);
Mike Stumpba6a0c42009-12-14 21:58:14 +00001815
Mike Stumpe8c3b3e2009-12-15 00:35:12 +00001816 /// getTrapBB - Create a basic block that will call the trap intrinsic. We'll
1817 /// generate a branch around the created basic block as necessary.
Chris Lattner26008e02010-07-20 20:19:24 +00001818 llvm::BasicBlock *getTrapBB();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001819
Anders Carlsson093bdff2010-03-30 03:27:09 +00001820 /// EmitCallArg - Emit a single call argument.
1821 RValue EmitCallArg(const Expr *E, QualType ArgType);
1822
John McCall23f66262010-05-26 22:34:26 +00001823 /// EmitDelegateCallArg - We are performing a delegate call; that
1824 /// is, the current function is delegating to another one. Produce
1825 /// a r-value suitable for passing the given parameter.
1826 RValue EmitDelegateCallArg(const VarDecl *Param);
1827
Chris Lattnercd439292008-11-12 08:04:58 +00001828private:
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +00001829 void EmitReturnOfRValue(RValue RV, QualType Ty);
1830
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001831 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
1832 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
1833 ///
1834 /// \param AI - The first function argument of the expansion.
1835 /// \return The argument following the last expanded function
1836 /// argument.
Mike Stumpfc496822009-02-08 23:14:22 +00001837 llvm::Function::arg_iterator
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001838 ExpandTypeFromArgs(QualType Ty, LValue Dst,
1839 llvm::Function::arg_iterator AI);
1840
Mike Stumpfc496822009-02-08 23:14:22 +00001841 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type for \arg
1842 /// Ty, into individual arguments on the provided vector \arg Args. See
1843 /// ABIArgInfo::Expand.
1844 void ExpandTypeToArgs(QualType Ty, RValue Src,
Daniel Dunbar8fc81b02008-09-17 00:51:38 +00001845 llvm::SmallVector<llvm::Value*, 16> &Args);
Anders Carlsson03aaf112009-01-11 19:40:10 +00001846
Mike Stump11289f42009-09-09 15:08:12 +00001847 llvm::Value* EmitAsmInput(const AsmStmt &S,
Daniel Dunbard53e07b2009-05-04 06:56:16 +00001848 const TargetInfo::ConstraintInfo &Info,
Anders Carlsson03aaf112009-01-11 19:40:10 +00001849 const Expr *InputExpr, std::string &ConstraintStr);
Mike Stumpfc496822009-02-08 23:14:22 +00001850
Eli Friedmaneca55af2010-07-16 00:55:21 +00001851 llvm::Value* EmitAsmInputLValue(const AsmStmt &S,
1852 const TargetInfo::ConstraintInfo &Info,
1853 LValue InputValue, QualType InputType,
1854 std::string &ConstraintStr);
1855
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00001856 /// EmitCallArgs - Emit call arguments for a function.
Mike Stump11289f42009-09-09 15:08:12 +00001857 /// The CallArgTypeInfo parameter is used for iterating over the known
Anders Carlsson603d6af2009-04-18 20:20:22 +00001858 /// argument types of the function being called.
1859 template<typename T>
1860 void EmitCallArgs(CallArgList& Args, const T* CallArgTypeInfo,
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00001861 CallExpr::const_arg_iterator ArgBeg,
Anders Carlsson603d6af2009-04-18 20:20:22 +00001862 CallExpr::const_arg_iterator ArgEnd) {
1863 CallExpr::const_arg_iterator Arg = ArgBeg;
Anders Carlsson60ce3fe2009-04-08 20:47:54 +00001864
Anders Carlsson603d6af2009-04-18 20:20:22 +00001865 // First, use the argument types that the type info knows about
1866 if (CallArgTypeInfo) {
1867 for (typename T::arg_type_iterator I = CallArgTypeInfo->arg_type_begin(),
1868 E = CallArgTypeInfo->arg_type_end(); I != E; ++I, ++Arg) {
Eli Friedman794290c2009-11-18 03:42:04 +00001869 assert(Arg != ArgEnd && "Running over edge of argument list!");
Anders Carlsson603d6af2009-04-18 20:20:22 +00001870 QualType ArgType = *I;
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00001871#ifndef NDEBUG
1872 QualType ActualArgType = Arg->getType();
1873 if (ArgType->isPointerType() && ActualArgType->isPointerType()) {
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001874 QualType ActualBaseType =
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00001875 ActualArgType->getAs<PointerType>()->getPointeeType();
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001876 QualType ArgBaseType =
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00001877 ArgType->getAs<PointerType>()->getPointeeType();
1878 if (ArgBaseType->isVariableArrayType()) {
1879 if (const VariableArrayType *VAT =
1880 getContext().getAsVariableArrayType(ActualBaseType)) {
1881 if (!VAT->getSizeExpr())
1882 ActualArgType = ArgType;
1883 }
1884 }
1885 }
Anders Carlsson603d6af2009-04-18 20:20:22 +00001886 assert(getContext().getCanonicalType(ArgType.getNonReferenceType()).
Mike Stump11289f42009-09-09 15:08:12 +00001887 getTypePtr() ==
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00001888 getContext().getCanonicalType(ActualArgType).getTypePtr() &&
Anders Carlsson603d6af2009-04-18 20:20:22 +00001889 "type mismatch in call argument!");
Fariborz Jahanian8fb87ae2010-09-24 17:30:16 +00001890#endif
Mike Stump11289f42009-09-09 15:08:12 +00001891 Args.push_back(std::make_pair(EmitCallArg(*Arg, ArgType),
Anders Carlsson603d6af2009-04-18 20:20:22 +00001892 ArgType));
1893 }
Mike Stump11289f42009-09-09 15:08:12 +00001894
1895 // Either we've emitted all the call args, or we have a call to a
Anders Carlsson603d6af2009-04-18 20:20:22 +00001896 // variadic function.
Mike Stump11289f42009-09-09 15:08:12 +00001897 assert((Arg == ArgEnd || CallArgTypeInfo->isVariadic()) &&
Anders Carlsson603d6af2009-04-18 20:20:22 +00001898 "Extra arguments in non-variadic function!");
Mike Stump11289f42009-09-09 15:08:12 +00001899
Anders Carlsson603d6af2009-04-18 20:20:22 +00001900 }
Mike Stump11289f42009-09-09 15:08:12 +00001901
Anders Carlsson603d6af2009-04-18 20:20:22 +00001902 // If we still have any arguments, emit them using the type of the argument.
1903 for (; Arg != ArgEnd; ++Arg) {
1904 QualType ArgType = Arg->getType();
1905 Args.push_back(std::make_pair(EmitCallArg(*Arg, ArgType),
1906 ArgType));
1907 }
1908 }
John McCalld4f4b7f2010-03-03 04:15:11 +00001909
1910 const TargetCodeGenInfo &getTargetHooks() const {
1911 return CGM.getTargetCodeGenInfo();
1912 }
John McCall09ae0322010-07-06 23:57:41 +00001913
1914 void EmitDeclMetadata();
Chris Lattnerbed31442007-05-28 01:07:47 +00001915};
Mike Stump11289f42009-09-09 15:08:12 +00001916
John McCallce1de612011-01-26 04:00:11 +00001917/// Helper class with most of the code for saving a value for a
1918/// conditional expression cleanup.
1919struct SavedValueInCondImpl {
1920 typedef llvm::PointerIntPair<llvm::Value*, 1, bool> saved_type;
1921
1922 /// Answer whether the given value needs extra work to be saved.
1923 static bool needsSaving(llvm::Value *value) {
1924 // If it's not an instruction, we don't need to save.
1925 if (!isa<llvm::Instruction>(value)) return false;
1926
1927 // If it's an instruction in the entry block, we don't need to save.
1928 llvm::BasicBlock *block = cast<llvm::Instruction>(value)->getParent();
1929 return (block != &block->getParent()->getEntryBlock());
1930 }
1931
1932 /// Try to save the given value.
1933 static saved_type save(CodeGenFunction &CGF, llvm::Value *value) {
1934 if (!needsSaving(value)) return saved_type(value, false);
1935
1936 // Otherwise we need an alloca.
1937 llvm::Value *alloca =
1938 CGF.CreateTempAlloca(value->getType(), "cond-cleanup.save");
1939 CGF.Builder.CreateStore(value, alloca);
1940
1941 return saved_type(alloca, true);
1942 }
1943
1944 static llvm::Value *restore(CodeGenFunction &CGF, saved_type value) {
1945 if (!value.getInt()) return value.getPointer();
1946 return CGF.Builder.CreateLoad(value.getPointer());
1947 }
1948};
1949
1950/// Partial specialization of SavedValueInCond for when a value really
1951/// requires saving.
1952template <class T> struct SavedValueInCond<T,true> : SavedValueInCondImpl {
1953 typedef T type;
1954 static type restore(CodeGenFunction &CGF, saved_type value) {
1955 return static_cast<T>(SavedValueInCondImpl::restore(CGF, value));
1956 }
1957};
1958
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001959/// CGBlockInfo - Information to generate a block literal.
1960class CGBlockInfo {
1961public:
1962 /// Name - The name of the block, kindof.
1963 const char *Name;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001964
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001965 /// DeclRefs - Variables from parent scopes that have been
1966 /// imported into this block.
1967 llvm::SmallVector<const BlockDeclRefExpr *, 8> DeclRefs;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001968
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001969 /// InnerBlocks - This block and the blocks it encloses.
1970 llvm::SmallPtrSet<const DeclContext *, 4> InnerBlocks;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001971
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001972 /// CXXThisRef - Non-null if 'this' was required somewhere, in
1973 /// which case this is that expression.
1974 const CXXThisExpr *CXXThisRef;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001975
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001976 /// NeedsObjCSelf - True if something in this block has an implicit
1977 /// reference to 'self'.
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001978 bool NeedsObjCSelf : 1;
1979
1980 /// HasCXXObject - True if block has imported c++ object requiring copy
1981 /// construction in copy helper and destruction in copy dispose helpers.
1982 bool HasCXXObject : 1;
1983
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001984 /// These are initialized by GenerateBlockFunction.
Fariborz Jahaniane988bda2010-11-13 21:53:34 +00001985 bool BlockHasCopyDispose : 1;
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001986 CharUnits BlockSize;
1987 CharUnits BlockAlign;
1988 llvm::SmallVector<const Expr*, 8> BlockLayout;
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001989
Fariborz Jahanianc05349e2010-08-04 16:57:49 +00001990 CGBlockInfo(const char *Name);
1991};
Michael J. Spencerf5a1fbc2010-10-19 06:39:39 +00001992
Chris Lattnerbed31442007-05-28 01:07:47 +00001993} // end namespace CodeGen
1994} // end namespace clang
Chris Lattnerbed31442007-05-28 01:07:47 +00001995
1996#endif