1 /*
2 * Copyright (c) 1999, 2010, 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_C1_C1_COMPILATION_HPP
26 #define SHARE_VM_C1_C1_COMPILATION_HPP
27
28 #include "ci/ciEnv.hpp"
29 #include "code/exceptionHandlerTable.hpp"
30 #include "memory/resourceArea.hpp"
31
32 class BlockBegin;
33 class CompilationResourceObj;
34 class XHandlers;
35 class ExceptionInfo;
36 class DebugInformationRecorder;
37 class FrameMap;
38 class IR;
39 class IRScope;
40 class Instruction;
41 class LinearScan;
42 class OopMap;
43 class LIR_Emitter;
44 class LIR_Assembler;
45 class CodeEmitInfo;
46 class ciEnv;
47 class ciMethod;
48 class ValueStack;
49 class LIR_OprDesc;
50 class C1_MacroAssembler;
51 class CFGPrinter;
52 typedef LIR_OprDesc* LIR_Opr;
53
54
55 define_array(BasicTypeArray, BasicType)
56 define_stack(BasicTypeList, BasicTypeArray)
57
58 define_array(ExceptionInfoArray, ExceptionInfo*)
59 define_stack(ExceptionInfoList, ExceptionInfoArray)
60
61 class Compilation: public StackObj {
62 friend class CompilationResourceObj;
63 private:
64 // compilation specifics
65 Arena* _arena;
66 int _next_id;
67 int _next_block_id;
68 AbstractCompiler* _compiler;
69 ciEnv* _env;
70 ciMethod* _method;
71 int _osr_bci;
72 IR* _hir;
73 int _max_spills;
74 FrameMap* _frame_map;
75 C1_MacroAssembler* _masm;
76 bool _has_exception_handlers;
77 bool _has_fpu_code;
78 bool _has_unsafe_access;
79 bool _would_profile;
80 bool _has_method_handle_invokes; // True if this method has MethodHandle invokes.
81 const char* _bailout_msg;
82 ExceptionInfoList* _exception_info_list;
83 ExceptionHandlerTable _exception_handler_table;
84 ImplicitExceptionTable _implicit_exception_table;
85 LinearScan* _allocator;
86 CodeOffsets _offsets;
87 CodeBuffer _code;
88
89 // compilation helpers
90 void initialize();
91 void build_hir();
92 void emit_lir();
93
94 void emit_code_epilog(LIR_Assembler* assembler);
95 int emit_code_body();
96
97 int compile_java_method();
98 void install_code(int frame_size);
99 void compile_method();
100
101 void generate_exception_handler_table();
102
103 ExceptionInfoList* exception_info_list() const { return _exception_info_list; }
104 ExceptionHandlerTable* exception_handler_table() { return &_exception_handler_table; }
105
106 LinearScan* allocator() { return _allocator; }
107 void set_allocator(LinearScan* allocator) { _allocator = allocator; }
108
109 Instruction* _current_instruction; // the instruction currently being processed
110 #ifndef PRODUCT
111 Instruction* _last_instruction_printed; // the last instruction printed during traversal
112 #endif // PRODUCT
113
114 public:
115 // creation
116 Compilation(AbstractCompiler* compiler, ciEnv* env, ciMethod* method,
117 int osr_bci, BufferBlob* buffer_blob);
118 ~Compilation();
119
120
121 static Compilation* current() {
122 return (Compilation*) ciEnv::current()->compiler_data();
123 }
124
125 // accessors
126 ciEnv* env() const { return _env; }
127 AbstractCompiler* compiler() const { return _compiler; }
128 bool has_exception_handlers() const { return _has_exception_handlers; }
129 bool has_fpu_code() const { return _has_fpu_code; }
130 bool has_unsafe_access() const { return _has_unsafe_access; }
131 ciMethod* method() const { return _method; }
132 int osr_bci() const { return _osr_bci; }
133 bool is_osr_compile() const { return osr_bci() >= 0; }
134 IR* hir() const { return _hir; }
135 int max_spills() const { return _max_spills; }
136 FrameMap* frame_map() const { return _frame_map; }
137 CodeBuffer* code() { return &_code; }
138 C1_MacroAssembler* masm() const { return _masm; }
139 CodeOffsets* offsets() { return &_offsets; }
140 Arena* arena() { return _arena; }
141
142 // Instruction ids
143 int get_next_id() { return _next_id++; }
144 int number_of_instructions() const { return _next_id; }
145
146 // BlockBegin ids
147 int get_next_block_id() { return _next_block_id++; }
148 int number_of_blocks() const { return _next_block_id; }
149
150 // setters
151 void set_has_exception_handlers(bool f) { _has_exception_handlers = f; }
152 void set_has_fpu_code(bool f) { _has_fpu_code = f; }
153 void set_has_unsafe_access(bool f) { _has_unsafe_access = f; }
154 void set_would_profile(bool f) { _would_profile = f; }
155 // Add a set of exception handlers covering the given PC offset
156 void add_exception_handlers_for_pco(int pco, XHandlers* exception_handlers);
157 // Statistics gathering
158 void notice_inlined_method(ciMethod* method);
159
160 // JSR 292
161 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
162 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
163
164 DebugInformationRecorder* debug_info_recorder() const; // = _env->debug_info();
165 Dependencies* dependency_recorder() const; // = _env->dependencies()
166 ImplicitExceptionTable* implicit_exception_table() { return &_implicit_exception_table; }
167
168 Instruction* current_instruction() const { return _current_instruction; }
169 Instruction* set_current_instruction(Instruction* instr) {
170 Instruction* previous = _current_instruction;
171 _current_instruction = instr;
172 return previous;
173 }
174
175 #ifndef PRODUCT
176 void maybe_print_current_instruction();
177 #endif // PRODUCT
178
179 // error handling
180 void bailout(const char* msg);
181 bool bailed_out() const { return _bailout_msg != NULL; }
182 const char* bailout_msg() const { return _bailout_msg; }
183
184 static int desired_max_code_buffer_size() {
185 #ifndef PPC
186 return (int) NMethodSizeLimit; // default 256K or 512K
187 #else
188 // conditional branches on PPC are restricted to 16 bit signed
189 return MAX2((unsigned int)NMethodSizeLimit,32*K);
190 #endif
191 }
192 static int desired_max_constant_size() {
193 #ifndef PPC
194 return (int) NMethodSizeLimit / 10; // about 25K
195 #else
196 return (MAX2((unsigned int)NMethodSizeLimit, 32*K)) / 10;
197 #endif
198 }
199
200 static void setup_code_buffer(CodeBuffer* cb, int call_stub_estimate);
201
202 // timers
203 static void print_timers();
204
205 #ifndef PRODUCT
206 // debugging support.
207 // produces a file named c1compileonly in the current directory with
208 // directives to compile only the current method and it's inlines.
209 // The file can be passed to the command line option -XX:Flags=<filename>
210 void compile_only_this_method();
211 void compile_only_this_scope(outputStream* st, IRScope* scope);
212 void exclude_this_method();
213 #endif // PRODUCT
214
215 bool is_profiling() {
216 return env()->comp_level() == CompLevel_full_profile ||
217 env()->comp_level() == CompLevel_limited_profile;
218 }
219 bool count_invocations() { return is_profiling(); }
220 bool count_backedges() { return is_profiling(); }
221
222 // Helpers for generation of profile information
223 bool profile_branches() {
224 return env()->comp_level() == CompLevel_full_profile &&
225 C1UpdateMethodData && C1ProfileBranches;
226 }
227 bool profile_calls() {
228 return env()->comp_level() == CompLevel_full_profile &&
229 C1UpdateMethodData && C1ProfileCalls;
230 }
231 bool profile_inlined_calls() {
232 return profile_calls() && C1ProfileInlinedCalls;
233 }
234 bool profile_checkcasts() {
235 return env()->comp_level() == CompLevel_full_profile &&
236 C1UpdateMethodData && C1ProfileCheckcasts;
237 }
238 };
239
240
241 // Macro definitions for unified bailout-support
242 // The methods bailout() and bailed_out() are present in all classes
243 // that might bailout, but forward all calls to Compilation
244 #define BAILOUT(msg) { bailout(msg); return; }
245 #define BAILOUT_(msg, res) { bailout(msg); return res; }
246
247 #define CHECK_BAILOUT() { if (bailed_out()) return; }
248 #define CHECK_BAILOUT_(res) { if (bailed_out()) return res; }
249
250
251 class InstructionMark: public StackObj {
252 private:
253 Compilation* _compilation;
254 Instruction* _previous;
255
256 public:
257 InstructionMark(Compilation* compilation, Instruction* instr) {
258 _compilation = compilation;
259 _previous = _compilation->set_current_instruction(instr);
260 }
261 ~InstructionMark() {
262 _compilation->set_current_instruction(_previous);
263 }
264 };
265
266
267 //----------------------------------------------------------------------
268 // Base class for objects allocated by the compiler in the compilation arena
269 class CompilationResourceObj ALLOCATION_SUPER_CLASS_SPEC {
270 public:
271 void* operator new(size_t size) { return Compilation::current()->arena()->Amalloc(size); }
272 void* operator new(size_t size, Arena* arena) {
273 return arena->Amalloc(size);
274 }
275 void operator delete(void* p) {} // nothing to do
276 };
277
278
279 //----------------------------------------------------------------------
280 // Class for aggregating exception handler information.
281
282 // Effectively extends XHandlers class with PC offset of
283 // potentially exception-throwing instruction.
284 // This class is used at the end of the compilation to build the
285 // ExceptionHandlerTable.
286 class ExceptionInfo: public CompilationResourceObj {
287 private:
288 int _pco; // PC of potentially exception-throwing instruction
289 XHandlers* _exception_handlers; // flat list of exception handlers covering this PC
290
291 public:
292 ExceptionInfo(int pco, XHandlers* exception_handlers)
293 : _pco(pco)
294 , _exception_handlers(exception_handlers)
295 { }
296
297 int pco() { return _pco; }
298 XHandlers* exception_handlers() { return _exception_handlers; }
299 };
300
301 #endif // SHARE_VM_C1_C1_COMPILATION_HPP