64b07d8857c19ae374c38cc2e529731a40a3ab45
[WebKit-https.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 "SegmentedVector.h"
41 #include "SymbolTable.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*);
81         CodeGenerator(EvalNode*, const Debugger*, const ScopeChain&, SymbolTable*, EvalCodeBlock*);
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 isLocal(const Identifier&);
112         bool isLocalConstant(const Identifier&);
113
114         // Returns the next available temporary register. Registers returned by
115         // newTemporary require a modified form of reference counting: any
116         // register with a refcount of 0 is considered "available", meaning that
117         // the next instruction may overwrite it.
118         RegisterID* newTemporary();
119
120         RegisterID* highestUsedRegister();
121
122         // The same as newTemporary(), but this function returns "suggestion" if
123         // "suggestion" is a temporary. This function is helpful in situations
124         // where you've put "suggestion" in a RefPtr, but you'd like to allow
125         // the next instruction to overwrite it anyway.
126         RegisterID* newTemporaryOr(RegisterID* suggestion) { return suggestion->isTemporary() ? suggestion : newTemporary(); }
127
128         // Functions for handling of dst register
129
130         // Returns  a place to write intermediate values of an operation
131         // which reuses dst if it is safe to do so.
132
133         RegisterID* tempDestination(RegisterID* dst) { return (dst && dst->isTemporary()) ? dst : newTemporary(); }
134
135         // Returns the place to write the final output of an operation.
136         RegisterID* finalDestination(RegisterID* originalDst, RegisterID* tempDst = 0)
137         {
138             if (originalDst)
139                 return originalDst;
140             if (tempDst && tempDst->isTemporary())
141                 return tempDst;
142             return newTemporary();
143         }
144
145         RegisterID* destinationForAssignResult(RegisterID* dst)
146         {
147             if (dst && m_codeBlock->needsFullScopeChain)
148                 return dst->isTemporary() ? dst : newTemporary();
149             return 0;
150         }
151
152         // moves src to dst if dst is not null and is different from src, otherwise just returns src
153         RegisterID* moveToDestinationIfNeeded(RegisterID* dst, RegisterID* src) { return (dst && dst != src) ? emitMove(dst, src) : src; }
154
155         PassRefPtr<LabelID> newLabel();
156
157         // The emitNode functions are just syntactic sugar for calling
158         // Node::emitCode. They're the only functions that accept a NULL register.
159         RegisterID* emitNode(RegisterID* dst, Node* n)
160         {
161             // Node::emitCode assumes that dst, if provided, is either a local or a referenced temporary.
162             ASSERT(!dst || !dst->isTemporary() || dst->refCount());
163             if (!m_codeBlock->lineInfo.size() || m_codeBlock->lineInfo.last().lineNumber != n->lineNo()) {
164                 LineInfo info = { instructions().size(), n->lineNo() };
165                 m_codeBlock->lineInfo.append(info);
166             }
167             return n->emitCode(*this, dst);
168         }
169
170         RegisterID* emitNode(Node* n)
171         {
172             return emitNode(0, n);
173         }
174
175         ALWAYS_INLINE bool leftHandSideNeedsCopy(bool rightHasAssignments, bool rightIsPure)
176         {
177             return (m_codeType != FunctionCode || m_codeBlock->needsFullScopeChain || rightHasAssignments) && !rightIsPure;
178         }
179
180         ALWAYS_INLINE PassRefPtr<RegisterID> emitNodeForLeftHandSide(ExpressionNode* n, bool rightHasAssignments, bool rightIsPure)
181         {
182             if (leftHandSideNeedsCopy(rightHasAssignments, rightIsPure)) {
183                 PassRefPtr<RegisterID> dst = newTemporary();
184                 emitNode(dst.get(), n);
185                 return dst;
186             }
187
188             return PassRefPtr<RegisterID>(emitNode(n));
189         }
190
191         RegisterID* emitLoad(RegisterID* dst, bool);
192         RegisterID* emitLoad(RegisterID* dst, double);
193         RegisterID* emitLoad(RegisterID* dst, JSValue*);
194
195         RegisterID* emitNullaryOp(OpcodeID, RegisterID* dst);
196         RegisterID* emitUnaryOp(OpcodeID, RegisterID* dst, RegisterID* src);
197         RegisterID* emitBinaryOp(OpcodeID, RegisterID* dst, RegisterID* src1, RegisterID* src2);
198         RegisterID* emitUnaryNoDstOp(OpcodeID, RegisterID* src);
199
200
201         RegisterID* emitNewObject(RegisterID* dst) { return emitNullaryOp(op_new_object, dst); }
202         RegisterID* emitNewArray(RegisterID* dst) { return emitNullaryOp(op_new_array, dst); }
203
204         RegisterID* emitNewFunction(RegisterID* dst, FuncDeclNode* func);
205         RegisterID* emitNewFunctionExpression(RegisterID* dst, FuncExprNode* func);
206         RegisterID* emitNewRegExp(RegisterID* dst, RegExp* regExp);
207
208         RegisterID* emitMove(RegisterID* dst, RegisterID* src);
209
210
211         RegisterID* emitNot(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_not, dst, src); }
212         RegisterID* emitBitNot(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_bitnot, dst, src); }
213
214         RegisterID* emitToJSNumber(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_to_jsnumber, dst, src); }
215         RegisterID* emitNegate(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_negate, dst, src); }
216         RegisterID* emitPreInc(RegisterID* srcDst);
217         RegisterID* emitPreDec(RegisterID* srcDst);
218         RegisterID* emitPostInc(RegisterID* dst, RegisterID* srcDst);
219         RegisterID* emitPostDec(RegisterID* dst, RegisterID* srcDst);
220
221         RegisterID* emitInstanceOf(RegisterID* dst, RegisterID* value, RegisterID* base) { return emitBinaryOp(op_instanceof, dst, value, base); }
222         RegisterID* emitTypeOf(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_typeof, dst, src); }
223         RegisterID* emitIn(RegisterID* dst, RegisterID* property, RegisterID* base) { return emitBinaryOp(op_in, dst, property, base); }
224
225         RegisterID* emitResolve(RegisterID* dst, const Identifier& property);
226         RegisterID* emitGetScopedVar(RegisterID* dst, size_t skip, int index);
227         RegisterID* emitPutScopedVar(size_t skip, int index, RegisterID* value);
228
229         RegisterID* emitResolveBase(RegisterID* dst, const Identifier& property);
230         RegisterID* emitResolveWithBase(RegisterID* baseDst, RegisterID* propDst, const Identifier& property);
231         RegisterID* emitResolveFunction(RegisterID* baseDst, RegisterID* funcDst, const Identifier& property);
232
233         RegisterID* emitGetById(RegisterID* dst, RegisterID* base, const Identifier& property);
234         RegisterID* emitPutById(RegisterID* base, const Identifier& property, RegisterID* value);
235         RegisterID* emitDeleteById(RegisterID* dst, RegisterID* base, const Identifier&);
236         RegisterID* emitGetByVal(RegisterID* dst, RegisterID* base, RegisterID* property);
237         RegisterID* emitPutByVal(RegisterID* base, RegisterID* property, RegisterID* value);
238         RegisterID* emitDeleteByVal(RegisterID* dst, RegisterID* base, RegisterID* property);
239         RegisterID* emitPutByIndex(RegisterID* base, unsigned index, RegisterID* value);
240         RegisterID* emitPutGetter(RegisterID* base, const Identifier& property, RegisterID* value);
241         RegisterID* emitPutSetter(RegisterID* base, const Identifier& property, RegisterID* value);
242
243         RegisterID* emitCall(RegisterID* dst, RegisterID* func, RegisterID* base, ArgumentsNode*);
244         RegisterID* emitCallEval(RegisterID* dst, RegisterID* func, RegisterID* base, ArgumentsNode*);
245
246         RegisterID* emitReturn(RegisterID* src) { return emitUnaryNoDstOp(op_ret, src); } 
247         RegisterID* emitEnd(RegisterID* src) { return emitUnaryNoDstOp(op_end, src); }
248
249         RegisterID* emitConstruct(RegisterID* dst, RegisterID* func, ArgumentsNode*);
250
251         PassRefPtr<LabelID> emitLabel(LabelID*);
252         PassRefPtr<LabelID> emitJump(LabelID* target);
253         PassRefPtr<LabelID> emitJumpIfTrueMayCombine(RegisterID* cond, LabelID* target);
254         PassRefPtr<LabelID> emitJumpIfTrue(RegisterID* cond, LabelID* target);
255         PassRefPtr<LabelID> emitJumpIfFalse(RegisterID* cond, LabelID* target);
256         PassRefPtr<LabelID> emitJumpScopes(LabelID* target, int targetScopeDepth);
257
258         PassRefPtr<LabelID> emitJumpSubroutine(RegisterID* retAddrDst, LabelID*);
259         void emitSubroutineReturn(RegisterID* retAddrSrc);
260
261         RegisterID* emitGetPropertyNames(RegisterID* dst, RegisterID* base) { return emitUnaryOp(op_get_pnames, dst, base); }
262         RegisterID* emitNextPropertyName(RegisterID* dst, RegisterID* iter, LabelID* target);
263
264         RegisterID* emitCatch(RegisterID*, LabelID* start, LabelID* end);
265         void emitThrow(RegisterID* exc) { emitUnaryNoDstOp(op_throw, exc); }
266         RegisterID* emitNewError(RegisterID* dst, ErrorType type, JSValue* message);
267
268         RegisterID* emitPushScope(RegisterID* scope);
269         void emitPopScope();
270
271         void emitDebugHook(DebugHookID, int firstLine, int lastLine);
272
273         int scopeDepth() { return m_dynamicScopeDepth + m_finallyDepth; }
274
275         void pushFinallyContext(LabelID* target, RegisterID* returnAddrDst);
276         void popFinallyContext();
277         bool inContinueContext() { return m_continueDepth > 0; };
278         bool inJumpContext() { return m_jumpContextStack.size() > 0; };
279         void pushJumpContext(LabelStack*, LabelID* continueTarget, LabelID* breakTarget, bool isValidUnlabeledBreakTarget);
280         void popJumpContext();
281         JumpContext* jumpContextForContinue(const Identifier&);
282         JumpContext* jumpContextForBreak(const Identifier&);
283
284         CodeType codeType() const { return m_codeType; }
285
286     private:
287         void emitOpcode(OpcodeID);
288         void retrieveLastBinaryOp(int& dstIndex, int& src1Index, int& src2Index);
289         void rewindBinaryOp();
290
291         PassRefPtr<LabelID> emitComplexJumpScopes(LabelID* target, ControlFlowContext* topScope, ControlFlowContext* bottomScope);
292         struct JSValueHashTraits : HashTraits<JSValue*> {
293             static void constructDeletedValue(JSValue** slot) { *slot = JSImmediate::impossibleValue(); }
294             static bool isDeletedValue(JSValue* value) { return value == JSImmediate::impossibleValue(); }
295         };
296
297         typedef HashMap<JSValue*, unsigned, DefaultHash<JSValue*>::Hash, JSValueHashTraits> JSValueMap;
298
299         struct IdentifierMapIndexHashTraits {
300             typedef int TraitType;
301             typedef IdentifierMapIndexHashTraits StorageTraits;
302             static int emptyValue() { return std::numeric_limits<int>::max(); }
303             static const bool emptyValueIsZero = false;
304             static const bool needsDestruction = false;
305             static const bool needsRef = false;
306         };
307
308         typedef HashMap<RefPtr<UString::Rep>, int, IdentifierRepHash, HashTraits<RefPtr<UString::Rep> >, IdentifierMapIndexHashTraits> IdentifierMap;
309
310         RegisterID* emitCall(OpcodeID, RegisterID*, RegisterID*, RegisterID*, ArgumentsNode*);
311
312         // Maps a register index in the symbol table to a RegisterID index in m_locals.
313         int localsIndex(int registerIndex) { return -registerIndex - 1; }
314
315         // Returns the RegisterID corresponding to ident.
316         RegisterID* addVar(const Identifier& ident, bool isConstant)
317         {
318             RegisterID* local;
319             addVar(ident, local, isConstant);
320             return local;
321         }
322
323         // Returns true if a new RegisterID was added, false if a pre-existing RegisterID was re-used.
324         bool addVar(const Identifier&, RegisterID*&, bool isConstant);
325
326         RegisterID* addParameter(const Identifier&);
327
328         unsigned addConstant(FuncDeclNode*);
329         unsigned addConstant(FuncExprNode*);
330         unsigned addConstant(const Identifier&);
331         unsigned addConstant(JSValue*);
332         unsigned addRegExp(RegExp* r);
333
334         Vector<Instruction>& instructions() { return m_codeBlock->instructions; }
335         SymbolTable& symbolTable() { return *m_symbolTable; }
336         Vector<HandlerInfo>& exceptionHandlers() { return m_codeBlock->exceptionHandlers; }
337
338         bool shouldOptimizeLocals() { return (m_codeType != EvalCode) && !m_dynamicScopeDepth; }
339         bool canOptimizeNonLocals() { return (m_codeType == FunctionCode) && !m_dynamicScopeDepth && !m_codeBlock->usesEval; }
340
341         bool m_shouldEmitDebugHooks;
342
343         const ScopeChain* m_scopeChain;
344         SymbolTable* m_symbolTable;
345
346         ScopeNode* m_scopeNode;
347         CodeBlock* m_codeBlock;
348
349         HashSet<RefPtr<UString::Rep>, IdentifierRepHash> m_functions;
350         RegisterID m_thisRegister;
351         SegmentedVector<RegisterID, 512> m_locals;
352         SegmentedVector<RegisterID, 512> m_temporaries;
353         SegmentedVector<LabelID, 512> m_labels;
354         int m_finallyDepth;
355         int m_dynamicScopeDepth;
356         CodeType m_codeType;
357
358         Vector<JumpContext> m_jumpContextStack;
359         int m_continueDepth;
360         Vector<ControlFlowContext> m_scopeContextStack;
361
362         int m_nextVar;
363         int m_nextParameter;
364
365         // Constant pool
366         IdentifierMap m_identifierMap;
367         JSValueMap m_jsValueMap;
368
369         const CommonIdentifiers* m_propertyNames;
370
371         OpcodeID m_lastOpcodeID;
372
373 #ifndef NDEBUG
374         static bool s_dumpsGeneratedCode;
375 #endif
376     };
377
378 }
379
380 #endif // CodeGenerator_h