blob: 63af44f9cb656e123d3bf950b7211abc25acffec [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//
10// This is the internal per-function state used for llvm translation.
11//
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"
Chris Lattnerac248202007-05-30 00:13:02 +000018#include "llvm/ADT/DenseMap.h"
Chris Lattnere73e4322007-07-16 21:28:45 +000019#include "llvm/ADT/SmallVector.h"
Ted Kremenek08e17112008-06-17 02:43:46 +000020#include "clang/AST/Expr.h"
Argyrios Kyrtzidis07052352008-09-10 02:36:38 +000021#include "clang/AST/ExprCXX.h"
Ted Kremenek08e17112008-06-17 02:43:46 +000022#include "clang/AST/ExprObjC.h"
23
Chris Lattner2ccb73b2007-06-16 00:16:26 +000024#include <vector>
Daniel Dunbar88402ce2008-08-04 16:51:22 +000025#include <map>
Chris Lattner308f4312007-05-29 23:50:05 +000026
Daniel Dunbarcb463852008-11-01 01:53:16 +000027#include "CGBuilder.h"
Daniel Dunbar3d7c90b2008-09-08 21:33:45 +000028#include "CGCall.h"
Daniel Dunbar97db84c2008-08-23 03:46:30 +000029#include "CGValue.h"
30
Chris Lattnerbed31442007-05-28 01:07:47 +000031namespace llvm {
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000032 class BasicBlock;
Chris Lattnerbed31442007-05-28 01:07:47 +000033 class Module;
Daniel Dunbar2efd5382008-09-30 01:06:03 +000034 class SwitchInst;
Daniel Dunbar9b1335e2008-11-19 09:36:46 +000035 class Value;
Chris Lattner23b7eb62007-06-15 23:05:46 +000036}
37
Chris Lattnerbed31442007-05-28 01:07:47 +000038namespace clang {
39 class ASTContext;
Chris Lattner84915fa2007-06-02 04:16:21 +000040 class Decl;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000041 class EnumConstantDecl;
Chris Lattnerbed31442007-05-28 01:07:47 +000042 class FunctionDecl;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000043 class FunctionTypeProto;
44 class LabelStmt;
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +000045 class ObjCInterfaceDecl;
46 class ObjCIvarDecl;
Chris Lattner4bd55962008-03-30 23:03:07 +000047 class ObjCMethodDecl;
Daniel Dunbar89654ee2008-08-26 08:29:31 +000048 class ObjCPropertyImplDecl;
Chris Lattner2ccb73b2007-06-16 00:16:26 +000049 class TargetInfo;
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000050 class VarDecl;
Devang Patel3e11cce2007-10-23 02:10:49 +000051
Chris Lattnerbed31442007-05-28 01:07:47 +000052namespace CodeGen {
53 class CodeGenModule;
Devang Patel3e11cce2007-10-23 02:10:49 +000054 class CodeGenTypes;
Devang Patele11664a2007-11-01 19:11:01 +000055 class CGRecordLayout;
Daniel Dunbarcb463852008-11-01 01:53:16 +000056
Chris Lattnerbed31442007-05-28 01:07:47 +000057/// CodeGenFunction - This class organizes the per-function state that is used
58/// while generating LLVM code.
59class CodeGenFunction {
Chris Lattnerbda69f82007-08-26 23:13:56 +000060public:
Chris Lattnerbed31442007-05-28 01:07:47 +000061 CodeGenModule &CGM; // Per-module state.
Chris Lattnerd1af2d22007-05-29 23:17:50 +000062 TargetInfo &Target;
Chris Lattnerbda69f82007-08-26 23:13:56 +000063
Chris Lattner96d72562007-08-21 16:57:55 +000064 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbarcb463852008-11-01 01:53:16 +000065 CGBuilderTy Builder;
Chris Lattner3f3dbee2007-06-02 03:19:07 +000066
Chris Lattner5506f8c2008-04-04 04:07:35 +000067 // Holds the Decl for the current function or method
Chris Lattner5696e7b2008-06-17 18:05:57 +000068 const Decl *CurFuncDecl;
Chris Lattner4bd55962008-03-30 23:03:07 +000069 QualType FnRetTy;
Chris Lattnerac248202007-05-30 00:13:02 +000070 llvm::Function *CurFn;
71
Daniel Dunbar54bb1932008-09-09 21:00:17 +000072 /// ReturnBlock - Unified return block.
73 llvm::BasicBlock *ReturnBlock;
74 /// ReturnValue - The temporary alloca to hold the return value. This
75 /// is null iff the function has no return value.
76 llvm::Instruction *ReturnValue;
77
Chris Lattner03df1222007-06-02 04:53:11 +000078 /// AllocaInsertPoint - This is an instruction in the entry block before which
79 /// we prefer to insert allocas.
80 llvm::Instruction *AllocaInsertPt;
Daniel Dunbar88402ce2008-08-04 16:51:22 +000081
Chris Lattner6db1fb82007-06-02 22:49:07 +000082 const llvm::Type *LLVMIntTy;
Hartmut Kaiser7078da82007-10-17 15:00:17 +000083 uint32_t LLVMPointerWidth;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +000084
85public:
86 // FIXME: The following should be private once EH code is moved out
87 // of NeXT runtime.
88
89 // ObjCEHStack - This keeps track of which object to rethrow from
90 // inside @catch blocks and which @finally block exits from an EH
91 // scope should be chained through.
92 struct ObjCEHEntry {
Daniel Dunbar2efd5382008-09-30 01:06:03 +000093 ObjCEHEntry(llvm::BasicBlock *fb, llvm::BasicBlock *fne,
94 llvm::SwitchInst *fs, llvm::Value *dc)
95 : FinallyBlock(fb), FinallyNoExit(fne), FinallySwitch(fs),
96 DestCode(dc), Exception(0) {}
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +000097
Daniel Dunbar2efd5382008-09-30 01:06:03 +000098 /// Entry point to the finally block.
99 llvm::BasicBlock *FinallyBlock;
100
101 /// Entry point to the finally block which skips execution of the
102 /// try_exit runtime function.
103 llvm::BasicBlock *FinallyNoExit;
104
105 /// Switch instruction which runs at the end of the finally block
106 /// to forward jumps through the finally block.
107 llvm::SwitchInst *FinallySwitch;
108
109 /// Variable holding the code for the destination of a jump
110 /// through the @finally block.
111 llvm::Value *DestCode;
112
113 /// The exception object being handled, during IR generation for a
114 /// @catch block.
115 llvm::Value *Exception;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000116 };
Daniel Dunbar2efd5382008-09-30 01:06:03 +0000117
118 typedef llvm::SmallVector<ObjCEHEntry*, 8> ObjCEHStackType;
119 ObjCEHStackType ObjCEHStack;
120
121 /// EmitJumpThroughFinally - Emit a branch from the current insert
122 /// point through the finally handling code for \arg Entry and then
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000123 /// on to \arg Dest. It is legal to call this function even if there
124 /// is no current insertion point.
Daniel Dunbar2efd5382008-09-30 01:06:03 +0000125 ///
126 /// \param ExecuteTryExit - When true, the try_exit runtime function
127 /// should be called prior to executing the finally code.
128 void EmitJumpThroughFinally(ObjCEHEntry *Entry, llvm::BasicBlock *Dest,
129 bool ExecuteTryExit=true);
Chris Lattner6db1fb82007-06-02 22:49:07 +0000130
Chris Lattner2da04b32007-08-24 05:35:26 +0000131private:
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000132 /// LabelIDs - Track arbitrary ids assigned to labels for use in
133 /// implementing the GCC address-of-label extension and indirect
134 /// goto. IDs are assigned to labels inside getIDForAddrOfLabel().
135 std::map<const LabelStmt*, unsigned> LabelIDs;
136
137 /// IndirectSwitches - Record the list of switches for indirect
138 /// gotos. Emission of the actual switching code needs to be delayed
139 /// until all AddrLabelExprs have been seen.
140 std::vector<llvm::SwitchInst*> IndirectSwitches;
141
Chris Lattner84915fa2007-06-02 04:16:21 +0000142 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
143 /// decls.
Chris Lattner23b7eb62007-06-15 23:05:46 +0000144 llvm::DenseMap<const Decl*, llvm::Value*> LocalDeclMap;
Chris Lattner84915fa2007-06-02 04:16:21 +0000145
Chris Lattnerac248202007-05-30 00:13:02 +0000146 /// LabelMap - This keeps track of the LLVM basic block for each C label.
Chris Lattner23b7eb62007-06-15 23:05:46 +0000147 llvm::DenseMap<const LabelStmt*, llvm::BasicBlock*> LabelMap;
Chris Lattnere73e4322007-07-16 21:28:45 +0000148
149 // BreakContinueStack - This keeps track of where break and continue
150 // statements should jump to.
151 struct BreakContinue {
152 BreakContinue(llvm::BasicBlock *bb, llvm::BasicBlock *cb)
153 : BreakBlock(bb), ContinueBlock(cb) {}
154
155 llvm::BasicBlock *BreakBlock;
156 llvm::BasicBlock *ContinueBlock;
157 };
158 llvm::SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbard3dcb4f82008-09-28 01:03:14 +0000159
Devang Patel49a44f32007-10-09 17:08:50 +0000160 /// SwitchInsn - This is nearest current switch instruction. It is null if
161 /// if current context is not in a switch.
Devang Patelda5d6bb2007-10-04 23:45:31 +0000162 llvm::SwitchInst *SwitchInsn;
163
Devang Patel49a44f32007-10-09 17:08:50 +0000164 /// CaseRangeBlock - This block holds if condition check for last case
165 /// statement range in current switch instruction.
Devang Patel11663122007-10-08 20:57:48 +0000166 llvm::BasicBlock *CaseRangeBlock;
167
Chris Lattnerbed31442007-05-28 01:07:47 +0000168public:
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000169 CodeGenFunction(CodeGenModule &cgm);
Chris Lattnerbed31442007-05-28 01:07:47 +0000170
Chris Lattner6db1fb82007-06-02 22:49:07 +0000171 ASTContext &getContext() const;
172
Chris Lattner4bd55962008-03-30 23:03:07 +0000173 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000174
175 void StartObjCMethod(const ObjCMethodDecl *MD);
176
177 /// GenerateObjCGetter - Synthesize an Objective-C property getter
178 /// function.
179 void GenerateObjCGetter(const ObjCPropertyImplDecl *PID);
180
181 /// GenerateObjCSetter - Synthesize an Objective-C property setter
182 /// function for the given property.
183 void GenerateObjCSetter(const ObjCPropertyImplDecl *PID);
184
Daniel Dunbar9c426522008-07-29 23:18:29 +0000185 void GenerateCode(const FunctionDecl *FD,
186 llvm::Function *Fn);
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000187 void StartFunction(const Decl *D, QualType RetTy,
188 llvm::Function *Fn,
Daniel Dunbar354d2782008-10-18 18:22:23 +0000189 const FunctionArgList &Args,
190 SourceLocation StartLoc);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000191
192 /// FinishFunction - Complete IR generation of the current
193 /// function. It is legal to call this function even if there is no
194 /// current insertion point.
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000195 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar613855c2008-09-09 23:27:19 +0000196
197 /// EmitFunctionProlog - Emit the target specific LLVM code to load
198 /// the arguments for the given function. This is also responsible
199 /// for naming the LLVM function arguments.
200 void EmitFunctionProlog(llvm::Function *Fn, QualType RetTy,
201 const FunctionArgList &Args);
202
203 /// EmitFunctionEpilog - Emit the target specific LLVM code to
204 /// return the given temporary.
205 void EmitFunctionEpilog(QualType RetTy,
206 llvm::Value *ReturnValue);
207
Chris Lattnerf033c142007-06-22 19:05:19 +0000208 const llvm::Type *ConvertType(QualType T);
Chris Lattner5506f8c2008-04-04 04:07:35 +0000209
Daniel Dunbara94ecd22008-08-16 03:19:19 +0000210 /// LoadObjCSelf - Load the value of self. This function is only
211 /// valid while generating code for an Objective-C method.
Chris Lattner5506f8c2008-04-04 04:07:35 +0000212 llvm::Value *LoadObjCSelf();
Chris Lattner5696e7b2008-06-17 18:05:57 +0000213
214 /// isObjCPointerType - Return true if the specificed AST type will map onto
215 /// some Objective-C pointer type.
216 static bool isObjCPointerType(QualType T);
217
Chris Lattner54fb19e2007-06-22 22:02:34 +0000218 /// hasAggregateLLVMType - Return true if the specified AST type will map into
219 /// an aggregate LLVM type or is void.
220 static bool hasAggregateLLVMType(QualType T);
Daniel Dunbar75283ff2008-11-11 02:29:29 +0000221
222 /// createBasicBlock - Create an LLVM basic block.
223 llvm::BasicBlock *createBasicBlock(const char *Name="",
224 llvm::Function *Parent=0,
225 llvm::BasicBlock *InsertBefore=0) {
Daniel Dunbar851eec12008-11-12 00:01:12 +0000226#ifdef NDEBUG
227 return llvm::BasicBlock::Create("", Parent, InsertBefore);
228#else
Daniel Dunbar75283ff2008-11-11 02:29:29 +0000229 return llvm::BasicBlock::Create(Name, Parent, InsertBefore);
Daniel Dunbar851eec12008-11-12 00:01:12 +0000230#endif
Daniel Dunbar75283ff2008-11-11 02:29:29 +0000231 }
232
Chris Lattnerac248202007-05-30 00:13:02 +0000233 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
234 /// label maps to.
235 llvm::BasicBlock *getBasicBlockForLabel(const LabelStmt *S);
236
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000237 /// EmitBlock - Emit the given block \arg BB and set it as the
238 /// insert point, adding a fall-through branch from the current
239 /// insert block if necessary. It is legal to call this function
240 /// even if there is no current insertion point.
Daniel Dunbarfcac22e2008-11-13 01:24:05 +0000241 ///
242 /// IsFinished - If true, indicates that the caller has finished
243 /// emitting branches to the given block and does not expect to emit
244 /// code into it. This means the block can be ignored if it is
245 /// unreachable.
246 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar29ac59f2008-11-11 04:34:23 +0000247
Daniel Dunbarc56e6762008-11-11 09:41:28 +0000248 /// EmitBranch - Emit a branch to the specified basic block from the
249 /// current insert block, taking care to avoid creation of branches
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000250 /// from dummy blocks. It is legal to call this function even if
251 /// there is no current insertion point.
Daniel Dunbarab197eb2008-11-11 22:06:59 +0000252 ///
253 /// This function clears the current insertion point. The caller
254 /// should follow calls to this function with calls to Emit*Block
255 /// prior to generation new code.
Daniel Dunbarc56e6762008-11-11 09:41:28 +0000256 void EmitBranch(llvm::BasicBlock *Block);
257
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000258 /// HaveInsertPoint - True if an insertion point is defined. If not,
259 /// this indicates that the current code being emitted is
260 /// unreachable.
261 bool HaveInsertPoint() const {
262 return Builder.GetInsertBlock() != 0;
263 }
264
265 /// EnsureInsertPoint - Ensure that an insertion point is defined so
266 /// that emitted IR has a place to go. Note that by definition, if
267 /// this function creates a block then that block is unreachable;
268 /// callers may do better to detect when no insertion point is
269 /// defined and simply skip IR generation.
270 void EnsureInsertPoint() {
271 if (!HaveInsertPoint())
272 EmitBlock(createBasicBlock());
273 }
Chris Lattnerfc944342007-12-02 01:43:38 +0000274
Daniel Dunbara7c8cf62008-08-16 00:56:44 +0000275 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +0000276 /// specified stmt yet.
Daniel Dunbarf2cf6d12008-09-04 03:43:08 +0000277 void ErrorUnsupported(const Stmt *S, const char *Type,
278 bool OmitOnError=false);
Chris Lattner84915fa2007-06-02 04:16:21 +0000279
Chris Lattnere9a64532007-06-22 21:44:33 +0000280 //===--------------------------------------------------------------------===//
281 // Helpers
282 //===--------------------------------------------------------------------===//
283
284 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
285 /// block.
286 llvm::AllocaInst *CreateTempAlloca(const llvm::Type *Ty,
287 const char *Name = "tmp");
288
Chris Lattner8394d792007-06-05 20:53:16 +0000289 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
290 /// expression and compare the result against zero, returning an Int1Ty value.
Chris Lattner23b7eb62007-06-15 23:05:46 +0000291 llvm::Value *EvaluateExprAsBool(const Expr *E);
Chris Lattnere9a64532007-06-22 21:44:33 +0000292
Chris Lattner4647a212007-08-31 22:49:20 +0000293 /// EmitAnyExpr - Emit code to compute the specified expression which can have
294 /// any type. The result is returned as an RValue struct. If this is an
295 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
296 /// the result should be returned.
297 RValue EmitAnyExpr(const Expr *E, llvm::Value *AggLoc = 0,
298 bool isAggLocVolatile = false);
Devang Patel8ec4f832007-09-28 21:49:18 +0000299
Daniel Dunbar41cf9de2008-09-09 01:06:48 +0000300 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result
301 /// will always be accessible even if no aggregate location is
302 /// provided.
303 RValue EmitAnyExprToTemp(const Expr *E, llvm::Value *AggLoc = 0,
304 bool isAggLocVolatile = false);
305
Daniel Dunbar0bc8e862008-09-09 20:49:46 +0000306 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
307 QualType EltTy);
308
309 void EmitAggregateClear(llvm::Value *DestPtr, QualType Ty);
310
Devang Patelda5d6bb2007-10-04 23:45:31 +0000311 /// StartBlock - Start new block named N. If insert block is a dummy block
312 /// then reuse it.
313 void StartBlock(const char *N);
314
Devang Patele11664a2007-11-01 19:11:01 +0000315 /// getCGRecordLayout - Return record layout info.
316 const CGRecordLayout *getCGRecordLayout(CodeGenTypes &CGT, QualType RTy);
Lauro Ramos Venancio01a72ff2008-02-26 21:41:45 +0000317
318 /// GetAddrOfStaticLocalVar - Return the address of a static local variable.
Steve Naroff08899ff2008-04-15 22:42:06 +0000319 llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD);
Dan Gohman75d69da2008-05-22 00:50:06 +0000320
Anders Carlsson9396a892008-09-11 09:15:33 +0000321 /// GetAddrOfLocalVar - Return the address of a local variable.
322 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD);
323
Dan Gohman75d69da2008-05-22 00:50:06 +0000324 /// getAccessedFieldNo - Given an encoded value and a result number, return
325 /// the input field number being accessed.
326 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
327
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000328 unsigned GetIDForAddrOfLabel(const LabelStmt *L);
329
Anders Carlsson2e744e82008-08-30 19:51:14 +0000330 /// EmitMemSetToZero - Generate code to memset a value of the given type to 0;
331 void EmitMemSetToZero(llvm::Value *DestPtr, QualType Ty);
Anders Carlsson13abd7e2008-11-04 05:30:00 +0000332
333 // EmitVAArg - Generate code to get an argument from the passed in pointer
334 // and update it accordingly. The return value is a pointer to the argument.
335 // FIXME: We should be able to get rid of this method and use the va_arg
336 // instruction in LLVM instead once it works well enough.
337 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +0000338
Chris Lattner8394d792007-06-05 20:53:16 +0000339 //===--------------------------------------------------------------------===//
Chris Lattner53621a52007-06-13 20:44:40 +0000340 // Declaration Emission
Chris Lattner84915fa2007-06-02 04:16:21 +0000341 //===--------------------------------------------------------------------===//
342
Chris Lattner1ad38f82007-06-09 01:20:56 +0000343 void EmitDecl(const Decl &D);
Steve Naroff08899ff2008-04-15 22:42:06 +0000344 void EmitBlockVarDecl(const VarDecl &D);
345 void EmitLocalBlockVarDecl(const VarDecl &D);
346 void EmitStaticBlockVarDecl(const VarDecl &D);
Daniel Dunbara94ecd22008-08-16 03:19:19 +0000347
348 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
349 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg);
Chris Lattner03df1222007-06-02 04:53:11 +0000350
Chris Lattner84915fa2007-06-02 04:16:21 +0000351 //===--------------------------------------------------------------------===//
Chris Lattner308f4312007-05-29 23:50:05 +0000352 // Statement Emission
353 //===--------------------------------------------------------------------===//
354
Daniel Dunbar5fc28712008-11-12 08:21:33 +0000355 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug
356 /// info.
357 void EmitStopPoint(const Stmt *S);
358
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000359 /// EmitStmt - Emit the code for the statement \arg S. It is legal
360 /// to call this function even if there is no current insertion
361 /// point.
362 ///
363 /// This function may clear the current insertion point; callers
364 /// should use EnsureInsertPoint if they wish to subsequently
365 /// generate code without first calling EmitBlock, EmitBranch, or
366 /// EmitStmt.
Chris Lattner308f4312007-05-29 23:50:05 +0000367 void EmitStmt(const Stmt *S);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000368
Daniel Dunbar5fc28712008-11-12 08:21:33 +0000369 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
370 /// necessarily require an insertion point or debug information;
371 /// typically because the statement amounts to a jump or a container
372 /// of other statements.
373 ///
374 /// \return True if the statement was handled.
375 bool EmitSimpleStmt(const Stmt *S);
376
Chris Lattner4647a212007-08-31 22:49:20 +0000377 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
378 llvm::Value *AggLoc = 0, bool isAggVol = false);
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000379
380 /// EmitLabel - Emit the block for the given label. It is legal
381 /// to call this function even if there is no current insertion
382 /// point.
Chris Lattner7e800972008-07-26 20:23:23 +0000383 void EmitLabel(const LabelStmt &S); // helper for EmitLabelStmt.
Daniel Dunbar5c7e3932008-11-11 23:11:34 +0000384
Chris Lattnerac248202007-05-30 00:13:02 +0000385 void EmitLabelStmt(const LabelStmt &S);
386 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000387 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Chris Lattner5269c032007-05-30 21:03:58 +0000388 void EmitIfStmt(const IfStmt &S);
Chris Lattner946aa312007-06-05 03:59:43 +0000389 void EmitWhileStmt(const WhileStmt &S);
Chris Lattner8394d792007-06-05 20:53:16 +0000390 void EmitDoStmt(const DoStmt &S);
391 void EmitForStmt(const ForStmt &S);
Chris Lattner3f3dbee2007-06-02 03:19:07 +0000392 void EmitReturnStmt(const ReturnStmt &S);
Chris Lattner1ad38f82007-06-09 01:20:56 +0000393 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar5fc28712008-11-12 08:21:33 +0000394 void EmitBreakStmt(const BreakStmt &S);
395 void EmitContinueStmt(const ContinueStmt &S);
Devang Patelda5d6bb2007-10-04 23:45:31 +0000396 void EmitSwitchStmt(const SwitchStmt &S);
397 void EmitDefaultStmt(const DefaultStmt &S);
398 void EmitCaseStmt(const CaseStmt &S);
Devang Patel11663122007-10-08 20:57:48 +0000399 void EmitCaseStmtRange(const CaseStmt &S);
Anders Carlsson952a9952008-02-05 16:35:33 +0000400 void EmitAsmStmt(const AsmStmt &S);
401
Anders Carlsson2e744e82008-08-30 19:51:14 +0000402 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson1963b0c2008-09-09 10:04:29 +0000403 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
404 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattnere132e242008-11-15 21:26:17 +0000405 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
Anders Carlsson2e744e82008-08-30 19:51:14 +0000406
Chris Lattner208ae962007-05-30 17:57:17 +0000407 //===--------------------------------------------------------------------===//
Chris Lattnerd7f58862007-06-02 05:24:33 +0000408 // LValue Expression Emission
409 //===--------------------------------------------------------------------===//
Chris Lattner8394d792007-06-05 20:53:16 +0000410
Daniel Dunbarf2e69882008-08-25 20:45:57 +0000411 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E
412 /// and issue an ErrorUnsupported style diagnostic (using the
413 /// provided Name).
414 LValue EmitUnsupportedLValue(const Expr *E,
415 const char *Name);
416
Chris Lattner8394d792007-06-05 20:53:16 +0000417 /// EmitLValue - Emit code to compute a designator that specifies the location
418 /// of the expression.
419 ///
420 /// This can return one of two things: a simple address or a bitfield
421 /// reference. In either case, the LLVM Value* in the LValue structure is
422 /// guaranteed to be an LLVM pointer type.
423 ///
424 /// If this returns a bitfield reference, nothing about the pointee type of
425 /// the LLVM value is known: For example, it may not be a pointer to an
426 /// integer.
427 ///
428 /// If this returns a normal address, and if the lvalue's C type is fixed
429 /// size, this method guarantees that the returned pointer type will point to
430 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
431 /// variable length type, this is not possible.
432 ///
Chris Lattnerd7f58862007-06-02 05:24:33 +0000433 LValue EmitLValue(const Expr *E);
Chris Lattner8394d792007-06-05 20:53:16 +0000434
435 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
436 /// this method emits the address of the lvalue, then loads the result as an
437 /// rvalue, returning the rvalue.
Chris Lattner9369a562007-06-29 16:31:29 +0000438 RValue EmitLoadOfLValue(LValue V, QualType LVType);
Nate Begemance4d7fc2008-04-18 23:10:10 +0000439 RValue EmitLoadOfExtVectorElementLValue(LValue V, QualType LVType);
Lauro Ramos Venancio2ddcb25a32008-01-22 20:17:04 +0000440 RValue EmitLoadOfBitfieldLValue(LValue LV, QualType ExprType);
Daniel Dunbar9e22c0d2008-08-29 08:11:39 +0000441 RValue EmitLoadOfPropertyRefLValue(LValue LV, QualType ExprType);
Fariborz Jahanian9ac53512008-11-22 22:30:21 +0000442 RValue EmitLoadOfKVCRefLValue(LValue LV, QualType ExprType);
Chris Lattner9369a562007-06-29 16:31:29 +0000443
Chris Lattner40ff7012007-08-03 16:18:34 +0000444
Chris Lattner8394d792007-06-05 20:53:16 +0000445 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
446 /// lvalue, where both are guaranteed to the have the same type, and that type
447 /// is 'Ty'.
448 void EmitStoreThroughLValue(RValue Src, LValue Dst, QualType Ty);
Nate Begemance4d7fc2008-04-18 23:10:10 +0000449 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst,
450 QualType Ty);
Daniel Dunbar9e22c0d2008-08-29 08:11:39 +0000451 void EmitStoreThroughPropertyRefLValue(RValue Src, LValue Dst, QualType Ty);
Fariborz Jahanian9ac53512008-11-22 22:30:21 +0000452 void EmitStoreThroughKVCRefLValue(RValue Src, LValue Dst, QualType Ty);
Daniel Dunbar9b1335e2008-11-19 09:36:46 +0000453
454 /// EmitStoreThroughLValue - Store Src into Dst with same
455 /// constraints as EmitStoreThroughLValue.
456 ///
457 /// \param Result [out] - If non-null, this will be set to a Value*
458 /// for the bit-field contents after the store, appropriate for use
459 /// as the result of an assignment to the bit-field.
460 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst, QualType Ty,
461 llvm::Value **Result=0);
Christopher Lambd91c3d42007-12-29 05:02:41 +0000462
463 // Note: only availabe for agg return types
Daniel Dunbar8cde00a2008-09-04 03:20:13 +0000464 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
465 // Note: only availabe for agg return types
Christopher Lambd91c3d42007-12-29 05:02:41 +0000466 LValue EmitCallExprLValue(const CallExpr *E);
Chris Lattnerd7f58862007-06-02 05:24:33 +0000467 LValue EmitDeclRefLValue(const DeclRefExpr *E);
Chris Lattner4347e3692007-06-06 04:54:52 +0000468 LValue EmitStringLiteralLValue(const StringLiteral *E);
Daniel Dunbarb3517472008-10-17 21:58:32 +0000469 LValue EmitPredefinedFunctionName(unsigned Type);
Chris Lattner6307f192008-08-10 01:53:14 +0000470 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +0000471 LValue EmitUnaryOpLValue(const UnaryOperator *E);
Chris Lattnerd9d2fb12007-06-08 23:31:14 +0000472 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
Nate Begemance4d7fc2008-04-18 23:10:10 +0000473 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patel3e11cce2007-10-23 02:10:49 +0000474 LValue EmitMemberExpr(const MemberExpr *E);
Eli Friedman9fd8b682008-05-13 23:18:27 +0000475 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Eli Friedmana62f3e12008-02-09 08:50:58 +0000476
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +0000477 llvm::Value *EmitIvarOffset(ObjCInterfaceDecl *Interface,
478 const ObjCIvarDecl *Ivar);
Eli Friedmana62f3e12008-02-09 08:50:58 +0000479 LValue EmitLValueForField(llvm::Value* Base, FieldDecl* Field,
Eli Friedman327944b2008-06-13 23:01:12 +0000480 bool isUnion, unsigned CVRQualifiers);
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +0000481 LValue EmitLValueForIvar(llvm::Value* Base, const ObjCIvarDecl *Ivar,
482 unsigned CVRQualifiers);
483
Argyrios Kyrtzidis07052352008-09-10 02:36:38 +0000484 LValue EmitCXXConditionDeclLValue(const CXXConditionDeclExpr *E);
485
Daniel Dunbarc8317a42008-08-23 10:51:21 +0000486 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner4bd55962008-03-30 23:03:07 +0000487 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Daniel Dunbar9e22c0d2008-08-29 08:11:39 +0000488 LValue EmitObjCPropertyRefLValue(const ObjCPropertyRefExpr *E);
Fariborz Jahanian9ac53512008-11-22 22:30:21 +0000489 LValue EmitObjCKVCRefLValue(const ObjCKVCRefExpr *E);
Douglas Gregor8ea1f532008-11-04 14:56:14 +0000490 LValue EmitObjCSuperExpr(const ObjCSuperExpr *E);
Daniel Dunbarc8317a42008-08-23 10:51:21 +0000491
Chris Lattnerd7f58862007-06-02 05:24:33 +0000492 //===--------------------------------------------------------------------===//
Chris Lattner6278e6a2007-08-11 00:04:45 +0000493 // Scalar Expression Emission
Chris Lattner208ae962007-05-30 17:57:17 +0000494 //===--------------------------------------------------------------------===//
495
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +0000496 /// EmitCall - Generate a call of the given function, expecting the
497 /// given result type, and using the given argument list which
498 /// specifies both the LLVM arguments and the types they were
499 /// derived from.
Daniel Dunbarc722b852008-08-30 03:02:31 +0000500 RValue EmitCall(llvm::Value *Callee,
501 QualType ResultType,
502 const CallArgList &Args);
503
Chris Lattner2b228c92007-06-15 21:34:29 +0000504 RValue EmitCallExpr(const CallExpr *E);
Ted Kremenek08e17112008-06-17 02:43:46 +0000505
506 RValue EmitCallExpr(Expr *FnExpr, CallExpr::const_arg_iterator ArgBeg,
507 CallExpr::const_arg_iterator ArgEnd);
508
Eli Friedman9d92ce82008-01-30 01:32:06 +0000509 RValue EmitCallExpr(llvm::Value *Callee, QualType FnType,
Ted Kremenek08e17112008-06-17 02:43:46 +0000510 CallExpr::const_arg_iterator ArgBeg,
511 CallExpr::const_arg_iterator ArgEnd);
512
Chris Lattner6c555f92007-08-26 22:58:05 +0000513 RValue EmitBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Chris Lattner8394d792007-06-05 20:53:16 +0000514
Daniel Dunbareca513d2008-10-10 00:24:54 +0000515 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0
516 /// if the call is unhandled by the current target.
517 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
518
Anders Carlsson895af082007-12-09 23:17:02 +0000519 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
520 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
521
Anders Carlssonb9eb82c2007-12-10 19:35:18 +0000522 llvm::Value *EmitShuffleVector(llvm::Value* V1, llvm::Value *V2, ...);
Nate Begeman330aaa72007-12-30 02:59:45 +0000523 llvm::Value *EmitVector(llvm::Value * const *Vals, unsigned NumVals,
524 bool isSplat = false);
Anders Carlssonf5f65442007-12-15 21:23:30 +0000525
Daniel Dunbar66912a12008-08-20 00:28:19 +0000526 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner2da04b32007-08-24 05:35:26 +0000527 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000528 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
Daniel Dunbar97db84c2008-08-23 03:46:30 +0000529 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E);
Fariborz Jahanian8a1810f2008-11-22 18:39:36 +0000530 RValue EmitObjCPropertyGet(const Expr *E);
Fariborz Jahanian9ac53512008-11-22 22:30:21 +0000531 void EmitObjCPropertySet(const Expr *E, RValue Src);
Chris Lattnerb1d329d2008-06-24 17:04:18 +0000532
533
Chris Lattner6278e6a2007-08-11 00:04:45 +0000534 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +0000535 // Expression Emission
Chris Lattner6278e6a2007-08-11 00:04:45 +0000536 //===--------------------------------------------------------------------===//
Chris Lattnerbda69f82007-08-26 23:13:56 +0000537
538 // Expressions are broken into three classes: scalar, complex, aggregate.
Chris Lattner6278e6a2007-08-11 00:04:45 +0000539
Chris Lattner2da04b32007-08-24 05:35:26 +0000540 /// EmitScalarExpr - Emit the computation of the specified expression of
541 /// LLVM scalar type, returning the result.
542 llvm::Value *EmitScalarExpr(const Expr *E);
543
Chris Lattner3474c202007-08-26 06:48:56 +0000544 /// EmitScalarConversion - Emit a conversion from the specified type to the
545 /// specified destination type, both of which are LLVM scalar types.
546 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
547 QualType DstTy);
548
Chris Lattner42e6b812007-08-26 16:34:22 +0000549 /// EmitComplexToScalarConversion - Emit a conversion from the specified
550 /// complex type to the specified destination type, where the destination
551 /// type is an LLVM scalar type.
552 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
553 QualType DstTy);
554
Chris Lattner3474c202007-08-26 06:48:56 +0000555
Chris Lattner6278e6a2007-08-11 00:04:45 +0000556 /// EmitAggExpr - Emit the computation of the specified expression of
557 /// aggregate type. The result is computed into DestPtr. Note that if
558 /// DestPtr is null, the value of the aggregate expression is not needed.
559 void EmitAggExpr(const Expr *E, llvm::Value *DestPtr, bool VolatileDest);
Chris Lattnercbfc73b2007-08-21 05:54:00 +0000560
561 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner08b15df2007-08-23 23:43:33 +0000562 /// complex type, returning the result.
Chris Lattner96d72562007-08-21 16:57:55 +0000563 ComplexPairTy EmitComplexExpr(const Expr *E);
Chris Lattner08b15df2007-08-23 23:43:33 +0000564
565 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
566 /// of complex type, storing into the specified Value*.
Chris Lattnerb84bb952007-08-26 16:22:13 +0000567 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
568 bool DestIsVolatile);
Daniel Dunbar4b8c6db2008-08-30 05:35:15 +0000569
570 /// StoreComplexToAddr - Store a complex number into the specified address.
571 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
572 bool DestIsVolatile);
Chris Lattner4647a212007-08-31 22:49:20 +0000573 /// LoadComplexFromAddr - Load a complex number from the specified address.
574 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
Chris Lattnerb781dc792008-05-08 05:58:21 +0000575
576 /// GenerateStaticBlockVarDecl - return the the static
577 /// declaration of local variable.
578 llvm::GlobalValue *GenerateStaticBlockVarDecl(const VarDecl &D,
579 bool NoInit,
580 const char *Separator);
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000581
Anders Carlsson87fc5a52008-08-22 16:00:37 +0000582 // GenerateStaticBlockVarDecl - return the static declaration of
583 // a local variable. Performs initialization of the variable if necessary.
584 llvm::GlobalValue *GenerateStaticCXXBlockVarDecl(const VarDecl &D);
585
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000586 //===--------------------------------------------------------------------===//
587 // Internal Helpers
588 //===--------------------------------------------------------------------===//
589
Chris Lattner5b1964b2008-11-11 07:41:27 +0000590 /// ContainsLabel - Return true if the statement contains a label in it. If
591 /// this statement is not executed normally, it not containing a label means
592 /// that we can just remove the code.
593 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
594
Daniel Dunbar682712c2008-11-12 10:12:14 +0000595 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattnercd439292008-11-12 08:04:58 +0000596 /// to a constant, or if it does but contains a label, return 0. If it
597 /// constant folds to 'true' and does not contain a label, return 1, if it
598 /// constant folds to 'false' and does not contain a label, return -1.
599 int ConstantFoldsToSimpleInteger(const Expr *Cond);
600
601 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
602 /// if statement) to the specified blocks. Based on the condition, this might
603 /// try to simplify the codegen of the conditional based on the branch.
604 ///
Chris Lattnerb7a9e162008-11-12 07:46:33 +0000605 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar682712c2008-11-12 10:12:14 +0000606 llvm::BasicBlock *FalseBlock);
Chris Lattnercd439292008-11-12 08:04:58 +0000607private:
Chris Lattner5b1964b2008-11-11 07:41:27 +0000608
Daniel Dunbar88402ce2008-08-04 16:51:22 +0000609 /// EmitIndirectSwitches - Emit code for all of the switch
610 /// instructions in IndirectSwitches.
611 void EmitIndirectSwitches();
Daniel Dunbar8fc81b02008-09-17 00:51:38 +0000612
Daniel Dunbar1c64e5d2008-09-24 04:00:38 +0000613 void EmitReturnOfRValue(RValue RV, QualType Ty);
614
Daniel Dunbar8fc81b02008-09-17 00:51:38 +0000615 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
616 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
617 ///
618 /// \param AI - The first function argument of the expansion.
619 /// \return The argument following the last expanded function
620 /// argument.
621 llvm::Function::arg_iterator
622 ExpandTypeFromArgs(QualType Ty, LValue Dst,
623 llvm::Function::arg_iterator AI);
624
625 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type
626 /// for \arg Ty, into individual arguments on the provided vector
627 /// \arg Args. See ABIArgInfo::Expand.
628 void ExpandTypeToArgs(QualType Ty, RValue Src,
629 llvm::SmallVector<llvm::Value*, 16> &Args);
Chris Lattnerbed31442007-05-28 01:07:47 +0000630};
631} // end namespace CodeGen
632} // end namespace clang
Chris Lattnerbed31442007-05-28 01:07:47 +0000633
634#endif