Fri, 29 Aug 2014 19:45:49 -0400
8054292: code comments leak in fastdebug builds
Summary: Added deallocation to destructor; hardened interface against misuse
Reviewed-by: kvn
1 /*
2 * Copyright (c) 1997, 2013, 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 */
25 #ifndef SHARE_VM_INTERPRETER_INTERPRETER_HPP
26 #define SHARE_VM_INTERPRETER_INTERPRETER_HPP
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
37 // This file contains the platform-independent parts
38 // of the interpreter and the interpreter generator.
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.
45 class 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(CodeStrings _strings;) // Comments for annotating assembler output.
53 public:
54 // Initialization/finalization
55 void initialize(int size,
56 CodeStrings& strings) { _size = size;
57 DEBUG_ONLY(::new(&_strings) CodeStrings();)
58 DEBUG_ONLY(_strings.assign(strings);) }
59 void finalize() { ShouldNotCallThis(); }
61 // General info/converters
62 int size() const { return _size; }
63 static int code_size_to_size(int code_size) { return round_to(sizeof(InterpreterCodelet), CodeEntryAlignment) + code_size; }
65 // Code info
66 address code_begin() const { return (address)this + round_to(sizeof(InterpreterCodelet), CodeEntryAlignment); }
67 address code_end() const { return (address)this + size(); }
69 // Debugging
70 void verify();
71 void print_on(outputStream* st) const;
72 void print() const { print_on(tty); }
74 // Interpreter-specific initialization
75 void initialize(const char* description, Bytecodes::Code bytecode);
77 // Interpreter-specific attributes
78 int code_size() const { return code_end() - code_begin(); }
79 const char* description() const { return _description; }
80 Bytecodes::Code bytecode() const { return _bytecode; }
81 };
83 // Define a prototype interface
84 DEF_STUB_INTERFACE(InterpreterCodelet);
87 //------------------------------------------------------------------------------------------------------------------------
88 // A CodeletMark serves as an automatic creator/initializer for Codelets
89 // (As a subclass of ResourceMark it automatically GC's the allocated
90 // code buffer and assemblers).
92 class CodeletMark: ResourceMark {
93 private:
94 InterpreterCodelet* _clet;
95 InterpreterMacroAssembler** _masm;
96 CodeBuffer _cb;
98 int codelet_size() {
99 // Request the whole code buffer (minus a little for alignment).
100 // The commit call below trims it back for each codelet.
101 int codelet_size = AbstractInterpreter::code()->available_space() - 2*K;
103 // Guarantee there's a little bit of code space left.
104 guarantee (codelet_size > 0 && (size_t)codelet_size > 2*K,
105 "not enough space for interpreter generation");
107 return codelet_size;
108 }
110 public:
111 CodeletMark(
112 InterpreterMacroAssembler*& masm,
113 const char* description,
114 Bytecodes::Code bytecode = Bytecodes::_illegal):
115 _clet((InterpreterCodelet*)AbstractInterpreter::code()->request(codelet_size())),
116 _cb(_clet->code_begin(), _clet->code_size())
118 { // request all space (add some slack for Codelet data)
119 assert (_clet != NULL, "we checked not enough space already");
121 // initialize Codelet attributes
122 _clet->initialize(description, bytecode);
123 // create assembler for code generation
124 masm = new InterpreterMacroAssembler(&_cb);
125 _masm = &masm;
126 }
128 ~CodeletMark() {
129 // align so printing shows nop's instead of random code at the end (Codelets are aligned)
130 (*_masm)->align(wordSize);
131 // make sure all code is in code buffer
132 (*_masm)->flush();
135 // commit Codelet
136 AbstractInterpreter::code()->commit((*_masm)->code()->pure_insts_size(), (*_masm)->code()->strings());
137 // make sure nobody can use _masm outside a CodeletMark lifespan
138 *_masm = NULL;
139 }
140 };
142 // Wrapper classes to produce Interpreter/InterpreterGenerator from either
143 // the c++ interpreter or the template interpreter.
145 class Interpreter: public CC_INTERP_ONLY(CppInterpreter) NOT_CC_INTERP(TemplateInterpreter) {
147 public:
148 // Debugging/printing
149 static InterpreterCodelet* codelet_containing(address pc) { return (InterpreterCodelet*)_code->stub_containing(pc); }
150 #ifdef TARGET_ARCH_x86
151 # include "interpreter_x86.hpp"
152 #endif
153 #ifdef TARGET_ARCH_sparc
154 # include "interpreter_sparc.hpp"
155 #endif
156 #ifdef TARGET_ARCH_zero
157 # include "interpreter_zero.hpp"
158 #endif
159 #ifdef TARGET_ARCH_arm
160 # include "interpreter_arm.hpp"
161 #endif
162 #ifdef TARGET_ARCH_ppc
163 # include "interpreter_ppc.hpp"
164 #endif
166 };
168 #endif // SHARE_VM_INTERPRETER_INTERPRETER_HPP