/*

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

#define SHARE_OPTO_COMPILE_HPP

#include "asm/codeBuffer.hpp"

#include "ci/compilerInterface.hpp"

#include "code/debugInfoRec.hpp"

#include "code/exceptionHandlerTable.hpp"

#include "compiler/compilerOracle.hpp"

#include "compiler/compileBroker.hpp"

#include "libadt/dict.hpp"

#include "libadt/vectset.hpp"

#include "jfr/jfrEvents.hpp"

#include "memory/resourceArea.hpp"

#include "oops/methodData.hpp"

#include "opto/idealGraphPrinter.hpp"

#include "opto/phasetype.hpp"

#include "opto/phase.hpp"

#include "opto/regmask.hpp"

#include "runtime/deoptimization.hpp"

#include "runtime/timerTrace.hpp"

#include "runtime/vmThread.hpp"

#include "utilities/ticks.hpp"

class AddPNode;

class Block;

class Bundle;

class C2Compiler;

class CallGenerator;

class CloneMap;

class ConnectionGraph;

class IdealGraphPrinter;

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 NodeCloneInfo;

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 Type;

class TypeData;

class TypeInt;

class TypePtr;

class TypeOopPtr;

class TypeFunc;

class Unique_Node_List;

class nmethod;

class WarmCallInfo;

class Node_Stack;

struct Final_Reshape_Counts;

enum LoopOptsMode {

  LoopOptsDefault,

  LoopOptsNone,

  LoopOptsShenandoahExpand,

  LoopOptsShenandoahPostExpand,

  LoopOptsSkipSplitIf,

  LoopOptsVerify

};

typedef unsigned int node_idx_t;

class NodeCloneInfo {

 private:

  uint64_t _idx_clone_orig;

 public:

  void set_idx(node_idx_t idx) {

    _idx_clone_orig = (_idx_clone_orig & CONST64(0xFFFFFFFF00000000)) | idx;

  }

  node_idx_t idx() const { return (node_idx_t)(_idx_clone_orig & 0xFFFFFFFF); }

  void set_gen(int generation) {

    uint64_t g = (uint64_t)generation << 32;

    _idx_clone_orig = (_idx_clone_orig & 0xFFFFFFFF) | g;

  }

  int gen() const { return (int)(_idx_clone_orig >> 32); }

  void set(uint64_t x) { _idx_clone_orig = x; }

  void set(node_idx_t x, int g) { set_idx(x); set_gen(g); }

  uint64_t get() const { return _idx_clone_orig; }

  NodeCloneInfo(uint64_t idx_clone_orig) : _idx_clone_orig(idx_clone_orig) {}

  NodeCloneInfo(node_idx_t x, int g) : _idx_clone_orig(0) { set(x, g); }

  void dump() const;

};

class CloneMap {

  friend class Compile;

 private:

  bool      _debug;

  Dict*     _dict;

  int       _clone_idx;   // current cloning iteration/generation in loop unroll

 public:

  void*     _2p(node_idx_t key)   const          { return (void*)(intptr_t)key; } // 2 conversion functions to make gcc happy

  node_idx_t _2_node_idx_t(const void* k) const  { return (node_idx_t)(intptr_t)k; }

  Dict*     dict()                const          { return _dict; }

  void insert(node_idx_t key, uint64_t val)      { assert(_dict->operator[](_2p(key)) == NULL, "key existed"); _dict->Insert(_2p(key), (void*)val); }

  void insert(node_idx_t key, NodeCloneInfo& ci) { insert(key, ci.get()); }

  void remove(node_idx_t key)                    { _dict->Delete(_2p(key)); }

  uint64_t value(node_idx_t key)  const          { return (uint64_t)_dict->operator[](_2p(key)); }

  node_idx_t idx(node_idx_t key)  const          { return NodeCloneInfo(value(key)).idx(); }

  int gen(node_idx_t key)         const          { return NodeCloneInfo(value(key)).gen(); }

  int gen(const void* k)          const          { return gen(_2_node_idx_t(k)); }

  int max_gen()                   const;

  void clone(Node* old, Node* nnn, int gen);

  void verify_insert_and_clone(Node* old, Node* nnn, int gen);

  void dump(node_idx_t key)       const;

  int  clone_idx() const                         { return _clone_idx; }

  void set_clone_idx(int x)                      { _clone_idx = x; }

  bool is_debug()                 const          { return _debug; }

  void set_debug(bool debug)                     { _debug = debug; }

  static const char* debug_option_name;

  bool same_idx(node_idx_t k1, node_idx_t k2)  const { return idx(k1) == idx(k2); }

  bool same_gen(node_idx_t k1, node_idx_t k2)  const { return gen(k1) == gen(k2); }

};

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

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

class Compile : public Phase {

  friend class VMStructs;

 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, CITime);

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

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

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

  class TracePhase : public TraceTime {

   private:

    Compile*    C;

    CompileLog* _log;

    const char* _phase_name;

    bool _dolog;

   public:

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

    ~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

    const Type*     _element;       // relevant array element type, 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; }

    const Type*     element()       const { return _element; }

    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() || f->is_stable()) {

        // In the case of @Stable, multiple writes are possible but may be assumed to be no-ops.

        _is_rewritable = false;

      }

    }

    void set_element(const Type* e) {

      assert(_element == NULL, "");

      _element = e;

    }

    BasicType basic_type() const;

    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 = MethodData::_trap_hist_limit

  };

  // Constant entry of the constant table.

  class Constant {

  private:

    BasicType _type;

    union {

      jvalue    _value;

      Metadata* _metadata;

    } _v;

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

    float     _freq;

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

  public:

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

    Constant(BasicType type, jvalue value, float freq = 0.0f, bool can_be_reused = true) :

      _type(type),

      _offset(-1),

      _freq(freq),

      _can_be_reused(can_be_reused)

    {

      assert(type != T_METADATA, "wrong constructor");

      _v._value = value;

    }

    Constant(Metadata* metadata, bool can_be_reused = true) :

      _type(T_METADATA),

      _offset(-1),

      _freq(0.0f),

      _can_be_reused(can_be_reused)

    {

      _v._metadata = metadata;

    }

    bool operator==(const Constant& other);

    BasicType type()      const    { return _type; }

    jint    get_jint()    const    { return _v._value.i; }

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

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

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

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

    Metadata* get_metadata() const { return _v._metadata; }

    int         offset()  const    { return _offset; }

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

    float       freq()    const    { return _freq;         }

    void    inc_freq(float freq)   {        _freq += freq; }

    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.

    int                     _nof_jump_tables;    // Number of jump-tables in this constant table.

    static int qsort_comparator(Constant* a, Constant* b);

    // We use negative frequencies to keep the order of the

    // jump-tables in which they were added.  Otherwise we get into

    // trouble with relocation.

    float next_jump_table_freq() { return -1.0f * (++_nof_jump_tables); }

  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).

      _nof_jump_tables(0)

    {}

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

    int calculate_table_base_offset() const;  // AD specific

    void set_table_base_offset(int x)  { assert(_table_base_offset == -1 || x == _table_base_offset, "can't change"); _table_base_offset = x; }

    int      table_base_offset() const { assert(_table_base_offset != -1, "not set yet");                      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, "not bound yet"); return _constants.top().offset(); }

    void calculate_offsets_and_size();

    int  find_offset(Constant& con) const;

    void     add(Constant& con);

    Constant add(MachConstantNode* n, BasicType type, jvalue value);

    Constant add(Metadata* metadata);

    Constant add(MachConstantNode* n, MachOper* oper);

    Constant add(MachConstantNode* n, jint i) {

      jvalue value; value.i = i;

      return add(n, T_INT, value);

    }

    Constant add(MachConstantNode* n, jlong j) {

      jvalue value; value.j = j;

      return add(n, T_LONG, value);

    }

    Constant add(MachConstantNode* n, jfloat f) {

      jvalue value; value.f = f;

      return add(n, T_FLOAT, value);

    }

    Constant add(MachConstantNode* n, jdouble d) {

      jvalue value; value.d = d;

      return add(n, T_DOUBLE, value);

    }

    // Jump-table

    Constant  add_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.

  const bool            _eliminate_boxing;      // Do boxing elimination.

  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                   _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.

  uintx                 _max_node_limit;        // Max unique node count during a single compilation.

  // For deopt

  int                   _orig_pc_slot;

  int                   _orig_pc_slot_offset_in_bytes;

  int                   _major_progress;        // Count of something big happening

  bool                  _inlining_progress;     // progress doing incremental inlining?

  bool                  _inlining_incrementally;// Are we doing incremental inlining (post parse)

  bool                  _do_cleanup;            // Cleanup is needed before proceeding with incremental inlining

  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

  bool                  _has_boxed_value;       // True if a boxed object is allocated

  bool                  _has_reserved_stack_access; // True if the method or an inlined method is annotated with ReservedStackAccess

  uint                  _max_vector_size;       // Maximum size of generated vectors

  bool                  _clear_upper_avx;       // Clear upper bits of ymm registers using vzeroupper

  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 MethodData*s

  bool                  _do_vector_loop;        // True if allowed to execute loop in parallel iterations

  bool                  _use_cmove;             // True if CMove should be used without profitability analysis

  bool                  _age_code;              // True if we need to profile code age (decrement the aging counter)

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

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

  bool                  _print_inlining;        // True if we should print inlining for this compilation

  bool                  _print_intrinsics;      // True if we should print intrinsics for this compilation

#ifndef PRODUCT

  bool                  _trace_opto_output;

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

#endif

  bool                  _has_irreducible_loop;  // Found irreducible loops

  // JSR 292

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

  RTMState              _rtm_state;             // State of Restricted Transactional Memory usage

  int                   _loop_opts_cnt;         // loop opts round

  bool                  _clinit_barrier_on_entry; // True if clinit barrier is needed on nmethod entry

  // Compilation environment.

  Arena                 _comp_arena;            // Arena with lifetime equivalent to Compile

  void*                 _barrier_set_state;     // Potential GC barrier state for Compile

  ciEnv*                _env;                   // CI interface

  DirectiveSet*         _directive;             // Compiler directive

  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.

  GrowableArray<Node*>* _expensive_nodes;       // List of nodes that are expensive to compute and that we'd better not let the GVN freely common

  GrowableArray<Node*>* _range_check_casts;     // List of CastII nodes with a range check dependency

  GrowableArray<Node*>* _opaque4_nodes;         // List of Opaque4 nodes that have a default value

  ConnectionGraph*      _congraph;

#ifndef PRODUCT

  IdealGraphPrinter*    _printer;

#endif

  // Node management

  uint                  _unique;                // Counter for unique Node indices

  VectorSet             _dead_node_list;        // Set of dead nodes

  uint                  _dead_node_count;       // Number of dead nodes; VectorSet::Size() is O(N).

                                                // So use this to keep count and make the call O(1).

  DEBUG_ONLY( Unique_Node_List* _modified_nodes; )  // List of nodes which inputs were modified

  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

  CloneMap              _clone_map;             // used for recording history of cloned nodes

  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.

  GrowableArray<CallGenerator*> _string_late_inlines; // same but for string operations

  GrowableArray<CallGenerator*> _boxing_late_inlines; // same but for boxing operations