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   _sp = sp;
  81   _unextended_sp = unextended_sp;
  82   _fp = fp;
  83   _pc = pc;
  84   assert(pc != NULL, "no pc?");
  85   _cb = CodeCache::find_blob(pc);
  86   adjust_unextended_sp();
  87 
  88   address original_pc = nmethod::get_deopt_original_pc(this);
  89   if (original_pc != NULL) {
  90     _pc = original_pc;
  91     assert(((nmethod*)_cb)->insts_contains(_pc), "original PC must be in nmethod");
  92     _deopt_state = is_deoptimized;
  93   } else {
  94     _deopt_state = not_deoptimized;
  95   }
  96 }
  97 
  98 inline frame::frame(intptr_t* sp, intptr_t* fp) {
  99   intptr_t a = intptr_t(sp);
 100   intptr_t b = intptr_t(fp);
 101   _sp = sp;
 102   _unextended_sp = sp;
 103   _fp = fp;
 104   _pc = (address)(sp[-1]);
 105 
 106   // Here's a sticky one. This constructor can be called via AsyncGetCallTrace
 107   // when last_Java_sp is non-null but the pc fetched is junk. If we are truly
 108   // unlucky the junk value could be to a zombied method and we'll die on the
 109   // find_blob call. This is also why we can have no asserts on the validity
 110   // of the pc we find here. AsyncGetCallTrace -> pd_get_top_frame_for_signal_handler
 111   // -> pd_last_frame should use a specialized version of pd_last_frame which could
 112   // call a specilaized frame constructor instead of this one.
 113   // Then we could use the assert below. However this assert is of somewhat dubious
 114   // value.
 115   // assert(_pc != NULL, "no pc?");
 116 
 117   _cb = CodeCache::find_blob(_pc);
 118   adjust_unextended_sp();
 119 
 120   address original_pc = nmethod::get_deopt_original_pc(this);
 121   if (original_pc != NULL) {
 122     _pc = original_pc;
 123     _deopt_state = is_deoptimized;
 124   } else {
 125     _deopt_state = not_deoptimized;
 126   }
 127 }
 128 
 129 // Accessors
 130 
 131 inline bool frame::equal(frame other) const {
 132   bool ret =  sp() == other.sp()
 133               && unextended_sp() == other.unextended_sp()
 134               && fp() == other.fp()
 135               && pc() == other.pc();
 136   assert(!ret || ret && cb() == other.cb() && _deopt_state == other._deopt_state, "inconsistent construction");
 137   return ret;
 138 }
 139 
 140 // Return unique id for this frame. The id must have a value where we can distinguish
 141 // identity and younger/older relationship. NULL represents an invalid (incomparable)
 142 // frame.
 143 inline intptr_t* frame::id(void) const { return unextended_sp(); }
 144 
 145 // Relationals on frames based
 146 // Return true if the frame is younger (more recent activation) than the frame represented by id
 147 inline bool frame::is_younger(intptr_t* id) const { assert(this->id() != NULL && id != NULL, "NULL frame id");
 148                                                     return this->id() < id ; }
 149 
 150 // Return true if the frame is older (less recent activation) than the frame represented by id
 151 inline bool frame::is_older(intptr_t* id) const   { assert(this->id() != NULL && id != NULL, "NULL frame id");
 152                                                     return this->id() > id ; }
 153 
 154 
 155 
 156 inline intptr_t* frame::link() const              { return (intptr_t*) *(intptr_t **)addr_at(link_offset); }
 157 
 158 
 159 inline intptr_t* frame::unextended_sp() const     { return _unextended_sp; }
 160 
 161 // Return address:
 162 
 163 inline address* frame::sender_pc_addr()      const { return (address*) addr_at( return_addr_offset); }
 164 inline address  frame::sender_pc()           const { return *sender_pc_addr(); }
 165 
 166 #ifdef CC_INTERP
 167 
 168 inline interpreterState frame::get_interpreterState() const {
 169   return ((interpreterState)addr_at( -((int)sizeof(BytecodeInterpreter))/wordSize ));
 170 }
 171 
 172 inline intptr_t*    frame::sender_sp()        const {
 173   // Hmm this seems awfully expensive QQQ, is this really called with interpreted frames?
 174   if (is_interpreted_frame()) {
 175     assert(false, "should never happen");
 176     return get_interpreterState()->sender_sp();
 177   } else {
 178     return            addr_at(sender_sp_offset);
 179   }
 180 }
 181 
 182 inline intptr_t** frame::interpreter_frame_locals_addr() const {
 183   assert(is_interpreted_frame(), "must be interpreted");
 184   return &(get_interpreterState()->_locals);
 185 }
 186 
 187 inline intptr_t* frame::interpreter_frame_bcx_addr() const {
 188   assert(is_interpreted_frame(), "must be interpreted");
 189   return (intptr_t*) &(get_interpreterState()->_bcp);
 190 }
 191 
 192 
 193 // Constant pool cache
 194 
 195 inline constantPoolCacheOop* frame::interpreter_frame_cache_addr() const {
 196   assert(is_interpreted_frame(), "must be interpreted");
 197   return &(get_interpreterState()->_constants);
 198 }
 199 
 200 // Method
 201 
 202 inline methodOop* frame::interpreter_frame_method_addr() const {
 203   assert(is_interpreted_frame(), "must be interpreted");
 204   return &(get_interpreterState()->_method);
 205 }
 206 
 207 inline intptr_t* frame::interpreter_frame_mdx_addr() const {
 208   assert(is_interpreted_frame(), "must be interpreted");
 209   return (intptr_t*) &(get_interpreterState()->_mdx);
 210 }
 211 
 212 // top of expression stack
 213 inline intptr_t* frame::interpreter_frame_tos_address() const {
 214   assert(is_interpreted_frame(), "wrong frame type");
 215   return get_interpreterState()->_stack + 1;
 216 }
 217 
 218 #else /* asm interpreter */
 219 inline intptr_t*    frame::sender_sp()        const { return            addr_at(   sender_sp_offset); }
 220 
 221 inline intptr_t** frame::interpreter_frame_locals_addr() const {
 222   return (intptr_t**)addr_at(interpreter_frame_locals_offset);
 223 }
 224 
 225 inline intptr_t* frame::interpreter_frame_last_sp() const {
 226   return *(intptr_t**)addr_at(interpreter_frame_last_sp_offset);
 227 }
 228 
 229 inline intptr_t* frame::interpreter_frame_bcp_addr() const {
 230   return (intptr_t*)addr_at(interpreter_frame_bcp_offset);
 231 }
 232 
 233 inline intptr_t* frame::interpreter_frame_mdp_addr() const {
 234   return (intptr_t*)addr_at(interpreter_frame_mdp_offset);
 235 }
 236 
 237 
 238 // Constant pool cache
 239 
 240 inline ConstantPoolCache** frame::interpreter_frame_cache_addr() const {
 241   return (ConstantPoolCache**)addr_at(interpreter_frame_cache_offset);
 242 }
 243 
 244 // Method
 245 
 246 inline Method** frame::interpreter_frame_method_addr() const {
 247   return (Method**)addr_at(interpreter_frame_method_offset);
 248 }
 249 
 250 // top of expression stack
 251 inline intptr_t* frame::interpreter_frame_tos_address() const {
 252   intptr_t* last_sp = interpreter_frame_last_sp();
 253   if (last_sp == NULL) {
 254     return sp();
 255   } else {
 256     // sp() may have been extended or shrunk by an adapter.  At least
 257     // check that we don't fall behind the legal region.
 258     // For top deoptimized frame last_sp == interpreter_frame_monitor_end.
 259     assert(last_sp <= (intptr_t*) interpreter_frame_monitor_end(), "bad tos");
 260     return last_sp;
 261   }
 262 }
 263 
 264 inline oop* frame::interpreter_frame_temp_oop_addr() const {
 265   return (oop *)(fp() + interpreter_frame_oop_temp_offset);
 266 }
 267 
 268 #endif /* CC_INTERP */
 269 
 270 inline int frame::pd_oop_map_offset_adjustment() const {
 271   return 0;
 272 }
 273 
 274 inline int frame::interpreter_frame_monitor_size() {
 275   return BasicObjectLock::size();
 276 }
 277 
 278 
 279 // expression stack
 280 // (the max_stack arguments are used by the GC; see class FrameClosure)
 281 
 282 inline intptr_t* frame::interpreter_frame_expression_stack() const {
 283   intptr_t* monitor_end = (intptr_t*) interpreter_frame_monitor_end();
 284   return monitor_end-1;
 285 }
 286 
 287 
 288 inline jint frame::interpreter_frame_expression_stack_direction() { return -1; }
 289 
 290 
 291 // Entry frames
 292 
 293 inline JavaCallWrapper** frame::entry_frame_call_wrapper_addr() const {
 294  return (JavaCallWrapper**)addr_at(entry_frame_call_wrapper_offset);
 295 }
 296 
 297 
 298 // Compiled frames
 299 
 300 inline int frame::local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 301   return (nof_args - local_index + (local_index < nof_args ? 1: -1));
 302 }
 303 
 304 inline int frame::monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 305   return local_offset_for_compiler(local_index, nof_args, max_nof_locals, max_nof_monitors);
 306 }
 307 
 308 inline int frame::min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors) {
 309   return (nof_args - (max_nof_locals + max_nof_monitors*2) - 1);
 310 }
 311 
 312 inline bool frame::volatile_across_calls(Register reg) {
 313   return true;
 314 }
 315 
 316 
 317 
 318 inline oop frame::saved_oop_result(RegisterMap* map) const {
 319   oop* result_adr = (oop *)map->location(r0->as_VMReg());
 320   guarantee(result_adr != NULL, "bad register save location");
 321 
 322   return (*result_adr);
 323 }
 324 
 325 inline void frame::set_saved_oop_result(RegisterMap* map, oop obj) {
 326   oop* result_adr = (oop *)map->location(r0->as_VMReg());
 327   guarantee(result_adr != NULL, "bad register save location");
 328 
 329   *result_adr = obj;
 330 }
 331 
 332 #endif // CPU_AARCH64_VM_FRAME_AARCH64_INLINE_HPP