1 /*
   2  * Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2014, Red Hat Inc. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #ifndef CPU_AARCH64_VM_FRAME_AARCH64_INLINE_HPP
  27 #define CPU_AARCH64_VM_FRAME_AARCH64_INLINE_HPP
  28 
  29 #include "code/codeCache.hpp"
  30 #include "code/vmreg.inline.hpp"
  31 
  32 // Inline functions for AArch64 frames:
  33 
  34 // Constructors:
  35 
  36 inline frame::frame() {
  37   _pc = NULL;
  38   _sp = NULL;
  39   _unextended_sp = NULL;
  40   _fp = NULL;
  41   _cb = NULL;
  42   _deopt_state = unknown;
  43 }
  44 
  45 static int spin;
  46 
  47 inline void frame::init(intptr_t* sp, intptr_t* fp, address pc) {
  48   intptr_t a = intptr_t(sp);
  49   intptr_t b = intptr_t(fp);
  50 #ifndef PRODUCT
  51   if (fp)
  52     if (sp > fp || (fp - sp > 0x100000))
  53       for(;;)
  54         asm("nop");
  55 #endif
  56   _sp = sp;
  57   _unextended_sp = sp;
  58   _fp = fp;
  59   _pc = pc;
  60   assert(pc != NULL, "no pc?");
  61   _cb = CodeCache::find_blob(pc);
  62   adjust_unextended_sp();
  63 
  64   address original_pc = nmethod::get_deopt_original_pc(this);
  65   if (original_pc != NULL) {
  66     _pc = original_pc;
  67     _deopt_state = is_deoptimized;
  68   } else {
  69     _deopt_state = not_deoptimized;
  70   }
  71 }
  72 
  73 inline frame::frame(intptr_t* sp, intptr_t* fp, address pc) {
  74   init(sp, fp, pc);
  75 }
  76 
  77 inline frame::frame(intptr_t* sp, intptr_t* unextended_sp, intptr_t* fp, address pc) {
  78   intptr_t a = intptr_t(sp);
  79   intptr_t b = intptr_t(fp);
  80 // C2 may use fp as a general reg - C1 doesn't
  81 #if !defined(PRODUCT) && !defined(COMPILER2)
  82   if (fp)
  83     if (sp > fp || (fp - sp > 0x100000))
  84       for(;;)
  85         asm("nop");
  86 #endif
  87   _sp = sp;
  88   _unextended_sp = unextended_sp;
  89   _fp = fp;
  90   _pc = pc;
  91   assert(pc != NULL, "no pc?");
  92   _cb = CodeCache::find_blob(pc);
  93   adjust_unextended_sp();
  94 
  95   address original_pc = nmethod::get_deopt_original_pc(this);
  96   if (original_pc != NULL) {
  97     _pc = original_pc;
  98     assert(((nmethod*)_cb)->insts_contains(_pc), "original PC must be in nmethod");
  99     _deopt_state = is_deoptimized;
 100   } else {
 101     _deopt_state = not_deoptimized;
 102   }
 103 }
 104 
 105 inline frame::frame(intptr_t* sp, intptr_t* fp) {
 106   intptr_t a = intptr_t(sp);
 107   intptr_t b = intptr_t(fp);
 108 // C2 may use fp as a general reg - C1 doesn't
 109 #if !defined(PRODUCT) && !defined(COMPILER2)
 110   if (fp)
 111     if (sp > fp || (fp - sp > 0x100000))
 112       for(;;)
 113         asm("nop");
 114 #endif
 115   _sp = sp;
 116   _unextended_sp = sp;
 117   _fp = fp;
 118   _pc = (address)(sp[-1]);
 119 
 120   // Here's a sticky one. This constructor can be called via AsyncGetCallTrace
 121   // when last_Java_sp is non-null but the pc fetched is junk. If we are truly
 122   // unlucky the junk value could be to a zombied method and we'll die on the
 123   // find_blob call. This is also why we can have no asserts on the validity
 124   // of the pc we find here. AsyncGetCallTrace -> pd_get_top_frame_for_signal_handler
 125   // -> pd_last_frame should use a specialized version of pd_last_frame which could
 126   // call a specilaized frame constructor instead of this one.
 127   // Then we could use the assert below. However this assert is of somewhat dubious
 128   // value.
 129   // assert(_pc != NULL, "no pc?");
 130 
 131   _cb = CodeCache::find_blob(_pc);
 132   adjust_unextended_sp();
 133 
 134   address original_pc = nmethod::get_deopt_original_pc(this);
 135   if (original_pc != NULL) {
 136     _pc = original_pc;
 137     _deopt_state = is_deoptimized;
 138   } else {
 139     _deopt_state = not_deoptimized;
 140   }
 141 }
 142 
 143 // Accessors
 144 
 145 inline bool frame::equal(frame other) const {
 146   bool ret =  sp() == other.sp()
 147               && unextended_sp() == other.unextended_sp()
 148               && fp() == other.fp()
 149               && pc() == other.pc();
 150   assert(!ret || ret && cb() == other.cb() && _deopt_state == other._deopt_state, "inconsistent construction");
 151   return ret;
 152 }
 153 
 154 // Return unique id for this frame. The id must have a value where we can distinguish
 155 // identity and younger/older relationship. NULL represents an invalid (incomparable)
 156 // frame.
 157 inline intptr_t* frame::id(void) const { return unextended_sp(); }
 158 
 159 // Relationals on frames based
 160 // Return true if the frame is younger (more recent activation) than the frame represented by id
 161 inline bool frame::is_younger(intptr_t* id) const { assert(this->id() != NULL && id != NULL, "NULL frame id");
 162                                                     return this->id() < id ; }
 163 
 164 // Return true if the frame is older (less recent activation) than the frame represented by id
 165 inline bool frame::is_older(intptr_t* id) const   { assert(this->id() != NULL && id != NULL, "NULL frame id");
 166                                                     return this->id() > id ; }
 167 
 168 
 169 
 170 inline intptr_t* frame::link() const              { return (intptr_t*) *(intptr_t **)addr_at(link_offset); }
 171 
 172 
 173 inline intptr_t* frame::unextended_sp() const     { return _unextended_sp; }
 174 
 175 // Return address:
 176 
 177 inline address* frame::sender_pc_addr()      const { return (address*) addr_at( return_addr_offset); }
 178 inline address  frame::sender_pc()           const { return *sender_pc_addr(); }
 179 
 180 #ifdef CC_INTERP
 181 
 182 inline interpreterState frame::get_interpreterState() const {
 183   return ((interpreterState)addr_at( -((int)sizeof(BytecodeInterpreter))/wordSize ));
 184 }
 185 
 186 inline intptr_t*    frame::sender_sp()        const {
 187   // Hmm this seems awfully expensive QQQ, is this really called with interpreted frames?
 188   if (is_interpreted_frame()) {
 189     assert(false, "should never happen");
 190     return get_interpreterState()->sender_sp();
 191   } else {
 192     return            addr_at(sender_sp_offset);
 193   }
 194 }
 195 
 196 inline intptr_t** frame::interpreter_frame_locals_addr() const {
 197   assert(is_interpreted_frame(), "must be interpreted");
 198   return &(get_interpreterState()->_locals);
 199 }
 200 
 201 inline intptr_t* frame::interpreter_frame_bcx_addr() const {
 202   assert(is_interpreted_frame(), "must be interpreted");
 203   return (intptr_t*) &(get_interpreterState()->_bcp);
 204 }
 205 
 206 
 207 // Constant pool cache
 208 
 209 inline constantPoolCacheOop* frame::interpreter_frame_cache_addr() const {
 210   assert(is_interpreted_frame(), "must be interpreted");
 211   return &(get_interpreterState()->_constants);
 212 }
 213 
 214 // Method
 215 
 216 inline methodOop* frame::interpreter_frame_method_addr() const {
 217   assert(is_interpreted_frame(), "must be interpreted");
 218   return &(get_interpreterState()->_method);
 219 }
 220 
 221 inline intptr_t* frame::interpreter_frame_mdx_addr() const {
 222   assert(is_interpreted_frame(), "must be interpreted");
 223   return (intptr_t*) &(get_interpreterState()->_mdx);
 224 }
 225 
 226 // top of expression stack
 227 inline intptr_t* frame::interpreter_frame_tos_address() const {
 228   assert(is_interpreted_frame(), "wrong frame type");
 229   return get_interpreterState()->_stack + 1;
 230 }
 231 
 232 #else /* asm interpreter */
 233 inline intptr_t*    frame::sender_sp()        const { return            addr_at(   sender_sp_offset); }
 234 
 235 inline intptr_t** frame::interpreter_frame_locals_addr() const {
 236   return (intptr_t**)addr_at(interpreter_frame_locals_offset);
 237 }
 238 
 239 inline intptr_t* frame::interpreter_frame_last_sp() const {
 240   return *(intptr_t**)addr_at(interpreter_frame_last_sp_offset);
 241 }
 242 
 243 inline intptr_t* frame::interpreter_frame_bcp_addr() const {
 244   return (intptr_t*)addr_at(interpreter_frame_bcp_offset);
 245 }
 246 
 247 inline intptr_t* frame::interpreter_frame_mdp_addr() const {
 248   return (intptr_t*)addr_at(interpreter_frame_mdp_offset);
 249 }
 250 
 251 
 252 // Constant pool cache
 253 
 254 inline ConstantPoolCache** frame::interpreter_frame_cache_addr() const {
 255   return (ConstantPoolCache**)addr_at(interpreter_frame_cache_offset);
 256 }
 257 
 258 // Method
 259 
 260 inline Method** frame::interpreter_frame_method_addr() const {
 261   return (Method**)addr_at(interpreter_frame_method_offset);
 262 }
 263 
 264 // top of expression stack
 265 inline intptr_t* frame::interpreter_frame_tos_address() const {
 266   intptr_t* last_sp = interpreter_frame_last_sp();
 267   if (last_sp == NULL) {
 268     return sp();
 269   } else {
 270     // sp() may have been extended or shrunk by an adapter.  At least
 271     // check that we don't fall behind the legal region.
 272     // For top deoptimized frame last_sp == interpreter_frame_monitor_end.
 273     assert(last_sp <= (intptr_t*) interpreter_frame_monitor_end(), "bad tos");
 274     return last_sp;
 275   }
 276 }
 277 
 278 inline oop* frame::interpreter_frame_temp_oop_addr() const {
 279   return (oop *)(fp() + interpreter_frame_oop_temp_offset);
 280 }
 281 
 282 #endif /* CC_INTERP */
 283 
 284 inline int frame::pd_oop_map_offset_adjustment() const {
 285   return 0;
 286 }
 287 
 288 inline int frame::interpreter_frame_monitor_size() {
 289   return BasicObjectLock::size();
 290 }
 291 
 292 
 293 // expression stack
 294 // (the max_stack arguments are used by the GC; see class FrameClosure)
 295 
 296 inline intptr_t* frame::interpreter_frame_expression_stack() const {
 297   intptr_t* monitor_end = (intptr_t*) interpreter_frame_monitor_end();
 298   return monitor_end-1;
 299 }
 300 
 301 
 302 inline jint frame::interpreter_frame_expression_stack_direction() { return -1; }
 303 
 304 
 305 // Entry frames
 306 
 307 inline JavaCallWrapper** frame::entry_frame_call_wrapper_addr() const {
 308  return (JavaCallWrapper**)addr_at(entry_frame_call_wrapper_offset);
 309 }
 310 
 311 
 312 // Compiled frames
 313 
 314 inline int frame::local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 315   return (nof_args - local_index + (local_index < nof_args ? 1: -1));
 316 }
 317 
 318 inline int frame::monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 319   return local_offset_for_compiler(local_index, nof_args, max_nof_locals, max_nof_monitors);
 320 }
 321 
 322 inline int frame::min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors) {
 323   return (nof_args - (max_nof_locals + max_nof_monitors*2) - 1);
 324 }
 325 
 326 inline bool frame::volatile_across_calls(Register reg) {
 327   return true;
 328 }
 329 
 330 
 331 
 332 inline oop frame::saved_oop_result(RegisterMap* map) const {
 333   oop* result_adr = (oop *)map->location(r0->as_VMReg());
 334   guarantee(result_adr != NULL, "bad register save location");
 335 
 336   return (*result_adr);
 337 }
 338 
 339 inline void frame::set_saved_oop_result(RegisterMap* map, oop obj) {
 340   oop* result_adr = (oop *)map->location(r0->as_VMReg());
 341   guarantee(result_adr != NULL, "bad register save location");
 342 
 343   *result_adr = obj;
 344 }
 345 
 346 #endif // CPU_AARCH64_VM_FRAME_AARCH64_INLINE_HPP