2008-05-22 Sam Weinig <sam@webkit.org>
[WebKit.git] / JavaScriptCore / VM / CodeGenerator.h
1 // -*- mode: c++; c-basic-offset: 4 -*-
2 /*
3  * Copyright (C) 2008 Apple Inc. All rights reserved.
4  * Copyright (C) 2008 Cameron Zwarich <cwzwarich@uwaterloo.ca>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer.
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution.
15  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16  *     its contributors may be used to endorse or promote products derived
17  *     from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef CodeGenerator_h
32 #define CodeGenerator_h
33
34 #include "CodeBlock.h"
35 #include "HashTraits.h"
36 #include "Instruction.h"
37 #include "LabelID.h"
38 #include "Machine.h"
39 #include "RegisterID.h"
40 #include "SymbolTable.h"
41 #include "SegmentedVector.h"
42 #include "debugger.h"
43 #include "nodes.h"
44 #include <wtf/PassRefPtr.h>
45 #include <wtf/Vector.h>
46
47 namespace KJS {
48
49     class Identifier;
50     class ScopeChain;
51     class ScopeNode;
52
53     // JumpContexts are used to track entry and exit points for javascript loops and switch statements
54     struct JumpContext {
55         LabelStack* labels;
56         LabelID* continueTarget;
57         LabelID* breakTarget;
58         int scopeDepth;
59         bool isValidUnlabeledBreakTarget;
60     };
61
62     struct FinallyContext {
63         LabelID* finallyAddr;
64         RegisterID* retAddrDst;
65     };
66     
67     struct ControlFlowContext {
68         bool isFinallyBlock;
69         FinallyContext finallyContext;
70     };
71     
72     class CodeGenerator {
73     public:
74         typedef DeclarationStacks::VarStack VarStack;
75         typedef DeclarationStacks::FunctionStack FunctionStack;
76         
77         static void setDumpsGeneratedCode(bool dumpsGeneratedCode);
78         
79         CodeGenerator(ProgramNode*, const Debugger*, const ScopeChain&, SymbolTable*, CodeBlock*, VarStack&, FunctionStack&, bool canCreateGlobals);
80         CodeGenerator(FunctionBodyNode*, const Debugger*, const ScopeChain&, SymbolTable*, CodeBlock*, VarStack&, FunctionStack&, Vector<Identifier>& parameters);
81         CodeGenerator(EvalNode*, const Debugger*, const ScopeChain&, SymbolTable*, EvalCodeBlock*, VarStack&, FunctionStack& functionStack);
82
83         ~CodeGenerator();
84
85         const CommonIdentifiers& propertyNames() const { return *m_propertyNames; }
86
87         void generate();
88
89         // Returns the register corresponding to a local variable, or 0 if no
90         // such register exists. Registers returned by registerForLocal do not
91         // require explicit reference counting.
92         RegisterID* registerForLocal(const Identifier&);
93         // Behaves as registerForLocal does, but ignores dynamic scope as
94         // dynamic scope should not interfere with const initialisation
95         RegisterID* registerForLocalConstInit(const Identifier&);
96
97         // Searches the scope chain in an attempt to  statically locate the requested
98         // property.  Returns false if for any reason the property cannot be safely 
99         // optimised at all.  Otherwise it will return the index and depth of the
100         // VariableObject that defines the property.  If the property cannot be found 
101         // statically, depth will contain the depth of the scope chain where dynamic
102         // lookup must begin.
103         //
104         // NB: depth does _not_ include the local scope.  eg. a depth of 0 refers
105         // to the scope containing this codeblock.
106         bool findScopedProperty(const Identifier&, int& index, size_t& depth);
107
108         // Returns the register storing "this"
109         RegisterID* thisRegister() { return m_thisRegister; }
110
111         bool isLocalConstant(const Identifier&);
112
113         // Returns the next available temporary register. Registers returned by
114         // newTemporary require a modified form of reference counting: any
115         // register with a refcount of 0 is considered "available", meaning that
116         // the next instruction may overwrite it.
117         RegisterID* newTemporary();
118
119         // The same as newTemporary(), but this function returns "suggestion" if
120         // "suggestion" is a temporary. This function is helpful in situations
121         // where you've put "suggestion" in a RefPtr, but you'd like to allow
122         // the next instruction to overwrite it anyway.
123         RegisterID* newTemporaryOr(RegisterID* suggestion) { return suggestion->isTemporary() ? suggestion : newTemporary(); }
124
125         // Functions for handling of dst register
126
127         // Returns  a place to write intermediate values of an operation
128         // which reuses dst if it is safe to do so.
129
130         RegisterID* tempDestination(RegisterID* dst) { return (dst && dst->isTemporary()) ? dst : newTemporary(); }
131
132         // Returns the place to write the final output of an operation.
133         RegisterID* finalDestination(RegisterID* originalDst, RegisterID* tempDst = 0) 
134         { 
135             if (originalDst)
136                 return originalDst;
137             if (tempDst && tempDst->isTemporary())
138                 return tempDst;
139             return newTemporary(); 
140         }
141         
142         RegisterID* destinationForAssignResult(RegisterID* dst) { 
143             if (dst && m_codeBlock->needsFullScopeChain) 
144                 return dst->isTemporary() ? dst : newTemporary();
145             return 0;
146         }
147
148         // moves src to dst if dst is not null and is different from src, otherwise just returns src
149         RegisterID* moveToDestinationIfNeeded(RegisterID* dst, RegisterID* src) { return (dst && dst != src) ? emitMove(dst, src) : src; }
150
151
152         PassRefPtr<LabelID> newLabel();
153         
154         // The emitNode functions are just syntactic sugar for calling
155         // Node::emitCode. They're the only functions that accept a NULL register.
156         RegisterID* emitNode(RegisterID* dst, Node* n) {
157             // Node::emitCode assumes that dst, if provided, is either a local or a referenced temporary.
158             ASSERT(!dst || !dst->isTemporary() || dst->refCount());
159             if (!m_codeBlock->lineInfo.size() || m_codeBlock->lineInfo.last().lineNumber != n->lineNo()) {
160                 LineInfo info = { instructions().size(), n->lineNo() };
161                 m_codeBlock->lineInfo.append(info);
162             }
163             return n->emitCode(*this, dst);
164         }
165
166         RegisterID* emitNode(Node* n)
167         {
168             return emitNode(0, n);
169         }
170
171         ALWAYS_INLINE bool leftHandSideNeedsCopy(bool rightHasAssignments)
172         {
173             return m_codeBlock->needsFullScopeChain || rightHasAssignments;
174         }
175
176         ALWAYS_INLINE PassRefPtr<RegisterID> emitNodeForLeftHandSide(ExpressionNode* n, bool rightHasAssignments)
177         {
178             if (leftHandSideNeedsCopy(rightHasAssignments)) {
179                 PassRefPtr<RegisterID> dst = newTemporary();
180                 emitNode(dst.get(), n);
181                 return dst;
182             }
183             
184             return PassRefPtr<RegisterID>(emitNode(n));
185         }
186
187         RegisterID* emitLoad(RegisterID* dst, bool);
188         RegisterID* emitLoad(RegisterID* dst, double);
189         RegisterID* emitLoad(RegisterID* dst, JSValue*);
190         
191         RegisterID* emitNewObject(RegisterID* dst);
192         RegisterID* emitNewArray(RegisterID* dst);
193
194         RegisterID* emitNewFunction(RegisterID* dst, FuncDeclNode* func);
195         RegisterID* emitNewFunctionExpression(RegisterID* dst, FuncExprNode* func);
196         RegisterID* emitNewRegExp(RegisterID* dst, RegExp* regExp);
197
198         RegisterID* emitMove(RegisterID* dst, RegisterID* src);
199
200         RegisterID* emitNot(RegisterID* dst, RegisterID* src);
201         RegisterID* emitEqual(RegisterID* dst, RegisterID* src1, RegisterID* src2);
202         RegisterID* emitNotEqual(RegisterID* dst, RegisterID* src1, RegisterID* src2);
203         RegisterID* emitStrictEqual(RegisterID* dst, RegisterID* src1, RegisterID* src2);
204         RegisterID* emitNotStrictEqual(RegisterID* dst, RegisterID* src1, RegisterID* src2);
205         RegisterID* emitLess(RegisterID* dst, RegisterID* src1, RegisterID* src2);
206         RegisterID* emitLessEq(RegisterID* dst, RegisterID* src1, RegisterID* src2);
207
208         RegisterID* emitToJSNumber(RegisterID* dst, RegisterID* src);
209         RegisterID* emitNegate(RegisterID* dst, RegisterID* src);
210         RegisterID* emitPreInc(RegisterID* srcDst);
211         RegisterID* emitPreDec(RegisterID* srcDst);
212         RegisterID* emitPostInc(RegisterID* dst, RegisterID* srcDst);
213         RegisterID* emitPostDec(RegisterID* dst, RegisterID* srcDst);
214         RegisterID* emitAdd(RegisterID* dst, RegisterID* src1, RegisterID* src2);
215         RegisterID* emitMul(RegisterID* dst, RegisterID* src1, RegisterID* src2);
216         RegisterID* emitDiv(RegisterID* dst, RegisterID* dividend, RegisterID* divisor);
217         RegisterID* emitMod(RegisterID* dst, RegisterID* dividend, RegisterID* divisor);
218         RegisterID* emitSub(RegisterID* dst, RegisterID* src1, RegisterID* src2);
219
220         RegisterID* emitLeftShift(RegisterID* dst, RegisterID* val, RegisterID* shift);
221         RegisterID* emitRightShift(RegisterID* dst, RegisterID* val, RegisterID* shift);
222         RegisterID* emitUnsignedRightShift(RegisterID* dst, RegisterID* val, RegisterID* shift);
223
224         RegisterID* emitBitAnd(RegisterID* dst, RegisterID* src1, RegisterID* src2);
225         RegisterID* emitBitXOr(RegisterID* dst, RegisterID* src1, RegisterID* src2);
226         RegisterID* emitBitOr(RegisterID* dst, RegisterID* src1, RegisterID* src2);
227         RegisterID* emitBitNot(RegisterID* dst, RegisterID* src);
228
229         RegisterID* emitInstanceOf(RegisterID* dst, RegisterID* value, RegisterID* base);
230         RegisterID* emitTypeOf(RegisterID* dst, RegisterID* src);
231         RegisterID* emitIn(RegisterID* dst, RegisterID* property, RegisterID* base);
232
233         RegisterID* emitResolve(RegisterID* dst, const Identifier& property);
234         RegisterID* emitGetScopedVar(RegisterID* dst, size_t skip, int index);
235         RegisterID* emitPutScopedVar(size_t skip, int index, RegisterID* value);
236
237         RegisterID* emitResolveBase(RegisterID* dst, const Identifier& property);
238         RegisterID* emitResolveWithBase(RegisterID* baseDst, RegisterID* propDst, const Identifier& property);
239         RegisterID* emitResolveFunction(RegisterID* baseDst, RegisterID* funcDst, const Identifier& property);
240
241         RegisterID* emitGetById(RegisterID* dst, RegisterID* base, const Identifier& property);
242         RegisterID* emitPutById(RegisterID* base, const Identifier& property, RegisterID* value);
243         RegisterID* emitDeleteById(RegisterID* dst, RegisterID* base, const Identifier&);
244         RegisterID* emitGetByVal(RegisterID* dst, RegisterID* base, RegisterID* property);
245         RegisterID* emitPutByVal(RegisterID* base, RegisterID* property, RegisterID* value);
246         RegisterID* emitDeleteByVal(RegisterID* dst, RegisterID* base, RegisterID* property);
247         RegisterID* emitPutByIndex(RegisterID* base, unsigned index, RegisterID* value);
248         RegisterID* emitPutGetter(RegisterID* base, const Identifier& property, RegisterID* value);
249         RegisterID* emitPutSetter(RegisterID* base, const Identifier& property, RegisterID* value);
250
251         RegisterID* emitCall(RegisterID* dst, RegisterID* func, RegisterID* base, ArgumentsNode*);
252         RegisterID* emitCallEval(RegisterID* dst, RegisterID* func, RegisterID* base, ArgumentsNode*);
253         RegisterID* emitReturn(RegisterID*);
254         RegisterID* emitEnd(RegisterID* dst);
255
256         RegisterID* emitConstruct(RegisterID* dst, RegisterID* func, ArgumentsNode*);
257
258         PassRefPtr<LabelID> emitLabel(LabelID*);
259         PassRefPtr<LabelID> emitJump(LabelID* target);
260         PassRefPtr<LabelID> emitJumpIfTrue(RegisterID* cond, LabelID* target);
261         PassRefPtr<LabelID> emitJumpIfFalse(RegisterID* cond, LabelID* target);
262         PassRefPtr<LabelID> emitJumpScopes(LabelID* target, int targetScopeDepth);
263
264         PassRefPtr<LabelID> emitJumpSubroutine(RegisterID* retAddrDst, LabelID*);
265         void emitSubroutineReturn(RegisterID* retAddrSrc);
266         
267         RegisterID* emitGetPropertyNames(RegisterID* dst, RegisterID* base);
268         RegisterID* emitNextPropertyName(RegisterID* dst, RegisterID* iter, LabelID* target);
269
270         RegisterID* emitCatch(RegisterID*, LabelID* start, LabelID* end);
271         void emitThrow(RegisterID*);
272         RegisterID* emitNewError(RegisterID* dst, ErrorType type, JSValue* message);
273         
274         RegisterID* emitPushScope(RegisterID* scope);
275         void emitPopScope();
276         
277         void emitDebugHook(DebugHookID, int firstLine, int lastLine);
278
279         int scopeDepth() { return m_dynamicScopeDepth + m_finallyDepth; }
280         
281         void pushFinallyContext(LabelID* target, RegisterID* returnAddrDst);
282         void popFinallyContext();
283         bool inContinueContext() { return m_continueDepth > 0; };
284         bool inJumpContext() { return m_jumpContextStack.size() > 0; };
285         void pushJumpContext(LabelStack*, LabelID* continueTarget, LabelID* breakTarget, bool isValidUnlabeledBreakTarget);
286         void popJumpContext();
287         JumpContext* jumpContextForContinue(const Identifier&);
288         JumpContext* jumpContextForBreak(const Identifier&);
289
290
291         CodeType codeType() const { return m_codeType; }
292     private:
293         PassRefPtr<LabelID> emitComplexJumpScopes(LabelID* target, ControlFlowContext* topScope, ControlFlowContext* bottomScope);
294         struct JSValueHashTraits : HashTraits<JSValue*> {
295             static void constructDeletedValue(JSValue** slot) { *slot = JSImmediate::impossibleValue(); }
296             static bool isDeletedValue(JSValue* value) { return value == JSImmediate::impossibleValue(); }
297         };
298
299         typedef HashMap<JSValue*, unsigned, DefaultHash<JSValue*>::Hash, JSValueHashTraits> JSValueMap;
300         
301         struct IdentifierMapIndexHashTraits {
302             typedef int TraitType;
303             typedef IdentifierMapIndexHashTraits StorageTraits;
304             static int emptyValue() { return std::numeric_limits<int>::max(); }
305             static const bool emptyValueIsZero = false;
306             static const bool needsDestruction = false;
307             static const bool needsRef = false;
308         };
309
310         typedef HashMap<RefPtr<UString::Rep>, int, IdentifierRepHash, HashTraits<RefPtr<UString::Rep> >, IdentifierMapIndexHashTraits> IdentifierMap;
311
312         RegisterID* emitCall(OpcodeID, RegisterID*, RegisterID*, RegisterID*, ArgumentsNode*);
313
314         // Maps a register index in the symbol table to a RegisterID index in m_locals.
315         int localsIndex(int registerIndex) { return -registerIndex - 1; }
316         
317         // Returns the RegisterID corresponding to ident.
318         RegisterID* addVar(const Identifier& ident, bool isConstant)
319         {
320             RegisterID* local;
321             addVar(ident, local, isConstant);
322             return local;
323         }
324
325         // Returns true if a new RegisterID was added, false if a pre-existing RegisterID was re-used.
326         bool addVar(const Identifier&, RegisterID*&, bool isConstant);
327
328         RegisterID* addParameter(const Identifier&);
329
330         unsigned addConstant(FuncDeclNode*);
331         unsigned addConstant(FuncExprNode*);
332         unsigned addConstant(const Identifier&);
333         unsigned addConstant(JSValue*);
334         unsigned addRegExp(RegExp* r);
335         
336         Vector<Instruction>& instructions() { return m_codeBlock->instructions; }
337         SymbolTable& symbolTable() { return *m_symbolTable; }
338         Vector<HandlerInfo>& exceptionHandlers() { return m_codeBlock->exceptionHandlers; }
339         
340         bool shouldOptimizeLocals() { return (m_codeType != EvalCode) && !m_dynamicScopeDepth; }
341         bool canOptimizeNonLocals() { return (m_codeType == FunctionCode) && !m_dynamicScopeDepth && !m_codeBlock->usesEval; }
342
343         bool m_shouldEmitDebugHooks;
344         
345         const ScopeChain* m_scopeChain;
346         SymbolTable* m_symbolTable;
347         
348         ScopeNode* m_scopeNode;
349         CodeBlock* m_codeBlock;
350         
351         HashSet<RefPtr<UString::Rep>, IdentifierRepHash> m_functions;
352         static RegisterID* programCodeThis();
353         RegisterID* m_thisRegister;
354         SegmentedVector<RegisterID, 512> m_locals;
355         SegmentedVector<RegisterID, 512> m_temporaries;
356         SegmentedVector<LabelID, 512> m_labels;
357         int m_finallyDepth;
358         int m_dynamicScopeDepth;
359         CodeType m_codeType;
360         
361         Vector<JumpContext> m_jumpContextStack;
362         int m_continueDepth;
363         Vector<ControlFlowContext> m_scopeContextStack;
364
365         int m_nextVar;
366         int m_nextParameter;
367
368         // Constant pool
369         IdentifierMap m_identifierMap;
370         JSValueMap m_jsValueMap;
371
372         CommonIdentifiers* m_propertyNames;
373
374 #ifndef NDEBUG        
375         static bool s_dumpsGeneratedCode;
376 #endif
377     };
378
379 }
380
381 #endif // CodeGenerator_h