1/*
2 * Copyright (C) 2012, 2013 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#include "config.h"
27#include "JITDisassembler.h"
28
29#if ENABLE(JIT)
30
31#include "CodeBlock.h"
32#include "CodeBlockWithJITType.h"
33#include "JIT.h"
34#include "JSCInlines.h"
35#include "LinkBuffer.h"
36#include <wtf/StringPrintStream.h>
37
38namespace JSC {
39
40JITDisassembler::JITDisassembler(CodeBlock *codeBlock)
41    : m_codeBlock(codeBlock)
42    , m_labelForBytecodeIndexInMainPath(codeBlock->instructionCount())
43    , m_labelForBytecodeIndexInSlowPath(codeBlock->instructionCount())
44{
45}
46
47JITDisassembler::~JITDisassembler()
48{
49}
50
51void JITDisassembler::dump(PrintStream& out, LinkBuffer& linkBuffer)
52{
53    dumpHeader(out, linkBuffer);
54    dumpDisassembly(out, linkBuffer, m_startOfCode, m_labelForBytecodeIndexInMainPath[0]);
55
56    dumpForInstructions(out, linkBuffer, "    ", m_labelForBytecodeIndexInMainPath, firstSlowLabel());
57    out.print("    (End Of Main Path)\n");
58    dumpForInstructions(out, linkBuffer, "    (S) ", m_labelForBytecodeIndexInSlowPath, m_endOfSlowPath);
59    out.print("    (End Of Slow Path)\n");
60
61    dumpDisassembly(out, linkBuffer, m_endOfSlowPath, m_endOfCode);
62}
63
64void JITDisassembler::dump(LinkBuffer& linkBuffer)
65{
66    dump(WTF::dataFile(), linkBuffer);
67}
68
69void JITDisassembler::reportToProfiler(Profiler::Compilation* compilation, LinkBuffer& linkBuffer)
70{
71    StringPrintStream out;
72
73    dumpHeader(out, linkBuffer);
74    compilation->addDescription(Profiler::CompiledBytecode(Profiler::OriginStack(), out.toCString()));
75    out.reset();
76    dumpDisassembly(out, linkBuffer, m_startOfCode, m_labelForBytecodeIndexInMainPath[0]);
77    compilation->addDescription(Profiler::CompiledBytecode(Profiler::OriginStack(), out.toCString()));
78
79    reportInstructions(compilation, linkBuffer, "    ", m_labelForBytecodeIndexInMainPath, firstSlowLabel());
80    compilation->addDescription(Profiler::CompiledBytecode(Profiler::OriginStack(), "    (End Of Main Path)\n"));
81    reportInstructions(compilation, linkBuffer, "    (S) ", m_labelForBytecodeIndexInSlowPath, m_endOfSlowPath);
82    compilation->addDescription(Profiler::CompiledBytecode(Profiler::OriginStack(), "    (End Of Slow Path)\n"));
83    out.reset();
84    dumpDisassembly(out, linkBuffer, m_endOfSlowPath, m_endOfCode);
85    compilation->addDescription(Profiler::CompiledBytecode(Profiler::OriginStack(), out.toCString()));
86}
87
88void JITDisassembler::dumpHeader(PrintStream& out, LinkBuffer& linkBuffer)
89{
90    out.print("Generated Baseline JIT code for ", CodeBlockWithJITType(m_codeBlock, JITCode::BaselineJIT), ", instruction count = ", m_codeBlock->instructionCount(), "\n");
91    out.print("   Source: ", m_codeBlock->sourceCodeOnOneLine(), "\n");
92    out.print("   Code at [", RawPointer(linkBuffer.debugAddress()), ", ", RawPointer(static_cast<char*>(linkBuffer.debugAddress()) + linkBuffer.size()), "):\n");
93}
94
95MacroAssembler::Label JITDisassembler::firstSlowLabel()
96{
97    MacroAssembler::Label firstSlowLabel;
98    for (unsigned i = 0; i < m_labelForBytecodeIndexInSlowPath.size(); ++i) {
99        if (m_labelForBytecodeIndexInSlowPath[i].isSet()) {
100            firstSlowLabel = m_labelForBytecodeIndexInSlowPath[i];
101            break;
102        }
103    }
104    return firstSlowLabel.isSet() ? firstSlowLabel : m_endOfSlowPath;
105}
106
107Vector<JITDisassembler::DumpedOp> JITDisassembler::dumpVectorForInstructions(LinkBuffer& linkBuffer, const char* prefix, Vector<MacroAssembler::Label>& labels, MacroAssembler::Label endLabel)
108{
109    StringPrintStream out;
110    Vector<DumpedOp> result;
111
112    for (unsigned i = 0; i < labels.size();) {
113        if (!labels[i].isSet()) {
114            i++;
115            continue;
116        }
117        out.reset();
118        result.append(DumpedOp());
119        result.last().index = i;
120        out.print(prefix);
121        m_codeBlock->dumpBytecode(out, i);
122        for (unsigned nextIndex = i + 1; ; nextIndex++) {
123            if (nextIndex >= labels.size()) {
124                dumpDisassembly(out, linkBuffer, labels[i], endLabel);
125                result.last().disassembly = out.toCString();
126                return result;
127            }
128            if (labels[nextIndex].isSet()) {
129                dumpDisassembly(out, linkBuffer, labels[i], labels[nextIndex]);
130                result.last().disassembly = out.toCString();
131                i = nextIndex;
132                break;
133            }
134        }
135    }
136
137    return result;
138}
139
140void JITDisassembler::dumpForInstructions(PrintStream& out, LinkBuffer& linkBuffer, const char* prefix, Vector<MacroAssembler::Label>& labels, MacroAssembler::Label endLabel)
141{
142    Vector<DumpedOp> dumpedOps = dumpVectorForInstructions(linkBuffer, prefix, labels, endLabel);
143
144    for (unsigned i = 0; i < dumpedOps.size(); ++i)
145        out.print(dumpedOps[i].disassembly);
146}
147
148void JITDisassembler::reportInstructions(Profiler::Compilation* compilation, LinkBuffer& linkBuffer, const char* prefix, Vector<MacroAssembler::Label>& labels, MacroAssembler::Label endLabel)
149{
150    Vector<DumpedOp> dumpedOps = dumpVectorForInstructions(linkBuffer, prefix, labels, endLabel);
151
152    for (unsigned i = 0; i < dumpedOps.size(); ++i) {
153        compilation->addDescription(
154            Profiler::CompiledBytecode(
155                Profiler::OriginStack(Profiler::Origin(compilation->bytecodes(), dumpedOps[i].index)),
156                dumpedOps[i].disassembly));
157    }
158}
159
160void JITDisassembler::dumpDisassembly(PrintStream& out, LinkBuffer& linkBuffer, MacroAssembler::Label from, MacroAssembler::Label to)
161{
162    CodeLocationLabel fromLocation = linkBuffer.locationOf(from);
163    CodeLocationLabel toLocation = linkBuffer.locationOf(to);
164    disassemble(fromLocation, bitwise_cast<uintptr_t>(toLocation.executableAddress()) - bitwise_cast<uintptr_t>(fromLocation.executableAddress()), "        ", out);
165}
166
167} // namespace JSC
168
169#endif // ENABLE(JIT)
170
171