/*

 * Copyright 2003-2008 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 *

 */

#include "incls/_precompiled.incl"

#include "incls/_interp_masm_x86_64.cpp.incl"

// Implementation of InterpreterMacroAssembler

void InterpreterMacroAssembler::call_VM_leaf_base(address entry_point,

                                                  int number_of_arguments) {

  // interpreter specific

  //

  // Note: No need to save/restore bcp & locals (r13 & r14) pointer

  //       since these are callee saved registers and no blocking/

  //       GC can happen in leaf calls.

  // Further Note: DO NOT save/restore bcp/locals. If a caller has

  // already saved them so that it can use esi/edi as temporaries

  // then a save/restore here will DESTROY the copy the caller

  // saved! There used to be a save_bcp() that only happened in

  // the ASSERT path (no restore_bcp). Which caused bizarre failures

  // when jvm built with ASSERTs.

#ifdef ASSERT

  {

    Label L;

    cmpq(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), (int)NULL_WORD);

    jcc(Assembler::equal, L);

    stop("InterpreterMacroAssembler::call_VM_leaf_base:"

         " last_sp != NULL");

    bind(L);

  }

#endif

  // super call

  MacroAssembler::call_VM_leaf_base(entry_point, number_of_arguments);

  // interpreter specific

  // Used to ASSERT that r13/r14 were equal to frame's bcp/locals

  // but since they may not have been saved (and we don't want to

  // save thme here (see note above) the assert is invalid.

}

void InterpreterMacroAssembler::call_VM_base(Register oop_result,

                                             Register java_thread,

                                             Register last_java_sp,

                                             address  entry_point,

                                             int      number_of_arguments,

                                             bool     check_exceptions) {

  // interpreter specific

  //

  // Note: Could avoid restoring locals ptr (callee saved) - however doesn't

  //       really make a difference for these runtime calls, since they are

  //       slow anyway. Btw., bcp must be saved/restored since it may change

  //       due to GC.

  // assert(java_thread == noreg , "not expecting a precomputed java thread");

  save_bcp();

#ifdef ASSERT

  {

    Label L;

    cmpq(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), (int)NULL_WORD);

    jcc(Assembler::equal, L);

    stop("InterpreterMacroAssembler::call_VM_leaf_base:"

         " last_sp != NULL");

    bind(L);

  }

#endif /* ASSERT */

  // super call

  MacroAssembler::call_VM_base(oop_result, noreg, last_java_sp,

                               entry_point, number_of_arguments,

                               check_exceptions);

  // interpreter specific

  restore_bcp();

  restore_locals();

}

void InterpreterMacroAssembler::check_and_handle_popframe(Register java_thread) {

  if (JvmtiExport::can_pop_frame()) {

    Label L;

    // Initiate popframe handling only if it is not already being

    // processed.  If the flag has the popframe_processing bit set, it

    // means that this code is called *during* popframe handling - we

    // don't want to reenter.

    // This method is only called just after the call into the vm in

    // call_VM_base, so the arg registers are available.

    movl(c_rarg0, Address(r15_thread, JavaThread::popframe_condition_offset()));

    testl(c_rarg0, JavaThread::popframe_pending_bit);

    jcc(Assembler::zero, L);

    testl(c_rarg0, JavaThread::popframe_processing_bit);

    jcc(Assembler::notZero, L);

    // Call Interpreter::remove_activation_preserving_args_entry() to get the

    // address of the same-named entrypoint in the generated interpreter code.

    call_VM_leaf(CAST_FROM_FN_PTR(address, Interpreter::remove_activation_preserving_args_entry));

    jmp(rax);

    bind(L);

  }

}

void InterpreterMacroAssembler::load_earlyret_value(TosState state) {

  movq(rcx, Address(r15_thread, JavaThread::jvmti_thread_state_offset()));

  const Address tos_addr(rcx, JvmtiThreadState::earlyret_tos_offset());

  const Address oop_addr(rcx, JvmtiThreadState::earlyret_oop_offset());

  const Address val_addr(rcx, JvmtiThreadState::earlyret_value_offset());

  switch (state) {

    case atos: movq(rax, oop_addr);

               movptr(oop_addr, NULL_WORD);

               verify_oop(rax, state);              break;

    case ltos: movq(rax, val_addr);                 break;

    case btos:                                   // fall through

    case ctos:                                   // fall through

    case stos:                                   // fall through

    case itos: movl(rax, val_addr);                 break;

    case ftos: movflt(xmm0, val_addr);              break;

    case dtos: movdbl(xmm0, val_addr);              break;

    case vtos: /* nothing to do */                  break;

    default  : ShouldNotReachHere();

  }

  // Clean up tos value in the thread object

  movl(tos_addr,  (int) ilgl);

  movl(val_addr,  (int) NULL_WORD);

}

void InterpreterMacroAssembler::check_and_handle_earlyret(Register java_thread) {

  if (JvmtiExport::can_force_early_return()) {

    Label L;

    movq(c_rarg0, Address(r15_thread, JavaThread::jvmti_thread_state_offset()));

    testq(c_rarg0, c_rarg0);

    jcc(Assembler::zero, L); // if (thread->jvmti_thread_state() == NULL) exit;

    // Initiate earlyret handling only if it is not already being processed.

    // If the flag has the earlyret_processing bit set, it means that this code

    // is called *during* earlyret handling - we don't want to reenter.

    movl(c_rarg0, Address(c_rarg0, JvmtiThreadState::earlyret_state_offset()));

    cmpl(c_rarg0, JvmtiThreadState::earlyret_pending);

    jcc(Assembler::notEqual, L);

    // Call Interpreter::remove_activation_early_entry() to get the address of the

    // same-named entrypoint in the generated interpreter code.

    movq(c_rarg0, Address(r15_thread, JavaThread::jvmti_thread_state_offset()));

    movl(c_rarg0, Address(c_rarg0, JvmtiThreadState::earlyret_tos_offset()));

    call_VM_leaf(CAST_FROM_FN_PTR(address, Interpreter::remove_activation_early_entry), c_rarg0);

    jmp(rax);

    bind(L);

  }

}

void InterpreterMacroAssembler::get_unsigned_2_byte_index_at_bcp(

  Register reg,

  int bcp_offset) {

  assert(bcp_offset >= 0, "bcp is still pointing to start of bytecode");

  movl(reg, Address(r13, bcp_offset));

  bswapl(reg);

  shrl(reg, 16);

}

void InterpreterMacroAssembler::get_cache_and_index_at_bcp(Register cache,

                                                           Register index,

                                                           int bcp_offset) {

  assert(bcp_offset > 0, "bcp is still pointing to start of bytecode");

  assert(cache != index, "must use different registers");

  load_unsigned_word(index, Address(r13, bcp_offset));

  movq(cache, Address(rbp, frame::interpreter_frame_cache_offset * wordSize));

  assert(sizeof(ConstantPoolCacheEntry) == 4 * wordSize, "adjust code below");

  // convert from field index to ConstantPoolCacheEntry index

  shll(index, 2);

}

void InterpreterMacroAssembler::get_cache_entry_pointer_at_bcp(Register cache,

                                                               Register tmp,

                                                               int bcp_offset) {

  assert(bcp_offset > 0, "bcp is still pointing to start of bytecode");

  assert(cache != tmp, "must use different register");

  load_unsigned_word(tmp, Address(r13, bcp_offset));

  assert(sizeof(ConstantPoolCacheEntry) == 4 * wordSize, "adjust code below");

  // convert from field index to ConstantPoolCacheEntry index

  // and from word offset to byte offset

  shll(tmp, 2 + LogBytesPerWord);

  movq(cache, Address(rbp, frame::interpreter_frame_cache_offset * wordSize));

  // skip past the header

  addq(cache, in_bytes(constantPoolCacheOopDesc::base_offset()));

  addq(cache, tmp);  // construct pointer to cache entry

}

// Generate a subtype check: branch to ok_is_subtype if sub_klass is a

// subtype of super_klass.

//

// Args:

//      rax: superklass

//      Rsub_klass: subklass

//

// Kills:

//      rcx, rdi

void InterpreterMacroAssembler::gen_subtype_check(Register Rsub_klass,

                                                  Label& ok_is_subtype) {

  assert(Rsub_klass != rax, "rax holds superklass");

  assert(Rsub_klass != r14, "r14 holds locals");

  assert(Rsub_klass != r13, "r13 holds bcp");

  assert(Rsub_klass != rcx, "rcx holds 2ndary super array length");

  assert(Rsub_klass != rdi, "rdi holds 2ndary super array scan ptr");

  Label not_subtype, not_subtype_pop, loop;

  // Profile the not-null value's klass.

  profile_typecheck(rcx, Rsub_klass, rdi); // blows rcx, rdi

  // Load the super-klass's check offset into rcx

  movl(rcx, Address(rax, sizeof(oopDesc) +

                    Klass::super_check_offset_offset_in_bytes()));

  // Load from the sub-klass's super-class display list, or a 1-word

  // cache of the secondary superclass list, or a failing value with a

  // sentinel offset if the super-klass is an interface or

  // exceptionally deep in the Java hierarchy and we have to scan the

  // secondary superclass list the hard way.  See if we get an

  // immediate positive hit

  cmpq(rax, Address(Rsub_klass, rcx, Address::times_1));

  jcc(Assembler::equal,ok_is_subtype);

  // Check for immediate negative hit

  cmpl(rcx, sizeof(oopDesc) + Klass::secondary_super_cache_offset_in_bytes());

  jcc( Assembler::notEqual, not_subtype );

  // Check for self

  cmpq(Rsub_klass, rax);

  jcc(Assembler::equal, ok_is_subtype);

  // Now do a linear scan of the secondary super-klass chain.

  movq(rdi, Address(Rsub_klass, sizeof(oopDesc) +

                    Klass::secondary_supers_offset_in_bytes()));

  // rdi holds the objArrayOop of secondary supers.

  // Load the array length

  movl(rcx, Address(rdi, arrayOopDesc::length_offset_in_bytes()));

  // Skip to start of data; also clear Z flag incase rcx is zero

  addq(rdi, arrayOopDesc::base_offset_in_bytes(T_OBJECT));

  // Scan rcx words at [rdi] for occurance of rax

  // Set NZ/Z based on last compare

  // this part is kind tricky, as values in supers array could be 32 or 64 bit wide

  // and we store values in objArrays always encoded, thus we need to encode value

  // before repne

  if (UseCompressedOops) {

    pushq(rax);

    encode_heap_oop(rax);

    repne_scanl();

    // Not equal?

    jcc(Assembler::notEqual, not_subtype_pop);

    // restore heap oop here for movq

    popq(rax);

  } else {

    repne_scanq();

    jcc(Assembler::notEqual, not_subtype);

  }

  // Must be equal but missed in cache.  Update cache.

  movq(Address(Rsub_klass, sizeof(oopDesc) +

               Klass::secondary_super_cache_offset_in_bytes()), rax);

  jmp(ok_is_subtype);

  bind(not_subtype_pop);

  // restore heap oop here for miss

  if (UseCompressedOops) popq(rax);

  bind(not_subtype);

  profile_typecheck_failed(rcx); // blows rcx

}

// Java Expression Stack

#ifdef ASSERT

// Verifies that the stack tag matches.  Must be called before the stack

// value is popped off the stack.

void InterpreterMacroAssembler::verify_stack_tag(frame::Tag t) {

  if (TaggedStackInterpreter) {

    frame::Tag tag = t;

    if (t == frame::TagCategory2) {

      tag = frame::TagValue;

      Label hokay;

      cmpq(Address(rsp, 3*wordSize), (int)tag);

      jcc(Assembler::equal, hokay);

      stop("Java Expression stack tag high value is bad");

      bind(hokay);

    }

    Label okay;

    cmpq(Address(rsp, wordSize), (int)tag);

    jcc(Assembler::equal, okay);

    // Also compare if the stack value is zero, then the tag might

    // not have been set coming from deopt.

    cmpq(Address(rsp, 0), 0);

    jcc(Assembler::equal, okay);

    stop("Java Expression stack tag value is bad");

    bind(okay);

  }

}

#endif // ASSERT

void InterpreterMacroAssembler::pop_ptr(Register r) {

  debug_only(verify_stack_tag(frame::TagReference));

  popq(r);

  if (TaggedStackInterpreter) addq(rsp, 1 * wordSize);

}

void InterpreterMacroAssembler::pop_ptr(Register r, Register tag) {

  popq(r);

  if (TaggedStackInterpreter) popq(tag);

}

void InterpreterMacroAssembler::pop_i(Register r) {

  // XXX can't use popq currently, upper half non clean

  debug_only(verify_stack_tag(frame::TagValue));

  movl(r, Address(rsp, 0));

  addq(rsp, wordSize);

  if (TaggedStackInterpreter) addq(rsp, 1 * wordSize);

}

void InterpreterMacroAssembler::pop_l(Register r) {

  debug_only(verify_stack_tag(frame::TagCategory2));

  movq(r, Address(rsp, 0));

  addq(rsp, 2 * Interpreter::stackElementSize());

}

void InterpreterMacroAssembler::pop_f(XMMRegister r) {

  debug_only(verify_stack_tag(frame::TagValue));

  movflt(r, Address(rsp, 0));

  addq(rsp, wordSize);

  if (TaggedStackInterpreter) addq(rsp, 1 * wordSize);

}

void InterpreterMacroAssembler::pop_d(XMMRegister r) {

  debug_only(verify_stack_tag(frame::TagCategory2));

  movdbl(r, Address(rsp, 0));

  addq(rsp, 2 * Interpreter::stackElementSize());

}

void InterpreterMacroAssembler::push_ptr(Register r) {

  if (TaggedStackInterpreter) pushq(frame::TagReference);

  pushq(r);

}

void InterpreterMacroAssembler::push_ptr(Register r, Register tag) {

  if (TaggedStackInterpreter) pushq(tag);

  pushq(r);

}

void InterpreterMacroAssembler::push_i(Register r) {

  if (TaggedStackInterpreter) pushq(frame::TagValue);

  pushq(r);

}

void InterpreterMacroAssembler::push_l(Register r) {

  if (TaggedStackInterpreter) {

    pushq(frame::TagValue);

    subq(rsp, 1 * wordSize);

    pushq(frame::TagValue);

    subq(rsp, 1 * wordSize);

  } else {

    subq(rsp, 2 * wordSize);

  }

  movq(Address(rsp, 0), r);

}

void InterpreterMacroAssembler::push_f(XMMRegister r) {

  if (TaggedStackInterpreter) pushq(frame::TagValue);

  subq(rsp, wordSize);

  movflt(Address(rsp, 0), r);

}

void InterpreterMacroAssembler::push_d(XMMRegister r) {

  if (TaggedStackInterpreter) {

    pushq(frame::TagValue);

    subq(rsp, 1 * wordSize);

    pushq(frame::TagValue);

    subq(rsp, 1 * wordSize);

  } else {

    subq(rsp, 2 * wordSize);

  }

  movdbl(Address(rsp, 0), r);

}

void InterpreterMacroAssembler::pop(TosState state) {

  switch (state) {

  case atos: pop_ptr();                 break;

  case btos:

  case ctos:

  case stos:

  case itos: pop_i();                   break;

  case ltos: pop_l();                   break;

  case ftos: pop_f();                   break;

  case dtos: pop_d();                   break;

  case vtos: /* nothing to do */        break;

  default:   ShouldNotReachHere();

  }

  verify_oop(rax, state);

}

void InterpreterMacroAssembler::push(TosState state) {

  verify_oop(rax, state);

  switch (state) {

  case atos: push_ptr();                break;

  case btos:

  case ctos:

  case stos:

  case itos: push_i();                  break;

  case ltos: push_l();                  break;

  case ftos: push_f();                  break;

  case dtos: push_d();                  break;

  case vtos: /* nothing to do */        break;

  default  : ShouldNotReachHere();

  }

}

// Tagged stack helpers for swap and dup

void InterpreterMacroAssembler::load_ptr_and_tag(int n, Register val,

                                                 Register tag) {

  movq(val, Address(rsp, Interpreter::expr_offset_in_bytes(n)));

  if (TaggedStackInterpreter) {

    movq(tag, Address(rsp, Interpreter::expr_tag_offset_in_bytes(n)));

  }

}

void InterpreterMacroAssembler::store_ptr_and_tag(int n, Register val,

                                                  Register tag) {

  movq(Address(rsp, Interpreter::expr_offset_in_bytes(n)), val);

  if (TaggedStackInterpreter) {

    movq(Address(rsp, Interpreter::expr_tag_offset_in_bytes(n)), tag);

  }

}

// Tagged local support

void InterpreterMacroAssembler::tag_local(frame::Tag tag, int n) {

  if (TaggedStackInterpreter) {

    if (tag == frame::TagCategory2) {

      mov64(Address(r14, Interpreter::local_tag_offset_in_bytes(n+1)),

           (intptr_t)frame::TagValue);

      mov64(Address(r14, Interpreter::local_tag_offset_in_bytes(n)),

           (intptr_t)frame::TagValue);

    } else {

      mov64(Address(r14, Interpreter::local_tag_offset_in_bytes(n)), (intptr_t)tag);

    }

  }

}

void InterpreterMacroAssembler::tag_local(frame::Tag tag, Register idx) {

  if (TaggedStackInterpreter) {

    if (tag == frame::TagCategory2) {

      mov64(Address(r14, idx, Address::times_8,

                  Interpreter::local_tag_offset_in_bytes(1)), (intptr_t)frame::TagValue);

      mov64(Address(r14, idx, Address::times_8,

                  Interpreter::local_tag_offset_in_bytes(0)), (intptr_t)frame::TagValue);

    } else {

      mov64(Address(r14, idx, Address::times_8, Interpreter::local_tag_offset_in_bytes(0)),

           (intptr_t)tag);

    }

  }

}

void InterpreterMacroAssembler::tag_local(Register tag, Register idx) {

  if (TaggedStackInterpreter) {

    // can only be TagValue or TagReference

    movq(Address(r14, idx, Address::times_8, Interpreter::local_tag_offset_in_bytes(0)), tag);

  }

}

void InterpreterMacroAssembler::tag_local(Register tag, int n) {

  if (TaggedStackInterpreter) {

    // can only be TagValue or TagReference

    movq(Address(r14, Interpreter::local_tag_offset_in_bytes(n)), tag);

  }

}

#ifdef ASSERT

void InterpreterMacroAssembler::verify_local_tag(frame::Tag tag, int n) {

  if (TaggedStackInterpreter) {

     frame::Tag t = tag;

    if (tag == frame::TagCategory2) {

      Label nbl;

      t = frame::TagValue;  // change to what is stored in locals

      cmpq(Address(r14, Interpreter::local_tag_offset_in_bytes(n+1)), (int)t);

      jcc(Assembler::equal, nbl);

      stop("Local tag is bad for long/double");

      bind(nbl);

    }

    Label notBad;

    cmpq(Address(r14, Interpreter::local_tag_offset_in_bytes(n)), (int)t);

    jcc(Assembler::equal, notBad);

    // Also compare if the local value is zero, then the tag might

    // not have been set coming from deopt.

    cmpq(Address(r14, Interpreter::local_offset_in_bytes(n)), 0);

    jcc(Assembler::equal, notBad);

    stop("Local tag is bad");

    bind(notBad);

  }

}

void InterpreterMacroAssembler::verify_local_tag(frame::Tag tag, Register idx) {

  if (TaggedStackInterpreter) {

    frame::Tag t = tag;

    if (tag == frame::TagCategory2) {

      Label nbl;

      t = frame::TagValue;  // change to what is stored in locals

      cmpq(Address(r14, idx, Address::times_8, Interpreter::local_tag_offset_in_bytes(1)), (int)t);