interpreter.hpp revision 3718:b9a9ed0f8eeb 
1/*
2 * Copyright (c) 1997, 2012, 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//------------------------------------------------------------------------------------------------------------------------
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
45class InterpreterCodelet: public Stub {
46  friend class VMStructs;
47 private:
48  int         _size;                             // the size in bytes
49  const char* _description;                      // a description of the codelet, for debugging & printing
50  Bytecodes::Code _bytecode;                     // associated bytecode if any
51  DEBUG_ONLY(CodeComments _comments;)            // Comments for annotating assembler output.
52
53 public:
54  // Initialization/finalization
55  void    initialize(int size,
56                     CodeComments& comments)     { _size = size; DEBUG_ONLY(_comments.assign(comments);) }
57  void    finalize()                             { ShouldNotCallThis(); }
58
59  // General info/converters
60  int     size() const                           { return _size; }
61  static  int code_size_to_size(int code_size)   { return round_to(sizeof(InterpreterCodelet), CodeEntryAlignment) + code_size; }
62
63  // Code info
64  address code_begin() const                     { return (address)this + round_to(sizeof(InterpreterCodelet), CodeEntryAlignment); }
65  address code_end() const                       { return (address)this + size(); }
66
67  // Debugging
68  void    verify();
69  void    print_on(outputStream* st) const;
70  void    print() const { print_on(tty); }
71
72  // Interpreter-specific initialization
73  void    initialize(const char* description, Bytecodes::Code bytecode);
74
75  // Interpreter-specific attributes
76  int         code_size() const                  { return code_end() - code_begin(); }
77  const char* description() const                { return _description; }
78  Bytecodes::Code bytecode() const               { return _bytecode; }
79};
80
81// Define a prototype interface
82DEF_STUB_INTERFACE(InterpreterCodelet);
83
84
85//------------------------------------------------------------------------------------------------------------------------
86// A CodeletMark serves as an automatic creator/initializer for Codelets
87// (As a subclass of ResourceMark it automatically GC's the allocated
88// code buffer and assemblers).
89
90class CodeletMark: ResourceMark {
91 private:
92  InterpreterCodelet*         _clet;
93  InterpreterMacroAssembler** _masm;
94  CodeBuffer                  _cb;
95
96  int codelet_size() {
97    // Request the whole code buffer (minus a little for alignment).
98    // The commit call below trims it back for each codelet.
99    int codelet_size = AbstractInterpreter::code()->available_space() - 2*K;
100
101    // Guarantee there's a little bit of code space left.
102    guarantee (codelet_size > 0 && (size_t)codelet_size >  2*K,
103               "not enough space for interpreter generation");
104
105    return codelet_size;
106  }
107
108 public:
109  CodeletMark(
110    InterpreterMacroAssembler*& masm,
111    const char* description,
112    Bytecodes::Code bytecode = Bytecodes::_illegal):
113    _clet((InterpreterCodelet*)AbstractInterpreter::code()->request(codelet_size())),
114    _cb(_clet->code_begin(), _clet->code_size())
115
116  { // request all space (add some slack for Codelet data)
117    assert (_clet != NULL, "we checked not enough space already");
118
119    // initialize Codelet attributes
120    _clet->initialize(description, bytecode);
121    // create assembler for code generation
122    masm  = new InterpreterMacroAssembler(&_cb);
123    _masm = &masm;
124  }
125
126  ~CodeletMark() {
127    // align so printing shows nop's instead of random code at the end (Codelets are aligned)
128    (*_masm)->align(wordSize);
129    // make sure all code is in code buffer
130    (*_masm)->flush();
131
132
133    // commit Codelet
134    AbstractInterpreter::code()->commit((*_masm)->code()->pure_insts_size(), (*_masm)->code()->comments());
135    // make sure nobody can use _masm outside a CodeletMark lifespan
136    *_masm = NULL;
137  }
138};
139
140// Wrapper classes to produce Interpreter/InterpreterGenerator from either
141// the c++ interpreter or the template interpreter.
142
143class Interpreter: public CC_INTERP_ONLY(CppInterpreter) NOT_CC_INTERP(TemplateInterpreter) {
144
145  public:
146  // Debugging/printing
147  static InterpreterCodelet* codelet_containing(address pc)     { return (InterpreterCodelet*)_code->stub_containing(pc); }
148#ifdef TARGET_ARCH_x86
149# include "interpreter_x86.hpp"
150#endif
151#ifdef TARGET_ARCH_sparc
152# include "interpreter_sparc.hpp"
153#endif
154#ifdef TARGET_ARCH_zero
155# include "interpreter_zero.hpp"
156#endif
157#ifdef TARGET_ARCH_arm
158# include "interpreter_arm.hpp"
159#endif
160#ifdef TARGET_ARCH_ppc
161# include "interpreter_ppc.hpp"
162#endif
163
164};
165
166#endif // SHARE_VM_INTERPRETER_INTERPRETER_HPP
167