/*

 * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

#include "precompiled.hpp"

#include "opto/chaitin.hpp"

#include "opto/idealGraphPrinter.hpp"

#include "opto/machnode.hpp"

#include "opto/parse.hpp"

#include "runtime/threadCritical.hpp"

#ifndef PRODUCT

// Constants

// Keep consistent with Java constants

const char *IdealGraphPrinter::INDENT = "  ";

const char *IdealGraphPrinter::TOP_ELEMENT = "graphDocument";

const char *IdealGraphPrinter::GROUP_ELEMENT = "group";

const char *IdealGraphPrinter::GRAPH_ELEMENT = "graph";

const char *IdealGraphPrinter::PROPERTIES_ELEMENT = "properties";

const char *IdealGraphPrinter::EDGES_ELEMENT = "edges";

const char *IdealGraphPrinter::PROPERTY_ELEMENT = "p";

const char *IdealGraphPrinter::EDGE_ELEMENT = "edge";

const char *IdealGraphPrinter::NODE_ELEMENT = "node";

const char *IdealGraphPrinter::NODES_ELEMENT = "nodes";

const char *IdealGraphPrinter::REMOVE_EDGE_ELEMENT = "removeEdge";

const char *IdealGraphPrinter::REMOVE_NODE_ELEMENT = "removeNode";

const char *IdealGraphPrinter::METHOD_NAME_PROPERTY = "name";

const char *IdealGraphPrinter::METHOD_IS_PUBLIC_PROPERTY = "public";

const char *IdealGraphPrinter::METHOD_IS_STATIC_PROPERTY = "static";

const char *IdealGraphPrinter::TRUE_VALUE = "true";

const char *IdealGraphPrinter::NODE_NAME_PROPERTY = "name";

const char *IdealGraphPrinter::EDGE_NAME_PROPERTY = "name";

const char *IdealGraphPrinter::NODE_ID_PROPERTY = "id";

const char *IdealGraphPrinter::FROM_PROPERTY = "from";

const char *IdealGraphPrinter::TO_PROPERTY = "to";

const char *IdealGraphPrinter::PROPERTY_NAME_PROPERTY = "name";

const char *IdealGraphPrinter::GRAPH_NAME_PROPERTY = "name";

const char *IdealGraphPrinter::INDEX_PROPERTY = "index";

const char *IdealGraphPrinter::METHOD_ELEMENT = "method";

const char *IdealGraphPrinter::INLINE_ELEMENT = "inline";

const char *IdealGraphPrinter::BYTECODES_ELEMENT = "bytecodes";

const char *IdealGraphPrinter::METHOD_BCI_PROPERTY = "bci";

const char *IdealGraphPrinter::METHOD_SHORT_NAME_PROPERTY = "shortName";

const char *IdealGraphPrinter::CONTROL_FLOW_ELEMENT = "controlFlow";

const char *IdealGraphPrinter::BLOCK_NAME_PROPERTY = "name";

const char *IdealGraphPrinter::BLOCK_DOMINATOR_PROPERTY = "dom";

const char *IdealGraphPrinter::BLOCK_ELEMENT = "block";

const char *IdealGraphPrinter::SUCCESSORS_ELEMENT = "successors";

const char *IdealGraphPrinter::SUCCESSOR_ELEMENT = "successor";

const char *IdealGraphPrinter::ASSEMBLY_ELEMENT = "assembly";

int IdealGraphPrinter::_file_count = 0;

IdealGraphPrinter *IdealGraphPrinter::printer() {

  if (PrintIdealGraphLevel == 0) return NULL;

  JavaThread *thread = JavaThread::current();

  if (!thread->is_Compiler_thread()) return NULL;

  CompilerThread *compiler_thread = (CompilerThread *)thread;

  if (compiler_thread->ideal_graph_printer() == NULL) {

    IdealGraphPrinter *printer = new IdealGraphPrinter();

    compiler_thread->set_ideal_graph_printer(printer);

  }

  return compiler_thread->ideal_graph_printer();

}

void IdealGraphPrinter::clean_up() {

  JavaThread *p;

  for (p = Threads::first(); p; p = p->next()) {

    if (p->is_Compiler_thread()) {

      CompilerThread *c = (CompilerThread *)p;

      IdealGraphPrinter *printer = c->ideal_graph_printer();

      if (printer) {

        delete printer;

      }

      c->set_ideal_graph_printer(NULL);

    }

  }

}

// Constructor, either file or network output

IdealGraphPrinter::IdealGraphPrinter() {

  // By default dump both ins and outs since dead or unreachable code

  // needs to appear in the graph.  There are also some special cases

  // in the mach where kill projections have no users but should

  // appear in the dump.

  _traverse_outs = true;

  _should_send_method = true;

  _output = NULL;

  buffer[0] = 0;

  _depth = 0;

  _current_method = NULL;

  assert(!_current_method, "current method must be initialized to NULL");

  _stream = NULL;

  if (PrintIdealGraphFile != NULL) {

    ThreadCritical tc;

    // User wants all output to go to files

    if (_file_count != 0) {

      ResourceMark rm;

      stringStream st;

      const char* dot = strrchr(PrintIdealGraphFile, '.');

      if (dot) {

        st.write(PrintIdealGraphFile, dot - PrintIdealGraphFile);

        st.print("%d%s", _file_count, dot);

      } else {

        st.print("%s%d", PrintIdealGraphFile, _file_count);

      }

      fileStream *stream = new (ResourceObj::C_HEAP) fileStream(st.as_string());

      _output = stream;

    } else {

      fileStream *stream = new (ResourceObj::C_HEAP) fileStream(PrintIdealGraphFile);

      _output = stream;

    }

    _file_count++;

  } else {

    _stream = new (ResourceObj::C_HEAP) networkStream();

    // Try to connect to visualizer

    if (_stream->connect(PrintIdealGraphAddress, PrintIdealGraphPort)) {

      char c = 0;

      _stream->read(&c, 1);

      if (c != 'y') {

        tty->print_cr("Client available, but does not want to receive data!");

        _stream->close();

        delete _stream;

        _stream = NULL;

        return;

      }

      _output = _stream;

    } else {

      // It would be nice if we could shut down cleanly but it should

      // be an error if we can't connect to the visualizer.

      fatal(err_msg("Couldn't connect to visualizer at %s:%d",

                    PrintIdealGraphAddress, PrintIdealGraphPort));

    }

  }

  _xml = new (ResourceObj::C_HEAP) xmlStream(_output);

  head(TOP_ELEMENT);

}

// Destructor, close file or network stream

IdealGraphPrinter::~IdealGraphPrinter() {

  tail(TOP_ELEMENT);

  // tty->print_cr("Walk time: %d", (int)_walk_time.milliseconds());

  // tty->print_cr("Output time: %d", (int)_output_time.milliseconds());

  // tty->print_cr("Build blocks time: %d", (int)_build_blocks_time.milliseconds());

  if(_xml) {

    delete _xml;

    _xml = NULL;

  }

  if (_stream) {

    delete _stream;

    if (_stream == _output) {

      _output = NULL;

    }

    _stream = NULL;

  }

  if (_output) {

    delete _output;

    _output = NULL;

  }

}

void IdealGraphPrinter::begin_elem(const char *s) {

  _xml->begin_elem(s);

}

void IdealGraphPrinter::end_elem() {

  _xml->end_elem();

}

void IdealGraphPrinter::begin_head(const char *s) {

  _xml->begin_head(s);

}

void IdealGraphPrinter::end_head() {

  _xml->end_head();

}

void IdealGraphPrinter::print_attr(const char *name, intptr_t val) {

  stringStream stream;

  stream.print(INTX_FORMAT, val);

  print_attr(name, stream.as_string());

}

void IdealGraphPrinter::print_attr(const char *name, const char *val) {

  _xml->print(" %s='", name);

  text(val);

  _xml->print("'");

}

void IdealGraphPrinter::head(const char *name) {

  _xml->head(name);

}

void IdealGraphPrinter::tail(const char *name) {

  _xml->tail(name);

}

void IdealGraphPrinter::text(const char *s) {

  _xml->text(s);

}

void IdealGraphPrinter::print_prop(const char *name, int val) {

  stringStream stream;

  stream.print("%d", val);

  print_prop(name, stream.as_string());

}

void IdealGraphPrinter::print_prop(const char *name, const char *val) {

  begin_head(PROPERTY_ELEMENT);

  print_attr(PROPERTY_NAME_PROPERTY, name);

  end_head();

  text(val);

  tail(PROPERTY_ELEMENT);

}

void IdealGraphPrinter::print_method(ciMethod *method, int bci, InlineTree *tree) {

  begin_head(METHOD_ELEMENT);

  stringStream str;

  method->print_name(&str);

  stringStream shortStr;

  method->print_short_name(&shortStr);

  print_attr(METHOD_NAME_PROPERTY, str.as_string());

  print_attr(METHOD_SHORT_NAME_PROPERTY, shortStr.as_string());

  print_attr(METHOD_BCI_PROPERTY, bci);

  end_head();

  head(BYTECODES_ELEMENT);

  output()->print_cr("<![CDATA[");

  method->print_codes_on(output());

  output()->print_cr("]]>");

  tail(BYTECODES_ELEMENT);

  head(INLINE_ELEMENT);

  if (tree != NULL) {

    GrowableArray<InlineTree *> subtrees = tree->subtrees();

    for (int i = 0; i < subtrees.length(); i++) {

      print_inline_tree(subtrees.at(i));

    }

  }

  tail(INLINE_ELEMENT);

  tail(METHOD_ELEMENT);

  output()->flush();

}

void IdealGraphPrinter::print_inline_tree(InlineTree *tree) {

  if (tree == NULL) return;

  ciMethod *method = tree->method();

  print_method(tree->method(), tree->caller_bci(), tree);

}

void IdealGraphPrinter::print_inlining(Compile* compile) {

  // Print inline tree

  if (_should_send_method) {

    InlineTree *inlineTree = compile->ilt();

    if (inlineTree != NULL) {

      print_inline_tree(inlineTree);

    } else {

      // print this method only

    }

  }

}

// Has to be called whenever a method is compiled

void IdealGraphPrinter::begin_method(Compile* compile) {

  ciMethod *method = compile->method();

  assert(_output, "output stream must exist!");

  assert(method, "null methods are not allowed!");

  assert(!_current_method, "current method must be null!");

  head(GROUP_ELEMENT);

  head(PROPERTIES_ELEMENT);

  // Print properties

  // Add method name

  stringStream strStream;

  method->print_name(&strStream);

  print_prop(METHOD_NAME_PROPERTY, strStream.as_string());

  if (method->flags().is_public()) {

    print_prop(METHOD_IS_PUBLIC_PROPERTY, TRUE_VALUE);

  }

  if (method->flags().is_static()) {

    print_prop(METHOD_IS_STATIC_PROPERTY, TRUE_VALUE);

  }

  tail(PROPERTIES_ELEMENT);

  if (_stream) {

    char answer = 0;

    _xml->flush();

    int result = _stream->read(&answer, 1);

    _should_send_method = (answer == 'y');

  }

  this->_current_method = method;

  _xml->flush();

}

// Has to be called whenever a method has finished compilation

void IdealGraphPrinter::end_method() {

  nmethod* method = (nmethod*)this->_current_method->code();

  tail(GROUP_ELEMENT);

  _current_method = NULL;

  _xml->flush();

}

// Print indent

void IdealGraphPrinter::print_indent() {

  tty->print_cr("printing ident %d", _depth);

  for (int i = 0; i < _depth; i++) {

    _xml->print(INDENT);

  }

}

bool IdealGraphPrinter::traverse_outs() {

  return _traverse_outs;

}

void IdealGraphPrinter::set_traverse_outs(bool b) {

  _traverse_outs = b;

}

intptr_t IdealGraphPrinter::get_node_id(Node *n) {

  return (intptr_t)(n);

}

void IdealGraphPrinter::visit_node(Node *n, bool edges, VectorSet* temp_set) {

  if (edges) {

    // Output edge

    intptr_t dest_id = get_node_id(n);

    for ( uint i = 0; i < n->len(); i++ ) {

      if ( n->in(i) ) {

        Node *source = n->in(i);

        begin_elem(EDGE_ELEMENT);

        intptr_t source_id = get_node_id(source);

        print_attr(FROM_PROPERTY, source_id);

        print_attr(TO_PROPERTY, dest_id);

        print_attr(INDEX_PROPERTY, i);

        end_elem();

      }

    }

  } else {

    // Output node

    begin_head(NODE_ELEMENT);

    print_attr(NODE_ID_PROPERTY, get_node_id(n));

    end_head();

    head(PROPERTIES_ELEMENT);

    Node *node = n;

#ifndef PRODUCT

    node->_in_dump_cnt++;

    print_prop(NODE_NAME_PROPERTY, (const char *)node->Name());

    const Type *t = node->bottom_type();

    print_prop("type", (const char *)Type::msg[t->base()]);

    print_prop("idx", node->_idx);

#ifdef ASSERT

    print_prop("debug_idx", node->_debug_idx);

#endif

    if(C->cfg() != NULL) {

      Block *block = C->cfg()->_bbs[node->_idx];

      if(block == NULL) {

        print_prop("block", C->cfg()->_blocks[0]->_pre_order);

      } else {

        print_prop("block", block->_pre_order);

      }

    }

    const jushort flags = node->flags();

    if (flags & Node::Flag_is_Copy) {

      print_prop("is_copy", "true");

    }

    if (flags & Node::Flag_rematerialize) {

      print_prop("rematerialize", "true");

    }

    if (flags & Node::Flag_needs_anti_dependence_check) {

      print_prop("needs_anti_dependence_check", "true");

    }

    if (flags & Node::Flag_is_macro) {

      print_prop("is_macro", "true");

    }

    if (flags & Node::Flag_is_Con) {

      print_prop("is_con", "true");

    }

    if (flags & Node::Flag_is_cisc_alternate) {

      print_prop("is_cisc_alternate", "true");

    }

    if (flags & Node::Flag_is_dead_loop_safe) {

      print_prop("is_dead_loop_safe", "true");

    }

    if (flags & Node::Flag_may_be_short_branch) {

      print_prop("may_be_short_branch", "true");

    }

    if (C->matcher() != NULL) {

      if (C->matcher()->is_shared(node)) {

        print_prop("is_shared", "true");

      } else {

        print_prop("is_shared", "false");

      }

      if (C->matcher()->is_dontcare(node)) {

        print_prop("is_dontcare", "true");

      } else {

        print_prop("is_dontcare", "false");

      }

#ifdef ASSERT

      Node* old = C->matcher()->find_old_node(node);

      if (old != NULL) {

        print_prop("old_node_idx", old->_idx);

      }

#endif

    }

    if (node->is_Proj()) {

      print_prop("con", (int)node->as_Proj()->_con);

    }

    if (node->is_Mach()) {

      print_prop("idealOpcode", (const char *)NodeClassNames[node->as_Mach()->ideal_Opcode()]);

    }

    buffer[0] = 0;

    stringStream s2(buffer, sizeof(buffer) - 1);

    node->dump_spec(&s2);

    if (t != NULL && (t->isa_instptr() || t->isa_klassptr())) {

      const TypeInstPtr  *toop = t->isa_instptr();

      const TypeKlassPtr *tkls = t->isa_klassptr();

      ciKlass*           klass = toop ? toop->klass() : (tkls ? tkls->klass() : NULL );

      if( klass && klass->is_loaded() && klass->is_interface() ) {

        s2.print("  Interface:");

      } else if( toop ) {

        s2.print("  Oop:");

      } else if( tkls ) {

        s2.print("  Klass:");

      }

      t->dump_on(&s2);

    } else if( t == Type::MEMORY ) {

      s2.print("  Memory:");

      MemNode::dump_adr_type(node, node->adr_type(), &s2);

    }

    assert(s2.size() < sizeof(buffer), "size in range");

    print_prop("dump_spec", buffer);

    if (node->is_block_proj()) {

      print_prop("is_block_proj", "true");

    }

    if (node->is_block_start()) {