1 /*
  2  * Copyright (c) 1998, 2020, 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 #include "precompiled.hpp"
 26 #include "memory/allocation.inline.hpp"
 27 #include "memory/resourceArea.hpp"
 28 #include "opto/chaitin.hpp"
 29 #include "opto/machnode.hpp"
 30 
 31 // See if this register (or pairs, or vector) already contains the value.
 32 static bool register_contains_value(Node* val, OptoReg::Name reg, int n_regs,
 33                                     Node_List& value) {
 34   for (int i = 0; i < n_regs; i++) {
 35     OptoReg::Name nreg = OptoReg::add(reg,-i);
 36     if (value[nreg] != val)
 37       return false;
 38   }
 39   return true;
 40 }
 41 
 42 //---------------------------may_be_copy_of_callee-----------------------------
 43 // Check to see if we can possibly be a copy of a callee-save value.
 44 bool PhaseChaitin::may_be_copy_of_callee( Node *def ) const {
 45   // Short circuit if there are no callee save registers
 46   if (_matcher.number_of_saved_registers() == 0) return false;
 47 
 48   // Expect only a spill-down and reload on exit for callee-save spills.
 49   // Chains of copies cannot be deep.
 50   // 5008997 - This is wishful thinking. Register allocator seems to
 51   // be splitting live ranges for callee save registers to such
 52   // an extent that in large methods the chains can be very long
 53   // (50+). The conservative answer is to return true if we don't
 54   // know as this prevents optimizations from occurring.
 55 
 56   const int limit = 60;
 57   int i;
 58   for( i=0; i < limit; i++ ) {
 59     if( def->is_Proj() && def->in(0)->is_Start() &&
 60         _matcher.is_save_on_entry(lrgs(_lrg_map.live_range_id(def)).reg()))
 61       return true;              // Direct use of callee-save proj
 62     if( def->is_Copy() )        // Copies carry value through
 63       def = def->in(def->is_Copy());
 64     else if( def->is_Phi() )    // Phis can merge it from any direction
 65       def = def->in(1);
 66     else
 67       break;
 68     guarantee(def != NULL, "must not resurrect dead copy");
 69   }
 70   // If we reached the end and didn't find a callee save proj
 71   // then this may be a callee save proj so we return true
 72   // as the conservative answer. If we didn't reach then end
 73   // we must have discovered that it was not a callee save
 74   // else we would have returned.
 75   return i == limit;
 76 }
 77 
 78 //------------------------------yank-----------------------------------
 79 // Helper function for yank_if_dead
 80 int PhaseChaitin::yank( Node *old, Block *current_block, Node_List *value, Node_List *regnd ) {
 81   int blk_adjust=0;
 82   Block *oldb = _cfg.get_block_for_node(old);
 83   oldb->find_remove(old);
 84   // Count 1 if deleting an instruction from the current block
 85   if (oldb == current_block) {
 86     blk_adjust++;
 87   }
 88   _cfg.unmap_node_from_block(old);
 89   OptoReg::Name old_reg = lrgs(_lrg_map.live_range_id(old)).reg();
 90   if( regnd && (*regnd)[old_reg]==old ) { // Instruction is currently available?
 91     value->map(old_reg,NULL);  // Yank from value/regnd maps
 92     regnd->map(old_reg,NULL);  // This register's value is now unknown
 93   }
 94   return blk_adjust;
 95 }
 96 
 97 #ifdef ASSERT
 98 static bool expected_yanked_node(Node *old, Node *orig_old) {
 99   // This code is expected only next original nodes:
100   // - load from constant table node which may have next data input nodes:
101   //     MachConstantBase, MachTemp, MachSpillCopy
102   // - Phi nodes that are considered Junk
103   // - load constant node which may have next data input nodes:
104   //     MachTemp, MachSpillCopy
105   // - MachSpillCopy
106   // - MachProj and Copy dead nodes
107   if (old->is_MachSpillCopy()) {
108     return true;
109   } else if (old->is_Con()) {
110     return true;
111   } else if (old->is_MachProj()) { // Dead kills projection of Con node
112     return (old == orig_old);
113   } else if (old->is_Copy()) {     // Dead copy of a callee-save value
114     return (old == orig_old);
115   } else if (old->is_MachTemp()) {
116     return orig_old->is_Con();
117   } else if (old->is_Phi()) { // Junk phi's
118     return true;
119   } else if (old->is_MachConstantBase()) {
120     return (orig_old->is_Con() && orig_old->is_MachConstant());
121   }
122   return false;
123 }
124 #endif
125 
126 //------------------------------yank_if_dead-----------------------------------
127 // Removed edges from 'old'.  Yank if dead.  Return adjustment counts to
128 // iterators in the current block.
129 int PhaseChaitin::yank_if_dead_recurse(Node *old, Node *orig_old, Block *current_block,
130                                        Node_List *value, Node_List *regnd) {
131   int blk_adjust=0;
132   if (old->outcnt() == 0 && old != C->top()) {
133 #ifdef ASSERT
134     if (!expected_yanked_node(old, orig_old)) {
135       tty->print_cr("==============================================");
136       tty->print_cr("orig_old:");
137       orig_old->dump();
138       tty->print_cr("old:");
139       old->dump();
140       assert(false, "unexpected yanked node");
141     }
142     if (old->is_Con())
143       orig_old = old; // Reset to satisfy expected nodes checks.
144 #endif
145     blk_adjust += yank(old, current_block, value, regnd);
146 
147     for (uint i = 1; i < old->req(); i++) {
148       Node* n = old->in(i);
149       if (n != NULL) {
150         old->set_req(i, NULL);
151         blk_adjust += yank_if_dead_recurse(n, orig_old, current_block, value, regnd);
152       }
153     }
154     // Disconnect control and remove precedence edges if any exist
155     old->disconnect_inputs(NULL, C);
156   }
157   return blk_adjust;
158 }
159 
160 //------------------------------use_prior_register-----------------------------
161 // Use the prior value instead of the current value, in an effort to make
162 // the current value go dead.  Return block iterator adjustment, in case
163 // we yank some instructions from this block.
164 int PhaseChaitin::use_prior_register( Node *n, uint idx, Node *def, Block *current_block, Node_List &value, Node_List &regnd ) {
165   // No effect?
166   if( def == n->in(idx) ) return 0;
167   // Def is currently dead and can be removed?  Do not resurrect
168   if( def->outcnt() == 0 ) return 0;
169 
170   // Not every pair of physical registers are assignment compatible,
171   // e.g. on sparc floating point registers are not assignable to integer
172   // registers.
173   const LRG &def_lrg = lrgs(_lrg_map.live_range_id(def));
174   OptoReg::Name def_reg = def_lrg.reg();
175   const RegMask &use_mask = n->in_RegMask(idx);
176   bool can_use = ( RegMask::can_represent(def_reg) ? (use_mask.Member(def_reg) != 0)
177                                                    : (use_mask.is_AllStack() != 0));
178   if (!RegMask::is_vector(def->ideal_reg())) {
179     // Check for a copy to or from a misaligned pair.
180     // It is workaround for a sparc with misaligned pairs.
181     can_use = can_use && !use_mask.is_misaligned_pair() && !def_lrg.mask().is_misaligned_pair();
182   }
183   if (!can_use)
184     return 0;
185 
186   // Capture the old def in case it goes dead...
187   Node *old = n->in(idx);
188 
189   // Save-on-call copies can only be elided if the entire copy chain can go
190   // away, lest we get the same callee-save value alive in 2 locations at
191   // once.  We check for the obvious trivial case here.  Although it can
192   // sometimes be elided with cooperation outside our scope, here we will just
193   // miss the opportunity.  :-(
194   if( may_be_copy_of_callee(def) ) {
195     if( old->outcnt() > 1 ) return 0; // We're the not last user
196     int idx = old->is_Copy();
197     assert( idx, "chain of copies being removed" );
198     Node *old2 = old->in(idx);  // Chain of copies
199     if( old2->outcnt() > 1 ) return 0; // old is not the last user
200     int idx2 = old2->is_Copy();
201     if( !idx2 ) return 0;       // Not a chain of 2 copies
202     if( def != old2->in(idx2) ) return 0; // Chain of exactly 2 copies
203   }
204 
205   // Use the new def
206   n->set_req(idx,def);
207   _post_alloc++;
208 
209   // Is old def now dead?  We successfully yanked a copy?
210   return yank_if_dead(old,current_block,&value,&regnd);
211 }
212 
213 
214 //------------------------------skip_copies------------------------------------
215 // Skip through any number of copies (that don't mod oop-i-ness)
216 Node *PhaseChaitin::skip_copies( Node *c ) {
217   int idx = c->is_Copy();
218   uint is_oop = lrgs(_lrg_map.live_range_id(c))._is_oop;
219   while (idx != 0) {
220     guarantee(c->in(idx) != NULL, "must not resurrect dead copy");
221     if (lrgs(_lrg_map.live_range_id(c->in(idx)))._is_oop != is_oop) {
222       break;  // casting copy, not the same value
223     }
224     c = c->in(idx);
225     idx = c->is_Copy();
226   }
227   return c;
228 }
229 
230 //------------------------------elide_copy-------------------------------------
231 // Remove (bypass) copies along Node n, edge k.
232 int PhaseChaitin::elide_copy( Node *n, int k, Block *current_block, Node_List &value, Node_List &regnd, bool can_change_regs ) {
233   int blk_adjust = 0;
234 
235   uint nk_idx = _lrg_map.live_range_id(n->in(k));
236   OptoReg::Name nk_reg = lrgs(nk_idx).reg();
237 
238   // Remove obvious same-register copies
239   Node *x = n->in(k);
240   int idx;
241   while( (idx=x->is_Copy()) != 0 ) {
242     Node *copy = x->in(idx);
243     guarantee(copy != NULL, "must not resurrect dead copy");
244     if(lrgs(_lrg_map.live_range_id(copy)).reg() != nk_reg) {
245       break;
246     }
247     blk_adjust += use_prior_register(n,k,copy,current_block,value,regnd);
248     if (n->in(k) != copy) {
249       break; // Failed for some cutout?
250     }
251     x = copy;                   // Progress, try again
252   }
253 
254   // Phis and 2-address instructions cannot change registers so easily - their
255   // outputs must match their input.
256   if( !can_change_regs )
257     return blk_adjust;          // Only check stupid copies!
258 
259   // Loop backedges won't have a value-mapping yet
260   if( &value == NULL ) return blk_adjust;
261 
262   // Skip through all copies to the _value_ being used.  Do not change from
263   // int to pointer.  This attempts to jump through a chain of copies, where
264   // intermediate copies might be illegal, i.e., value is stored down to stack
265   // then reloaded BUT survives in a register the whole way.
266   Node *val = skip_copies(n->in(k));
267   if (val == x) return blk_adjust; // No progress?
268 
269   uint val_idx = _lrg_map.live_range_id(val);
270   OptoReg::Name val_reg = lrgs(val_idx).reg();
271   int n_regs = RegMask::num_registers(val->ideal_reg(), lrgs(val_idx));
272 
273   // See if it happens to already be in the correct register!
274   // (either Phi's direct register, or the common case of the name
275   // never-clobbered original-def register)
276   if (register_contains_value(val, val_reg, n_regs, value)) {
277     blk_adjust += use_prior_register(n,k,regnd[val_reg],current_block,value,regnd);
278     if( n->in(k) == regnd[val_reg] ) // Success!  Quit trying
279       return blk_adjust;
280   }
281 
282   // See if we can skip the copy by changing registers.  Don't change from
283   // using a register to using the stack unless we know we can remove a
284   // copy-load.  Otherwise we might end up making a pile of Intel cisc-spill
285   // ops reading from memory instead of just loading once and using the
286   // register.
287 
288   // Also handle duplicate copies here.
289   const Type *t = val->is_Con() ? val->bottom_type() : NULL;
290 
291   // Scan all registers to see if this value is around already
292   for( uint reg = 0; reg < (uint)_max_reg; reg++ ) {
293     if (reg == (uint)nk_reg) {
294       // Found ourselves so check if there is only one user of this
295       // copy and keep on searching for a better copy if so.
296       bool ignore_self = true;
297       x = n->in(k);
298       DUIterator_Fast imax, i = x->fast_outs(imax);
299       Node* first = x->fast_out(i); i++;
300       while (i < imax && ignore_self) {
301         Node* use = x->fast_out(i); i++;
302         if (use != first) ignore_self = false;
303       }
304       if (ignore_self) continue;
305     }
306 
307     Node *vv = value[reg];
308     // For scalable register, number of registers may be inconsistent between
309     // "val_reg" and "reg". For example, when "val" resides in register
310     // but "reg" is located in stack.
311     if (lrgs(val_idx).is_scalable()) {
312       assert(val->ideal_reg() == Op_VecA, "scalable vector register");
313       if (OptoReg::is_stack(reg)) {
314         n_regs = lrgs(val_idx).scalable_reg_slots();
315       } else {
316         n_regs = RegMask::SlotsPerVecA;
317       }
318     }
319     if (n_regs > 1) { // Doubles and vectors check for aligned-adjacent set
320       uint last;
321       if (lrgs(val_idx).is_scalable()) {
322         assert(val->ideal_reg() == Op_VecA, "scalable vector register");
323         // For scalable vector register, regmask is always SlotsPerVecA bits aligned
324         last = RegMask::SlotsPerVecA - 1;
325       } else {
326         last = (n_regs-1); // Looking for the last part of a set
327       }
328       if ((reg&last) != last) continue; // Wrong part of a set
329       if (!register_contains_value(vv, reg, n_regs, value)) continue; // Different value
330     }
331     if( vv == val ||            // Got a direct hit?
332         (t && vv && vv->bottom_type() == t && vv->is_Mach() &&
333          vv->as_Mach()->rule() == val->as_Mach()->rule()) ) { // Or same constant?
334       assert( !n->is_Phi(), "cannot change registers at a Phi so easily" );
335       if( OptoReg::is_stack(nk_reg) || // CISC-loading from stack OR
336           OptoReg::is_reg(reg) || // turning into a register use OR
337           regnd[reg]->outcnt()==1 ) { // last use of a spill-load turns into a CISC use
338         blk_adjust += use_prior_register(n,k,regnd[reg],current_block,value,regnd);
339         if( n->in(k) == regnd[reg] ) // Success!  Quit trying
340           return blk_adjust;
341       } // End of if not degrading to a stack
342     } // End of if found value in another register
343   } // End of scan all machine registers
344   return blk_adjust;
345 }
346 
347 
348 //
349 // Check if nreg already contains the constant value val.  Normal copy
350 // elimination doesn't doesn't work on constants because multiple
351 // nodes can represent the same constant so the type and rule of the
352 // MachNode must be checked to ensure equivalence.
353 //
354 bool PhaseChaitin::eliminate_copy_of_constant(Node* val, Node* n,
355                                               Block *current_block,
356                                               Node_List& value, Node_List& regnd,
357                                               OptoReg::Name nreg, OptoReg::Name nreg2) {
358   if (value[nreg] != val && val->is_Con() &&
359       value[nreg] != NULL && value[nreg]->is_Con() &&
360       (nreg2 == OptoReg::Bad || value[nreg] == value[nreg2]) &&
361       value[nreg]->bottom_type() == val->bottom_type() &&
362       value[nreg]->as_Mach()->rule() == val->as_Mach()->rule()) {
363     // This code assumes that two MachNodes representing constants
364     // which have the same rule and the same bottom type will produce
365     // identical effects into a register.  This seems like it must be
366     // objectively true unless there are hidden inputs to the nodes
367     // but if that were to change this code would need to updated.
368     // Since they are equivalent the second one if redundant and can
369     // be removed.
370     //
371     // n will be replaced with the old value but n might have
372     // kills projections associated with it so remove them now so that
373     // yank_if_dead will be able to eliminate the copy once the uses
374     // have been transferred to the old[value].
375     for (DUIterator_Fast imax, i = n->fast_outs(imax); i < imax; i++) {
376       Node* use = n->fast_out(i);
377       if (use->is_Proj() && use->outcnt() == 0) {
378         // Kill projections have no users and one input
379         use->set_req(0, C->top());
380         yank_if_dead(use, current_block, &value, &regnd);
381         --i; --imax;
382       }
383     }
384     _post_alloc++;
385     return true;
386   }
387   return false;
388 }
389 
390 // The algorithms works as follows:
391 // We traverse the block top to bottom. possibly_merge_multidef() is invoked for every input edge k
392 // of the instruction n. We check to see if the input is a multidef lrg. If it is, we record the fact that we've
393 // seen a definition (coming as an input) and add that fact to the reg2defuse array. The array maps registers to their
394 // current reaching definitions (we track only multidefs though). With each definition we also associate the first
395 // instruction we saw use it. If we encounter the situation when we observe an def (an input) that is a part of the
396 // same lrg but is different from the previous seen def we merge the two with a MachMerge node and substitute
397 // all the uses that we've seen so far to use the merge. After that we keep replacing the new defs in the same lrg
398 // as they get encountered with the merge node and keep adding these defs to the merge inputs.
399 void PhaseChaitin::merge_multidefs() {
400   Compile::TracePhase tp("mergeMultidefs", &timers[_t_mergeMultidefs]);
401   ResourceMark rm;
402   // Keep track of the defs seen in registers and collect their uses in the block.
403   RegToDefUseMap reg2defuse(_max_reg, _max_reg, RegDefUse());
404   for (uint i = 0; i < _cfg.number_of_blocks(); i++) {
405     Block* block = _cfg.get_block(i);
406     for (uint j = 1; j < block->number_of_nodes(); j++) {
407       Node* n = block->get_node(j);
408       if (n->is_Phi()) continue;
409       for (uint k = 1; k < n->req(); k++) {
410         j += possibly_merge_multidef(n, k, block, reg2defuse);
411       }
412       // Null out the value produced by the instruction itself, since we're only interested in defs
413       // implicitly defined by the uses. We are actually interested in tracking only redefinitions
414       // of the multidef lrgs in the same register. For that matter it's enough to track changes in
415       // the base register only and ignore other effects of multi-register lrgs and fat projections.
416       // It is also ok to ignore defs coming from singledefs. After an implicit overwrite by one of
417       // those our register is guaranteed to be used by another lrg and we won't attempt to merge it.
418       uint lrg = _lrg_map.live_range_id(n);
419       if (lrg > 0 && lrgs(lrg).is_multidef()) {
420         OptoReg::Name reg = lrgs(lrg).reg();
421         reg2defuse.at(reg).clear();
422       }
423     }
424     // Clear reg->def->use tracking for the next block
425     for (int j = 0; j < reg2defuse.length(); j++) {
426       reg2defuse.at(j).clear();
427     }
428   }
429 }
430 
431 int PhaseChaitin::possibly_merge_multidef(Node *n, uint k, Block *block, RegToDefUseMap& reg2defuse) {
432   int blk_adjust = 0;
433 
434   uint lrg = _lrg_map.live_range_id(n->in(k));
435   if (lrg > 0 && lrgs(lrg).is_multidef()) {
436     OptoReg::Name reg = lrgs(lrg).reg();
437 
438     Node* def = reg2defuse.at(reg).def();
439     if (def != NULL && lrg == _lrg_map.live_range_id(def) && def != n->in(k)) {
440       // Same lrg but different node, we have to merge.
441       MachMergeNode* merge;
442       if (def->is_MachMerge()) { // is it already a merge?
443         merge = def->as_MachMerge();
444       } else {
445         merge = new MachMergeNode(def);
446 
447         // Insert the merge node into the block before the first use.
448         uint use_index = block->find_node(reg2defuse.at(reg).first_use());
449         block->insert_node(merge, use_index++);
450         _cfg.map_node_to_block(merge, block);
451 
452         // Let the allocator know about the new node, use the same lrg
453         _lrg_map.extend(merge->_idx, lrg);
454         blk_adjust++;
455 
456         // Fixup all the uses (there is at least one) that happened between the first
457         // use and before the current one.
458         for (; use_index < block->number_of_nodes(); use_index++) {
459           Node* use = block->get_node(use_index);
460           if (use == n) {
461             break;
462           }
463           use->replace_edge(def, merge);
464         }
465       }
466       if (merge->find_edge(n->in(k)) == -1) {
467         merge->add_req(n->in(k));
468       }
469       n->set_req(k, merge);
470     }
471 
472     // update the uses
473     reg2defuse.at(reg).update(n->in(k), n);
474   }
475 
476   return blk_adjust;
477 }
478 
479 
480 //------------------------------post_allocate_copy_removal---------------------
481 // Post-Allocation peephole copy removal.  We do this in 1 pass over the
482 // basic blocks.  We maintain a mapping of registers to Nodes (an  array of
483 // Nodes indexed by machine register or stack slot number).  NULL means that a
484 // register is not mapped to any Node.  We can (want to have!) have several
485 // registers map to the same Node.  We walk forward over the instructions
486 // updating the mapping as we go.  At merge points we force a NULL if we have
487 // to merge 2 different Nodes into the same register.  Phi functions will give
488 // us a new Node if there is a proper value merging.  Since the blocks are
489 // arranged in some RPO, we will visit all parent blocks before visiting any
490 // successor blocks (except at loops).
491 //
492 // If we find a Copy we look to see if the Copy's source register is a stack
493 // slot and that value has already been loaded into some machine register; if
494 // so we use machine register directly.  This turns a Load into a reg-reg
495 // Move.  We also look for reloads of identical constants.
496 //
497 // When we see a use from a reg-reg Copy, we will attempt to use the copy's
498 // source directly and make the copy go dead.
499 void PhaseChaitin::post_allocate_copy_removal() {
500   Compile::TracePhase tp("postAllocCopyRemoval", &timers[_t_postAllocCopyRemoval]);
501   ResourceMark rm;
502 
503   // Need a mapping from basic block Node_Lists.  We need a Node_List to
504   // map from register number to value-producing Node.
505   Node_List **blk2value = NEW_RESOURCE_ARRAY( Node_List *, _cfg.number_of_blocks() + 1);
506   memset(blk2value, 0, sizeof(Node_List*) * (_cfg.number_of_blocks() + 1));
507   // Need a mapping from basic block Node_Lists.  We need a Node_List to
508   // map from register number to register-defining Node.
509   Node_List **blk2regnd = NEW_RESOURCE_ARRAY( Node_List *, _cfg.number_of_blocks() + 1);
510   memset(blk2regnd, 0, sizeof(Node_List*) * (_cfg.number_of_blocks() + 1));
511 
512   // We keep unused Node_Lists on a free_list to avoid wasting
513   // memory.
514   GrowableArray<Node_List*> free_list = GrowableArray<Node_List*>(16);
515 
516   // For all blocks
517   for (uint i = 0; i < _cfg.number_of_blocks(); i++) {
518     uint j;
519     Block* block = _cfg.get_block(i);
520 
521     // Count of Phis in block
522     uint phi_dex;
523     for (phi_dex = 1; phi_dex < block->number_of_nodes(); phi_dex++) {
524       Node* phi = block->get_node(phi_dex);
525       if (!phi->is_Phi()) {
526         break;
527       }
528     }
529 
530     // If any predecessor has not been visited, we do not know the state
531     // of registers at the start.  Check for this, while updating copies
532     // along Phi input edges
533     bool missing_some_inputs = false;
534     Block *freed = NULL;
535     for (j = 1; j < block->num_preds(); j++) {
536       Block* pb = _cfg.get_block_for_node(block->pred(j));
537       // Remove copies along phi edges
538       for (uint k = 1; k < phi_dex; k++) {
539         elide_copy(block->get_node(k), j, block, *blk2value[pb->_pre_order], *blk2regnd[pb->_pre_order], false);
540       }
541       if (blk2value[pb->_pre_order]) { // Have a mapping on this edge?
542         // See if this predecessor's mappings have been used by everybody
543         // who wants them.  If so, free 'em.
544         uint k;
545         for (k = 0; k < pb->_num_succs; k++) {
546           Block* pbsucc = pb->_succs[k];
547           if (!blk2value[pbsucc->_pre_order] && pbsucc != block) {
548             break;              // Found a future user
549           }
550         }
551         if (k >= pb->_num_succs) { // No more uses, free!
552           freed = pb;           // Record last block freed
553           free_list.push(blk2value[pb->_pre_order]);
554           free_list.push(blk2regnd[pb->_pre_order]);
555         }
556       } else {                  // This block has unvisited (loopback) inputs
557         missing_some_inputs = true;
558       }
559     }
560 
561 
562     // Extract Node_List mappings.  If 'freed' is non-zero, we just popped
563     // 'freed's blocks off the list
564     Node_List &regnd = *(free_list.is_empty() ? new Node_List() : free_list.pop());
565     Node_List &value = *(free_list.is_empty() ? new Node_List() : free_list.pop());
566     assert( !freed || blk2value[freed->_pre_order] == &value, "" );
567     value.map(_max_reg,NULL);
568     regnd.map(_max_reg,NULL);
569     // Set mappings as OUR mappings
570     blk2value[block->_pre_order] = &value;
571     blk2regnd[block->_pre_order] = &regnd;
572 
573     // Initialize value & regnd for this block
574     if (missing_some_inputs) {
575       // Some predecessor has not yet been visited; zap map to empty
576       for (uint k = 0; k < (uint)_max_reg; k++) {
577         value.map(k,NULL);
578         regnd.map(k,NULL);
579       }
580     } else {
581       if( !freed ) {            // Didn't get a freebie prior block
582         // Must clone some data
583         freed = _cfg.get_block_for_node(block->pred(1));
584         Node_List &f_value = *blk2value[freed->_pre_order];
585         Node_List &f_regnd = *blk2regnd[freed->_pre_order];
586         for( uint k = 0; k < (uint)_max_reg; k++ ) {
587           value.map(k,f_value[k]);
588           regnd.map(k,f_regnd[k]);
589         }
590       }
591       // Merge all inputs together, setting to NULL any conflicts.
592       for (j = 1; j < block->num_preds(); j++) {
593         Block* pb = _cfg.get_block_for_node(block->pred(j));
594         if (pb == freed) {
595           continue; // Did self already via freelist
596         }
597         Node_List &p_regnd = *blk2regnd[pb->_pre_order];
598         for( uint k = 0; k < (uint)_max_reg; k++ ) {
599           if( regnd[k] != p_regnd[k] ) { // Conflict on reaching defs?
600             value.map(k,NULL); // Then no value handy
601             regnd.map(k,NULL);
602           }
603         }
604       }
605     }
606 
607     // For all Phi's
608     for (j = 1; j < phi_dex; j++) {
609       uint k;
610       Node *phi = block->get_node(j);
611       uint pidx = _lrg_map.live_range_id(phi);
612       OptoReg::Name preg = lrgs(pidx).reg();
613 
614       // Remove copies remaining on edges.  Check for junk phi.
615       Node *u = NULL;
616       for (k = 1; k < phi->req(); k++) {
617         Node *x = phi->in(k);
618         if( phi != x && u != x ) // Found a different input
619           u = u ? NodeSentinel : x; // Capture unique input, or NodeSentinel for 2nd input
620       }
621       if (u != NodeSentinel) {    // Junk Phi.  Remove
622         phi->replace_by(u);
623         j -= yank_if_dead(phi, block, &value, &regnd);
624         phi_dex--;
625         continue;
626       }
627       // Note that if value[pidx] exists, then we merged no new values here
628       // and the phi is useless.  This can happen even with the above phi
629       // removal for complex flows.  I cannot keep the better known value here
630       // because locally the phi appears to define a new merged value.  If I
631       // keep the better value then a copy of the phi, being unable to use the
632       // global flow analysis, can't "peek through" the phi to the original
633       // reaching value and so will act like it's defining a new value.  This
634       // can lead to situations where some uses are from the old and some from
635       // the new values.  Not illegal by itself but throws the over-strong
636       // assert in scheduling.
637       if( pidx ) {
638         value.map(preg,phi);
639         regnd.map(preg,phi);
640         int n_regs = RegMask::num_registers(phi->ideal_reg(), lrgs(pidx));
641         for (int l = 1; l < n_regs; l++) {
642           OptoReg::Name preg_lo = OptoReg::add(preg,-l);
643           value.map(preg_lo,phi);
644           regnd.map(preg_lo,phi);
645         }
646       }
647     }
648 
649     // For all remaining instructions
650     for (j = phi_dex; j < block->number_of_nodes(); j++) {
651       Node* n = block->get_node(j);
652 
653       if(n->outcnt() == 0 &&   // Dead?
654          n != C->top() &&      // (ignore TOP, it has no du info)
655          !n->is_Proj() ) {     // fat-proj kills
656         j -= yank_if_dead(n, block, &value, &regnd);
657         continue;
658       }
659 
660       // Improve reaching-def info.  Occasionally post-alloc's liveness gives
661       // up (at loop backedges, because we aren't doing a full flow pass).
662       // The presence of a live use essentially asserts that the use's def is
663       // alive and well at the use (or else the allocator fubar'd).  Take
664       // advantage of this info to set a reaching def for the use-reg.
665       uint k;
666       for (k = 1; k < n->req(); k++) {
667         Node *def = n->in(k);   // n->in(k) is a USE; def is the DEF for this USE
668         guarantee(def != NULL, "no disconnected nodes at this point");
669         uint useidx = _lrg_map.live_range_id(def); // useidx is the live range index for this USE
670 
671         if( useidx ) {
672           OptoReg::Name ureg = lrgs(useidx).reg();
673           if( !value[ureg] ) {
674             int idx;            // Skip occasional useless copy
675             while( (idx=def->is_Copy()) != 0 &&
676                    def->in(idx) != NULL &&  // NULL should not happen
677                    ureg == lrgs(_lrg_map.live_range_id(def->in(idx))).reg())
678               def = def->in(idx);
679             Node *valdef = skip_copies(def); // tighten up val through non-useless copies
680             value.map(ureg,valdef); // record improved reaching-def info
681             regnd.map(ureg,   def);
682             // Record other half of doubles
683             uint def_ideal_reg = def->ideal_reg();
684             int n_regs = RegMask::num_registers(def_ideal_reg, lrgs(_lrg_map.live_range_id(def)));
685             for (int l = 1; l < n_regs; l++) {
686               OptoReg::Name ureg_lo = OptoReg::add(ureg,-l);
687               if (!value[ureg_lo] &&
688                   (!RegMask::can_represent(ureg_lo) ||
689                    lrgs(useidx).mask().Member(ureg_lo))) { // Nearly always adjacent
690                 value.map(ureg_lo,valdef); // record improved reaching-def info
691                 regnd.map(ureg_lo,   def);
692               }
693             }
694           }
695         }
696       }
697 
698       const uint two_adr = n->is_Mach() ? n->as_Mach()->two_adr() : 0;
699 
700       // Remove copies along input edges
701       for (k = 1; k < n->req(); k++) {
702         j -= elide_copy(n, k, block, value, regnd, two_adr != k);
703       }
704 
705       // Unallocated Nodes define no registers
706       uint lidx = _lrg_map.live_range_id(n);
707       if (!lidx) {
708         continue;
709       }
710 
711       // Update the register defined by this instruction
712       OptoReg::Name nreg = lrgs(lidx).reg();
713       // Skip through all copies to the _value_ being defined.
714       // Do not change from int to pointer
715       Node *val = skip_copies(n);
716 
717       // Clear out a dead definition before starting so that the
718       // elimination code doesn't have to guard against it.  The
719       // definition could in fact be a kill projection with a count of
720       // 0 which is safe but since those are uninteresting for copy
721       // elimination just delete them as well.
722       if (regnd[nreg] != NULL && regnd[nreg]->outcnt() == 0) {
723         regnd.map(nreg, NULL);
724         value.map(nreg, NULL);
725       }
726 
727       uint n_ideal_reg = n->ideal_reg();
728       int n_regs = RegMask::num_registers(n_ideal_reg, lrgs(lidx));
729       if (n_regs == 1) {
730         // If Node 'n' does not change the value mapped by the register,
731         // then 'n' is a useless copy.  Do not update the register->node
732         // mapping so 'n' will go dead.
733         if( value[nreg] != val ) {
734           if (eliminate_copy_of_constant(val, n, block, value, regnd, nreg, OptoReg::Bad)) {
735             j -= replace_and_yank_if_dead(n, nreg, block, value, regnd);
736           } else {
737             // Update the mapping: record new Node defined by the register
738             regnd.map(nreg,n);
739             // Update mapping for defined *value*, which is the defined
740             // Node after skipping all copies.
741             value.map(nreg,val);
742           }
743         } else if( !may_be_copy_of_callee(n) ) {
744           assert(n->is_Copy(), "");
745           j -= replace_and_yank_if_dead(n, nreg, block, value, regnd);
746         }
747       } else if (RegMask::is_vector(n_ideal_reg)) {
748         // If Node 'n' does not change the value mapped by the register,
749         // then 'n' is a useless copy.  Do not update the register->node
750         // mapping so 'n' will go dead.
751         if (!register_contains_value(val, nreg, n_regs, value)) {
752           // Update the mapping: record new Node defined by the register
753           regnd.map(nreg,n);
754           // Update mapping for defined *value*, which is the defined
755           // Node after skipping all copies.
756           value.map(nreg,val);
757           for (int l = 1; l < n_regs; l++) {
758             OptoReg::Name nreg_lo = OptoReg::add(nreg,-l);
759             regnd.map(nreg_lo, n );
760             value.map(nreg_lo,val);
761           }
762         } else if (n->is_Copy()) {
763           // Note: vector can't be constant and can't be copy of calee.
764           j -= replace_and_yank_if_dead(n, nreg, block, value, regnd);
765         }
766       } else {
767         // If the value occupies a register pair, record same info
768         // in both registers.
769         OptoReg::Name nreg_lo = OptoReg::add(nreg,-1);
770         if( RegMask::can_represent(nreg_lo) &&     // Either a spill slot, or
771             !lrgs(lidx).mask().Member(nreg_lo) ) { // Nearly always adjacent
772           // Sparc occasionally has non-adjacent pairs.
773           // Find the actual other value
774           RegMask tmp = lrgs(lidx).mask();
775           tmp.Remove(nreg);
776           nreg_lo = tmp.find_first_elem();
777         }
778         if (value[nreg] != val || value[nreg_lo] != val) {
779           if (eliminate_copy_of_constant(val, n, block, value, regnd, nreg, nreg_lo)) {
780             j -= replace_and_yank_if_dead(n, nreg, block, value, regnd);
781           } else {
782             regnd.map(nreg   , n );
783             regnd.map(nreg_lo, n );
784             value.map(nreg   ,val);
785             value.map(nreg_lo,val);
786           }
787         } else if (!may_be_copy_of_callee(n)) {
788           assert(n->is_Copy(), "");
789           j -= replace_and_yank_if_dead(n, nreg, block, value, regnd);
790         }
791       }
792 
793       // Fat projections kill many registers
794       if( n_ideal_reg == MachProjNode::fat_proj ) {
795         RegMask rm = n->out_RegMask();
796         // wow, what an expensive iterator...
797         nreg = rm.find_first_elem();
798         while( OptoReg::is_valid(nreg)) {
799           rm.Remove(nreg);
800           value.map(nreg,n);
801           regnd.map(nreg,n);
802           nreg = rm.find_first_elem();
803         }
804       }
805 
806     } // End of for all instructions in the block
807 
808   } // End for all blocks
809 }