OptCompiledMethod (Jikes RVM API)

java.lang.Object
- org.jikesrvm.compilers.common.CompiledMethod
- - org.jikesrvm.compilers.opt.runtimesupport.OptCompiledMethod

```
public final class OptCompiledMethod
extends CompiledMethod
```
An implementation of CompiledMethod for the OPT compiler.
NOTE: OptCompiledMethod live as long as their corresponding compiled machine code. Therefore, they should only contain state that is really required to be persistent. Anything transitory should be stored on the IR object.

Field Summary

Fields
Modifier and Type	Field and Description
`private OptMachineCodeMap`	`_mcMap` The primary machine code maps
`private EncodedOSRMap`	`_osrMap`
`private static RVMThread.SoftHandshakeVisitor`	`codePatchSyncRequestVisitor`
`private int[]`	`eTable` The encoded exception tables (null if there are none)
`private static ExceptionDeliverer`	`exceptionDeliverer`
`private char`	`exceptionObjectOffset` unsigned offset (off the framepointer) of caught exception object in bytes
`private byte`	`firstNonvolatileFPR` first saved nonvolatile floating point register (-1 if no nonvolatile FPRs)
`private byte`	`firstNonvolatileGPR` first saved nonvolatile integer register (-1 if no nonvolatile GPRs)
`private boolean`	`instrumented` is the current method executing with instrumentation
`private char`	`nonvolatileOffset` unsigned offset (off the framepointer) of nonvolatile save area in bytes
`private byte`	`optLevel` opt level at which the method was compiled
`private int[]`	`patchMap`
`private char`	`stackFrameFixedSize` size of the fixed portion of the stackframe
`private boolean`	`volatilesSaved` were the volatile registers saved?

Fields inherited from class org.jikesrvm.compilers.common.CompiledMethod
BASELINE, cmid, compilationTime, instructions, JNI, method, NATIVE_METHOD_LINE_NUMBER, NUM_COMPILER_TYPES, OPT, osrJTOCoffset, TRAP

Constructor Summary

Constructors
Constructor and Description

OptCompiledMethod(int id, RVMMethod m)

Constructors
Constructor and Description
`OptCompiledMethod(int id, RVMMethod m)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyCodePatches(CompiledMethod cm)` Applies the code patches to the INSTRUCTION array of cm.
`void`	`createCodePatchMaps(IR ir)` Create the code patching maps from the IR for the method
`void`	`createFinalExceptionTable(IR ir)` Create the final exception table from the IR for the method.
`void`	`createFinalMCMap(IR ir, int machineCodeLength)` Create the final machine code map for the compiled method.
`void`	`createFinalOSRMap(IR ir)`
`private void`	`dealWithPossibleRemovalOfCatchBlockByTheOptCompiler(Offset instructionOffset, RVMType exceptionType, int catchOffset)`
`int`	`findCatchBlockForInstruction(Offset instructionOffset, RVMType exceptionType)` Find "catch" block for a machine instruction of this method.
`int`	`findLineNumberForInstruction(Offset instructionOffset)` Find source line number corresponding to one of this method's machine instructions.
`String`	`getCompilerName()`
`int`	`getCompilerType()` Identify the compiler that produced this compiled method.
`void`	`getDynamicLink(DynamicLink dynamicLink, Offset instructionOffset)` Fetch symbolic reference to a method that's called by one of this method's instructions.
`ExceptionDeliverer`	`getExceptionDeliverer()`
`int`	`getFirstNonVolatileFPR()`
`int`	`getFirstNonVolatileGPR()`
`int`	`getFrameFixedSize()`
`OptMachineCodeMap`	`getMCMap()`
`int`	`getNumberOfNonvolatileFPRs()`
`int`	`getNumberOfNonvolatileGPRs()`
`int`	`getOptLevel()`
`EncodedOSRMap`	`getOSRMap()`
`int`	`getUnsignedExceptionOffset()`
`int`	`getUnsignedNonVolatileOffset()`
`boolean`	`isInstrumentedMethod()`
`boolean`	`isSaveVolatile()`
`boolean`	`isWithinUninterruptibleCode(Offset instructionOffset)` Return whether or not the given address (which is purported to be inside of the compiled method's code array) corresponds to an uninterruptible context.
`void`	`printExceptionTable()`
`void`	`printStackTrace(Offset instructionOffset, PrintLN out)` Print this compiled method's portion of a stack trace
`void`	`set(StackBrowser browser, Offset instr)` Set the stack browser to the innermost logical stack frame of this method.
`void`	`setFirstNonVolatileFPR(int x)`
`void`	`setFirstNonVolatileGPR(int x)`
`void`	`setFrameFixedSize(int x)`
`void`	`setInstrumentedMethod(boolean _instrumented)`
`void`	`setNumberOfNonvolatileFPRs(short n)`
`void`	`setNumberOfNonvolatileGPRs(short n)`
`void`	`setOptLevel(int x)`
`void`	`setSaveVolatile(boolean sv)`
`void`	`setUnsignedExceptionOffset(int x)`
`void`	`setUnsignedNonVolatileOffset(int x)`
`int`	`size()`
`boolean`	`up(StackBrowser browser)` Advance the StackBrowser up one internal stack frame, if possible

Methods inherited from class org.jikesrvm.compilers.common.CompiledMethod
clearActiveOnStack, codeArrayForOffset, compileComplete, compilerTypeToString, containsReturnAddress, getCompilationTime, getEntryCodeArray, getId, getInstructionAddress, getInstructionOffset, getInstructionOffset, getMethod, getOsrJTOCoffset, getSamplesReset, hasBridgeFromNativeAnnotation, isActiveOnStack, isCompiled, isInvalid, isObsolete, isOutdated, isSpecialForOSR, numberOfInstructions, setActiveOnStack, setCompilationTime, setInvalid, setObsolete, setOutdated, setSamplesReset, setSpecialForOSR

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

- Field Detail
  - exceptionDeliverer
```
private static final ExceptionDeliverer exceptionDeliverer
```
  - _osrMap
```
private EncodedOSRMap _osrMap
```
  - _mcMap
```
private OptMachineCodeMap _mcMap
```
    The primary machine code maps
  - eTable
```
private int[] eTable
```
    The encoded exception tables (null if there are none)
  - patchMap
```
private int[] patchMap
```
  - nonvolatileOffset
```
private char nonvolatileOffset
```
    unsigned offset (off the framepointer) of nonvolatile save area in bytes
  - exceptionObjectOffset
```
private char exceptionObjectOffset
```
    unsigned offset (off the framepointer) of caught exception object in bytes
  - stackFrameFixedSize
```
private char stackFrameFixedSize
```
    size of the fixed portion of the stackframe
  - firstNonvolatileGPR
```
private byte firstNonvolatileGPR
```
    first saved nonvolatile integer register (-1 if no nonvolatile GPRs)
  - firstNonvolatileFPR
```
private byte firstNonvolatileFPR
```
    first saved nonvolatile floating point register (-1 if no nonvolatile FPRs)
  - optLevel
```
private byte optLevel
```
    opt level at which the method was compiled
  - volatilesSaved
```
private boolean volatilesSaved
```
    were the volatile registers saved?
  - instrumented
```
private boolean instrumented
```
    is the current method executing with instrumentation
  - codePatchSyncRequestVisitor
```
private static RVMThread.SoftHandshakeVisitor codePatchSyncRequestVisitor
```
- Constructor Detail
  - OptCompiledMethod
```
public OptCompiledMethod(int id,
                         RVMMethod m)
```
- Method Detail
  - getCompilerType
```
public int getCompilerType()
```
    Description copied from class: CompiledMethod
    
    Identify the compiler that produced this compiled method.
    
    Specified by:
    
    getCompilerType in class CompiledMethod
    
    Returns:
    
    CompiledMethod.OPT
  - getCompilerName
```
public String getCompilerName()
```
    Specified by:
    
    getCompilerName in class CompiledMethod
    
    Returns:
    
    Name of the compiler that produced this compiled method.
  - getExceptionDeliverer
```
public ExceptionDeliverer getExceptionDeliverer()
```
    Specified by:
    
    getExceptionDeliverer in class CompiledMethod
    
    Returns:
    
    a handler to deal with stack unwinding and exception delivery for this compiled method's stackframes.
  - findCatchBlockForInstruction
```
public int findCatchBlockForInstruction(Offset instructionOffset,
                                        RVMType exceptionType)
```
    Find "catch" block for a machine instruction of this method.
    
    Specified by:
    
    findCatchBlockForInstruction in class CompiledMethod
    
    Parameters:
    
    instructionOffset - offset of machine instruction from start of this method, in bytes
    
    exceptionType - type of exception being thrown - something like "NullPointerException"
    
    Returns:
    
    offset of machine instruction for catch block (-1 --> no catch block)
  - dealWithPossibleRemovalOfCatchBlockByTheOptCompiler
```
private void dealWithPossibleRemovalOfCatchBlockByTheOptCompiler(Offset instructionOffset,
                                                                 RVMType exceptionType,
                                                                 int catchOffset)
```
  - getDynamicLink
```
public void getDynamicLink(DynamicLink dynamicLink,
                           Offset instructionOffset)
```
    Fetch symbolic reference to a method that's called by one of this method's instructions.
    
    Specified by:
    
    getDynamicLink in class CompiledMethod
    
    Parameters:
    
    dynamicLink - place to put return information
    
    instructionOffset - offset of machine instruction that issued the call
  - isWithinUninterruptibleCode
```
public boolean isWithinUninterruptibleCode(Offset instructionOffset)
```
    Description copied from class: CompiledMethod
    
    Return whether or not the given address (which is purported to be inside of the compiled method's code array) corresponds to an uninterruptible context.
    
    Specified by:
    
    isWithinUninterruptibleCode in class CompiledMethod
    
    Parameters:
    
    instructionOffset - of addr from start of instructions in bytes
    
    Returns:
    
    true if the IP is within an Uninterruptible method, false otherwise.
  - findLineNumberForInstruction
```
public int findLineNumberForInstruction(Offset instructionOffset)
```
    Find source line number corresponding to one of this method's machine instructions.
    
    Overrides:
    
    findLineNumberForInstruction in class CompiledMethod
    
    Parameters:
    
    instructionOffset - of machine instruction from start of this method, in bytes
    
    Returns:
    
    source line number (0 == no line info available, 1 == first line of source file, -2 == native method))
  - set
```
public void set(StackBrowser browser,
                Offset instr)
```
    Description copied from class: CompiledMethod
    
    Set the stack browser to the innermost logical stack frame of this method.
    
    Specified by:
    
    set in class CompiledMethod
    
    Parameters:
    
    browser - the browser
    
    instr - the offset of the instruction
  - up
```
public boolean up(StackBrowser browser)
```
    Description copied from class: CompiledMethod
    
    Advance the StackBrowser up one internal stack frame, if possible
    
    Overrides:
    
    up in class CompiledMethod
    
    Parameters:
    
    browser - the browser to advance
    
    Returns:
    
    whether the browser advanced a frame
  - printStackTrace
```
public void printStackTrace(Offset instructionOffset,
                            PrintLN out)
```
    Description copied from class: CompiledMethod
    
    Print this compiled method's portion of a stack trace
    
    Specified by:
    
    printStackTrace in class CompiledMethod
    
    Parameters:
    
    instructionOffset - offset of machine instruction from start of method
    
    out - the PrintLN to print the stack trace to.
  - size
```
public int size()
```
    Overrides:
    
    size in class CompiledMethod
    
    Returns:
    
    the number of bytes used to encode the compiler-specific mapping information for this compiled method. Used to gather statistics on the space costs of mapping schemes.
  - createFinalOSRMap
```
public void createFinalOSRMap(IR ir)
```
  - getOSRMap
```
public EncodedOSRMap getOSRMap()
```
  - getUnsignedNonVolatileOffset
```
public int getUnsignedNonVolatileOffset()
```
  - getUnsignedExceptionOffset
```
public int getUnsignedExceptionOffset()
```
  - getFirstNonVolatileGPR
```
public int getFirstNonVolatileGPR()
```
  - getFirstNonVolatileFPR
```
public int getFirstNonVolatileFPR()
```
  - getOptLevel
```
public int getOptLevel()
```
  - isSaveVolatile
```
public boolean isSaveVolatile()
```
  - isInstrumentedMethod
```
public boolean isInstrumentedMethod()
```
  - getFrameFixedSize
```
public int getFrameFixedSize()
```
  - setUnsignedNonVolatileOffset
```
public void setUnsignedNonVolatileOffset(int x)
```
  - setUnsignedExceptionOffset
```
public void setUnsignedExceptionOffset(int x)
```
  - setFirstNonVolatileGPR
```
public void setFirstNonVolatileGPR(int x)
```
  - setFirstNonVolatileFPR
```
public void setFirstNonVolatileFPR(int x)
```
  - setOptLevel
```
public void setOptLevel(int x)
```
  - setSaveVolatile
```
public void setSaveVolatile(boolean sv)
```
  - setInstrumentedMethod
```
public void setInstrumentedMethod(boolean _instrumented)
```
  - setFrameFixedSize
```
public void setFrameFixedSize(int x)
```
  - getNumberOfNonvolatileGPRs
```
public int getNumberOfNonvolatileGPRs()
```
    Returns:
    
    the number of non-volatile GPRs used by this method.
  - getNumberOfNonvolatileFPRs
```
public int getNumberOfNonvolatileFPRs()
```
    Returns:
    
    the number of non-volatile FPRs used by this method.
  - setNumberOfNonvolatileGPRs
```
public void setNumberOfNonvolatileGPRs(short n)
```
  - setNumberOfNonvolatileFPRs
```
public void setNumberOfNonvolatileFPRs(short n)
```
  - printExceptionTable
```
public void printExceptionTable()
```
  - getMCMap
```
public OptMachineCodeMap getMCMap()
```
    Returns:
    
    the machine code map for the compiled method.
  - createFinalMCMap
```
public void createFinalMCMap(IR ir,
                             int machineCodeLength)
```
    Create the final machine code map for the compiled method. Remember the offset for the end of prologue too for debugger.
    
    Parameters:
    
    ir - the ir
    
    machineCodeLength - the number of machine code instructions.
  - createFinalExceptionTable
```
public void createFinalExceptionTable(IR ir)
```
    Create the final exception table from the IR for the method.
    
    Parameters:
    
    ir - the ir
  - createCodePatchMaps
```
public void createCodePatchMaps(IR ir)
```
    Create the code patching maps from the IR for the method
    
    Parameters:
    
    ir - the ir
  - applyCodePatches
```
public void applyCodePatches(CompiledMethod cm)
```
    Applies the code patches to the INSTRUCTION array of cm.
    
    Parameters:
    
    cm - the method which will be patched

Class OptCompiledMethod

Field Summary

Fields inherited from class org.jikesrvm.compilers.common.CompiledMethod

Constructor Summary

Method Summary

Methods inherited from class org.jikesrvm.compilers.common.CompiledMethod

Methods inherited from class java.lang.Object

Field Detail

exceptionDeliverer

_osrMap

_mcMap

eTable

patchMap

nonvolatileOffset

exceptionObjectOffset

stackFrameFixedSize

firstNonvolatileGPR

firstNonvolatileFPR

optLevel

volatilesSaved

instrumented

codePatchSyncRequestVisitor

Constructor Detail

OptCompiledMethod

Method Detail

getCompilerType

getCompilerName

getExceptionDeliverer

findCatchBlockForInstruction

dealWithPossibleRemovalOfCatchBlockByTheOptCompiler

getDynamicLink

isWithinUninterruptibleCode

findLineNumberForInstruction

set

up

printStackTrace

size

createFinalOSRMap

getOSRMap

getUnsignedNonVolatileOffset

getUnsignedExceptionOffset

getFirstNonVolatileGPR

getFirstNonVolatileFPR

getOptLevel

isSaveVolatile

isInstrumentedMethod

getFrameFixedSize

setUnsignedNonVolatileOffset

setUnsignedExceptionOffset

setFirstNonVolatileGPR

setFirstNonVolatileFPR

setOptLevel

setSaveVolatile

setInstrumentedMethod

setFrameFixedSize

getNumberOfNonvolatileGPRs

getNumberOfNonvolatileFPRs

setNumberOfNonvolatileGPRs

setNumberOfNonvolatileFPRs

printExceptionTable

getMCMap

createFinalMCMap

createFinalExceptionTable

createCodePatchMaps

applyCodePatches