1 /*
   2  * Copyright (c) 2008, 2019, 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_ARM_FRAME_ARM_INLINE_HPP
  26 #define CPU_ARM_FRAME_ARM_INLINE_HPP
  27 
  28 #include "code/codeCache.hpp"
  29 #include "code/vmreg.inline.hpp"
  30 
  31 // Inline functions for ARM 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     _deopt_state = not_deoptimized;
  83   }
  84 }
  85 
  86 
  87 inline frame::frame(intptr_t* sp, intptr_t* fp) {
  88   _sp = sp;
  89   _unextended_sp = sp;
  90   _fp = fp;
  91   assert(sp != NULL,"null SP ?");
  92   _pc = (address)(sp[-1]);
  93   // assert(_pc != NULL, "no pc?"); // see comments in x86
  94   _cb = CodeCache::find_blob(_pc);
  95   adjust_unextended_sp();
  96 
  97   address original_pc = CompiledMethod::get_deopt_original_pc(this);
  98   if (original_pc != NULL) {
  99     _pc = original_pc;
 100     _deopt_state = is_deoptimized;
 101   } else {
 102     _deopt_state = not_deoptimized;
 103   }
 104 }
 105 
 106 
 107 // Accessors
 108 
 109 inline bool frame::equal(frame other) const {
 110   bool ret =  sp() == other.sp()
 111               && unextended_sp() == other.unextended_sp()
 112               && fp() == other.fp()
 113               && pc() == other.pc();
 114   assert(!ret || ret && cb() == other.cb() && _deopt_state == other._deopt_state, "inconsistent construction");
 115   return ret;
 116 }
 117 
 118 // Return unique id for this frame. The id must have a value where we can distinguish
 119 // identity and younger/older relationship. NULL represents an invalid (incomparable)
 120 // frame.
 121 inline intptr_t* frame::id(void) const { return unextended_sp(); }
 122 
 123 // Return true if the frame is older (less recent activation) than the frame represented by id
 124 inline bool frame::is_older(intptr_t* id) const   { assert(this->id() != NULL && id != NULL, "NULL frame id");
 125                                                     return this->id() > id ; }
 126 
 127 
 128 inline intptr_t* frame::link() const              { return (intptr_t*) *(intptr_t **)addr_at(link_offset); }
 129 
 130 inline intptr_t* frame::unextended_sp() const     { return _unextended_sp; }
 131 
 132 // Return address:
 133 
 134 inline address* frame::sender_pc_addr()      const { return (address*) addr_at(return_addr_offset); }
 135 inline address  frame::sender_pc()           const { return *sender_pc_addr(); }
 136 
 137 inline intptr_t* frame::sender_sp() const { return addr_at(sender_sp_offset); }
 138 
 139 inline intptr_t** frame::interpreter_frame_locals_addr() const {
 140   return (intptr_t**)addr_at(interpreter_frame_locals_offset);
 141 }
 142 
 143 inline intptr_t* frame::interpreter_frame_last_sp() const {
 144   return *(intptr_t**)addr_at(interpreter_frame_last_sp_offset);
 145 }
 146 
 147 inline intptr_t* frame::interpreter_frame_bcp_addr() const {
 148   return (intptr_t*)addr_at(interpreter_frame_bcp_offset);
 149 }
 150 
 151 inline intptr_t* frame::interpreter_frame_mdp_addr() const {
 152   return (intptr_t*)addr_at(interpreter_frame_mdp_offset);
 153 }
 154 
 155 
 156 // Constant pool cache
 157 
 158 inline ConstantPoolCache** frame::interpreter_frame_cache_addr() const {
 159   return (ConstantPoolCache**)addr_at(interpreter_frame_cache_offset);
 160 }
 161 
 162 // Method
 163 
 164 inline Method** frame::interpreter_frame_method_addr() const {
 165   return (Method**)addr_at(interpreter_frame_method_offset);
 166 }
 167 
 168 inline oop* frame::interpreter_frame_mirror_addr() const {
 169   return (oop*)addr_at(interpreter_frame_mirror_offset);
 170 }
 171 
 172 // top of expression stack
 173 inline intptr_t* frame::interpreter_frame_tos_address() const {
 174   intptr_t* last_sp = interpreter_frame_last_sp();
 175   if (last_sp == NULL ) {
 176     return sp();
 177   } else {
 178     // sp() may have been extended or shrunk by an adapter.  At least
 179     // check that we don't fall behind the legal region.
 180     // For top deoptimized frame last_sp == interpreter_frame_monitor_end.
 181     assert(last_sp <= (intptr_t*) interpreter_frame_monitor_end(), "bad tos");
 182     return last_sp;
 183   }
 184 }
 185 
 186 inline oop* frame::interpreter_frame_temp_oop_addr() const {
 187   return (oop *)(fp() + interpreter_frame_oop_temp_offset);
 188 }
 189 
 190 inline int frame::interpreter_frame_monitor_size() {
 191   return BasicObjectLock::size();
 192 }
 193 
 194 
 195 // expression stack
 196 // (the max_stack arguments are used by the GC; see class FrameClosure)
 197 
 198 inline intptr_t* frame::interpreter_frame_expression_stack() const {
 199   intptr_t* monitor_end = (intptr_t*) interpreter_frame_monitor_end();
 200   return monitor_end-1;
 201 }
 202 
 203 
 204 // Entry frames
 205 
 206 inline JavaCallWrapper** frame::entry_frame_call_wrapper_addr() const {
 207  return (JavaCallWrapper**)addr_at(entry_frame_call_wrapper_offset);
 208 }
 209 
 210 
 211 // Compiled frames
 212 
 213 inline oop frame::saved_oop_result(RegisterMap* map) const {
 214   oop* result_adr = (oop*) map->location(R0->as_VMReg());
 215   guarantee(result_adr != NULL, "bad register save location");
 216   return (*result_adr);
 217 }
 218 
 219 inline void frame::set_saved_oop_result(RegisterMap* map, oop obj) {
 220   oop* result_adr = (oop*) map->location(R0->as_VMReg());
 221   guarantee(result_adr != NULL, "bad register save location");
 222   *result_adr = obj;
 223 }
 224 
 225 #endif // CPU_ARM_FRAME_ARM_INLINE_HPP