b1cf6fc7a5a3ac9e40d35e09752338ff6d4a33ba
[WebKit-https.git] / Source / JavaScriptCore / bytecode / UnlinkedCodeBlock.h
1 /*
2  * Copyright (C) 2012-2016 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "BytecodeConventions.h"
29 #include "CodeType.h"
30 #include "ExpressionRangeInfo.h"
31 #include "HandlerInfo.h"
32 #include "Identifier.h"
33 #include "JSCell.h"
34 #include "LockDuringMarking.h"
35 #include "ParserModes.h"
36 #include "RegExp.h"
37 #include "SpecialPointer.h"
38 #include "UnlinkedFunctionExecutable.h"
39 #include "VirtualRegister.h"
40 #include <algorithm>
41 #include <wtf/BitVector.h>
42 #include <wtf/HashSet.h>
43 #include <wtf/TriState.h>
44 #include <wtf/Vector.h>
45 #include <wtf/text/UniquedStringImpl.h>
46
47 namespace JSC {
48
49 class BytecodeRewriter;
50 class Debugger;
51 class FunctionExecutable;
52 class ParserError;
53 class ScriptExecutable;
54 class SourceCode;
55 class SourceProvider;
56 class UnlinkedCodeBlock;
57 class UnlinkedFunctionCodeBlock;
58 class UnlinkedFunctionExecutable;
59 class UnlinkedInstructionStream;
60 struct ExecutableInfo;
61
62 typedef unsigned UnlinkedValueProfile;
63 typedef unsigned UnlinkedArrayProfile;
64 typedef unsigned UnlinkedArrayAllocationProfile;
65 typedef unsigned UnlinkedObjectAllocationProfile;
66 typedef unsigned UnlinkedLLIntCallLinkInfo;
67 using ConstantIndentifierSetEntry = std::pair<IdentifierSet, unsigned>;
68
69 struct UnlinkedStringJumpTable {
70     struct OffsetLocation {
71         int32_t branchOffset;
72     };
73
74     typedef HashMap<RefPtr<StringImpl>, OffsetLocation> StringOffsetTable;
75     StringOffsetTable offsetTable;
76
77     inline int32_t offsetForValue(StringImpl* value, int32_t defaultOffset)
78     {
79         StringOffsetTable::const_iterator end = offsetTable.end();
80         StringOffsetTable::const_iterator loc = offsetTable.find(value);
81         if (loc == end)
82             return defaultOffset;
83         return loc->value.branchOffset;
84     }
85
86 };
87
88 struct UnlinkedSimpleJumpTable {
89     Vector<int32_t> branchOffsets;
90     int32_t min;
91
92     int32_t offsetForValue(int32_t value, int32_t defaultOffset);
93     void add(int32_t key, int32_t offset)
94     {
95         if (!branchOffsets[key])
96             branchOffsets[key] = offset;
97     }
98 };
99
100 struct UnlinkedInstruction {
101     UnlinkedInstruction() { u.operand = 0; }
102     UnlinkedInstruction(OpcodeID opcode) { u.opcode = opcode; }
103     UnlinkedInstruction(int operand) { u.operand = operand; }
104     union {
105         OpcodeID opcode;
106         int32_t operand;
107         unsigned unsignedValue;
108     } u;
109 };
110
111 class UnlinkedCodeBlock : public JSCell {
112 public:
113     typedef JSCell Base;
114     static const unsigned StructureFlags = Base::StructureFlags;
115
116     static const bool needsDestruction = true;
117
118     enum { CallFunction, ApplyFunction };
119
120     typedef UnlinkedInstruction Instruction;
121     typedef Vector<UnlinkedInstruction, 0, UnsafeVectorOverflow> UnpackedInstructions;
122
123     bool isConstructor() const { return m_isConstructor; }
124     bool isStrictMode() const { return m_isStrictMode; }
125     bool usesEval() const { return m_usesEval; }
126     SourceParseMode parseMode() const { return m_parseMode; }
127     bool isArrowFunction() const { return isArrowFunctionParseMode(parseMode()); }
128     DerivedContextType derivedContextType() const { return static_cast<DerivedContextType>(m_derivedContextType); }
129     EvalContextType evalContextType() const { return static_cast<EvalContextType>(m_evalContextType); }
130     bool isArrowFunctionContext() const { return m_isArrowFunctionContext; }
131     bool isClassContext() const { return m_isClassContext; }
132     bool hasTailCalls() const { return m_hasTailCalls; }
133     void setHasTailCalls() { m_hasTailCalls = true; }
134
135     void addExpressionInfo(unsigned instructionOffset, int divot,
136         int startOffset, int endOffset, unsigned line, unsigned column);
137
138     void addTypeProfilerExpressionInfo(unsigned instructionOffset, unsigned startDivot, unsigned endDivot);
139
140     bool hasExpressionInfo() { return m_expressionInfo.size(); }
141     const Vector<ExpressionRangeInfo>& expressionInfo() { return m_expressionInfo; }
142
143     // Special registers
144     void setThisRegister(VirtualRegister thisRegister) { m_thisRegister = thisRegister; }
145     void setScopeRegister(VirtualRegister scopeRegister) { m_scopeRegister = scopeRegister; }
146
147     bool usesGlobalObject() const { return m_globalObjectRegister.isValid(); }
148     void setGlobalObjectRegister(VirtualRegister globalObjectRegister) { m_globalObjectRegister = globalObjectRegister; }
149     VirtualRegister globalObjectRegister() const { return m_globalObjectRegister; }
150
151     // Parameter information
152     void setNumParameters(int newValue) { m_numParameters = newValue; }
153     void addParameter() { m_numParameters++; }
154     unsigned numParameters() const { return m_numParameters; }
155
156     unsigned addRegExp(RegExp* r)
157     {
158         createRareDataIfNecessary();
159         VM& vm = *this->vm();
160         auto locker = lockDuringMarking(vm.heap, *this);
161         unsigned size = m_rareData->m_regexps.size();
162         m_rareData->m_regexps.append(WriteBarrier<RegExp>(vm, this, r));
163         return size;
164     }
165     unsigned numberOfRegExps() const
166     {
167         if (!m_rareData)
168             return 0;
169         return m_rareData->m_regexps.size();
170     }
171     RegExp* regexp(int index) const { ASSERT(m_rareData); return m_rareData->m_regexps[index].get(); }
172
173     // Constant Pools
174
175     size_t numberOfIdentifiers() const { return m_identifiers.size(); }
176     void addIdentifier(const Identifier& i) { return m_identifiers.append(i); }
177     const Identifier& identifier(int index) const { return m_identifiers[index]; }
178     const Vector<Identifier>& identifiers() const { return m_identifiers; }
179
180     const Vector<BitVector>& bitVectors() const { return m_bitVectors; }
181     BitVector& bitVector(size_t i) { return m_bitVectors[i]; }
182     unsigned addBitVector(BitVector&& bitVector)
183     {
184         m_bitVectors.append(WTFMove(bitVector));
185         return m_bitVectors.size() - 1;
186     }
187
188     void addSetConstant(IdentifierSet& set)
189     {
190         VM& vm = *this->vm();
191         auto locker = lockDuringMarking(vm.heap, *this);
192         unsigned result = m_constantRegisters.size();
193         m_constantRegisters.append(WriteBarrier<Unknown>());
194         m_constantsSourceCodeRepresentation.append(SourceCodeRepresentation::Other);
195         m_constantIdentifierSets.append(ConstantIndentifierSetEntry(set, result));
196     }
197
198     unsigned addConstant(JSValue v, SourceCodeRepresentation sourceCodeRepresentation = SourceCodeRepresentation::Other)
199     {
200         VM& vm = *this->vm();
201         auto locker = lockDuringMarking(vm.heap, *this);
202         unsigned result = m_constantRegisters.size();
203         m_constantRegisters.append(WriteBarrier<Unknown>());
204         m_constantRegisters.last().set(vm, this, v);
205         m_constantsSourceCodeRepresentation.append(sourceCodeRepresentation);
206         return result;
207     }
208     unsigned addConstant(LinkTimeConstant type)
209     {
210         VM& vm = *this->vm();
211         auto locker = lockDuringMarking(vm.heap, *this);
212         unsigned result = m_constantRegisters.size();
213         ASSERT(result);
214         unsigned index = static_cast<unsigned>(type);
215         ASSERT(index < LinkTimeConstantCount);
216         m_linkTimeConstants[index] = result;
217         m_constantRegisters.append(WriteBarrier<Unknown>());
218         m_constantsSourceCodeRepresentation.append(SourceCodeRepresentation::Other);
219         return result;
220     }
221
222     unsigned registerIndexForLinkTimeConstant(LinkTimeConstant type)
223     {
224         unsigned index = static_cast<unsigned>(type);
225         ASSERT(index < LinkTimeConstantCount);
226         return m_linkTimeConstants[index];
227     }
228     const Vector<WriteBarrier<Unknown>>& constantRegisters() { return m_constantRegisters; }
229     const Vector<ConstantIndentifierSetEntry>& constantIdentifierSets() { return m_constantIdentifierSets; }
230     const WriteBarrier<Unknown>& constantRegister(int index) const { return m_constantRegisters[index - FirstConstantRegisterIndex]; }
231     ALWAYS_INLINE bool isConstantRegisterIndex(int index) const { return index >= FirstConstantRegisterIndex; }
232     ALWAYS_INLINE JSValue getConstant(int index) const { return m_constantRegisters[index - FirstConstantRegisterIndex].get(); }
233     const Vector<SourceCodeRepresentation>& constantsSourceCodeRepresentation() { return m_constantsSourceCodeRepresentation; }
234
235     // Jumps
236     size_t numberOfJumpTargets() const { return m_jumpTargets.size(); }
237     void addJumpTarget(unsigned jumpTarget) { m_jumpTargets.append(jumpTarget); }
238     unsigned jumpTarget(int index) const { return m_jumpTargets[index]; }
239     unsigned lastJumpTarget() const { return m_jumpTargets.last(); }
240
241     UnlinkedHandlerInfo* handlerForBytecodeOffset(unsigned bytecodeOffset, RequiredHandler = RequiredHandler::AnyHandler);
242     UnlinkedHandlerInfo* handlerForIndex(unsigned, RequiredHandler = RequiredHandler::AnyHandler);
243
244     bool isBuiltinFunction() const { return m_isBuiltinFunction; }
245
246     ConstructorKind constructorKind() const { return static_cast<ConstructorKind>(m_constructorKind); }
247     SuperBinding superBinding() const { return static_cast<SuperBinding>(m_superBinding); }
248     JSParserScriptMode scriptMode() const { return static_cast<JSParserScriptMode>(m_scriptMode); }
249
250     void shrinkToFit();
251
252     void setInstructions(std::unique_ptr<UnlinkedInstructionStream>);
253     const UnlinkedInstructionStream& instructions() const;
254
255     int numCalleeLocals() const { return m_numCalleeLocals; }
256
257     int m_numVars;
258     int m_numCapturedVars;
259     int m_numCalleeLocals;
260
261     // Jump Tables
262
263     size_t numberOfSwitchJumpTables() const { return m_rareData ? m_rareData->m_switchJumpTables.size() : 0; }
264     UnlinkedSimpleJumpTable& addSwitchJumpTable() { createRareDataIfNecessary(); m_rareData->m_switchJumpTables.append(UnlinkedSimpleJumpTable()); return m_rareData->m_switchJumpTables.last(); }
265     UnlinkedSimpleJumpTable& switchJumpTable(int tableIndex) { ASSERT(m_rareData); return m_rareData->m_switchJumpTables[tableIndex]; }
266
267     size_t numberOfStringSwitchJumpTables() const { return m_rareData ? m_rareData->m_stringSwitchJumpTables.size() : 0; }
268     UnlinkedStringJumpTable& addStringSwitchJumpTable() { createRareDataIfNecessary(); m_rareData->m_stringSwitchJumpTables.append(UnlinkedStringJumpTable()); return m_rareData->m_stringSwitchJumpTables.last(); }
269     UnlinkedStringJumpTable& stringSwitchJumpTable(int tableIndex) { ASSERT(m_rareData); return m_rareData->m_stringSwitchJumpTables[tableIndex]; }
270
271     unsigned addFunctionDecl(UnlinkedFunctionExecutable* n)
272     {
273         VM& vm = *this->vm();
274         auto locker = lockDuringMarking(vm.heap, *this);
275         unsigned size = m_functionDecls.size();
276         m_functionDecls.append(WriteBarrier<UnlinkedFunctionExecutable>());
277         m_functionDecls.last().set(vm, this, n);
278         return size;
279     }
280     UnlinkedFunctionExecutable* functionDecl(int index) { return m_functionDecls[index].get(); }
281     size_t numberOfFunctionDecls() { return m_functionDecls.size(); }
282     unsigned addFunctionExpr(UnlinkedFunctionExecutable* n)
283     {
284         VM& vm = *this->vm();
285         auto locker = lockDuringMarking(vm.heap, *this);
286         unsigned size = m_functionExprs.size();
287         m_functionExprs.append(WriteBarrier<UnlinkedFunctionExecutable>());
288         m_functionExprs.last().set(vm, this, n);
289         return size;
290     }
291     UnlinkedFunctionExecutable* functionExpr(int index) { return m_functionExprs[index].get(); }
292     size_t numberOfFunctionExprs() { return m_functionExprs.size(); }
293
294     // Exception handling support
295     size_t numberOfExceptionHandlers() const { return m_rareData ? m_rareData->m_exceptionHandlers.size() : 0; }
296     void addExceptionHandler(const UnlinkedHandlerInfo& handler) { createRareDataIfNecessary(); return m_rareData->m_exceptionHandlers.append(handler); }
297     UnlinkedHandlerInfo& exceptionHandler(int index) { ASSERT(m_rareData); return m_rareData->m_exceptionHandlers[index]; }
298
299     UnlinkedArrayProfile addArrayProfile() { return m_arrayProfileCount++; }
300     unsigned numberOfArrayProfiles() { return m_arrayProfileCount; }
301     UnlinkedArrayAllocationProfile addArrayAllocationProfile() { return m_arrayAllocationProfileCount++; }
302     unsigned numberOfArrayAllocationProfiles() { return m_arrayAllocationProfileCount; }
303     UnlinkedObjectAllocationProfile addObjectAllocationProfile() { return m_objectAllocationProfileCount++; }
304     unsigned numberOfObjectAllocationProfiles() { return m_objectAllocationProfileCount; }
305     UnlinkedValueProfile addValueProfile() { return m_valueProfileCount++; }
306     unsigned numberOfValueProfiles() { return m_valueProfileCount; }
307
308     UnlinkedLLIntCallLinkInfo addLLIntCallLinkInfo() { return m_llintCallLinkInfoCount++; }
309     unsigned numberOfLLintCallLinkInfos() { return m_llintCallLinkInfoCount; }
310
311     CodeType codeType() const { return m_codeType; }
312
313     VirtualRegister thisRegister() const { return m_thisRegister; }
314     VirtualRegister scopeRegister() const { return m_scopeRegister; }
315
316     void addPropertyAccessInstruction(unsigned propertyAccessInstruction)
317     {
318         m_propertyAccessInstructions.append(propertyAccessInstruction);
319     }
320
321     size_t numberOfPropertyAccessInstructions() const { return m_propertyAccessInstructions.size(); }
322     const Vector<unsigned>& propertyAccessInstructions() const { return m_propertyAccessInstructions; }
323
324     typedef Vector<JSValue> ConstantBuffer;
325
326     size_t constantBufferCount() { ASSERT(m_rareData); return m_rareData->m_constantBuffers.size(); }
327     unsigned addConstantBuffer(unsigned length)
328     {
329         createRareDataIfNecessary();
330         unsigned size = m_rareData->m_constantBuffers.size();
331         m_rareData->m_constantBuffers.append(Vector<JSValue>(length));
332         return size;
333     }
334
335     const ConstantBuffer& constantBuffer(unsigned index) const
336     {
337         ASSERT(m_rareData);
338         return m_rareData->m_constantBuffers[index];
339     }
340
341     ConstantBuffer& constantBuffer(unsigned index)
342     {
343         ASSERT(m_rareData);
344         return m_rareData->m_constantBuffers[index];
345     }
346
347     bool hasRareData() const { return m_rareData.get(); }
348
349     int lineNumberForBytecodeOffset(unsigned bytecodeOffset);
350
351     void expressionRangeForBytecodeOffset(unsigned bytecodeOffset, int& divot,
352         int& startOffset, int& endOffset, unsigned& line, unsigned& column) const;
353
354     bool typeProfilerExpressionInfoForBytecodeOffset(unsigned bytecodeOffset, unsigned& startDivot, unsigned& endDivot);
355
356     void recordParse(CodeFeatures features, bool hasCapturedVariables, unsigned lineCount, unsigned endColumn)
357     {
358         m_features = features;
359         m_hasCapturedVariables = hasCapturedVariables;
360         m_lineCount = lineCount;
361         // For the UnlinkedCodeBlock, startColumn is always 0.
362         m_endColumn = endColumn;
363     }
364
365     const String& sourceURLDirective() const { return m_sourceURLDirective; }
366     const String& sourceMappingURLDirective() const { return m_sourceMappingURLDirective; }
367     void setSourceURLDirective(const String& sourceURL) { m_sourceURLDirective = sourceURL; }
368     void setSourceMappingURLDirective(const String& sourceMappingURL) { m_sourceMappingURLDirective = sourceMappingURL; }
369
370     CodeFeatures codeFeatures() const { return m_features; }
371     bool hasCapturedVariables() const { return m_hasCapturedVariables; }
372     unsigned lineCount() const { return m_lineCount; }
373     ALWAYS_INLINE unsigned startColumn() const { return 0; }
374     unsigned endColumn() const { return m_endColumn; }
375
376     void addOpProfileControlFlowBytecodeOffset(size_t offset)
377     {
378         createRareDataIfNecessary();
379         m_rareData->m_opProfileControlFlowBytecodeOffsets.append(offset);
380     }
381     const Vector<size_t>& opProfileControlFlowBytecodeOffsets() const
382     {
383         ASSERT(m_rareData);
384         return m_rareData->m_opProfileControlFlowBytecodeOffsets;
385     }
386     bool hasOpProfileControlFlowBytecodeOffsets() const
387     {
388         return m_rareData && !m_rareData->m_opProfileControlFlowBytecodeOffsets.isEmpty();
389     }
390
391     void dumpExpressionRangeInfo(); // For debugging purpose only.
392
393     bool wasCompiledWithDebuggingOpcodes() const { return m_wasCompiledWithDebuggingOpcodes; }
394
395     TriState didOptimize() const { return m_didOptimize; }
396     void setDidOptimize(TriState didOptimize) { m_didOptimize = didOptimize; }
397
398     void dump(PrintStream&) const;
399
400 protected:
401     UnlinkedCodeBlock(VM*, Structure*, CodeType, const ExecutableInfo&, DebuggerMode);
402     ~UnlinkedCodeBlock();
403
404     void finishCreation(VM& vm)
405     {
406         Base::finishCreation(vm);
407     }
408
409 private:
410     friend class BytecodeRewriter;
411     void applyModification(BytecodeRewriter&);
412
413     void createRareDataIfNecessary()
414     {
415         if (!m_rareData) {
416             auto locker = lockDuringMarking(*heap(), *this);
417             m_rareData = std::make_unique<RareData>();
418         }
419     }
420
421     void getLineAndColumn(const ExpressionRangeInfo&, unsigned& line, unsigned& column) const;
422
423     int m_numParameters;
424
425     std::unique_ptr<UnlinkedInstructionStream> m_unlinkedInstructions;
426
427     VirtualRegister m_thisRegister;
428     VirtualRegister m_scopeRegister;
429     VirtualRegister m_globalObjectRegister;
430
431     String m_sourceURLDirective;
432     String m_sourceMappingURLDirective;
433
434     unsigned m_usesEval : 1;
435     unsigned m_isStrictMode : 1;
436     unsigned m_isConstructor : 1;
437     unsigned m_hasCapturedVariables : 1;
438     unsigned m_isBuiltinFunction : 1;
439     unsigned m_superBinding : 1;
440     unsigned m_scriptMode: 1;
441     unsigned m_isArrowFunctionContext : 1;
442     unsigned m_isClassContext : 1;
443     unsigned m_wasCompiledWithDebuggingOpcodes : 1;
444     unsigned m_constructorKind : 2;
445     unsigned m_derivedContextType : 2;
446     unsigned m_evalContextType : 2;
447     unsigned m_hasTailCalls : 1;
448     unsigned m_lineCount;
449     unsigned m_endColumn;
450
451     TriState m_didOptimize;
452     SourceParseMode m_parseMode;
453     CodeFeatures m_features;
454     CodeType m_codeType;
455
456     Vector<unsigned> m_jumpTargets;
457
458     Vector<unsigned> m_propertyAccessInstructions;
459
460     // Constant Pools
461     Vector<Identifier> m_identifiers;
462     Vector<BitVector> m_bitVectors;
463     Vector<WriteBarrier<Unknown>> m_constantRegisters;
464     Vector<ConstantIndentifierSetEntry> m_constantIdentifierSets;
465     Vector<SourceCodeRepresentation> m_constantsSourceCodeRepresentation;
466     typedef Vector<WriteBarrier<UnlinkedFunctionExecutable>> FunctionExpressionVector;
467     FunctionExpressionVector m_functionDecls;
468     FunctionExpressionVector m_functionExprs;
469     std::array<unsigned, LinkTimeConstantCount> m_linkTimeConstants;
470
471     unsigned m_arrayProfileCount;
472     unsigned m_arrayAllocationProfileCount;
473     unsigned m_objectAllocationProfileCount;
474     unsigned m_valueProfileCount;
475     unsigned m_llintCallLinkInfoCount;
476
477 public:
478     struct RareData {
479         WTF_MAKE_FAST_ALLOCATED;
480     public:
481         Vector<UnlinkedHandlerInfo> m_exceptionHandlers;
482
483         // Rare Constants
484         Vector<WriteBarrier<RegExp>> m_regexps;
485
486         // Buffers used for large array literals
487         Vector<ConstantBuffer> m_constantBuffers;
488
489         // Jump Tables
490         Vector<UnlinkedSimpleJumpTable> m_switchJumpTables;
491         Vector<UnlinkedStringJumpTable> m_stringSwitchJumpTables;
492
493         Vector<ExpressionRangeInfo::FatPosition> m_expressionInfoFatPositions;
494
495         struct TypeProfilerExpressionRange {
496             unsigned m_startDivot;
497             unsigned m_endDivot;
498         };
499         HashMap<unsigned, TypeProfilerExpressionRange> m_typeProfilerInfoMap;
500         Vector<size_t> m_opProfileControlFlowBytecodeOffsets;
501     };
502
503 private:
504     std::unique_ptr<RareData> m_rareData;
505     Vector<ExpressionRangeInfo> m_expressionInfo;
506
507 protected:
508     static void visitChildren(JSCell*, SlotVisitor&);
509     static size_t estimatedSize(JSCell*);
510
511 public:
512     DECLARE_INFO;
513 };
514
515 }