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