blob: 3d0c2a2fdb572e9acc533f693124cd40bdf4e118 [file] [log] [blame]
Daniel Dunbarbd012ff2008-07-29 23:18:29 +00001//===-- CodeGenFunction.h - Per-Function state for LLVM CodeGen -*- C++ -*-===//
Reid Spencer5f016e22007-07-11 17:01:13 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This is the internal per-function state used for llvm translation.
11//
12//===----------------------------------------------------------------------===//
13
Chris Lattneref52a2f2008-02-29 17:10:38 +000014#ifndef CLANG_CODEGEN_CODEGENFUNCTION_H
15#define CLANG_CODEGEN_CODEGENFUNCTION_H
Reid Spencer5f016e22007-07-11 17:01:13 +000016
Chris Lattner391d77a2008-03-30 23:03:07 +000017#include "clang/AST/Type.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000018#include "llvm/ADT/DenseMap.h"
Chris Lattnerda138702007-07-16 21:28:45 +000019#include "llvm/ADT/SmallVector.h"
Anders Carlssonc8c7b182009-01-11 19:40:10 +000020#include "clang/Basic/TargetInfo.h"
Ted Kremenek55499762008-06-17 02:43:46 +000021#include "clang/AST/Expr.h"
Argyrios Kyrtzidise3a09e62008-09-10 02:36:38 +000022#include "clang/AST/ExprCXX.h"
Ted Kremenek55499762008-06-17 02:43:46 +000023#include "clang/AST/ExprObjC.h"
24
Reid Spencer5f016e22007-07-11 17:01:13 +000025#include <vector>
Daniel Dunbar0ffb1252008-08-04 16:51:22 +000026#include <map>
Reid Spencer5f016e22007-07-11 17:01:13 +000027
Daniel Dunbar45d196b2008-11-01 01:53:16 +000028#include "CGBuilder.h"
Daniel Dunbar0dbe2272008-09-08 21:33:45 +000029#include "CGCall.h"
Daniel Dunbar8f2926b2008-08-23 03:46:30 +000030#include "CGValue.h"
31
Reid Spencer5f016e22007-07-11 17:01:13 +000032namespace llvm {
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000033 class BasicBlock;
Reid Spencer5f016e22007-07-11 17:01:13 +000034 class Module;
Daniel Dunbar898d5082008-09-30 01:06:03 +000035 class SwitchInst;
Daniel Dunbared3849b2008-11-19 09:36:46 +000036 class Value;
Reid Spencer5f016e22007-07-11 17:01:13 +000037}
38
39namespace clang {
40 class ASTContext;
41 class Decl;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000042 class EnumConstantDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000043 class FunctionDecl;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000044 class FunctionTypeProto;
45 class LabelStmt;
Fariborz Jahanian679a5022009-01-10 21:06:09 +000046 class ObjCContainerDecl;
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +000047 class ObjCInterfaceDecl;
48 class ObjCIvarDecl;
Chris Lattner391d77a2008-03-30 23:03:07 +000049 class ObjCMethodDecl;
Fariborz Jahanianfef30b52008-12-09 20:23:04 +000050 class ObjCImplementationDecl;
Daniel Dunbaraf05bb92008-08-26 08:29:31 +000051 class ObjCPropertyImplDecl;
Reid Spencer5f016e22007-07-11 17:01:13 +000052 class TargetInfo;
Daniel Dunbarc4a1dea2008-08-11 05:35:13 +000053 class VarDecl;
Devang Patelb84a06e2007-10-23 02:10:49 +000054
Reid Spencer5f016e22007-07-11 17:01:13 +000055namespace CodeGen {
56 class CodeGenModule;
Devang Patelb84a06e2007-10-23 02:10:49 +000057 class CodeGenTypes;
Devang Patel88a981b2007-11-01 19:11:01 +000058 class CGRecordLayout;
Daniel Dunbar45d196b2008-11-01 01:53:16 +000059
Reid Spencer5f016e22007-07-11 17:01:13 +000060/// CodeGenFunction - This class organizes the per-function state that is used
61/// while generating LLVM code.
62class CodeGenFunction {
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +000063public:
Reid Spencer5f016e22007-07-11 17:01:13 +000064 CodeGenModule &CGM; // Per-module state.
65 TargetInfo &Target;
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +000066
Chris Lattner58dee102007-08-21 16:57:55 +000067 typedef std::pair<llvm::Value *, llvm::Value *> ComplexPairTy;
Daniel Dunbar45d196b2008-11-01 01:53:16 +000068 CGBuilderTy Builder;
Reid Spencer5f016e22007-07-11 17:01:13 +000069
Chris Lattnerc8aa5f12008-04-04 04:07:35 +000070 // Holds the Decl for the current function or method
Chris Lattner41110242008-06-17 18:05:57 +000071 const Decl *CurFuncDecl;
Chris Lattner391d77a2008-03-30 23:03:07 +000072 QualType FnRetTy;
Reid Spencer5f016e22007-07-11 17:01:13 +000073 llvm::Function *CurFn;
74
Daniel Dunbar5ca20842008-09-09 21:00:17 +000075 /// ReturnBlock - Unified return block.
76 llvm::BasicBlock *ReturnBlock;
77 /// ReturnValue - The temporary alloca to hold the return value. This
78 /// is null iff the function has no return value.
79 llvm::Instruction *ReturnValue;
80
Reid Spencer5f016e22007-07-11 17:01:13 +000081 /// AllocaInsertPoint - This is an instruction in the entry block before which
82 /// we prefer to insert allocas.
83 llvm::Instruction *AllocaInsertPt;
Daniel Dunbar0ffb1252008-08-04 16:51:22 +000084
Reid Spencer5f016e22007-07-11 17:01:13 +000085 const llvm::Type *LLVMIntTy;
Hartmut Kaiser7b660002007-10-17 15:00:17 +000086 uint32_t LLVMPointerWidth;
Daniel Dunbar18ccc772008-09-28 01:03:14 +000087
88public:
89 // FIXME: The following should be private once EH code is moved out
90 // of NeXT runtime.
91
92 // ObjCEHStack - This keeps track of which object to rethrow from
93 // inside @catch blocks and which @finally block exits from an EH
94 // scope should be chained through.
95 struct ObjCEHEntry {
Daniel Dunbar898d5082008-09-30 01:06:03 +000096 ObjCEHEntry(llvm::BasicBlock *fb, llvm::BasicBlock *fne,
97 llvm::SwitchInst *fs, llvm::Value *dc)
98 : FinallyBlock(fb), FinallyNoExit(fne), FinallySwitch(fs),
99 DestCode(dc), Exception(0) {}
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000100
Daniel Dunbar898d5082008-09-30 01:06:03 +0000101 /// Entry point to the finally block.
102 llvm::BasicBlock *FinallyBlock;
103
104 /// Entry point to the finally block which skips execution of the
105 /// try_exit runtime function.
106 llvm::BasicBlock *FinallyNoExit;
107
108 /// Switch instruction which runs at the end of the finally block
109 /// to forward jumps through the finally block.
110 llvm::SwitchInst *FinallySwitch;
111
112 /// Variable holding the code for the destination of a jump
113 /// through the @finally block.
114 llvm::Value *DestCode;
115
116 /// The exception object being handled, during IR generation for a
117 /// @catch block.
118 llvm::Value *Exception;
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000119 };
Daniel Dunbar898d5082008-09-30 01:06:03 +0000120
121 typedef llvm::SmallVector<ObjCEHEntry*, 8> ObjCEHStackType;
122 ObjCEHStackType ObjCEHStack;
123
124 /// EmitJumpThroughFinally - Emit a branch from the current insert
125 /// point through the finally handling code for \arg Entry and then
Daniel Dunbara448fb22008-11-11 23:11:34 +0000126 /// on to \arg Dest. It is legal to call this function even if there
127 /// is no current insertion point.
Daniel Dunbar898d5082008-09-30 01:06:03 +0000128 ///
129 /// \param ExecuteTryExit - When true, the try_exit runtime function
130 /// should be called prior to executing the finally code.
131 void EmitJumpThroughFinally(ObjCEHEntry *Entry, llvm::BasicBlock *Dest,
132 bool ExecuteTryExit=true);
Reid Spencer5f016e22007-07-11 17:01:13 +0000133
Chris Lattner7f02f722007-08-24 05:35:26 +0000134private:
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000135 /// LabelIDs - Track arbitrary ids assigned to labels for use in
136 /// implementing the GCC address-of-label extension and indirect
137 /// goto. IDs are assigned to labels inside getIDForAddrOfLabel().
138 std::map<const LabelStmt*, unsigned> LabelIDs;
139
140 /// IndirectSwitches - Record the list of switches for indirect
141 /// gotos. Emission of the actual switching code needs to be delayed
142 /// until all AddrLabelExprs have been seen.
143 std::vector<llvm::SwitchInst*> IndirectSwitches;
144
Reid Spencer5f016e22007-07-11 17:01:13 +0000145 /// LocalDeclMap - This keeps track of the LLVM allocas or globals for local C
146 /// decls.
147 llvm::DenseMap<const Decl*, llvm::Value*> LocalDeclMap;
148
149 /// LabelMap - This keeps track of the LLVM basic block for each C label.
150 llvm::DenseMap<const LabelStmt*, llvm::BasicBlock*> LabelMap;
Chris Lattnerda138702007-07-16 21:28:45 +0000151
152 // BreakContinueStack - This keeps track of where break and continue
Anders Carlssone21269b2008-12-13 22:52:24 +0000153 // statements should jump to, as well as the size of the eh stack.
Chris Lattnerda138702007-07-16 21:28:45 +0000154 struct BreakContinue {
Anders Carlssone21269b2008-12-13 22:52:24 +0000155 BreakContinue(llvm::BasicBlock *bb, llvm::BasicBlock *cb, size_t ehss)
156 : BreakBlock(bb), ContinueBlock(cb), EHStackSize(ehss) {}
Chris Lattnerda138702007-07-16 21:28:45 +0000157
158 llvm::BasicBlock *BreakBlock;
159 llvm::BasicBlock *ContinueBlock;
Anders Carlssone21269b2008-12-13 22:52:24 +0000160 size_t EHStackSize;
Chris Lattnerda138702007-07-16 21:28:45 +0000161 };
162 llvm::SmallVector<BreakContinue, 8> BreakContinueStack;
Daniel Dunbar18ccc772008-09-28 01:03:14 +0000163
Devang Patel80fd5f92007-10-09 17:08:50 +0000164 /// SwitchInsn - This is nearest current switch instruction. It is null if
165 /// if current context is not in a switch.
Devang Patel51b09f22007-10-04 23:45:31 +0000166 llvm::SwitchInst *SwitchInsn;
167
Devang Patel80fd5f92007-10-09 17:08:50 +0000168 /// CaseRangeBlock - This block holds if condition check for last case
169 /// statement range in current switch instruction.
Devang Patelc049e4f2007-10-08 20:57:48 +0000170 llvm::BasicBlock *CaseRangeBlock;
171
Anders Carlssondcc90d82008-12-12 07:19:02 +0000172 // VLASizeMap - This keeps track of the associated size for each VLA type
173 // FIXME: Maybe this could be a stack of maps that is pushed/popped as
174 // we enter/leave scopes.
175 llvm::DenseMap<const VariableArrayType*, llvm::Value*> VLASizeMap;
176
Anders Carlsson17d28a32008-12-12 05:52:00 +0000177 /// StackSaveValues - A stack(!) of stack save values. When a new scope is
178 /// entered, a null is pushed on this stack. If a VLA is emitted, then
179 /// the return value of llvm.stacksave() is stored at the top of this stack.
180 llvm::SmallVector<llvm::Value*, 8> StackSaveValues;
181
Reid Spencer5f016e22007-07-11 17:01:13 +0000182public:
183 CodeGenFunction(CodeGenModule &cgm);
184
185 ASTContext &getContext() const;
186
Chris Lattner391d77a2008-03-30 23:03:07 +0000187 void GenerateObjCMethod(const ObjCMethodDecl *OMD);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000188
Fariborz Jahanian679a5022009-01-10 21:06:09 +0000189 void StartObjCMethod(const ObjCMethodDecl *MD,
190 const ObjCContainerDecl *CD);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000191
192 /// GenerateObjCGetter - Synthesize an Objective-C property getter
193 /// function.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +0000194 void GenerateObjCGetter(ObjCImplementationDecl *IMP,
195 const ObjCPropertyImplDecl *PID);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000196
197 /// GenerateObjCSetter - Synthesize an Objective-C property setter
198 /// function for the given property.
Fariborz Jahanianfef30b52008-12-09 20:23:04 +0000199 void GenerateObjCSetter(ObjCImplementationDecl *IMP,
200 const ObjCPropertyImplDecl *PID);
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000201
Daniel Dunbarbd012ff2008-07-29 23:18:29 +0000202 void GenerateCode(const FunctionDecl *FD,
203 llvm::Function *Fn);
Daniel Dunbar7c086512008-09-09 23:14:03 +0000204 void StartFunction(const Decl *D, QualType RetTy,
205 llvm::Function *Fn,
Daniel Dunbar2284ac92008-10-18 18:22:23 +0000206 const FunctionArgList &Args,
207 SourceLocation StartLoc);
Daniel Dunbara448fb22008-11-11 23:11:34 +0000208
209 /// FinishFunction - Complete IR generation of the current
210 /// function. It is legal to call this function even if there is no
211 /// current insertion point.
Daniel Dunbaraf05bb92008-08-26 08:29:31 +0000212 void FinishFunction(SourceLocation EndLoc=SourceLocation());
Daniel Dunbar17b708d2008-09-09 23:27:19 +0000213
214 /// EmitFunctionProlog - Emit the target specific LLVM code to load
215 /// the arguments for the given function. This is also responsible
216 /// for naming the LLVM function arguments.
217 void EmitFunctionProlog(llvm::Function *Fn, QualType RetTy,
218 const FunctionArgList &Args);
219
220 /// EmitFunctionEpilog - Emit the target specific LLVM code to
221 /// return the given temporary.
222 void EmitFunctionEpilog(QualType RetTy,
223 llvm::Value *ReturnValue);
224
Reid Spencer5f016e22007-07-11 17:01:13 +0000225 const llvm::Type *ConvertType(QualType T);
Chris Lattnerc8aa5f12008-04-04 04:07:35 +0000226
Daniel Dunbarb7ec2462008-08-16 03:19:19 +0000227 /// LoadObjCSelf - Load the value of self. This function is only
228 /// valid while generating code for an Objective-C method.
Chris Lattnerc8aa5f12008-04-04 04:07:35 +0000229 llvm::Value *LoadObjCSelf();
Chris Lattner41110242008-06-17 18:05:57 +0000230
231 /// isObjCPointerType - Return true if the specificed AST type will map onto
232 /// some Objective-C pointer type.
233 static bool isObjCPointerType(QualType T);
234
Reid Spencer5f016e22007-07-11 17:01:13 +0000235 /// hasAggregateLLVMType - Return true if the specified AST type will map into
236 /// an aggregate LLVM type or is void.
237 static bool hasAggregateLLVMType(QualType T);
Daniel Dunbar55e87422008-11-11 02:29:29 +0000238
239 /// createBasicBlock - Create an LLVM basic block.
240 llvm::BasicBlock *createBasicBlock(const char *Name="",
241 llvm::Function *Parent=0,
242 llvm::BasicBlock *InsertBefore=0) {
Daniel Dunbar29ea6722008-11-12 00:01:12 +0000243#ifdef NDEBUG
244 return llvm::BasicBlock::Create("", Parent, InsertBefore);
245#else
Daniel Dunbar55e87422008-11-11 02:29:29 +0000246 return llvm::BasicBlock::Create(Name, Parent, InsertBefore);
Daniel Dunbar29ea6722008-11-12 00:01:12 +0000247#endif
Daniel Dunbar55e87422008-11-11 02:29:29 +0000248 }
249
Reid Spencer5f016e22007-07-11 17:01:13 +0000250 /// getBasicBlockForLabel - Return the LLVM basicblock that the specified
251 /// label maps to.
252 llvm::BasicBlock *getBasicBlockForLabel(const LabelStmt *S);
253
Daniel Dunbara448fb22008-11-11 23:11:34 +0000254 /// EmitBlock - Emit the given block \arg BB and set it as the
255 /// insert point, adding a fall-through branch from the current
256 /// insert block if necessary. It is legal to call this function
257 /// even if there is no current insertion point.
Daniel Dunbara0c21a82008-11-13 01:24:05 +0000258 ///
259 /// IsFinished - If true, indicates that the caller has finished
260 /// emitting branches to the given block and does not expect to emit
261 /// code into it. This means the block can be ignored if it is
262 /// unreachable.
263 void EmitBlock(llvm::BasicBlock *BB, bool IsFinished=false);
Daniel Dunbar824e3bd2008-11-11 04:34:23 +0000264
Daniel Dunbard57a8712008-11-11 09:41:28 +0000265 /// EmitBranch - Emit a branch to the specified basic block from the
266 /// current insert block, taking care to avoid creation of branches
Daniel Dunbara448fb22008-11-11 23:11:34 +0000267 /// from dummy blocks. It is legal to call this function even if
268 /// there is no current insertion point.
Daniel Dunbar5e08ad32008-11-11 22:06:59 +0000269 ///
270 /// This function clears the current insertion point. The caller
271 /// should follow calls to this function with calls to Emit*Block
272 /// prior to generation new code.
Daniel Dunbard57a8712008-11-11 09:41:28 +0000273 void EmitBranch(llvm::BasicBlock *Block);
274
Daniel Dunbara448fb22008-11-11 23:11:34 +0000275 /// HaveInsertPoint - True if an insertion point is defined. If not,
276 /// this indicates that the current code being emitted is
277 /// unreachable.
278 bool HaveInsertPoint() const {
279 return Builder.GetInsertBlock() != 0;
280 }
281
282 /// EnsureInsertPoint - Ensure that an insertion point is defined so
283 /// that emitted IR has a place to go. Note that by definition, if
284 /// this function creates a block then that block is unreachable;
285 /// callers may do better to detect when no insertion point is
286 /// defined and simply skip IR generation.
287 void EnsureInsertPoint() {
288 if (!HaveInsertPoint())
289 EmitBlock(createBasicBlock());
290 }
Chris Lattnerdc5e8262007-12-02 01:43:38 +0000291
Daniel Dunbar488e9932008-08-16 00:56:44 +0000292 /// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerdc5e8262007-12-02 01:43:38 +0000293 /// specified stmt yet.
Daniel Dunbar90df4b62008-09-04 03:43:08 +0000294 void ErrorUnsupported(const Stmt *S, const char *Type,
295 bool OmitOnError=false);
Reid Spencer5f016e22007-07-11 17:01:13 +0000296
297 //===--------------------------------------------------------------------===//
298 // Helpers
299 //===--------------------------------------------------------------------===//
300
301 /// CreateTempAlloca - This creates a alloca and inserts it into the entry
302 /// block.
303 llvm::AllocaInst *CreateTempAlloca(const llvm::Type *Ty,
304 const char *Name = "tmp");
305
306 /// EvaluateExprAsBool - Perform the usual unary conversions on the specified
307 /// expression and compare the result against zero, returning an Int1Ty value.
308 llvm::Value *EvaluateExprAsBool(const Expr *E);
309
Chris Lattner9b655512007-08-31 22:49:20 +0000310 /// EmitAnyExpr - Emit code to compute the specified expression which can have
311 /// any type. The result is returned as an RValue struct. If this is an
312 /// aggregate expression, the aggloc/agglocvolatile arguments indicate where
313 /// the result should be returned.
314 RValue EmitAnyExpr(const Expr *E, llvm::Value *AggLoc = 0,
315 bool isAggLocVolatile = false);
Devang Pateld9363c32007-09-28 21:49:18 +0000316
Daniel Dunbar46f45b92008-09-09 01:06:48 +0000317 /// EmitAnyExprToTemp - Similary to EmitAnyExpr(), however, the result
318 /// will always be accessible even if no aggregate location is
319 /// provided.
320 RValue EmitAnyExprToTemp(const Expr *E, llvm::Value *AggLoc = 0,
321 bool isAggLocVolatile = false);
322
Daniel Dunbar7482d122008-09-09 20:49:46 +0000323 void EmitAggregateCopy(llvm::Value *DestPtr, llvm::Value *SrcPtr,
324 QualType EltTy);
325
326 void EmitAggregateClear(llvm::Value *DestPtr, QualType Ty);
327
Devang Patel51b09f22007-10-04 23:45:31 +0000328 /// StartBlock - Start new block named N. If insert block is a dummy block
329 /// then reuse it.
330 void StartBlock(const char *N);
331
Devang Patel88a981b2007-11-01 19:11:01 +0000332 /// getCGRecordLayout - Return record layout info.
333 const CGRecordLayout *getCGRecordLayout(CodeGenTypes &CGT, QualType RTy);
Lauro Ramos Venancio81373352008-02-26 21:41:45 +0000334
335 /// GetAddrOfStaticLocalVar - Return the address of a static local variable.
Steve Naroff248a7532008-04-15 22:42:06 +0000336 llvm::Constant *GetAddrOfStaticLocalVar(const VarDecl *BVD);
Dan Gohman4f8d1232008-05-22 00:50:06 +0000337
Anders Carlssondde0a942008-09-11 09:15:33 +0000338 /// GetAddrOfLocalVar - Return the address of a local variable.
339 llvm::Value *GetAddrOfLocalVar(const VarDecl *VD);
340
Dan Gohman4f8d1232008-05-22 00:50:06 +0000341 /// getAccessedFieldNo - Given an encoded value and a result number, return
342 /// the input field number being accessed.
343 static unsigned getAccessedFieldNo(unsigned Idx, const llvm::Constant *Elts);
344
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000345 unsigned GetIDForAddrOfLabel(const LabelStmt *L);
346
Anders Carlsson3d8400d2008-08-30 19:51:14 +0000347 /// EmitMemSetToZero - Generate code to memset a value of the given type to 0;
348 void EmitMemSetToZero(llvm::Value *DestPtr, QualType Ty);
Anders Carlssonddf7cac2008-11-04 05:30:00 +0000349
350 // EmitVAArg - Generate code to get an argument from the passed in pointer
351 // and update it accordingly. The return value is a pointer to the argument.
352 // FIXME: We should be able to get rid of this method and use the va_arg
353 // instruction in LLVM instead once it works well enough.
354 llvm::Value *EmitVAArg(llvm::Value *VAListAddr, QualType Ty);
Anders Carlssonf666b772008-12-20 20:27:15 +0000355
Anders Carlsson60d35412008-12-20 20:46:34 +0000356 // EmitVLASize - Generate code for any VLA size expressions that might occur
357 // in a variably modified type. If Ty is a VLA, will return the value that
358 // corresponds to the size in bytes of the VLA type. Will return 0 otherwise.
359 llvm::Value *EmitVLASize(QualType Ty);
Anders Carlssonf666b772008-12-20 20:27:15 +0000360
Anders Carlssondcc90d82008-12-12 07:19:02 +0000361 // GetVLASize - Returns an LLVM value that corresponds to the size in bytes
362 // of a variable length array type.
363 llvm::Value *GetVLASize(const VariableArrayType *);
364
Reid Spencer5f016e22007-07-11 17:01:13 +0000365 //===--------------------------------------------------------------------===//
Reid Spencer5f016e22007-07-11 17:01:13 +0000366 // Declaration Emission
367 //===--------------------------------------------------------------------===//
368
369 void EmitDecl(const Decl &D);
Steve Naroff248a7532008-04-15 22:42:06 +0000370 void EmitBlockVarDecl(const VarDecl &D);
371 void EmitLocalBlockVarDecl(const VarDecl &D);
372 void EmitStaticBlockVarDecl(const VarDecl &D);
Daniel Dunbarb7ec2462008-08-16 03:19:19 +0000373
374 /// EmitParmDecl - Emit a ParmVarDecl or an ImplicitParamDecl.
375 void EmitParmDecl(const VarDecl &D, llvm::Value *Arg);
Reid Spencer5f016e22007-07-11 17:01:13 +0000376
377 //===--------------------------------------------------------------------===//
378 // Statement Emission
379 //===--------------------------------------------------------------------===//
380
Daniel Dunbar09124252008-11-12 08:21:33 +0000381 /// EmitStopPoint - Emit a debug stoppoint if we are emitting debug
382 /// info.
383 void EmitStopPoint(const Stmt *S);
384
Daniel Dunbara448fb22008-11-11 23:11:34 +0000385 /// EmitStmt - Emit the code for the statement \arg S. It is legal
386 /// to call this function even if there is no current insertion
387 /// point.
388 ///
389 /// This function may clear the current insertion point; callers
390 /// should use EnsureInsertPoint if they wish to subsequently
391 /// generate code without first calling EmitBlock, EmitBranch, or
392 /// EmitStmt.
Reid Spencer5f016e22007-07-11 17:01:13 +0000393 void EmitStmt(const Stmt *S);
Daniel Dunbara448fb22008-11-11 23:11:34 +0000394
Daniel Dunbar09124252008-11-12 08:21:33 +0000395 /// EmitSimpleStmt - Try to emit a "simple" statement which does not
396 /// necessarily require an insertion point or debug information;
397 /// typically because the statement amounts to a jump or a container
398 /// of other statements.
399 ///
400 /// \return True if the statement was handled.
401 bool EmitSimpleStmt(const Stmt *S);
402
Chris Lattner9b655512007-08-31 22:49:20 +0000403 RValue EmitCompoundStmt(const CompoundStmt &S, bool GetLast = false,
404 llvm::Value *AggLoc = 0, bool isAggVol = false);
Daniel Dunbara448fb22008-11-11 23:11:34 +0000405
406 /// EmitLabel - Emit the block for the given label. It is legal
407 /// to call this function even if there is no current insertion
408 /// point.
Chris Lattner91d723d2008-07-26 20:23:23 +0000409 void EmitLabel(const LabelStmt &S); // helper for EmitLabelStmt.
Daniel Dunbara448fb22008-11-11 23:11:34 +0000410
Reid Spencer5f016e22007-07-11 17:01:13 +0000411 void EmitLabelStmt(const LabelStmt &S);
412 void EmitGotoStmt(const GotoStmt &S);
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000413 void EmitIndirectGotoStmt(const IndirectGotoStmt &S);
Reid Spencer5f016e22007-07-11 17:01:13 +0000414 void EmitIfStmt(const IfStmt &S);
415 void EmitWhileStmt(const WhileStmt &S);
416 void EmitDoStmt(const DoStmt &S);
417 void EmitForStmt(const ForStmt &S);
418 void EmitReturnStmt(const ReturnStmt &S);
419 void EmitDeclStmt(const DeclStmt &S);
Daniel Dunbar09124252008-11-12 08:21:33 +0000420 void EmitBreakStmt(const BreakStmt &S);
421 void EmitContinueStmt(const ContinueStmt &S);
Devang Patel51b09f22007-10-04 23:45:31 +0000422 void EmitSwitchStmt(const SwitchStmt &S);
423 void EmitDefaultStmt(const DefaultStmt &S);
424 void EmitCaseStmt(const CaseStmt &S);
Devang Patelc049e4f2007-10-08 20:57:48 +0000425 void EmitCaseStmtRange(const CaseStmt &S);
Anders Carlssonfb1aeb82008-02-05 16:35:33 +0000426 void EmitAsmStmt(const AsmStmt &S);
427
Anders Carlsson3d8400d2008-08-30 19:51:14 +0000428 void EmitObjCForCollectionStmt(const ObjCForCollectionStmt &S);
Anders Carlsson64d5d6c2008-09-09 10:04:29 +0000429 void EmitObjCAtTryStmt(const ObjCAtTryStmt &S);
430 void EmitObjCAtThrowStmt(const ObjCAtThrowStmt &S);
Chris Lattner10cac6f2008-11-15 21:26:17 +0000431 void EmitObjCAtSynchronizedStmt(const ObjCAtSynchronizedStmt &S);
Anders Carlsson3d8400d2008-08-30 19:51:14 +0000432
Reid Spencer5f016e22007-07-11 17:01:13 +0000433 //===--------------------------------------------------------------------===//
434 // LValue Expression Emission
435 //===--------------------------------------------------------------------===//
436
Daniel Dunbarce1d38b2009-01-09 16:50:52 +0000437 /// EmitUnsupportedRValue - Emit a dummy r-value using the type of E
438 /// and issue an ErrorUnsupported style diagnostic (using the
439 /// provided Name).
440 RValue EmitUnsupportedRValue(const Expr *E,
441 const char *Name);
442
Daniel Dunbar6ba82a42008-08-25 20:45:57 +0000443 /// EmitUnsupportedLValue - Emit a dummy l-value using the type of E
444 /// and issue an ErrorUnsupported style diagnostic (using the
445 /// provided Name).
446 LValue EmitUnsupportedLValue(const Expr *E,
447 const char *Name);
448
Reid Spencer5f016e22007-07-11 17:01:13 +0000449 /// EmitLValue - Emit code to compute a designator that specifies the location
450 /// of the expression.
451 ///
452 /// This can return one of two things: a simple address or a bitfield
453 /// reference. In either case, the LLVM Value* in the LValue structure is
454 /// guaranteed to be an LLVM pointer type.
455 ///
456 /// If this returns a bitfield reference, nothing about the pointee type of
457 /// the LLVM value is known: For example, it may not be a pointer to an
458 /// integer.
459 ///
460 /// If this returns a normal address, and if the lvalue's C type is fixed
461 /// size, this method guarantees that the returned pointer type will point to
462 /// an LLVM type of the same size of the lvalue's type. If the lvalue has a
463 /// variable length type, this is not possible.
464 ///
465 LValue EmitLValue(const Expr *E);
466
467 /// EmitLoadOfLValue - Given an expression that represents a value lvalue,
468 /// this method emits the address of the lvalue, then loads the result as an
469 /// rvalue, returning the rvalue.
Reid Spencer5f016e22007-07-11 17:01:13 +0000470 RValue EmitLoadOfLValue(LValue V, QualType LVType);
Nate Begeman213541a2008-04-18 23:10:10 +0000471 RValue EmitLoadOfExtVectorElementLValue(LValue V, QualType LVType);
Lauro Ramos Venancio3b8c22d2008-01-22 20:17:04 +0000472 RValue EmitLoadOfBitfieldLValue(LValue LV, QualType ExprType);
Daniel Dunbar85c59ed2008-08-29 08:11:39 +0000473 RValue EmitLoadOfPropertyRefLValue(LValue LV, QualType ExprType);
Fariborz Jahanian43f44702008-11-22 22:30:21 +0000474 RValue EmitLoadOfKVCRefLValue(LValue LV, QualType ExprType);
Reid Spencer5f016e22007-07-11 17:01:13 +0000475
Chris Lattner34cdc862007-08-03 16:18:34 +0000476
Reid Spencer5f016e22007-07-11 17:01:13 +0000477 /// EmitStoreThroughLValue - Store the specified rvalue into the specified
478 /// lvalue, where both are guaranteed to the have the same type, and that type
479 /// is 'Ty'.
480 void EmitStoreThroughLValue(RValue Src, LValue Dst, QualType Ty);
Nate Begeman213541a2008-04-18 23:10:10 +0000481 void EmitStoreThroughExtVectorComponentLValue(RValue Src, LValue Dst,
482 QualType Ty);
Daniel Dunbar85c59ed2008-08-29 08:11:39 +0000483 void EmitStoreThroughPropertyRefLValue(RValue Src, LValue Dst, QualType Ty);
Fariborz Jahanian43f44702008-11-22 22:30:21 +0000484 void EmitStoreThroughKVCRefLValue(RValue Src, LValue Dst, QualType Ty);
Daniel Dunbared3849b2008-11-19 09:36:46 +0000485
486 /// EmitStoreThroughLValue - Store Src into Dst with same
487 /// constraints as EmitStoreThroughLValue.
488 ///
489 /// \param Result [out] - If non-null, this will be set to a Value*
490 /// for the bit-field contents after the store, appropriate for use
491 /// as the result of an assignment to the bit-field.
492 void EmitStoreThroughBitfieldLValue(RValue Src, LValue Dst, QualType Ty,
493 llvm::Value **Result=0);
Christopher Lamb22c940e2007-12-29 05:02:41 +0000494
495 // Note: only availabe for agg return types
Daniel Dunbar80e62c22008-09-04 03:20:13 +0000496 LValue EmitBinaryOperatorLValue(const BinaryOperator *E);
497 // Note: only availabe for agg return types
Christopher Lamb22c940e2007-12-29 05:02:41 +0000498 LValue EmitCallExprLValue(const CallExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +0000499 LValue EmitDeclRefLValue(const DeclRefExpr *E);
500 LValue EmitStringLiteralLValue(const StringLiteral *E);
Daniel Dunbar662b71e2008-10-17 21:58:32 +0000501 LValue EmitPredefinedFunctionName(unsigned Type);
Chris Lattnerd9f69102008-08-10 01:53:14 +0000502 LValue EmitPredefinedLValue(const PredefinedExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +0000503 LValue EmitUnaryOpLValue(const UnaryOperator *E);
504 LValue EmitArraySubscriptExpr(const ArraySubscriptExpr *E);
Nate Begeman213541a2008-04-18 23:10:10 +0000505 LValue EmitExtVectorElementExpr(const ExtVectorElementExpr *E);
Devang Patelb84a06e2007-10-23 02:10:49 +0000506 LValue EmitMemberExpr(const MemberExpr *E);
Eli Friedman06e863f2008-05-13 23:18:27 +0000507 LValue EmitCompoundLiteralLValue(const CompoundLiteralExpr *E);
Eli Friedman472778e2008-02-09 08:50:58 +0000508
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +0000509 llvm::Value *EmitIvarOffset(ObjCInterfaceDecl *Interface,
510 const ObjCIvarDecl *Ivar);
Eli Friedman472778e2008-02-09 08:50:58 +0000511 LValue EmitLValueForField(llvm::Value* Base, FieldDecl* Field,
Eli Friedman1e692ac2008-06-13 23:01:12 +0000512 bool isUnion, unsigned CVRQualifiers);
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +0000513 LValue EmitLValueForIvar(llvm::Value* Base, const ObjCIvarDecl *Ivar,
Fariborz Jahanianfd64bb62008-12-15 20:35:07 +0000514 const FieldDecl *Field,
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +0000515 unsigned CVRQualifiers);
516
Fariborz Jahanianfd64bb62008-12-15 20:35:07 +0000517 LValue EmitLValueForBitfield(llvm::Value* Base, FieldDecl* Field,
518 unsigned CVRQualifiers, unsigned idx);
519
Argyrios Kyrtzidise3a09e62008-09-10 02:36:38 +0000520 LValue EmitCXXConditionDeclLValue(const CXXConditionDeclExpr *E);
521
Daniel Dunbar0a04d772008-08-23 10:51:21 +0000522 LValue EmitObjCMessageExprLValue(const ObjCMessageExpr *E);
Chris Lattner391d77a2008-03-30 23:03:07 +0000523 LValue EmitObjCIvarRefLValue(const ObjCIvarRefExpr *E);
Daniel Dunbar85c59ed2008-08-29 08:11:39 +0000524 LValue EmitObjCPropertyRefLValue(const ObjCPropertyRefExpr *E);
Fariborz Jahanian43f44702008-11-22 22:30:21 +0000525 LValue EmitObjCKVCRefLValue(const ObjCKVCRefExpr *E);
Douglas Gregorcd9b46e2008-11-04 14:56:14 +0000526 LValue EmitObjCSuperExpr(const ObjCSuperExpr *E);
Daniel Dunbar0a04d772008-08-23 10:51:21 +0000527
Reid Spencer5f016e22007-07-11 17:01:13 +0000528 //===--------------------------------------------------------------------===//
Chris Lattner883f6a72007-08-11 00:04:45 +0000529 // Scalar Expression Emission
Reid Spencer5f016e22007-07-11 17:01:13 +0000530 //===--------------------------------------------------------------------===//
531
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +0000532 /// EmitCall - Generate a call of the given function, expecting the
533 /// given result type, and using the given argument list which
534 /// specifies both the LLVM arguments and the types they were
535 /// derived from.
Daniel Dunbar19cd87e2008-08-30 03:02:31 +0000536 RValue EmitCall(llvm::Value *Callee,
537 QualType ResultType,
538 const CallArgList &Args);
539
Reid Spencer5f016e22007-07-11 17:01:13 +0000540 RValue EmitCallExpr(const CallExpr *E);
Ted Kremenek55499762008-06-17 02:43:46 +0000541
542 RValue EmitCallExpr(Expr *FnExpr, CallExpr::const_arg_iterator ArgBeg,
543 CallExpr::const_arg_iterator ArgEnd);
544
Eli Friedman5193b8a2008-01-30 01:32:06 +0000545 RValue EmitCallExpr(llvm::Value *Callee, QualType FnType,
Ted Kremenek55499762008-06-17 02:43:46 +0000546 CallExpr::const_arg_iterator ArgBeg,
547 CallExpr::const_arg_iterator ArgEnd);
548
Chris Lattner1e4d21e2007-08-26 22:58:05 +0000549 RValue EmitBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
Reid Spencer5f016e22007-07-11 17:01:13 +0000550
Daniel Dunbarf02e9dd2008-10-10 00:24:54 +0000551 /// EmitTargetBuiltinExpr - Emit the given builtin call. Returns 0
552 /// if the call is unhandled by the current target.
553 llvm::Value *EmitTargetBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
554
Anders Carlsson564f1de2007-12-09 23:17:02 +0000555 llvm::Value *EmitX86BuiltinExpr(unsigned BuiltinID, const CallExpr *E);
556 llvm::Value *EmitPPCBuiltinExpr(unsigned BuiltinID, const CallExpr *E);
557
Anders Carlssoncc23aca2007-12-10 19:35:18 +0000558 llvm::Value *EmitShuffleVector(llvm::Value* V1, llvm::Value *V2, ...);
Nate Begeman4119d1a2007-12-30 02:59:45 +0000559 llvm::Value *EmitVector(llvm::Value * const *Vals, unsigned NumVals,
560 bool isSplat = false);
Anders Carlsson6086bbd2007-12-15 21:23:30 +0000561
Daniel Dunbared7c6182008-08-20 00:28:19 +0000562 llvm::Value *EmitObjCProtocolExpr(const ObjCProtocolExpr *E);
Chris Lattner7f02f722007-08-24 05:35:26 +0000563 llvm::Value *EmitObjCStringLiteral(const ObjCStringLiteral *E);
Chris Lattner8fdf3282008-06-24 17:04:18 +0000564 llvm::Value *EmitObjCSelectorExpr(const ObjCSelectorExpr *E);
Daniel Dunbar8f2926b2008-08-23 03:46:30 +0000565 RValue EmitObjCMessageExpr(const ObjCMessageExpr *E);
Fariborz Jahanian5daf5702008-11-22 18:39:36 +0000566 RValue EmitObjCPropertyGet(const Expr *E);
Fariborz Jahanian43f44702008-11-22 22:30:21 +0000567 void EmitObjCPropertySet(const Expr *E, RValue Src);
Chris Lattner8fdf3282008-06-24 17:04:18 +0000568
569
Chris Lattner883f6a72007-08-11 00:04:45 +0000570 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +0000571 // Expression Emission
Chris Lattner883f6a72007-08-11 00:04:45 +0000572 //===--------------------------------------------------------------------===//
Chris Lattnerbfc0c1a2007-08-26 23:13:56 +0000573
574 // Expressions are broken into three classes: scalar, complex, aggregate.
Chris Lattner883f6a72007-08-11 00:04:45 +0000575
Chris Lattner7f02f722007-08-24 05:35:26 +0000576 /// EmitScalarExpr - Emit the computation of the specified expression of
577 /// LLVM scalar type, returning the result.
578 llvm::Value *EmitScalarExpr(const Expr *E);
579
Chris Lattner3707b252007-08-26 06:48:56 +0000580 /// EmitScalarConversion - Emit a conversion from the specified type to the
581 /// specified destination type, both of which are LLVM scalar types.
582 llvm::Value *EmitScalarConversion(llvm::Value *Src, QualType SrcTy,
583 QualType DstTy);
584
Chris Lattner4f1a7b32007-08-26 16:34:22 +0000585 /// EmitComplexToScalarConversion - Emit a conversion from the specified
586 /// complex type to the specified destination type, where the destination
587 /// type is an LLVM scalar type.
588 llvm::Value *EmitComplexToScalarConversion(ComplexPairTy Src, QualType SrcTy,
589 QualType DstTy);
590
Chris Lattner3707b252007-08-26 06:48:56 +0000591
Chris Lattner883f6a72007-08-11 00:04:45 +0000592 /// EmitAggExpr - Emit the computation of the specified expression of
593 /// aggregate type. The result is computed into DestPtr. Note that if
594 /// DestPtr is null, the value of the aggregate expression is not needed.
595 void EmitAggExpr(const Expr *E, llvm::Value *DestPtr, bool VolatileDest);
Chris Lattnerb6ef18a2007-08-21 05:54:00 +0000596
597 /// EmitComplexExpr - Emit the computation of the specified expression of
Chris Lattner23b1cdb2007-08-23 23:43:33 +0000598 /// complex type, returning the result.
Chris Lattner58dee102007-08-21 16:57:55 +0000599 ComplexPairTy EmitComplexExpr(const Expr *E);
Chris Lattner23b1cdb2007-08-23 23:43:33 +0000600
601 /// EmitComplexExprIntoAddr - Emit the computation of the specified expression
602 /// of complex type, storing into the specified Value*.
Chris Lattner190dbe22007-08-26 16:22:13 +0000603 void EmitComplexExprIntoAddr(const Expr *E, llvm::Value *DestAddr,
604 bool DestIsVolatile);
Daniel Dunbar7f8ea5c2008-08-30 05:35:15 +0000605
606 /// StoreComplexToAddr - Store a complex number into the specified address.
607 void StoreComplexToAddr(ComplexPairTy V, llvm::Value *DestAddr,
608 bool DestIsVolatile);
Chris Lattner9b655512007-08-31 22:49:20 +0000609 /// LoadComplexFromAddr - Load a complex number from the specified address.
610 ComplexPairTy LoadComplexFromAddr(llvm::Value *SrcAddr, bool SrcIsVolatile);
Chris Lattner2621fd12008-05-08 05:58:21 +0000611
612 /// GenerateStaticBlockVarDecl - return the the static
613 /// declaration of local variable.
614 llvm::GlobalValue *GenerateStaticBlockVarDecl(const VarDecl &D,
615 bool NoInit,
616 const char *Separator);
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000617
Anders Carlssone1b29ef2008-08-22 16:00:37 +0000618 // GenerateStaticBlockVarDecl - return the static declaration of
619 // a local variable. Performs initialization of the variable if necessary.
620 llvm::GlobalValue *GenerateStaticCXXBlockVarDecl(const VarDecl &D);
621
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000622 //===--------------------------------------------------------------------===//
623 // Internal Helpers
624 //===--------------------------------------------------------------------===//
625
Chris Lattner0946ccd2008-11-11 07:41:27 +0000626 /// ContainsLabel - Return true if the statement contains a label in it. If
627 /// this statement is not executed normally, it not containing a label means
628 /// that we can just remove the code.
629 static bool ContainsLabel(const Stmt *S, bool IgnoreCaseStmts = false);
630
Daniel Dunbar4bc04552008-11-12 10:12:14 +0000631 /// ConstantFoldsToSimpleInteger - If the specified expression does not fold
Chris Lattner31a09842008-11-12 08:04:58 +0000632 /// to a constant, or if it does but contains a label, return 0. If it
633 /// constant folds to 'true' and does not contain a label, return 1, if it
634 /// constant folds to 'false' and does not contain a label, return -1.
635 int ConstantFoldsToSimpleInteger(const Expr *Cond);
636
637 /// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an
638 /// if statement) to the specified blocks. Based on the condition, this might
639 /// try to simplify the codegen of the conditional based on the branch.
640 ///
Chris Lattner9bc47e22008-11-12 07:46:33 +0000641 void EmitBranchOnBoolExpr(const Expr *Cond, llvm::BasicBlock *TrueBlock,
Daniel Dunbar4bc04552008-11-12 10:12:14 +0000642 llvm::BasicBlock *FalseBlock);
Chris Lattner31a09842008-11-12 08:04:58 +0000643private:
Chris Lattner0946ccd2008-11-11 07:41:27 +0000644
Daniel Dunbar0ffb1252008-08-04 16:51:22 +0000645 /// EmitIndirectSwitches - Emit code for all of the switch
646 /// instructions in IndirectSwitches.
647 void EmitIndirectSwitches();
Daniel Dunbar56273772008-09-17 00:51:38 +0000648
Daniel Dunbar29e0bcc2008-09-24 04:00:38 +0000649 void EmitReturnOfRValue(RValue RV, QualType Ty);
650
Daniel Dunbar56273772008-09-17 00:51:38 +0000651 /// ExpandTypeFromArgs - Reconstruct a structure of type \arg Ty
652 /// from function arguments into \arg Dst. See ABIArgInfo::Expand.
653 ///
654 /// \param AI - The first function argument of the expansion.
655 /// \return The argument following the last expanded function
656 /// argument.
657 llvm::Function::arg_iterator
658 ExpandTypeFromArgs(QualType Ty, LValue Dst,
659 llvm::Function::arg_iterator AI);
660
661 /// ExpandTypeToArgs - Expand an RValue \arg Src, with the LLVM type
662 /// for \arg Ty, into individual arguments on the provided vector
663 /// \arg Args. See ABIArgInfo::Expand.
664 void ExpandTypeToArgs(QualType Ty, RValue Src,
665 llvm::SmallVector<llvm::Value*, 16> &Args);
Anders Carlssonc8c7b182009-01-11 19:40:10 +0000666
667 llvm::Value* EmitAsmInput(const AsmStmt &S, TargetInfo::ConstraintInfo Info,
668 const Expr *InputExpr, std::string &ConstraintStr);
669
Reid Spencer5f016e22007-07-11 17:01:13 +0000670};
671} // end namespace CodeGen
672} // end namespace clang
673
674#endif