finally blocks should not set the exception stack trace when re-throwing the exception.
[WebKit-https.git] / Source / JavaScriptCore / bytecompiler / BytecodeGenerator.h
1 /*
2  * Copyright (C) 2008, 2009, 2012-2015 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Cameron Zwarich <cwzwarich@uwaterloo.ca>
4  * Copyright (C) 2012 Igalia, S.L.
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 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 BytecodeGenerator_h
32 #define BytecodeGenerator_h
33
34 #include "CodeBlock.h"
35 #include <wtf/HashTraits.h>
36 #include "Instruction.h"
37 #include "Label.h"
38 #include "LabelScope.h"
39 #include "Interpreter.h"
40 #include "ParserError.h"
41 #include "RegisterID.h"
42 #include "SymbolTable.h"
43 #include "Debugger.h"
44 #include "Nodes.h"
45 #include "StaticPropertyAnalyzer.h"
46 #include "TemplateRegistryKey.h"
47 #include "UnlinkedCodeBlock.h"
48
49 #include <functional>
50
51 #include <wtf/PassRefPtr.h>
52 #include <wtf/SegmentedVector.h>
53 #include <wtf/Vector.h>
54
55
56 namespace JSC {
57
58     class Identifier;
59     class JSTemplateRegistryKey;
60
61     enum ExpectedFunction {
62         NoExpectedFunction,
63         ExpectObjectConstructor,
64         ExpectArrayConstructor
65     };
66
67     class CallArguments {
68     public:
69         CallArguments(BytecodeGenerator&, ArgumentsNode*, unsigned additionalArguments = 0);
70
71         RegisterID* thisRegister() { return m_argv[0].get(); }
72         RegisterID* argumentRegister(unsigned i) { return m_argv[i + 1].get(); }
73         unsigned stackOffset() { return -m_argv[0]->index() + JSStack::CallFrameHeaderSize; }
74         unsigned argumentCountIncludingThis() { return m_argv.size() - m_padding; }
75         RegisterID* profileHookRegister() { return m_profileHookRegister.get(); }
76         ArgumentsNode* argumentsNode() { return m_argumentsNode; }
77
78     private:
79         RefPtr<RegisterID> m_profileHookRegister;
80         ArgumentsNode* m_argumentsNode;
81         Vector<RefPtr<RegisterID>, 8, UnsafeVectorOverflow> m_argv;
82         unsigned m_padding;
83     };
84
85     struct FinallyContext {
86         StatementNode* finallyBlock;
87         RegisterID* iterator;
88         ThrowableExpressionData* enumerationNode;
89         unsigned scopeContextStackSize;
90         unsigned switchContextStackSize;
91         unsigned forInContextStackSize;
92         unsigned tryContextStackSize;
93         unsigned labelScopesSize;
94         int finallyDepth;
95         int dynamicScopeDepth;
96     };
97
98     struct ControlFlowContext {
99         bool isFinallyBlock;
100         FinallyContext finallyContext;
101     };
102
103     class ForInContext {
104     public:
105         ForInContext(RegisterID* localRegister)
106             : m_localRegister(localRegister)
107             , m_isValid(true)
108         {
109         }
110
111         virtual ~ForInContext()
112         {
113         }
114
115         bool isValid() const { return m_isValid; }
116         void invalidate() { m_isValid = false; }
117
118         enum ForInContextType {
119             StructureForInContextType,
120             IndexedForInContextType
121         };
122         virtual ForInContextType type() const = 0;
123
124         RegisterID* local() const { return m_localRegister.get(); }
125
126     private:
127         RefPtr<RegisterID> m_localRegister;
128         bool m_isValid;
129     };
130
131     class StructureForInContext : public ForInContext {
132     public:
133         StructureForInContext(RegisterID* localRegister, RegisterID* indexRegister, RegisterID* propertyRegister, RegisterID* enumeratorRegister)
134             : ForInContext(localRegister)
135             , m_indexRegister(indexRegister)
136             , m_propertyRegister(propertyRegister)
137             , m_enumeratorRegister(enumeratorRegister)
138         {
139         }
140
141         virtual ForInContextType type() const
142         {
143             return StructureForInContextType;
144         }
145
146         RegisterID* index() const { return m_indexRegister.get(); }
147         RegisterID* property() const { return m_propertyRegister.get(); }
148         RegisterID* enumerator() const { return m_enumeratorRegister.get(); }
149
150     private:
151         RefPtr<RegisterID> m_indexRegister;
152         RefPtr<RegisterID> m_propertyRegister;
153         RefPtr<RegisterID> m_enumeratorRegister;
154     };
155
156     class IndexedForInContext : public ForInContext {
157     public:
158         IndexedForInContext(RegisterID* localRegister, RegisterID* indexRegister)
159             : ForInContext(localRegister)
160             , m_indexRegister(indexRegister)
161         {
162         }
163
164         virtual ForInContextType type() const
165         {
166             return IndexedForInContextType;
167         }
168
169         RegisterID* index() const { return m_indexRegister.get(); }
170
171     private:
172         RefPtr<RegisterID> m_indexRegister;
173     };
174
175     struct TryData {
176         RefPtr<Label> target;
177         unsigned targetScopeDepth;
178         HandlerType handlerType;
179     };
180
181     struct TryContext {
182         RefPtr<Label> start;
183         TryData* tryData;
184     };
185
186     class Variable {
187     public:
188         enum VariableKind { NormalVariable, SpecialVariable };
189
190         Variable()
191             : m_offset()
192             , m_local(nullptr)
193             , m_attributes(0)
194             , m_kind(NormalVariable)
195         {
196         }
197         
198         Variable(const Identifier& ident)
199             : m_ident(ident)
200             , m_local(nullptr)
201             , m_attributes(0)
202             , m_kind(NormalVariable) // This is somewhat meaningless here for this kind of Variable.
203         {
204         }
205
206         Variable(const Identifier& ident, VarOffset offset, RegisterID* local, unsigned attributes, VariableKind kind)
207             : m_ident(ident)
208             , m_offset(offset)
209             , m_local(local)
210             , m_attributes(attributes)
211             , m_kind(kind)
212         {
213         }
214
215         // If it's unset, then it is a non-locally-scoped variable. If it is set, then it could be
216         // a stack variable, a scoped variable in the local scope, or a variable captured in the
217         // direct arguments object.
218         bool isResolved() const { return !!m_offset; }
219         
220         const Identifier& ident() const { return m_ident; }
221         
222         VarOffset offset() const { return m_offset; }
223         bool isLocal() const { return m_offset.isStack(); }
224         RegisterID* local() const { return m_local; }
225
226         bool isReadOnly() const { return m_attributes & ReadOnly; }
227         bool isSpecial() const { return m_kind != NormalVariable; }
228
229     private:
230         Identifier m_ident;
231         VarOffset m_offset;
232         RegisterID* m_local;
233         unsigned m_attributes;
234         VariableKind m_kind;
235     };
236
237     struct TryRange {
238         RefPtr<Label> start;
239         RefPtr<Label> end;
240         TryData* tryData;
241     };
242
243     enum ProfileTypeBytecodeFlag {
244         ProfileTypeBytecodePutToScope,
245         ProfileTypeBytecodeGetFromScope,
246         ProfileTypeBytecodePutToLocalScope,
247         ProfileTypeBytecodeGetFromLocalScope,
248         ProfileTypeBytecodeHasGlobalID,
249         ProfileTypeBytecodeDoesNotHaveGlobalID,
250         ProfileTypeBytecodeFunctionArgument,
251         ProfileTypeBytecodeFunctionReturnStatement
252     };
253
254     class BytecodeGenerator {
255         WTF_MAKE_FAST_ALLOCATED;
256         WTF_MAKE_NONCOPYABLE(BytecodeGenerator);
257     public:
258         typedef DeclarationStacks::VarStack VarStack;
259         typedef DeclarationStacks::FunctionStack FunctionStack;
260
261         BytecodeGenerator(VM&, ProgramNode*, UnlinkedProgramCodeBlock*, DebuggerMode, ProfilerMode);
262         BytecodeGenerator(VM&, FunctionNode*, UnlinkedFunctionCodeBlock*, DebuggerMode, ProfilerMode);
263         BytecodeGenerator(VM&, EvalNode*, UnlinkedEvalCodeBlock*, DebuggerMode, ProfilerMode);
264
265         ~BytecodeGenerator();
266         
267         VM* vm() const { return m_vm; }
268         ParserArena& parserArena() const { return m_scopeNode->parserArena(); }
269         const CommonIdentifiers& propertyNames() const { return *m_vm->propertyNames; }
270
271         bool isConstructor() const { return m_codeBlock->isConstructor(); }
272 #if ENABLE(ES6_CLASS_SYNTAX)
273         ConstructorKind constructorKind() const { return m_codeBlock->constructorKind(); }
274 #else
275         ConstructorKind constructorKind() const { return ConstructorKind::None; }
276 #endif
277
278         ParserError generate();
279
280         bool isArgumentNumber(const Identifier&, int);
281
282         Variable variable(const Identifier&);
283         
284         // Ignores the possibility of intervening scopes.
285         Variable variablePerSymbolTable(const Identifier&);
286         
287         enum ExistingVariableMode { VerifyExisting, IgnoreExisting };
288         void createVariable(const Identifier&, VarKind, ConstantMode, ExistingVariableMode = VerifyExisting); // Creates the variable, or asserts that the already-created variable is sufficiently compatible.
289         
290         // Returns the register storing "this"
291         RegisterID* thisRegister() { return &m_thisRegister; }
292         RegisterID* argumentsRegister() { return m_argumentsRegister; }
293         RegisterID* newTarget() { return m_newTargetRegister; }
294
295         RegisterID* scopeRegister() { return m_scopeRegister; }
296
297         // Returns the next available temporary register. Registers returned by
298         // newTemporary require a modified form of reference counting: any
299         // register with a refcount of 0 is considered "available", meaning that
300         // the next instruction may overwrite it.
301         RegisterID* newTemporary();
302
303         // The same as newTemporary(), but this function returns "suggestion" if
304         // "suggestion" is a temporary. This function is helpful in situations
305         // where you've put "suggestion" in a RefPtr, but you'd like to allow
306         // the next instruction to overwrite it anyway.
307         RegisterID* newTemporaryOr(RegisterID* suggestion) { return suggestion->isTemporary() ? suggestion : newTemporary(); }
308
309         // Functions for handling of dst register
310
311         RegisterID* ignoredResult() { return &m_ignoredResultRegister; }
312
313         // Returns a place to write intermediate values of an operation
314         // which reuses dst if it is safe to do so.
315         RegisterID* tempDestination(RegisterID* dst)
316         {
317             return (dst && dst != ignoredResult() && dst->isTemporary()) ? dst : newTemporary();
318         }
319
320         // Returns the place to write the final output of an operation.
321         RegisterID* finalDestination(RegisterID* originalDst, RegisterID* tempDst = 0)
322         {
323             if (originalDst && originalDst != ignoredResult())
324                 return originalDst;
325             ASSERT(tempDst != ignoredResult());
326             if (tempDst && tempDst->isTemporary())
327                 return tempDst;
328             return newTemporary();
329         }
330
331         RegisterID* destinationForAssignResult(RegisterID* dst)
332         {
333             if (dst && dst != ignoredResult() && m_codeBlock->needsFullScopeChain())
334                 return dst->isTemporary() ? dst : newTemporary();
335             return 0;
336         }
337
338         // Moves src to dst if dst is not null and is different from src, otherwise just returns src.
339         RegisterID* moveToDestinationIfNeeded(RegisterID* dst, RegisterID* src)
340         {
341             return dst == ignoredResult() ? 0 : (dst && dst != src) ? emitMove(dst, src) : src;
342         }
343
344         LabelScopePtr newLabelScope(LabelScope::Type, const Identifier* = 0);
345         PassRefPtr<Label> newLabel();
346
347         void emitNode(RegisterID* dst, StatementNode* n)
348         {
349             // Node::emitCode assumes that dst, if provided, is either a local or a referenced temporary.
350             ASSERT(!dst || dst == ignoredResult() || !dst->isTemporary() || dst->refCount());
351             if (!m_vm->isSafeToRecurse()) {
352                 emitThrowExpressionTooDeepException();
353                 return;
354             }
355             n->emitBytecode(*this, dst);
356         }
357
358         void emitNode(StatementNode* n)
359         {
360             emitNode(0, n);
361         }
362
363         RegisterID* emitNode(RegisterID* dst, ExpressionNode* n)
364         {
365             // Node::emitCode assumes that dst, if provided, is either a local or a referenced temporary.
366             ASSERT(!dst || dst == ignoredResult() || !dst->isTemporary() || dst->refCount());
367             if (!m_vm->isSafeToRecurse())
368                 return emitThrowExpressionTooDeepException();
369             return n->emitBytecode(*this, dst);
370         }
371
372         RegisterID* emitNode(ExpressionNode* n)
373         {
374             return emitNode(0, n);
375         }
376
377         void emitNodeInConditionContext(ExpressionNode* n, Label* trueTarget, Label* falseTarget, FallThroughMode fallThroughMode)
378         {
379             if (!m_vm->isSafeToRecurse()) {
380                 emitThrowExpressionTooDeepException();
381                 return;
382             }
383
384             n->emitBytecodeInConditionContext(*this, trueTarget, falseTarget, fallThroughMode);
385         }
386
387         void emitExpressionInfo(const JSTextPosition& divot, const JSTextPosition& divotStart, const JSTextPosition& divotEnd)
388         {            
389             ASSERT(divot.offset >= divotStart.offset);
390             ASSERT(divotEnd.offset >= divot.offset);
391
392             int sourceOffset = m_scopeNode->source().startOffset();
393             unsigned firstLine = m_scopeNode->source().firstLine();
394
395             int divotOffset = divot.offset - sourceOffset;
396             int startOffset = divot.offset - divotStart.offset;
397             int endOffset = divotEnd.offset - divot.offset;
398
399             unsigned line = divot.line;
400             ASSERT(line >= firstLine);
401             line -= firstLine;
402
403             int lineStart = divot.lineStartOffset;
404             if (lineStart > sourceOffset)
405                 lineStart -= sourceOffset;
406             else
407                 lineStart = 0;
408
409             if (divotOffset < lineStart)
410                 return;
411
412             unsigned column = divotOffset - lineStart;
413
414             unsigned instructionOffset = instructions().size();
415             if (!m_isBuiltinFunction)
416                 m_codeBlock->addExpressionInfo(instructionOffset, divotOffset, startOffset, endOffset, line, column);
417         }
418
419
420         ALWAYS_INLINE bool leftHandSideNeedsCopy(bool rightHasAssignments, bool rightIsPure)
421         {
422             return (m_codeType != FunctionCode || m_codeBlock->needsFullScopeChain() || rightHasAssignments) && !rightIsPure;
423         }
424
425         ALWAYS_INLINE PassRefPtr<RegisterID> emitNodeForLeftHandSide(ExpressionNode* n, bool rightHasAssignments, bool rightIsPure)
426         {
427             if (leftHandSideNeedsCopy(rightHasAssignments, rightIsPure)) {
428                 PassRefPtr<RegisterID> dst = newTemporary();
429                 emitNode(dst.get(), n);
430                 return dst;
431             }
432
433             return emitNode(n);
434         }
435
436         void emitTypeProfilerExpressionInfo(const JSTextPosition& startDivot, const JSTextPosition& endDivot);
437         void emitProfileType(RegisterID* registerToProfile, ProfileTypeBytecodeFlag, const Identifier*);
438
439         void emitProfileControlFlow(int);
440
441         RegisterID* emitLoad(RegisterID* dst, bool);
442         RegisterID* emitLoad(RegisterID* dst, const Identifier&);
443         RegisterID* emitLoad(RegisterID* dst, JSValue, SourceCodeRepresentation = SourceCodeRepresentation::Other);
444         RegisterID* emitLoadGlobalObject(RegisterID* dst);
445
446         RegisterID* emitUnaryOp(OpcodeID, RegisterID* dst, RegisterID* src);
447         RegisterID* emitBinaryOp(OpcodeID, RegisterID* dst, RegisterID* src1, RegisterID* src2, OperandTypes);
448         RegisterID* emitEqualityOp(OpcodeID, RegisterID* dst, RegisterID* src1, RegisterID* src2);
449         RegisterID* emitUnaryNoDstOp(OpcodeID, RegisterID* src);
450
451         RegisterID* emitCreateThis(RegisterID* dst);
452         void emitTDZCheck(RegisterID* target);
453         RegisterID* emitNewObject(RegisterID* dst);
454         RegisterID* emitNewArray(RegisterID* dst, ElementNode*, unsigned length); // stops at first elision
455
456         RegisterID* emitNewFunction(RegisterID* dst, FunctionBodyNode*);
457         RegisterID* emitNewFunctionInternal(RegisterID* dst, unsigned index);
458         RegisterID* emitNewFunctionExpression(RegisterID* dst, FuncExprNode* func);
459         RegisterID* emitNewDefaultConstructor(RegisterID* dst, ConstructorKind, const Identifier& name);
460         RegisterID* emitNewRegExp(RegisterID* dst, RegExp*);
461
462         RegisterID* emitMoveLinkTimeConstant(RegisterID* dst, LinkTimeConstant);
463         RegisterID* emitMoveEmptyValue(RegisterID* dst);
464         RegisterID* emitMove(RegisterID* dst, RegisterID* src);
465
466         RegisterID* emitToNumber(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_to_number, dst, src); }
467         RegisterID* emitToString(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_to_string, dst, src); }
468         RegisterID* emitInc(RegisterID* srcDst);
469         RegisterID* emitDec(RegisterID* srcDst);
470
471         void emitCheckHasInstance(RegisterID* dst, RegisterID* value, RegisterID* base, Label* target);
472         RegisterID* emitInstanceOf(RegisterID* dst, RegisterID* value, RegisterID* basePrototype);
473         RegisterID* emitTypeOf(RegisterID* dst, RegisterID* src) { return emitUnaryOp(op_typeof, dst, src); }
474         RegisterID* emitIn(RegisterID* dst, RegisterID* property, RegisterID* base) { return emitBinaryOp(op_in, dst, property, base, OperandTypes()); }
475
476         RegisterID* emitInitGlobalConst(const Identifier&, RegisterID* value);
477
478         RegisterID* emitGetById(RegisterID* dst, RegisterID* base, const Identifier& property);
479         RegisterID* emitPutById(RegisterID* base, const Identifier& property, RegisterID* value);
480         RegisterID* emitDirectPutById(RegisterID* base, const Identifier& property, RegisterID* value, PropertyNode::PutType);
481         RegisterID* emitDeleteById(RegisterID* dst, RegisterID* base, const Identifier&);
482         RegisterID* emitGetByVal(RegisterID* dst, RegisterID* base, RegisterID* property);
483         RegisterID* emitGetArgumentByVal(RegisterID* dst, RegisterID* base, RegisterID* property);
484         RegisterID* emitPutByVal(RegisterID* base, RegisterID* property, RegisterID* value);
485         RegisterID* emitDirectPutByVal(RegisterID* base, RegisterID* property, RegisterID* value);
486         RegisterID* emitDeleteByVal(RegisterID* dst, RegisterID* base, RegisterID* property);
487         RegisterID* emitPutByIndex(RegisterID* base, unsigned index, RegisterID* value);
488
489         void emitPutGetterById(RegisterID* base, const Identifier& property, RegisterID* getter);
490         void emitPutSetterById(RegisterID* base, const Identifier& property, RegisterID* setter);
491         void emitPutGetterSetter(RegisterID* base, const Identifier& property, RegisterID* getter, RegisterID* setter);
492         
493         ExpectedFunction expectedFunctionForIdentifier(const Identifier&);
494         RegisterID* emitCall(RegisterID* dst, RegisterID* func, ExpectedFunction, CallArguments&, const JSTextPosition& divot, const JSTextPosition& divotStart, const JSTextPosition& divotEnd);
495         RegisterID* emitCallEval(RegisterID* dst, RegisterID* func, CallArguments&, const JSTextPosition& divot, const JSTextPosition& divotStart, const JSTextPosition& divotEnd);
496         RegisterID* emitCallVarargs(RegisterID* dst, RegisterID* func, RegisterID* thisRegister, RegisterID* arguments, RegisterID* firstFreeRegister, int32_t firstVarArgOffset, RegisterID* profileHookRegister, const JSTextPosition& divot, const JSTextPosition& divotStart, const JSTextPosition& divotEnd);
497
498         enum PropertyDescriptorOption {
499             PropertyConfigurable = 1,
500             PropertyWritable     = 1 << 1,
501             PropertyEnumerable   = 1 << 2,
502         };
503         void emitCallDefineProperty(RegisterID* newObj, RegisterID* propertyNameRegister,
504             RegisterID* valueRegister, RegisterID* getterRegister, RegisterID* setterRegister, unsigned options, const JSTextPosition&);
505
506         void emitEnumeration(ThrowableExpressionData* enumerationNode, ExpressionNode* subjectNode, const std::function<void(BytecodeGenerator&, RegisterID*)>& callBack);
507
508 #if ENABLE(ES6_TEMPLATE_LITERAL_SYNTAX)
509         RegisterID* emitGetTemplateObject(RegisterID* dst, TaggedTemplateNode*);
510 #endif
511
512         RegisterID* emitReturn(RegisterID* src);
513         RegisterID* emitEnd(RegisterID* src) { return emitUnaryNoDstOp(op_end, src); }
514
515         RegisterID* emitConstruct(RegisterID* dst, RegisterID* func, ExpectedFunction, CallArguments&, const JSTextPosition& divot, const JSTextPosition& divotStart, const JSTextPosition& divotEnd);
516         RegisterID* emitStrcat(RegisterID* dst, RegisterID* src, int count);
517         void emitToPrimitive(RegisterID* dst, RegisterID* src);
518
519         ResolveType resolveType();
520         RegisterID* emitResolveConstantLocal(RegisterID* dst, const Variable&);
521         RegisterID* emitResolveScope(RegisterID* dst, const Variable&);
522         RegisterID* emitGetFromScope(RegisterID* dst, RegisterID* scope, const Variable&, ResolveMode);
523         RegisterID* emitPutToScope(RegisterID* scope, const Variable&, RegisterID* value, ResolveMode);
524         RegisterID* initializeVariable(const Variable&, RegisterID* value);
525
526         PassRefPtr<Label> emitLabel(Label*);
527         void emitLoopHint();
528         PassRefPtr<Label> emitJump(Label* target);
529         PassRefPtr<Label> emitJumpIfTrue(RegisterID* cond, Label* target);
530         PassRefPtr<Label> emitJumpIfFalse(RegisterID* cond, Label* target);
531         PassRefPtr<Label> emitJumpIfNotFunctionCall(RegisterID* cond, Label* target);
532         PassRefPtr<Label> emitJumpIfNotFunctionApply(RegisterID* cond, Label* target);
533         void emitPopScopes(RegisterID* srcDst, int targetScopeDepth);
534
535         RegisterID* emitHasIndexedProperty(RegisterID* dst, RegisterID* base, RegisterID* propertyName);
536         RegisterID* emitHasStructureProperty(RegisterID* dst, RegisterID* base, RegisterID* propertyName, RegisterID* enumerator);
537         RegisterID* emitHasGenericProperty(RegisterID* dst, RegisterID* base, RegisterID* propertyName);
538         RegisterID* emitGetPropertyEnumerator(RegisterID* dst, RegisterID* base);
539         RegisterID* emitGetEnumerableLength(RegisterID* dst, RegisterID* base);
540         RegisterID* emitGetStructurePropertyEnumerator(RegisterID* dst, RegisterID* base, RegisterID* length);
541         RegisterID* emitGetGenericPropertyEnumerator(RegisterID* dst, RegisterID* base, RegisterID* length, RegisterID* structureEnumerator);
542         RegisterID* emitEnumeratorStructurePropertyName(RegisterID* dst, RegisterID* enumerator, RegisterID* index);
543         RegisterID* emitEnumeratorGenericPropertyName(RegisterID* dst, RegisterID* enumerator, RegisterID* index);
544         RegisterID* emitToIndexString(RegisterID* dst, RegisterID* index);
545
546         RegisterID* emitIsObject(RegisterID* dst, RegisterID* src);
547         RegisterID* emitIsUndefined(RegisterID* dst, RegisterID* src);
548
549         void emitIteratorClose(RegisterID* iterator, ThrowableExpressionData* node);
550
551         void emitReadOnlyExceptionIfNeeded();
552
553         // Start a try block. 'start' must have been emitted.
554         TryData* pushTry(Label* start);
555         // End a try block. 'end' must have been emitted.
556         void popTryAndEmitCatch(TryData*, RegisterID* exceptionRegister, RegisterID* thrownValueRegister, Label* end, HandlerType);
557
558         void emitThrow(RegisterID* exc)
559         { 
560             m_usesExceptions = true;
561             emitUnaryNoDstOp(op_throw, exc);
562         }
563
564         void emitThrowReferenceError(const String& message);
565         void emitThrowTypeError(const String& message);
566
567         void emitPushFunctionNameScope(RegisterID* dst, const Identifier& property, RegisterID* value, unsigned attributes);
568         void emitPushCatchScope(RegisterID* dst, const Identifier& property, RegisterID* value, unsigned attributes);
569
570         void emitGetScope();
571         RegisterID* emitPushWithScope(RegisterID* dst, RegisterID* scope);
572         void emitPopScope(RegisterID* srcDst);
573
574         void emitDebugHook(DebugHookID, unsigned line, unsigned charOffset, unsigned lineStart);
575
576         int scopeDepth() { return m_localScopeDepth + m_finallyDepth; }
577         bool hasFinaliser() { return m_finallyDepth != 0; }
578
579         void pushFinallyContext(StatementNode* finallyBlock);
580         void popFinallyContext();
581         void pushIteratorCloseContext(RegisterID* iterator, ThrowableExpressionData* enumerationNode);
582         void popIteratorCloseContext();
583
584         void pushIndexedForInScope(RegisterID* local, RegisterID* index);
585         void popIndexedForInScope(RegisterID* local);
586         void pushStructureForInScope(RegisterID* local, RegisterID* index, RegisterID* property, RegisterID* enumerator);
587         void popStructureForInScope(RegisterID* local);
588         void invalidateForInContextForLocal(RegisterID* local);
589
590         LabelScopePtr breakTarget(const Identifier&);
591         LabelScopePtr continueTarget(const Identifier&);
592
593         void beginSwitch(RegisterID*, SwitchInfo::SwitchType);
594         void endSwitch(uint32_t clauseCount, RefPtr<Label>*, ExpressionNode**, Label* defaultLabel, int32_t min, int32_t range);
595
596         CodeType codeType() const { return m_codeType; }
597
598         bool shouldEmitProfileHooks() { return m_shouldEmitProfileHooks; }
599         bool shouldEmitDebugHooks() { return m_shouldEmitDebugHooks; }
600         
601         bool isStrictMode() const { return m_codeBlock->isStrictMode(); }
602         
603         bool isBuiltinFunction() const { return m_isBuiltinFunction; }
604
605         OpcodeID lastOpcodeID() const { return m_lastOpcodeID; }
606
607     private:
608         Variable variableForLocalEntry(const Identifier&, const SymbolTableEntry&);
609
610         void emitOpcode(OpcodeID);
611         UnlinkedArrayAllocationProfile newArrayAllocationProfile();
612         UnlinkedObjectAllocationProfile newObjectAllocationProfile();
613         UnlinkedArrayProfile newArrayProfile();
614         UnlinkedValueProfile emitProfiledOpcode(OpcodeID);
615         int kill(RegisterID* dst)
616         {
617             int index = dst->index();
618             m_staticPropertyAnalyzer.kill(index);
619             return index;
620         }
621
622         void retrieveLastBinaryOp(int& dstIndex, int& src1Index, int& src2Index);
623         void retrieveLastUnaryOp(int& dstIndex, int& srcIndex);
624         ALWAYS_INLINE void rewindBinaryOp();
625         ALWAYS_INLINE void rewindUnaryOp();
626
627         void allocateAndEmitScope();
628         void emitComplexPopScopes(RegisterID*, ControlFlowContext* topScope, ControlFlowContext* bottomScope);
629
630         typedef HashMap<double, JSValue> NumberMap;
631         typedef HashMap<UniquedStringImpl*, JSString*, IdentifierRepHash> IdentifierStringMap;
632         typedef HashMap<TemplateRegistryKey, JSTemplateRegistryKey*> TemplateRegistryKeyMap;
633         
634         // Helper for emitCall() and emitConstruct(). This works because the set of
635         // expected functions have identical behavior for both call and construct
636         // (i.e. "Object()" is identical to "new Object()").
637         ExpectedFunction emitExpectedFunctionSnippet(RegisterID* dst, RegisterID* func, ExpectedFunction, CallArguments&, Label* done);
638         
639         RegisterID* emitCall(OpcodeID, RegisterID* dst, RegisterID* func, ExpectedFunction, CallArguments&, const JSTextPosition& divot, const JSTextPosition& divotStart, const JSTextPosition& divotEnd);
640
641         RegisterID* newRegister();
642
643         // Adds an anonymous local var slot. To give this slot a name, add it to symbolTable().
644         RegisterID* addVar()
645         {
646             ++m_codeBlock->m_numVars;
647             RegisterID* result = newRegister();
648             ASSERT(VirtualRegister(result->index()).toLocal() == m_codeBlock->m_numVars - 1);
649             result->ref(); // We should never free this slot.
650             return result;
651         }
652
653         // Initializes the stack form the parameter; does nothing for the symbol table.
654         RegisterID* initializeNextParameter();
655         UniquedStringImpl* visibleNameForParameter(DeconstructionPatternNode*);
656         
657         RegisterID& registerFor(VirtualRegister reg)
658         {
659             if (reg.isLocal())
660                 return m_calleeRegisters[reg.toLocal()];
661
662             if (reg.offset() == JSStack::Callee)
663                 return m_calleeRegister;
664
665             ASSERT(m_parameters.size());
666             return m_parameters[reg.toArgument()];
667         }
668
669         bool hasConstant(const Identifier&) const;
670         unsigned addConstant(const Identifier&);
671         RegisterID* addConstantValue(JSValue, SourceCodeRepresentation = SourceCodeRepresentation::Other);
672         RegisterID* addConstantEmptyValue();
673         unsigned addRegExp(RegExp*);
674
675         unsigned addConstantBuffer(unsigned length);
676         
677         UnlinkedFunctionExecutable* makeFunction(FunctionBodyNode* body)
678         {
679             return UnlinkedFunctionExecutable::create(m_vm, m_scopeNode->source(), body, isBuiltinFunction() ? UnlinkedBuiltinFunction : UnlinkedNormalFunction);
680         }
681
682         RegisterID* emitConstructVarargs(RegisterID* dst, RegisterID* func, RegisterID* thisRegister, RegisterID* arguments, RegisterID* firstFreeRegister, int32_t firstVarArgOffset, RegisterID* profileHookRegister, const JSTextPosition& divot, const JSTextPosition& divotStart, const JSTextPosition& divotEnd);
683         RegisterID* emitCallVarargs(OpcodeID, RegisterID* dst, RegisterID* func, RegisterID* thisRegister, RegisterID* arguments, RegisterID* firstFreeRegister, int32_t firstVarArgOffset, RegisterID* profileHookRegister, const JSTextPosition& divot, const JSTextPosition& divotStart, const JSTextPosition& divotEnd);
684
685     public:
686         JSString* addStringConstant(const Identifier&);
687         JSTemplateRegistryKey* addTemplateRegistryKeyConstant(const TemplateRegistryKey&);
688
689         Vector<UnlinkedInstruction, 0, UnsafeVectorOverflow>& instructions() { return m_instructions; }
690
691         SymbolTable& symbolTable() { return *m_symbolTable; }
692
693         bool shouldOptimizeLocals()
694         {
695             if (m_codeType != FunctionCode)
696                 return false;
697
698             if (m_localScopeDepth)
699                 return false;
700
701             return true;
702         }
703
704         bool canOptimizeNonLocals()
705         {
706             if (m_localScopeDepth)
707                 return false;
708
709             if (m_codeType == EvalCode)
710                 return false;
711
712             if (m_codeType == FunctionCode && m_codeBlock->usesEval())
713                 return false;
714
715             return true;
716         }
717
718         RegisterID* emitThrowExpressionTooDeepException();
719
720     private:
721         Vector<UnlinkedInstruction, 0, UnsafeVectorOverflow> m_instructions;
722
723         bool m_shouldEmitDebugHooks;
724         bool m_shouldEmitProfileHooks;
725
726         SymbolTable* m_symbolTable { nullptr };
727
728         ScopeNode* const m_scopeNode;
729         Strong<UnlinkedCodeBlock> m_codeBlock;
730
731         // Some of these objects keep pointers to one another. They are arranged
732         // to ensure a sane destruction order that avoids references to freed memory.
733         HashSet<RefPtr<UniquedStringImpl>, IdentifierRepHash> m_functions;
734         RegisterID m_ignoredResultRegister;
735         RegisterID m_thisRegister;
736         RegisterID m_calleeRegister;
737         RegisterID* m_scopeRegister { nullptr };
738         RegisterID* m_argumentsRegister { nullptr };
739         RegisterID* m_lexicalEnvironmentRegister { nullptr };
740         RegisterID* m_emptyValueRegister { nullptr };
741         RegisterID* m_globalObjectRegister { nullptr };
742         RegisterID* m_newTargetRegister { nullptr };
743         RegisterID* m_linkTimeConstantRegisters[LinkTimeConstantCount];
744
745         SegmentedVector<RegisterID, 32> m_constantPoolRegisters;
746         SegmentedVector<RegisterID, 32> m_calleeRegisters;
747         SegmentedVector<RegisterID, 32> m_parameters;
748         SegmentedVector<Label, 32> m_labels;
749         LabelScopeStore m_labelScopes;
750         int m_finallyDepth { 0 };
751         int m_localScopeDepth { 0 };
752         const CodeType m_codeType;
753
754         Vector<ControlFlowContext, 0, UnsafeVectorOverflow> m_scopeContextStack;
755         Vector<SwitchInfo> m_switchContextStack;
756         Vector<std::unique_ptr<ForInContext>> m_forInContextStack;
757         Vector<TryContext> m_tryContextStack;
758         Vector<std::pair<RefPtr<RegisterID>, const DeconstructionPatternNode*>> m_deconstructedParameters;
759         enum FunctionVariableType : uint8_t { NormalFunctionVariable, GlobalFunctionVariable };
760         Vector<std::pair<FunctionBodyNode*, FunctionVariableType>> m_functionsToInitialize;
761         bool m_needToInitializeArguments { false };
762         
763         Vector<TryRange> m_tryRanges;
764         SegmentedVector<TryData, 8> m_tryData;
765
766         int m_nextConstantOffset { 0 };
767
768         typedef HashMap<FunctionBodyNode*, unsigned> FunctionOffsetMap;
769         FunctionOffsetMap m_functionOffsets;
770         
771         // Constant pool
772         IdentifierMap m_identifierMap;
773
774         typedef HashMap<EncodedJSValueWithRepresentation, unsigned, EncodedJSValueWithRepresentationHash, EncodedJSValueWithRepresentationHashTraits> JSValueMap;
775         JSValueMap m_jsValueMap;
776         IdentifierStringMap m_stringMap;
777         TemplateRegistryKeyMap m_templateRegistryKeyMap;
778
779         StaticPropertyAnalyzer m_staticPropertyAnalyzer { &m_instructions };
780
781         VM* m_vm;
782
783         OpcodeID m_lastOpcodeID = op_end;
784 #ifndef NDEBUG
785         size_t m_lastOpcodePosition { 0 };
786 #endif
787
788         bool m_usesExceptions { false };
789         bool m_expressionTooDeep { false };
790         bool m_isBuiltinFunction { false };
791     };
792
793 }
794
795 #endif // BytecodeGenerator_h