Sat, 16 Mar 2013 07:39:14 -0700
8009166: [parfait] Null pointer deference in hotspot/src/share/vm/opto/type.cpp
Summary: add guarantee() to as_instance_type()
Reviewed-by: kvn, twisti
1 /*
2 * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 *
23 */
25 #include "precompiled.hpp"
26 #include "memory/allocation.inline.hpp"
27 #include "opto/block.hpp"
28 #include "opto/c2compiler.hpp"
29 #include "opto/callnode.hpp"
30 #include "opto/cfgnode.hpp"
31 #include "opto/machnode.hpp"
32 #include "opto/runtime.hpp"
33 #ifdef TARGET_ARCH_MODEL_x86_32
34 # include "adfiles/ad_x86_32.hpp"
35 #endif
36 #ifdef TARGET_ARCH_MODEL_x86_64
37 # include "adfiles/ad_x86_64.hpp"
38 #endif
39 #ifdef TARGET_ARCH_MODEL_sparc
40 # include "adfiles/ad_sparc.hpp"
41 #endif
42 #ifdef TARGET_ARCH_MODEL_zero
43 # include "adfiles/ad_zero.hpp"
44 #endif
45 #ifdef TARGET_ARCH_MODEL_arm
46 # include "adfiles/ad_arm.hpp"
47 #endif
48 #ifdef TARGET_ARCH_MODEL_ppc
49 # include "adfiles/ad_ppc.hpp"
50 #endif
52 // Optimization - Graph Style
54 //------------------------------implicit_null_check----------------------------
55 // Detect implicit-null-check opportunities. Basically, find NULL checks
56 // with suitable memory ops nearby. Use the memory op to do the NULL check.
57 // I can generate a memory op if there is not one nearby.
58 // The proj is the control projection for the not-null case.
59 // The val is the pointer being checked for nullness or
60 // decodeHeapOop_not_null node if it did not fold into address.
61 void Block::implicit_null_check(PhaseCFG *cfg, Node *proj, Node *val, int allowed_reasons) {
62 // Assume if null check need for 0 offset then always needed
63 // Intel solaris doesn't support any null checks yet and no
64 // mechanism exists (yet) to set the switches at an os_cpu level
65 if( !ImplicitNullChecks || MacroAssembler::needs_explicit_null_check(0)) return;
67 // Make sure the ptr-is-null path appears to be uncommon!
68 float f = end()->as_MachIf()->_prob;
69 if( proj->Opcode() == Op_IfTrue ) f = 1.0f - f;
70 if( f > PROB_UNLIKELY_MAG(4) ) return;
72 uint bidx = 0; // Capture index of value into memop
73 bool was_store; // Memory op is a store op
75 // Get the successor block for if the test ptr is non-null
76 Block* not_null_block; // this one goes with the proj
77 Block* null_block;
78 if (_nodes[_nodes.size()-1] == proj) {
79 null_block = _succs[0];
80 not_null_block = _succs[1];
81 } else {
82 assert(_nodes[_nodes.size()-2] == proj, "proj is one or the other");
83 not_null_block = _succs[0];
84 null_block = _succs[1];
85 }
86 while (null_block->is_Empty() == Block::empty_with_goto) {
87 null_block = null_block->_succs[0];
88 }
90 // Search the exception block for an uncommon trap.
91 // (See Parse::do_if and Parse::do_ifnull for the reason
92 // we need an uncommon trap. Briefly, we need a way to
93 // detect failure of this optimization, as in 6366351.)
94 {
95 bool found_trap = false;
96 for (uint i1 = 0; i1 < null_block->_nodes.size(); i1++) {
97 Node* nn = null_block->_nodes[i1];
98 if (nn->is_MachCall() &&
99 nn->as_MachCall()->entry_point() == SharedRuntime::uncommon_trap_blob()->entry_point()) {
100 const Type* trtype = nn->in(TypeFunc::Parms)->bottom_type();
101 if (trtype->isa_int() && trtype->is_int()->is_con()) {
102 jint tr_con = trtype->is_int()->get_con();
103 Deoptimization::DeoptReason reason = Deoptimization::trap_request_reason(tr_con);
104 Deoptimization::DeoptAction action = Deoptimization::trap_request_action(tr_con);
105 assert((int)reason < (int)BitsPerInt, "recode bit map");
106 if (is_set_nth_bit(allowed_reasons, (int) reason)
107 && action != Deoptimization::Action_none) {
108 // This uncommon trap is sure to recompile, eventually.
109 // When that happens, C->too_many_traps will prevent
110 // this transformation from happening again.
111 found_trap = true;
112 }
113 }
114 break;
115 }
116 }
117 if (!found_trap) {
118 // We did not find an uncommon trap.
119 return;
120 }
121 }
123 // Check for decodeHeapOop_not_null node which did not fold into address
124 bool is_decoden = ((intptr_t)val) & 1;
125 val = (Node*)(((intptr_t)val) & ~1);
127 assert(!is_decoden || (val->in(0) == NULL) && val->is_Mach() &&
128 (val->as_Mach()->ideal_Opcode() == Op_DecodeN), "sanity");
130 // Search the successor block for a load or store who's base value is also
131 // the tested value. There may be several.
132 Node_List *out = new Node_List(Thread::current()->resource_area());
133 MachNode *best = NULL; // Best found so far
134 for (DUIterator i = val->outs(); val->has_out(i); i++) {
135 Node *m = val->out(i);
136 if( !m->is_Mach() ) continue;
137 MachNode *mach = m->as_Mach();
138 was_store = false;
139 int iop = mach->ideal_Opcode();
140 switch( iop ) {
141 case Op_LoadB:
142 case Op_LoadUB:
143 case Op_LoadUS:
144 case Op_LoadD:
145 case Op_LoadF:
146 case Op_LoadI:
147 case Op_LoadL:
148 case Op_LoadP:
149 case Op_LoadN:
150 case Op_LoadS:
151 case Op_LoadKlass:
152 case Op_LoadNKlass:
153 case Op_LoadRange:
154 case Op_LoadD_unaligned:
155 case Op_LoadL_unaligned:
156 assert(mach->in(2) == val, "should be address");
157 break;
158 case Op_StoreB:
159 case Op_StoreC:
160 case Op_StoreCM:
161 case Op_StoreD:
162 case Op_StoreF:
163 case Op_StoreI:
164 case Op_StoreL:
165 case Op_StoreP:
166 case Op_StoreN:
167 case Op_StoreNKlass:
168 was_store = true; // Memory op is a store op
169 // Stores will have their address in slot 2 (memory in slot 1).
170 // If the value being nul-checked is in another slot, it means we
171 // are storing the checked value, which does NOT check the value!
172 if( mach->in(2) != val ) continue;
173 break; // Found a memory op?
174 case Op_StrComp:
175 case Op_StrEquals:
176 case Op_StrIndexOf:
177 case Op_AryEq:
178 case Op_EncodeISOArray:
179 // Not a legit memory op for implicit null check regardless of
180 // embedded loads
181 continue;
182 default: // Also check for embedded loads
183 if( !mach->needs_anti_dependence_check() )
184 continue; // Not an memory op; skip it
185 if( must_clone[iop] ) {
186 // Do not move nodes which produce flags because
187 // RA will try to clone it to place near branch and
188 // it will cause recompilation, see clone_node().
189 continue;
190 }
191 {
192 // Check that value is used in memory address in
193 // instructions with embedded load (CmpP val1,(val2+off)).
194 Node* base;
195 Node* index;
196 const MachOper* oper = mach->memory_inputs(base, index);
197 if (oper == NULL || oper == (MachOper*)-1) {
198 continue; // Not an memory op; skip it
199 }
200 if (val == base ||
201 val == index && val->bottom_type()->isa_narrowoop()) {
202 break; // Found it
203 } else {
204 continue; // Skip it
205 }
206 }
207 break;
208 }
209 // check if the offset is not too high for implicit exception
210 {
211 intptr_t offset = 0;
212 const TypePtr *adr_type = NULL; // Do not need this return value here
213 const Node* base = mach->get_base_and_disp(offset, adr_type);
214 if (base == NULL || base == NodeSentinel) {
215 // Narrow oop address doesn't have base, only index
216 if( val->bottom_type()->isa_narrowoop() &&
217 MacroAssembler::needs_explicit_null_check(offset) )
218 continue; // Give up if offset is beyond page size
219 // cannot reason about it; is probably not implicit null exception
220 } else {
221 const TypePtr* tptr;
222 if (UseCompressedOops && Universe::narrow_oop_shift() == 0) {
223 // 32-bits narrow oop can be the base of address expressions
224 tptr = base->bottom_type()->make_ptr();
225 } else {
226 // only regular oops are expected here
227 tptr = base->bottom_type()->is_ptr();
228 }
229 // Give up if offset is not a compile-time constant
230 if( offset == Type::OffsetBot || tptr->_offset == Type::OffsetBot )
231 continue;
232 offset += tptr->_offset; // correct if base is offseted
233 if( MacroAssembler::needs_explicit_null_check(offset) )
234 continue; // Give up is reference is beyond 4K page size
235 }
236 }
238 // Check ctrl input to see if the null-check dominates the memory op
239 Block *cb = cfg->_bbs[mach->_idx];
240 cb = cb->_idom; // Always hoist at least 1 block
241 if( !was_store ) { // Stores can be hoisted only one block
242 while( cb->_dom_depth > (_dom_depth + 1))
243 cb = cb->_idom; // Hoist loads as far as we want
244 // The non-null-block should dominate the memory op, too. Live
245 // range spilling will insert a spill in the non-null-block if it is
246 // needs to spill the memory op for an implicit null check.
247 if (cb->_dom_depth == (_dom_depth + 1)) {
248 if (cb != not_null_block) continue;
249 cb = cb->_idom;
250 }
251 }
252 if( cb != this ) continue;
254 // Found a memory user; see if it can be hoisted to check-block
255 uint vidx = 0; // Capture index of value into memop
256 uint j;
257 for( j = mach->req()-1; j > 0; j-- ) {
258 if( mach->in(j) == val ) {
259 vidx = j;
260 // Ignore DecodeN val which could be hoisted to where needed.
261 if( is_decoden ) continue;
262 }
263 // Block of memory-op input
264 Block *inb = cfg->_bbs[mach->in(j)->_idx];
265 Block *b = this; // Start from nul check
266 while( b != inb && b->_dom_depth > inb->_dom_depth )
267 b = b->_idom; // search upwards for input
268 // See if input dominates null check
269 if( b != inb )
270 break;
271 }
272 if( j > 0 )
273 continue;
274 Block *mb = cfg->_bbs[mach->_idx];
275 // Hoisting stores requires more checks for the anti-dependence case.
276 // Give up hoisting if we have to move the store past any load.
277 if( was_store ) {
278 Block *b = mb; // Start searching here for a local load
279 // mach use (faulting) trying to hoist
280 // n might be blocker to hoisting
281 while( b != this ) {
282 uint k;
283 for( k = 1; k < b->_nodes.size(); k++ ) {
284 Node *n = b->_nodes[k];
285 if( n->needs_anti_dependence_check() &&
286 n->in(LoadNode::Memory) == mach->in(StoreNode::Memory) )
287 break; // Found anti-dependent load
288 }
289 if( k < b->_nodes.size() )
290 break; // Found anti-dependent load
291 // Make sure control does not do a merge (would have to check allpaths)
292 if( b->num_preds() != 2 ) break;
293 b = cfg->_bbs[b->pred(1)->_idx]; // Move up to predecessor block
294 }
295 if( b != this ) continue;
296 }
298 // Make sure this memory op is not already being used for a NullCheck
299 Node *e = mb->end();
300 if( e->is_MachNullCheck() && e->in(1) == mach )
301 continue; // Already being used as a NULL check
303 // Found a candidate! Pick one with least dom depth - the highest
304 // in the dom tree should be closest to the null check.
305 if( !best ||
306 cfg->_bbs[mach->_idx]->_dom_depth < cfg->_bbs[best->_idx]->_dom_depth ) {
307 best = mach;
308 bidx = vidx;
310 }
311 }
312 // No candidate!
313 if( !best ) return;
315 // ---- Found an implicit null check
316 extern int implicit_null_checks;
317 implicit_null_checks++;
319 if( is_decoden ) {
320 // Check if we need to hoist decodeHeapOop_not_null first.
321 Block *valb = cfg->_bbs[val->_idx];
322 if( this != valb && this->_dom_depth < valb->_dom_depth ) {
323 // Hoist it up to the end of the test block.
324 valb->find_remove(val);
325 this->add_inst(val);
326 cfg->_bbs.map(val->_idx,this);
327 // DecodeN on x86 may kill flags. Check for flag-killing projections
328 // that also need to be hoisted.
329 for (DUIterator_Fast jmax, j = val->fast_outs(jmax); j < jmax; j++) {
330 Node* n = val->fast_out(j);
331 if( n->is_MachProj() ) {
332 cfg->_bbs[n->_idx]->find_remove(n);
333 this->add_inst(n);
334 cfg->_bbs.map(n->_idx,this);
335 }
336 }
337 }
338 }
339 // Hoist the memory candidate up to the end of the test block.
340 Block *old_block = cfg->_bbs[best->_idx];
341 old_block->find_remove(best);
342 add_inst(best);
343 cfg->_bbs.map(best->_idx,this);
345 // Move the control dependence
346 if (best->in(0) && best->in(0) == old_block->_nodes[0])
347 best->set_req(0, _nodes[0]);
349 // Check for flag-killing projections that also need to be hoisted
350 // Should be DU safe because no edge updates.
351 for (DUIterator_Fast jmax, j = best->fast_outs(jmax); j < jmax; j++) {
352 Node* n = best->fast_out(j);
353 if( n->is_MachProj() ) {
354 cfg->_bbs[n->_idx]->find_remove(n);
355 add_inst(n);
356 cfg->_bbs.map(n->_idx,this);
357 }
358 }
360 Compile *C = cfg->C;
361 // proj==Op_True --> ne test; proj==Op_False --> eq test.
362 // One of two graph shapes got matched:
363 // (IfTrue (If (Bool NE (CmpP ptr NULL))))
364 // (IfFalse (If (Bool EQ (CmpP ptr NULL))))
365 // NULL checks are always branch-if-eq. If we see a IfTrue projection
366 // then we are replacing a 'ne' test with a 'eq' NULL check test.
367 // We need to flip the projections to keep the same semantics.
368 if( proj->Opcode() == Op_IfTrue ) {
369 // Swap order of projections in basic block to swap branch targets
370 Node *tmp1 = _nodes[end_idx()+1];
371 Node *tmp2 = _nodes[end_idx()+2];
372 _nodes.map(end_idx()+1, tmp2);
373 _nodes.map(end_idx()+2, tmp1);
374 Node *tmp = new (C) Node(C->top()); // Use not NULL input
375 tmp1->replace_by(tmp);
376 tmp2->replace_by(tmp1);
377 tmp->replace_by(tmp2);
378 tmp->destruct();
379 }
381 // Remove the existing null check; use a new implicit null check instead.
382 // Since schedule-local needs precise def-use info, we need to correct
383 // it as well.
384 Node *old_tst = proj->in(0);
385 MachNode *nul_chk = new (C) MachNullCheckNode(old_tst->in(0),best,bidx);
386 _nodes.map(end_idx(),nul_chk);
387 cfg->_bbs.map(nul_chk->_idx,this);
388 // Redirect users of old_test to nul_chk
389 for (DUIterator_Last i2min, i2 = old_tst->last_outs(i2min); i2 >= i2min; --i2)
390 old_tst->last_out(i2)->set_req(0, nul_chk);
391 // Clean-up any dead code
392 for (uint i3 = 0; i3 < old_tst->req(); i3++)
393 old_tst->set_req(i3, NULL);
395 cfg->latency_from_uses(nul_chk);
396 cfg->latency_from_uses(best);
397 }
400 //------------------------------select-----------------------------------------
401 // Select a nice fellow from the worklist to schedule next. If there is only
402 // one choice, then use it. Projections take top priority for correctness
403 // reasons - if I see a projection, then it is next. There are a number of
404 // other special cases, for instructions that consume condition codes, et al.
405 // These are chosen immediately. Some instructions are required to immediately
406 // precede the last instruction in the block, and these are taken last. Of the
407 // remaining cases (most), choose the instruction with the greatest latency
408 // (that is, the most number of pseudo-cycles required to the end of the
409 // routine). If there is a tie, choose the instruction with the most inputs.
410 Node *Block::select(PhaseCFG *cfg, Node_List &worklist, GrowableArray<int> &ready_cnt, VectorSet &next_call, uint sched_slot) {
412 // If only a single entry on the stack, use it
413 uint cnt = worklist.size();
414 if (cnt == 1) {
415 Node *n = worklist[0];
416 worklist.map(0,worklist.pop());
417 return n;
418 }
420 uint choice = 0; // Bigger is most important
421 uint latency = 0; // Bigger is scheduled first
422 uint score = 0; // Bigger is better
423 int idx = -1; // Index in worklist
424 int cand_cnt = 0; // Candidate count
426 for( uint i=0; i<cnt; i++ ) { // Inspect entire worklist
427 // Order in worklist is used to break ties.
428 // See caller for how this is used to delay scheduling
429 // of induction variable increments to after the other
430 // uses of the phi are scheduled.
431 Node *n = worklist[i]; // Get Node on worklist
433 int iop = n->is_Mach() ? n->as_Mach()->ideal_Opcode() : 0;
434 if( n->is_Proj() || // Projections always win
435 n->Opcode()== Op_Con || // So does constant 'Top'
436 iop == Op_CreateEx || // Create-exception must start block
437 iop == Op_CheckCastPP
438 ) {
439 worklist.map(i,worklist.pop());
440 return n;
441 }
443 // Final call in a block must be adjacent to 'catch'
444 Node *e = end();
445 if( e->is_Catch() && e->in(0)->in(0) == n )
446 continue;
448 // Memory op for an implicit null check has to be at the end of the block
449 if( e->is_MachNullCheck() && e->in(1) == n )
450 continue;
452 // Schedule IV increment last.
453 if (e->is_Mach() && e->as_Mach()->ideal_Opcode() == Op_CountedLoopEnd &&
454 e->in(1)->in(1) == n && n->is_iteratively_computed())
455 continue;
457 uint n_choice = 2;
459 // See if this instruction is consumed by a branch. If so, then (as the
460 // branch is the last instruction in the basic block) force it to the
461 // end of the basic block
462 if ( must_clone[iop] ) {
463 // See if any use is a branch
464 bool found_machif = false;
466 for (DUIterator_Fast jmax, j = n->fast_outs(jmax); j < jmax; j++) {
467 Node* use = n->fast_out(j);
469 // The use is a conditional branch, make them adjacent
470 if (use->is_MachIf() && cfg->_bbs[use->_idx]==this ) {
471 found_machif = true;
472 break;
473 }
475 // More than this instruction pending for successor to be ready,
476 // don't choose this if other opportunities are ready
477 if (ready_cnt.at(use->_idx) > 1)
478 n_choice = 1;
479 }
481 // loop terminated, prefer not to use this instruction
482 if (found_machif)
483 continue;
484 }
486 // See if this has a predecessor that is "must_clone", i.e. sets the
487 // condition code. If so, choose this first
488 for (uint j = 0; j < n->req() ; j++) {
489 Node *inn = n->in(j);
490 if (inn) {
491 if (inn->is_Mach() && must_clone[inn->as_Mach()->ideal_Opcode()] ) {
492 n_choice = 3;
493 break;
494 }
495 }
496 }
498 // MachTemps should be scheduled last so they are near their uses
499 if (n->is_MachTemp()) {
500 n_choice = 1;
501 }
503 uint n_latency = cfg->_node_latency->at_grow(n->_idx);
504 uint n_score = n->req(); // Many inputs get high score to break ties
506 // Keep best latency found
507 cand_cnt++;
508 if (choice < n_choice ||
509 (choice == n_choice &&
510 ((StressLCM && Compile::randomized_select(cand_cnt)) ||
511 (!StressLCM &&
512 (latency < n_latency ||
513 (latency == n_latency &&
514 (score < n_score))))))) {
515 choice = n_choice;
516 latency = n_latency;
517 score = n_score;
518 idx = i; // Also keep index in worklist
519 }
520 } // End of for all ready nodes in worklist
522 assert(idx >= 0, "index should be set");
523 Node *n = worklist[(uint)idx]; // Get the winner
525 worklist.map((uint)idx, worklist.pop()); // Compress worklist
526 return n;
527 }
530 //------------------------------set_next_call----------------------------------
531 void Block::set_next_call( Node *n, VectorSet &next_call, Block_Array &bbs ) {
532 if( next_call.test_set(n->_idx) ) return;
533 for( uint i=0; i<n->len(); i++ ) {
534 Node *m = n->in(i);
535 if( !m ) continue; // must see all nodes in block that precede call
536 if( bbs[m->_idx] == this )
537 set_next_call( m, next_call, bbs );
538 }
539 }
541 //------------------------------needed_for_next_call---------------------------
542 // Set the flag 'next_call' for each Node that is needed for the next call to
543 // be scheduled. This flag lets me bias scheduling so Nodes needed for the
544 // next subroutine call get priority - basically it moves things NOT needed
545 // for the next call till after the call. This prevents me from trying to
546 // carry lots of stuff live across a call.
547 void Block::needed_for_next_call(Node *this_call, VectorSet &next_call, Block_Array &bbs) {
548 // Find the next control-defining Node in this block
549 Node* call = NULL;
550 for (DUIterator_Fast imax, i = this_call->fast_outs(imax); i < imax; i++) {
551 Node* m = this_call->fast_out(i);
552 if( bbs[m->_idx] == this && // Local-block user
553 m != this_call && // Not self-start node
554 m->is_MachCall() )
555 call = m;
556 break;
557 }
558 if (call == NULL) return; // No next call (e.g., block end is near)
559 // Set next-call for all inputs to this call
560 set_next_call(call, next_call, bbs);
561 }
563 //------------------------------add_call_kills-------------------------------------
564 void Block::add_call_kills(MachProjNode *proj, RegMask& regs, const char* save_policy, bool exclude_soe) {
565 // Fill in the kill mask for the call
566 for( OptoReg::Name r = OptoReg::Name(0); r < _last_Mach_Reg; r=OptoReg::add(r,1) ) {
567 if( !regs.Member(r) ) { // Not already defined by the call
568 // Save-on-call register?
569 if ((save_policy[r] == 'C') ||
570 (save_policy[r] == 'A') ||
571 ((save_policy[r] == 'E') && exclude_soe)) {
572 proj->_rout.Insert(r);
573 }
574 }
575 }
576 }
579 //------------------------------sched_call-------------------------------------
580 uint Block::sched_call( Matcher &matcher, Block_Array &bbs, uint node_cnt, Node_List &worklist, GrowableArray<int> &ready_cnt, MachCallNode *mcall, VectorSet &next_call ) {
581 RegMask regs;
583 // Schedule all the users of the call right now. All the users are
584 // projection Nodes, so they must be scheduled next to the call.
585 // Collect all the defined registers.
586 for (DUIterator_Fast imax, i = mcall->fast_outs(imax); i < imax; i++) {
587 Node* n = mcall->fast_out(i);
588 assert( n->is_MachProj(), "" );
589 int n_cnt = ready_cnt.at(n->_idx)-1;
590 ready_cnt.at_put(n->_idx, n_cnt);
591 assert( n_cnt == 0, "" );
592 // Schedule next to call
593 _nodes.map(node_cnt++, n);
594 // Collect defined registers
595 regs.OR(n->out_RegMask());
596 // Check for scheduling the next control-definer
597 if( n->bottom_type() == Type::CONTROL )
598 // Warm up next pile of heuristic bits
599 needed_for_next_call(n, next_call, bbs);
601 // Children of projections are now all ready
602 for (DUIterator_Fast jmax, j = n->fast_outs(jmax); j < jmax; j++) {
603 Node* m = n->fast_out(j); // Get user
604 if( bbs[m->_idx] != this ) continue;
605 if( m->is_Phi() ) continue;
606 int m_cnt = ready_cnt.at(m->_idx)-1;
607 ready_cnt.at_put(m->_idx, m_cnt);
608 if( m_cnt == 0 )
609 worklist.push(m);
610 }
612 }
614 // Act as if the call defines the Frame Pointer.
615 // Certainly the FP is alive and well after the call.
616 regs.Insert(matcher.c_frame_pointer());
618 // Set all registers killed and not already defined by the call.
619 uint r_cnt = mcall->tf()->range()->cnt();
620 int op = mcall->ideal_Opcode();
621 MachProjNode *proj = new (matcher.C) MachProjNode( mcall, r_cnt+1, RegMask::Empty, MachProjNode::fat_proj );
622 bbs.map(proj->_idx,this);
623 _nodes.insert(node_cnt++, proj);
625 // Select the right register save policy.
626 const char * save_policy;
627 switch (op) {
628 case Op_CallRuntime:
629 case Op_CallLeaf:
630 case Op_CallLeafNoFP:
631 // Calling C code so use C calling convention
632 save_policy = matcher._c_reg_save_policy;
633 break;
635 case Op_CallStaticJava:
636 case Op_CallDynamicJava:
637 // Calling Java code so use Java calling convention
638 save_policy = matcher._register_save_policy;
639 break;
641 default:
642 ShouldNotReachHere();
643 }
645 // When using CallRuntime mark SOE registers as killed by the call
646 // so values that could show up in the RegisterMap aren't live in a
647 // callee saved register since the register wouldn't know where to
648 // find them. CallLeaf and CallLeafNoFP are ok because they can't
649 // have debug info on them. Strictly speaking this only needs to be
650 // done for oops since idealreg2debugmask takes care of debug info
651 // references but there no way to handle oops differently than other
652 // pointers as far as the kill mask goes.
653 bool exclude_soe = op == Op_CallRuntime;
655 // If the call is a MethodHandle invoke, we need to exclude the
656 // register which is used to save the SP value over MH invokes from
657 // the mask. Otherwise this register could be used for
658 // deoptimization information.
659 if (op == Op_CallStaticJava) {
660 MachCallStaticJavaNode* mcallstaticjava = (MachCallStaticJavaNode*) mcall;
661 if (mcallstaticjava->_method_handle_invoke)
662 proj->_rout.OR(Matcher::method_handle_invoke_SP_save_mask());
663 }
665 add_call_kills(proj, regs, save_policy, exclude_soe);
667 return node_cnt;
668 }
671 //------------------------------schedule_local---------------------------------
672 // Topological sort within a block. Someday become a real scheduler.
673 bool Block::schedule_local(PhaseCFG *cfg, Matcher &matcher, GrowableArray<int> &ready_cnt, VectorSet &next_call) {
674 // Already "sorted" are the block start Node (as the first entry), and
675 // the block-ending Node and any trailing control projections. We leave
676 // these alone. PhiNodes and ParmNodes are made to follow the block start
677 // Node. Everything else gets topo-sorted.
679 #ifndef PRODUCT
680 if (cfg->trace_opto_pipelining()) {
681 tty->print_cr("# --- schedule_local B%d, before: ---", _pre_order);
682 for (uint i = 0;i < _nodes.size();i++) {
683 tty->print("# ");
684 _nodes[i]->fast_dump();
685 }
686 tty->print_cr("#");
687 }
688 #endif
690 // RootNode is already sorted
691 if( _nodes.size() == 1 ) return true;
693 // Move PhiNodes and ParmNodes from 1 to cnt up to the start
694 uint node_cnt = end_idx();
695 uint phi_cnt = 1;
696 uint i;
697 for( i = 1; i<node_cnt; i++ ) { // Scan for Phi
698 Node *n = _nodes[i];
699 if( n->is_Phi() || // Found a PhiNode or ParmNode
700 (n->is_Proj() && n->in(0) == head()) ) {
701 // Move guy at 'phi_cnt' to the end; makes a hole at phi_cnt
702 _nodes.map(i,_nodes[phi_cnt]);
703 _nodes.map(phi_cnt++,n); // swap Phi/Parm up front
704 } else { // All others
705 // Count block-local inputs to 'n'
706 uint cnt = n->len(); // Input count
707 uint local = 0;
708 for( uint j=0; j<cnt; j++ ) {
709 Node *m = n->in(j);
710 if( m && cfg->_bbs[m->_idx] == this && !m->is_top() )
711 local++; // One more block-local input
712 }
713 ready_cnt.at_put(n->_idx, local); // Count em up
715 #ifdef ASSERT
716 if( UseConcMarkSweepGC || UseG1GC ) {
717 if( n->is_Mach() && n->as_Mach()->ideal_Opcode() == Op_StoreCM ) {
718 // Check the precedence edges
719 for (uint prec = n->req(); prec < n->len(); prec++) {
720 Node* oop_store = n->in(prec);
721 if (oop_store != NULL) {
722 assert(cfg->_bbs[oop_store->_idx]->_dom_depth <= this->_dom_depth, "oop_store must dominate card-mark");
723 }
724 }
725 }
726 }
727 #endif
729 // A few node types require changing a required edge to a precedence edge
730 // before allocation.
731 if( n->is_Mach() && n->req() > TypeFunc::Parms &&
732 (n->as_Mach()->ideal_Opcode() == Op_MemBarAcquire ||
733 n->as_Mach()->ideal_Opcode() == Op_MemBarVolatile) ) {
734 // MemBarAcquire could be created without Precedent edge.
735 // del_req() replaces the specified edge with the last input edge
736 // and then removes the last edge. If the specified edge > number of
737 // edges the last edge will be moved outside of the input edges array
738 // and the edge will be lost. This is why this code should be
739 // executed only when Precedent (== TypeFunc::Parms) edge is present.
740 Node *x = n->in(TypeFunc::Parms);
741 n->del_req(TypeFunc::Parms);
742 n->add_prec(x);
743 }
744 }
745 }
746 for(uint i2=i; i2<_nodes.size(); i2++ ) // Trailing guys get zapped count
747 ready_cnt.at_put(_nodes[i2]->_idx, 0);
749 // All the prescheduled guys do not hold back internal nodes
750 uint i3;
751 for(i3 = 0; i3<phi_cnt; i3++ ) { // For all pre-scheduled
752 Node *n = _nodes[i3]; // Get pre-scheduled
753 for (DUIterator_Fast jmax, j = n->fast_outs(jmax); j < jmax; j++) {
754 Node* m = n->fast_out(j);
755 if( cfg->_bbs[m->_idx] ==this ) { // Local-block user
756 int m_cnt = ready_cnt.at(m->_idx)-1;
757 ready_cnt.at_put(m->_idx, m_cnt); // Fix ready count
758 }
759 }
760 }
762 Node_List delay;
763 // Make a worklist
764 Node_List worklist;
765 for(uint i4=i3; i4<node_cnt; i4++ ) { // Put ready guys on worklist
766 Node *m = _nodes[i4];
767 if( !ready_cnt.at(m->_idx) ) { // Zero ready count?
768 if (m->is_iteratively_computed()) {
769 // Push induction variable increments last to allow other uses
770 // of the phi to be scheduled first. The select() method breaks
771 // ties in scheduling by worklist order.
772 delay.push(m);
773 } else if (m->is_Mach() && m->as_Mach()->ideal_Opcode() == Op_CreateEx) {
774 // Force the CreateEx to the top of the list so it's processed
775 // first and ends up at the start of the block.
776 worklist.insert(0, m);
777 } else {
778 worklist.push(m); // Then on to worklist!
779 }
780 }
781 }
782 while (delay.size()) {
783 Node* d = delay.pop();
784 worklist.push(d);
785 }
787 // Warm up the 'next_call' heuristic bits
788 needed_for_next_call(_nodes[0], next_call, cfg->_bbs);
790 #ifndef PRODUCT
791 if (cfg->trace_opto_pipelining()) {
792 for (uint j=0; j<_nodes.size(); j++) {
793 Node *n = _nodes[j];
794 int idx = n->_idx;
795 tty->print("# ready cnt:%3d ", ready_cnt.at(idx));
796 tty->print("latency:%3d ", cfg->_node_latency->at_grow(idx));
797 tty->print("%4d: %s\n", idx, n->Name());
798 }
799 }
800 #endif
802 uint max_idx = (uint)ready_cnt.length();
803 // Pull from worklist and schedule
804 while( worklist.size() ) { // Worklist is not ready
806 #ifndef PRODUCT
807 if (cfg->trace_opto_pipelining()) {
808 tty->print("# ready list:");
809 for( uint i=0; i<worklist.size(); i++ ) { // Inspect entire worklist
810 Node *n = worklist[i]; // Get Node on worklist
811 tty->print(" %d", n->_idx);
812 }
813 tty->cr();
814 }
815 #endif
817 // Select and pop a ready guy from worklist
818 Node* n = select(cfg, worklist, ready_cnt, next_call, phi_cnt);
819 _nodes.map(phi_cnt++,n); // Schedule him next
821 #ifndef PRODUCT
822 if (cfg->trace_opto_pipelining()) {
823 tty->print("# select %d: %s", n->_idx, n->Name());
824 tty->print(", latency:%d", cfg->_node_latency->at_grow(n->_idx));
825 n->dump();
826 if (Verbose) {
827 tty->print("# ready list:");
828 for( uint i=0; i<worklist.size(); i++ ) { // Inspect entire worklist
829 Node *n = worklist[i]; // Get Node on worklist
830 tty->print(" %d", n->_idx);
831 }
832 tty->cr();
833 }
834 }
836 #endif
837 if( n->is_MachCall() ) {
838 MachCallNode *mcall = n->as_MachCall();
839 phi_cnt = sched_call(matcher, cfg->_bbs, phi_cnt, worklist, ready_cnt, mcall, next_call);
840 continue;
841 }
843 if (n->is_Mach() && n->as_Mach()->has_call()) {
844 RegMask regs;
845 regs.Insert(matcher.c_frame_pointer());
846 regs.OR(n->out_RegMask());
848 MachProjNode *proj = new (matcher.C) MachProjNode( n, 1, RegMask::Empty, MachProjNode::fat_proj );
849 cfg->_bbs.map(proj->_idx,this);
850 _nodes.insert(phi_cnt++, proj);
852 add_call_kills(proj, regs, matcher._c_reg_save_policy, false);
853 }
855 // Children are now all ready
856 for (DUIterator_Fast i5max, i5 = n->fast_outs(i5max); i5 < i5max; i5++) {
857 Node* m = n->fast_out(i5); // Get user
858 if( cfg->_bbs[m->_idx] != this ) continue;
859 if( m->is_Phi() ) continue;
860 if (m->_idx >= max_idx) { // new node, skip it
861 assert(m->is_MachProj() && n->is_Mach() && n->as_Mach()->has_call(), "unexpected node types");
862 continue;
863 }
864 int m_cnt = ready_cnt.at(m->_idx)-1;
865 ready_cnt.at_put(m->_idx, m_cnt);
866 if( m_cnt == 0 )
867 worklist.push(m);
868 }
869 }
871 if( phi_cnt != end_idx() ) {
872 // did not schedule all. Retry, Bailout, or Die
873 Compile* C = matcher.C;
874 if (C->subsume_loads() == true && !C->failing()) {
875 // Retry with subsume_loads == false
876 // If this is the first failure, the sentinel string will "stick"
877 // to the Compile object, and the C2Compiler will see it and retry.
878 C->record_failure(C2Compiler::retry_no_subsuming_loads());
879 }
880 // assert( phi_cnt == end_idx(), "did not schedule all" );
881 return false;
882 }
884 #ifndef PRODUCT
885 if (cfg->trace_opto_pipelining()) {
886 tty->print_cr("#");
887 tty->print_cr("# after schedule_local");
888 for (uint i = 0;i < _nodes.size();i++) {
889 tty->print("# ");
890 _nodes[i]->fast_dump();
891 }
892 tty->cr();
893 }
894 #endif
897 return true;
898 }
900 //--------------------------catch_cleanup_fix_all_inputs-----------------------
901 static void catch_cleanup_fix_all_inputs(Node *use, Node *old_def, Node *new_def) {
902 for (uint l = 0; l < use->len(); l++) {
903 if (use->in(l) == old_def) {
904 if (l < use->req()) {
905 use->set_req(l, new_def);
906 } else {
907 use->rm_prec(l);
908 use->add_prec(new_def);
909 l--;
910 }
911 }
912 }
913 }
915 //------------------------------catch_cleanup_find_cloned_def------------------
916 static Node *catch_cleanup_find_cloned_def(Block *use_blk, Node *def, Block *def_blk, Block_Array &bbs, int n_clone_idx) {
917 assert( use_blk != def_blk, "Inter-block cleanup only");
919 // The use is some block below the Catch. Find and return the clone of the def
920 // that dominates the use. If there is no clone in a dominating block, then
921 // create a phi for the def in a dominating block.
923 // Find which successor block dominates this use. The successor
924 // blocks must all be single-entry (from the Catch only; I will have
925 // split blocks to make this so), hence they all dominate.
926 while( use_blk->_dom_depth > def_blk->_dom_depth+1 )
927 use_blk = use_blk->_idom;
929 // Find the successor
930 Node *fixup = NULL;
932 uint j;
933 for( j = 0; j < def_blk->_num_succs; j++ )
934 if( use_blk == def_blk->_succs[j] )
935 break;
937 if( j == def_blk->_num_succs ) {
938 // Block at same level in dom-tree is not a successor. It needs a
939 // PhiNode, the PhiNode uses from the def and IT's uses need fixup.
940 Node_Array inputs = new Node_List(Thread::current()->resource_area());
941 for(uint k = 1; k < use_blk->num_preds(); k++) {
942 inputs.map(k, catch_cleanup_find_cloned_def(bbs[use_blk->pred(k)->_idx], def, def_blk, bbs, n_clone_idx));
943 }
945 // Check to see if the use_blk already has an identical phi inserted.
946 // If it exists, it will be at the first position since all uses of a
947 // def are processed together.
948 Node *phi = use_blk->_nodes[1];
949 if( phi->is_Phi() ) {
950 fixup = phi;
951 for (uint k = 1; k < use_blk->num_preds(); k++) {
952 if (phi->in(k) != inputs[k]) {
953 // Not a match
954 fixup = NULL;
955 break;
956 }
957 }
958 }
960 // If an existing PhiNode was not found, make a new one.
961 if (fixup == NULL) {
962 Node *new_phi = PhiNode::make(use_blk->head(), def);
963 use_blk->_nodes.insert(1, new_phi);
964 bbs.map(new_phi->_idx, use_blk);
965 for (uint k = 1; k < use_blk->num_preds(); k++) {
966 new_phi->set_req(k, inputs[k]);
967 }
968 fixup = new_phi;
969 }
971 } else {
972 // Found the use just below the Catch. Make it use the clone.
973 fixup = use_blk->_nodes[n_clone_idx];
974 }
976 return fixup;
977 }
979 //--------------------------catch_cleanup_intra_block--------------------------
980 // Fix all input edges in use that reference "def". The use is in the same
981 // block as the def and both have been cloned in each successor block.
982 static void catch_cleanup_intra_block(Node *use, Node *def, Block *blk, int beg, int n_clone_idx) {
984 // Both the use and def have been cloned. For each successor block,
985 // get the clone of the use, and make its input the clone of the def
986 // found in that block.
988 uint use_idx = blk->find_node(use);
989 uint offset_idx = use_idx - beg;
990 for( uint k = 0; k < blk->_num_succs; k++ ) {
991 // Get clone in each successor block
992 Block *sb = blk->_succs[k];
993 Node *clone = sb->_nodes[offset_idx+1];
994 assert( clone->Opcode() == use->Opcode(), "" );
996 // Make use-clone reference the def-clone
997 catch_cleanup_fix_all_inputs(clone, def, sb->_nodes[n_clone_idx]);
998 }
999 }
1001 //------------------------------catch_cleanup_inter_block---------------------
1002 // Fix all input edges in use that reference "def". The use is in a different
1003 // block than the def.
1004 static void catch_cleanup_inter_block(Node *use, Block *use_blk, Node *def, Block *def_blk, Block_Array &bbs, int n_clone_idx) {
1005 if( !use_blk ) return; // Can happen if the use is a precedence edge
1007 Node *new_def = catch_cleanup_find_cloned_def(use_blk, def, def_blk, bbs, n_clone_idx);
1008 catch_cleanup_fix_all_inputs(use, def, new_def);
1009 }
1011 //------------------------------call_catch_cleanup-----------------------------
1012 // If we inserted any instructions between a Call and his CatchNode,
1013 // clone the instructions on all paths below the Catch.
1014 void Block::call_catch_cleanup(Block_Array &bbs, Compile* C) {
1016 // End of region to clone
1017 uint end = end_idx();
1018 if( !_nodes[end]->is_Catch() ) return;
1019 // Start of region to clone
1020 uint beg = end;
1021 while(!_nodes[beg-1]->is_MachProj() ||
1022 !_nodes[beg-1]->in(0)->is_MachCall() ) {
1023 beg--;
1024 assert(beg > 0,"Catch cleanup walking beyond block boundary");
1025 }
1026 // Range of inserted instructions is [beg, end)
1027 if( beg == end ) return;
1029 // Clone along all Catch output paths. Clone area between the 'beg' and
1030 // 'end' indices.
1031 for( uint i = 0; i < _num_succs; i++ ) {
1032 Block *sb = _succs[i];
1033 // Clone the entire area; ignoring the edge fixup for now.
1034 for( uint j = end; j > beg; j-- ) {
1035 // It is safe here to clone a node with anti_dependence
1036 // since clones dominate on each path.
1037 Node *clone = _nodes[j-1]->clone();
1038 sb->_nodes.insert( 1, clone );
1039 bbs.map(clone->_idx,sb);
1040 }
1041 }
1044 // Fixup edges. Check the def-use info per cloned Node
1045 for(uint i2 = beg; i2 < end; i2++ ) {
1046 uint n_clone_idx = i2-beg+1; // Index of clone of n in each successor block
1047 Node *n = _nodes[i2]; // Node that got cloned
1048 // Need DU safe iterator because of edge manipulation in calls.
1049 Unique_Node_List *out = new Unique_Node_List(Thread::current()->resource_area());
1050 for (DUIterator_Fast j1max, j1 = n->fast_outs(j1max); j1 < j1max; j1++) {
1051 out->push(n->fast_out(j1));
1052 }
1053 uint max = out->size();
1054 for (uint j = 0; j < max; j++) {// For all users
1055 Node *use = out->pop();
1056 Block *buse = bbs[use->_idx];
1057 if( use->is_Phi() ) {
1058 for( uint k = 1; k < use->req(); k++ )
1059 if( use->in(k) == n ) {
1060 Node *fixup = catch_cleanup_find_cloned_def(bbs[buse->pred(k)->_idx], n, this, bbs, n_clone_idx);
1061 use->set_req(k, fixup);
1062 }
1063 } else {
1064 if (this == buse) {
1065 catch_cleanup_intra_block(use, n, this, beg, n_clone_idx);
1066 } else {
1067 catch_cleanup_inter_block(use, buse, n, this, bbs, n_clone_idx);
1068 }
1069 }
1070 } // End for all users
1072 } // End of for all Nodes in cloned area
1074 // Remove the now-dead cloned ops
1075 for(uint i3 = beg; i3 < end; i3++ ) {
1076 _nodes[beg]->disconnect_inputs(NULL, C);
1077 _nodes.remove(beg);
1078 }
1080 // If the successor blocks have a CreateEx node, move it back to the top
1081 for(uint i4 = 0; i4 < _num_succs; i4++ ) {
1082 Block *sb = _succs[i4];
1083 uint new_cnt = end - beg;
1084 // Remove any newly created, but dead, nodes.
1085 for( uint j = new_cnt; j > 0; j-- ) {
1086 Node *n = sb->_nodes[j];
1087 if (n->outcnt() == 0 &&
1088 (!n->is_Proj() || n->as_Proj()->in(0)->outcnt() == 1) ){
1089 n->disconnect_inputs(NULL, C);
1090 sb->_nodes.remove(j);
1091 new_cnt--;
1092 }
1093 }
1094 // If any newly created nodes remain, move the CreateEx node to the top
1095 if (new_cnt > 0) {
1096 Node *cex = sb->_nodes[1+new_cnt];
1097 if( cex->is_Mach() && cex->as_Mach()->ideal_Opcode() == Op_CreateEx ) {
1098 sb->_nodes.remove(1+new_cnt);
1099 sb->_nodes.insert(1,cex);
1100 }
1101 }
1102 }
1103 }