1 /*
   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.
   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_ABSTRACTINTERPRETER_HPP
  26 #define SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP
  27 
  28 #include "code/stubs.hpp"
  29 #include "interpreter/bytecodes.hpp"
  30 #include "runtime/vmThread.hpp"
  31 #include "utilities/top.hpp"
  32 #ifdef TARGET_ARCH_MODEL_x86_32
  33 # include "interp_masm_x86_32.hpp"
  34 #endif
  35 #ifdef TARGET_ARCH_MODEL_x86_64
  36 # include "interp_masm_x86_64.hpp"
  37 #endif
  38 #ifdef TARGET_ARCH_MODEL_sparc
  39 # include "interp_masm_sparc.hpp"
  40 #endif
  41 #ifdef TARGET_ARCH_MODEL_zero
  42 # include "interp_masm_zero.hpp"
  43 #endif
  44 #ifdef TARGET_ARCH_MODEL_arm
  45 # include "interp_masm_arm.hpp"
  46 #endif
  47 #ifdef TARGET_ARCH_MODEL_ppc
  48 # include "interp_masm_ppc.hpp"
  49 #endif
  50 #ifdef TARGET_OS_FAMILY_linux
  51 # include "thread_linux.inline.hpp"
  52 #endif
  53 #ifdef TARGET_OS_FAMILY_solaris
  54 # include "thread_solaris.inline.hpp"
  55 #endif
  56 #ifdef TARGET_OS_FAMILY_windows
  57 # include "thread_windows.inline.hpp"
  58 #endif
  59 
  60 // This file contains the platform-independent parts
  61 // of the abstract interpreter and the abstract interpreter generator.
  62 
  63 // Organization of the interpreter(s). There exists two different interpreters in hotpot
  64 // an assembly language version (aka template interpreter) and a high level language version
  65 // (aka c++ interpreter). Th division of labor is as follows:
  66 
  67 // Template Interpreter          C++ Interpreter        Functionality
  68 //
  69 // templateTable*                bytecodeInterpreter*   actual interpretation of bytecodes
  70 //
  71 // templateInterpreter*          cppInterpreter*        generation of assembly code that creates
  72 //                                                      and manages interpreter runtime frames.
  73 //                                                      Also code for populating interpreter
  74 //                                                      frames created during deoptimization.
  75 //
  76 // For both template and c++ interpreter. There are common files for aspects of the interpreter
  77 // that are generic to both interpreters. This is the layout:
  78 //
  79 // abstractInterpreter.hpp: generic description of the interpreter.
  80 // interpreter*:            generic frame creation and handling.
  81 //
  82 
  83 //------------------------------------------------------------------------------------------------------------------------
  84 // The C++ interface to the bytecode interpreter(s).
  85 
  86 class AbstractInterpreter: AllStatic {
  87   friend class VMStructs;
  88   friend class Interpreter;
  89   friend class CppInterpreterGenerator;
  90  public:
  91   enum MethodKind {
  92     zerolocals,                                                 // method needs locals initialization
  93     zerolocals_synchronized,                                    // method needs locals initialization & is synchronized
  94     native,                                                     // native method
  95     native_synchronized,                                        // native method & is synchronized
  96     empty,                                                      // empty method (code: _return)
  97     accessor,                                                   // accessor method (code: _aload_0, _getfield, _(a|i)return)
  98     abstract,                                                   // abstract method (throws an AbstractMethodException)
  99     method_handle,                                              // java.lang.invoke.MethodHandles::invoke
 100     java_lang_math_sin,                                         // implementation of java.lang.Math.sin   (x)
 101     java_lang_math_cos,                                         // implementation of java.lang.Math.cos   (x)
 102     java_lang_math_tan,                                         // implementation of java.lang.Math.tan   (x)
 103     java_lang_math_abs,                                         // implementation of java.lang.Math.abs   (x)
 104     java_lang_math_sqrt,                                        // implementation of java.lang.Math.sqrt  (x)
 105     java_lang_math_log,                                         // implementation of java.lang.Math.log   (x)
 106     java_lang_math_log10,                                       // implementation of java.lang.Math.log10 (x)
 107     number_of_method_entries,
 108     invalid = -1
 109   };
 110 
 111   enum SomeConstants {
 112     number_of_result_handlers = 10                              // number of result handlers for native calls
 113   };
 114 
 115  protected:
 116   static StubQueue* _code;                                      // the interpreter code (codelets)
 117 
 118   static bool       _notice_safepoints;                         // true if safepoints are activated
 119 
 120   static address    _native_entry_begin;                        // Region for native entry code
 121   static address    _native_entry_end;
 122 
 123   // method entry points
 124   static address    _entry_table[number_of_method_entries];     // entry points for a given method
 125   static address    _native_abi_to_tosca[number_of_result_handlers];  // for native method result handlers
 126   static address    _slow_signature_handler;                              // the native method generic (slow) signature handler
 127 
 128   static address    _rethrow_exception_entry;                   // rethrows an activation in previous frame
 129 
 130   friend class      AbstractInterpreterGenerator;
 131   friend class              InterpreterGenerator;
 132   friend class      InterpreterMacroAssembler;
 133 
 134  public:
 135   // Initialization/debugging
 136   static void       initialize();
 137   static StubQueue* code()                                      { return _code; }
 138 
 139 
 140   // Method activation
 141   static MethodKind method_kind(methodHandle m);
 142   static address    entry_for_kind(MethodKind k)                { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
 143   static address    entry_for_method(methodHandle m)            { return _entry_table[method_kind(m)]; }
 144 
 145   static void       print_method_kind(MethodKind kind)          PRODUCT_RETURN;
 146 
 147   static bool       can_be_compiled(methodHandle m);
 148 
 149   // Runtime support
 150 
 151   // length = invoke bytecode length (to advance to next bytecode)
 152   static address    deopt_entry   (TosState state, int length) { ShouldNotReachHere(); return NULL; }
 153   static address    return_entry  (TosState state, int length) { ShouldNotReachHere(); return NULL; }
 154 
 155   static address    rethrow_exception_entry()                   { return _rethrow_exception_entry; }
 156 
 157   // Activation size in words for a method that is just being called.
 158   // Parameters haven't been pushed so count them too.
 159   static int        size_top_interpreter_activation(methodOop method);
 160 
 161   // Deoptimization support
 162   // Compute the entry address for continuation after
 163   static address deopt_continue_after_entry(methodOop method,
 164                                             address bcp,
 165                                             int callee_parameters,
 166                                             bool is_top_frame);
 167   // Compute the entry address for reexecution
 168   static address deopt_reexecute_entry(methodOop method, address bcp);
 169   // Deoptimization should reexecute this bytecode
 170   static bool    bytecode_should_reexecute(Bytecodes::Code code);
 171 
 172   // share implementation of size_activation and layout_activation:
 173   static int        size_activation(methodOop method,
 174                                     int temps,
 175                                     int popframe_args,
 176                                     int monitors,
 177                                     int callee_params,
 178                                     int callee_locals,
 179                                     bool is_top_frame);
 180 
 181   static int       layout_activation(methodOop method,
 182                                       int temps,
 183                                       int popframe_args,
 184                                       int monitors,
 185                                       int callee_params,
 186                                       int callee_locals,
 187                                       frame* caller,
 188                                       frame* interpreter_frame,
 189                                       bool is_top_frame);
 190 
 191   // Runtime support
 192   static bool       is_not_reached(                       methodHandle method, int bci);
 193   // Safepoint support
 194   static void       notice_safepoints()                         { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
 195   static void       ignore_safepoints()                         { ShouldNotReachHere(); } // ignores safepoints
 196 
 197   // Support for native calls
 198   static address    slow_signature_handler()                    { return _slow_signature_handler; }
 199   static address    result_handler(BasicType type)              { return _native_abi_to_tosca[BasicType_as_index(type)]; }
 200   static int        BasicType_as_index(BasicType type);         // computes index into result_handler_by_index table
 201   static bool       in_native_entry(address pc)                 { return _native_entry_begin <= pc && pc < _native_entry_end; }
 202   // Debugging/printing
 203   static void       print();                                    // prints the interpreter code
 204 
 205  public:
 206   // Interpreter helpers
 207   const static int stackElementWords   = 1;
 208   const static int stackElementSize    = stackElementWords * wordSize;
 209   const static int logStackElementSize = LogBytesPerWord;
 210 
 211   // Local values relative to locals[n]
 212   static int  local_offset_in_bytes(int n) {
 213     return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
 214   }
 215 
 216   // access to stacked values according to type:
 217   static oop* oop_addr_in_slot(intptr_t* slot_addr) {
 218     return (oop*) slot_addr;
 219   }
 220   static jint* int_addr_in_slot(intptr_t* slot_addr) {
 221     if ((int) sizeof(jint) < wordSize && !Bytes::is_Java_byte_ordering_different())
 222       // big-endian LP64
 223       return (jint*)(slot_addr + 1) - 1;
 224     else
 225       return (jint*) slot_addr;
 226   }
 227   static jlong long_in_slot(intptr_t* slot_addr) {
 228     if (sizeof(intptr_t) >= sizeof(jlong)) {
 229       return *(jlong*) slot_addr;
 230     } else {
 231       return Bytes::get_native_u8((address)slot_addr);
 232     }
 233   }
 234   static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
 235     if (sizeof(intptr_t) >= sizeof(jlong)) {
 236       *(jlong*) slot_addr = value;
 237     } else {
 238       Bytes::put_native_u8((address)slot_addr, value);
 239     }
 240   }
 241   static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
 242     switch (type) {
 243     case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr);            break;
 244     case T_CHAR:    value->c = *int_addr_in_slot(slot_addr);            break;
 245     case T_BYTE:    value->b = *int_addr_in_slot(slot_addr);            break;
 246     case T_SHORT:   value->s = *int_addr_in_slot(slot_addr);            break;
 247     case T_INT:     value->i = *int_addr_in_slot(slot_addr);            break;
 248     case T_LONG:    value->j = long_in_slot(slot_addr);                 break;
 249     case T_FLOAT:   value->f = *(jfloat*)int_addr_in_slot(slot_addr);   break;
 250     case T_DOUBLE:  value->d = jdouble_cast(long_in_slot(slot_addr));   break;
 251     case T_OBJECT:  value->l = (jobject)*oop_addr_in_slot(slot_addr);   break;
 252     default:        ShouldNotReachHere();
 253     }
 254   }
 255   static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
 256     switch (type) {
 257     case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0);     break;
 258     case T_CHAR:    *int_addr_in_slot(slot_addr) = value->c;            break;
 259     case T_BYTE:    *int_addr_in_slot(slot_addr) = value->b;            break;
 260     case T_SHORT:   *int_addr_in_slot(slot_addr) = value->s;            break;
 261     case T_INT:     *int_addr_in_slot(slot_addr) = value->i;            break;
 262     case T_LONG:    set_long_in_slot(slot_addr, value->j);              break;
 263     case T_FLOAT:   *(jfloat*)int_addr_in_slot(slot_addr) = value->f;   break;
 264     case T_DOUBLE:  set_long_in_slot(slot_addr, jlong_cast(value->d));  break;
 265     case T_OBJECT:  *oop_addr_in_slot(slot_addr) = (oop) value->l;      break;
 266     default:        ShouldNotReachHere();
 267     }
 268   }
 269 };
 270 
 271 //------------------------------------------------------------------------------------------------------------------------
 272 // The interpreter generator.
 273 
 274 class Template;
 275 class AbstractInterpreterGenerator: public StackObj {
 276  protected:
 277   InterpreterMacroAssembler* _masm;
 278 
 279   // shared code sequences
 280   // Converter for native abi result to tosca result
 281   address generate_result_handler_for(BasicType type);
 282   address generate_slow_signature_handler();
 283 
 284   // entry point generator
 285   address generate_method_entry(AbstractInterpreter::MethodKind kind);
 286 
 287   void bang_stack_shadow_pages(bool native_call);
 288 
 289   void generate_all();
 290 
 291  public:
 292   AbstractInterpreterGenerator(StubQueue* _code);
 293 };
 294 
 295 #endif // SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP