/*

 * Copyright (c) 1997, 2015, 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 "asm/macroAssembler.hpp"

#include "asm/macroAssembler.inline.hpp"

#include "ci/ciReplay.hpp"

#include "classfile/systemDictionary.hpp"

#include "code/exceptionHandlerTable.hpp"

#include "code/nmethod.hpp"

#include "compiler/compileBroker.hpp"

#include "compiler/compileLog.hpp"

#include "compiler/disassembler.hpp"

#include "compiler/oopMap.hpp"

#include "opto/addnode.hpp"

#include "opto/block.hpp"

#include "opto/c2compiler.hpp"

#include "opto/callGenerator.hpp"

#include "opto/callnode.hpp"

#include "opto/cfgnode.hpp"

#include "opto/chaitin.hpp"

#include "opto/compile.hpp"

#include "opto/connode.hpp"

#include "opto/convertnode.hpp"

#include "opto/divnode.hpp"

#include "opto/escape.hpp"

#include "opto/idealGraphPrinter.hpp"

#include "opto/loopnode.hpp"

#include "opto/machnode.hpp"

#include "opto/macro.hpp"

#include "opto/matcher.hpp"

#include "opto/mathexactnode.hpp"

#include "opto/memnode.hpp"

#include "opto/mulnode.hpp"

#include "opto/narrowptrnode.hpp"

#include "opto/node.hpp"

#include "opto/opcodes.hpp"

#include "opto/output.hpp"

#include "opto/parse.hpp"

#include "opto/phaseX.hpp"

#include "opto/rootnode.hpp"

#include "opto/runtime.hpp"

#include "opto/stringopts.hpp"

#include "opto/type.hpp"

#include "opto/vectornode.hpp"

#include "runtime/arguments.hpp"

#include "runtime/sharedRuntime.hpp"

#include "runtime/signature.hpp"

#include "runtime/stubRoutines.hpp"

#include "runtime/timer.hpp"

#include "utilities/copy.hpp"

// -------------------- Compile::mach_constant_base_node -----------------------

// Constant table base node singleton.

MachConstantBaseNode* Compile::mach_constant_base_node() {

  if (_mach_constant_base_node == NULL) {

    _mach_constant_base_node = new MachConstantBaseNode();

    _mach_constant_base_node->add_req(C->root());

  }

  return _mach_constant_base_node;

}

/// Support for intrinsics.

// Return the index at which m must be inserted (or already exists).

// The sort order is by the address of the ciMethod, with is_virtual as minor key.

int Compile::intrinsic_insertion_index(ciMethod* m, bool is_virtual) {

#ifdef ASSERT

  for (int i = 1; i < _intrinsics->length(); i++) {

    CallGenerator* cg1 = _intrinsics->at(i-1);

    CallGenerator* cg2 = _intrinsics->at(i);

    assert(cg1->method() != cg2->method()

           ? cg1->method()     < cg2->method()

           : cg1->is_virtual() < cg2->is_virtual(),

           "compiler intrinsics list must stay sorted");

  }

#endif

  // Binary search sorted list, in decreasing intervals [lo, hi].

  int lo = 0, hi = _intrinsics->length()-1;

  while (lo <= hi) {

    int mid = (uint)(hi + lo) / 2;

    ciMethod* mid_m = _intrinsics->at(mid)->method();

    if (m < mid_m) {

      hi = mid-1;

    } else if (m > mid_m) {

      lo = mid+1;

    } else {

      // look at minor sort key

      bool mid_virt = _intrinsics->at(mid)->is_virtual();

      if (is_virtual < mid_virt) {

        hi = mid-1;

      } else if (is_virtual > mid_virt) {

        lo = mid+1;

      } else {

        return mid;  // exact match

      }

    }

  }

  return lo;  // inexact match

}

void Compile::register_intrinsic(CallGenerator* cg) {

  if (_intrinsics == NULL) {

    _intrinsics = new (comp_arena())GrowableArray<CallGenerator*>(comp_arena(), 60, 0, NULL);

  }

  // This code is stolen from ciObjectFactory::insert.

  // Really, GrowableArray should have methods for

  // insert_at, remove_at, and binary_search.

  int len = _intrinsics->length();

  int index = intrinsic_insertion_index(cg->method(), cg->is_virtual());

  if (index == len) {

    _intrinsics->append(cg);

  } else {

#ifdef ASSERT

    CallGenerator* oldcg = _intrinsics->at(index);

    assert(oldcg->method() != cg->method() || oldcg->is_virtual() != cg->is_virtual(), "don't register twice");

#endif

    _intrinsics->append(_intrinsics->at(len-1));

    int pos;

    for (pos = len-2; pos >= index; pos--) {

      _intrinsics->at_put(pos+1,_intrinsics->at(pos));

    }

    _intrinsics->at_put(index, cg);

  }

  assert(find_intrinsic(cg->method(), cg->is_virtual()) == cg, "registration worked");

}

CallGenerator* Compile::find_intrinsic(ciMethod* m, bool is_virtual) {

  assert(m->is_loaded(), "don't try this on unloaded methods");

  if (_intrinsics != NULL) {

    int index = intrinsic_insertion_index(m, is_virtual);

    if (index < _intrinsics->length()

        && _intrinsics->at(index)->method() == m

        && _intrinsics->at(index)->is_virtual() == is_virtual) {

      return _intrinsics->at(index);

    }

  }

  // Lazily create intrinsics for intrinsic IDs well-known in the runtime.

  if (m->intrinsic_id() != vmIntrinsics::_none &&

      m->intrinsic_id() <= vmIntrinsics::LAST_COMPILER_INLINE) {

    CallGenerator* cg = make_vm_intrinsic(m, is_virtual);

    if (cg != NULL) {

      // Save it for next time:

      register_intrinsic(cg);

      return cg;

    } else {

      gather_intrinsic_statistics(m->intrinsic_id(), is_virtual, _intrinsic_disabled);

    }

  }

  return NULL;

}

// Compile:: register_library_intrinsics and make_vm_intrinsic are defined

// in library_call.cpp.

#ifndef PRODUCT

// statistics gathering...

juint  Compile::_intrinsic_hist_count[vmIntrinsics::ID_LIMIT] = {0};

jubyte Compile::_intrinsic_hist_flags[vmIntrinsics::ID_LIMIT] = {0};

bool Compile::gather_intrinsic_statistics(vmIntrinsics::ID id, bool is_virtual, int flags) {

  assert(id > vmIntrinsics::_none && id < vmIntrinsics::ID_LIMIT, "oob");

  int oflags = _intrinsic_hist_flags[id];

  assert(flags != 0, "what happened?");

  if (is_virtual) {

    flags |= _intrinsic_virtual;

  }

  bool changed = (flags != oflags);

  if ((flags & _intrinsic_worked) != 0) {

    juint count = (_intrinsic_hist_count[id] += 1);

    if (count == 1) {

      changed = true;           // first time

    }

    // increment the overall count also:

    _intrinsic_hist_count[vmIntrinsics::_none] += 1;

  }

  if (changed) {

    if (((oflags ^ flags) & _intrinsic_virtual) != 0) {

      // Something changed about the intrinsic's virtuality.

      if ((flags & _intrinsic_virtual) != 0) {

        // This is the first use of this intrinsic as a virtual call.

        if (oflags != 0) {

          // We already saw it as a non-virtual, so note both cases.

          flags |= _intrinsic_both;

        }

      } else if ((oflags & _intrinsic_both) == 0) {

        // This is the first use of this intrinsic as a non-virtual

        flags |= _intrinsic_both;

      }

    }

    _intrinsic_hist_flags[id] = (jubyte) (oflags | flags);

  }

  // update the overall flags also:

  _intrinsic_hist_flags[vmIntrinsics::_none] |= (jubyte) flags;

  return changed;

}

static char* format_flags(int flags, char* buf) {

  buf[0] = 0;

  if ((flags & Compile::_intrinsic_worked) != 0)    strcat(buf, ",worked");

  if ((flags & Compile::_intrinsic_failed) != 0)    strcat(buf, ",failed");

  if ((flags & Compile::_intrinsic_disabled) != 0)  strcat(buf, ",disabled");

  if ((flags & Compile::_intrinsic_virtual) != 0)   strcat(buf, ",virtual");

  if ((flags & Compile::_intrinsic_both) != 0)      strcat(buf, ",nonvirtual");

  if (buf[0] == 0)  strcat(buf, ",");

  assert(buf[0] == ',', "must be");

  return &buf[1];

}

void Compile::print_intrinsic_statistics() {

  char flagsbuf[100];

  ttyLocker ttyl;

  if (xtty != NULL)  xtty->head("statistics type='intrinsic'");

  tty->print_cr("Compiler intrinsic usage:");

  juint total = _intrinsic_hist_count[vmIntrinsics::_none];

  if (total == 0)  total = 1;  // avoid div0 in case of no successes

  #define PRINT_STAT_LINE(name, c, f) \

    tty->print_cr("  %4d (%4.1f%%) %s (%s)", (int)(c), ((c) * 100.0) / total, name, f);

  for (int index = 1 + (int)vmIntrinsics::_none; index < (int)vmIntrinsics::ID_LIMIT; index++) {

    vmIntrinsics::ID id = (vmIntrinsics::ID) index;

    int   flags = _intrinsic_hist_flags[id];

    juint count = _intrinsic_hist_count[id];

    if ((flags | count) != 0) {

      PRINT_STAT_LINE(vmIntrinsics::name_at(id), count, format_flags(flags, flagsbuf));

    }

  }

  PRINT_STAT_LINE("total", total, format_flags(_intrinsic_hist_flags[vmIntrinsics::_none], flagsbuf));

  if (xtty != NULL)  xtty->tail("statistics");

}

void Compile::print_statistics() {

  { ttyLocker ttyl;

    if (xtty != NULL)  xtty->head("statistics type='opto'");

    Parse::print_statistics();

    PhaseCCP::print_statistics();

    PhaseRegAlloc::print_statistics();

    Scheduling::print_statistics();

    PhasePeephole::print_statistics();

    PhaseIdealLoop::print_statistics();

    if (xtty != NULL)  xtty->tail("statistics");

  }

  if (_intrinsic_hist_flags[vmIntrinsics::_none] != 0) {

    // put this under its own <statistics> element.

    print_intrinsic_statistics();

  }

}

#endif //PRODUCT

// Support for bundling info

Bundle* Compile::node_bundling(const Node *n) {

  assert(valid_bundle_info(n), "oob");

  return &_node_bundling_base[n->_idx];

}

bool Compile::valid_bundle_info(const Node *n) {

  return (_node_bundling_limit > n->_idx);

}

void Compile::gvn_replace_by(Node* n, Node* nn) {

  for (DUIterator_Last imin, i = n->last_outs(imin); i >= imin; ) {

    Node* use = n->last_out(i);

    bool is_in_table = initial_gvn()->hash_delete(use);

    uint uses_found = 0;

    for (uint j = 0; j < use->len(); j++) {

      if (use->in(j) == n) {

        if (j < use->req())

          use->set_req(j, nn);

        else

          use->set_prec(j, nn);

        uses_found++;

      }

    }

    if (is_in_table) {

      // reinsert into table

      initial_gvn()->hash_find_insert(use);

    }

    record_for_igvn(use);

    i -= uses_found;    // we deleted 1 or more copies of this edge

  }

}

static inline bool not_a_node(const Node* n) {

  if (n == NULL)                   return true;

  if (((intptr_t)n & 1) != 0)      return true;  // uninitialized, etc.

  if (*(address*)n == badAddress)  return true;  // kill by Node::destruct

  return false;

}

// Identify all nodes that are reachable from below, useful.

// Use breadth-first pass that records state in a Unique_Node_List,

// recursive traversal is slower.

void Compile::identify_useful_nodes(Unique_Node_List &useful) {

  int estimated_worklist_size = live_nodes();

  useful.map( estimated_worklist_size, NULL );  // preallocate space

  // Initialize worklist

  if (root() != NULL)     { useful.push(root()); }

  // If 'top' is cached, declare it useful to preserve cached node

  if( cached_top_node() ) { useful.push(cached_top_node()); }

  // Push all useful nodes onto the list, breadthfirst

  for( uint next = 0; next < useful.size(); ++next ) {

    assert( next < unique(), "Unique useful nodes < total nodes");

    Node *n  = useful.at(next);

    uint max = n->len();

    for( uint i = 0; i < max; ++i ) {

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

      if (not_a_node(m))  continue;

      useful.push(m);

    }

  }

}

// Update dead_node_list with any missing dead nodes using useful

// list. Consider all non-useful nodes to be useless i.e., dead nodes.

void Compile::update_dead_node_list(Unique_Node_List &useful) {

  uint max_idx = unique();

  VectorSet& useful_node_set = useful.member_set();

  for (uint node_idx = 0; node_idx < max_idx; node_idx++) {

    // If node with index node_idx is not in useful set,

    // mark it as dead in dead node list.

    if (! useful_node_set.test(node_idx) ) {

      record_dead_node(node_idx);

    }

  }

}

void Compile::remove_useless_late_inlines(GrowableArray<CallGenerator*>* inlines, Unique_Node_List &useful) {

  int shift = 0;

  for (int i = 0; i < inlines->length(); i++) {

    CallGenerator* cg = inlines->at(i);

    CallNode* call = cg->call_node();

    if (shift > 0) {

      inlines->at_put(i-shift, cg);

    }

    if (!useful.member(call)) {

      shift++;

    }

  }

  inlines->trunc_to(inlines->length()-shift);

}

// Disconnect all useless nodes by disconnecting those at the boundary.

void Compile::remove_useless_nodes(Unique_Node_List &useful) {

  uint next = 0;

  while (next < useful.size()) {

    Node *n = useful.at(next++);

    if (n->is_SafePoint()) {

      // We're done with a parsing phase. Replaced nodes are not valid

      // beyond that point.

      n->as_SafePoint()->delete_replaced_nodes();

    }

    // Use raw traversal of out edges since this code removes out edges

    int max = n->outcnt();

    for (int j = 0; j < max; ++j) {

      Node* child = n->raw_out(j);

      if (! useful.member(child)) {

        assert(!child->is_top() || child != top(),

               "If top is cached in Compile object it is in useful list");

        // Only need to remove this out-edge to the useless node

        n->raw_del_out(j);

        --j;

        --max;

      }

    }

    if (n->outcnt() == 1 && n->has_special_unique_user()) {

      record_for_igvn(n->unique_out());

    }

  }

  // Remove useless macro and predicate opaq nodes

  for (int i = C->macro_count()-1; i >= 0; i--) {

    Node* n = C->macro_node(i);

    if (!useful.member(n)) {

      remove_macro_node(n);

    }

  }

  // Remove useless expensive node

  for (int i = C->expensive_count()-1; i >= 0; i--) {

    Node* n = C->expensive_node(i);

    if (!useful.member(n)) {

      remove_expensive_node(n);

    }

  }

  // clean up the late inline lists

  remove_useless_late_inlines(&_string_late_inlines, useful);

  remove_useless_late_inlines(&_boxing_late_inlines, useful);

  remove_useless_late_inlines(&_late_inlines, useful);

  debug_only(verify_graph_edges(true/*check for no_dead_code*/);)

}

//------------------------------frame_size_in_words-----------------------------

// frame_slots in units of words

int Compile::frame_size_in_words() const {

  // shift is 0 in LP32 and 1 in LP64

  const int shift = (LogBytesPerWord - LogBytesPerInt);

  int words = _frame_slots >> shift;

  assert( words << shift == _frame_slots, "frame size must be properly aligned in LP64" );

  return words;

}

// To bang the stack of this compiled method we use the stack size

// that the interpreter would need in case of a deoptimization. This

// removes the need to bang the stack in the deoptimization blob which

// in turn simplifies stack overflow handling.

int Compile::bang_size_in_bytes() const {

  return MAX2(frame_size_in_bytes() + os::extra_bang_size_in_bytes(), _interpreter_frame_size);

}

// ============================================================================

//------------------------------CompileWrapper---------------------------------

class CompileWrapper : public StackObj {

  Compile *const _compile;

 public:

  CompileWrapper(Compile* compile);

  ~CompileWrapper();

};

CompileWrapper::CompileWrapper(Compile* compile) : _compile(compile) {

  // the Compile* pointer is stored in the current ciEnv:

  ciEnv* env = compile->env();

  assert(env == ciEnv::current(), "must already be a ciEnv active");

  assert(env->compiler_data() == NULL, "compile already active?");

  env->set_compiler_data(compile);

  assert(compile == Compile::current(), "sanity");

  compile->set_type_dict(NULL);

  compile->set_clone_map(new Dict(cmpkey, hashkey, _compile->comp_arena()));

  compile->clone_map().set_clone_idx(0);

  compile->set_type_hwm(NULL);

  compile->set_type_last_size(0);

  compile->set_last_tf(NULL, NULL);

  compile->set_indexSet_arena(NULL);

  compile->set_indexSet_free_block_list(NULL);

  compile->init_type_arena();

  Type::Initialize(compile);

  _compile->set_scratch_buffer_blob(NULL);

  _compile->begin_method();

  _compile->clone_map().set_debug(_compile->has_method() && _compile->directive()->CloneMapDebugOption);

}

CompileWrapper::~CompileWrapper() {

  _compile->end_method();

  if (_compile->scratch_buffer_blob() != NULL)

    BufferBlob::free(_compile->scratch_buffer_blob());

  _compile->env()->set_compiler_data(NULL);

}

//----------------------------print_compile_messages---------------------------

void Compile::print_compile_messages() {

#ifndef PRODUCT

  // Check if recompiling

  if (_subsume_loads == false && PrintOpto) {

    // Recompiling without allowing machine instructions to subsume loads

    tty->print_cr("*********************************************************");

    tty->print_cr("** Bailout: Recompile without subsuming loads          **");

    tty->print_cr("*********************************************************");

  }

  if (_do_escape_analysis != DoEscapeAnalysis && PrintOpto) {

    // Recompiling without escape analysis

    tty->print_cr("*********************************************************");

    tty->print_cr("** Bailout: Recompile without escape analysis          **");

    tty->print_cr("*********************************************************");

  }

  if (_eliminate_boxing != EliminateAutoBox && PrintOpto) {

    // Recompiling without boxing elimination

    tty->print_cr("*********************************************************");

    tty->print_cr("** Bailout: Recompile without boxing elimination       **");

    tty->print_cr("*********************************************************");

  }

  if (C->directive()->BreakAtCompileOption) {

    // Open the debugger when compiling this method.

    tty->print("### Breaking when compiling: ");

    method()->print_short_name();

    tty->cr();

    BREAKPOINT;

  }

  if( PrintOpto ) {

    if (is_osr_compilation()) {

      tty->print("[OSR]%3d", _compile_id);

    } else {

      tty->print("%3d", _compile_id);

    }