/*

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

#define CPU_SPARC_VM_MACROASSEMBLER_SPARC_HPP

#include "asm/assembler.hpp"

#include "utilities/macros.hpp"

// <sys/trap.h> promises that the system will not use traps 16-31

#define ST_RESERVED_FOR_USER_0 0x10

class BiasedLockingCounters;

// Register aliases for parts of the system:

// 64 bit values can be kept in g1-g5, o1-o5 and o7 and all 64 bits are safe

// across context switches in V8+ ABI.  Of course, there are no 64 bit regs

// in V8 ABI. All 64 bits are preserved in V9 ABI for all registers.

// g2-g4 are scratch registers called "application globals".  Their

// meaning is reserved to the "compilation system"--which means us!

// They are are not supposed to be touched by ordinary C code, although

// highly-optimized C code might steal them for temps.  They are safe

// across thread switches, and the ABI requires that they be safe

// across function calls.

//

// g1 and g3 are touched by more modules.  V8 allows g1 to be clobbered

// across func calls, and V8+ also allows g5 to be clobbered across

// func calls.  Also, g1 and g5 can get touched while doing shared

// library loading.

//

// We must not touch g7 (it is the thread-self register) and g6 is

// reserved for certain tools.  g0, of course, is always zero.

//

// (Sources:  SunSoft Compilers Group, thread library engineers.)

// %%%% The interpreter should be revisited to reduce global scratch regs.

// This global always holds the current JavaThread pointer:

REGISTER_DECLARATION(Register, G2_thread , G2);

REGISTER_DECLARATION(Register, G6_heapbase , G6);

// The following globals are part of the Java calling convention:

REGISTER_DECLARATION(Register, G5_method             , G5);

REGISTER_DECLARATION(Register, G5_megamorphic_method , G5_method);

REGISTER_DECLARATION(Register, G5_inline_cache_reg   , G5_method);

// The following globals are used for the new C1 & interpreter calling convention:

REGISTER_DECLARATION(Register, Gargs        , G4); // pointing to the last argument

// This local is used to preserve G2_thread in the interpreter and in stubs:

REGISTER_DECLARATION(Register, L7_thread_cache , L7);

// These globals are used as scratch registers in the interpreter:

REGISTER_DECLARATION(Register, Gframe_size   , G1); // SAME REG as G1_scratch

REGISTER_DECLARATION(Register, G1_scratch    , G1); // also SAME

REGISTER_DECLARATION(Register, G3_scratch    , G3);

REGISTER_DECLARATION(Register, G4_scratch    , G4);

// These globals are used as short-lived scratch registers in the compiler:

REGISTER_DECLARATION(Register, Gtemp  , G5);

// JSR 292 fixed register usages:

REGISTER_DECLARATION(Register, G5_method_type        , G5);

REGISTER_DECLARATION(Register, G3_method_handle      , G3);

REGISTER_DECLARATION(Register, L7_mh_SP_save         , L7);

// The compiler requires that G5_megamorphic_method is G5_inline_cache_klass,

// because a single patchable "set" instruction (NativeMovConstReg,

// or NativeMovConstPatching for compiler1) instruction

// serves to set up either quantity, depending on whether the compiled

// call site is an inline cache or is megamorphic.  See the function

// CompiledIC::set_to_megamorphic.

//

// If a inline cache targets an interpreted method, then the

// G5 register will be used twice during the call.  First,

// the call site will be patched to load a compiledICHolder

// into G5. (This is an ordered pair of ic_klass, method.)

// The c2i adapter will first check the ic_klass, then load

// G5_method with the method part of the pair just before

// jumping into the interpreter.

//

// Note that G5_method is only the method-self for the interpreter,

// and is logically unrelated to G5_megamorphic_method.

//

// Invariants on G2_thread (the JavaThread pointer):

//  - it should not be used for any other purpose anywhere

//  - it must be re-initialized by StubRoutines::call_stub()

//  - it must be preserved around every use of call_VM

// We can consider using g2/g3/g4 to cache more values than the

// JavaThread, such as the card-marking base or perhaps pointers into

// Eden.  It's something of a waste to use them as scratch temporaries,

// since they are not supposed to be volatile.  (Of course, if we find

// that Java doesn't benefit from application globals, then we can just

// use them as ordinary temporaries.)

//

// Since g1 and g5 (and/or g6) are the volatile (caller-save) registers,

// it makes sense to use them routinely for procedure linkage,

// whenever the On registers are not applicable.  Examples:  G5_method,

// G5_inline_cache_klass, and a double handful of miscellaneous compiler

// stubs.  This means that compiler stubs, etc., should be kept to a

// maximum of two or three G-register arguments.

// stub frames

REGISTER_DECLARATION(Register, Lentry_args      , L0); // pointer to args passed to callee (interpreter) not stub itself

// Interpreter frames

REGISTER_DECLARATION(Register, Lesp             , L0); // expression stack pointer

REGISTER_DECLARATION(Register, Lbcp             , L1); // pointer to next bytecode

REGISTER_DECLARATION(Register, Lmethod          , L2);

REGISTER_DECLARATION(Register, Llocals          , L3);

REGISTER_DECLARATION(Register, Largs            , L3); // pointer to locals for signature handler

                                                       // must match Llocals in asm interpreter

REGISTER_DECLARATION(Register, Lmonitors        , L4);

REGISTER_DECLARATION(Register, Lbyte_code       , L5);

// When calling out from the interpreter we record SP so that we can remove any extra stack

// space allocated during adapter transitions. This register is only live from the point

// of the call until we return.

REGISTER_DECLARATION(Register, Llast_SP         , L5);

REGISTER_DECLARATION(Register, Lscratch         , L5);

REGISTER_DECLARATION(Register, Lscratch2        , L6);

REGISTER_DECLARATION(Register, LcpoolCache      , L6); // constant pool cache

REGISTER_DECLARATION(Register, O5_savedSP       , O5);

REGISTER_DECLARATION(Register, I5_savedSP       , I5); // Saved SP before bumping for locals.  This is simply

                                                       // a copy SP, so in 64-bit it's a biased value.  The bias

                                                       // is added and removed as needed in the frame code.

REGISTER_DECLARATION(Register, IdispatchAddress , I3); // Register which saves the dispatch address for each bytecode

REGISTER_DECLARATION(Register, ImethodDataPtr   , I2); // Pointer to the current method data

// NOTE: Lscratch2 and LcpoolCache point to the same registers in

//       the interpreter code. If Lscratch2 needs to be used for some

//       purpose than LcpoolCache should be restore after that for

//       the interpreter to work right

// (These assignments must be compatible with L7_thread_cache; see above.)

// Lbcp points into the middle of the method object.

// Exception processing

// These registers are passed into exception handlers.

// All exception handlers require the exception object being thrown.

// In addition, an nmethod's exception handler must be passed

// the address of the call site within the nmethod, to allow

// proper selection of the applicable catch block.

// (Interpreter frames use their own bcp() for this purpose.)

//

// The Oissuing_pc value is not always needed.  When jumping to a

// handler that is known to be interpreted, the Oissuing_pc value can be

// omitted.  An actual catch block in compiled code receives (from its

// nmethod's exception handler) the thrown exception in the Oexception,

// but it doesn't need the Oissuing_pc.

//

// If an exception handler (either interpreted or compiled)

// discovers there is no applicable catch block, it updates

// the Oissuing_pc to the continuation PC of its own caller,

// pops back to that caller's stack frame, and executes that

// caller's exception handler.  Obviously, this process will

// iterate until the control stack is popped back to a method

// containing an applicable catch block.  A key invariant is

// that the Oissuing_pc value is always a value local to

// the method whose exception handler is currently executing.

//

// Note:  The issuing PC value is __not__ a raw return address (I7 value).

// It is a "return pc", the address __following__ the call.

// Raw return addresses are converted to issuing PCs by frame::pc(),

// or by stubs.  Issuing PCs can be used directly with PC range tables.

//

REGISTER_DECLARATION(Register, Oexception  , O0); // exception being thrown

REGISTER_DECLARATION(Register, Oissuing_pc , O1); // where the exception is coming from

// These must occur after the declarations above

#ifndef DONT_USE_REGISTER_DEFINES

#define Gthread             AS_REGISTER(Register, Gthread)

#define Gmethod             AS_REGISTER(Register, Gmethod)

#define Gmegamorphic_method AS_REGISTER(Register, Gmegamorphic_method)

#define Ginline_cache_reg   AS_REGISTER(Register, Ginline_cache_reg)

#define Gargs               AS_REGISTER(Register, Gargs)

#define Lthread_cache       AS_REGISTER(Register, Lthread_cache)

#define Gframe_size         AS_REGISTER(Register, Gframe_size)

#define Gtemp               AS_REGISTER(Register, Gtemp)

#define Lesp                AS_REGISTER(Register, Lesp)

#define Lbcp                AS_REGISTER(Register, Lbcp)

#define Lmethod             AS_REGISTER(Register, Lmethod)

#define Llocals             AS_REGISTER(Register, Llocals)

#define Lmonitors           AS_REGISTER(Register, Lmonitors)

#define Lbyte_code          AS_REGISTER(Register, Lbyte_code)

#define Lscratch            AS_REGISTER(Register, Lscratch)

#define Lscratch2           AS_REGISTER(Register, Lscratch2)

#define LcpoolCache         AS_REGISTER(Register, LcpoolCache)

#define Lentry_args         AS_REGISTER(Register, Lentry_args)

#define I5_savedSP          AS_REGISTER(Register, I5_savedSP)

#define O5_savedSP          AS_REGISTER(Register, O5_savedSP)

#define IdispatchAddress    AS_REGISTER(Register, IdispatchAddress)

#define ImethodDataPtr      AS_REGISTER(Register, ImethodDataPtr)

#define Oexception          AS_REGISTER(Register, Oexception)

#define Oissuing_pc         AS_REGISTER(Register, Oissuing_pc)

#endif

// Address is an abstraction used to represent a memory location.

//

// Note: A register location is represented via a Register, not

//       via an address for efficiency & simplicity reasons.

class Address VALUE_OBJ_CLASS_SPEC {

 private:

  Register           _base;           // Base register.

  RegisterOrConstant _index_or_disp;  // Index register or constant displacement.

  RelocationHolder   _rspec;

 public:

  Address() : _base(noreg), _index_or_disp(noreg) {}

  Address(Register base, RegisterOrConstant index_or_disp)

    : _base(base),

      _index_or_disp(index_or_disp) {

  }

  Address(Register base, Register index)

    : _base(base),

      _index_or_disp(index) {

  }

  Address(Register base, int disp)

    : _base(base),

      _index_or_disp(disp) {

  }

#ifdef ASSERT

  // ByteSize is only a class when ASSERT is defined, otherwise it's an int.

  Address(Register base, ByteSize disp)

    : _base(base),

      _index_or_disp(in_bytes(disp)) {

  }

#endif

  // accessors

  Register base()             const { return _base; }

  Register index()            const { return _index_or_disp.as_register(); }

  int      disp()             const { return _index_or_disp.as_constant(); }

  bool     has_index()        const { return _index_or_disp.is_register(); }

  bool     has_disp()         const { return _index_or_disp.is_constant(); }

  bool     uses(Register reg) const { return base() == reg || (has_index() && index() == reg); }

  const relocInfo::relocType rtype() { return _rspec.type(); }

  const RelocationHolder&    rspec() { return _rspec; }

  RelocationHolder rspec(int offset) const {

    return offset == 0 ? _rspec : _rspec.plus(offset);

  }

  inline bool is_simm13(int offset = 0);  // check disp+offset for overflow

  Address plus_disp(int plusdisp) const {     // bump disp by a small amount

    assert(_index_or_disp.is_constant(), "must have a displacement");

    Address a(base(), disp() + plusdisp);

    return a;

  }

  bool is_same_address(Address a) const {

    // disregard _rspec

    return base() == a.base() && (has_index() ? index() == a.index() : disp() == a.disp());

  }

  Address after_save() const {

    Address a = (*this);

    a._base = a._base->after_save();

    return a;

  }

  Address after_restore() const {

    Address a = (*this);

    a._base = a._base->after_restore();

    return a;

  }

  // Convert the raw encoding form into the form expected by the

  // constructor for Address.

  static Address make_raw(int base, int index, int scale, int disp, relocInfo::relocType disp_reloc);

  friend class Assembler;

};

class AddressLiteral VALUE_OBJ_CLASS_SPEC {

 private:

  address          _address;

  RelocationHolder _rspec;

  RelocationHolder rspec_from_rtype(relocInfo::relocType rtype, address addr) {

    switch (rtype) {

    case relocInfo::external_word_type:

      return external_word_Relocation::spec(addr);

    case relocInfo::internal_word_type:

      return internal_word_Relocation::spec(addr);

    case relocInfo::opt_virtual_call_type:

      return opt_virtual_call_Relocation::spec();

    case relocInfo::static_call_type:

      return static_call_Relocation::spec();

    case relocInfo::runtime_call_type:

      return runtime_call_Relocation::spec();

    case relocInfo::none:

      return RelocationHolder();

    default:

      ShouldNotReachHere();

      return RelocationHolder();

    }

  }

 protected:

  // creation

  AddressLiteral() : _address(NULL), _rspec(NULL) {}

 public:

  AddressLiteral(address addr, RelocationHolder const& rspec)

    : _address(addr),

      _rspec(rspec) {}

  // Some constructors to avoid casting at the call site.

  AddressLiteral(jobject obj, RelocationHolder const& rspec)

    : _address((address) obj),

      _rspec(rspec) {}

  AddressLiteral(intptr_t value, RelocationHolder const& rspec)

    : _address((address) value),

      _rspec(rspec) {}

  AddressLiteral(address addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

    _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  // Some constructors to avoid casting at the call site.

  AddressLiteral(address* addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

    _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  AddressLiteral(bool* addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  AddressLiteral(const bool* addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  AddressLiteral(signed char* addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  AddressLiteral(int* addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  AddressLiteral(intptr_t addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  // 32-bit complains about a multiple declaration for int*.

  AddressLiteral(intptr_t* addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  AddressLiteral(Metadata* addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  AddressLiteral(Metadata** addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  AddressLiteral(float* addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  AddressLiteral(double* addr, relocInfo::relocType rtype = relocInfo::none)

    : _address((address) addr),

      _rspec(rspec_from_rtype(rtype, (address) addr)) {}

  intptr_t value() const { return (intptr_t) _address; }

  int      low10() const;

  const relocInfo::relocType rtype() const { return _rspec.type(); }

  const RelocationHolder&    rspec() const { return _rspec; }

  RelocationHolder rspec(int offset) const {

    return offset == 0 ? _rspec : _rspec.plus(offset);

  }

};

// Convenience classes

class ExternalAddress: public AddressLiteral {

 private:

  static relocInfo::relocType reloc_for_target(address target) {

    // Sometimes ExternalAddress is used for values which aren't

    // exactly addresses, like the card table base.

    // external_word_type can't be used for values in the first page

    // so just skip the reloc in that case.

    return external_word_Relocation::can_be_relocated(target) ? relocInfo::external_word_type : relocInfo::none;

  }

 public:

  ExternalAddress(address target) : AddressLiteral(target, reloc_for_target(          target)) {}

  ExternalAddress(Metadata** target) : AddressLiteral(target, reloc_for_target((address) target)) {}

};

inline Address RegisterImpl::address_in_saved_window() const {

   return (Address(SP, (sp_offset_in_saved_window() * wordSize) + STACK_BIAS));

}

// Argument is an abstraction used to represent an outgoing

// actual argument or an incoming formal parameter, whether

// it resides in memory or in a register, in a manner consistent

// with the SPARC Application Binary Interface, or ABI.  This is

// often referred to as the native or C calling convention.

class Argument VALUE_OBJ_CLASS_SPEC {

 private:

  int _number;

  bool _is_in;

 public:

  enum {

    n_register_parameters = 6,          // only 6 registers may contain integer parameters

    n_float_register_parameters = 16    // Can have up to 16 floating registers

  };

  // creation

  Argument(int number, bool is_in) : _number(number), _is_in(is_in) {}

  int  number() const  { return _number;  }

  bool is_in()  const  { return _is_in;   }

  bool is_out() const  { return !is_in(); }

  Argument successor() const  { return Argument(number() + 1, is_in()); }

  Argument as_in()     const  { return Argument(number(), true ); }

  Argument as_out()    const  { return Argument(number(), false); }

  // locating register-based arguments:

  bool is_register() const { return _number < n_register_parameters; }

  // locating Floating Point register-based arguments:

  bool is_float_register() const { return _number < n_float_register_parameters; }

  FloatRegister as_float_register() const {

    assert(is_float_register(), "must be a register argument");

    return as_FloatRegister(( number() *2 ) + 1);

  }

  FloatRegister as_double_register() const {

    assert(is_float_register(), "must be a register argument");

    return as_FloatRegister(( number() *2 ));

  }

  Register as_register() const {

    assert(is_register(), "must be a register argument");

    return is_in() ? as_iRegister(number()) : as_oRegister(number());

  }

  // locating memory-based arguments

  Address as_address() const {

    assert(!is_register(), "must be a memory argument");

    return address_in_frame();

  }

  // When applied to a register-based argument, give the corresponding address

  // into the 6-word area "into which callee may store register arguments"

  // (This is a different place than the corresponding register-save area location.)

  Address address_in_frame() const;

  // debugging

  const char* name() const;

  friend class Assembler;

};

class RegistersForDebugging : public StackObj {

 public:

  intptr_t i[8], l[8], o[8], g[8];

  float    f[32];

  double   d[32];

  void print(outputStream* s);

  static int i_offset(int j) { return offset_of(RegistersForDebugging, i[j]); }

  static int l_offset(int j) { return offset_of(RegistersForDebugging, l[j]); }

  static int o_offset(int j) { return offset_of(RegistersForDebugging, o[j]); }

  static int g_offset(int j) { return offset_of(RegistersForDebugging, g[j]); }

  static int f_offset(int j) { return offset_of(RegistersForDebugging, f[j]); }

  static int d_offset(int j) { return offset_of(RegistersForDebugging, d[j / 2]); }