blob: 069a7a460b55e7d5f9883cd71772d71573bc6cba [file] [log] [blame]
Nicolas Geoffrayf635e632014-05-14 09:43:38 +01001/*
2 * Copyright (C) 2014 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include "graph_visualizer.h"
18
Alexandre Rameseb7b7392015-06-19 14:47:01 +010019#include <dlfcn.h>
20
21#include <cctype>
22#include <sstream>
23
Nicolas Geoffraya7062e02014-05-22 12:50:17 +010024#include "code_generator.h"
David Brazdila4b8c212015-05-07 09:59:30 +010025#include "dead_code_elimination.h"
Alexandre Rameseb7b7392015-06-19 14:47:01 +010026#include "disassembler.h"
Andreas Gampe7c3952f2015-02-19 18:21:24 -080027#include "licm.h"
Nicolas Geoffrayf635e632014-05-14 09:43:38 +010028#include "nodes.h"
Nicolas Geoffray82091da2015-01-26 10:02:45 +000029#include "optimization.h"
Nicolas Geoffray7cb499b2015-06-17 11:35:11 +010030#include "reference_type_propagation.h"
Andreas Gampe7c3952f2015-02-19 18:21:24 -080031#include "register_allocator.h"
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +010032#include "ssa_liveness_analysis.h"
Alexandre Rameseb7b7392015-06-19 14:47:01 +010033#include "utils/assembler.h"
David Brazdilc74652862015-05-13 17:50:09 +010034
Nicolas Geoffrayf635e632014-05-14 09:43:38 +010035namespace art {
36
David Brazdilc74652862015-05-13 17:50:09 +010037static bool HasWhitespace(const char* str) {
38 DCHECK(str != nullptr);
39 while (str[0] != 0) {
40 if (isspace(str[0])) {
41 return true;
42 }
43 str++;
44 }
45 return false;
46}
47
48class StringList {
49 public:
David Brazdilc7a24852015-05-15 16:44:05 +010050 enum Format {
51 kArrayBrackets,
52 kSetBrackets,
53 };
54
David Brazdilc74652862015-05-13 17:50:09 +010055 // Create an empty list
David Brazdilf1a9ff72015-05-18 16:04:53 +010056 explicit StringList(Format format = kArrayBrackets) : format_(format), is_empty_(true) {}
David Brazdilc74652862015-05-13 17:50:09 +010057
58 // Construct StringList from a linked list. List element class T
59 // must provide methods `GetNext` and `Dump`.
60 template<class T>
David Brazdilc7a24852015-05-15 16:44:05 +010061 explicit StringList(T* first_entry, Format format = kArrayBrackets) : StringList(format) {
David Brazdilc74652862015-05-13 17:50:09 +010062 for (T* current = first_entry; current != nullptr; current = current->GetNext()) {
63 current->Dump(NewEntryStream());
64 }
65 }
66
67 std::ostream& NewEntryStream() {
68 if (is_empty_) {
69 is_empty_ = false;
70 } else {
David Brazdilc57397b2015-05-15 16:01:59 +010071 sstream_ << ",";
David Brazdilc74652862015-05-13 17:50:09 +010072 }
73 return sstream_;
74 }
75
76 private:
David Brazdilc7a24852015-05-15 16:44:05 +010077 Format format_;
David Brazdilc74652862015-05-13 17:50:09 +010078 bool is_empty_;
79 std::ostringstream sstream_;
80
81 friend std::ostream& operator<<(std::ostream& os, const StringList& list);
82};
83
84std::ostream& operator<<(std::ostream& os, const StringList& list) {
David Brazdilc7a24852015-05-15 16:44:05 +010085 switch (list.format_) {
86 case StringList::kArrayBrackets: return os << "[" << list.sstream_.str() << "]";
87 case StringList::kSetBrackets: return os << "{" << list.sstream_.str() << "}";
88 default:
89 LOG(FATAL) << "Invalid StringList format";
90 UNREACHABLE();
91 }
David Brazdilc74652862015-05-13 17:50:09 +010092}
93
Alexandre Rameseb7b7392015-06-19 14:47:01 +010094typedef Disassembler* create_disasm_prototype(InstructionSet instruction_set,
95 DisassemblerOptions* options);
96class HGraphVisualizerDisassembler {
97 public:
98 HGraphVisualizerDisassembler(InstructionSet instruction_set, const uint8_t* base_address)
David Brazdil3a690be2015-06-23 10:22:38 +010099 : instruction_set_(instruction_set), disassembler_(nullptr) {
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100100 libart_disassembler_handle_ =
101 dlopen(kIsDebugBuild ? "libartd-disassembler.so" : "libart-disassembler.so", RTLD_NOW);
102 if (libart_disassembler_handle_ == nullptr) {
103 LOG(WARNING) << "Failed to dlopen libart-disassembler: " << dlerror();
104 return;
105 }
106 create_disasm_prototype* create_disassembler = reinterpret_cast<create_disasm_prototype*>(
107 dlsym(libart_disassembler_handle_, "create_disassembler"));
108 if (create_disassembler == nullptr) {
109 LOG(WARNING) << "Could not find create_disassembler entry: " << dlerror();
110 return;
111 }
112 // Reading the disassembly from 0x0 is easier, so we print relative
113 // addresses. We will only disassemble the code once everything has
114 // been generated, so we can read data in literal pools.
115 disassembler_ = std::unique_ptr<Disassembler>((*create_disassembler)(
116 instruction_set,
117 new DisassemblerOptions(/* absolute_addresses */ false,
118 base_address,
119 /* can_read_literals */ true)));
120 }
121
122 ~HGraphVisualizerDisassembler() {
123 // We need to call ~Disassembler() before we close the library.
124 disassembler_.reset();
125 if (libart_disassembler_handle_ != nullptr) {
126 dlclose(libart_disassembler_handle_);
127 }
128 }
129
130 void Disassemble(std::ostream& output, size_t start, size_t end) const {
David Brazdil3a690be2015-06-23 10:22:38 +0100131 if (disassembler_ == nullptr) {
132 return;
133 }
134
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100135 const uint8_t* base = disassembler_->GetDisassemblerOptions()->base_address_;
136 if (instruction_set_ == kThumb2) {
137 // ARM and Thumb-2 use the same disassembler. The bottom bit of the
138 // address is used to distinguish between the two.
139 base += 1;
140 }
141 disassembler_->Dump(output, base + start, base + end);
142 }
143
144 private:
145 InstructionSet instruction_set_;
146 std::unique_ptr<Disassembler> disassembler_;
147
148 void* libart_disassembler_handle_;
149};
150
151
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100152/**
153 * HGraph visitor to generate a file suitable for the c1visualizer tool and IRHydra.
154 */
Nicolas Geoffray842acd42015-07-01 13:00:15 +0100155class HGraphVisualizerPrinter : public HGraphDelegateVisitor {
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100156 public:
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100157 HGraphVisualizerPrinter(HGraph* graph,
158 std::ostream& output,
159 const char* pass_name,
Nicolas Geoffray840e5462015-01-07 16:01:24 +0000160 bool is_after_pass,
David Brazdilffee3d32015-07-06 11:48:53 +0100161 bool graph_in_bad_state,
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100162 const CodeGenerator& codegen,
163 const DisassemblyInformation* disasm_info = nullptr)
Nicolas Geoffray842acd42015-07-01 13:00:15 +0100164 : HGraphDelegateVisitor(graph),
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100165 output_(output),
166 pass_name_(pass_name),
Nicolas Geoffray840e5462015-01-07 16:01:24 +0000167 is_after_pass_(is_after_pass),
David Brazdilffee3d32015-07-06 11:48:53 +0100168 graph_in_bad_state_(graph_in_bad_state),
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100169 codegen_(codegen),
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100170 disasm_info_(disasm_info),
171 disassembler_(disasm_info_ != nullptr
172 ? new HGraphVisualizerDisassembler(
173 codegen_.GetInstructionSet(),
174 codegen_.GetAssembler().CodeBufferBaseAddress())
175 : nullptr),
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100176 indent_(0) {}
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100177
178 void StartTag(const char* name) {
179 AddIndent();
180 output_ << "begin_" << name << std::endl;
181 indent_++;
182 }
183
184 void EndTag(const char* name) {
185 indent_--;
186 AddIndent();
187 output_ << "end_" << name << std::endl;
188 }
189
190 void PrintProperty(const char* name, const char* property) {
191 AddIndent();
192 output_ << name << " \"" << property << "\"" << std::endl;
193 }
194
195 void PrintProperty(const char* name, const char* property, int id) {
196 AddIndent();
197 output_ << name << " \"" << property << id << "\"" << std::endl;
198 }
199
200 void PrintEmptyProperty(const char* name) {
201 AddIndent();
202 output_ << name << std::endl;
203 }
204
205 void PrintTime(const char* name) {
206 AddIndent();
Jean Christophe Beyler0ada95d2014-12-04 11:20:20 -0800207 output_ << name << " " << time(nullptr) << std::endl;
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100208 }
209
210 void PrintInt(const char* name, int value) {
211 AddIndent();
212 output_ << name << " " << value << std::endl;
213 }
214
215 void AddIndent() {
216 for (size_t i = 0; i < indent_; ++i) {
217 output_ << " ";
218 }
219 }
220
Nicolas Geoffrayb09aacb2014-09-17 18:21:53 +0100221 char GetTypeId(Primitive::Type type) {
Nicolas Geoffray18efde52014-09-22 15:51:11 +0100222 // Note that Primitive::Descriptor would not work for us
223 // because it does not handle reference types (that is kPrimNot).
Nicolas Geoffrayb09aacb2014-09-17 18:21:53 +0100224 switch (type) {
225 case Primitive::kPrimBoolean: return 'z';
226 case Primitive::kPrimByte: return 'b';
227 case Primitive::kPrimChar: return 'c';
228 case Primitive::kPrimShort: return 's';
229 case Primitive::kPrimInt: return 'i';
230 case Primitive::kPrimLong: return 'j';
231 case Primitive::kPrimFloat: return 'f';
232 case Primitive::kPrimDouble: return 'd';
233 case Primitive::kPrimNot: return 'l';
234 case Primitive::kPrimVoid: return 'v';
235 }
236 LOG(FATAL) << "Unreachable";
237 return 'v';
238 }
239
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100240 void PrintPredecessors(HBasicBlock* block) {
241 AddIndent();
242 output_ << "predecessors";
Vladimir Marko145acc52015-09-03 13:33:25 +0000243 for (size_t i = 0, e = block->GetPredecessors().Size(); i < e; ++i) {
244 HBasicBlock* predecessor = block->GetPredecessors().Get(i);
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100245 output_ << " \"B" << predecessor->GetBlockId() << "\" ";
246 }
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100247 if (block->IsEntryBlock() && (disasm_info_ != nullptr)) {
248 output_ << " \"" << kDisassemblyBlockFrameEntry << "\" ";
249 }
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100250 output_<< std::endl;
251 }
252
253 void PrintSuccessors(HBasicBlock* block) {
254 AddIndent();
255 output_ << "successors";
David Brazdilffee3d32015-07-06 11:48:53 +0100256 for (size_t i = 0; i < block->NumberOfNormalSuccessors(); ++i) {
Vladimir Marko145acc52015-09-03 13:33:25 +0000257 HBasicBlock* successor = block->GetSuccessors().Get(i);
David Brazdilffee3d32015-07-06 11:48:53 +0100258 output_ << " \"B" << successor->GetBlockId() << "\" ";
David Brazdilfc6a86a2015-06-26 10:33:45 +0000259 }
260 output_<< std::endl;
261 }
262
263 void PrintExceptionHandlers(HBasicBlock* block) {
264 AddIndent();
265 output_ << "xhandlers";
Vladimir Marko145acc52015-09-03 13:33:25 +0000266 for (size_t i = block->NumberOfNormalSuccessors(); i < block->GetSuccessors().Size(); ++i) {
267 HBasicBlock* handler = block->GetSuccessors().Get(i);
David Brazdilffee3d32015-07-06 11:48:53 +0100268 output_ << " \"B" << handler->GetBlockId() << "\" ";
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100269 }
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100270 if (block->IsExitBlock() &&
271 (disasm_info_ != nullptr) &&
272 !disasm_info_->GetSlowPathIntervals().empty()) {
273 output_ << " \"" << kDisassemblyBlockSlowPaths << "\" ";
274 }
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100275 output_<< std::endl;
276 }
277
David Brazdilc74652862015-05-13 17:50:09 +0100278 void DumpLocation(std::ostream& stream, const Location& location) {
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100279 if (location.IsRegister()) {
David Brazdilc74652862015-05-13 17:50:09 +0100280 codegen_.DumpCoreRegister(stream, location.reg());
Nicolas Geoffray102cbed2014-10-15 18:31:05 +0100281 } else if (location.IsFpuRegister()) {
David Brazdilc74652862015-05-13 17:50:09 +0100282 codegen_.DumpFloatingPointRegister(stream, location.reg());
Nicolas Geoffray96f89a22014-07-11 10:57:49 +0100283 } else if (location.IsConstant()) {
David Brazdilc74652862015-05-13 17:50:09 +0100284 stream << "#";
Nicolas Geoffray18efde52014-09-22 15:51:11 +0100285 HConstant* constant = location.GetConstant();
286 if (constant->IsIntConstant()) {
David Brazdilc74652862015-05-13 17:50:09 +0100287 stream << constant->AsIntConstant()->GetValue();
Nicolas Geoffray18efde52014-09-22 15:51:11 +0100288 } else if (constant->IsLongConstant()) {
David Brazdilc74652862015-05-13 17:50:09 +0100289 stream << constant->AsLongConstant()->GetValue();
Nicolas Geoffray18efde52014-09-22 15:51:11 +0100290 }
Nicolas Geoffray96f89a22014-07-11 10:57:49 +0100291 } else if (location.IsInvalid()) {
David Brazdilc74652862015-05-13 17:50:09 +0100292 stream << "invalid";
Nicolas Geoffray412f10c2014-06-19 10:00:34 +0100293 } else if (location.IsStackSlot()) {
David Brazdilc74652862015-05-13 17:50:09 +0100294 stream << location.GetStackIndex() << "(sp)";
Nicolas Geoffray840e5462015-01-07 16:01:24 +0000295 } else if (location.IsFpuRegisterPair()) {
David Brazdilc74652862015-05-13 17:50:09 +0100296 codegen_.DumpFloatingPointRegister(stream, location.low());
297 stream << "|";
298 codegen_.DumpFloatingPointRegister(stream, location.high());
Nicolas Geoffray6c2dff82015-01-21 14:56:54 +0000299 } else if (location.IsRegisterPair()) {
David Brazdilc74652862015-05-13 17:50:09 +0100300 codegen_.DumpCoreRegister(stream, location.low());
301 stream << "|";
302 codegen_.DumpCoreRegister(stream, location.high());
Mark Mendell09ed1a32015-03-25 08:30:06 -0400303 } else if (location.IsUnallocated()) {
David Brazdilc74652862015-05-13 17:50:09 +0100304 stream << "unallocated";
Nicolas Geoffray412f10c2014-06-19 10:00:34 +0100305 } else {
306 DCHECK(location.IsDoubleStackSlot());
David Brazdilc74652862015-05-13 17:50:09 +0100307 stream << "2x" << location.GetStackIndex() << "(sp)";
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100308 }
309 }
310
David Brazdilc74652862015-05-13 17:50:09 +0100311 std::ostream& StartAttributeStream(const char* name = nullptr) {
312 if (name == nullptr) {
313 output_ << " ";
314 } else {
315 DCHECK(!HasWhitespace(name)) << "Checker does not allow spaces in attributes";
316 output_ << " " << name << ":";
317 }
318 return output_;
319 }
320
David Brazdilb7e4a062014-12-29 15:35:02 +0000321 void VisitParallelMove(HParallelMove* instruction) OVERRIDE {
David Brazdilc74652862015-05-13 17:50:09 +0100322 StartAttributeStream("liveness") << instruction->GetLifetimePosition();
323 StringList moves;
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100324 for (size_t i = 0, e = instruction->NumMoves(); i < e; ++i) {
325 MoveOperands* move = instruction->MoveOperandsAt(i);
David Brazdilc74652862015-05-13 17:50:09 +0100326 std::ostream& str = moves.NewEntryStream();
327 DumpLocation(str, move->GetSource());
328 str << "->";
329 DumpLocation(str, move->GetDestination());
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100330 }
David Brazdilc74652862015-05-13 17:50:09 +0100331 StartAttributeStream("moves") << moves;
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100332 }
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100333
David Brazdil36cf0952015-01-08 19:28:33 +0000334 void VisitIntConstant(HIntConstant* instruction) OVERRIDE {
David Brazdilc74652862015-05-13 17:50:09 +0100335 StartAttributeStream() << instruction->GetValue();
David Brazdilb7e4a062014-12-29 15:35:02 +0000336 }
337
David Brazdil36cf0952015-01-08 19:28:33 +0000338 void VisitLongConstant(HLongConstant* instruction) OVERRIDE {
David Brazdilc74652862015-05-13 17:50:09 +0100339 StartAttributeStream() << instruction->GetValue();
David Brazdilb7e4a062014-12-29 15:35:02 +0000340 }
341
David Brazdil36cf0952015-01-08 19:28:33 +0000342 void VisitFloatConstant(HFloatConstant* instruction) OVERRIDE {
David Brazdilc74652862015-05-13 17:50:09 +0100343 StartAttributeStream() << instruction->GetValue();
David Brazdilb7e4a062014-12-29 15:35:02 +0000344 }
345
David Brazdil36cf0952015-01-08 19:28:33 +0000346 void VisitDoubleConstant(HDoubleConstant* instruction) OVERRIDE {
David Brazdilc74652862015-05-13 17:50:09 +0100347 StartAttributeStream() << instruction->GetValue();
David Brazdilb7e4a062014-12-29 15:35:02 +0000348 }
349
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000350 void VisitPhi(HPhi* phi) OVERRIDE {
David Brazdilc74652862015-05-13 17:50:09 +0100351 StartAttributeStream("reg") << phi->GetRegNumber();
David Brazdilffee3d32015-07-06 11:48:53 +0100352 StartAttributeStream("is_catch_phi") << std::boolalpha << phi->IsCatchPhi() << std::noboolalpha;
Nicolas Geoffrayd6138ef2015-02-18 14:48:53 +0000353 }
354
Calin Juravle27df7582015-04-17 19:12:31 +0100355 void VisitMemoryBarrier(HMemoryBarrier* barrier) OVERRIDE {
David Brazdilc74652862015-05-13 17:50:09 +0100356 StartAttributeStream("kind") << barrier->GetBarrierKind();
Calin Juravle27df7582015-04-17 19:12:31 +0100357 }
358
David Brazdilbff75032015-07-08 17:26:51 +0000359 void VisitMonitorOperation(HMonitorOperation* monitor) OVERRIDE {
360 StartAttributeStream("kind") << (monitor->IsEnter() ? "enter" : "exit");
361 }
362
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100363 void VisitLoadClass(HLoadClass* load_class) OVERRIDE {
Calin Juravle0ba218d2015-05-19 18:46:01 +0100364 StartAttributeStream("gen_clinit_check") << std::boolalpha
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100365 << load_class->MustGenerateClinitCheck() << std::noboolalpha;
Calin Juravle0ba218d2015-05-19 18:46:01 +0100366 }
367
Guillaume "Vermeille" Sanchez9099ef72015-05-20 15:19:21 +0100368 void VisitCheckCast(HCheckCast* check_cast) OVERRIDE {
369 StartAttributeStream("must_do_null_check") << std::boolalpha
370 << check_cast->MustDoNullCheck() << std::noboolalpha;
371 }
372
373 void VisitInstanceOf(HInstanceOf* instance_of) OVERRIDE {
374 StartAttributeStream("must_do_null_check") << std::boolalpha
375 << instance_of->MustDoNullCheck() << std::noboolalpha;
376 }
377
Nicolas Geoffray842acd42015-07-01 13:00:15 +0100378 void VisitInvoke(HInvoke* invoke) OVERRIDE {
Nicolas Geoffrayd23eeef2015-05-18 22:31:29 +0100379 StartAttributeStream("dex_file_index") << invoke->GetDexMethodIndex();
Nicolas Geoffray242febb2015-07-01 16:10:44 +0100380 StartAttributeStream("method_name") << PrettyMethod(
381 invoke->GetDexMethodIndex(), GetGraph()->GetDexFile(), /* with_signature */ false);
Nicolas Geoffray842acd42015-07-01 13:00:15 +0100382 }
383
384 void VisitInvokeStaticOrDirect(HInvokeStaticOrDirect* invoke) OVERRIDE {
385 VisitInvoke(invoke);
Nicolas Geoffrayd23eeef2015-05-18 22:31:29 +0100386 StartAttributeStream("recursive") << std::boolalpha
387 << invoke->IsRecursive()
388 << std::noboolalpha;
Scott Wakelingd60a1af2015-07-22 14:32:44 +0100389 StartAttributeStream("intrinsic") << invoke->GetIntrinsic();
Nicolas Geoffrayd23eeef2015-05-18 22:31:29 +0100390 }
391
David Brazdilfc6a86a2015-06-26 10:33:45 +0000392 void VisitTryBoundary(HTryBoundary* try_boundary) OVERRIDE {
David Brazdil56e1acc2015-06-30 15:41:36 +0100393 StartAttributeStream("kind") << (try_boundary->IsEntry() ? "entry" : "exit");
David Brazdilfc6a86a2015-06-26 10:33:45 +0000394 }
395
Andreas Gampe7c3952f2015-02-19 18:21:24 -0800396 bool IsPass(const char* name) {
397 return strcmp(pass_name_, name) == 0;
398 }
399
Calin Juravlea5ae3c32015-07-28 14:40:50 +0000400 bool IsReferenceTypePropagationPass() {
401 return strstr(pass_name_, ReferenceTypePropagation::kReferenceTypePropagationPassName)
402 != nullptr;
403 }
404
David Brazdilb7e4a062014-12-29 15:35:02 +0000405 void PrintInstruction(HInstruction* instruction) {
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100406 output_ << instruction->DebugName();
407 if (instruction->InputCount() > 0) {
David Brazdilc74652862015-05-13 17:50:09 +0100408 StringList inputs;
409 for (HInputIterator it(instruction); !it.Done(); it.Advance()) {
410 inputs.NewEntryStream() << GetTypeId(it.Current()->GetType()) << it.Current()->GetId();
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100411 }
David Brazdilc74652862015-05-13 17:50:09 +0100412 StartAttributeStream() << inputs;
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100413 }
David Brazdilc74652862015-05-13 17:50:09 +0100414 instruction->Accept(this);
Zheng Xubb7a28a2015-01-09 14:40:47 +0800415 if (instruction->HasEnvironment()) {
David Brazdilc74652862015-05-13 17:50:09 +0100416 StringList envs;
Nicolas Geoffray0a23d742015-05-07 11:57:35 +0100417 for (HEnvironment* environment = instruction->GetEnvironment();
418 environment != nullptr;
419 environment = environment->GetParent()) {
David Brazdilc74652862015-05-13 17:50:09 +0100420 StringList vregs;
Nicolas Geoffray0a23d742015-05-07 11:57:35 +0100421 for (size_t i = 0, e = environment->Size(); i < e; ++i) {
422 HInstruction* insn = environment->GetInstructionAt(i);
423 if (insn != nullptr) {
David Brazdilc74652862015-05-13 17:50:09 +0100424 vregs.NewEntryStream() << GetTypeId(insn->GetType()) << insn->GetId();
Nicolas Geoffray0a23d742015-05-07 11:57:35 +0100425 } else {
David Brazdilc74652862015-05-13 17:50:09 +0100426 vregs.NewEntryStream() << "_";
Nicolas Geoffray0a23d742015-05-07 11:57:35 +0100427 }
Zheng Xubb7a28a2015-01-09 14:40:47 +0800428 }
David Brazdilc74652862015-05-13 17:50:09 +0100429 envs.NewEntryStream() << vregs;
Zheng Xubb7a28a2015-01-09 14:40:47 +0800430 }
David Brazdilc74652862015-05-13 17:50:09 +0100431 StartAttributeStream("env") << envs;
Zheng Xubb7a28a2015-01-09 14:40:47 +0800432 }
Andreas Gampe7c3952f2015-02-19 18:21:24 -0800433 if (IsPass(SsaLivenessAnalysis::kLivenessPassName)
David Brazdil5e8b1372015-01-23 14:39:08 +0000434 && is_after_pass_
435 && instruction->GetLifetimePosition() != kNoLifetime) {
David Brazdilc74652862015-05-13 17:50:09 +0100436 StartAttributeStream("liveness") << instruction->GetLifetimePosition();
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100437 if (instruction->HasLiveInterval()) {
David Brazdilc74652862015-05-13 17:50:09 +0100438 LiveInterval* interval = instruction->GetLiveInterval();
David Brazdilc7a24852015-05-15 16:44:05 +0100439 StartAttributeStream("ranges")
440 << StringList(interval->GetFirstRange(), StringList::kSetBrackets);
David Brazdilc74652862015-05-13 17:50:09 +0100441 StartAttributeStream("uses") << StringList(interval->GetFirstUse());
442 StartAttributeStream("env_uses") << StringList(interval->GetFirstEnvironmentUse());
443 StartAttributeStream("is_fixed") << interval->IsFixed();
444 StartAttributeStream("is_split") << interval->IsSplit();
445 StartAttributeStream("is_low") << interval->IsLowInterval();
446 StartAttributeStream("is_high") << interval->IsHighInterval();
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100447 }
Andreas Gampe7c3952f2015-02-19 18:21:24 -0800448 } else if (IsPass(RegisterAllocator::kRegisterAllocatorPassName) && is_after_pass_) {
David Brazdilc74652862015-05-13 17:50:09 +0100449 StartAttributeStream("liveness") << instruction->GetLifetimePosition();
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100450 LocationSummary* locations = instruction->GetLocations();
451 if (locations != nullptr) {
David Brazdilc74652862015-05-13 17:50:09 +0100452 StringList inputs;
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100453 for (size_t i = 0; i < instruction->InputCount(); ++i) {
David Brazdilc74652862015-05-13 17:50:09 +0100454 DumpLocation(inputs.NewEntryStream(), locations->InAt(i));
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100455 }
David Brazdilc74652862015-05-13 17:50:09 +0100456 std::ostream& attr = StartAttributeStream("locations");
457 attr << inputs << "->";
458 DumpLocation(attr, locations->Out());
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100459 }
David Brazdila4b8c212015-05-07 09:59:30 +0100460 } else if (IsPass(LICM::kLoopInvariantCodeMotionPassName)
461 || IsPass(HDeadCodeElimination::kFinalDeadCodeEliminationPassName)) {
Nicolas Geoffray82091da2015-01-26 10:02:45 +0000462 HLoopInformation* info = instruction->GetBlock()->GetLoopInformation();
463 if (info == nullptr) {
David Brazdilc74652862015-05-13 17:50:09 +0100464 StartAttributeStream("loop") << "none";
Nicolas Geoffray82091da2015-01-26 10:02:45 +0000465 } else {
David Brazdilc74652862015-05-13 17:50:09 +0100466 StartAttributeStream("loop") << "B" << info->GetHeader()->GetBlockId();
Nicolas Geoffray82091da2015-01-26 10:02:45 +0000467 }
Calin Juravle2e768302015-07-28 14:41:11 +0000468 } else if (IsReferenceTypePropagationPass()
469 && (instruction->GetType() == Primitive::kPrimNot)) {
470 ReferenceTypeInfo info = instruction->IsLoadClass()
471 ? instruction->AsLoadClass()->GetLoadedClassRTI()
472 : instruction->GetReferenceTypeInfo();
473 ScopedObjectAccess soa(Thread::Current());
474 if (info.IsValid()) {
475 StartAttributeStream("klass") << PrettyDescriptor(info.GetTypeHandle().Get());
476 StartAttributeStream("can_be_null")
477 << std::boolalpha << instruction->CanBeNull() << std::noboolalpha;
478 StartAttributeStream("exact") << std::boolalpha << info.IsExact() << std::noboolalpha;
479 } else {
480 DCHECK(!is_after_pass_) << "Type info should be valid after reference type propagation";
Nicolas Geoffray7cb499b2015-06-17 11:35:11 +0100481 }
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100482 }
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100483 if (disasm_info_ != nullptr) {
484 DCHECK(disassembler_ != nullptr);
485 // If the information is available, disassemble the code generated for
486 // this instruction.
487 auto it = disasm_info_->GetInstructionIntervals().find(instruction);
488 if (it != disasm_info_->GetInstructionIntervals().end()
489 && it->second.start != it->second.end) {
490 output_ << std::endl;
491 disassembler_->Disassemble(output_, it->second.start, it->second.end);
492 }
493 }
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100494 }
495
496 void PrintInstructions(const HInstructionList& list) {
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100497 for (HInstructionIterator it(list); !it.Done(); it.Advance()) {
498 HInstruction* instruction = it.Current();
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100499 int bci = 0;
David Brazdilea55b932015-01-27 17:12:29 +0000500 size_t num_uses = 0;
501 for (HUseIterator<HInstruction*> use_it(instruction->GetUses());
502 !use_it.Done();
503 use_it.Advance()) {
504 ++num_uses;
505 }
506 AddIndent();
507 output_ << bci << " " << num_uses << " "
508 << GetTypeId(instruction->GetType()) << instruction->GetId() << " ";
David Brazdilb7e4a062014-12-29 15:35:02 +0000509 PrintInstruction(instruction);
David Brazdilc74652862015-05-13 17:50:09 +0100510 output_ << " " << kEndInstructionMarker << std::endl;
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100511 }
512 }
513
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100514 void DumpStartOfDisassemblyBlock(const char* block_name,
515 int predecessor_index,
516 int successor_index) {
517 StartTag("block");
518 PrintProperty("name", block_name);
519 PrintInt("from_bci", -1);
520 PrintInt("to_bci", -1);
521 if (predecessor_index != -1) {
522 PrintProperty("predecessors", "B", predecessor_index);
523 } else {
524 PrintEmptyProperty("predecessors");
525 }
526 if (successor_index != -1) {
527 PrintProperty("successors", "B", successor_index);
528 } else {
529 PrintEmptyProperty("successors");
530 }
531 PrintEmptyProperty("xhandlers");
532 PrintEmptyProperty("flags");
533 StartTag("states");
534 StartTag("locals");
535 PrintInt("size", 0);
536 PrintProperty("method", "None");
537 EndTag("locals");
538 EndTag("states");
539 StartTag("HIR");
540 }
541
542 void DumpEndOfDisassemblyBlock() {
543 EndTag("HIR");
544 EndTag("block");
545 }
546
547 void DumpDisassemblyBlockForFrameEntry() {
548 DumpStartOfDisassemblyBlock(kDisassemblyBlockFrameEntry,
549 -1,
550 GetGraph()->GetEntryBlock()->GetBlockId());
551 output_ << " 0 0 disasm " << kDisassemblyBlockFrameEntry << " ";
552 GeneratedCodeInterval frame_entry = disasm_info_->GetFrameEntryInterval();
553 if (frame_entry.start != frame_entry.end) {
554 output_ << std::endl;
555 disassembler_->Disassemble(output_, frame_entry.start, frame_entry.end);
556 }
557 output_ << kEndInstructionMarker << std::endl;
558 DumpEndOfDisassemblyBlock();
559 }
560
561 void DumpDisassemblyBlockForSlowPaths() {
562 if (disasm_info_->GetSlowPathIntervals().empty()) {
563 return;
564 }
565 // If the graph has an exit block we attach the block for the slow paths
566 // after it. Else we just add the block to the graph without linking it to
567 // any other.
568 DumpStartOfDisassemblyBlock(
569 kDisassemblyBlockSlowPaths,
570 GetGraph()->HasExitBlock() ? GetGraph()->GetExitBlock()->GetBlockId() : -1,
571 -1);
572 for (SlowPathCodeInfo info : disasm_info_->GetSlowPathIntervals()) {
573 output_ << " 0 0 disasm " << info.slow_path->GetDescription() << std::endl;
574 disassembler_->Disassemble(output_, info.code_interval.start, info.code_interval.end);
575 output_ << kEndInstructionMarker << std::endl;
576 }
577 DumpEndOfDisassemblyBlock();
578 }
579
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100580 void Run() {
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100581 StartTag("cfg");
David Brazdilffee3d32015-07-06 11:48:53 +0100582 std::string pass_desc = std::string(pass_name_)
583 + " ("
584 + (is_after_pass_ ? "after" : "before")
585 + (graph_in_bad_state_ ? ", bad_state" : "")
586 + ")";
Nicolas Geoffray840e5462015-01-07 16:01:24 +0000587 PrintProperty("name", pass_desc.c_str());
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100588 if (disasm_info_ != nullptr) {
589 DumpDisassemblyBlockForFrameEntry();
590 }
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100591 VisitInsertionOrder();
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100592 if (disasm_info_ != nullptr) {
593 DumpDisassemblyBlockForSlowPaths();
594 }
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100595 EndTag("cfg");
596 }
597
David Brazdilb7e4a062014-12-29 15:35:02 +0000598 void VisitBasicBlock(HBasicBlock* block) OVERRIDE {
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100599 StartTag("block");
600 PrintProperty("name", "B", block->GetBlockId());
Nicolas Geoffrayddb311f2014-05-16 09:28:54 +0100601 if (block->GetLifetimeStart() != kNoLifetime) {
602 // Piggy back on these fields to show the lifetime of the block.
603 PrintInt("from_bci", block->GetLifetimeStart());
604 PrintInt("to_bci", block->GetLifetimeEnd());
605 } else {
606 PrintInt("from_bci", -1);
607 PrintInt("to_bci", -1);
608 }
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100609 PrintPredecessors(block);
610 PrintSuccessors(block);
David Brazdilfc6a86a2015-06-26 10:33:45 +0000611 PrintExceptionHandlers(block);
612
613 if (block->IsCatchBlock()) {
614 PrintProperty("flags", "catch_block");
615 } else {
616 PrintEmptyProperty("flags");
617 }
618
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100619 if (block->GetDominator() != nullptr) {
620 PrintProperty("dominator", "B", block->GetDominator()->GetBlockId());
621 }
622
623 StartTag("states");
624 StartTag("locals");
625 PrintInt("size", 0);
626 PrintProperty("method", "None");
627 for (HInstructionIterator it(block->GetPhis()); !it.Done(); it.Advance()) {
628 AddIndent();
629 HInstruction* instruction = it.Current();
Nicolas Geoffrayb09aacb2014-09-17 18:21:53 +0100630 output_ << instruction->GetId() << " " << GetTypeId(instruction->GetType())
631 << instruction->GetId() << "[ ";
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100632 for (HInputIterator inputs(instruction); !inputs.Done(); inputs.Advance()) {
633 output_ << inputs.Current()->GetId() << " ";
634 }
635 output_ << "]" << std::endl;
636 }
637 EndTag("locals");
638 EndTag("states");
639
640 StartTag("HIR");
641 PrintInstructions(block->GetPhis());
642 PrintInstructions(block->GetInstructions());
643 EndTag("HIR");
644 EndTag("block");
645 }
646
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100647 static constexpr const char* const kEndInstructionMarker = "<|@";
648 static constexpr const char* const kDisassemblyBlockFrameEntry = "FrameEntry";
649 static constexpr const char* const kDisassemblyBlockSlowPaths = "SlowPaths";
650
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100651 private:
652 std::ostream& output_;
Nicolas Geoffray86dbb9a2014-06-04 11:12:39 +0100653 const char* pass_name_;
Nicolas Geoffray840e5462015-01-07 16:01:24 +0000654 const bool is_after_pass_;
David Brazdilffee3d32015-07-06 11:48:53 +0100655 const bool graph_in_bad_state_;
Nicolas Geoffraya7062e02014-05-22 12:50:17 +0100656 const CodeGenerator& codegen_;
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100657 const DisassemblyInformation* disasm_info_;
658 std::unique_ptr<HGraphVisualizerDisassembler> disassembler_;
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100659 size_t indent_;
660
661 DISALLOW_COPY_AND_ASSIGN(HGraphVisualizerPrinter);
662};
663
664HGraphVisualizer::HGraphVisualizer(std::ostream* output,
665 HGraph* graph,
David Brazdil62e074f2015-04-07 18:09:37 +0100666 const CodeGenerator& codegen)
667 : output_(output), graph_(graph), codegen_(codegen) {}
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100668
David Brazdil62e074f2015-04-07 18:09:37 +0100669void HGraphVisualizer::PrintHeader(const char* method_name) const {
670 DCHECK(output_ != nullptr);
David Brazdilffee3d32015-07-06 11:48:53 +0100671 HGraphVisualizerPrinter printer(graph_, *output_, "", true, false, codegen_);
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100672 printer.StartTag("compilation");
Nicolas Geoffraye53798a2014-12-01 10:31:54 +0000673 printer.PrintProperty("name", method_name);
674 printer.PrintProperty("method", method_name);
Nicolas Geoffray0d3f5782014-05-14 09:43:38 +0100675 printer.PrintTime("date");
676 printer.EndTag("compilation");
677}
678
David Brazdilffee3d32015-07-06 11:48:53 +0100679void HGraphVisualizer::DumpGraph(const char* pass_name,
680 bool is_after_pass,
681 bool graph_in_bad_state) const {
David Brazdil5e8b1372015-01-23 14:39:08 +0000682 DCHECK(output_ != nullptr);
683 if (!graph_->GetBlocks().IsEmpty()) {
David Brazdilffee3d32015-07-06 11:48:53 +0100684 HGraphVisualizerPrinter printer(graph_,
685 *output_,
686 pass_name,
687 is_after_pass,
688 graph_in_bad_state,
689 codegen_);
David Brazdilee690a32014-12-01 17:04:16 +0000690 printer.Run();
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100691 }
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100692}
693
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100694void HGraphVisualizer::DumpGraphWithDisassembly() const {
695 DCHECK(output_ != nullptr);
696 if (!graph_->GetBlocks().IsEmpty()) {
David Brazdilffee3d32015-07-06 11:48:53 +0100697 HGraphVisualizerPrinter printer(graph_,
698 *output_,
699 "disassembly",
700 /* is_after_pass */ true,
701 /* graph_in_bad_state */ false,
702 codegen_,
703 codegen_.GetDisassemblyInformation());
Alexandre Rameseb7b7392015-06-19 14:47:01 +0100704 printer.Run();
705 }
706}
707
Nicolas Geoffrayf635e632014-05-14 09:43:38 +0100708} // namespace art