1 /*
   2  * Copyright 1997-2008 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  *
  23  */
  24 
  25 // Portions of code courtesy of Clifford Click
  26 
  27 // Optimization - Graph Style
  28 
  29 #include "incls/_precompiled.incl"
  30 #include "incls/_memnode.cpp.incl"
  31 
  32 static Node *step_through_mergemem(PhaseGVN *phase, MergeMemNode *mmem,  const TypePtr *tp, const TypePtr *adr_check, outputStream *st);
  33 
  34 //=============================================================================
  35 uint MemNode::size_of() const { return sizeof(*this); }
  36 
  37 const TypePtr *MemNode::adr_type() const {
  38   Node* adr = in(Address);
  39   const TypePtr* cross_check = NULL;
  40   DEBUG_ONLY(cross_check = _adr_type);
  41   return calculate_adr_type(adr->bottom_type(), cross_check);
  42 }
  43 
  44 #ifndef PRODUCT
  45 void MemNode::dump_spec(outputStream *st) const {
  46   if (in(Address) == NULL)  return; // node is dead
  47 #ifndef ASSERT
  48   // fake the missing field
  49   const TypePtr* _adr_type = NULL;
  50   if (in(Address) != NULL)
  51     _adr_type = in(Address)->bottom_type()->isa_ptr();
  52 #endif
  53   dump_adr_type(this, _adr_type, st);
  54 
  55   Compile* C = Compile::current();
  56   if( C->alias_type(_adr_type)->is_volatile() )
  57     st->print(" Volatile!");
  58 }
  59 
  60 void MemNode::dump_adr_type(const Node* mem, const TypePtr* adr_type, outputStream *st) {
  61   st->print(" @");
  62   if (adr_type == NULL) {
  63     st->print("NULL");
  64   } else {
  65     adr_type->dump_on(st);
  66     Compile* C = Compile::current();
  67     Compile::AliasType* atp = NULL;
  68     if (C->have_alias_type(adr_type))  atp = C->alias_type(adr_type);
  69     if (atp == NULL)
  70       st->print(", idx=?\?;");
  71     else if (atp->index() == Compile::AliasIdxBot)
  72       st->print(", idx=Bot;");
  73     else if (atp->index() == Compile::AliasIdxTop)
  74       st->print(", idx=Top;");
  75     else if (atp->index() == Compile::AliasIdxRaw)
  76       st->print(", idx=Raw;");
  77     else {
  78       ciField* field = atp->field();
  79       if (field) {
  80         st->print(", name=");
  81         field->print_name_on(st);
  82       }
  83       st->print(", idx=%d;", atp->index());
  84     }
  85   }
  86 }
  87 
  88 extern void print_alias_types();
  89 
  90 #endif
  91 
  92 Node *MemNode::optimize_simple_memory_chain(Node *mchain, const TypePtr *t_adr, PhaseGVN *phase) {
  93   const TypeOopPtr *tinst = t_adr->isa_oopptr();
  94   if (tinst == NULL || !tinst->is_known_instance_field())
  95     return mchain;  // don't try to optimize non-instance types
  96   uint instance_id = tinst->instance_id();
  97   Node *start_mem = phase->C->start()->proj_out(TypeFunc::Memory);
  98   Node *prev = NULL;
  99   Node *result = mchain;
 100   while (prev != result) {
 101     prev = result;
 102     if (result == start_mem)
 103       break;  // hit one of our sentinals
 104     // skip over a call which does not affect this memory slice
 105     if (result->is_Proj() && result->as_Proj()->_con == TypeFunc::Memory) {
 106       Node *proj_in = result->in(0);
 107       if (proj_in->is_Allocate() && proj_in->_idx == instance_id) {
 108         break;  // hit one of our sentinals
 109       } else if (proj_in->is_Call()) {
 110         CallNode *call = proj_in->as_Call();
 111         if (!call->may_modify(t_adr, phase)) {
 112           result = call->in(TypeFunc::Memory);
 113         }
 114       } else if (proj_in->is_Initialize()) {
 115         AllocateNode* alloc = proj_in->as_Initialize()->allocation();
 116         // Stop if this is the initialization for the object instance which
 117         // which contains this memory slice, otherwise skip over it.
 118         if (alloc != NULL && alloc->_idx != instance_id) {
 119           result = proj_in->in(TypeFunc::Memory);
 120         }
 121       } else if (proj_in->is_MemBar()) {
 122         result = proj_in->in(TypeFunc::Memory);
 123       } else {
 124         assert(false, "unexpected projection");
 125       }
 126     } else if (result->is_MergeMem()) {
 127       result = step_through_mergemem(phase, result->as_MergeMem(), t_adr, NULL, tty);
 128     }
 129   }
 130   return result;
 131 }
 132 
 133 Node *MemNode::optimize_memory_chain(Node *mchain, const TypePtr *t_adr, PhaseGVN *phase) {
 134   const TypeOopPtr *t_oop = t_adr->isa_oopptr();
 135   bool is_instance = (t_oop != NULL) && t_oop->is_known_instance_field();
 136   PhaseIterGVN *igvn = phase->is_IterGVN();
 137   Node *result = mchain;
 138   result = optimize_simple_memory_chain(result, t_adr, phase);
 139   if (is_instance && igvn != NULL  && result->is_Phi()) {
 140     PhiNode *mphi = result->as_Phi();
 141     assert(mphi->bottom_type() == Type::MEMORY, "memory phi required");
 142     const TypePtr *t = mphi->adr_type();
 143     if (t == TypePtr::BOTTOM || t == TypeRawPtr::BOTTOM ||
 144         t->isa_oopptr() && !t->is_oopptr()->is_known_instance() &&
 145         t->is_oopptr()->cast_to_exactness(true)
 146          ->is_oopptr()->cast_to_ptr_type(t_oop->ptr())
 147          ->is_oopptr()->cast_to_instance_id(t_oop->instance_id()) == t_oop) {
 148       // clone the Phi with our address type
 149       result = mphi->split_out_instance(t_adr, igvn);
 150     } else {
 151       assert(phase->C->get_alias_index(t) == phase->C->get_alias_index(t_adr), "correct memory chain");
 152     }
 153   }
 154   return result;
 155 }
 156 
 157 static Node *step_through_mergemem(PhaseGVN *phase, MergeMemNode *mmem,  const TypePtr *tp, const TypePtr *adr_check, outputStream *st) {
 158   uint alias_idx = phase->C->get_alias_index(tp);
 159   Node *mem = mmem;
 160 #ifdef ASSERT
 161   {
 162     // Check that current type is consistent with the alias index used during graph construction
 163     assert(alias_idx >= Compile::AliasIdxRaw, "must not be a bad alias_idx");
 164     bool consistent =  adr_check == NULL || adr_check->empty() ||
 165                        phase->C->must_alias(adr_check, alias_idx );
 166     // Sometimes dead array references collapse to a[-1], a[-2], or a[-3]
 167     if( !consistent && adr_check != NULL && !adr_check->empty() &&
 168                tp->isa_aryptr() &&        tp->offset() == Type::OffsetBot &&
 169         adr_check->isa_aryptr() && adr_check->offset() != Type::OffsetBot &&
 170         ( adr_check->offset() == arrayOopDesc::length_offset_in_bytes() ||
 171           adr_check->offset() == oopDesc::klass_offset_in_bytes() ||
 172           adr_check->offset() == oopDesc::mark_offset_in_bytes() ) ) {
 173       // don't assert if it is dead code.
 174       consistent = true;
 175     }
 176     if( !consistent ) {
 177       st->print("alias_idx==%d, adr_check==", alias_idx);
 178       if( adr_check == NULL ) {
 179         st->print("NULL");
 180       } else {
 181         adr_check->dump();
 182       }
 183       st->cr();
 184       print_alias_types();
 185       assert(consistent, "adr_check must match alias idx");
 186     }
 187   }
 188 #endif
 189   // TypeInstPtr::NOTNULL+any is an OOP with unknown offset - generally
 190   // means an array I have not precisely typed yet.  Do not do any
 191   // alias stuff with it any time soon.
 192   const TypeOopPtr *tinst = tp->isa_oopptr();
 193   if( tp->base() != Type::AnyPtr &&
 194       !(tinst &&
 195         tinst->klass()->is_java_lang_Object() &&
 196         tinst->offset() == Type::OffsetBot) ) {
 197     // compress paths and change unreachable cycles to TOP
 198     // If not, we can update the input infinitely along a MergeMem cycle
 199     // Equivalent code in PhiNode::Ideal
 200     Node* m  = phase->transform(mmem);
 201     // If tranformed to a MergeMem, get the desired slice
 202     // Otherwise the returned node represents memory for every slice
 203     mem = (m->is_MergeMem())? m->as_MergeMem()->memory_at(alias_idx) : m;
 204     // Update input if it is progress over what we have now
 205   }
 206   return mem;
 207 }
 208 
 209 //--------------------------Ideal_common---------------------------------------
 210 // Look for degenerate control and memory inputs.  Bypass MergeMem inputs.
 211 // Unhook non-raw memories from complete (macro-expanded) initializations.
 212 Node *MemNode::Ideal_common(PhaseGVN *phase, bool can_reshape) {
 213   // If our control input is a dead region, kill all below the region
 214   Node *ctl = in(MemNode::Control);
 215   if (ctl && remove_dead_region(phase, can_reshape))
 216     return this;
 217   ctl = in(MemNode::Control);
 218   // Don't bother trying to transform a dead node
 219   if( ctl && ctl->is_top() )  return NodeSentinel;
 220 
 221   // Ignore if memory is dead, or self-loop
 222   Node *mem = in(MemNode::Memory);
 223   if( phase->type( mem ) == Type::TOP ) return NodeSentinel; // caller will return NULL
 224   assert( mem != this, "dead loop in MemNode::Ideal" );
 225 
 226   Node *address = in(MemNode::Address);
 227   const Type *t_adr = phase->type( address );
 228   if( t_adr == Type::TOP )              return NodeSentinel; // caller will return NULL
 229 
 230   PhaseIterGVN *igvn = phase->is_IterGVN();
 231   if( can_reshape && igvn != NULL && igvn->_worklist.member(address) ) {
 232     // The address's base and type may change when the address is processed.
 233     // Delay this mem node transformation until the address is processed.
 234     phase->is_IterGVN()->_worklist.push(this);
 235     return NodeSentinel; // caller will return NULL
 236   }
 237 
 238   // Avoid independent memory operations
 239   Node* old_mem = mem;
 240 
 241   // The code which unhooks non-raw memories from complete (macro-expanded)
 242   // initializations was removed. After macro-expansion all stores catched
 243   // by Initialize node became raw stores and there is no information
 244   // which memory slices they modify. So it is unsafe to move any memory
 245   // operation above these stores. Also in most cases hooked non-raw memories
 246   // were already unhooked by using information from detect_ptr_independence()
 247   // and find_previous_store().
 248 
 249   if (mem->is_MergeMem()) {
 250     MergeMemNode* mmem = mem->as_MergeMem();
 251     const TypePtr *tp = t_adr->is_ptr();
 252 
 253     mem = step_through_mergemem(phase, mmem, tp, adr_type(), tty);
 254   }
 255 
 256   if (mem != old_mem) {
 257     set_req(MemNode::Memory, mem);
 258     if (phase->type( mem ) == Type::TOP) return NodeSentinel;
 259     return this;
 260   }
 261 
 262   // let the subclass continue analyzing...
 263   return NULL;
 264 }
 265 
 266 // Helper function for proving some simple control dominations.
 267 // Attempt to prove that all control inputs of 'dom' dominate 'sub'.
 268 // Already assumes that 'dom' is available at 'sub', and that 'sub'
 269 // is not a constant (dominated by the method's StartNode).
 270 // Used by MemNode::find_previous_store to prove that the
 271 // control input of a memory operation predates (dominates)
 272 // an allocation it wants to look past.
 273 bool MemNode::all_controls_dominate(Node* dom, Node* sub) {
 274   if (dom == NULL || dom->is_top() || sub == NULL || sub->is_top())
 275     return false; // Conservative answer for dead code
 276 
 277   // Check 'dom'. Skip Proj and CatchProj nodes.
 278   dom = dom->find_exact_control(dom);
 279   if (dom == NULL || dom->is_top())
 280     return false; // Conservative answer for dead code
 281 
 282   if (dom == sub) {
 283     // For the case when, for example, 'sub' is Initialize and the original
 284     // 'dom' is Proj node of the 'sub'.
 285     return false;
 286   }
 287 
 288   if (dom->is_Con() || dom->is_Start() || dom->is_Root() || dom == sub)
 289     return true;
 290 
 291   // 'dom' dominates 'sub' if its control edge and control edges
 292   // of all its inputs dominate or equal to sub's control edge.
 293 
 294   // Currently 'sub' is either Allocate, Initialize or Start nodes.
 295   // Or Region for the check in LoadNode::Ideal();
 296   // 'sub' should have sub->in(0) != NULL.
 297   assert(sub->is_Allocate() || sub->is_Initialize() || sub->is_Start() ||
 298          sub->is_Region(), "expecting only these nodes");
 299 
 300   // Get control edge of 'sub'.
 301   Node* orig_sub = sub;
 302   sub = sub->find_exact_control(sub->in(0));
 303   if (sub == NULL || sub->is_top())
 304     return false; // Conservative answer for dead code
 305 
 306   assert(sub->is_CFG(), "expecting control");
 307 
 308   if (sub == dom)
 309     return true;
 310 
 311   if (sub->is_Start() || sub->is_Root())
 312     return false;
 313 
 314   {
 315     // Check all control edges of 'dom'.
 316 
 317     ResourceMark rm;
 318     Arena* arena = Thread::current()->resource_area();
 319     Node_List nlist(arena);
 320     Unique_Node_List dom_list(arena);
 321 
 322     dom_list.push(dom);
 323     bool only_dominating_controls = false;
 324 
 325     for (uint next = 0; next < dom_list.size(); next++) {
 326       Node* n = dom_list.at(next);
 327       if (n == orig_sub)
 328         return false; // One of dom's inputs dominated by sub.
 329       if (!n->is_CFG() && n->pinned()) {
 330         // Check only own control edge for pinned non-control nodes.
 331         n = n->find_exact_control(n->in(0));
 332         if (n == NULL || n->is_top())
 333           return false; // Conservative answer for dead code
 334         assert(n->is_CFG(), "expecting control");
 335         dom_list.push(n);
 336       } else if (n->is_Con() || n->is_Start() || n->is_Root()) {
 337         only_dominating_controls = true;
 338       } else if (n->is_CFG()) {
 339         if (n->dominates(sub, nlist))
 340           only_dominating_controls = true;
 341         else
 342           return false;
 343       } else {
 344         // First, own control edge.
 345         Node* m = n->find_exact_control(n->in(0));
 346         if (m != NULL) {
 347           if (m->is_top())
 348             return false; // Conservative answer for dead code
 349           dom_list.push(m);
 350         }
 351         // Now, the rest of edges.
 352         uint cnt = n->req();
 353         for (uint i = 1; i < cnt; i++) {
 354           m = n->find_exact_control(n->in(i));
 355           if (m == NULL || m->is_top())
 356             continue;
 357           dom_list.push(m);
 358         }
 359       }
 360     }
 361     return only_dominating_controls;
 362   }
 363 }
 364 
 365 //---------------------detect_ptr_independence---------------------------------
 366 // Used by MemNode::find_previous_store to prove that two base
 367 // pointers are never equal.
 368 // The pointers are accompanied by their associated allocations,
 369 // if any, which have been previously discovered by the caller.
 370 bool MemNode::detect_ptr_independence(Node* p1, AllocateNode* a1,
 371                                       Node* p2, AllocateNode* a2,
 372                                       PhaseTransform* phase) {
 373   // Attempt to prove that these two pointers cannot be aliased.
 374   // They may both manifestly be allocations, and they should differ.
 375   // Or, if they are not both allocations, they can be distinct constants.
 376   // Otherwise, one is an allocation and the other a pre-existing value.
 377   if (a1 == NULL && a2 == NULL) {           // neither an allocation
 378     return (p1 != p2) && p1->is_Con() && p2->is_Con();
 379   } else if (a1 != NULL && a2 != NULL) {    // both allocations
 380     return (a1 != a2);
 381   } else if (a1 != NULL) {                  // one allocation a1
 382     // (Note:  p2->is_Con implies p2->in(0)->is_Root, which dominates.)
 383     return all_controls_dominate(p2, a1);
 384   } else { //(a2 != NULL)                   // one allocation a2
 385     return all_controls_dominate(p1, a2);
 386   }
 387   return false;
 388 }
 389 
 390 
 391 // The logic for reordering loads and stores uses four steps:
 392 // (a) Walk carefully past stores and initializations which we
 393 //     can prove are independent of this load.
 394 // (b) Observe that the next memory state makes an exact match
 395 //     with self (load or store), and locate the relevant store.
 396 // (c) Ensure that, if we were to wire self directly to the store,
 397 //     the optimizer would fold it up somehow.
 398 // (d) Do the rewiring, and return, depending on some other part of
 399 //     the optimizer to fold up the load.
 400 // This routine handles steps (a) and (b).  Steps (c) and (d) are
 401 // specific to loads and stores, so they are handled by the callers.
 402 // (Currently, only LoadNode::Ideal has steps (c), (d).  More later.)
 403 //
 404 Node* MemNode::find_previous_store(PhaseTransform* phase) {
 405   Node*         ctrl   = in(MemNode::Control);
 406   Node*         adr    = in(MemNode::Address);
 407   intptr_t      offset = 0;
 408   Node*         base   = AddPNode::Ideal_base_and_offset(adr, phase, offset);
 409   AllocateNode* alloc  = AllocateNode::Ideal_allocation(base, phase);
 410 
 411   if (offset == Type::OffsetBot)
 412     return NULL;            // cannot unalias unless there are precise offsets
 413 
 414   const TypeOopPtr *addr_t = adr->bottom_type()->isa_oopptr();
 415 
 416   intptr_t size_in_bytes = memory_size();
 417 
 418   Node* mem = in(MemNode::Memory);   // start searching here...
 419 
 420   int cnt = 50;             // Cycle limiter
 421   for (;;) {                // While we can dance past unrelated stores...
 422     if (--cnt < 0)  break;  // Caught in cycle or a complicated dance?
 423 
 424     if (mem->is_Store()) {
 425       Node* st_adr = mem->in(MemNode::Address);
 426       intptr_t st_offset = 0;
 427       Node* st_base = AddPNode::Ideal_base_and_offset(st_adr, phase, st_offset);
 428       if (st_base == NULL)
 429         break;              // inscrutable pointer
 430       if (st_offset != offset && st_offset != Type::OffsetBot) {
 431         const int MAX_STORE = BytesPerLong;
 432         if (st_offset >= offset + size_in_bytes ||
 433             st_offset <= offset - MAX_STORE ||
 434             st_offset <= offset - mem->as_Store()->memory_size()) {
 435           // Success:  The offsets are provably independent.
 436           // (You may ask, why not just test st_offset != offset and be done?
 437           // The answer is that stores of different sizes can co-exist
 438           // in the same sequence of RawMem effects.  We sometimes initialize
 439           // a whole 'tile' of array elements with a single jint or jlong.)
 440           mem = mem->in(MemNode::Memory);
 441           continue;           // (a) advance through independent store memory
 442         }
 443       }
 444       if (st_base != base &&
 445           detect_ptr_independence(base, alloc,
 446                                   st_base,
 447                                   AllocateNode::Ideal_allocation(st_base, phase),
 448                                   phase)) {
 449         // Success:  The bases are provably independent.
 450         mem = mem->in(MemNode::Memory);
 451         continue;           // (a) advance through independent store memory
 452       }
 453 
 454       // (b) At this point, if the bases or offsets do not agree, we lose,
 455       // since we have not managed to prove 'this' and 'mem' independent.
 456       if (st_base == base && st_offset == offset) {
 457         return mem;         // let caller handle steps (c), (d)
 458       }
 459 
 460     } else if (mem->is_Proj() && mem->in(0)->is_Initialize()) {
 461       InitializeNode* st_init = mem->in(0)->as_Initialize();
 462       AllocateNode*  st_alloc = st_init->allocation();
 463       if (st_alloc == NULL)
 464         break;              // something degenerated
 465       bool known_identical = false;
 466       bool known_independent = false;
 467       if (alloc == st_alloc)
 468         known_identical = true;
 469       else if (alloc != NULL)
 470         known_independent = true;
 471       else if (all_controls_dominate(this, st_alloc))
 472         known_independent = true;
 473 
 474       if (known_independent) {
 475         // The bases are provably independent: Either they are
 476         // manifestly distinct allocations, or else the control
 477         // of this load dominates the store's allocation.
 478         int alias_idx = phase->C->get_alias_index(adr_type());
 479         if (alias_idx == Compile::AliasIdxRaw) {
 480           mem = st_alloc->in(TypeFunc::Memory);
 481         } else {
 482           mem = st_init->memory(alias_idx);
 483         }
 484         continue;           // (a) advance through independent store memory
 485       }
 486 
 487       // (b) at this point, if we are not looking at a store initializing
 488       // the same allocation we are loading from, we lose.
 489       if (known_identical) {
 490         // From caller, can_see_stored_value will consult find_captured_store.
 491         return mem;         // let caller handle steps (c), (d)
 492       }
 493 
 494     } else if (addr_t != NULL && addr_t->is_known_instance_field()) {
 495       // Can't use optimize_simple_memory_chain() since it needs PhaseGVN.
 496       if (mem->is_Proj() && mem->in(0)->is_Call()) {
 497         CallNode *call = mem->in(0)->as_Call();
 498         if (!call->may_modify(addr_t, phase)) {
 499           mem = call->in(TypeFunc::Memory);
 500           continue;         // (a) advance through independent call memory
 501         }
 502       } else if (mem->is_Proj() && mem->in(0)->is_MemBar()) {
 503         mem = mem->in(0)->in(TypeFunc::Memory);
 504         continue;           // (a) advance through independent MemBar memory
 505       } else if (mem->is_MergeMem()) {
 506         int alias_idx = phase->C->get_alias_index(adr_type());
 507         mem = mem->as_MergeMem()->memory_at(alias_idx);
 508         continue;           // (a) advance through independent MergeMem memory
 509       }
 510     }
 511 
 512     // Unless there is an explicit 'continue', we must bail out here,
 513     // because 'mem' is an inscrutable memory state (e.g., a call).
 514     break;
 515   }
 516 
 517   return NULL;              // bail out
 518 }
 519 
 520 //----------------------calculate_adr_type-------------------------------------
 521 // Helper function.  Notices when the given type of address hits top or bottom.
 522 // Also, asserts a cross-check of the type against the expected address type.
 523 const TypePtr* MemNode::calculate_adr_type(const Type* t, const TypePtr* cross_check) {
 524   if (t == Type::TOP)  return NULL; // does not touch memory any more?
 525   #ifdef PRODUCT
 526   cross_check = NULL;
 527   #else
 528   if (!VerifyAliases || is_error_reported() || Node::in_dump())  cross_check = NULL;
 529   #endif
 530   const TypePtr* tp = t->isa_ptr();
 531   if (tp == NULL) {
 532     assert(cross_check == NULL || cross_check == TypePtr::BOTTOM, "expected memory type must be wide");
 533     return TypePtr::BOTTOM;           // touches lots of memory
 534   } else {
 535     #ifdef ASSERT
 536     // %%%% [phh] We don't check the alias index if cross_check is
 537     //            TypeRawPtr::BOTTOM.  Needs to be investigated.
 538     if (cross_check != NULL &&
 539         cross_check != TypePtr::BOTTOM &&
 540         cross_check != TypeRawPtr::BOTTOM) {
 541       // Recheck the alias index, to see if it has changed (due to a bug).
 542       Compile* C = Compile::current();
 543       assert(C->get_alias_index(cross_check) == C->get_alias_index(tp),
 544              "must stay in the original alias category");
 545       // The type of the address must be contained in the adr_type,
 546       // disregarding "null"-ness.
 547       // (We make an exception for TypeRawPtr::BOTTOM, which is a bit bucket.)
 548       const TypePtr* tp_notnull = tp->join(TypePtr::NOTNULL)->is_ptr();
 549       assert(cross_check->meet(tp_notnull) == cross_check,
 550              "real address must not escape from expected memory type");
 551     }
 552     #endif
 553     return tp;
 554   }
 555 }
 556 
 557 //------------------------adr_phi_is_loop_invariant----------------------------
 558 // A helper function for Ideal_DU_postCCP to check if a Phi in a counted
 559 // loop is loop invariant. Make a quick traversal of Phi and associated
 560 // CastPP nodes, looking to see if they are a closed group within the loop.
 561 bool MemNode::adr_phi_is_loop_invariant(Node* adr_phi, Node* cast) {
 562   // The idea is that the phi-nest must boil down to only CastPP nodes
 563   // with the same data. This implies that any path into the loop already
 564   // includes such a CastPP, and so the original cast, whatever its input,
 565   // must be covered by an equivalent cast, with an earlier control input.
 566   ResourceMark rm;
 567 
 568   // The loop entry input of the phi should be the unique dominating
 569   // node for every Phi/CastPP in the loop.
 570   Unique_Node_List closure;
 571   closure.push(adr_phi->in(LoopNode::EntryControl));
 572 
 573   // Add the phi node and the cast to the worklist.
 574   Unique_Node_List worklist;
 575   worklist.push(adr_phi);
 576   if( cast != NULL ){
 577     if( !cast->is_ConstraintCast() ) return false;
 578     worklist.push(cast);
 579   }
 580 
 581   // Begin recursive walk of phi nodes.
 582   while( worklist.size() ){
 583     // Take a node off the worklist
 584     Node *n = worklist.pop();
 585     if( !closure.member(n) ){
 586       // Add it to the closure.
 587       closure.push(n);
 588       // Make a sanity check to ensure we don't waste too much time here.
 589       if( closure.size() > 20) return false;
 590       // This node is OK if:
 591       //  - it is a cast of an identical value
 592       //  - or it is a phi node (then we add its inputs to the worklist)
 593       // Otherwise, the node is not OK, and we presume the cast is not invariant
 594       if( n->is_ConstraintCast() ){
 595         worklist.push(n->in(1));
 596       } else if( n->is_Phi() ) {
 597         for( uint i = 1; i < n->req(); i++ ) {
 598           worklist.push(n->in(i));
 599         }
 600       } else {
 601         return false;
 602       }
 603     }
 604   }
 605 
 606   // Quit when the worklist is empty, and we've found no offending nodes.
 607   return true;
 608 }
 609 
 610 //------------------------------Ideal_DU_postCCP-------------------------------
 611 // Find any cast-away of null-ness and keep its control.  Null cast-aways are
 612 // going away in this pass and we need to make this memory op depend on the
 613 // gating null check.
 614 Node *MemNode::Ideal_DU_postCCP( PhaseCCP *ccp ) {
 615   return Ideal_common_DU_postCCP(ccp, this, in(MemNode::Address));
 616 }
 617 
 618 // I tried to leave the CastPP's in.  This makes the graph more accurate in
 619 // some sense; we get to keep around the knowledge that an oop is not-null
 620 // after some test.  Alas, the CastPP's interfere with GVN (some values are
 621 // the regular oop, some are the CastPP of the oop, all merge at Phi's which
 622 // cannot collapse, etc).  This cost us 10% on SpecJVM, even when I removed
 623 // some of the more trivial cases in the optimizer.  Removing more useless
 624 // Phi's started allowing Loads to illegally float above null checks.  I gave
 625 // up on this approach.  CNC 10/20/2000
 626 // This static method may be called not from MemNode (EncodePNode calls it).
 627 // Only the control edge of the node 'n' might be updated.
 628 Node *MemNode::Ideal_common_DU_postCCP( PhaseCCP *ccp, Node* n, Node* adr ) {
 629   Node *skipped_cast = NULL;
 630   // Need a null check?  Regular static accesses do not because they are
 631   // from constant addresses.  Array ops are gated by the range check (which
 632   // always includes a NULL check).  Just check field ops.
 633   if( n->in(MemNode::Control) == NULL ) {
 634     // Scan upwards for the highest location we can place this memory op.
 635     while( true ) {
 636       switch( adr->Opcode() ) {
 637 
 638       case Op_AddP:             // No change to NULL-ness, so peek thru AddP's
 639         adr = adr->in(AddPNode::Base);
 640         continue;
 641 
 642       case Op_DecodeN:         // No change to NULL-ness, so peek thru
 643         adr = adr->in(1);
 644         continue;
 645 
 646       case Op_CastPP:
 647         // If the CastPP is useless, just peek on through it.
 648         if( ccp->type(adr) == ccp->type(adr->in(1)) ) {
 649           // Remember the cast that we've peeked though. If we peek
 650           // through more than one, then we end up remembering the highest
 651           // one, that is, if in a loop, the one closest to the top.
 652           skipped_cast = adr;
 653           adr = adr->in(1);
 654           continue;
 655         }
 656         // CastPP is going away in this pass!  We need this memory op to be
 657         // control-dependent on the test that is guarding the CastPP.
 658         ccp->hash_delete(n);
 659         n->set_req(MemNode::Control, adr->in(0));
 660         ccp->hash_insert(n);
 661         return n;
 662 
 663       case Op_Phi:
 664         // Attempt to float above a Phi to some dominating point.
 665         if (adr->in(0) != NULL && adr->in(0)->is_CountedLoop()) {
 666           // If we've already peeked through a Cast (which could have set the
 667           // control), we can't float above a Phi, because the skipped Cast
 668           // may not be loop invariant.
 669           if (adr_phi_is_loop_invariant(adr, skipped_cast)) {
 670             adr = adr->in(1);
 671             continue;
 672           }
 673         }
 674 
 675         // Intentional fallthrough!
 676 
 677         // No obvious dominating point.  The mem op is pinned below the Phi
 678         // by the Phi itself.  If the Phi goes away (no true value is merged)
 679         // then the mem op can float, but not indefinitely.  It must be pinned
 680         // behind the controls leading to the Phi.
 681       case Op_CheckCastPP:
 682         // These usually stick around to change address type, however a
 683         // useless one can be elided and we still need to pick up a control edge
 684         if (adr->in(0) == NULL) {
 685           // This CheckCastPP node has NO control and is likely useless. But we
 686           // need check further up the ancestor chain for a control input to keep
 687           // the node in place. 4959717.
 688           skipped_cast = adr;
 689           adr = adr->in(1);
 690           continue;
 691         }
 692         ccp->hash_delete(n);
 693         n->set_req(MemNode::Control, adr->in(0));
 694         ccp->hash_insert(n);
 695         return n;
 696 
 697         // List of "safe" opcodes; those that implicitly block the memory
 698         // op below any null check.
 699       case Op_CastX2P:          // no null checks on native pointers
 700       case Op_Parm:             // 'this' pointer is not null
 701       case Op_LoadP:            // Loading from within a klass
 702       case Op_LoadN:            // Loading from within a klass
 703       case Op_LoadKlass:        // Loading from within a klass
 704       case Op_LoadNKlass:       // Loading from within a klass
 705       case Op_ConP:             // Loading from a klass
 706       case Op_ConN:             // Loading from a klass
 707       case Op_CreateEx:         // Sucking up the guts of an exception oop
 708       case Op_Con:              // Reading from TLS
 709       case Op_CMoveP:           // CMoveP is pinned
 710       case Op_CMoveN:           // CMoveN is pinned
 711         break;                  // No progress
 712 
 713       case Op_Proj:             // Direct call to an allocation routine
 714       case Op_SCMemProj:        // Memory state from store conditional ops
 715 #ifdef ASSERT
 716         {
 717           assert(adr->as_Proj()->_con == TypeFunc::Parms, "must be return value");
 718           const Node* call = adr->in(0);
 719           if (call->is_CallJava()) {
 720             const CallJavaNode* call_java = call->as_CallJava();
 721             const TypeTuple *r = call_java->tf()->range();
 722             assert(r->cnt() > TypeFunc::Parms, "must return value");
 723             const Type* ret_type = r->field_at(TypeFunc::Parms);
 724             assert(ret_type && ret_type->isa_ptr(), "must return pointer");
 725             // We further presume that this is one of
 726             // new_instance_Java, new_array_Java, or
 727             // the like, but do not assert for this.
 728           } else if (call->is_Allocate()) {
 729             // similar case to new_instance_Java, etc.
 730           } else if (!call->is_CallLeaf()) {
 731             // Projections from fetch_oop (OSR) are allowed as well.
 732             ShouldNotReachHere();
 733           }
 734         }
 735 #endif
 736         break;
 737       default:
 738         ShouldNotReachHere();
 739       }
 740       break;
 741     }
 742   }
 743 
 744   return  NULL;               // No progress
 745 }
 746 
 747 
 748 //=============================================================================
 749 uint LoadNode::size_of() const { return sizeof(*this); }
 750 uint LoadNode::cmp( const Node &n ) const
 751 { return !Type::cmp( _type, ((LoadNode&)n)._type ); }
 752 const Type *LoadNode::bottom_type() const { return _type; }
 753 uint LoadNode::ideal_reg() const {
 754   return Matcher::base2reg[_type->base()];
 755 }
 756 
 757 #ifndef PRODUCT
 758 void LoadNode::dump_spec(outputStream *st) const {
 759   MemNode::dump_spec(st);
 760   if( !Verbose && !WizardMode ) {
 761     // standard dump does this in Verbose and WizardMode
 762     st->print(" #"); _type->dump_on(st);
 763   }
 764 }
 765 #endif
 766 
 767 
 768 //----------------------------LoadNode::make-----------------------------------
 769 // Polymorphic factory method:
 770 Node *LoadNode::make( PhaseGVN& gvn, Node *ctl, Node *mem, Node *adr, const TypePtr* adr_type, const Type *rt, BasicType bt ) {
 771   Compile* C = gvn.C;
 772 
 773   // sanity check the alias category against the created node type
 774   assert(!(adr_type->isa_oopptr() &&
 775            adr_type->offset() == oopDesc::klass_offset_in_bytes()),
 776          "use LoadKlassNode instead");
 777   assert(!(adr_type->isa_aryptr() &&
 778            adr_type->offset() == arrayOopDesc::length_offset_in_bytes()),
 779          "use LoadRangeNode instead");
 780   switch (bt) {
 781   case T_BOOLEAN:
 782   case T_BYTE:    return new (C, 3) LoadBNode (ctl, mem, adr, adr_type, rt->is_int()    );
 783   case T_INT:     return new (C, 3) LoadINode (ctl, mem, adr, adr_type, rt->is_int()    );
 784   case T_CHAR:    return new (C, 3) LoadUSNode(ctl, mem, adr, adr_type, rt->is_int()    );
 785   case T_SHORT:   return new (C, 3) LoadSNode (ctl, mem, adr, adr_type, rt->is_int()    );
 786   case T_LONG:    return new (C, 3) LoadLNode (ctl, mem, adr, adr_type, rt->is_long()   );
 787   case T_FLOAT:   return new (C, 3) LoadFNode (ctl, mem, adr, adr_type, rt              );
 788   case T_DOUBLE:  return new (C, 3) LoadDNode (ctl, mem, adr, adr_type, rt              );
 789   case T_ADDRESS: return new (C, 3) LoadPNode (ctl, mem, adr, adr_type, rt->is_ptr()    );
 790   case T_OBJECT:
 791 #ifdef _LP64
 792     if (adr->bottom_type()->is_ptr_to_narrowoop()) {
 793       Node* load  = gvn.transform(new (C, 3) LoadNNode(ctl, mem, adr, adr_type, rt->make_narrowoop()));
 794       return new (C, 2) DecodeNNode(load, load->bottom_type()->make_ptr());
 795     } else
 796 #endif
 797     {
 798       assert(!adr->bottom_type()->is_ptr_to_narrowoop(), "should have got back a narrow oop");
 799       return new (C, 3) LoadPNode(ctl, mem, adr, adr_type, rt->is_oopptr());
 800     }
 801   }
 802   ShouldNotReachHere();
 803   return (LoadNode*)NULL;
 804 }
 805 
 806 LoadLNode* LoadLNode::make_atomic(Compile *C, Node* ctl, Node* mem, Node* adr, const TypePtr* adr_type, const Type* rt) {
 807   bool require_atomic = true;
 808   return new (C, 3) LoadLNode(ctl, mem, adr, adr_type, rt->is_long(), require_atomic);
 809 }
 810 
 811 
 812 
 813 
 814 //------------------------------hash-------------------------------------------
 815 uint LoadNode::hash() const {
 816   // unroll addition of interesting fields
 817   return (uintptr_t)in(Control) + (uintptr_t)in(Memory) + (uintptr_t)in(Address);
 818 }
 819 
 820 //---------------------------can_see_stored_value------------------------------
 821 // This routine exists to make sure this set of tests is done the same
 822 // everywhere.  We need to make a coordinated change: first LoadNode::Ideal
 823 // will change the graph shape in a way which makes memory alive twice at the
 824 // same time (uses the Oracle model of aliasing), then some
 825 // LoadXNode::Identity will fold things back to the equivalence-class model
 826 // of aliasing.
 827 Node* MemNode::can_see_stored_value(Node* st, PhaseTransform* phase) const {
 828   Node* ld_adr = in(MemNode::Address);
 829 
 830   const TypeInstPtr* tp = phase->type(ld_adr)->isa_instptr();
 831   Compile::AliasType* atp = tp != NULL ? phase->C->alias_type(tp) : NULL;
 832   if (EliminateAutoBox && atp != NULL && atp->index() >= Compile::AliasIdxRaw &&
 833       atp->field() != NULL && !atp->field()->is_volatile()) {
 834     uint alias_idx = atp->index();
 835     bool final = atp->field()->is_final();
 836     Node* result = NULL;
 837     Node* current = st;
 838     // Skip through chains of MemBarNodes checking the MergeMems for
 839     // new states for the slice of this load.  Stop once any other
 840     // kind of node is encountered.  Loads from final memory can skip
 841     // through any kind of MemBar but normal loads shouldn't skip
 842     // through MemBarAcquire since the could allow them to move out of
 843     // a synchronized region.
 844     while (current->is_Proj()) {
 845       int opc = current->in(0)->Opcode();
 846       if ((final && opc == Op_MemBarAcquire) ||
 847           opc == Op_MemBarRelease || opc == Op_MemBarCPUOrder) {
 848         Node* mem = current->in(0)->in(TypeFunc::Memory);
 849         if (mem->is_MergeMem()) {
 850           MergeMemNode* merge = mem->as_MergeMem();
 851           Node* new_st = merge->memory_at(alias_idx);
 852           if (new_st == merge->base_memory()) {
 853             // Keep searching
 854             current = merge->base_memory();
 855             continue;
 856           }
 857           // Save the new memory state for the slice and fall through
 858           // to exit.
 859           result = new_st;
 860         }
 861       }
 862       break;
 863     }
 864     if (result != NULL) {
 865       st = result;
 866     }
 867   }
 868 
 869 
 870   // Loop around twice in the case Load -> Initialize -> Store.
 871   // (See PhaseIterGVN::add_users_to_worklist, which knows about this case.)
 872   for (int trip = 0; trip <= 1; trip++) {
 873 
 874     if (st->is_Store()) {
 875       Node* st_adr = st->in(MemNode::Address);
 876       if (!phase->eqv(st_adr, ld_adr)) {
 877         // Try harder before giving up...  Match raw and non-raw pointers.
 878         intptr_t st_off = 0;
 879         AllocateNode* alloc = AllocateNode::Ideal_allocation(st_adr, phase, st_off);
 880         if (alloc == NULL)       return NULL;
 881         intptr_t ld_off = 0;
 882         AllocateNode* allo2 = AllocateNode::Ideal_allocation(ld_adr, phase, ld_off);
 883         if (alloc != allo2)      return NULL;
 884         if (ld_off != st_off)    return NULL;
 885         // At this point we have proven something like this setup:
 886         //  A = Allocate(...)
 887         //  L = LoadQ(,  AddP(CastPP(, A.Parm),, #Off))
 888         //  S = StoreQ(, AddP(,        A.Parm  , #Off), V)
 889         // (Actually, we haven't yet proven the Q's are the same.)
 890         // In other words, we are loading from a casted version of
 891         // the same pointer-and-offset that we stored to.
 892         // Thus, we are able to replace L by V.
 893       }
 894       // Now prove that we have a LoadQ matched to a StoreQ, for some Q.
 895       if (store_Opcode() != st->Opcode())
 896         return NULL;
 897       return st->in(MemNode::ValueIn);
 898     }
 899 
 900     intptr_t offset = 0;  // scratch
 901 
 902     // A load from a freshly-created object always returns zero.
 903     // (This can happen after LoadNode::Ideal resets the load's memory input
 904     // to find_captured_store, which returned InitializeNode::zero_memory.)
 905     if (st->is_Proj() && st->in(0)->is_Allocate() &&
 906         st->in(0) == AllocateNode::Ideal_allocation(ld_adr, phase, offset) &&
 907         offset >= st->in(0)->as_Allocate()->minimum_header_size()) {
 908       // return a zero value for the load's basic type
 909       // (This is one of the few places where a generic PhaseTransform
 910       // can create new nodes.  Think of it as lazily manifesting
 911       // virtually pre-existing constants.)
 912       return phase->zerocon(memory_type());
 913     }
 914 
 915     // A load from an initialization barrier can match a captured store.
 916     if (st->is_Proj() && st->in(0)->is_Initialize()) {
 917       InitializeNode* init = st->in(0)->as_Initialize();
 918       AllocateNode* alloc = init->allocation();
 919       if (alloc != NULL &&
 920           alloc == AllocateNode::Ideal_allocation(ld_adr, phase, offset)) {
 921         // examine a captured store value
 922         st = init->find_captured_store(offset, memory_size(), phase);
 923         if (st != NULL)
 924           continue;             // take one more trip around
 925       }
 926     }
 927 
 928     break;
 929   }
 930 
 931   return NULL;
 932 }
 933 
 934 //----------------------is_instance_field_load_with_local_phi------------------
 935 bool LoadNode::is_instance_field_load_with_local_phi(Node* ctrl) {
 936   if( in(MemNode::Memory)->is_Phi() && in(MemNode::Memory)->in(0) == ctrl &&
 937       in(MemNode::Address)->is_AddP() ) {
 938     const TypeOopPtr* t_oop = in(MemNode::Address)->bottom_type()->isa_oopptr();
 939     // Only instances.
 940     if( t_oop != NULL && t_oop->is_known_instance_field() &&
 941         t_oop->offset() != Type::OffsetBot &&
 942         t_oop->offset() != Type::OffsetTop) {
 943       return true;
 944     }
 945   }
 946   return false;
 947 }
 948 
 949 //------------------------------Identity---------------------------------------
 950 // Loads are identity if previous store is to same address
 951 Node *LoadNode::Identity( PhaseTransform *phase ) {
 952   // If the previous store-maker is the right kind of Store, and the store is
 953   // to the same address, then we are equal to the value stored.
 954   Node* mem = in(MemNode::Memory);
 955   Node* value = can_see_stored_value(mem, phase);
 956   if( value ) {
 957     // byte, short & char stores truncate naturally.
 958     // A load has to load the truncated value which requires
 959     // some sort of masking operation and that requires an
 960     // Ideal call instead of an Identity call.
 961     if (memory_size() < BytesPerInt) {
 962       // If the input to the store does not fit with the load's result type,
 963       // it must be truncated via an Ideal call.
 964       if (!phase->type(value)->higher_equal(phase->type(this)))
 965         return this;
 966     }
 967     // (This works even when value is a Con, but LoadNode::Value
 968     // usually runs first, producing the singleton type of the Con.)
 969     return value;
 970   }
 971 
 972   // Search for an existing data phi which was generated before for the same
 973   // instance's field to avoid infinite genertion of phis in a loop.
 974   Node *region = mem->in(0);
 975   if (is_instance_field_load_with_local_phi(region)) {
 976     const TypePtr *addr_t = in(MemNode::Address)->bottom_type()->isa_ptr();
 977     int this_index  = phase->C->get_alias_index(addr_t);
 978     int this_offset = addr_t->offset();
 979     int this_id    = addr_t->is_oopptr()->instance_id();
 980     const Type* this_type = bottom_type();
 981     for (DUIterator_Fast imax, i = region->fast_outs(imax); i < imax; i++) {
 982       Node* phi = region->fast_out(i);
 983       if (phi->is_Phi() && phi != mem &&
 984           phi->as_Phi()->is_same_inst_field(this_type, this_id, this_index, this_offset)) {
 985         return phi;
 986       }
 987     }
 988   }
 989 
 990   return this;
 991 }
 992 
 993 
 994 // Returns true if the AliasType refers to the field that holds the
 995 // cached box array.  Currently only handles the IntegerCache case.
 996 static bool is_autobox_cache(Compile::AliasType* atp) {
 997   if (atp != NULL && atp->field() != NULL) {
 998     ciField* field = atp->field();
 999     ciSymbol* klass = field->holder()->name();
1000     if (field->name() == ciSymbol::cache_field_name() &&
1001         field->holder()->uses_default_loader() &&
1002         klass == ciSymbol::java_lang_Integer_IntegerCache()) {
1003       return true;
1004     }
1005   }
1006   return false;
1007 }
1008 
1009 // Fetch the base value in the autobox array
1010 static bool fetch_autobox_base(Compile::AliasType* atp, int& cache_offset) {
1011   if (atp != NULL && atp->field() != NULL) {
1012     ciField* field = atp->field();
1013     ciSymbol* klass = field->holder()->name();
1014     if (field->name() == ciSymbol::cache_field_name() &&
1015         field->holder()->uses_default_loader() &&
1016         klass == ciSymbol::java_lang_Integer_IntegerCache()) {
1017       assert(field->is_constant(), "what?");
1018       ciObjArray* array = field->constant_value().as_object()->as_obj_array();
1019       // Fetch the box object at the base of the array and get its value
1020       ciInstance* box = array->obj_at(0)->as_instance();
1021       ciInstanceKlass* ik = box->klass()->as_instance_klass();
1022       if (ik->nof_nonstatic_fields() == 1) {
1023         // This should be true nonstatic_field_at requires calling
1024         // nof_nonstatic_fields so check it anyway
1025         ciConstant c = box->field_value(ik->nonstatic_field_at(0));
1026         cache_offset = c.as_int();
1027       }
1028       return true;
1029     }
1030   }
1031   return false;
1032 }
1033 
1034 // Returns true if the AliasType refers to the value field of an
1035 // autobox object.  Currently only handles Integer.
1036 static bool is_autobox_object(Compile::AliasType* atp) {
1037   if (atp != NULL && atp->field() != NULL) {
1038     ciField* field = atp->field();
1039     ciSymbol* klass = field->holder()->name();
1040     if (field->name() == ciSymbol::value_name() &&
1041         field->holder()->uses_default_loader() &&
1042         klass == ciSymbol::java_lang_Integer()) {
1043       return true;
1044     }
1045   }
1046   return false;
1047 }
1048 
1049 
1050 // We're loading from an object which has autobox behaviour.
1051 // If this object is result of a valueOf call we'll have a phi
1052 // merging a newly allocated object and a load from the cache.
1053 // We want to replace this load with the original incoming
1054 // argument to the valueOf call.
1055 Node* LoadNode::eliminate_autobox(PhaseGVN* phase) {
1056   Node* base = in(Address)->in(AddPNode::Base);
1057   if (base->is_Phi() && base->req() == 3) {
1058     AllocateNode* allocation = NULL;
1059     int allocation_index = -1;
1060     int load_index = -1;
1061     for (uint i = 1; i < base->req(); i++) {
1062       allocation = AllocateNode::Ideal_allocation(base->in(i), phase);
1063       if (allocation != NULL) {
1064         allocation_index = i;
1065         load_index = 3 - allocation_index;
1066         break;
1067       }
1068     }
1069     LoadNode* load = NULL;
1070     if (allocation != NULL && base->in(load_index)->is_Load()) {
1071       load = base->in(load_index)->as_Load();
1072     }
1073     if (load != NULL && in(Memory)->is_Phi() && in(Memory)->in(0) == base->in(0)) {
1074       // Push the loads from the phi that comes from valueOf up
1075       // through it to allow elimination of the loads and the recovery
1076       // of the original value.
1077       Node* mem_phi = in(Memory);
1078       Node* offset = in(Address)->in(AddPNode::Offset);
1079       Node* region = base->in(0);
1080 
1081       Node* in1 = clone();
1082       Node* in1_addr = in1->in(Address)->clone();
1083       in1_addr->set_req(AddPNode::Base, base->in(allocation_index));
1084       in1_addr->set_req(AddPNode::Address, base->in(allocation_index));
1085       in1_addr->set_req(AddPNode::Offset, offset);
1086       in1->set_req(0, region->in(allocation_index));
1087       in1->set_req(Address, in1_addr);
1088       in1->set_req(Memory, mem_phi->in(allocation_index));
1089 
1090       Node* in2 = clone();
1091       Node* in2_addr = in2->in(Address)->clone();
1092       in2_addr->set_req(AddPNode::Base, base->in(load_index));
1093       in2_addr->set_req(AddPNode::Address, base->in(load_index));
1094       in2_addr->set_req(AddPNode::Offset, offset);
1095       in2->set_req(0, region->in(load_index));
1096       in2->set_req(Address, in2_addr);
1097       in2->set_req(Memory, mem_phi->in(load_index));
1098 
1099       in1_addr = phase->transform(in1_addr);
1100       in1 =      phase->transform(in1);
1101       in2_addr = phase->transform(in2_addr);
1102       in2 =      phase->transform(in2);
1103 
1104       PhiNode* result = PhiNode::make_blank(region, this);
1105       result->set_req(allocation_index, in1);
1106       result->set_req(load_index, in2);
1107       return result;
1108     }
1109   } else if (base->is_Load()) {
1110     // Eliminate the load of Integer.value for integers from the cache
1111     // array by deriving the value from the index into the array.
1112     // Capture the offset of the load and then reverse the computation.
1113     Node* load_base = base->in(Address)->in(AddPNode::Base);
1114     if (load_base != NULL) {
1115       Compile::AliasType* atp = phase->C->alias_type(load_base->adr_type());
1116       intptr_t cache_offset;
1117       int shift = -1;
1118       Node* cache = NULL;
1119       if (is_autobox_cache(atp)) {
1120         shift  = exact_log2(type2aelembytes(T_OBJECT));
1121         cache = AddPNode::Ideal_base_and_offset(load_base->in(Address), phase, cache_offset);
1122       }
1123       if (cache != NULL && base->in(Address)->is_AddP()) {
1124         Node* elements[4];
1125         int count = base->in(Address)->as_AddP()->unpack_offsets(elements, ARRAY_SIZE(elements));
1126         int cache_low;
1127         if (count > 0 && fetch_autobox_base(atp, cache_low)) {
1128           int offset = arrayOopDesc::base_offset_in_bytes(memory_type()) - (cache_low << shift);
1129           // Add up all the offsets making of the address of the load
1130           Node* result = elements[0];
1131           for (int i = 1; i < count; i++) {
1132             result = phase->transform(new (phase->C, 3) AddXNode(result, elements[i]));
1133           }
1134           // Remove the constant offset from the address and then
1135           // remove the scaling of the offset to recover the original index.
1136           result = phase->transform(new (phase->C, 3) AddXNode(result, phase->MakeConX(-offset)));
1137           if (result->Opcode() == Op_LShiftX && result->in(2) == phase->intcon(shift)) {
1138             // Peel the shift off directly but wrap it in a dummy node
1139             // since Ideal can't return existing nodes
1140             result = new (phase->C, 3) RShiftXNode(result->in(1), phase->intcon(0));
1141           } else {
1142             result = new (phase->C, 3) RShiftXNode(result, phase->intcon(shift));
1143           }
1144 #ifdef _LP64
1145           result = new (phase->C, 2) ConvL2INode(phase->transform(result));
1146 #endif
1147           return result;
1148         }
1149       }
1150     }
1151   }
1152   return NULL;
1153 }
1154 
1155 //------------------------------split_through_phi------------------------------
1156 // Split instance field load through Phi.
1157 Node *LoadNode::split_through_phi(PhaseGVN *phase) {
1158   Node* mem     = in(MemNode::Memory);
1159   Node* address = in(MemNode::Address);
1160   const TypePtr *addr_t = phase->type(address)->isa_ptr();
1161   const TypeOopPtr *t_oop = addr_t->isa_oopptr();
1162 
1163   assert(mem->is_Phi() && (t_oop != NULL) &&
1164          t_oop->is_known_instance_field(), "invalide conditions");
1165 
1166   Node *region = mem->in(0);
1167   if (region == NULL) {
1168     return NULL; // Wait stable graph
1169   }
1170   uint cnt = mem->req();
1171   for( uint i = 1; i < cnt; i++ ) {
1172     Node *in = mem->in(i);
1173     if( in == NULL ) {
1174       return NULL; // Wait stable graph
1175     }
1176   }
1177   // Check for loop invariant.
1178   if (cnt == 3) {
1179     for( uint i = 1; i < cnt; i++ ) {
1180       Node *in = mem->in(i);
1181       Node* m = MemNode::optimize_memory_chain(in, addr_t, phase);
1182       if (m == mem) {
1183         set_req(MemNode::Memory, mem->in(cnt - i)); // Skip this phi.
1184         return this;
1185       }
1186     }
1187   }
1188   // Split through Phi (see original code in loopopts.cpp).
1189   assert(phase->C->have_alias_type(addr_t), "instance should have alias type");
1190 
1191   // Do nothing here if Identity will find a value
1192   // (to avoid infinite chain of value phis generation).
1193   if ( !phase->eqv(this, this->Identity(phase)) )
1194     return NULL;
1195 
1196   // Skip the split if the region dominates some control edge of the address.
1197   if (cnt == 3 && !MemNode::all_controls_dominate(address, region))
1198     return NULL;
1199 
1200   const Type* this_type = this->bottom_type();
1201   int this_index  = phase->C->get_alias_index(addr_t);
1202   int this_offset = addr_t->offset();
1203   int this_iid    = addr_t->is_oopptr()->instance_id();
1204   int wins = 0;
1205   PhaseIterGVN *igvn = phase->is_IterGVN();
1206   Node *phi = new (igvn->C, region->req()) PhiNode(region, this_type, NULL, this_iid, this_index, this_offset);
1207   for( uint i = 1; i < region->req(); i++ ) {
1208     Node *x;
1209     Node* the_clone = NULL;
1210     if( region->in(i) == phase->C->top() ) {
1211       x = phase->C->top();      // Dead path?  Use a dead data op
1212     } else {
1213       x = this->clone();        // Else clone up the data op
1214       the_clone = x;            // Remember for possible deletion.
1215       // Alter data node to use pre-phi inputs
1216       if( this->in(0) == region ) {
1217         x->set_req( 0, region->in(i) );
1218       } else {
1219         x->set_req( 0, NULL );
1220       }
1221       for( uint j = 1; j < this->req(); j++ ) {
1222         Node *in = this->in(j);
1223         if( in->is_Phi() && in->in(0) == region )
1224           x->set_req( j, in->in(i) ); // Use pre-Phi input for the clone
1225       }
1226     }
1227     // Check for a 'win' on some paths
1228     const Type *t = x->Value(igvn);
1229 
1230     bool singleton = t->singleton();
1231 
1232     // See comments in PhaseIdealLoop::split_thru_phi().
1233     if( singleton && t == Type::TOP ) {
1234       singleton &= region->is_Loop() && (i != LoopNode::EntryControl);
1235     }
1236 
1237     if( singleton ) {
1238       wins++;
1239       x = igvn->makecon(t);
1240     } else {
1241       // We now call Identity to try to simplify the cloned node.
1242       // Note that some Identity methods call phase->type(this).
1243       // Make sure that the type array is big enough for
1244       // our new node, even though we may throw the node away.
1245       // (This tweaking with igvn only works because x is a new node.)
1246       igvn->set_type(x, t);
1247       // If x is a TypeNode, capture any more-precise type permanently into Node
1248       // othewise it will be not updated during igvn->transform since
1249       // igvn->type(x) is set to x->Value() already.
1250       x->raise_bottom_type(t);
1251       Node *y = x->Identity(igvn);
1252       if( y != x ) {
1253         wins++;
1254         x = y;
1255       } else {
1256         y = igvn->hash_find(x);
1257         if( y ) {
1258           wins++;
1259           x = y;
1260         } else {
1261           // Else x is a new node we are keeping
1262           // We do not need register_new_node_with_optimizer
1263           // because set_type has already been called.
1264           igvn->_worklist.push(x);
1265         }
1266       }
1267     }
1268     if (x != the_clone && the_clone != NULL)
1269       igvn->remove_dead_node(the_clone);
1270     phi->set_req(i, x);
1271   }
1272   if( wins > 0 ) {
1273     // Record Phi
1274     igvn->register_new_node_with_optimizer(phi);
1275     return phi;
1276   }
1277   igvn->remove_dead_node(phi);
1278   return NULL;
1279 }
1280 
1281 //------------------------------Ideal------------------------------------------
1282 // If the load is from Field memory and the pointer is non-null, we can
1283 // zero out the control input.
1284 // If the offset is constant and the base is an object allocation,
1285 // try to hook me up to the exact initializing store.
1286 Node *LoadNode::Ideal(PhaseGVN *phase, bool can_reshape) {
1287   Node* p = MemNode::Ideal_common(phase, can_reshape);
1288   if (p)  return (p == NodeSentinel) ? NULL : p;
1289 
1290   Node* ctrl    = in(MemNode::Control);
1291   Node* address = in(MemNode::Address);
1292 
1293   // Skip up past a SafePoint control.  Cannot do this for Stores because
1294   // pointer stores & cardmarks must stay on the same side of a SafePoint.
1295   if( ctrl != NULL && ctrl->Opcode() == Op_SafePoint &&
1296       phase->C->get_alias_index(phase->type(address)->is_ptr()) != Compile::AliasIdxRaw ) {
1297     ctrl = ctrl->in(0);
1298     set_req(MemNode::Control,ctrl);
1299   }
1300 
1301   // Check for useless control edge in some common special cases
1302   if (in(MemNode::Control) != NULL) {
1303     intptr_t ignore = 0;
1304     Node*    base   = AddPNode::Ideal_base_and_offset(address, phase, ignore);
1305     if (base != NULL
1306         && phase->type(base)->higher_equal(TypePtr::NOTNULL)
1307         && all_controls_dominate(base, phase->C->start())) {
1308       // A method-invariant, non-null address (constant or 'this' argument).
1309       set_req(MemNode::Control, NULL);
1310     }
1311   }
1312 
1313   if (EliminateAutoBox && can_reshape && in(Address)->is_AddP()) {
1314     Node* base = in(Address)->in(AddPNode::Base);
1315     if (base != NULL) {
1316       Compile::AliasType* atp = phase->C->alias_type(adr_type());
1317       if (is_autobox_object(atp)) {
1318         Node* result = eliminate_autobox(phase);
1319         if (result != NULL) return result;
1320       }
1321     }
1322   }
1323 
1324   Node* mem = in(MemNode::Memory);
1325   const TypePtr *addr_t = phase->type(address)->isa_ptr();
1326 
1327   if (addr_t != NULL) {
1328     // try to optimize our memory input
1329     Node* opt_mem = MemNode::optimize_memory_chain(mem, addr_t, phase);
1330     if (opt_mem != mem) {
1331       set_req(MemNode::Memory, opt_mem);
1332       if (phase->type( opt_mem ) == Type::TOP) return NULL;
1333       return this;
1334     }
1335     const TypeOopPtr *t_oop = addr_t->isa_oopptr();
1336     if (can_reshape && opt_mem->is_Phi() &&
1337         (t_oop != NULL) && t_oop->is_known_instance_field()) {
1338       // Split instance field load through Phi.
1339       Node* result = split_through_phi(phase);
1340       if (result != NULL) return result;
1341     }
1342   }
1343 
1344   // Check for prior store with a different base or offset; make Load
1345   // independent.  Skip through any number of them.  Bail out if the stores
1346   // are in an endless dead cycle and report no progress.  This is a key
1347   // transform for Reflection.  However, if after skipping through the Stores
1348   // we can't then fold up against a prior store do NOT do the transform as
1349   // this amounts to using the 'Oracle' model of aliasing.  It leaves the same
1350   // array memory alive twice: once for the hoisted Load and again after the
1351   // bypassed Store.  This situation only works if EVERYBODY who does
1352   // anti-dependence work knows how to bypass.  I.e. we need all
1353   // anti-dependence checks to ask the same Oracle.  Right now, that Oracle is
1354   // the alias index stuff.  So instead, peek through Stores and IFF we can
1355   // fold up, do so.
1356   Node* prev_mem = find_previous_store(phase);
1357   // Steps (a), (b):  Walk past independent stores to find an exact match.
1358   if (prev_mem != NULL && prev_mem != in(MemNode::Memory)) {
1359     // (c) See if we can fold up on the spot, but don't fold up here.
1360     // Fold-up might require truncation (for LoadB/LoadS/LoadUS) or
1361     // just return a prior value, which is done by Identity calls.
1362     if (can_see_stored_value(prev_mem, phase)) {
1363       // Make ready for step (d):
1364       set_req(MemNode::Memory, prev_mem);
1365       return this;
1366     }
1367   }
1368 
1369   return NULL;                  // No further progress
1370 }
1371 
1372 // Helper to recognize certain Klass fields which are invariant across
1373 // some group of array types (e.g., int[] or all T[] where T < Object).
1374 const Type*
1375 LoadNode::load_array_final_field(const TypeKlassPtr *tkls,
1376                                  ciKlass* klass) const {
1377   if (tkls->offset() == Klass::modifier_flags_offset_in_bytes() + (int)sizeof(oopDesc)) {
1378     // The field is Klass::_modifier_flags.  Return its (constant) value.
1379     // (Folds up the 2nd indirection in aClassConstant.getModifiers().)
1380     assert(this->Opcode() == Op_LoadI, "must load an int from _modifier_flags");
1381     return TypeInt::make(klass->modifier_flags());
1382   }
1383   if (tkls->offset() == Klass::access_flags_offset_in_bytes() + (int)sizeof(oopDesc)) {
1384     // The field is Klass::_access_flags.  Return its (constant) value.
1385     // (Folds up the 2nd indirection in Reflection.getClassAccessFlags(aClassConstant).)
1386     assert(this->Opcode() == Op_LoadI, "must load an int from _access_flags");
1387     return TypeInt::make(klass->access_flags());
1388   }
1389   if (tkls->offset() == Klass::layout_helper_offset_in_bytes() + (int)sizeof(oopDesc)) {
1390     // The field is Klass::_layout_helper.  Return its constant value if known.
1391     assert(this->Opcode() == Op_LoadI, "must load an int from _layout_helper");
1392     return TypeInt::make(klass->layout_helper());
1393   }
1394 
1395   // No match.
1396   return NULL;
1397 }
1398 
1399 //------------------------------Value-----------------------------------------
1400 const Type *LoadNode::Value( PhaseTransform *phase ) const {
1401   // Either input is TOP ==> the result is TOP
1402   Node* mem = in(MemNode::Memory);
1403   const Type *t1 = phase->type(mem);
1404   if (t1 == Type::TOP)  return Type::TOP;
1405   Node* adr = in(MemNode::Address);
1406   const TypePtr* tp = phase->type(adr)->isa_ptr();
1407   if (tp == NULL || tp->empty())  return Type::TOP;
1408   int off = tp->offset();
1409   assert(off != Type::OffsetTop, "case covered by TypePtr::empty");
1410 
1411   // Try to guess loaded type from pointer type
1412   if (tp->base() == Type::AryPtr) {
1413     const Type *t = tp->is_aryptr()->elem();
1414     // Don't do this for integer types. There is only potential profit if
1415     // the element type t is lower than _type; that is, for int types, if _type is
1416     // more restrictive than t.  This only happens here if one is short and the other
1417     // char (both 16 bits), and in those cases we've made an intentional decision
1418     // to use one kind of load over the other. See AndINode::Ideal and 4965907.
1419     // Also, do not try to narrow the type for a LoadKlass, regardless of offset.
1420     //
1421     // Yes, it is possible to encounter an expression like (LoadKlass p1:(AddP x x 8))
1422     // where the _gvn.type of the AddP is wider than 8.  This occurs when an earlier
1423     // copy p0 of (AddP x x 8) has been proven equal to p1, and the p0 has been
1424     // subsumed by p1.  If p1 is on the worklist but has not yet been re-transformed,
1425     // it is possible that p1 will have a type like Foo*[int+]:NotNull*+any.
1426     // In fact, that could have been the original type of p1, and p1 could have
1427     // had an original form like p1:(AddP x x (LShiftL quux 3)), where the
1428     // expression (LShiftL quux 3) independently optimized to the constant 8.
1429     if ((t->isa_int() == NULL) && (t->isa_long() == NULL)
1430         && Opcode() != Op_LoadKlass && Opcode() != Op_LoadNKlass) {
1431       // t might actually be lower than _type, if _type is a unique
1432       // concrete subclass of abstract class t.
1433       // Make sure the reference is not into the header, by comparing
1434       // the offset against the offset of the start of the array's data.
1435       // Different array types begin at slightly different offsets (12 vs. 16).
1436       // We choose T_BYTE as an example base type that is least restrictive
1437       // as to alignment, which will therefore produce the smallest
1438       // possible base offset.
1439       const int min_base_off = arrayOopDesc::base_offset_in_bytes(T_BYTE);
1440       if ((uint)off >= (uint)min_base_off) {  // is the offset beyond the header?
1441         const Type* jt = t->join(_type);
1442         // In any case, do not allow the join, per se, to empty out the type.
1443         if (jt->empty() && !t->empty()) {
1444           // This can happen if a interface-typed array narrows to a class type.
1445           jt = _type;
1446         }
1447 
1448         if (EliminateAutoBox) {
1449           // The pointers in the autobox arrays are always non-null
1450           Node* base = in(Address)->in(AddPNode::Base);
1451           if (base != NULL) {
1452             Compile::AliasType* atp = phase->C->alias_type(base->adr_type());
1453             if (is_autobox_cache(atp)) {
1454               return jt->join(TypePtr::NOTNULL)->is_ptr();
1455             }
1456           }
1457         }
1458         return jt;
1459       }
1460     }
1461   } else if (tp->base() == Type::InstPtr) {
1462     assert( off != Type::OffsetBot ||
1463             // arrays can be cast to Objects
1464             tp->is_oopptr()->klass()->is_java_lang_Object() ||
1465             // unsafe field access may not have a constant offset
1466             phase->C->has_unsafe_access(),
1467             "Field accesses must be precise" );
1468     // For oop loads, we expect the _type to be precise
1469   } else if (tp->base() == Type::KlassPtr) {
1470     assert( off != Type::OffsetBot ||
1471             // arrays can be cast to Objects
1472             tp->is_klassptr()->klass()->is_java_lang_Object() ||
1473             // also allow array-loading from the primary supertype
1474             // array during subtype checks
1475             Opcode() == Op_LoadKlass,
1476             "Field accesses must be precise" );
1477     // For klass/static loads, we expect the _type to be precise
1478   }
1479 
1480   const TypeKlassPtr *tkls = tp->isa_klassptr();
1481   if (tkls != NULL && !StressReflectiveCode) {
1482     ciKlass* klass = tkls->klass();
1483     if (klass->is_loaded() && tkls->klass_is_exact()) {
1484       // We are loading a field from a Klass metaobject whose identity
1485       // is known at compile time (the type is "exact" or "precise").
1486       // Check for fields we know are maintained as constants by the VM.
1487       if (tkls->offset() == Klass::super_check_offset_offset_in_bytes() + (int)sizeof(oopDesc)) {
1488         // The field is Klass::_super_check_offset.  Return its (constant) value.
1489         // (Folds up type checking code.)
1490         assert(Opcode() == Op_LoadI, "must load an int from _super_check_offset");
1491         return TypeInt::make(klass->super_check_offset());
1492       }
1493       // Compute index into primary_supers array
1494       juint depth = (tkls->offset() - (Klass::primary_supers_offset_in_bytes() + (int)sizeof(oopDesc))) / sizeof(klassOop);
1495       // Check for overflowing; use unsigned compare to handle the negative case.
1496       if( depth < ciKlass::primary_super_limit() ) {
1497         // The field is an element of Klass::_primary_supers.  Return its (constant) value.
1498         // (Folds up type checking code.)
1499         assert(Opcode() == Op_LoadKlass, "must load a klass from _primary_supers");
1500         ciKlass *ss = klass->super_of_depth(depth);
1501         return ss ? TypeKlassPtr::make(ss) : TypePtr::NULL_PTR;
1502       }
1503       const Type* aift = load_array_final_field(tkls, klass);
1504       if (aift != NULL)  return aift;
1505       if (tkls->offset() == in_bytes(arrayKlass::component_mirror_offset()) + (int)sizeof(oopDesc)
1506           && klass->is_array_klass()) {
1507         // The field is arrayKlass::_component_mirror.  Return its (constant) value.
1508         // (Folds up aClassConstant.getComponentType, common in Arrays.copyOf.)
1509         assert(Opcode() == Op_LoadP, "must load an oop from _component_mirror");
1510         return TypeInstPtr::make(klass->as_array_klass()->component_mirror());
1511       }
1512       if (tkls->offset() == Klass::java_mirror_offset_in_bytes() + (int)sizeof(oopDesc)) {
1513         // The field is Klass::_java_mirror.  Return its (constant) value.
1514         // (Folds up the 2nd indirection in anObjConstant.getClass().)
1515         assert(Opcode() == Op_LoadP, "must load an oop from _java_mirror");
1516         return TypeInstPtr::make(klass->java_mirror());
1517       }
1518     }
1519 
1520     // We can still check if we are loading from the primary_supers array at a
1521     // shallow enough depth.  Even though the klass is not exact, entries less
1522     // than or equal to its super depth are correct.
1523     if (klass->is_loaded() ) {
1524       ciType *inner = klass->klass();
1525       while( inner->is_obj_array_klass() )
1526         inner = inner->as_obj_array_klass()->base_element_type();
1527       if( inner->is_instance_klass() &&
1528           !inner->as_instance_klass()->flags().is_interface() ) {
1529         // Compute index into primary_supers array
1530         juint depth = (tkls->offset() - (Klass::primary_supers_offset_in_bytes() + (int)sizeof(oopDesc))) / sizeof(klassOop);
1531         // Check for overflowing; use unsigned compare to handle the negative case.
1532         if( depth < ciKlass::primary_super_limit() &&
1533             depth <= klass->super_depth() ) { // allow self-depth checks to handle self-check case
1534           // The field is an element of Klass::_primary_supers.  Return its (constant) value.
1535           // (Folds up type checking code.)
1536           assert(Opcode() == Op_LoadKlass, "must load a klass from _primary_supers");
1537           ciKlass *ss = klass->super_of_depth(depth);
1538           return ss ? TypeKlassPtr::make(ss) : TypePtr::NULL_PTR;
1539         }
1540       }
1541     }
1542 
1543     // If the type is enough to determine that the thing is not an array,
1544     // we can give the layout_helper a positive interval type.
1545     // This will help short-circuit some reflective code.
1546     if (tkls->offset() == Klass::layout_helper_offset_in_bytes() + (int)sizeof(oopDesc)
1547         && !klass->is_array_klass() // not directly typed as an array
1548         && !klass->is_interface()  // specifically not Serializable & Cloneable
1549         && !klass->is_java_lang_Object()   // not the supertype of all T[]
1550         ) {
1551       // Note:  When interfaces are reliable, we can narrow the interface
1552       // test to (klass != Serializable && klass != Cloneable).
1553       assert(Opcode() == Op_LoadI, "must load an int from _layout_helper");
1554       jint min_size = Klass::instance_layout_helper(oopDesc::header_size(), false);
1555       // The key property of this type is that it folds up tests
1556       // for array-ness, since it proves that the layout_helper is positive.
1557       // Thus, a generic value like the basic object layout helper works fine.
1558       return TypeInt::make(min_size, max_jint, Type::WidenMin);
1559     }
1560   }
1561 
1562   // If we are loading from a freshly-allocated object, produce a zero,
1563   // if the load is provably beyond the header of the object.
1564   // (Also allow a variable load from a fresh array to produce zero.)
1565   if (ReduceFieldZeroing) {
1566     Node* value = can_see_stored_value(mem,phase);
1567     if (value != NULL && value->is_Con())
1568       return value->bottom_type();
1569   }
1570 
1571   const TypeOopPtr *tinst = tp->isa_oopptr();
1572   if (tinst != NULL && tinst->is_known_instance_field()) {
1573     // If we have an instance type and our memory input is the
1574     // programs's initial memory state, there is no matching store,
1575     // so just return a zero of the appropriate type
1576     Node *mem = in(MemNode::Memory);
1577     if (mem->is_Parm() && mem->in(0)->is_Start()) {
1578       assert(mem->as_Parm()->_con == TypeFunc::Memory, "must be memory Parm");
1579       return Type::get_zero_type(_type->basic_type());
1580     }
1581   }
1582   return _type;
1583 }
1584 
1585 //------------------------------match_edge-------------------------------------
1586 // Do we Match on this edge index or not?  Match only the address.
1587 uint LoadNode::match_edge(uint idx) const {
1588   return idx == MemNode::Address;
1589 }
1590 
1591 //--------------------------LoadBNode::Ideal--------------------------------------
1592 //
1593 //  If the previous store is to the same address as this load,
1594 //  and the value stored was larger than a byte, replace this load
1595 //  with the value stored truncated to a byte.  If no truncation is
1596 //  needed, the replacement is done in LoadNode::Identity().
1597 //
1598 Node *LoadBNode::Ideal(PhaseGVN *phase, bool can_reshape) {
1599   Node* mem = in(MemNode::Memory);
1600   Node* value = can_see_stored_value(mem,phase);
1601   if( value && !phase->type(value)->higher_equal( _type ) ) {
1602     Node *result = phase->transform( new (phase->C, 3) LShiftINode(value, phase->intcon(24)) );
1603     return new (phase->C, 3) RShiftINode(result, phase->intcon(24));
1604   }
1605   // Identity call will handle the case where truncation is not needed.
1606   return LoadNode::Ideal(phase, can_reshape);
1607 }
1608 
1609 //--------------------------LoadUSNode::Ideal-------------------------------------
1610 //
1611 //  If the previous store is to the same address as this load,
1612 //  and the value stored was larger than a char, replace this load
1613 //  with the value stored truncated to a char.  If no truncation is
1614 //  needed, the replacement is done in LoadNode::Identity().
1615 //
1616 Node *LoadUSNode::Ideal(PhaseGVN *phase, bool can_reshape) {
1617   Node* mem = in(MemNode::Memory);
1618   Node* value = can_see_stored_value(mem,phase);
1619   if( value && !phase->type(value)->higher_equal( _type ) )
1620     return new (phase->C, 3) AndINode(value,phase->intcon(0xFFFF));
1621   // Identity call will handle the case where truncation is not needed.
1622   return LoadNode::Ideal(phase, can_reshape);
1623 }
1624 
1625 //--------------------------LoadSNode::Ideal--------------------------------------
1626 //
1627 //  If the previous store is to the same address as this load,
1628 //  and the value stored was larger than a short, replace this load
1629 //  with the value stored truncated to a short.  If no truncation is
1630 //  needed, the replacement is done in LoadNode::Identity().
1631 //
1632 Node *LoadSNode::Ideal(PhaseGVN *phase, bool can_reshape) {
1633   Node* mem = in(MemNode::Memory);
1634   Node* value = can_see_stored_value(mem,phase);
1635   if( value && !phase->type(value)->higher_equal( _type ) ) {
1636     Node *result = phase->transform( new (phase->C, 3) LShiftINode(value, phase->intcon(16)) );
1637     return new (phase->C, 3) RShiftINode(result, phase->intcon(16));
1638   }
1639   // Identity call will handle the case where truncation is not needed.
1640   return LoadNode::Ideal(phase, can_reshape);
1641 }
1642 
1643 //=============================================================================
1644 //----------------------------LoadKlassNode::make------------------------------
1645 // Polymorphic factory method:
1646 Node *LoadKlassNode::make( PhaseGVN& gvn, Node *mem, Node *adr, const TypePtr* at, const TypeKlassPtr *tk ) {
1647   Compile* C = gvn.C;
1648   Node *ctl = NULL;
1649   // sanity check the alias category against the created node type
1650   const TypeOopPtr *adr_type = adr->bottom_type()->isa_oopptr();
1651   assert(adr_type != NULL, "expecting TypeOopPtr");
1652 #ifdef _LP64
1653   if (adr_type->is_ptr_to_narrowoop()) {
1654     Node* load_klass = gvn.transform(new (C, 3) LoadNKlassNode(ctl, mem, adr, at, tk->make_narrowoop()));
1655     return new (C, 2) DecodeNNode(load_klass, load_klass->bottom_type()->make_ptr());
1656   }
1657 #endif
1658   assert(!adr_type->is_ptr_to_narrowoop(), "should have got back a narrow oop");
1659   return new (C, 3) LoadKlassNode(ctl, mem, adr, at, tk);
1660 }
1661 
1662 //------------------------------Value------------------------------------------
1663 const Type *LoadKlassNode::Value( PhaseTransform *phase ) const {
1664   return klass_value_common(phase);
1665 }
1666 
1667 const Type *LoadNode::klass_value_common( PhaseTransform *phase ) const {
1668   // Either input is TOP ==> the result is TOP
1669   const Type *t1 = phase->type( in(MemNode::Memory) );
1670   if (t1 == Type::TOP)  return Type::TOP;
1671   Node *adr = in(MemNode::Address);
1672   const Type *t2 = phase->type( adr );
1673   if (t2 == Type::TOP)  return Type::TOP;
1674   const TypePtr *tp = t2->is_ptr();
1675   if (TypePtr::above_centerline(tp->ptr()) ||
1676       tp->ptr() == TypePtr::Null)  return Type::TOP;
1677 
1678   // Return a more precise klass, if possible
1679   const TypeInstPtr *tinst = tp->isa_instptr();
1680   if (tinst != NULL) {
1681     ciInstanceKlass* ik = tinst->klass()->as_instance_klass();
1682     int offset = tinst->offset();
1683     if (ik == phase->C->env()->Class_klass()
1684         && (offset == java_lang_Class::klass_offset_in_bytes() ||
1685             offset == java_lang_Class::array_klass_offset_in_bytes())) {
1686       // We are loading a special hidden field from a Class mirror object,
1687       // the field which points to the VM's Klass metaobject.
1688       ciType* t = tinst->java_mirror_type();
1689       // java_mirror_type returns non-null for compile-time Class constants.
1690       if (t != NULL) {
1691         // constant oop => constant klass
1692         if (offset == java_lang_Class::array_klass_offset_in_bytes()) {
1693           return TypeKlassPtr::make(ciArrayKlass::make(t));
1694         }
1695         if (!t->is_klass()) {
1696           // a primitive Class (e.g., int.class) has NULL for a klass field
1697           return TypePtr::NULL_PTR;
1698         }
1699         // (Folds up the 1st indirection in aClassConstant.getModifiers().)
1700         return TypeKlassPtr::make(t->as_klass());
1701       }
1702       // non-constant mirror, so we can't tell what's going on
1703     }
1704     if( !ik->is_loaded() )
1705       return _type;             // Bail out if not loaded
1706     if (offset == oopDesc::klass_offset_in_bytes()) {
1707       if (tinst->klass_is_exact()) {
1708         return TypeKlassPtr::make(ik);
1709       }
1710       // See if we can become precise: no subklasses and no interface
1711       // (Note:  We need to support verified interfaces.)
1712       if (!ik->is_interface() && !ik->has_subklass()) {
1713         //assert(!UseExactTypes, "this code should be useless with exact types");
1714         // Add a dependence; if any subclass added we need to recompile
1715         if (!ik->is_final()) {
1716           // %%% should use stronger assert_unique_concrete_subtype instead
1717           phase->C->dependencies()->assert_leaf_type(ik);
1718         }
1719         // Return precise klass
1720         return TypeKlassPtr::make(ik);
1721       }
1722 
1723       // Return root of possible klass
1724       return TypeKlassPtr::make(TypePtr::NotNull, ik, 0/*offset*/);
1725     }
1726   }
1727 
1728   // Check for loading klass from an array
1729   const TypeAryPtr *tary = tp->isa_aryptr();
1730   if( tary != NULL ) {
1731     ciKlass *tary_klass = tary->klass();
1732     if (tary_klass != NULL   // can be NULL when at BOTTOM or TOP
1733         && tary->offset() == oopDesc::klass_offset_in_bytes()) {
1734       if (tary->klass_is_exact()) {
1735         return TypeKlassPtr::make(tary_klass);
1736       }
1737       ciArrayKlass *ak = tary->klass()->as_array_klass();
1738       // If the klass is an object array, we defer the question to the
1739       // array component klass.
1740       if( ak->is_obj_array_klass() ) {
1741         assert( ak->is_loaded(), "" );
1742         ciKlass *base_k = ak->as_obj_array_klass()->base_element_klass();
1743         if( base_k->is_loaded() && base_k->is_instance_klass() ) {
1744           ciInstanceKlass* ik = base_k->as_instance_klass();
1745           // See if we can become precise: no subklasses and no interface
1746           if (!ik->is_interface() && !ik->has_subklass()) {
1747             //assert(!UseExactTypes, "this code should be useless with exact types");
1748             // Add a dependence; if any subclass added we need to recompile
1749             if (!ik->is_final()) {
1750               phase->C->dependencies()->assert_leaf_type(ik);
1751             }
1752             // Return precise array klass
1753             return TypeKlassPtr::make(ak);
1754           }
1755         }
1756         return TypeKlassPtr::make(TypePtr::NotNull, ak, 0/*offset*/);
1757       } else {                  // Found a type-array?
1758         //assert(!UseExactTypes, "this code should be useless with exact types");
1759         assert( ak->is_type_array_klass(), "" );
1760         return TypeKlassPtr::make(ak); // These are always precise
1761       }
1762     }
1763   }
1764 
1765   // Check for loading klass from an array klass
1766   const TypeKlassPtr *tkls = tp->isa_klassptr();
1767   if (tkls != NULL && !StressReflectiveCode) {
1768     ciKlass* klass = tkls->klass();
1769     if( !klass->is_loaded() )
1770       return _type;             // Bail out if not loaded
1771     if( klass->is_obj_array_klass() &&
1772         (uint)tkls->offset() == objArrayKlass::element_klass_offset_in_bytes() + sizeof(oopDesc)) {
1773       ciKlass* elem = klass->as_obj_array_klass()->element_klass();
1774       // // Always returning precise element type is incorrect,
1775       // // e.g., element type could be object and array may contain strings
1776       // return TypeKlassPtr::make(TypePtr::Constant, elem, 0);
1777 
1778       // The array's TypeKlassPtr was declared 'precise' or 'not precise'
1779       // according to the element type's subclassing.
1780       return TypeKlassPtr::make(tkls->ptr(), elem, 0/*offset*/);
1781     }
1782     if( klass->is_instance_klass() && tkls->klass_is_exact() &&
1783         (uint)tkls->offset() == Klass::super_offset_in_bytes() + sizeof(oopDesc)) {
1784       ciKlass* sup = klass->as_instance_klass()->super();
1785       // The field is Klass::_super.  Return its (constant) value.
1786       // (Folds up the 2nd indirection in aClassConstant.getSuperClass().)
1787       return sup ? TypeKlassPtr::make(sup) : TypePtr::NULL_PTR;
1788     }
1789   }
1790 
1791   // Bailout case
1792   return LoadNode::Value(phase);
1793 }
1794 
1795 //------------------------------Identity---------------------------------------
1796 // To clean up reflective code, simplify k.java_mirror.as_klass to plain k.
1797 // Also feed through the klass in Allocate(...klass...)._klass.
1798 Node* LoadKlassNode::Identity( PhaseTransform *phase ) {
1799   return klass_identity_common(phase);
1800 }
1801 
1802 Node* LoadNode::klass_identity_common(PhaseTransform *phase ) {
1803   Node* x = LoadNode::Identity(phase);
1804   if (x != this)  return x;
1805 
1806   // Take apart the address into an oop and and offset.
1807   // Return 'this' if we cannot.
1808   Node*    adr    = in(MemNode::Address);
1809   intptr_t offset = 0;
1810   Node*    base   = AddPNode::Ideal_base_and_offset(adr, phase, offset);
1811   if (base == NULL)     return this;
1812   const TypeOopPtr* toop = phase->type(adr)->isa_oopptr();
1813   if (toop == NULL)     return this;
1814 
1815   // We can fetch the klass directly through an AllocateNode.
1816   // This works even if the klass is not constant (clone or newArray).
1817   if (offset == oopDesc::klass_offset_in_bytes()) {
1818     Node* allocated_klass = AllocateNode::Ideal_klass(base, phase);
1819     if (allocated_klass != NULL) {
1820       return allocated_klass;
1821     }
1822   }
1823 
1824   // Simplify k.java_mirror.as_klass to plain k, where k is a klassOop.
1825   // Simplify ak.component_mirror.array_klass to plain ak, ak an arrayKlass.
1826   // See inline_native_Class_query for occurrences of these patterns.
1827   // Java Example:  x.getClass().isAssignableFrom(y)
1828   // Java Example:  Array.newInstance(x.getClass().getComponentType(), n)
1829   //
1830   // This improves reflective code, often making the Class
1831   // mirror go completely dead.  (Current exception:  Class
1832   // mirrors may appear in debug info, but we could clean them out by
1833   // introducing a new debug info operator for klassOop.java_mirror).
1834   if (toop->isa_instptr() && toop->klass() == phase->C->env()->Class_klass()
1835       && (offset == java_lang_Class::klass_offset_in_bytes() ||
1836           offset == java_lang_Class::array_klass_offset_in_bytes())) {
1837     // We are loading a special hidden field from a Class mirror,
1838     // the field which points to its Klass or arrayKlass metaobject.
1839     if (base->is_Load()) {
1840       Node* adr2 = base->in(MemNode::Address);
1841       const TypeKlassPtr* tkls = phase->type(adr2)->isa_klassptr();
1842       if (tkls != NULL && !tkls->empty()
1843           && (tkls->klass()->is_instance_klass() ||
1844               tkls->klass()->is_array_klass())
1845           && adr2->is_AddP()
1846           ) {
1847         int mirror_field = Klass::java_mirror_offset_in_bytes();
1848         if (offset == java_lang_Class::array_klass_offset_in_bytes()) {
1849           mirror_field = in_bytes(arrayKlass::component_mirror_offset());
1850         }
1851         if (tkls->offset() == mirror_field + (int)sizeof(oopDesc)) {
1852           return adr2->in(AddPNode::Base);
1853         }
1854       }
1855     }
1856   }
1857 
1858   return this;
1859 }
1860 
1861 
1862 //------------------------------Value------------------------------------------
1863 const Type *LoadNKlassNode::Value( PhaseTransform *phase ) const {
1864   const Type *t = klass_value_common(phase);
1865   if (t == Type::TOP)
1866     return t;
1867 
1868   return t->make_narrowoop();
1869 }
1870 
1871 //------------------------------Identity---------------------------------------
1872 // To clean up reflective code, simplify k.java_mirror.as_klass to narrow k.
1873 // Also feed through the klass in Allocate(...klass...)._klass.
1874 Node* LoadNKlassNode::Identity( PhaseTransform *phase ) {
1875   Node *x = klass_identity_common(phase);
1876 
1877   const Type *t = phase->type( x );
1878   if( t == Type::TOP ) return x;
1879   if( t->isa_narrowoop()) return x;
1880 
1881   return phase->transform(new (phase->C, 2) EncodePNode(x, t->make_narrowoop()));
1882 }
1883 
1884 //------------------------------Value-----------------------------------------
1885 const Type *LoadRangeNode::Value( PhaseTransform *phase ) const {
1886   // Either input is TOP ==> the result is TOP
1887   const Type *t1 = phase->type( in(MemNode::Memory) );
1888   if( t1 == Type::TOP ) return Type::TOP;
1889   Node *adr = in(MemNode::Address);
1890   const Type *t2 = phase->type( adr );
1891   if( t2 == Type::TOP ) return Type::TOP;
1892   const TypePtr *tp = t2->is_ptr();
1893   if (TypePtr::above_centerline(tp->ptr()))  return Type::TOP;
1894   const TypeAryPtr *tap = tp->isa_aryptr();
1895   if( !tap ) return _type;
1896   return tap->size();
1897 }
1898 
1899 //-------------------------------Ideal---------------------------------------
1900 // Feed through the length in AllocateArray(...length...)._length.
1901 Node *LoadRangeNode::Ideal(PhaseGVN *phase, bool can_reshape) {
1902   Node* p = MemNode::Ideal_common(phase, can_reshape);
1903   if (p)  return (p == NodeSentinel) ? NULL : p;
1904 
1905   // Take apart the address into an oop and and offset.
1906   // Return 'this' if we cannot.
1907   Node*    adr    = in(MemNode::Address);
1908   intptr_t offset = 0;
1909   Node*    base   = AddPNode::Ideal_base_and_offset(adr, phase,  offset);
1910   if (base == NULL)     return NULL;
1911   const TypeAryPtr* tary = phase->type(adr)->isa_aryptr();
1912   if (tary == NULL)     return NULL;
1913 
1914   // We can fetch the length directly through an AllocateArrayNode.
1915   // This works even if the length is not constant (clone or newArray).
1916   if (offset == arrayOopDesc::length_offset_in_bytes()) {
1917     AllocateArrayNode* alloc = AllocateArrayNode::Ideal_array_allocation(base, phase);
1918     if (alloc != NULL) {
1919       Node* allocated_length = alloc->Ideal_length();
1920       Node* len = alloc->make_ideal_length(tary, phase);
1921       if (allocated_length != len) {
1922         // New CastII improves on this.
1923         return len;
1924       }
1925     }
1926   }
1927 
1928   return NULL;
1929 }
1930 
1931 //------------------------------Identity---------------------------------------
1932 // Feed through the length in AllocateArray(...length...)._length.
1933 Node* LoadRangeNode::Identity( PhaseTransform *phase ) {
1934   Node* x = LoadINode::Identity(phase);
1935   if (x != this)  return x;
1936 
1937   // Take apart the address into an oop and and offset.
1938   // Return 'this' if we cannot.
1939   Node*    adr    = in(MemNode::Address);
1940   intptr_t offset = 0;
1941   Node*    base   = AddPNode::Ideal_base_and_offset(adr, phase, offset);
1942   if (base == NULL)     return this;
1943   const TypeAryPtr* tary = phase->type(adr)->isa_aryptr();
1944   if (tary == NULL)     return this;
1945 
1946   // We can fetch the length directly through an AllocateArrayNode.
1947   // This works even if the length is not constant (clone or newArray).
1948   if (offset == arrayOopDesc::length_offset_in_bytes()) {
1949     AllocateArrayNode* alloc = AllocateArrayNode::Ideal_array_allocation(base, phase);
1950     if (alloc != NULL) {
1951       Node* allocated_length = alloc->Ideal_length();
1952       // Do not allow make_ideal_length to allocate a CastII node.
1953       Node* len = alloc->make_ideal_length(tary, phase, false);
1954       if (allocated_length == len) {
1955         // Return allocated_length only if it would not be improved by a CastII.
1956         return allocated_length;
1957       }
1958     }
1959   }
1960 
1961   return this;
1962 
1963 }
1964 
1965 //=============================================================================
1966 //---------------------------StoreNode::make-----------------------------------
1967 // Polymorphic factory method:
1968 StoreNode* StoreNode::make( PhaseGVN& gvn, Node* ctl, Node* mem, Node* adr, const TypePtr* adr_type, Node* val, BasicType bt ) {
1969   Compile* C = gvn.C;
1970 
1971   switch (bt) {
1972   case T_BOOLEAN:
1973   case T_BYTE:    return new (C, 4) StoreBNode(ctl, mem, adr, adr_type, val);
1974   case T_INT:     return new (C, 4) StoreINode(ctl, mem, adr, adr_type, val);
1975   case T_CHAR:
1976   case T_SHORT:   return new (C, 4) StoreCNode(ctl, mem, adr, adr_type, val);
1977   case T_LONG:    return new (C, 4) StoreLNode(ctl, mem, adr, adr_type, val);
1978   case T_FLOAT:   return new (C, 4) StoreFNode(ctl, mem, adr, adr_type, val);
1979   case T_DOUBLE:  return new (C, 4) StoreDNode(ctl, mem, adr, adr_type, val);
1980   case T_ADDRESS:
1981   case T_OBJECT:
1982 #ifdef _LP64
1983     if (adr->bottom_type()->is_ptr_to_narrowoop() ||
1984         (UseCompressedOops && val->bottom_type()->isa_klassptr() &&
1985          adr->bottom_type()->isa_rawptr())) {
1986       val = gvn.transform(new (C, 2) EncodePNode(val, val->bottom_type()->make_narrowoop()));
1987       return new (C, 4) StoreNNode(ctl, mem, adr, adr_type, val);
1988     } else
1989 #endif
1990     {
1991       return new (C, 4) StorePNode(ctl, mem, adr, adr_type, val);
1992     }
1993   }
1994   ShouldNotReachHere();
1995   return (StoreNode*)NULL;
1996 }
1997 
1998 StoreLNode* StoreLNode::make_atomic(Compile *C, Node* ctl, Node* mem, Node* adr, const TypePtr* adr_type, Node* val) {
1999   bool require_atomic = true;
2000   return new (C, 4) StoreLNode(ctl, mem, adr, adr_type, val, require_atomic);
2001 }
2002 
2003 
2004 //--------------------------bottom_type----------------------------------------
2005 const Type *StoreNode::bottom_type() const {
2006   return Type::MEMORY;
2007 }
2008 
2009 //------------------------------hash-------------------------------------------
2010 uint StoreNode::hash() const {
2011   // unroll addition of interesting fields
2012   //return (uintptr_t)in(Control) + (uintptr_t)in(Memory) + (uintptr_t)in(Address) + (uintptr_t)in(ValueIn);
2013 
2014   // Since they are not commoned, do not hash them:
2015   return NO_HASH;
2016 }
2017 
2018 //------------------------------Ideal------------------------------------------
2019 // Change back-to-back Store(, p, x) -> Store(m, p, y) to Store(m, p, x).
2020 // When a store immediately follows a relevant allocation/initialization,
2021 // try to capture it into the initialization, or hoist it above.
2022 Node *StoreNode::Ideal(PhaseGVN *phase, bool can_reshape) {
2023   Node* p = MemNode::Ideal_common(phase, can_reshape);
2024   if (p)  return (p == NodeSentinel) ? NULL : p;
2025 
2026   Node* mem     = in(MemNode::Memory);
2027   Node* address = in(MemNode::Address);
2028 
2029   // Back-to-back stores to same address?  Fold em up.
2030   // Generally unsafe if I have intervening uses...
2031   if (mem->is_Store() && phase->eqv_uncast(mem->in(MemNode::Address), address)) {
2032     // Looking at a dead closed cycle of memory?
2033     assert(mem != mem->in(MemNode::Memory), "dead loop in StoreNode::Ideal");
2034 
2035     assert(Opcode() == mem->Opcode() ||
2036            phase->C->get_alias_index(adr_type()) == Compile::AliasIdxRaw,
2037            "no mismatched stores, except on raw memory");
2038 
2039     if (mem->outcnt() == 1 &&           // check for intervening uses
2040         mem->as_Store()->memory_size() <= this->memory_size()) {
2041       // If anybody other than 'this' uses 'mem', we cannot fold 'mem' away.
2042       // For example, 'mem' might be the final state at a conditional return.
2043       // Or, 'mem' might be used by some node which is live at the same time
2044       // 'this' is live, which might be unschedulable.  So, require exactly
2045       // ONE user, the 'this' store, until such time as we clone 'mem' for
2046       // each of 'mem's uses (thus making the exactly-1-user-rule hold true).
2047       if (can_reshape) {  // (%%% is this an anachronism?)
2048         set_req_X(MemNode::Memory, mem->in(MemNode::Memory),
2049                   phase->is_IterGVN());
2050       } else {
2051         // It's OK to do this in the parser, since DU info is always accurate,
2052         // and the parser always refers to nodes via SafePointNode maps.
2053         set_req(MemNode::Memory, mem->in(MemNode::Memory));
2054       }
2055       return this;
2056     }
2057   }
2058 
2059   // Capture an unaliased, unconditional, simple store into an initializer.
2060   // Or, if it is independent of the allocation, hoist it above the allocation.
2061   if (ReduceFieldZeroing && /*can_reshape &&*/
2062       mem->is_Proj() && mem->in(0)->is_Initialize()) {
2063     InitializeNode* init = mem->in(0)->as_Initialize();
2064     intptr_t offset = init->can_capture_store(this, phase);
2065     if (offset > 0) {
2066       Node* moved = init->capture_store(this, offset, phase);
2067       // If the InitializeNode captured me, it made a raw copy of me,
2068       // and I need to disappear.
2069       if (moved != NULL) {
2070         // %%% hack to ensure that Ideal returns a new node:
2071         mem = MergeMemNode::make(phase->C, mem);
2072         return mem;             // fold me away
2073       }
2074     }
2075   }
2076 
2077   return NULL;                  // No further progress
2078 }
2079 
2080 //------------------------------Value-----------------------------------------
2081 const Type *StoreNode::Value( PhaseTransform *phase ) const {
2082   // Either input is TOP ==> the result is TOP
2083   const Type *t1 = phase->type( in(MemNode::Memory) );
2084   if( t1 == Type::TOP ) return Type::TOP;
2085   const Type *t2 = phase->type( in(MemNode::Address) );
2086   if( t2 == Type::TOP ) return Type::TOP;
2087   const Type *t3 = phase->type( in(MemNode::ValueIn) );
2088   if( t3 == Type::TOP ) return Type::TOP;
2089   return Type::MEMORY;
2090 }
2091 
2092 //------------------------------Identity---------------------------------------
2093 // Remove redundant stores:
2094 //   Store(m, p, Load(m, p)) changes to m.
2095 //   Store(, p, x) -> Store(m, p, x) changes to Store(m, p, x).
2096 Node *StoreNode::Identity( PhaseTransform *phase ) {
2097   Node* mem = in(MemNode::Memory);
2098   Node* adr = in(MemNode::Address);
2099   Node* val = in(MemNode::ValueIn);
2100 
2101   // Load then Store?  Then the Store is useless
2102   if (val->is_Load() &&
2103       phase->eqv_uncast( val->in(MemNode::Address), adr ) &&
2104       phase->eqv_uncast( val->in(MemNode::Memory ), mem ) &&
2105       val->as_Load()->store_Opcode() == Opcode()) {
2106     return mem;
2107   }
2108 
2109   // Two stores in a row of the same value?
2110   if (mem->is_Store() &&
2111       phase->eqv_uncast( mem->in(MemNode::Address), adr ) &&
2112       phase->eqv_uncast( mem->in(MemNode::ValueIn), val ) &&
2113       mem->Opcode() == Opcode()) {
2114     return mem;
2115   }
2116 
2117   // Store of zero anywhere into a freshly-allocated object?
2118   // Then the store is useless.
2119   // (It must already have been captured by the InitializeNode.)
2120   if (ReduceFieldZeroing && phase->type(val)->is_zero_type()) {
2121     // a newly allocated object is already all-zeroes everywhere
2122     if (mem->is_Proj() && mem->in(0)->is_Allocate()) {
2123       return mem;
2124     }
2125 
2126     // the store may also apply to zero-bits in an earlier object
2127     Node* prev_mem = find_previous_store(phase);
2128     // Steps (a), (b):  Walk past independent stores to find an exact match.
2129     if (prev_mem != NULL) {
2130       Node* prev_val = can_see_stored_value(prev_mem, phase);
2131       if (prev_val != NULL && phase->eqv(prev_val, val)) {
2132         // prev_val and val might differ by a cast; it would be good
2133         // to keep the more informative of the two.
2134         return mem;
2135       }
2136     }
2137   }
2138 
2139   return this;
2140 }
2141 
2142 //------------------------------match_edge-------------------------------------
2143 // Do we Match on this edge index or not?  Match only memory & value
2144 uint StoreNode::match_edge(uint idx) const {
2145   return idx == MemNode::Address || idx == MemNode::ValueIn;
2146 }
2147 
2148 //------------------------------cmp--------------------------------------------
2149 // Do not common stores up together.  They generally have to be split
2150 // back up anyways, so do not bother.
2151 uint StoreNode::cmp( const Node &n ) const {
2152   return (&n == this);          // Always fail except on self
2153 }
2154 
2155 //------------------------------Ideal_masked_input-----------------------------
2156 // Check for a useless mask before a partial-word store
2157 // (StoreB ... (AndI valIn conIa) )
2158 // If (conIa & mask == mask) this simplifies to
2159 // (StoreB ... (valIn) )
2160 Node *StoreNode::Ideal_masked_input(PhaseGVN *phase, uint mask) {
2161   Node *val = in(MemNode::ValueIn);
2162   if( val->Opcode() == Op_AndI ) {
2163     const TypeInt *t = phase->type( val->in(2) )->isa_int();
2164     if( t && t->is_con() && (t->get_con() & mask) == mask ) {
2165       set_req(MemNode::ValueIn, val->in(1));
2166       return this;
2167     }
2168   }
2169   return NULL;
2170 }
2171 
2172 
2173 //------------------------------Ideal_sign_extended_input----------------------
2174 // Check for useless sign-extension before a partial-word store
2175 // (StoreB ... (RShiftI _ (LShiftI _ valIn conIL ) conIR) )
2176 // If (conIL == conIR && conIR <= num_bits)  this simplifies to
2177 // (StoreB ... (valIn) )
2178 Node *StoreNode::Ideal_sign_extended_input(PhaseGVN *phase, int num_bits) {
2179   Node *val = in(MemNode::ValueIn);
2180   if( val->Opcode() == Op_RShiftI ) {
2181     const TypeInt *t = phase->type( val->in(2) )->isa_int();
2182     if( t && t->is_con() && (t->get_con() <= num_bits) ) {
2183       Node *shl = val->in(1);
2184       if( shl->Opcode() == Op_LShiftI ) {
2185         const TypeInt *t2 = phase->type( shl->in(2) )->isa_int();
2186         if( t2 && t2->is_con() && (t2->get_con() == t->get_con()) ) {
2187           set_req(MemNode::ValueIn, shl->in(1));
2188           return this;
2189         }
2190       }
2191     }
2192   }
2193   return NULL;
2194 }
2195 
2196 //------------------------------value_never_loaded-----------------------------------
2197 // Determine whether there are any possible loads of the value stored.
2198 // For simplicity, we actually check if there are any loads from the
2199 // address stored to, not just for loads of the value stored by this node.
2200 //
2201 bool StoreNode::value_never_loaded( PhaseTransform *phase) const {
2202   Node *adr = in(Address);
2203   const TypeOopPtr *adr_oop = phase->type(adr)->isa_oopptr();
2204   if (adr_oop == NULL)
2205     return false;
2206   if (!adr_oop->is_known_instance_field())
2207     return false; // if not a distinct instance, there may be aliases of the address
2208   for (DUIterator_Fast imax, i = adr->fast_outs(imax); i < imax; i++) {
2209     Node *use = adr->fast_out(i);
2210     int opc = use->Opcode();
2211     if (use->is_Load() || use->is_LoadStore()) {
2212       return false;
2213     }
2214   }
2215   return true;
2216 }
2217 
2218 //=============================================================================
2219 //------------------------------Ideal------------------------------------------
2220 // If the store is from an AND mask that leaves the low bits untouched, then
2221 // we can skip the AND operation.  If the store is from a sign-extension
2222 // (a left shift, then right shift) we can skip both.
2223 Node *StoreBNode::Ideal(PhaseGVN *phase, bool can_reshape){
2224   Node *progress = StoreNode::Ideal_masked_input(phase, 0xFF);
2225   if( progress != NULL ) return progress;
2226 
2227   progress = StoreNode::Ideal_sign_extended_input(phase, 24);
2228   if( progress != NULL ) return progress;
2229 
2230   // Finally check the default case
2231   return StoreNode::Ideal(phase, can_reshape);
2232 }
2233 
2234 //=============================================================================
2235 //------------------------------Ideal------------------------------------------
2236 // If the store is from an AND mask that leaves the low bits untouched, then
2237 // we can skip the AND operation
2238 Node *StoreCNode::Ideal(PhaseGVN *phase, bool can_reshape){
2239   Node *progress = StoreNode::Ideal_masked_input(phase, 0xFFFF);
2240   if( progress != NULL ) return progress;
2241 
2242   progress = StoreNode::Ideal_sign_extended_input(phase, 16);
2243   if( progress != NULL ) return progress;
2244 
2245   // Finally check the default case
2246   return StoreNode::Ideal(phase, can_reshape);
2247 }
2248 
2249 //=============================================================================
2250 //------------------------------Identity---------------------------------------
2251 Node *StoreCMNode::Identity( PhaseTransform *phase ) {
2252   // No need to card mark when storing a null ptr
2253   Node* my_store = in(MemNode::OopStore);
2254   if (my_store->is_Store()) {
2255     const Type *t1 = phase->type( my_store->in(MemNode::ValueIn) );
2256     if( t1 == TypePtr::NULL_PTR ) {
2257       return in(MemNode::Memory);
2258     }
2259   }
2260   return this;
2261 }
2262 
2263 //------------------------------Value-----------------------------------------
2264 const Type *StoreCMNode::Value( PhaseTransform *phase ) const {
2265   // Either input is TOP ==> the result is TOP
2266   const Type *t = phase->type( in(MemNode::Memory) );
2267   if( t == Type::TOP ) return Type::TOP;
2268   t = phase->type( in(MemNode::Address) );
2269   if( t == Type::TOP ) return Type::TOP;
2270   t = phase->type( in(MemNode::ValueIn) );
2271   if( t == Type::TOP ) return Type::TOP;
2272   // If extra input is TOP ==> the result is TOP
2273   t = phase->type( in(MemNode::OopStore) );
2274   if( t == Type::TOP ) return Type::TOP;
2275 
2276   return StoreNode::Value( phase );
2277 }
2278 
2279 
2280 //=============================================================================
2281 //----------------------------------SCMemProjNode------------------------------
2282 const Type * SCMemProjNode::Value( PhaseTransform *phase ) const
2283 {
2284   return bottom_type();
2285 }
2286 
2287 //=============================================================================
2288 LoadStoreNode::LoadStoreNode( Node *c, Node *mem, Node *adr, Node *val, Node *ex ) : Node(5) {
2289   init_req(MemNode::Control, c  );
2290   init_req(MemNode::Memory , mem);
2291   init_req(MemNode::Address, adr);
2292   init_req(MemNode::ValueIn, val);
2293   init_req(         ExpectedIn, ex );
2294   init_class_id(Class_LoadStore);
2295 
2296 }
2297 
2298 //=============================================================================
2299 //-------------------------------adr_type--------------------------------------
2300 // Do we Match on this edge index or not?  Do not match memory
2301 const TypePtr* ClearArrayNode::adr_type() const {
2302   Node *adr = in(3);
2303   return MemNode::calculate_adr_type(adr->bottom_type());
2304 }
2305 
2306 //------------------------------match_edge-------------------------------------
2307 // Do we Match on this edge index or not?  Do not match memory
2308 uint ClearArrayNode::match_edge(uint idx) const {
2309   return idx > 1;
2310 }
2311 
2312 //------------------------------Identity---------------------------------------
2313 // Clearing a zero length array does nothing
2314 Node *ClearArrayNode::Identity( PhaseTransform *phase ) {
2315   return phase->type(in(2))->higher_equal(TypeX::ZERO)  ? in(1) : this;
2316 }
2317 
2318 //------------------------------Idealize---------------------------------------
2319 // Clearing a short array is faster with stores
2320 Node *ClearArrayNode::Ideal(PhaseGVN *phase, bool can_reshape){
2321   const int unit = BytesPerLong;
2322   const TypeX* t = phase->type(in(2))->isa_intptr_t();
2323   if (!t)  return NULL;
2324   if (!t->is_con())  return NULL;
2325   intptr_t raw_count = t->get_con();
2326   intptr_t size = raw_count;
2327   if (!Matcher::init_array_count_is_in_bytes) size *= unit;
2328   // Clearing nothing uses the Identity call.
2329   // Negative clears are possible on dead ClearArrays
2330   // (see jck test stmt114.stmt11402.val).
2331   if (size <= 0 || size % unit != 0)  return NULL;
2332   intptr_t count = size / unit;
2333   // Length too long; use fast hardware clear
2334   if (size > Matcher::init_array_short_size)  return NULL;
2335   Node *mem = in(1);
2336   if( phase->type(mem)==Type::TOP ) return NULL;
2337   Node *adr = in(3);
2338   const Type* at = phase->type(adr);
2339   if( at==Type::TOP ) return NULL;
2340   const TypePtr* atp = at->isa_ptr();
2341   // adjust atp to be the correct array element address type
2342   if (atp == NULL)  atp = TypePtr::BOTTOM;
2343   else              atp = atp->add_offset(Type::OffsetBot);
2344   // Get base for derived pointer purposes
2345   if( adr->Opcode() != Op_AddP ) Unimplemented();
2346   Node *base = adr->in(1);
2347 
2348   Node *zero = phase->makecon(TypeLong::ZERO);
2349   Node *off  = phase->MakeConX(BytesPerLong);
2350   mem = new (phase->C, 4) StoreLNode(in(0),mem,adr,atp,zero);
2351   count--;
2352   while( count-- ) {
2353     mem = phase->transform(mem);
2354     adr = phase->transform(new (phase->C, 4) AddPNode(base,adr,off));
2355     mem = new (phase->C, 4) StoreLNode(in(0),mem,adr,atp,zero);
2356   }
2357   return mem;
2358 }
2359 
2360 //----------------------------clear_memory-------------------------------------
2361 // Generate code to initialize object storage to zero.
2362 Node* ClearArrayNode::clear_memory(Node* ctl, Node* mem, Node* dest,
2363                                    intptr_t start_offset,
2364                                    Node* end_offset,
2365                                    PhaseGVN* phase) {
2366   Compile* C = phase->C;
2367   intptr_t offset = start_offset;
2368 
2369   int unit = BytesPerLong;
2370   if ((offset % unit) != 0) {
2371     Node* adr = new (C, 4) AddPNode(dest, dest, phase->MakeConX(offset));
2372     adr = phase->transform(adr);
2373     const TypePtr* atp = TypeRawPtr::BOTTOM;
2374     mem = StoreNode::make(*phase, ctl, mem, adr, atp, phase->zerocon(T_INT), T_INT);
2375     mem = phase->transform(mem);
2376     offset += BytesPerInt;
2377   }
2378   assert((offset % unit) == 0, "");
2379 
2380   // Initialize the remaining stuff, if any, with a ClearArray.
2381   return clear_memory(ctl, mem, dest, phase->MakeConX(offset), end_offset, phase);
2382 }
2383 
2384 Node* ClearArrayNode::clear_memory(Node* ctl, Node* mem, Node* dest,
2385                                    Node* start_offset,
2386                                    Node* end_offset,
2387                                    PhaseGVN* phase) {
2388   if (start_offset == end_offset) {
2389     // nothing to do
2390     return mem;
2391   }
2392 
2393   Compile* C = phase->C;
2394   int unit = BytesPerLong;
2395   Node* zbase = start_offset;
2396   Node* zend  = end_offset;
2397 
2398   // Scale to the unit required by the CPU:
2399   if (!Matcher::init_array_count_is_in_bytes) {
2400     Node* shift = phase->intcon(exact_log2(unit));
2401     zbase = phase->transform( new(C,3) URShiftXNode(zbase, shift) );
2402     zend  = phase->transform( new(C,3) URShiftXNode(zend,  shift) );
2403   }
2404 
2405   Node* zsize = phase->transform( new(C,3) SubXNode(zend, zbase) );
2406   Node* zinit = phase->zerocon((unit == BytesPerLong) ? T_LONG : T_INT);
2407 
2408   // Bulk clear double-words
2409   Node* adr = phase->transform( new(C,4) AddPNode(dest, dest, start_offset) );
2410   mem = new (C, 4) ClearArrayNode(ctl, mem, zsize, adr);
2411   return phase->transform(mem);
2412 }
2413 
2414 Node* ClearArrayNode::clear_memory(Node* ctl, Node* mem, Node* dest,
2415                                    intptr_t start_offset,
2416                                    intptr_t end_offset,
2417                                    PhaseGVN* phase) {
2418   if (start_offset == end_offset) {
2419     // nothing to do
2420     return mem;
2421   }
2422 
2423   Compile* C = phase->C;
2424   assert((end_offset % BytesPerInt) == 0, "odd end offset");
2425   intptr_t done_offset = end_offset;
2426   if ((done_offset % BytesPerLong) != 0) {
2427     done_offset -= BytesPerInt;
2428   }
2429   if (done_offset > start_offset) {
2430     mem = clear_memory(ctl, mem, dest,
2431                        start_offset, phase->MakeConX(done_offset), phase);
2432   }
2433   if (done_offset < end_offset) { // emit the final 32-bit store
2434     Node* adr = new (C, 4) AddPNode(dest, dest, phase->MakeConX(done_offset));
2435     adr = phase->transform(adr);
2436     const TypePtr* atp = TypeRawPtr::BOTTOM;
2437     mem = StoreNode::make(*phase, ctl, mem, adr, atp, phase->zerocon(T_INT), T_INT);
2438     mem = phase->transform(mem);
2439     done_offset += BytesPerInt;
2440   }
2441   assert(done_offset == end_offset, "");
2442   return mem;
2443 }
2444 
2445 //=============================================================================
2446 // Do we match on this edge? No memory edges
2447 uint StrCompNode::match_edge(uint idx) const {
2448   return idx == 5 || idx == 6;
2449 }
2450 
2451 //------------------------------Ideal------------------------------------------
2452 // Return a node which is more "ideal" than the current node.  Strip out
2453 // control copies
2454 Node *StrCompNode::Ideal(PhaseGVN *phase, bool can_reshape){
2455   return remove_dead_region(phase, can_reshape) ? this : NULL;
2456 }
2457 
2458 //------------------------------Ideal------------------------------------------
2459 // Return a node which is more "ideal" than the current node.  Strip out
2460 // control copies
2461 Node *AryEqNode::Ideal(PhaseGVN *phase, bool can_reshape){
2462   return remove_dead_region(phase, can_reshape) ? this : NULL;
2463 }
2464 
2465 
2466 //=============================================================================
2467 MemBarNode::MemBarNode(Compile* C, int alias_idx, Node* precedent)
2468   : MultiNode(TypeFunc::Parms + (precedent == NULL? 0: 1)),
2469     _adr_type(C->get_adr_type(alias_idx))
2470 {
2471   init_class_id(Class_MemBar);
2472   Node* top = C->top();
2473   init_req(TypeFunc::I_O,top);
2474   init_req(TypeFunc::FramePtr,top);
2475   init_req(TypeFunc::ReturnAdr,top);
2476   if (precedent != NULL)
2477     init_req(TypeFunc::Parms, precedent);
2478 }
2479 
2480 //------------------------------cmp--------------------------------------------
2481 uint MemBarNode::hash() const { return NO_HASH; }
2482 uint MemBarNode::cmp( const Node &n ) const {
2483   return (&n == this);          // Always fail except on self
2484 }
2485 
2486 //------------------------------make-------------------------------------------
2487 MemBarNode* MemBarNode::make(Compile* C, int opcode, int atp, Node* pn) {
2488   int len = Precedent + (pn == NULL? 0: 1);
2489   switch (opcode) {
2490   case Op_MemBarAcquire:   return new(C, len) MemBarAcquireNode(C,  atp, pn);
2491   case Op_MemBarRelease:   return new(C, len) MemBarReleaseNode(C,  atp, pn);
2492   case Op_MemBarVolatile:  return new(C, len) MemBarVolatileNode(C, atp, pn);
2493   case Op_MemBarCPUOrder:  return new(C, len) MemBarCPUOrderNode(C, atp, pn);
2494   case Op_Initialize:      return new(C, len) InitializeNode(C,     atp, pn);
2495   default:                 ShouldNotReachHere(); return NULL;
2496   }
2497 }
2498 
2499 //------------------------------Ideal------------------------------------------
2500 // Return a node which is more "ideal" than the current node.  Strip out
2501 // control copies
2502 Node *MemBarNode::Ideal(PhaseGVN *phase, bool can_reshape) {
2503   return remove_dead_region(phase, can_reshape) ? this : NULL;
2504 }
2505 
2506 //------------------------------Value------------------------------------------
2507 const Type *MemBarNode::Value( PhaseTransform *phase ) const {
2508   if( !in(0) ) return Type::TOP;
2509   if( phase->type(in(0)) == Type::TOP )
2510     return Type::TOP;
2511   return TypeTuple::MEMBAR;
2512 }
2513 
2514 //------------------------------match------------------------------------------
2515 // Construct projections for memory.
2516 Node *MemBarNode::match( const ProjNode *proj, const Matcher *m ) {
2517   switch (proj->_con) {
2518   case TypeFunc::Control:
2519   case TypeFunc::Memory:
2520     return new (m->C, 1) MachProjNode(this,proj->_con,RegMask::Empty,MachProjNode::unmatched_proj);
2521   }
2522   ShouldNotReachHere();
2523   return NULL;
2524 }
2525 
2526 //===========================InitializeNode====================================
2527 // SUMMARY:
2528 // This node acts as a memory barrier on raw memory, after some raw stores.
2529 // The 'cooked' oop value feeds from the Initialize, not the Allocation.
2530 // The Initialize can 'capture' suitably constrained stores as raw inits.
2531 // It can coalesce related raw stores into larger units (called 'tiles').
2532 // It can avoid zeroing new storage for memory units which have raw inits.
2533 // At macro-expansion, it is marked 'complete', and does not optimize further.
2534 //
2535 // EXAMPLE:
2536 // The object 'new short[2]' occupies 16 bytes in a 32-bit machine.
2537 //   ctl = incoming control; mem* = incoming memory
2538 // (Note:  A star * on a memory edge denotes I/O and other standard edges.)
2539 // First allocate uninitialized memory and fill in the header:
2540 //   alloc = (Allocate ctl mem* 16 #short[].klass ...)
2541 //   ctl := alloc.Control; mem* := alloc.Memory*
2542 //   rawmem = alloc.Memory; rawoop = alloc.RawAddress
2543 // Then initialize to zero the non-header parts of the raw memory block:
2544 //   init = (Initialize alloc.Control alloc.Memory* alloc.RawAddress)
2545 //   ctl := init.Control; mem.SLICE(#short[*]) := init.Memory
2546 // After the initialize node executes, the object is ready for service:
2547 //   oop := (CheckCastPP init.Control alloc.RawAddress #short[])
2548 // Suppose its body is immediately initialized as {1,2}:
2549 //   store1 = (StoreC init.Control init.Memory (+ oop 12) 1)
2550 //   store2 = (StoreC init.Control store1      (+ oop 14) 2)
2551 //   mem.SLICE(#short[*]) := store2
2552 //
2553 // DETAILS:
2554 // An InitializeNode collects and isolates object initialization after
2555 // an AllocateNode and before the next possible safepoint.  As a
2556 // memory barrier (MemBarNode), it keeps critical stores from drifting
2557 // down past any safepoint or any publication of the allocation.
2558 // Before this barrier, a newly-allocated object may have uninitialized bits.
2559 // After this barrier, it may be treated as a real oop, and GC is allowed.
2560 //
2561 // The semantics of the InitializeNode include an implicit zeroing of
2562 // the new object from object header to the end of the object.
2563 // (The object header and end are determined by the AllocateNode.)
2564 //
2565 // Certain stores may be added as direct inputs to the InitializeNode.
2566 // These stores must update raw memory, and they must be to addresses
2567 // derived from the raw address produced by AllocateNode, and with
2568 // a constant offset.  They must be ordered by increasing offset.
2569 // The first one is at in(RawStores), the last at in(req()-1).
2570 // Unlike most memory operations, they are not linked in a chain,
2571 // but are displayed in parallel as users of the rawmem output of
2572 // the allocation.
2573 //
2574 // (See comments in InitializeNode::capture_store, which continue
2575 // the example given above.)
2576 //
2577 // When the associated Allocate is macro-expanded, the InitializeNode
2578 // may be rewritten to optimize collected stores.  A ClearArrayNode
2579 // may also be created at that point to represent any required zeroing.
2580 // The InitializeNode is then marked 'complete', prohibiting further
2581 // capturing of nearby memory operations.
2582 //
2583 // During macro-expansion, all captured initializations which store
2584 // constant values of 32 bits or smaller are coalesced (if advantagous)
2585 // into larger 'tiles' 32 or 64 bits.  This allows an object to be
2586 // initialized in fewer memory operations.  Memory words which are
2587 // covered by neither tiles nor non-constant stores are pre-zeroed
2588 // by explicit stores of zero.  (The code shape happens to do all
2589 // zeroing first, then all other stores, with both sequences occurring
2590 // in order of ascending offsets.)
2591 //
2592 // Alternatively, code may be inserted between an AllocateNode and its
2593 // InitializeNode, to perform arbitrary initialization of the new object.
2594 // E.g., the object copying intrinsics insert complex data transfers here.
2595 // The initialization must then be marked as 'complete' disable the
2596 // built-in zeroing semantics and the collection of initializing stores.
2597 //
2598 // While an InitializeNode is incomplete, reads from the memory state
2599 // produced by it are optimizable if they match the control edge and
2600 // new oop address associated with the allocation/initialization.
2601 // They return a stored value (if the offset matches) or else zero.
2602 // A write to the memory state, if it matches control and address,
2603 // and if it is to a constant offset, may be 'captured' by the
2604 // InitializeNode.  It is cloned as a raw memory operation and rewired
2605 // inside the initialization, to the raw oop produced by the allocation.
2606 // Operations on addresses which are provably distinct (e.g., to
2607 // other AllocateNodes) are allowed to bypass the initialization.
2608 //
2609 // The effect of all this is to consolidate object initialization
2610 // (both arrays and non-arrays, both piecewise and bulk) into a
2611 // single location, where it can be optimized as a unit.
2612 //
2613 // Only stores with an offset less than TrackedInitializationLimit words
2614 // will be considered for capture by an InitializeNode.  This puts a
2615 // reasonable limit on the complexity of optimized initializations.
2616 
2617 //---------------------------InitializeNode------------------------------------
2618 InitializeNode::InitializeNode(Compile* C, int adr_type, Node* rawoop)
2619   : _is_complete(false),
2620     MemBarNode(C, adr_type, rawoop)
2621 {
2622   init_class_id(Class_Initialize);
2623 
2624   assert(adr_type == Compile::AliasIdxRaw, "only valid atp");
2625   assert(in(RawAddress) == rawoop, "proper init");
2626   // Note:  allocation() can be NULL, for secondary initialization barriers
2627 }
2628 
2629 // Since this node is not matched, it will be processed by the
2630 // register allocator.  Declare that there are no constraints
2631 // on the allocation of the RawAddress edge.
2632 const RegMask &InitializeNode::in_RegMask(uint idx) const {
2633   // This edge should be set to top, by the set_complete.  But be conservative.
2634   if (idx == InitializeNode::RawAddress)
2635     return *(Compile::current()->matcher()->idealreg2spillmask[in(idx)->ideal_reg()]);
2636   return RegMask::Empty;
2637 }
2638 
2639 Node* InitializeNode::memory(uint alias_idx) {
2640   Node* mem = in(Memory);
2641   if (mem->is_MergeMem()) {
2642     return mem->as_MergeMem()->memory_at(alias_idx);
2643   } else {
2644     // incoming raw memory is not split
2645     return mem;
2646   }
2647 }
2648 
2649 bool InitializeNode::is_non_zero() {
2650   if (is_complete())  return false;
2651   remove_extra_zeroes();
2652   return (req() > RawStores);
2653 }
2654 
2655 void InitializeNode::set_complete(PhaseGVN* phase) {
2656   assert(!is_complete(), "caller responsibility");
2657   _is_complete = true;
2658 
2659   // After this node is complete, it contains a bunch of
2660   // raw-memory initializations.  There is no need for
2661   // it to have anything to do with non-raw memory effects.
2662   // Therefore, tell all non-raw users to re-optimize themselves,
2663   // after skipping the memory effects of this initialization.
2664   PhaseIterGVN* igvn = phase->is_IterGVN();
2665   if (igvn)  igvn->add_users_to_worklist(this);
2666 }
2667 
2668 // convenience function
2669 // return false if the init contains any stores already
2670 bool AllocateNode::maybe_set_complete(PhaseGVN* phase) {
2671   InitializeNode* init = initialization();
2672   if (init == NULL || init->is_complete())  return false;
2673   init->remove_extra_zeroes();
2674   // for now, if this allocation has already collected any inits, bail:
2675   if (init->is_non_zero())  return false;
2676   init->set_complete(phase);
2677   return true;
2678 }
2679 
2680 void InitializeNode::remove_extra_zeroes() {
2681   if (req() == RawStores)  return;
2682   Node* zmem = zero_memory();
2683   uint fill = RawStores;
2684   for (uint i = fill; i < req(); i++) {
2685     Node* n = in(i);
2686     if (n->is_top() || n == zmem)  continue;  // skip
2687     if (fill < i)  set_req(fill, n);          // compact
2688     ++fill;
2689   }
2690   // delete any empty spaces created:
2691   while (fill < req()) {
2692     del_req(fill);
2693   }
2694 }
2695 
2696 // Helper for remembering which stores go with which offsets.
2697 intptr_t InitializeNode::get_store_offset(Node* st, PhaseTransform* phase) {
2698   if (!st->is_Store())  return -1;  // can happen to dead code via subsume_node
2699   intptr_t offset = -1;
2700   Node* base = AddPNode::Ideal_base_and_offset(st->in(MemNode::Address),
2701                                                phase, offset);
2702   if (base == NULL)     return -1;  // something is dead,
2703   if (offset < 0)       return -1;  //        dead, dead
2704   return offset;
2705 }
2706 
2707 // Helper for proving that an initialization expression is
2708 // "simple enough" to be folded into an object initialization.
2709 // Attempts to prove that a store's initial value 'n' can be captured
2710 // within the initialization without creating a vicious cycle, such as:
2711 //     { Foo p = new Foo(); p.next = p; }
2712 // True for constants and parameters and small combinations thereof.
2713 bool InitializeNode::detect_init_independence(Node* n,
2714                                               bool st_is_pinned,
2715                                               int& count) {
2716   if (n == NULL)      return true;   // (can this really happen?)
2717   if (n->is_Proj())   n = n->in(0);
2718   if (n == this)      return false;  // found a cycle
2719   if (n->is_Con())    return true;
2720   if (n->is_Start())  return true;   // params, etc., are OK
2721   if (n->is_Root())   return true;   // even better
2722 
2723   Node* ctl = n->in(0);
2724   if (ctl != NULL && !ctl->is_top()) {
2725     if (ctl->is_Proj())  ctl = ctl->in(0);
2726     if (ctl == this)  return false;
2727 
2728     // If we already know that the enclosing memory op is pinned right after
2729     // the init, then any control flow that the store has picked up
2730     // must have preceded the init, or else be equal to the init.
2731     // Even after loop optimizations (which might change control edges)
2732     // a store is never pinned *before* the availability of its inputs.
2733     if (!MemNode::all_controls_dominate(n, this))
2734       return false;                  // failed to prove a good control
2735 
2736   }
2737 
2738   // Check data edges for possible dependencies on 'this'.
2739   if ((count += 1) > 20)  return false;  // complexity limit
2740   for (uint i = 1; i < n->req(); i++) {
2741     Node* m = n->in(i);
2742     if (m == NULL || m == n || m->is_top())  continue;
2743     uint first_i = n->find_edge(m);
2744     if (i != first_i)  continue;  // process duplicate edge just once
2745     if (!detect_init_independence(m, st_is_pinned, count)) {
2746       return false;
2747     }
2748   }
2749 
2750   return true;
2751 }
2752 
2753 // Here are all the checks a Store must pass before it can be moved into
2754 // an initialization.  Returns zero if a check fails.
2755 // On success, returns the (constant) offset to which the store applies,
2756 // within the initialized memory.
2757 intptr_t InitializeNode::can_capture_store(StoreNode* st, PhaseTransform* phase) {
2758   const int FAIL = 0;
2759   if (st->req() != MemNode::ValueIn + 1)
2760     return FAIL;                // an inscrutable StoreNode (card mark?)
2761   Node* ctl = st->in(MemNode::Control);
2762   if (!(ctl != NULL && ctl->is_Proj() && ctl->in(0) == this))
2763     return FAIL;                // must be unconditional after the initialization
2764   Node* mem = st->in(MemNode::Memory);
2765   if (!(mem->is_Proj() && mem->in(0) == this))
2766     return FAIL;                // must not be preceded by other stores
2767   Node* adr = st->in(MemNode::Address);
2768   intptr_t offset;
2769   AllocateNode* alloc = AllocateNode::Ideal_allocation(adr, phase, offset);
2770   if (alloc == NULL)
2771     return FAIL;                // inscrutable address
2772   if (alloc != allocation())
2773     return FAIL;                // wrong allocation!  (store needs to float up)
2774   Node* val = st->in(MemNode::ValueIn);
2775   int complexity_count = 0;
2776   if (!detect_init_independence(val, true, complexity_count))
2777     return FAIL;                // stored value must be 'simple enough'
2778 
2779   return offset;                // success
2780 }
2781 
2782 // Find the captured store in(i) which corresponds to the range
2783 // [start..start+size) in the initialized object.
2784 // If there is one, return its index i.  If there isn't, return the
2785 // negative of the index where it should be inserted.
2786 // Return 0 if the queried range overlaps an initialization boundary
2787 // or if dead code is encountered.
2788 // If size_in_bytes is zero, do not bother with overlap checks.
2789 int InitializeNode::captured_store_insertion_point(intptr_t start,
2790                                                    int size_in_bytes,
2791                                                    PhaseTransform* phase) {
2792   const int FAIL = 0, MAX_STORE = BytesPerLong;
2793 
2794   if (is_complete())
2795     return FAIL;                // arraycopy got here first; punt
2796 
2797   assert(allocation() != NULL, "must be present");
2798 
2799   // no negatives, no header fields:
2800   if (start < (intptr_t) allocation()->minimum_header_size())  return FAIL;
2801 
2802   // after a certain size, we bail out on tracking all the stores:
2803   intptr_t ti_limit = (TrackedInitializationLimit * HeapWordSize);
2804   if (start >= ti_limit)  return FAIL;
2805 
2806   for (uint i = InitializeNode::RawStores, limit = req(); ; ) {
2807     if (i >= limit)  return -(int)i; // not found; here is where to put it
2808 
2809     Node*    st     = in(i);
2810     intptr_t st_off = get_store_offset(st, phase);
2811     if (st_off < 0) {
2812       if (st != zero_memory()) {
2813         return FAIL;            // bail out if there is dead garbage
2814       }
2815     } else if (st_off > start) {
2816       // ...we are done, since stores are ordered
2817       if (st_off < start + size_in_bytes) {
2818         return FAIL;            // the next store overlaps
2819       }
2820       return -(int)i;           // not found; here is where to put it
2821     } else if (st_off < start) {
2822       if (size_in_bytes != 0 &&
2823           start < st_off + MAX_STORE &&
2824           start < st_off + st->as_Store()->memory_size()) {
2825         return FAIL;            // the previous store overlaps
2826       }
2827     } else {
2828       if (size_in_bytes != 0 &&
2829           st->as_Store()->memory_size() != size_in_bytes) {
2830         return FAIL;            // mismatched store size
2831       }
2832       return i;
2833     }
2834 
2835     ++i;
2836   }
2837 }
2838 
2839 // Look for a captured store which initializes at the offset 'start'
2840 // with the given size.  If there is no such store, and no other
2841 // initialization interferes, then return zero_memory (the memory
2842 // projection of the AllocateNode).
2843 Node* InitializeNode::find_captured_store(intptr_t start, int size_in_bytes,
2844                                           PhaseTransform* phase) {
2845   assert(stores_are_sane(phase), "");
2846   int i = captured_store_insertion_point(start, size_in_bytes, phase);
2847   if (i == 0) {
2848     return NULL;                // something is dead
2849   } else if (i < 0) {
2850     return zero_memory();       // just primordial zero bits here
2851   } else {
2852     Node* st = in(i);           // here is the store at this position
2853     assert(get_store_offset(st->as_Store(), phase) == start, "sanity");
2854     return st;
2855   }
2856 }
2857 
2858 // Create, as a raw pointer, an address within my new object at 'offset'.
2859 Node* InitializeNode::make_raw_address(intptr_t offset,
2860                                        PhaseTransform* phase) {
2861   Node* addr = in(RawAddress);
2862   if (offset != 0) {
2863     Compile* C = phase->C;
2864     addr = phase->transform( new (C, 4) AddPNode(C->top(), addr,
2865                                                  phase->MakeConX(offset)) );
2866   }
2867   return addr;
2868 }
2869 
2870 // Clone the given store, converting it into a raw store
2871 // initializing a field or element of my new object.
2872 // Caller is responsible for retiring the original store,
2873 // with subsume_node or the like.
2874 //
2875 // From the example above InitializeNode::InitializeNode,
2876 // here are the old stores to be captured:
2877 //   store1 = (StoreC init.Control init.Memory (+ oop 12) 1)
2878 //   store2 = (StoreC init.Control store1      (+ oop 14) 2)
2879 //
2880 // Here is the changed code; note the extra edges on init:
2881 //   alloc = (Allocate ...)
2882 //   rawoop = alloc.RawAddress
2883 //   rawstore1 = (StoreC alloc.Control alloc.Memory (+ rawoop 12) 1)
2884 //   rawstore2 = (StoreC alloc.Control alloc.Memory (+ rawoop 14) 2)
2885 //   init = (Initialize alloc.Control alloc.Memory rawoop
2886 //                      rawstore1 rawstore2)
2887 //
2888 Node* InitializeNode::capture_store(StoreNode* st, intptr_t start,
2889                                     PhaseTransform* phase) {
2890   assert(stores_are_sane(phase), "");
2891 
2892   if (start < 0)  return NULL;
2893   assert(can_capture_store(st, phase) == start, "sanity");
2894 
2895   Compile* C = phase->C;
2896   int size_in_bytes = st->memory_size();
2897   int i = captured_store_insertion_point(start, size_in_bytes, phase);
2898   if (i == 0)  return NULL;     // bail out
2899   Node* prev_mem = NULL;        // raw memory for the captured store
2900   if (i > 0) {
2901     prev_mem = in(i);           // there is a pre-existing store under this one
2902     set_req(i, C->top());       // temporarily disconnect it
2903     // See StoreNode::Ideal 'st->outcnt() == 1' for the reason to disconnect.
2904   } else {
2905     i = -i;                     // no pre-existing store
2906     prev_mem = zero_memory();   // a slice of the newly allocated object
2907     if (i > InitializeNode::RawStores && in(i-1) == prev_mem)
2908       set_req(--i, C->top());   // reuse this edge; it has been folded away
2909     else
2910       ins_req(i, C->top());     // build a new edge
2911   }
2912   Node* new_st = st->clone();
2913   new_st->set_req(MemNode::Control, in(Control));
2914   new_st->set_req(MemNode::Memory,  prev_mem);
2915   new_st->set_req(MemNode::Address, make_raw_address(start, phase));
2916   new_st = phase->transform(new_st);
2917 
2918   // At this point, new_st might have swallowed a pre-existing store
2919   // at the same offset, or perhaps new_st might have disappeared,
2920   // if it redundantly stored the same value (or zero to fresh memory).
2921 
2922   // In any case, wire it in:
2923   set_req(i, new_st);
2924 
2925   // The caller may now kill the old guy.
2926   DEBUG_ONLY(Node* check_st = find_captured_store(start, size_in_bytes, phase));
2927   assert(check_st == new_st || check_st == NULL, "must be findable");
2928   assert(!is_complete(), "");
2929   return new_st;
2930 }
2931 
2932 static bool store_constant(jlong* tiles, int num_tiles,
2933                            intptr_t st_off, int st_size,
2934                            jlong con) {
2935   if ((st_off & (st_size-1)) != 0)
2936     return false;               // strange store offset (assume size==2**N)
2937   address addr = (address)tiles + st_off;
2938   assert(st_off >= 0 && addr+st_size <= (address)&tiles[num_tiles], "oob");
2939   switch (st_size) {
2940   case sizeof(jbyte):  *(jbyte*) addr = (jbyte) con; break;
2941   case sizeof(jchar):  *(jchar*) addr = (jchar) con; break;
2942   case sizeof(jint):   *(jint*)  addr = (jint)  con; break;
2943   case sizeof(jlong):  *(jlong*) addr = (jlong) con; break;
2944   default: return false;        // strange store size (detect size!=2**N here)
2945   }
2946   return true;                  // return success to caller
2947 }
2948 
2949 // Coalesce subword constants into int constants and possibly
2950 // into long constants.  The goal, if the CPU permits,
2951 // is to initialize the object with a small number of 64-bit tiles.
2952 // Also, convert floating-point constants to bit patterns.
2953 // Non-constants are not relevant to this pass.
2954 //
2955 // In terms of the running example on InitializeNode::InitializeNode
2956 // and InitializeNode::capture_store, here is the transformation
2957 // of rawstore1 and rawstore2 into rawstore12:
2958 //   alloc = (Allocate ...)
2959 //   rawoop = alloc.RawAddress
2960 //   tile12 = 0x00010002
2961 //   rawstore12 = (StoreI alloc.Control alloc.Memory (+ rawoop 12) tile12)
2962 //   init = (Initialize alloc.Control alloc.Memory rawoop rawstore12)
2963 //
2964 void
2965 InitializeNode::coalesce_subword_stores(intptr_t header_size,
2966                                         Node* size_in_bytes,
2967                                         PhaseGVN* phase) {
2968   Compile* C = phase->C;
2969 
2970   assert(stores_are_sane(phase), "");
2971   // Note:  After this pass, they are not completely sane,
2972   // since there may be some overlaps.
2973 
2974   int old_subword = 0, old_long = 0, new_int = 0, new_long = 0;
2975 
2976   intptr_t ti_limit = (TrackedInitializationLimit * HeapWordSize);
2977   intptr_t size_limit = phase->find_intptr_t_con(size_in_bytes, ti_limit);
2978   size_limit = MIN2(size_limit, ti_limit);
2979   size_limit = align_size_up(size_limit, BytesPerLong);
2980   int num_tiles = size_limit / BytesPerLong;
2981 
2982   // allocate space for the tile map:
2983   const int small_len = DEBUG_ONLY(true ? 3 :) 30; // keep stack frames small
2984   jlong  tiles_buf[small_len];
2985   Node*  nodes_buf[small_len];
2986   jlong  inits_buf[small_len];
2987   jlong* tiles = ((num_tiles <= small_len) ? &tiles_buf[0]
2988                   : NEW_RESOURCE_ARRAY(jlong, num_tiles));
2989   Node** nodes = ((num_tiles <= small_len) ? &nodes_buf[0]
2990                   : NEW_RESOURCE_ARRAY(Node*, num_tiles));
2991   jlong* inits = ((num_tiles <= small_len) ? &inits_buf[0]
2992                   : NEW_RESOURCE_ARRAY(jlong, num_tiles));
2993   // tiles: exact bitwise model of all primitive constants
2994   // nodes: last constant-storing node subsumed into the tiles model
2995   // inits: which bytes (in each tile) are touched by any initializations
2996 
2997   //// Pass A: Fill in the tile model with any relevant stores.
2998 
2999   Copy::zero_to_bytes(tiles, sizeof(tiles[0]) * num_tiles);
3000   Copy::zero_to_bytes(nodes, sizeof(nodes[0]) * num_tiles);
3001   Copy::zero_to_bytes(inits, sizeof(inits[0]) * num_tiles);
3002   Node* zmem = zero_memory(); // initially zero memory state
3003   for (uint i = InitializeNode::RawStores, limit = req(); i < limit; i++) {
3004     Node* st = in(i);
3005     intptr_t st_off = get_store_offset(st, phase);
3006 
3007     // Figure out the store's offset and constant value:
3008     if (st_off < header_size)             continue; //skip (ignore header)
3009     if (st->in(MemNode::Memory) != zmem)  continue; //skip (odd store chain)
3010     int st_size = st->as_Store()->memory_size();
3011     if (st_off + st_size > size_limit)    break;
3012 
3013     // Record which bytes are touched, whether by constant or not.
3014     if (!store_constant(inits, num_tiles, st_off, st_size, (jlong) -1))
3015       continue;                 // skip (strange store size)
3016 
3017     const Type* val = phase->type(st->in(MemNode::ValueIn));
3018     if (!val->singleton())                continue; //skip (non-con store)
3019     BasicType type = val->basic_type();
3020 
3021     jlong con = 0;
3022     switch (type) {
3023     case T_INT:    con = val->is_int()->get_con();  break;
3024     case T_LONG:   con = val->is_long()->get_con(); break;
3025     case T_FLOAT:  con = jint_cast(val->getf());    break;
3026     case T_DOUBLE: con = jlong_cast(val->getd());   break;
3027     default:                              continue; //skip (odd store type)
3028     }
3029 
3030     if (type == T_LONG && Matcher::isSimpleConstant64(con) &&
3031         st->Opcode() == Op_StoreL) {
3032       continue;                 // This StoreL is already optimal.
3033     }
3034 
3035     // Store down the constant.
3036     store_constant(tiles, num_tiles, st_off, st_size, con);
3037 
3038     intptr_t j = st_off >> LogBytesPerLong;
3039 
3040     if (type == T_INT && st_size == BytesPerInt
3041         && (st_off & BytesPerInt) == BytesPerInt) {
3042       jlong lcon = tiles[j];
3043       if (!Matcher::isSimpleConstant64(lcon) &&
3044           st->Opcode() == Op_StoreI) {
3045         // This StoreI is already optimal by itself.
3046         jint* intcon = (jint*) &tiles[j];
3047         intcon[1] = 0;  // undo the store_constant()
3048 
3049         // If the previous store is also optimal by itself, back up and
3050         // undo the action of the previous loop iteration... if we can.
3051         // But if we can't, just let the previous half take care of itself.
3052         st = nodes[j];
3053         st_off -= BytesPerInt;
3054         con = intcon[0];
3055         if (con != 0 && st != NULL && st->Opcode() == Op_StoreI) {
3056           assert(st_off >= header_size, "still ignoring header");
3057           assert(get_store_offset(st, phase) == st_off, "must be");
3058           assert(in(i-1) == zmem, "must be");
3059           DEBUG_ONLY(const Type* tcon = phase->type(st->in(MemNode::ValueIn)));
3060           assert(con == tcon->is_int()->get_con(), "must be");
3061           // Undo the effects of the previous loop trip, which swallowed st:
3062           intcon[0] = 0;        // undo store_constant()
3063           set_req(i-1, st);     // undo set_req(i, zmem)
3064           nodes[j] = NULL;      // undo nodes[j] = st
3065           --old_subword;        // undo ++old_subword
3066         }
3067         continue;               // This StoreI is already optimal.
3068       }
3069     }
3070 
3071     // This store is not needed.
3072     set_req(i, zmem);
3073     nodes[j] = st;              // record for the moment
3074     if (st_size < BytesPerLong) // something has changed
3075           ++old_subword;        // includes int/float, but who's counting...
3076     else  ++old_long;
3077   }
3078 
3079   if ((old_subword + old_long) == 0)
3080     return;                     // nothing more to do
3081 
3082   //// Pass B: Convert any non-zero tiles into optimal constant stores.
3083   // Be sure to insert them before overlapping non-constant stores.
3084   // (E.g., byte[] x = { 1,2,y,4 }  =>  x[int 0] = 0x01020004, x[2]=y.)
3085   for (int j = 0; j < num_tiles; j++) {
3086     jlong con  = tiles[j];
3087     jlong init = inits[j];
3088     if (con == 0)  continue;
3089     jint con0,  con1;           // split the constant, address-wise
3090     jint init0, init1;          // split the init map, address-wise
3091     { union { jlong con; jint intcon[2]; } u;
3092       u.con = con;
3093       con0  = u.intcon[0];
3094       con1  = u.intcon[1];
3095       u.con = init;
3096       init0 = u.intcon[0];
3097       init1 = u.intcon[1];
3098     }
3099 
3100     Node* old = nodes[j];
3101     assert(old != NULL, "need the prior store");
3102     intptr_t offset = (j * BytesPerLong);
3103 
3104     bool split = !Matcher::isSimpleConstant64(con);
3105 
3106     if (offset < header_size) {
3107       assert(offset + BytesPerInt >= header_size, "second int counts");
3108       assert(*(jint*)&tiles[j] == 0, "junk in header");
3109       split = true;             // only the second word counts
3110       // Example:  int a[] = { 42 ... }
3111     } else if (con0 == 0 && init0 == -1) {
3112       split = true;             // first word is covered by full inits
3113       // Example:  int a[] = { ... foo(), 42 ... }
3114     } else if (con1 == 0 && init1 == -1) {
3115       split = true;             // second word is covered by full inits
3116       // Example:  int a[] = { ... 42, foo() ... }
3117     }
3118 
3119     // Here's a case where init0 is neither 0 nor -1:
3120     //   byte a[] = { ... 0,0,foo(),0,  0,0,0,42 ... }
3121     // Assuming big-endian memory, init0, init1 are 0x0000FF00, 0x000000FF.
3122     // In this case the tile is not split; it is (jlong)42.
3123     // The big tile is stored down, and then the foo() value is inserted.
3124     // (If there were foo(),foo() instead of foo(),0, init0 would be -1.)
3125 
3126     Node* ctl = old->in(MemNode::Control);
3127     Node* adr = make_raw_address(offset, phase);
3128     const TypePtr* atp = TypeRawPtr::BOTTOM;
3129 
3130     // One or two coalesced stores to plop down.
3131     Node*    st[2];
3132     intptr_t off[2];
3133     int  nst = 0;
3134     if (!split) {
3135       ++new_long;
3136       off[nst] = offset;
3137       st[nst++] = StoreNode::make(*phase, ctl, zmem, adr, atp,
3138                                   phase->longcon(con), T_LONG);
3139     } else {
3140       // Omit either if it is a zero.
3141       if (con0 != 0) {
3142         ++new_int;
3143         off[nst]  = offset;
3144         st[nst++] = StoreNode::make(*phase, ctl, zmem, adr, atp,
3145                                     phase->intcon(con0), T_INT);
3146       }
3147       if (con1 != 0) {
3148         ++new_int;
3149         offset += BytesPerInt;
3150         adr = make_raw_address(offset, phase);
3151         off[nst]  = offset;
3152         st[nst++] = StoreNode::make(*phase, ctl, zmem, adr, atp,
3153                                     phase->intcon(con1), T_INT);
3154       }
3155     }
3156 
3157     // Insert second store first, then the first before the second.
3158     // Insert each one just before any overlapping non-constant stores.
3159     while (nst > 0) {
3160       Node* st1 = st[--nst];
3161       C->copy_node_notes_to(st1, old);
3162       st1 = phase->transform(st1);
3163       offset = off[nst];
3164       assert(offset >= header_size, "do not smash header");
3165       int ins_idx = captured_store_insertion_point(offset, /*size:*/0, phase);
3166       guarantee(ins_idx != 0, "must re-insert constant store");
3167       if (ins_idx < 0)  ins_idx = -ins_idx;  // never overlap
3168       if (ins_idx > InitializeNode::RawStores && in(ins_idx-1) == zmem)
3169         set_req(--ins_idx, st1);
3170       else
3171         ins_req(ins_idx, st1);
3172     }
3173   }
3174 
3175   if (PrintCompilation && WizardMode)
3176     tty->print_cr("Changed %d/%d subword/long constants into %d/%d int/long",
3177                   old_subword, old_long, new_int, new_long);
3178   if (C->log() != NULL)
3179     C->log()->elem("comment that='%d/%d subword/long to %d/%d int/long'",
3180                    old_subword, old_long, new_int, new_long);
3181 
3182   // Clean up any remaining occurrences of zmem:
3183   remove_extra_zeroes();
3184 }
3185 
3186 // Explore forward from in(start) to find the first fully initialized
3187 // word, and return its offset.  Skip groups of subword stores which
3188 // together initialize full words.  If in(start) is itself part of a
3189 // fully initialized word, return the offset of in(start).  If there
3190 // are no following full-word stores, or if something is fishy, return
3191 // a negative value.
3192 intptr_t InitializeNode::find_next_fullword_store(uint start, PhaseGVN* phase) {
3193   int       int_map = 0;
3194   intptr_t  int_map_off = 0;
3195   const int FULL_MAP = right_n_bits(BytesPerInt);  // the int_map we hope for
3196 
3197   for (uint i = start, limit = req(); i < limit; i++) {
3198     Node* st = in(i);
3199 
3200     intptr_t st_off = get_store_offset(st, phase);
3201     if (st_off < 0)  break;  // return conservative answer
3202 
3203     int st_size = st->as_Store()->memory_size();
3204     if (st_size >= BytesPerInt && (st_off % BytesPerInt) == 0) {
3205       return st_off;            // we found a complete word init
3206     }
3207 
3208     // update the map:
3209 
3210     intptr_t this_int_off = align_size_down(st_off, BytesPerInt);
3211     if (this_int_off != int_map_off) {
3212       // reset the map:
3213       int_map = 0;
3214       int_map_off = this_int_off;
3215     }
3216 
3217     int subword_off = st_off - this_int_off;
3218     int_map |= right_n_bits(st_size) << subword_off;
3219     if ((int_map & FULL_MAP) == FULL_MAP) {
3220       return this_int_off;      // we found a complete word init
3221     }
3222 
3223     // Did this store hit or cross the word boundary?
3224     intptr_t next_int_off = align_size_down(st_off + st_size, BytesPerInt);
3225     if (next_int_off == this_int_off + BytesPerInt) {
3226       // We passed the current int, without fully initializing it.
3227       int_map_off = next_int_off;
3228       int_map >>= BytesPerInt;
3229     } else if (next_int_off > this_int_off + BytesPerInt) {
3230       // We passed the current and next int.
3231       return this_int_off + BytesPerInt;
3232     }
3233   }
3234 
3235   return -1;
3236 }
3237 
3238 
3239 // Called when the associated AllocateNode is expanded into CFG.
3240 // At this point, we may perform additional optimizations.
3241 // Linearize the stores by ascending offset, to make memory
3242 // activity as coherent as possible.
3243 Node* InitializeNode::complete_stores(Node* rawctl, Node* rawmem, Node* rawptr,
3244                                       intptr_t header_size,
3245                                       Node* size_in_bytes,
3246                                       PhaseGVN* phase) {
3247   assert(!is_complete(), "not already complete");
3248   assert(stores_are_sane(phase), "");
3249   assert(allocation() != NULL, "must be present");
3250 
3251   remove_extra_zeroes();
3252 
3253   if (ReduceFieldZeroing || ReduceBulkZeroing)
3254     // reduce instruction count for common initialization patterns
3255     coalesce_subword_stores(header_size, size_in_bytes, phase);
3256 
3257   Node* zmem = zero_memory();   // initially zero memory state
3258   Node* inits = zmem;           // accumulating a linearized chain of inits
3259   #ifdef ASSERT
3260   intptr_t first_offset = allocation()->minimum_header_size();
3261   intptr_t last_init_off = first_offset;  // previous init offset
3262   intptr_t last_init_end = first_offset;  // previous init offset+size
3263   intptr_t last_tile_end = first_offset;  // previous tile offset+size
3264   #endif
3265   intptr_t zeroes_done = header_size;
3266 
3267   bool do_zeroing = true;       // we might give up if inits are very sparse
3268   int  big_init_gaps = 0;       // how many large gaps have we seen?
3269 
3270   if (ZeroTLAB)  do_zeroing = false;
3271   if (!ReduceFieldZeroing && !ReduceBulkZeroing)  do_zeroing = false;
3272 
3273   for (uint i = InitializeNode::RawStores, limit = req(); i < limit; i++) {
3274     Node* st = in(i);
3275     intptr_t st_off = get_store_offset(st, phase);
3276     if (st_off < 0)
3277       break;                    // unknown junk in the inits
3278     if (st->in(MemNode::Memory) != zmem)
3279       break;                    // complicated store chains somehow in list
3280 
3281     int st_size = st->as_Store()->memory_size();
3282     intptr_t next_init_off = st_off + st_size;
3283 
3284     if (do_zeroing && zeroes_done < next_init_off) {
3285       // See if this store needs a zero before it or under it.
3286       intptr_t zeroes_needed = st_off;
3287 
3288       if (st_size < BytesPerInt) {
3289         // Look for subword stores which only partially initialize words.
3290         // If we find some, we must lay down some word-level zeroes first,
3291         // underneath the subword stores.
3292         //
3293         // Examples:
3294         //   byte[] a = { p,q,r,s }  =>  a[0]=p,a[1]=q,a[2]=r,a[3]=s
3295         //   byte[] a = { x,y,0,0 }  =>  a[0..3] = 0, a[0]=x,a[1]=y
3296         //   byte[] a = { 0,0,z,0 }  =>  a[0..3] = 0, a[2]=z
3297         //
3298         // Note:  coalesce_subword_stores may have already done this,
3299         // if it was prompted by constant non-zero subword initializers.
3300         // But this case can still arise with non-constant stores.
3301 
3302         intptr_t next_full_store = find_next_fullword_store(i, phase);
3303 
3304         // In the examples above:
3305         //   in(i)          p   q   r   s     x   y     z
3306         //   st_off        12  13  14  15    12  13    14
3307         //   st_size        1   1   1   1     1   1     1
3308         //   next_full_s.  12  16  16  16    16  16    16
3309         //   z's_done      12  16  16  16    12  16    12
3310         //   z's_needed    12  16  16  16    16  16    16
3311         //   zsize          0   0   0   0     4   0     4
3312         if (next_full_store < 0) {
3313           // Conservative tack:  Zero to end of current word.
3314           zeroes_needed = align_size_up(zeroes_needed, BytesPerInt);
3315         } else {
3316           // Zero to beginning of next fully initialized word.
3317           // Or, don't zero at all, if we are already in that word.
3318           assert(next_full_store >= zeroes_needed, "must go forward");
3319           assert((next_full_store & (BytesPerInt-1)) == 0, "even boundary");
3320           zeroes_needed = next_full_store;
3321         }
3322       }
3323 
3324       if (zeroes_needed > zeroes_done) {
3325         intptr_t zsize = zeroes_needed - zeroes_done;
3326         // Do some incremental zeroing on rawmem, in parallel with inits.
3327         zeroes_done = align_size_down(zeroes_done, BytesPerInt);
3328         rawmem = ClearArrayNode::clear_memory(rawctl, rawmem, rawptr,
3329                                               zeroes_done, zeroes_needed,
3330                                               phase);
3331         zeroes_done = zeroes_needed;
3332         if (zsize > Matcher::init_array_short_size && ++big_init_gaps > 2)
3333           do_zeroing = false;   // leave the hole, next time
3334       }
3335     }
3336 
3337     // Collect the store and move on:
3338     st->set_req(MemNode::Memory, inits);
3339     inits = st;                 // put it on the linearized chain
3340     set_req(i, zmem);           // unhook from previous position
3341 
3342     if (zeroes_done == st_off)
3343       zeroes_done = next_init_off;
3344 
3345     assert(!do_zeroing || zeroes_done >= next_init_off, "don't miss any");
3346 
3347     #ifdef ASSERT
3348     // Various order invariants.  Weaker than stores_are_sane because
3349     // a large constant tile can be filled in by smaller non-constant stores.
3350     assert(st_off >= last_init_off, "inits do not reverse");
3351     last_init_off = st_off;
3352     const Type* val = NULL;
3353     if (st_size >= BytesPerInt &&
3354         (val = phase->type(st->in(MemNode::ValueIn)))->singleton() &&
3355         (int)val->basic_type() < (int)T_OBJECT) {
3356       assert(st_off >= last_tile_end, "tiles do not overlap");
3357       assert(st_off >= last_init_end, "tiles do not overwrite inits");
3358       last_tile_end = MAX2(last_tile_end, next_init_off);
3359     } else {
3360       intptr_t st_tile_end = align_size_up(next_init_off, BytesPerLong);
3361       assert(st_tile_end >= last_tile_end, "inits stay with tiles");
3362       assert(st_off      >= last_init_end, "inits do not overlap");
3363       last_init_end = next_init_off;  // it's a non-tile
3364     }
3365     #endif //ASSERT
3366   }
3367 
3368   remove_extra_zeroes();        // clear out all the zmems left over
3369   add_req(inits);
3370 
3371   if (!ZeroTLAB) {
3372     // If anything remains to be zeroed, zero it all now.
3373     zeroes_done = align_size_down(zeroes_done, BytesPerInt);
3374     // if it is the last unused 4 bytes of an instance, forget about it
3375     intptr_t size_limit = phase->find_intptr_t_con(size_in_bytes, max_jint);
3376     if (zeroes_done + BytesPerLong >= size_limit) {
3377       assert(allocation() != NULL, "");
3378       Node* klass_node = allocation()->in(AllocateNode::KlassNode);
3379       ciKlass* k = phase->type(klass_node)->is_klassptr()->klass();
3380       if (zeroes_done == k->layout_helper())
3381         zeroes_done = size_limit;
3382     }
3383     if (zeroes_done < size_limit) {
3384       rawmem = ClearArrayNode::clear_memory(rawctl, rawmem, rawptr,
3385                                             zeroes_done, size_in_bytes, phase);
3386     }
3387   }
3388 
3389   set_complete(phase);
3390   return rawmem;
3391 }
3392 
3393 
3394 #ifdef ASSERT
3395 bool InitializeNode::stores_are_sane(PhaseTransform* phase) {
3396   if (is_complete())
3397     return true;                // stores could be anything at this point
3398   assert(allocation() != NULL, "must be present");
3399   intptr_t last_off = allocation()->minimum_header_size();
3400   for (uint i = InitializeNode::RawStores; i < req(); i++) {
3401     Node* st = in(i);
3402     intptr_t st_off = get_store_offset(st, phase);
3403     if (st_off < 0)  continue;  // ignore dead garbage
3404     if (last_off > st_off) {
3405       tty->print_cr("*** bad store offset at %d: %d > %d", i, last_off, st_off);
3406       this->dump(2);
3407       assert(false, "ascending store offsets");
3408       return false;
3409     }
3410     last_off = st_off + st->as_Store()->memory_size();
3411   }
3412   return true;
3413 }
3414 #endif //ASSERT
3415 
3416 
3417 
3418 
3419 //============================MergeMemNode=====================================
3420 //
3421 // SEMANTICS OF MEMORY MERGES:  A MergeMem is a memory state assembled from several
3422 // contributing store or call operations.  Each contributor provides the memory
3423 // state for a particular "alias type" (see Compile::alias_type).  For example,
3424 // if a MergeMem has an input X for alias category #6, then any memory reference
3425 // to alias category #6 may use X as its memory state input, as an exact equivalent
3426 // to using the MergeMem as a whole.
3427 //   Load<6>( MergeMem(<6>: X, ...), p ) <==> Load<6>(X,p)
3428 //
3429 // (Here, the <N> notation gives the index of the relevant adr_type.)
3430 //
3431 // In one special case (and more cases in the future), alias categories overlap.
3432 // The special alias category "Bot" (Compile::AliasIdxBot) includes all memory
3433 // states.  Therefore, if a MergeMem has only one contributing input W for Bot,
3434 // it is exactly equivalent to that state W:
3435 //   MergeMem(<Bot>: W) <==> W
3436 //
3437 // Usually, the merge has more than one input.  In that case, where inputs
3438 // overlap (i.e., one is Bot), the narrower alias type determines the memory
3439 // state for that type, and the wider alias type (Bot) fills in everywhere else:
3440 //   Load<5>( MergeMem(<Bot>: W, <6>: X), p ) <==> Load<5>(W,p)
3441 //   Load<6>( MergeMem(<Bot>: W, <6>: X), p ) <==> Load<6>(X,p)
3442 //
3443 // A merge can take a "wide" memory state as one of its narrow inputs.
3444 // This simply means that the merge observes out only the relevant parts of
3445 // the wide input.  That is, wide memory states arriving at narrow merge inputs
3446 // are implicitly "filtered" or "sliced" as necessary.  (This is rare.)
3447 //
3448 // These rules imply that MergeMem nodes may cascade (via their <Bot> links),
3449 // and that memory slices "leak through":
3450 //   MergeMem(<Bot>: MergeMem(<Bot>: W, <7>: Y)) <==> MergeMem(<Bot>: W, <7>: Y)
3451 //
3452 // But, in such a cascade, repeated memory slices can "block the leak":
3453 //   MergeMem(<Bot>: MergeMem(<Bot>: W, <7>: Y), <7>: Y') <==> MergeMem(<Bot>: W, <7>: Y')
3454 //
3455 // In the last example, Y is not part of the combined memory state of the
3456 // outermost MergeMem.  The system must, of course, prevent unschedulable
3457 // memory states from arising, so you can be sure that the state Y is somehow
3458 // a precursor to state Y'.
3459 //
3460 //
3461 // REPRESENTATION OF MEMORY MERGES: The indexes used to address the Node::in array
3462 // of each MergeMemNode array are exactly the numerical alias indexes, including
3463 // but not limited to AliasIdxTop, AliasIdxBot, and AliasIdxRaw.  The functions
3464 // Compile::alias_type (and kin) produce and manage these indexes.
3465 //
3466 // By convention, the value of in(AliasIdxTop) (i.e., in(1)) is always the top node.
3467 // (Note that this provides quick access to the top node inside MergeMem methods,
3468 // without the need to reach out via TLS to Compile::current.)
3469 //
3470 // As a consequence of what was just described, a MergeMem that represents a full
3471 // memory state has an edge in(AliasIdxBot) which is a "wide" memory state,
3472 // containing all alias categories.
3473 //
3474 // MergeMem nodes never (?) have control inputs, so in(0) is NULL.
3475 //
3476 // All other edges in(N) (including in(AliasIdxRaw), which is in(3)) are either
3477 // a memory state for the alias type <N>, or else the top node, meaning that
3478 // there is no particular input for that alias type.  Note that the length of
3479 // a MergeMem is variable, and may be extended at any time to accommodate new
3480 // memory states at larger alias indexes.  When merges grow, they are of course
3481 // filled with "top" in the unused in() positions.
3482 //
3483 // This use of top is named "empty_memory()", or "empty_mem" (no-memory) as a variable.
3484 // (Top was chosen because it works smoothly with passes like GCM.)
3485 //
3486 // For convenience, we hardwire the alias index for TypeRawPtr::BOTTOM.  (It is
3487 // the type of random VM bits like TLS references.)  Since it is always the
3488 // first non-Bot memory slice, some low-level loops use it to initialize an
3489 // index variable:  for (i = AliasIdxRaw; i < req(); i++).
3490 //
3491 //
3492 // ACCESSORS:  There is a special accessor MergeMemNode::base_memory which returns
3493 // the distinguished "wide" state.  The accessor MergeMemNode::memory_at(N) returns
3494 // the memory state for alias type <N>, or (if there is no particular slice at <N>,
3495 // it returns the base memory.  To prevent bugs, memory_at does not accept <Top>
3496 // or <Bot> indexes.  The iterator MergeMemStream provides robust iteration over
3497 // MergeMem nodes or pairs of such nodes, ensuring that the non-top edges are visited.
3498 //
3499 // %%%% We may get rid of base_memory as a separate accessor at some point; it isn't
3500 // really that different from the other memory inputs.  An abbreviation called
3501 // "bot_memory()" for "memory_at(AliasIdxBot)" would keep code tidy.
3502 //
3503 //
3504 // PARTIAL MEMORY STATES:  During optimization, MergeMem nodes may arise that represent
3505 // partial memory states.  When a Phi splits through a MergeMem, the copy of the Phi
3506 // that "emerges though" the base memory will be marked as excluding the alias types
3507 // of the other (narrow-memory) copies which "emerged through" the narrow edges:
3508 //
3509 //   Phi<Bot>(U, MergeMem(<Bot>: W, <8>: Y))
3510 //     ==Ideal=>  MergeMem(<Bot>: Phi<Bot-8>(U, W), Phi<8>(U, Y))
3511 //
3512 // This strange "subtraction" effect is necessary to ensure IGVN convergence.
3513 // (It is currently unimplemented.)  As you can see, the resulting merge is
3514 // actually a disjoint union of memory states, rather than an overlay.
3515 //
3516 
3517 //------------------------------MergeMemNode-----------------------------------
3518 Node* MergeMemNode::make_empty_memory() {
3519   Node* empty_memory = (Node*) Compile::current()->top();
3520   assert(empty_memory->is_top(), "correct sentinel identity");
3521   return empty_memory;
3522 }
3523 
3524 MergeMemNode::MergeMemNode(Node *new_base) : Node(1+Compile::AliasIdxRaw) {
3525   init_class_id(Class_MergeMem);
3526   // all inputs are nullified in Node::Node(int)
3527   // set_input(0, NULL);  // no control input
3528 
3529   // Initialize the edges uniformly to top, for starters.
3530   Node* empty_mem = make_empty_memory();
3531   for (uint i = Compile::AliasIdxTop; i < req(); i++) {
3532     init_req(i,empty_mem);
3533   }
3534   assert(empty_memory() == empty_mem, "");
3535 
3536   if( new_base != NULL && new_base->is_MergeMem() ) {
3537     MergeMemNode* mdef = new_base->as_MergeMem();
3538     assert(mdef->empty_memory() == empty_mem, "consistent sentinels");
3539     for (MergeMemStream mms(this, mdef); mms.next_non_empty2(); ) {
3540       mms.set_memory(mms.memory2());
3541     }
3542     assert(base_memory() == mdef->base_memory(), "");
3543   } else {
3544     set_base_memory(new_base);
3545   }
3546 }
3547 
3548 // Make a new, untransformed MergeMem with the same base as 'mem'.
3549 // If mem is itself a MergeMem, populate the result with the same edges.
3550 MergeMemNode* MergeMemNode::make(Compile* C, Node* mem) {
3551   return new(C, 1+Compile::AliasIdxRaw) MergeMemNode(mem);
3552 }
3553 
3554 //------------------------------cmp--------------------------------------------
3555 uint MergeMemNode::hash() const { return NO_HASH; }
3556 uint MergeMemNode::cmp( const Node &n ) const {
3557   return (&n == this);          // Always fail except on self
3558 }
3559 
3560 //------------------------------Identity---------------------------------------
3561 Node* MergeMemNode::Identity(PhaseTransform *phase) {
3562   // Identity if this merge point does not record any interesting memory
3563   // disambiguations.
3564   Node* base_mem = base_memory();
3565   Node* empty_mem = empty_memory();
3566   if (base_mem != empty_mem) {  // Memory path is not dead?
3567     for (uint i = Compile::AliasIdxRaw; i < req(); i++) {
3568       Node* mem = in(i);
3569       if (mem != empty_mem && mem != base_mem) {
3570         return this;            // Many memory splits; no change
3571       }
3572     }
3573   }
3574   return base_mem;              // No memory splits; ID on the one true input
3575 }
3576 
3577 //------------------------------Ideal------------------------------------------
3578 // This method is invoked recursively on chains of MergeMem nodes
3579 Node *MergeMemNode::Ideal(PhaseGVN *phase, bool can_reshape) {
3580   // Remove chain'd MergeMems
3581   //
3582   // This is delicate, because the each "in(i)" (i >= Raw) is interpreted
3583   // relative to the "in(Bot)".  Since we are patching both at the same time,
3584   // we have to be careful to read each "in(i)" relative to the old "in(Bot)",
3585   // but rewrite each "in(i)" relative to the new "in(Bot)".
3586   Node *progress = NULL;
3587 
3588 
3589   Node* old_base = base_memory();
3590   Node* empty_mem = empty_memory();
3591   if (old_base == empty_mem)
3592     return NULL; // Dead memory path.
3593 
3594   MergeMemNode* old_mbase;
3595   if (old_base != NULL && old_base->is_MergeMem())
3596     old_mbase = old_base->as_MergeMem();
3597   else
3598     old_mbase = NULL;
3599   Node* new_base = old_base;
3600 
3601   // simplify stacked MergeMems in base memory
3602   if (old_mbase)  new_base = old_mbase->base_memory();
3603 
3604   // the base memory might contribute new slices beyond my req()
3605   if (old_mbase)  grow_to_match(old_mbase);
3606 
3607   // Look carefully at the base node if it is a phi.
3608   PhiNode* phi_base;
3609   if (new_base != NULL && new_base->is_Phi())
3610     phi_base = new_base->as_Phi();
3611   else
3612     phi_base = NULL;
3613 
3614   Node*    phi_reg = NULL;
3615   uint     phi_len = (uint)-1;
3616   if (phi_base != NULL && !phi_base->is_copy()) {
3617     // do not examine phi if degraded to a copy
3618     phi_reg = phi_base->region();
3619     phi_len = phi_base->req();
3620     // see if the phi is unfinished
3621     for (uint i = 1; i < phi_len; i++) {
3622       if (phi_base->in(i) == NULL) {
3623         // incomplete phi; do not look at it yet!
3624         phi_reg = NULL;
3625         phi_len = (uint)-1;
3626         break;
3627       }
3628     }
3629   }
3630 
3631   // Note:  We do not call verify_sparse on entry, because inputs
3632   // can normalize to the base_memory via subsume_node or similar
3633   // mechanisms.  This method repairs that damage.
3634 
3635   assert(!old_mbase || old_mbase->is_empty_memory(empty_mem), "consistent sentinels");
3636 
3637   // Look at each slice.
3638   for (uint i = Compile::AliasIdxRaw; i < req(); i++) {
3639     Node* old_in = in(i);
3640     // calculate the old memory value
3641     Node* old_mem = old_in;
3642     if (old_mem == empty_mem)  old_mem = old_base;
3643     assert(old_mem == memory_at(i), "");
3644 
3645     // maybe update (reslice) the old memory value
3646 
3647     // simplify stacked MergeMems
3648     Node* new_mem = old_mem;
3649     MergeMemNode* old_mmem;
3650     if (old_mem != NULL && old_mem->is_MergeMem())
3651       old_mmem = old_mem->as_MergeMem();
3652     else
3653       old_mmem = NULL;
3654     if (old_mmem == this) {
3655       // This can happen if loops break up and safepoints disappear.
3656       // A merge of BotPtr (default) with a RawPtr memory derived from a
3657       // safepoint can be rewritten to a merge of the same BotPtr with
3658       // the BotPtr phi coming into the loop.  If that phi disappears
3659       // also, we can end up with a self-loop of the mergemem.
3660       // In general, if loops degenerate and memory effects disappear,
3661       // a mergemem can be left looking at itself.  This simply means
3662       // that the mergemem's default should be used, since there is
3663       // no longer any apparent effect on this slice.
3664       // Note: If a memory slice is a MergeMem cycle, it is unreachable
3665       //       from start.  Update the input to TOP.
3666       new_mem = (new_base == this || new_base == empty_mem)? empty_mem : new_base;
3667     }
3668     else if (old_mmem != NULL) {
3669       new_mem = old_mmem->memory_at(i);
3670     }
3671     // else preceeding memory was not a MergeMem
3672 
3673     // replace equivalent phis (unfortunately, they do not GVN together)
3674     if (new_mem != NULL && new_mem != new_base &&
3675         new_mem->req() == phi_len && new_mem->in(0) == phi_reg) {
3676       if (new_mem->is_Phi()) {
3677         PhiNode* phi_mem = new_mem->as_Phi();
3678         for (uint i = 1; i < phi_len; i++) {
3679           if (phi_base->in(i) != phi_mem->in(i)) {
3680             phi_mem = NULL;
3681             break;
3682           }
3683         }
3684         if (phi_mem != NULL) {
3685           // equivalent phi nodes; revert to the def
3686           new_mem = new_base;
3687         }
3688       }
3689     }
3690 
3691     // maybe store down a new value
3692     Node* new_in = new_mem;
3693     if (new_in == new_base)  new_in = empty_mem;
3694 
3695     if (new_in != old_in) {
3696       // Warning:  Do not combine this "if" with the previous "if"
3697       // A memory slice might have be be rewritten even if it is semantically
3698       // unchanged, if the base_memory value has changed.
3699       set_req(i, new_in);
3700       progress = this;          // Report progress
3701     }
3702   }
3703 
3704   if (new_base != old_base) {
3705     set_req(Compile::AliasIdxBot, new_base);
3706     // Don't use set_base_memory(new_base), because we need to update du.
3707     assert(base_memory() == new_base, "");
3708     progress = this;
3709   }
3710 
3711   if( base_memory() == this ) {
3712     // a self cycle indicates this memory path is dead
3713     set_req(Compile::AliasIdxBot, empty_mem);
3714   }
3715 
3716   // Resolve external cycles by calling Ideal on a MergeMem base_memory
3717   // Recursion must occur after the self cycle check above
3718   if( base_memory()->is_MergeMem() ) {
3719     MergeMemNode *new_mbase = base_memory()->as_MergeMem();
3720     Node *m = phase->transform(new_mbase);  // Rollup any cycles
3721     if( m != NULL && (m->is_top() ||
3722         m->is_MergeMem() && m->as_MergeMem()->base_memory() == empty_mem) ) {
3723       // propagate rollup of dead cycle to self
3724       set_req(Compile::AliasIdxBot, empty_mem);
3725     }
3726   }
3727 
3728   if( base_memory() == empty_mem ) {
3729     progress = this;
3730     // Cut inputs during Parse phase only.
3731     // During Optimize phase a dead MergeMem node will be subsumed by Top.
3732     if( !can_reshape ) {
3733       for (uint i = Compile::AliasIdxRaw; i < req(); i++) {
3734         if( in(i) != empty_mem ) { set_req(i, empty_mem); }
3735       }
3736     }
3737   }
3738 
3739   if( !progress && base_memory()->is_Phi() && can_reshape ) {
3740     // Check if PhiNode::Ideal's "Split phis through memory merges"
3741     // transform should be attempted. Look for this->phi->this cycle.
3742     uint merge_width = req();
3743     if (merge_width > Compile::AliasIdxRaw) {
3744       PhiNode* phi = base_memory()->as_Phi();
3745       for( uint i = 1; i < phi->req(); ++i ) {// For all paths in
3746         if (phi->in(i) == this) {
3747           phase->is_IterGVN()->_worklist.push(phi);
3748           break;
3749         }
3750       }
3751     }
3752   }
3753 
3754   assert(progress || verify_sparse(), "please, no dups of base");
3755   return progress;
3756 }
3757 
3758 //-------------------------set_base_memory-------------------------------------
3759 void MergeMemNode::set_base_memory(Node *new_base) {
3760   Node* empty_mem = empty_memory();
3761   set_req(Compile::AliasIdxBot, new_base);
3762   assert(memory_at(req()) == new_base, "must set default memory");
3763   // Clear out other occurrences of new_base:
3764   if (new_base != empty_mem) {
3765     for (uint i = Compile::AliasIdxRaw; i < req(); i++) {
3766       if (in(i) == new_base)  set_req(i, empty_mem);
3767     }
3768   }
3769 }
3770 
3771 //------------------------------out_RegMask------------------------------------
3772 const RegMask &MergeMemNode::out_RegMask() const {
3773   return RegMask::Empty;
3774 }
3775 
3776 //------------------------------dump_spec--------------------------------------
3777 #ifndef PRODUCT
3778 void MergeMemNode::dump_spec(outputStream *st) const {
3779   st->print(" {");
3780   Node* base_mem = base_memory();
3781   for( uint i = Compile::AliasIdxRaw; i < req(); i++ ) {
3782     Node* mem = memory_at(i);
3783     if (mem == base_mem) { st->print(" -"); continue; }
3784     st->print( " N%d:", mem->_idx );
3785     Compile::current()->get_adr_type(i)->dump_on(st);
3786   }
3787   st->print(" }");
3788 }
3789 #endif // !PRODUCT
3790 
3791 
3792 #ifdef ASSERT
3793 static bool might_be_same(Node* a, Node* b) {
3794   if (a == b)  return true;
3795   if (!(a->is_Phi() || b->is_Phi()))  return false;
3796   // phis shift around during optimization
3797   return true;  // pretty stupid...
3798 }
3799 
3800 // verify a narrow slice (either incoming or outgoing)
3801 static void verify_memory_slice(const MergeMemNode* m, int alias_idx, Node* n) {
3802   if (!VerifyAliases)       return;  // don't bother to verify unless requested
3803   if (is_error_reported())  return;  // muzzle asserts when debugging an error
3804   if (Node::in_dump())      return;  // muzzle asserts when printing
3805   assert(alias_idx >= Compile::AliasIdxRaw, "must not disturb base_memory or sentinel");
3806   assert(n != NULL, "");
3807   // Elide intervening MergeMem's
3808   while (n->is_MergeMem()) {
3809     n = n->as_MergeMem()->memory_at(alias_idx);
3810   }
3811   Compile* C = Compile::current();
3812   const TypePtr* n_adr_type = n->adr_type();
3813   if (n == m->empty_memory()) {
3814     // Implicit copy of base_memory()
3815   } else if (n_adr_type != TypePtr::BOTTOM) {
3816     assert(n_adr_type != NULL, "new memory must have a well-defined adr_type");
3817     assert(C->must_alias(n_adr_type, alias_idx), "new memory must match selected slice");
3818   } else {
3819     // A few places like make_runtime_call "know" that VM calls are narrow,
3820     // and can be used to update only the VM bits stored as TypeRawPtr::BOTTOM.
3821     bool expected_wide_mem = false;
3822     if (n == m->base_memory()) {
3823       expected_wide_mem = true;
3824     } else if (alias_idx == Compile::AliasIdxRaw ||
3825                n == m->memory_at(Compile::AliasIdxRaw)) {
3826       expected_wide_mem = true;
3827     } else if (!C->alias_type(alias_idx)->is_rewritable()) {
3828       // memory can "leak through" calls on channels that
3829       // are write-once.  Allow this also.
3830       expected_wide_mem = true;
3831     }
3832     assert(expected_wide_mem, "expected narrow slice replacement");
3833   }
3834 }
3835 #else // !ASSERT
3836 #define verify_memory_slice(m,i,n) (0)  // PRODUCT version is no-op
3837 #endif
3838 
3839 
3840 //-----------------------------memory_at---------------------------------------
3841 Node* MergeMemNode::memory_at(uint alias_idx) const {
3842   assert(alias_idx >= Compile::AliasIdxRaw ||
3843          alias_idx == Compile::AliasIdxBot && Compile::current()->AliasLevel() == 0,
3844          "must avoid base_memory and AliasIdxTop");
3845 
3846   // Otherwise, it is a narrow slice.
3847   Node* n = alias_idx < req() ? in(alias_idx) : empty_memory();
3848   Compile *C = Compile::current();
3849   if (is_empty_memory(n)) {
3850     // the array is sparse; empty slots are the "top" node
3851     n = base_memory();
3852     assert(Node::in_dump()
3853            || n == NULL || n->bottom_type() == Type::TOP
3854            || n->adr_type() == TypePtr::BOTTOM
3855            || n->adr_type() == TypeRawPtr::BOTTOM
3856            || Compile::current()->AliasLevel() == 0,
3857            "must be a wide memory");
3858     // AliasLevel == 0 if we are organizing the memory states manually.
3859     // See verify_memory_slice for comments on TypeRawPtr::BOTTOM.
3860   } else {
3861     // make sure the stored slice is sane
3862     #ifdef ASSERT
3863     if (is_error_reported() || Node::in_dump()) {
3864     } else if (might_be_same(n, base_memory())) {
3865       // Give it a pass:  It is a mostly harmless repetition of the base.
3866       // This can arise normally from node subsumption during optimization.
3867     } else {
3868       verify_memory_slice(this, alias_idx, n);
3869     }
3870     #endif
3871   }
3872   return n;
3873 }
3874 
3875 //---------------------------set_memory_at-------------------------------------
3876 void MergeMemNode::set_memory_at(uint alias_idx, Node *n) {
3877   verify_memory_slice(this, alias_idx, n);
3878   Node* empty_mem = empty_memory();
3879   if (n == base_memory())  n = empty_mem;  // collapse default
3880   uint need_req = alias_idx+1;
3881   if (req() < need_req) {
3882     if (n == empty_mem)  return;  // already the default, so do not grow me
3883     // grow the sparse array
3884     do {
3885       add_req(empty_mem);
3886     } while (req() < need_req);
3887   }
3888   set_req( alias_idx, n );
3889 }
3890 
3891 
3892 
3893 //--------------------------iteration_setup------------------------------------
3894 void MergeMemNode::iteration_setup(const MergeMemNode* other) {
3895   if (other != NULL) {
3896     grow_to_match(other);
3897     // invariant:  the finite support of mm2 is within mm->req()
3898     #ifdef ASSERT
3899     for (uint i = req(); i < other->req(); i++) {
3900       assert(other->is_empty_memory(other->in(i)), "slice left uncovered");
3901     }
3902     #endif
3903   }
3904   // Replace spurious copies of base_memory by top.
3905   Node* base_mem = base_memory();
3906   if (base_mem != NULL && !base_mem->is_top()) {
3907     for (uint i = Compile::AliasIdxBot+1, imax = req(); i < imax; i++) {
3908       if (in(i) == base_mem)
3909         set_req(i, empty_memory());
3910     }
3911   }
3912 }
3913 
3914 //---------------------------grow_to_match-------------------------------------
3915 void MergeMemNode::grow_to_match(const MergeMemNode* other) {
3916   Node* empty_mem = empty_memory();
3917   assert(other->is_empty_memory(empty_mem), "consistent sentinels");
3918   // look for the finite support of the other memory
3919   for (uint i = other->req(); --i >= req(); ) {
3920     if (other->in(i) != empty_mem) {
3921       uint new_len = i+1;
3922       while (req() < new_len)  add_req(empty_mem);
3923       break;
3924     }
3925   }
3926 }
3927 
3928 //---------------------------verify_sparse-------------------------------------
3929 #ifndef PRODUCT
3930 bool MergeMemNode::verify_sparse() const {
3931   assert(is_empty_memory(make_empty_memory()), "sane sentinel");
3932   Node* base_mem = base_memory();
3933   // The following can happen in degenerate cases, since empty==top.
3934   if (is_empty_memory(base_mem))  return true;
3935   for (uint i = Compile::AliasIdxRaw; i < req(); i++) {
3936     assert(in(i) != NULL, "sane slice");
3937     if (in(i) == base_mem)  return false;  // should have been the sentinel value!
3938   }
3939   return true;
3940 }
3941 
3942 bool MergeMemStream::match_memory(Node* mem, const MergeMemNode* mm, int idx) {
3943   Node* n;
3944   n = mm->in(idx);
3945   if (mem == n)  return true;  // might be empty_memory()
3946   n = (idx == Compile::AliasIdxBot)? mm->base_memory(): mm->memory_at(idx);
3947   if (mem == n)  return true;
3948   while (n->is_Phi() && (n = n->as_Phi()->is_copy()) != NULL) {
3949     if (mem == n)  return true;
3950     if (n == NULL)  break;
3951   }
3952   return false;
3953 }
3954 #endif // !PRODUCT