de.uni_hildesheim.sse.monitoring.runtime.boot

Class RecorderAccess

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.boot.RecorderAccess

public class RecorderAccess
extends java.lang.Object

Provides static access to RecorderFrontend. This is needed because calls to the recorder before recording is started would otherwise result in a NullPointerException. Conversely, the recorder RecorderFrontend is needed in order to hide the dependencies of the concrete implementation which would lead to a dependency cycle while instrumentation and class loading.

Since:

1.00

Version:

1.20

Author:

Holger Eichelberger

Constructor Summary

Constructors

Modifier	Constructor and Description
private	RecorderAccess() Prevents this class from being instantiated from outside.

Method Summary

Modifier and Type	Method and Description
static void	assignAllTo(java.lang.String recId, boolean enter) Notifies that the following values (if not further calls to this method or other recording ids occur) should be assigned to the given recId.
static void	changeValueContext(java.lang.String id, boolean push) Notifies the recorder about changing the value context.
static void	configurationChange(java.lang.String ids) Notify the recorder that a new variability configuration might have been entered.
static void	enableVariabilityDetection(boolean enable) Changes if automated variability detection should be enabled or not.
static void	endSystem() Notifies about the end of the monitored program.
static void	enter(java.lang.String caller, java.lang.String recId, boolean exclude, boolean directId, long instanceId) Notifies the recorder about a method being called.
static void	exit(java.lang.String caller, java.lang.String recId, boolean exclude, boolean directId, long instanceId) Notifies the recorder about a method being exited.
static void	memoryAllocated(java.lang.Object allocated) Notifies the recorder about an object allocated to memory.
static void	memoryAllocated(java.lang.Object tag, long size) Notifies the recorder about an object allocated to memory.
static void	memoryFreed(long tag, long size) Notifies the recorder about an object freed from memory.
static void	memoryFreed(java.lang.Object freed) Notifies the recorder about an object freed from memory.
static void	memoryFreed(java.lang.Object tag, long size) Notifies the recorder about an object freed from memory.
static void	notifyProgramEnd() Notifies about end of monitoring (this might occur at different point of time than endSystem() and at multiple times).
static void	notifyProgramStart() Notifies about start of monitoring.
static void	notifyThreadEnd() Notifies about the end of the current thread.
void	notifyThreadEnd(long threadId) Notifies about an ended thread.
static void	notifyThreadStart(java.lang.Thread thread) Notifies about a started thread.
static void	notifyTimer(java.lang.String id, TimerState state, boolean considerThreads) Notifies about a timer event.
static void	notifyValueChange(java.lang.String recId, boolean newValue) Notifies the recorder about a changing value.
static void	notifyValueChange(java.lang.String recId, byte newValue) Notifies the recorder about a changing value.
static void	notifyValueChange(java.lang.String recId, char newValue) Notifies the recorder about a changing value.
static void	notifyValueChange(java.lang.String recId, double newValue) Notifies the recorder about a changing value.
static void	notifyValueChange(java.lang.String recId, float newValue) Notifies the recorder about a changing value.
static void	notifyValueChange(java.lang.String recId, int newValue) Notifies the recorder about a changing value.
static void	notifyValueChange(java.lang.String recId, long newValue) Notifies the recorder about a changing value.
static void	notifyValueChange(java.lang.String recId, java.lang.Object newValue) Notifies the recorder about a changing value.
static void	notifyValueChange(java.lang.String recId, short newValue) Notifies the recorder about a changing value.
static void	notifyValueChange(java.lang.String recId, java.lang.String newValue) Notifies the recorder about a changing value.
static void	printCurrentState() Prints the current (aggregated) state to the output formatter.
static void	printStatistics() Emits the values collected so far.
static int	readIo(java.lang.String recId, java.lang.String caller, int bytes, StreamType type) Notifies the recorder about an amount of bytes read from some I/O channel.
static void	registerAsOverheadStream(java.io.InputStream in) Register the given input stream as overhead stream, i.e. set the attribute added by instrumentation via reflection so that the recorder is notified.
static void	registerAsOverheadStream(java.io.OutputStream out) Register the given output stream as overhead stream, i.e. set the attribute added by instrumentation via reflection so that the recorder is notified.
static void	registerForRecording(java.lang.String className, MonitoringGroupSettings settings) Registers a given class for recording.
static void	registerThisThread(boolean register) Registers a JVM thread with its native counterpart.
static int	writeIo(java.lang.String recId, java.lang.String caller, int bytes, StreamType type) Notifies the recorder about an amount of bytes written to some I/O channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecorderAccess

private RecorderAccess()

Prevents this class from being instantiated from outside.

Since:

1.00

Method Detail

registerForRecording

public static void registerForRecording(java.lang.String className,
                                        MonitoringGroupSettings settings)

Registers a given class for recording. Optional, a (group) of ids might be specified to which the measurements are assigned to. Ids are unique strings without inherent semantics. If not given, the className is used for grouping and assigning measurements (implicit 1-groups).

Parameters:

className - the name of the class measurements should be registered for

settings - the monitoring group settings including all configuration information (reference should not be stored, will be freed explicitly)

Since:

1.00

registerAsOverheadStream

public static void registerAsOverheadStream(java.io.InputStream in)

Register the given input stream as overhead stream, i.e. set the attribute added by instrumentation via reflection so that the recorder is notified.

Parameters:

in - the stream to be registered

Since:

1.00

registerAsOverheadStream

public static void registerAsOverheadStream(java.io.OutputStream out)

Register the given output stream as overhead stream, i.e. set the attribute added by instrumentation via reflection so that the recorder is notified.

Parameters:

out - the stream to be registered

Since:

1.00

notifyProgramStart

public static void notifyProgramStart()

Notifies about start of monitoring.

Since:

1.00

notifyProgramEnd

public static void notifyProgramEnd()

Notifies about end of monitoring (this might occur at different point of time than endSystem() and at multiple times).

Since:

1.00

enableVariabilityDetection

public static void enableVariabilityDetection(boolean enable)

Changes if automated variability detection should be enabled or not.

Parameters:

enable - true if it should be enabled (can be switched off by annotation) or if manual notification via annotation should be considered only

Since:

1.00

notifyThreadStart

public static void notifyThreadStart(java.lang.Thread thread)

Notifies about a started thread.

Parameters:

thread - the started thread

Since:

1.00

notifyThreadEnd

public static final void notifyThreadEnd()

Notifies about the end of the current thread. [Java call]

Since:

1.00

notifyThreadEnd

public final void notifyThreadEnd(long threadId)

Notifies about an ended thread. [native call]

Parameters:

threadId - the identification of the ended thread

Since:

1.00

assignAllTo

public static void assignAllTo(java.lang.String recId,
                               boolean enter)

Notifies that the following values (if not further calls to this method or other recording ids occur) should be assigned to the given recId.

Parameters:

recId - the recording id (may be also the variability prefix)

enter - true if this is a method enter event, false else

Since:

1.00

printStatistics

public static void printStatistics()

Emits the values collected so far.

Since:

1.00

endSystem

public static void endSystem()

Notifies about the end of the monitored program.

Since:

1.00

enter

public static void enter(java.lang.String caller,
                         java.lang.String recId,
                         boolean exclude,
                         boolean directId,
                         long instanceId)

Notifies the recorder about a method being called.

Parameters:

caller - the type of the caller

recId - the recorder id (may be null)

exclude - is this an exclusion from monitoring

directId - is recId direct, e.g. in case of an annotated method

instanceId - the optional instance identifier, 0 means disabled

Since:

1.20

exit

public static void exit(java.lang.String caller,
                        java.lang.String recId,
                        boolean exclude,
                        boolean directId,
                        long instanceId)

Notifies the recorder about a method being exited.

Parameters:

caller - the type of the caller

recId - the recorder id (may be null)

exclude - is this an exclusion from monitoring

directId - is recId direct, e.g. in case of an annotated method

instanceId - the optional instance identifier, 0 means disabled

Since:

1.00

configurationChange

public static void configurationChange(java.lang.String ids)

Notify the recorder that a new variability configuration might have been entered. The recorder should resolve the concrete configuration by tracking the configuration activations.

Parameters:

ids - an optional list of group identifications

Since:

1.00

memoryAllocated

public static void memoryAllocated(java.lang.Object tag,
                                   long size)

Notifies the recorder about an object allocated to memory. This method is required for explicit notifications. [Java call]

Parameters:

tag - an object which serves as the identification for object size to be freed

size - the allocated memory size

Since:

1.00

memoryAllocated

public static void memoryAllocated(java.lang.Object allocated)

Notifies the recorder about an object allocated to memory. Please note that dependent on the concrete instrumentation not all allocated objects might be cleaned up.

Parameters:

allocated - the allocated

Since:

1.00

memoryFreed

public static void memoryFreed(java.lang.Object tag,
                               long size)

Notifies the recorder about an object freed from memory. This method is required for explicit notifications. [Java call]

Parameters:

tag - an object which serves as the identification for object size to be freed

size - the size of the freed object

Since:

1.00

memoryFreed

public static void memoryFreed(java.lang.Object freed)

Notifies the recorder about an object freed from memory. Please note that dependent on the concrete instrumentation not all memory frees might be detected, e.g. those of immediate system classes (e.g. Object cannot be instrumented, garbage collector not called when JVM is running, etc.).

Parameters:

freed - the freed object

Since:

1.00

memoryFreed

public static void memoryFreed(long tag,
                               long size)

Notifies the recorder about an object freed from memory. Please note that dependent on the concrete instrumentation not all memory frees might be detected, e.g. those of immediate system classes (e.g. Object cannot be instrumented, garbage collector not called when JVM is running, etc.).

Parameters:

tag - the identification of the object to be freed

size - the size of the freed object

Since:

1.00

readIo

public static int readIo(java.lang.String recId,
                         java.lang.String caller,
                         int bytes,
                         StreamType type)

Notifies the recorder about an amount of bytes read from some I/O channel.

Parameters:

recId - an the target group identification

caller - the type of the caller

bytes - the number of bytes

type - the type of the channel

Returns:

bytes

Since:

1.00

writeIo

public static int writeIo(java.lang.String recId,
                          java.lang.String caller,
                          int bytes,
                          StreamType type)

Notifies the recorder about an amount of bytes written to some I/O channel.

Parameters:

recId - an the target group identification

caller - the type of the caller

bytes - the number of bytes

type - the type of the channel

Returns:

bytes

Since:

1.00

changeValueContext

public static void changeValueContext(java.lang.String id,
                                      boolean push)

Notifies the recorder about changing the value context.

Parameters:

id - the value identification representing the context

push - if true push the context to the context stack, false else

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     java.lang.Object newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     int newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     byte newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     char newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     short newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     long newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     double newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     float newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     java.lang.String newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

notifyValueChange

public static void notifyValueChange(java.lang.String recId,
                                     boolean newValue)

Notifies the recorder about a changing value.

Parameters:

recId - the recorder id (optional, may be null)

newValue - the value after the value change

Since:

1.00

printCurrentState

public static void printCurrentState()

Prints the current (aggregated) state to the output formatter.

Since:

1.00

notifyTimer

public static void notifyTimer(java.lang.String id,
                               TimerState state,
                               boolean considerThreads)

Notifies about a timer event.

Parameters:

id - the timer identification (may overlap with recorder ids)

state - the new timer state

considerThreads - false if the id is thread save and threads must not be considered explicitly, false else

Since:

1.00

registerThisThread

public static void registerThisThread(boolean register)

Registers a JVM thread with its native counterpart. Needed only if the JVM/JDK is not able to handle this, e.g. in 1.4 or Android.

Parameters:

register - register or unregister the thread

Since:

1.00