1 /*
   2  * Copyright (c) 2013, 2015, 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 package jdk.vm.ci.meta;
  24 
  25 /**
  26  * Represents a platform-specific low-level type for values.
  27  */
  28 public interface PlatformKind {
  29 
  30     String name();
  31 
  32     public interface Key {
  33 
  34     }
  35 
  36     class EnumKey<E extends Enum<E>> implements Key {
  37         private final Enum<E> e;
  38 
  39         public EnumKey(Enum<E> e) {
  40             this.e = e;
  41         }
  42 
  43         @Override
  44         public int hashCode() {
  45             return e.ordinal();
  46         }
  47 
  48         @Override
  49         public boolean equals(Object obj) {
  50             if (obj == this) {
  51                 return true;
  52             }
  53             if (obj instanceof EnumKey) {
  54                 EnumKey<?> that = (EnumKey<?>) obj;
  55                 return this.e == that.e;
  56             }
  57             return false;
  58         }
  59     }
  60 
  61     /**
  62      * Gets a value associated with this object that can be used as a stable key in a map. The
  63      * {@link Object#hashCode()} implementation of the returned value should be stable between VM
  64      * executions.
  65      */
  66     Key getKey();
  67 
  68     /**
  69      * Get the size in bytes of this {@link PlatformKind}.
  70      */
  71     int getSizeInBytes();
  72 
  73     /**
  74      * Returns how many primitive values fit in this {@link PlatformKind}. For scalar types this is
  75      * one, for SIMD types it may be higher.
  76      */
  77     int getVectorLength();
  78 
  79     /**
  80      * Gets a single type char that identifies this type for use in debug output.
  81      */
  82     char getTypeChar();
  83 }