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