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(AsmRemarks _asm_remarks;)   // Comments for annotating assembler output.
 53   NOT_PRODUCT(DbgStrings _dbg_strings;)   // Debug strings used in generated code.
 54 
 55  public:
 56   // Initialization/finalization
 57   void    initialize(int size)                   { _size = size; }
 58   void    finalize()                             { ShouldNotCallThis(); }
 59 
 60   // General info/converters
 61   int     size() const                           { return _size; }
 62   static  int code_size_to_size(int code_size)   { return align_up((int)sizeof(InterpreterCodelet), CodeEntryAlignment) + code_size; }
 63 
 64   // Code info
 65   address code_begin() const                     { return (address)this + align_up(sizeof(InterpreterCodelet), CodeEntryAlignment); }
 66   address code_end() const                       { return (address)this + size(); }
 67 
 68   // Debugging
 69   void    verify();
 70   void    print_on(outputStream* st) const;
 71   void    print() const;
 72 
 73   // Interpreter-specific initialization
 74   void    initialize(const char* description, Bytecodes::Code bytecode);
 75 
 76   // Interpreter-specific attributes
 77   int         code_size() const                  { return code_end() - code_begin(); }
 78   const char* description() const                { return _description; }
 79   Bytecodes::Code bytecode() const               { return _bytecode; }
 80 #ifndef PRODUCT
 81  ~InterpreterCodelet() {
 82     // InterpreterCodelets reside in the StubQueue and should not be deleted,
 83     // nor are they ever finalized (see above).
 84     ShouldNotCallThis();
 85   }
 86   void use_remarks(AsmRemarks &remarks) { _asm_remarks.share(remarks); }
 87   void use_strings(DbgStrings &strings) { _dbg_strings.share(strings); }
 88 #endif
 89 };
 90 
 91 // Define a prototype interface
 92 DEF_STUB_INTERFACE(InterpreterCodelet);
 93 
 94 
 95 //------------------------------------------------------------------------------------------------------------------------
 96 // A CodeletMark serves as an automatic creator/initializer for Codelets
 97 // (As a subclass of ResourceMark it automatically GC's the allocated
 98 // code buffer and assemblers).
 99 
100 class CodeletMark: ResourceMark {
101  private:
102   InterpreterCodelet*         _clet;
103   InterpreterMacroAssembler** _masm;
104   CodeBuffer                  _cb;
105 
106   int codelet_size() {
107     // Request the whole code buffer (minus a little for alignment).
108     // The commit call below trims it back for each codelet.
109     int codelet_size = AbstractInterpreter::code()->available_space() - 2*K;
110 
111     // Guarantee there's a little bit of code space left.
112     guarantee(codelet_size > 0 && (size_t)codelet_size > 2*K,
113               "not enough space for interpreter generation");
114 
115     return codelet_size;
116   }
117 
118  public:
119   CodeletMark(InterpreterMacroAssembler*& masm,
120               const char* description,
121               Bytecodes::Code bytecode = Bytecodes::_illegal);
122   ~CodeletMark();
123 };
124 
125 // Wrapper typedef to use the name Interpreter to mean either
126 // the Zero interpreter or the template interpreter.
127 
128 typedef ZERO_ONLY(ZeroInterpreter) NOT_ZERO(TemplateInterpreter) Interpreter;
129 
130 #endif // SHARE_INTERPRETER_INTERPRETER_HPP