1/*
2 * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2012, 2017 SAP SE. 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
45void RegisterMap::check_location_valid() {
46}
47#endif // ASSERT
48
49bool 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
61bool frame::is_interpreted_frame() const  {
62  return Interpreter::contains(pc());
63}
64
65frame 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
85frame frame::sender_for_interpreter_frame(RegisterMap *map) const {
86  // Pass callers initial_caller_sp as unextended_sp.
87  return frame(sender_sp(), sender_pc(), (intptr_t*)get_ijava_state()->sender_sp);
88}
89
90frame frame::sender_for_compiled_frame(RegisterMap *map) const {
91  assert(map != NULL, "map must be set");
92
93  // Frame owned by compiler.
94  address pc = *compiled_sender_pc_addr(_cb);
95  frame caller(compiled_sender_sp(_cb), pc);
96
97  // Now adjust the map.
98
99  // Get the rest.
100  if (map->update_map()) {
101    // Tell GC to use argument oopmaps for some runtime stubs that need it.
102    map->set_include_argument_oops(_cb->caller_must_gc_arguments(map->thread()));
103    if (_cb->oop_maps() != NULL) {
104      OopMapSet::update_register_map(this, map);
105    }
106  }
107
108  return caller;
109}
110
111intptr_t* frame::compiled_sender_sp(CodeBlob* cb) const {
112  return sender_sp();
113}
114
115address* frame::compiled_sender_pc_addr(CodeBlob* cb) const {
116  return sender_pc_addr();
117}
118
119frame frame::sender(RegisterMap* map) const {
120  // Default is we do have to follow them. The sender_for_xxx will
121  // update it accordingly.
122  map->set_include_argument_oops(false);
123
124  if (is_entry_frame())       return sender_for_entry_frame(map);
125  if (is_interpreted_frame()) return sender_for_interpreter_frame(map);
126  assert(_cb == CodeCache::find_blob(pc()),"Must be the same");
127
128  if (_cb != NULL) {
129    return sender_for_compiled_frame(map);
130  }
131  // Must be native-compiled frame, i.e. the marshaling code for native
132  // methods that exists in the core system.
133  return frame(sender_sp(), sender_pc());
134}
135
136void frame::patch_pc(Thread* thread, address pc) {
137  if (TracePcPatching) {
138    tty->print_cr("patch_pc at address " PTR_FORMAT " [" PTR_FORMAT " -> " PTR_FORMAT "]",
139                  p2i(&((address*) _sp)[-1]), p2i(((address*) _sp)[-1]), p2i(pc));
140  }
141  own_abi()->lr = (uint64_t)pc;
142  _cb = CodeCache::find_blob(pc);
143  if (_cb != NULL && _cb->is_nmethod() && ((nmethod*)_cb)->is_deopt_pc(_pc)) {
144    address orig = (((nmethod*)_cb)->get_original_pc(this));
145    assert(orig == _pc, "expected original to be stored before patching");
146    _deopt_state = is_deoptimized;
147    // Leave _pc as is.
148  } else {
149    _deopt_state = not_deoptimized;
150    _pc = pc;
151  }
152}
153
154bool frame::is_interpreted_frame_valid(JavaThread* thread) const {
155  // Is there anything to do?
156  assert(is_interpreted_frame(), "Not an interpreted frame");
157  return true;
158}
159
160BasicType frame::interpreter_frame_result(oop* oop_result, jvalue* value_result) {
161  assert(is_interpreted_frame(), "interpreted frame expected");
162  Method* method = interpreter_frame_method();
163  BasicType type = method->result_type();
164
165  if (method->is_native()) {
166    // Prior to calling into the runtime to notify the method exit the possible
167    // result value is saved into the interpreter frame.
168    address lresult = (address)&(get_ijava_state()->lresult);
169    address fresult = (address)&(get_ijava_state()->fresult);
170
171    switch (method->result_type()) {
172      case T_OBJECT:
173      case T_ARRAY: {
174        *oop_result = JNIHandles::resolve(*(jobject*)lresult);
175        break;
176      }
177      // We use std/stfd to store the values.
178      case T_BOOLEAN : value_result->z = (jboolean) *(unsigned long*)lresult; break;
179      case T_INT     : value_result->i = (jint)     *(long*)lresult;          break;
180      case T_CHAR    : value_result->c = (jchar)    *(unsigned long*)lresult; break;
181      case T_SHORT   : value_result->s = (jshort)   *(long*)lresult;          break;
182      case T_BYTE    : value_result->z = (jbyte)    *(long*)lresult;          break;
183      case T_LONG    : value_result->j = (jlong)    *(long*)lresult;          break;
184      case T_FLOAT   : value_result->f = (jfloat)   *(double*)fresult;        break;
185      case T_DOUBLE  : value_result->d = (jdouble)  *(double*)fresult;        break;
186      case T_VOID    : /* Nothing to do */ break;
187      default        : ShouldNotReachHere();
188    }
189  } else {
190    intptr_t* tos_addr = interpreter_frame_tos_address();
191    switch (method->result_type()) {
192      case T_OBJECT:
193      case T_ARRAY: {
194        oop obj = *(oop*)tos_addr;
195        assert(obj == NULL || Universe::heap()->is_in(obj), "sanity check");
196        *oop_result = obj;
197      }
198      case T_BOOLEAN : value_result->z = (jboolean) *(jint*)tos_addr; break;
199      case T_BYTE    : value_result->b = (jbyte) *(jint*)tos_addr; break;
200      case T_CHAR    : value_result->c = (jchar) *(jint*)tos_addr; break;
201      case T_SHORT   : value_result->s = (jshort) *(jint*)tos_addr; break;
202      case T_INT     : value_result->i = *(jint*)tos_addr; break;
203      case T_LONG    : value_result->j = *(jlong*)tos_addr; break;
204      case T_FLOAT   : value_result->f = *(jfloat*)tos_addr; break;
205      case T_DOUBLE  : value_result->d = *(jdouble*)tos_addr; break;
206      case T_VOID    : /* Nothing to do */ break;
207      default        : ShouldNotReachHere();
208    }
209  }
210  return type;
211}
212
213#ifndef PRODUCT
214
215void frame::describe_pd(FrameValues& values, int frame_no) {
216  if (is_interpreted_frame()) {
217#define DESCRIBE_ADDRESS(name) \
218  values.describe(frame_no, (intptr_t*)&(get_ijava_state()->name), #name);
219
220      DESCRIBE_ADDRESS(method);
221      DESCRIBE_ADDRESS(mirror);
222      DESCRIBE_ADDRESS(locals);
223      DESCRIBE_ADDRESS(monitors);
224      DESCRIBE_ADDRESS(cpoolCache);
225      DESCRIBE_ADDRESS(bcp);
226      DESCRIBE_ADDRESS(esp);
227      DESCRIBE_ADDRESS(mdx);
228      DESCRIBE_ADDRESS(top_frame_sp);
229      DESCRIBE_ADDRESS(sender_sp);
230      DESCRIBE_ADDRESS(oop_tmp);
231      DESCRIBE_ADDRESS(lresult);
232      DESCRIBE_ADDRESS(fresult);
233  }
234}
235#endif
236
237intptr_t *frame::initial_deoptimization_info() {
238  // unused... but returns fp() to minimize changes introduced by 7087445
239  return fp();
240}
241
242#ifndef PRODUCT
243// This is a generic constructor which is only used by pns() in debug.cpp.
244frame::frame(void* sp, void* fp, void* pc) : _sp((intptr_t*)sp), _unextended_sp((intptr_t*)sp) {
245  find_codeblob_and_set_pc_and_deopt_state((address)pc); // also sets _fp and adjusts _unextended_sp
246}
247#endif
248