/*

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

#define SHARE_OPTO_CALLNODE_HPP

#include "opto/connode.hpp"

#include "opto/mulnode.hpp"

#include "opto/multnode.hpp"

#include "opto/opcodes.hpp"

#include "opto/phaseX.hpp"

#include "opto/replacednodes.hpp"

#include "opto/type.hpp"

// Portions of code courtesy of Clifford Click

// Optimization - Graph Style

class Chaitin;

class NamedCounter;

class MultiNode;

class  SafePointNode;

class   CallNode;

class     CallJavaNode;

class       CallStaticJavaNode;

class       CallDynamicJavaNode;

class     CallRuntimeNode;

class       CallLeafNode;

class         CallLeafNoFPNode;

class     AllocateNode;

class       AllocateArrayNode;

class     BoxLockNode;

class     LockNode;

class     UnlockNode;

class JVMState;

class OopMap;

class State;

class StartNode;

class MachCallNode;

class FastLockNode;

//------------------------------StartNode--------------------------------------

// The method start node

class StartNode : public MultiNode {

  virtual bool cmp( const Node &n ) const;

  virtual uint size_of() const; // Size is bigger

public:

  const TypeTuple *_domain;

  StartNode( Node *root, const TypeTuple *domain ) : MultiNode(2), _domain(domain) {

    init_class_id(Class_Start);

    init_req(0,this);

    init_req(1,root);

  }

  virtual int Opcode() const;

  virtual bool pinned() const { return true; };

  virtual const Type *bottom_type() const;

  virtual const TypePtr *adr_type() const { return TypePtr::BOTTOM; }

  virtual const Type* Value(PhaseGVN* phase) const;

  virtual Node *Ideal(PhaseGVN *phase, bool can_reshape);

  virtual void  calling_convention( BasicType* sig_bt, VMRegPair *parm_reg, uint length ) const;

  virtual const RegMask &in_RegMask(uint) const;

  virtual Node *match( const ProjNode *proj, const Matcher *m );

  virtual uint ideal_reg() const { return 0; }

#ifndef PRODUCT

  virtual void  dump_spec(outputStream *st) const;

  virtual void  dump_compact_spec(outputStream *st) const;

#endif

};

//------------------------------StartOSRNode-----------------------------------

// The method start node for on stack replacement code

class StartOSRNode : public StartNode {

public:

  StartOSRNode( Node *root, const TypeTuple *domain ) : StartNode(root, domain) {}

  virtual int   Opcode() const;

  static  const TypeTuple *osr_domain();

};

//------------------------------ParmNode---------------------------------------

// Incoming parameters

class ParmNode : public ProjNode {

  static const char * const names[TypeFunc::Parms+1];

public:

  ParmNode( StartNode *src, uint con ) : ProjNode(src,con) {

    init_class_id(Class_Parm);

  }

  virtual int Opcode() const;

  virtual bool  is_CFG() const { return (_con == TypeFunc::Control); }

  virtual uint ideal_reg() const;

#ifndef PRODUCT

  virtual void dump_spec(outputStream *st) const;

  virtual void dump_compact_spec(outputStream *st) const;

  virtual void related(GrowableArray<Node*> *in_rel, GrowableArray<Node*> *out_rel, bool compact) const;

#endif

};

//------------------------------ReturnNode-------------------------------------

// Return from subroutine node

class ReturnNode : public Node {

public:

  ReturnNode( uint edges, Node *cntrl, Node *i_o, Node *memory, Node *retadr, Node *frameptr );

  virtual int Opcode() const;

  virtual bool  is_CFG() const { return true; }

  virtual uint hash() const { return NO_HASH; }  // CFG nodes do not hash

  virtual bool depends_only_on_test() const { return false; }

  virtual Node *Ideal(PhaseGVN *phase, bool can_reshape);

  virtual const Type* Value(PhaseGVN* phase) const;

  virtual uint ideal_reg() const { return NotAMachineReg; }

  virtual uint match_edge(uint idx) const;

#ifndef PRODUCT

  virtual void dump_req(outputStream *st = tty) const;

#endif

};

//------------------------------RethrowNode------------------------------------

// Rethrow of exception at call site.  Ends a procedure before rethrowing;

// ends the current basic block like a ReturnNode.  Restores registers and

// unwinds stack.  Rethrow happens in the caller's method.

class RethrowNode : public Node {

 public:

  RethrowNode( Node *cntrl, Node *i_o, Node *memory, Node *frameptr, Node *ret_adr, Node *exception );

  virtual int Opcode() const;

  virtual bool  is_CFG() const { return true; }

  virtual uint hash() const { return NO_HASH; }  // CFG nodes do not hash

  virtual bool depends_only_on_test() const { return false; }

  virtual Node *Ideal(PhaseGVN *phase, bool can_reshape);

  virtual const Type* Value(PhaseGVN* phase) const;

  virtual uint match_edge(uint idx) const;

  virtual uint ideal_reg() const { return NotAMachineReg; }

#ifndef PRODUCT

  virtual void dump_req(outputStream *st = tty) const;

#endif

};

//------------------------------TailCallNode-----------------------------------

// Pop stack frame and jump indirect

class TailCallNode : public ReturnNode {

public:

  TailCallNode( Node *cntrl, Node *i_o, Node *memory, Node *frameptr, Node *retadr, Node *target, Node *moop )

    : ReturnNode( TypeFunc::Parms+2, cntrl, i_o, memory, frameptr, retadr ) {

    init_req(TypeFunc::Parms, target);

    init_req(TypeFunc::Parms+1, moop);

  }

  virtual int Opcode() const;

  virtual uint match_edge(uint idx) const;

};

//------------------------------TailJumpNode-----------------------------------

// Pop stack frame and jump indirect

class TailJumpNode : public ReturnNode {

public:

  TailJumpNode( Node *cntrl, Node *i_o, Node *memory, Node *frameptr, Node *target, Node *ex_oop)

    : ReturnNode(TypeFunc::Parms+2, cntrl, i_o, memory, frameptr, Compile::current()->top()) {

    init_req(TypeFunc::Parms, target);

    init_req(TypeFunc::Parms+1, ex_oop);

  }

  virtual int Opcode() const;

  virtual uint match_edge(uint idx) const;

};

//-------------------------------JVMState-------------------------------------

// A linked list of JVMState nodes captures the whole interpreter state,

// plus GC roots, for all active calls at some call site in this compilation

// unit.  (If there is no inlining, then the list has exactly one link.)

// This provides a way to map the optimized program back into the interpreter,

// or to let the GC mark the stack.

class JVMState : public ResourceObj {

  friend class VMStructs;

public:

  typedef enum {

    Reexecute_Undefined = -1, // not defined -- will be translated into false later

    Reexecute_False     =  0, // false       -- do not reexecute

    Reexecute_True      =  1  // true        -- reexecute the bytecode

  } ReexecuteState; //Reexecute State

private:

  JVMState*         _caller;    // List pointer for forming scope chains

  uint              _depth;     // One more than caller depth, or one.

  uint              _locoff;    // Offset to locals in input edge mapping

  uint              _stkoff;    // Offset to stack in input edge mapping

  uint              _monoff;    // Offset to monitors in input edge mapping

  uint              _scloff;    // Offset to fields of scalar objs in input edge mapping

  uint              _endoff;    // Offset to end of input edge mapping

  uint              _sp;        // Jave Expression Stack Pointer for this state

  int               _bci;       // Byte Code Index of this JVM point

  ReexecuteState    _reexecute; // Whether this bytecode need to be re-executed

  ciMethod*         _method;    // Method Pointer

  SafePointNode*    _map;       // Map node associated with this scope

public:

  friend class Compile;

  friend class PreserveReexecuteState;

  // Because JVMState objects live over the entire lifetime of the

  // Compile object, they are allocated into the comp_arena, which

  // does not get resource marked or reset during the compile process

  void *operator new( size_t x, Compile* C ) throw() { return C->comp_arena()->Amalloc(x); }

  void operator delete( void * ) { } // fast deallocation

  // Create a new JVMState, ready for abstract interpretation.

  JVMState(ciMethod* method, JVMState* caller);

  JVMState(int stack_size);  // root state; has a null method

  // Access functions for the JVM

  // ... --|--- loc ---|--- stk ---|--- arg ---|--- mon ---|--- scl ---|

  //       \ locoff    \ stkoff    \ argoff    \ monoff    \ scloff    \ endoff

  uint              locoff() const { return _locoff; }

  uint              stkoff() const { return _stkoff; }

  uint              argoff() const { return _stkoff + _sp; }

  uint              monoff() const { return _monoff; }

  uint              scloff() const { return _scloff; }

  uint              endoff() const { return _endoff; }

  uint              oopoff() const { return debug_end(); }

  int            loc_size() const { return stkoff() - locoff(); }

  int            stk_size() const { return monoff() - stkoff(); }

  int            mon_size() const { return scloff() - monoff(); }

  int            scl_size() const { return endoff() - scloff(); }

  bool        is_loc(uint i) const { return locoff() <= i && i < stkoff(); }

  bool        is_stk(uint i) const { return stkoff() <= i && i < monoff(); }

  bool        is_mon(uint i) const { return monoff() <= i && i < scloff(); }

  bool        is_scl(uint i) const { return scloff() <= i && i < endoff(); }

  uint                      sp() const { return _sp; }

  int                      bci() const { return _bci; }

  bool        should_reexecute() const { return _reexecute==Reexecute_True; }

  bool  is_reexecute_undefined() const { return _reexecute==Reexecute_Undefined; }

  bool              has_method() const { return _method != NULL; }

  ciMethod*             method() const { assert(has_method(), ""); return _method; }

  JVMState*             caller() const { return _caller; }

  SafePointNode*           map() const { return _map; }

  uint                   depth() const { return _depth; }

  uint             debug_start() const; // returns locoff of root caller

  uint               debug_end() const; // returns endoff of self

  uint              debug_size() const {

    return loc_size() + sp() + mon_size() + scl_size();

  }

  uint        debug_depth()  const; // returns sum of debug_size values at all depths

  // Returns the JVM state at the desired depth (1 == root).

  JVMState* of_depth(int d) const;

  // Tells if two JVM states have the same call chain (depth, methods, & bcis).

  bool same_calls_as(const JVMState* that) const;

  // Monitors (monitors are stored as (boxNode, objNode) pairs

  enum { logMonitorEdges = 1 };

  int  nof_monitors()              const { return mon_size() >> logMonitorEdges; }

  int  monitor_depth()             const { return nof_monitors() + (caller() ? caller()->monitor_depth() : 0); }

  int  monitor_box_offset(int idx) const { return monoff() + (idx << logMonitorEdges) + 0; }

  int  monitor_obj_offset(int idx) const { return monoff() + (idx << logMonitorEdges) + 1; }

  bool is_monitor_box(uint off)    const {

    assert(is_mon(off), "should be called only for monitor edge");

    return (0 == bitfield(off - monoff(), 0, logMonitorEdges));

  }

  bool is_monitor_use(uint off)    const { return (is_mon(off)

                                                   && is_monitor_box(off))

                                             || (caller() && caller()->is_monitor_use(off)); }

  // Initialization functions for the JVM

  void              set_locoff(uint off) { _locoff = off; }

  void              set_stkoff(uint off) { _stkoff = off; }

  void              set_monoff(uint off) { _monoff = off; }

  void              set_scloff(uint off) { _scloff = off; }

  void              set_endoff(uint off) { _endoff = off; }

  void              set_offsets(uint off) {

    _locoff = _stkoff = _monoff = _scloff = _endoff = off;

  }

  void              set_map(SafePointNode *map) { _map = map; }

  void              set_sp(uint sp) { _sp = sp; }

                    // _reexecute is initialized to "undefined" for a new bci

  void              set_bci(int bci) {if(_bci != bci)_reexecute=Reexecute_Undefined; _bci = bci; }

  void              set_should_reexecute(bool reexec) {_reexecute = reexec ? Reexecute_True : Reexecute_False;}

  // Miscellaneous utility functions

  JVMState* clone_deep(Compile* C) const;    // recursively clones caller chain

  JVMState* clone_shallow(Compile* C) const; // retains uncloned caller

  void      set_map_deep(SafePointNode *map);// reset map for all callers

  void      adapt_position(int delta);       // Adapt offsets in in-array after adding an edge.

  int       interpreter_frame_size() const;

#ifndef PRODUCT

  void      format(PhaseRegAlloc *regalloc, const Node *n, outputStream* st) const;

  void      dump_spec(outputStream *st) const;

  void      dump_on(outputStream* st) const;

  void      dump() const {

    dump_on(tty);

  }

#endif

};

//------------------------------SafePointNode----------------------------------

// A SafePointNode is a subclass of a MultiNode for convenience (and

// potential code sharing) only - conceptually it is independent of

// the Node semantics.

class SafePointNode : public MultiNode {

  virtual bool           cmp( const Node &n ) const;

  virtual uint           size_of() const;       // Size is bigger

public:

  SafePointNode(uint edges, JVMState* jvms,

                // A plain safepoint advertises no memory effects (NULL):

                const TypePtr* adr_type = NULL)

    : MultiNode( edges ),

      _oop_map(NULL),

      _jvms(jvms),

      _adr_type(adr_type)

  {

    init_class_id(Class_SafePoint);

  }

  OopMap*         _oop_map;   // Array of OopMap info (8-bit char) for GC

  JVMState* const _jvms;      // Pointer to list of JVM State objects

  const TypePtr*  _adr_type;  // What type of memory does this node produce?

  ReplacedNodes   _replaced_nodes; // During parsing: list of pair of nodes from calls to GraphKit::replace_in_map()

  // Many calls take *all* of memory as input,

  // but some produce a limited subset of that memory as output.

  // The adr_type reports the call's behavior as a store, not a load.

  virtual JVMState* jvms() const { return _jvms; }

  void set_jvms(JVMState* s) {

    *(JVMState**)&_jvms = s;  // override const attribute in the accessor

  }

  OopMap *oop_map() const { return _oop_map; }

  void set_oop_map(OopMap *om) { _oop_map = om; }

 private:

  void verify_input(JVMState* jvms, uint idx) const {

    assert(verify_jvms(jvms), "jvms must match");

    Node* n = in(idx);

    assert((!n->bottom_type()->isa_long() && !n->bottom_type()->isa_double()) ||

           in(idx + 1)->is_top(), "2nd half of long/double");

  }

 public:

  // Functionality from old debug nodes which has changed

  Node *local(JVMState* jvms, uint idx) const {

    verify_input(jvms, jvms->locoff() + idx);

    return in(jvms->locoff() + idx);

  }

  Node *stack(JVMState* jvms, uint idx) const {

    verify_input(jvms, jvms->stkoff() + idx);

    return in(jvms->stkoff() + idx);

  }

  Node *argument(JVMState* jvms, uint idx) const {

    verify_input(jvms, jvms->argoff() + idx);

    return in(jvms->argoff() + idx);

  }

  Node *monitor_box(JVMState* jvms, uint idx) const {

    assert(verify_jvms(jvms), "jvms must match");

    return in(jvms->monitor_box_offset(idx));

  }

  Node *monitor_obj(JVMState* jvms, uint idx) const {

    assert(verify_jvms(jvms), "jvms must match");

    return in(jvms->monitor_obj_offset(idx));

  }

  void  set_local(JVMState* jvms, uint idx, Node *c);

  void  set_stack(JVMState* jvms, uint idx, Node *c) {

    assert(verify_jvms(jvms), "jvms must match");

    set_req(jvms->stkoff() + idx, c);

  }

  void  set_argument(JVMState* jvms, uint idx, Node *c) {

    assert(verify_jvms(jvms), "jvms must match");

    set_req(jvms->argoff() + idx, c);

  }

  void ensure_stack(JVMState* jvms, uint stk_size) {

    assert(verify_jvms(jvms), "jvms must match");

    int grow_by = (int)stk_size - (int)jvms->stk_size();

    if (grow_by > 0)  grow_stack(jvms, grow_by);

  }

  void grow_stack(JVMState* jvms, uint grow_by);

  // Handle monitor stack

  void push_monitor( const FastLockNode *lock );

  void pop_monitor ();

  Node *peek_monitor_box() const;

  Node *peek_monitor_obj() const;

  // Access functions for the JVM

  Node *control  () const { return in(TypeFunc::Control  ); }

  Node *i_o      () const { return in(TypeFunc::I_O      ); }

  Node *memory   () const { return in(TypeFunc::Memory   ); }

  Node *returnadr() const { return in(TypeFunc::ReturnAdr); }

  Node *frameptr () const { return in(TypeFunc::FramePtr ); }

  void set_control  ( Node *c ) { set_req(TypeFunc::Control,c); }

  void set_i_o      ( Node *c ) { set_req(TypeFunc::I_O    ,c); }

  void set_memory   ( Node *c ) { set_req(TypeFunc::Memory ,c); }

  MergeMemNode* merged_memory() const {

    return in(TypeFunc::Memory)->as_MergeMem();

  }

  // The parser marks useless maps as dead when it's done with them:

  bool is_killed() { return in(TypeFunc::Control) == NULL; }

  // Exception states bubbling out of subgraphs such as inlined calls

  // are recorded here.  (There might be more than one, hence the "next".)

  // This feature is used only for safepoints which serve as "maps"

  // for JVM states during parsing, intrinsic expansion, etc.

  SafePointNode*         next_exception() const;

  void               set_next_exception(SafePointNode* n);

  bool                   has_exceptions() const { return next_exception() != NULL; }

  // Helper methods to operate on replaced nodes

  ReplacedNodes replaced_nodes() const {

    return _replaced_nodes;

  }

  void set_replaced_nodes(ReplacedNodes replaced_nodes) {

    _replaced_nodes = replaced_nodes;

  }

  void clone_replaced_nodes() {

    _replaced_nodes.clone();

  }

  void record_replaced_node(Node* initial, Node* improved) {

    _replaced_nodes.record(initial, improved);

  }

  void transfer_replaced_nodes_from(SafePointNode* sfpt, uint idx = 0) {

    _replaced_nodes.transfer_from(sfpt->_replaced_nodes, idx);

  }

  void delete_replaced_nodes() {

    _replaced_nodes.reset();

  }

  void apply_replaced_nodes(uint idx) {

    _replaced_nodes.apply(this, idx);

  }

  void merge_replaced_nodes_with(SafePointNode* sfpt) {

    _replaced_nodes.merge_with(sfpt->_replaced_nodes);

  }

  bool has_replaced_nodes() const {

    return !_replaced_nodes.is_empty();

  }

  void disconnect_from_root(PhaseIterGVN *igvn);

  // Standard Node stuff

  virtual int            Opcode() const;

  virtual bool           pinned() const { return true; }

  virtual const Type*    Value(PhaseGVN* phase) const;

  virtual const Type    *bottom_type() const { return Type::CONTROL; }

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

  virtual Node          *Ideal(PhaseGVN *phase, bool can_reshape);

  virtual Node*          Identity(PhaseGVN* phase);

  virtual uint           ideal_reg() const { return 0; }

  virtual const RegMask &in_RegMask(uint) const;

  virtual const RegMask &out_RegMask() const;

  virtual uint           match_edge(uint idx) const;

  static  bool           needs_polling_address_input();

#ifndef PRODUCT

  virtual void           dump_spec(outputStream *st) const;

  virtual void           related(GrowableArray<Node*> *in_rel, GrowableArray<Node*> *out_rel, bool compact) const;

#endif

};

//------------------------------SafePointScalarObjectNode----------------------

// A SafePointScalarObjectNode represents the state of a scalarized object

// at a safepoint.

class SafePointScalarObjectNode: public TypeNode {

  uint _first_index; // First input edge relative index of a SafePoint node where

                     // states of the scalarized object fields are collected.

                     // It is relative to the last (youngest) jvms->_scloff.

  uint _n_fields;    // Number of non-static fields of the scalarized object.

  DEBUG_ONLY(AllocateNode* _alloc;)

  virtual uint hash() const ; // { return NO_HASH; }

  virtual bool cmp( const Node &n ) const;

  uint first_index() const { return _first_index; }

public:

  SafePointScalarObjectNode(const TypeOopPtr* tp,

#ifdef ASSERT

                            AllocateNode* alloc,

#endif

                            uint first_index, uint n_fields);

  virtual int Opcode() const;

  virtual uint           ideal_reg() const;