a2fb1184ff41b1d434c85d83f8a0793cba268cd3
[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 "CodeSpecializationKind.h"
30 #include "CodeType.h"
31 #include "ConstructAbility.h"
32 #include "ExpressionRangeInfo.h"
33 #include "HandlerInfo.h"
34 #include "Identifier.h"
35 #include "JSCell.h"
36 #include "JSString.h"
37 #include "LockDuringMarking.h"
38 #include "ParserModes.h"
39 #include "RegExp.h"
40 #include "SpecialPointer.h"
41 #include "UnlinkedFunctionExecutable.h"
42 #include "VariableEnvironment.h"
43 #include "VirtualRegister.h"
44 #include <algorithm>
45 #include <wtf/BitVector.h>
46 #include <wtf/HashSet.h>
47 #include <wtf/TriState.h>
48 #include <wtf/Vector.h>
49 #include <wtf/text/UniquedStringImpl.h>
50
51 namespace JSC {
52
53 class BytecodeRewriter;
54 class Debugger;
55 class FunctionExecutable;
56 class ParserError;
57 class ScriptExecutable;
58 class SourceCode;
59 class SourceProvider;
60 class UnlinkedCodeBlock;
61 class UnlinkedFunctionCodeBlock;
62 class UnlinkedFunctionExecutable;
63 class UnlinkedInstructionStream;
64 struct ExecutableInfo;
65
66 typedef unsigned UnlinkedValueProfile;
67 typedef unsigned UnlinkedArrayProfile;
68 typedef unsigned UnlinkedArrayAllocationProfile;
69 typedef unsigned UnlinkedObjectAllocationProfile;
70 typedef unsigned UnlinkedLLIntCallLinkInfo;
71 typedef std::pair<IdentifierSet, unsigned> ConstantIndentifierSetEntry;
72
73 struct UnlinkedStringJumpTable {
74     struct OffsetLocation {
75         int32_t branchOffset;
76     };
77
78     typedef HashMap<RefPtr<StringImpl>, OffsetLocation> StringOffsetTable;
79     StringOffsetTable offsetTable;
80
81     inline int32_t offsetForValue(StringImpl* value, int32_t defaultOffset)
82     {
83         StringOffsetTable::const_iterator end = offsetTable.end();
84         StringOffsetTable::const_iterator loc = offsetTable.find(value);
85         if (loc == end)
86             return defaultOffset;
87         return loc->value.branchOffset;
88     }
89
90 };
91
92 struct UnlinkedSimpleJumpTable {
93     Vector<int32_t> branchOffsets;
94     int32_t min;
95
96     int32_t offsetForValue(int32_t value, int32_t defaultOffset);
97     void add(int32_t key, int32_t offset)
98     {
99         if (!branchOffsets[key])
100             branchOffsets[key] = offset;
101     }
102 };
103
104 struct UnlinkedInstruction {
105     UnlinkedInstruction() { u.operand = 0; }
106     UnlinkedInstruction(OpcodeID opcode) { u.opcode = opcode; }
107     UnlinkedInstruction(int operand) { u.operand = operand; }
108     union {
109         OpcodeID opcode;
110         int32_t operand;
111         unsigned unsignedValue;
112     } u;
113 };
114
115 class UnlinkedCodeBlock : public JSCell {
116 public:
117     typedef JSCell Base;
118     static const unsigned StructureFlags = Base::StructureFlags;
119
120     static const bool needsDestruction = true;
121
122     enum { CallFunction, ApplyFunction };
123
124     typedef UnlinkedInstruction Instruction;
125     typedef Vector<UnlinkedInstruction, 0, UnsafeVectorOverflow> UnpackedInstructions;
126
127     bool isConstructor() const { return m_isConstructor; }
128     bool isStrictMode() const { return m_isStrictMode; }
129     bool usesEval() const { return m_usesEval; }
130     SourceParseMode parseMode() const { return m_parseMode; }
131     bool isArrowFunction() const { return isArrowFunctionParseMode(parseMode()); }
132     DerivedContextType derivedContextType() const { return static_cast<DerivedContextType>(m_derivedContextType); }
133     EvalContextType evalContextType() const { return static_cast<EvalContextType>(m_evalContextType); }
134     bool isArrowFunctionContext() const { return m_isArrowFunctionContext; }
135     bool isClassContext() const { return m_isClassContext; }
136
137     void addExpressionInfo(unsigned instructionOffset, int divot,
138         int startOffset, int endOffset, unsigned line, unsigned column);
139
140     void addTypeProfilerExpressionInfo(unsigned instructionOffset, unsigned startDivot, unsigned endDivot);
141
142     bool hasExpressionInfo() { return m_expressionInfo.size(); }
143     const Vector<ExpressionRangeInfo>& expressionInfo() { return m_expressionInfo; }
144
145     // Special registers
146     void setThisRegister(VirtualRegister thisRegister) { m_thisRegister = thisRegister; }
147     void setScopeRegister(VirtualRegister scopeRegister) { m_scopeRegister = scopeRegister; }
148
149     bool usesGlobalObject() const { return m_globalObjectRegister.isValid(); }
150     void setGlobalObjectRegister(VirtualRegister globalObjectRegister) { m_globalObjectRegister = globalObjectRegister; }
151     VirtualRegister globalObjectRegister() const { return m_globalObjectRegister; }
152
153     // Parameter information
154     void setNumParameters(int newValue) { m_numParameters = newValue; }
155     void addParameter() { m_numParameters++; }
156     unsigned numParameters() const { return m_numParameters; }
157
158     unsigned addRegExp(RegExp* r)
159     {
160         createRareDataIfNecessary();
161         VM& vm = *this->vm();
162         auto locker = lockDuringMarking(vm.heap, *this);
163         unsigned size = m_rareData->m_regexps.size();
164         m_rareData->m_regexps.append(WriteBarrier<RegExp>(vm, this, r));
165         return size;
166     }
167     unsigned numberOfRegExps() const
168     {
169         if (!m_rareData)
170             return 0;
171         return m_rareData->m_regexps.size();
172     }
173     RegExp* regexp(int index) const { ASSERT(m_rareData); return m_rareData->m_regexps[index].get(); }
174
175     // Constant Pools
176
177     size_t numberOfIdentifiers() const { return m_identifiers.size(); }
178     void addIdentifier(const Identifier& i) { return m_identifiers.append(i); }
179     const Identifier& identifier(int index) const { return m_identifiers[index]; }
180     const Vector<Identifier>& identifiers() const { return m_identifiers; }
181
182     const Vector<BitVector>& bitVectors() const { return m_bitVectors; }
183     BitVector& bitVector(size_t i) { return m_bitVectors[i]; }
184     unsigned addBitVector(BitVector&& bitVector)
185     {
186         m_bitVectors.append(WTFMove(bitVector));
187         return m_bitVectors.size() - 1;
188     }
189     
190     void addSetConstant(IdentifierSet& set)
191     {
192         VM& vm = *this->vm();
193         auto locker = lockDuringMarking(vm.heap, *this);
194         unsigned result = m_constantRegisters.size();
195         m_constantRegisters.append(WriteBarrier<Unknown>());
196         m_constantsSourceCodeRepresentation.append(SourceCodeRepresentation::Other);
197         m_constantIdentifierSets.append(ConstantIndentifierSetEntry(set, result));
198     }
199
200     unsigned addConstant(JSValue v, SourceCodeRepresentation sourceCodeRepresentation = SourceCodeRepresentation::Other)
201     {
202         VM& vm = *this->vm();
203         auto locker = lockDuringMarking(vm.heap, *this);
204         unsigned result = m_constantRegisters.size();
205         m_constantRegisters.append(WriteBarrier<Unknown>());
206         m_constantRegisters.last().set(vm, this, v);
207         m_constantsSourceCodeRepresentation.append(sourceCodeRepresentation);
208         return result;
209     }
210     unsigned addConstant(LinkTimeConstant type)
211     {
212         VM& vm = *this->vm();
213         auto locker = lockDuringMarking(vm.heap, *this);
214         unsigned result = m_constantRegisters.size();
215         ASSERT(result);
216         unsigned index = static_cast<unsigned>(type);
217         ASSERT(index < LinkTimeConstantCount);
218         m_linkTimeConstants[index] = result;
219         m_constantRegisters.append(WriteBarrier<Unknown>());
220         m_constantsSourceCodeRepresentation.append(SourceCodeRepresentation::Other);
221         return result;
222     }
223     unsigned registerIndexForLinkTimeConstant(LinkTimeConstant type)
224     {
225         unsigned index = static_cast<unsigned>(type);
226         ASSERT(index < LinkTimeConstantCount);
227         return m_linkTimeConstants[index];
228     }
229     const Vector<WriteBarrier<Unknown>>& constantRegisters() { return m_constantRegisters; }
230     const Vector<ConstantIndentifierSetEntry>& constantIdentifierSets() { return m_constantIdentifierSets; }
231     const WriteBarrier<Unknown>& constantRegister(int index) const { return m_constantRegisters[index - FirstConstantRegisterIndex]; }
232     ALWAYS_INLINE bool isConstantRegisterIndex(int index) const { return index >= FirstConstantRegisterIndex; }
233     ALWAYS_INLINE JSValue getConstant(int index) const { return m_constantRegisters[index - FirstConstantRegisterIndex].get(); }
234     const Vector<SourceCodeRepresentation>& constantsSourceCodeRepresentation() { return m_constantsSourceCodeRepresentation; }
235
236     // Jumps
237     size_t numberOfJumpTargets() const { return m_jumpTargets.size(); }
238     void addJumpTarget(unsigned jumpTarget) { m_jumpTargets.append(jumpTarget); }
239     unsigned jumpTarget(int index) const { return m_jumpTargets[index]; }
240     unsigned lastJumpTarget() const { return m_jumpTargets.last(); }
241
242     UnlinkedHandlerInfo* handlerForBytecodeOffset(unsigned bytecodeOffset, RequiredHandler = RequiredHandler::AnyHandler);
243     UnlinkedHandlerInfo* handlerForIndex(unsigned, RequiredHandler = RequiredHandler::AnyHandler);
244
245     bool isBuiltinFunction() const { return m_isBuiltinFunction; }
246
247     ConstructorKind constructorKind() const { return static_cast<ConstructorKind>(m_constructorKind); }
248     SuperBinding superBinding() const { return static_cast<SuperBinding>(m_superBinding); }
249     JSParserScriptMode scriptMode() const { return static_cast<JSParserScriptMode>(m_scriptMode); }
250
251     void shrinkToFit();
252
253     void setInstructions(std::unique_ptr<UnlinkedInstructionStream>);
254     const UnlinkedInstructionStream& instructions() const;
255
256     int numCalleeLocals() const { return m_numCalleeLocals; }
257
258     int m_numVars;
259     int m_numCapturedVars;
260     int m_numCalleeLocals;
261
262     // Jump Tables
263
264     size_t numberOfSwitchJumpTables() const { return m_rareData ? m_rareData->m_switchJumpTables.size() : 0; }
265     UnlinkedSimpleJumpTable& addSwitchJumpTable() { createRareDataIfNecessary(); m_rareData->m_switchJumpTables.append(UnlinkedSimpleJumpTable()); return m_rareData->m_switchJumpTables.last(); }
266     UnlinkedSimpleJumpTable& switchJumpTable(int tableIndex) { ASSERT(m_rareData); return m_rareData->m_switchJumpTables[tableIndex]; }
267
268     size_t numberOfStringSwitchJumpTables() const { return m_rareData ? m_rareData->m_stringSwitchJumpTables.size() : 0; }
269     UnlinkedStringJumpTable& addStringSwitchJumpTable() { createRareDataIfNecessary(); m_rareData->m_stringSwitchJumpTables.append(UnlinkedStringJumpTable()); return m_rareData->m_stringSwitchJumpTables.last(); }
270     UnlinkedStringJumpTable& stringSwitchJumpTable(int tableIndex) { ASSERT(m_rareData); return m_rareData->m_stringSwitchJumpTables[tableIndex]; }
271
272     unsigned addFunctionDecl(UnlinkedFunctionExecutable* n)
273     {
274         VM& vm = *this->vm();
275         auto locker = lockDuringMarking(vm.heap, *this);
276         unsigned size = m_functionDecls.size();
277         m_functionDecls.append(WriteBarrier<UnlinkedFunctionExecutable>());
278         m_functionDecls.last().set(vm, this, n);
279         return size;
280     }
281     UnlinkedFunctionExecutable* functionDecl(int index) { return m_functionDecls[index].get(); }
282     size_t numberOfFunctionDecls() { return m_functionDecls.size(); }
283     unsigned addFunctionExpr(UnlinkedFunctionExecutable* n)
284     {
285         VM& vm = *this->vm();
286         auto locker = lockDuringMarking(vm.heap, *this);
287         unsigned size = m_functionExprs.size();
288         m_functionExprs.append(WriteBarrier<UnlinkedFunctionExecutable>());
289         m_functionExprs.last().set(vm, this, n);
290         return size;
291     }
292     UnlinkedFunctionExecutable* functionExpr(int index) { return m_functionExprs[index].get(); }
293     size_t numberOfFunctionExprs() { return m_functionExprs.size(); }
294
295     // Exception handling support
296     size_t numberOfExceptionHandlers() const { return m_rareData ? m_rareData->m_exceptionHandlers.size() : 0; }
297     void addExceptionHandler(const UnlinkedHandlerInfo& handler) { createRareDataIfNecessary(); return m_rareData->m_exceptionHandlers.append(handler); }
298     UnlinkedHandlerInfo& exceptionHandler(int index) { ASSERT(m_rareData); return m_rareData->m_exceptionHandlers[index]; }
299
300     UnlinkedArrayProfile addArrayProfile() { return m_arrayProfileCount++; }
301     unsigned numberOfArrayProfiles() { return m_arrayProfileCount; }
302     UnlinkedArrayAllocationProfile addArrayAllocationProfile() { return m_arrayAllocationProfileCount++; }
303     unsigned numberOfArrayAllocationProfiles() { return m_arrayAllocationProfileCount; }
304     UnlinkedObjectAllocationProfile addObjectAllocationProfile() { return m_objectAllocationProfileCount++; }
305     unsigned numberOfObjectAllocationProfiles() { return m_objectAllocationProfileCount; }
306     UnlinkedValueProfile addValueProfile() { return m_valueProfileCount++; }
307     unsigned numberOfValueProfiles() { return m_valueProfileCount; }
308
309     UnlinkedLLIntCallLinkInfo addLLIntCallLinkInfo() { return m_llintCallLinkInfoCount++; }
310     unsigned numberOfLLintCallLinkInfos() { return m_llintCallLinkInfoCount; }
311
312     CodeType codeType() const { return m_codeType; }
313
314     VirtualRegister thisRegister() const { return m_thisRegister; }
315     VirtualRegister scopeRegister() const { return m_scopeRegister; }
316
317     void addPropertyAccessInstruction(unsigned propertyAccessInstruction)
318     {
319         m_propertyAccessInstructions.append(propertyAccessInstruction);
320     }
321
322     size_t numberOfPropertyAccessInstructions() const { return m_propertyAccessInstructions.size(); }
323     const Vector<unsigned>& propertyAccessInstructions() const { return m_propertyAccessInstructions; }
324
325     typedef Vector<JSValue> ConstantBuffer;
326
327     size_t constantBufferCount() { ASSERT(m_rareData); return m_rareData->m_constantBuffers.size(); }
328     unsigned addConstantBuffer(unsigned length)
329     {
330         createRareDataIfNecessary();
331         unsigned size = m_rareData->m_constantBuffers.size();
332         m_rareData->m_constantBuffers.append(Vector<JSValue>(length));
333         return size;
334     }
335
336     const ConstantBuffer& constantBuffer(unsigned index) const
337     {
338         ASSERT(m_rareData);
339         return m_rareData->m_constantBuffers[index];
340     }
341
342     ConstantBuffer& constantBuffer(unsigned index)
343     {
344         ASSERT(m_rareData);
345         return m_rareData->m_constantBuffers[index];
346     }
347
348     bool hasRareData() const { return m_rareData.get(); }
349
350     int lineNumberForBytecodeOffset(unsigned bytecodeOffset);
351
352     void expressionRangeForBytecodeOffset(unsigned bytecodeOffset, int& divot,
353         int& startOffset, int& endOffset, unsigned& line, unsigned& column) const;
354
355     bool typeProfilerExpressionInfoForBytecodeOffset(unsigned bytecodeOffset, unsigned& startDivot, unsigned& endDivot);
356
357     void recordParse(CodeFeatures features, bool hasCapturedVariables, unsigned lineCount, unsigned endColumn)
358     {
359         m_features = features;
360         m_hasCapturedVariables = hasCapturedVariables;
361         m_lineCount = lineCount;
362         // For the UnlinkedCodeBlock, startColumn is always 0.
363         m_endColumn = endColumn;
364     }
365
366     const String& sourceURLDirective() const { return m_sourceURLDirective; }
367     const String& sourceMappingURLDirective() const { return m_sourceMappingURLDirective; }
368     void setSourceURLDirective(const String& sourceURL) { m_sourceURLDirective = sourceURL; }
369     void setSourceMappingURLDirective(const String& sourceMappingURL) { m_sourceMappingURLDirective = sourceMappingURL; }
370
371     CodeFeatures codeFeatures() const { return m_features; }
372     bool hasCapturedVariables() const { return m_hasCapturedVariables; }
373     unsigned lineCount() const { return m_lineCount; }
374     ALWAYS_INLINE unsigned startColumn() const { return 0; }
375     unsigned endColumn() const { return m_endColumn; }
376
377     void addOpProfileControlFlowBytecodeOffset(size_t offset)
378     {
379         createRareDataIfNecessary();
380         m_rareData->m_opProfileControlFlowBytecodeOffsets.append(offset);
381     }
382     const Vector<size_t>& opProfileControlFlowBytecodeOffsets() const
383     {
384         ASSERT(m_rareData);
385         return m_rareData->m_opProfileControlFlowBytecodeOffsets;
386     }
387     bool hasOpProfileControlFlowBytecodeOffsets() const
388     {
389         return m_rareData && !m_rareData->m_opProfileControlFlowBytecodeOffsets.isEmpty();
390     }
391
392     void dumpExpressionRangeInfo(); // For debugging purpose only.
393
394     bool wasCompiledWithDebuggingOpcodes() const { return m_wasCompiledWithDebuggingOpcodes; }
395
396     TriState didOptimize() const { return m_didOptimize; }
397     void setDidOptimize(TriState didOptimize) { m_didOptimize = didOptimize; }
398
399     void dump(PrintStream&) const;
400
401 protected:
402     UnlinkedCodeBlock(VM*, Structure*, CodeType, const ExecutableInfo&, DebuggerMode);
403     ~UnlinkedCodeBlock();
404
405     void finishCreation(VM& vm)
406     {
407         Base::finishCreation(vm);
408     }
409
410 private:
411     friend class BytecodeRewriter;
412     void applyModification(BytecodeRewriter&);
413
414     void createRareDataIfNecessary()
415     {
416         if (!m_rareData) {
417             auto locker = lockDuringMarking(*heap(), *this);
418             m_rareData = std::make_unique<RareData>();
419         }
420     }
421
422     void getLineAndColumn(const ExpressionRangeInfo&, unsigned& line, unsigned& column) const;
423
424     int m_numParameters;
425
426     std::unique_ptr<UnlinkedInstructionStream> m_unlinkedInstructions;
427
428     VirtualRegister m_thisRegister;
429     VirtualRegister m_scopeRegister;
430     VirtualRegister m_globalObjectRegister;
431
432     String m_sourceURLDirective;
433     String m_sourceMappingURLDirective;
434
435     unsigned m_usesEval : 1;
436     unsigned m_isStrictMode : 1;
437     unsigned m_isConstructor : 1;
438     unsigned m_hasCapturedVariables : 1;
439     unsigned m_isBuiltinFunction : 1;
440     unsigned m_superBinding : 1;
441     unsigned m_scriptMode: 1;
442     unsigned m_isArrowFunctionContext : 1;
443     unsigned m_isClassContext : 1;
444     unsigned m_wasCompiledWithDebuggingOpcodes : 1;
445     unsigned m_constructorKind : 2;
446     unsigned m_derivedContextType : 2;
447     unsigned m_evalContextType : 2;
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 }