We should support CreateThis in the FTL
[WebKit-https.git] / Source / JavaScriptCore / bytecode / BytecodeDumper.h
1 /*
2  * Copyright (C) 2017 Yusuke Suzuki <utatane.tea@gmail.com>
3  * Copyright (C) 2018 Apple Inc. All rights reserved.
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  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "CallLinkInfo.h"
30 #include "ICStatusMap.h"
31 #include "StructureStubInfo.h"
32
33 namespace JSC {
34
35 struct Instruction;
36
37 template<class Block>
38 class BytecodeDumper {
39 public:
40     typedef typename Block::Instruction Instruction;
41
42     static void dumpBytecode(Block*, PrintStream& out, const Instruction* begin, const Instruction*& it, const ICStatusMap& statusMap = ICStatusMap());
43     static void dumpBlock(Block*, const typename Block::UnpackedInstructions&, PrintStream& out, const ICStatusMap& statusMap = ICStatusMap());
44
45 private:
46     BytecodeDumper(Block* block, const Instruction* instructionsBegin)
47         : m_block(block)
48         , m_instructionsBegin(instructionsBegin)
49     {
50     }
51
52     Block* block() const { return m_block; }
53     const Instruction* instructionsBegin() const { return m_instructionsBegin; }
54
55     ALWAYS_INLINE VM* vm() const;
56
57     CString registerName(int r) const;
58     CString constantName(int index) const;
59
60     const Identifier& identifier(int index) const;
61
62     void dumpIdentifiers(PrintStream& out);
63     void dumpConstants(PrintStream& out);
64     void dumpExceptionHandlers(PrintStream& out);
65     void dumpSwitchJumpTables(PrintStream& out);
66     void dumpStringSwitchJumpTables(PrintStream& out);
67
68     void printUnaryOp(PrintStream& out, int location, const Instruction*& it, const char* op);
69     void printBinaryOp(PrintStream& out, int location, const Instruction*& it, const char* op);
70     void printConditionalJump(PrintStream& out, const Instruction*, const Instruction*& it, int location, const char* op);
71     void printCompareJump(PrintStream& out, const Instruction*, const Instruction*& it, int location, const char* op);
72     void printGetByIdOp(PrintStream& out, int location, const Instruction*& it);
73     void printGetByIdCacheStatus(PrintStream& out, int location, const ICStatusMap&);
74     void printPutByIdCacheStatus(PrintStream& out, int location, const ICStatusMap&);
75     void printInByIdCacheStatus(PrintStream& out, int location, const ICStatusMap&);
76     enum CacheDumpMode { DumpCaches, DontDumpCaches };
77     void printCallOp(PrintStream& out, int location, const Instruction*& it, const char* op, CacheDumpMode, bool& hasPrintedProfiling, const ICStatusMap&);
78     void printPutByIdOp(PrintStream& out, int location, const Instruction*& it, const char* op);
79     void printLocationOpAndRegisterOperand(PrintStream& out, int location, const Instruction*& it, const char* op, int operand);
80     void dumpBytecode(PrintStream& out, const Instruction* begin, const Instruction*& it, const ICStatusMap&);
81
82     void dumpValueProfiling(PrintStream&, const Instruction*&, bool& hasPrintedProfiling);
83     void dumpArrayProfiling(PrintStream&, const Instruction*&, bool& hasPrintedProfiling);
84     void dumpProfilesForBytecodeOffset(PrintStream&, unsigned location, bool& hasPrintedProfiling);
85
86     void* actualPointerFor(Special::Pointer) const;
87
88 #if ENABLE(JIT)
89     void dumpCallLinkStatus(PrintStream&, unsigned location, const ICStatusMap&);
90 #endif
91
92     Block* m_block;
93     const Instruction* m_instructionsBegin;
94 };
95
96 }