1 /* 2 * Copyright (c) 1997, 2020, 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_INTERPRETER_HPP 26 #define SHARE_INTERPRETER_INTERPRETER_HPP 27 28 #include "code/stubs.hpp" 29 #include "interpreter/interp_masm.hpp" 30 #include "interpreter/templateInterpreter.hpp" 31 #include "interpreter/zero/zeroInterpreter.hpp" 32 #include "memory/resourceArea.hpp" 33 #include "utilities/align.hpp" 34 35 // This file contains the platform-independent parts 36 // of the interpreter and the interpreter generator. 37 38 class InterpreterMacroAssembler; 39 40 //------------------------------------------------------------------------------------------------------------------------ 41 // An InterpreterCodelet is a piece of interpreter code. All 42 // interpreter code is generated into little codelets which 43 // contain extra information for debugging and printing purposes. 44 45 class InterpreterCodelet: public Stub { 46 friend class VMStructs; 47 friend class CodeCacheDumper; // possible extension [do not remove] 48 private: 49 int _size; // the size in bytes 50 const char* _description; // a description of the codelet, for debugging & printing 51 Bytecodes::Code _bytecode; // associated bytecode if any 52 NOT_PRODUCT(CodeStrings _strings;) // Comments for annotating assembler output. 53 54 public: 55 // Initialization/finalization initialize(int size,CodeStrings & strings)56 void initialize(int size, 57 CodeStrings& strings) { _size = size; 58 NOT_PRODUCT(_strings = CodeStrings();) 59 NOT_PRODUCT(_strings.copy(strings);) } finalize()60 void finalize() { ShouldNotCallThis(); } 61 62 // General info/converters size() const63 int size() const { return _size; } code_size_to_size(int code_size)64 static int code_size_to_size(int code_size) { return align_up((int)sizeof(InterpreterCodelet), CodeEntryAlignment) + code_size; } 65 66 // Code info code_begin() const67 address code_begin() const { return (address)this + align_up(sizeof(InterpreterCodelet), CodeEntryAlignment); } code_end() const68 address code_end() const { return (address)this + size(); } 69 70 // Debugging 71 void verify(); 72 void print_on(outputStream* st) const; 73 void print() const; 74 75 // Interpreter-specific initialization 76 void initialize(const char* description, Bytecodes::Code bytecode); 77 78 // Interpreter-specific attributes code_size() const79 int code_size() const { return code_end() - code_begin(); } description() const80 const char* description() const { return _description; } bytecode() const81 Bytecodes::Code bytecode() const { return _bytecode; } 82 }; 83 84 // Define a prototype interface 85 DEF_STUB_INTERFACE(InterpreterCodelet); 86 87 88 //------------------------------------------------------------------------------------------------------------------------ 89 // A CodeletMark serves as an automatic creator/initializer for Codelets 90 // (As a subclass of ResourceMark it automatically GC's the allocated 91 // code buffer and assemblers). 92 93 class CodeletMark: ResourceMark { 94 private: 95 InterpreterCodelet* _clet; 96 InterpreterMacroAssembler** _masm; 97 CodeBuffer _cb; 98 codelet_size()99 int codelet_size() { 100 // Request the whole code buffer (minus a little for alignment). 101 // The commit call below trims it back for each codelet. 102 int codelet_size = AbstractInterpreter::code()->available_space() - 2*K; 103 104 // Guarantee there's a little bit of code space left. 105 guarantee(codelet_size > 0 && (size_t)codelet_size > 2*K, 106 "not enough space for interpreter generation"); 107 108 return codelet_size; 109 } 110 111 public: 112 CodeletMark(InterpreterMacroAssembler*& masm, 113 const char* description, 114 Bytecodes::Code bytecode = Bytecodes::_illegal); 115 ~CodeletMark(); 116 }; 117 118 // Wrapper typedef to use the name Interpreter to mean either 119 // the Zero interpreter or the template interpreter. 120 121 typedef ZERO_ONLY(ZeroInterpreter) NOT_ZERO(TemplateInterpreter) Interpreter; 122 123 #endif // SHARE_INTERPRETER_INTERPRETER_HPP 124