[turbofan] Make AllocatedOperand an InstructionOperand::Kind.

src/compiler/instruction.h

 // Copyright 2014 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef V8_COMPILER_INSTRUCTION_H_
 #define V8_COMPILER_INSTRUCTION_H_
 
 #include <deque>
 #include <iosfwd>
 #include <map>
 #include <set>
 
 #include "src/compiler/common-operator.h"
 #include "src/compiler/frame.h"
 #include "src/compiler/instruction-codes.h"
 #include "src/compiler/opcodes.h"
 #include "src/compiler/register-configuration.h"
 #include "src/compiler/source-position.h"
 #include "src/zone-allocator.h"
 
 namespace v8 {
 namespace internal {
 namespace compiler {
 
 class Schedule;
 
 // A couple of reserved opcodes are used for internal use.
 const InstructionCode kSourcePositionInstruction = -1;
 
-#define ALLOCATED_OPERAND_LIST(V)       \
-  V(StackSlot, STACK_SLOT)              \
-  V(DoubleStackSlot, DOUBLE_STACK_SLOT) \
-  V(Register, REGISTER)                 \
-  V(DoubleRegister, DOUBLE_REGISTER)
-
 class InstructionOperand {
  public:
   static const int kInvalidVirtualRegister = -1;
 
-  enum Kind {
-    INVALID,
-    UNALLOCATED,
-    CONSTANT,
-    IMMEDIATE,
-    STACK_SLOT,
-    DOUBLE_STACK_SLOT,
-    REGISTER,
-    DOUBLE_REGISTER
-  };
+  // TODO(dcarney): recover bit. INVALID can be represented as UNALLOCATED with
+  // kInvalidVirtualRegister and some DCHECKS.
+  enum Kind { INVALID, UNALLOCATED, CONSTANT, IMMEDIATE, ALLOCATED };
 
   InstructionOperand()
       : InstructionOperand(INVALID, 0, kInvalidVirtualRegister) {}
 
   Kind kind() const { return KindField::decode(value_); }
 
 #define INSTRUCTION_OPERAND_PREDICATE(name, type) \
   bool Is##name() const { return kind() == type; }
-  ALLOCATED_OPERAND_LIST(INSTRUCTION_OPERAND_PREDICATE)
+  INSTRUCTION_OPERAND_PREDICATE(Invalid, INVALID)
+  INSTRUCTION_OPERAND_PREDICATE(Unallocated, UNALLOCATED)
   INSTRUCTION_OPERAND_PREDICATE(Constant, CONSTANT)
   INSTRUCTION_OPERAND_PREDICATE(Immediate, IMMEDIATE)
-  INSTRUCTION_OPERAND_PREDICATE(Unallocated, UNALLOCATED)
-  INSTRUCTION_OPERAND_PREDICATE(Invalid, INVALID)
+  INSTRUCTION_OPERAND_PREDICATE(Allocated, ALLOCATED)
 #undef INSTRUCTION_OPERAND_PREDICATE
 
+  inline bool IsRegister() const;
+  inline bool IsDoubleRegister() const;
+  inline bool IsStackSlot() const;
+  inline bool IsDoubleStackSlot() const;
+
   bool Equals(const InstructionOperand* other) const {
     return value_ == other->value_;
   }
 
   // Useful for map/set keys.
   bool operator<(const InstructionOperand& op) const {
     return value_ < op.value_;
   }
 
   template <typename SubKindOperand>
   static SubKindOperand* New(Zone* zone, const SubKindOperand& op) {
     void* buffer = zone->New(sizeof(op));
     return new (buffer) SubKindOperand(op);
   }
 
   static void ReplaceWith(InstructionOperand* dest,
                           const InstructionOperand* src) {
     *dest = *src;
   }
 
  protected:
   InstructionOperand(Kind kind, int index, int virtual_register) {
-    if (kind == REGISTER || kind == DOUBLE_REGISTER) DCHECK(index >= 0);
     if (kind != UNALLOCATED && kind != CONSTANT) {
       DCHECK(virtual_register == kInvalidVirtualRegister);
     }
     value_ = KindField::encode(kind);
     value_ |=
         VirtualRegisterField::encode(static_cast<uint32_t>(virtual_register));
     value_ |= static_cast<int64_t>(index) << IndexField::kShift;
   }
 
   typedef BitField64<Kind, 0, 3> KindField;
   typedef BitField64<uint32_t, 3, 32> VirtualRegisterField;
   typedef BitField64<int32_t, 35, 29> IndexField;
 
   uint64_t value_;
 };
 
 struct PrintableInstructionOperand {
   const RegisterConfiguration* register_configuration_;
   const InstructionOperand* op_;
 };
 
 std::ostream& operator<<(std::ostream& os,
                          const PrintableInstructionOperand& op);
 
+#define INSTRUCTION_OPERAND_CASTS(OperandType, OperandKind)      \
+                                                                 \
+  static OperandType* cast(InstructionOperand* op) {             \
+    DCHECK_EQ(OperandKind, op->kind());                          \
+    return static_cast<OperandType*>(op);                        \
+  }                                                              \
+                                                                 \
+  static const OperandType* cast(const InstructionOperand* op) { \
+    DCHECK_EQ(OperandKind, op->kind());                          \
+    return static_cast<const OperandType*>(op);                  \
+  }                                                              \
+                                                                 \
+  static OperandType cast(const InstructionOperand& op) {        \
+    DCHECK_EQ(OperandKind, op.kind());                           \
+    return *static_cast<const OperandType*>(&op);                \
+  }
+
 class UnallocatedOperand : public InstructionOperand {
  public:
   enum BasicPolicy { FIXED_SLOT, EXTENDED_POLICY };
 
   enum ExtendedPolicy {
     NONE,
     ANY,
     FIXED_REGISTER,
     FIXED_DOUBLE_REGISTER,
     MUST_HAVE_REGISTER,
@@ skipping 46 matching lines @@
     value_ |= ExtendedPolicyField::encode(policy);
     value_ |= LifetimeField::encode(lifetime);
   }
 
   UnallocatedOperand* Copy(Zone* zone) { return New(zone, *this); }
 
   UnallocatedOperand* CopyUnconstrained(Zone* zone) {
     return New(zone, UnallocatedOperand(ANY, virtual_register()));
   }
 
-  static const UnallocatedOperand* cast(const InstructionOperand* op) {
-    DCHECK(op->IsUnallocated());
-    return static_cast<const UnallocatedOperand*>(op);
-  }
-
-  static UnallocatedOperand* cast(InstructionOperand* op) {
-    DCHECK(op->IsUnallocated());
-    return static_cast<UnallocatedOperand*>(op);
-  }
-
-  static UnallocatedOperand cast(const InstructionOperand& op) {
-    DCHECK(op.IsUnallocated());
-    return *static_cast<const UnallocatedOperand*>(&op);
-  }
-
   // The encoding used for UnallocatedOperand operands depends on the policy
   // that is
   // stored within the operand. The FIXED_SLOT policy uses a compact encoding
   // because it accommodates a larger pay-load.
   //
   // For FIXED_SLOT policy:
   //     +------------------------------------------------+
   //     |      slot_index   | 0 | virtual_register | 001 |
   //     +------------------------------------------------+
   //
@@ skipping 87 matching lines @@
   void set_virtual_register(int32_t id) {
     DCHECK_EQ(UNALLOCATED, kind());
     value_ = VirtualRegisterField::update(value_, static_cast<uint32_t>(id));
   }
 
   // [lifetime]: Only for non-FIXED_SLOT.
   bool IsUsedAtStart() const {
     DCHECK(basic_policy() == EXTENDED_POLICY);
     return LifetimeField::decode(value_) == USED_AT_START;
   }
+
+  INSTRUCTION_OPERAND_CASTS(UnallocatedOperand, UNALLOCATED);
 };
 
 
 class ConstantOperand : public InstructionOperand {
  public:
   explicit ConstantOperand(int virtual_register)
       : InstructionOperand(CONSTANT, 0, virtual_register) {}
 
   int32_t virtual_register() const {
     return static_cast<int32_t>(VirtualRegisterField::decode(value_));
   }
 
   static ConstantOperand* New(Zone* zone, int virtual_register) {
     return InstructionOperand::New(zone, ConstantOperand(virtual_register));
   }
 
-  static ConstantOperand* cast(InstructionOperand* op) {
-    DCHECK(op->kind() == CONSTANT);
-    return static_cast<ConstantOperand*>(op);
-  }
-
-  static const ConstantOperand* cast(const InstructionOperand* op) {
-    DCHECK(op->kind() == CONSTANT);
-    return static_cast<const ConstantOperand*>(op);
-  }
-
-  static ConstantOperand cast(const InstructionOperand& op) {
-    DCHECK(op.kind() == CONSTANT);
-    return *static_cast<const ConstantOperand*>(&op);
-  }
+  INSTRUCTION_OPERAND_CASTS(ConstantOperand, CONSTANT);
 };
 
 
 class ImmediateOperand : public InstructionOperand {
  public:
   explicit ImmediateOperand(int index)
       : InstructionOperand(IMMEDIATE, index, kInvalidVirtualRegister) {}
 
   int index() const {
     return static_cast<int64_t>(value_) >> IndexField::kShift;
   }
 
   static ImmediateOperand* New(Zone* zone, int index) {
     return InstructionOperand::New(zone, ImmediateOperand(index));
   }
 
-  static ImmediateOperand* cast(InstructionOperand* op) {
-    DCHECK(op->kind() == IMMEDIATE);
-    return static_cast<ImmediateOperand*>(op);
-  }
-
-  static const ImmediateOperand* cast(const InstructionOperand* op) {
-    DCHECK(op->kind() == IMMEDIATE);
-    return static_cast<const ImmediateOperand*>(op);
-  }
-
-  static ImmediateOperand cast(const InstructionOperand& op) {
-    DCHECK(op.kind() == IMMEDIATE);
-    return *static_cast<const ImmediateOperand*>(&op);
-  }
+  INSTRUCTION_OPERAND_CASTS(ImmediateOperand, IMMEDIATE);
 };
 
 
 class AllocatedOperand : public InstructionOperand {
-#define ALLOCATED_OPERAND_CHECK(Name, Kind) || kind == Kind
-#define CHECK_ALLOCATED_KIND()                                   \
-  DCHECK(false ALLOCATED_OPERAND_LIST(ALLOCATED_OPERAND_CHECK)); \
-  USE(kind);
+ public:
+  enum AllocatedKind {
+    STACK_SLOT,
+    DOUBLE_STACK_SLOT,
+    REGISTER,
+    DOUBLE_REGISTER
+  };
 
- public:
+  AllocatedOperand(AllocatedKind kind, int index)
+      : InstructionOperand(ALLOCATED, index, kInvalidVirtualRegister) {
+    if (kind == REGISTER || kind == DOUBLE_REGISTER) DCHECK(index >= 0);
+    value_ = AllocatedKindField::update(value_, kind);
+  }
+
   int index() const {
     return static_cast<int64_t>(value_) >> IndexField::kShift;
   }
 
-  AllocatedOperand(Kind kind, int index)
-      : InstructionOperand(kind, index, kInvalidVirtualRegister) {
-    CHECK_ALLOCATED_KIND();
+  AllocatedKind allocated_kind() const {
+    return AllocatedKindField::decode(value_);
   }
 
-  static AllocatedOperand* New(Zone* zone, Kind kind, int index) {
+  static AllocatedOperand* New(Zone* zone, AllocatedKind kind, int index) {
     return InstructionOperand::New(zone, AllocatedOperand(kind, index));
   }
 
-  static AllocatedOperand* cast(InstructionOperand* op) {
-    Kind kind = op->kind();
-    CHECK_ALLOCATED_KIND();
-    return static_cast<AllocatedOperand*>(op);
-  }
+  INSTRUCTION_OPERAND_CASTS(AllocatedOperand, ALLOCATED);
 
-  static const AllocatedOperand* cast(const InstructionOperand* op) {
-    Kind kind = op->kind();
-    CHECK_ALLOCATED_KIND();
-    return static_cast<const AllocatedOperand*>(op);
-  }
-
-  static AllocatedOperand cast(const InstructionOperand& op) {
-    Kind kind = op.kind();
-    CHECK_ALLOCATED_KIND();
-    return *static_cast<const AllocatedOperand*>(&op);
-  }
-
-#undef CHECK_ALLOCATED_KIND
-#undef ALLOCATED_OPERAND_CAST_CHECK
+ private:
+  typedef BitField64<AllocatedKind, 3, 2> AllocatedKindField;
 };
 
 
-#define INSTRUCTION_SUBKIND_OPERAND_CLASS(SubKind, kOperandKind)        \
-  class SubKind##Operand FINAL : public AllocatedOperand {              \
-   public:                                                              \
-    explicit SubKind##Operand(int index)                                \
-        : AllocatedOperand(kOperandKind, index) {}                      \
-                                                                        \
-    static SubKind##Operand* New(Zone* zone, int index) {               \
-      return InstructionOperand::New(zone, SubKind##Operand(index));    \
-    }                                                                   \
-                                                                        \
-    static SubKind##Operand* cast(InstructionOperand* op) {             \
-      DCHECK(op->kind() == kOperandKind);                               \
-      return reinterpret_cast<SubKind##Operand*>(op);                   \
-    }                                                                   \
-                                                                        \
-    static const SubKind##Operand* cast(const InstructionOperand* op) { \
-      DCHECK(op->kind() == kOperandKind);                               \
-      return reinterpret_cast<const SubKind##Operand*>(op);             \
-    }                                                                   \
-                                                                        \
-    static SubKind##Operand cast(const InstructionOperand& op) {        \
-      DCHECK(op.kind() == kOperandKind);                                \
-      return *static_cast<const SubKind##Operand*>(&op);                \
-    }                                                                   \
+#undef INSTRUCTION_OPERAND_CASTS
+
+
+#define ALLOCATED_OPERAND_LIST(V)       \
+  V(StackSlot, STACK_SLOT)              \
+  V(DoubleStackSlot, DOUBLE_STACK_SLOT) \
+  V(Register, REGISTER)                 \
+  V(DoubleRegister, DOUBLE_REGISTER)
+
+
+#define ALLOCATED_OPERAND_IS(SubKind, kOperandKind)          \
+  bool InstructionOperand::Is##SubKind() const {             \
+    return IsAllocated() &&                                  \
+           AllocatedOperand::cast(this)->allocated_kind() == \
+               AllocatedOperand::kOperandKind;               \
+  }
+ALLOCATED_OPERAND_LIST(ALLOCATED_OPERAND_IS)
+#undef ALLOCATED_OPERAND_IS
+
+
+#define ALLOCATED_OPERAND_CLASS(SubKind, kOperandKind)                       \
+  class SubKind##Operand FINAL : public AllocatedOperand {                   \
+   public:                                                                   \
+    explicit SubKind##Operand(int index)                                     \
+        : AllocatedOperand(kOperandKind, index) {}                           \
+                                                                             \
+    static SubKind##Operand* New(Zone* zone, int index) {                    \
+      return InstructionOperand::New(zone, SubKind##Operand(index));         \
+    }                                                                        \
+                                                                             \
+    static SubKind##Operand* cast(InstructionOperand* op) {                  \
+      DCHECK_EQ(kOperandKind, AllocatedOperand::cast(op)->allocated_kind()); \
+      return reinterpret_cast<SubKind##Operand*>(op);                        \
+    }                                                                        \
+                                                                             \
+    static const SubKind##Operand* cast(const InstructionOperand* op) {      \
+      DCHECK_EQ(kOperandKind, AllocatedOperand::cast(op)->allocated_kind()); \
+      return reinterpret_cast<const SubKind##Operand*>(op);                  \
+    }                                                                        \
+                                                                             \
+    static SubKind##Operand cast(const InstructionOperand& op) {             \
+      DCHECK_EQ(kOperandKind, AllocatedOperand::cast(op).allocated_kind());  \
+      return *static_cast<const SubKind##Operand*>(&op);                     \
+    }                                                                        \
   };
-ALLOCATED_OPERAND_LIST(INSTRUCTION_SUBKIND_OPERAND_CLASS)
-#undef INSTRUCTION_SUBKIND_OPERAND_CLASS
+ALLOCATED_OPERAND_LIST(ALLOCATED_OPERAND_CLASS)
+#undef ALLOCATED_OPERAND_CLASS
 
 
 class MoveOperands FINAL {
  public:
   MoveOperands(InstructionOperand* source, InstructionOperand* destination)
       : source_(source), destination_(destination) {}
 
   InstructionOperand* source() const { return source_; }
   void set_source(InstructionOperand* operand) { source_ = operand; }
 
@@ skipping 691 matching lines @@
 
 
 std::ostream& operator<<(std::ostream& os,
                          const PrintableInstructionSequence& code);
 
 }  // namespace compiler
 }  // namespace internal
 }  // namespace v8
 
 #endif  // V8_COMPILER_INSTRUCTION_H_