8b2453bfe6bb51a1a862fdd16a129b8561569329
[WebKit-https.git] / Source / JavaScriptCore / bytecode / BytecodeDumper.h
1 /*
2  * Copyright (C) 2017 Yusuke Suzuki <utatane.tea@gmail.com>
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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "CallLinkInfo.h"
29 #include "StructureStubInfo.h"
30 #include <wtf/StringPrintStream.h>
31
32 namespace JSC {
33
34 struct Instruction;
35
36 template<class Block>
37 class BytecodeDumper {
38 public:
39     typedef typename Block::Instruction Instruction;
40
41     static void dumpBytecode(Block*, PrintStream& out, const Instruction* begin, const Instruction*& it, const StubInfoMap& = StubInfoMap(), const CallLinkInfoMap& = CallLinkInfoMap());
42     static void dumpBlock(Block*, const typename Block::UnpackedInstructions&, PrintStream& out, const StubInfoMap& = StubInfoMap(), const CallLinkInfoMap& = CallLinkInfoMap());
43
44 private:
45     BytecodeDumper(Block* block, const Instruction* instructionsBegin)
46         : m_block(block)
47         , m_instructionsBegin(instructionsBegin)
48     {
49     }
50
51     Block* block() const { return m_block; }
52     const Instruction* instructionsBegin() const { return m_instructionsBegin; }
53
54     ALWAYS_INLINE VM* vm() const;
55
56     CString registerName(int r) const;
57     CString constantName(int index) const;
58
59     const Identifier& identifier(int index) const;
60
61     void dumpIdentifiers(PrintStream& out);
62     void dumpConstants(PrintStream& out);
63     void dumpRegExps(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 printGetByIdOp(PrintStream& out, int location, const Instruction*& it);
72     void printGetByIdCacheStatus(PrintStream& out, int location, const StubInfoMap&);
73     void printPutByIdCacheStatus(PrintStream& out, int location, const StubInfoMap&);
74     enum CacheDumpMode { DumpCaches, DontDumpCaches };
75     void printCallOp(PrintStream& out, int location, const Instruction*& it, const char* op, CacheDumpMode, bool& hasPrintedProfiling, const CallLinkInfoMap&);
76     void printPutByIdOp(PrintStream& out, int location, const Instruction*& it, const char* op);
77     void printLocationOpAndRegisterOperand(PrintStream& out, int location, const Instruction*& it, const char* op, int operand);
78     void dumpBytecode(PrintStream& out, const Instruction* begin, const Instruction*& it, const StubInfoMap&, const CallLinkInfoMap&);
79
80     void dumpValueProfiling(PrintStream&, const Instruction*&, bool& hasPrintedProfiling);
81     void dumpArrayProfiling(PrintStream&, const Instruction*&, bool& hasPrintedProfiling);
82     void dumpProfilesForBytecodeOffset(PrintStream&, unsigned location, bool& hasPrintedProfiling);
83
84     void* actualPointerFor(Special::Pointer) const;
85
86 #if ENABLE(JIT)
87     void dumpCallLinkStatus(PrintStream&, unsigned location, const CallLinkInfoMap&);
88 #endif
89
90     Block* m_block;
91     const Instruction* m_instructionsBegin;
92 };
93
94 }