NormalMethod (Jikes RVM API)

java.lang.Object
- org.jikesrvm.classloader.AnnotatedElement
- - org.jikesrvm.classloader.RVMMember
  - - org.jikesrvm.classloader.RVMMethod
    - - org.jikesrvm.classloader.NormalMethod

All Implemented Interfaces:

AnnotatedElement
```
public final class NormalMethod
extends RVMMethod
```
A method of a java class that has bytecodes.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLOCATION_COST`
`static int`	`ARRAY_LOAD_COST`
`static int`	`ARRAY_STORE_COST`
`private byte[]`	`bytecodes` bytecodes for this method (`null` --> none)
`static int`	`CALL_COST`
`static int`	`CLASS_CHECK_COST`
`private ExceptionHandlerMap`	`exceptionHandlerMap` try/catch/finally blocks for this method (`null` --> none)
`private static char`	`HAS_ALLOCATION`
`private static char`	`HAS_ARRAY_READ`
`private static char`	`HAS_ARRAY_WRITE`
`private static char`	`HAS_BACK_BRANCH`
`private static char`	`HAS_COND_BRANCH`
`private static char`	`HAS_FIELD_READ`
`private static char`	`HAS_FIELD_WRITE`
`private static char`	`HAS_INVOKE`
`private static char`	`HAS_JSR`
`private static char`	`HAS_MAGIC`
`private static char`	`HAS_SWITCH`
`private static char`	`HAS_SYNCH`
`private static char`	`HAS_THROW`
`private static char`	`IS_RS_METHOD`
`static int`	`JSR_COST`
`private int[]`	`lineNumberMap` pc to source-line info (`null` --> none) Each entry contains both the line number (upper 16 bits) and corresponding start PC (lower 16 bits).
`private static HashMapRVM<NormalMethod,LocalVariableTable>`	`localVariableTables` the local variable table
`private short`	`localWords` words needed for local variables (including parameters)
`static int`	`LONG_OPERATION_COST`
`static int`	`MAGIC_COST`
`private short`	`operandWords` words needed for operand stack (high water mark) TODO: OSR redesign; add subclass of NormalMethod for OSR method and then make this field final in NormalMethod.
`private static HashMapRVM<NormalMethod,byte[]>`	`osrPrologues` Possible OSR record of osr prologue
`private static HashMapRVM<NormalMethod,Integer>`	`savedOperandWords` Possibly OSR prologue may change the maximum stack height, remember the original stack height
`static int`	`SIMPLE_OPERATION_COST`
`static int`	`STORE_CHECK_COST`
`private char`	`summaryFlags` storage for bytecode summary flags
`private char`	`summarySize` storage for bytecode summary size
`static int`	`SWITCH_COST`
`static int`	`SYNCH_COST`
`private static HashMapRVM<NormalMethod,byte[]>`	`synthesizedBytecodes` Possible OSR bytecode array consisting of prologue and original bytecodes
`static int`	`THROW_COST`

Fields inherited from class org.jikesrvm.classloader.RVMMethod
currentCompiledMethod

Fields inherited from class org.jikesrvm.classloader.RVMMember
memRef, modifiers, offset

Fields inherited from class org.jikesrvm.classloader.AnnotatedElement
declaredAnnotationDatas

Constructor Summary

Constructors
Constructor and Description
`NormalMethod(TypeReference dc, MemberReference mr, short mo, TypeReference[] et, short lw, short ow, byte[] bc, ExceptionHandlerMap eMap, int[] lm, LocalVariableTable lvt, int[] constantPool, Atom sig, RVMAnnotation[] annotations, RVMAnnotation[][] parameterAnnotations, Object ad)` Construct a normal Java bytecode method's information

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`computeSummary(int[] constantPool)` This method computes a summary of interesting method characteristics and stores an encoding of the summary as an int.
`void`	`finalizeOsrSpecialization()` Restores the original state of the method.
`protected CompiledMethod`	`genCode()` Generates the code for this method.
`int`	`getBytecodeLength()`
`BytecodeStream`	`getBytecodes()` Get a representation of the bytecodes in the code attribute of this method.
`void`	`getDynamicLink(DynamicLink dynamicLink, int bcIndex)` Fill in DynamicLink object for the invoke at the given bytecode index
`ExceptionHandlerMap`	`getExceptionHandlerMap()` Exceptions caught by this method.
`int`	`getLineNumberForBCIndex(int bci)` Return the line number information for the argument bytecode index.
`LocalVariableTable`	`getLocalVariableTable()`
`int`	`getLocalWords()`
`int`	`getOperandWords()`
`BytecodeStream`	`getOsrPrologue()` Returns a bytecode stream of osr prologue
`int`	`getOsrPrologueLength()` Returns the OSR prologue length for adjusting various tables and maps.
`BytecodeStream`	`getOsrSynthesizedBytecodes()` Returns the synthesized bytecode stream with osr prologue
`boolean`	`hasAllocation()`
`boolean`	`hasArrayRead()`
`boolean`	`hasArrayWrite()`
`boolean`	`hasBackwardsBranch()`
`boolean`	`hasCondBranch()`
`boolean`	`hasFieldRead()`
`boolean`	`hasFieldWrite()`
`boolean`	`hasInvoke()`
`boolean`	`hasJSR()`
`boolean`	`hasMagic()`
`boolean`	`hasSwitch()`
`boolean`	`hasSynch()`
`boolean`	`hasThrow()`
`int`	`inlinedSizeEstimate()`
`boolean`	`isForOsrSpecialization()` Checks if the method is in state for OSR specialization now
`boolean`	`isRuntimeServiceMethod()`
`boolean`	`mayWrite(RVMField field)`
`(package private) void`	`recomputeSummary(int[] constantPool)` For use by `RVMClass.allBootImageTypesResolved()` only.
`void`	`setForOsrSpecialization(byte[] prologue, short newStackHeight)` Sets method in state for OSR specialization, i.e, the subsequent calls of `getBytecodes()` return the stream of specialized bytecodes.
`void`	`setRuntimeServiceMethod(boolean value)` Set the value of the 'runtime service method' flag to the argument value.

Methods inherited from class org.jikesrvm.classloader.RVMMember
getDeclaringClass, getDescriptor, getId, getMemberRef, getModifiers, getName, getOffset, getSignature, hashCode, hasOffset, isPrivate, isProtected, isPublic, setOffset, toString

Methods inherited from class org.jikesrvm.classloader.AnnotatedElement
getAnnotation, getAnnotations, getAnnotationsInternal, getDeclaredAnnotations, getDeclaredAnnotationsInternal, hasAnnotations, hasBaselineNoRegistersAnnotation, hasBaselineSaveLSRegistersAnnotation, hasInlineAnnotation, hasInterruptibleAnnotation, hasLogicallyUninterruptibleAnnotation, hasNoBoundsCheckAnnotation, hasNoCheckStoreAnnotation, hasNoEscapesAnnotation, hasNoInlineAnnotation, hasNonMovingAllocationAnnotation, hasNonMovingAnnotation, hasNoNullCheckAnnotation, hasNoOptCompileAnnotation, hasPreemptibleAnnotation, hasPureAnnotation, hasRuntimeFinalAnnotation, hasRuntimePureAnnotation, hasUninterruptibleAnnotation, hasUninterruptibleNoWarnAnnotation, hasUnpreemptibleAnnotation, hasUnpreemptibleNoWarnAnnotation, hasUntracedAnnotation, isAnnotationDeclared, isAnnotationPresent, readAnnotations, toAnnotations

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

Methods inherited from interface java.lang.reflect.AnnotatedElement
getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotationsByType

- Field Detail
  - SIMPLE_OPERATION_COST
```
public static final int SIMPLE_OPERATION_COST
```
    See Also:
    
    Constant Field Values
  - LONG_OPERATION_COST
```
public static final int LONG_OPERATION_COST
```
    See Also:
    
    Constant Field Values
  - ARRAY_LOAD_COST
```
public static final int ARRAY_LOAD_COST
```
    See Also:
    
    Constant Field Values
  - ARRAY_STORE_COST
```
public static final int ARRAY_STORE_COST
```
    See Also:
    
    Constant Field Values
  - JSR_COST
```
public static final int JSR_COST
```
    See Also:
    
    Constant Field Values
  - CALL_COST
```
public static final int CALL_COST
```
    See Also:
    
    Constant Field Values
  - MAGIC_COST
```
public static final int MAGIC_COST
```
    See Also:
    
    Constant Field Values
  - ALLOCATION_COST
```
public static final int ALLOCATION_COST
```
    See Also:
    
    Constant Field Values
  - CLASS_CHECK_COST
```
public static final int CLASS_CHECK_COST
```
    See Also:
    
    Constant Field Values
  - STORE_CHECK_COST
```
public static final int STORE_CHECK_COST
```
    See Also:
    
    Constant Field Values
  - THROW_COST
```
public static final int THROW_COST
```
    See Also:
    
    Constant Field Values
  - SYNCH_COST
```
public static final int SYNCH_COST
```
    See Also:
    
    Constant Field Values
  - SWITCH_COST
```
public static final int SWITCH_COST
```
    See Also:
    
    Constant Field Values
  - HAS_MAGIC
```
private static final char HAS_MAGIC
```
    See Also:
    
    Constant Field Values
  - HAS_SYNCH
```
private static final char HAS_SYNCH
```
    See Also:
    
    Constant Field Values
  - HAS_ALLOCATION
```
private static final char HAS_ALLOCATION
```
    See Also:
    
    Constant Field Values
  - HAS_THROW
```
private static final char HAS_THROW
```
    See Also:
    
    Constant Field Values
  - HAS_INVOKE
```
private static final char HAS_INVOKE
```
    See Also:
    
    Constant Field Values
  - HAS_FIELD_READ
```
private static final char HAS_FIELD_READ
```
    See Also:
    
    Constant Field Values
  - HAS_FIELD_WRITE
```
private static final char HAS_FIELD_WRITE
```
    See Also:
    
    Constant Field Values
  - HAS_ARRAY_READ
```
private static final char HAS_ARRAY_READ
```
    See Also:
    
    Constant Field Values
  - HAS_ARRAY_WRITE
```
private static final char HAS_ARRAY_WRITE
```
    See Also:
    
    Constant Field Values
  - HAS_JSR
```
private static final char HAS_JSR
```
    See Also:
    
    Constant Field Values
  - HAS_COND_BRANCH
```
private static final char HAS_COND_BRANCH
```
    See Also:
    
    Constant Field Values
  - HAS_SWITCH
```
private static final char HAS_SWITCH
```
    See Also:
    
    Constant Field Values
  - HAS_BACK_BRANCH
```
private static final char HAS_BACK_BRANCH
```
    See Also:
    
    Constant Field Values
  - IS_RS_METHOD
```
private static final char IS_RS_METHOD
```
    See Also:
    
    Constant Field Values
  - summaryFlags
```
private char summaryFlags
```
    storage for bytecode summary flags
  - summarySize
```
private char summarySize
```
    storage for bytecode summary size
  - localWords
```
private final short localWords
```
    words needed for local variables (including parameters)
  - operandWords
```
private short operandWords
```
    words needed for operand stack (high water mark) TODO: OSR redesign; add subclass of NormalMethod for OSR method and then make this field final in NormalMethod.
  - bytecodes
```
private final byte[] bytecodes
```
    bytecodes for this method (null --> none)
  - exceptionHandlerMap
```
private final ExceptionHandlerMap exceptionHandlerMap
```
    try/catch/finally blocks for this method (null --> none)
  - lineNumberMap
```
private final int[] lineNumberMap
```
    pc to source-line info (null --> none) Each entry contains both the line number (upper 16 bits) and corresponding start PC (lower 16 bits).
  - localVariableTables
```
private static final HashMapRVM<NormalMethod,LocalVariableTable> localVariableTables
```
    the local variable table
  - synthesizedBytecodes
```
private static final HashMapRVM<NormalMethod,byte[]> synthesizedBytecodes
```
    Possible OSR bytecode array consisting of prologue and original bytecodes
  - osrPrologues
```
private static final HashMapRVM<NormalMethod,byte[]> osrPrologues
```
    Possible OSR record of osr prologue
  - savedOperandWords
```
private static final HashMapRVM<NormalMethod,Integer> savedOperandWords
```
    Possibly OSR prologue may change the maximum stack height, remember the original stack height
- Constructor Detail
  - NormalMethod
```
NormalMethod(TypeReference dc,
             MemberReference mr,
             short mo,
             TypeReference[] et,
             short lw,
             short ow,
             byte[] bc,
             ExceptionHandlerMap eMap,
             int[] lm,
             LocalVariableTable lvt,
             int[] constantPool,
             Atom sig,
             RVMAnnotation[] annotations,
             RVMAnnotation[][] parameterAnnotations,
             Object ad)
```
    Construct a normal Java bytecode method's information
    
    Parameters:
    
    dc - the TypeReference object of the class that declared this field
    
    mr - the canonical memberReference for this member.
    
    mo - modifiers associated with this member.
    
    et - exceptions thrown by this method.
    
    lw - the number of local words used by the bytecode of this method
    
    ow - the number of operand words used by the bytecode of this method
    
    bc - the bytecodes of this method
    
    eMap - the exception handler map for this method
    
    lm - the line number map for this method
    
    lvt - the local variable table for this method
    
    constantPool - the constantPool for this method
    
    sig - generic type of this method.
    
    annotations - array of runtime visible annotations
    
    parameterAnnotations - array of runtime visible paramter annotations
    
    ad - annotation default value for that appears in annotation classes
- Method Detail
  - genCode
```
protected CompiledMethod genCode()
                          throws VerifyError
```
    Description copied from class: RVMMethod
    
    Generates the code for this method.
    
    Specified by:
    
    genCode in class RVMMethod
    
    Returns:
    
    an object representing the compiled method
    
    Throws:
    
    VerifyError
  - getLocalWords
```
public int getLocalWords()
```
    Returns:
    
    space required by this method for its local variables, in words. Note: local variables include parameters
  - getOperandWords
```
public int getOperandWords()
```
    Returns:
    
    space required by this method for its operand stack, in words.
  - getBytecodes
```
public BytecodeStream getBytecodes()
```
    Get a representation of the bytecodes in the code attribute of this method.
    
    Returns:
    
    object representing the bytecodes
  - getDynamicLink
```
public void getDynamicLink(DynamicLink dynamicLink,
                           int bcIndex)
```
    Fill in DynamicLink object for the invoke at the given bytecode index
    
    Parameters:
    
    dynamicLink - the dynamicLink object to initialize
    
    bcIndex - the bcIndex of the invoke instruction
  - getBytecodeLength
```
public int getBytecodeLength()
```
  - getExceptionHandlerMap
```
public ExceptionHandlerMap getExceptionHandlerMap()
```
    Exceptions caught by this method.
    
    Returns:
    
    info (null --> method doesn't catch any exceptions)
  - getLineNumberForBCIndex
```
public int getLineNumberForBCIndex(int bci)
```
    Return the line number information for the argument bytecode index.
    
    Parameters:
    
    bci - bytecode index
    
    Returns:
    
    The line number, a positive integer. Zero means unable to find.
  - isForOsrSpecialization
```
public boolean isForOsrSpecialization()
```
    Checks if the method is in state for OSR specialization now
    
    Returns:
    
    true, if it is (with prologue)
  - setForOsrSpecialization
```
public void setForOsrSpecialization(byte[] prologue,
                                    short newStackHeight)
```
    Sets method in state for OSR specialization, i.e, the subsequent calls of getBytecodes() return the stream of specialized bytecodes.
    NB: between flag and action, it should not allow GC or threadSwitch happen.
    
    Parameters:
    
    prologue - The bytecode of prologue
    
    newStackHeight - The prologue may change the default height of stack
  - finalizeOsrSpecialization
```
public void finalizeOsrSpecialization()
```
    Restores the original state of the method.
  - getOsrPrologueLength
```
public int getOsrPrologueLength()
```
    Returns the OSR prologue length for adjusting various tables and maps.
    
    Returns:
    
    the length of prologue if the method is in state for OSR, 0 otherwise.
  - getOsrPrologue
```
public BytecodeStream getOsrPrologue()
```
    Returns a bytecode stream of osr prologue
    
    Returns:
    
    osr prologue bytecode stream
  - getOsrSynthesizedBytecodes
```
public BytecodeStream getOsrSynthesizedBytecodes()
```
    Returns the synthesized bytecode stream with osr prologue
    
    Returns:
    
    bytecode stream
  - inlinedSizeEstimate
```
public int inlinedSizeEstimate()
```
    Returns:
    
    An estimate of the expected size of the machine code instructions that will be generated by the opt compiler if the method is inlined.
  - hasMagic
```
public boolean hasMagic()
```
    Returns:
    
    true if the method contains a Magic.xxx or Address.yyy
  - hasSynch
```
public boolean hasSynch()
```
    Returns:
    
    true if the method contains a monitorenter/exit or is synchronized
  - hasAllocation
```
public boolean hasAllocation()
```
    Returns:
    
    true if the method contains an allocation
  - hasThrow
```
public boolean hasThrow()
```
    Returns:
    
    true if the method contains an athrow
  - hasInvoke
```
public boolean hasInvoke()
```
    Returns:
    
    true if the method contains an invoke
  - hasFieldRead
```
public boolean hasFieldRead()
```
    Returns:
    
    true if the method contains a getfield or getstatic
  - hasFieldWrite
```
public boolean hasFieldWrite()
```
    Returns:
    
    true if the method contains a putfield or putstatic
  - hasArrayRead
```
public boolean hasArrayRead()
```
    Returns:
    
    true if the method contains an array load
  - hasArrayWrite
```
public boolean hasArrayWrite()
```
    Returns:
    
    true if the method contains an array store
  - hasJSR
```
public boolean hasJSR()
```
    Returns:
    
    true if the method contains a jsr
  - hasCondBranch
```
public boolean hasCondBranch()
```
    Returns:
    
    true if the method contains a conditional branch
  - hasSwitch
```
public boolean hasSwitch()
```
    Returns:
    
    true if the method contains a switch
  - hasBackwardsBranch
```
public boolean hasBackwardsBranch()
```
    Returns:
    
    true if the method contains a backwards branch
  - isRuntimeServiceMethod
```
public boolean isRuntimeServiceMethod()
```
    Overrides:
    
    isRuntimeServiceMethod in class RVMMethod
    
    Returns:
    
    true if the method is the implementation of a runtime service that is called "under the covers" from the generated code and thus is not subject to inlining via the normal mechanisms.
  - setRuntimeServiceMethod
```
public void setRuntimeServiceMethod(boolean value)
```
    Set the value of the 'runtime service method' flag to the argument value. A method is considered to be a runtime service method if it is only/primarily invoked "under the covers" from the generated code and thus is not subject to inlining via the normal mechanisms. For example, the implementations of bytecodes such as new or checkcast or the implementation of yieldpoints.
    
    Parameters:
    
    value - true if this is a runtime service method, false it is not.
  - mayWrite
```
public boolean mayWrite(RVMField field)
```
    Overrides:
    
    mayWrite in class RVMMethod
    
    Parameters:
    
    field - the field whose write access is supposed to be checked
    
    Returns:
    
    true if the method may write to a given field
  - recomputeSummary
```
void recomputeSummary(int[] constantPool)
```
    For use by RVMClass.allBootImageTypesResolved() only.
    
    Parameters:
    
    constantPool - the constant pool
  - computeSummary
```
private void computeSummary(int[] constantPool)
```
    This method computes a summary of interesting method characteristics and stores an encoding of the summary as an int.
    
    Parameters:
    
    constantPool - the constant pool
  - getLocalVariableTable
```
public LocalVariableTable getLocalVariableTable()
```
    Returns:
    
    LocalVariableTable associated with this method

Class NormalMethod

Field Summary

Fields inherited from class org.jikesrvm.classloader.RVMMethod

Fields inherited from class org.jikesrvm.classloader.RVMMember

Fields inherited from class org.jikesrvm.classloader.AnnotatedElement

Constructor Summary

Method Summary

Methods inherited from class org.jikesrvm.classloader.RVMMethod

Methods inherited from class org.jikesrvm.classloader.RVMMember

Methods inherited from class org.jikesrvm.classloader.AnnotatedElement

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.reflect.AnnotatedElement

Field Detail

SIMPLE_OPERATION_COST

LONG_OPERATION_COST

ARRAY_LOAD_COST

ARRAY_STORE_COST

JSR_COST

CALL_COST

MAGIC_COST

ALLOCATION_COST

CLASS_CHECK_COST

STORE_CHECK_COST

THROW_COST

SYNCH_COST

SWITCH_COST

HAS_MAGIC

HAS_SYNCH

HAS_ALLOCATION

HAS_THROW

HAS_INVOKE

HAS_FIELD_READ

HAS_FIELD_WRITE

HAS_ARRAY_READ

HAS_ARRAY_WRITE

HAS_JSR

HAS_COND_BRANCH

HAS_SWITCH

HAS_BACK_BRANCH

IS_RS_METHOD

summaryFlags

summarySize

localWords

operandWords

bytecodes

exceptionHandlerMap

lineNumberMap

localVariableTables

synthesizedBytecodes

osrPrologues

savedOperandWords

Constructor Detail

NormalMethod

Method Detail

genCode

getLocalWords

getOperandWords

getBytecodes

getDynamicLink

getBytecodeLength

getExceptionHandlerMap

getLineNumberForBCIndex

isForOsrSpecialization

setForOsrSpecialization

finalizeOsrSpecialization

getOsrPrologueLength

getOsrPrologue

getOsrSynthesizedBytecodes

inlinedSizeEstimate

hasMagic

hasSynch

hasAllocation

hasThrow

hasInvoke

hasFieldRead

hasFieldWrite

hasArrayRead

hasArrayWrite

hasJSR

hasCondBranch