1 /*
   2  * Copyright (c) 1997, 2016, 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 = CompiledMethod::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 = CompiledMethod::get_deopt_original_pc(this);
  76   if (original_pc != NULL) {
  77     _pc = original_pc;
  78     assert(((CompiledMethod*)_cb)->insts_contains(_pc), "original PC must be in CompiledMethod");
  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   // UPDATE: this constructor is only used by trace_method_handle_stub() now.
 105   // assert(_pc != NULL, "no pc?");
 106 
 107   _cb = CodeCache::find_blob(_pc);
 108   adjust_unextended_sp();
 109 
 110   address original_pc = CompiledMethod::get_deopt_original_pc(this);
 111   if (original_pc != NULL) {
 112     _pc = original_pc;
 113     _deopt_state = is_deoptimized;
 114   } else {
 115     _deopt_state = not_deoptimized;
 116   }
 117 }
 118 
 119 // Accessors
 120 
 121 inline bool frame::equal(frame other) const {
 122   bool ret =  sp() == other.sp()
 123               && unextended_sp() == other.unextended_sp()
 124               && fp() == other.fp()
 125               && pc() == other.pc();
 126   assert(!ret || ret && cb() == other.cb() && _deopt_state == other._deopt_state, "inconsistent construction");
 127   return ret;
 128 }
 129 
 130 // Return unique id for this frame. The id must have a value where we can distinguish
 131 // identity and younger/older relationship. NULL represents an invalid (incomparable)
 132 // frame.
 133 inline intptr_t* frame::id(void) const { return unextended_sp(); }
 134 
 135 // Relationals on frames based
 136 // Return true if the frame is younger (more recent activation) than the frame represented by id
 137 inline bool frame::is_younger(intptr_t* id) const { assert(this->id() != NULL && id != NULL, "NULL frame id");
 138                                                     return this->id() < id ; }
 139 
 140 // Return true if the frame is older (less recent activation) than the frame represented by id
 141 inline bool frame::is_older(intptr_t* id) const   { assert(this->id() != NULL && id != NULL, "NULL frame id");
 142                                                     return this->id() > id ; }
 143 
 144 
 145 
 146 inline intptr_t* frame::link() const              { return (intptr_t*) *(intptr_t **)addr_at(link_offset); }
 147 
 148 inline intptr_t* frame::unextended_sp() const     { return _unextended_sp; }
 149 
 150 // Return address:
 151 
 152 inline address* frame::sender_pc_addr()      const { return (address*) addr_at( return_addr_offset); }
 153 inline address  frame::sender_pc()           const { return *sender_pc_addr(); }
 154 
 155 inline intptr_t*    frame::sender_sp()        const { return            addr_at(   sender_sp_offset); }
 156 
 157 inline intptr_t** frame::interpreter_frame_locals_addr() const {
 158   return (intptr_t**)addr_at(interpreter_frame_locals_offset);
 159 }
 160 
 161 inline intptr_t* frame::interpreter_frame_last_sp() const {
 162   return *(intptr_t**)addr_at(interpreter_frame_last_sp_offset);
 163 }
 164 
 165 inline intptr_t* frame::interpreter_frame_bcp_addr() const {
 166   return (intptr_t*)addr_at(interpreter_frame_bcp_offset);
 167 }
 168 
 169 
 170 inline intptr_t* frame::interpreter_frame_mdp_addr() const {
 171   return (intptr_t*)addr_at(interpreter_frame_mdp_offset);
 172 }
 173 
 174 
 175 
 176 // Constant pool cache
 177 
 178 inline ConstantPoolCache** frame::interpreter_frame_cache_addr() const {
 179   return (ConstantPoolCache**)addr_at(interpreter_frame_cache_offset);
 180 }
 181 
 182 // Method
 183 
 184 inline Method** frame::interpreter_frame_method_addr() const {
 185   return (Method**)addr_at(interpreter_frame_method_offset);
 186 }
 187 
 188 // Mirror
 189 
 190 inline oop* frame::interpreter_frame_mirror_addr() const {
 191   return (oop*)addr_at(interpreter_frame_mirror_offset);
 192 }
 193 
 194 // top of expression stack
 195 inline intptr_t* frame::interpreter_frame_tos_address() const {
 196   intptr_t* last_sp = interpreter_frame_last_sp();
 197   if (last_sp == NULL) {
 198     return sp();
 199   } else {
 200     // sp() may have been extended or shrunk by an adapter.  At least
 201     // check that we don't fall behind the legal region.
 202     // For top deoptimized frame last_sp == interpreter_frame_monitor_end.
 203     assert(last_sp <= (intptr_t*) interpreter_frame_monitor_end(), "bad tos");
 204     return last_sp;
 205   }
 206 }
 207 
 208 inline oop* frame::interpreter_frame_temp_oop_addr() const {
 209   return (oop *)(fp() + interpreter_frame_oop_temp_offset);
 210 }
 211 
 212 inline int frame::pd_oop_map_offset_adjustment() const {
 213   return 0;
 214 }
 215 
 216 inline int frame::interpreter_frame_monitor_size() {
 217   return BasicObjectLock::size();
 218 }
 219 
 220 
 221 // expression stack
 222 // (the max_stack arguments are used by the GC; see class FrameClosure)
 223 
 224 inline intptr_t* frame::interpreter_frame_expression_stack() const {
 225   intptr_t* monitor_end = (intptr_t*) interpreter_frame_monitor_end();
 226   return monitor_end-1;
 227 }
 228 
 229 
 230 inline jint frame::interpreter_frame_expression_stack_direction() { return -1; }
 231 
 232 
 233 // Entry frames
 234 
 235 inline JavaCallWrapper** frame::entry_frame_call_wrapper_addr() const {
 236  return (JavaCallWrapper**)addr_at(entry_frame_call_wrapper_offset);
 237 }
 238 
 239 // Compiled frames
 240 
 241 inline int frame::local_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 242   return (nof_args - local_index + (local_index < nof_args ? 1: -1));
 243 }
 244 
 245 inline int frame::monitor_offset_for_compiler(int local_index, int nof_args, int max_nof_locals, int max_nof_monitors) {
 246   return local_offset_for_compiler(local_index, nof_args, max_nof_locals, max_nof_monitors);
 247 }
 248 
 249 inline int frame::min_local_offset_for_compiler(int nof_args, int max_nof_locals, int max_nof_monitors) {
 250   return (nof_args - (max_nof_locals + max_nof_monitors*2) - 1);
 251 }
 252 
 253 inline bool frame::volatile_across_calls(Register reg) {
 254   return true;
 255 }
 256 
 257 inline oop frame::saved_oop_result(RegisterMap* map) const {
 258   oop* result_adr = (oop *)map->location(rax->as_VMReg());
 259   guarantee(result_adr != NULL, "bad register save location");
 260 
 261   return (*result_adr);
 262 }
 263 
 264 inline void frame::set_saved_oop_result(RegisterMap* map, oop obj) {
 265   oop* result_adr = (oop *)map->location(rax->as_VMReg());
 266   guarantee(result_adr != NULL, "bad register save location");
 267 
 268   *result_adr = obj;
 269 }
 270 
 271 #endif // CPU_X86_VM_FRAME_X86_INLINE_HPP