org.jikesrvm.classloader

Class RVMMethod

java.lang.Object

org.jikesrvm.classloader.AnnotatedElement

org.jikesrvm.classloader.RVMMember

org.jikesrvm.classloader.RVMMethod

All Implemented Interfaces:

AnnotatedElement

Direct Known Subclasses:

AbstractMethod, NativeMethod, NormalMethod

public abstract class RVMMethod
extends RVMMember

A method of a java class corresponding to a method_info structure in the class file. A method is read from a class file using the readMethod(org.jikesrvm.classloader.TypeReference, int[], org.jikesrvm.classloader.MemberReference, short, java.io.DataInputStream) method.

Field Summary

Fields

Modifier and Type	Field and Description
private static HashMapRVM<RVMMethod,Object>	annotationDefaults A table mapping to values present in the method info tables of annotation types.
protected CompiledMethod	currentCompiledMethod current compiled method for this method
private static ImmutableEntryHashMapRVM<RVMMethod,Annotation[][]>	declaredParameterAnnotations Cache of arrays of declared parameter annotations.
private static ImmutableEntryHashMapRVM<RVMMethod,TypeReference[]>	exceptionTypes exceptions this method might throw (null --> none)
private static ImmutableEntryHashMapRVM<RVMMethod,ReflectionBase>	invokeMethods Map from a method to a reflective method capable of invoking it
private static ImmutableEntryHashMapRVM<RVMMethod,Integer>	jtocOffsets The offsets of virtual methods in the JTOC, if it's been placed there by constant propagation.
private static ImmutableEntryHashMapRVM<RVMMethod,RVMAnnotation[][]>	parameterAnnotations Method parameter annotations from the class file that are described as runtime visible.

Fields inherited from class org.jikesrvm.classloader.RVMMember

memRef, modifiers, offset

Fields inherited from class org.jikesrvm.classloader.AnnotatedElement

declaredAnnotationDatas

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RVMMethod(TypeReference declaringClass, MemberReference memRef, short modifiers, TypeReference[] exceptionTypes, Atom signature, RVMAnnotation[] annotations, RVMAnnotation[][] parameterAnnotations, Object annotationDefault) Construct a read method

Method Summary

Modifier and Type	Method and Description
void	compile() Generate machine code for this method if valid machine code doesn't already exist.
(package private) static RVMMethod	createDefaultConstructor(TypeReference klass, MemberReference memRef) Create a method to act as a default constructor (just return)
(package private) RVMMethod	createReflectionMethod(TypeReference reflectionClass, int[] constantPool, MethodReference memRef) Create a method for reflectively invoking this method
Offset	findOrCreateJtocOffset() Finds or create a JTOC offset for this method.
protected abstract CompiledMethod	genCode() Generates the code for this method.
Object	getAnnotationDefault()
CompiledMethod	getCurrentCompiledMethod() Get the current compiled method for this method.
CodeArray	getCurrentEntryCodeArray() Get the code array that corresponds to the entry point (prologue) for the method.
Annotation[][]	getDeclaredParameterAnnotations()
TypeReference[]	getExceptionTypes() Exceptions thrown by this method - something like { "java/lang/IOException", "java/lang/EOFException" }
ReflectionBase	getInvoker()
private Offset	getJtocOffset() Gets the offset used to hold a JTOC addressable version of the current entry code array.
private RVMAnnotation[][]	getParameterAnnotations()
TypeReference[]	getParameterTypes()
int	getParameterWords()
TypeReference	getReturnType()
boolean	hasNoInlinePragma() Has this method been marked as forbidden to inline?
void	invalidateCompiledMethod(CompiledMethod cm) Invalidates the given compiled method if it is the current compiled code for this method.
boolean	isAbstract()
boolean	isBridge()
boolean	isClassInitializer()
boolean	isCompiled()
boolean	isFinal()
boolean	isInterruptible() Is this method interruptible?
boolean	isNative()
boolean	isNonMovingAllocation()
boolean	isObjectInitializer()
boolean	isObjectInitializerHelper()
boolean	isPure() Is the method Pure?
boolean	isRuntimePure() Is the method RuntimePure?
boolean	isRuntimeServiceMethod()
boolean	isSpecializedInvoke()
boolean	isStatic()
boolean	isStrictFP()
boolean	isSynchronized()
boolean	isSynthetic()
boolean	isSysCall()
boolean	isUninterruptible() Is the method Uninterruptible?
boolean	isUnpreemptible() Is the method Unpreemptible?
boolean	isVarArgs()
boolean	mayWrite(RVMField field)
(package private) static RVMMethod	readMethod(TypeReference declaringClass, int[] constantPool, MemberReference memRef, short modifiers, DataInputStream input) Called from ClassFileReader.readClass(TypeReference,DataInputStream) to create an instance of a RVMMethod by reading the relevant data from the argument bytecode stream.
void	replaceCompiledMethod(CompiledMethod compiledMethod) Change machine code that will be used by future executions of this method (ie. optimized <-> non-optimized) Side effect: updates JTOC or method dispatch tables ("type information blocks") for this class and its subclasses

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

currentCompiledMethod

protected CompiledMethod currentCompiledMethod

current compiled method for this method

exceptionTypes

private static final ImmutableEntryHashMapRVM<RVMMethod,TypeReference[]> exceptionTypes

exceptions this method might throw (null --> none)

parameterAnnotations

private static final ImmutableEntryHashMapRVM<RVMMethod,RVMAnnotation[][]> parameterAnnotations

Method parameter annotations from the class file that are described as runtime visible. These annotations are available to the reflection API.

annotationDefaults

private static final HashMapRVM<RVMMethod,Object> annotationDefaults

A table mapping to values present in the method info tables of annotation types. It represents the default result from an annotation method.

jtocOffsets

private static final ImmutableEntryHashMapRVM<RVMMethod,Integer> jtocOffsets

The offsets of virtual methods in the JTOC, if it's been placed there by constant propagation.

declaredParameterAnnotations

private static final ImmutableEntryHashMapRVM<RVMMethod,Annotation[][]> declaredParameterAnnotations

Cache of arrays of declared parameter annotations.

invokeMethods

private static final ImmutableEntryHashMapRVM<RVMMethod,ReflectionBase> invokeMethods

Map from a method to a reflective method capable of invoking it

Constructor Detail

RVMMethod

protected RVMMethod(TypeReference declaringClass,
                    MemberReference memRef,
                    short modifiers,
                    TypeReference[] exceptionTypes,
                    Atom signature,
                    RVMAnnotation[] annotations,
                    RVMAnnotation[][] parameterAnnotations,
                    Object annotationDefault)

Construct a read method

Parameters:

declaringClass - the RVMClass object of the class that declared this field

memRef - the canonical memberReference for this method.

modifiers - modifiers associated with this method.

exceptionTypes - exceptions thrown by this method.

signature - generic type of this method.

annotations - array of runtime visible annotations

parameterAnnotations - array of runtime visible parameter annotations

annotationDefault - value for this annotation that appears

Method Detail

getParameterAnnotations

private RVMAnnotation[][] getParameterAnnotations()

Returns:

the parameter annotations for this method

getAnnotationDefault

public Object getAnnotationDefault()

Returns:

the annotation default value for an annotation method

readMethod

static RVMMethod readMethod(TypeReference declaringClass,
                            int[] constantPool,
                            MemberReference memRef,
                            short modifiers,
                            DataInputStream input)
                     throws IOException

Called from ClassFileReader.readClass(TypeReference,DataInputStream) to create an instance of a RVMMethod by reading the relevant data from the argument bytecode stream.

Parameters:

declaringClass - the TypeReference of the class being loaded

constantPool - the constantPool of the RVMClass object that's being constructed

memRef - the canonical memberReference for this member.

modifiers - modifiers associated with this member.

input - the DataInputStream to read the method's attributes from

Returns:

the newly created method

Throws:

IOException - when the underlying stream throws an IOException or when the skipping of attributes does not work as expected

isClassInitializer

public final boolean isClassInitializer()

Returns:

true if this method is a class initializer

isObjectInitializer

public final boolean isObjectInitializer()

Returns:

true if this method is an object initializer

isObjectInitializerHelper

public final boolean isObjectInitializerHelper()

Returns:

true if this method is a a compiler-generated object initializer helper

getReturnType

public final TypeReference getReturnType()

getParameterTypes

public final TypeReference[] getParameterTypes()

Returns:

the types of this method's parameters. Note: does *not* include implicit "this" parameter, if any.

getParameterWords

public final int getParameterWords()

Returns:

space required by this method for its parameters, in words. Note: does *not* include implicit "this" parameter, if any.

isCompiled

public final boolean isCompiled()

Returns:

true if machine code has been generated for this method's bytecodes

getCurrentCompiledMethod

public final CompiledMethod getCurrentCompiledMethod()

Get the current compiled method for this method. Will return null if there is no current compiled method!

We make this method Unpreemptible to avoid a race-condition in Reflection.invoke.

Returns:

compiled method or null if none exists

isStatic

public final boolean isStatic()

Returns:

true if this method is declared as statically dispatched

isFinal

public final boolean isFinal()

Returns:

true if this method is declared as non-overridable by subclasses

isSynchronized

public final boolean isSynchronized()

Returns:

true if this method is guarded by monitorenter/monitorexit

isNative

public final boolean isNative()

Returns:

true if this method is not implemented in java

isStrictFP

public final boolean isStrictFP()

Returns:

true if IEEE 754 rules need to be strictly enforced for this method

isSysCall

public final boolean isSysCall()

Returns:

true if this is a method that's not implemented in Java and use C not JNI calling convention

See Also:

SysCall

isSpecializedInvoke

public final boolean isSpecializedInvoke()

Returns:

true if this is a specialized method invoke

See Also:

SpecializedMethod, SpecializedMethodManager

isAbstract

public final boolean isAbstract()

Returns:

true if this method needs to be implemented by subclasses

isSynthetic

public boolean isSynthetic()

Returns:

true if this method is not present in the source code file (e.g. because it has been added by a Java compiler like javac)

isBridge

public boolean isBridge()

Returns:

true if this method is a bridge method. Bridge methods are generated in some cases of generics and inheritance.

isVarArgs

public boolean isVarArgs()

Returns:

true if ts this a varargs method taking a variable number of arguments

getExceptionTypes

public final TypeReference[] getExceptionTypes()

Exceptions thrown by this method - something like { "java/lang/IOException", "java/lang/EOFException" }

Returns:

exception info or null if this method doesn't throw any exceptions

isInterruptible

public final boolean isInterruptible()

Is this method interruptible? In other words, should the compiler insert yieldpoints in method prologue, epilogue, and backwards branches. Also, only methods that are Interruptible have stackoverflow checks in the method prologue (since there is no mechanism for handling a stackoverflow that doesn't violate the uninterruptiblity of the method). To determine if a method is interruptible, the following conditions are checked (in order):

• If it is a <clinit> or <init> method then it is interruptible.
• If is the synthetic 'this' method used by jikes to factor out default initializers for <init> methods then it is interruptible.
• If it is annotated with @Interruptible it is interruptible.
• If it is annotated with @Preemptible it is interruptible.
• If it is annotated with @Uninterruptible it is not interruptible.
• If it is annotated with @UninterruptibleNoWarn it is not interruptible.
• If it is annotated with @Unpreemptible it is not interruptible.
• If its declaring class is annotated with @Uninterruptible or @Unpreemptible it is not interruptible.

Returns:

true if and only if this method is interruptible

isUnpreemptible

public final boolean isUnpreemptible()

Is the method Unpreemptible? See the comment in isInterruptible()

Returns:

true if and only if this method is unpreemptible

isUninterruptible

public final boolean isUninterruptible()

Is the method Uninterruptible? See the comment in isInterruptible()

Returns:

true if and only if this method is uninterruptible

isPure

public final boolean isPure()

Is the method Pure? That is would it, without any side effects, return the same value given the same arguments?

Returns:

whether the method has a pure annotation

isRuntimePure

public final boolean isRuntimePure()

Is the method RuntimePure? This is the same as Pure at runtime but has a special return value at boot image writing time

Returns:

whether the method has a pure annotation

hasNoInlinePragma

public final boolean hasNoInlinePragma()

Has this method been marked as forbidden to inline? ie., it is marked with the NoInline annotation or the NoOptCompile annotation?

Returns:

true if this method must not be inlined

mayWrite

public boolean mayWrite(RVMField field)

Parameters:

field - the field whose write access is supposed to be checked

Returns:

true if the method may write to a given field

isRuntimeServiceMethod

public boolean isRuntimeServiceMethod()

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.

isNonMovingAllocation

public boolean isNonMovingAllocation()

Returns:

true if all allocation from this method must go to a non-moving space

See Also:

NonMovingAllocation

getCurrentEntryCodeArray

public final CodeArray getCurrentEntryCodeArray()

Get the code array that corresponds to the entry point (prologue) for the method.

Returns:

the code array for the method

compile

public final void compile()

Generate machine code for this method if valid machine code doesn't already exist.

genCode

protected abstract CompiledMethod genCode()

Generates the code for this method.

Returns:

an object representing the compiled method

replaceCompiledMethod

public final void replaceCompiledMethod(CompiledMethod compiledMethod)

Change machine code that will be used by future executions of this method (ie. optimized <-> non-optimized)

Side effect: updates JTOC or method dispatch tables ("type information blocks") for this class and its subclasses

Parameters:

compiledMethod - new machine code

invalidateCompiledMethod

public final void invalidateCompiledMethod(CompiledMethod cm)

Invalidates the given compiled method if it is the current compiled code for this method.

Parameters:

cm - the compiled method to try to invalidate

getJtocOffset

private Offset getJtocOffset()

Gets the offset used to hold a JTOC addressable version of the current entry code array.

Returns:

the JTOC offset

findOrCreateJtocOffset

public final Offset findOrCreateJtocOffset()

Finds or create a JTOC offset for this method.

Returns:

the JTOC offset

getDeclaredParameterAnnotations

public final Annotation[][] getDeclaredParameterAnnotations()

Returns:

the parameter annotations for this method.

getInvoker

public ReflectionBase getInvoker()

Returns:

an instance of an object capable of reflectively invoking this method

createDefaultConstructor

static RVMMethod createDefaultConstructor(TypeReference klass,
                                          MemberReference memRef)

Create a method to act as a default constructor (just return)

Parameters:

klass - class for method

memRef - reference for default constructor

Returns:

method normal (bytecode containing) method that just returns

createReflectionMethod

RVMMethod createReflectionMethod(TypeReference reflectionClass,
                                 int[] constantPool,
                                 MethodReference memRef)

Create a method for reflectively invoking this method

Parameters:

reflectionClass - the class this method will belong to

constantPool - for the class

memRef - the member reference corresponding to this method

Returns:

the created method