1 /*
   2  * Copyright (c) 1997, 2017, 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 #include "utilities/macros.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 class to access current interpreter state
  46   class LastFrameAccessor : public StackObj {
  47     frame _last_frame;
  48   public:
  49     LastFrameAccessor(JavaThread* thread) {
  50       assert(thread == Thread::current(), "sanity");
  51       _last_frame = thread->last_frame();
  52     }
  53     bool is_interpreted_frame() const              { return _last_frame.is_interpreted_frame(); }
  54     Method*   method() const                       { return _last_frame.interpreter_frame_method(); }
  55     address   bcp() const                          { return _last_frame.interpreter_frame_bcp(); }
  56     int       bci() const                          { return _last_frame.interpreter_frame_bci(); }
  57     address   mdp() const                          { return _last_frame.interpreter_frame_mdp(); }
  58 
  59     void      set_bcp(address bcp)                 { _last_frame.interpreter_frame_set_bcp(bcp); }
  60     void      set_mdp(address dp)                  { _last_frame.interpreter_frame_set_mdp(dp); }
  61 
  62     // pass method to avoid calling unsafe bcp_to_method (partial fix 4926272)
  63     Bytecodes::Code code() const                   { return Bytecodes::code_at(method(), bcp()); }
  64 
  65     Bytecode  bytecode() const                     { return Bytecode(method(), bcp()); }
  66     int get_index_u1(Bytecodes::Code bc) const     { return bytecode().get_index_u1(bc); }
  67     int get_index_u2(Bytecodes::Code bc) const     { return bytecode().get_index_u2(bc); }
  68     int get_index_u2_cpcache(Bytecodes::Code bc) const
  69                                                    { return bytecode().get_index_u2_cpcache(bc); }
  70     int get_index_u4(Bytecodes::Code bc) const     { return bytecode().get_index_u4(bc); }
  71     int number_of_dimensions() const               { return bcp()[3]; }
  72     ConstantPoolCacheEntry* cache_entry_at(int i) const
  73                                                    { return method()->constants()->cache()->entry_at(i); }
  74     ConstantPoolCacheEntry* cache_entry() const    { return cache_entry_at(Bytes::get_native_u2(bcp() + 1)); }
  75 
  76     oop callee_receiver(Symbol* signature) {
  77       return _last_frame.interpreter_callee_receiver(signature);
  78     }
  79     BasicObjectLock* monitor_begin() const {
  80       return _last_frame.interpreter_frame_monitor_begin();
  81     }
  82     BasicObjectLock* monitor_end() const {
  83       return _last_frame.interpreter_frame_monitor_end();
  84     }
  85     BasicObjectLock* next_monitor(BasicObjectLock* current) const {
  86       return _last_frame.next_monitor_in_interpreter_frame(current);
  87     }
  88 
  89     frame& get_frame()                             { return _last_frame; }
  90   };
  91 
  92   static void      set_bcp_and_mdp(address bcp, JavaThread*thread);
  93   static void      note_trap_inner(JavaThread* thread, int reason,
  94                                    const methodHandle& trap_method, int trap_bci, TRAPS);
  95   static void      note_trap(JavaThread *thread, int reason, TRAPS);
  96 #ifdef CC_INTERP
  97   // Profile traps in C++ interpreter.
  98   static void      note_trap(JavaThread* thread, int reason, Method *method, int trap_bci);
  99 #endif // CC_INTERP
 100 
 101   // Inner work method for Interpreter's frequency counter overflow.
 102   static nmethod* frequency_counter_overflow_inner(JavaThread* thread, address branch_bcp);
 103 
 104  public:
 105   // Constants
 106   static void    ldc           (JavaThread* thread, bool wide);
 107   static void    resolve_ldc   (JavaThread* thread, Bytecodes::Code bytecode);
 108 
 109   // Allocation
 110   static void    _new          (JavaThread* thread, ConstantPool* pool, int index);
 111   static void    newarray      (JavaThread* thread, BasicType type, jint size);
 112   static void    anewarray     (JavaThread* thread, ConstantPool* pool, int index, jint size);
 113   static void    multianewarray(JavaThread* thread, jint* first_size_address);
 114   static void    register_finalizer(JavaThread* thread, oopDesc* obj);
 115   static void    vdefault      (JavaThread* thread, ConstantPool* pool, int index);
 116   static int     vwithfield    (JavaThread* thread, ConstantPoolCache* cp_cache);
 117   static void    qgetfield     (JavaThread* thread, oopDesc* value, int index, Klass* field_holder);
 118   static void    qputfield     (JavaThread* thread, oopDesc* obj, oopDesc* value, ConstantPoolCache* cp_cache);
 119   static void    qputstatic    (JavaThread* thread, oopDesc* value, int offset, oopDesc* mirror);
 120   static void    uninitialized_static_value_field(JavaThread*, oopDesc* mirror, int offset);
 121 
 122   // Value Buffers support
 123   static void    recycle_vtbuffer(void *alloc_ptr);
 124   static void    recycle_buffered_values(JavaThread* thread);
 125   static void    reallocate_value_in_heap(JavaThread* thread, oopDesc* obj);
 126   static void    relocate_return_value(oopDesc* obj, void* alloc_ptr);
 127   static void    check_areturn(JavaThread* thread, oopDesc* obj);
 128   static void    fix_frame_vt_alloc_ptr(JavaThread* thread);
 129 
 130   // vaload/vastore
 131   static void value_array_load(JavaThread* thread, arrayOopDesc* array, int index);
 132   static void value_array_store(JavaThread* thread, arrayOopDesc* array, int index, void* val);
 133 
 134   // Valhalla MVT VCC<->DVT
 135   static void    vbox  (JavaThread* thread, ConstantPool* pool, int index, oopDesc* value);
 136   static void    vunbox(JavaThread* thread, ConstantPool* pool, int index, oopDesc* obj);
 137 
 138 
 139   // Quicken instance-of and check-cast bytecodes
 140   static void    quicken_io_cc(JavaThread* thread);
 141 
 142   // Exceptions thrown by the interpreter
 143   static void    throw_AbstractMethodError(JavaThread* thread);
 144   static void    throw_IncompatibleClassChangeError(JavaThread* thread);
 145   static void    throw_StackOverflowError(JavaThread* thread);
 146   static void    throw_delayed_StackOverflowError(JavaThread* thread);
 147   static void    throw_ArrayIndexOutOfBoundsException(JavaThread* thread, char* name, jint index);
 148   static void    throw_ClassCastException(JavaThread* thread, oopDesc* obj);
 149   static void    create_exception(JavaThread* thread, char* name, char* message);
 150   static void    create_klass_exception(JavaThread* thread, char* name, oopDesc* obj);
 151   static address exception_handler_for_exception(JavaThread* thread, oopDesc* exception);
 152 #if INCLUDE_JVMTI
 153   static void    member_name_arg_or_null(JavaThread* thread, address dmh, Method* m, address bcp);
 154 #endif
 155   static void    throw_pending_exception(JavaThread* thread);
 156 
 157 #ifdef CC_INTERP
 158   // Profile traps in C++ interpreter.
 159   static void    note_nullCheck_trap (JavaThread* thread, Method *method, int trap_bci);
 160   static void    note_div0Check_trap (JavaThread* thread, Method *method, int trap_bci);
 161   static void    note_rangeCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 162   static void    note_classCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 163   static void    note_arrayCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 164   // A dummy for macros that shall not profile traps.
 165   static void    note_no_trap(JavaThread* thread, Method *method, int trap_bci) {}
 166 #endif // CC_INTERP
 167 
 168   static void resolve_from_cache(JavaThread* thread, Bytecodes::Code bytecode);
 169  private:
 170   // Statics & fields
 171   static void resolve_get_put(JavaThread* thread, Bytecodes::Code bytecode);
 172 
 173   // Calls
 174   static void resolve_invoke(JavaThread* thread, Bytecodes::Code bytecode);
 175   static void resolve_invokehandle (JavaThread* thread);
 176   static void resolve_invokedynamic(JavaThread* thread);
 177 
 178  public:
 179   // Synchronization
 180   static void    monitorenter(JavaThread* thread, BasicObjectLock* elem);
 181   static void    monitorexit (JavaThread* thread, BasicObjectLock* elem);
 182 
 183   static void    throw_illegal_monitor_state_exception(JavaThread* thread);
 184   static void    new_illegal_monitor_state_exception(JavaThread* thread);
 185 
 186   // Breakpoints
 187   static void _breakpoint(JavaThread* thread, Method* method, address bcp);
 188   static Bytecodes::Code get_original_bytecode_at(JavaThread* thread, Method* method, address bcp);
 189   static void            set_original_bytecode_at(JavaThread* thread, Method* method, address bcp, Bytecodes::Code new_code);
 190   static bool is_breakpoint(JavaThread *thread) { return Bytecodes::code_or_bp_at(LastFrameAccessor(thread).bcp()) == Bytecodes::_breakpoint; }
 191 
 192   // Safepoints
 193   static void    at_safepoint(JavaThread* thread);
 194 
 195   // Debugger support
 196   static void post_field_access(JavaThread *thread, oopDesc* obj,
 197     ConstantPoolCacheEntry *cp_entry);
 198   static void post_field_modification(JavaThread *thread, oopDesc* obj,
 199     ConstantPoolCacheEntry *cp_entry, jvalue *value);
 200   static void post_method_entry(JavaThread *thread);
 201   static void post_method_exit (JavaThread *thread);
 202   static int  interpreter_contains(address pc);
 203 
 204   // Native signature handlers
 205   static void prepare_native_call(JavaThread* thread, Method* method);
 206   static address slow_signature_handler(JavaThread* thread,
 207                                         Method* method,
 208                                         intptr_t* from, intptr_t* to);
 209 
 210 #if defined(IA32) || defined(AMD64) || defined(ARM)
 211   // Popframe support (only needed on x86, AMD64 and ARM)
 212   static void popframe_move_outgoing_args(JavaThread* thread, void* src_address, void* dest_address);
 213 #endif
 214 
 215   // bytecode tracing is only used by the TraceBytecodes
 216   static intptr_t trace_bytecode(JavaThread* thread, intptr_t preserve_this_value, intptr_t tos, intptr_t tos2) PRODUCT_RETURN0;
 217 
 218   // Platform dependent stuff
 219 #include CPU_HEADER(interpreterRT)
 220 
 221   // optional normalization of fingerprints to reduce the number of adapters
 222   static uint64_t normalize_fast_native_fingerprint(uint64_t fingerprint);
 223 
 224   // Interpreter's frequency counter overflow
 225   static nmethod* frequency_counter_overflow(JavaThread* thread, address branch_bcp);
 226 
 227   // Interpreter profiling support
 228   static jint    bcp_to_di(Method* method, address cur_bcp);
 229   static void    profile_method(JavaThread* thread);
 230   static void    update_mdp_for_ret(JavaThread* thread, int bci);
 231 #ifdef ASSERT
 232   static void    verify_mdp(Method* method, address bcp, address mdp);
 233 #endif // ASSERT
 234   static MethodCounters* build_method_counters(JavaThread* thread, Method* m);
 235 };
 236 
 237 
 238 class SignatureHandlerLibrary: public AllStatic {
 239  public:
 240   enum { buffer_size =  1*K }; // the size of the temporary code buffer
 241   enum { blob_size   = 32*K }; // the size of a handler code blob.
 242 
 243  private:
 244   static BufferBlob*              _handler_blob; // the current buffer blob containing the generated handlers
 245   static address                  _handler;      // next available address within _handler_blob;
 246   static GrowableArray<uint64_t>* _fingerprints; // the fingerprint collection
 247   static GrowableArray<address>*  _handlers;     // the corresponding handlers
 248   static address                  _buffer;       // the temporary code buffer
 249 
 250   static address set_handler_blob();
 251   static void initialize();
 252   static address set_handler(CodeBuffer* buffer);
 253   static void pd_set_handler(address handler);
 254 
 255  public:
 256   static void add(const methodHandle& method);
 257   static void add(uint64_t fingerprint, address handler);
 258 };
 259 
 260 #endif // SHARE_VM_INTERPRETER_INTERPRETERRUNTIME_HPP
--- EOF ---