CompilationResult

java.lang.Object
- org.graalvm.compiler.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.CodeAnnotation` Provides extra information about instructions or data at specific positions in `CompilationResult.getTargetCode()`.
`static class`	`CompilationResult.CodeComment` A string comment about one or more instructions at a specific position in the code.
`static class`	`CompilationResult.CodeMark` An alternative to the existing `Mark` which isn't very flexible since it's final.
`static class`	`CompilationResult.JumpTable` Describes a table of signed offsets embedded in the code.
`static interface`	`CompilationResult.MarkId` An identified mark in the generated code.

Constructor Summary

Constructors
Constructor and Description
`CompilationResult(CompilationIdentifier compilationId)`
`CompilationResult(CompilationIdentifier compilationId, String name)`
`CompilationResult(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotation(CompilationResult.CodeAnnotation annotation)`
`void`	`addInfopoint(Infopoint infopoint)` Records a custom infopoint in the code section.
`void`	`clearExceptionHandlers()`
`void`	`clearInfopoints()`
`void`	`close(OptionValues options)` Closes this compilation result to future updates.
`boolean`	`equals(Object obj)`
`Assumption[]`	`getAssumptions()` Gets the assumptions made during compilation.
`int`	`getBytecodeSize()`
`List<CompilationResult.CodeAnnotation>`	`getCodeAnnotations()`
`CompilationIdentifier`	`getCompilationId()`
`StackSlot`	`getCustomStackArea()` Start of the custom stack area.
`List<DataPatch>`	`getDataPatches()`
`DataSection`	`getDataSection()`
`int`	`getEntryBCI()`
`List<ExceptionHandler>`	`getExceptionHandlers()`
`List<Infopoint>`	`getInfopoints()`
`List<CompilationResult.CodeMark>`	`getMarks()`
`int`	`getMaxInterpreterFrameSize()`
`ResolvedJavaMethod[]`	`getMethods()` Gets the methods whose bytecodes were used as input to the compilation.
`String`	`getName()` Gets the name for this compilation result.
`List<SourceMapping>`	`getSourceMappings()`
`SpeculationLog`	`getSpeculationLog()` Gets the `SpeculationLog` log, if any, used during compilation.
`byte[]`	`getTargetCode()`
`int`	`getTargetCodeSize()`
`int`	`getTotalFrameSize()` The total frame size of the method in bytes.
`int`	`hashCode()`
`boolean`	`hasUnsafeAccess()`
`Call`	`recordCall(int codePos, int size, InvokeTarget target, DebugInfo debugInfo, boolean direct)` Records a call in the code array.
`void`	`recordDataPatch(int codePos, Reference ref)` Records a data patch in the code section.
`void`	`recordDataPatchWithNote(int codePos, Reference ref, Object note)` Records a data patch in the code section.
`void`	`recordExceptionHandler(int codePos, int handlerPos)` Records an exception handler for this method.
`void`	`recordImplicitException(int codePos, int dispatchPos, DebugInfo debugInfo)` Records an implicit exception in the code array.
`void`	`recordInfopoint(int codePos, DebugInfo debugInfo, InfopointReason reason)` Records an infopoint in the code array.
`CompilationResult.CodeMark`	`recordMark(int codePos, CompilationResult.MarkId markId)` Records an instruction mark within this method.
`void`	`recordSourceMapping(int startOffset, int endOffset, NodeSourcePosition sourcePosition)`
`void`	`resetForEmittingCode()` Clears the information in this object pertaining to generating code.
`void`	`setAssumptions(Assumption[] assumptions)` Sets the assumptions made during compilation.
`void`	`setBytecodeSize(int bytecodeSize)`
`void`	`setCustomStackAreaOffset(StackSlot slot)`
`void`	`setEntryBCI(int entryBCI)`
`void`	`setHasUnsafeAccess(boolean hasUnsafeAccess)`
`void`	`setMaxInterpreterFrameSize(int maxInterpreterFrameSize)`
`void`	`setMethods(ResolvedJavaMethod rootMethod, Collection<ResolvedJavaMethod> inlinedMethods)` Sets the methods whose bytecodes were used as input to the compilation.
`void`	`setSpeculationLog(SpeculationLog speculationLog)` Sets the `SpeculationLog` log used during 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()`

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

- Constructor Detail
  - CompilationResult
```
public CompilationResult(CompilationIdentifier compilationId)
```
  - CompilationResult
```
public CompilationResult(CompilationIdentifier compilationId,
                         String name)
```
  - 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
  - getEntryBCI
```
public int getEntryBCI()
```
    Returns:
    
    the entryBCI
  - setEntryBCI
```
public void setEntryBCI(int entryBCI)
```
    Parameters:
    
    entryBCI - the entryBCI to set
  - setAssumptions
```
public void setAssumptions(Assumption[] assumptions)
```
    Sets the assumptions made during compilation.
  - getAssumptions
```
public Assumption[] getAssumptions()
```
    Gets the assumptions made during compilation. The caller must not modify the contents of the returned array.
  - 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. The caller must not modify the contents of the returned array.
    
    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
  - setSpeculationLog
```
public void setSpeculationLog(SpeculationLog speculationLog)
```
    Sets the SpeculationLog log used during compilation.
  - getSpeculationLog
```
public SpeculationLog getSpeculationLog()
```
    Gets the SpeculationLog log, if any, used during 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
  - getMaxInterpreterFrameSize
```
public int getMaxInterpreterFrameSize()
```
  - setMaxInterpreterFrameSize
```
public void setMaxInterpreterFrameSize(int maxInterpreterFrameSize)
```
  - 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,
                            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
  - recordDataPatchWithNote
```
public void recordDataPatchWithNote(int codePos,
                                    Reference ref,
                                    Object note)
```
    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
    
    note - a note attached to data patch for use by post-processing tools
  - recordCall
```
public Call 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
  - 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
  - recordImplicitException
```
public void recordImplicitException(int codePos,
                                    int dispatchPos,
                                    DebugInfo debugInfo)
```
    Records an implicit exception in the code array.
    
    Parameters:
    
    codePos - the position of the implicit exception in the code array
    
    dispatchPos - the position to resume execution when an implicit exception occurs. Setting it to the same value of codePos forces a deoptimization, and will resume execution at the default deoptimization blob.
    
    debugInfo - the debug info for the infopoint
  - addInfopoint
```
public void addInfopoint(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 dedicated methods like CompilationResult.recordCall(int, int, InvokeTarget, DebugInfo, boolean).
    
    Parameters:
    
    infopoint - the infopoint to record, usually a derived class from Infopoint
  - recordSourceMapping
```
public void recordSourceMapping(int startOffset,
                                int endOffset,
                                NodeSourcePosition sourcePosition)
```
  - recordMark
```
public CompilationResult.CodeMark recordMark(int codePos,
                                             CompilationResult.MarkId 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
  - getCustomStackArea
```
public StackSlot getCustomStackArea()
```
    Start of the custom stack area.
    
    Returns:
    
    the first stack slot of the custom stack area
  - setCustomStackAreaOffset
```
public void setCustomStackAreaOffset(StackSlot slot)
```
    Parameters:
    
    slot -
    
    See Also:
    
    CompilationResult.getCustomStackArea()
  - 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
  - getCodeAnnotations
```
public List<CompilationResult.CodeAnnotation> getCodeAnnotations()
```
    Returns:
    
    the code annotations or null if there are none
  - addAnnotation
```
public void addAnnotation(CompilationResult.CodeAnnotation annotation)
```
  - getInfopoints
```
public List<Infopoint> getInfopoints()
```
    Returns:
    
    the list of infopoints, sorted by Site.pcOffset
  - getDataPatches
```
public List<DataPatch> getDataPatches()
```
    Returns:
    
    the list of data references
  - getExceptionHandlers
```
public List<ExceptionHandler> getExceptionHandlers()
```
    Returns:
    
    the list of exception handlers
  - getMarks
```
public List<CompilationResult.CodeMark> getMarks()
```
    Returns:
    
    the list of code marks.
  - getSourceMappings
```
public List<SourceMapping> getSourceMappings()
```
    Returns:
    
    the list of SourceMappings
  - getName
```
public String getName()
```
    Gets the name for this compilation result. This will only be non-null when it provides a value unrelated to CompilationResult.getCompilationId().
  - getCompilationId
```
public CompilationIdentifier getCompilationId()
```
  - setHasUnsafeAccess
```
public void setHasUnsafeAccess(boolean hasUnsafeAccess)
```
  - hasUnsafeAccess
```
public boolean hasUnsafeAccess()
```
  - resetForEmittingCode
```
public void resetForEmittingCode()
```
    Clears the information in this object pertaining to generating code. That is, the marks, infopoints, exception handlers, data patches and annotations recorded in this object are cleared.
  - clearInfopoints
```
public void clearInfopoints()
```
  - clearExceptionHandlers
```
public void clearExceptionHandlers()
```
  - close
```
public void close(OptionValues options)
```
    Closes this compilation result to future updates.

Class CompilationResult

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompilationResult

CompilationResult

CompilationResult

Method Detail

hashCode

toString

equals

getEntryBCI

setEntryBCI

setAssumptions

getAssumptions

setMethods

getMethods

setSpeculationLog

getSpeculationLog

setBytecodeSize

getBytecodeSize

getDataSection

getTotalFrameSize

setTotalFrameSize

getMaxInterpreterFrameSize

setMaxInterpreterFrameSize

setTargetCode

recordDataPatch

recordDataPatchWithNote

recordCall

recordExceptionHandler

recordInfopoint

recordImplicitException

addInfopoint

recordSourceMapping

recordMark

getCustomStackArea

setCustomStackAreaOffset

getTargetCode

getTargetCodeSize

getCodeAnnotations

addAnnotation

getInfopoints

getDataPatches

getExceptionHandlers

getMarks

getSourceMappings

getName

getCompilationId

setHasUnsafeAccess

hasUnsafeAccess

resetForEmittingCode

clearInfopoints

clearExceptionHandlers

close