de.uni_hildesheim.sse.monitoring.runtime.instrumentation

Class MethodEditor

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.BehaviorEditor

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.MethodEditor

public class MethodEditor
extends de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.BehaviorEditor

Implements the usual instrumentation for methods. Call clear() after usage! This class is public for testing.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private static HashMap<java.lang.String,java.lang.String>	annotatedFields Stores the relation among annotated fields and recording ids (may be null if not specified).
private ISemanticsCollector	collector Stores the semantics collector (may be null).
static java.lang.String[]	GET_INPUT_ERROR_STREAM_CLASSES Stores all classes which need instrumentation of a getErrorStream (as InputStream) method.
static java.lang.String[]	GET_INPUT_STREAM_CLASSES Stores all classes which need instrumentation of a getInputStream method.
static java.lang.String[]	GET_OPEN_STREAM_CLASSES Stores all classes which need instrumentation of a getOpenStream method.
static java.lang.String[]	GET_OUTPUT_STREAM_CLASSES Stores all classes which need instrumentation of a getOutputStream method.
private GroupAccountingType	groupAccounting Stores the group accounting type.
private ValueContext	lastFieldAccessContext Stores the context annotation of the last field access.
private java.lang.String	lastFieldAccessType Stores the type of the last field access.
private MemoryAccountingType	memoryAccounting Stores how memory use shall be monitored.
private int	memRecord Stores the (temporary) instrumentation record of memory resouces to facilitate safe monitoring-class redefinition.
private boolean	monitorCpuTime Stores whether CPU time shall be monitored.
private boolean	monitorFileIo Stores whether file I/O shall be monitored.
private boolean	monitorNetIo Stores whether network I/O shall be monitored.
private static ArrayList<MethodEditor>	POOL Stores the instance pool.
private Monitor	semantics Stores the semantics to be applied.
protected static java.lang.String	URL_TYPE_EXPR Defines the call to determine the type of a stream.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MethodEditor() Creates a new method editor (and prevents instantiation from outside this package).

Method Summary

Modifier and Type	Method and Description
(package private) void	assignSemantics(java.lang.String cls, java.lang.String name, java.lang.String methodSignature) Assigns the stored monitoring semantics to the given method (methodSignature) in class with name cls.
void	clear() Clears temporary variables for instance reuse.
void	editFieldAccess(java.lang.String name, java.lang.String type, boolean isWriter) Instruments a field access for notifying the recorder about value changes.
void	editMethodCall(java.lang.String name, java.lang.String signature, java.lang.String targetClass) Instruments a method call.
void	editNewArray() Instruments the creation of an array.
void	editNewExpression(java.lang.String type) Instruments an object creation.
private java.lang.String	getContextValueChangeCallRecId(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IStatementModifier mod) Returns the context id for the current method call.
private static java.lang.String	getFieldId(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IField field) Produces an id for the given field.
private static java.lang.String	getFieldId(java.lang.String declaringClassName, java.lang.String name) Produces an id for the given field.
static MethodEditor	getFromPool(Monitor semantics, boolean useSumResources, ISemanticsCollector collector, boolean inherited) Returns an instance from the pool.
GroupAccountingType	getGroupAccountingType() Returns the group accounting type.
MemoryAccountingType	getMemoryAccountingType() Returns the memory accounting type.
int	getMemRecord() Returns the instrumentation record for memory.
boolean	instrumentCpuTime() Returns whether CPU time shall be monitored.
boolean	instrumentFileIo() Returns whether file I/O shall be monitored.
boolean	instrumentNetIo() Returns whether network I/O shall be monitored.
protected boolean	mcDeclaringClassInstanceOf(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IStatementModifier mod, java.lang.String[] types) Returns whether the declaring class of the current method call is instance of at least one of the given types, whereby types may be superclasses.
protected boolean	processNetIoMethodCall(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IStatementModifier mod, java.lang.String name) Processes a net I/O method call (intended to be called if library is not instrumented or overhead instrumentation is done).
protected boolean	processOtherIoMethodCall(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IStatementModifier mod, java.lang.String name) Processes other I/O method (in case that library is instrumented).
static void	put(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IField field, java.lang.String id) Stores an annotated field.
static void	release(MethodEditor editor) Releases the given instance.
void	setGroup(Monitor semantics, boolean useSumResources, ISemanticsCollector collector, boolean inherited) Defines the actual group annotation.
void	setInstrumentationRecord(MethodInstrumented record) Defines the instrumentation record for the current method under transformation.

Methods inherited from class de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.BehaviorEditor

getCodeModifier, setCodeModifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GET_OUTPUT_STREAM_CLASSES

public static final java.lang.String[] GET_OUTPUT_STREAM_CLASSES

Stores all classes which need instrumentation of a getOutputStream method. Do not refer via classes as these classes should not be loaded before (dynamic) instrumentation.

GET_INPUT_STREAM_CLASSES

public static final java.lang.String[] GET_INPUT_STREAM_CLASSES

Stores all classes which need instrumentation of a getInputStream method. Do not refer via classes as these classes should not be loaded before (dynamic) instrumentation.

GET_INPUT_ERROR_STREAM_CLASSES

public static final java.lang.String[] GET_INPUT_ERROR_STREAM_CLASSES

Stores all classes which need instrumentation of a getErrorStream (as InputStream) method. Do not refer via classes as these classes should not be loaded before (dynamic) instrumentation.

GET_OPEN_STREAM_CLASSES

public static final java.lang.String[] GET_OPEN_STREAM_CLASSES

Stores all classes which need instrumentation of a getOpenStream method. Do not refer via classes as these classes should not be loaded before (dynamic) instrumentation.

URL_TYPE_EXPR

protected static final java.lang.String URL_TYPE_EXPR

Defines the call to determine the type of a stream.

annotatedFields

private static HashMap<java.lang.String,java.lang.String> annotatedFields

Stores the relation among annotated fields and recording ids (may be null if not specified).

POOL

private static final ArrayList<MethodEditor> POOL

Stores the instance pool.

lastFieldAccessType

private java.lang.String lastFieldAccessType

Stores the type of the last field access.

lastFieldAccessContext

private ValueContext lastFieldAccessContext

Stores the context annotation of the last field access.

memRecord

private int memRecord

Stores the (temporary) instrumentation record of memory resouces to facilitate safe monitoring-class redefinition.

collector

private ISemanticsCollector collector

Stores the semantics collector (may be null).

semantics

private Monitor semantics

Stores the semantics to be applied.

monitorCpuTime

private boolean monitorCpuTime

Stores whether CPU time shall be monitored.

memoryAccounting

private MemoryAccountingType memoryAccounting

Stores how memory use shall be monitored.

groupAccounting

private GroupAccountingType groupAccounting

Stores the group accounting type.

monitorFileIo

private boolean monitorFileIo

Stores whether file I/O shall be monitored.

monitorNetIo

private boolean monitorNetIo

Stores whether network I/O shall be monitored.

Constructor Detail

MethodEditor

private MethodEditor()

Creates a new method editor (and prevents instantiation from outside this package).

Since:

1.00

Method Detail

getFromPool

public static final MethodEditor getFromPool(Monitor semantics,
                                             boolean useSumResources,
                                             ISemanticsCollector collector,
                                             boolean inherited)

Returns an instance from the pool.

Parameters:

semantics - the actual group annotation (may be null)

useSumResources - use the sum resources specified in the configuration instead of group

collector - the instance to be used for collecting semantics for future retransformations (may be null)

inherited - whether semantics is inherited

Returns:

an instance

Since:

1.00

release

public static final void release(MethodEditor editor)

Releases the given instance.

Parameters:

editor - the instance to release

Since:

1.00

processNetIoMethodCall

protected boolean processNetIoMethodCall(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IStatementModifier mod,
                                         java.lang.String name)
                                  throws de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException

Processes a net I/O method call (intended to be called if library is not instrumented or overhead instrumentation is done).

Parameters:

mod - the statement modifier instance

name - the name of the method being called

Returns:

was code modification done or not

Throws:

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException - if new code cannot be compiled

Since:

1.00

mcDeclaringClassInstanceOf

protected boolean mcDeclaringClassInstanceOf(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IStatementModifier mod,
                                             java.lang.String[] types)
                                      throws de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException

Returns whether the declaring class of the current method call is instance of at least one of the given types, whereby types may be superclasses.

Parameters:

mod - the statement modifier

types - the classes to test for

Returns:

true if clazz is a subclass of at least one of types, false else

Throws:

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException - declaring class not found

Since:

1.00

processOtherIoMethodCall

protected boolean processOtherIoMethodCall(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IStatementModifier mod,
                                           java.lang.String name)
                                    throws de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException

Processes other I/O method (in case that library is instrumented).

Parameters:

mod - the statement modifier instance

name - the name of the method being called

Returns:

was code modification done or not

Throws:

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException - in case that new code cannot be compiled

Since:

1.00

setGroup

public void setGroup(Monitor semantics,
                     boolean useSumResources,
                     ISemanticsCollector collector,
                     boolean inherited)

Defines the actual group annotation.

Parameters:

semantics - the actual annotation holding the monitoring group semantics

useSumResources - use the sum resources specified in the configuration instead of group

collector - the instance to be used for collecting semantics for future retransformations (may be null)

inherited - whether semantics is inherited

Since:

1.00

instrumentCpuTime

public boolean instrumentCpuTime()

Returns whether CPU time shall be monitored.

Returns:

true if CPU time shall be monitored, false else

Since:

1.00

instrumentNetIo

public boolean instrumentNetIo()

Returns whether network I/O shall be monitored.

Returns:

true if network I/O shall be monitored, false else

Since:

1.00

instrumentFileIo

public boolean instrumentFileIo()

Returns whether file I/O shall be monitored.

Returns:

true if file I/O shall be monitored, false else

Since:

1.00

getMemoryAccountingType

public MemoryAccountingType getMemoryAccountingType()

Returns the memory accounting type.

Returns:

the memory accounting type

Since:

1.00

getGroupAccountingType

public GroupAccountingType getGroupAccountingType()

Returns the group accounting type.

Returns:

the group accounting type

Since:

1.00

assignSemantics

void assignSemantics(java.lang.String cls,
                     java.lang.String name,
                     java.lang.String methodSignature)

Assigns the stored monitoring semantics to the given method (methodSignature) in class with name cls.

Parameters:

cls - the class to assign the semantics to

name - the name of the method

methodSignature - the signature of the method to assign the semantics to

Since:

1.00

put

public static void put(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IField field,
                       java.lang.String id)

Stores an annotated field.

Parameters:

field - the annotated filed

id - the annotated recorded id

Since:

1.00

editNewExpression

public void editNewExpression(java.lang.String type)
                       throws de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException

Instruments an object creation.

Overrides:

editNewExpression in class de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.BehaviorEditor

Parameters:

type - the type to be created

Throws:

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException - in case that the new code does not compile

editNewArray

public void editNewArray()
                  throws de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException

Instruments the creation of an array.

Overrides:

editNewArray in class de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.BehaviorEditor

Throws:

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException - in case that the new code does not compile

editMethodCall

public void editMethodCall(java.lang.String name,
                           java.lang.String signature,
                           java.lang.String targetClass)
                    throws de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException

Instruments a method call. For detailed information please consider the mc* methods in BehaviorEditor.getCodeModifier().

Overrides:

editMethodCall in class de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.BehaviorEditor

Parameters:

name - the name of the method being called

signature - the JVM signature of the method

targetClass - the class being called

Throws:

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException - in case that the new code does not compile

getContextValueChangeCallRecId

private java.lang.String getContextValueChangeCallRecId(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IStatementModifier mod)
                                                 throws de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException

Returns the context id for the current method call. If there is a last field access with the same type where the method is accessed and the method call is not static, then check the last field access for the ValueContext method and return the id.

Parameters:

mod - the statement modifier to gather information from

Returns:

the context id or null

Throws:

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException - in case that the method call or the declaring class cannot be found

Since:

1.00

editFieldAccess

public void editFieldAccess(java.lang.String name,
                            java.lang.String type,
                            boolean isWriter)
                     throws de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException

Instruments a field access for notifying the recorder about value changes.

Overrides:

editFieldAccess in class de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.BehaviorEditor

Parameters:

name - the name of the field

type - the type of the field

isWriter - whether the field value is changed

Throws:

de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.InstrumenterException - in case that the new code does not compile

getFieldId

private static java.lang.String getFieldId(de.uni_hildesheim.sse.monitoring.runtime.instrumentation.lib.IField field)

Produces an id for the given field. Avoid storing the references of the bytecode framework in order to allow cleaning up references.

Parameters:

field - the field to return the id for

Returns:

the id

Since:

1.00

getFieldId

private static java.lang.String getFieldId(java.lang.String declaringClassName,
                                           java.lang.String name)

Produces an id for the given field. Avoid storing the references of the bytecode framework in order to allow cleaning up references.

Parameters:

declaringClassName - the name of the class declaring the field

name - the name of the field

Returns:

the id

Since:

1.00

clear

public void clear()

Clears temporary variables for instance reuse.

Since:

1.00

setInstrumentationRecord

public void setInstrumentationRecord(MethodInstrumented record)

Defines the instrumentation record for the current method under transformation.

Parameters:

record - the instrumentation record (null clears the record)

Since:

1.00

getMemRecord

public int getMemRecord()

Returns the instrumentation record for memory.

Returns:

the instrumentation record

Since:

1.00