/*

 * Copyright (c) 1997, 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.

 *

 */

#ifndef SHARE_VM_OPTO_COMPILE_HPP

#define SHARE_VM_OPTO_COMPILE_HPP

#include "asm/codeBuffer.hpp"

#include "ci/compilerInterface.hpp"

#include "code/debugInfoRec.hpp"

#include "code/exceptionHandlerTable.hpp"

#include "compiler/compilerOracle.hpp"

#include "libadt/dict.hpp"

#include "libadt/port.hpp"

#include "libadt/vectset.hpp"

#include "memory/resourceArea.hpp"

#include "opto/idealGraphPrinter.hpp"

#include "opto/phase.hpp"

#include "opto/regmask.hpp"

#include "runtime/deoptimization.hpp"

#include "runtime/vmThread.hpp"

class Block;

class Bundle;

class C2Compiler;

class CallGenerator;

class ConnectionGraph;

class InlineTree;

class Int_Array;

class Matcher;

class MachConstantNode;

class MachConstantBaseNode;

class MachNode;

class MachOper;

class MachSafePointNode;

class Node;

class Node_Array;

class Node_Notes;

class OptoReg;

class PhaseCFG;

class PhaseGVN;

class PhaseIterGVN;

class PhaseRegAlloc;

class PhaseCCP;

class PhaseCCP_DCE;

class RootNode;

class relocInfo;

class Scope;

class StartNode;

class SafePointNode;

class JVMState;

class TypeData;

class TypePtr;

class TypeFunc;

class Unique_Node_List;

class nmethod;

class WarmCallInfo;

//------------------------------Compile----------------------------------------

// This class defines a top-level Compiler invocation.

class Compile : public Phase {

 public:

  // Fixed alias indexes.  (See also MergeMemNode.)

  enum {

    AliasIdxTop = 1,  // pseudo-index, aliases to nothing (used as sentinel value)

    AliasIdxBot = 2,  // pseudo-index, aliases to everything

    AliasIdxRaw = 3   // hard-wired index for TypeRawPtr::BOTTOM

  };

  // Variant of TraceTime(NULL, &_t_accumulator, TimeCompiler);

  // Integrated with logging.  If logging is turned on, and dolog is true,

  // then brackets are put into the log, with time stamps and node counts.

  // (The time collection itself is always conditionalized on TimeCompiler.)

  class TracePhase : public TraceTime {

   private:

    Compile*    C;

    CompileLog* _log;

   public:

    TracePhase(const char* name, elapsedTimer* accumulator, bool dolog);

    ~TracePhase();

  };

  // Information per category of alias (memory slice)

  class AliasType {

   private:

    friend class Compile;

    int             _index;         // unique index, used with MergeMemNode

    const TypePtr*  _adr_type;      // normalized address type

    ciField*        _field;         // relevant instance field, or null if none

    bool            _is_rewritable; // false if the memory is write-once only

    int             _general_index; // if this is type is an instance, the general

                                    // type that this is an instance of

    void Init(int i, const TypePtr* at);

   public:

    int             index()         const { return _index; }

    const TypePtr*  adr_type()      const { return _adr_type; }

    ciField*        field()         const { return _field; }

    bool            is_rewritable() const { return _is_rewritable; }

    bool            is_volatile()   const { return (_field ? _field->is_volatile() : false); }

    int             general_index() const { return (_general_index != 0) ? _general_index : _index; }

    void set_rewritable(bool z) { _is_rewritable = z; }

    void set_field(ciField* f) {

      assert(!_field,"");

      _field = f;

      if (f->is_final())  _is_rewritable = false;

    }

    void print_on(outputStream* st) PRODUCT_RETURN;

  };

  enum {

    logAliasCacheSize = 6,

    AliasCacheSize = (1<<logAliasCacheSize)

  };

  struct AliasCacheEntry { const TypePtr* _adr_type; int _index; };  // simple duple type

  enum {

    trapHistLength = methodDataOopDesc::_trap_hist_limit

  };

  // Constant entry of the constant table.

  class Constant {

  private:

    BasicType _type;

    jvalue    _value;

    int       _offset;         // offset of this constant (in bytes) relative to the constant table base.

    bool      _can_be_reused;  // true (default) if the value can be shared with other users.

  public:

    Constant() : _type(T_ILLEGAL), _offset(-1), _can_be_reused(true) { _value.l = 0; }

    Constant(BasicType type, jvalue value, bool can_be_reused = true) :

      _type(type),

      _value(value),

      _offset(-1),

      _can_be_reused(can_be_reused)

    {}

    bool operator==(const Constant& other);

    BasicType type()      const    { return _type; }

    jlong   get_jlong()   const    { return _value.j; }

    jfloat  get_jfloat()  const    { return _value.f; }

    jdouble get_jdouble() const    { return _value.d; }

    jobject get_jobject() const    { return _value.l; }

    int         offset()  const    { return _offset; }

    void    set_offset(int offset) {        _offset = offset; }

    bool    can_be_reused() const  { return _can_be_reused; }

  };

  // Constant table.

  class ConstantTable {

  private:

    GrowableArray<Constant> _constants;          // Constants of this table.

    int                     _size;               // Size in bytes the emitted constant table takes (including padding).

    int                     _table_base_offset;  // Offset of the table base that gets added to the constant offsets.

  public:

    ConstantTable() :

      _size(-1),

      _table_base_offset(-1)  // We can use -1 here since the constant table is always bigger than 2 bytes (-(size / 2), see MachConstantBaseNode::emit).

    {}

    int size() const { assert(_size != -1, "size not yet calculated"); return _size; }

    void set_table_base_offset(int x)  { assert(_table_base_offset == -1, "set only once");                        _table_base_offset = x; }

    int      table_base_offset() const { assert(_table_base_offset != -1, "table base offset not yet set"); return _table_base_offset; }

    void emit(CodeBuffer& cb);

    // Returns the offset of the last entry (the top) of the constant table.

    int  top_offset() const { assert(_constants.top().offset() != -1, "constant not yet bound"); return _constants.top().offset(); }

    void calculate_offsets_and_size();

    int  find_offset(Constant& con) const;

    void     add(Constant& con);

    Constant add(BasicType type, jvalue value);

    Constant add(MachOper* oper);

    Constant add(jfloat f) {

      jvalue value; value.f = f;

      return add(T_FLOAT, value);

    }

    Constant add(jdouble d) {

      jvalue value; value.d = d;

      return add(T_DOUBLE, value);

    }

    // Jump table

    Constant allocate_jump_table(MachConstantNode* n);

    void         fill_jump_table(CodeBuffer& cb, MachConstantNode* n, GrowableArray<Label*> labels) const;

  };

 private:

  // Fixed parameters to this compilation.

  const int             _compile_id;

  const bool            _save_argument_registers; // save/restore arg regs for trampolines

  const bool            _subsume_loads;         // Load can be matched as part of a larger op.

  const bool            _do_escape_analysis;    // Do escape analysis.

  ciMethod*             _method;                // The method being compiled.

  int                   _entry_bci;             // entry bci for osr methods.

  const TypeFunc*       _tf;                    // My kind of signature

  InlineTree*           _ilt;                   // Ditto (temporary).

  address               _stub_function;         // VM entry for stub being compiled, or NULL

  const char*           _stub_name;             // Name of stub or adapter being compiled, or NULL

  address               _stub_entry_point;      // Compile code entry for generated stub, or NULL

  // Control of this compilation.

  int                   _num_loop_opts;         // Number of iterations for doing loop optimiztions

  int                   _max_inline_size;       // Max inline size for this compilation

  int                   _freq_inline_size;      // Max hot method inline size for this compilation

  int                   _fixed_slots;           // count of frame slots not allocated by the register

                                                // allocator i.e. locks, original deopt pc, etc.

  // For deopt

  int                   _orig_pc_slot;

  int                   _orig_pc_slot_offset_in_bytes;

  int                   _major_progress;        // Count of something big happening

  bool                  _has_loops;             // True if the method _may_ have some loops

  bool                  _has_split_ifs;         // True if the method _may_ have some split-if

  bool                  _has_unsafe_access;     // True if the method _may_ produce faults in unsafe loads or stores.

  bool                  _has_stringbuilder;     // True StringBuffers or StringBuilders are allocated

  uint                  _trap_hist[trapHistLength];  // Cumulative traps

  bool                  _trap_can_recompile;    // Have we emitted a recompiling trap?

  uint                  _decompile_count;       // Cumulative decompilation counts.

  bool                  _do_inlining;           // True if we intend to do inlining

  bool                  _do_scheduling;         // True if we intend to do scheduling

  bool                  _do_freq_based_layout;  // True if we intend to do frequency based block layout

  bool                  _do_count_invocations;  // True if we generate code to count invocations

  bool                  _do_method_data_update; // True if we generate code to update methodDataOops

  int                   _AliasLevel;            // Locally-adjusted version of AliasLevel flag.

  bool                  _print_assembly;        // True if we should dump assembly code for this compilation

#ifndef PRODUCT

  bool                  _trace_opto_output;

  bool                  _parsed_irreducible_loop; // True if ciTypeFlow detected irreducible loops during parsing

#endif

  // JSR 292

  bool                  _has_method_handle_invokes; // True if this method has MethodHandle invokes.

  // Compilation environment.

  Arena                 _comp_arena;            // Arena with lifetime equivalent to Compile

  ciEnv*                _env;                   // CI interface

  CompileLog*           _log;                   // from CompilerThread

  const char*           _failure_reason;        // for record_failure/failing pattern

  GrowableArray<CallGenerator*>* _intrinsics;   // List of intrinsics.

  GrowableArray<Node*>* _macro_nodes;           // List of nodes which need to be expanded before matching.

  GrowableArray<Node*>* _predicate_opaqs;       // List of Opaque1 nodes for the loop predicates.

  ConnectionGraph*      _congraph;

#ifndef PRODUCT

  IdealGraphPrinter*    _printer;

#endif

  // Node management

  uint                  _unique;                // Counter for unique Node indices

  debug_only(static int _debug_idx;)            // Monotonic counter (not reset), use -XX:BreakAtNode=<idx>

  Arena                 _node_arena;            // Arena for new-space Nodes

  Arena                 _old_arena;             // Arena for old-space Nodes, lifetime during xform

  RootNode*             _root;                  // Unique root of compilation, or NULL after bail-out.

  Node*                 _top;                   // Unique top node.  (Reset by various phases.)

  Node*                 _immutable_memory;      // Initial memory state

  Node*                 _recent_alloc_obj;

  Node*                 _recent_alloc_ctl;

  // Constant table

  ConstantTable         _constant_table;        // The constant table for this compile.

  MachConstantBaseNode* _mach_constant_base_node;  // Constant table base node singleton.

  // Blocked array of debugging and profiling information,

  // tracked per node.

  enum { _log2_node_notes_block_size = 8,

         _node_notes_block_size = (1<<_log2_node_notes_block_size)

  };

  GrowableArray<Node_Notes*>* _node_note_array;

  Node_Notes*           _default_node_notes;  // default notes for new nodes

  // After parsing and every bulk phase we hang onto the Root instruction.

  // The RootNode instruction is where the whole program begins.  It produces

  // the initial Control and BOTTOM for everybody else.

  // Type management

  Arena                 _Compile_types;         // Arena for all types

  Arena*                _type_arena;            // Alias for _Compile_types except in Initialize_shared()

  Dict*                 _type_dict;             // Intern table

  void*                 _type_hwm;              // Last allocation (see Type::operator new/delete)

  size_t                _type_last_size;        // Last allocation size (see Type::operator new/delete)

  ciMethod*             _last_tf_m;             // Cache for

  const TypeFunc*       _last_tf;               //  TypeFunc::make

  AliasType**           _alias_types;           // List of alias types seen so far.

  int                   _num_alias_types;       // Logical length of _alias_types

  int                   _max_alias_types;       // Physical length of _alias_types

  AliasCacheEntry       _alias_cache[AliasCacheSize]; // Gets aliases w/o data structure walking

  // Parsing, optimization

  PhaseGVN*             _initial_gvn;           // Results of parse-time PhaseGVN

  Unique_Node_List*     _for_igvn;              // Initial work-list for next round of Iterative GVN

  WarmCallInfo*         _warm_calls;            // Sorted work-list for heat-based inlining.

  GrowableArray<CallGenerator*> _late_inlines;  // List of CallGenerators to be revisited after

                                                // main parsing has finished.

  // Matching, CFG layout, allocation, code generation

  PhaseCFG*             _cfg;                   // Results of CFG finding

  bool                  _select_24_bit_instr;   // We selected an instruction with a 24-bit result

  bool                  _in_24_bit_fp_mode;     // We are emitting instructions with 24-bit results

  int                   _java_calls;            // Number of java calls in the method

  int                   _inner_loops;           // Number of inner loops in the method

  Matcher*              _matcher;               // Engine to map ideal to machine instructions

  PhaseRegAlloc*        _regalloc;              // Results of register allocation.

  int                   _frame_slots;           // Size of total frame in stack slots

  CodeOffsets           _code_offsets;          // Offsets into the code for various interesting entries

  RegMask               _FIRST_STACK_mask;      // All stack slots usable for spills (depends on frame layout)

  Arena*                _indexSet_arena;        // control IndexSet allocation within PhaseChaitin

  void*                 _indexSet_free_block_list; // free list of IndexSet bit blocks

  uint                  _node_bundling_limit;

  Bundle*               _node_bundling_base;    // Information for instruction bundling

  // Instruction bits passed off to the VM

  int                   _method_size;           // Size of nmethod code segment in bytes

  CodeBuffer            _code_buffer;           // Where the code is assembled

  int                   _first_block_size;      // Size of unvalidated entry point code / OSR poison code

  ExceptionHandlerTable _handler_table;         // Table of native-code exception handlers

  ImplicitExceptionTable _inc_table;            // Table of implicit null checks in native code

  OopMapSet*            _oop_map_set;           // Table of oop maps (one for each safepoint location)

  static int            _CompiledZap_count;     // counter compared against CompileZap[First/Last]

  BufferBlob*           _scratch_buffer_blob;   // For temporary code buffers.

  relocInfo*            _scratch_locs_memory;   // For temporary code buffers.

  int                   _scratch_const_size;    // For temporary code buffers.

  bool                  _in_scratch_emit_size;  // true when in scratch_emit_size.

 public:

  // Accessors

  // The Compile instance currently active in this (compiler) thread.

  static Compile* current() {

    return (Compile*) ciEnv::current()->compiler_data();

  }

  // ID for this compilation.  Useful for setting breakpoints in the debugger.

  int               compile_id() const          { return _compile_id; }

  // Does this compilation allow instructions to subsume loads?  User

  // instructions that subsume a load may result in an unschedulable

  // instruction sequence.

  bool              subsume_loads() const       { return _subsume_loads; }

  // Do escape analysis.

  bool              do_escape_analysis() const  { return _do_escape_analysis; }

  bool              save_argument_registers() const { return _save_argument_registers; }

  // Other fixed compilation parameters.

  ciMethod*         method() const              { return _method; }

  int               entry_bci() const           { return _entry_bci; }

  bool              is_osr_compilation() const  { return _entry_bci != InvocationEntryBci; }

  bool              is_method_compilation() const { return (_method != NULL && !_method->flags().is_native()); }

  const TypeFunc*   tf() const                  { assert(_tf!=NULL, ""); return _tf; }

  void         init_tf(const TypeFunc* tf)      { assert(_tf==NULL, ""); _tf = tf; }

  InlineTree*       ilt() const                 { return _ilt; }

  address           stub_function() const       { return _stub_function; }

  const char*       stub_name() const           { return _stub_name; }

  address           stub_entry_point() const    { return _stub_entry_point; }

  // Control of this compilation.

  int               fixed_slots() const         { assert(_fixed_slots >= 0, "");         return _fixed_slots; }

  void          set_fixed_slots(int n)          { _fixed_slots = n; }

  int               major_progress() const      { return _major_progress; }

  void          set_major_progress()            { _major_progress++; }

  void        clear_major_progress()            { _major_progress = 0; }

  int               num_loop_opts() const       { return _num_loop_opts; }

  void          set_num_loop_opts(int n)        { _num_loop_opts = n; }

  int               max_inline_size() const     { return _max_inline_size; }

  void          set_freq_inline_size(int n)     { _freq_inline_size = n; }

  int               freq_inline_size() const    { return _freq_inline_size; }

  void          set_max_inline_size(int n)      { _max_inline_size = n; }

  bool              has_loops() const           { return _has_loops; }

  void          set_has_loops(bool z)           { _has_loops = z; }

  bool              has_split_ifs() const       { return _has_split_ifs; }

  void          set_has_split_ifs(bool z)       { _has_split_ifs = z; }

  bool              has_unsafe_access() const   { return _has_unsafe_access; }

  void          set_has_unsafe_access(bool z)   { _has_unsafe_access = z; }

  bool              has_stringbuilder() const   { return _has_stringbuilder; }

  void          set_has_stringbuilder(bool z)   { _has_stringbuilder = z; }

  void          set_trap_count(uint r, uint c)  { assert(r < trapHistLength, "oob");        _trap_hist[r] = c; }

  uint              trap_count(uint r) const    { assert(r < trapHistLength, "oob"); return _trap_hist[r]; }

  bool              trap_can_recompile() const  { return _trap_can_recompile; }

  void          set_trap_can_recompile(bool z)  { _trap_can_recompile = z; }

  uint              decompile_count() const     { return _decompile_count; }

  void          set_decompile_count(uint c)     { _decompile_count = c; }

  bool              allow_range_check_smearing() const;

  bool              do_inlining() const         { return _do_inlining; }

  void          set_do_inlining(bool z)         { _do_inlining = z; }

  bool              do_scheduling() const       { return _do_scheduling; }

  void          set_do_scheduling(bool z)       { _do_scheduling = z; }

  bool              do_freq_based_layout() const{ return _do_freq_based_layout; }

  void          set_do_freq_based_layout(bool z){ _do_freq_based_layout = z; }

  bool              do_count_invocations() const{ return _do_count_invocations; }

  void          set_do_count_invocations(bool z){ _do_count_invocations = z; }

  bool              do_method_data_update() const { return _do_method_data_update; }

  void          set_do_method_data_update(bool z) { _do_method_data_update = z; }

  int               AliasLevel() const          { return _AliasLevel; }

  bool              print_assembly() const       { return _print_assembly; }

  void          set_print_assembly(bool z)       { _print_assembly = z; }

  // check the CompilerOracle for special behaviours for this compile

  bool          method_has_option(const char * option) {

    return method() != NULL && method()->has_option(option);

  }

#ifndef PRODUCT

  bool          trace_opto_output() const       { return _trace_opto_output; }

  bool              parsed_irreducible_loop() const { return _parsed_irreducible_loop; }

  void          set_parsed_irreducible_loop(bool z) { _parsed_irreducible_loop = z; }

#endif

  // JSR 292

  bool              has_method_handle_invokes() const { return _has_method_handle_invokes;     }

  void          set_has_method_handle_invokes(bool z) {        _has_method_handle_invokes = z; }

  void begin_method() {

#ifndef PRODUCT

    if (_printer) _printer->begin_method(this);

#endif

  }

  void print_method(const char * name, int level = 1) {

#ifndef PRODUCT

    if (_printer) _printer->print_method(this, name, level);

#endif

  }

  void end_method() {

#ifndef PRODUCT

    if (_printer) _printer->end_method();

#endif

  }

  int           macro_count()                   { return _macro_nodes->length(); }

  int           predicate_count()               { return _predicate_opaqs->length();}

  Node*         macro_node(int idx)             { return _macro_nodes->at(idx); }

  Node*         predicate_opaque1_node(int idx) { return _predicate_opaqs->at(idx);}

  ConnectionGraph* congraph()                   { return _congraph;}

  void set_congraph(ConnectionGraph* congraph)  { _congraph = congraph;}

  void add_macro_node(Node * n) {

    //assert(n->is_macro(), "must be a macro node");

    assert(!_macro_nodes->contains(n), " duplicate entry in expand list");

    _macro_nodes->append(n);

  }

  void remove_macro_node(Node * n) {

    // this function may be called twice for a node so check

    // that the node is in the array before attempting to remove it

    if (_macro_nodes->contains(n))

      _macro_nodes->remove(n);

    // remove from _predicate_opaqs list also if it is there

    if (predicate_count() > 0 && _predicate_opaqs->contains(n)){

      _predicate_opaqs->remove(n);

    }

  }

  void add_predicate_opaq(Node * n) {

    assert(!_predicate_opaqs->contains(n), " duplicate entry in predicate opaque1");

    assert(_macro_nodes->contains(n), "should have already been in macro list");

    _predicate_opaqs->append(n);

  }

  // remove the opaque nodes that protect the predicates so that the unused checks and

  // uncommon traps will be eliminated from the graph.

  void cleanup_loop_predicates(PhaseIterGVN &igvn);

  bool is_predicate_opaq(Node * n) {

    return _predicate_opaqs->contains(n);

  }

  // Compilation environment.

  Arena*            comp_arena()                { return &_comp_arena; }

  ciEnv*            env() const                 { return _env; }

  CompileLog*       log() const                 { return _log; }

  bool              failing() const             { return _env->failing() || _failure_reason != NULL; }

  const char* failure_reason() { return _failure_reason; }

  bool              failure_reason_is(const char* r) { return (r==_failure_reason) || (r!=NULL && _failure_reason!=NULL && strcmp(r, _failure_reason)==0); }

  void record_failure(const char* reason);

  void record_method_not_compilable(const char* reason, bool all_tiers = false) {

    // All bailouts cover "all_tiers" when TieredCompilation is off.

    if (!TieredCompilation) all_tiers = true;

    env()->record_method_not_compilable(reason, all_tiers);

    // Record failure reason.

    record_failure(reason);

  }

  void record_method_not_compilable_all_tiers(const char* reason) {

    record_method_not_compilable(reason, true);

  }

  bool check_node_count(uint margin, const char* reason) {