1 /*
   2  * Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2015-2018, Azul Systems, Inc. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #ifndef SHARE_VM_INTERPRETER_TEMPLATEINTERPRETERGENERATOR_HPP
  27 #define SHARE_VM_INTERPRETER_TEMPLATEINTERPRETERGENERATOR_HPP
  28 
  29 // This file contains the platform-independent parts
  30 // of the template interpreter generator.
  31 
  32 #ifndef CC_INTERP
  33 
  34 class TemplateInterpreterGenerator: public AbstractInterpreterGenerator {
  35  protected:
  36 
  37   // entry points for shared code sequence
  38   address _unimplemented_bytecode;
  39   address _illegal_bytecode_sequence;
  40 
  41   // shared code sequences
  42   // Converter for native abi result to tosca result
  43   address generate_result_handler_for(BasicType type);
  44   address generate_slow_signature_handler();
  45   address generate_error_exit(const char* msg);
  46   address generate_StackOverflowError_handler();
  47   address generate_exception_handler(const char* name, const char* message) {
  48     return generate_exception_handler_common(name, message, false);
  49   }
  50   address generate_klass_exception_handler(const char* name) {
  51     return generate_exception_handler_common(name, NULL, true);
  52   }
  53   address generate_exception_handler_common(const char* name, const char* message, bool pass_oop);
  54   address generate_ClassCastException_handler();
  55   address generate_ArrayIndexOutOfBounds_handler();
  56   address generate_return_entry_for(TosState state, int step, size_t index_size);
  57   address generate_earlyret_entry_for(TosState state);
  58   address generate_deopt_entry_for(TosState state, int step, address continuation = NULL);
  59   address generate_safept_entry_for(TosState state, address runtime_entry);
  60   void    generate_throw_exception();
  61 
  62   void lock_method();
  63 
  64   void bang_stack_shadow_pages(bool native_call);
  65 
  66   // Instruction generation
  67   void generate_and_dispatch (Template* t, TosState tos_out = ilgl);
  68   void set_vtos_entry_points (Template* t, address& bep, address& cep, address& sep, address& aep, address& iep, address& lep, address& fep, address& dep, address& vep);
  69   void set_short_entry_points(Template* t, address& bep, address& cep, address& sep, address& aep, address& iep, address& lep, address& fep, address& dep, address& vep);
  70   void set_wide_entry_point  (Template* t, address& wep);
  71 
  72   void set_entry_points(Bytecodes::Code code);
  73   void set_unimplemented(int i);
  74   void set_entry_points_for_all_bytes();
  75   void set_safepoints_for_all_bytes();
  76 
  77   // Helpers for generate_and_dispatch
  78   address generate_trace_code(TosState state)   PRODUCT_RETURN0;
  79   void count_bytecode()                         PRODUCT_RETURN;
  80   void histogram_bytecode(Template* t)          PRODUCT_RETURN;
  81   void histogram_bytecode_pair(Template* t)     PRODUCT_RETURN;
  82   void trace_bytecode(Template* t)              PRODUCT_RETURN;
  83   void stop_interpreter_at()                    PRODUCT_RETURN;
  84 
  85   void generate_all();
  86 
  87   // entry point generator
  88   address generate_method_entry(AbstractInterpreter::MethodKind kind);
  89 
  90   address generate_normal_entry(bool synchronized);
  91   address generate_native_entry(bool synchronized);
  92   address generate_abstract_entry(void);
  93   address generate_math_entry(AbstractInterpreter::MethodKind kind);
  94   address generate_Reference_get_entry();
  95   address generate_CRC32_update_entry();
  96   address generate_CRC32_updateBytes_entry(AbstractInterpreter::MethodKind kind);
  97   address generate_CRC32C_updateBytes_entry(AbstractInterpreter::MethodKind kind);
  98 #ifdef IA32
  99   address generate_Float_intBitsToFloat_entry();
 100   address generate_Float_floatToRawIntBits_entry();
 101   address generate_Double_longBitsToDouble_entry();
 102   address generate_Double_doubleToRawLongBits_entry();
 103 #endif // IA32
 104 #ifdef AARCH32
 105   address generate_CRC32_updateBytes_inner(AbstractInterpreter::MethodKind kind, int is_crc32c);
 106   address generate_aescrypt_block_entry(AbstractInterpreter::MethodKind kind);
 107   address generate_cipherBlockChaining_encryptAESCrypt_entry(AbstractInterpreter::MethodKind kind);
 108   address generate_SHA_implCompress_entry(AbstractInterpreter::MethodKind kind);
 109 #endif
 110   // Some platforms don't need registers, other need two. Unused function is
 111   // left unimplemented.
 112   void generate_stack_overflow_check(void);
 113   void generate_stack_overflow_check(Register Rframe_size, Register Rscratch);
 114 
 115   void generate_counter_incr(Label* overflow, Label* profile_method, Label* profile_method_continue);
 116   void generate_counter_overflow(Label& continue_entry);
 117 
 118   void generate_fixed_frame(bool native_call);
 119 #ifdef SPARC
 120   void save_native_result(void);
 121   void restore_native_result(void);
 122 #endif // SPARC
 123 
 124 #if defined(AARCH64)
 125   void generate_transcendental_entry(AbstractInterpreter::MethodKind kind, int fpargs);
 126 #elif defined(AARCH32)
 127   void generate_transcendental_entry(AbstractInterpreter::MethodKind kind);
 128 #endif // AARCH64
 129 
 130 #ifdef PPC
 131   void lock_method(Register Rflags, Register Rscratch1, Register Rscratch2, bool flags_preloaded=false);
 132   void generate_fixed_frame(bool native_call, Register Rsize_of_parameters, Register Rsize_of_locals);
 133 #endif // PPC
 134 
 135  public:
 136   TemplateInterpreterGenerator(StubQueue* _code);
 137 };
 138 
 139 #endif // !CC_INTERP
 140 
 141 #endif // SHARE_VM_INTERPRETER_TEMPLATEINTERPRETERGENERATOR_HPP