CompilationResult (Graal OpenJDK Project Documentation)

java.lang.Object
- jdk.internal.jvmci.code.CompilationResult

```
public class CompilationResult
extends Object
```
Represents the output from compiling a method, including the compiled machine code, associated data and references, relocation information, deoptimization information, etc.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CompilationResult.Call` Represents a call in the code.
`static class`	`CompilationResult.CodeAnnotation` Provides extra information about instructions or data at specific positions in `getTargetCode()`.
`static class`	`CompilationResult.CodeComment` A string comment about one or more instructions at a specific position in the code.
`static class`	`CompilationResult.ConstantReference`
`static class`	`CompilationResult.DataPatch` Represents a code site that references some data.
`static class`	`CompilationResult.DataSectionReference`
`static class`	`CompilationResult.ExceptionHandler` Represents exception handler information for a specific code position.
`static class`	`CompilationResult.Infopoint` Represents an infopoint with associated debug info.
`static class`	`CompilationResult.JumpTable` Describes a table of signed offsets embedded in the code.
`static class`	`CompilationResult.Mark` Represents a mark in the machine code that can be used by the runtime for its own purposes.
`static class`	`CompilationResult.Reference` Represents some external data that is referenced by the code.
`static class`	`CompilationResult.Site` Represents a code position with associated additional information.

Field Summary

Fields
Modifier and Type	Field and Description
`private ArrayList<CompilationResult.CodeAnnotation>`	`annotations`
`private Assumptions.Assumption[]`	`assumptions`
`private int`	`bytecodeSize`
`private int`	`customStackAreaOffset`
`private List<CompilationResult.DataPatch>`	`dataPatches`
`private DataSection`	`dataSection`
`private int`	`entryBCI`
`private List<CompilationResult.ExceptionHandler>`	`exceptionHandlers`
`private boolean`	`hasUnsafeAccess`
`private int`	`id`
`private List<CompilationResult.Infopoint>`	`infopoints`
`private List<CompilationResult.Mark>`	`marks`
`private ResolvedJavaMethod[]`	`methods` The list of the methods whose bytecodes were used as input to the compilation.
`private String`	`name`
`private byte[]`	`targetCode` The buffer containing the emitted machine code.
`private int`	`targetCodeSize` The leading number of bytes in `targetCode` containing the emitted machine code.
`private int`	`totalFrameSize`

Constructor Summary

Constructors
Constructor and Description

CompilationResult()

CompilationResult(String name)

Constructors
Constructor and Description
`CompilationResult()`
`CompilationResult(String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotation(CompilationResult.CodeAnnotation annotation)`
`void`	`addInfopoint(CompilationResult.Infopoint infopoint)` Records a custom infopoint in the code section.
`private static void`	`appendDebugInfo(StringBuilder sb, DebugInfo info)`
`boolean`	`equals(Object obj)`
`List<CompilationResult.CodeAnnotation>`	`getAnnotations()`
`Assumptions.Assumption[]`	`getAssumptions()` Gets the assumptions made during compilation.
`int`	`getBytecodeSize()`
`int`	`getCustomStackAreaOffset()` Offset in bytes for the custom stack area (relative to sp).
`List<CompilationResult.DataPatch>`	`getDataPatches()`
`DataSection`	`getDataSection()`
`int`	`getEntryBCI()`
`private CompilationResult.ExceptionHandler`	`getExceptionHandlerForCodePos(int codePos)` Returns the first ExceptionHandler which matches codePos.
`List<CompilationResult.ExceptionHandler>`	`getExceptionHandlers()`
`int`	`getId()`
`List<CompilationResult.Infopoint>`	`getInfopoints()`
`List<CompilationResult.Mark>`	`getMarks()`
`ResolvedJavaMethod[]`	`getMethods()` Gets the methods whose bytecodes were used as input to the compilation.
`String`	`getName()`
`byte[]`	`getTargetCode()`
`int`	`getTargetCodeSize()`
`int`	`getTotalFrameSize()` The total frame size of the method in bytes.
`int`	`hashCode()`
`boolean`	`hasUnsafeAccess()`
`void`	`recordCall(int codePos, int size, InvokeTarget target, DebugInfo debugInfo, boolean direct)` Records a call in the code array.
`void`	`recordDataPatch(int codePos, CompilationResult.Reference ref)` Records a data patch in the code section.
`void`	`recordExceptionHandler(int codePos, int handlerPos)` Records an exception handler for this method.
`void`	`recordInfopoint(int codePos, DebugInfo debugInfo, InfopointReason reason)` Records an infopoint in the code array.
`CompilationResult.Mark`	`recordMark(int codePos, Object markId)` Records an instruction mark within this method.
`void`	`reset()`
`void`	`setAssumptions(Assumptions.Assumption[] assumptions)` Sets the assumptions made during compilation.
`void`	`setBytecodeSize(int bytecodeSize)`
`void`	`setCustomStackAreaOffset(int offset)`
`void`	`setEntryBCI(int entryBCI)`
`void`	`setHasUnsafeAccess(boolean hasUnsafeAccess)`
`void`	`setId(int id)`
`void`	`setMethods(ResolvedJavaMethod rootMethod, Collection<ResolvedJavaMethod> inlinedMethods)` Sets the methods whose bytecodes were used as input to the compilation.
`void`	`setTargetCode(byte[] code, int size)` Sets the machine that has been generated by the compiler.
`void`	`setTotalFrameSize(int size)` Sets the total frame size in bytes.
`String`	`toString()`
`private boolean`	`validateExceptionHandlerAdd(int codePos, int handlerPos)` Validate if the exception handler for codePos already exists and handlerPos is different.

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

- Field Detail
  - id
```
private int id
```
  - entryBCI
```
private int entryBCI
```
  - dataSection
```
private final DataSection dataSection
```
  - infopoints
```
private final List<CompilationResult.Infopoint> infopoints
```
  - dataPatches
```
private final List<CompilationResult.DataPatch> dataPatches
```
  - exceptionHandlers
```
private final List<CompilationResult.ExceptionHandler> exceptionHandlers
```
  - marks
```
private final List<CompilationResult.Mark> marks
```
  - totalFrameSize
```
private int totalFrameSize
```
  - customStackAreaOffset
```
private int customStackAreaOffset
```
  - name
```
private final String name
```
  - targetCode
```
private byte[] targetCode
```
    The buffer containing the emitted machine code.
  - targetCodeSize
```
private int targetCodeSize
```
    The leading number of bytes in targetCode containing the emitted machine code.
  - annotations
```
private ArrayList<CompilationResult.CodeAnnotation> annotations
```
  - assumptions
```
private Assumptions.Assumption[] assumptions
```
  - methods
```
private ResolvedJavaMethod[] methods
```
    The list of the methods whose bytecodes were used as input to the compilation. If null, then the compilation did not record method dependencies. Otherwise, the first element of this array is the root method of the compilation.
  - bytecodeSize
```
private int bytecodeSize
```
  - hasUnsafeAccess
```
private boolean hasUnsafeAccess
```
- Constructor Detail
  - CompilationResult
```
public CompilationResult()
```
  - CompilationResult
```
public CompilationResult(String name)
```
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getId
```
public int getId()
```
    Returns:
    
    the compile id
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - the compile id to set
  - getEntryBCI
```
public int getEntryBCI()
```
    Returns:
    
    the entryBCI
  - setEntryBCI
```
public void setEntryBCI(int entryBCI)
```
    Parameters:
    
    entryBCI - the entryBCI to set
  - setAssumptions
```
public void setAssumptions(Assumptions.Assumption[] assumptions)
```
    Sets the assumptions made during compilation.
  - getAssumptions
```
public Assumptions.Assumption[] getAssumptions()
```
    Gets the assumptions made during compilation.
  - setMethods
```
public void setMethods(ResolvedJavaMethod rootMethod,
                       Collection<ResolvedJavaMethod> inlinedMethods)
```
    Sets the methods whose bytecodes were used as input to the compilation.
    
    Parameters:
    
    rootMethod - the root method of the compilation
    
    inlinedMethods - the methods inlined during compilation
  - getMethods
```
public ResolvedJavaMethod[] getMethods()
```
    Gets the methods whose bytecodes were used as input to the compilation.
    
    Returns:
    
    null if the compilation did not record method dependencies otherwise the methods whose bytecodes were used as input to the compilation with the first element being the root method of the compilation
  - setBytecodeSize
```
public void setBytecodeSize(int bytecodeSize)
```
  - getBytecodeSize
```
public int getBytecodeSize()
```
  - getDataSection
```
public DataSection getDataSection()
```
  - getTotalFrameSize
```
public int getTotalFrameSize()
```
    The total frame size of the method in bytes. This includes the return address pushed onto the stack, if any.
    
    Returns:
    
    the frame size
  - setTotalFrameSize
```
public void setTotalFrameSize(int size)
```
    Sets the total frame size in bytes. This includes the return address pushed onto the stack, if any.
    
    Parameters:
    
    size - the size of the frame in bytes
  - setTargetCode
```
public void setTargetCode(byte[] code,
                          int size)
```
    Sets the machine that has been generated by the compiler.
    
    Parameters:
    
    code - the machine code generated
    
    size - the size of the machine code
  - recordDataPatch
```
public void recordDataPatch(int codePos,
                            CompilationResult.Reference ref)
```
    Records a data patch in the code section. The data patch can refer to something in the data section or directly to an inlined constant.
    
    Parameters:
    
    codePos - The position in the code that needs to be patched.
    
    ref - The reference that should be inserted in the code.
  - recordCall
```
public void recordCall(int codePos,
                       int size,
                       InvokeTarget target,
                       DebugInfo debugInfo,
                       boolean direct)
```
    Records a call in the code array.
    
    Parameters:
    
    codePos - the position of the call in the code array
    
    size - the size of the call instruction
    
    target - the being called
    
    debugInfo - the debug info for the call
    
    direct - specifies if this is a direct call
  - recordExceptionHandler
```
public void recordExceptionHandler(int codePos,
                                   int handlerPos)
```
    Records an exception handler for this method.
    
    Parameters:
    
    codePos - the position in the code that is covered by the handler
    
    handlerPos - the position of the handler
  - validateExceptionHandlerAdd
```
private boolean validateExceptionHandlerAdd(int codePos,
                                            int handlerPos)
```
    Validate if the exception handler for codePos already exists and handlerPos is different.
    
    Parameters:
    
    codePos -
    
    handlerPos -
    
    Returns:
    
    true if the validation is successful
  - getExceptionHandlerForCodePos
```
private CompilationResult.ExceptionHandler getExceptionHandlerForCodePos(int codePos)
```
    Returns the first ExceptionHandler which matches codePos.
    
    Parameters:
    
    codePos - position to search for
    
    Returns:
    
    first matching ExceptionHandler
  - recordInfopoint
```
public void recordInfopoint(int codePos,
                            DebugInfo debugInfo,
                            InfopointReason reason)
```
    Records an infopoint in the code array.
    
    Parameters:
    
    codePos - the position of the infopoint in the code array
    
    debugInfo - the debug info for the infopoint
  - addInfopoint
```
public void addInfopoint(CompilationResult.Infopoint infopoint)
```
    Records a custom infopoint in the code section. Compiler implementations can use this method to record non-standard infopoints, which are not handled by the dedicated methods like recordCall(int, int, jdk.internal.jvmci.meta.InvokeTarget, jdk.internal.jvmci.code.DebugInfo, boolean).
    
    Parameters:
    
    infopoint - the infopoint to record, usually a derived class from CompilationResult.Infopoint
  - recordMark
```
public CompilationResult.Mark recordMark(int codePos,
                                         Object markId)
```
    Records an instruction mark within this method.
    
    Parameters:
    
    codePos - the position in the code that is covered by the handler
    
    markId - the identifier for this mark
  - getCustomStackAreaOffset
```
public int getCustomStackAreaOffset()
```
    Offset in bytes for the custom stack area (relative to sp).
    
    Returns:
    
    the offset in bytes
  - setCustomStackAreaOffset
```
public void setCustomStackAreaOffset(int offset)
```
    Parameters:
    
    offset -
    
    See Also:
    
    getCustomStackAreaOffset()
  - getTargetCode
```
public byte[] getTargetCode()
```
    Returns:
    
    the machine code generated for this method
  - getTargetCodeSize
```
public int getTargetCodeSize()
```
    Returns:
    
    the size of the machine code generated for this method
  - getAnnotations
```
public List<CompilationResult.CodeAnnotation> getAnnotations()
```
    Returns:
    
    the code annotations or null if there are none
  - addAnnotation
```
public void addAnnotation(CompilationResult.CodeAnnotation annotation)
```
  - appendDebugInfo
```
private static void appendDebugInfo(StringBuilder sb,
                                    DebugInfo info)
```
  - getInfopoints
```
public List<CompilationResult.Infopoint> getInfopoints()
```
    Returns:
    
    the list of infopoints, sorted by CompilationResult.Site.pcOffset
  - getDataPatches
```
public List<CompilationResult.DataPatch> getDataPatches()
```
    Returns:
    
    the list of data references
  - getExceptionHandlers
```
public List<CompilationResult.ExceptionHandler> getExceptionHandlers()
```
    Returns:
    
    the list of exception handlers
  - getMarks
```
public List<CompilationResult.Mark> getMarks()
```
    Returns:
    
    the list of marks
  - getName
```
public String getName()
```
  - setHasUnsafeAccess
```
public void setHasUnsafeAccess(boolean hasUnsafeAccess)
```
  - hasUnsafeAccess
```
public boolean hasUnsafeAccess()
```
  - reset
```
public void reset()
```

Class CompilationResult

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

entryBCI

dataSection

infopoints

dataPatches

exceptionHandlers

marks

totalFrameSize

customStackAreaOffset

name

targetCode

targetCodeSize

annotations

assumptions

methods

bytecodeSize

hasUnsafeAccess

Constructor Detail

CompilationResult

CompilationResult

Method Detail

hashCode

toString

equals

getId

setId

getEntryBCI

setEntryBCI

setAssumptions

getAssumptions

setMethods

getMethods

setBytecodeSize

getBytecodeSize

getDataSection

getTotalFrameSize

setTotalFrameSize

setTargetCode

recordDataPatch

recordCall

recordExceptionHandler

validateExceptionHandlerAdd

getExceptionHandlerForCodePos

recordInfopoint

addInfopoint

recordMark

getCustomStackAreaOffset

setCustomStackAreaOffset

getTargetCode

getTargetCodeSize

getAnnotations

addAnnotation

appendDebugInfo

getInfopoints

getDataPatches

getExceptionHandlers

getMarks

getName

setHasUnsafeAccess

hasUnsafeAccess

reset