2 * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.
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
25 #ifndef CPU_X86_VM_FRAME_X86_HPP
26 #define CPU_X86_VM_FRAME_X86_HPP
28 #include "runtime/synchronizer.hpp"
29 #include "utilities/top.hpp"
31 // A frame represents a physical stack frame (an activation). Frames can be
32 // C or Java frames, and the Java frames can be interpreted or compiled.
33 // In contrast, vframes represent source-level activations, so that one physical frame
34 // can correspond to multiple source level frames because of inlining.
35 // A frame is comprised of {pc, fp, sp}
36 // ------------------------------ Asm interpreter ----------------------------------------
37 // Layout of asm interpreter frame:
38 // [expression stack ] * <- sp
40 // ... | monitor block size
42 // [monitor block size ]
43 // [byte code index/pointr] = bcx() bcx_offset
44 // [pointer to locals ] = locals() locals_offset
45 // [constant pool cache ] = cache() cache_offset
46 // [methodData ] = mdp() mdx_offset
47 // [methodOop ] = method() method_offset
48 // [last sp ] = last_sp() last_sp_offset
49 // [old stack pointer ] (sender_sp) sender_sp_offset
50 // [old frame pointer ] <- fp = link()
52 // [oop temp ] (only for native calls)
53 // [locals and parameters ]
55 // ------------------------------ Asm interpreter ----------------------------------------
57 // ------------------------------ C++ interpreter ----------------------------------------
59 // Layout of C++ interpreter frame: (While executing in BytecodeInterpreter::run)
61 // <- SP (current esp/rsp)
62 // [local variables ] BytecodeInterpreter::run local variables
63 // ... BytecodeInterpreter::run local variables
64 // [local variables ] BytecodeInterpreter::run local variables
65 // [old frame pointer ] fp [ BytecodeInterpreter::run's ebp/rbp ]
66 // [return pc ] (return to frame manager)
67 // [interpreter_state* ] (arg to BytecodeInterpreter::run) --------------
68 // [expression stack ] <- last_Java_sp |
69 // [... ] * <- interpreter_state.stack |
70 // [expression stack ] * <- interpreter_state.stack_base |
72 // ... | monitor block size |
73 // [monitors ] / <- interpreter_state.monitor_base |
74 // [struct interpretState ] <-----------------------------------------|
75 // [return pc ] (return to callee of frame manager [1]
76 // [locals and parameters ]
79 // [1] When the c++ interpreter calls a new method it returns to the frame
80 // manager which allocates a new frame on the stack. In that case there
81 // is no real callee of this newly allocated frame. The frame manager is
82 // aware of the additional frame(s) and will pop them as nested calls
83 // complete. Howevers tTo make it look good in the debugger the frame
84 // manager actually installs a dummy pc pointing to RecursiveInterpreterActivation
85 // with a fake interpreter_state* parameter to make it easy to debug
88 // Note that contrary to the layout for the assembly interpreter the
89 // expression stack allocated for the C++ interpreter is full sized.
90 // However this is not as bad as it seems as the interpreter frame_manager
91 // will truncate the unused space on succesive method calls.
93 // ------------------------------ C++ interpreter ----------------------------------------
100 return_addr_offset = 1,
101 // non-interpreter frames
102 sender_sp_offset = 2,
106 // Interpreter frames
107 interpreter_frame_result_handler_offset = 3, // for native calls only
108 interpreter_frame_oop_temp_offset = 2, // for native calls only
110 interpreter_frame_sender_sp_offset = -1,
111 // outgoing sp before a call to an invoked method
112 interpreter_frame_last_sp_offset = interpreter_frame_sender_sp_offset - 1,
113 interpreter_frame_method_offset = interpreter_frame_last_sp_offset - 1,
114 interpreter_frame_mdx_offset = interpreter_frame_method_offset - 1,
115 interpreter_frame_cache_offset = interpreter_frame_mdx_offset - 1,
116 interpreter_frame_locals_offset = interpreter_frame_cache_offset - 1,
117 interpreter_frame_bcx_offset = interpreter_frame_locals_offset - 1,
118 interpreter_frame_initial_sp_offset = interpreter_frame_bcx_offset - 1,
120 interpreter_frame_monitor_block_top_offset = interpreter_frame_initial_sp_offset,
121 interpreter_frame_monitor_block_bottom_offset = interpreter_frame_initial_sp_offset,
128 entry_frame_after_call_words = 28,
129 entry_frame_call_wrapper_offset = 2,
131 arg_reg_save_area_bytes = 32, // Register argument save area
133 entry_frame_after_call_words = 13,
134 entry_frame_call_wrapper_offset = -6,
136 arg_reg_save_area_bytes = 0,
139 entry_frame_call_wrapper_offset = 2,
144 native_frame_initial_param_offset = 2
148 intptr_t ptr_at(int offset) const {
149 return *ptr_at_addr(offset);
152 void ptr_at_put(int offset, intptr_t value) {
153 *ptr_at_addr(offset) = value;
157 // an additional field beyond _sp and _pc:
158 intptr_t* _fp; // frame pointer
159 // The interpreter and adapters will extend the frame of the caller.
160 // Since oopMaps are based on the sp of the caller before extension
161 // we need to know that value. However in order to compute the address
162 // of the return address we need the real "raw" sp. Since sparc already
163 // uses sp() to mean "raw" sp and unextended_sp() to mean the caller's
164 // original sp we use that convention.
166 intptr_t* _unextended_sp;
167 void adjust_unextended_sp();
169 intptr_t* ptr_at_addr(int offset) const {
170 return (intptr_t*) addr_at(offset);
174 // Used in frame::sender_for_{interpreter,compiled}_frame
175 static void verify_deopt_original_pc( nmethod* nm, intptr_t* unextended_sp, bool is_method_handle_return = false);
176 static void verify_deopt_mh_original_pc(nmethod* nm, intptr_t* unextended_sp) {
177 verify_deopt_original_pc(nm, unextended_sp, true);
184 frame(intptr_t* sp, intptr_t* fp, address pc);
186 frame(intptr_t* sp, intptr_t* unextended_sp, intptr_t* fp, address pc);
188 frame(intptr_t* sp, intptr_t* fp);
190 // accessors for the instance variables
191 intptr_t* fp() const { return _fp; }
193 inline address* sender_pc_addr() const;
195 // return address of param, zero origin index.
196 inline address* native_param_addr(int idx) const;
198 // expression stack tos if we are nested in a java call
199 intptr_t* interpreter_frame_last_sp() const;
201 // helper to update a map with callee-saved RBP
202 static void update_map_with_saved_link(RegisterMap* map, intptr_t** link_addr);
205 // deoptimization support
206 void interpreter_frame_set_last_sp(intptr_t* sp);
210 inline interpreterState get_interpreterState() const;
213 #endif // CPU_X86_VM_FRAME_X86_HPP