1 /*
2 * Copyright (c) 1997, 2025, 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_OPTO_COMPILE_HPP
26 #define SHARE_OPTO_COMPILE_HPP
27
28 #include "asm/codeBuffer.hpp"
29 #include "ci/compilerInterface.hpp"
30 #include "code/debugInfoRec.hpp"
31 #include "compiler/compiler_globals.hpp"
32 #include "compiler/compileBroker.hpp"
33 #include "compiler/compilerEvent.hpp"
34 #include "compiler/cHeapStringHolder.hpp"
35 #include "libadt/dict.hpp"
36 #include "libadt/vectset.hpp"
37 #include "memory/resourceArea.hpp"
38 #include "oops/methodData.hpp"
39 #include "opto/idealGraphPrinter.hpp"
40 #include "opto/phasetype.hpp"
41 #include "opto/phase.hpp"
42 #include "opto/regmask.hpp"
43 #include "runtime/deoptimization.hpp"
44 #include "runtime/sharedRuntime.hpp"
45 #include "runtime/timerTrace.hpp"
46 #include "runtime/vmThread.hpp"
47 #include "utilities/ticks.hpp"
48 #include "utilities/vmEnums.hpp"
49 #include "opto/printinlining.hpp"
50
51 class AbstractLockNode;
52 class AddPNode;
53 class Block;
54 class Bundle;
55 class CallGenerator;
56 class CallStaticJavaNode;
57 class CloneMap;
58 class CompilationFailureInfo;
59 class ConnectionGraph;
60 class IdealGraphPrinter;
61 class InlineTree;
62 class Matcher;
63 class MachConstantNode;
64 class MachConstantBaseNode;
65 class MachNode;
66 class MachOper;
67 class MachSafePointNode;
68 class Node;
69 class Node_Array;
70 class Node_List;
71 class Node_Notes;
72 class NodeHash;
73 class NodeCloneInfo;
74 class OpaqueTemplateAssertionPredicateNode;
75 class OptoReg;
76 class ParsePredicateNode;
77 class PhaseCFG;
78 class PhaseGVN;
79 class PhaseIterGVN;
80 class PhaseRegAlloc;
81 class PhaseCCP;
82 class PhaseOutput;
83 class RootNode;
84 class relocInfo;
85 class StartNode;
86 class SafePointNode;
87 class JVMState;
88 class Type;
89 class TypeInt;
90 class TypeInteger;
91 class TypeKlassPtr;
92 class TypePtr;
93 class TypeOopPtr;
94 class TypeFunc;
95 class TypeVect;
96 class Type_Array;
97 class Unique_Node_List;
98 class UnstableIfTrap;
99 class nmethod;
100 class Node_Stack;
101 struct Final_Reshape_Counts;
102 class VerifyMeetResult;
103
104 enum LoopOptsMode {
105 LoopOptsDefault,
106 LoopOptsNone,
107 LoopOptsMaxUnroll,
108 LoopOptsShenandoahExpand,
109 LoopOptsSkipSplitIf,
110 LoopOptsVerify
111 };
112
113 // The type of all node counts and indexes.
114 // It must hold at least 16 bits, but must also be fast to load and store.
115 // This type, if less than 32 bits, could limit the number of possible nodes.
116 // (To make this type platform-specific, move to globalDefinitions_xxx.hpp.)
117 typedef unsigned int node_idx_t;
118
119 class NodeCloneInfo {
120 private:
121 uint64_t _idx_clone_orig;
122 public:
123
124 void set_idx(node_idx_t idx) {
125 _idx_clone_orig = (_idx_clone_orig & CONST64(0xFFFFFFFF00000000)) | idx;
126 }
127 node_idx_t idx() const { return (node_idx_t)(_idx_clone_orig & 0xFFFFFFFF); }
128
129 void set_gen(int generation) {
130 uint64_t g = (uint64_t)generation << 32;
131 _idx_clone_orig = (_idx_clone_orig & 0xFFFFFFFF) | g;
132 }
133 int gen() const { return (int)(_idx_clone_orig >> 32); }
134
135 void set(uint64_t x) { _idx_clone_orig = x; }
136 void set(node_idx_t x, int g) { set_idx(x); set_gen(g); }
137 uint64_t get() const { return _idx_clone_orig; }
138
139 NodeCloneInfo(uint64_t idx_clone_orig) : _idx_clone_orig(idx_clone_orig) {}
140 NodeCloneInfo(node_idx_t x, int g) : _idx_clone_orig(0) { set(x, g); }
141
142 void dump_on(outputStream* st) const;
143 };
144
145 class CloneMap {
146 friend class Compile;
147 private:
148 bool _debug;
149 Dict* _dict;
150 int _clone_idx; // current cloning iteration/generation in loop unroll
151 public:
152 void* _2p(node_idx_t key) const { return (void*)(intptr_t)key; } // 2 conversion functions to make gcc happy
153 node_idx_t _2_node_idx_t(const void* k) const { return (node_idx_t)(intptr_t)k; }
154 Dict* dict() const { return _dict; }
155 void insert(node_idx_t key, uint64_t val) { assert(_dict->operator[](_2p(key)) == nullptr, "key existed"); _dict->Insert(_2p(key), (void*)val); }
156 void insert(node_idx_t key, NodeCloneInfo& ci) { insert(key, ci.get()); }
157 void remove(node_idx_t key) { _dict->Delete(_2p(key)); }
158 uint64_t value(node_idx_t key) const { return (uint64_t)_dict->operator[](_2p(key)); }
159 node_idx_t idx(node_idx_t key) const { return NodeCloneInfo(value(key)).idx(); }
160 int gen(node_idx_t key) const { return NodeCloneInfo(value(key)).gen(); }
161 int gen(const void* k) const { return gen(_2_node_idx_t(k)); }
162 int max_gen() const;
163 void clone(Node* old, Node* nnn, int gen);
164 void verify_insert_and_clone(Node* old, Node* nnn, int gen);
165 void dump(node_idx_t key, outputStream* st) const;
166
167 int clone_idx() const { return _clone_idx; }
168 void set_clone_idx(int x) { _clone_idx = x; }
169 bool is_debug() const { return _debug; }
170 void set_debug(bool debug) { _debug = debug; }
171
172 bool same_idx(node_idx_t k1, node_idx_t k2) const { return idx(k1) == idx(k2); }
173 bool same_gen(node_idx_t k1, node_idx_t k2) const { return gen(k1) == gen(k2); }
174 };
175
176 class Options {
177 friend class Compile;
178 private:
179 const bool _subsume_loads; // Load can be matched as part of a larger op.
180 const bool _do_escape_analysis; // Do escape analysis.
181 const bool _do_iterative_escape_analysis; // Do iterative escape analysis.
182 const bool _do_reduce_allocation_merges; // Do try to reduce allocation merges.
183 const bool _eliminate_boxing; // Do boxing elimination.
184 const bool _do_locks_coarsening; // Do locks coarsening
185 const bool _do_superword; // Do SuperWord
186 const bool _install_code; // Install the code that was compiled
187 public:
188 Options(bool subsume_loads,
189 bool do_escape_analysis,
190 bool do_iterative_escape_analysis,
191 bool do_reduce_allocation_merges,
192 bool eliminate_boxing,
193 bool do_locks_coarsening,
194 bool do_superword,
195 bool install_code) :
196 _subsume_loads(subsume_loads),
197 _do_escape_analysis(do_escape_analysis),
198 _do_iterative_escape_analysis(do_iterative_escape_analysis),
199 _do_reduce_allocation_merges(do_reduce_allocation_merges),
200 _eliminate_boxing(eliminate_boxing),
201 _do_locks_coarsening(do_locks_coarsening),
202 _do_superword(do_superword),
203 _install_code(install_code) {
204 }
205
206 static Options for_runtime_stub() {
207 return Options(
208 /* subsume_loads = */ true,
209 /* do_escape_analysis = */ false,
210 /* do_iterative_escape_analysis = */ false,
211 /* do_reduce_allocation_merges = */ false,
212 /* eliminate_boxing = */ false,
213 /* do_lock_coarsening = */ false,
214 /* do_superword = */ true,
215 /* install_code = */ true
216 );
217 }
218 };
219
220 //------------------------------Compile----------------------------------------
221 // This class defines a top-level Compiler invocation.
222
223 class Compile : public Phase {
224
225 public:
226 // Fixed alias indexes. (See also MergeMemNode.)
227 enum {
228 AliasIdxTop = 1, // pseudo-index, aliases to nothing (used as sentinel value)
229 AliasIdxBot = 2, // pseudo-index, aliases to everything
230 AliasIdxRaw = 3 // hard-wired index for TypeRawPtr::BOTTOM
231 };
232
233 // Variant of TraceTime(nullptr, &_t_accumulator, CITime);
234 // Integrated with logging. If logging is turned on, and CITimeVerbose is true,
235 // then brackets are put into the log, with time stamps and node counts.
236 // (The time collection itself is always conditionalized on CITime.)
237 class TracePhase : public TraceTime {
238 private:
239 Compile* const _compile;
240 CompileLog* _log;
241 const bool _dolog;
242 public:
243 TracePhase(PhaseTraceId phaseTraceId);
244 TracePhase(const char* name, PhaseTraceId phaseTraceId);
245 ~TracePhase();
246 const char* phase_name() const { return title(); }
247 };
248
249 // Information per category of alias (memory slice)
250 class AliasType {
251 private:
252 friend class Compile;
253
254 int _index; // unique index, used with MergeMemNode
255 const TypePtr* _adr_type; // normalized address type
256 ciField* _field; // relevant instance field, or null if none
257 const Type* _element; // relevant array element type, or null if none
258 bool _is_rewritable; // false if the memory is write-once only
259 int _general_index; // if this is type is an instance, the general
260 // type that this is an instance of
261
262 void Init(int i, const TypePtr* at);
263
264 public:
265 int index() const { return _index; }
266 const TypePtr* adr_type() const { return _adr_type; }
267 ciField* field() const { return _field; }
268 const Type* element() const { return _element; }
269 bool is_rewritable() const { return _is_rewritable; }
270 bool is_volatile() const { return (_field ? _field->is_volatile() : false); }
271 int general_index() const { return (_general_index != 0) ? _general_index : _index; }
272
273 void set_rewritable(bool z) { _is_rewritable = z; }
274 void set_field(ciField* f) {
275 assert(!_field,"");
276 _field = f;
277 if (f->is_final() || f->is_stable()) {
278 // In the case of @Stable, multiple writes are possible but may be assumed to be no-ops.
279 _is_rewritable = false;
280 }
281 }
282 void set_element(const Type* e) {
283 assert(_element == nullptr, "");
284 _element = e;
285 }
286
287 BasicType basic_type() const;
288
289 void print_on(outputStream* st) PRODUCT_RETURN;
290 };
291
292 enum {
293 logAliasCacheSize = 6,
294 AliasCacheSize = (1<<logAliasCacheSize)
295 };
296 struct AliasCacheEntry { const TypePtr* _adr_type; int _index; }; // simple duple type
297 enum {
298 trapHistLength = MethodData::_trap_hist_limit
299 };
300
301 private:
302 // Fixed parameters to this compilation.
303 const int _compile_id;
304 const Options _options; // Compilation options
305 ciMethod* _method; // The method being compiled.
306 int _entry_bci; // entry bci for osr methods.
307 const TypeFunc* _tf; // My kind of signature
308 InlineTree* _ilt; // Ditto (temporary).
309 address _stub_function; // VM entry for stub being compiled, or null
310 const char* _stub_name; // Name of stub or adapter being compiled, or null
311 address _stub_entry_point; // Compile code entry for generated stub, or null
312
313 // Control of this compilation.
314 int _max_inline_size; // Max inline size for this compilation
315 int _freq_inline_size; // Max hot method inline size for this compilation
316 int _fixed_slots; // count of frame slots not allocated by the register
317 // allocator i.e. locks, original deopt pc, etc.
318 uintx _max_node_limit; // Max unique node count during a single compilation.
319
320 bool _post_loop_opts_phase; // Loop opts are finished.
321 bool _merge_stores_phase; // Phase for merging stores, after post loop opts phase.
322 bool _allow_macro_nodes; // True if we allow creation of macro nodes.
323
324 int _major_progress; // Count of something big happening
325 bool _inlining_progress; // progress doing incremental inlining?
326 bool _inlining_incrementally;// Are we doing incremental inlining (post parse)
327 bool _do_cleanup; // Cleanup is needed before proceeding with incremental inlining
328 bool _has_loops; // True if the method _may_ have some loops
329 bool _has_split_ifs; // True if the method _may_ have some split-if
330 bool _has_unsafe_access; // True if the method _may_ produce faults in unsafe loads or stores.
331 bool _has_stringbuilder; // True StringBuffers or StringBuilders are allocated
332 bool _has_boxed_value; // True if a boxed object is allocated
333 bool _has_reserved_stack_access; // True if the method or an inlined method is annotated with ReservedStackAccess
334 uint _max_vector_size; // Maximum size of generated vectors
335 bool _clear_upper_avx; // Clear upper bits of ymm registers using vzeroupper
336 uint _trap_hist[trapHistLength]; // Cumulative traps
337 bool _trap_can_recompile; // Have we emitted a recompiling trap?
338 uint _decompile_count; // Cumulative decompilation counts.
339 bool _do_inlining; // True if we intend to do inlining
340 bool _do_scheduling; // True if we intend to do scheduling
341 bool _do_freq_based_layout; // True if we intend to do frequency based block layout
342 bool _do_vector_loop; // True if allowed to execute loop in parallel iterations
343 bool _use_cmove; // True if CMove should be used without profitability analysis
344 bool _do_aliasing; // True if we intend to do aliasing
345 bool _print_assembly; // True if we should dump assembly code for this compilation
346 bool _print_inlining; // True if we should print inlining for this compilation
347 bool _print_intrinsics; // True if we should print intrinsics for this compilation
348 #ifndef PRODUCT
349 uint _igv_idx; // Counter for IGV node identifiers
350 uint _igv_phase_iter[PHASE_NUM_TYPES]; // Counters for IGV phase iterations
351 bool _trace_opto_output;
352 bool _parsed_irreducible_loop; // True if ciTypeFlow detected irreducible loops during parsing
353 #endif
354 bool _has_irreducible_loop; // Found irreducible loops
355 // JSR 292
356 bool _has_method_handle_invokes; // True if this method has MethodHandle invokes.
357 bool _has_monitors; // Metadata transfered to nmethod to enable Continuations lock-detection fastpath
358 bool _has_scoped_access; // For shared scope closure
359 bool _clinit_barrier_on_entry; // True if clinit barrier is needed on nmethod entry
360 int _loop_opts_cnt; // loop opts round
361 uint _stress_seed; // Seed for stress testing
362
363 // Compilation environment.
364 Arena _comp_arena; // Arena with lifetime equivalent to Compile
365 void* _barrier_set_state; // Potential GC barrier state for Compile
366 ciEnv* _env; // CI interface
367 DirectiveSet* _directive; // Compiler directive
368 CompileLog* _log; // from CompilerThread
369 CHeapStringHolder _failure_reason; // for record_failure/failing pattern
370 CompilationFailureInfo* _first_failure_details; // Details for the first failure happening during compilation
371 GrowableArray<CallGenerator*> _intrinsics; // List of intrinsics.
372 GrowableArray<Node*> _macro_nodes; // List of nodes which need to be expanded before matching.
373 GrowableArray<ParsePredicateNode*> _parse_predicates; // List of Parse Predicates.
374 // List of OpaqueTemplateAssertionPredicateNode nodes for Template Assertion Predicates which can be seen as list
375 // of Template Assertion Predicates themselves.
376 GrowableArray<OpaqueTemplateAssertionPredicateNode*> _template_assertion_predicate_opaques;
377 GrowableArray<Node*> _expensive_nodes; // List of nodes that are expensive to compute and that we'd better not let the GVN freely common
378 GrowableArray<Node*> _for_post_loop_igvn; // List of nodes for IGVN after loop opts are over
379 GrowableArray<Node*> _for_merge_stores_igvn; // List of nodes for IGVN merge stores
380 GrowableArray<UnstableIfTrap*> _unstable_if_traps; // List of ifnodes after IGVN
381 GrowableArray<Node_List*> _coarsened_locks; // List of coarsened Lock and Unlock nodes
382 ConnectionGraph* _congraph;
383 #ifndef PRODUCT
384 IdealGraphPrinter* _igv_printer;
385 static IdealGraphPrinter* _debug_file_printer;
386 static IdealGraphPrinter* _debug_network_printer;
387 #endif
388
389
390 // Node management
391 uint _unique; // Counter for unique Node indices
392 uint _dead_node_count; // Number of dead nodes; VectorSet::Size() is O(N).
393 // So use this to keep count and make the call O(1).
394 VectorSet _dead_node_list; // Set of dead nodes
395 DEBUG_ONLY(Unique_Node_List* _modified_nodes;) // List of nodes which inputs were modified
396 DEBUG_ONLY(bool _phase_optimize_finished;) // Used for live node verification while creating new nodes
397
398 DEBUG_ONLY(bool _phase_verify_ideal_loop;) // Are we in PhaseIdealLoop verification?
399
400 // Arenas for new-space and old-space nodes.
401 // Swapped between using _node_arena.
402 // The lifetime of the old-space nodes is during xform.
403 Arena _node_arena_one;
404 Arena _node_arena_two;
405 Arena* _node_arena;
406 public:
407 Arena* swap_old_and_new() {
408 Arena* filled_arena_ptr = _node_arena;
409 Arena* old_arena_ptr = old_arena();
410 old_arena_ptr->destruct_contents();
411 _node_arena = old_arena_ptr;
412 return filled_arena_ptr;
413 }
414 private:
415 RootNode* _root; // Unique root of compilation, or null after bail-out.
416 Node* _top; // Unique top node. (Reset by various phases.)
417
418 Node* _immutable_memory; // Initial memory state
419
420 Node* _recent_alloc_obj;
421 Node* _recent_alloc_ctl;
422
423 // Constant table
424 MachConstantBaseNode* _mach_constant_base_node; // Constant table base node singleton.
425
426
427 // Blocked array of debugging and profiling information,
428 // tracked per node.
429 enum { _log2_node_notes_block_size = 8,
430 _node_notes_block_size = (1<<_log2_node_notes_block_size)
431 };
432 GrowableArray<Node_Notes*>* _node_note_array;
433 Node_Notes* _default_node_notes; // default notes for new nodes
434
435 // After parsing and every bulk phase we hang onto the Root instruction.
436 // The RootNode instruction is where the whole program begins. It produces
437 // the initial Control and BOTTOM for everybody else.
438
439 // Type management
440 Arena _Compile_types; // Arena for all types
441 Arena* _type_arena; // Alias for _Compile_types except in Initialize_shared()
442 Dict* _type_dict; // Intern table
443 CloneMap _clone_map; // used for recording history of cloned nodes
444 size_t _type_last_size; // Last allocation size (see Type::operator new/delete)
445 ciMethod* _last_tf_m; // Cache for
446 const TypeFunc* _last_tf; // TypeFunc::make
447 AliasType** _alias_types; // List of alias types seen so far.
448 int _num_alias_types; // Logical length of _alias_types
449 int _max_alias_types; // Physical length of _alias_types
450 AliasCacheEntry _alias_cache[AliasCacheSize]; // Gets aliases w/o data structure walking
451
452 // Parsing, optimization
453 PhaseGVN* _initial_gvn; // Results of parse-time PhaseGVN
454
455 // Shared worklist for all IGVN rounds. Nodes can be pushed to it at any time.
456 // If pushed outside IGVN, the Node is processed in the next IGVN round.
457 Unique_Node_List* _igvn_worklist;
458
459 // Shared type array for GVN, IGVN and CCP. It maps node idx -> Type*.
460 Type_Array* _types;
461
462 // Shared node hash table for GVN, IGVN and CCP.
463 NodeHash* _node_hash;
464
465 GrowableArray<CallGenerator*> _late_inlines; // List of CallGenerators to be revisited after main parsing has finished.
466 GrowableArray<CallGenerator*> _string_late_inlines; // same but for string operations
467 GrowableArray<CallGenerator*> _boxing_late_inlines; // same but for boxing operations
468
469 GrowableArray<CallGenerator*> _vector_reboxing_late_inlines; // same but for vector reboxing operations
470
471 int _late_inlines_pos; // Where in the queue should the next late inlining candidate go (emulate depth first inlining)
472 uint _number_of_mh_late_inlines; // number of method handle late inlining still pending
473
474 // "MemLimit" directive was specified and the memory limit was hit during compilation
475 bool _oom;
476
477 // Only keep nodes in the expensive node list that need to be optimized
478 void cleanup_expensive_nodes(PhaseIterGVN &igvn);
479 // Use for sorting expensive nodes to bring similar nodes together
480 static int cmp_expensive_nodes(Node** n1, Node** n2);
481 // Expensive nodes list already sorted?
482 bool expensive_nodes_sorted() const;
483 // Remove the speculative part of types and clean up the graph
484 void remove_speculative_types(PhaseIterGVN &igvn);
485
486 void* _replay_inline_data; // Pointer to data loaded from file
487
488 void log_late_inline_failure(CallGenerator* cg, const char* msg);
489 DEBUG_ONLY(bool _exception_backedge;)
490
491 void record_method_not_compilable_oom();
492
493 InlinePrinter _inline_printer;
494
495 public:
496 void* barrier_set_state() const { return _barrier_set_state; }
497
498 InlinePrinter* inline_printer() { return &_inline_printer; }
499
500 #ifndef PRODUCT
501 IdealGraphPrinter* igv_printer() { return _igv_printer; }
502 void reset_igv_phase_iter(CompilerPhaseType cpt) { _igv_phase_iter[cpt] = 0; }
503 #endif
504
505 void log_late_inline(CallGenerator* cg);
506 void log_inline_id(CallGenerator* cg);
507 void log_inline_failure(const char* msg);
508
509 void* replay_inline_data() const { return _replay_inline_data; }
510
511 // Dump inlining replay data to the stream.
512 void dump_inline_data(outputStream* out);
513 void dump_inline_data_reduced(outputStream* out);
514
515 private:
516 // Matching, CFG layout, allocation, code generation
517 PhaseCFG* _cfg; // Results of CFG finding
518 int _java_calls; // Number of java calls in the method
519 int _inner_loops; // Number of inner loops in the method
520 Matcher* _matcher; // Engine to map ideal to machine instructions
521 PhaseRegAlloc* _regalloc; // Results of register allocation.
522 RegMask _FIRST_STACK_mask; // All stack slots usable for spills (depends on frame layout)
523 Arena* _indexSet_arena; // control IndexSet allocation within PhaseChaitin
524 void* _indexSet_free_block_list; // free list of IndexSet bit blocks
525 int _interpreter_frame_size;
526
527 PhaseOutput* _output;
528
529 public:
530 // Accessors
531
532 // The Compile instance currently active in this (compiler) thread.
533 static Compile* current() {
534 return (Compile*) ciEnv::current()->compiler_data();
535 }
536
537 int interpreter_frame_size() const { return _interpreter_frame_size; }
538
539 PhaseOutput* output() const { return _output; }
540 void set_output(PhaseOutput* o) { _output = o; }
541
542 // ID for this compilation. Useful for setting breakpoints in the debugger.
543 int compile_id() const { return _compile_id; }
544 DirectiveSet* directive() const { return _directive; }
545
546 // Does this compilation allow instructions to subsume loads? User
547 // instructions that subsume a load may result in an unschedulable
548 // instruction sequence.
549 bool subsume_loads() const { return _options._subsume_loads; }
550 /** Do escape analysis. */
551 bool do_escape_analysis() const { return _options._do_escape_analysis; }
552 bool do_iterative_escape_analysis() const { return _options._do_iterative_escape_analysis; }
553 bool do_reduce_allocation_merges() const { return _options._do_reduce_allocation_merges; }
554 /** Do boxing elimination. */
555 bool eliminate_boxing() const { return _options._eliminate_boxing; }
556 /** Do aggressive boxing elimination. */
557 bool aggressive_unboxing() const { return _options._eliminate_boxing && AggressiveUnboxing; }
558 bool should_install_code() const { return _options._install_code; }
559 /** Do locks coarsening. */
560 bool do_locks_coarsening() const { return _options._do_locks_coarsening; }
561 bool do_superword() const { return _options._do_superword; }
562
563 // Other fixed compilation parameters.
564 ciMethod* method() const { return _method; }
565 int entry_bci() const { return _entry_bci; }
566 bool is_osr_compilation() const { return _entry_bci != InvocationEntryBci; }
567 bool is_method_compilation() const { return (_method != nullptr && !_method->flags().is_native()); }
568 const TypeFunc* tf() const { assert(_tf!=nullptr, ""); return _tf; }
569 void init_tf(const TypeFunc* tf) { assert(_tf==nullptr, ""); _tf = tf; }
570 InlineTree* ilt() const { return _ilt; }
571 address stub_function() const { return _stub_function; }
572 const char* stub_name() const { return _stub_name; }
573 address stub_entry_point() const { return _stub_entry_point; }
574 void set_stub_entry_point(address z) { _stub_entry_point = z; }
575
576 // Control of this compilation.
577 int fixed_slots() const { assert(_fixed_slots >= 0, ""); return _fixed_slots; }
578 void set_fixed_slots(int n) { _fixed_slots = n; }
579 int major_progress() const { return _major_progress; }
580 void set_inlining_progress(bool z) { _inlining_progress = z; }
581 int inlining_progress() const { return _inlining_progress; }
582 void set_inlining_incrementally(bool z) { _inlining_incrementally = z; }
583 int inlining_incrementally() const { return _inlining_incrementally; }
584 void set_do_cleanup(bool z) { _do_cleanup = z; }
585 int do_cleanup() const { return _do_cleanup; }
586 void set_major_progress() { _major_progress++; }
587 void restore_major_progress(int progress) { _major_progress += progress; }
588 void clear_major_progress() { _major_progress = 0; }
589 int max_inline_size() const { return _max_inline_size; }
590 void set_freq_inline_size(int n) { _freq_inline_size = n; }
591 int freq_inline_size() const { return _freq_inline_size; }
592 void set_max_inline_size(int n) { _max_inline_size = n; }
593 bool has_loops() const { return _has_loops; }
594 void set_has_loops(bool z) { _has_loops = z; }
595 bool has_split_ifs() const { return _has_split_ifs; }
596 void set_has_split_ifs(bool z) { _has_split_ifs = z; }
597 bool has_unsafe_access() const { return _has_unsafe_access; }
598 void set_has_unsafe_access(bool z) { _has_unsafe_access = z; }
599 bool has_stringbuilder() const { return _has_stringbuilder; }
600 void set_has_stringbuilder(bool z) { _has_stringbuilder = z; }
601 bool has_boxed_value() const { return _has_boxed_value; }
602 void set_has_boxed_value(bool z) { _has_boxed_value = z; }
603 bool has_reserved_stack_access() const { return _has_reserved_stack_access; }
604 void set_has_reserved_stack_access(bool z) { _has_reserved_stack_access = z; }
605 uint max_vector_size() const { return _max_vector_size; }
606 void set_max_vector_size(uint s) { _max_vector_size = s; }
607 bool clear_upper_avx() const { return _clear_upper_avx; }
608 void set_clear_upper_avx(bool s) { _clear_upper_avx = s; }
609 void set_trap_count(uint r, uint c) { assert(r < trapHistLength, "oob"); _trap_hist[r] = c; }
610 uint trap_count(uint r) const { assert(r < trapHistLength, "oob"); return _trap_hist[r]; }
611 bool trap_can_recompile() const { return _trap_can_recompile; }
612 void set_trap_can_recompile(bool z) { _trap_can_recompile = z; }
613 uint decompile_count() const { return _decompile_count; }
614 void set_decompile_count(uint c) { _decompile_count = c; }
615 bool allow_range_check_smearing() const;
616 bool do_inlining() const { return _do_inlining; }
617 void set_do_inlining(bool z) { _do_inlining = z; }
618 bool do_scheduling() const { return _do_scheduling; }
619 void set_do_scheduling(bool z) { _do_scheduling = z; }
620 bool do_freq_based_layout() const{ return _do_freq_based_layout; }
621 void set_do_freq_based_layout(bool z){ _do_freq_based_layout = z; }
622 bool do_vector_loop() const { return _do_vector_loop; }
623 void set_do_vector_loop(bool z) { _do_vector_loop = z; }
624 bool use_cmove() const { return _use_cmove; }
625 void set_use_cmove(bool z) { _use_cmove = z; }
626 bool do_aliasing() const { return _do_aliasing; }
627 bool print_assembly() const { return _print_assembly; }
628 void set_print_assembly(bool z) { _print_assembly = z; }
629 bool print_inlining() const { return _print_inlining; }
630 void set_print_inlining(bool z) { _print_inlining = z; }
631 bool print_intrinsics() const { return _print_intrinsics; }
632 void set_print_intrinsics(bool z) { _print_intrinsics = z; }
633 uint max_node_limit() const { return (uint)_max_node_limit; }
634 void set_max_node_limit(uint n) { _max_node_limit = n; }
635 bool clinit_barrier_on_entry() { return _clinit_barrier_on_entry; }
636 void set_clinit_barrier_on_entry(bool z) { _clinit_barrier_on_entry = z; }
637 bool has_monitors() const { return _has_monitors; }
638 void set_has_monitors(bool v) { _has_monitors = v; }
639 bool has_scoped_access() const { return _has_scoped_access; }
640 void set_has_scoped_access(bool v) { _has_scoped_access = v; }
641
642 // check the CompilerOracle for special behaviours for this compile
643 bool method_has_option(CompileCommandEnum option) {
644 return method() != nullptr && method()->has_option(option);
645 }
646
647 #ifndef PRODUCT
648 uint next_igv_idx() { return _igv_idx++; }
649 bool trace_opto_output() const { return _trace_opto_output; }
650 void print_ideal_ir(const char* phase_name);
651 bool should_print_ideal() const { return _directive->PrintIdealOption; }
652 bool parsed_irreducible_loop() const { return _parsed_irreducible_loop; }
653 void set_parsed_irreducible_loop(bool z) { _parsed_irreducible_loop = z; }
654 int _in_dump_cnt; // Required for dumping ir nodes.
655 #endif
656 bool has_irreducible_loop() const { return _has_irreducible_loop; }
657 void set_has_irreducible_loop(bool z) { _has_irreducible_loop = z; }
658
659 // JSR 292
660 bool has_method_handle_invokes() const { return _has_method_handle_invokes; }
661 void set_has_method_handle_invokes(bool z) { _has_method_handle_invokes = z; }
662
663 Ticks _latest_stage_start_counter;
664
665 void begin_method();
666 void end_method();
667 bool should_print_igv(int level);
668 bool should_print_phase(CompilerPhaseType cpt);
669
670 void print_method(CompilerPhaseType cpt, int level, Node* n = nullptr);
671
672 #ifndef PRODUCT
673 void init_igv();
674 void dump_igv(const char* graph_name, int level = 3) {
675 if (should_print_igv(level)) {
676 _igv_printer->print_graph(graph_name);
677 }
678 }
679
680 void igv_print_method_to_file(const char* phase_name = "Debug", bool append = false);
681 void igv_print_method_to_network(const char* phase_name = "Debug");
682 void igv_print_graph_to_network(const char* name, GrowableArray<const Node*>& visible_nodes);
683 static IdealGraphPrinter* debug_file_printer() { return _debug_file_printer; }
684 static IdealGraphPrinter* debug_network_printer() { return _debug_network_printer; }
685 #endif
686
687 const GrowableArray<ParsePredicateNode*>& parse_predicates() const {
688 return _parse_predicates;
689 }
690
691 const GrowableArray<OpaqueTemplateAssertionPredicateNode*>& template_assertion_predicate_opaques() const {
692 return _template_assertion_predicate_opaques;
693 }
694
695 int macro_count() const { return _macro_nodes.length(); }
696 int parse_predicate_count() const { return _parse_predicates.length(); }
697 int template_assertion_predicate_count() const { return _template_assertion_predicate_opaques.length(); }
698 int expensive_count() const { return _expensive_nodes.length(); }
699 int coarsened_count() const { return _coarsened_locks.length(); }
700
701 Node* macro_node(int idx) const { return _macro_nodes.at(idx); }
702
703 Node* expensive_node(int idx) const { return _expensive_nodes.at(idx); }
704
705 ConnectionGraph* congraph() { return _congraph;}
706 void set_congraph(ConnectionGraph* congraph) { _congraph = congraph;}
707 void add_macro_node(Node * n) {
708 //assert(n->is_macro(), "must be a macro node");
709 assert(!_macro_nodes.contains(n), "duplicate entry in expand list");
710 _macro_nodes.append(n);
711 }
712 void remove_macro_node(Node* n) {
713 // this function may be called twice for a node so we can only remove it
714 // if it's still existing.
715 _macro_nodes.remove_if_existing(n);
716 // Remove from coarsened locks list if present
717 if (coarsened_count() > 0) {
718 remove_coarsened_lock(n);
719 }
720 }
721 void add_expensive_node(Node* n);
722 void remove_expensive_node(Node* n) {
723 _expensive_nodes.remove_if_existing(n);
724 }
725
726 void add_parse_predicate(ParsePredicateNode* n) {
727 assert(!_parse_predicates.contains(n), "duplicate entry in Parse Predicate list");
728 _parse_predicates.append(n);
729 }
730
731 void remove_parse_predicate(ParsePredicateNode* n) {
732 if (parse_predicate_count() > 0) {
733 _parse_predicates.remove_if_existing(n);
734 }
735 }
736
737 void add_template_assertion_predicate_opaque(OpaqueTemplateAssertionPredicateNode* n) {
738 assert(!_template_assertion_predicate_opaques.contains(n),
739 "Duplicate entry in Template Assertion Predicate OpaqueTemplateAssertionPredicate list");
740 _template_assertion_predicate_opaques.append(n);
741 }
742
743 void remove_template_assertion_predicate_opaque(OpaqueTemplateAssertionPredicateNode* n) {
744 if (template_assertion_predicate_count() > 0) {
745 _template_assertion_predicate_opaques.remove_if_existing(n);
746 }
747 }
748 void add_coarsened_locks(GrowableArray<AbstractLockNode*>& locks);
749 void remove_coarsened_lock(Node* n);
750 bool coarsened_locks_consistent();
751 void mark_unbalanced_boxes() const;
752
753 bool post_loop_opts_phase() { return _post_loop_opts_phase; }
754 void set_post_loop_opts_phase() { _post_loop_opts_phase = true; }
755 void reset_post_loop_opts_phase() { _post_loop_opts_phase = false; }
756
757 #ifdef ASSERT
758 bool phase_verify_ideal_loop() const { return _phase_verify_ideal_loop; }
759 void set_phase_verify_ideal_loop() { _phase_verify_ideal_loop = true; }
760 void reset_phase_verify_ideal_loop() { _phase_verify_ideal_loop = false; }
761 #endif
762
763 bool allow_macro_nodes() { return _allow_macro_nodes; }
764 void reset_allow_macro_nodes() { _allow_macro_nodes = false; }
765
766 void record_for_post_loop_opts_igvn(Node* n);
767 void remove_from_post_loop_opts_igvn(Node* n);
768 void process_for_post_loop_opts_igvn(PhaseIterGVN& igvn);
769
770 void record_unstable_if_trap(UnstableIfTrap* trap);
771 bool remove_unstable_if_trap(CallStaticJavaNode* unc, bool yield);
772 void remove_useless_unstable_if_traps(Unique_Node_List &useful);
773 void process_for_unstable_if_traps(PhaseIterGVN& igvn);
774
775 bool merge_stores_phase() { return _merge_stores_phase; }
776 void set_merge_stores_phase() { _merge_stores_phase = true; }
777 void record_for_merge_stores_igvn(Node* n);
778 void remove_from_merge_stores_igvn(Node* n);
779 void process_for_merge_stores_igvn(PhaseIterGVN& igvn);
780
781 void shuffle_macro_nodes();
782 void sort_macro_nodes();
783
784 void mark_parse_predicate_nodes_useless(PhaseIterGVN& igvn);
785
786 // Are there candidate expensive nodes for optimization?
787 bool should_optimize_expensive_nodes(PhaseIterGVN &igvn);
788 // Check whether n1 and n2 are similar
789 static int cmp_expensive_nodes(Node* n1, Node* n2);
790 // Sort expensive nodes to locate similar expensive nodes
791 void sort_expensive_nodes();
792
793 // Compilation environment.
794 Arena* comp_arena() { return &_comp_arena; }
795 ciEnv* env() const { return _env; }
796 CompileLog* log() const { return _log; }
797
798 bool failing_internal() const {
799 return _env->failing() ||
800 _failure_reason.get() != nullptr;
801 }
802
803 const char* failure_reason() const {
804 return _env->failing() ? _env->failure_reason()
805 : _failure_reason.get();
806 }
807
808 const CompilationFailureInfo* first_failure_details() const { return _first_failure_details; }
809
810 bool failing() {
811 if (failing_internal()) {
812 return true;
813 }
814 #ifdef ASSERT
815 // Disable stress code for PhaseIdealLoop verification (would have cascading effects).
816 if (phase_verify_ideal_loop()) {
817 return false;
818 }
819 if (StressBailout) {
820 return fail_randomly();
821 }
822 #endif
823 return false;
824 }
825
826 #ifdef ASSERT
827 bool fail_randomly();
828 bool failure_is_artificial();
829 #endif
830
831 bool failure_reason_is(const char* r) const {
832 return (r == _failure_reason.get()) ||
833 (r != nullptr &&
834 _failure_reason.get() != nullptr &&
835 strcmp(r, _failure_reason.get()) == 0);
836 }
837
838 void record_failure(const char* reason DEBUG_ONLY(COMMA bool allow_multiple_failures = false));
839 void record_method_not_compilable(const char* reason DEBUG_ONLY(COMMA bool allow_multiple_failures = false)) {
840 env()->record_method_not_compilable(reason);
841 // Record failure reason.
842 record_failure(reason DEBUG_ONLY(COMMA allow_multiple_failures));
843 }
844 bool check_node_count(uint margin, const char* reason) {
845 if (oom()) {
846 record_method_not_compilable_oom();
847 return true;
848 }
849 if (live_nodes() + margin > max_node_limit()) {
850 record_method_not_compilable(reason);
851 return true;
852 } else {
853 return false;
854 }
855 }
856 bool oom() const { return _oom; }
857 void set_oom() { _oom = true; }
858
859 // Node management
860 uint unique() const { return _unique; }
861 uint next_unique() { return _unique++; }
862 void set_unique(uint i) { _unique = i; }
863 Arena* node_arena() { return _node_arena; }
864 Arena* old_arena() { return (&_node_arena_one == _node_arena) ? &_node_arena_two : &_node_arena_one; }
865 RootNode* root() const { return _root; }
866 void set_root(RootNode* r) { _root = r; }
867 StartNode* start() const; // (Derived from root.)
868 void verify_start(StartNode* s) const NOT_DEBUG_RETURN;
869 Node* immutable_memory();
870
871 Node* recent_alloc_ctl() const { return _recent_alloc_ctl; }
872 Node* recent_alloc_obj() const { return _recent_alloc_obj; }
873 void set_recent_alloc(Node* ctl, Node* obj) {
874 _recent_alloc_ctl = ctl;
875 _recent_alloc_obj = obj;
876 }
877 void record_dead_node(uint idx) { if (_dead_node_list.test_set(idx)) return;
878 _dead_node_count++;
879 }
880 void reset_dead_node_list() { _dead_node_list.reset();
881 _dead_node_count = 0;
882 }
883 uint live_nodes() const {
884 int val = _unique - _dead_node_count;
885 assert (val >= 0, "number of tracked dead nodes %d more than created nodes %d", _unique, _dead_node_count);
886 return (uint) val;
887 }
888 #ifdef ASSERT
889 void set_phase_optimize_finished() { _phase_optimize_finished = true; }
890 bool phase_optimize_finished() const { return _phase_optimize_finished; }
891 uint count_live_nodes_by_graph_walk();
892 void print_missing_nodes();
893 #endif
894
895 // Record modified nodes to check that they are put on IGVN worklist
896 void record_modified_node(Node* n) NOT_DEBUG_RETURN;
897 void remove_modified_node(Node* n) NOT_DEBUG_RETURN;
898 DEBUG_ONLY( Unique_Node_List* modified_nodes() const { return _modified_nodes; } )
899
900 MachConstantBaseNode* mach_constant_base_node();
901 bool has_mach_constant_base_node() const { return _mach_constant_base_node != nullptr; }
902 // Generated by adlc, true if CallNode requires MachConstantBase.
903 bool needs_deep_clone_jvms();
904
905 // Handy undefined Node
906 Node* top() const { return _top; }
907
908 // these are used by guys who need to know about creation and transformation of top:
909 Node* cached_top_node() { return _top; }
910 void set_cached_top_node(Node* tn);
911
912 GrowableArray<Node_Notes*>* node_note_array() const { return _node_note_array; }
913 void set_node_note_array(GrowableArray<Node_Notes*>* arr) { _node_note_array = arr; }
914 Node_Notes* default_node_notes() const { return _default_node_notes; }
915 void set_default_node_notes(Node_Notes* n) { _default_node_notes = n; }
916
917 Node_Notes* node_notes_at(int idx);
918
919 inline bool set_node_notes_at(int idx, Node_Notes* value);
920 // Copy notes from source to dest, if they exist.
921 // Overwrite dest only if source provides something.
922 // Return true if information was moved.
923 bool copy_node_notes_to(Node* dest, Node* source);
924
925 // Workhorse function to sort out the blocked Node_Notes array:
926 inline Node_Notes* locate_node_notes(GrowableArray<Node_Notes*>* arr,
927 int idx, bool can_grow = false);
928
929 void grow_node_notes(GrowableArray<Node_Notes*>* arr, int grow_by);
930
931 // Type management
932 Arena* type_arena() { return _type_arena; }
933 Dict* type_dict() { return _type_dict; }
934 size_t type_last_size() { return _type_last_size; }
935 int num_alias_types() { return _num_alias_types; }
936
937 void init_type_arena() { _type_arena = &_Compile_types; }
938 void set_type_arena(Arena* a) { _type_arena = a; }
939 void set_type_dict(Dict* d) { _type_dict = d; }
940 void set_type_last_size(size_t sz) { _type_last_size = sz; }
941
942 const TypeFunc* last_tf(ciMethod* m) {
943 return (m == _last_tf_m) ? _last_tf : nullptr;
944 }
945 void set_last_tf(ciMethod* m, const TypeFunc* tf) {
946 assert(m != nullptr || tf == nullptr, "");
947 _last_tf_m = m;
948 _last_tf = tf;
949 }
950
951 AliasType* alias_type(int idx) { assert(idx < num_alias_types(), "oob"); return _alias_types[idx]; }
952 AliasType* alias_type(const TypePtr* adr_type, ciField* field = nullptr) { return find_alias_type(adr_type, false, field); }
953 bool have_alias_type(const TypePtr* adr_type);
954 AliasType* alias_type(ciField* field);
955
956 int get_alias_index(const TypePtr* at) { return alias_type(at)->index(); }
957 const TypePtr* get_adr_type(uint aidx) { return alias_type(aidx)->adr_type(); }
958 int get_general_index(uint aidx) { return alias_type(aidx)->general_index(); }
959
960 // Building nodes
961 void rethrow_exceptions(JVMState* jvms);
962 void return_values(JVMState* jvms);
963 JVMState* build_start_state(StartNode* start, const TypeFunc* tf);
964
965 // Decide how to build a call.
966 // The profile factor is a discount to apply to this site's interp. profile.
967 CallGenerator* call_generator(ciMethod* call_method, int vtable_index, bool call_does_dispatch,
968 JVMState* jvms, bool allow_inline, float profile_factor, ciKlass* speculative_receiver_type = nullptr,
969 bool allow_intrinsics = true);
970 bool should_delay_inlining(ciMethod* call_method, JVMState* jvms) {
971 return should_delay_string_inlining(call_method, jvms) ||
972 should_delay_boxing_inlining(call_method, jvms) ||
973 should_delay_vector_inlining(call_method, jvms);
974 }
975 bool should_delay_string_inlining(ciMethod* call_method, JVMState* jvms);
976 bool should_delay_boxing_inlining(ciMethod* call_method, JVMState* jvms);
977 bool should_delay_vector_inlining(ciMethod* call_method, JVMState* jvms);
978 bool should_delay_vector_reboxing_inlining(ciMethod* call_method, JVMState* jvms);
979
980 // Helper functions to identify inlining potential at call-site
981 ciMethod* optimize_virtual_call(ciMethod* caller, ciInstanceKlass* klass,
982 ciKlass* holder, ciMethod* callee,
983 const TypeOopPtr* receiver_type, bool is_virtual,
984 bool &call_does_dispatch, int &vtable_index,
985 bool check_access = true);
986 ciMethod* optimize_inlining(ciMethod* caller, ciInstanceKlass* klass, ciKlass* holder,
987 ciMethod* callee, const TypeOopPtr* receiver_type,
988 bool check_access = true);
989
990 // Report if there were too many traps at a current method and bci.
991 // Report if a trap was recorded, and/or PerMethodTrapLimit was exceeded.
992 // If there is no MDO at all, report no trap unless told to assume it.
993 bool too_many_traps(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
994 // This version, unspecific to a particular bci, asks if
995 // PerMethodTrapLimit was exceeded for all inlined methods seen so far.
996 bool too_many_traps(Deoptimization::DeoptReason reason,
997 // Privately used parameter for logging:
998 ciMethodData* logmd = nullptr);
999 // Report if there were too many recompiles at a method and bci.
1000 bool too_many_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason);
1001 // Report if there were too many traps or recompiles at a method and bci.
1002 bool too_many_traps_or_recompiles(ciMethod* method, int bci, Deoptimization::DeoptReason reason) {
1003 return too_many_traps(method, bci, reason) ||
1004 too_many_recompiles(method, bci, reason);
1005 }
1006 // Return a bitset with the reasons where deoptimization is allowed,
1007 // i.e., where there were not too many uncommon traps.
1008 int _allowed_reasons;
1009 int allowed_deopt_reasons() { return _allowed_reasons; }
1010 void set_allowed_deopt_reasons();
1011
1012 // Parsing, optimization
1013 PhaseGVN* initial_gvn() { return _initial_gvn; }
1014 Unique_Node_List* igvn_worklist() {
1015 assert(_igvn_worklist != nullptr, "must be created in Compile::Compile");
1016 return _igvn_worklist;
1017 }
1018 Type_Array* types() {
1019 assert(_types != nullptr, "must be created in Compile::Compile");
1020 return _types;
1021 }
1022 NodeHash* node_hash() {
1023 assert(_node_hash != nullptr, "must be created in Compile::Compile");
1024 return _node_hash;
1025 }
1026 inline void record_for_igvn(Node* n); // Body is after class Unique_Node_List in node.hpp.
1027 inline void remove_for_igvn(Node* n); // Body is after class Unique_Node_List in node.hpp.
1028 void set_initial_gvn(PhaseGVN *gvn) { _initial_gvn = gvn; }
1029
1030 // Replace n by nn using initial_gvn, calling hash_delete and
1031 // record_for_igvn as needed.
1032 void gvn_replace_by(Node* n, Node* nn);
1033
1034
1035 void identify_useful_nodes(Unique_Node_List &useful);
1036 void update_dead_node_list(Unique_Node_List &useful);
1037 void disconnect_useless_nodes(Unique_Node_List& useful, Unique_Node_List& worklist, const Unique_Node_List* root_and_safepoints = nullptr);
1038
1039 void remove_useless_node(Node* dead);
1040
1041 // Record this CallGenerator for inlining at the end of parsing.
1042 void add_late_inline(CallGenerator* cg) {
1043 _late_inlines.insert_before(_late_inlines_pos, cg);
1044 _late_inlines_pos++;
1045 }
1046
1047 void prepend_late_inline(CallGenerator* cg) {
1048 _late_inlines.insert_before(0, cg);
1049 }
1050
1051 void add_string_late_inline(CallGenerator* cg) {
1052 _string_late_inlines.push(cg);
1053 }
1054
1055 void add_boxing_late_inline(CallGenerator* cg) {
1056 _boxing_late_inlines.push(cg);
1057 }
1058
1059 void add_vector_reboxing_late_inline(CallGenerator* cg) {
1060 _vector_reboxing_late_inlines.push(cg);
1061 }
1062
1063 template<typename N, ENABLE_IF(std::is_base_of<Node, N>::value)>
1064 void remove_useless_nodes(GrowableArray<N*>& node_list, Unique_Node_List& useful);
1065
1066 void remove_useless_late_inlines(GrowableArray<CallGenerator*>* inlines, Unique_Node_List &useful);
1067 void remove_useless_late_inlines(GrowableArray<CallGenerator*>* inlines, Node* dead);
1068
1069 void remove_useless_coarsened_locks(Unique_Node_List& useful);
1070
1071 void dump_print_inlining();
1072
1073 bool over_inlining_cutoff() const {
1074 if (!inlining_incrementally()) {
1075 return unique() > (uint)NodeCountInliningCutoff;
1076 } else {
1077 // Give some room for incremental inlining algorithm to "breathe"
1078 // and avoid thrashing when live node count is close to the limit.
1079 // Keep in mind that live_nodes() isn't accurate during inlining until
1080 // dead node elimination step happens (see Compile::inline_incrementally).
1081 return live_nodes() > (uint)LiveNodeCountInliningCutoff * 11 / 10;
1082 }
1083 }
1084
1085 void inc_number_of_mh_late_inlines() { _number_of_mh_late_inlines++; }
1086 void dec_number_of_mh_late_inlines() { assert(_number_of_mh_late_inlines > 0, "_number_of_mh_late_inlines < 0 !"); _number_of_mh_late_inlines--; }
1087 bool has_mh_late_inlines() const { return _number_of_mh_late_inlines > 0; }
1088
1089 bool inline_incrementally_one();
1090 void inline_incrementally_cleanup(PhaseIterGVN& igvn);
1091 void inline_incrementally(PhaseIterGVN& igvn);
1092 bool should_delay_inlining() { return AlwaysIncrementalInline || (StressIncrementalInlining && (random() % 2) == 0); }
1093 void inline_string_calls(bool parse_time);
1094 void inline_boxing_calls(PhaseIterGVN& igvn);
1095 bool optimize_loops(PhaseIterGVN& igvn, LoopOptsMode mode);
1096 void remove_root_to_sfpts_edges(PhaseIterGVN& igvn);
1097
1098 void inline_vector_reboxing_calls();
1099 bool has_vbox_nodes();
1100
1101 void process_late_inline_calls_no_inline(PhaseIterGVN& igvn);
1102
1103 // Matching, CFG layout, allocation, code generation
1104 PhaseCFG* cfg() { return _cfg; }
1105 bool has_java_calls() const { return _java_calls > 0; }
1106 int java_calls() const { return _java_calls; }
1107 int inner_loops() const { return _inner_loops; }
1108 Matcher* matcher() { return _matcher; }
1109 PhaseRegAlloc* regalloc() { return _regalloc; }
1110 RegMask& FIRST_STACK_mask() { return _FIRST_STACK_mask; }
1111 Arena* indexSet_arena() { return _indexSet_arena; }
1112 void* indexSet_free_block_list() { return _indexSet_free_block_list; }
1113 DebugInformationRecorder* debug_info() { return env()->debug_info(); }
1114
1115 void update_interpreter_frame_size(int size) {
1116 if (_interpreter_frame_size < size) {
1117 _interpreter_frame_size = size;
1118 }
1119 }
1120
1121 void set_matcher(Matcher* m) { _matcher = m; }
1122 //void set_regalloc(PhaseRegAlloc* ra) { _regalloc = ra; }
1123 void set_indexSet_arena(Arena* a) { _indexSet_arena = a; }
1124 void set_indexSet_free_block_list(void* p) { _indexSet_free_block_list = p; }
1125
1126 void set_java_calls(int z) { _java_calls = z; }
1127 void set_inner_loops(int z) { _inner_loops = z; }
1128
1129 Dependencies* dependencies() { return env()->dependencies(); }
1130
1131 // Major entry point. Given a Scope, compile the associated method.
1132 // For normal compilations, entry_bci is InvocationEntryBci. For on stack
1133 // replacement, entry_bci indicates the bytecode for which to compile a
1134 // continuation.
1135 Compile(ciEnv* ci_env, ciMethod* target,
1136 int entry_bci, Options options, DirectiveSet* directive);
1137
1138 // Second major entry point. From the TypeFunc signature, generate code
1139 // to pass arguments from the Java calling convention to the C calling
1140 // convention.
1141 Compile(ciEnv* ci_env, const TypeFunc *(*gen)(),
1142 address stub_function, const char *stub_name,
1143 int is_fancy_jump, bool pass_tls,
1144 bool return_pc, DirectiveSet* directive);
1145
1146 ~Compile();
1147
1148 // Are we compiling a method?
1149 bool has_method() { return method() != nullptr; }
1150
1151 // Maybe print some information about this compile.
1152 void print_compile_messages();
1153
1154 // Final graph reshaping, a post-pass after the regular optimizer is done.
1155 bool final_graph_reshaping();
1156
1157 // returns true if adr is completely contained in the given alias category
1158 bool must_alias(const TypePtr* adr, int alias_idx);
1159
1160 // returns true if adr overlaps with the given alias category
1161 bool can_alias(const TypePtr* adr, int alias_idx);
1162
1163 // Stack slots that may be unused by the calling convention but must
1164 // otherwise be preserved. On Intel this includes the return address.
1165 // On PowerPC it includes the 4 words holding the old TOC & LR glue.
1166 uint in_preserve_stack_slots() {
1167 return SharedRuntime::in_preserve_stack_slots();
1168 }
1169
1170 // "Top of Stack" slots that may be unused by the calling convention but must
1171 // otherwise be preserved.
1172 // On Intel these are not necessary and the value can be zero.
1173 static uint out_preserve_stack_slots() {
1174 return SharedRuntime::out_preserve_stack_slots();
1175 }
1176
1177 // Number of outgoing stack slots killed above the out_preserve_stack_slots
1178 // for calls to C. Supports the var-args backing area for register parms.
1179 uint varargs_C_out_slots_killed() const;
1180
1181 // Number of Stack Slots consumed by a synchronization entry
1182 int sync_stack_slots() const;
1183
1184 // Compute the name of old_SP. See <arch>.ad for frame layout.
1185 OptoReg::Name compute_old_SP();
1186
1187 private:
1188 // Phase control:
1189 void Init(bool aliasing); // Prepare for a single compilation
1190 void Optimize(); // Given a graph, optimize it
1191 void Code_Gen(); // Generate code from a graph
1192
1193 // Management of the AliasType table.
1194 void grow_alias_types();
1195 AliasCacheEntry* probe_alias_cache(const TypePtr* adr_type);
1196 const TypePtr *flatten_alias_type(const TypePtr* adr_type) const;
1197 AliasType* find_alias_type(const TypePtr* adr_type, bool no_create, ciField* field);
1198
1199 void verify_top(Node*) const PRODUCT_RETURN;
1200
1201 // Intrinsic setup.
1202 CallGenerator* make_vm_intrinsic(ciMethod* m, bool is_virtual); // constructor
1203 int intrinsic_insertion_index(ciMethod* m, bool is_virtual, bool& found); // helper
1204 CallGenerator* find_intrinsic(ciMethod* m, bool is_virtual); // query fn
1205 void register_intrinsic(CallGenerator* cg); // update fn
1206
1207 #ifndef PRODUCT
1208 static juint _intrinsic_hist_count[];
1209 static jubyte _intrinsic_hist_flags[];
1210 #endif
1211 // Function calls made by the public function final_graph_reshaping.
1212 // No need to be made public as they are not called elsewhere.
1213 void final_graph_reshaping_impl(Node *n, Final_Reshape_Counts& frc, Unique_Node_List& dead_nodes);
1214 void final_graph_reshaping_main_switch(Node* n, Final_Reshape_Counts& frc, uint nop, Unique_Node_List& dead_nodes);
1215 void final_graph_reshaping_walk(Node_Stack& nstack, Node* root, Final_Reshape_Counts& frc, Unique_Node_List& dead_nodes);
1216 void handle_div_mod_op(Node* n, BasicType bt, bool is_unsigned);
1217
1218 // Logic cone optimization.
1219 void optimize_logic_cones(PhaseIterGVN &igvn);
1220 void collect_logic_cone_roots(Unique_Node_List& list);
1221 void process_logic_cone_root(PhaseIterGVN &igvn, Node* n, VectorSet& visited);
1222 bool compute_logic_cone(Node* n, Unique_Node_List& partition, Unique_Node_List& inputs);
1223 uint compute_truth_table(Unique_Node_List& partition, Unique_Node_List& inputs);
1224 uint eval_macro_logic_op(uint func, uint op1, uint op2, uint op3);
1225 Node* xform_to_MacroLogicV(PhaseIterGVN &igvn, const TypeVect* vt, Unique_Node_List& partitions, Unique_Node_List& inputs);
1226 void check_no_dead_use() const NOT_DEBUG_RETURN;
1227
1228 public:
1229
1230 // Note: Histogram array size is about 1 Kb.
1231 enum { // flag bits:
1232 _intrinsic_worked = 1, // succeeded at least once
1233 _intrinsic_failed = 2, // tried it but it failed
1234 _intrinsic_disabled = 4, // was requested but disabled (e.g., -XX:-InlineUnsafeOps)
1235 _intrinsic_virtual = 8, // was seen in the virtual form (rare)
1236 _intrinsic_both = 16 // was seen in the non-virtual form (usual)
1237 };
1238 // Update histogram. Return boolean if this is a first-time occurrence.
1239 static bool gather_intrinsic_statistics(vmIntrinsics::ID id,
1240 bool is_virtual, int flags) PRODUCT_RETURN0;
1241 static void print_intrinsic_statistics() PRODUCT_RETURN;
1242
1243 // Graph verification code
1244 // Walk the node list, verifying that there is a one-to-one correspondence
1245 // between Use-Def edges and Def-Use edges. The option no_dead_code enables
1246 // stronger checks that the graph is strongly connected from starting points
1247 // in both directions.
1248 // root_and_safepoints is used to give the starting points for the traversal.
1249 // If not supplied, only root is used. When this check is called after CCP,
1250 // we need to start traversal from Root and safepoints, just like CCP does its
1251 // own traversal (see PhaseCCP::transform for reasons).
1252 //
1253 // To call this function, there are 2 ways to go:
1254 // - give root_and_safepoints to start traversal everywhere needed (like after CCP)
1255 // - if the whole graph is assumed to be reachable from Root's input,
1256 // root_and_safepoints is not needed (like in PhaseRemoveUseless).
1257 //
1258 // Failure to specify root_and_safepoints in case the graph is not fully
1259 // reachable from Root's input make this check unsound (can miss inconsistencies)
1260 // and even incomplete (can make up non-existing problems) if no_dead_code is
1261 // true.
1262 void verify_graph_edges(bool no_dead_code = false, const Unique_Node_List* root_and_safepoints = nullptr) const PRODUCT_RETURN;
1263
1264 // Verify bi-directional correspondence of edges
1265 void verify_bidirectional_edges(Unique_Node_List& visited, const Unique_Node_List* root_and_safepoints = nullptr) const;
1266
1267 // End-of-run dumps.
1268 static void print_statistics() PRODUCT_RETURN;
1269
1270 // Verify ADLC assumptions during startup
1271 static void adlc_verification() PRODUCT_RETURN;
1272
1273 // Definitions of pd methods
1274 static void pd_compiler2_init();
1275
1276 // Static parse-time type checking logic for gen_subtype_check:
1277 enum SubTypeCheckResult { SSC_always_false, SSC_always_true, SSC_easy_test, SSC_full_test };
1278 SubTypeCheckResult static_subtype_check(const TypeKlassPtr* superk, const TypeKlassPtr* subk, bool skip = StressReflectiveCode);
1279
1280 static Node* conv_I2X_index(PhaseGVN* phase, Node* offset, const TypeInt* sizetype,
1281 // Optional control dependency (for example, on range check)
1282 Node* ctrl = nullptr);
1283
1284 // Convert integer value to a narrowed long type dependent on ctrl (for example, a range check)
1285 static Node* constrained_convI2L(PhaseGVN* phase, Node* value, const TypeInt* itype, Node* ctrl, bool carry_dependency = false);
1286
1287 // Auxiliary methods for randomized fuzzing/stressing
1288 int random();
1289 bool randomized_select(int count);
1290
1291 // seed random number generation and log the seed for repeatability.
1292 void initialize_stress_seed(const DirectiveSet* directive);
1293
1294 // supporting clone_map
1295 CloneMap& clone_map();
1296 void set_clone_map(Dict* d);
1297
1298 bool needs_clinit_barrier(ciField* ik, ciMethod* accessing_method);
1299 bool needs_clinit_barrier(ciMethod* ik, ciMethod* accessing_method);
1300 bool needs_clinit_barrier(ciInstanceKlass* ik, ciMethod* accessing_method);
1301
1302 #ifdef ASSERT
1303 VerifyMeetResult* _type_verify;
1304 void set_exception_backedge() { _exception_backedge = true; }
1305 bool has_exception_backedge() const { return _exception_backedge; }
1306 #endif
1307
1308 static bool push_thru_add(PhaseGVN* phase, Node* z, const TypeInteger* tz, const TypeInteger*& rx, const TypeInteger*& ry,
1309 BasicType out_bt, BasicType in_bt);
1310
1311 static Node* narrow_value(BasicType bt, Node* value, const Type* type, PhaseGVN* phase, bool transform_res);
1312 };
1313
1314 #endif // SHARE_OPTO_COMPILE_HPP