JavaScriptCore:
[WebKit-https.git] / JavaScriptCore / VM / CodeGenerator.h
1 /*
2  * Copyright (C) 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Cameron Zwarich <cwzwarich@uwaterloo.ca>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef CodeGenerator_h
31 #define CodeGenerator_h
32
33 #include "CodeBlock.h"
34 #include "HashTraits.h"
35 #include "Instruction.h"
36 #include "LabelID.h"
37 #include "Machine.h"
38 #include "RegisterID.h"
39 #include "SegmentedVector.h"
40 #include "SymbolTable.h"
41 #include "debugger.h"
42 #include "nodes.h"
43 #include <wtf/PassRefPtr.h>
44 #include <wtf/Vector.h>
45
46 namespace KJS {
47
48     class Identifier;
49     class ScopeChain;
50     class ScopeNode;
51
52     // JumpContexts are used to track entry and exit points for javascript loops and switch statements
53     struct JumpContext {
54         LabelStack* labels;
55         LabelID* continueTarget;
56         LabelID* breakTarget;
57         int scopeDepth;
58         bool isValidUnlabeledBreakTarget;
59     };
60
61     struct FinallyContext {
62         LabelID* finallyAddr;
63         RegisterID* retAddrDst;
64     };
65
66     struct ControlFlowContext {
67         bool isFinallyBlock;
68         FinallyContext finallyContext;
69     };
70
71     class CodeGenerator {
72     public:
73         typedef DeclarationStacks::VarStack VarStack;
74         typedef DeclarationStacks::FunctionStack FunctionStack;
75
76         static void setDumpsGeneratedCode(bool dumpsGeneratedCode);
77
78         CodeGenerator(ProgramNode*, const Debugger*, const ScopeChain&, SymbolTable*, CodeBlock*, VarStack&, FunctionStack&);
79         CodeGenerator(FunctionBodyNode*, const Debugger*, const ScopeChain&, SymbolTable*, CodeBlock*);
80         CodeGenerator(EvalNode*, const Debugger*, const ScopeChain&, SymbolTable*, EvalCodeBlock*);
81
82         ~CodeGenerator();
83
84         JSGlobalData* globalData() const { return m_globalData; }
85         const CommonIdentifiers& propertyNames() const { return *m_globalData->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, bool forWriting);
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         RegisterID* tempDestination(RegisterID* dst)
133         {
134             return (dst && dst != ignoredResult() && dst->isTemporary()) ? dst : newTemporary();
135         }
136
137         // Returns the place to write the final output of an operation.
138         RegisterID* finalDestination(RegisterID* originalDst, RegisterID* tempDst = 0)
139         {
140             if (originalDst && originalDst != ignoredResult())
141                 return originalDst;
142             ASSERT(tempDst != ignoredResult());
143             if (tempDst && tempDst->isTemporary())
144                 return tempDst;
145             return newTemporary();
146         }
147
148         RegisterID* destinationForAssignResult(RegisterID* dst)
149         {
150             if (dst && dst != ignoredResult() && m_codeBlock->needsFullScopeChain)
151                 return dst->isTemporary() ? dst : newTemporary();
152             return 0;
153         }
154
155         // Moves src to dst if dst is not null and is different from src, otherwise just returns src.
156         RegisterID* moveToDestinationIfNeeded(RegisterID* dst, RegisterID* src)
157         {
158             return dst == ignoredResult() ? 0 : (dst && dst != src) ? emitMove(dst, src) : src;
159         }
160
161         PassRefPtr<LabelID> newLabel();
162
163         // The emitNode functions are just syntactic sugar for calling
164         // Node::emitCode. These functions accept a 0 for the register,
165         // meaning that the node should allocate a register, or ignoredResult(),
166         // meaning that the node need not put the result in a register.
167         // Other emit functions do not accept 0 or ignoredResult().
168         RegisterID* emitNode(RegisterID* dst, Node* n)
169         {
170             // Node::emitCode assumes that dst, if provided, is either a local or a referenced temporary.
171             ASSERT(!dst || dst == ignoredResult() || !dst->isTemporary() || dst->refCount());
172             if (!m_codeBlock->lineInfo.size() || m_codeBlock->lineInfo.last().lineNumber != n->lineNo()) {
173                 LineInfo info = { instructions().size(), n->lineNo() };
174                 m_codeBlock->lineInfo.append(info);
175             }
176             return n->emitCode(*this, dst);
177         }
178
179         RegisterID* emitNode(Node* n)
180         {
181             return emitNode(0, n);
182         }
183
184         void emitExpressionInfo(unsigned divot, unsigned startOffset, unsigned endOffset)
185         { 
186             divot -= m_codeBlock->sourceOffset;
187             if (divot > ExpressionRangeInfo::MaxDivot) {
188                 // Overflow has occurred, we can only give line number info for errors for this region
189                 divot = 0;
190                 startOffset = 0;
191                 endOffset = 0;
192             } else if (startOffset > ExpressionRangeInfo::MaxOffset) {
193                 // If the start offset is out of bounds we clear both offsets
194                 // so we only get the divot marker.  Error message will have to be reduced
195                 // to line and column number.
196                 startOffset = 0;
197                 endOffset = 0;
198             } else if (endOffset > ExpressionRangeInfo::MaxOffset) {
199                 // The end offset is only used for additional context, and is much more likely
200                 // to overflow (eg. function call arguments) so we are willing to drop it without
201                 // dropping the rest of the range.
202                 endOffset = 0;
203             }
204             
205             ExpressionRangeInfo info;
206             info.instructionOffset = instructions().size();
207             info.divotPoint = divot;
208             info.startOffset = startOffset;
209             info.endOffset = endOffset;
210             m_codeBlock->expressionInfo.append(info);
211         }
212         
213         ALWAYS_INLINE bool leftHandSideNeedsCopy(bool rightHasAssignments, bool rightIsPure)
214         {
215             return (m_codeType != FunctionCode || m_codeBlock->needsFullScopeChain || rightHasAssignments) && !rightIsPure;
216         }
217
218         ALWAYS_INLINE PassRefPtr<RegisterID> emitNodeForLeftHandSide(ExpressionNode* n, bool rightHasAssignments, bool rightIsPure)
219         {
220             if (leftHandSideNeedsCopy(rightHasAssignments, rightIsPure)) {
221                 PassRefPtr<RegisterID> dst = newTemporary();
222                 emitNode(dst.get(), n);
223                 return dst;
224             }
225
226             return PassRefPtr<RegisterID>(emitNode(n));
227         }
228
229         RegisterID* emitLoad(RegisterID* dst, bool);
230         RegisterID* emitLoad(RegisterID* dst, double);
231         RegisterID* emitLoad(RegisterID* dst, JSValue*);
232         RegisterID* emitUnexpectedLoad(RegisterID* dst, bool);
233         RegisterID* emitUnexpectedLoad(RegisterID* dst, double);
234
235         RegisterID* emitUnaryOp(OpcodeID, RegisterID* dst, RegisterID* src);
236         RegisterID* emitBinaryOp(OpcodeID, RegisterID* dst, RegisterID* src1, RegisterID* src2);
237         RegisterID* emitUnaryNoDstOp(OpcodeID, RegisterID* src);
238
239         RegisterID* emitNewObject(RegisterID* dst);
240         RegisterID* emitNewArray(RegisterID* dst, ElementNode*); // stops at first elision
241
242         RegisterID* emitNewFunction(RegisterID* dst, FuncDeclNode* func);
243         RegisterID* emitNewFunctionExpression(RegisterID* dst, FuncExprNode* func);
244         RegisterID* emitNewRegExp(RegisterID* dst, RegExp* regExp);
245
246         RegisterID* emitMove(RegisterID* dst, RegisterID* src);
247
248         RegisterID* emitToJSNumber(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_to_jsnumber, dst, src); }
249         RegisterID* emitPreInc(RegisterID* srcDst);
250         RegisterID* emitPreDec(RegisterID* srcDst);
251         RegisterID* emitPostInc(RegisterID* dst, RegisterID* srcDst);
252         RegisterID* emitPostDec(RegisterID* dst, RegisterID* srcDst);
253
254         RegisterID* emitInstanceOf(RegisterID* dst, RegisterID* value, RegisterID* base) { return emitBinaryOp(op_instanceof, dst, value, base); }
255         RegisterID* emitTypeOf(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_typeof, dst, src); }
256         RegisterID* emitIn(RegisterID* dst, RegisterID* property, RegisterID* base) { return emitBinaryOp(op_in, dst, property, base); }
257
258         RegisterID* emitResolve(RegisterID* dst, const Identifier& property);
259         RegisterID* emitGetScopedVar(RegisterID* dst, size_t skip, int index);
260         RegisterID* emitPutScopedVar(size_t skip, int index, RegisterID* value);
261
262         RegisterID* emitResolveBase(RegisterID* dst, const Identifier& property);
263         RegisterID* emitResolveWithBase(RegisterID* baseDst, RegisterID* propDst, const Identifier& property);
264         RegisterID* emitResolveFunction(RegisterID* baseDst, RegisterID* funcDst, const Identifier& property);
265
266         RegisterID* emitGetById(RegisterID* dst, RegisterID* base, const Identifier& property);
267         RegisterID* emitPutById(RegisterID* base, const Identifier& property, RegisterID* value);
268         RegisterID* emitDeleteById(RegisterID* dst, RegisterID* base, const Identifier&);
269         RegisterID* emitGetByVal(RegisterID* dst, RegisterID* base, RegisterID* property);
270         RegisterID* emitPutByVal(RegisterID* base, RegisterID* property, RegisterID* value);
271         RegisterID* emitDeleteByVal(RegisterID* dst, RegisterID* base, RegisterID* property);
272         RegisterID* emitPutByIndex(RegisterID* base, unsigned index, RegisterID* value);
273         RegisterID* emitPutGetter(RegisterID* base, const Identifier& property, RegisterID* value);
274         RegisterID* emitPutSetter(RegisterID* base, const Identifier& property, RegisterID* value);
275
276         RegisterID* emitCall(RegisterID* dst, RegisterID* func, RegisterID* base, ArgumentsNode*, unsigned divot, unsigned startOffset, unsigned endOffset);
277         RegisterID* emitCallEval(RegisterID* dst, RegisterID* func, RegisterID* base, ArgumentsNode*, unsigned divot, unsigned startOffset, unsigned endOffset);
278
279         RegisterID* emitReturn(RegisterID* src) { return emitUnaryNoDstOp(op_ret, src); } 
280         RegisterID* emitEnd(RegisterID* src) { return emitUnaryNoDstOp(op_end, src); }
281
282         RegisterID* emitConstruct(RegisterID* dst, RegisterID* func, ArgumentsNode*);
283
284         PassRefPtr<LabelID> emitLabel(LabelID*);
285         PassRefPtr<LabelID> emitJump(LabelID* target);
286         PassRefPtr<LabelID> emitJumpIfTrue(RegisterID* cond, LabelID* target);
287         PassRefPtr<LabelID> emitJumpIfFalse(RegisterID* cond, LabelID* target);
288         PassRefPtr<LabelID> emitJumpScopes(LabelID* target, int targetScopeDepth);
289
290         PassRefPtr<LabelID> emitJumpSubroutine(RegisterID* retAddrDst, LabelID*);
291         void emitSubroutineReturn(RegisterID* retAddrSrc);
292
293         RegisterID* emitGetPropertyNames(RegisterID* dst, RegisterID* base) { return emitUnaryOp(op_get_pnames, dst, base); }
294         RegisterID* emitNextPropertyName(RegisterID* dst, RegisterID* iter, LabelID* target);
295
296         RegisterID* emitCatch(RegisterID*, LabelID* start, LabelID* end);
297         void emitThrow(RegisterID* exc) { emitUnaryNoDstOp(op_throw, exc); }
298         RegisterID* emitNewError(RegisterID* dst, ErrorType type, JSValue* message);
299         void emitPushNewScope(RegisterID* dst, Identifier& property, RegisterID* value);
300
301         RegisterID* emitPushScope(RegisterID* scope);
302         void emitPopScope();
303
304         void emitDebugHook(DebugHookID, int firstLine, int lastLine);
305
306         int scopeDepth() { return m_dynamicScopeDepth + m_finallyDepth; }
307
308         void pushFinallyContext(LabelID* target, RegisterID* returnAddrDst);
309         void popFinallyContext();
310         bool inContinueContext() { return m_continueDepth > 0; };
311         bool inJumpContext() { return m_jumpContextStack.size() > 0; };
312         void pushJumpContext(LabelStack*, LabelID* continueTarget, LabelID* breakTarget, bool isValidUnlabeledBreakTarget);
313         void popJumpContext();
314         JumpContext* jumpContextForContinue(const Identifier&);
315         JumpContext* jumpContextForBreak(const Identifier&);
316
317         void beginSwitch(RegisterID*, SwitchInfo::SwitchType);
318         void endSwitch(uint32_t clauseCount, RefPtr<LabelID>*, ExpressionNode**, LabelID* defaultLabel, int32_t min, int32_t range);
319
320         CodeType codeType() const { return m_codeType; }
321
322         ExecState* globalExec() { return m_scopeChain->globalObject()->globalExec(); }
323
324     private:
325         void emitOpcode(OpcodeID);
326         void retrieveLastBinaryOp(int& dstIndex, int& src1Index, int& src2Index);
327         void retrieveLastUnaryOp(int& dstIndex, int& srcIndex);
328         void rewindBinaryOp();
329         void rewindUnaryOp();
330
331         PassRefPtr<LabelID> emitComplexJumpScopes(LabelID* target, ControlFlowContext* topScope, ControlFlowContext* bottomScope);
332         struct JSValueHashTraits : HashTraits<JSValue*> {
333             static void constructDeletedValue(JSValue*& slot) { slot = JSImmediate::impossibleValue(); }
334             static bool isDeletedValue(JSValue* value) { return value == JSImmediate::impossibleValue(); }
335         };
336
337         typedef HashMap<JSValue*, unsigned, DefaultHash<JSValue*>::Hash, JSValueHashTraits> JSValueMap;
338
339         struct IdentifierMapIndexHashTraits {
340             typedef int TraitType;
341             typedef IdentifierMapIndexHashTraits StorageTraits;
342             static int emptyValue() { return std::numeric_limits<int>::max(); }
343             static const bool emptyValueIsZero = false;
344             static const bool needsDestruction = false;
345             static const bool needsRef = false;
346         };
347
348         typedef HashMap<RefPtr<UString::Rep>, int, IdentifierRepHash, HashTraits<RefPtr<UString::Rep> >, IdentifierMapIndexHashTraits> IdentifierMap;
349
350         RegisterID* emitCall(OpcodeID, RegisterID*, RegisterID*, RegisterID*, ArgumentsNode*, unsigned divot, unsigned startOffset, unsigned endOffset);
351
352         // Maps a register index in the symbol table to a RegisterID index in m_locals.
353         int localsIndex(int registerIndex) { return -registerIndex - 1; }
354
355         // Returns the RegisterID corresponding to ident.
356         RegisterID* addVar(const Identifier& ident, bool isConstant)
357         {
358             RegisterID* local;
359             addVar(ident, isConstant, local);
360             return local;
361         }
362         // Returns true if a new RegisterID was added, false if a pre-existing RegisterID was re-used.
363         bool addVar(const Identifier&, bool isConstant, RegisterID*&);
364
365         // Returns the RegisterID corresponding to ident.
366         RegisterID* addGlobalVar(const Identifier& ident, bool isConstant)
367         {
368             RegisterID* local;
369             addGlobalVar(ident, isConstant, local);
370             return local;
371         }
372         // Returns true if a new RegisterID was added, false if a pre-existing RegisterID was re-used.
373         bool addGlobalVar(const Identifier&, bool isConstant, RegisterID*&);
374
375         RegisterID* addParameter(const Identifier&);
376
377         unsigned addConstant(FuncDeclNode*);
378         unsigned addConstant(FuncExprNode*);
379         unsigned addConstant(const Identifier&);
380         RegisterID* addConstant(JSValue*);
381         unsigned addUnexpectedConstant(JSValue*);
382         unsigned addRegExp(RegExp* r);
383         StructureID* addStructureID();
384
385         Vector<Instruction>& instructions() { return m_codeBlock->instructions; }
386         SymbolTable& symbolTable() { return *m_symbolTable; }
387         Vector<HandlerInfo>& exceptionHandlers() { return m_codeBlock->exceptionHandlers; }
388
389         bool shouldOptimizeLocals() { return (m_codeType != EvalCode) && !m_dynamicScopeDepth; }
390         bool canOptimizeNonLocals() { return (m_codeType == FunctionCode) && !m_dynamicScopeDepth && !m_codeBlock->usesEval; }
391
392         bool m_shouldEmitDebugHooks;
393
394         const ScopeChain* m_scopeChain;
395         SymbolTable* m_symbolTable;
396
397         ScopeNode* m_scopeNode;
398         CodeBlock* m_codeBlock;
399
400         HashSet<RefPtr<UString::Rep>, IdentifierRepHash> m_functions;
401         RegisterID m_thisRegister;
402         SegmentedVector<RegisterID, 512> m_locals;
403         SegmentedVector<RegisterID, 512> m_constants;
404         SegmentedVector<RegisterID, 512> m_temporaries;
405         SegmentedVector<LabelID, 512> m_labels;
406         int m_finallyDepth;
407         int m_dynamicScopeDepth;
408         CodeType m_codeType;
409
410         Vector<JumpContext> m_jumpContextStack;
411         int m_continueDepth;
412         Vector<ControlFlowContext> m_scopeContextStack;
413         Vector<SwitchInfo> m_switchContextStack;
414
415         int m_nextVar;
416         int m_nextParameter;
417
418         int m_globalVarStorageOffset;
419
420         // Constant pool
421         IdentifierMap m_identifierMap;
422         JSValueMap m_jsValueMap;
423
424         JSGlobalData* m_globalData;
425
426         OpcodeID m_lastOpcodeID;
427
428 #ifndef NDEBUG
429         static bool s_dumpsGeneratedCode;
430 #endif
431     };
432
433 }
434
435 #endif // CodeGenerator_h