/*

 * 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_OOPS_METHODDATAOOP_HPP

#define SHARE_VM_OOPS_METHODDATAOOP_HPP

#include "interpreter/bytecodes.hpp"

#include "memory/universe.hpp"

#include "oops/method.hpp"

#include "oops/oop.hpp"

#include "utilities/align.hpp"

#if INCLUDE_JVMCI

#include "jvmci/jvmci_globals.hpp"

#endif

class BytecodeStream;

class KlassSizeStats;

// The MethodData object collects counts and other profile information

// during zeroth-tier (interpretive) and first-tier execution.

// The profile is used later by compilation heuristics.  Some heuristics

// enable use of aggressive (or "heroic") optimizations.  An aggressive

// optimization often has a down-side, a corner case that it handles

// poorly, but which is thought to be rare.  The profile provides

// evidence of this rarity for a given method or even BCI.  It allows

// the compiler to back out of the optimization at places where it

// has historically been a poor choice.  Other heuristics try to use

// specific information gathered about types observed at a given site.

//

// All data in the profile is approximate.  It is expected to be accurate

// on the whole, but the system expects occasional inaccuraces, due to

// counter overflow, multiprocessor races during data collection, space

// limitations, missing MDO blocks, etc.  Bad or missing data will degrade

// optimization quality but will not affect correctness.  Also, each MDO

// is marked with its birth-date ("creation_mileage") which can be used

// to assess the quality ("maturity") of its data.

//

// Short (<32-bit) counters are designed to overflow to a known "saturated"

// state.  Also, certain recorded per-BCI events are given one-bit counters

// which overflow to a saturated state which applied to all counters at

// that BCI.  In other words, there is a small lattice which approximates

// the ideal of an infinite-precision counter for each event at each BCI,

// and the lattice quickly "bottoms out" in a state where all counters

// are taken to be indefinitely large.

//

// The reader will find many data races in profile gathering code, starting

// with invocation counter incrementation.  None of these races harm correct

// execution of the compiled code.

// forward decl

class ProfileData;

// DataLayout

//

// Overlay for generic profiling data.

class DataLayout VALUE_OBJ_CLASS_SPEC {

  friend class VMStructs;

  friend class JVMCIVMStructs;

private:

  // Every data layout begins with a header.  This header

  // contains a tag, which is used to indicate the size/layout

  // of the data, 4 bits of flags, which can be used in any way,

  // 4 bits of trap history (none/one reason/many reasons),

  // and a bci, which is used to tie this piece of data to a

  // specific bci in the bytecodes.

  union {

    intptr_t _bits;

    struct {

      u1 _tag;

      u1 _flags;

      u2 _bci;

    } _struct;

  } _header;

  // The data layout has an arbitrary number of cells, each sized

  // to accomodate a pointer or an integer.

  intptr_t _cells[1];

  // Some types of data layouts need a length field.

  static bool needs_array_len(u1 tag);

public:

  enum {

    counter_increment = 1

  };

  enum {

    cell_size = sizeof(intptr_t)

  };

  // Tag values

  enum {

    no_tag,

    bit_data_tag,

    counter_data_tag,

    jump_data_tag,

    receiver_type_data_tag,

    virtual_call_data_tag,

    ret_data_tag,

    branch_data_tag,

    multi_branch_data_tag,

    arg_info_data_tag,

    call_type_data_tag,

    virtual_call_type_data_tag,

    parameters_type_data_tag,

    speculative_trap_data_tag

  };

  enum {

    // The _struct._flags word is formatted as [trap_state:4 | flags:4].

    // The trap state breaks down further as [recompile:1 | reason:3].

    // This further breakdown is defined in deoptimization.cpp.

    // See Deoptimization::trap_state_reason for an assert that

    // trap_bits is big enough to hold reasons < Reason_RECORDED_LIMIT.

    //

    // The trap_state is collected only if ProfileTraps is true.

    trap_bits = 1+3,  // 3: enough to distinguish [0..Reason_RECORDED_LIMIT].

    trap_shift = BitsPerByte - trap_bits,

    trap_mask = right_n_bits(trap_bits),

    trap_mask_in_place = (trap_mask << trap_shift),

    flag_limit = trap_shift,

    flag_mask = right_n_bits(flag_limit),

    first_flag = 0

  };

  // Size computation

  static int header_size_in_bytes() {

    return cell_size;

  }

  static int header_size_in_cells() {

    return 1;

  }

  static int compute_size_in_bytes(int cell_count) {

    return header_size_in_bytes() + cell_count * cell_size;

  }

  // Initialization

  void initialize(u1 tag, u2 bci, int cell_count);

  // Accessors

  u1 tag() {

    return _header._struct._tag;

  }

  // Return a few bits of trap state.  Range is [0..trap_mask].

  // The state tells if traps with zero, one, or many reasons have occurred.

  // It also tells whether zero or many recompilations have occurred.

  // The associated trap histogram in the MDO itself tells whether

  // traps are common or not.  If a BCI shows that a trap X has

  // occurred, and the MDO shows N occurrences of X, we make the

  // simplifying assumption that all N occurrences can be blamed

  // on that BCI.

  int trap_state() const {

    return ((_header._struct._flags >> trap_shift) & trap_mask);

  }

  void set_trap_state(int new_state) {

    assert(ProfileTraps, "used only under +ProfileTraps");

    uint old_flags = (_header._struct._flags & flag_mask);

    _header._struct._flags = (new_state << trap_shift) | old_flags;

  }

  u1 flags() const {

    return _header._struct._flags;

  }

  u2 bci() const {

    return _header._struct._bci;

  }

  void set_header(intptr_t value) {

    _header._bits = value;

  }

  intptr_t header() {

    return _header._bits;

  }

  void set_cell_at(int index, intptr_t value) {

    _cells[index] = value;

  }

  intptr_t cell_at(int index) const {

    return _cells[index];

  }

  void set_flag_at(int flag_number) {

    assert(flag_number < flag_limit, "oob");

    _header._struct._flags |= (0x1 << flag_number);

  }

  bool flag_at(int flag_number) const {

    assert(flag_number < flag_limit, "oob");

    return (_header._struct._flags & (0x1 << flag_number)) != 0;

  }

  // Low-level support for code generation.

  static ByteSize header_offset() {

    return byte_offset_of(DataLayout, _header);

  }

  static ByteSize tag_offset() {

    return byte_offset_of(DataLayout, _header._struct._tag);

  }

  static ByteSize flags_offset() {

    return byte_offset_of(DataLayout, _header._struct._flags);

  }

  static ByteSize bci_offset() {

    return byte_offset_of(DataLayout, _header._struct._bci);

  }

  static ByteSize cell_offset(int index) {

    return byte_offset_of(DataLayout, _cells) + in_ByteSize(index * cell_size);

  }

#ifdef CC_INTERP

  static int cell_offset_in_bytes(int index) {

    return (int)offset_of(DataLayout, _cells[index]);

  }

#endif // CC_INTERP

  // Return a value which, when or-ed as a byte into _flags, sets the flag.

  static int flag_number_to_byte_constant(int flag_number) {

    assert(0 <= flag_number && flag_number < flag_limit, "oob");

    DataLayout temp; temp.set_header(0);

    temp.set_flag_at(flag_number);

    return temp._header._struct._flags;

  }

  // Return a value which, when or-ed as a word into _header, sets the flag.

  static intptr_t flag_mask_to_header_mask(int byte_constant) {

    DataLayout temp; temp.set_header(0);

    temp._header._struct._flags = byte_constant;

    return temp._header._bits;

  }

  ProfileData* data_in();

  // GC support

  void clean_weak_klass_links(BoolObjectClosure* cl);

  // Redefinition support

  void clean_weak_method_links();

  DEBUG_ONLY(void verify_clean_weak_method_links();)

};

// ProfileData class hierarchy

class ProfileData;

class   BitData;

class     CounterData;

class       ReceiverTypeData;

class         VirtualCallData;

class           VirtualCallTypeData;

class       RetData;

class       CallTypeData;

class   JumpData;

class     BranchData;

class   ArrayData;

class     MultiBranchData;

class     ArgInfoData;

class     ParametersTypeData;

class   SpeculativeTrapData;

// ProfileData

//

// A ProfileData object is created to refer to a section of profiling

// data in a structured way.

class ProfileData : public ResourceObj {

  friend class TypeEntries;

  friend class ReturnTypeEntry;

  friend class TypeStackSlotEntries;

private:

  enum {

    tab_width_one = 16,

    tab_width_two = 36

  };

  // This is a pointer to a section of profiling data.

  DataLayout* _data;

  char* print_data_on_helper(const MethodData* md) const;

protected:

  DataLayout* data() { return _data; }

  const DataLayout* data() const { return _data; }

  enum {

    cell_size = DataLayout::cell_size

  };

public:

  // How many cells are in this?

  virtual int cell_count() const {

    ShouldNotReachHere();

    return -1;

  }

  // Return the size of this data.

  int size_in_bytes() {

    return DataLayout::compute_size_in_bytes(cell_count());

  }

protected:

  // Low-level accessors for underlying data

  void set_intptr_at(int index, intptr_t value) {

    assert(0 <= index && index < cell_count(), "oob");

    data()->set_cell_at(index, value);

  }

  intptr_t intptr_at(int index) const {

    assert(0 <= index && index < cell_count(), "oob");

    return data()->cell_at(index);

  }

  void set_uint_at(int index, uint value) {

    set_intptr_at(index, (intptr_t) value);

  }

  uint uint_at(int index) const {

    return (uint)intptr_at(index);

  }

  void set_int_at(int index, int value) {

    set_intptr_at(index, (intptr_t) value);

  }

  int int_at(int index) const {

    return (int)intptr_at(index);

  }

  int int_at_unchecked(int index) const {

    return (int)data()->cell_at(index);

  }

  void set_oop_at(int index, oop value) {

    set_intptr_at(index, cast_from_oop<intptr_t>(value));

  }

  oop oop_at(int index) const {

    return cast_to_oop(intptr_at(index));

  }

  void set_flag_at(int flag_number) {

    data()->set_flag_at(flag_number);

  }

  bool flag_at(int flag_number) const {

    return data()->flag_at(flag_number);

  }

  // two convenient imports for use by subclasses:

  static ByteSize cell_offset(int index) {

    return DataLayout::cell_offset(index);

  }

  static int flag_number_to_byte_constant(int flag_number) {

    return DataLayout::flag_number_to_byte_constant(flag_number);

  }

  ProfileData(DataLayout* data) {

    _data = data;

  }

#ifdef CC_INTERP

  // Static low level accessors for DataLayout with ProfileData's semantics.

  static int cell_offset_in_bytes(int index) {

    return DataLayout::cell_offset_in_bytes(index);

  }

  static void increment_uint_at_no_overflow(DataLayout* layout, int index,

                                            int inc = DataLayout::counter_increment) {

    uint count = ((uint)layout->cell_at(index)) + inc;

    if (count == 0) return;

    layout->set_cell_at(index, (intptr_t) count);

  }

  static int int_at(DataLayout* layout, int index) {

    return (int)layout->cell_at(index);

  }

  static int uint_at(DataLayout* layout, int index) {

    return (uint)layout->cell_at(index);

  }

  static oop oop_at(DataLayout* layout, int index) {

    return cast_to_oop(layout->cell_at(index));

  }

  static void set_intptr_at(DataLayout* layout, int index, intptr_t value) {

    layout->set_cell_at(index, (intptr_t) value);

  }

  static void set_flag_at(DataLayout* layout, int flag_number) {

    layout->set_flag_at(flag_number);

  }

#endif // CC_INTERP

public:

  // Constructor for invalid ProfileData.

  ProfileData();

  u2 bci() const {

    return data()->bci();

  }

  address dp() {

    return (address)_data;

  }

  int trap_state() const {

    return data()->trap_state();

  }

  void set_trap_state(int new_state) {

    data()->set_trap_state(new_state);

  }

  // Type checking

  virtual bool is_BitData()         const { return false; }

  virtual bool is_CounterData()     const { return false; }

  virtual bool is_JumpData()        const { return false; }

  virtual bool is_ReceiverTypeData()const { return false; }

  virtual bool is_VirtualCallData() const { return false; }

  virtual bool is_RetData()         const { return false; }

  virtual bool is_BranchData()      const { return false; }

  virtual bool is_ArrayData()       const { return false; }

  virtual bool is_MultiBranchData() const { return false; }

  virtual bool is_ArgInfoData()     const { return false; }

  virtual bool is_CallTypeData()    const { return false; }

  virtual bool is_VirtualCallTypeData()const { return false; }

  virtual bool is_ParametersTypeData() const { return false; }

  virtual bool is_SpeculativeTrapData()const { return false; }

  BitData* as_BitData() const {

    assert(is_BitData(), "wrong type");

    return is_BitData()         ? (BitData*)        this : NULL;

  }

  CounterData* as_CounterData() const {

    assert(is_CounterData(), "wrong type");

    return is_CounterData()     ? (CounterData*)    this : NULL;

  }

  JumpData* as_JumpData() const {

    assert(is_JumpData(), "wrong type");

    return is_JumpData()        ? (JumpData*)       this : NULL;

  }

  ReceiverTypeData* as_ReceiverTypeData() const {

    assert(is_ReceiverTypeData(), "wrong type");

    return is_ReceiverTypeData() ? (ReceiverTypeData*)this : NULL;

  }

  VirtualCallData* as_VirtualCallData() const {

    assert(is_VirtualCallData(), "wrong type");

    return is_VirtualCallData() ? (VirtualCallData*)this : NULL;

  }

  RetData* as_RetData() const {

    assert(is_RetData(), "wrong type");

    return is_RetData()         ? (RetData*)        this : NULL;

  }

  BranchData* as_BranchData() const {

    assert(is_BranchData(), "wrong type");

    return is_BranchData()      ? (BranchData*)     this : NULL;

  }

  ArrayData* as_ArrayData() const {

    assert(is_ArrayData(), "wrong type");

    return is_ArrayData()       ? (ArrayData*)      this : NULL;

  }

  MultiBranchData* as_MultiBranchData() const {

    assert(is_MultiBranchData(), "wrong type");

    return is_MultiBranchData() ? (MultiBranchData*)this : NULL;

  }

  ArgInfoData* as_ArgInfoData() const {

    assert(is_ArgInfoData(), "wrong type");

    return is_ArgInfoData() ? (ArgInfoData*)this : NULL;

  }

  CallTypeData* as_CallTypeData() const {

    assert(is_CallTypeData(), "wrong type");

    return is_CallTypeData() ? (CallTypeData*)this : NULL;

  }

  VirtualCallTypeData* as_VirtualCallTypeData() const {

    assert(is_VirtualCallTypeData(), "wrong type");

    return is_VirtualCallTypeData() ? (VirtualCallTypeData*)this : NULL;

  }

  ParametersTypeData* as_ParametersTypeData() const {

    assert(is_ParametersTypeData(), "wrong type");

    return is_ParametersTypeData() ? (ParametersTypeData*)this : NULL;

  }

  SpeculativeTrapData* as_SpeculativeTrapData() const {

    assert(is_SpeculativeTrapData(), "wrong type");

    return is_SpeculativeTrapData() ? (SpeculativeTrapData*)this : NULL;

  }

  // Subclass specific initialization

  virtual void post_initialize(BytecodeStream* stream, MethodData* mdo) {}

  // GC support

  virtual void clean_weak_klass_links(BoolObjectClosure* is_alive_closure) {}

  // Redefinition support

  virtual void clean_weak_method_links() {}

  DEBUG_ONLY(virtual void verify_clean_weak_method_links() {})