1 /*
   2  * Copyright (c) 1997, 2015, 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 
  31 // Inline functions for SPARC frames:
  32 
  33 // Constructors
  34 
  35 inline frame::frame() {
  36   _pc = NULL;
  37   _sp = NULL;
  38   _younger_sp = NULL;
  39   _cb = NULL;
  40   _deopt_state = unknown;
  41   _sp_adjustment_by_callee = 0;
  42 }
  43 
  44 // Accessors:
  45 
  46 inline bool frame::equal(frame other) const {
  47   bool ret =  sp() == other.sp()
  48            && fp() == other.fp()
  49            && pc() == other.pc();
  50   assert(!ret || ret && cb() == other.cb() && _deopt_state == other._deopt_state, "inconsistent construction");
  51   return ret;
  52 }
  53 
  54 // Return unique id for this frame. The id must have a value where we can distinguish
  55 // identity and younger/older relationship. NULL represents an invalid (incomparable)
  56 // frame.
  57 inline intptr_t* frame::id(void) const { return unextended_sp(); }
  58 
  59 // Relationals on frames based
  60 // Return true if the frame is younger (more recent activation) than the frame represented by id
  61 inline bool frame::is_younger(intptr_t* id) const { assert(this->id() != NULL && id != NULL, "NULL frame id");
  62                                                     return this->id() < id ; }
  63 
  64 // Return true if the frame is older (less recent activation) than the frame represented by id
  65 inline bool frame::is_older(intptr_t* id) const   { assert(this->id() != NULL && id != NULL, "NULL frame id");
  66                                                     return this->id() > id ; }
  67 
  68 inline int frame::frame_size(RegisterMap* map) const { return sender_sp() - sp(); }
  69 
  70 inline intptr_t* frame::link() const { return (intptr_t *)(fp()[FP->sp_offset_in_saved_window()] + STACK_BIAS); }
  71 
  72 inline intptr_t* frame::unextended_sp() const { return sp() + _sp_adjustment_by_callee; }
  73 
  74 // return address:
  75 
  76 inline address  frame::sender_pc()        const    { return *I7_addr() + pc_return_offset; }
  77 
  78 inline address* frame::I7_addr() const  { return (address*) &sp()[ I7->sp_offset_in_saved_window()]; }
  79 inline address* frame::I0_addr() const  { return (address*) &sp()[ I0->sp_offset_in_saved_window()]; }
  80 
  81 inline address* frame::O7_addr() const  { return (address*) &younger_sp()[ I7->sp_offset_in_saved_window()]; }
  82 inline address* frame::O0_addr() const  { return (address*) &younger_sp()[ I0->sp_offset_in_saved_window()]; }
  83 
  84 inline intptr_t*    frame::sender_sp() const  { return fp(); }
  85 
  86 inline intptr_t* frame::real_fp() const { return fp(); }
  87 
  88 // Used only in frame::oopmapreg_to_location
  89 // This return a value in VMRegImpl::slot_size
  90 inline int frame::pd_oop_map_offset_adjustment() const {
  91   return _sp_adjustment_by_callee * VMRegImpl::slots_per_word;
  92 }
  93 
  94 #ifdef CC_INTERP
  95 inline intptr_t** frame::interpreter_frame_locals_addr() const {
  96   interpreterState istate = get_interpreterState();
  97   return (intptr_t**) &istate->_locals;
  98 }
  99 
 100 inline intptr_t* frame::interpreter_frame_bcp_addr() const {
 101   interpreterState istate = get_interpreterState();
 102   return (intptr_t*) &istate->_bcp;
 103 }
 104 
 105 inline intptr_t* frame::interpreter_frame_mdp_addr() const {
 106   interpreterState istate = get_interpreterState();
 107   return (intptr_t*) &istate->_mdx;
 108 }
 109 
 110 inline jint frame::interpreter_frame_expression_stack_direction() { return -1; }
 111 
 112 // bottom(base) of the expression stack (highest address)
 113 inline intptr_t* frame::interpreter_frame_expression_stack() const {
 114   return (intptr_t*)interpreter_frame_monitor_end() - 1;
 115 }
 116 
 117 // top of expression stack (lowest address)
 118 inline intptr_t* frame::interpreter_frame_tos_address() const {
 119   interpreterState istate = get_interpreterState();
 120   return istate->_stack + 1; // Is this off by one? QQQ
 121 }
 122 
 123 // monitor elements
 124 
 125 // in keeping with Intel side: end is lower in memory than begin;
 126 // and beginning element is oldest element
 127 // Also begin is one past last monitor.
 128 
 129 inline BasicObjectLock* frame::interpreter_frame_monitor_begin()       const  {
 130   return get_interpreterState()->monitor_base();
 131 }
 132 
 133 inline BasicObjectLock* frame::interpreter_frame_monitor_end()         const  {
 134   return (BasicObjectLock*) get_interpreterState()->stack_base();
 135 }
 136 
 137 
 138 inline int frame::interpreter_frame_monitor_size() {
 139   return round_to(BasicObjectLock::size(), WordsPerLong);
 140 }
 141 
 142 inline Method** frame::interpreter_frame_method_addr() const {
 143   interpreterState istate = get_interpreterState();
 144   return &istate->_method;
 145 }
 146 
 147 
 148 // Constant pool cache
 149 
 150 // where LcpoolCache is saved:
 151 inline ConstantPoolCache** frame::interpreter_frame_cpoolcache_addr() const {
 152   interpreterState istate = get_interpreterState();
 153   return &istate->_constants; // should really use accessor
 154   }
 155 
 156 inline ConstantPoolCache** frame::interpreter_frame_cache_addr() const {
 157   interpreterState istate = get_interpreterState();
 158   return &istate->_constants;
 159 }
 160 
 161 #else // !CC_INTERP
 162 
 163 inline intptr_t** frame::interpreter_frame_locals_addr() const {
 164   return (intptr_t**) sp_addr_at( Llocals->sp_offset_in_saved_window());
 165 }
 166 
 167 inline intptr_t* frame::interpreter_frame_bcp_addr() const {
 168   return (intptr_t*) sp_addr_at( Lbcp->sp_offset_in_saved_window());
 169 }
 170 
 171 inline intptr_t* frame::interpreter_frame_mdp_addr() const {
 172   // %%%%% reinterpreting ImethodDataPtr as a mdx
 173   return (intptr_t*) sp_addr_at( ImethodDataPtr->sp_offset_in_saved_window());
 174 }
 175 
 176 inline jint frame::interpreter_frame_expression_stack_direction() { return -1; }
 177 
 178 // bottom(base) of the expression stack (highest address)
 179 inline intptr_t* frame::interpreter_frame_expression_stack() const {
 180   return (intptr_t*)interpreter_frame_monitors() - 1;
 181 }
 182 
 183 // top of expression stack (lowest address)
 184 inline intptr_t* frame::interpreter_frame_tos_address() const {
 185   return *interpreter_frame_esp_addr() + 1;
 186 }
 187 
 188 inline BasicObjectLock** frame::interpreter_frame_monitors_addr() const {
 189   return (BasicObjectLock**) sp_addr_at(Lmonitors->sp_offset_in_saved_window());
 190 }
 191 inline intptr_t** frame::interpreter_frame_esp_addr() const {
 192   return (intptr_t**)sp_addr_at(Lesp->sp_offset_in_saved_window());
 193 }
 194 
 195 inline void frame::interpreter_frame_set_tos_address( intptr_t* x ) {
 196   *interpreter_frame_esp_addr() = x - 1;
 197 }
 198 
 199 // monitor elements
 200 
 201 // in keeping with Intel side: end is lower in memory than begin;
 202 // and beginning element is oldest element
 203 // Also begin is one past last monitor.
 204 
 205 inline BasicObjectLock* frame::interpreter_frame_monitor_begin()       const  {
 206   int rounded_vm_local_words = round_to(frame::interpreter_frame_vm_local_words, WordsPerLong);
 207   return (BasicObjectLock *)fp_addr_at(-rounded_vm_local_words);
 208 }
 209 
 210 inline BasicObjectLock* frame::interpreter_frame_monitor_end()         const  {
 211   return interpreter_frame_monitors();
 212 }
 213 
 214 
 215 inline void frame::interpreter_frame_set_monitor_end(BasicObjectLock* value) {
 216   interpreter_frame_set_monitors(value);
 217 }
 218 
 219 inline int frame::interpreter_frame_monitor_size() {
 220   return round_to(BasicObjectLock::size(), WordsPerLong);
 221 }
 222 
 223 inline Method** frame::interpreter_frame_method_addr() const {
 224   return (Method**)sp_addr_at( Lmethod->sp_offset_in_saved_window());
 225 }
 226 
 227 inline BasicObjectLock* frame::interpreter_frame_monitors() const {
 228   return *interpreter_frame_monitors_addr();
 229 }
 230 
 231 inline void frame::interpreter_frame_set_monitors(BasicObjectLock* monitors) {
 232   *interpreter_frame_monitors_addr() = monitors;
 233 }
 234 
 235 // Constant pool cache
 236 
 237 // where LcpoolCache is saved:
 238 inline ConstantPoolCache** frame::interpreter_frame_cpoolcache_addr() const {
 239     return (ConstantPoolCache**)sp_addr_at(LcpoolCache->sp_offset_in_saved_window());
 240   }
 241 
 242 inline ConstantPoolCache** frame::interpreter_frame_cache_addr() const {
 243   return (ConstantPoolCache**)sp_addr_at( LcpoolCache->sp_offset_in_saved_window());
 244 }
 245 
 246 inline oop* frame::interpreter_frame_temp_oop_addr() const {
 247   return (oop *)(fp() + interpreter_frame_oop_temp_offset);
 248 }
 249 #endif // CC_INTERP
 250 
 251 
 252 inline JavaCallWrapper** frame::entry_frame_call_wrapper_addr() const {
 253   // note: adjust this code if the link argument in StubGenerator::call_stub() changes!
 254   const Argument link = Argument(0, false);
 255   return (JavaCallWrapper**)&sp()[link.as_in().as_register()->sp_offset_in_saved_window()];
 256 }
 257 
 258 
 259 inline int frame::local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 260    // always allocate non-argument locals 0..5 as if they were arguments:
 261   int allocated_above_frame = nof_args;
 262   if (allocated_above_frame < callee_register_argument_save_area_words)
 263     allocated_above_frame = callee_register_argument_save_area_words;
 264   if (allocated_above_frame > max_nof_locals)
 265     allocated_above_frame = max_nof_locals;
 266 
 267   // Note: monitors (BasicLock blocks) are never allocated in argument slots
 268   //assert(local_index >= 0 && local_index < max_nof_locals, "bad local index");
 269   if (local_index < allocated_above_frame)
 270     return local_index + callee_register_argument_save_area_sp_offset;
 271   else
 272     return local_index - (max_nof_locals + max_nof_monitors*2) + compiler_frame_vm_locals_fp_offset;
 273 }
 274 
 275 inline int frame::monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 276   assert(local_index >= max_nof_locals && ((local_index - max_nof_locals) & 1) && (local_index - max_nof_locals) < max_nof_monitors*2, "bad monitor index");
 277 
 278   // The compiler uses the __higher__ of two indexes allocated to the monitor.
 279   // Increasing local indexes are mapped to increasing memory locations,
 280   // so the start of the BasicLock is associated with the __lower__ index.
 281 
 282   int offset = (local_index-1) - (max_nof_locals + max_nof_monitors*2) + compiler_frame_vm_locals_fp_offset;
 283 
 284   // We allocate monitors aligned zero mod 8:
 285   assert((offset & 1) == 0, "monitor must be an an even address.");
 286   // This works because all monitors are allocated after
 287   // all locals, and because the highest address corresponding to any
 288   // monitor index is always even.
 289   assert((compiler_frame_vm_locals_fp_offset & 1) == 0, "end of monitors must be even address");
 290 
 291   return offset;
 292 }
 293 
 294 inline int frame::min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors) {
 295    // always allocate non-argument locals 0..5 as if they were arguments:
 296   int allocated_above_frame = nof_args;
 297   if (allocated_above_frame < callee_register_argument_save_area_words)
 298     allocated_above_frame = callee_register_argument_save_area_words;
 299   if (allocated_above_frame > max_nof_locals)
 300     allocated_above_frame = max_nof_locals;
 301 
 302   int allocated_in_frame = (max_nof_locals + max_nof_monitors*2) - allocated_above_frame;
 303 
 304   return compiler_frame_vm_locals_fp_offset - allocated_in_frame;
 305 }
 306 
 307 // On SPARC, the %lN and %iN registers are non-volatile.
 308 inline bool frame::volatile_across_calls(Register reg) {
 309   // This predicate is (presently) applied only to temporary registers,
 310   // and so it need not recognize non-volatile globals.
 311   return reg->is_out() || reg->is_global();
 312 }
 313 
 314 inline oop  frame::saved_oop_result(RegisterMap* map) const      {
 315   return *((oop*) map->location(O0->as_VMReg()));
 316 }
 317 
 318 inline void frame::set_saved_oop_result(RegisterMap* map, oop obj) {
 319   *((oop*) map->location(O0->as_VMReg())) = obj;
 320 }
 321 
 322 #endif // CPU_SPARC_VM_FRAME_SPARC_INLINE_HPP