HotSpotConstantPool (Graal OpenJDK Project Documentation)

java.lang.Object
- jdk.internal.jvmci.hotspot.HotSpotConstantPool

All Implemented Interfaces:

HotSpotProxified, ConstantPool
```
public class HotSpotConstantPool
extends Object
implements ConstantPool, HotSpotProxified
```
Implementation of ConstantPool for HotSpot.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HotSpotConstantPool.Bytecodes` Subset of JVM bytecode opcodes used by `HotSpotConstantPool`.
`private class`	`HotSpotConstantPool.Cache` Represents a `ConstantPoolCache`.
`private static class`	`HotSpotConstantPool.JVM_CONSTANT` Enum of all `JVM_CONSTANT` constants used in the VM.
`private static class`	`HotSpotConstantPool.LookupTypeCacheElement`
`static class`	`HotSpotConstantPool.Options`
`private class`	`HotSpotConstantPool.ResolvedReferences` Hide the resolved references array in a private class so it cannot be accessed directly.

Field Summary

Fields
Modifier and Type	Field and Description
`private HotSpotConstantPool.Cache`	`cache` The constant pool cache of this constant pool.
`private HotSpotConstantPool.LookupTypeCacheElement`	`lastLookupType`
`private long`	`metaspaceConstantPool` Reference to the C++ ConstantPool object.
`private HotSpotConstantPool.ResolvedReferences`	`resolvedReferences` Resolved references of this constant pool.

Constructor Summary

Constructors
Constructor and Description

HotSpotConstantPool(long metaspaceConstantPool)

Constructors
Constructor and Description
`HotSpotConstantPool(long metaspaceConstantPool)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`assertBounds(int index)` Asserts that the constant pool index `index` is in the bounds of the constant pool.
`private void`	`assertTag(int index, HotSpotConstantPool.JVM_CONSTANT tag)` Asserts that the constant pool tag at index `index` is equal to `tag`.
`private void`	`assertTagIsFieldOrMethod(int index)` Asserts that the constant pool tag at index `index` is a `HotSpotConstantPool.JVM_CONSTANT.Fieldref`, or a `HotSpotConstantPool.JVM_CONSTANT.MethodRef`, or a `HotSpotConstantPool.JVM_CONSTANT.InterfaceMethodref`.
`private static int`	`decodeConstantPoolCacheIndex(int index)` Decode a constant pool cache index to a constant pool index.
`private static int`	`decodeInvokedynamicIndex(int i)` See `ConstantPool::decode_invokedynamic_index`.
`private double`	`getDoubleAt(int index)` Gets the double constant pool entry at index `index`.
`private long`	`getEntryAt(int index)` Gets the constant pool entry at index `index`.
`private float`	`getFloatAt(int index)` Gets the float constant pool entry at index `index`.
`private HotSpotResolvedObjectType`	`getHolder()` Gets the holder for this constant pool as `HotSpotResolvedObjectTypeImpl`.
`private int`	`getIntAt(int index)` Gets the integer constant pool entry at index `index`.
`private static JavaType`	`getJavaType(long metaspacePointer)` Gets a `JavaType` corresponding a given metaspace Klass or a metaspace Symbol depending on the `tag`.
`private int`	`getKlassRefIndexAt(int index)` Gets the klass reference index constant pool entry at index `index`.
`private int`	`getKlassRefIndexAt(int index, boolean cached)` Gets the klass reference index constant pool entry at index `index`.
`private long`	`getLongAt(int index)` Gets the long constant pool entry at index `index`.
`private int`	`getNameAndTypeAt(int index)` Gets the `JVM_CONSTANT_NameAndType` constant pool entry at index `index`.
`private int`	`getNameAndTypeRefIndexAt(int index)` Gets the `JVM_CONSTANT_NameAndType` reference index constant pool entry at index `index`.
`private String`	`getNameRefAt(int index)` Gets the name of a `JVM_CONSTANT_NameAndType` constant pool entry at index `index`.
`private int`	`getNameRefIndexAt(int index)` Gets the name reference index of a `JVM_CONSTANT_NameAndType` constant pool entry at index `index`.
`private String`	`getSignatureRefAt(int index)` Gets the signature of a `JVM_CONSTANT_NameAndType` constant pool entry at index `index`.
`private int`	`getSignatureRefIndexAt(int index)` Gets the signature reference index of a `JVM_CONSTANT_NameAndType` constant pool entry at index `index`.
`private HotSpotConstantPool.JVM_CONSTANT`	`getTagAt(int index)` Gets the constant pool tag at index `index`.
`private int`	`getUncachedKlassRefIndexAt(int index)` Gets the uncached klass reference index constant pool entry at index `index`.
`private static boolean`	`isInvokedynamicIndex(int index)` See `ConstantPool::is_invokedynamic_index`.
`private boolean`	`isInvokeHandle(int methodRefCacheIndex, HotSpotResolvedObjectTypeImpl klass)`
`int`	`length()` Returns the number of entries the constant pool.
`void`	`loadReferencedType(int cpi, int opcode)` Ensures that the type referenced by the specified constant pool entry is loaded and initialized.
`JavaConstant`	`lookupAppendix(int cpi, int opcode)` Looks up the appendix at the specified index.
`Object`	`lookupConstant(int cpi)` Looks up a constant at the specified index.
`JavaField`	`lookupField(int cpi, int opcode)` Looks up a reference to a field.
`JavaMethod`	`lookupMethod(int cpi, int opcode)` Looks up a reference to a method.
`Signature`	`lookupSignature(int cpi)` Looks up a method signature.
`JavaType`	`lookupType(int cpi, int opcode)` Looks up a reference to a type.
`String`	`lookupUtf8(int cpi)` Looks up an Utf8 string.
`private static int`	`rawIndexToConstantPoolIndex(int rawIndex, int opcode)` Converts a raw index from the bytecodes to a constant pool index by adding a `constant`.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - metaspaceConstantPool
```
private final long metaspaceConstantPool
```
    Reference to the C++ ConstantPool object.
  - lastLookupType
```
private volatile HotSpotConstantPool.LookupTypeCacheElement lastLookupType
```
  - cache
```
private final HotSpotConstantPool.Cache cache
```
    The constant pool cache of this constant pool.
  - resolvedReferences
```
private final HotSpotConstantPool.ResolvedReferences resolvedReferences
```
    Resolved references of this constant pool.
- Constructor Detail
  - HotSpotConstantPool
```
public HotSpotConstantPool(long metaspaceConstantPool)
```
- Method Detail
  - getHolder
```
private HotSpotResolvedObjectType getHolder()
```
    Gets the holder for this constant pool as HotSpotResolvedObjectTypeImpl.
    
    Returns:
    
    holder for this constant pool
  - rawIndexToConstantPoolIndex
```
private static int rawIndexToConstantPoolIndex(int rawIndex,
                                               int opcode)
```
    Converts a raw index from the bytecodes to a constant pool index by adding a constant.
    
    Parameters:
    
    rawIndex - index from the bytecode
    
    opcode - bytecode to convert the index for
    
    Returns:
    
    constant pool index
  - decodeConstantPoolCacheIndex
```
private static int decodeConstantPoolCacheIndex(int index)
```
    Decode a constant pool cache index to a constant pool index. See ConstantPool::decode_cpcache_index.
    
    Parameters:
    
    index - constant pool cache index
    
    Returns:
    
    decoded index
  - isInvokedynamicIndex
```
private static boolean isInvokedynamicIndex(int index)
```
    See ConstantPool::is_invokedynamic_index.
  - decodeInvokedynamicIndex
```
private static int decodeInvokedynamicIndex(int i)
```
    See ConstantPool::decode_invokedynamic_index.
  - getTagAt
```
private HotSpotConstantPool.JVM_CONSTANT getTagAt(int index)
```
    Gets the constant pool tag at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    constant pool tag
  - getEntryAt
```
private long getEntryAt(int index)
```
    Gets the constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    constant pool entry
  - getIntAt
```
private int getIntAt(int index)
```
    Gets the integer constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    integer constant pool entry at index
  - getLongAt
```
private long getLongAt(int index)
```
    Gets the long constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    long constant pool entry
  - getFloatAt
```
private float getFloatAt(int index)
```
    Gets the float constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    float constant pool entry
  - getDoubleAt
```
private double getDoubleAt(int index)
```
    Gets the double constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    float constant pool entry
  - getNameAndTypeAt
```
private int getNameAndTypeAt(int index)
```
    Gets the JVM_CONSTANT_NameAndType constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    JVM_CONSTANT_NameAndType constant pool entry
  - getNameAndTypeRefIndexAt
```
private int getNameAndTypeRefIndexAt(int index)
```
    Gets the JVM_CONSTANT_NameAndType reference index constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    JVM_CONSTANT_NameAndType reference constant pool entry
  - getNameRefAt
```
private String getNameRefAt(int index)
```
    Gets the name of a JVM_CONSTANT_NameAndType constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    name as String
  - getNameRefIndexAt
```
private int getNameRefIndexAt(int index)
```
    Gets the name reference index of a JVM_CONSTANT_NameAndType constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    name reference index
  - getSignatureRefAt
```
private String getSignatureRefAt(int index)
```
    Gets the signature of a JVM_CONSTANT_NameAndType constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    signature as String
  - getSignatureRefIndexAt
```
private int getSignatureRefIndexAt(int index)
```
    Gets the signature reference index of a JVM_CONSTANT_NameAndType constant pool entry at index index.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    signature reference index
  - getKlassRefIndexAt
```
private int getKlassRefIndexAt(int index,
                               boolean cached)
```
    Gets the klass reference index constant pool entry at index index. See ConstantPool::klass_ref_index_at.
    
    Parameters:
    
    index - constant pool index
    
    cached - whether to go through the constant pool cache
    
    Returns:
    
    klass reference index
  - getKlassRefIndexAt
```
private int getKlassRefIndexAt(int index)
```
    Gets the klass reference index constant pool entry at index index. See ConstantPool::klass_ref_index_at.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    klass reference index
  - getUncachedKlassRefIndexAt
```
private int getUncachedKlassRefIndexAt(int index)
```
    Gets the uncached klass reference index constant pool entry at index index. See: ConstantPool::uncached_klass_ref_index_at.
    
    Parameters:
    
    index - constant pool index
    
    Returns:
    
    klass reference index
  - assertBounds
```
private void assertBounds(int index)
```
    Asserts that the constant pool index index is in the bounds of the constant pool.
    
    Parameters:
    
    index - constant pool index
  - assertTag
```
private void assertTag(int index,
                       HotSpotConstantPool.JVM_CONSTANT tag)
```
    Asserts that the constant pool tag at index index is equal to tag.
    
    Parameters:
    
    index - constant pool index
    
    tag - expected tag
  - assertTagIsFieldOrMethod
```
private void assertTagIsFieldOrMethod(int index)
```
    Asserts that the constant pool tag at index index is a HotSpotConstantPool.JVM_CONSTANT.Fieldref, or a HotSpotConstantPool.JVM_CONSTANT.MethodRef, or a HotSpotConstantPool.JVM_CONSTANT.InterfaceMethodref.
    
    Parameters:
    
    index - constant pool index
  - length
```
public int length()
```
    Description copied from interface: ConstantPool
    
    Returns the number of entries the constant pool.
    
    Specified by:
    
    length in interface ConstantPool
    
    Returns:
    
    number of entries in the constant pool
  - lookupConstant
```
public Object lookupConstant(int cpi)
```
    Description copied from interface: ConstantPool
    
    Looks up a constant at the specified index.
    
    Specified by:
    
    lookupConstant in interface ConstantPool
    
    Parameters:
    
    cpi - the constant pool index
    
    Returns:
    
    the Constant or JavaType instance representing the constant pool entry
  - lookupUtf8
```
public String lookupUtf8(int cpi)
```
    Description copied from interface: ConstantPool
    
    Looks up an Utf8 string.
    
    Specified by:
    
    lookupUtf8 in interface ConstantPool
    
    Parameters:
    
    cpi - the constant pool index
    
    Returns:
    
    the Utf8 string at index cpi in this constant pool
  - lookupSignature
```
public Signature lookupSignature(int cpi)
```
    Description copied from interface: ConstantPool
    
    Looks up a method signature.
    
    Specified by:
    
    lookupSignature in interface ConstantPool
    
    Parameters:
    
    cpi - the constant pool index
    
    Returns:
    
    the method signature at index cpi in this constant pool
  - lookupAppendix
```
public JavaConstant lookupAppendix(int cpi,
                                   int opcode)
```
    Description copied from interface: ConstantPool
    
    Looks up the appendix at the specified index.
    
    Specified by:
    
    lookupAppendix in interface ConstantPool
    
    Parameters:
    
    cpi - the constant pool index
    
    opcode - the opcode of the instruction for which the lookup is being performed or -1
    
    Returns:
    
    the appendix if it exists and is resolved or null
  - getJavaType
```
private static JavaType getJavaType(long metaspacePointer)
```
    Gets a JavaType corresponding a given metaspace Klass or a metaspace Symbol depending on the tag.
    
    Parameters:
    
    metaspacePointer - either a metaspace Klass or a metaspace Symbol
  - lookupMethod
```
public JavaMethod lookupMethod(int cpi,
                               int opcode)
```
    Description copied from interface: ConstantPool
    
    Looks up a reference to a method. If opcode is non-negative, then resolution checks specific to the bytecode it denotes are performed if the method is already resolved. Should any of these checks fail, an unresolved method reference is returned.
    
    Specified by:
    
    lookupMethod in interface ConstantPool
    
    Parameters:
    
    cpi - the constant pool index
    
    opcode - the opcode of the instruction for which the lookup is being performed or -1
    
    Returns:
    
    a reference to the method at cpi in this pool
  - lookupType
```
public JavaType lookupType(int cpi,
                           int opcode)
```
    Description copied from interface: ConstantPool
    
    Looks up a reference to a type. If opcode is non-negative, then resolution checks specific to the bytecode it denotes are performed if the type is already resolved. Should any of these checks fail, an unresolved type reference is returned.
    
    Specified by:
    
    lookupType in interface ConstantPool
    
    Parameters:
    
    cpi - the constant pool index
    
    opcode - the opcode of the instruction for which the lookup is being performed or -1
    
    Returns:
    
    a reference to the compiler interface type
  - lookupField
```
public JavaField lookupField(int cpi,
                             int opcode)
```
    Description copied from interface: ConstantPool
    
    Looks up a reference to a field. If opcode is non-negative, then resolution checks specific to the bytecode it denotes are performed if the field is already resolved. Should any of these checks fail, an unresolved field reference is returned.
    
    Specified by:
    
    lookupField in interface ConstantPool
    
    Parameters:
    
    cpi - the constant pool index
    
    opcode - the opcode of the instruction for which the lookup is being performed or -1
    
    Returns:
    
    a reference to the field at cpi in this pool
  - loadReferencedType
```
public void loadReferencedType(int cpi,
                               int opcode)
```
    Description copied from interface: ConstantPool
    
    Ensures that the type referenced by the specified constant pool entry is loaded and initialized. This can be used to compile time resolve a type. It works for field, method, or type constant pool entries.
    
    Specified by:
    
    loadReferencedType in interface ConstantPool
    
    Parameters:
    
    cpi - the index of the constant pool entry that references the type
    
    opcode - the opcode of the instruction that references the type
  - isInvokeHandle
```
private boolean isInvokeHandle(int methodRefCacheIndex,
                               HotSpotResolvedObjectTypeImpl klass)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HotSpotConstantPool

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metaspaceConstantPool

lastLookupType

cache

resolvedReferences

Constructor Detail

HotSpotConstantPool

Method Detail

getHolder

rawIndexToConstantPoolIndex

decodeConstantPoolCacheIndex

isInvokedynamicIndex

decodeInvokedynamicIndex

getTagAt

getEntryAt

getIntAt

getLongAt

getFloatAt

getDoubleAt

getNameAndTypeAt

getNameAndTypeRefIndexAt

getNameRefAt

getNameRefIndexAt

getSignatureRefAt

getSignatureRefIndexAt

getKlassRefIndexAt

getKlassRefIndexAt

getUncachedKlassRefIndexAt

assertBounds

assertTag

assertTagIsFieldOrMethod

length

lookupConstant

lookupUtf8

lookupSignature

lookupAppendix

getJavaType

lookupMethod

lookupType

lookupField

loadReferencedType

isInvokeHandle

toString