1 /*
   2  * Copyright (c) 1997, 2018, 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(_cb->as_compiled_method()->insts_contains_inclusive(_pc),
  79            "original PC must be in the main code section of the the compiled method (or must be immediately following it)");
  80     _deopt_state = is_deoptimized;
  81   } else {
  82     if (_cb->is_deoptimization_stub()) {
  83       _deopt_state = is_deoptimized;
  84     } else {
  85       _deopt_state = not_deoptimized;
  86     }
  87   }
  88 }
  89 
  90 inline frame::frame(intptr_t* sp, intptr_t* fp) {
  91   _sp = sp;
  92   _unextended_sp = sp;
  93   _fp = fp;
  94   _pc = (address)(sp[-1]);
  95 
  96   // Here's a sticky one. This constructor can be called via AsyncGetCallTrace
  97   // when last_Java_sp is non-null but the pc fetched is junk. If we are truly
  98   // unlucky the junk value could be to a zombied method and we'll die on the
  99   // find_blob call. This is also why we can have no asserts on the validity
 100   // of the pc we find here. AsyncGetCallTrace -> pd_get_top_frame_for_signal_handler
 101   // -> pd_last_frame should use a specialized version of pd_last_frame which could
 102   // call a specialized frame constructor instead of this one.
 103   // Then we could use the assert below. However this assert is of somewhat dubious
 104   // value.
 105   // UPDATE: this constructor is only used by trace_method_handle_stub() now.
 106   // assert(_pc != NULL, "no pc?");
 107 
 108   _cb = CodeCache::find_blob(_pc);
 109   adjust_unextended_sp();
 110 
 111   address original_pc = CompiledMethod::get_deopt_original_pc(this);
 112   if (original_pc != NULL) {
 113     _pc = original_pc;
 114     _deopt_state = is_deoptimized;
 115   } else {
 116     _deopt_state = not_deoptimized;
 117   }
 118 }
 119 
 120 // Accessors
 121 
 122 inline bool frame::equal(frame other) const {
 123   bool ret =  sp() == other.sp()
 124               && unextended_sp() == other.unextended_sp()
 125               && fp() == other.fp()
 126               && pc() == other.pc();
 127   assert(!ret || ret && cb() == other.cb() && _deopt_state == other._deopt_state, "inconsistent construction");
 128   return ret;
 129 }
 130 
 131 // Return unique id for this frame. The id must have a value where we can distinguish
 132 // identity and younger/older relationship. NULL represents an invalid (incomparable)
 133 // frame.
 134 inline intptr_t* frame::id(void) const { return unextended_sp(); }
 135 
 136 // Relationals on frames based
 137 // Return true if the frame is younger (more recent activation) than the frame represented by id
 138 inline bool frame::is_younger(intptr_t* id) const { assert(this->id() != NULL && id != NULL, "NULL frame id");
 139                                                     return this->id() < id ; }
 140 
 141 // Return true if the frame is older (less recent activation) than the frame represented by id
 142 inline bool frame::is_older(intptr_t* id) const   { assert(this->id() != NULL && id != NULL, "NULL frame id");
 143                                                     return this->id() > id ; }
 144 
 145 
 146 
 147 inline intptr_t* frame::link() const              { return (intptr_t*) *(intptr_t **)addr_at(link_offset); }
 148 
 149 inline intptr_t* frame::unextended_sp() const     { return _unextended_sp; }
 150 
 151 // Return address:
 152 
 153 inline address* frame::sender_pc_addr()      const { return (address*) addr_at( return_addr_offset); }
 154 inline address  frame::sender_pc()           const { return *sender_pc_addr(); }
 155 
 156 inline intptr_t*    frame::sender_sp()        const { return            addr_at(   sender_sp_offset); }
 157 
 158 inline intptr_t** frame::interpreter_frame_locals_addr() const {
 159   return (intptr_t**)addr_at(interpreter_frame_locals_offset);
 160 }
 161 
 162 inline intptr_t* frame::interpreter_frame_last_sp() const {
 163   return *(intptr_t**)addr_at(interpreter_frame_last_sp_offset);
 164 }
 165 
 166 inline intptr_t* frame::interpreter_frame_bcp_addr() const {
 167   return (intptr_t*)addr_at(interpreter_frame_bcp_offset);
 168 }
 169 
 170 
 171 inline intptr_t* frame::interpreter_frame_mdp_addr() const {
 172   return (intptr_t*)addr_at(interpreter_frame_mdp_offset);
 173 }
 174 
 175 
 176 
 177 // Constant pool cache
 178 
 179 inline ConstantPoolCache** frame::interpreter_frame_cache_addr() const {
 180   return (ConstantPoolCache**)addr_at(interpreter_frame_cache_offset);
 181 }
 182 
 183 // Method
 184 
 185 inline Method** frame::interpreter_frame_method_addr() const {
 186   return (Method**)addr_at(interpreter_frame_method_offset);
 187 }
 188 
 189 // Mirror
 190 
 191 inline oop* frame::interpreter_frame_mirror_addr() const {
 192   return (oop*)addr_at(interpreter_frame_mirror_offset);
 193 }
 194 
 195 inline intptr_t** frame::interpreter_frame_vt_alloc_ptr_addr() const {
 196   return (intptr_t**)addr_at(interpreter_frame_vt_alloc_ptr_offset);
 197 }
 198 
 199 // top of expression stack
 200 inline intptr_t* frame::interpreter_frame_tos_address() const {
 201   intptr_t* last_sp = interpreter_frame_last_sp();
 202   if (last_sp == NULL) {
 203     return sp();
 204   } else {
 205     // sp() may have been extended or shrunk by an adapter.  At least
 206     // check that we don't fall behind the legal region.
 207     // For top deoptimized frame last_sp == interpreter_frame_monitor_end.
 208     assert(last_sp <= (intptr_t*) interpreter_frame_monitor_end(), "bad tos");
 209     return last_sp;
 210   }
 211 }
 212 
 213 inline oop* frame::interpreter_frame_temp_oop_addr() const {
 214   return (oop *)(fp() + interpreter_frame_oop_temp_offset);
 215 }
 216 
 217 inline int frame::interpreter_frame_monitor_size() {
 218   return BasicObjectLock::size();
 219 }
 220 
 221 
 222 // expression stack
 223 // (the max_stack arguments are used by the GC; see class FrameClosure)
 224 
 225 inline intptr_t* frame::interpreter_frame_expression_stack() const {
 226   intptr_t* monitor_end = (intptr_t*) interpreter_frame_monitor_end();
 227   return monitor_end-1;
 228 }
 229 
 230 // Entry frames
 231 
 232 inline JavaCallWrapper** frame::entry_frame_call_wrapper_addr() const {
 233  return (JavaCallWrapper**)addr_at(entry_frame_call_wrapper_offset);
 234 }
 235 
 236 // Compiled frames
 237 
 238 inline oop frame::saved_oop_result(RegisterMap* map) const {
 239   oop* result_adr = (oop *)map->location(rax->as_VMReg());
 240   guarantee(result_adr != NULL, "bad register save location");
 241 
 242   return (*result_adr);
 243 }
 244 
 245 inline void frame::set_saved_oop_result(RegisterMap* map, oop obj) {
 246   oop* result_adr = (oop *)map->location(rax->as_VMReg());
 247   guarantee(result_adr != NULL, "bad register save location");
 248 
 249   *result_adr = obj;
 250 }
 251 
 252 #endif // CPU_X86_VM_FRAME_X86_INLINE_HPP