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