1 /*
   2  * Copyright (c) 2000, 2023, 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_C1_C1_LIR_HPP
  26 #define SHARE_C1_C1_LIR_HPP
  27 
  28 #include "c1/c1_Defs.hpp"
  29 #include "c1/c1_ValueType.hpp"
  30 #include "oops/method.hpp"
  31 #include "utilities/globalDefinitions.hpp"
  32 
  33 class BlockBegin;
  34 class BlockList;
  35 class LIR_Assembler;
  36 class CodeEmitInfo;
  37 class CodeStub;
  38 class CodeStubList;
  39 class C1SafepointPollStub;
  40 class ArrayCopyStub;
  41 class LIR_Op;
  42 class ciType;
  43 class ValueType;
  44 class LIR_OpVisitState;
  45 class FpuStackSim;
  46 
  47 //---------------------------------------------------------------------
  48 //                 LIR Operands
  49 //    LIR_OprPtr
  50 //      LIR_Const
  51 //      LIR_Address
  52 //---------------------------------------------------------------------
  53 class LIR_OprPtr;
  54 class LIR_Const;
  55 class LIR_Address;
  56 class LIR_OprVisitor;
  57 class LIR_Opr;
  58 
  59 typedef int          RegNr;
  60 
  61 typedef GrowableArray<LIR_Opr> LIR_OprList;
  62 typedef GrowableArray<LIR_Op*> LIR_OpArray;
  63 typedef GrowableArray<LIR_Op*> LIR_OpList;
  64 
  65 // define LIR_OprPtr early so LIR_Opr can refer to it
  66 class LIR_OprPtr: public CompilationResourceObj {
  67  public:
  68   bool is_oop_pointer() const                    { return (type() == T_OBJECT); }
  69   bool is_float_kind() const                     { BasicType t = type(); return (t == T_FLOAT) || (t == T_DOUBLE); }
  70 
  71   virtual LIR_Const*  as_constant()              { return nullptr; }
  72   virtual LIR_Address* as_address()              { return nullptr; }
  73   virtual BasicType type() const                 = 0;
  74   virtual void print_value_on(outputStream* out) const = 0;
  75 };
  76 
  77 
  78 
  79 // LIR constants
  80 class LIR_Const: public LIR_OprPtr {
  81  private:
  82   JavaValue _value;
  83 
  84   void type_check(BasicType t) const   { assert(type() == t, "type check"); }
  85   void type_check(BasicType t1, BasicType t2) const   { assert(type() == t1 || type() == t2, "type check"); }
  86   void type_check(BasicType t1, BasicType t2, BasicType t3) const   { assert(type() == t1 || type() == t2 || type() == t3, "type check"); }
  87 
  88  public:
  89   LIR_Const(jint i, bool is_address=false)       { _value.set_type(is_address?T_ADDRESS:T_INT); _value.set_jint(i); }
  90   LIR_Const(jlong l)                             { _value.set_type(T_LONG);    _value.set_jlong(l); }
  91   LIR_Const(jfloat f)                            { _value.set_type(T_FLOAT);   _value.set_jfloat(f); }
  92   LIR_Const(jdouble d)                           { _value.set_type(T_DOUBLE);  _value.set_jdouble(d); }
  93   LIR_Const(jobject o)                           { _value.set_type(T_OBJECT);  _value.set_jobject(o); }
  94   LIR_Const(void* p) {
  95 #ifdef _LP64
  96     assert(sizeof(jlong) >= sizeof(p), "too small");;
  97     _value.set_type(T_LONG);    _value.set_jlong((jlong)p);
  98 #else
  99     assert(sizeof(jint) >= sizeof(p), "too small");;
 100     _value.set_type(T_INT);     _value.set_jint((jint)p);
 101 #endif
 102   }
 103   LIR_Const(Metadata* m) {
 104     _value.set_type(T_METADATA);
 105 #ifdef _LP64
 106     _value.set_jlong((jlong)m);
 107 #else
 108     _value.set_jint((jint)m);
 109 #endif // _LP64
 110   }
 111 
 112   virtual BasicType type()       const { return _value.get_type(); }
 113   virtual LIR_Const* as_constant()     { return this; }
 114 
 115   jint      as_jint()    const         { type_check(T_INT, T_ADDRESS); return _value.get_jint(); }
 116   jlong     as_jlong()   const         { type_check(T_LONG  ); return _value.get_jlong(); }
 117   jfloat    as_jfloat()  const         { type_check(T_FLOAT ); return _value.get_jfloat(); }
 118   jdouble   as_jdouble() const         { type_check(T_DOUBLE); return _value.get_jdouble(); }
 119   jobject   as_jobject() const         { type_check(T_OBJECT); return _value.get_jobject(); }
 120   jint      as_jint_lo() const         { type_check(T_LONG  ); return low(_value.get_jlong()); }
 121   jint      as_jint_hi() const         { type_check(T_LONG  ); return high(_value.get_jlong()); }
 122 
 123 #ifdef _LP64
 124   address   as_pointer() const         { type_check(T_LONG  ); return (address)_value.get_jlong(); }
 125   Metadata* as_metadata() const        { type_check(T_METADATA); return (Metadata*)_value.get_jlong(); }
 126 #else
 127   address   as_pointer() const         { type_check(T_INT   ); return (address)_value.get_jint(); }
 128   Metadata* as_metadata() const        { type_check(T_METADATA); return (Metadata*)_value.get_jint(); }
 129 #endif
 130 
 131 
 132   jint      as_jint_bits() const       { type_check(T_FLOAT, T_INT, T_ADDRESS); return _value.get_jint(); }
 133   jint      as_jint_lo_bits() const    {
 134     if (type() == T_DOUBLE) {
 135       return low(jlong_cast(_value.get_jdouble()));
 136     } else {
 137       return as_jint_lo();
 138     }
 139   }
 140   jint      as_jint_hi_bits() const    {
 141     if (type() == T_DOUBLE) {
 142       return high(jlong_cast(_value.get_jdouble()));
 143     } else {
 144       return as_jint_hi();
 145     }
 146   }
 147   jlong      as_jlong_bits() const    {
 148     if (type() == T_DOUBLE) {
 149       return jlong_cast(_value.get_jdouble());
 150     } else {
 151       return as_jlong();
 152     }
 153   }
 154 
 155   virtual void print_value_on(outputStream* out) const PRODUCT_RETURN;
 156 
 157 
 158   bool is_zero_float() {
 159     jfloat f = as_jfloat();
 160     jfloat ok = 0.0f;
 161     return jint_cast(f) == jint_cast(ok);
 162   }
 163 
 164   bool is_one_float() {
 165     jfloat f = as_jfloat();
 166     return !g_isnan(f) && g_isfinite(f) && f == 1.0;
 167   }
 168 
 169   bool is_zero_double() {
 170     jdouble d = as_jdouble();
 171     jdouble ok = 0.0;
 172     return jlong_cast(d) == jlong_cast(ok);
 173   }
 174 
 175   bool is_one_double() {
 176     jdouble d = as_jdouble();
 177     return !g_isnan(d) && g_isfinite(d) && d == 1.0;
 178   }
 179 };
 180 
 181 
 182 //---------------------LIR Operand descriptor------------------------------------
 183 //
 184 // The class LIR_Opr represents a LIR instruction operand;
 185 // it can be a register (ALU/FPU), stack location or a constant;
 186 // Constants and addresses are represented as resource area allocated
 187 // structures (see above), and pointers are stored in the _value field (cast to
 188 // an intptr_t).
 189 // Registers and stack locations are represented inline as integers.
 190 // (see value function).
 191 
 192 // Previously, this class was derived from CompilationResourceObj.
 193 // However, deriving from any of the "Obj" types in allocation.hpp seems
 194 // detrimental, since in some build modes it would add a vtable to this class,
 195 // which make it no longer be a 1-word trivially-copyable wrapper object,
 196 // which is the entire point of it.
 197 
 198 class LIR_Opr {
 199  public:
 200   // value structure:
 201   //          data        other-non-data opr-type opr-kind
 202   // +-------------------+--------------+-------+-----+
 203   // [max...............................|6 5 4 3|2 1 0]
 204   //                                                 ^
 205   //                                           is_pointer bit
 206   //
 207   // lowest bit cleared, means it is a structure pointer
 208   // we need 4 bits to represent types
 209 
 210  private:
 211   friend class LIR_OprFact;
 212 
 213   intptr_t _value;
 214   // Conversion
 215   intptr_t value() const                         { return _value; }
 216 
 217   bool check_value_mask(intptr_t mask, intptr_t masked_value) const {
 218     return (value() & mask) == masked_value;
 219   }
 220 
 221   enum OprKind {
 222       pointer_value      = 0
 223     , stack_value        = 1
 224     , cpu_register       = 3
 225     , fpu_register       = 5
 226     , illegal_value      = 7
 227   };
 228 
 229   enum OprBits {
 230       pointer_bits   = 1
 231     , kind_bits      = 3
 232     , type_bits      = 4
 233     , size_bits      = 2
 234     , destroys_bits  = 1
 235     , virtual_bits   = 1
 236     , is_xmm_bits    = 1
 237     , last_use_bits  = 1
 238     , is_fpu_stack_offset_bits = 1        // used in assertion checking on x86 for FPU stack slot allocation
 239     , non_data_bits  = kind_bits + type_bits + size_bits + destroys_bits + virtual_bits
 240                        + is_xmm_bits + last_use_bits + is_fpu_stack_offset_bits
 241     , data_bits      = BitsPerInt - non_data_bits
 242     , reg_bits       = data_bits / 2      // for two registers in one value encoding
 243   };
 244 
 245   enum OprShift : uintptr_t {
 246       kind_shift     = 0
 247     , type_shift     = kind_shift     + kind_bits
 248     , size_shift     = type_shift     + type_bits
 249     , destroys_shift = size_shift     + size_bits
 250     , last_use_shift = destroys_shift + destroys_bits
 251     , is_fpu_stack_offset_shift = last_use_shift + last_use_bits
 252     , virtual_shift  = is_fpu_stack_offset_shift + is_fpu_stack_offset_bits
 253     , is_xmm_shift   = virtual_shift + virtual_bits
 254     , data_shift     = is_xmm_shift + is_xmm_bits
 255     , reg1_shift = data_shift
 256     , reg2_shift = data_shift + reg_bits
 257 
 258   };
 259 
 260   enum OprSize {
 261       single_size = 0 << size_shift
 262     , double_size = 1 << size_shift
 263   };
 264 
 265   enum OprMask {
 266       kind_mask      = right_n_bits(kind_bits)
 267     , type_mask      = right_n_bits(type_bits) << type_shift
 268     , size_mask      = right_n_bits(size_bits) << size_shift
 269     , last_use_mask  = right_n_bits(last_use_bits) << last_use_shift
 270     , is_fpu_stack_offset_mask = right_n_bits(is_fpu_stack_offset_bits) << is_fpu_stack_offset_shift
 271     , virtual_mask   = right_n_bits(virtual_bits) << virtual_shift
 272     , is_xmm_mask    = right_n_bits(is_xmm_bits) << is_xmm_shift
 273     , pointer_mask   = right_n_bits(pointer_bits)
 274     , lower_reg_mask = right_n_bits(reg_bits)
 275     , no_type_mask   = (int)(~(type_mask | last_use_mask | is_fpu_stack_offset_mask))
 276   };
 277 
 278   uint32_t data() const                          { return (uint32_t)value() >> data_shift; }
 279   int lo_reg_half() const                        { return data() & lower_reg_mask; }
 280   int hi_reg_half() const                        { return (data() >> reg_bits) & lower_reg_mask; }
 281   OprKind kind_field() const                     { return (OprKind)(value() & kind_mask); }
 282   OprSize size_field() const                     { return (OprSize)(value() & size_mask); }
 283 
 284   static char type_char(BasicType t);
 285 
 286  public:
 287   LIR_Opr() : _value(0) {}
 288   LIR_Opr(intptr_t val) : _value(val) {}
 289   LIR_Opr(LIR_OprPtr *val) : _value(reinterpret_cast<intptr_t>(val)) {}
 290   bool operator==(const LIR_Opr &other) const { return _value == other._value; }
 291   bool operator!=(const LIR_Opr &other) const { return _value != other._value; }
 292   explicit operator bool() const { return _value != 0; }
 293 
 294   // UGLY HACK: make this value object look like a pointer (to itself). This
 295   // operator overload should be removed, and all callers updated from
 296   // `opr->fn()` to `opr.fn()`.
 297   const LIR_Opr* operator->() const { return this; }
 298   LIR_Opr* operator->() { return this; }
 299 
 300   enum {
 301     vreg_base = ConcreteRegisterImpl::number_of_registers,
 302     data_max = (1 << data_bits) - 1,      // max unsigned value for data bit field
 303     vreg_limit =  10000,                  // choose a reasonable limit,
 304     vreg_max = MIN2(vreg_limit, data_max) // and make sure if fits in the bit field
 305   };
 306 
 307   static inline LIR_Opr illegalOpr();
 308   static inline LIR_Opr nullOpr();
 309 
 310   enum OprType {
 311       unknown_type  = 0 << type_shift    // means: not set (catch uninitialized types)
 312     , int_type      = 1 << type_shift
 313     , long_type     = 2 << type_shift
 314     , object_type   = 3 << type_shift
 315     , address_type  = 4 << type_shift
 316     , float_type    = 5 << type_shift
 317     , double_type   = 6 << type_shift
 318     , metadata_type = 7 << type_shift
 319   };
 320   friend OprType as_OprType(BasicType t);
 321   friend BasicType as_BasicType(OprType t);
 322 
 323   OprType type_field_valid() const               { assert(is_register() || is_stack(), "should not be called otherwise"); return (OprType)(value() & type_mask); }
 324   OprType type_field() const                     { return is_illegal() ? unknown_type : (OprType)(value() & type_mask); }
 325 
 326   static OprSize size_for(BasicType t) {
 327     switch (t) {
 328       case T_LONG:
 329       case T_DOUBLE:
 330         return double_size;
 331         break;
 332 
 333       case T_FLOAT:
 334       case T_BOOLEAN:
 335       case T_CHAR:
 336       case T_BYTE:
 337       case T_SHORT:
 338       case T_INT:
 339       case T_ADDRESS:
 340       case T_OBJECT:
 341       case T_ARRAY:
 342       case T_METADATA:
 343         return single_size;
 344         break;
 345 
 346       default:
 347         ShouldNotReachHere();
 348         return single_size;
 349       }
 350   }
 351 
 352 
 353   void validate_type() const PRODUCT_RETURN;
 354 
 355   BasicType type() const {
 356     if (is_pointer()) {
 357       return pointer()->type();
 358     }
 359     return as_BasicType(type_field());
 360   }
 361 
 362 
 363   ValueType* value_type() const                  { return as_ValueType(type()); }
 364 
 365   char type_char() const                         { return type_char((is_pointer()) ? pointer()->type() : type()); }
 366 
 367   bool is_equal(LIR_Opr opr) const         { return *this == opr; }
 368   // checks whether types are same
 369   bool is_same_type(LIR_Opr opr) const     {
 370     assert(type_field() != unknown_type &&
 371            opr->type_field() != unknown_type, "shouldn't see unknown_type");
 372     return type_field() == opr->type_field();
 373   }
 374   bool is_same_register(LIR_Opr opr) {
 375     return (is_register() && opr->is_register() &&
 376             kind_field() == opr->kind_field() &&
 377             (value() & no_type_mask) == (opr->value() & no_type_mask));
 378   }
 379 
 380   bool is_pointer() const      { return check_value_mask(pointer_mask, pointer_value); }
 381   bool is_illegal() const      { return kind_field() == illegal_value; }
 382   bool is_valid() const        { return kind_field() != illegal_value; }
 383 
 384   bool is_register() const     { return is_cpu_register() || is_fpu_register(); }
 385   bool is_virtual() const      { return is_virtual_cpu()  || is_virtual_fpu();  }
 386 
 387   bool is_constant() const     { return is_pointer() && pointer()->as_constant() != nullptr; }
 388   bool is_address() const      { return is_pointer() && pointer()->as_address() != nullptr; }
 389 
 390   bool is_float_kind() const   { return is_pointer() ? pointer()->is_float_kind() : (kind_field() == fpu_register); }
 391   bool is_oop() const;
 392 
 393   // semantic for fpu- and xmm-registers:
 394   // * is_float and is_double return true for xmm_registers
 395   //   (so is_single_fpu and is_single_xmm are true)
 396   // * So you must always check for is_???_xmm prior to is_???_fpu to
 397   //   distinguish between fpu- and xmm-registers
 398 
 399   bool is_stack() const        { validate_type(); return check_value_mask(kind_mask,                stack_value);                 }
 400   bool is_single_stack() const { validate_type(); return check_value_mask(kind_mask | size_mask,    stack_value  | single_size);  }
 401   bool is_double_stack() const { validate_type(); return check_value_mask(kind_mask | size_mask,    stack_value  | double_size);  }
 402 
 403   bool is_cpu_register() const { validate_type(); return check_value_mask(kind_mask,                cpu_register);                }
 404   bool is_virtual_cpu() const  { validate_type(); return check_value_mask(kind_mask | virtual_mask, cpu_register | virtual_mask); }
 405   bool is_fixed_cpu() const    { validate_type(); return check_value_mask(kind_mask | virtual_mask, cpu_register);                }
 406   bool is_single_cpu() const   { validate_type(); return check_value_mask(kind_mask | size_mask,    cpu_register | single_size);  }
 407   bool is_double_cpu() const   { validate_type(); return check_value_mask(kind_mask | size_mask,    cpu_register | double_size);  }
 408 
 409   bool is_fpu_register() const { validate_type(); return check_value_mask(kind_mask,                fpu_register);                }
 410   bool is_virtual_fpu() const  { validate_type(); return check_value_mask(kind_mask | virtual_mask, fpu_register | virtual_mask); }
 411   bool is_fixed_fpu() const    { validate_type(); return check_value_mask(kind_mask | virtual_mask, fpu_register);                }
 412   bool is_single_fpu() const   { validate_type(); return check_value_mask(kind_mask | size_mask,    fpu_register | single_size);  }
 413   bool is_double_fpu() const   { validate_type(); return check_value_mask(kind_mask | size_mask,    fpu_register | double_size);  }
 414 
 415   bool is_xmm_register() const { validate_type(); return check_value_mask(kind_mask | is_xmm_mask,             fpu_register | is_xmm_mask); }
 416   bool is_single_xmm() const   { validate_type(); return check_value_mask(kind_mask | size_mask | is_xmm_mask, fpu_register | single_size | is_xmm_mask); }
 417   bool is_double_xmm() const   { validate_type(); return check_value_mask(kind_mask | size_mask | is_xmm_mask, fpu_register | double_size | is_xmm_mask); }
 418 
 419   // fast accessor functions for special bits that do not work for pointers
 420   // (in this functions, the check for is_pointer() is omitted)
 421   bool is_single_word() const      { assert(is_register() || is_stack(), "type check"); return check_value_mask(size_mask, single_size); }
 422   bool is_double_word() const      { assert(is_register() || is_stack(), "type check"); return check_value_mask(size_mask, double_size); }
 423   bool is_virtual_register() const { assert(is_register(),               "type check"); return check_value_mask(virtual_mask, virtual_mask); }
 424   bool is_oop_register() const     { assert(is_register() || is_stack(), "type check"); return type_field_valid() == object_type; }
 425   BasicType type_register() const  { assert(is_register() || is_stack(), "type check"); return as_BasicType(type_field_valid());  }
 426 
 427   bool is_last_use() const         { assert(is_register(), "only works for registers"); return (value() & last_use_mask) != 0; }
 428   bool is_fpu_stack_offset() const { assert(is_register(), "only works for registers"); return (value() & is_fpu_stack_offset_mask) != 0; }
 429   LIR_Opr make_last_use()          { assert(is_register(), "only works for registers"); return (LIR_Opr)(value() | last_use_mask); }
 430   LIR_Opr make_fpu_stack_offset()  { assert(is_register(), "only works for registers"); return (LIR_Opr)(value() | is_fpu_stack_offset_mask); }
 431 
 432 
 433   int single_stack_ix() const  { assert(is_single_stack() && !is_virtual(), "type check"); return (int)data(); }
 434   int double_stack_ix() const  { assert(is_double_stack() && !is_virtual(), "type check"); return (int)data(); }
 435   RegNr cpu_regnr() const      { assert(is_single_cpu()   && !is_virtual(), "type check"); return (RegNr)data(); }
 436   RegNr cpu_regnrLo() const    { assert(is_double_cpu()   && !is_virtual(), "type check"); return (RegNr)lo_reg_half(); }
 437   RegNr cpu_regnrHi() const    { assert(is_double_cpu()   && !is_virtual(), "type check"); return (RegNr)hi_reg_half(); }
 438   RegNr fpu_regnr() const      { assert(is_single_fpu()   && !is_virtual(), "type check"); return (RegNr)data(); }
 439   RegNr fpu_regnrLo() const    { assert(is_double_fpu()   && !is_virtual(), "type check"); return (RegNr)lo_reg_half(); }
 440   RegNr fpu_regnrHi() const    { assert(is_double_fpu()   && !is_virtual(), "type check"); return (RegNr)hi_reg_half(); }
 441   RegNr xmm_regnr() const      { assert(is_single_xmm()   && !is_virtual(), "type check"); return (RegNr)data(); }
 442   RegNr xmm_regnrLo() const    { assert(is_double_xmm()   && !is_virtual(), "type check"); return (RegNr)lo_reg_half(); }
 443   RegNr xmm_regnrHi() const    { assert(is_double_xmm()   && !is_virtual(), "type check"); return (RegNr)hi_reg_half(); }
 444   int   vreg_number() const    { assert(is_virtual(),                       "type check"); return (RegNr)data(); }
 445 
 446   LIR_OprPtr* pointer() const { assert(_value != 0 && is_pointer(), "nullness and type check"); return (LIR_OprPtr*)_value; }
 447   LIR_Const* as_constant_ptr() const             { return pointer()->as_constant(); }
 448   LIR_Address* as_address_ptr() const            { return pointer()->as_address(); }
 449 
 450   Register as_register()    const;
 451   Register as_register_lo() const;
 452   Register as_register_hi() const;
 453 
 454   Register as_pointer_register() {
 455 #ifdef _LP64
 456     if (is_double_cpu()) {
 457       assert(as_register_lo() == as_register_hi(), "should be a single register");
 458       return as_register_lo();
 459     }
 460 #endif
 461     return as_register();
 462   }
 463 
 464   FloatRegister as_float_reg   () const;
 465   FloatRegister as_double_reg  () const;
 466 #ifdef X86
 467   XMMRegister as_xmm_float_reg () const;
 468   XMMRegister as_xmm_double_reg() const;
 469   // for compatibility with RInfo
 470   int fpu() const { return lo_reg_half(); }
 471 #endif
 472 
 473   jint      as_jint()    const { return as_constant_ptr()->as_jint(); }
 474   jlong     as_jlong()   const { return as_constant_ptr()->as_jlong(); }
 475   jfloat    as_jfloat()  const { return as_constant_ptr()->as_jfloat(); }
 476   jdouble   as_jdouble() const { return as_constant_ptr()->as_jdouble(); }
 477   jobject   as_jobject() const { return as_constant_ptr()->as_jobject(); }
 478 
 479   void print() const PRODUCT_RETURN;
 480   void print(outputStream* out) const PRODUCT_RETURN;
 481 };
 482 
 483 inline LIR_Opr::OprType as_OprType(BasicType type) {
 484   switch (type) {
 485   case T_INT:      return LIR_Opr::int_type;
 486   case T_LONG:     return LIR_Opr::long_type;
 487   case T_FLOAT:    return LIR_Opr::float_type;
 488   case T_DOUBLE:   return LIR_Opr::double_type;
 489   case T_OBJECT:
 490   case T_ARRAY:    return LIR_Opr::object_type;
 491   case T_ADDRESS:  return LIR_Opr::address_type;
 492   case T_METADATA: return LIR_Opr::metadata_type;
 493   case T_ILLEGAL:  // fall through
 494   default: ShouldNotReachHere(); return LIR_Opr::unknown_type;
 495   }
 496 }
 497 
 498 inline BasicType as_BasicType(LIR_Opr::OprType t) {
 499   switch (t) {
 500   case LIR_Opr::int_type:     return T_INT;
 501   case LIR_Opr::long_type:    return T_LONG;
 502   case LIR_Opr::float_type:   return T_FLOAT;
 503   case LIR_Opr::double_type:  return T_DOUBLE;
 504   case LIR_Opr::object_type:  return T_OBJECT;
 505   case LIR_Opr::address_type: return T_ADDRESS;
 506   case LIR_Opr::metadata_type:return T_METADATA;
 507   case LIR_Opr::unknown_type: // fall through
 508   default: ShouldNotReachHere();  return T_ILLEGAL;
 509   }
 510 }
 511 
 512 
 513 // LIR_Address
 514 class LIR_Address: public LIR_OprPtr {
 515  friend class LIR_OpVisitState;
 516 
 517  public:
 518   // NOTE: currently these must be the log2 of the scale factor (and
 519   // must also be equivalent to the ScaleFactor enum in
 520   // assembler_i486.hpp)
 521   enum Scale {
 522     times_1  =  0,
 523     times_2  =  1,
 524     times_4  =  2,
 525     times_8  =  3
 526   };
 527 
 528  private:
 529   LIR_Opr   _base;
 530   LIR_Opr   _index;
 531   Scale     _scale;
 532   intx      _disp;
 533   BasicType _type;
 534 
 535  public:
 536   LIR_Address(LIR_Opr base, LIR_Opr index, BasicType type):
 537        _base(base)
 538      , _index(index)
 539      , _scale(times_1)
 540      , _disp(0)
 541      , _type(type) { verify(); }
 542 
 543   LIR_Address(LIR_Opr base, intx disp, BasicType type):
 544        _base(base)
 545      , _index(LIR_Opr::illegalOpr())
 546      , _scale(times_1)
 547      , _disp(disp)
 548      , _type(type) { verify(); }
 549 
 550   LIR_Address(LIR_Opr base, BasicType type):
 551        _base(base)
 552      , _index(LIR_Opr::illegalOpr())
 553      , _scale(times_1)
 554      , _disp(0)
 555      , _type(type) { verify(); }
 556 
 557   LIR_Address(LIR_Opr base, LIR_Opr index, intx disp, BasicType type):
 558        _base(base)
 559      , _index(index)
 560      , _scale(times_1)
 561      , _disp(disp)
 562      , _type(type) { verify(); }
 563 
 564   LIR_Address(LIR_Opr base, LIR_Opr index, Scale scale, intx disp, BasicType type):
 565        _base(base)
 566      , _index(index)
 567      , _scale(scale)
 568      , _disp(disp)
 569      , _type(type) { verify(); }
 570 
 571   LIR_Opr base()  const                          { return _base;  }
 572   LIR_Opr index() const                          { return _index; }
 573   Scale   scale() const                          { return _scale; }
 574   intx    disp()  const                          { return _disp;  }
 575 
 576   bool equals(LIR_Address* other) const          { return base() == other->base() && index() == other->index() && disp() == other->disp() && scale() == other->scale(); }
 577 
 578   virtual LIR_Address* as_address()              { return this;   }
 579   virtual BasicType type() const                 { return _type; }
 580   virtual void print_value_on(outputStream* out) const PRODUCT_RETURN;
 581 
 582   void verify() const PRODUCT_RETURN;
 583 
 584   static Scale scale(BasicType type);
 585 };
 586 
 587 
 588 // operand factory
 589 class LIR_OprFact: public AllStatic {
 590  public:
 591 
 592   static LIR_Opr illegalOpr;
 593   static LIR_Opr nullOpr;
 594 
 595   static LIR_Opr single_cpu(int reg) {
 596     return (LIR_Opr)(intptr_t)((reg  << LIR_Opr::reg1_shift) |
 597                                LIR_Opr::int_type             |
 598                                LIR_Opr::cpu_register         |
 599                                LIR_Opr::single_size);
 600   }
 601   static LIR_Opr single_cpu_oop(int reg) {
 602     return (LIR_Opr)(intptr_t)((reg  << LIR_Opr::reg1_shift) |
 603                                LIR_Opr::object_type          |
 604                                LIR_Opr::cpu_register         |
 605                                LIR_Opr::single_size);
 606   }
 607   static LIR_Opr single_cpu_address(int reg) {
 608     return (LIR_Opr)(intptr_t)((reg  << LIR_Opr::reg1_shift) |
 609                                LIR_Opr::address_type         |
 610                                LIR_Opr::cpu_register         |
 611                                LIR_Opr::single_size);
 612   }
 613   static LIR_Opr single_cpu_metadata(int reg) {
 614     return (LIR_Opr)(intptr_t)((reg  << LIR_Opr::reg1_shift) |
 615                                LIR_Opr::metadata_type        |
 616                                LIR_Opr::cpu_register         |
 617                                LIR_Opr::single_size);
 618   }
 619   static LIR_Opr double_cpu(int reg1, int reg2) {
 620     LP64_ONLY(assert(reg1 == reg2, "must be identical"));
 621     return (LIR_Opr)(intptr_t)((reg1 << LIR_Opr::reg1_shift) |
 622                                (reg2 << LIR_Opr::reg2_shift) |
 623                                LIR_Opr::long_type            |
 624                                LIR_Opr::cpu_register         |
 625                                LIR_Opr::double_size);
 626   }
 627 
 628   static LIR_Opr single_fpu(int reg) {
 629     return (LIR_Opr)(intptr_t)((reg  << LIR_Opr::reg1_shift) |
 630                                LIR_Opr::float_type           |
 631                                LIR_Opr::fpu_register         |
 632                                LIR_Opr::single_size);
 633   }
 634 
 635   // Platform dependent.
 636   static LIR_Opr double_fpu(int reg1, int reg2 = -1 /*fnoreg*/);
 637 
 638 #ifdef ARM32
 639   static LIR_Opr single_softfp(int reg) {
 640     return (LIR_Opr)(intptr_t)((reg  << LIR_Opr::reg1_shift) |
 641                                LIR_Opr::float_type           |
 642                                LIR_Opr::cpu_register         |
 643                                LIR_Opr::single_size);
 644   }
 645   static LIR_Opr double_softfp(int reg1, int reg2) {
 646     return (LIR_Opr)(intptr_t)((reg1 << LIR_Opr::reg1_shift) |
 647                                (reg2 << LIR_Opr::reg2_shift) |
 648                                LIR_Opr::double_type          |
 649                                LIR_Opr::cpu_register         |
 650                                LIR_Opr::double_size);
 651   }
 652 #endif // ARM32
 653 
 654 #if defined(X86)
 655   static LIR_Opr single_xmm(int reg) {
 656     return (LIR_Opr)(intptr_t)((reg << LIR_Opr::reg1_shift) |
 657                                LIR_Opr::float_type          |
 658                                LIR_Opr::fpu_register        |
 659                                LIR_Opr::single_size         |
 660                                LIR_Opr::is_xmm_mask);
 661   }
 662   static LIR_Opr double_xmm(int reg) {
 663     return (LIR_Opr)(intptr_t)((reg << LIR_Opr::reg1_shift) |
 664                                (reg << LIR_Opr::reg2_shift) |
 665                                LIR_Opr::double_type         |
 666                                LIR_Opr::fpu_register        |
 667                                LIR_Opr::double_size         |
 668                                LIR_Opr::is_xmm_mask);
 669   }
 670 #endif // X86
 671 
 672   static LIR_Opr virtual_register(int index, BasicType type) {
 673     if (index > LIR_Opr::vreg_max) {
 674       // Running out of virtual registers. Caller should bailout.
 675       return illegalOpr;
 676     }
 677 
 678     LIR_Opr res;
 679     switch (type) {
 680       case T_OBJECT: // fall through
 681       case T_ARRAY:
 682         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift)  |
 683                                             LIR_Opr::object_type  |
 684                                             LIR_Opr::cpu_register |
 685                                             LIR_Opr::single_size  |
 686                                             LIR_Opr::virtual_mask);
 687         break;
 688 
 689       case T_METADATA:
 690         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift)  |
 691                                             LIR_Opr::metadata_type|
 692                                             LIR_Opr::cpu_register |
 693                                             LIR_Opr::single_size  |
 694                                             LIR_Opr::virtual_mask);
 695         break;
 696 
 697       case T_INT:
 698         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 699                                   LIR_Opr::int_type              |
 700                                   LIR_Opr::cpu_register          |
 701                                   LIR_Opr::single_size           |
 702                                   LIR_Opr::virtual_mask);
 703         break;
 704 
 705       case T_ADDRESS:
 706         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 707                                   LIR_Opr::address_type          |
 708                                   LIR_Opr::cpu_register          |
 709                                   LIR_Opr::single_size           |
 710                                   LIR_Opr::virtual_mask);
 711         break;
 712 
 713       case T_LONG:
 714         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 715                                   LIR_Opr::long_type             |
 716                                   LIR_Opr::cpu_register          |
 717                                   LIR_Opr::double_size           |
 718                                   LIR_Opr::virtual_mask);
 719         break;
 720 
 721 #ifdef __SOFTFP__
 722       case T_FLOAT:
 723         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 724                                   LIR_Opr::float_type  |
 725                                   LIR_Opr::cpu_register |
 726                                   LIR_Opr::single_size |
 727                                   LIR_Opr::virtual_mask);
 728         break;
 729       case T_DOUBLE:
 730         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 731                                   LIR_Opr::double_type |
 732                                   LIR_Opr::cpu_register |
 733                                   LIR_Opr::double_size |
 734                                   LIR_Opr::virtual_mask);
 735         break;
 736 #else // __SOFTFP__
 737       case T_FLOAT:
 738         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 739                                   LIR_Opr::float_type           |
 740                                   LIR_Opr::fpu_register         |
 741                                   LIR_Opr::single_size          |
 742                                   LIR_Opr::virtual_mask);
 743         break;
 744 
 745       case
 746         T_DOUBLE: res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 747                                             LIR_Opr::double_type           |
 748                                             LIR_Opr::fpu_register          |
 749                                             LIR_Opr::double_size           |
 750                                             LIR_Opr::virtual_mask);
 751         break;
 752 #endif // __SOFTFP__
 753       default:       ShouldNotReachHere(); res = illegalOpr;
 754     }
 755 
 756 #ifdef ASSERT
 757     res->validate_type();
 758     assert(res->vreg_number() == index, "conversion check");
 759     assert(index >= LIR_Opr::vreg_base, "must start at vreg_base");
 760 
 761     // old-style calculation; check if old and new method are equal
 762     LIR_Opr::OprType t = as_OprType(type);
 763 #ifdef __SOFTFP__
 764     LIR_Opr old_res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 765                                t |
 766                                LIR_Opr::cpu_register |
 767                                LIR_Opr::size_for(type) | LIR_Opr::virtual_mask);
 768 #else // __SOFTFP__
 769     LIR_Opr old_res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) | t |
 770                                           ((type == T_FLOAT || type == T_DOUBLE) ?  LIR_Opr::fpu_register : LIR_Opr::cpu_register) |
 771                                LIR_Opr::size_for(type) | LIR_Opr::virtual_mask);
 772     assert(res == old_res, "old and new method not equal");
 773 #endif // __SOFTFP__
 774 #endif // ASSERT
 775 
 776     return res;
 777   }
 778 
 779   // 'index' is computed by FrameMap::local_stack_pos(index); do not use other parameters as
 780   // the index is platform independent; a double stack using indices 2 and 3 has always
 781   // index 2.
 782   static LIR_Opr stack(int index, BasicType type) {
 783     LIR_Opr res;
 784     switch (type) {
 785       case T_OBJECT: // fall through
 786       case T_ARRAY:
 787         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 788                                   LIR_Opr::object_type           |
 789                                   LIR_Opr::stack_value           |
 790                                   LIR_Opr::single_size);
 791         break;
 792 
 793       case T_METADATA:
 794         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 795                                   LIR_Opr::metadata_type         |
 796                                   LIR_Opr::stack_value           |
 797                                   LIR_Opr::single_size);
 798         break;
 799       case T_INT:
 800         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 801                                   LIR_Opr::int_type              |
 802                                   LIR_Opr::stack_value           |
 803                                   LIR_Opr::single_size);
 804         break;
 805 
 806       case T_ADDRESS:
 807         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 808                                   LIR_Opr::address_type          |
 809                                   LIR_Opr::stack_value           |
 810                                   LIR_Opr::single_size);
 811         break;
 812 
 813       case T_LONG:
 814         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 815                                   LIR_Opr::long_type             |
 816                                   LIR_Opr::stack_value           |
 817                                   LIR_Opr::double_size);
 818         break;
 819 
 820       case T_FLOAT:
 821         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 822                                   LIR_Opr::float_type            |
 823                                   LIR_Opr::stack_value           |
 824                                   LIR_Opr::single_size);
 825         break;
 826       case T_DOUBLE:
 827         res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 828                                   LIR_Opr::double_type           |
 829                                   LIR_Opr::stack_value           |
 830                                   LIR_Opr::double_size);
 831         break;
 832 
 833       default:       ShouldNotReachHere(); res = illegalOpr;
 834     }
 835 
 836 #ifdef ASSERT
 837     assert(index >= 0, "index must be positive");
 838     assert(index == (int)res->data(), "conversion check");
 839 
 840     LIR_Opr old_res = (LIR_Opr)(intptr_t)((index << LIR_Opr::data_shift) |
 841                                           LIR_Opr::stack_value           |
 842                                           as_OprType(type)                   |
 843                                           LIR_Opr::size_for(type));
 844     assert(res == old_res, "old and new method not equal");
 845 #endif
 846 
 847     return res;
 848   }
 849 
 850   static LIR_Opr intConst(jint i)                { return (LIR_Opr)(new LIR_Const(i)); }
 851   static LIR_Opr longConst(jlong l)              { return (LIR_Opr)(new LIR_Const(l)); }
 852   static LIR_Opr floatConst(jfloat f)            { return (LIR_Opr)(new LIR_Const(f)); }
 853   static LIR_Opr doubleConst(jdouble d)          { return (LIR_Opr)(new LIR_Const(d)); }
 854   static LIR_Opr oopConst(jobject o)             { return (LIR_Opr)(new LIR_Const(o)); }
 855   static LIR_Opr address(LIR_Address* a)         { return (LIR_Opr)a; }
 856   static LIR_Opr intptrConst(void* p)            { return (LIR_Opr)(new LIR_Const(p)); }
 857   static LIR_Opr intptrConst(intptr_t v)         { return (LIR_Opr)(new LIR_Const((void*)v)); }
 858   static LIR_Opr illegal()                       { return (LIR_Opr)-1; }
 859   static LIR_Opr addressConst(jint i)            { return (LIR_Opr)(new LIR_Const(i, true)); }
 860   static LIR_Opr metadataConst(Metadata* m)      { return (LIR_Opr)(new LIR_Const(m)); }
 861 
 862   static LIR_Opr value_type(ValueType* type);
 863 };
 864 
 865 
 866 //-------------------------------------------------------------------------------
 867 //                   LIR Instructions
 868 //-------------------------------------------------------------------------------
 869 //
 870 // Note:
 871 //  - every instruction has a result operand
 872 //  - every instruction has an CodeEmitInfo operand (can be revisited later)
 873 //  - every instruction has a LIR_OpCode operand
 874 //  - LIR_OpN, means an instruction that has N input operands
 875 //
 876 // class hierarchy:
 877 //
 878 class  LIR_Op;
 879 class    LIR_Op0;
 880 class      LIR_OpLabel;
 881 class    LIR_Op1;
 882 class      LIR_OpBranch;
 883 class      LIR_OpConvert;
 884 class      LIR_OpAllocObj;
 885 class      LIR_OpReturn;
 886 class      LIR_OpRoundFP;
 887 class    LIR_Op2;
 888 class    LIR_OpDelay;
 889 class    LIR_Op3;
 890 class      LIR_OpAllocArray;
 891 class    LIR_Op4;
 892 class    LIR_OpCall;
 893 class      LIR_OpJavaCall;
 894 class      LIR_OpRTCall;
 895 class    LIR_OpArrayCopy;
 896 class    LIR_OpUpdateCRC32;
 897 class    LIR_OpLock;
 898 class    LIR_OpTypeCheck;
 899 class    LIR_OpFlattenedArrayCheck;
 900 class    LIR_OpNullFreeArrayCheck;
 901 class    LIR_OpSubstitutabilityCheck;
 902 class    LIR_OpCompareAndSwap;
 903 class    LIR_OpLoadKlass;
 904 class    LIR_OpProfileCall;
 905 class    LIR_OpProfileType;
 906 class    LIR_OpProfileInlineType;
 907 #ifdef ASSERT
 908 class    LIR_OpAssert;
 909 #endif
 910 
 911 // LIR operation codes
 912 enum LIR_Code {
 913     lir_none
 914   , begin_op0
 915       , lir_label
 916       , lir_nop
 917       , lir_std_entry
 918       , lir_osr_entry
 919       , lir_fpop_raw
 920       , lir_breakpoint
 921       , lir_rtcall
 922       , lir_membar
 923       , lir_membar_acquire
 924       , lir_membar_release
 925       , lir_membar_loadload
 926       , lir_membar_storestore
 927       , lir_membar_loadstore
 928       , lir_membar_storeload
 929       , lir_get_thread
 930       , lir_on_spin_wait
 931       , lir_check_orig_pc
 932   , end_op0
 933   , begin_op1
 934       , lir_fxch
 935       , lir_fld
 936       , lir_push
 937       , lir_pop
 938       , lir_null_check
 939       , lir_return
 940       , lir_leal
 941       , lir_move
 942       , lir_convert
 943       , lir_alloc_object
 944       , lir_monaddr
 945       , lir_roundfp
 946       , lir_safepoint
 947       , lir_unwind
 948       , lir_load_klass
 949   , end_op1
 950   , begin_op2
 951       , lir_branch
 952       , lir_cond_float_branch
 953       , lir_cmp
 954       , lir_cmp_l2i
 955       , lir_ucmp_fd2i
 956       , lir_cmp_fd2i
 957       , lir_add
 958       , lir_sub
 959       , lir_mul
 960       , lir_div
 961       , lir_rem
 962       , lir_sqrt
 963       , lir_abs
 964       , lir_neg
 965       , lir_tan
 966       , lir_f2hf
 967       , lir_hf2f
 968       , lir_log10
 969       , lir_logic_and
 970       , lir_logic_or
 971       , lir_logic_xor
 972       , lir_shl
 973       , lir_shr
 974       , lir_ushr
 975       , lir_alloc_array
 976       , lir_throw
 977       , lir_xadd
 978       , lir_xchg
 979   , end_op2
 980   , begin_op3
 981       , lir_idiv
 982       , lir_irem
 983       , lir_fmad
 984       , lir_fmaf
 985   , end_op3
 986   , begin_op4
 987       , lir_cmove
 988   , end_op4
 989   , begin_opJavaCall
 990       , lir_static_call
 991       , lir_optvirtual_call
 992       , lir_icvirtual_call
 993       , lir_dynamic_call
 994   , end_opJavaCall
 995   , begin_opArrayCopy
 996       , lir_arraycopy
 997   , end_opArrayCopy
 998   , begin_opUpdateCRC32
 999       , lir_updatecrc32
1000   , end_opUpdateCRC32
1001   , begin_opLock
1002     , lir_lock
1003     , lir_unlock
1004   , end_opLock
1005   , begin_delay_slot
1006     , lir_delay_slot
1007   , end_delay_slot
1008   , begin_opTypeCheck
1009     , lir_instanceof
1010     , lir_checkcast
1011     , lir_store_check
1012   , end_opTypeCheck
1013   , begin_opFlattenedArrayCheck
1014     , lir_flat_array_check
1015   , end_opFlattenedArrayCheck
1016   , begin_opNullFreeArrayCheck
1017     , lir_null_free_array_check
1018   , end_opNullFreeArrayCheck
1019   , begin_opSubstitutabilityCheck
1020     , lir_substitutability_check
1021   , end_opSubstitutabilityCheck
1022   , begin_opCompareAndSwap
1023     , lir_cas_long
1024     , lir_cas_obj
1025     , lir_cas_int
1026   , end_opCompareAndSwap
1027   , begin_opMDOProfile
1028     , lir_profile_call
1029     , lir_profile_type
1030     , lir_profile_inline_type
1031   , end_opMDOProfile
1032   , begin_opAssert
1033     , lir_assert
1034   , end_opAssert
1035 #ifdef INCLUDE_ZGC
1036   , begin_opXLoadBarrierTest
1037     , lir_xloadbarrier_test
1038   , end_opXLoadBarrierTest
1039 #endif
1040 };
1041 
1042 
1043 enum LIR_Condition {
1044     lir_cond_equal
1045   , lir_cond_notEqual
1046   , lir_cond_less
1047   , lir_cond_lessEqual
1048   , lir_cond_greaterEqual
1049   , lir_cond_greater
1050   , lir_cond_belowEqual
1051   , lir_cond_aboveEqual
1052   , lir_cond_always
1053   , lir_cond_unknown = -1
1054 };
1055 
1056 
1057 enum LIR_PatchCode {
1058   lir_patch_none,
1059   lir_patch_low,
1060   lir_patch_high,
1061   lir_patch_normal
1062 };
1063 
1064 
1065 enum LIR_MoveKind {
1066   lir_move_normal,
1067   lir_move_volatile,
1068   lir_move_wide,
1069   lir_move_max_flag
1070 };
1071 
1072 
1073 // --------------------------------------------------
1074 // LIR_Op
1075 // --------------------------------------------------
1076 class LIR_Op: public CompilationResourceObj {
1077  friend class LIR_OpVisitState;
1078 
1079 #ifdef ASSERT
1080  private:
1081   const char *  _file;
1082   int           _line;
1083 #endif
1084 
1085  protected:
1086   LIR_Opr       _result;
1087   unsigned short _code;
1088   unsigned short _flags;
1089   CodeEmitInfo* _info;
1090   int           _id;     // value id for register allocation
1091   int           _fpu_pop_count;
1092   Instruction*  _source; // for debugging
1093 
1094   static void print_condition(outputStream* out, LIR_Condition cond) PRODUCT_RETURN;
1095 
1096  protected:
1097   static bool is_in_range(LIR_Code test, LIR_Code start, LIR_Code end)  { return start < test && test < end; }
1098 
1099  public:
1100   LIR_Op()
1101     :
1102 #ifdef ASSERT
1103       _file(nullptr)
1104     , _line(0),
1105 #endif
1106       _result(LIR_OprFact::illegalOpr)
1107     , _code(lir_none)
1108     , _flags(0)
1109     , _info(nullptr)
1110     , _id(-1)
1111     , _fpu_pop_count(0)
1112     , _source(nullptr) {}
1113 
1114   LIR_Op(LIR_Code code, LIR_Opr result, CodeEmitInfo* info)
1115     :
1116 #ifdef ASSERT
1117       _file(nullptr)
1118     , _line(0),
1119 #endif
1120       _result(result)
1121     , _code(code)
1122     , _flags(0)
1123     , _info(info)
1124     , _id(-1)
1125     , _fpu_pop_count(0)
1126     , _source(nullptr) {}
1127 
1128   CodeEmitInfo* info() const                  { return _info;   }
1129   LIR_Code code()      const                  { return (LIR_Code)_code;   }
1130   LIR_Opr result_opr() const                  { return _result; }
1131   void    set_result_opr(LIR_Opr opr)         { _result = opr;  }
1132 
1133 #ifdef ASSERT
1134   void set_file_and_line(const char * file, int line) {
1135     _file = file;
1136     _line = line;
1137   }
1138 #endif
1139 
1140   virtual const char * name() const PRODUCT_RETURN0;
1141   virtual void visit(LIR_OpVisitState* state);
1142 
1143   int id()             const                  { return _id;     }
1144   void set_id(int id)                         { _id = id; }
1145 
1146   // FPU stack simulation helpers -- only used on Intel
1147   void set_fpu_pop_count(int count)           { assert(count >= 0 && count <= 1, "currently only 0 and 1 are valid"); _fpu_pop_count = count; }
1148   int  fpu_pop_count() const                  { return _fpu_pop_count; }
1149   bool pop_fpu_stack()                        { return _fpu_pop_count > 0; }
1150 
1151   Instruction* source() const                 { return _source; }
1152   void set_source(Instruction* ins)           { _source = ins; }
1153 
1154   virtual void emit_code(LIR_Assembler* masm) = 0;
1155   virtual void print_instr(outputStream* out) const   = 0;
1156   virtual void print_on(outputStream* st) const PRODUCT_RETURN;
1157 
1158   virtual bool is_patching() { return false; }
1159   virtual LIR_OpCall* as_OpCall() { return nullptr; }
1160   virtual LIR_OpJavaCall* as_OpJavaCall() { return nullptr; }
1161   virtual LIR_OpLabel* as_OpLabel() { return nullptr; }
1162   virtual LIR_OpDelay* as_OpDelay() { return nullptr; }
1163   virtual LIR_OpLock* as_OpLock() { return nullptr; }
1164   virtual LIR_OpAllocArray* as_OpAllocArray() { return nullptr; }
1165   virtual LIR_OpAllocObj* as_OpAllocObj() { return nullptr; }
1166   virtual LIR_OpRoundFP* as_OpRoundFP() { return nullptr; }
1167   virtual LIR_OpBranch* as_OpBranch() { return nullptr; }
1168   virtual LIR_OpReturn* as_OpReturn() { return nullptr; }
1169   virtual LIR_OpRTCall* as_OpRTCall() { return nullptr; }
1170   virtual LIR_OpConvert* as_OpConvert() { return nullptr; }
1171   virtual LIR_Op0* as_Op0() { return nullptr; }
1172   virtual LIR_Op1* as_Op1() { return nullptr; }
1173   virtual LIR_Op2* as_Op2() { return nullptr; }
1174   virtual LIR_Op3* as_Op3() { return nullptr; }
1175   virtual LIR_Op4* as_Op4() { return nullptr; }
1176   virtual LIR_OpArrayCopy* as_OpArrayCopy() { return nullptr; }
1177   virtual LIR_OpUpdateCRC32* as_OpUpdateCRC32() { return nullptr; }
1178   virtual LIR_OpTypeCheck* as_OpTypeCheck() { return nullptr; }
1179   virtual LIR_OpFlattenedArrayCheck* as_OpFlattenedArrayCheck() { return nullptr; }
1180   virtual LIR_OpNullFreeArrayCheck* as_OpNullFreeArrayCheck() { return nullptr; }
1181   virtual LIR_OpSubstitutabilityCheck* as_OpSubstitutabilityCheck() { return nullptr; }
1182   virtual LIR_OpCompareAndSwap* as_OpCompareAndSwap() { return nullptr; }
1183   virtual LIR_OpLoadKlass* as_OpLoadKlass() { return nullptr; }
1184   virtual LIR_OpProfileCall* as_OpProfileCall() { return nullptr; }
1185   virtual LIR_OpProfileType* as_OpProfileType() { return nullptr; }
1186   virtual LIR_OpProfileInlineType* as_OpProfileInlineType() { return nullptr; }
1187 #ifdef ASSERT
1188   virtual LIR_OpAssert* as_OpAssert() { return nullptr; }
1189 #endif
1190 
1191   virtual void verify() const {}
1192 };
1193 
1194 // for calls
1195 class LIR_OpCall: public LIR_Op {
1196  friend class LIR_OpVisitState;
1197 
1198  protected:
1199   address      _addr;
1200   LIR_OprList* _arguments;
1201  protected:
1202   LIR_OpCall(LIR_Code code, address addr, LIR_Opr result,
1203              LIR_OprList* arguments, CodeEmitInfo* info = nullptr)
1204     : LIR_Op(code, result, info)
1205     , _addr(addr)
1206     , _arguments(arguments) {}
1207 
1208  public:
1209   address addr() const                           { return _addr; }
1210   const LIR_OprList* arguments() const           { return _arguments; }
1211   virtual LIR_OpCall* as_OpCall()                { return this; }
1212 };
1213 
1214 
1215 // --------------------------------------------------
1216 // LIR_OpJavaCall
1217 // --------------------------------------------------
1218 class LIR_OpJavaCall: public LIR_OpCall {
1219  friend class LIR_OpVisitState;
1220 
1221  private:
1222   ciMethod* _method;
1223   LIR_Opr   _receiver;
1224   LIR_Opr   _method_handle_invoke_SP_save_opr;  // Used in LIR_OpVisitState::visit to store the reference to FrameMap::method_handle_invoke_SP_save_opr.
1225 
1226  public:
1227   LIR_OpJavaCall(LIR_Code code, ciMethod* method,
1228                  LIR_Opr receiver, LIR_Opr result,
1229                  address addr, LIR_OprList* arguments,
1230                  CodeEmitInfo* info)
1231   : LIR_OpCall(code, addr, result, arguments, info)
1232   , _method(method)
1233   , _receiver(receiver)
1234   , _method_handle_invoke_SP_save_opr(LIR_OprFact::illegalOpr)
1235   { assert(is_in_range(code, begin_opJavaCall, end_opJavaCall), "code check"); }
1236 
1237   LIR_OpJavaCall(LIR_Code code, ciMethod* method,
1238                  LIR_Opr receiver, LIR_Opr result, intptr_t vtable_offset,
1239                  LIR_OprList* arguments, CodeEmitInfo* info)
1240   : LIR_OpCall(code, (address)vtable_offset, result, arguments, info)
1241   , _method(method)
1242   , _receiver(receiver)
1243   , _method_handle_invoke_SP_save_opr(LIR_OprFact::illegalOpr)
1244   { assert(is_in_range(code, begin_opJavaCall, end_opJavaCall), "code check"); }
1245 
1246   LIR_Opr receiver() const                       { return _receiver; }
1247   ciMethod* method() const                       { return _method;   }
1248 
1249   // JSR 292 support.
1250   bool is_invokedynamic() const                  { return code() == lir_dynamic_call; }
1251   bool is_method_handle_invoke() const {
1252     return method()->is_compiled_lambda_form() ||   // Java-generated lambda form
1253            method()->is_method_handle_intrinsic();  // JVM-generated MH intrinsic
1254   }
1255 
1256   virtual void emit_code(LIR_Assembler* masm);
1257   virtual LIR_OpJavaCall* as_OpJavaCall() { return this; }
1258   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1259 
1260   bool maybe_return_as_fields(ciInlineKlass** vk = nullptr) const;
1261 };
1262 
1263 // --------------------------------------------------
1264 // LIR_OpLabel
1265 // --------------------------------------------------
1266 // Location where a branch can continue
1267 class LIR_OpLabel: public LIR_Op {
1268  friend class LIR_OpVisitState;
1269 
1270  private:
1271   Label* _label;
1272  public:
1273   LIR_OpLabel(Label* lbl)
1274    : LIR_Op(lir_label, LIR_OprFact::illegalOpr, nullptr)
1275    , _label(lbl)                                 {}
1276   Label* label() const                           { return _label; }
1277 
1278   virtual void emit_code(LIR_Assembler* masm);
1279   virtual LIR_OpLabel* as_OpLabel() { return this; }
1280   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1281 };
1282 
1283 // LIR_OpArrayCopy
1284 class LIR_OpArrayCopy: public LIR_Op {
1285  friend class LIR_OpVisitState;
1286 
1287  private:
1288   ArrayCopyStub*  _stub;
1289   LIR_Opr   _src;
1290   LIR_Opr   _src_pos;
1291   LIR_Opr   _dst;
1292   LIR_Opr   _dst_pos;
1293   LIR_Opr   _length;
1294   LIR_Opr   _tmp;
1295   ciArrayKlass* _expected_type;
1296   int       _flags;
1297 
1298 public:
1299   enum Flags {
1300     src_null_check         = 1 << 0,
1301     dst_null_check         = 1 << 1,
1302     src_pos_positive_check = 1 << 2,
1303     dst_pos_positive_check = 1 << 3,
1304     length_positive_check  = 1 << 4,
1305     src_range_check        = 1 << 5,
1306     dst_range_check        = 1 << 6,
1307     type_check             = 1 << 7,
1308     overlapping            = 1 << 8,
1309     unaligned              = 1 << 9,
1310     src_objarray           = 1 << 10,
1311     dst_objarray           = 1 << 11,
1312     always_slow_path       = 1 << 12,
1313     src_inlinetype_check   = 1 << 13,
1314     dst_inlinetype_check   = 1 << 14,
1315     all_flags              = (1 << 15) - 1
1316   };
1317 
1318   LIR_OpArrayCopy(LIR_Opr src, LIR_Opr src_pos, LIR_Opr dst, LIR_Opr dst_pos, LIR_Opr length, LIR_Opr tmp,
1319                   ciArrayKlass* expected_type, int flags, CodeEmitInfo* info);
1320 
1321   LIR_Opr src() const                            { return _src; }
1322   LIR_Opr src_pos() const                        { return _src_pos; }
1323   LIR_Opr dst() const                            { return _dst; }
1324   LIR_Opr dst_pos() const                        { return _dst_pos; }
1325   LIR_Opr length() const                         { return _length; }
1326   LIR_Opr tmp() const                            { return _tmp; }
1327   int flags() const                              { return _flags; }
1328   ciArrayKlass* expected_type() const            { return _expected_type; }
1329   ArrayCopyStub* stub() const                    { return _stub; }
1330 
1331   virtual void emit_code(LIR_Assembler* masm);
1332   virtual LIR_OpArrayCopy* as_OpArrayCopy() { return this; }
1333   void print_instr(outputStream* out) const PRODUCT_RETURN;
1334 };
1335 
1336 // LIR_OpUpdateCRC32
1337 class LIR_OpUpdateCRC32: public LIR_Op {
1338   friend class LIR_OpVisitState;
1339 
1340 private:
1341   LIR_Opr   _crc;
1342   LIR_Opr   _val;
1343 
1344 public:
1345 
1346   LIR_OpUpdateCRC32(LIR_Opr crc, LIR_Opr val, LIR_Opr res);
1347 
1348   LIR_Opr crc() const                            { return _crc; }
1349   LIR_Opr val() const                            { return _val; }
1350 
1351   virtual void emit_code(LIR_Assembler* masm);
1352   virtual LIR_OpUpdateCRC32* as_OpUpdateCRC32()  { return this; }
1353   void print_instr(outputStream* out) const PRODUCT_RETURN;
1354 };
1355 
1356 // --------------------------------------------------
1357 // LIR_Op0
1358 // --------------------------------------------------
1359 class LIR_Op0: public LIR_Op {
1360  friend class LIR_OpVisitState;
1361 
1362  public:
1363   LIR_Op0(LIR_Code code)
1364    : LIR_Op(code, LIR_OprFact::illegalOpr, nullptr)  { assert(is_in_range(code, begin_op0, end_op0), "code check"); }
1365   LIR_Op0(LIR_Code code, LIR_Opr result, CodeEmitInfo* info = nullptr)
1366    : LIR_Op(code, result, info)  { assert(is_in_range(code, begin_op0, end_op0), "code check"); }
1367 
1368   virtual void emit_code(LIR_Assembler* masm);
1369   virtual LIR_Op0* as_Op0() { return this; }
1370   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1371 };
1372 
1373 
1374 // --------------------------------------------------
1375 // LIR_Op1
1376 // --------------------------------------------------
1377 
1378 class LIR_Op1: public LIR_Op {
1379  friend class LIR_OpVisitState;
1380 
1381  protected:
1382   LIR_Opr         _opr;   // input operand
1383   BasicType       _type;  // Operand types
1384   LIR_PatchCode   _patch; // only required with patchin (NEEDS_CLEANUP: do we want a special instruction for patching?)
1385 
1386   static void print_patch_code(outputStream* out, LIR_PatchCode code);
1387 
1388   void set_kind(LIR_MoveKind kind) {
1389     assert(code() == lir_move, "must be");
1390     _flags = kind;
1391   }
1392 
1393  public:
1394   LIR_Op1(LIR_Code code, LIR_Opr opr, LIR_Opr result = LIR_OprFact::illegalOpr, BasicType type = T_ILLEGAL, LIR_PatchCode patch = lir_patch_none, CodeEmitInfo* info = nullptr)
1395     : LIR_Op(code, result, info)
1396     , _opr(opr)
1397     , _type(type)
1398     , _patch(patch)                    { assert(is_in_range(code, begin_op1, end_op1), "code check"); }
1399 
1400   LIR_Op1(LIR_Code code, LIR_Opr opr, LIR_Opr result, BasicType type, LIR_PatchCode patch, CodeEmitInfo* info, LIR_MoveKind kind)
1401     : LIR_Op(code, result, info)
1402     , _opr(opr)
1403     , _type(type)
1404     , _patch(patch)                    {
1405     assert(code == lir_move, "must be");
1406     set_kind(kind);
1407   }
1408 
1409   LIR_Op1(LIR_Code code, LIR_Opr opr, CodeEmitInfo* info)
1410     : LIR_Op(code, LIR_OprFact::illegalOpr, info)
1411     , _opr(opr)
1412     , _type(T_ILLEGAL)
1413     , _patch(lir_patch_none)           { assert(is_in_range(code, begin_op1, end_op1), "code check"); }
1414 
1415   LIR_Opr in_opr()           const               { return _opr;   }
1416   LIR_PatchCode patch_code() const               { return _patch; }
1417   BasicType type()           const               { return _type;  }
1418 
1419   LIR_MoveKind move_kind() const {
1420     assert(code() == lir_move, "must be");
1421     return (LIR_MoveKind)_flags;
1422   }
1423 
1424   virtual bool is_patching() { return _patch != lir_patch_none; }
1425   virtual void emit_code(LIR_Assembler* masm);
1426   virtual LIR_Op1* as_Op1() { return this; }
1427   virtual const char * name() const PRODUCT_RETURN0;
1428 
1429   void set_in_opr(LIR_Opr opr) { _opr = opr; }
1430 
1431   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1432   virtual void verify() const;
1433 };
1434 
1435 
1436 // for runtime calls
1437 class LIR_OpRTCall: public LIR_OpCall {
1438  friend class LIR_OpVisitState;
1439 
1440  private:
1441   LIR_Opr _tmp;
1442  public:
1443   LIR_OpRTCall(address addr, LIR_Opr tmp,
1444                LIR_Opr result, LIR_OprList* arguments, CodeEmitInfo* info = nullptr)
1445     : LIR_OpCall(lir_rtcall, addr, result, arguments, info)
1446     , _tmp(tmp) {}
1447 
1448   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1449   virtual void emit_code(LIR_Assembler* masm);
1450   virtual LIR_OpRTCall* as_OpRTCall() { return this; }
1451 
1452   LIR_Opr tmp() const                            { return _tmp; }
1453 
1454   virtual void verify() const;
1455 };
1456 
1457 
1458 
1459 class LIR_OpReturn: public LIR_Op1 {
1460  friend class LIR_OpVisitState;
1461 
1462  private:
1463   C1SafepointPollStub* _stub;
1464 
1465  public:
1466   LIR_OpReturn(LIR_Opr opr);
1467 
1468   C1SafepointPollStub* stub() const { return _stub; }
1469   virtual LIR_OpReturn* as_OpReturn() { return this; }
1470 };
1471 
1472 class ConversionStub;
1473 
1474 class LIR_OpConvert: public LIR_Op1 {
1475  friend class LIR_OpVisitState;
1476 
1477  private:
1478    Bytecodes::Code _bytecode;
1479    ConversionStub* _stub;
1480 
1481  public:
1482    LIR_OpConvert(Bytecodes::Code code, LIR_Opr opr, LIR_Opr result, ConversionStub* stub)
1483      : LIR_Op1(lir_convert, opr, result)
1484      , _bytecode(code)
1485      , _stub(stub)                               {}
1486 
1487   Bytecodes::Code bytecode() const               { return _bytecode; }
1488   ConversionStub* stub() const                   { return _stub; }
1489 
1490   virtual void emit_code(LIR_Assembler* masm);
1491   virtual LIR_OpConvert* as_OpConvert() { return this; }
1492   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1493 
1494   static void print_bytecode(outputStream* out, Bytecodes::Code code) PRODUCT_RETURN;
1495 };
1496 
1497 
1498 // LIR_OpAllocObj
1499 class LIR_OpAllocObj : public LIR_Op1 {
1500  friend class LIR_OpVisitState;
1501 
1502  private:
1503   LIR_Opr _tmp1;
1504   LIR_Opr _tmp2;
1505   LIR_Opr _tmp3;
1506   LIR_Opr _tmp4;
1507   int     _hdr_size;
1508   int     _obj_size;
1509   CodeStub* _stub;
1510   bool    _init_check;
1511 
1512  public:
1513   LIR_OpAllocObj(LIR_Opr klass, LIR_Opr result,
1514                  LIR_Opr t1, LIR_Opr t2, LIR_Opr t3, LIR_Opr t4,
1515                  int hdr_size, int obj_size, bool init_check, CodeStub* stub)
1516     : LIR_Op1(lir_alloc_object, klass, result)
1517     , _tmp1(t1)
1518     , _tmp2(t2)
1519     , _tmp3(t3)
1520     , _tmp4(t4)
1521     , _hdr_size(hdr_size)
1522     , _obj_size(obj_size)
1523     , _stub(stub)
1524     , _init_check(init_check)                    { }
1525 
1526   LIR_Opr klass()        const                   { return in_opr();     }
1527   LIR_Opr obj()          const                   { return result_opr(); }
1528   LIR_Opr tmp1()         const                   { return _tmp1;        }
1529   LIR_Opr tmp2()         const                   { return _tmp2;        }
1530   LIR_Opr tmp3()         const                   { return _tmp3;        }
1531   LIR_Opr tmp4()         const                   { return _tmp4;        }
1532   int     header_size()  const                   { return _hdr_size;    }
1533   int     object_size()  const                   { return _obj_size;    }
1534   bool    init_check()   const                   { return _init_check;  }
1535   CodeStub* stub()       const                   { return _stub;        }
1536 
1537   virtual void emit_code(LIR_Assembler* masm);
1538   virtual LIR_OpAllocObj * as_OpAllocObj () { return this; }
1539   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1540 };
1541 
1542 
1543 // LIR_OpRoundFP
1544 class LIR_OpRoundFP : public LIR_Op1 {
1545  friend class LIR_OpVisitState;
1546 
1547  private:
1548   LIR_Opr _tmp;
1549 
1550  public:
1551   LIR_OpRoundFP(LIR_Opr reg, LIR_Opr stack_loc_temp, LIR_Opr result)
1552     : LIR_Op1(lir_roundfp, reg, result)
1553     , _tmp(stack_loc_temp) {}
1554 
1555   LIR_Opr tmp() const                            { return _tmp; }
1556   virtual LIR_OpRoundFP* as_OpRoundFP()          { return this; }
1557   void print_instr(outputStream* out) const PRODUCT_RETURN;
1558 };
1559 
1560 // LIR_OpTypeCheck
1561 class LIR_OpTypeCheck: public LIR_Op {
1562  friend class LIR_OpVisitState;
1563 
1564  private:
1565   LIR_Opr       _object;
1566   LIR_Opr       _array;
1567   ciKlass*      _klass;
1568   LIR_Opr       _tmp1;
1569   LIR_Opr       _tmp2;
1570   LIR_Opr       _tmp3;
1571   bool          _fast_check;
1572   CodeEmitInfo* _info_for_patch;
1573   CodeEmitInfo* _info_for_exception;
1574   CodeStub*     _stub;
1575   ciMethod*     _profiled_method;
1576   int           _profiled_bci;
1577   bool          _should_profile;
1578   bool          _need_null_check;
1579 
1580 public:
1581   LIR_OpTypeCheck(LIR_Code code, LIR_Opr result, LIR_Opr object, ciKlass* klass,
1582                   LIR_Opr tmp1, LIR_Opr tmp2, LIR_Opr tmp3, bool fast_check,
1583                   CodeEmitInfo* info_for_exception, CodeEmitInfo* info_for_patch, CodeStub* stub, bool need_null_check = true);
1584   LIR_OpTypeCheck(LIR_Code code, LIR_Opr object, LIR_Opr array,
1585                   LIR_Opr tmp1, LIR_Opr tmp2, LIR_Opr tmp3, CodeEmitInfo* info_for_exception);
1586 
1587   LIR_Opr object() const                         { return _object;         }
1588   LIR_Opr array() const                          { assert(code() == lir_store_check, "not valid"); return _array;         }
1589   LIR_Opr tmp1() const                           { return _tmp1;           }
1590   LIR_Opr tmp2() const                           { return _tmp2;           }
1591   LIR_Opr tmp3() const                           { return _tmp3;           }
1592   ciKlass* klass() const                         { assert(code() == lir_instanceof || code() == lir_checkcast, "not valid"); return _klass;          }
1593   bool fast_check() const                        { assert(code() == lir_instanceof || code() == lir_checkcast, "not valid"); return _fast_check;     }
1594   CodeEmitInfo* info_for_patch() const           { return _info_for_patch;  }
1595   CodeEmitInfo* info_for_exception() const       { return _info_for_exception; }
1596   CodeStub* stub() const                         { return _stub;           }
1597 
1598   // MethodData* profiling
1599   void set_profiled_method(ciMethod *method)     { _profiled_method = method; }
1600   void set_profiled_bci(int bci)                 { _profiled_bci = bci;       }
1601   void set_should_profile(bool b)                { _should_profile = b;       }
1602   ciMethod* profiled_method() const              { return _profiled_method;   }
1603   int       profiled_bci() const                 { return _profiled_bci;      }
1604   bool      should_profile() const               { return _should_profile;    }
1605   bool      need_null_check() const              { return _need_null_check;   }
1606   virtual bool is_patching() { return _info_for_patch != nullptr; }
1607   virtual void emit_code(LIR_Assembler* masm);
1608   virtual LIR_OpTypeCheck* as_OpTypeCheck() { return this; }
1609   void print_instr(outputStream* out) const PRODUCT_RETURN;
1610 };
1611 
1612 // LIR_OpFlattenedArrayCheck
1613 class LIR_OpFlattenedArrayCheck: public LIR_Op {
1614  friend class LIR_OpVisitState;
1615 
1616  private:
1617   LIR_Opr       _array;
1618   LIR_Opr       _value;
1619   LIR_Opr       _tmp;
1620   CodeStub*     _stub;
1621 public:
1622   LIR_OpFlattenedArrayCheck(LIR_Opr array, LIR_Opr value, LIR_Opr tmp, CodeStub* stub);
1623   LIR_Opr array() const                          { return _array;         }
1624   LIR_Opr value() const                          { return _value;         }
1625   LIR_Opr tmp() const                            { return _tmp;           }
1626   CodeStub* stub() const                         { return _stub;          }
1627 
1628   virtual void emit_code(LIR_Assembler* masm);
1629   virtual LIR_OpFlattenedArrayCheck* as_OpFlattenedArrayCheck() { return this; }
1630   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1631 };
1632 
1633 // LIR_OpNullFreeArrayCheck
1634 class LIR_OpNullFreeArrayCheck: public LIR_Op {
1635  friend class LIR_OpVisitState;
1636 
1637  private:
1638   LIR_Opr       _array;
1639   LIR_Opr       _tmp;
1640 public:
1641   LIR_OpNullFreeArrayCheck(LIR_Opr array, LIR_Opr tmp);
1642   LIR_Opr array() const                          { return _array;         }
1643   LIR_Opr tmp() const                            { return _tmp;           }
1644 
1645   virtual void emit_code(LIR_Assembler* masm);
1646   virtual LIR_OpNullFreeArrayCheck* as_OpNullFreeArrayCheck() { return this; }
1647   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1648 };
1649 
1650 class LIR_OpSubstitutabilityCheck: public LIR_Op {
1651  friend class LIR_OpVisitState;
1652 
1653  private:
1654   LIR_Opr       _left;
1655   LIR_Opr       _right;
1656   LIR_Opr       _equal_result;
1657   LIR_Opr       _not_equal_result;
1658   LIR_Opr       _tmp1;
1659   LIR_Opr       _tmp2;
1660   ciKlass*      _left_klass;
1661   ciKlass*      _right_klass;
1662   LIR_Opr       _left_klass_op;
1663   LIR_Opr       _right_klass_op;
1664   CodeStub*     _stub;
1665 public:
1666   LIR_OpSubstitutabilityCheck(LIR_Opr result, LIR_Opr left, LIR_Opr right, LIR_Opr equal_result, LIR_Opr not_equal_result,
1667                               LIR_Opr tmp1, LIR_Opr tmp2,
1668                               ciKlass* left_klass, ciKlass* right_klass, LIR_Opr left_klass_op, LIR_Opr right_klass_op,
1669                               CodeEmitInfo* info, CodeStub* stub);
1670 
1671   LIR_Opr left() const             { return _left; }
1672   LIR_Opr right() const            { return _right; }
1673   LIR_Opr equal_result() const     { return _equal_result; }
1674   LIR_Opr not_equal_result() const { return _not_equal_result; }
1675   LIR_Opr tmp1() const             { return _tmp1; }
1676   LIR_Opr tmp2() const             { return _tmp2; }
1677   ciKlass* left_klass() const      { return _left_klass; }
1678   ciKlass* right_klass() const     { return _right_klass; }
1679   LIR_Opr left_klass_op() const    { return _left_klass_op; }
1680   LIR_Opr right_klass_op() const   { return _right_klass_op; }
1681   CodeStub* stub() const           { return _stub; }
1682 
1683   virtual void emit_code(LIR_Assembler* masm);
1684   virtual LIR_OpSubstitutabilityCheck* as_OpSubstitutabilityCheck() { return this; }
1685   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1686 };
1687 
1688 // LIR_Op2
1689 class LIR_Op2: public LIR_Op {
1690  friend class LIR_OpVisitState;
1691 
1692   int  _fpu_stack_size; // for sin/cos implementation on Intel
1693 
1694  protected:
1695   LIR_Opr   _opr1;
1696   LIR_Opr   _opr2;
1697   BasicType _type;
1698   LIR_Opr   _tmp1;
1699   LIR_Opr   _tmp2;
1700   LIR_Opr   _tmp3;
1701   LIR_Opr   _tmp4;
1702   LIR_Opr   _tmp5;
1703   LIR_Condition _condition;
1704 
1705   void verify() const;
1706 
1707  public:
1708   LIR_Op2(LIR_Code code, LIR_Condition condition, LIR_Opr opr1, LIR_Opr opr2, CodeEmitInfo* info = nullptr, BasicType type = T_ILLEGAL)
1709     : LIR_Op(code, LIR_OprFact::illegalOpr, info)
1710     , _fpu_stack_size(0)
1711     , _opr1(opr1)
1712     , _opr2(opr2)
1713     , _type(type)
1714     , _tmp1(LIR_OprFact::illegalOpr)
1715     , _tmp2(LIR_OprFact::illegalOpr)
1716     , _tmp3(LIR_OprFact::illegalOpr)
1717     , _tmp4(LIR_OprFact::illegalOpr)
1718     , _tmp5(LIR_OprFact::illegalOpr)
1719     , _condition(condition) {
1720     assert(code == lir_cmp || code == lir_branch || code == lir_cond_float_branch || code == lir_assert, "code check");
1721   }
1722 
1723   LIR_Op2(LIR_Code code, LIR_Condition condition, LIR_Opr opr1, LIR_Opr opr2, LIR_Opr result, BasicType type)
1724     : LIR_Op(code, result, nullptr)
1725     , _fpu_stack_size(0)
1726     , _opr1(opr1)
1727     , _opr2(opr2)
1728     , _type(type)
1729     , _tmp1(LIR_OprFact::illegalOpr)
1730     , _tmp2(LIR_OprFact::illegalOpr)
1731     , _tmp3(LIR_OprFact::illegalOpr)
1732     , _tmp4(LIR_OprFact::illegalOpr)
1733     , _tmp5(LIR_OprFact::illegalOpr)
1734     , _condition(condition) {
1735     assert(code == lir_cmove, "code check");
1736     assert(type != T_ILLEGAL, "cmove should have type");
1737   }
1738 
1739   LIR_Op2(LIR_Code code, LIR_Opr opr1, LIR_Opr opr2, LIR_Opr result = LIR_OprFact::illegalOpr,
1740           CodeEmitInfo* info = nullptr, BasicType type = T_ILLEGAL)
1741     : LIR_Op(code, result, info)
1742     , _fpu_stack_size(0)
1743     , _opr1(opr1)
1744     , _opr2(opr2)
1745     , _type(type)
1746     , _tmp1(LIR_OprFact::illegalOpr)
1747     , _tmp2(LIR_OprFact::illegalOpr)
1748     , _tmp3(LIR_OprFact::illegalOpr)
1749     , _tmp4(LIR_OprFact::illegalOpr)
1750     , _tmp5(LIR_OprFact::illegalOpr)
1751     , _condition(lir_cond_unknown) {
1752     assert(code != lir_cmp && code != lir_branch && code != lir_cond_float_branch && is_in_range(code, begin_op2, end_op2), "code check");
1753   }
1754 
1755   LIR_Op2(LIR_Code code, LIR_Opr opr1, LIR_Opr opr2, LIR_Opr result, LIR_Opr tmp1, LIR_Opr tmp2 = LIR_OprFact::illegalOpr,
1756           LIR_Opr tmp3 = LIR_OprFact::illegalOpr, LIR_Opr tmp4 = LIR_OprFact::illegalOpr, LIR_Opr tmp5 = LIR_OprFact::illegalOpr)
1757     : LIR_Op(code, result, nullptr)
1758     , _fpu_stack_size(0)
1759     , _opr1(opr1)
1760     , _opr2(opr2)
1761     , _type(T_ILLEGAL)
1762     , _tmp1(tmp1)
1763     , _tmp2(tmp2)
1764     , _tmp3(tmp3)
1765     , _tmp4(tmp4)
1766     , _tmp5(tmp5)
1767     , _condition(lir_cond_unknown) {
1768     assert(code != lir_cmp && code != lir_branch && code != lir_cond_float_branch && is_in_range(code, begin_op2, end_op2), "code check");
1769   }
1770 
1771   LIR_Opr in_opr1() const                        { return _opr1; }
1772   LIR_Opr in_opr2() const                        { return _opr2; }
1773   BasicType type()  const                        { return _type; }
1774   LIR_Opr tmp1_opr() const                       { return _tmp1; }
1775   LIR_Opr tmp2_opr() const                       { return _tmp2; }
1776   LIR_Opr tmp3_opr() const                       { return _tmp3; }
1777   LIR_Opr tmp4_opr() const                       { return _tmp4; }
1778   LIR_Opr tmp5_opr() const                       { return _tmp5; }
1779   LIR_Condition condition() const  {
1780     assert(code() == lir_cmp || code() == lir_branch || code() == lir_cond_float_branch || code() == lir_assert, "only valid for branch and assert"); return _condition;
1781   }
1782   void set_condition(LIR_Condition condition) {
1783     assert(code() == lir_cmp || code() == lir_branch || code() == lir_cond_float_branch, "only valid for branch"); _condition = condition;
1784   }
1785 
1786   void set_fpu_stack_size(int size)              { _fpu_stack_size = size; }
1787   int  fpu_stack_size() const                    { return _fpu_stack_size; }
1788 
1789   void set_in_opr1(LIR_Opr opr)                  { _opr1 = opr; }
1790   void set_in_opr2(LIR_Opr opr)                  { _opr2 = opr; }
1791 
1792   virtual void emit_code(LIR_Assembler* masm);
1793   virtual LIR_Op2* as_Op2() { return this; }
1794   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1795 };
1796 
1797 class LIR_OpBranch: public LIR_Op2 {
1798  friend class LIR_OpVisitState;
1799 
1800  private:
1801   Label*        _label;
1802   BlockBegin*   _block;  // if this is a branch to a block, this is the block
1803   BlockBegin*   _ublock; // if this is a float-branch, this is the unordered block
1804   CodeStub*     _stub;   // if this is a branch to a stub, this is the stub
1805 
1806  public:
1807   LIR_OpBranch(LIR_Condition cond, Label* lbl)
1808     : LIR_Op2(lir_branch, cond, LIR_OprFact::illegalOpr, LIR_OprFact::illegalOpr, (CodeEmitInfo*) nullptr)
1809     , _label(lbl)
1810     , _block(nullptr)
1811     , _ublock(nullptr)
1812     , _stub(nullptr) { }
1813 
1814   LIR_OpBranch(LIR_Condition cond, BlockBegin* block);
1815   LIR_OpBranch(LIR_Condition cond, CodeStub* stub);
1816 
1817   // for unordered comparisons
1818   LIR_OpBranch(LIR_Condition cond, BlockBegin* block, BlockBegin* ublock);
1819 
1820   LIR_Condition cond() const {
1821     return condition();
1822   }
1823 
1824   void set_cond(LIR_Condition cond) {
1825     set_condition(cond);
1826   }
1827 
1828   Label*        label()       const              { return _label;       }
1829   BlockBegin*   block()       const              { return _block;       }
1830   BlockBegin*   ublock()      const              { return _ublock;      }
1831   CodeStub*     stub()        const              { return _stub;        }
1832 
1833   void          change_block(BlockBegin* b);
1834   void          change_ublock(BlockBegin* b);
1835   void          negate_cond();
1836 
1837   virtual void emit_code(LIR_Assembler* masm);
1838   virtual LIR_OpBranch* as_OpBranch() { return this; }
1839   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1840 };
1841 
1842 class LIR_OpAllocArray : public LIR_Op {
1843  friend class LIR_OpVisitState;
1844 
1845  private:
1846   LIR_Opr   _klass;
1847   LIR_Opr   _len;
1848   LIR_Opr   _tmp1;
1849   LIR_Opr   _tmp2;
1850   LIR_Opr   _tmp3;
1851   LIR_Opr   _tmp4;
1852   BasicType _type;
1853   CodeStub* _stub;
1854   bool      _is_null_free;
1855 
1856  public:
1857   LIR_OpAllocArray(LIR_Opr klass, LIR_Opr len, LIR_Opr result, LIR_Opr t1, LIR_Opr t2, LIR_Opr t3, LIR_Opr t4, BasicType type, CodeStub* stub, bool is_null_free)
1858     : LIR_Op(lir_alloc_array, result, nullptr)
1859     , _klass(klass)
1860     , _len(len)
1861     , _tmp1(t1)
1862     , _tmp2(t2)
1863     , _tmp3(t3)
1864     , _tmp4(t4)
1865     , _type(type)
1866     , _stub(stub)
1867     , _is_null_free(is_null_free) {}
1868 
1869   LIR_Opr   klass()   const                      { return _klass;       }
1870   LIR_Opr   len()     const                      { return _len;         }
1871   LIR_Opr   obj()     const                      { return result_opr(); }
1872   LIR_Opr   tmp1()    const                      { return _tmp1;        }
1873   LIR_Opr   tmp2()    const                      { return _tmp2;        }
1874   LIR_Opr   tmp3()    const                      { return _tmp3;        }
1875   LIR_Opr   tmp4()    const                      { return _tmp4;        }
1876   BasicType type()    const                      { return _type;        }
1877   CodeStub* stub()    const                      { return _stub;        }
1878   bool      is_null_free() const                 { return _is_null_free;}
1879 
1880   virtual void emit_code(LIR_Assembler* masm);
1881   virtual LIR_OpAllocArray * as_OpAllocArray () { return this; }
1882   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1883 };
1884 
1885 
1886 class LIR_Op3: public LIR_Op {
1887  friend class LIR_OpVisitState;
1888 
1889  private:
1890   LIR_Opr _opr1;
1891   LIR_Opr _opr2;
1892   LIR_Opr _opr3;
1893  public:
1894   LIR_Op3(LIR_Code code, LIR_Opr opr1, LIR_Opr opr2, LIR_Opr opr3, LIR_Opr result, CodeEmitInfo* info = nullptr)
1895     : LIR_Op(code, result, info)
1896     , _opr1(opr1)
1897     , _opr2(opr2)
1898     , _opr3(opr3)                                { assert(is_in_range(code, begin_op3, end_op3), "code check"); }
1899   LIR_Opr in_opr1() const                        { return _opr1; }
1900   LIR_Opr in_opr2() const                        { return _opr2; }
1901   LIR_Opr in_opr3() const                        { return _opr3; }
1902 
1903   virtual void emit_code(LIR_Assembler* masm);
1904   virtual LIR_Op3* as_Op3() { return this; }
1905   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1906 };
1907 
1908 class LIR_Op4: public LIR_Op {
1909   friend class LIR_OpVisitState;
1910  protected:
1911   LIR_Opr   _opr1;
1912   LIR_Opr   _opr2;
1913   LIR_Opr   _opr3;
1914   LIR_Opr   _opr4;
1915   BasicType _type;
1916   LIR_Opr   _tmp1;
1917   LIR_Opr   _tmp2;
1918   LIR_Opr   _tmp3;
1919   LIR_Opr   _tmp4;
1920   LIR_Opr   _tmp5;
1921   LIR_Condition _condition;
1922 
1923  public:
1924   LIR_Op4(LIR_Code code, LIR_Condition condition, LIR_Opr opr1, LIR_Opr opr2, LIR_Opr opr3, LIR_Opr opr4,
1925           LIR_Opr result, BasicType type)
1926     : LIR_Op(code, result, nullptr)
1927     , _opr1(opr1)
1928     , _opr2(opr2)
1929     , _opr3(opr3)
1930     , _opr4(opr4)
1931     , _type(type)
1932     , _tmp1(LIR_OprFact::illegalOpr)
1933     , _tmp2(LIR_OprFact::illegalOpr)
1934     , _tmp3(LIR_OprFact::illegalOpr)
1935     , _tmp4(LIR_OprFact::illegalOpr)
1936     , _tmp5(LIR_OprFact::illegalOpr)
1937     , _condition(condition) {
1938     assert(code == lir_cmove, "code check");
1939     assert(type != T_ILLEGAL, "cmove should have type");
1940   }
1941 
1942   LIR_Opr in_opr1() const                        { return _opr1; }
1943   LIR_Opr in_opr2() const                        { return _opr2; }
1944   LIR_Opr in_opr3() const                        { return _opr3; }
1945   LIR_Opr in_opr4() const                        { return _opr4; }
1946   BasicType type()  const                        { return _type; }
1947   LIR_Opr tmp1_opr() const                       { return _tmp1; }
1948   LIR_Opr tmp2_opr() const                       { return _tmp2; }
1949   LIR_Opr tmp3_opr() const                       { return _tmp3; }
1950   LIR_Opr tmp4_opr() const                       { return _tmp4; }
1951   LIR_Opr tmp5_opr() const                       { return _tmp5; }
1952 
1953   LIR_Condition condition() const                { return _condition; }
1954   void set_condition(LIR_Condition condition)    { _condition = condition; }
1955 
1956   void set_in_opr1(LIR_Opr opr)                  { _opr1 = opr; }
1957   void set_in_opr2(LIR_Opr opr)                  { _opr2 = opr; }
1958   void set_in_opr3(LIR_Opr opr)                  { _opr3 = opr; }
1959   void set_in_opr4(LIR_Opr opr)                  { _opr4 = opr; }
1960   virtual void emit_code(LIR_Assembler* masm);
1961   virtual LIR_Op4* as_Op4() { return this; }
1962 
1963   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
1964 };
1965 
1966 //--------------------------------
1967 class LabelObj: public CompilationResourceObj {
1968  private:
1969   Label _label;
1970  public:
1971   LabelObj()                                     {}
1972   Label* label()                                 { return &_label; }
1973 };
1974 
1975 
1976 class LIR_OpLock: public LIR_Op {
1977  friend class LIR_OpVisitState;
1978 
1979  private:
1980   LIR_Opr _hdr;
1981   LIR_Opr _obj;
1982   LIR_Opr _lock;
1983   LIR_Opr _scratch;
1984   CodeStub* _stub;
1985   CodeStub* _throw_ie_stub;
1986  public:
1987   LIR_OpLock(LIR_Code code, LIR_Opr hdr, LIR_Opr obj, LIR_Opr lock, LIR_Opr scratch, CodeStub* stub, CodeEmitInfo* info, CodeStub* throw_ie_stub=nullptr)
1988     : LIR_Op(code, LIR_OprFact::illegalOpr, info)
1989     , _hdr(hdr)
1990     , _obj(obj)
1991     , _lock(lock)
1992     , _scratch(scratch)
1993     , _stub(stub)
1994     , _throw_ie_stub(throw_ie_stub)                    {}
1995 
1996   LIR_Opr hdr_opr() const                        { return _hdr; }
1997   LIR_Opr obj_opr() const                        { return _obj; }
1998   LIR_Opr lock_opr() const                       { return _lock; }
1999   LIR_Opr scratch_opr() const                    { return _scratch; }
2000   CodeStub* stub() const                         { return _stub; }
2001   CodeStub* throw_ie_stub() const                { return _throw_ie_stub; }
2002 
2003   virtual void emit_code(LIR_Assembler* masm);
2004   virtual LIR_OpLock* as_OpLock() { return this; }
2005   void print_instr(outputStream* out) const PRODUCT_RETURN;
2006 };
2007 
2008 class LIR_OpLoadKlass: public LIR_Op {
2009   friend class LIR_OpVisitState;
2010 
2011  private:
2012   LIR_Opr _obj;
2013  public:
2014   LIR_OpLoadKlass(LIR_Opr obj, LIR_Opr result, CodeEmitInfo* info)
2015     : LIR_Op(lir_load_klass, result, info)
2016     , _obj(obj)
2017     {}
2018 
2019   LIR_Opr obj()        const { return _obj;  }
2020 
2021   virtual LIR_OpLoadKlass* as_OpLoadKlass() { return this; }
2022   virtual void emit_code(LIR_Assembler* masm);
2023   void print_instr(outputStream* out) const PRODUCT_RETURN;
2024 };
2025 
2026 class LIR_OpDelay: public LIR_Op {
2027  friend class LIR_OpVisitState;
2028 
2029  private:
2030   LIR_Op* _op;
2031 
2032  public:
2033   LIR_OpDelay(LIR_Op* op, CodeEmitInfo* info):
2034     LIR_Op(lir_delay_slot, LIR_OprFact::illegalOpr, info),
2035     _op(op) {
2036     assert(op->code() == lir_nop, "should be filling with nops");
2037   }
2038   virtual void emit_code(LIR_Assembler* masm);
2039   virtual LIR_OpDelay* as_OpDelay() { return this; }
2040   void print_instr(outputStream* out) const PRODUCT_RETURN;
2041   LIR_Op* delay_op() const { return _op; }
2042   CodeEmitInfo* call_info() const { return info(); }
2043 };
2044 
2045 #ifdef ASSERT
2046 // LIR_OpAssert
2047 class LIR_OpAssert : public LIR_Op2 {
2048  friend class LIR_OpVisitState;
2049 
2050  private:
2051   const char* _msg;
2052   bool        _halt;
2053 
2054  public:
2055   LIR_OpAssert(LIR_Condition condition, LIR_Opr opr1, LIR_Opr opr2, const char* msg, bool halt)
2056     : LIR_Op2(lir_assert, condition, opr1, opr2)
2057     , _msg(msg)
2058     , _halt(halt) {
2059   }
2060 
2061   const char* msg() const                        { return _msg; }
2062   bool        halt() const                       { return _halt; }
2063 
2064   virtual void emit_code(LIR_Assembler* masm);
2065   virtual LIR_OpAssert* as_OpAssert()            { return this; }
2066   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
2067 };
2068 #endif
2069 
2070 // LIR_OpCompareAndSwap
2071 class LIR_OpCompareAndSwap : public LIR_Op {
2072  friend class LIR_OpVisitState;
2073 
2074  private:
2075   LIR_Opr _addr;
2076   LIR_Opr _cmp_value;
2077   LIR_Opr _new_value;
2078   LIR_Opr _tmp1;
2079   LIR_Opr _tmp2;
2080 
2081  public:
2082   LIR_OpCompareAndSwap(LIR_Code code, LIR_Opr addr, LIR_Opr cmp_value, LIR_Opr new_value,
2083                        LIR_Opr t1, LIR_Opr t2, LIR_Opr result)
2084     : LIR_Op(code, result, nullptr)  // no result, no info
2085     , _addr(addr)
2086     , _cmp_value(cmp_value)
2087     , _new_value(new_value)
2088     , _tmp1(t1)
2089     , _tmp2(t2)                                  { }
2090 
2091   LIR_Opr addr()        const                    { return _addr;  }
2092   LIR_Opr cmp_value()   const                    { return _cmp_value; }
2093   LIR_Opr new_value()   const                    { return _new_value; }
2094   LIR_Opr tmp1()        const                    { return _tmp1;      }
2095   LIR_Opr tmp2()        const                    { return _tmp2;      }
2096 
2097   virtual void emit_code(LIR_Assembler* masm);
2098   virtual LIR_OpCompareAndSwap * as_OpCompareAndSwap () { return this; }
2099   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
2100 };
2101 
2102 // LIR_OpProfileCall
2103 class LIR_OpProfileCall : public LIR_Op {
2104  friend class LIR_OpVisitState;
2105 
2106  private:
2107   ciMethod* _profiled_method;
2108   int       _profiled_bci;
2109   ciMethod* _profiled_callee;
2110   LIR_Opr   _mdo;
2111   LIR_Opr   _recv;
2112   LIR_Opr   _tmp1;
2113   ciKlass*  _known_holder;
2114 
2115  public:
2116   // Destroys recv
2117   LIR_OpProfileCall(ciMethod* profiled_method, int profiled_bci, ciMethod* profiled_callee, LIR_Opr mdo, LIR_Opr recv, LIR_Opr t1, ciKlass* known_holder)
2118     : LIR_Op(lir_profile_call, LIR_OprFact::illegalOpr, nullptr)  // no result, no info
2119     , _profiled_method(profiled_method)
2120     , _profiled_bci(profiled_bci)
2121     , _profiled_callee(profiled_callee)
2122     , _mdo(mdo)
2123     , _recv(recv)
2124     , _tmp1(t1)
2125     , _known_holder(known_holder)                { }
2126 
2127   ciMethod* profiled_method() const              { return _profiled_method;  }
2128   int       profiled_bci()    const              { return _profiled_bci;     }
2129   ciMethod* profiled_callee() const              { return _profiled_callee;  }
2130   LIR_Opr   mdo()             const              { return _mdo;              }
2131   LIR_Opr   recv()            const              { return _recv;             }
2132   LIR_Opr   tmp1()            const              { return _tmp1;             }
2133   ciKlass*  known_holder()    const              { return _known_holder;     }
2134 
2135   virtual void emit_code(LIR_Assembler* masm);
2136   virtual LIR_OpProfileCall* as_OpProfileCall() { return this; }
2137   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
2138   bool should_profile_receiver_type() const {
2139     bool callee_is_static = _profiled_callee->is_loaded() && _profiled_callee->is_static();
2140     Bytecodes::Code bc = _profiled_method->java_code_at_bci(_profiled_bci);
2141     bool call_is_virtual = (bc == Bytecodes::_invokevirtual && !_profiled_callee->can_be_statically_bound()) || bc == Bytecodes::_invokeinterface;
2142     return C1ProfileVirtualCalls && call_is_virtual && !callee_is_static;
2143   }
2144 };
2145 
2146 // LIR_OpProfileType
2147 class LIR_OpProfileType : public LIR_Op {
2148  friend class LIR_OpVisitState;
2149 
2150  private:
2151   LIR_Opr      _mdp;
2152   LIR_Opr      _obj;
2153   LIR_Opr      _tmp;
2154   ciKlass*     _exact_klass;   // non null if we know the klass statically (no need to load it from _obj)
2155   intptr_t     _current_klass; // what the profiling currently reports
2156   bool         _not_null;      // true if we know statically that _obj cannot be null
2157   bool         _no_conflict;   // true if we're profling parameters, _exact_klass is not null and we know
2158                                // _exact_klass it the only possible type for this parameter in any context.
2159 
2160  public:
2161   // Destroys recv
2162   LIR_OpProfileType(LIR_Opr mdp, LIR_Opr obj, ciKlass* exact_klass, intptr_t current_klass, LIR_Opr tmp, bool not_null, bool no_conflict)
2163     : LIR_Op(lir_profile_type, LIR_OprFact::illegalOpr, nullptr)  // no result, no info
2164     , _mdp(mdp)
2165     , _obj(obj)
2166     , _tmp(tmp)
2167     , _exact_klass(exact_klass)
2168     , _current_klass(current_klass)
2169     , _not_null(not_null)
2170     , _no_conflict(no_conflict) { }
2171 
2172   LIR_Opr      mdp()              const             { return _mdp;              }
2173   LIR_Opr      obj()              const             { return _obj;              }
2174   LIR_Opr      tmp()              const             { return _tmp;              }
2175   ciKlass*     exact_klass()      const             { return _exact_klass;      }
2176   intptr_t     current_klass()    const             { return _current_klass;    }
2177   bool         not_null()         const             { return _not_null;         }
2178   bool         no_conflict()      const             { return _no_conflict;      }
2179 
2180   virtual void emit_code(LIR_Assembler* masm);
2181   virtual LIR_OpProfileType* as_OpProfileType() { return this; }
2182   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
2183 };
2184 
2185 // LIR_OpProfileInlineType
2186 class LIR_OpProfileInlineType : public LIR_Op {
2187  friend class LIR_OpVisitState;
2188 
2189  private:
2190   LIR_Opr      _mdp;
2191   LIR_Opr      _obj;
2192   int          _flag;
2193   LIR_Opr      _tmp;
2194   bool         _not_null;      // true if we know statically that _obj cannot be null
2195 
2196  public:
2197   // Destroys recv
2198   LIR_OpProfileInlineType(LIR_Opr mdp, LIR_Opr obj, int flag, LIR_Opr tmp, bool not_null)
2199     : LIR_Op(lir_profile_inline_type, LIR_OprFact::illegalOpr, nullptr)  // no result, no info
2200     , _mdp(mdp)
2201     , _obj(obj)
2202     , _flag(flag)
2203     , _tmp(tmp)
2204     , _not_null(not_null) { }
2205 
2206   LIR_Opr      mdp()              const             { return _mdp;              }
2207   LIR_Opr      obj()              const             { return _obj;              }
2208   int          flag()             const             { return _flag;             }
2209   LIR_Opr      tmp()              const             { return _tmp;              }
2210   bool         not_null()         const             { return _not_null;         }
2211 
2212   virtual void emit_code(LIR_Assembler* masm);
2213   virtual LIR_OpProfileInlineType* as_OpProfileInlineType() { return this; }
2214   virtual void print_instr(outputStream* out) const PRODUCT_RETURN;
2215 };
2216 
2217 class LIR_InsertionBuffer;
2218 
2219 //--------------------------------LIR_List---------------------------------------------------
2220 // Maintains a list of LIR instructions (one instance of LIR_List per basic block)
2221 // The LIR instructions are appended by the LIR_List class itself;
2222 //
2223 // Notes:
2224 // - all offsets are(should be) in bytes
2225 // - local positions are specified with an offset, with offset 0 being local 0
2226 
2227 class LIR_List: public CompilationResourceObj {
2228  private:
2229   LIR_OpList  _operations;
2230 
2231   Compilation*  _compilation;
2232 #ifndef PRODUCT
2233   BlockBegin*   _block;
2234 #endif
2235 #ifdef ASSERT
2236   const char *  _file;
2237   int           _line;
2238 #endif
2239 #ifdef RISCV
2240   LIR_Opr       _cmp_opr1;
2241   LIR_Opr       _cmp_opr2;
2242 #endif
2243 
2244  public:
2245   void append(LIR_Op* op) {
2246     if (op->source() == nullptr)
2247       op->set_source(_compilation->current_instruction());
2248 #ifndef PRODUCT
2249     if (PrintIRWithLIR) {
2250       _compilation->maybe_print_current_instruction();
2251       op->print(); tty->cr();
2252     }
2253 #endif // PRODUCT
2254 
2255 #ifdef RISCV
2256     set_cmp_oprs(op);
2257     // lir_cmp set cmp oprs only on riscv
2258     if (op->code() == lir_cmp) return;
2259 #endif
2260 
2261     _operations.append(op);
2262 
2263 #ifdef ASSERT
2264     op->verify();
2265     op->set_file_and_line(_file, _line);
2266     _file = nullptr;
2267     _line = 0;
2268 #endif
2269   }
2270 
2271   LIR_List(Compilation* compilation, BlockBegin* block = nullptr);
2272 
2273 #ifdef ASSERT
2274   void set_file_and_line(const char * file, int line);
2275 #endif
2276 
2277 #ifdef RISCV
2278   void set_cmp_oprs(LIR_Op* op);
2279 #endif
2280 
2281   //---------- accessors ---------------
2282   LIR_OpList* instructions_list()                { return &_operations; }
2283   int         length() const                     { return _operations.length(); }
2284   LIR_Op*     at(int i) const                    { return _operations.at(i); }
2285 
2286   NOT_PRODUCT(BlockBegin* block() const          { return _block; });
2287 
2288   // insert LIR_Ops in buffer to right places in LIR_List
2289   void append(LIR_InsertionBuffer* buffer);
2290 
2291   //---------- mutators ---------------
2292   void insert_before(int i, LIR_List* op_list)   { _operations.insert_before(i, op_list->instructions_list()); }
2293   void insert_before(int i, LIR_Op* op)          { _operations.insert_before(i, op); }
2294   void remove_at(int i)                          { _operations.remove_at(i); }
2295 
2296   //---------- printing -------------
2297   void print_instructions() PRODUCT_RETURN;
2298 
2299 
2300   //---------- instructions -------------
2301   void call_opt_virtual(ciMethod* method, LIR_Opr receiver, LIR_Opr result,
2302                         address dest, LIR_OprList* arguments,
2303                         CodeEmitInfo* info) {
2304     append(new LIR_OpJavaCall(lir_optvirtual_call, method, receiver, result, dest, arguments, info));
2305   }
2306   void call_static(ciMethod* method, LIR_Opr result,
2307                    address dest, LIR_OprList* arguments, CodeEmitInfo* info) {
2308     append(new LIR_OpJavaCall(lir_static_call, method, LIR_OprFact::illegalOpr, result, dest, arguments, info));
2309   }
2310   void call_icvirtual(ciMethod* method, LIR_Opr receiver, LIR_Opr result,
2311                       address dest, LIR_OprList* arguments, CodeEmitInfo* info) {
2312     append(new LIR_OpJavaCall(lir_icvirtual_call, method, receiver, result, dest, arguments, info));
2313   }
2314   void call_dynamic(ciMethod* method, LIR_Opr receiver, LIR_Opr result,
2315                     address dest, LIR_OprList* arguments, CodeEmitInfo* info) {
2316     append(new LIR_OpJavaCall(lir_dynamic_call, method, receiver, result, dest, arguments, info));
2317   }
2318 
2319   void get_thread(LIR_Opr result)                { append(new LIR_Op0(lir_get_thread, result)); }
2320   void membar()                                  { append(new LIR_Op0(lir_membar)); }
2321   void membar_acquire()                          { append(new LIR_Op0(lir_membar_acquire)); }
2322   void membar_release()                          { append(new LIR_Op0(lir_membar_release)); }
2323   void membar_loadload()                         { append(new LIR_Op0(lir_membar_loadload)); }
2324   void membar_storestore()                       { append(new LIR_Op0(lir_membar_storestore)); }
2325   void membar_loadstore()                        { append(new LIR_Op0(lir_membar_loadstore)); }
2326   void membar_storeload()                        { append(new LIR_Op0(lir_membar_storeload)); }
2327 
2328   void nop()                                     { append(new LIR_Op0(lir_nop)); }
2329 
2330   void std_entry(LIR_Opr receiver)               { append(new LIR_Op0(lir_std_entry, receiver)); }
2331   void osr_entry(LIR_Opr osrPointer)             { append(new LIR_Op0(lir_osr_entry, osrPointer)); }
2332 
2333   void on_spin_wait()                            { append(new LIR_Op0(lir_on_spin_wait)); }
2334 
2335   void branch_destination(Label* lbl)            { append(new LIR_OpLabel(lbl)); }
2336 
2337   void leal(LIR_Opr from, LIR_Opr result_reg, LIR_PatchCode patch_code = lir_patch_none, CodeEmitInfo* info = nullptr) { append(new LIR_Op1(lir_leal, from, result_reg, T_ILLEGAL, patch_code, info)); }
2338 
2339   // result is a stack location for old backend and vreg for UseLinearScan
2340   // stack_loc_temp is an illegal register for old backend
2341   void roundfp(LIR_Opr reg, LIR_Opr stack_loc_temp, LIR_Opr result) { append(new LIR_OpRoundFP(reg, stack_loc_temp, result)); }
2342   void move(LIR_Opr src, LIR_Opr dst, CodeEmitInfo* info = nullptr) { append(new LIR_Op1(lir_move, src, dst, dst->type(), lir_patch_none, info)); }
2343   void move(LIR_Address* src, LIR_Opr dst, CodeEmitInfo* info = nullptr) { append(new LIR_Op1(lir_move, LIR_OprFact::address(src), dst, src->type(), lir_patch_none, info)); }
2344   void move(LIR_Opr src, LIR_Address* dst, CodeEmitInfo* info = nullptr) { append(new LIR_Op1(lir_move, src, LIR_OprFact::address(dst), dst->type(), lir_patch_none, info)); }
2345   void move_wide(LIR_Address* src, LIR_Opr dst, CodeEmitInfo* info = nullptr) {
2346     if (UseCompressedOops) {
2347       append(new LIR_Op1(lir_move, LIR_OprFact::address(src), dst, src->type(), lir_patch_none, info, lir_move_wide));
2348     } else {
2349       move(src, dst, info);
2350     }
2351   }
2352   void move_wide(LIR_Opr src, LIR_Address* dst, CodeEmitInfo* info = nullptr) {
2353     if (UseCompressedOops) {
2354       append(new LIR_Op1(lir_move, src, LIR_OprFact::address(dst), dst->type(), lir_patch_none, info, lir_move_wide));
2355     } else {
2356       move(src, dst, info);
2357     }
2358   }
2359   void volatile_move(LIR_Opr src, LIR_Opr dst, BasicType type, CodeEmitInfo* info = nullptr, LIR_PatchCode patch_code = lir_patch_none) { append(new LIR_Op1(lir_move, src, dst, type, patch_code, info, lir_move_volatile)); }
2360 
2361   void oop2reg  (jobject o, LIR_Opr reg)         { assert(reg->type() == T_OBJECT, "bad reg"); append(new LIR_Op1(lir_move, LIR_OprFact::oopConst(o),    reg));   }
2362   void oop2reg_patch(jobject o, LIR_Opr reg, CodeEmitInfo* info);
2363 
2364   void metadata2reg  (Metadata* o, LIR_Opr reg)  { assert(reg->type() == T_METADATA, "bad reg"); append(new LIR_Op1(lir_move, LIR_OprFact::metadataConst(o), reg));   }
2365   void klass2reg_patch(Metadata* o, LIR_Opr reg, CodeEmitInfo* info);
2366 
2367   void safepoint(LIR_Opr tmp, CodeEmitInfo* info)  { append(new LIR_Op1(lir_safepoint, tmp, info)); }
2368   void return_op(LIR_Opr result)                   { append(new LIR_OpReturn(result)); }
2369 
2370   void convert(Bytecodes::Code code, LIR_Opr left, LIR_Opr dst, ConversionStub* stub = nullptr/*, bool is_32bit = false*/) { append(new LIR_OpConvert(code, left, dst, stub)); }
2371 
2372   void logical_and (LIR_Opr left, LIR_Opr right, LIR_Opr dst) { append(new LIR_Op2(lir_logic_and,  left, right, dst)); }
2373   void logical_or  (LIR_Opr left, LIR_Opr right, LIR_Opr dst) { append(new LIR_Op2(lir_logic_or,   left, right, dst)); }
2374   void logical_xor (LIR_Opr left, LIR_Opr right, LIR_Opr dst) { append(new LIR_Op2(lir_logic_xor,  left, right, dst)); }
2375 
2376   void null_check(LIR_Opr opr, CodeEmitInfo* info, bool deoptimize_on_null = false);
2377   void throw_exception(LIR_Opr exceptionPC, LIR_Opr exceptionOop, CodeEmitInfo* info) {
2378     append(new LIR_Op2(lir_throw, exceptionPC, exceptionOop, LIR_OprFact::illegalOpr, info));
2379   }
2380   void unwind_exception(LIR_Opr exceptionOop) {
2381     append(new LIR_Op1(lir_unwind, exceptionOop));
2382   }
2383 
2384   void push(LIR_Opr opr)                                   { append(new LIR_Op1(lir_push, opr)); }
2385   void pop(LIR_Opr reg)                                    { append(new LIR_Op1(lir_pop,  reg)); }
2386 
2387   void cmp(LIR_Condition condition, LIR_Opr left, LIR_Opr right, CodeEmitInfo* info = nullptr) {
2388     append(new LIR_Op2(lir_cmp, condition, left, right, info));
2389   }
2390   void cmp(LIR_Condition condition, LIR_Opr left, int right, CodeEmitInfo* info = nullptr) {
2391     cmp(condition, left, LIR_OprFact::intConst(right), info);
2392   }
2393 
2394   void cmp_mem_int(LIR_Condition condition, LIR_Opr base, int disp, int c, CodeEmitInfo* info);
2395   void cmp_reg_mem(LIR_Condition condition, LIR_Opr reg, LIR_Address* addr, CodeEmitInfo* info);
2396 
2397   void cmove(LIR_Condition condition, LIR_Opr src1, LIR_Opr src2, LIR_Opr dst, BasicType type,
2398              LIR_Opr cmp_opr1 = LIR_OprFact::illegalOpr, LIR_Opr cmp_opr2 = LIR_OprFact::illegalOpr) {
2399     append(new LIR_Op4(lir_cmove, condition, src1, src2, cmp_opr1, cmp_opr2, dst, type));
2400   }
2401 
2402   void cas_long(LIR_Opr addr, LIR_Opr cmp_value, LIR_Opr new_value,
2403                 LIR_Opr t1, LIR_Opr t2, LIR_Opr result = LIR_OprFact::illegalOpr);
2404   void cas_obj(LIR_Opr addr, LIR_Opr cmp_value, LIR_Opr new_value,
2405                LIR_Opr t1, LIR_Opr t2, LIR_Opr result = LIR_OprFact::illegalOpr);
2406   void cas_int(LIR_Opr addr, LIR_Opr cmp_value, LIR_Opr new_value,
2407                LIR_Opr t1, LIR_Opr t2, LIR_Opr result = LIR_OprFact::illegalOpr);
2408 
2409   void abs (LIR_Opr from, LIR_Opr to, LIR_Opr tmp)                { append(new LIR_Op2(lir_abs , from, tmp, to)); }
2410   void negate(LIR_Opr from, LIR_Opr to, LIR_Opr tmp = LIR_OprFact::illegalOpr)              { append(new LIR_Op2(lir_neg, from, tmp, to)); }
2411   void sqrt(LIR_Opr from, LIR_Opr to, LIR_Opr tmp)                { append(new LIR_Op2(lir_sqrt, from, tmp, to)); }
2412   void fmad(LIR_Opr from, LIR_Opr from1, LIR_Opr from2, LIR_Opr to) { append(new LIR_Op3(lir_fmad, from, from1, from2, to)); }
2413   void fmaf(LIR_Opr from, LIR_Opr from1, LIR_Opr from2, LIR_Opr to) { append(new LIR_Op3(lir_fmaf, from, from1, from2, to)); }
2414   void log10 (LIR_Opr from, LIR_Opr to, LIR_Opr tmp)              { append(new LIR_Op2(lir_log10, from, LIR_OprFact::illegalOpr, to, tmp)); }
2415   void tan (LIR_Opr from, LIR_Opr to, LIR_Opr tmp1, LIR_Opr tmp2) { append(new LIR_Op2(lir_tan , from, tmp1, to, tmp2)); }
2416   void f2hf(LIR_Opr from, LIR_Opr to, LIR_Opr tmp)                { append(new LIR_Op2(lir_f2hf, from, tmp, to)); }
2417   void hf2f(LIR_Opr from, LIR_Opr to, LIR_Opr tmp)                { append(new LIR_Op2(lir_hf2f, from, tmp, to)); }
2418 
2419   void add (LIR_Opr left, LIR_Opr right, LIR_Opr res)      { append(new LIR_Op2(lir_add, left, right, res)); }
2420   void sub (LIR_Opr left, LIR_Opr right, LIR_Opr res, CodeEmitInfo* info = nullptr) { append(new LIR_Op2(lir_sub, left, right, res, info)); }
2421   void mul (LIR_Opr left, LIR_Opr right, LIR_Opr res) { append(new LIR_Op2(lir_mul, left, right, res)); }
2422   void mul (LIR_Opr left, LIR_Opr right, LIR_Opr res, LIR_Opr tmp) { append(new LIR_Op2(lir_mul, left, right, res, tmp)); }
2423   void div (LIR_Opr left, LIR_Opr right, LIR_Opr res, CodeEmitInfo* info = nullptr)      { append(new LIR_Op2(lir_div, left, right, res, info)); }
2424   void div (LIR_Opr left, LIR_Opr right, LIR_Opr res, LIR_Opr tmp) { append(new LIR_Op2(lir_div, left, right, res, tmp)); }
2425   void rem (LIR_Opr left, LIR_Opr right, LIR_Opr res, CodeEmitInfo* info = nullptr)      { append(new LIR_Op2(lir_rem, left, right, res, info)); }
2426 
2427   void volatile_load_mem_reg(LIR_Address* address, LIR_Opr dst, CodeEmitInfo* info, LIR_PatchCode patch_code = lir_patch_none);
2428   void volatile_load_unsafe_reg(LIR_Opr base, LIR_Opr offset, LIR_Opr dst, BasicType type, CodeEmitInfo* info, LIR_PatchCode patch_code);
2429 
2430   void load(LIR_Address* addr, LIR_Opr src, CodeEmitInfo* info = nullptr, LIR_PatchCode patch_code = lir_patch_none);
2431 
2432   void store_mem_int(jint v,    LIR_Opr base, int offset_in_bytes, BasicType type, CodeEmitInfo* info, LIR_PatchCode patch_code = lir_patch_none);
2433   void store_mem_oop(jobject o, LIR_Opr base, int offset_in_bytes, BasicType type, CodeEmitInfo* info, LIR_PatchCode patch_code = lir_patch_none);
2434   void store(LIR_Opr src, LIR_Address* addr, CodeEmitInfo* info = nullptr, LIR_PatchCode patch_code = lir_patch_none);
2435   void volatile_store_mem_reg(LIR_Opr src, LIR_Address* address, CodeEmitInfo* info, LIR_PatchCode patch_code = lir_patch_none);
2436   void volatile_store_unsafe_reg(LIR_Opr src, LIR_Opr base, LIR_Opr offset, BasicType type, CodeEmitInfo* info, LIR_PatchCode patch_code);
2437 
2438   void idiv(LIR_Opr left, LIR_Opr right, LIR_Opr res, LIR_Opr tmp, CodeEmitInfo* info);
2439   void idiv(LIR_Opr left, int   right, LIR_Opr res, LIR_Opr tmp, CodeEmitInfo* info);
2440   void irem(LIR_Opr left, LIR_Opr right, LIR_Opr res, LIR_Opr tmp, CodeEmitInfo* info);
2441   void irem(LIR_Opr left, int   right, LIR_Opr res, LIR_Opr tmp, CodeEmitInfo* info);
2442 
2443   void allocate_object(LIR_Opr dst, LIR_Opr t1, LIR_Opr t2, LIR_Opr t3, LIR_Opr t4, int header_size, int object_size, LIR_Opr klass, bool init_check, CodeStub* stub);
2444   void allocate_array(LIR_Opr dst, LIR_Opr len, LIR_Opr t1,LIR_Opr t2, LIR_Opr t3,LIR_Opr t4, BasicType type, LIR_Opr klass, CodeStub* stub, bool is_null_free);
2445 
2446   // jump is an unconditional branch
2447   void jump(BlockBegin* block) {
2448     append(new LIR_OpBranch(lir_cond_always, block));
2449   }
2450   void jump(CodeStub* stub) {
2451     append(new LIR_OpBranch(lir_cond_always, stub));
2452   }
2453   void branch(LIR_Condition cond, Label* lbl) {
2454     append(new LIR_OpBranch(cond, lbl));
2455   }
2456   // Should not be used for fp comparisons
2457   void branch(LIR_Condition cond, BlockBegin* block) {
2458     append(new LIR_OpBranch(cond, block));
2459   }
2460   // Should not be used for fp comparisons
2461   void branch(LIR_Condition cond, CodeStub* stub) {
2462     append(new LIR_OpBranch(cond, stub));
2463   }
2464   // Should only be used for fp comparisons
2465   void branch(LIR_Condition cond, BlockBegin* block, BlockBegin* unordered) {
2466     append(new LIR_OpBranch(cond, block, unordered));
2467   }
2468 
2469   void shift_left(LIR_Opr value, LIR_Opr count, LIR_Opr dst, LIR_Opr tmp);
2470   void shift_right(LIR_Opr value, LIR_Opr count, LIR_Opr dst, LIR_Opr tmp);
2471   void unsigned_shift_right(LIR_Opr value, LIR_Opr count, LIR_Opr dst, LIR_Opr tmp);
2472 
2473   void shift_left(LIR_Opr value, int count, LIR_Opr dst)       { shift_left(value, LIR_OprFact::intConst(count), dst, LIR_OprFact::illegalOpr); }
2474   void shift_right(LIR_Opr value, int count, LIR_Opr dst)      { shift_right(value, LIR_OprFact::intConst(count), dst, LIR_OprFact::illegalOpr); }
2475   void unsigned_shift_right(LIR_Opr value, int count, LIR_Opr dst) { unsigned_shift_right(value, LIR_OprFact::intConst(count), dst, LIR_OprFact::illegalOpr); }
2476 
2477   void lcmp2int(LIR_Opr left, LIR_Opr right, LIR_Opr dst)        { append(new LIR_Op2(lir_cmp_l2i,  left, right, dst)); }
2478   void fcmp2int(LIR_Opr left, LIR_Opr right, LIR_Opr dst, bool is_unordered_less);
2479 
2480   void call_runtime_leaf(address routine, LIR_Opr tmp, LIR_Opr result, LIR_OprList* arguments) {
2481     append(new LIR_OpRTCall(routine, tmp, result, arguments));
2482   }
2483 
2484   void call_runtime(address routine, LIR_Opr tmp, LIR_Opr result,
2485                     LIR_OprList* arguments, CodeEmitInfo* info) {
2486     append(new LIR_OpRTCall(routine, tmp, result, arguments, info));
2487   }
2488 
2489   void load_stack_address_monitor(int monitor_ix, LIR_Opr dst)  { append(new LIR_Op1(lir_monaddr, LIR_OprFact::intConst(monitor_ix), dst)); }
2490   void unlock_object(LIR_Opr hdr, LIR_Opr obj, LIR_Opr lock, LIR_Opr scratch, CodeStub* stub);
2491   void lock_object(LIR_Opr hdr, LIR_Opr obj, LIR_Opr lock, LIR_Opr scratch, CodeStub* stub, CodeEmitInfo* info, CodeStub* throw_ie_stub=nullptr);
2492 
2493   void breakpoint()                                                  { append(new LIR_Op0(lir_breakpoint)); }
2494 
2495   void arraycopy(LIR_Opr src, LIR_Opr src_pos, LIR_Opr dst, LIR_Opr dst_pos, LIR_Opr length, LIR_Opr tmp, ciArrayKlass* expected_type, int flags, CodeEmitInfo* info) { append(new LIR_OpArrayCopy(src, src_pos, dst, dst_pos, length, tmp, expected_type, flags, info)); }
2496 
2497   void update_crc32(LIR_Opr crc, LIR_Opr val, LIR_Opr res)  { append(new LIR_OpUpdateCRC32(crc, val, res)); }
2498 
2499   void instanceof(LIR_Opr result, LIR_Opr object, ciKlass* klass, LIR_Opr tmp1, LIR_Opr tmp2, LIR_Opr tmp3, bool fast_check, CodeEmitInfo* info_for_patch, ciMethod* profiled_method, int profiled_bci);
2500   void store_check(LIR_Opr object, LIR_Opr array, LIR_Opr tmp1, LIR_Opr tmp2, LIR_Opr tmp3, CodeEmitInfo* info_for_exception, ciMethod* profiled_method, int profiled_bci);
2501   void check_flat_array(LIR_Opr array, LIR_Opr value, LIR_Opr tmp, CodeStub* stub);
2502   void check_null_free_array(LIR_Opr array, LIR_Opr tmp);
2503   void substitutability_check(LIR_Opr result, LIR_Opr left, LIR_Opr right, LIR_Opr equal_result, LIR_Opr not_equal_result,
2504                               LIR_Opr tmp1, LIR_Opr tmp2,
2505                               ciKlass* left_klass, ciKlass* right_klass, LIR_Opr left_klass_op, LIR_Opr right_klass_op,
2506                               CodeEmitInfo* info, CodeStub* stub);
2507 
2508   void checkcast (LIR_Opr result, LIR_Opr object, ciKlass* klass,
2509                   LIR_Opr tmp1, LIR_Opr tmp2, LIR_Opr tmp3, bool fast_check,
2510                   CodeEmitInfo* info_for_exception, CodeEmitInfo* info_for_patch, CodeStub* stub,
2511                   ciMethod* profiled_method, int profiled_bci, bool is_null_free);
2512   // MethodData* profiling
2513   void profile_call(ciMethod* method, int bci, ciMethod* callee, LIR_Opr mdo, LIR_Opr recv, LIR_Opr t1, ciKlass* cha_klass) {
2514     append(new LIR_OpProfileCall(method, bci, callee, mdo, recv, t1, cha_klass));
2515   }
2516   void profile_type(LIR_Address* mdp, LIR_Opr obj, ciKlass* exact_klass, intptr_t current_klass, LIR_Opr tmp, bool not_null, bool no_conflict) {
2517     append(new LIR_OpProfileType(LIR_OprFact::address(mdp), obj, exact_klass, current_klass, tmp, not_null, no_conflict));
2518   }
2519   void profile_inline_type(LIR_Address* mdp, LIR_Opr obj, int flag, LIR_Opr tmp, bool not_null) {
2520     append(new LIR_OpProfileInlineType(LIR_OprFact::address(mdp), obj, flag, tmp, not_null));
2521   }
2522 
2523   void xadd(LIR_Opr src, LIR_Opr add, LIR_Opr res, LIR_Opr tmp) { append(new LIR_Op2(lir_xadd, src, add, res, tmp)); }
2524   void xchg(LIR_Opr src, LIR_Opr set, LIR_Opr res, LIR_Opr tmp) { append(new LIR_Op2(lir_xchg, src, set, res, tmp)); }
2525 
2526   void load_klass(LIR_Opr obj, LIR_Opr result, CodeEmitInfo* info) { append(new LIR_OpLoadKlass(obj, result, info)); }
2527 
2528 #ifdef ASSERT
2529   void lir_assert(LIR_Condition condition, LIR_Opr opr1, LIR_Opr opr2, const char* msg, bool halt) { append(new LIR_OpAssert(condition, opr1, opr2, msg, halt)); }
2530 #endif
2531 };
2532 
2533 void print_LIR(BlockList* blocks);
2534 
2535 class LIR_InsertionBuffer : public CompilationResourceObj {
2536  private:
2537   LIR_List*   _lir;   // the lir list where ops of this buffer should be inserted later (null when uninitialized)
2538 
2539   // list of insertion points. index and count are stored alternately:
2540   // _index_and_count[i * 2]:     the index into lir list where "count" ops should be inserted
2541   // _index_and_count[i * 2 + 1]: the number of ops to be inserted at index
2542   intStack    _index_and_count;
2543 
2544   // the LIR_Ops to be inserted
2545   LIR_OpList  _ops;
2546 
2547   void append_new(int index, int count)  { _index_and_count.append(index); _index_and_count.append(count); }
2548   void set_index_at(int i, int value)    { _index_and_count.at_put((i << 1),     value); }
2549   void set_count_at(int i, int value)    { _index_and_count.at_put((i << 1) + 1, value); }
2550 
2551 #ifdef ASSERT
2552   void verify();
2553 #endif
2554  public:
2555   LIR_InsertionBuffer() : _lir(nullptr), _index_and_count(8), _ops(8) { }
2556 
2557   // must be called before using the insertion buffer
2558   void init(LIR_List* lir)  { assert(!initialized(), "already initialized"); _lir = lir; _index_and_count.clear(); _ops.clear(); }
2559   bool initialized() const  { return _lir != nullptr; }
2560   // called automatically when the buffer is appended to the LIR_List
2561   void finish()             { _lir = nullptr; }
2562 
2563   // accessors
2564   LIR_List*  lir_list() const             { return _lir; }
2565   int number_of_insertion_points() const  { return _index_and_count.length() >> 1; }
2566   int index_at(int i) const               { return _index_and_count.at((i << 1));     }
2567   int count_at(int i) const               { return _index_and_count.at((i << 1) + 1); }
2568 
2569   int number_of_ops() const               { return _ops.length(); }
2570   LIR_Op* op_at(int i) const              { return _ops.at(i); }
2571 
2572   // append an instruction to the buffer
2573   void append(int index, LIR_Op* op);
2574 
2575   // instruction
2576   void move(int index, LIR_Opr src, LIR_Opr dst, CodeEmitInfo* info = nullptr) { append(index, new LIR_Op1(lir_move, src, dst, dst->type(), lir_patch_none, info)); }
2577 };
2578 
2579 
2580 //
2581 // LIR_OpVisitState is used for manipulating LIR_Ops in an abstract way.
2582 // Calling a LIR_Op's visit function with a LIR_OpVisitState causes
2583 // information about the input, output and temporaries used by the
2584 // op to be recorded.  It also records whether the op has call semantics
2585 // and also records all the CodeEmitInfos used by this op.
2586 //
2587 
2588 
2589 class LIR_OpVisitState: public StackObj {
2590  public:
2591   typedef enum { inputMode, firstMode = inputMode, tempMode, outputMode, numModes, invalidMode = -1 } OprMode;
2592 
2593   enum {
2594     maxNumberOfOperands = 21,
2595     maxNumberOfInfos = 4
2596   };
2597 
2598  private:
2599   LIR_Op*          _op;
2600 
2601   // optimization: the operands and infos are not stored in a variable-length
2602   //               list, but in a fixed-size array to save time of size checks and resizing
2603   int              _oprs_len[numModes];
2604   LIR_Opr*         _oprs_new[numModes][maxNumberOfOperands];
2605   int _info_len;
2606   CodeEmitInfo*    _info_new[maxNumberOfInfos];
2607 
2608   bool             _has_call;
2609   bool             _has_slow_case;
2610 
2611 
2612   // only include register operands
2613   // addresses are decomposed to the base and index registers
2614   // constants and stack operands are ignored
2615   void append(LIR_Opr& opr, OprMode mode) {
2616     assert(opr->is_valid(), "should not call this otherwise");
2617     assert(mode >= 0 && mode < numModes, "bad mode");
2618 
2619     if (opr->is_register()) {
2620        assert(_oprs_len[mode] < maxNumberOfOperands, "array overflow");
2621       _oprs_new[mode][_oprs_len[mode]++] = &opr;
2622 
2623     } else if (opr->is_pointer()) {
2624       LIR_Address* address = opr->as_address_ptr();
2625       if (address != nullptr) {
2626         // special handling for addresses: add base and index register of the address
2627         // both are always input operands or temp if we want to extend
2628         // their liveness!
2629         if (mode == outputMode) {
2630           mode = inputMode;
2631         }
2632         assert (mode == inputMode || mode == tempMode, "input or temp only for addresses");
2633         if (address->_base->is_valid()) {
2634           assert(address->_base->is_register(), "must be");
2635           assert(_oprs_len[mode] < maxNumberOfOperands, "array overflow");
2636           _oprs_new[mode][_oprs_len[mode]++] = &address->_base;
2637         }
2638         if (address->_index->is_valid()) {
2639           assert(address->_index->is_register(), "must be");
2640           assert(_oprs_len[mode] < maxNumberOfOperands, "array overflow");
2641           _oprs_new[mode][_oprs_len[mode]++] = &address->_index;
2642         }
2643 
2644       } else {
2645         assert(opr->is_constant(), "constant operands are not processed");
2646       }
2647     } else {
2648       assert(opr->is_stack(), "stack operands are not processed");
2649     }
2650   }
2651 
2652   void append(CodeEmitInfo* info) {
2653     assert(info != nullptr, "should not call this otherwise");
2654     assert(_info_len < maxNumberOfInfos, "array overflow");
2655     _info_new[_info_len++] = info;
2656   }
2657 
2658  public:
2659   LIR_OpVisitState()         { reset(); }
2660 
2661   LIR_Op* op() const         { return _op; }
2662   void set_op(LIR_Op* op)    { reset(); _op = op; }
2663 
2664   bool has_call() const      { return _has_call; }
2665   bool has_slow_case() const { return _has_slow_case; }
2666 
2667   void reset() {
2668     _op = nullptr;
2669     _has_call = false;
2670     _has_slow_case = false;
2671 
2672     _oprs_len[inputMode] = 0;
2673     _oprs_len[tempMode] = 0;
2674     _oprs_len[outputMode] = 0;
2675     _info_len = 0;
2676   }
2677 
2678 
2679   int opr_count(OprMode mode) const {
2680     assert(mode >= 0 && mode < numModes, "bad mode");
2681     return _oprs_len[mode];
2682   }
2683 
2684   LIR_Opr opr_at(OprMode mode, int index) const {
2685     assert(mode >= 0 && mode < numModes, "bad mode");
2686     assert(index >= 0 && index < _oprs_len[mode], "index out of bound");
2687     return *_oprs_new[mode][index];
2688   }
2689 
2690   void set_opr_at(OprMode mode, int index, LIR_Opr opr) const {
2691     assert(mode >= 0 && mode < numModes, "bad mode");
2692     assert(index >= 0 && index < _oprs_len[mode], "index out of bound");
2693     *_oprs_new[mode][index] = opr;
2694   }
2695 
2696   int info_count() const {
2697     return _info_len;
2698   }
2699 
2700   CodeEmitInfo* info_at(int index) const {
2701     assert(index < _info_len, "index out of bounds");
2702     return _info_new[index];
2703   }
2704 
2705   XHandlers* all_xhandler();
2706 
2707   // collects all register operands of the instruction
2708   void visit(LIR_Op* op);
2709 
2710 #ifdef ASSERT
2711   // check that an operation has no operands
2712   bool no_operands(LIR_Op* op);
2713 #endif
2714 
2715   // LIR_Op visitor functions use these to fill in the state
2716   void do_input(LIR_Opr& opr)             { append(opr, LIR_OpVisitState::inputMode); }
2717   void do_output(LIR_Opr& opr)            { append(opr, LIR_OpVisitState::outputMode); }
2718   void do_temp(LIR_Opr& opr)              { append(opr, LIR_OpVisitState::tempMode); }
2719   void do_info(CodeEmitInfo* info)        { append(info); }
2720 
2721   void do_stub(CodeStub* stub);
2722   void do_call()                          { _has_call = true; }
2723   void do_slow_case()                     { _has_slow_case = true; }
2724   void do_slow_case(CodeEmitInfo* info) {
2725     _has_slow_case = true;
2726     append(info);
2727   }
2728 };
2729 
2730 
2731 inline LIR_Opr LIR_Opr::illegalOpr()   { return LIR_OprFact::illegalOpr; };
2732 
2733 inline LIR_Opr LIR_Opr::nullOpr()   { return LIR_OprFact::nullOpr; };
2734 
2735 #endif // SHARE_C1_C1_LIR_HPP