1 /*
   2  * Copyright (c) 2010, 2018, 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 package org.graalvm.compiler.lir;
  26 
  27 import jdk.vm.ci.code.RegisterValue;
  28 import jdk.vm.ci.code.StackSlot;
  29 import jdk.vm.ci.meta.AllocatableValue;
  30 import jdk.vm.ci.meta.ValueKind;
  31 
  32 /**
  33  * Represents a value that is yet to be bound to a machine location (such as a {@link RegisterValue}
  34  * or {@link StackSlot}) by a register allocator.
  35  */
  36 public class Variable extends AllocatableValue {
  37 
  38     /**
  39      * The identifier of the variable. This is a non-zero index in a contiguous 0-based name space.
  40      */
  41     public final int index;
  42 
  43     private String name;
  44 
  45     /**
  46      * Creates a new variable.
  47      *
  48      * @param kind
  49      * @param index
  50      */
  51     public Variable(ValueKind<?> kind, int index) {
  52         super(kind);
  53         assert index >= 0;
  54         this.index = index;
  55     }
  56 
  57     public void setName(String name) {
  58         this.name = name;
  59     }
  60 
  61     public String getName() {
  62         return name;
  63     }
  64 
  65     @Override
  66     public String toString() {
  67         if (name != null) {
  68             return name;
  69         } else {
  70             return "v" + index + getKindSuffix();
  71         }
  72     }
  73 
  74     @Override
  75     public int hashCode() {
  76         return 71 * super.hashCode() + index;
  77     }
  78 
  79     @Override
  80     public boolean equals(Object obj) {
  81         if (obj instanceof Variable) {
  82             Variable other = (Variable) obj;
  83             return super.equals(other) && index == other.index;
  84         }
  85         return false;
  86     }
  87 }