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