1 /*
   2  * Copyright (c) 1997, 2014, 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_INTERPRETER_HPP
  26 #define SHARE_VM_INTERPRETER_INTERPRETER_HPP
  27 
  28 #include "code/stubs.hpp"
  29 #include "interpreter/cppInterpreter.hpp"
  30 #include "interpreter/templateInterpreter.hpp"
  31 #ifdef ZERO
  32 #ifdef TARGET_ARCH_zero
  33 # include "entry_zero.hpp"
  34 #endif
  35 #endif
  36 
  37 // This file contains the platform-independent parts
  38 // of the interpreter and the interpreter generator.
  39 
  40 class InterpreterMacroAssembler;
  41 
  42 //------------------------------------------------------------------------------------------------------------------------
  43 // An InterpreterCodelet is a piece of interpreter code. All
  44 // interpreter code is generated into little codelets which
  45 // contain extra information for debugging and printing purposes.
  46 
  47 class InterpreterCodelet: public Stub {
  48   friend class VMStructs;
  49  private:
  50   int         _size;                             // the size in bytes
  51   const char* _description;                      // a description of the codelet, for debugging & printing
  52   Bytecodes::Code _bytecode;                     // associated bytecode if any
  53   DEBUG_ONLY(CodeStrings _strings;)              // Comments for annotating assembler output.
  54 
  55  public:
  56   // Initialization/finalization
  57   void    initialize(int size,
  58                      CodeStrings& strings)       { _size = size;
  59                                                    DEBUG_ONLY(::new(&_strings) CodeStrings();)
  60                                                    DEBUG_ONLY(_strings.assign(strings);) }
  61   void    finalize()                             { ShouldNotCallThis(); }
  62 
  63   // General info/converters
  64   int     size() const                           { return _size; }
  65   static  int code_size_to_size(int code_size)   { return round_to(sizeof(InterpreterCodelet), CodeEntryAlignment) + code_size; }
  66 
  67   // Code info
  68   address code_begin() const                     { return (address)this + round_to(sizeof(InterpreterCodelet), CodeEntryAlignment); }
  69   address code_end() const                       { return (address)this + size(); }
  70 
  71   // Debugging
  72   void    verify();
  73   void    print_on(outputStream* st) const;
  74   void    print() const { print_on(tty); }
  75 
  76   // Interpreter-specific initialization
  77   void    initialize(const char* description, Bytecodes::Code bytecode);
  78 
  79   // Interpreter-specific attributes
  80   int         code_size() const                  { return code_end() - code_begin(); }
  81   const char* description() const                { return _description; }
  82   Bytecodes::Code bytecode() const               { return _bytecode; }
  83 };
  84 
  85 // Define a prototype interface
  86 DEF_STUB_INTERFACE(InterpreterCodelet);
  87 
  88 
  89 //------------------------------------------------------------------------------------------------------------------------
  90 // A CodeletMark serves as an automatic creator/initializer for Codelets
  91 // (As a subclass of ResourceMark it automatically GC's the allocated
  92 // code buffer and assemblers).
  93 
  94 class CodeletMark: ResourceMark {
  95  private:
  96   InterpreterCodelet*         _clet;
  97   InterpreterMacroAssembler** _masm;
  98   CodeBuffer                  _cb;
  99 
 100   int codelet_size() {
 101     // Request the whole code buffer (minus a little for alignment).
 102     // The commit call below trims it back for each codelet.
 103     int codelet_size = AbstractInterpreter::code()->available_space() - 2*K;
 104 
 105     // Guarantee there's a little bit of code space left.
 106     guarantee(codelet_size > 0 && (size_t)codelet_size > 2*K,
 107               "not enough space for interpreter generation");
 108 
 109     return codelet_size;
 110   }
 111 
 112  public:
 113   CodeletMark(InterpreterMacroAssembler*& masm,
 114               const char* description,
 115               Bytecodes::Code bytecode = Bytecodes::_illegal);
 116   ~CodeletMark();
 117 };
 118 
 119 // Wrapper classes to produce Interpreter/InterpreterGenerator from either
 120 // the c++ interpreter or the template interpreter.
 121 
 122 class Interpreter: public CC_INTERP_ONLY(CppInterpreter) NOT_CC_INTERP(TemplateInterpreter) {
 123 
 124  public:
 125   // Debugging/printing
 126   static InterpreterCodelet* codelet_containing(address pc) { return (InterpreterCodelet*)_code->stub_containing(pc); }
 127 
 128 #ifdef TARGET_ARCH_x86
 129 # include "interpreter_x86.hpp"
 130 #endif
 131 #ifdef TARGET_ARCH_sparc
 132 # include "interpreter_sparc.hpp"
 133 #endif
 134 #ifdef TARGET_ARCH_zero
 135 # include "interpreter_zero.hpp"
 136 #endif
 137 #ifdef TARGET_ARCH_arm
 138 # include "interpreter_arm.hpp"
 139 #endif
 140 #ifdef TARGET_ARCH_ppc
 141 # include "interpreter_ppc.hpp"
 142 #endif
 143 #ifdef TARGET_ARCH_aarch64
 144 # include "interpreter_aarch64.hpp"
 145 #endif
 146 
 147 };
 148 
 149 #endif // SHARE_VM_INTERPRETER_INTERPRETER_HPP