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