com.oracle.graal.pointsto.heap

Class ImageHeapScanner

java.lang.Object

com.oracle.graal.pointsto.heap.ImageHeapScanner

public abstract class ImageHeapScanner
extends Object

Scanning is triggered when:

• a static final field is marked as accessed, or
s
• a method is parsed and embedded roots are discovered

When an instance field is marked as accessed the objects of its declaring type (and all the subtypes) are re-scanned.

Field Summary

Fields

Modifier and Type	Field and Description
protected BigBang	bb
protected ConstantReflectionProvider	constantReflection
protected ConstantReflectionProvider	hostedConstantReflection
protected org.graalvm.compiler.api.replacements.SnippetReflectionProvider	hostedSnippetReflection
protected HostVM	hostVM
protected ImageHeap	imageHeap
protected AnalysisMetaAccess	metaAccess
protected ObjectScanningObserver	scanningObserver
protected org.graalvm.compiler.api.replacements.SnippetReflectionProvider	snippetReflection
protected AnalysisUniverse	universe

Constructor Summary

Constructors

Constructor and Description
ImageHeapScanner(BigBang bb, ImageHeap heap, AnalysisMetaAccess aMetaAccess, org.graalvm.compiler.api.replacements.SnippetReflectionProvider aSnippetReflection, ConstantReflectionProvider aConstantReflection, ObjectScanningObserver aScanningObserver)

Method Summary

Modifier and Type	Method and Description
JavaConstant	asConstant(Object object)
protected Object	asObject(JavaConstant constant)
void	cleanupAfterAnalysis()
TypeData	computeTypeData(AnalysisType type) Computes the class initialization status and the snapshot of all static fields.
protected JavaConstant	createFieldValue(AnalysisField field, ImageHeapInstance receiver, ValueSupplier<JavaConstant> rawValue, ObjectScanner.ScanReason reason)
protected JavaConstant	createFieldValue(AnalysisField field, ValueSupplier<JavaConstant> rawValue, ObjectScanner.ScanReason reason)
JavaConstant	createImageHeapConstant(JavaConstant constant, ObjectScanner.ScanReason reason)
protected ImageHeapConstant	createImageHeapObject(JavaConstant constant, ObjectScanner.ScanReason reason) Create the ImageHeapConstant object wrapper, capture the hosted state of fields and arrays, and install a future that can process them.
protected String	formatReason(String message, ObjectScanner.ScanReason reason)
protected abstract Class<?>	getClass(String className)
protected ImageHeapConstant	getOrCreateImageHeapConstant(JavaConstant javaConstant, ObjectScanner.ScanReason reason)
ObjectScanningObserver	getScanningObserver()
boolean	isValueAvailable(AnalysisField field)
static boolean	isWordType(JavaConstant rawElementValue, UniverseMetaAccess metaAccess)
protected AnalysisField	lookupJavaField(String className, String fieldName)
protected AnalysisType	lookupJavaType(String className)
protected JavaConstant	onArrayElementReachable(ImageHeapArray array, AnalysisType arrayType, JavaConstant rawElementValue, int elementIndex, ObjectScanner.ScanReason reason, Consumer<ObjectScanner.ScanReason> onAnalysisModified)
void	onFieldRead(AnalysisField field)
protected void	onObjectReachable(ImageHeapConstant imageHeapConstant, ObjectScanner.ScanReason reason, Consumer<ObjectScanner.ScanReason> onAnalysisModified)
protected AnalysisFuture<JavaConstant>	patchArrayElement(ImageHeapObjectArray arrayObject, int index, JavaConstant elementValue, ObjectScanner.ScanReason reason, Consumer<ObjectScanner.ScanReason> onAnalysisModified)
protected AnalysisFuture<JavaConstant>	patchInstanceField(ImageHeapInstance receiverObject, AnalysisField field, JavaConstant fieldValue, ObjectScanner.ScanReason reason, Consumer<ObjectScanner.ScanReason> onAnalysisModified)
protected AnalysisFuture<JavaConstant>	patchStaticField(TypeData typeData, AnalysisField field, JavaConstant fieldValue, ObjectScanner.ScanReason reason, Consumer<ObjectScanner.ScanReason> onAnalysisModified)
void	postTask(Runnable task)
JavaConstant	readFieldValue(AnalysisField field, JavaConstant receiver)
protected ValueSupplier<JavaConstant>	readHostedFieldValue(AnalysisField field, JavaConstant receiver)
protected void	rescanEconomicMap(org.graalvm.collections.EconomicMap<?,?> object)
void	rescanField(Object receiver, Field reflectionField)
void	rescanObject(Object object) Add the object to the image heap and, if the object is a collection, rescan its elements.
void	rescanObject(Object object, ObjectScanner.ScanReason reason) Add the object to the image heap.
void	rescanRoot(Field reflectionField)
void	scanEmbeddedRoot(JavaConstant root, BytecodePosition position)
protected boolean	skipScanning()
ImageHeapConstant	toImageHeapObject(JavaConstant constant, ObjectScanner.ScanReason reason)
protected JavaConstant	transformFieldValue(AnalysisField field, JavaConstant receiverConstant, JavaConstant originalValueConstant)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bb

protected final BigBang bb

imageHeap

protected final ImageHeap imageHeap

metaAccess

protected final AnalysisMetaAccess metaAccess

universe

protected final AnalysisUniverse universe

hostVM

protected final HostVM hostVM

snippetReflection

protected final org.graalvm.compiler.api.replacements.SnippetReflectionProvider snippetReflection

constantReflection

protected final ConstantReflectionProvider constantReflection

hostedConstantReflection

protected final ConstantReflectionProvider hostedConstantReflection

hostedSnippetReflection

protected final org.graalvm.compiler.api.replacements.SnippetReflectionProvider hostedSnippetReflection

scanningObserver

protected ObjectScanningObserver scanningObserver

Constructor Detail

ImageHeapScanner

public ImageHeapScanner(BigBang bb,
                        ImageHeap heap,
                        AnalysisMetaAccess aMetaAccess,
                        org.graalvm.compiler.api.replacements.SnippetReflectionProvider aSnippetReflection,
                        ConstantReflectionProvider aConstantReflection,
                        ObjectScanningObserver aScanningObserver)

Method Detail

scanEmbeddedRoot

public void scanEmbeddedRoot(JavaConstant root,
                             BytecodePosition position)

onFieldRead

public void onFieldRead(AnalysisField field)

computeTypeData

public TypeData computeTypeData(AnalysisType type)

Computes the class initialization status and the snapshot of all static fields. This is an expensive operation and therefore done in an asynchronous task.

createImageHeapConstant

public JavaConstant createImageHeapConstant(JavaConstant constant,
                                            ObjectScanner.ScanReason reason)

toImageHeapObject

public ImageHeapConstant toImageHeapObject(JavaConstant constant,
                                           ObjectScanner.ScanReason reason)

getOrCreateImageHeapConstant

protected ImageHeapConstant getOrCreateImageHeapConstant(JavaConstant javaConstant,
                                                         ObjectScanner.ScanReason reason)

createImageHeapObject

protected ImageHeapConstant createImageHeapObject(JavaConstant constant,
                                                  ObjectScanner.ScanReason reason)

Create the ImageHeapConstant object wrapper, capture the hosted state of fields and arrays, and install a future that can process them.

createFieldValue

protected JavaConstant createFieldValue(AnalysisField field,
                                        ValueSupplier<JavaConstant> rawValue,
                                        ObjectScanner.ScanReason reason)

createFieldValue

protected JavaConstant createFieldValue(AnalysisField field,
                                        ImageHeapInstance receiver,
                                        ValueSupplier<JavaConstant> rawValue,
                                        ObjectScanner.ScanReason reason)

transformFieldValue

protected JavaConstant transformFieldValue(AnalysisField field,
                                           JavaConstant receiverConstant,
                                           JavaConstant originalValueConstant)

onArrayElementReachable

protected JavaConstant onArrayElementReachable(ImageHeapArray array,
                                               AnalysisType arrayType,
                                               JavaConstant rawElementValue,
                                               int elementIndex,
                                               ObjectScanner.ScanReason reason,
                                               Consumer<ObjectScanner.ScanReason> onAnalysisModified)

isWordType

public static boolean isWordType(JavaConstant rawElementValue,
                                 UniverseMetaAccess metaAccess)

onObjectReachable

protected void onObjectReachable(ImageHeapConstant imageHeapConstant,
                                 ObjectScanner.ScanReason reason,
                                 Consumer<ObjectScanner.ScanReason> onAnalysisModified)

isValueAvailable

public boolean isValueAvailable(AnalysisField field)

formatReason

protected String formatReason(String message,
                              ObjectScanner.ScanReason reason)

readHostedFieldValue

protected ValueSupplier<JavaConstant> readHostedFieldValue(AnalysisField field,
                                                           JavaConstant receiver)

readFieldValue

public JavaConstant readFieldValue(AnalysisField field,
                                   JavaConstant receiver)

skipScanning

protected boolean skipScanning()

rescanRoot

public void rescanRoot(Field reflectionField)

rescanField

public void rescanField(Object receiver,
                        Field reflectionField)

patchStaticField

protected AnalysisFuture<JavaConstant> patchStaticField(TypeData typeData,
                                                        AnalysisField field,
                                                        JavaConstant fieldValue,
                                                        ObjectScanner.ScanReason reason,
                                                        Consumer<ObjectScanner.ScanReason> onAnalysisModified)

patchInstanceField

protected AnalysisFuture<JavaConstant> patchInstanceField(ImageHeapInstance receiverObject,
                                                          AnalysisField field,
                                                          JavaConstant fieldValue,
                                                          ObjectScanner.ScanReason reason,
                                                          Consumer<ObjectScanner.ScanReason> onAnalysisModified)

patchArrayElement

protected AnalysisFuture<JavaConstant> patchArrayElement(ImageHeapObjectArray arrayObject,
                                                         int index,
                                                         JavaConstant elementValue,
                                                         ObjectScanner.ScanReason reason,
                                                         Consumer<ObjectScanner.ScanReason> onAnalysisModified)

rescanObject

public void rescanObject(Object object)

Add the object to the image heap and, if the object is a collection, rescan its elements.

rescanObject

public void rescanObject(Object object,
                         ObjectScanner.ScanReason reason)

Add the object to the image heap.

rescanEconomicMap

protected void rescanEconomicMap(org.graalvm.collections.EconomicMap<?,?> object)

asObject

protected Object asObject(JavaConstant constant)

asConstant

public JavaConstant asConstant(Object object)

cleanupAfterAnalysis

public void cleanupAfterAnalysis()

getScanningObserver

public ObjectScanningObserver getScanningObserver()

getClass

protected abstract Class<?> getClass(String className)

lookupJavaType

protected AnalysisType lookupJavaType(String className)

lookupJavaField

protected AnalysisField lookupJavaField(String className,
                                        String fieldName)

postTask

public void postTask(Runnable task)