1 /*
2  * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.
8  *
9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  *
23  */
24 
25 #ifndef SHARE_C1_C1_CFGPRINTER_HPP
26 #define SHARE_C1_C1_CFGPRINTER_HPP
27 
28 #include "c1/c1_Compilation.hpp"
29 #include "c1/c1_Instruction.hpp"
30 
31 #ifndef PRODUCT
32 
33 // This is a utility class used for recording the results of a
34 // compilation for later analysis.
35 
36 class CFGPrinterOutput;
37 class Interval;
38 
39 typedef GrowableArray<Interval*> IntervalList;
40 
41 class CFGPrinter : public AllStatic {
42 public:
43   static void print_compilation(Compilation* compilation);
44   static void print_cfg(BlockList* blocks, const char* name, bool do_print_HIR, bool do_print_LIR);
45   static void print_cfg(IR* blocks, const char* name, bool do_print_HIR, bool do_print_LIR);
46   static void print_intervals(IntervalList* intervals, const char* name);
47 };
48 
49 class CFGPrinterOutput : public CHeapObj<mtCompiler> {
50  private:
51   outputStream* _output;
52 
53   Compilation*  _compilation;
54   bool _do_print_HIR;
55   bool _do_print_LIR;
56 
57   class PrintBlockClosure: public BlockClosure {
block_do(BlockBegin * block)58     void block_do(BlockBegin* block) { if (block != NULL) Compilation::current()->cfg_printer_output()->print_block(block); }
59   };
60 
output()61   outputStream* output() { assert(_output != NULL, ""); return _output; }
62 
63   void inc_indent();
64   void dec_indent();
65   void print(const char* format, ...) ATTRIBUTE_PRINTF(2, 3);
66   void print_begin(const char* tag);
67   void print_end(const char* tag);
68 
69   char* method_name(ciMethod* method, bool short_name = false);
70 
71  public:
72   CFGPrinterOutput(Compilation* compilation);
73 
set_print_flags(bool do_print_HIR,bool do_print_LIR)74   void set_print_flags(bool do_print_HIR, bool do_print_LIR) { _do_print_HIR = do_print_HIR; _do_print_LIR = do_print_LIR; }
75 
76   void print_compilation();
77   void print_intervals(IntervalList* intervals, const char* name);
78 
79   void print_state(BlockBegin* block);
80   void print_operand(Value instr);
81   void print_HIR(Value instr);
82   void print_HIR(BlockBegin* block);
83   void print_LIR(BlockBegin* block);
84   void print_block(BlockBegin* block);
85   void print_cfg(BlockList* blocks, const char* name);
86   void print_cfg(IR* blocks, const char* name);
87 };
88 
89 #endif
90 
91 #endif // SHARE_C1_C1_CFGPRINTER_HPP
92