1 /*
   2  * Copyright (c) 1997, 2013, 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 SHARE_VM_INTERPRETER_INTERPRETERRUNTIME_HPP
  26 #define SHARE_VM_INTERPRETER_INTERPRETERRUNTIME_HPP
  27 
  28 #include "interpreter/bytecode.hpp"
  29 #include "interpreter/linkResolver.hpp"
  30 #include "memory/universe.hpp"
  31 #include "oops/method.hpp"
  32 #include "runtime/frame.inline.hpp"
  33 #include "runtime/signature.hpp"
  34 #include "runtime/thread.inline.hpp"
  35 #include "utilities/top.hpp"
  36 
  37 // The InterpreterRuntime is called by the interpreter for everything
  38 // that cannot/should not be dealt with in assembly and needs C support.
  39 
  40 class InterpreterRuntime: AllStatic {
  41   friend class BytecodeClosure; // for method and bcp
  42   friend class PrintingClosure; // for method and bcp
  43 
  44  private:
  45   // Helper functions to access current interpreter state
  46   static frame     last_frame(JavaThread *thread)    { return thread->last_frame(); }
  47   static Method*   method(JavaThread *thread)        { return last_frame(thread).interpreter_frame_method(); }
  48   static address   bcp(JavaThread *thread)           { return last_frame(thread).interpreter_frame_bcp(); }
  49   static int       bci(JavaThread *thread)           { return last_frame(thread).interpreter_frame_bci(); }
  50   static void      set_bcp_and_mdp(address bcp, JavaThread*thread);
  51   static Bytecodes::Code code(JavaThread *thread)    {
  52     // pass method to avoid calling unsafe bcp_to_method (partial fix 4926272)
  53     return Bytecodes::code_at(method(thread), bcp(thread));
  54   }
  55   static bool      already_resolved(JavaThread *thread) { return cache_entry(thread)->is_resolved(code(thread)); }
  56   static Bytecode  bytecode(JavaThread *thread)      { return Bytecode(method(thread), bcp(thread)); }
  57   static int       get_index_u1(JavaThread *thread, Bytecodes::Code bc)
  58                                                         { return bytecode(thread).get_index_u1(bc); }
  59   static int       get_index_u2(JavaThread *thread, Bytecodes::Code bc)
  60                                                         { return bytecode(thread).get_index_u2(bc); }
  61   static int       get_index_u2_cpcache(JavaThread *thread, Bytecodes::Code bc)
  62                                                         { return bytecode(thread).get_index_u2_cpcache(bc); }
  63   static int       get_index_u4(JavaThread *thread, Bytecodes::Code bc)
  64                                                         { return bytecode(thread).get_index_u4(bc); }
  65   static int       number_of_dimensions(JavaThread *thread)  { return bcp(thread)[3]; }
  66 
  67   static ConstantPoolCacheEntry* cache_entry_at(JavaThread *thread, int i)  { return method(thread)->constants()->cache()->entry_at(i); }
  68   static ConstantPoolCacheEntry* cache_entry(JavaThread *thread)            { return cache_entry_at(thread, Bytes::get_native_u2(bcp(thread) + 1)); }
  69   static void      note_trap(JavaThread *thread, int reason, TRAPS);
  70 
  71   // Inner work method for Interpreter's frequency counter overflow
  72   static nmethod* frequency_counter_overflow_inner(JavaThread* thread, address branch_bcp);
  73 
  74  public:
  75   // Constants
  76   static void    ldc           (JavaThread* thread, bool wide);
  77   static void    resolve_ldc   (JavaThread* thread, Bytecodes::Code bytecode);
  78 
  79   // Allocation
  80   static void    _new          (JavaThread* thread, ConstantPool* pool, int index);
  81   static void    newarray      (JavaThread* thread, BasicType type, jint size);
  82   static void    anewarray     (JavaThread* thread, ConstantPool* pool, int index, jint size);
  83   static void    multianewarray(JavaThread* thread, jint* first_size_address);
  84   static void    register_finalizer(JavaThread* thread, oopDesc* obj);
  85 
  86   // Quicken instance-of and check-cast bytecodes
  87   static void    quicken_io_cc(JavaThread* thread);
  88 
  89   // Exceptions thrown by the interpreter
  90   static void    throw_AbstractMethodError(JavaThread* thread);
  91   static void    throw_IncompatibleClassChangeError(JavaThread* thread);
  92   static void    throw_StackOverflowError(JavaThread* thread);
  93   static void    throw_ArrayIndexOutOfBoundsException(JavaThread* thread, char* name, jint index);
  94   static void    throw_ClassCastException(JavaThread* thread, oopDesc* obj);
  95   static void    create_exception(JavaThread* thread, char* name, char* message);
  96   static void    create_klass_exception(JavaThread* thread, char* name, oopDesc* obj);
  97   static address exception_handler_for_exception(JavaThread* thread, oopDesc* exception);
  98   static void    throw_pending_exception(JavaThread* thread);
  99 
 100   // Statics & fields
 101   static void    resolve_get_put(JavaThread* thread, Bytecodes::Code bytecode);
 102 
 103   // Synchronization
 104   static void    monitorenter(JavaThread* thread, BasicObjectLock* elem);
 105   static void    monitorexit (JavaThread* thread, BasicObjectLock* elem);
 106 
 107   static void    throw_illegal_monitor_state_exception(JavaThread* thread);
 108   static void    new_illegal_monitor_state_exception(JavaThread* thread);
 109 
 110   // Calls
 111   static void    resolve_invoke       (JavaThread* thread, Bytecodes::Code bytecode);
 112   static void    resolve_invokehandle (JavaThread* thread);
 113   static void    resolve_invokedynamic(JavaThread* thread);
 114 
 115   // Breakpoints
 116   static void _breakpoint(JavaThread* thread, Method* method, address bcp);
 117   static Bytecodes::Code get_original_bytecode_at(JavaThread* thread, Method* method, address bcp);
 118   static void            set_original_bytecode_at(JavaThread* thread, Method* method, address bcp, Bytecodes::Code new_code);
 119   static bool is_breakpoint(JavaThread *thread) { return Bytecodes::code_or_bp_at(bcp(thread)) == Bytecodes::_breakpoint; }
 120 
 121   // Safepoints
 122   static void    at_safepoint(JavaThread* thread);
 123 
 124   // Debugger support
 125   static void post_field_access(JavaThread *thread, oopDesc* obj,
 126     ConstantPoolCacheEntry *cp_entry);
 127   static void post_field_modification(JavaThread *thread, oopDesc* obj,
 128     ConstantPoolCacheEntry *cp_entry, jvalue *value);
 129   static void post_method_entry(JavaThread *thread);
 130   static void post_method_exit (JavaThread *thread);
 131   static int  interpreter_contains(address pc);
 132 
 133   // Native signature handlers
 134   static void prepare_native_call(JavaThread* thread, Method* method);
 135   static address slow_signature_handler(JavaThread* thread,
 136                                         Method* method,
 137                                         intptr_t* from, intptr_t* to);
 138 
 139 #if defined(IA32) || defined(AMD64) || defined(ARM)
 140   // Popframe support (only needed on x86, AMD64 and ARM)
 141   static void popframe_move_outgoing_args(JavaThread* thread, void* src_address, void* dest_address);
 142 #endif
 143 
 144 #ifdef ASSERT
 145   static void verify_stable(JavaThread *thread, oopDesc* obj,
 146     ConstantPoolCacheEntry *cp_entry, jvalue *value);
 147 #endif // ASSERT
 148 
 149   // Platform dependent stuff
 150 #ifdef TARGET_ARCH_x86
 151 # include "interpreterRT_x86.hpp"
 152 #endif
 153 #ifdef TARGET_ARCH_sparc
 154 # include "interpreterRT_sparc.hpp"
 155 #endif
 156 #ifdef TARGET_ARCH_zero
 157 # include "interpreterRT_zero.hpp"
 158 #endif
 159 #ifdef TARGET_ARCH_arm
 160 # include "interpreterRT_arm.hpp"
 161 #endif
 162 #ifdef TARGET_ARCH_ppc
 163 # include "interpreterRT_ppc.hpp"
 164 #endif
 165 
 166 
 167   // Interpreter's frequency counter overflow
 168   static nmethod* frequency_counter_overflow(JavaThread* thread, address branch_bcp);
 169 
 170   // Interpreter profiling support
 171   static jint    bcp_to_di(Method* method, address cur_bcp);
 172   static void    profile_method(JavaThread* thread);
 173   static void    update_mdp_for_ret(JavaThread* thread, int bci);
 174 #ifdef ASSERT
 175   static void    verify_mdp(Method* method, address bcp, address mdp);
 176 #endif // ASSERT
 177   static MethodCounters* build_method_counters(JavaThread* thread, Method* m);
 178 };
 179 
 180 
 181 class SignatureHandlerLibrary: public AllStatic {
 182  public:
 183   enum { buffer_size =  1*K }; // the size of the temporary code buffer
 184   enum { blob_size   = 32*K }; // the size of a handler code blob.
 185 
 186  private:
 187   static BufferBlob*              _handler_blob; // the current buffer blob containing the generated handlers
 188   static address                  _handler;      // next available address within _handler_blob;
 189   static GrowableArray<uint64_t>* _fingerprints; // the fingerprint collection
 190   static GrowableArray<address>*  _handlers;     // the corresponding handlers
 191   static address                  _buffer;       // the temporary code buffer
 192 
 193   static address set_handler_blob();
 194   static void initialize();
 195   static address set_handler(CodeBuffer* buffer);
 196   static void pd_set_handler(address handler);
 197 
 198  public:
 199   static void add(methodHandle method);
 200 };
 201 
 202 #endif // SHARE_VM_INTERPRETER_INTERPRETERRUNTIME_HPP