1 /*
   2  * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright 2012, 2014 SAP AG. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #include "precompiled.hpp"
  27 #include "interpreter/interpreter.hpp"
  28 #include "memory/resourceArea.hpp"
  29 #include "oops/markOop.hpp"
  30 #include "oops/method.hpp"
  31 #include "oops/oop.inline.hpp"
  32 #include "runtime/frame.inline.hpp"
  33 #include "runtime/handles.inline.hpp"
  34 #include "runtime/javaCalls.hpp"
  35 #include "runtime/monitorChunk.hpp"
  36 #include "runtime/signature.hpp"
  37 #include "runtime/stubCodeGenerator.hpp"
  38 #include "runtime/stubRoutines.hpp"
  39 #ifdef COMPILER1
  40 #include "c1/c1_Runtime1.hpp"
  41 #include "runtime/vframeArray.hpp"
  42 #endif
  43 
  44 #ifdef ASSERT
  45 void RegisterMap::check_location_valid() {
  46 }
  47 #endif // ASSERT
  48 
  49 bool frame::safe_for_sender(JavaThread *thread) {
  50   bool safe = false;
  51   address   cursp = (address)sp();
  52   address   curfp = (address)fp();
  53   if ((cursp != NULL && curfp != NULL &&
  54       (cursp <= thread->stack_base() && cursp >= thread->stack_base() - thread->stack_size())) &&
  55       (curfp <= thread->stack_base() && curfp >= thread->stack_base() - thread->stack_size())) {
  56       safe = true;
  57   }
  58   return safe;
  59 }
  60 
  61 bool frame::is_interpreted_frame() const  {
  62   return Interpreter::contains(pc());
  63 }
  64 
  65 frame frame::sender_for_entry_frame(RegisterMap *map) const {
  66   assert(map != NULL, "map must be set");
  67   // Java frame called from C; skip all C frames and return top C
  68   // frame of that chunk as the sender.
  69   JavaFrameAnchor* jfa = entry_frame_call_wrapper()->anchor();
  70   assert(!entry_frame_is_first(), "next Java fp must be non zero");
  71   assert(jfa->last_Java_sp() > _sp, "must be above this frame on stack");
  72   map->clear();
  73   assert(map->include_argument_oops(), "should be set by clear");
  74 
  75   if (jfa->last_Java_pc() != NULL) {
  76     frame fr(jfa->last_Java_sp(), jfa->last_Java_pc());
  77     return fr;
  78   }
  79   // Last_java_pc is not set, if we come here from compiled code. The
  80   // constructor retrieves the PC from the stack.
  81   frame fr(jfa->last_Java_sp());
  82   return fr;
  83 }
  84 
  85 frame frame::sender_for_interpreter_frame(RegisterMap *map) const {
  86   // Pass callers initial_caller_sp as unextended_sp.
  87   return frame(sender_sp(), sender_pc(),
  88                CC_INTERP_ONLY((intptr_t*)((parent_ijava_frame_abi *)callers_abi())->initial_caller_sp)
  89                NOT_CC_INTERP((intptr_t*)get_ijava_state()->sender_sp)
  90                );
  91 }
  92 
  93 frame frame::sender_for_compiled_frame(RegisterMap *map) const {
  94   assert(map != NULL, "map must be set");
  95 
  96   // Frame owned by compiler.
  97   address pc = *compiled_sender_pc_addr(_cb);
  98   frame caller(compiled_sender_sp(_cb), pc);
  99 
 100   // Now adjust the map.
 101 
 102   // Get the rest.
 103   if (map->update_map()) {
 104     // Tell GC to use argument oopmaps for some runtime stubs that need it.
 105     map->set_include_argument_oops(_cb->caller_must_gc_arguments(map->thread()));
 106     if (_cb->oop_maps() != NULL) {
 107       OopMapSet::update_register_map(this, map);
 108     }
 109   }
 110 
 111   return caller;
 112 }
 113 
 114 intptr_t* frame::compiled_sender_sp(CodeBlob* cb) const {
 115   return sender_sp();
 116 }
 117 
 118 address* frame::compiled_sender_pc_addr(CodeBlob* cb) const {
 119   return sender_pc_addr();
 120 }
 121 
 122 frame frame::sender(RegisterMap* map) const {
 123   // Default is we do have to follow them. The sender_for_xxx will
 124   // update it accordingly.
 125   map->set_include_argument_oops(false);
 126 
 127   if (is_entry_frame())       return sender_for_entry_frame(map);
 128   if (is_interpreted_frame()) return sender_for_interpreter_frame(map);
 129   assert(_cb == CodeCache::find_blob(pc()),"Must be the same");
 130 
 131   if (_cb != NULL) {
 132     return sender_for_compiled_frame(map);
 133   }
 134   // Must be native-compiled frame, i.e. the marshaling code for native
 135   // methods that exists in the core system.
 136   return frame(sender_sp(), sender_pc());
 137 }
 138 
 139 void frame::patch_pc(Thread* thread, address pc) {
 140   if (TracePcPatching) {
 141     tty->print_cr("patch_pc at address " PTR_FORMAT " [" PTR_FORMAT " -> " PTR_FORMAT "]",
 142                   p2i(&((address*) _sp)[-1]), p2i(((address*) _sp)[-1]), p2i(pc));
 143   }
 144   own_abi()->lr = (uint64_t)pc;
 145   _cb = CodeCache::find_blob(pc);
 146   if (_cb != NULL && _cb->is_nmethod() && ((nmethod*)_cb)->is_deopt_pc(_pc)) {
 147     address orig = (((nmethod*)_cb)->get_original_pc(this));
 148     assert(orig == _pc, "expected original to be stored before patching");
 149     _deopt_state = is_deoptimized;
 150     // Leave _pc as is.
 151   } else {
 152     _deopt_state = not_deoptimized;
 153     _pc = pc;
 154   }
 155 }
 156 
 157 bool frame::is_interpreted_frame_valid(JavaThread* thread) const {
 158   // Is there anything to do?
 159   assert(is_interpreted_frame(), "Not an interpreted frame");
 160   return true;
 161 }
 162 
 163 BasicType frame::interpreter_frame_result(oop* oop_result, jvalue* value_result) {
 164   assert(is_interpreted_frame(), "interpreted frame expected");
 165   Method* method = interpreter_frame_method();
 166   BasicType type = method->result_type();
 167 
 168   if (method->is_native()) {
 169     // Prior to calling into the runtime to notify the method exit the possible
 170     // result value is saved into the interpreter frame.
 171 #ifdef CC_INTERP
 172     interpreterState istate = get_interpreterState();
 173     address lresult = (address)istate + in_bytes(BytecodeInterpreter::native_lresult_offset());
 174     address fresult = (address)istate + in_bytes(BytecodeInterpreter::native_fresult_offset());
 175 #else
 176     address lresult = (address)&(get_ijava_state()->lresult);
 177     address fresult = (address)&(get_ijava_state()->fresult);
 178 #endif
 179 
 180     switch (method->result_type()) {
 181       case T_OBJECT:
 182       case T_ARRAY: {
 183         oop* obj_p = *(oop**)lresult;
 184         oop obj = (obj_p == NULL) ? (oop)NULL : *obj_p;
 185         assert(obj == NULL || Universe::heap()->is_in(obj), "sanity check");
 186         *oop_result = obj;
 187         break;
 188       }
 189       // We use std/stfd to store the values.
 190       case T_BOOLEAN : value_result->z = (jboolean) *(unsigned long*)lresult; break;
 191       case T_INT     : value_result->i = (jint)     *(long*)lresult;          break;
 192       case T_CHAR    : value_result->c = (jchar)    *(unsigned long*)lresult; break;
 193       case T_SHORT   : value_result->s = (jshort)   *(long*)lresult;          break;
 194       case T_BYTE    : value_result->z = (jbyte)    *(long*)lresult;          break;
 195       case T_LONG    : value_result->j = (jlong)    *(long*)lresult;          break;
 196       case T_FLOAT   : value_result->f = (jfloat)   *(double*)fresult;        break;
 197       case T_DOUBLE  : value_result->d = (jdouble)  *(double*)fresult;        break;
 198       case T_VOID    : /* Nothing to do */ break;
 199       default        : ShouldNotReachHere();
 200     }
 201   } else {
 202     intptr_t* tos_addr = interpreter_frame_tos_address();
 203     switch (method->result_type()) {
 204       case T_OBJECT:
 205       case T_ARRAY: {
 206         oop obj = *(oop*)tos_addr;
 207         assert(obj == NULL || Universe::heap()->is_in(obj), "sanity check");
 208         *oop_result = obj;
 209       }
 210       case T_BOOLEAN : value_result->z = (jboolean) *(jint*)tos_addr; break;
 211       case T_BYTE    : value_result->b = (jbyte) *(jint*)tos_addr; break;
 212       case T_CHAR    : value_result->c = (jchar) *(jint*)tos_addr; break;
 213       case T_SHORT   : value_result->s = (jshort) *(jint*)tos_addr; break;
 214       case T_INT     : value_result->i = *(jint*)tos_addr; break;
 215       case T_LONG    : value_result->j = *(jlong*)tos_addr; break;
 216       case T_FLOAT   : value_result->f = *(jfloat*)tos_addr; break;
 217       case T_DOUBLE  : value_result->d = *(jdouble*)tos_addr; break;
 218       case T_VOID    : /* Nothing to do */ break;
 219       default        : ShouldNotReachHere();
 220     }
 221   }
 222   return type;
 223 }
 224 
 225 #ifndef PRODUCT
 226 
 227 void frame::describe_pd(FrameValues& values, int frame_no) {
 228   if (is_interpreted_frame()) {
 229 #ifdef CC_INTERP
 230     interpreterState istate = get_interpreterState();
 231     values.describe(frame_no, (intptr_t*)istate, "istate");
 232     values.describe(frame_no, (intptr_t*)&(istate->_thread), " thread");
 233     values.describe(frame_no, (intptr_t*)&(istate->_bcp), " bcp");
 234     values.describe(frame_no, (intptr_t*)&(istate->_locals), " locals");
 235     values.describe(frame_no, (intptr_t*)&(istate->_constants), " constants");
 236     values.describe(frame_no, (intptr_t*)&(istate->_method), err_msg(" method = %s", istate->_method->name_and_sig_as_C_string()));
 237     values.describe(frame_no, (intptr_t*)&(istate->_mdx), " mdx");
 238     values.describe(frame_no, (intptr_t*)&(istate->_stack), " stack");
 239     values.describe(frame_no, (intptr_t*)&(istate->_msg), err_msg(" msg = %s", BytecodeInterpreter::C_msg(istate->_msg)));
 240     values.describe(frame_no, (intptr_t*)&(istate->_result), " result");
 241     values.describe(frame_no, (intptr_t*)&(istate->_prev_link), " prev_link");
 242     values.describe(frame_no, (intptr_t*)&(istate->_oop_temp), " oop_temp");
 243     values.describe(frame_no, (intptr_t*)&(istate->_stack_base), " stack_base");
 244     values.describe(frame_no, (intptr_t*)&(istate->_stack_limit), " stack_limit");
 245     values.describe(frame_no, (intptr_t*)&(istate->_monitor_base), " monitor_base");
 246     values.describe(frame_no, (intptr_t*)&(istate->_frame_bottom), " frame_bottom");
 247     values.describe(frame_no, (intptr_t*)&(istate->_last_Java_pc), " last_Java_pc");
 248     values.describe(frame_no, (intptr_t*)&(istate->_last_Java_fp), " last_Java_fp");
 249     values.describe(frame_no, (intptr_t*)&(istate->_last_Java_sp), " last_Java_sp");
 250     values.describe(frame_no, (intptr_t*)&(istate->_self_link), " self_link");
 251     values.describe(frame_no, (intptr_t*)&(istate->_native_fresult), " native_fresult");
 252     values.describe(frame_no, (intptr_t*)&(istate->_native_lresult), " native_lresult");
 253 #else
 254 #define DESCRIBE_ADDRESS(name) \
 255   values.describe(frame_no, (intptr_t*)&(get_ijava_state()->name), #name);
 256 
 257       DESCRIBE_ADDRESS(method);
 258       DESCRIBE_ADDRESS(locals);
 259       DESCRIBE_ADDRESS(monitors);
 260       DESCRIBE_ADDRESS(cpoolCache);
 261       DESCRIBE_ADDRESS(bcp);
 262       DESCRIBE_ADDRESS(esp);
 263       DESCRIBE_ADDRESS(mdx);
 264       DESCRIBE_ADDRESS(top_frame_sp);
 265       DESCRIBE_ADDRESS(sender_sp);
 266       DESCRIBE_ADDRESS(oop_tmp);
 267       DESCRIBE_ADDRESS(lresult);
 268       DESCRIBE_ADDRESS(fresult);
 269 #endif
 270   }
 271 }
 272 #endif
 273 
 274 void frame::adjust_unextended_sp() {
 275   // If we are returning to a compiled MethodHandle call site, the
 276   // saved_fp will in fact be a saved value of the unextended SP. The
 277   // simplest way to tell whether we are returning to such a call site
 278   // is as follows:
 279 
 280   if (is_compiled_frame() && false /*is_at_mh_callsite()*/) {  // TODO PPC port
 281     // If the sender PC is a deoptimization point, get the original
 282     // PC. For MethodHandle call site the unextended_sp is stored in
 283     // saved_fp.
 284     _unextended_sp = _fp - _cb->frame_size();
 285 
 286 #ifdef ASSERT
 287     nmethod *sender_nm = _cb->as_nmethod_or_null();
 288     assert(sender_nm && *_sp == *_unextended_sp, "backlink changed");
 289 
 290     intptr_t* sp = _unextended_sp;  // check if stack can be walked from here
 291     for (int x = 0; x < 5; ++x) {   // check up to a couple of backlinks
 292       intptr_t* prev_sp = *(intptr_t**)sp;
 293       if (prev_sp == 0) break;      // end of stack
 294       assert(prev_sp>sp, "broken stack");
 295       sp = prev_sp;
 296     }
 297 
 298     if (sender_nm->is_deopt_mh_entry(_pc)) { // checks for deoptimization
 299       address original_pc = sender_nm->get_original_pc(this);
 300       assert(sender_nm->insts_contains(original_pc), "original PC must be in nmethod");
 301       assert(sender_nm->is_method_handle_return(original_pc), "must be");
 302     }
 303 #endif
 304   }
 305 }
 306 
 307 intptr_t *frame::initial_deoptimization_info() {
 308   // unused... but returns fp() to minimize changes introduced by 7087445
 309   return fp();
 310 }