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