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