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