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