1 /*
  2  * Copyright (c) 1997, 2021, 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_INTERPRETER_TEMPLATEINTERPRETERGENERATOR_HPP
 26 #define SHARE_INTERPRETER_TEMPLATEINTERPRETERGENERATOR_HPP
 27 
 28 // This file contains the platform-independent parts
 29 // of the template interpreter generator.
 30 
 31 #ifndef ZERO
 32 
 33 class TemplateInterpreterGenerator: public AbstractInterpreterGenerator {
 34  protected:
 35 
 36   // entry points for shared code sequence
 37   address _unimplemented_bytecode;
 38   address _illegal_bytecode_sequence;
 39 
 40   // shared code sequences
 41   // Converter for native abi result to tosca result
 42   address generate_result_handler_for(BasicType type);
 43   address generate_slow_signature_handler();
 44   address generate_error_exit(const char* msg);
 45   address generate_StackOverflowError_handler();
 46   address generate_exception_handler(const char* name, const char* message) {
 47     return generate_exception_handler_common(name, message, false);
 48   }
 49   address generate_klass_exception_handler(const char* name) {
 50     return generate_exception_handler_common(name, NULL, true);
 51   }
 52   address generate_exception_handler_common(const char* name, const char* message, bool pass_oop);
 53   address generate_ClassCastException_handler();
 54   address generate_ArrayIndexOutOfBounds_handler();
 55   address generate_return_entry_for(TosState state, int step, size_t index_size);
 56   address generate_earlyret_entry_for(TosState state);
 57   address generate_deopt_entry_for(TosState state, int step, address continuation = NULL);
 58   address generate_safept_entry_for(TosState state, address runtime_entry);
 59   void    generate_throw_exception();
 60 
 61   void lock_method();
 62 
 63   void bang_stack_shadow_pages(bool native_call);
 64 
 65   // Instruction generation
 66   void generate_and_dispatch (Template* t, TosState tos_out = ilgl);
 67   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);
 68   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);
 69   void set_wide_entry_point  (Template* t, address& wep);
 70 
 71   void set_entry_points(Bytecodes::Code code);
 72   void set_unimplemented(int i);
 73   void set_entry_points_for_all_bytes();
 74   void set_safepoints_for_all_bytes();
 75 
 76   // Helpers for generate_and_dispatch
 77   address generate_trace_code(TosState state)   PRODUCT_RETURN0;
 78   void count_bytecode()                         PRODUCT_RETURN;
 79   void histogram_bytecode(Template* t)          PRODUCT_RETURN;
 80   void histogram_bytecode_pair(Template* t)     PRODUCT_RETURN;
 81   void trace_bytecode(Template* t)              PRODUCT_RETURN;
 82   void stop_interpreter_at()                    PRODUCT_RETURN;
 83 
 84   void generate_all();
 85 
 86   // entry point generator
 87   address generate_method_entry(AbstractInterpreter::MethodKind kind);
 88 
 89   address generate_normal_entry(bool synchronized);
 90   address generate_native_entry(bool synchronized);
 91   address generate_abstract_entry(void);
 92   address generate_math_entry(AbstractInterpreter::MethodKind kind);
 93   address generate_Reference_get_entry();
 94   address generate_Continuation_doYield_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 
 99 #ifdef IA32
100   address generate_Float_intBitsToFloat_entry();
101   address generate_Float_floatToRawIntBits_entry();
102   address generate_Double_longBitsToDouble_entry();
103   address generate_Double_doubleToRawLongBits_entry();
104 #endif // IA32
105   // Some platforms don't need registers, other need two. Unused function is
106   // left unimplemented.
107   void generate_stack_overflow_check(void);
108   void generate_stack_overflow_check(Register Rframe_size, Register Rscratch);
109 
110   void generate_counter_incr(Label* overflow);
111   void generate_counter_overflow(Label& continue_entry);
112 
113   void generate_fixed_frame(bool native_call);
114 
115 #ifdef AARCH64
116   void generate_transcendental_entry(AbstractInterpreter::MethodKind kind, int fpargs);
117 #endif // AARCH64
118 
119 #ifdef ARM32
120   void generate_math_runtime_call(AbstractInterpreter::MethodKind kind);
121 #endif // ARM32
122 
123 #ifdef PPC
124   void lock_method(Register Rflags, Register Rscratch1, Register Rscratch2, bool flags_preloaded=false);
125   void generate_fixed_frame(bool native_call, Register Rsize_of_parameters, Register Rsize_of_locals);
126 #endif // PPC
127 
128  public:
129   TemplateInterpreterGenerator(StubQueue* _code);
130 };
131 
132 #endif // !ZERO
133 
134 #endif // SHARE_INTERPRETER_TEMPLATEINTERPRETERGENERATOR_HPP