Make the MASM_PROBE mechanism mandatory for DFG and FTL builds.
[WebKit-https.git] / Source / JavaScriptCore / assembler / MacroAssemblerPrinter.cpp
1 /*
2  * Copyright (C) 2015-2017 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 "MacroAssemblerPrinter.h"
28
29 #include "MacroAssembler.h"
30 #include <inttypes.h>
31
32 namespace JSC {
33 namespace Printer {
34
35 using CPUState = MacroAssembler::CPUState;
36 using RegisterID = MacroAssembler::RegisterID;
37 using FPRegisterID = MacroAssembler::FPRegisterID;
38
39 template<typename T> T nextID(T id) { return static_cast<T>(id + 1); }
40
41 void printAllRegisters(PrintStream& out, Context& context)
42 {
43     auto& cpu = context.probeContext.cpu;
44     unsigned charsToIndent = context.data.as<unsigned>();
45
46     auto indent = [&] () {
47         for (unsigned i = 0; i < charsToIndent; ++i)
48             out.print(" ");
49     };
50 #define INDENT indent()
51
52     INDENT, out.print("cpu: {\n");
53
54 #if USE(JSVALUE32_64)
55     #define INTPTR_HEX_VALUE_FORMAT "0x%08" PRIxPTR
56 #else
57     #define INTPTR_HEX_VALUE_FORMAT "0x%016" PRIxPTR
58 #endif
59
60     for (auto id = MacroAssembler::firstRegister(); id <= MacroAssembler::lastRegister(); id = nextID(id)) {
61         intptr_t value = static_cast<intptr_t>(cpu.gpr(id));
62         INDENT, out.printf("    %6s: " INTPTR_HEX_VALUE_FORMAT "  %" PRIdPTR "\n", cpu.gprName(id), value, value);
63     }
64     for (auto id = MacroAssembler::firstSPRegister(); id <= MacroAssembler::lastSPRegister(); id = nextID(id)) {
65         intptr_t value = static_cast<intptr_t>(cpu.spr(id));
66         INDENT, out.printf("    %6s: " INTPTR_HEX_VALUE_FORMAT "  %" PRIdPTR "\n", cpu.sprName(id), value, value);
67     }
68     #undef INTPTR_HEX_VALUE_FORMAT
69
70     for (auto id = MacroAssembler::firstFPRegister(); id <= MacroAssembler::lastFPRegister(); id = nextID(id)) {
71         uint64_t u = bitwise_cast<uint64_t>(cpu.fpr(id));
72         double d = cpu.fpr(id);
73         INDENT, out.printf("    %6s: 0x%016" PRIx64 "  %.13g\n", cpu.fprName(id), u, d);
74     }
75
76     INDENT, out.print("}\n");
77 #undef INDENT
78
79 }
80
81 void printPCRegister(PrintStream& out, Context& context)
82 {
83     auto cpu = context.probeContext.cpu;
84     void* value = cpu.pc();
85     out.printf("pc:<%p %ld>", value, bitwise_cast<intptr_t>(value));
86 }
87
88 void printRegisterID(PrintStream& out, Context& context)
89 {
90     RegisterID regID = context.data.as<RegisterID>();
91     const char* name = CPUState::gprName(regID);
92     intptr_t value = context.probeContext.gpr(regID);
93     out.printf("%s:<%p %ld>", name, bitwise_cast<void*>(value), value);
94 }
95
96 void printFPRegisterID(PrintStream& out, Context& context)
97 {
98     FPRegisterID regID = context.data.as<FPRegisterID>();
99     const char* name = CPUState::fprName(regID);
100     double value = context.probeContext.fpr(regID);
101     out.printf("%s:<0x%016" PRIx64 " %.13g>", name, bitwise_cast<uint64_t>(value), value);
102 }
103
104 void printAddress(PrintStream& out, Context& context)
105 {
106     MacroAssembler::Address address = context.data.as<MacroAssembler::Address>();
107     RegisterID regID = address.base;
108     const char* name = CPUState::gprName(regID);
109     intptr_t value = context.probeContext.gpr(regID);
110     out.printf("Address{base:%s:<%p %ld>, offset:<0x%x %d>", name, bitwise_cast<void*>(value), value, address.offset, address.offset);
111 }
112
113 void printMemory(PrintStream& out, Context& context)
114 {
115     const Memory& memory = context.data.as<Memory>();
116
117     uint8_t* ptr = nullptr;
118     switch (memory.addressType) {
119     case Memory::AddressType::Address: {
120         ptr = reinterpret_cast<uint8_t*>(context.probeContext.gpr(memory.u.address.base));
121         ptr += memory.u.address.offset;
122         break;
123     }
124     case Memory::AddressType::AbsoluteAddress: {
125         ptr = reinterpret_cast<uint8_t*>(const_cast<void*>(memory.u.absoluteAddress.m_ptr));
126         break;
127     }
128     }
129
130     if (memory.dumpStyle == Memory::SingleWordDump) {
131         if (memory.numBytes == sizeof(int8_t)) {
132             auto p = reinterpret_cast<int8_t*>(ptr);
133             out.printf("%p:<0x%02x %d>", p, *p, *p);
134             return;
135         }
136         if (memory.numBytes == sizeof(int16_t)) {
137             auto p = reinterpret_cast<int16_t*>(ptr);
138             out.printf("%p:<0x%04x %d>", p, *p, *p);
139             return;
140         }
141         if (memory.numBytes == sizeof(int32_t)) {
142             auto p = reinterpret_cast<int32_t*>(ptr);
143             out.printf("%p:<0x%08x %d>", p, *p, *p);
144             return;
145         }
146         if (memory.numBytes == sizeof(int64_t)) {
147             auto p = reinterpret_cast<int64_t*>(ptr);
148             out.printf("%p:<0x%016" PRIx64 " %" PRId64 ">", p, *p, *p);
149             return;
150         }
151         // Else, unknown word size. Fall thru and dump in the generic way.
152     }
153
154     // Generic dump: dump rows of 16 bytes in 4 byte groupings.
155     size_t numBytes = memory.numBytes;
156     for (size_t i = 0; i < numBytes; i++) {
157         if (!(i % 16))
158             out.printf("%p: ", &ptr[i]);
159         else if (!(i % 4))
160             out.printf(" ");
161
162         out.printf("%02x", ptr[i]);
163
164         if (i % 16 == 15)
165             out.print("\n");
166     }
167     if (numBytes % 16 < 15)
168         out.print("\n");
169 }
170
171 void printCallback(ProbeContext* probeContext)
172 {
173     auto& out = WTF::dataFile();
174     PrintRecordList& list = *reinterpret_cast<PrintRecordList*>(probeContext->arg);
175     for (size_t i = 0; i < list.size(); i++) {
176         auto& record = list[i];
177         Context context(*probeContext, record.data);
178         record.printer(out, context);
179     }
180 }
181
182 } // namespace Printer
183 } // namespace JSC
184