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_OPTO_COMPILE_HPP
26 #define SHARE_VM_OPTO_COMPILE_HPP
27
28 #include "asm/codeBuffer.hpp"
29 #include "ci/compilerInterface.hpp"
30 #include "code/debugInfoRec.hpp"
31 #include "code/exceptionHandlerTable.hpp"
32 #include "compiler/compilerOracle.hpp"
33 #include "libadt/dict.hpp"
34 #include "libadt/port.hpp"
35 #include "libadt/vectset.hpp"
36 #include "memory/resourceArea.hpp"
37 #include "opto/idealGraphPrinter.hpp"
38 #include "opto/phase.hpp"
39 #include "opto/regmask.hpp"
40 #include "runtime/deoptimization.hpp"
41 #include "runtime/vmThread.hpp"
42
43 class Block;
44 class Bundle;
45 class C2Compiler;
46 class CallGenerator;
47 class ConnectionGraph;
48 class InlineTree;
49 class Int_Array;
50 class Matcher;
51 class MachConstantNode;
52 class MachConstantBaseNode;
53 class MachNode;
54 class MachOper;
55 class MachSafePointNode;
56 class Node;
57 class Node_Array;
58 class Node_Notes;
59 class OptoReg;
60 class PhaseCFG;
61 class PhaseGVN;
62 class PhaseIterGVN;
63 class PhaseRegAlloc;
64 class PhaseCCP;
65 class PhaseCCP_DCE;
66 class RootNode;
67 class relocInfo;
68 class Scope;
69 class StartNode;
70 class SafePointNode;
71 class JVMState;
72 class TypeData;
73 class TypePtr;
74 class TypeFunc;
75 class Unique_Node_List;
76 class nmethod;
77 class WarmCallInfo;
78
79 //------------------------------Compile----------------------------------------
80 // This class defines a top-level Compiler invocation.
81
82 class Compile : public Phase {
83 friend class VMStructs;
84
85 public:
86 // Fixed alias indexes. (See also MergeMemNode.)
87 enum {
88 AliasIdxTop = 1, // pseudo-index, aliases to nothing (used as sentinel value)
89 AliasIdxBot = 2, // pseudo-index, aliases to everything
90 AliasIdxRaw = 3 // hard-wired index for TypeRawPtr::BOTTOM
91 };
92
93 // Variant of TraceTime(NULL, &_t_accumulator, TimeCompiler);
94 // Integrated with logging. If logging is turned on, and dolog is true,
95 // then brackets are put into the log, with time stamps and node counts.
96 // (The time collection itself is always conditionalized on TimeCompiler.)
97 class TracePhase : public TraceTime {
98 private:
99 Compile* C;
100 CompileLog* _log;
101 public:
102 TracePhase(const char* name, elapsedTimer* accumulator, bool dolog);
103 ~TracePhase();
104 };
105
106 // Information per category of alias (memory slice)
107 class AliasType {
108 private:
109 friend class Compile;
110
111 int _index; // unique index, used with MergeMemNode
112 const TypePtr* _adr_type; // normalized address type
113 ciField* _field; // relevant instance field, or null if none
114 bool _is_rewritable; // false if the memory is write-once only
115 int _general_index; // if this is type is an instance, the general
116 // type that this is an instance of
117
118 void Init(int i, const TypePtr* at);
119
120 public:
121 int index() const { return _index; }
122 const TypePtr* adr_type() const { return _adr_type; }
123 ciField* field() const { return _field; }
124 bool is_rewritable() const { return _is_rewritable; }
125 bool is_volatile() const { return (_field ? _field->is_volatile() : false); }
126 int general_index() const { return (_general_index != 0) ? _general_index : _index; }
127
128 void set_rewritable(bool z) { _is_rewritable = z; }
129 void set_field(ciField* f) {
130 assert(!_field,"");
131 _field = f;
132 if (f->is_final()) _is_rewritable = false;
133 }
134
135 void print_on(outputStream* st) PRODUCT_RETURN;
136 };
137
138 enum {
139 logAliasCacheSize = 6,
140 AliasCacheSize = (1<<logAliasCacheSize)
141 };
142 struct AliasCacheEntry { const TypePtr* _adr_type; int _index; }; // simple duple type
143 enum {
144 trapHistLength = MethodData::_trap_hist_limit
145 };
146
147 // Constant entry of the constant table.
148 class Constant {
149 private:
150 BasicType _type;
151 union {
152 jvalue _value;
153 Metadata* _metadata;
154 } _v;
155 int _offset; // offset of this constant (in bytes) relative to the constant table base.
156 float _freq;
157 bool _can_be_reused; // true (default) if the value can be shared with other users.
158
159 public:
160 Constant() : _type(T_ILLEGAL), _offset(-1), _freq(0.0f), _can_be_reused(true) { _v._value.l = 0; }
161 Constant(BasicType type, jvalue value, float freq = 0.0f, bool can_be_reused = true) :
162 _type(type),
163 _offset(-1),
164 _freq(freq),
165 _can_be_reused(can_be_reused)
166 {
167 assert(type != T_METADATA, "wrong constructor");
168 _v._value = value;
169 }
170 Constant(Metadata* metadata, bool can_be_reused = true) :
171 _type(T_METADATA),
172 _offset(-1),
173 _freq(0.0f),
174 _can_be_reused(can_be_reused)
175 {
176 _v._metadata = metadata;
177 }
178
179 bool operator==(const Constant& other);
180
181 BasicType type() const { return _type; }
182
183 jlong get_jlong() const { return _v._value.j; }
184 jfloat get_jfloat() const { return _v._value.f; }
185 jdouble get_jdouble() const { return _v._value.d; }
186 jobject get_jobject() const { return _v._value.l; }
187
188 Metadata* get_metadata() const { return _v._metadata; }
189
190 int offset() const { return _offset; }
191 void set_offset(int offset) { _offset = offset; }
192
193 float freq() const { return _freq; }
194 void inc_freq(float freq) { _freq += freq; }
195
196 bool can_be_reused() const { return _can_be_reused; }
197 };
198
199 // Constant table.
200 class ConstantTable {
201 private:
202 GrowableArray<Constant> _constants; // Constants of this table.
203 int _size; // Size in bytes the emitted constant table takes (including padding).
204 int _table_base_offset; // Offset of the table base that gets added to the constant offsets.
205 int _nof_jump_tables; // Number of jump-tables in this constant table.
206
207 static int qsort_comparator(Constant* a, Constant* b);
208
209 // We use negative frequencies to keep the order of the
210 // jump-tables in which they were added. Otherwise we get into
211 // trouble with relocation.
212 float next_jump_table_freq() { return -1.0f * (++_nof_jump_tables); }
213
214 public:
215 ConstantTable() :
216 _size(-1),
217 _table_base_offset(-1), // We can use -1 here since the constant table is always bigger than 2 bytes (-(size / 2), see MachConstantBaseNode::emit).
218 _nof_jump_tables(0)
219 {}
220
221 int size() const { assert(_size != -1, "not calculated yet"); return _size; }
222
223 int calculate_table_base_offset() const; // AD specific
224 void set_table_base_offset(int x) { assert(_table_base_offset == -1 || x == _table_base_offset, "can't change"); _table_base_offset = x; }
225 int table_base_offset() const { assert(_table_base_offset != -1, "not set yet"); return _table_base_offset; }
226
227 void emit(CodeBuffer& cb);
228
229 // Returns the offset of the last entry (the top) of the constant table.
230 int top_offset() const { assert(_constants.top().offset() != -1, "not bound yet"); return _constants.top().offset(); }
231
232 void calculate_offsets_and_size();
233 int find_offset(Constant& con) const;
234
235 void add(Constant& con);
236 Constant add(MachConstantNode* n, BasicType type, jvalue value);
237 Constant add(Metadata* metadata);
238 Constant add(MachConstantNode* n, MachOper* oper);
239 Constant add(MachConstantNode* n, jfloat f) {
240 jvalue value; value.f = f;
241 return add(n, T_FLOAT, value);
242 }
243 Constant add(MachConstantNode* n, jdouble d) {
244 jvalue value; value.d = d;
245 return add(n, T_DOUBLE, value);
246 }
247
248 // Jump-table
249 Constant add_jump_table(MachConstantNode* n);
250 void fill_jump_table(CodeBuffer& cb, MachConstantNode* n, GrowableArray<Label*> labels) const;
251 };
252
253 private:
254 // Fixed parameters to this compilation.
255 const int _compile_id;
256 const bool _save_argument_registers; // save/restore arg regs for trampolines
257 const bool _subsume_loads; // Load can be matched as part of a larger op.
258 const bool _do_escape_analysis; // Do escape analysis.
259 ciMethod* _method; // The method being compiled.
260 int _entry_bci; // entry bci for osr methods.
261 const TypeFunc* _tf; // My kind of signature
262 InlineTree* _ilt; // Ditto (temporary).
263 address _stub_function; // VM entry for stub being compiled, or NULL
264 const char* _stub_name; // Name of stub or adapter being compiled, or NULL
265 address _stub_entry_point; // Compile code entry for generated stub, or NULL
266
267 // Control of this compilation.
268 int _num_loop_opts; // Number of iterations for doing loop optimiztions
269 int _max_inline_size; // Max inline size for this compilation
270 int _freq_inline_size; // Max hot method inline size for this compilation
271 int _fixed_slots; // count of frame slots not allocated by the register
272 // allocator i.e. locks, original deopt pc, etc.
273 // For deopt
274 int _orig_pc_slot;
275 int _orig_pc_slot_offset_in_bytes;
276
277 int _major_progress; // Count of something big happening
278 bool _has_loops; // True if the method _may_ have some loops
279 bool _has_split_ifs; // True if the method _may_ have some split-if
280 bool _has_unsafe_access; // True if the method _may_ produce faults in unsafe loads or stores.
281 bool _has_stringbuilder; // True StringBuffers or StringBuilders are allocated
282 int _max_vector_size; // Maximum size of generated vectors
283 uint _trap_hist[trapHistLength]; // Cumulative traps
284 bool _trap_can_recompile; // Have we emitted a recompiling trap?
285 uint _decompile_count; // Cumulative decompilation counts.
286 bool _do_inlining; // True if we intend to do inlining
287 bool _do_scheduling; // True if we intend to do scheduling
288 bool _do_freq_based_layout; // True if we intend to do frequency based block layout
289 bool _do_count_invocations; // True if we generate code to count invocations
290 bool _do_method_data_update; // True if we generate code to update MethodData*s
291 int _AliasLevel; // Locally-adjusted version of AliasLevel flag.
292 bool _print_assembly; // True if we should dump assembly code for this compilation
293 #ifndef PRODUCT
294 bool _trace_opto_output;
295 bool _parsed_irreducible_loop; // True if ciTypeFlow detected irreducible loops during parsing
296 #endif
297
298 // JSR 292
299 bool _has_method_handle_invokes; // True if this method has MethodHandle invokes.
300
301 // Compilation environment.
302 Arena _comp_arena; // Arena with lifetime equivalent to Compile
303 ciEnv* _env; // CI interface
304 CompileLog* _log; // from CompilerThread
305 const char* _failure_reason; // for record_failure/failing pattern
306 GrowableArray<CallGenerator*>* _intrinsics; // List of intrinsics.
307 GrowableArray<Node*>* _macro_nodes; // List of nodes which need to be expanded before matching.
308 GrowableArray<Node*>* _predicate_opaqs; // List of Opaque1 nodes for the loop predicates.
309 ConnectionGraph* _congraph;
310 #ifndef PRODUCT
311 IdealGraphPrinter* _printer;
312 #endif
313
314 // Node management
315 uint _unique; // Counter for unique Node indices
316 debug_only(static int _debug_idx;) // Monotonic counter (not reset), use -XX:BreakAtNode=<idx>
317 Arena _node_arena; // Arena for new-space Nodes
318 Arena _old_arena; // Arena for old-space Nodes, lifetime during xform
319 RootNode* _root; // Unique root of compilation, or NULL after bail-out.
320 Node* _top; // Unique top node. (Reset by various phases.)
321
322 Node* _immutable_memory; // Initial memory state
323
324 Node* _recent_alloc_obj;
325 Node* _recent_alloc_ctl;
326
327 // Constant table
328 ConstantTable _constant_table; // The constant table for this compile.
329 MachConstantBaseNode* _mach_constant_base_node; // Constant table base node singleton.
330
331
332 // Blocked array of debugging and profiling information,
333 // tracked per node.
334 enum { _log2_node_notes_block_size = 8,
335 _node_notes_block_size = (1<<_log2_node_notes_block_size)
336 };
337 GrowableArray<Node_Notes*>* _node_note_array;
338 Node_Notes* _default_node_notes; // default notes for new nodes
339
340 // After parsing and every bulk phase we hang onto the Root instruction.
341 // The RootNode instruction is where the whole program begins. It produces
342 // the initial Control and BOTTOM for everybody else.
343
344 // Type management
345 Arena _Compile_types; // Arena for all types
346 Arena* _type_arena; // Alias for _Compile_types except in Initialize_shared()
347 Dict* _type_dict; // Intern table
348 void* _type_hwm; // Last allocation (see Type::operator new/delete)
349 size_t _type_last_size; // Last allocation size (see Type::operator new/delete)
350 ciMethod* _last_tf_m; // Cache for
351 const TypeFunc* _last_tf; // TypeFunc::make
352 AliasType** _alias_types; // List of alias types seen so far.
353 int _num_alias_types; // Logical length of _alias_types
354 int _max_alias_types; // Physical length of _alias_types
355 AliasCacheEntry _alias_cache[AliasCacheSize]; // Gets aliases w/o data structure walking
356
357 // Parsing, optimization
358 PhaseGVN* _initial_gvn; // Results of parse-time PhaseGVN
359 Unique_Node_List* _for_igvn; // Initial work-list for next round of Iterative GVN
360 WarmCallInfo* _warm_calls; // Sorted work-list for heat-based inlining.
361
362 GrowableArray<CallGenerator*> _late_inlines; // List of CallGenerators to be revisited after
363 // main parsing has finished.
364
365 // Matching, CFG layout, allocation, code generation
366 PhaseCFG* _cfg; // Results of CFG finding
367 bool _select_24_bit_instr; // We selected an instruction with a 24-bit result
368 bool _in_24_bit_fp_mode; // We are emitting instructions with 24-bit results
369 int _java_calls; // Number of java calls in the method
370 int _inner_loops; // Number of inner loops in the method
371 Matcher* _matcher; // Engine to map ideal to machine instructions
372 PhaseRegAlloc* _regalloc; // Results of register allocation.
373 int _frame_slots; // Size of total frame in stack slots
374 CodeOffsets _code_offsets; // Offsets into the code for various interesting entries
375 RegMask _FIRST_STACK_mask; // All stack slots usable for spills (depends on frame layout)
376 Arena* _indexSet_arena; // control IndexSet allocation within PhaseChaitin
377 void* _indexSet_free_block_list; // free list of IndexSet bit blocks
378
379 uint _node_bundling_limit;
380 Bundle* _node_bundling_base; // Information for instruction bundling
381
382 // Instruction bits passed off to the VM
383 int _method_size; // Size of nmethod code segment in bytes
384 CodeBuffer _code_buffer; // Where the code is assembled
385 int _first_block_size; // Size of unvalidated entry point code / OSR poison code
386 ExceptionHandlerTable _handler_table; // Table of native-code exception handlers
387 ImplicitExceptionTable _inc_table; // Table of implicit null checks in native code
388 OopMapSet* _oop_map_set; // Table of oop maps (one for each safepoint location)
389 static int _CompiledZap_count; // counter compared against CompileZap[First/Last]
390 BufferBlob* _scratch_buffer_blob; // For temporary code buffers.
391 relocInfo* _scratch_locs_memory; // For temporary code buffers.
392 int _scratch_const_size; // For temporary code buffers.
393 bool _in_scratch_emit_size; // true when in scratch_emit_size.
394
395 public:
396 // Accessors
397
398 // The Compile instance currently active in this (compiler) thread.
399 static Compile* current() {
400 return (Compile*) ciEnv::current()->compiler_data();
401 }
402
403 // ID for this compilation. Useful for setting breakpoints in the debugger.
404 int compile_id() const { return _compile_id; }
405
406 // Does this compilation allow instructions to subsume loads? User
407 // instructions that subsume a load may result in an unschedulable
408 // instruction sequence.
409 bool subsume_loads() const { return _subsume_loads; }
410 // Do escape analysis.
411 bool do_escape_analysis() const { return _do_escape_analysis; }
412 bool save_argument_registers() const { return _save_argument_registers; }
413
414
415 // Other fixed compilation parameters.
416 ciMethod* method() const { return _method; }
417 int entry_bci() const { return _entry_bci; }
418 bool is_osr_compilation() const { return _entry_bci != InvocationEntryBci; }
419 bool is_method_compilation() const { return (_method != NULL && !_method->flags().is_native()); }
420 const TypeFunc* tf() const { assert(_tf!=NULL, ""); return _tf; }
421 void init_tf(const TypeFunc* tf) { assert(_tf==NULL, ""); _tf = tf; }
422 InlineTree* ilt() const { return _ilt; }
423 address stub_function() const { return _stub_function; }
424 const char* stub_name() const { return _stub_name; }
425 address stub_entry_point() const { return _stub_entry_point; }
426
427 // Control of this compilation.
428 int fixed_slots() const { assert(_fixed_slots >= 0, ""); return _fixed_slots; }
429 void set_fixed_slots(int n) { _fixed_slots = n; }
430 int major_progress() const { return _major_progress; }
431 void set_major_progress() { _major_progress++; }
432 void clear_major_progress() { _major_progress = 0; }
433 int num_loop_opts() const { return _num_loop_opts; }
434 void set_num_loop_opts(int n) { _num_loop_opts = n; }
435 int max_inline_size() const { return _max_inline_size; }
436 void set_freq_inline_size(int n) { _freq_inline_size = n; }
437 int freq_inline_size() const { return _freq_inline_size; }
438 void set_max_inline_size(int n) { _max_inline_size = n; }
439 bool has_loops() const { return _has_loops; }
440 void set_has_loops(bool z) { _has_loops = z; }
441 bool has_split_ifs() const { return _has_split_ifs; }
442 void set_has_split_ifs(bool z) { _has_split_ifs = z; }
443 bool has_unsafe_access() const { return _has_unsafe_access; }
444 void set_has_unsafe_access(bool z) { _has_unsafe_access = z; }
445 bool has_stringbuilder() const { return _has_stringbuilder; }
446 void set_has_stringbuilder(bool z) { _has_stringbuilder = z; }
447 int max_vector_size() const { return _max_vector_size; }
448 void set_max_vector_size(int s) { _max_vector_size = s; }
449 void set_trap_count(uint r, uint c) { assert(r < trapHistLength, "oob"); _trap_hist[r] = c; }
450 uint trap_count(uint r) const { assert(r < trapHistLength, "oob"); return _trap_hist[r]; }
451 bool trap_can_recompile() const { return _trap_can_recompile; }
452 void set_trap_can_recompile(bool z) { _trap_can_recompile = z; }
453 uint decompile_count() const { return _decompile_count; }
454 void set_decompile_count(uint c) { _decompile_count = c; }
455 bool allow_range_check_smearing() const;
456 bool do_inlining() const { return _do_inlining; }
457 void set_do_inlining(bool z) { _do_inlining = z; }
458 bool do_scheduling() const { return _do_scheduling; }
459 void set_do_scheduling(bool z) { _do_scheduling = z; }
460 bool do_freq_based_layout() const{ return _do_freq_based_layout; }
461 void set_do_freq_based_layout(bool z){ _do_freq_based_layout = z; }
462 bool do_count_invocations() const{ return _do_count_invocations; }
463 void set_do_count_invocations(bool z){ _do_count_invocations = z; }
464 bool do_method_data_update() const { return _do_method_data_update; }
465 void set_do_method_data_update(bool z) { _do_method_data_update = z; }
466 int AliasLevel() const { return _AliasLevel; }
467 bool print_assembly() const { return _print_assembly; }
468 void set_print_assembly(bool z) { _print_assembly = z; }
469 // check the CompilerOracle for special behaviours for this compile
470 bool method_has_option(const char * option) {
471 return method() != NULL && method()->has_option(option);
472 }
473 #ifndef PRODUCT
474 bool trace_opto_output() const { return _trace_opto_output; }
475 bool parsed_irreducible_loop() const { return _parsed_irreducible_loop; }
476 void set_parsed_irreducible_loop(bool z) { _parsed_irreducible_loop = z; }
477 #endif
478
479 // JSR 292
480 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
481 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
482
483 void begin_method() {
484 #ifndef PRODUCT
485 if (_printer) _printer->begin_method(this);
486 #endif
487 }
488 void print_method(const char * name, int level = 1) {
489 #ifndef PRODUCT
490 if (_printer) _printer->print_method(this, name, level);
491 #endif
492 }
493 void end_method() {
494 #ifndef PRODUCT
495 if (_printer) _printer->end_method();
496 #endif
497 }
498
499 int macro_count() { return _macro_nodes->length(); }
500 int predicate_count() { return _predicate_opaqs->length();}
501 Node* macro_node(int idx) { return _macro_nodes->at(idx); }
502 Node* predicate_opaque1_node(int idx) { return _predicate_opaqs->at(idx);}
503 ConnectionGraph* congraph() { return _congraph;}
504 void set_congraph(ConnectionGraph* congraph) { _congraph = congraph;}
505 void add_macro_node(Node * n) {
506 //assert(n->is_macro(), "must be a macro node");
507 assert(!_macro_nodes->contains(n), " duplicate entry in expand list");
508 _macro_nodes->append(n);
509 }
510 void remove_macro_node(Node * n) {
511 // this function may be called twice for a node so check
512 // that the node is in the array before attempting to remove it
513 if (_macro_nodes->contains(n))
514 _macro_nodes->remove(n);
515 // remove from _predicate_opaqs list also if it is there
516 if (predicate_count() > 0 && _predicate_opaqs->contains(n)){
517 _predicate_opaqs->remove(n);
518 }
519 }
520 void add_predicate_opaq(Node * n) {
521 assert(!_predicate_opaqs->contains(n), " duplicate entry in predicate opaque1");
522 assert(_macro_nodes->contains(n), "should have already been in macro list");
523 _predicate_opaqs->append(n);
524 }
525 // remove the opaque nodes that protect the predicates so that the unused checks and
526 // uncommon traps will be eliminated from the graph.
527 void cleanup_loop_predicates(PhaseIterGVN &igvn);
528 bool is_predicate_opaq(Node * n) {
529 return _predicate_opaqs->contains(n);
530 }
531
532 // Compilation environment.
533 Arena* comp_arena() { return &_comp_arena; }
534 ciEnv* env() const { return _env; }
535 CompileLog* log() const { return _log; }
536 bool failing() const { return _env->failing() || _failure_reason != NULL; }
537 const char* failure_reason() { return _failure_reason; }
538 bool failure_reason_is(const char* r) { return (r==_failure_reason) || (r!=NULL && _failure_reason!=NULL && strcmp(r, _failure_reason)==0); }
539
540 void record_failure(const char* reason);
541 void record_method_not_compilable(const char* reason, bool all_tiers = false) {
542 // All bailouts cover "all_tiers" when TieredCompilation is off.
543 if (!TieredCompilation) all_tiers = true;
544 env()->record_method_not_compilable(reason, all_tiers);
545 // Record failure reason.
546 record_failure(reason);
547 }
548 void record_method_not_compilable_all_tiers(const char* reason) {
549 record_method_not_compilable(reason, true);
550 }
551 bool check_node_count(uint margin, const char* reason) {
552 if (unique() + margin > (uint)MaxNodeLimit) {
553 record_method_not_compilable(reason);
554 return true;
555 } else {
556 return false;
557 }
558 }
559
560 // Node management
561 uint unique() const { return _unique; }
562 uint next_unique() { return _unique++; }
563 void set_unique(uint i) { _unique = i; }
564 static int debug_idx() { return debug_only(_debug_idx)+0; }
565 static void set_debug_idx(int i) { debug_only(_debug_idx = i); }
566 Arena* node_arena() { return &_node_arena; }
567 Arena* old_arena() { return &_old_arena; }
568 RootNode* root() const { return _root; }
569 void set_root(RootNode* r) { _root = r; }
570 StartNode* start() const; // (Derived from root.)
571 void init_start(StartNode* s);
572 Node* immutable_memory();
573
574 Node* recent_alloc_ctl() const { return _recent_alloc_ctl; }
575 Node* recent_alloc_obj() const { return _recent_alloc_obj; }
576 void set_recent_alloc(Node* ctl, Node* obj) {
577 _recent_alloc_ctl = ctl;
578 _recent_alloc_obj = obj;
579 }
580
581 // Constant table
582 ConstantTable& constant_table() { return _constant_table; }
583
584 MachConstantBaseNode* mach_constant_base_node();
585 bool has_mach_constant_base_node() const { return _mach_constant_base_node != NULL; }
586
587 // Handy undefined Node
588 Node* top() const { return _top; }
589
590 // these are used by guys who need to know about creation and transformation of top:
591 Node* cached_top_node() { return _top; }
592 void set_cached_top_node(Node* tn);
593
594 GrowableArray<Node_Notes*>* node_note_array() const { return _node_note_array; }
595 void set_node_note_array(GrowableArray<Node_Notes*>* arr) { _node_note_array = arr; }
596 Node_Notes* default_node_notes() const { return _default_node_notes; }
597 void set_default_node_notes(Node_Notes* n) { _default_node_notes = n; }
598
599 Node_Notes* node_notes_at(int idx) {
600 return locate_node_notes(_node_note_array, idx, false);
601 }
602 inline bool set_node_notes_at(int idx, Node_Notes* value);
603
604 // Copy notes from source to dest, if they exist.
605 // Overwrite dest only if source provides something.
606 // Return true if information was moved.
607 bool copy_node_notes_to(Node* dest, Node* source);
608
609 // Workhorse function to sort out the blocked Node_Notes array:
610 inline Node_Notes* locate_node_notes(GrowableArray<Node_Notes*>* arr,
611 int idx, bool can_grow = false);
612
613 void grow_node_notes(GrowableArray<Node_Notes*>* arr, int grow_by);
614
615 // Type management
616 Arena* type_arena() { return _type_arena; }
617 Dict* type_dict() { return _type_dict; }
618 void* type_hwm() { return _type_hwm; }
619 size_t type_last_size() { return _type_last_size; }
620 int num_alias_types() { return _num_alias_types; }
621
622 void init_type_arena() { _type_arena = &_Compile_types; }
623 void set_type_arena(Arena* a) { _type_arena = a; }
624 void set_type_dict(Dict* d) { _type_dict = d; }
625 void set_type_hwm(void* p) { _type_hwm = p; }
626 void set_type_last_size(size_t sz) { _type_last_size = sz; }
627
628 const TypeFunc* last_tf(ciMethod* m) {
629 return (m == _last_tf_m) ? _last_tf : NULL;
630 }
631 void set_last_tf(ciMethod* m, const TypeFunc* tf) {
632 assert(m != NULL || tf == NULL, "");
633 _last_tf_m = m;
634 _last_tf = tf;
635 }
636
637 AliasType* alias_type(int idx) { assert(idx < num_alias_types(), "oob"); return _alias_types[idx]; }
638 AliasType* alias_type(const TypePtr* adr_type, ciField* field = NULL) { return find_alias_type(adr_type, false, field); }
639 bool have_alias_type(const TypePtr* adr_type);
640 AliasType* alias_type(ciField* field);
641
642 int get_alias_index(const TypePtr* at) { return alias_type(at)->index(); }
643 const TypePtr* get_adr_type(uint aidx) { return alias_type(aidx)->adr_type(); }
644 int get_general_index(uint aidx) { return alias_type(aidx)->general_index(); }
645
646 // Building nodes
647 void rethrow_exceptions(JVMState* jvms);
648 void return_values(JVMState* jvms);
649 JVMState* build_start_state(StartNode* start, const TypeFunc* tf);
650
651 // Decide how to build a call.
652 // The profile factor is a discount to apply to this site's interp. profile.
653 CallGenerator* call_generator(ciMethod* call_method, int vtable_index, bool call_is_virtual, JVMState* jvms, bool allow_inline, float profile_factor, bool allow_intrinsics = true);
654 bool should_delay_inlining(ciMethod* call_method, JVMState* jvms);
655
656 // Report if there were too many traps at a current method and bci.
657 // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
658 // If there is no MDO at all, report no trap unless told to assume it.
659 bool too_many_traps(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
660 // This version, unspecific to a particular bci, asks if
661 // PerMethodTrapLimit was exceeded for all inlined methods seen so far.
662 bool too_many_traps(Deoptimization::DeoptReason reason,
663 // Privately used parameter for logging:
664 ciMethodData* logmd = NULL);
665 // Report if there were too many recompiles at a method and bci.
666 bool too_many_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
667
668 // Parsing, optimization
669 PhaseGVN* initial_gvn() { return _initial_gvn; }
670 Unique_Node_List* for_igvn() { return _for_igvn; }
671 inline void record_for_igvn(Node* n); // Body is after class Unique_Node_List.
672 void set_initial_gvn(PhaseGVN *gvn) { _initial_gvn = gvn; }
673 void set_for_igvn(Unique_Node_List *for_igvn) { _for_igvn = for_igvn; }
674
675 // Replace n by nn using initial_gvn, calling hash_delete and
676 // record_for_igvn as needed.
677 void gvn_replace_by(Node* n, Node* nn);
678
679
680 void identify_useful_nodes(Unique_Node_List &useful);
681 void remove_useless_nodes (Unique_Node_List &useful);
682
683 WarmCallInfo* warm_calls() const { return _warm_calls; }
684 void set_warm_calls(WarmCallInfo* l) { _warm_calls = l; }
685 WarmCallInfo* pop_warm_call();
686
687 // Record this CallGenerator for inlining at the end of parsing.
688 void add_late_inline(CallGenerator* cg) { _late_inlines.push(cg); }
689
690 // Matching, CFG layout, allocation, code generation
691 PhaseCFG* cfg() { return _cfg; }
692 bool select_24_bit_instr() const { return _select_24_bit_instr; }
693 bool in_24_bit_fp_mode() const { return _in_24_bit_fp_mode; }
694 bool has_java_calls() const { return _java_calls > 0; }
695 int java_calls() const { return _java_calls; }
696 int inner_loops() const { return _inner_loops; }
697 Matcher* matcher() { return _matcher; }
698 PhaseRegAlloc* regalloc() { return _regalloc; }
699 int frame_slots() const { return _frame_slots; }
700 int frame_size_in_words() const; // frame_slots in units of the polymorphic 'words'
701 RegMask& FIRST_STACK_mask() { return _FIRST_STACK_mask; }
702 Arena* indexSet_arena() { return _indexSet_arena; }
703 void* indexSet_free_block_list() { return _indexSet_free_block_list; }
704 uint node_bundling_limit() { return _node_bundling_limit; }
705 Bundle* node_bundling_base() { return _node_bundling_base; }
706 void set_node_bundling_limit(uint n) { _node_bundling_limit = n; }
707 void set_node_bundling_base(Bundle* b) { _node_bundling_base = b; }
708 bool starts_bundle(const Node *n) const;
709 bool need_stack_bang(int frame_size_in_bytes) const;
710 bool need_register_stack_bang() const;
711
712 void set_matcher(Matcher* m) { _matcher = m; }
713 //void set_regalloc(PhaseRegAlloc* ra) { _regalloc = ra; }
714 void set_indexSet_arena(Arena* a) { _indexSet_arena = a; }
715 void set_indexSet_free_block_list(void* p) { _indexSet_free_block_list = p; }
716
717 // Remember if this compilation changes hardware mode to 24-bit precision
718 void set_24_bit_selection_and_mode(bool selection, bool mode) {
719 _select_24_bit_instr = selection;
720 _in_24_bit_fp_mode = mode;
721 }
722
723 void set_java_calls(int z) { _java_calls = z; }
724 void set_inner_loops(int z) { _inner_loops = z; }
725
726 // Instruction bits passed off to the VM
727 int code_size() { return _method_size; }
728 CodeBuffer* code_buffer() { return &_code_buffer; }
729 int first_block_size() { return _first_block_size; }
730 void set_frame_complete(int off) { _code_offsets.set_value(CodeOffsets::Frame_Complete, off); }
731 ExceptionHandlerTable* handler_table() { return &_handler_table; }
732 ImplicitExceptionTable* inc_table() { return &_inc_table; }
733 OopMapSet* oop_map_set() { return _oop_map_set; }
734 DebugInformationRecorder* debug_info() { return env()->debug_info(); }
735 Dependencies* dependencies() { return env()->dependencies(); }
736 static int CompiledZap_count() { return _CompiledZap_count; }
737 BufferBlob* scratch_buffer_blob() { return _scratch_buffer_blob; }
738 void init_scratch_buffer_blob(int const_size);
739 void clear_scratch_buffer_blob();
740 void set_scratch_buffer_blob(BufferBlob* b) { _scratch_buffer_blob = b; }
741 relocInfo* scratch_locs_memory() { return _scratch_locs_memory; }
742 void set_scratch_locs_memory(relocInfo* b) { _scratch_locs_memory = b; }
743
744 // emit to scratch blob, report resulting size
745 uint scratch_emit_size(const Node* n);
746 void set_in_scratch_emit_size(bool x) { _in_scratch_emit_size = x; }
747 bool in_scratch_emit_size() const { return _in_scratch_emit_size; }
748
749 enum ScratchBufferBlob {
750 MAX_inst_size = 1024,
751 MAX_locs_size = 128, // number of relocInfo elements
752 MAX_const_size = 128,
753 MAX_stubs_size = 128
754 };
755
756 // Major entry point. Given a Scope, compile the associated method.
757 // For normal compilations, entry_bci is InvocationEntryBci. For on stack
758 // replacement, entry_bci indicates the bytecode for which to compile a
759 // continuation.
760 Compile(ciEnv* ci_env, C2Compiler* compiler, ciMethod* target,
761 int entry_bci, bool subsume_loads, bool do_escape_analysis);
762
763 // Second major entry point. From the TypeFunc signature, generate code
764 // to pass arguments from the Java calling convention to the C calling
765 // convention.
766 Compile(ciEnv* ci_env, const TypeFunc *(*gen)(),
767 address stub_function, const char *stub_name,
768 int is_fancy_jump, bool pass_tls,
769 bool save_arg_registers, bool return_pc);
770
771 // From the TypeFunc signature, generate code to pass arguments
772 // from Compiled calling convention to Interpreter's calling convention
773 void Generate_Compiled_To_Interpreter_Graph(const TypeFunc *tf, address interpreter_entry);
774
775 // From the TypeFunc signature, generate code to pass arguments
776 // from Interpreter's calling convention to Compiler's calling convention
777 void Generate_Interpreter_To_Compiled_Graph(const TypeFunc *tf);
778
779 // Are we compiling a method?
780 bool has_method() { return method() != NULL; }
781
782 // Maybe print some information about this compile.
783 void print_compile_messages();
784
785 // Final graph reshaping, a post-pass after the regular optimizer is done.
786 bool final_graph_reshaping();
787
788 // returns true if adr is completely contained in the given alias category
789 bool must_alias(const TypePtr* adr, int alias_idx);
790
791 // returns true if adr overlaps with the given alias category
792 bool can_alias(const TypePtr* adr, int alias_idx);
793
794 // Driver for converting compiler's IR into machine code bits
795 void Output();
796
797 // Accessors for node bundling info.
798 Bundle* node_bundling(const Node *n);
799 bool valid_bundle_info(const Node *n);
800
801 // Schedule and Bundle the instructions
802 void ScheduleAndBundle();
803
804 // Build OopMaps for each GC point
805 void BuildOopMaps();
806
807 // Append debug info for the node "local" at safepoint node "sfpt" to the
808 // "array", May also consult and add to "objs", which describes the
809 // scalar-replaced objects.
810 void FillLocArray( int idx, MachSafePointNode* sfpt,
811 Node *local, GrowableArray<ScopeValue*> *array,
812 GrowableArray<ScopeValue*> *objs );
813
814 // If "objs" contains an ObjectValue whose id is "id", returns it, else NULL.
815 static ObjectValue* sv_for_node_id(GrowableArray<ScopeValue*> *objs, int id);
816 // Requres that "objs" does not contains an ObjectValue whose id matches
817 // that of "sv. Appends "sv".
818 static void set_sv_for_object_node(GrowableArray<ScopeValue*> *objs,
819 ObjectValue* sv );
820
821 // Process an OopMap Element while emitting nodes
822 void Process_OopMap_Node(MachNode *mach, int code_offset);
823
824 // Initialize code buffer
825 CodeBuffer* init_buffer(uint* blk_starts);
826
827 // Write out basic block data to code buffer
828 void fill_buffer(CodeBuffer* cb, uint* blk_starts);
829
830 // Determine which variable sized branches can be shortened
831 void shorten_branches(uint* blk_starts, int& code_size, int& reloc_size, int& stub_size);
832
833 // Compute the size of first NumberOfLoopInstrToAlign instructions
834 // at the head of a loop.
835 void compute_loop_first_inst_sizes();
836
837 // Compute the information for the exception tables
838 void FillExceptionTables(uint cnt, uint *call_returns, uint *inct_starts, Label *blk_labels);
839
840 // Stack slots that may be unused by the calling convention but must
841 // otherwise be preserved. On Intel this includes the return address.
842 // On PowerPC it includes the 4 words holding the old TOC & LR glue.
843 uint in_preserve_stack_slots();
844
845 // "Top of Stack" slots that may be unused by the calling convention but must
846 // otherwise be preserved.
847 // On Intel these are not necessary and the value can be zero.
848 // On Sparc this describes the words reserved for storing a register window
849 // when an interrupt occurs.
850 static uint out_preserve_stack_slots();
851
852 // Number of outgoing stack slots killed above the out_preserve_stack_slots
853 // for calls to C. Supports the var-args backing area for register parms.
854 uint varargs_C_out_slots_killed() const;
855
856 // Number of Stack Slots consumed by a synchronization entry
857 int sync_stack_slots() const;
858
859 // Compute the name of old_SP. See <arch>.ad for frame layout.
860 OptoReg::Name compute_old_SP();
861
862 #ifdef ENABLE_ZAP_DEAD_LOCALS
863 static bool is_node_getting_a_safepoint(Node*);
864 void Insert_zap_nodes();
865 Node* call_zap_node(MachSafePointNode* n, int block_no);
866 #endif
867
868 private:
869 // Phase control:
870 void Init(int aliaslevel); // Prepare for a single compilation
871 int Inline_Warm(); // Find more inlining work.
872 void Finish_Warm(); // Give up on further inlines.
873 void Optimize(); // Given a graph, optimize it
874 void Code_Gen(); // Generate code from a graph
875
876 // Management of the AliasType table.
877 void grow_alias_types();
878 AliasCacheEntry* probe_alias_cache(const TypePtr* adr_type);
879 const TypePtr *flatten_alias_type(const TypePtr* adr_type) const;
880 AliasType* find_alias_type(const TypePtr* adr_type, bool no_create, ciField* field);
881
882 void verify_top(Node*) const PRODUCT_RETURN;
883
884 // Intrinsic setup.
885 void register_library_intrinsics(); // initializer
886 CallGenerator* make_vm_intrinsic(ciMethod* m, bool is_virtual); // constructor
887 int intrinsic_insertion_index(ciMethod* m, bool is_virtual); // helper
888 CallGenerator* find_intrinsic(ciMethod* m, bool is_virtual); // query fn
889 void register_intrinsic(CallGenerator* cg); // update fn
890
891 #ifndef PRODUCT
892 static juint _intrinsic_hist_count[vmIntrinsics::ID_LIMIT];
893 static jubyte _intrinsic_hist_flags[vmIntrinsics::ID_LIMIT];
894 #endif
895
896 public:
897
898 // Note: Histogram array size is about 1 Kb.
899 enum { // flag bits:
900 _intrinsic_worked = 1, // succeeded at least once
901 _intrinsic_failed = 2, // tried it but it failed
902 _intrinsic_disabled = 4, // was requested but disabled (e.g., -XX:-InlineUnsafeOps)
903 _intrinsic_virtual = 8, // was seen in the virtual form (rare)
904 _intrinsic_both = 16 // was seen in the non-virtual form (usual)
905 };
906 // Update histogram. Return boolean if this is a first-time occurrence.
907 static bool gather_intrinsic_statistics(vmIntrinsics::ID id,
908 bool is_virtual, int flags) PRODUCT_RETURN0;
909 static void print_intrinsic_statistics() PRODUCT_RETURN;
910
911 // Graph verification code
912 // Walk the node list, verifying that there is a one-to-one
913 // correspondence between Use-Def edges and Def-Use edges
914 // The option no_dead_code enables stronger checks that the
915 // graph is strongly connected from root in both directions.
916 void verify_graph_edges(bool no_dead_code = false) PRODUCT_RETURN;
917
918 // End-of-run dumps.
919 static void print_statistics() PRODUCT_RETURN;
920
921 // Dump formatted assembly
922 void dump_asm(int *pcs = NULL, uint pc_limit = 0) PRODUCT_RETURN;
923 void dump_pc(int *pcs, int pc_limit, Node *n);
924
925 // Verify ADLC assumptions during startup
926 static void adlc_verification() PRODUCT_RETURN;
927
928 // Definitions of pd methods
929 static void pd_compiler2_init();
930 };
931
932 #endif // SHARE_VM_OPTO_COMPILE_HPP