1 /*
   2  * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef CPU_SPARC_VM_FRAME_SPARC_INLINE_HPP
  26 #define CPU_SPARC_VM_FRAME_SPARC_INLINE_HPP
  27 
  28 #include "asm/macroAssembler.hpp"
  29 #include "code/vmreg.inline.hpp"
  30 #include "utilities/align.hpp"
  31 
  32 // Inline functions for SPARC frames:
  33 
  34 // Constructors
  35 
  36 inline frame::frame() {
  37   _pc = NULL;
  38   _sp = NULL;
  39   _younger_sp = NULL;
  40   _cb = NULL;
  41   _deopt_state = unknown;
  42   _sp_adjustment_by_callee = 0;
  43 }
  44 
  45 // Accessors:
  46 
  47 inline bool frame::equal(frame other) const {
  48   bool ret =  sp() == other.sp()
  49            && fp() == other.fp()
  50            && pc() == other.pc();
  51   assert(!ret || ret && cb() == other.cb() && _deopt_state == other._deopt_state, "inconsistent construction");
  52   return ret;
  53 }
  54 
  55 // Return unique id for this frame. The id must have a value where we can distinguish
  56 // identity and younger/older relationship. NULL represents an invalid (incomparable)
  57 // frame.
  58 inline intptr_t* frame::id(void) const { return unextended_sp(); }
  59 
  60 // Relationals on frames based
  61 // Return true if the frame is younger (more recent activation) than the frame represented by id
  62 inline bool frame::is_younger(intptr_t* id) const { assert(this->id() != NULL && id != NULL, "NULL frame id");
  63                                                     return this->id() < id ; }
  64 
  65 // Return true if the frame is older (less recent activation) than the frame represented by id
  66 inline bool frame::is_older(intptr_t* id) const   { assert(this->id() != NULL && id != NULL, "NULL frame id");
  67                                                     return this->id() > id ; }
  68 
  69 inline int frame::frame_size(RegisterMap* map) const { return sender_sp() - sp(); }
  70 
  71 inline intptr_t* frame::link() const { return (intptr_t *)(fp()[FP->sp_offset_in_saved_window()] + STACK_BIAS); }
  72 
  73 inline intptr_t* frame::unextended_sp() const { return sp() + _sp_adjustment_by_callee; }
  74 
  75 // return address:
  76 
  77 inline address  frame::sender_pc()        const    { return *I7_addr() + pc_return_offset; }
  78 
  79 inline address* frame::I7_addr() const  { return (address*) &sp()[ I7->sp_offset_in_saved_window()]; }
  80 inline address* frame::I0_addr() const  { return (address*) &sp()[ I0->sp_offset_in_saved_window()]; }
  81 
  82 inline address* frame::O7_addr() const  { return (address*) &younger_sp()[ I7->sp_offset_in_saved_window()]; }
  83 inline address* frame::O0_addr() const  { return (address*) &younger_sp()[ I0->sp_offset_in_saved_window()]; }
  84 
  85 inline intptr_t*    frame::sender_sp() const  { return fp(); }
  86 
  87 inline intptr_t* frame::real_fp() const { return fp(); }
  88 
  89 // Used only in frame::oopmapreg_to_location
  90 // This return a value in VMRegImpl::slot_size
  91 inline int frame::pd_oop_map_offset_adjustment() const {
  92   return _sp_adjustment_by_callee * VMRegImpl::slots_per_word;
  93 }
  94 
  95 inline intptr_t** frame::interpreter_frame_locals_addr() const {
  96   return (intptr_t**) sp_addr_at( Llocals->sp_offset_in_saved_window());
  97 }
  98 
  99 inline intptr_t* frame::interpreter_frame_bcp_addr() const {
 100   return (intptr_t*) sp_addr_at( Lbcp->sp_offset_in_saved_window());
 101 }
 102 
 103 inline intptr_t* frame::interpreter_frame_mdp_addr() const {
 104   // %%%%% reinterpreting ImethodDataPtr as a mdx
 105   return (intptr_t*) sp_addr_at( ImethodDataPtr->sp_offset_in_saved_window());
 106 }
 107 
 108 inline jint frame::interpreter_frame_expression_stack_direction() { return -1; }
 109 
 110 // bottom(base) of the expression stack (highest address)
 111 inline intptr_t* frame::interpreter_frame_expression_stack() const {
 112   return (intptr_t*)interpreter_frame_monitors() - 1;
 113 }
 114 
 115 // top of expression stack (lowest address)
 116 inline intptr_t* frame::interpreter_frame_tos_address() const {
 117   return *interpreter_frame_esp_addr() + 1;
 118 }
 119 
 120 inline BasicObjectLock** frame::interpreter_frame_monitors_addr() const {
 121   return (BasicObjectLock**) sp_addr_at(Lmonitors->sp_offset_in_saved_window());
 122 }
 123 inline intptr_t** frame::interpreter_frame_esp_addr() const {
 124   return (intptr_t**)sp_addr_at(Lesp->sp_offset_in_saved_window());
 125 }
 126 
 127 inline void frame::interpreter_frame_set_tos_address( intptr_t* x ) {
 128   *interpreter_frame_esp_addr() = x - 1;
 129 }
 130 
 131 // monitor elements
 132 
 133 // in keeping with Intel side: end is lower in memory than begin;
 134 // and beginning element is oldest element
 135 // Also begin is one past last monitor.
 136 
 137 inline BasicObjectLock* frame::interpreter_frame_monitor_begin()       const  {
 138   int rounded_vm_local_words = align_up((int)frame::interpreter_frame_vm_local_words, WordsPerLong);
 139   return (BasicObjectLock *)fp_addr_at(-rounded_vm_local_words);
 140 }
 141 
 142 inline BasicObjectLock* frame::interpreter_frame_monitor_end()         const  {
 143   return interpreter_frame_monitors();
 144 }
 145 
 146 
 147 inline void frame::interpreter_frame_set_monitor_end(BasicObjectLock* value) {
 148   interpreter_frame_set_monitors(value);
 149 }
 150 
 151 inline int frame::interpreter_frame_monitor_size() {
 152   return align_up(BasicObjectLock::size(), WordsPerLong);
 153 }
 154 
 155 inline Method** frame::interpreter_frame_method_addr() const {
 156   return (Method**)sp_addr_at( Lmethod->sp_offset_in_saved_window());
 157 }
 158 
 159 inline BasicObjectLock* frame::interpreter_frame_monitors() const {
 160   return *interpreter_frame_monitors_addr();
 161 }
 162 
 163 inline void frame::interpreter_frame_set_monitors(BasicObjectLock* monitors) {
 164   *interpreter_frame_monitors_addr() = monitors;
 165 }
 166 
 167 inline oop* frame::interpreter_frame_mirror_addr() const {
 168   return (oop*)(fp() + interpreter_frame_mirror_offset);
 169 }
 170 
 171 // Constant pool cache
 172 
 173 // where LcpoolCache is saved:
 174 inline ConstantPoolCache** frame::interpreter_frame_cpoolcache_addr() const {
 175     return (ConstantPoolCache**)sp_addr_at(LcpoolCache->sp_offset_in_saved_window());
 176   }
 177 
 178 inline ConstantPoolCache** frame::interpreter_frame_cache_addr() const {
 179   return (ConstantPoolCache**)sp_addr_at( LcpoolCache->sp_offset_in_saved_window());
 180 }
 181 
 182 inline oop* frame::interpreter_frame_temp_oop_addr() const {
 183   return (oop *)(fp() + interpreter_frame_oop_temp_offset);
 184 }
 185 
 186 
 187 inline JavaCallWrapper** frame::entry_frame_call_wrapper_addr() const {
 188   // note: adjust this code if the link argument in StubGenerator::call_stub() changes!
 189   const Argument link = Argument(0, false);
 190   return (JavaCallWrapper**)&sp()[link.as_in().as_register()->sp_offset_in_saved_window()];
 191 }
 192 
 193 
 194 inline int frame::local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 195    // always allocate non-argument locals 0..5 as if they were arguments:
 196   int allocated_above_frame = nof_args;
 197   if (allocated_above_frame < callee_register_argument_save_area_words)
 198     allocated_above_frame = callee_register_argument_save_area_words;
 199   if (allocated_above_frame > max_nof_locals)
 200     allocated_above_frame = max_nof_locals;
 201 
 202   // Note: monitors (BasicLock blocks) are never allocated in argument slots
 203   //assert(local_index >= 0 && local_index < max_nof_locals, "bad local index");
 204   if (local_index < allocated_above_frame)
 205     return local_index + callee_register_argument_save_area_sp_offset;
 206   else
 207     return local_index - (max_nof_locals + max_nof_monitors*2) + compiler_frame_vm_locals_fp_offset;
 208 }
 209 
 210 inline int frame::monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 211   assert(local_index >= max_nof_locals && ((local_index - max_nof_locals) & 1) && (local_index - max_nof_locals) < max_nof_monitors*2, "bad monitor index");
 212 
 213   // The compiler uses the __higher__ of two indexes allocated to the monitor.
 214   // Increasing local indexes are mapped to increasing memory locations,
 215   // so the start of the BasicLock is associated with the __lower__ index.
 216 
 217   int offset = (local_index-1) - (max_nof_locals + max_nof_monitors*2) + compiler_frame_vm_locals_fp_offset;
 218 
 219   // We allocate monitors aligned zero mod 8:
 220   assert((offset & 1) == 0, "monitor must be an an even address.");
 221   // This works because all monitors are allocated after
 222   // all locals, and because the highest address corresponding to any
 223   // monitor index is always even.
 224   assert((compiler_frame_vm_locals_fp_offset & 1) == 0, "end of monitors must be even address");
 225 
 226   return offset;
 227 }
 228 
 229 inline int frame::min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors) {
 230    // always allocate non-argument locals 0..5 as if they were arguments:
 231   int allocated_above_frame = nof_args;
 232   if (allocated_above_frame < callee_register_argument_save_area_words)
 233     allocated_above_frame = callee_register_argument_save_area_words;
 234   if (allocated_above_frame > max_nof_locals)
 235     allocated_above_frame = max_nof_locals;
 236 
 237   int allocated_in_frame = (max_nof_locals + max_nof_monitors*2) - allocated_above_frame;
 238 
 239   return compiler_frame_vm_locals_fp_offset - allocated_in_frame;
 240 }
 241 
 242 // On SPARC, the %lN and %iN registers are non-volatile.
 243 inline bool frame::volatile_across_calls(Register reg) {
 244   // This predicate is (presently) applied only to temporary registers,
 245   // and so it need not recognize non-volatile globals.
 246   return reg->is_out() || reg->is_global();
 247 }
 248 
 249 inline oop  frame::saved_oop_result(RegisterMap* map) const      {
 250   return *((oop*) map->location(O0->as_VMReg()));
 251 }
 252 
 253 inline void frame::set_saved_oop_result(RegisterMap* map, oop obj) {
 254   *((oop*) map->location(O0->as_VMReg())) = obj;
 255 }
 256 
 257 #endif // CPU_SPARC_VM_FRAME_SPARC_INLINE_HPP