1 /*
   2  * Copyright (c) 1999, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #ifndef SHARE_VM_C1_C1_INSTRUCTION_HPP
  26 #define SHARE_VM_C1_C1_INSTRUCTION_HPP
  27 
  28 #include "c1/c1_Compilation.hpp"
  29 #include "c1/c1_LIR.hpp"
  30 #include "c1/c1_ValueType.hpp"
  31 #include "ci/ciField.hpp"
  32 
  33 // Predefined classes
  34 class ciField;
  35 class ValueStack;
  36 class InstructionPrinter;
  37 class IRScope;
  38 class LIR_OprDesc;
  39 typedef LIR_OprDesc* LIR_Opr;
  40 
  41 
  42 // Instruction class hierarchy
  43 //
  44 // All leaf classes in the class hierarchy are concrete classes
  45 // (i.e., are instantiated). All other classes are abstract and
  46 // serve factoring.
  47 
  48 class Instruction;
  49 class   Phi;
  50 class   Local;
  51 class   Constant;
  52 class   AccessField;
  53 class     LoadField;
  54 class     StoreField;
  55 class   AccessArray;
  56 class     ArrayLength;
  57 class     AccessIndexed;
  58 class       LoadIndexed;
  59 class       StoreIndexed;
  60 class   NegateOp;
  61 class   Op2;
  62 class     ArithmeticOp;
  63 class     ShiftOp;
  64 class     LogicOp;
  65 class     CompareOp;
  66 class     IfOp;
  67 class   Convert;
  68 class   NullCheck;
  69 class   TypeCast;
  70 class   OsrEntry;
  71 class   ExceptionObject;
  72 class   StateSplit;
  73 class     Invoke;
  74 class     NewInstance;
  75 class     NewValueTypeInstance;
  76 class     NewArray;
  77 class       NewTypeArray;
  78 class       NewObjectArray;
  79 class       NewMultiArray;
  80 class     TypeCheck;
  81 class       CheckCast;
  82 class       InstanceOf;
  83 class     AccessMonitor;
  84 class       MonitorEnter;
  85 class       MonitorExit;
  86 class     Intrinsic;
  87 class     BlockBegin;
  88 class     BlockEnd;
  89 class       Goto;
  90 class       If;
  91 class       IfInstanceOf;
  92 class       Switch;
  93 class         TableSwitch;
  94 class         LookupSwitch;
  95 class       Return;
  96 class       Throw;
  97 class       Base;
  98 class   RoundFP;
  99 class   UnsafeOp;
 100 class     UnsafeRawOp;
 101 class       UnsafeGetRaw;
 102 class       UnsafePutRaw;
 103 class     UnsafeObjectOp;
 104 class       UnsafeGetObject;
 105 class       UnsafePutObject;
 106 class         UnsafeGetAndSetObject;
 107 class   ProfileCall;
 108 class   ProfileReturnType;
 109 class   ProfileInvoke;
 110 class   RuntimeCall;
 111 class   MemBar;
 112 class   RangeCheckPredicate;
 113 #ifdef ASSERT
 114 class   Assert;
 115 #endif
 116 
 117 // A Value is a reference to the instruction creating the value
 118 typedef Instruction* Value;
 119 typedef GrowableArray<Value> Values;
 120 typedef GrowableArray<ValueStack*> ValueStackStack;
 121 
 122 // BlockClosure is the base class for block traversal/iteration.
 123 
 124 class BlockClosure: public CompilationResourceObj {
 125  public:
 126   virtual void block_do(BlockBegin* block)       = 0;
 127 };
 128 
 129 
 130 // A simple closure class for visiting the values of an Instruction
 131 class ValueVisitor: public StackObj {
 132  public:
 133   virtual void visit(Value* v) = 0;
 134 };
 135 
 136 
 137 // Some array and list classes
 138 typedef GrowableArray<BlockBegin*> BlockBeginArray;
 139 
 140 class BlockList: public GrowableArray<BlockBegin*> {
 141  public:
 142   BlockList(): GrowableArray<BlockBegin*>() {}
 143   BlockList(const int size): GrowableArray<BlockBegin*>(size) {}
 144   BlockList(const int size, BlockBegin* init): GrowableArray<BlockBegin*>(size, size, init) {}
 145 
 146   void iterate_forward(BlockClosure* closure);
 147   void iterate_backward(BlockClosure* closure);
 148   void blocks_do(void f(BlockBegin*));
 149   void values_do(ValueVisitor* f);
 150   void print(bool cfg_only = false, bool live_only = false) PRODUCT_RETURN;
 151 };
 152 
 153 
 154 // InstructionVisitors provide type-based dispatch for instructions.
 155 // For each concrete Instruction class X, a virtual function do_X is
 156 // provided. Functionality that needs to be implemented for all classes
 157 // (e.g., printing, code generation) is factored out into a specialised
 158 // visitor instead of added to the Instruction classes itself.
 159 
 160 class InstructionVisitor: public StackObj {
 161  public:
 162   virtual void do_Phi            (Phi*             x) = 0;
 163   virtual void do_Local          (Local*           x) = 0;
 164   virtual void do_Constant       (Constant*        x) = 0;
 165   virtual void do_LoadField      (LoadField*       x) = 0;
 166   virtual void do_StoreField     (StoreField*      x) = 0;
 167   virtual void do_ArrayLength    (ArrayLength*     x) = 0;
 168   virtual void do_LoadIndexed    (LoadIndexed*     x) = 0;
 169   virtual void do_StoreIndexed   (StoreIndexed*    x) = 0;
 170   virtual void do_NegateOp       (NegateOp*        x) = 0;
 171   virtual void do_ArithmeticOp   (ArithmeticOp*    x) = 0;
 172   virtual void do_ShiftOp        (ShiftOp*         x) = 0;
 173   virtual void do_LogicOp        (LogicOp*         x) = 0;
 174   virtual void do_CompareOp      (CompareOp*       x) = 0;
 175   virtual void do_IfOp           (IfOp*            x) = 0;
 176   virtual void do_Convert        (Convert*         x) = 0;
 177   virtual void do_NullCheck      (NullCheck*       x) = 0;
 178   virtual void do_TypeCast       (TypeCast*        x) = 0;
 179   virtual void do_Invoke         (Invoke*          x) = 0;
 180   virtual void do_NewInstance    (NewInstance*     x) = 0;
 181   virtual void do_NewValueTypeInstance(NewValueTypeInstance* x) = 0;
 182   virtual void do_NewTypeArray   (NewTypeArray*    x) = 0;
 183   virtual void do_NewObjectArray (NewObjectArray*  x) = 0;
 184   virtual void do_NewMultiArray  (NewMultiArray*   x) = 0;
 185   virtual void do_CheckCast      (CheckCast*       x) = 0;
 186   virtual void do_InstanceOf     (InstanceOf*      x) = 0;
 187   virtual void do_MonitorEnter   (MonitorEnter*    x) = 0;
 188   virtual void do_MonitorExit    (MonitorExit*     x) = 0;
 189   virtual void do_Intrinsic      (Intrinsic*       x) = 0;
 190   virtual void do_BlockBegin     (BlockBegin*      x) = 0;
 191   virtual void do_Goto           (Goto*            x) = 0;
 192   virtual void do_If             (If*              x) = 0;
 193   virtual void do_IfInstanceOf   (IfInstanceOf*    x) = 0;
 194   virtual void do_TableSwitch    (TableSwitch*     x) = 0;
 195   virtual void do_LookupSwitch   (LookupSwitch*    x) = 0;
 196   virtual void do_Return         (Return*          x) = 0;
 197   virtual void do_Throw          (Throw*           x) = 0;
 198   virtual void do_Base           (Base*            x) = 0;
 199   virtual void do_OsrEntry       (OsrEntry*        x) = 0;
 200   virtual void do_ExceptionObject(ExceptionObject* x) = 0;
 201   virtual void do_RoundFP        (RoundFP*         x) = 0;
 202   virtual void do_UnsafeGetRaw   (UnsafeGetRaw*    x) = 0;
 203   virtual void do_UnsafePutRaw   (UnsafePutRaw*    x) = 0;
 204   virtual void do_UnsafeGetObject(UnsafeGetObject* x) = 0;
 205   virtual void do_UnsafePutObject(UnsafePutObject* x) = 0;
 206   virtual void do_UnsafeGetAndSetObject(UnsafeGetAndSetObject* x) = 0;
 207   virtual void do_ProfileCall    (ProfileCall*     x) = 0;
 208   virtual void do_ProfileReturnType (ProfileReturnType*  x) = 0;
 209   virtual void do_ProfileInvoke  (ProfileInvoke*   x) = 0;
 210   virtual void do_RuntimeCall    (RuntimeCall*     x) = 0;
 211   virtual void do_MemBar         (MemBar*          x) = 0;
 212   virtual void do_RangeCheckPredicate(RangeCheckPredicate* x) = 0;
 213 #ifdef ASSERT
 214   virtual void do_Assert         (Assert*          x) = 0;
 215 #endif
 216 };
 217 
 218 
 219 // Hashing support
 220 //
 221 // Note: This hash functions affect the performance
 222 //       of ValueMap - make changes carefully!
 223 
 224 #define HASH1(x1            )                    ((intx)(x1))
 225 #define HASH2(x1, x2        )                    ((HASH1(x1        ) << 7) ^ HASH1(x2))
 226 #define HASH3(x1, x2, x3    )                    ((HASH2(x1, x2    ) << 7) ^ HASH1(x3))
 227 #define HASH4(x1, x2, x3, x4)                    ((HASH3(x1, x2, x3) << 7) ^ HASH1(x4))
 228 
 229 
 230 // The following macros are used to implement instruction-specific hashing.
 231 // By default, each instruction implements hash() and is_equal(Value), used
 232 // for value numbering/common subexpression elimination. The default imple-
 233 // mentation disables value numbering. Each instruction which can be value-
 234 // numbered, should define corresponding hash() and is_equal(Value) functions
 235 // via the macros below. The f arguments specify all the values/op codes, etc.
 236 // that need to be identical for two instructions to be identical.
 237 //
 238 // Note: The default implementation of hash() returns 0 in order to indicate
 239 //       that the instruction should not be considered for value numbering.
 240 //       The currently used hash functions do not guarantee that never a 0
 241 //       is produced. While this is still correct, it may be a performance
 242 //       bug (no value numbering for that node). However, this situation is
 243 //       so unlikely, that we are not going to handle it specially.
 244 
 245 #define HASHING1(class_name, enabled, f1)             \
 246   virtual intx hash() const {                         \
 247     return (enabled) ? HASH2(name(), f1) : 0;         \
 248   }                                                   \
 249   virtual bool is_equal(Value v) const {              \
 250     if (!(enabled)  ) return false;                   \
 251     class_name* _v = v->as_##class_name();            \
 252     if (_v == NULL  ) return false;                   \
 253     if (f1 != _v->f1) return false;                   \
 254     return true;                                      \
 255   }                                                   \
 256 
 257 
 258 #define HASHING2(class_name, enabled, f1, f2)         \
 259   virtual intx hash() const {                         \
 260     return (enabled) ? HASH3(name(), f1, f2) : 0;     \
 261   }                                                   \
 262   virtual bool is_equal(Value v) const {              \
 263     if (!(enabled)  ) return false;                   \
 264     class_name* _v = v->as_##class_name();            \
 265     if (_v == NULL  ) return false;                   \
 266     if (f1 != _v->f1) return false;                   \
 267     if (f2 != _v->f2) return false;                   \
 268     return true;                                      \
 269   }                                                   \
 270 
 271 
 272 #define HASHING3(class_name, enabled, f1, f2, f3)     \
 273   virtual intx hash() const {                          \
 274     return (enabled) ? HASH4(name(), f1, f2, f3) : 0; \
 275   }                                                   \
 276   virtual bool is_equal(Value v) const {              \
 277     if (!(enabled)  ) return false;                   \
 278     class_name* _v = v->as_##class_name();            \
 279     if (_v == NULL  ) return false;                   \
 280     if (f1 != _v->f1) return false;                   \
 281     if (f2 != _v->f2) return false;                   \
 282     if (f3 != _v->f3) return false;                   \
 283     return true;                                      \
 284   }                                                   \
 285 
 286 
 287 // The mother of all instructions...
 288 
 289 class Instruction: public CompilationResourceObj {
 290  private:
 291   int          _id;                              // the unique instruction id
 292 #ifndef PRODUCT
 293   int          _printable_bci;                   // the bci of the instruction for printing
 294 #endif
 295   int          _use_count;                       // the number of instructions refering to this value (w/o prev/next); only roots can have use count = 0 or > 1
 296   int          _pin_state;                       // set of PinReason describing the reason for pinning
 297   ValueType*   _type;                            // the instruction value type
 298   Instruction* _next;                            // the next instruction if any (NULL for BlockEnd instructions)
 299   Instruction* _subst;                           // the substitution instruction if any
 300   LIR_Opr      _operand;                         // LIR specific information
 301   unsigned int _flags;                           // Flag bits
 302 
 303   ValueStack*  _state_before;                    // Copy of state with input operands still on stack (or NULL)
 304   ValueStack*  _exception_state;                 // Copy of state for exception handling
 305   XHandlers*   _exception_handlers;              // Flat list of exception handlers covering this instruction
 306 
 307   friend class UseCountComputer;
 308   friend class BlockBegin;
 309 
 310   void update_exception_state(ValueStack* state);
 311 
 312  protected:
 313   BlockBegin*  _block;                           // Block that contains this instruction
 314 
 315   void set_type(ValueType* type) {
 316     assert(type != NULL, "type must exist");
 317     _type = type;
 318   }
 319 
 320   // Helper class to keep track of which arguments need a null check
 321   class ArgsNonNullState {
 322   private:
 323     int _nonnull_state; // mask identifying which args are nonnull
 324   public:
 325     ArgsNonNullState()
 326       : _nonnull_state(AllBits) {}
 327 
 328     // Does argument number i needs a null check?
 329     bool arg_needs_null_check(int i) const {
 330       // No data is kept for arguments starting at position 33 so
 331       // conservatively assume that they need a null check.
 332       if (i >= 0 && i < (int)sizeof(_nonnull_state) * BitsPerByte) {
 333         return is_set_nth_bit(_nonnull_state, i);
 334       }
 335       return true;
 336     }
 337 
 338     // Set whether argument number i needs a null check or not
 339     void set_arg_needs_null_check(int i, bool check) {
 340       if (i >= 0 && i < (int)sizeof(_nonnull_state) * BitsPerByte) {
 341         if (check) {
 342           _nonnull_state |= nth_bit(i);
 343         } else {
 344           _nonnull_state &= ~(nth_bit(i));
 345         }
 346       }
 347     }
 348   };
 349 
 350  public:
 351   void* operator new(size_t size) throw() {
 352     Compilation* c = Compilation::current();
 353     void* res = c->arena()->Amalloc(size);
 354     ((Instruction*)res)->_id = c->get_next_id();
 355     return res;
 356   }
 357 
 358   static const int no_bci = -99;
 359 
 360   enum InstructionFlag {
 361     NeedsNullCheckFlag = 0,
 362     CanTrapFlag,
 363     DirectCompareFlag,
 364     IsEliminatedFlag,
 365     IsSafepointFlag,
 366     IsStaticFlag,
 367     IsStrictfpFlag,
 368     NeedsStoreCheckFlag,
 369     NeedsWriteBarrierFlag,
 370     PreservesStateFlag,
 371     TargetIsFinalFlag,
 372     TargetIsLoadedFlag,
 373     TargetIsStrictfpFlag,
 374     UnorderedIsTrueFlag,
 375     NeedsPatchingFlag,
 376     ThrowIncompatibleClassChangeErrorFlag,
 377     InvokeSpecialReceiverCheckFlag,
 378     ProfileMDOFlag,
 379     IsLinkedInBlockFlag,
 380     NeedsRangeCheckFlag,
 381     InWorkListFlag,
 382     DeoptimizeOnException,
 383     InstructionLastFlag
 384   };
 385 
 386  public:
 387   bool check_flag(InstructionFlag id) const      { return (_flags & (1 << id)) != 0;    }
 388   void set_flag(InstructionFlag id, bool f)      { _flags = f ? (_flags | (1 << id)) : (_flags & ~(1 << id)); };
 389 
 390   // 'globally' used condition values
 391   enum Condition {
 392     eql, neq, lss, leq, gtr, geq, aeq, beq
 393   };
 394 
 395   // Instructions may be pinned for many reasons and under certain conditions
 396   // with enough knowledge it's possible to safely unpin them.
 397   enum PinReason {
 398       PinUnknown           = 1 << 0
 399     , PinExplicitNullCheck = 1 << 3
 400     , PinStackForStateSplit= 1 << 12
 401     , PinStateSplitConstructor= 1 << 13
 402     , PinGlobalValueNumbering= 1 << 14
 403   };
 404 
 405   static Condition mirror(Condition cond);
 406   static Condition negate(Condition cond);
 407 
 408   // initialization
 409   static int number_of_instructions() {
 410     return Compilation::current()->number_of_instructions();
 411   }
 412 
 413   // creation
 414   Instruction(ValueType* type, ValueStack* state_before = NULL, bool type_is_constant = false)
 415   :
 416 #ifndef PRODUCT
 417   _printable_bci(-99),
 418 #endif
 419     _use_count(0)
 420   , _pin_state(0)
 421   , _type(type)
 422   , _next(NULL)
 423   , _subst(NULL)
 424   , _operand(LIR_OprFact::illegalOpr)
 425   , _flags(0)
 426   , _state_before(state_before)
 427   , _exception_handlers(NULL)
 428   , _block(NULL)
 429   {
 430     check_state(state_before);
 431     assert(type != NULL && (!type->is_constant() || type_is_constant), "type must exist");
 432     update_exception_state(_state_before);
 433   }
 434 
 435   // accessors
 436   int id() const                                 { return _id; }
 437 #ifndef PRODUCT
 438   bool has_printable_bci() const                 { return _printable_bci != -99; }
 439   int printable_bci() const                      { assert(has_printable_bci(), "_printable_bci should have been set"); return _printable_bci; }
 440   void set_printable_bci(int bci)                { _printable_bci = bci; }
 441 #endif
 442   int dominator_depth();
 443   int use_count() const                          { return _use_count; }
 444   int pin_state() const                          { return _pin_state; }
 445   bool is_pinned() const                         { return _pin_state != 0 || PinAllInstructions; }
 446   ValueType* type() const                        { return _type; }
 447   BlockBegin *block() const                      { return _block; }
 448   Instruction* prev();                           // use carefully, expensive operation
 449   Instruction* next() const                      { return _next; }
 450   bool has_subst() const                         { return _subst != NULL; }
 451   Instruction* subst()                           { return _subst == NULL ? this : _subst->subst(); }
 452   LIR_Opr operand() const                        { return _operand; }
 453 
 454   void set_needs_null_check(bool f)              { set_flag(NeedsNullCheckFlag, f); }
 455   bool needs_null_check() const                  { return check_flag(NeedsNullCheckFlag); }
 456   bool is_linked() const                         { return check_flag(IsLinkedInBlockFlag); }
 457   bool can_be_linked()                           { return as_Local() == NULL && as_Phi() == NULL; }
 458 
 459   bool has_uses() const                          { return use_count() > 0; }
 460   ValueStack* state_before() const               { return _state_before; }
 461   ValueStack* exception_state() const            { return _exception_state; }
 462   virtual bool needs_exception_state() const     { return true; }
 463   XHandlers* exception_handlers() const          { return _exception_handlers; }
 464 
 465   // manipulation
 466   void pin(PinReason reason)                     { _pin_state |= reason; }
 467   void pin()                                     { _pin_state |= PinUnknown; }
 468   // DANGEROUS: only used by EliminateStores
 469   void unpin(PinReason reason)                   { assert((reason & PinUnknown) == 0, "can't unpin unknown state"); _pin_state &= ~reason; }
 470 
 471   Instruction* set_next(Instruction* next) {
 472     assert(next->has_printable_bci(), "_printable_bci should have been set");
 473     assert(next != NULL, "must not be NULL");
 474     assert(as_BlockEnd() == NULL, "BlockEnd instructions must have no next");
 475     assert(next->can_be_linked(), "shouldn't link these instructions into list");
 476 
 477     BlockBegin *block = this->block();
 478     next->_block = block;
 479 
 480     next->set_flag(Instruction::IsLinkedInBlockFlag, true);
 481     _next = next;
 482     return next;
 483   }
 484 
 485   Instruction* set_next(Instruction* next, int bci) {
 486 #ifndef PRODUCT
 487     next->set_printable_bci(bci);
 488 #endif
 489     return set_next(next);
 490   }
 491 
 492   // when blocks are merged
 493   void fixup_block_pointers() {
 494     Instruction *cur = next()->next(); // next()'s block is set in set_next
 495     while (cur && cur->_block != block()) {
 496       cur->_block = block();
 497       cur = cur->next();
 498     }
 499   }
 500 
 501   Instruction *insert_after(Instruction *i) {
 502     Instruction* n = _next;
 503     set_next(i);
 504     i->set_next(n);
 505     return _next;
 506   }
 507 
 508   bool is_flattened_array() const;
 509 
 510   Instruction *insert_after_same_bci(Instruction *i) {
 511 #ifndef PRODUCT
 512     i->set_printable_bci(printable_bci());
 513 #endif
 514     return insert_after(i);
 515   }
 516 
 517   void set_subst(Instruction* subst)             {
 518     assert(subst == NULL ||
 519            type()->base() == subst->type()->base() ||
 520            subst->type()->base() == illegalType, "type can't change");
 521     _subst = subst;
 522   }
 523   void set_exception_handlers(XHandlers *xhandlers) { _exception_handlers = xhandlers; }
 524   void set_exception_state(ValueStack* s)        { check_state(s); _exception_state = s; }
 525   void set_state_before(ValueStack* s)           { check_state(s); _state_before = s; }
 526 
 527   // machine-specifics
 528   void set_operand(LIR_Opr operand)              { assert(operand != LIR_OprFact::illegalOpr, "operand must exist"); _operand = operand; }
 529   void clear_operand()                           { _operand = LIR_OprFact::illegalOpr; }
 530 
 531   // generic
 532   virtual Instruction*      as_Instruction()     { return this; } // to satisfy HASHING1 macro
 533   virtual Phi*              as_Phi()             { return NULL; }
 534   virtual Local*            as_Local()           { return NULL; }
 535   virtual Constant*         as_Constant()        { return NULL; }
 536   virtual AccessField*      as_AccessField()     { return NULL; }
 537   virtual LoadField*        as_LoadField()       { return NULL; }
 538   virtual StoreField*       as_StoreField()      { return NULL; }
 539   virtual AccessArray*      as_AccessArray()     { return NULL; }
 540   virtual ArrayLength*      as_ArrayLength()     { return NULL; }
 541   virtual AccessIndexed*    as_AccessIndexed()   { return NULL; }
 542   virtual LoadIndexed*      as_LoadIndexed()     { return NULL; }
 543   virtual StoreIndexed*     as_StoreIndexed()    { return NULL; }
 544   virtual NegateOp*         as_NegateOp()        { return NULL; }
 545   virtual Op2*              as_Op2()             { return NULL; }
 546   virtual ArithmeticOp*     as_ArithmeticOp()    { return NULL; }
 547   virtual ShiftOp*          as_ShiftOp()         { return NULL; }
 548   virtual LogicOp*          as_LogicOp()         { return NULL; }
 549   virtual CompareOp*        as_CompareOp()       { return NULL; }
 550   virtual IfOp*             as_IfOp()            { return NULL; }
 551   virtual Convert*          as_Convert()         { return NULL; }
 552   virtual NullCheck*        as_NullCheck()       { return NULL; }
 553   virtual OsrEntry*         as_OsrEntry()        { return NULL; }
 554   virtual StateSplit*       as_StateSplit()      { return NULL; }
 555   virtual Invoke*           as_Invoke()          { return NULL; }
 556   virtual NewInstance*      as_NewInstance()     { return NULL; }
 557   virtual NewValueTypeInstance* as_NewValueTypeInstance() { return NULL; }
 558   virtual NewArray*         as_NewArray()        { return NULL; }
 559   virtual NewTypeArray*     as_NewTypeArray()    { return NULL; }
 560   virtual NewObjectArray*   as_NewObjectArray()  { return NULL; }
 561   virtual NewMultiArray*    as_NewMultiArray()   { return NULL; }
 562   virtual TypeCheck*        as_TypeCheck()       { return NULL; }
 563   virtual CheckCast*        as_CheckCast()       { return NULL; }
 564   virtual InstanceOf*       as_InstanceOf()      { return NULL; }
 565   virtual TypeCast*         as_TypeCast()        { return NULL; }
 566   virtual AccessMonitor*    as_AccessMonitor()   { return NULL; }
 567   virtual MonitorEnter*     as_MonitorEnter()    { return NULL; }
 568   virtual MonitorExit*      as_MonitorExit()     { return NULL; }
 569   virtual Intrinsic*        as_Intrinsic()       { return NULL; }
 570   virtual BlockBegin*       as_BlockBegin()      { return NULL; }
 571   virtual BlockEnd*         as_BlockEnd()        { return NULL; }
 572   virtual Goto*             as_Goto()            { return NULL; }
 573   virtual If*               as_If()              { return NULL; }
 574   virtual IfInstanceOf*     as_IfInstanceOf()    { return NULL; }
 575   virtual TableSwitch*      as_TableSwitch()     { return NULL; }
 576   virtual LookupSwitch*     as_LookupSwitch()    { return NULL; }
 577   virtual Return*           as_Return()          { return NULL; }
 578   virtual Throw*            as_Throw()           { return NULL; }
 579   virtual Base*             as_Base()            { return NULL; }
 580   virtual RoundFP*          as_RoundFP()         { return NULL; }
 581   virtual ExceptionObject*  as_ExceptionObject() { return NULL; }
 582   virtual UnsafeOp*         as_UnsafeOp()        { return NULL; }
 583   virtual ProfileInvoke*    as_ProfileInvoke()   { return NULL; }
 584   virtual RangeCheckPredicate* as_RangeCheckPredicate() { return NULL; }
 585 
 586 #ifdef ASSERT
 587   virtual Assert*           as_Assert()          { return NULL; }
 588 #endif
 589 
 590   virtual void visit(InstructionVisitor* v)      = 0;
 591 
 592   virtual bool can_trap() const                  { return false; }
 593 
 594   virtual void input_values_do(ValueVisitor* f)   = 0;
 595   virtual void state_values_do(ValueVisitor* f);
 596   virtual void other_values_do(ValueVisitor* f)   { /* usually no other - override on demand */ }
 597           void       values_do(ValueVisitor* f)   { input_values_do(f); state_values_do(f); other_values_do(f); }
 598 
 599   virtual ciType* exact_type() const;
 600   virtual ciType* declared_type() const          { return NULL; }
 601 
 602   // hashing
 603   virtual const char* name() const               = 0;
 604   HASHING1(Instruction, false, id())             // hashing disabled by default
 605 
 606   // debugging
 607   static void check_state(ValueStack* state)     PRODUCT_RETURN;
 608   void print()                                   PRODUCT_RETURN;
 609   void print_line()                              PRODUCT_RETURN;
 610   void print(InstructionPrinter& ip)             PRODUCT_RETURN;
 611 };
 612 
 613 
 614 // The following macros are used to define base (i.e., non-leaf)
 615 // and leaf instruction classes. They define class-name related
 616 // generic functionality in one place.
 617 
 618 #define BASE(class_name, super_class_name)       \
 619   class class_name: public super_class_name {    \
 620    public:                                       \
 621     virtual class_name* as_##class_name()        { return this; }              \
 622 
 623 
 624 #define LEAF(class_name, super_class_name)       \
 625   BASE(class_name, super_class_name)             \
 626    public:                                       \
 627     virtual const char* name() const             { return #class_name; }       \
 628     virtual void visit(InstructionVisitor* v)    { v->do_##class_name(this); } \
 629 
 630 
 631 // Debugging support
 632 
 633 
 634 #ifdef ASSERT
 635 class AssertValues: public ValueVisitor {
 636   void visit(Value* x)             { assert((*x) != NULL, "value must exist"); }
 637 };
 638   #define ASSERT_VALUES                          { AssertValues assert_value; values_do(&assert_value); }
 639 #else
 640   #define ASSERT_VALUES
 641 #endif // ASSERT
 642 
 643 
 644 // A Phi is a phi function in the sense of SSA form. It stands for
 645 // the value of a local variable at the beginning of a join block.
 646 // A Phi consists of n operands, one for every incoming branch.
 647 
 648 LEAF(Phi, Instruction)
 649  private:
 650   int         _pf_flags; // the flags of the phi function
 651   int         _index;    // to value on operand stack (index < 0) or to local
 652   ciType*     _exact_type; // preserve type information for flattened arrays.
 653  public:
 654   // creation
 655   Phi(ValueType* type, BlockBegin* b, int index, ciType* exact_type)
 656   : Instruction(type->base())
 657   , _pf_flags(0)
 658   , _index(index)
 659   , _exact_type(exact_type)
 660   {
 661     _block = b;
 662     NOT_PRODUCT(set_printable_bci(Value(b)->printable_bci()));
 663     if (type->is_illegal()) {
 664       make_illegal();
 665     }
 666   }
 667 
 668   virtual ciType* exact_type() const {
 669     return _exact_type;
 670   }
 671 
 672   virtual ciType* declared_type() const {
 673     return _exact_type;
 674   }
 675 
 676   // flags
 677   enum Flag {
 678     no_flag         = 0,
 679     visited         = 1 << 0,
 680     cannot_simplify = 1 << 1
 681   };
 682 
 683   // accessors
 684   bool  is_local() const          { return _index >= 0; }
 685   bool  is_on_stack() const       { return !is_local(); }
 686   int   local_index() const       { assert(is_local(), ""); return _index; }
 687   int   stack_index() const       { assert(is_on_stack(), ""); return -(_index+1); }
 688 
 689   Value operand_at(int i) const;
 690   int   operand_count() const;
 691 
 692   void   set(Flag f)              { _pf_flags |=  f; }
 693   void   clear(Flag f)            { _pf_flags &= ~f; }
 694   bool   is_set(Flag f) const     { return (_pf_flags & f) != 0; }
 695 
 696   // Invalidates phis corresponding to merges of locals of two different types
 697   // (these should never be referenced, otherwise the bytecodes are illegal)
 698   void   make_illegal() {
 699     set(cannot_simplify);
 700     set_type(illegalType);
 701   }
 702 
 703   bool is_illegal() const {
 704     return type()->is_illegal();
 705   }
 706 
 707   // generic
 708   virtual void input_values_do(ValueVisitor* f) {
 709   }
 710 };
 711 
 712 
 713 // A local is a placeholder for an incoming argument to a function call.
 714 LEAF(Local, Instruction)
 715  private:
 716   int      _java_index;                          // the local index within the method to which the local belongs
 717   bool     _is_receiver;                         // if local variable holds the receiver: "this" for non-static methods
 718   ciType*  _declared_type;
 719  public:
 720   // creation
 721   Local(ciType* declared, ValueType* type, int index, bool receiver)
 722     : Instruction(type)
 723     , _java_index(index)
 724     , _is_receiver(receiver)
 725     , _declared_type(declared)
 726   {
 727     NOT_PRODUCT(set_printable_bci(-1));
 728   }
 729 
 730   // accessors
 731   int java_index() const                         { return _java_index; }
 732   bool is_receiver() const                       { return _is_receiver; }
 733 
 734   virtual ciType* declared_type() const          { return _declared_type; }
 735 
 736   // generic
 737   virtual void input_values_do(ValueVisitor* f)   { /* no values */ }
 738 };
 739 
 740 
 741 LEAF(Constant, Instruction)
 742  public:
 743   // creation
 744   Constant(ValueType* type):
 745       Instruction(type, NULL, /*type_is_constant*/ true)
 746   {
 747     assert(type->is_constant(), "must be a constant");
 748   }
 749 
 750   Constant(ValueType* type, ValueStack* state_before):
 751     Instruction(type, state_before, /*type_is_constant*/ true)
 752   {
 753     assert(state_before != NULL, "only used for constants which need patching");
 754     assert(type->is_constant(), "must be a constant");
 755     // since it's patching it needs to be pinned
 756     pin();
 757   }
 758 
 759   // generic
 760   virtual bool can_trap() const                  { return state_before() != NULL; }
 761   virtual void input_values_do(ValueVisitor* f)   { /* no values */ }
 762 
 763   virtual intx hash() const;
 764   virtual bool is_equal(Value v) const;
 765 
 766   virtual ciType* exact_type() const;
 767 
 768   enum CompareResult { not_comparable = -1, cond_false, cond_true };
 769 
 770   virtual CompareResult compare(Instruction::Condition condition, Value right) const;
 771   BlockBegin* compare(Instruction::Condition cond, Value right,
 772                       BlockBegin* true_sux, BlockBegin* false_sux) const {
 773     switch (compare(cond, right)) {
 774     case not_comparable:
 775       return NULL;
 776     case cond_false:
 777       return false_sux;
 778     case cond_true:
 779       return true_sux;
 780     default:
 781       ShouldNotReachHere();
 782       return NULL;
 783     }
 784   }
 785 };
 786 
 787 
 788 BASE(AccessField, Instruction)
 789  private:
 790   Value       _obj;
 791   int         _offset;
 792   ciField*    _field;
 793   NullCheck*  _explicit_null_check;              // For explicit null check elimination
 794 
 795  public:
 796   // creation
 797   AccessField(Value obj, int offset, ciField* field, bool is_static,
 798               ValueStack* state_before, bool needs_patching)
 799   : Instruction(as_ValueType(field->type()->basic_type()), state_before)
 800   , _obj(obj)
 801   , _offset(offset)
 802   , _field(field)
 803   , _explicit_null_check(NULL)
 804   {
 805     set_needs_null_check(!is_static);
 806     set_flag(IsStaticFlag, is_static);
 807     set_flag(NeedsPatchingFlag, needs_patching);
 808     ASSERT_VALUES
 809     // pin of all instructions with memory access
 810     pin();
 811   }
 812 
 813   // accessors
 814   Value obj() const                              { return _obj; }
 815   int offset() const                             { return _offset; }
 816   ciField* field() const                         { return _field; }
 817   BasicType field_type() const                   { return _field->type()->basic_type(); }
 818   bool is_static() const                         { return check_flag(IsStaticFlag); }
 819   NullCheck* explicit_null_check() const         { return _explicit_null_check; }
 820   bool needs_patching() const                    { return check_flag(NeedsPatchingFlag); }
 821 
 822   // Unresolved getstatic and putstatic can cause initialization.
 823   // Technically it occurs at the Constant that materializes the base
 824   // of the static fields but it's simpler to model it here.
 825   bool is_init_point() const                     { return is_static() && (needs_patching() || !_field->holder()->is_initialized()); }
 826 
 827   // manipulation
 828 
 829   // Under certain circumstances, if a previous NullCheck instruction
 830   // proved the target object non-null, we can eliminate the explicit
 831   // null check and do an implicit one, simply specifying the debug
 832   // information from the NullCheck. This field should only be consulted
 833   // if needs_null_check() is true.
 834   void set_explicit_null_check(NullCheck* check) { _explicit_null_check = check; }
 835 
 836   // generic
 837   virtual bool can_trap() const                  { return needs_null_check() || needs_patching(); }
 838   virtual void input_values_do(ValueVisitor* f)   { f->visit(&_obj); }
 839 };
 840 
 841 
 842 LEAF(LoadField, AccessField)
 843  public:
 844   // creation
 845   LoadField(Value obj, int offset, ciField* field, bool is_static,
 846             ValueStack* state_before, bool needs_patching)
 847   : AccessField(obj, offset, field, is_static, state_before, needs_patching)
 848   {}
 849 
 850   ciType* declared_type() const;
 851 
 852   // generic
 853   HASHING2(LoadField, !needs_patching() && !field()->is_volatile(), obj()->subst(), offset())  // cannot be eliminated if needs patching or if volatile
 854 };
 855 
 856 
 857 LEAF(StoreField, AccessField)
 858  private:
 859   Value _value;
 860 
 861  public:
 862   // creation
 863   StoreField(Value obj, int offset, ciField* field, Value value, bool is_static,
 864              ValueStack* state_before, bool needs_patching)
 865   : AccessField(obj, offset, field, is_static, state_before, needs_patching)
 866   , _value(value)
 867   {
 868     set_flag(NeedsWriteBarrierFlag, as_ValueType(field_type())->is_object());
 869     ASSERT_VALUES
 870     pin();
 871   }
 872 
 873   // accessors
 874   Value value() const                            { return _value; }
 875   bool needs_write_barrier() const               { return check_flag(NeedsWriteBarrierFlag); }
 876 
 877   // generic
 878   virtual void input_values_do(ValueVisitor* f)   { AccessField::input_values_do(f); f->visit(&_value); }
 879 };
 880 
 881 
 882 BASE(AccessArray, Instruction)
 883  private:
 884   Value       _array;
 885 
 886  public:
 887   // creation
 888   AccessArray(ValueType* type, Value array, ValueStack* state_before)
 889   : Instruction(type, state_before)
 890   , _array(array)
 891   {
 892     set_needs_null_check(true);
 893     ASSERT_VALUES
 894     pin(); // instruction with side effect (null exception or range check throwing)
 895   }
 896 
 897   Value array() const                            { return _array; }
 898 
 899   // generic
 900   virtual bool can_trap() const                  { return needs_null_check(); }
 901   virtual void input_values_do(ValueVisitor* f)   { f->visit(&_array); }
 902 };
 903 
 904 
 905 LEAF(ArrayLength, AccessArray)
 906  private:
 907   NullCheck*  _explicit_null_check;              // For explicit null check elimination
 908 
 909  public:
 910   // creation
 911   ArrayLength(Value array, ValueStack* state_before)
 912   : AccessArray(intType, array, state_before)
 913   , _explicit_null_check(NULL) {}
 914 
 915   // accessors
 916   NullCheck* explicit_null_check() const         { return _explicit_null_check; }
 917 
 918   // setters
 919   // See LoadField::set_explicit_null_check for documentation
 920   void set_explicit_null_check(NullCheck* check) { _explicit_null_check = check; }
 921 
 922   // generic
 923   HASHING1(ArrayLength, true, array()->subst())
 924 };
 925 
 926 
 927 BASE(AccessIndexed, AccessArray)
 928  private:
 929   Value     _index;
 930   Value     _length;
 931   BasicType _elt_type;
 932   bool      _mismatched;
 933 
 934  public:
 935   // creation
 936   AccessIndexed(Value array, Value index, Value length, BasicType elt_type, ValueStack* state_before, bool mismatched)
 937   : AccessArray(as_ValueType(elt_type), array, state_before)
 938   , _index(index)
 939   , _length(length)
 940   , _elt_type(elt_type)
 941   , _mismatched(mismatched)
 942   {
 943     set_flag(Instruction::NeedsRangeCheckFlag, true);
 944     ASSERT_VALUES
 945   }
 946 
 947   // accessors
 948   Value index() const                            { return _index; }
 949   Value length() const                           { return _length; }
 950   BasicType elt_type() const                     { return _elt_type; }
 951   bool mismatched() const                        { return _mismatched; }
 952 
 953   void clear_length()                            { _length = NULL; }
 954   // perform elimination of range checks involving constants
 955   bool compute_needs_range_check();
 956 
 957   // generic
 958   virtual void input_values_do(ValueVisitor* f)   { AccessArray::input_values_do(f); f->visit(&_index); if (_length != NULL) f->visit(&_length); }
 959 };
 960 
 961 
 962 LEAF(LoadIndexed, AccessIndexed)
 963  private:
 964   NullCheck*  _explicit_null_check;              // For explicit null check elimination
 965   NewValueTypeInstance* _vt;
 966 
 967  public:
 968   // creation
 969   LoadIndexed(Value array, Value index, Value length, BasicType elt_type, ValueStack* state_before, bool mismatched = false)
 970   : AccessIndexed(array, index, length, elt_type, state_before, mismatched)
 971   , _explicit_null_check(NULL) {}
 972 
 973   // accessors
 974   NullCheck* explicit_null_check() const         { return _explicit_null_check; }
 975 
 976   // setters
 977   // See LoadField::set_explicit_null_check for documentation
 978   void set_explicit_null_check(NullCheck* check) { _explicit_null_check = check; }
 979 
 980   ciType* exact_type() const;
 981   ciType* declared_type() const;
 982 
 983   NewValueTypeInstance* vt() { return _vt; }
 984   void set_vt(NewValueTypeInstance* vt) { _vt = vt; }
 985 
 986   // generic
 987   HASHING2(LoadIndexed, true, array()->subst(), index()->subst())
 988 };
 989 
 990 
 991 LEAF(StoreIndexed, AccessIndexed)
 992  private:
 993   Value       _value;
 994 
 995   ciMethod* _profiled_method;
 996   int       _profiled_bci;
 997   bool      _check_boolean;
 998 
 999  public:
1000   // creation
1001   StoreIndexed(Value array, Value index, Value length, BasicType elt_type, Value value, ValueStack* state_before,
1002                bool check_boolean, bool mismatched = false)
1003   : AccessIndexed(array, index, length, elt_type, state_before, mismatched)
1004   , _value(value), _profiled_method(NULL), _profiled_bci(0), _check_boolean(check_boolean)
1005   {
1006     set_flag(NeedsWriteBarrierFlag, (as_ValueType(elt_type)->is_object()));
1007     set_flag(NeedsStoreCheckFlag, (as_ValueType(elt_type)->is_object()));
1008     ASSERT_VALUES
1009     pin();
1010   }
1011 
1012   // accessors
1013   Value value() const                            { return _value; }
1014   bool needs_write_barrier() const               { return check_flag(NeedsWriteBarrierFlag); }
1015   bool needs_store_check() const                 { return check_flag(NeedsStoreCheckFlag); }
1016   bool check_boolean() const                     { return _check_boolean; }
1017   // Helpers for MethodData* profiling
1018   void set_should_profile(bool value)                { set_flag(ProfileMDOFlag, value); }
1019   void set_profiled_method(ciMethod* method)         { _profiled_method = method;   }
1020   void set_profiled_bci(int bci)                     { _profiled_bci = bci;         }
1021   bool      should_profile() const                   { return check_flag(ProfileMDOFlag); }
1022   ciMethod* profiled_method() const                  { return _profiled_method;     }
1023   int       profiled_bci() const                     { return _profiled_bci;        }
1024   // generic
1025   virtual void input_values_do(ValueVisitor* f)   { AccessIndexed::input_values_do(f); f->visit(&_value); }
1026 };
1027 
1028 
1029 LEAF(NegateOp, Instruction)
1030  private:
1031   Value _x;
1032 
1033  public:
1034   // creation
1035   NegateOp(Value x) : Instruction(x->type()->base()), _x(x) {
1036     ASSERT_VALUES
1037   }
1038 
1039   // accessors
1040   Value x() const                                { return _x; }
1041 
1042   // generic
1043   virtual void input_values_do(ValueVisitor* f)   { f->visit(&_x); }
1044 };
1045 
1046 
1047 BASE(Op2, Instruction)
1048  private:
1049   Bytecodes::Code _op;
1050   Value           _x;
1051   Value           _y;
1052 
1053  public:
1054   // creation
1055   Op2(ValueType* type, Bytecodes::Code op, Value x, Value y, ValueStack* state_before = NULL)
1056   : Instruction(type, state_before)
1057   , _op(op)
1058   , _x(x)
1059   , _y(y)
1060   {
1061     ASSERT_VALUES
1062   }
1063 
1064   // accessors
1065   Bytecodes::Code op() const                     { return _op; }
1066   Value x() const                                { return _x; }
1067   Value y() const                                { return _y; }
1068 
1069   // manipulators
1070   void swap_operands() {
1071     assert(is_commutative(), "operation must be commutative");
1072     Value t = _x; _x = _y; _y = t;
1073   }
1074 
1075   // generic
1076   virtual bool is_commutative() const            { return false; }
1077   virtual void input_values_do(ValueVisitor* f)   { f->visit(&_x); f->visit(&_y); }
1078 };
1079 
1080 
1081 LEAF(ArithmeticOp, Op2)
1082  public:
1083   // creation
1084   ArithmeticOp(Bytecodes::Code op, Value x, Value y, bool is_strictfp, ValueStack* state_before)
1085   : Op2(x->type()->meet(y->type()), op, x, y, state_before)
1086   {
1087     set_flag(IsStrictfpFlag, is_strictfp);
1088     if (can_trap()) pin();
1089   }
1090 
1091   // accessors
1092   bool        is_strictfp() const                { return check_flag(IsStrictfpFlag); }
1093 
1094   // generic
1095   virtual bool is_commutative() const;
1096   virtual bool can_trap() const;
1097   HASHING3(Op2, true, op(), x()->subst(), y()->subst())
1098 };
1099 
1100 
1101 LEAF(ShiftOp, Op2)
1102  public:
1103   // creation
1104   ShiftOp(Bytecodes::Code op, Value x, Value s) : Op2(x->type()->base(), op, x, s) {}
1105 
1106   // generic
1107   HASHING3(Op2, true, op(), x()->subst(), y()->subst())
1108 };
1109 
1110 
1111 LEAF(LogicOp, Op2)
1112  public:
1113   // creation
1114   LogicOp(Bytecodes::Code op, Value x, Value y) : Op2(x->type()->meet(y->type()), op, x, y) {}
1115 
1116   // generic
1117   virtual bool is_commutative() const;
1118   HASHING3(Op2, true, op(), x()->subst(), y()->subst())
1119 };
1120 
1121 
1122 LEAF(CompareOp, Op2)
1123  public:
1124   // creation
1125   CompareOp(Bytecodes::Code op, Value x, Value y, ValueStack* state_before)
1126   : Op2(intType, op, x, y, state_before)
1127   {}
1128 
1129   // generic
1130   HASHING3(Op2, true, op(), x()->subst(), y()->subst())
1131 };
1132 
1133 
1134 LEAF(IfOp, Op2)
1135  private:
1136   Value _tval;
1137   Value _fval;
1138 
1139  public:
1140   // creation
1141   IfOp(Value x, Condition cond, Value y, Value tval, Value fval)
1142   : Op2(tval->type()->meet(fval->type()), (Bytecodes::Code)cond, x, y)
1143   , _tval(tval)
1144   , _fval(fval)
1145   {
1146     ASSERT_VALUES
1147     assert(tval->type()->tag() == fval->type()->tag(), "types must match");
1148   }
1149 
1150   // accessors
1151   virtual bool is_commutative() const;
1152   Bytecodes::Code op() const                     { ShouldNotCallThis(); return Bytecodes::_illegal; }
1153   Condition cond() const                         { return (Condition)Op2::op(); }
1154   Value tval() const                             { return _tval; }
1155   Value fval() const                             { return _fval; }
1156 
1157   // generic
1158   virtual void input_values_do(ValueVisitor* f)   { Op2::input_values_do(f); f->visit(&_tval); f->visit(&_fval); }
1159 };
1160 
1161 
1162 LEAF(Convert, Instruction)
1163  private:
1164   Bytecodes::Code _op;
1165   Value           _value;
1166 
1167  public:
1168   // creation
1169   Convert(Bytecodes::Code op, Value value, ValueType* to_type) : Instruction(to_type), _op(op), _value(value) {
1170     ASSERT_VALUES
1171   }
1172 
1173   // accessors
1174   Bytecodes::Code op() const                     { return _op; }
1175   Value value() const                            { return _value; }
1176 
1177   // generic
1178   virtual void input_values_do(ValueVisitor* f)   { f->visit(&_value); }
1179   HASHING2(Convert, true, op(), value()->subst())
1180 };
1181 
1182 
1183 LEAF(NullCheck, Instruction)
1184  private:
1185   Value       _obj;
1186 
1187  public:
1188   // creation
1189   NullCheck(Value obj, ValueStack* state_before)
1190   : Instruction(obj->type()->base(), state_before)
1191   , _obj(obj)
1192   {
1193     ASSERT_VALUES
1194     set_can_trap(true);
1195     assert(_obj->type()->is_object(), "null check must be applied to objects only");
1196     pin(Instruction::PinExplicitNullCheck);
1197   }
1198 
1199   // accessors
1200   Value obj() const                              { return _obj; }
1201 
1202   // setters
1203   void set_can_trap(bool can_trap)               { set_flag(CanTrapFlag, can_trap); }
1204 
1205   // generic
1206   virtual bool can_trap() const                  { return check_flag(CanTrapFlag); /* null-check elimination sets to false */ }
1207   virtual void input_values_do(ValueVisitor* f)   { f->visit(&_obj); }
1208   HASHING1(NullCheck, true, obj()->subst())
1209 };
1210 
1211 
1212 // This node is supposed to cast the type of another node to a more precise
1213 // declared type.
1214 LEAF(TypeCast, Instruction)
1215  private:
1216   ciType* _declared_type;
1217   Value   _obj;
1218 
1219  public:
1220   // The type of this node is the same type as the object type (and it might be constant).
1221   TypeCast(ciType* type, Value obj, ValueStack* state_before)
1222   : Instruction(obj->type(), state_before, obj->type()->is_constant()),
1223     _declared_type(type),
1224     _obj(obj) {}
1225 
1226   // accessors
1227   ciType* declared_type() const                  { return _declared_type; }
1228   Value   obj() const                            { return _obj; }
1229 
1230   // generic
1231   virtual void input_values_do(ValueVisitor* f)  { f->visit(&_obj); }
1232 };
1233 
1234 
1235 BASE(StateSplit, Instruction)
1236  private:
1237   ValueStack* _state;
1238 
1239  protected:
1240   static void substitute(BlockList& list, BlockBegin* old_block, BlockBegin* new_block);
1241 
1242  public:
1243   // creation
1244   StateSplit(ValueType* type, ValueStack* state_before = NULL)
1245   : Instruction(type, state_before)
1246   , _state(NULL)
1247   {
1248     pin(PinStateSplitConstructor);
1249   }
1250 
1251   // accessors
1252   ValueStack* state() const                      { return _state; }
1253   IRScope* scope() const;                        // the state's scope
1254 
1255   // manipulation
1256   void set_state(ValueStack* state)              { assert(_state == NULL, "overwriting existing state"); check_state(state); _state = state; }
1257 
1258   // generic
1259   virtual void input_values_do(ValueVisitor* f)   { /* no values */ }
1260   virtual void state_values_do(ValueVisitor* f);
1261 };
1262 
1263 
1264 LEAF(Invoke, StateSplit)
1265  private:
1266   Bytecodes::Code _code;
1267   Value           _recv;
1268   Values*         _args;
1269   BasicTypeList*  _signature;
1270   int             _vtable_index;
1271   ciMethod*       _target;
1272 
1273  public:
1274   // creation
1275   Invoke(Bytecodes::Code code, ValueType* result_type, Value recv, Values* args,
1276          int vtable_index, ciMethod* target, ValueStack* state_before);
1277 
1278   // accessors
1279   Bytecodes::Code code() const                   { return _code; }
1280   Value receiver() const                         { return _recv; }
1281   bool has_receiver() const                      { return receiver() != NULL; }
1282   int number_of_arguments() const                { return _args->length(); }
1283   Value argument_at(int i) const                 { return _args->at(i); }
1284   int vtable_index() const                       { return _vtable_index; }
1285   BasicTypeList* signature() const               { return _signature; }
1286   ciMethod* target() const                       { return _target; }
1287 
1288   ciType* declared_type() const;
1289 
1290   // Returns false if target is not loaded
1291   bool target_is_final() const                   { return check_flag(TargetIsFinalFlag); }
1292   bool target_is_loaded() const                  { return check_flag(TargetIsLoadedFlag); }
1293   // Returns false if target is not loaded
1294   bool target_is_strictfp() const                { return check_flag(TargetIsStrictfpFlag); }
1295 
1296   // JSR 292 support
1297   bool is_invokedynamic() const                  { return code() == Bytecodes::_invokedynamic; }
1298   bool is_method_handle_intrinsic() const        { return target()->is_method_handle_intrinsic(); }
1299 
1300   virtual bool needs_exception_state() const     { return false; }
1301 
1302   // generic
1303   virtual bool can_trap() const                  { return true; }
1304   virtual void input_values_do(ValueVisitor* f) {
1305     StateSplit::input_values_do(f);
1306     if (has_receiver()) f->visit(&_recv);
1307     for (int i = 0; i < _args->length(); i++) f->visit(_args->adr_at(i));
1308   }
1309   virtual void state_values_do(ValueVisitor *f);
1310 };
1311 
1312 
1313 LEAF(NewInstance, StateSplit)
1314  private:
1315   ciInstanceKlass* _klass;
1316   bool _is_unresolved;
1317 
1318  public:
1319   // creation
1320   NewInstance(ciInstanceKlass* klass, ValueStack* state_before, bool is_unresolved)
1321   : StateSplit(instanceType, state_before)
1322   , _klass(klass), _is_unresolved(is_unresolved)
1323   {}
1324 
1325   // accessors
1326   ciInstanceKlass* klass() const                 { return _klass; }
1327   bool is_unresolved() const                     { return _is_unresolved; }
1328 
1329   virtual bool needs_exception_state() const     { return false; }
1330 
1331   // generic
1332   virtual bool can_trap() const                  { return true; }
1333   ciType* exact_type() const;
1334   ciType* declared_type() const;
1335 };
1336 
1337 LEAF(NewValueTypeInstance, StateSplit)
1338   bool _is_unresolved;
1339   ciValueKlass* _klass;
1340   Value _depends_on;      // Link to instance on with withfield was called on
1341 
1342 public:
1343 
1344   // Default creation, always allocated for now
1345   NewValueTypeInstance(ciValueKlass* klass, ValueStack* state_before, bool is_unresolved, Value depends_on = NULL)
1346   : StateSplit(instanceType, state_before)
1347    , _is_unresolved(is_unresolved)
1348    , _klass(klass)
1349   {
1350     if (depends_on == NULL) {
1351       _depends_on = this;
1352     } else {
1353       _depends_on = depends_on;
1354     }
1355   }
1356 
1357   // accessors
1358   bool is_unresolved() const                     { return _is_unresolved; }
1359   Value depends_on();
1360 
1361   ciValueKlass* klass() const { return _klass; }
1362 
1363   virtual bool needs_exception_state() const     { return false; }
1364 
1365   // generic
1366   virtual bool can_trap() const                  { return true; }
1367   ciType* exact_type() const;
1368   ciType* declared_type() const;
1369 
1370   // Only done in LIR Generator -> map everything to object
1371   void set_to_object_type() { set_type(instanceType); }
1372 };
1373 
1374 BASE(NewArray, StateSplit)
1375  private:
1376   Value       _length;
1377 
1378  public:
1379   // creation
1380   NewArray(Value length, ValueStack* state_before)
1381   : StateSplit(objectType, state_before)
1382   , _length(length)
1383   {
1384     // Do not ASSERT_VALUES since length is NULL for NewMultiArray
1385   }
1386 
1387   // accessors
1388   Value length() const                           { return _length; }
1389 
1390   virtual bool needs_exception_state() const     { return false; }
1391 
1392   ciType* exact_type() const                     { return NULL; }
1393   ciType* declared_type() const;
1394 
1395   // generic
1396   virtual bool can_trap() const                  { return true; }
1397   virtual void input_values_do(ValueVisitor* f)   { StateSplit::input_values_do(f); f->visit(&_length); }
1398 };
1399 
1400 
1401 LEAF(NewTypeArray, NewArray)
1402  private:
1403   BasicType _elt_type;
1404 
1405  public:
1406   // creation
1407   NewTypeArray(Value length, BasicType elt_type, ValueStack* state_before)
1408   : NewArray(length, state_before)
1409   , _elt_type(elt_type)
1410   {}
1411 
1412   // accessors
1413   BasicType elt_type() const                     { return _elt_type; }
1414   ciType* exact_type() const;
1415 };
1416 
1417 
1418 LEAF(NewObjectArray, NewArray)
1419  private:
1420   ciKlass* _klass;
1421 
1422  public:
1423   // creation
1424   NewObjectArray(ciKlass* klass, Value length, ValueStack* state_before) : NewArray(length, state_before), _klass(klass) {}
1425 
1426   // accessors
1427   ciKlass* klass() const                         { return _klass; }
1428   ciType* exact_type() const;
1429 };
1430 
1431 
1432 LEAF(NewMultiArray, NewArray)
1433  private:
1434   ciKlass* _klass;
1435   Values*  _dims;
1436 
1437  public:
1438   // creation
1439   NewMultiArray(ciKlass* klass, Values* dims, ValueStack* state_before) : NewArray(NULL, state_before), _klass(klass), _dims(dims) {
1440     ASSERT_VALUES
1441   }
1442 
1443   // accessors
1444   ciKlass* klass() const                         { return _klass; }
1445   Values* dims() const                           { return _dims; }
1446   int rank() const                               { return dims()->length(); }
1447 
1448   // generic
1449   virtual void input_values_do(ValueVisitor* f) {
1450     // NOTE: we do not call NewArray::input_values_do since "length"
1451     // is meaningless for a multi-dimensional array; passing the
1452     // zeroth element down to NewArray as its length is a bad idea
1453     // since there will be a copy in the "dims" array which doesn't
1454     // get updated, and the value must not be traversed twice. Was bug
1455     // - kbr 4/10/2001
1456     StateSplit::input_values_do(f);
1457     for (int i = 0; i < _dims->length(); i++) f->visit(_dims->adr_at(i));
1458   }
1459 };
1460 
1461 
1462 BASE(TypeCheck, StateSplit)
1463  private:
1464   ciKlass*    _klass;
1465   Value       _obj;
1466 
1467   ciMethod* _profiled_method;
1468   int       _profiled_bci;
1469 
1470  public:
1471   // creation
1472   TypeCheck(ciKlass* klass, Value obj, ValueType* type, ValueStack* state_before)
1473   : StateSplit(type, state_before), _klass(klass), _obj(obj),
1474     _profiled_method(NULL), _profiled_bci(0) {
1475     ASSERT_VALUES
1476     set_direct_compare(false);
1477   }
1478 
1479   // accessors
1480   ciKlass* klass() const                         { return _klass; }
1481   Value obj() const                              { return _obj; }
1482   bool is_loaded() const                         { return klass() != NULL; }
1483   bool direct_compare() const                    { return check_flag(DirectCompareFlag); }
1484 
1485   // manipulation
1486   void set_direct_compare(bool flag)             { set_flag(DirectCompareFlag, flag); }
1487 
1488   // generic
1489   virtual bool can_trap() const                  { return true; }
1490   virtual void input_values_do(ValueVisitor* f)   { StateSplit::input_values_do(f); f->visit(&_obj); }
1491 
1492   // Helpers for MethodData* profiling
1493   void set_should_profile(bool value)                { set_flag(ProfileMDOFlag, value); }
1494   void set_profiled_method(ciMethod* method)         { _profiled_method = method;   }
1495   void set_profiled_bci(int bci)                     { _profiled_bci = bci;         }
1496   bool      should_profile() const                   { return check_flag(ProfileMDOFlag); }
1497   ciMethod* profiled_method() const                  { return _profiled_method;     }
1498   int       profiled_bci() const                     { return _profiled_bci;        }
1499 };
1500 
1501 
1502 LEAF(CheckCast, TypeCheck)
1503  public:
1504   // creation
1505   CheckCast(ciKlass* klass, Value obj, ValueStack* state_before)
1506   : TypeCheck(klass, obj, objectType, state_before) {}
1507 
1508   void set_incompatible_class_change_check() {
1509     set_flag(ThrowIncompatibleClassChangeErrorFlag, true);
1510   }
1511   bool is_incompatible_class_change_check() const {
1512     return check_flag(ThrowIncompatibleClassChangeErrorFlag);
1513   }
1514   void set_invokespecial_receiver_check() {
1515     set_flag(InvokeSpecialReceiverCheckFlag, true);
1516   }
1517   bool is_invokespecial_receiver_check() const {
1518     return check_flag(InvokeSpecialReceiverCheckFlag);
1519   }
1520 
1521   virtual bool needs_exception_state() const {
1522     return !is_invokespecial_receiver_check();
1523   }
1524 
1525   ciType* declared_type() const;
1526 };
1527 
1528 
1529 LEAF(InstanceOf, TypeCheck)
1530  public:
1531   // creation
1532   InstanceOf(ciKlass* klass, Value obj, ValueStack* state_before) : TypeCheck(klass, obj, intType, state_before) {}
1533 
1534   virtual bool needs_exception_state() const     { return false; }
1535 };
1536 
1537 
1538 BASE(AccessMonitor, StateSplit)
1539  private:
1540   Value       _obj;
1541   int         _monitor_no;
1542 
1543  public:
1544   // creation
1545   AccessMonitor(Value obj, int monitor_no, ValueStack* state_before = NULL)
1546   : StateSplit(illegalType, state_before)
1547   , _obj(obj)
1548   , _monitor_no(monitor_no)
1549   {
1550     set_needs_null_check(true);
1551     ASSERT_VALUES
1552   }
1553 
1554   // accessors
1555   Value obj() const                              { return _obj; }
1556   int monitor_no() const                         { return _monitor_no; }
1557 
1558   // generic
1559   virtual void input_values_do(ValueVisitor* f)   { StateSplit::input_values_do(f); f->visit(&_obj); }
1560 };
1561 
1562 
1563 LEAF(MonitorEnter, AccessMonitor)
1564  public:
1565   // creation
1566   MonitorEnter(Value obj, int monitor_no, ValueStack* state_before)
1567   : AccessMonitor(obj, monitor_no, state_before)
1568   {
1569     ASSERT_VALUES
1570   }
1571 
1572   // generic
1573   virtual bool can_trap() const                  { return true; }
1574 };
1575 
1576 
1577 LEAF(MonitorExit, AccessMonitor)
1578  public:
1579   // creation
1580   MonitorExit(Value obj, int monitor_no)
1581   : AccessMonitor(obj, monitor_no, NULL)
1582   {
1583     ASSERT_VALUES
1584   }
1585 };
1586 
1587 
1588 LEAF(Intrinsic, StateSplit)
1589  private:
1590   vmIntrinsics::ID _id;
1591   Values*          _args;
1592   Value            _recv;
1593   ArgsNonNullState _nonnull_state;
1594 
1595  public:
1596   // preserves_state can be set to true for Intrinsics
1597   // which are guaranteed to preserve register state across any slow
1598   // cases; setting it to true does not mean that the Intrinsic can
1599   // not trap, only that if we continue execution in the same basic
1600   // block after the Intrinsic, all of the registers are intact. This
1601   // allows load elimination and common expression elimination to be
1602   // performed across the Intrinsic.  The default value is false.
1603   Intrinsic(ValueType* type,
1604             vmIntrinsics::ID id,
1605             Values* args,
1606             bool has_receiver,
1607             ValueStack* state_before,
1608             bool preserves_state,
1609             bool cantrap = true)
1610   : StateSplit(type, state_before)
1611   , _id(id)
1612   , _args(args)
1613   , _recv(NULL)
1614   {
1615     assert(args != NULL, "args must exist");
1616     ASSERT_VALUES
1617     set_flag(PreservesStateFlag, preserves_state);
1618     set_flag(CanTrapFlag,        cantrap);
1619     if (has_receiver) {
1620       _recv = argument_at(0);
1621     }
1622     set_needs_null_check(has_receiver);
1623 
1624     // some intrinsics can't trap, so don't force them to be pinned
1625     if (!can_trap() && !vmIntrinsics::should_be_pinned(_id)) {
1626       unpin(PinStateSplitConstructor);
1627     }
1628   }
1629 
1630   // accessors
1631   vmIntrinsics::ID id() const                    { return _id; }
1632   int number_of_arguments() const                { return _args->length(); }
1633   Value argument_at(int i) const                 { return _args->at(i); }
1634 
1635   bool has_receiver() const                      { return (_recv != NULL); }
1636   Value receiver() const                         { assert(has_receiver(), "must have receiver"); return _recv; }
1637   bool preserves_state() const                   { return check_flag(PreservesStateFlag); }
1638 
1639   bool arg_needs_null_check(int i) const {
1640     return _nonnull_state.arg_needs_null_check(i);
1641   }
1642 
1643   void set_arg_needs_null_check(int i, bool check) {
1644     _nonnull_state.set_arg_needs_null_check(i, check);
1645   }
1646 
1647   // generic
1648   virtual bool can_trap() const                  { return check_flag(CanTrapFlag); }
1649   virtual void input_values_do(ValueVisitor* f) {
1650     StateSplit::input_values_do(f);
1651     for (int i = 0; i < _args->length(); i++) f->visit(_args->adr_at(i));
1652   }
1653 };
1654 
1655 
1656 class LIR_List;
1657 
1658 LEAF(BlockBegin, StateSplit)
1659  private:
1660   int        _block_id;                          // the unique block id
1661   int        _bci;                               // start-bci of block
1662   int        _depth_first_number;                // number of this block in a depth-first ordering
1663   int        _linear_scan_number;                // number of this block in linear-scan ordering
1664   int        _dominator_depth;
1665   int        _loop_depth;                        // the loop nesting level of this block
1666   int        _loop_index;                        // number of the innermost loop of this block
1667   int        _flags;                             // the flags associated with this block
1668 
1669   // fields used by BlockListBuilder
1670   int            _total_preds;                   // number of predecessors found by BlockListBuilder
1671   ResourceBitMap _stores_to_locals;              // bit is set when a local variable is stored in the block
1672 
1673   // SSA specific fields: (factor out later)
1674   BlockList   _successors;                       // the successors of this block
1675   BlockList   _predecessors;                     // the predecessors of this block
1676   BlockList   _dominates;                        // list of blocks that are dominated by this block
1677   BlockBegin* _dominator;                        // the dominator of this block
1678   // SSA specific ends
1679   BlockEnd*  _end;                               // the last instruction of this block
1680   BlockList  _exception_handlers;                // the exception handlers potentially invoked by this block
1681   ValueStackStack* _exception_states;            // only for xhandler entries: states of all instructions that have an edge to this xhandler
1682   int        _exception_handler_pco;             // if this block is the start of an exception handler,
1683                                                  // this records the PC offset in the assembly code of the
1684                                                  // first instruction in this block
1685   Label      _label;                             // the label associated with this block
1686   LIR_List*  _lir;                               // the low level intermediate representation for this block
1687 
1688   ResourceBitMap _live_in;                       // set of live LIR_Opr registers at entry to this block
1689   ResourceBitMap _live_out;                      // set of live LIR_Opr registers at exit from this block
1690   ResourceBitMap _live_gen;                      // set of registers used before any redefinition in this block
1691   ResourceBitMap _live_kill;                     // set of registers defined in this block
1692 
1693   ResourceBitMap _fpu_register_usage;
1694   intArray*      _fpu_stack_state;               // For x86 FPU code generation with UseLinearScan
1695   int            _first_lir_instruction_id;      // ID of first LIR instruction in this block
1696   int            _last_lir_instruction_id;       // ID of last LIR instruction in this block
1697 
1698   void iterate_preorder (boolArray& mark, BlockClosure* closure);
1699   void iterate_postorder(boolArray& mark, BlockClosure* closure);
1700 
1701   friend class SuxAndWeightAdjuster;
1702 
1703  public:
1704    void* operator new(size_t size) throw() {
1705     Compilation* c = Compilation::current();
1706     void* res = c->arena()->Amalloc(size);
1707     ((BlockBegin*)res)->_id = c->get_next_id();
1708     ((BlockBegin*)res)->_block_id = c->get_next_block_id();
1709     return res;
1710   }
1711 
1712   // initialization/counting
1713   static int  number_of_blocks() {
1714     return Compilation::current()->number_of_blocks();
1715   }
1716 
1717   // creation
1718   BlockBegin(int bci)
1719   : StateSplit(illegalType)
1720   , _bci(bci)
1721   , _depth_first_number(-1)
1722   , _linear_scan_number(-1)
1723   , _dominator_depth(-1)
1724   , _loop_depth(0)
1725   , _loop_index(-1)
1726   , _flags(0)
1727   , _total_preds(0)
1728   , _stores_to_locals()
1729   , _successors(2)
1730   , _predecessors(2)
1731   , _dominates(2)
1732   , _dominator(NULL)
1733   , _end(NULL)
1734   , _exception_handlers(1)
1735   , _exception_states(NULL)
1736   , _exception_handler_pco(-1)
1737   , _lir(NULL)
1738   , _live_in()
1739   , _live_out()
1740   , _live_gen()
1741   , _live_kill()
1742   , _fpu_register_usage()
1743   , _fpu_stack_state(NULL)
1744   , _first_lir_instruction_id(-1)
1745   , _last_lir_instruction_id(-1)
1746   {
1747     _block = this;
1748 #ifndef PRODUCT
1749     set_printable_bci(bci);
1750 #endif
1751   }
1752 
1753   // accessors
1754   int block_id() const                           { return _block_id; }
1755   int bci() const                                { return _bci; }
1756   BlockList* successors()                        { return &_successors; }
1757   BlockList* dominates()                         { return &_dominates; }
1758   BlockBegin* dominator() const                  { return _dominator; }
1759   int loop_depth() const                         { return _loop_depth; }
1760   int dominator_depth() const                    { return _dominator_depth; }
1761   int depth_first_number() const                 { return _depth_first_number; }
1762   int linear_scan_number() const                 { return _linear_scan_number; }
1763   BlockEnd* end() const                          { return _end; }
1764   Label* label()                                 { return &_label; }
1765   LIR_List* lir() const                          { return _lir; }
1766   int exception_handler_pco() const              { return _exception_handler_pco; }
1767   ResourceBitMap& live_in()                      { return _live_in;        }
1768   ResourceBitMap& live_out()                     { return _live_out;       }
1769   ResourceBitMap& live_gen()                     { return _live_gen;       }
1770   ResourceBitMap& live_kill()                    { return _live_kill;      }
1771   ResourceBitMap& fpu_register_usage()           { return _fpu_register_usage; }
1772   intArray* fpu_stack_state() const              { return _fpu_stack_state;    }
1773   int first_lir_instruction_id() const           { return _first_lir_instruction_id; }
1774   int last_lir_instruction_id() const            { return _last_lir_instruction_id; }
1775   int total_preds() const                        { return _total_preds; }
1776   BitMap& stores_to_locals()                     { return _stores_to_locals; }
1777 
1778   // manipulation
1779   void set_dominator(BlockBegin* dom)            { _dominator = dom; }
1780   void set_loop_depth(int d)                     { _loop_depth = d; }
1781   void set_dominator_depth(int d)                { _dominator_depth = d; }
1782   void set_depth_first_number(int dfn)           { _depth_first_number = dfn; }
1783   void set_linear_scan_number(int lsn)           { _linear_scan_number = lsn; }
1784   void set_end(BlockEnd* end);
1785   void clear_end();
1786   void disconnect_from_graph();
1787   static void disconnect_edge(BlockBegin* from, BlockBegin* to);
1788   BlockBegin* insert_block_between(BlockBegin* sux);
1789   void substitute_sux(BlockBegin* old_sux, BlockBegin* new_sux);
1790   void set_lir(LIR_List* lir)                    { _lir = lir; }
1791   void set_exception_handler_pco(int pco)        { _exception_handler_pco = pco; }
1792   void set_live_in  (const ResourceBitMap& map)  { _live_in = map;   }
1793   void set_live_out (const ResourceBitMap& map)  { _live_out = map;  }
1794   void set_live_gen (const ResourceBitMap& map)  { _live_gen = map;  }
1795   void set_live_kill(const ResourceBitMap& map)  { _live_kill = map; }
1796   void set_fpu_register_usage(const ResourceBitMap& map) { _fpu_register_usage = map; }
1797   void set_fpu_stack_state(intArray* state)      { _fpu_stack_state = state;  }
1798   void set_first_lir_instruction_id(int id)      { _first_lir_instruction_id = id;  }
1799   void set_last_lir_instruction_id(int id)       { _last_lir_instruction_id = id;  }
1800   void increment_total_preds(int n = 1)          { _total_preds += n; }
1801   void init_stores_to_locals(int locals_count)   { _stores_to_locals.initialize(locals_count); }
1802 
1803   // generic
1804   virtual void state_values_do(ValueVisitor* f);
1805 
1806   // successors and predecessors
1807   int number_of_sux() const;
1808   BlockBegin* sux_at(int i) const;
1809   void add_successor(BlockBegin* sux);
1810   void remove_successor(BlockBegin* pred);
1811   bool is_successor(BlockBegin* sux) const       { return _successors.contains(sux); }
1812 
1813   void add_predecessor(BlockBegin* pred);
1814   void remove_predecessor(BlockBegin* pred);
1815   bool is_predecessor(BlockBegin* pred) const    { return _predecessors.contains(pred); }
1816   int number_of_preds() const                    { return _predecessors.length(); }
1817   BlockBegin* pred_at(int i) const               { return _predecessors.at(i); }
1818 
1819   // exception handlers potentially invoked by this block
1820   void add_exception_handler(BlockBegin* b);
1821   bool is_exception_handler(BlockBegin* b) const { return _exception_handlers.contains(b); }
1822   int  number_of_exception_handlers() const      { return _exception_handlers.length(); }
1823   BlockBegin* exception_handler_at(int i) const  { return _exception_handlers.at(i); }
1824 
1825   // states of the instructions that have an edge to this exception handler
1826   int number_of_exception_states()               { assert(is_set(exception_entry_flag), "only for xhandlers"); return _exception_states == NULL ? 0 : _exception_states->length(); }
1827   ValueStack* exception_state_at(int idx) const  { assert(is_set(exception_entry_flag), "only for xhandlers"); return _exception_states->at(idx); }
1828   int add_exception_state(ValueStack* state);
1829 
1830   // flags
1831   enum Flag {
1832     no_flag                       = 0,
1833     std_entry_flag                = 1 << 0,
1834     osr_entry_flag                = 1 << 1,
1835     exception_entry_flag          = 1 << 2,
1836     subroutine_entry_flag         = 1 << 3,
1837     backward_branch_target_flag   = 1 << 4,
1838     is_on_work_list_flag          = 1 << 5,
1839     was_visited_flag              = 1 << 6,
1840     parser_loop_header_flag       = 1 << 7,  // set by parser to identify blocks where phi functions can not be created on demand
1841     critical_edge_split_flag      = 1 << 8, // set for all blocks that are introduced when critical edges are split
1842     linear_scan_loop_header_flag  = 1 << 9, // set during loop-detection for LinearScan
1843     linear_scan_loop_end_flag     = 1 << 10, // set during loop-detection for LinearScan
1844     donot_eliminate_range_checks  = 1 << 11  // Should be try to eliminate range checks in this block
1845   };
1846 
1847   void set(Flag f)                               { _flags |= f; }
1848   void clear(Flag f)                             { _flags &= ~f; }
1849   bool is_set(Flag f) const                      { return (_flags & f) != 0; }
1850   bool is_entry_block() const {
1851     const int entry_mask = std_entry_flag | osr_entry_flag | exception_entry_flag;
1852     return (_flags & entry_mask) != 0;
1853   }
1854 
1855   // iteration
1856   void iterate_preorder   (BlockClosure* closure);
1857   void iterate_postorder  (BlockClosure* closure);
1858 
1859   void block_values_do(ValueVisitor* f);
1860 
1861   // loops
1862   void set_loop_index(int ix)                    { _loop_index = ix;        }
1863   int  loop_index() const                        { return _loop_index;      }
1864 
1865   // merging
1866   bool try_merge(ValueStack* state);             // try to merge states at block begin
1867   void merge(ValueStack* state)                  { bool b = try_merge(state); assert(b, "merge failed"); }
1868 
1869   // debugging
1870   void print_block()                             PRODUCT_RETURN;
1871   void print_block(InstructionPrinter& ip, bool live_only = false) PRODUCT_RETURN;
1872 };
1873 
1874 
1875 BASE(BlockEnd, StateSplit)
1876  private:
1877   BlockList*  _sux;
1878 
1879  protected:
1880   BlockList* sux() const                         { return _sux; }
1881 
1882   void set_sux(BlockList* sux) {
1883 #ifdef ASSERT
1884     assert(sux != NULL, "sux must exist");
1885     for (int i = sux->length() - 1; i >= 0; i--) assert(sux->at(i) != NULL, "sux must exist");
1886 #endif
1887     _sux = sux;
1888   }
1889 
1890  public:
1891   // creation
1892   BlockEnd(ValueType* type, ValueStack* state_before, bool is_safepoint)
1893   : StateSplit(type, state_before)
1894   , _sux(NULL)
1895   {
1896     set_flag(IsSafepointFlag, is_safepoint);
1897   }
1898 
1899   // accessors
1900   bool is_safepoint() const                      { return check_flag(IsSafepointFlag); }
1901   // For compatibility with old code, for new code use block()
1902   BlockBegin* begin() const                      { return _block; }
1903 
1904   // manipulation
1905   void set_begin(BlockBegin* begin);
1906 
1907   // successors
1908   int number_of_sux() const                      { return _sux != NULL ? _sux->length() : 0; }
1909   BlockBegin* sux_at(int i) const                { return _sux->at(i); }
1910   BlockBegin* default_sux() const                { return sux_at(number_of_sux() - 1); }
1911   BlockBegin** addr_sux_at(int i) const          { return _sux->adr_at(i); }
1912   int sux_index(BlockBegin* sux) const           { return _sux->find(sux); }
1913   void substitute_sux(BlockBegin* old_sux, BlockBegin* new_sux);
1914 };
1915 
1916 
1917 LEAF(Goto, BlockEnd)
1918  public:
1919   enum Direction {
1920     none,            // Just a regular goto
1921     taken, not_taken // Goto produced from If
1922   };
1923  private:
1924   ciMethod*   _profiled_method;
1925   int         _profiled_bci;
1926   Direction   _direction;
1927  public:
1928   // creation
1929   Goto(BlockBegin* sux, ValueStack* state_before, bool is_safepoint = false)
1930     : BlockEnd(illegalType, state_before, is_safepoint)
1931     , _profiled_method(NULL)
1932     , _profiled_bci(0)
1933     , _direction(none) {
1934     BlockList* s = new BlockList(1);
1935     s->append(sux);
1936     set_sux(s);
1937   }
1938 
1939   Goto(BlockBegin* sux, bool is_safepoint) : BlockEnd(illegalType, NULL, is_safepoint)
1940                                            , _profiled_method(NULL)
1941                                            , _profiled_bci(0)
1942                                            , _direction(none) {
1943     BlockList* s = new BlockList(1);
1944     s->append(sux);
1945     set_sux(s);
1946   }
1947 
1948   bool should_profile() const                    { return check_flag(ProfileMDOFlag); }
1949   ciMethod* profiled_method() const              { return _profiled_method; } // set only for profiled branches
1950   int profiled_bci() const                       { return _profiled_bci; }
1951   Direction direction() const                    { return _direction; }
1952 
1953   void set_should_profile(bool value)            { set_flag(ProfileMDOFlag, value); }
1954   void set_profiled_method(ciMethod* method)     { _profiled_method = method; }
1955   void set_profiled_bci(int bci)                 { _profiled_bci = bci; }
1956   void set_direction(Direction d)                { _direction = d; }
1957 };
1958 
1959 #ifdef ASSERT
1960 LEAF(Assert, Instruction)
1961   private:
1962   Value       _x;
1963   Condition   _cond;
1964   Value       _y;
1965   char        *_message;
1966 
1967  public:
1968   // creation
1969   // unordered_is_true is valid for float/double compares only
1970    Assert(Value x, Condition cond, bool unordered_is_true, Value y);
1971 
1972   // accessors
1973   Value x() const                                { return _x; }
1974   Condition cond() const                         { return _cond; }
1975   bool unordered_is_true() const                 { return check_flag(UnorderedIsTrueFlag); }
1976   Value y() const                                { return _y; }
1977   const char *message() const                    { return _message; }
1978 
1979   // generic
1980   virtual void input_values_do(ValueVisitor* f)  { f->visit(&_x); f->visit(&_y); }
1981 };
1982 #endif
1983 
1984 LEAF(RangeCheckPredicate, StateSplit)
1985  private:
1986   Value       _x;
1987   Condition   _cond;
1988   Value       _y;
1989 
1990   void check_state();
1991 
1992  public:
1993   // creation
1994   // unordered_is_true is valid for float/double compares only
1995    RangeCheckPredicate(Value x, Condition cond, bool unordered_is_true, Value y, ValueStack* state) : StateSplit(illegalType)
1996   , _x(x)
1997   , _cond(cond)
1998   , _y(y)
1999   {
2000     ASSERT_VALUES
2001     set_flag(UnorderedIsTrueFlag, unordered_is_true);
2002     assert(x->type()->tag() == y->type()->tag(), "types must match");
2003     this->set_state(state);
2004     check_state();
2005   }
2006 
2007   // Always deoptimize
2008   RangeCheckPredicate(ValueStack* state) : StateSplit(illegalType)
2009   {
2010     this->set_state(state);
2011     _x = _y = NULL;
2012     check_state();
2013   }
2014 
2015   // accessors
2016   Value x() const                                { return _x; }
2017   Condition cond() const                         { return _cond; }
2018   bool unordered_is_true() const                 { return check_flag(UnorderedIsTrueFlag); }
2019   Value y() const                                { return _y; }
2020 
2021   void always_fail()                             { _x = _y = NULL; }
2022 
2023   // generic
2024   virtual void input_values_do(ValueVisitor* f)  { StateSplit::input_values_do(f); f->visit(&_x); f->visit(&_y); }
2025   HASHING3(RangeCheckPredicate, true, x()->subst(), y()->subst(), cond())
2026 };
2027 
2028 LEAF(If, BlockEnd)
2029  private:
2030   Value       _x;
2031   Condition   _cond;
2032   Value       _y;
2033   ciMethod*   _profiled_method;
2034   int         _profiled_bci; // Canonicalizer may alter bci of If node
2035   bool        _swapped;      // Is the order reversed with respect to the original If in the
2036                              // bytecode stream?
2037  public:
2038   // creation
2039   // unordered_is_true is valid for float/double compares only
2040   If(Value x, Condition cond, bool unordered_is_true, Value y, BlockBegin* tsux, BlockBegin* fsux, ValueStack* state_before, bool is_safepoint)
2041     : BlockEnd(illegalType, state_before, is_safepoint)
2042   , _x(x)
2043   , _cond(cond)
2044   , _y(y)
2045   , _profiled_method(NULL)
2046   , _profiled_bci(0)
2047   , _swapped(false)
2048   {
2049     ASSERT_VALUES
2050     set_flag(UnorderedIsTrueFlag, unordered_is_true);
2051     assert(x->type()->tag() == y->type()->tag(), "types must match");
2052     BlockList* s = new BlockList(2);
2053     s->append(tsux);
2054     s->append(fsux);
2055     set_sux(s);
2056   }
2057 
2058   // accessors
2059   Value x() const                                { return _x; }
2060   Condition cond() const                         { return _cond; }
2061   bool unordered_is_true() const                 { return check_flag(UnorderedIsTrueFlag); }
2062   Value y() const                                { return _y; }
2063   BlockBegin* sux_for(bool is_true) const        { return sux_at(is_true ? 0 : 1); }
2064   BlockBegin* tsux() const                       { return sux_for(true); }
2065   BlockBegin* fsux() const                       { return sux_for(false); }
2066   BlockBegin* usux() const                       { return sux_for(unordered_is_true()); }
2067   bool should_profile() const                    { return check_flag(ProfileMDOFlag); }
2068   ciMethod* profiled_method() const              { return _profiled_method; } // set only for profiled branches
2069   int profiled_bci() const                       { return _profiled_bci; }    // set for profiled branches and tiered
2070   bool is_swapped() const                        { return _swapped; }
2071 
2072   // manipulation
2073   void swap_operands() {
2074     Value t = _x; _x = _y; _y = t;
2075     _cond = mirror(_cond);
2076   }
2077 
2078   void swap_sux() {
2079     assert(number_of_sux() == 2, "wrong number of successors");
2080     BlockList* s = sux();
2081     BlockBegin* t = s->at(0); s->at_put(0, s->at(1)); s->at_put(1, t);
2082     _cond = negate(_cond);
2083     set_flag(UnorderedIsTrueFlag, !check_flag(UnorderedIsTrueFlag));
2084   }
2085 
2086   void set_should_profile(bool value)             { set_flag(ProfileMDOFlag, value); }
2087   void set_profiled_method(ciMethod* method)      { _profiled_method = method; }
2088   void set_profiled_bci(int bci)                  { _profiled_bci = bci;       }
2089   void set_swapped(bool value)                    { _swapped = value;         }
2090   // generic
2091   virtual void input_values_do(ValueVisitor* f)   { BlockEnd::input_values_do(f); f->visit(&_x); f->visit(&_y); }
2092 };
2093 
2094 
2095 LEAF(IfInstanceOf, BlockEnd)
2096  private:
2097   ciKlass* _klass;
2098   Value    _obj;
2099   bool     _test_is_instance;                    // jump if instance
2100   int      _instanceof_bci;
2101 
2102  public:
2103   IfInstanceOf(ciKlass* klass, Value obj, bool test_is_instance, int instanceof_bci, BlockBegin* tsux, BlockBegin* fsux)
2104   : BlockEnd(illegalType, NULL, false) // temporary set to false
2105   , _klass(klass)
2106   , _obj(obj)
2107   , _test_is_instance(test_is_instance)
2108   , _instanceof_bci(instanceof_bci)
2109   {
2110     ASSERT_VALUES
2111     assert(instanceof_bci >= 0, "illegal bci");
2112     BlockList* s = new BlockList(2);
2113     s->append(tsux);
2114     s->append(fsux);
2115     set_sux(s);
2116   }
2117 
2118   // accessors
2119   //
2120   // Note 1: If test_is_instance() is true, IfInstanceOf tests if obj *is* an
2121   //         instance of klass; otherwise it tests if it is *not* and instance
2122   //         of klass.
2123   //
2124   // Note 2: IfInstanceOf instructions are created by combining an InstanceOf
2125   //         and an If instruction. The IfInstanceOf bci() corresponds to the
2126   //         bci that the If would have had; the (this->) instanceof_bci() is
2127   //         the bci of the original InstanceOf instruction.
2128   ciKlass* klass() const                         { return _klass; }
2129   Value obj() const                              { return _obj; }
2130   int instanceof_bci() const                     { return _instanceof_bci; }
2131   bool test_is_instance() const                  { return _test_is_instance; }
2132   BlockBegin* sux_for(bool is_true) const        { return sux_at(is_true ? 0 : 1); }
2133   BlockBegin* tsux() const                       { return sux_for(true); }
2134   BlockBegin* fsux() const                       { return sux_for(false); }
2135 
2136   // manipulation
2137   void swap_sux() {
2138     assert(number_of_sux() == 2, "wrong number of successors");
2139     BlockList* s = sux();
2140     BlockBegin* t = s->at(0); s->at_put(0, s->at(1)); s->at_put(1, t);
2141     _test_is_instance = !_test_is_instance;
2142   }
2143 
2144   // generic
2145   virtual void input_values_do(ValueVisitor* f)   { BlockEnd::input_values_do(f); f->visit(&_obj); }
2146 };
2147 
2148 
2149 BASE(Switch, BlockEnd)
2150  private:
2151   Value       _tag;
2152 
2153  public:
2154   // creation
2155   Switch(Value tag, BlockList* sux, ValueStack* state_before, bool is_safepoint)
2156   : BlockEnd(illegalType, state_before, is_safepoint)
2157   , _tag(tag) {
2158     ASSERT_VALUES
2159     set_sux(sux);
2160   }
2161 
2162   // accessors
2163   Value tag() const                              { return _tag; }
2164   int length() const                             { return number_of_sux() - 1; }
2165 
2166   virtual bool needs_exception_state() const     { return false; }
2167 
2168   // generic
2169   virtual void input_values_do(ValueVisitor* f)   { BlockEnd::input_values_do(f); f->visit(&_tag); }
2170 };
2171 
2172 
2173 LEAF(TableSwitch, Switch)
2174  private:
2175   int _lo_key;
2176 
2177  public:
2178   // creation
2179   TableSwitch(Value tag, BlockList* sux, int lo_key, ValueStack* state_before, bool is_safepoint)
2180     : Switch(tag, sux, state_before, is_safepoint)
2181   , _lo_key(lo_key) { assert(_lo_key <= hi_key(), "integer overflow"); }
2182 
2183   // accessors
2184   int lo_key() const                             { return _lo_key; }
2185   int hi_key() const                             { return _lo_key + (length() - 1); }
2186 };
2187 
2188 
2189 LEAF(LookupSwitch, Switch)
2190  private:
2191   intArray* _keys;
2192 
2193  public:
2194   // creation
2195   LookupSwitch(Value tag, BlockList* sux, intArray* keys, ValueStack* state_before, bool is_safepoint)
2196   : Switch(tag, sux, state_before, is_safepoint)
2197   , _keys(keys) {
2198     assert(keys != NULL, "keys must exist");
2199     assert(keys->length() == length(), "sux & keys have incompatible lengths");
2200   }
2201 
2202   // accessors
2203   int key_at(int i) const                        { return _keys->at(i); }
2204 };
2205 
2206 
2207 LEAF(Return, BlockEnd)
2208  private:
2209   Value _result;
2210 
2211  public:
2212   // creation
2213   Return(Value result) :
2214     BlockEnd(result == NULL ? voidType : result->type()->base(), NULL, true),
2215     _result(result) {}
2216 
2217   // accessors
2218   Value result() const                           { return _result; }
2219   bool has_result() const                        { return result() != NULL; }
2220 
2221   // generic
2222   virtual void input_values_do(ValueVisitor* f) {
2223     BlockEnd::input_values_do(f);
2224     if (has_result()) f->visit(&_result);
2225   }
2226 };
2227 
2228 
2229 LEAF(Throw, BlockEnd)
2230  private:
2231   Value _exception;
2232 
2233  public:
2234   // creation
2235   Throw(Value exception, ValueStack* state_before) : BlockEnd(illegalType, state_before, true), _exception(exception) {
2236     ASSERT_VALUES
2237   }
2238 
2239   // accessors
2240   Value exception() const                        { return _exception; }
2241 
2242   // generic
2243   virtual bool can_trap() const                  { return true; }
2244   virtual void input_values_do(ValueVisitor* f)   { BlockEnd::input_values_do(f); f->visit(&_exception); }
2245 };
2246 
2247 
2248 LEAF(Base, BlockEnd)
2249  public:
2250   // creation
2251   Base(BlockBegin* std_entry, BlockBegin* osr_entry) : BlockEnd(illegalType, NULL, false) {
2252     assert(std_entry->is_set(BlockBegin::std_entry_flag), "std entry must be flagged");
2253     assert(osr_entry == NULL || osr_entry->is_set(BlockBegin::osr_entry_flag), "osr entry must be flagged");
2254     BlockList* s = new BlockList(2);
2255     if (osr_entry != NULL) s->append(osr_entry);
2256     s->append(std_entry); // must be default sux!
2257     set_sux(s);
2258   }
2259 
2260   // accessors
2261   BlockBegin* std_entry() const                  { return default_sux(); }
2262   BlockBegin* osr_entry() const                  { return number_of_sux() < 2 ? NULL : sux_at(0); }
2263 };
2264 
2265 
2266 LEAF(OsrEntry, Instruction)
2267  public:
2268   // creation
2269 #ifdef _LP64
2270   OsrEntry() : Instruction(longType) { pin(); }
2271 #else
2272   OsrEntry() : Instruction(intType)  { pin(); }
2273 #endif
2274 
2275   // generic
2276   virtual void input_values_do(ValueVisitor* f)   { }
2277 };
2278 
2279 
2280 // Models the incoming exception at a catch site
2281 LEAF(ExceptionObject, Instruction)
2282  public:
2283   // creation
2284   ExceptionObject() : Instruction(objectType) {
2285     pin();
2286   }
2287 
2288   // generic
2289   virtual void input_values_do(ValueVisitor* f)   { }
2290 };
2291 
2292 
2293 // Models needed rounding for floating-point values on Intel.
2294 // Currently only used to represent rounding of double-precision
2295 // values stored into local variables, but could be used to model
2296 // intermediate rounding of single-precision values as well.
2297 LEAF(RoundFP, Instruction)
2298  private:
2299   Value _input;             // floating-point value to be rounded
2300 
2301  public:
2302   RoundFP(Value input)
2303   : Instruction(input->type()) // Note: should not be used for constants
2304   , _input(input)
2305   {
2306     ASSERT_VALUES
2307   }
2308 
2309   // accessors
2310   Value input() const                            { return _input; }
2311 
2312   // generic
2313   virtual void input_values_do(ValueVisitor* f)   { f->visit(&_input); }
2314 };
2315 
2316 
2317 BASE(UnsafeOp, Instruction)
2318  private:
2319   BasicType _basic_type;    // ValueType can not express byte-sized integers
2320 
2321  protected:
2322   // creation
2323   UnsafeOp(BasicType basic_type, bool is_put)
2324   : Instruction(is_put ? voidType : as_ValueType(basic_type))
2325   , _basic_type(basic_type)
2326   {
2327     //Note:  Unsafe ops are not not guaranteed to throw NPE.
2328     // Convservatively, Unsafe operations must be pinned though we could be
2329     // looser about this if we wanted to..
2330     pin();
2331   }
2332 
2333  public:
2334   // accessors
2335   BasicType basic_type()                         { return _basic_type; }
2336 
2337   // generic
2338   virtual void input_values_do(ValueVisitor* f)   { }
2339 };
2340 
2341 
2342 BASE(UnsafeRawOp, UnsafeOp)
2343  private:
2344   Value _base;                                   // Base address (a Java long)
2345   Value _index;                                  // Index if computed by optimizer; initialized to NULL
2346   int   _log2_scale;                             // Scale factor: 0, 1, 2, or 3.
2347                                                  // Indicates log2 of number of bytes (1, 2, 4, or 8)
2348                                                  // to scale index by.
2349 
2350  protected:
2351   UnsafeRawOp(BasicType basic_type, Value addr, bool is_put)
2352   : UnsafeOp(basic_type, is_put)
2353   , _base(addr)
2354   , _index(NULL)
2355   , _log2_scale(0)
2356   {
2357     // Can not use ASSERT_VALUES because index may be NULL
2358     assert(addr != NULL && addr->type()->is_long(), "just checking");
2359   }
2360 
2361   UnsafeRawOp(BasicType basic_type, Value base, Value index, int log2_scale, bool is_put)
2362   : UnsafeOp(basic_type, is_put)
2363   , _base(base)
2364   , _index(index)
2365   , _log2_scale(log2_scale)
2366   {
2367   }
2368 
2369  public:
2370   // accessors
2371   Value base()                                   { return _base; }
2372   Value index()                                  { return _index; }
2373   bool  has_index()                              { return (_index != NULL); }
2374   int   log2_scale()                             { return _log2_scale; }
2375 
2376   // setters
2377   void set_base (Value base)                     { _base  = base; }
2378   void set_index(Value index)                    { _index = index; }
2379   void set_log2_scale(int log2_scale)            { _log2_scale = log2_scale; }
2380 
2381   // generic
2382   virtual void input_values_do(ValueVisitor* f)   { UnsafeOp::input_values_do(f);
2383                                                    f->visit(&_base);
2384                                                    if (has_index()) f->visit(&_index); }
2385 };
2386 
2387 
2388 LEAF(UnsafeGetRaw, UnsafeRawOp)
2389  private:
2390  bool _may_be_unaligned, _is_wide;  // For OSREntry
2391 
2392  public:
2393  UnsafeGetRaw(BasicType basic_type, Value addr, bool may_be_unaligned, bool is_wide = false)
2394   : UnsafeRawOp(basic_type, addr, false) {
2395     _may_be_unaligned = may_be_unaligned;
2396     _is_wide = is_wide;
2397   }
2398 
2399  UnsafeGetRaw(BasicType basic_type, Value base, Value index, int log2_scale, bool may_be_unaligned, bool is_wide = false)
2400   : UnsafeRawOp(basic_type, base, index, log2_scale, false) {
2401     _may_be_unaligned = may_be_unaligned;
2402     _is_wide = is_wide;
2403   }
2404 
2405   bool may_be_unaligned()                         { return _may_be_unaligned; }
2406   bool is_wide()                                  { return _is_wide; }
2407 };
2408 
2409 
2410 LEAF(UnsafePutRaw, UnsafeRawOp)
2411  private:
2412   Value _value;                                  // Value to be stored
2413 
2414  public:
2415   UnsafePutRaw(BasicType basic_type, Value addr, Value value)
2416   : UnsafeRawOp(basic_type, addr, true)
2417   , _value(value)
2418   {
2419     assert(value != NULL, "just checking");
2420     ASSERT_VALUES
2421   }
2422 
2423   UnsafePutRaw(BasicType basic_type, Value base, Value index, int log2_scale, Value value)
2424   : UnsafeRawOp(basic_type, base, index, log2_scale, true)
2425   , _value(value)
2426   {
2427     assert(value != NULL, "just checking");
2428     ASSERT_VALUES
2429   }
2430 
2431   // accessors
2432   Value value()                                  { return _value; }
2433 
2434   // generic
2435   virtual void input_values_do(ValueVisitor* f)   { UnsafeRawOp::input_values_do(f);
2436                                                    f->visit(&_value); }
2437 };
2438 
2439 
2440 BASE(UnsafeObjectOp, UnsafeOp)
2441  private:
2442   Value _object;                                 // Object to be fetched from or mutated
2443   Value _offset;                                 // Offset within object
2444   bool  _is_volatile;                            // true if volatile - dl/JSR166
2445  public:
2446   UnsafeObjectOp(BasicType basic_type, Value object, Value offset, bool is_put, bool is_volatile)
2447     : UnsafeOp(basic_type, is_put), _object(object), _offset(offset), _is_volatile(is_volatile)
2448   {
2449   }
2450 
2451   // accessors
2452   Value object()                                 { return _object; }
2453   Value offset()                                 { return _offset; }
2454   bool  is_volatile()                            { return _is_volatile; }
2455   // generic
2456   virtual void input_values_do(ValueVisitor* f)   { UnsafeOp::input_values_do(f);
2457                                                    f->visit(&_object);
2458                                                    f->visit(&_offset); }
2459 };
2460 
2461 
2462 LEAF(UnsafeGetObject, UnsafeObjectOp)
2463  public:
2464   UnsafeGetObject(BasicType basic_type, Value object, Value offset, bool is_volatile)
2465   : UnsafeObjectOp(basic_type, object, offset, false, is_volatile)
2466   {
2467     ASSERT_VALUES
2468   }
2469 };
2470 
2471 
2472 LEAF(UnsafePutObject, UnsafeObjectOp)
2473  private:
2474   Value _value;                                  // Value to be stored
2475  public:
2476   UnsafePutObject(BasicType basic_type, Value object, Value offset, Value value, bool is_volatile)
2477   : UnsafeObjectOp(basic_type, object, offset, true, is_volatile)
2478     , _value(value)
2479   {
2480     ASSERT_VALUES
2481   }
2482 
2483   // accessors
2484   Value value()                                  { return _value; }
2485 
2486   // generic
2487   virtual void input_values_do(ValueVisitor* f)   { UnsafeObjectOp::input_values_do(f);
2488                                                    f->visit(&_value); }
2489 };
2490 
2491 LEAF(UnsafeGetAndSetObject, UnsafeObjectOp)
2492  private:
2493   Value _value;                                  // Value to be stored
2494   bool  _is_add;
2495  public:
2496   UnsafeGetAndSetObject(BasicType basic_type, Value object, Value offset, Value value, bool is_add)
2497   : UnsafeObjectOp(basic_type, object, offset, false, false)
2498     , _value(value)
2499     , _is_add(is_add)
2500   {
2501     ASSERT_VALUES
2502   }
2503 
2504   // accessors
2505   bool is_add() const                            { return _is_add; }
2506   Value value()                                  { return _value; }
2507 
2508   // generic
2509   virtual void input_values_do(ValueVisitor* f)   { UnsafeObjectOp::input_values_do(f);
2510                                                    f->visit(&_value); }
2511 };
2512 
2513 LEAF(ProfileCall, Instruction)
2514  private:
2515   ciMethod*        _method;
2516   int              _bci_of_invoke;
2517   ciMethod*        _callee;         // the method that is called at the given bci
2518   Value            _recv;
2519   ciKlass*         _known_holder;
2520   Values*          _obj_args;       // arguments for type profiling
2521   ArgsNonNullState _nonnull_state;  // Do we know whether some arguments are never null?
2522   bool             _inlined;        // Are we profiling a call that is inlined
2523 
2524  public:
2525   ProfileCall(ciMethod* method, int bci, ciMethod* callee, Value recv, ciKlass* known_holder, Values* obj_args, bool inlined)
2526     : Instruction(voidType)
2527     , _method(method)
2528     , _bci_of_invoke(bci)
2529     , _callee(callee)
2530     , _recv(recv)
2531     , _known_holder(known_holder)
2532     , _obj_args(obj_args)
2533     , _inlined(inlined)
2534   {
2535     // The ProfileCall has side-effects and must occur precisely where located
2536     pin();
2537   }
2538 
2539   ciMethod* method()             const { return _method; }
2540   int bci_of_invoke()            const { return _bci_of_invoke; }
2541   ciMethod* callee()             const { return _callee; }
2542   Value recv()                   const { return _recv; }
2543   ciKlass* known_holder()        const { return _known_holder; }
2544   int nb_profiled_args()         const { return _obj_args == NULL ? 0 : _obj_args->length(); }
2545   Value profiled_arg_at(int i)   const { return _obj_args->at(i); }
2546   bool arg_needs_null_check(int i) const {
2547     return _nonnull_state.arg_needs_null_check(i);
2548   }
2549   bool inlined()                 const { return _inlined; }
2550 
2551   void set_arg_needs_null_check(int i, bool check) {
2552     _nonnull_state.set_arg_needs_null_check(i, check);
2553   }
2554 
2555   virtual void input_values_do(ValueVisitor* f)   {
2556     if (_recv != NULL) {
2557       f->visit(&_recv);
2558     }
2559     for (int i = 0; i < nb_profiled_args(); i++) {
2560       f->visit(_obj_args->adr_at(i));
2561     }
2562   }
2563 };
2564 
2565 LEAF(ProfileReturnType, Instruction)
2566  private:
2567   ciMethod*        _method;
2568   ciMethod*        _callee;
2569   int              _bci_of_invoke;
2570   Value            _ret;
2571 
2572  public:
2573   ProfileReturnType(ciMethod* method, int bci, ciMethod* callee, Value ret)
2574     : Instruction(voidType)
2575     , _method(method)
2576     , _callee(callee)
2577     , _bci_of_invoke(bci)
2578     , _ret(ret)
2579   {
2580     set_needs_null_check(true);
2581     // The ProfileType has side-effects and must occur precisely where located
2582     pin();
2583   }
2584 
2585   ciMethod* method()             const { return _method; }
2586   ciMethod* callee()             const { return _callee; }
2587   int bci_of_invoke()            const { return _bci_of_invoke; }
2588   Value ret()                    const { return _ret; }
2589 
2590   virtual void input_values_do(ValueVisitor* f)   {
2591     if (_ret != NULL) {
2592       f->visit(&_ret);
2593     }
2594   }
2595 };
2596 
2597 // Call some C runtime function that doesn't safepoint,
2598 // optionally passing the current thread as the first argument.
2599 LEAF(RuntimeCall, Instruction)
2600  private:
2601   const char* _entry_name;
2602   address     _entry;
2603   Values*     _args;
2604   bool        _pass_thread;  // Pass the JavaThread* as an implicit first argument
2605 
2606  public:
2607   RuntimeCall(ValueType* type, const char* entry_name, address entry, Values* args, bool pass_thread = true)
2608     : Instruction(type)
2609     , _entry_name(entry_name)
2610     , _entry(entry)
2611     , _args(args)
2612     , _pass_thread(pass_thread) {
2613     ASSERT_VALUES
2614     pin();
2615   }
2616 
2617   const char* entry_name() const  { return _entry_name; }
2618   address entry() const           { return _entry; }
2619   int number_of_arguments() const { return _args->length(); }
2620   Value argument_at(int i) const  { return _args->at(i); }
2621   bool pass_thread() const        { return _pass_thread; }
2622 
2623   virtual void input_values_do(ValueVisitor* f)   {
2624     for (int i = 0; i < _args->length(); i++) f->visit(_args->adr_at(i));
2625   }
2626 };
2627 
2628 // Use to trip invocation counter of an inlined method
2629 
2630 LEAF(ProfileInvoke, Instruction)
2631  private:
2632   ciMethod*   _inlinee;
2633   ValueStack* _state;
2634 
2635  public:
2636   ProfileInvoke(ciMethod* inlinee,  ValueStack* state)
2637     : Instruction(voidType)
2638     , _inlinee(inlinee)
2639     , _state(state)
2640   {
2641     // The ProfileInvoke has side-effects and must occur precisely where located QQQ???
2642     pin();
2643   }
2644 
2645   ciMethod* inlinee()      { return _inlinee; }
2646   ValueStack* state()      { return _state; }
2647   virtual void input_values_do(ValueVisitor*)   {}
2648   virtual void state_values_do(ValueVisitor*);
2649 };
2650 
2651 LEAF(MemBar, Instruction)
2652  private:
2653   LIR_Code _code;
2654 
2655  public:
2656   MemBar(LIR_Code code)
2657     : Instruction(voidType)
2658     , _code(code)
2659   {
2660     pin();
2661   }
2662 
2663   LIR_Code code()           { return _code; }
2664 
2665   virtual void input_values_do(ValueVisitor*)   {}
2666 };
2667 
2668 class BlockPair: public CompilationResourceObj {
2669  private:
2670   BlockBegin* _from;
2671   BlockBegin* _to;
2672  public:
2673   BlockPair(BlockBegin* from, BlockBegin* to): _from(from), _to(to) {}
2674   BlockBegin* from() const { return _from; }
2675   BlockBegin* to() const   { return _to;   }
2676   bool is_same(BlockBegin* from, BlockBegin* to) const { return  _from == from && _to == to; }
2677   bool is_same(BlockPair* p) const { return  _from == p->from() && _to == p->to(); }
2678   void set_to(BlockBegin* b)   { _to = b; }
2679   void set_from(BlockBegin* b) { _from = b; }
2680 };
2681 
2682 typedef GrowableArray<BlockPair*> BlockPairList;
2683 
2684 inline int         BlockBegin::number_of_sux() const            { assert(_end == NULL || _end->number_of_sux() == _successors.length(), "mismatch"); return _successors.length(); }
2685 inline BlockBegin* BlockBegin::sux_at(int i) const              { assert(_end == NULL || _end->sux_at(i) == _successors.at(i), "mismatch");          return _successors.at(i); }
2686 inline void        BlockBegin::add_successor(BlockBegin* sux)   { assert(_end == NULL, "Would create mismatch with successors of BlockEnd");         _successors.append(sux); }
2687 
2688 #undef ASSERT_VALUES
2689 
2690 #endif // SHARE_VM_C1_C1_INSTRUCTION_HPP