de.uni_hildesheim.sse.monitoring.runtime.recording

Class Recorder

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.boot.RecorderFrontend

de.uni_hildesheim.sse.monitoring.runtime.recording.Recorder

All Implemented Interfaces:

de.uni_hildesheim.sse.system.IMemoryUnallocationReceiver

Direct Known Subclasses:

SynchronizedRecorder

public class Recorder
extends RecorderFrontend
implements de.uni_hildesheim.sse.system.IMemoryUnallocationReceiver

Implements the frontend to be called from instrumented code. This class is responsible for translating any program-specific information such as thread instances, object instances or platform/OS measurements to symbolic information such as thread ids, recording ids or measurement values, particularly for monitoring over network. Therefore most members are static. Currently, we use individual methods for the "events" registered in the code. In fact, this might be done via event objects but so far the impact on the memory footprint is not clear (TBD).

Since:

1.00

Version:

1.20

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CALIBRATE_RECORDER Stores if the recorder (i.e. the static sizes) should be calibrated.
static long	COLLECTION_ENTRY_SIZE Stores the size of a collection entry (for overhead recording).
private static LongHashMap<ArrayList<java.lang.String>>	CONTEXT_STACKS Stores the thread-id-context stacks.
private static boolean	doUnallocationRecording Stores whether unallocation recording shall be done.
protected static boolean	isRecording Stores if recording is enabled.
static long	MAP_ENTRY_SIZE Stores the size of a map entry (for overhead recording).
private static ArrayList<Plugin>	plugins Stores the plugins.
protected static long	programThreadId Stores the threadId the program started with.
private static RecorderStrategy	STRATEGY Stores the recording strategy.
private static LongLongHashMap	THREAD_STACKS Stores the thread stack sizes.

Fields inherited from class de.uni_hildesheim.sse.monitoring.runtime.boot.RecorderFrontend

instance

Constructor Summary

Constructors

Constructor and Description
Recorder() Prevents this class from being instantiated from outside.

Method Summary

Modifier and Type	Method and Description
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.
private static java.lang.String	assignId(java.lang.String recId, java.lang.String caller, boolean directId) Assign the proper recording id with respect to the object identity of the caller, i.e. check the actual type of caller and pass adjust the recording id if possible.
void	changeValueContext(java.lang.String id, boolean push) Notifies the recorder about changing the value context.
void	clearTemporaryData() Notify that temporary data e.g. from instrumentation shall be cleared.
void	configurationChange(java.lang.String ids) Notify the recorder that a new variability configuration might have been entered.
(package private) static boolean	doUnallocationRecording() Returns whether unallocation recording shall be performed.
void	enableVariabilityDetection(boolean enable) Changes if automated variability detection should be enabled or not.
private static boolean	endsWith(java.lang.String string, char chr) Returns if the specified string ends with a given char.
void	endSystem() Notifies about the end of the monitored program.
void	enter(java.lang.String caller, java.lang.String recId, boolean exclude, boolean directId, long instanceId) Notifies the recorder about a method being called.
void	exit(java.lang.String caller, java.lang.String recId, boolean exclude, boolean directId, long instanceId) Notifies the recorder about a method being exited.
private static java.lang.String	getContextualizedValueId(java.lang.String id) Contextualizes the given id if required.
protected static long	getId(java.lang.Object object) Returns an unique identification for an object.
static void	initialize() Cause loading this class.
protected boolean	isRecording() Returns whether this recorder is recording.
void	memoryAllocated(long tag, long size) Notifies the recorder about an object allocated to memory.
void	memoryAllocated(java.lang.Object allocated) Notifies the recorder about an object allocated to memory.
void	memoryAllocated(java.lang.Object tag, long size) Notifies the recorder about an object allocated to memory in the sense of adjusting an individual allocation due to value notifications.
void	memoryFreed(long tag, long size) Notifies the recorder about an object freed from memory.
void	memoryFreed(java.lang.Object freed) Notifies the recorder about an object freed from memory.
void	memoryFreed(java.lang.Object tag, long size) Notifies the recorder about an object freed from memory.
void	notifyProgramEnd() Notifies about end of monitoring (this might occur at different point of time than endSystem() and at multiple times).
void	notifyProgramStart() Notifies about start of monitoring.
void	notifyThreadEnd() Notifies about the end of the current thread.
void	notifyThreadEnd(long threadId) Notifies about an ended thread.
void	notifyThreadStart(long newThreadId) Notifies about a started thread.
void	notifyThreadStart(java.lang.Thread thread) Notifies about a started thread.
void	notifyTimer(java.lang.String id, TimerState state, boolean considerThreads) Notifies about a timer event.
void	notifyValueChange(java.lang.String recId, boolean newValue) Notifies the recorder about a changing value.
void	notifyValueChange(java.lang.String recId, byte newValue) Notifies the recorder about a changing value.
void	notifyValueChange(java.lang.String recId, char newValue) Notifies the recorder about a changing value.
void	notifyValueChange(java.lang.String recId, double newValue) Notifies the recorder about a changing value.
void	notifyValueChange(java.lang.String recId, float newValue) Notifies the recorder about a changing value.
void	notifyValueChange(java.lang.String recId, int newValue) Notifies the recorder about a changing value.
void	notifyValueChange(java.lang.String recId, long newValue) Notifies the recorder about a changing value.
void	notifyValueChange(java.lang.String recId, java.lang.Object newValue) Notifies the recorder about a changing value.
void	notifyValueChange(java.lang.String recId, short newValue) Notifies the recorder about a changing value.
void	notifyValueChange(java.lang.String recId, java.lang.String newValue) Notifies the recorder about a changing value.
private void	notifyValueChange(java.lang.String recId, ValueType type, java.lang.Object newValue) Notifies the recorder strategy about a changing value.
void	printCurrentState() Prints the current (aggregated) state to the output formatter.
void	printStatistics() Emits the values collected so far.
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.
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.
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.
void	registerForRecording(java.lang.String className, MonitoringGroupSettings settings) Registers a given class for recording.
private static void	registerPlugin(java.lang.String className, IPluginParameter params) Registers the given plugin.
void	registerThisThread(boolean register) Registers a JVM thread with its native counterpart.
void	unallocated(int recId, long size)
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

Field Detail

MAP_ENTRY_SIZE

public static final long MAP_ENTRY_SIZE

Stores the size of a map entry (for overhead recording).

COLLECTION_ENTRY_SIZE

public static final long COLLECTION_ENTRY_SIZE

Stores the size of a collection entry (for overhead recording).

CALIBRATE_RECORDER

public static final boolean CALIBRATE_RECORDER

Stores if the recorder (i.e. the static sizes) should be calibrated.

See Also:

Constant Field Values

isRecording

protected static boolean isRecording

Stores if recording is enabled.

programThreadId

protected static long programThreadId

Stores the threadId the program started with.

STRATEGY

private static final RecorderStrategy STRATEGY

Stores the recording strategy.

CONTEXT_STACKS

private static final LongHashMap<ArrayList<java.lang.String>> CONTEXT_STACKS

Stores the thread-id-context stacks.

THREAD_STACKS

private static final LongLongHashMap THREAD_STACKS

Stores the thread stack sizes.

doUnallocationRecording

private static boolean doUnallocationRecording

Stores whether unallocation recording shall be done.

plugins

private static ArrayList<Plugin> plugins

Stores the plugins.

Constructor Detail

Recorder

Recorder()

Prevents this class from being instantiated from outside.

Since:

1.00

Method Detail

initialize

public static void initialize()

Cause loading this class.

Since:

1.00

registerPlugin

private static void registerPlugin(java.lang.String className,
                                   IPluginParameter params)

Registers the given plugin.

Parameters:

className - the name of the class to be registered

params - unrecognized configuration params

Since:

1.00

registerForRecording

public final 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). [Java call, native call]

Specified by:

registerForRecording in class RecorderFrontend

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 final 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. [Java call]

Specified by:

registerAsOverheadStream in class RecorderFrontend

Parameters:

in - the stream to be registered

Since:

1.00

registerAsOverheadStream

public final 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. [Java call]

Specified by:

registerAsOverheadStream in class RecorderFrontend

Parameters:

out - the stream to be registered

Since:

1.00

doUnallocationRecording

static boolean doUnallocationRecording()

Returns whether unallocation recording shall be performed.

Returns:

true if unallocations shall be performed, false else

Since:

1.00

notifyProgramStart

public void notifyProgramStart()

Notifies about start of monitoring. [Java call, native call]

Specified by:

notifyProgramStart in class RecorderFrontend

Since:

1.00

notifyProgramEnd

public void notifyProgramEnd()

Notifies about end of monitoring (this might occur at different point of time than endSystem() and at multiple times). [Java call, native call]

Specified by:

notifyProgramEnd in class RecorderFrontend

Since:

1.00

enableVariabilityDetection

public final void enableVariabilityDetection(boolean enable)

Changes if automated variability detection should be enabled or not. [Java call, native call]

Specified by:

enableVariabilityDetection in class RecorderFrontend

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 final void notifyThreadStart(java.lang.Thread thread)

Notifies about a started thread. [Java call]

Specified by:

notifyThreadStart in class RecorderFrontend

Parameters:

thread - the started thread

Since:

1.00

notifyThreadStart

public final void notifyThreadStart(long newThreadId)

Notifies about a started thread. [native call]

Specified by:

notifyThreadStart in class RecorderFrontend

Parameters:

newThreadId - the identification of the started thread

Since:

1.00

notifyThreadEnd

public final void notifyThreadEnd()

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

Specified by:

notifyThreadEnd in class RecorderFrontend

Since:

1.00

notifyThreadEnd

public final void notifyThreadEnd(long threadId)

Notifies about an ended thread. [native call]

Specified by:

notifyThreadEnd in class RecorderFrontend

Parameters:

threadId - the identification of the ended thread

Since:

1.00

assignAllTo

public final 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. [Java call, native call]

Specified by:

assignAllTo in class RecorderFrontend

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

getId

protected static final long getId(java.lang.Object object)

Returns an unique identification for an object.

Parameters:

object - the object to return the identification for

Returns:

the identification of object

Since:

1.00

endSystem

public final void endSystem()

Notifies about the end of the monitored program. [Java call, native call]

Specified by:

endSystem in class RecorderFrontend

Since:

1.00

enter

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

Notifies the recorder about a method being called. [Java call, native call]

Specified by:

enter in class RecorderFrontend

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

exit

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

Notifies the recorder about a method being exited. [Java call, native call]

Specified by:

exit in class RecorderFrontend

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 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. [Java call, native call]

Specified by:

configurationChange in class RecorderFrontend

Parameters:

ids - an optional list of group identifications

Since:

1.00

memoryAllocated

public 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. [Java call]

Specified by:

memoryAllocated in class RecorderFrontend

Parameters:

allocated - the allocated

Since:

1.00

memoryAllocated

public void memoryAllocated(long tag,
                            long size)

Notifies the recorder about an object allocated to memory. Please note that sending the notification about an unallocated object is the responsibility of the caller. [native call]

Specified by:

memoryAllocated in class RecorderFrontend

Parameters:

tag - the identification of the memory object, e.g. its memory address

size - the allocated memory size

Since:

1.00

memoryAllocated

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

Notifies the recorder about an object allocated to memory in the sense of adjusting an individual allocation due to value notifications. [Java call]

Specified by:

memoryAllocated in class RecorderFrontend

Parameters:

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

size - the allocated memory size (considered as increment or decrement to the actual size)

Since:

1.00

memoryFreed

public 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.). [Java call]

Specified by:

memoryFreed in class RecorderFrontend

Parameters:

freed - the freed object

Since:

1.00

memoryFreed

public final 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]

Specified by:

memoryFreed in class RecorderFrontend

Parameters:

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

size - the size of the freed object (considered as increment or decrement to the actual size)

Since:

1.00

memoryFreed

public 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.). [Java call, native call]

Specified by:

memoryFreed in class RecorderFrontend

Parameters:

tag - the identification of the object to be freed, e.g. its memory address

size - the size of the freed object (ignored)

Since:

1.00

readIo

public 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. [Java call, native call]

Specified by:

readIo in class RecorderFrontend

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 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. [Java call, native call]

Specified by:

writeIo in class RecorderFrontend

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

endsWith

private static final boolean endsWith(java.lang.String string,
                                      char chr)

Returns if the specified string ends with a given char.

Parameters:

string - the string to be tested

chr - the char to be searched at the end of string

Returns:

true if c is at the end of string, false else

Since:

1.00

changeValueContext

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

Notifies the recorder about changing the value context. [Java call, native call]

Specified by:

changeValueContext in class RecorderFrontend

Parameters:

id - the value identification representing the context

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

Since:

1.00

getContextualizedValueId

private static final java.lang.String getContextualizedValueId(java.lang.String id)

Contextualizes the given id if required.

Parameters:

id - the id to be tested for contextualizing

Returns:

the contextualized id, id or null if id should be contextualized but the context is missing

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

private void notifyValueChange(java.lang.String recId,
                               ValueType type,
                               java.lang.Object newValue)

Notifies the recorder strategy about a changing value. [Java call, native call]

Parameters:

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

type - the value type

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

Notifies the recorder about a changing value. [Java call, native call]

Specified by:

notifyValueChange in class RecorderFrontend

Parameters:

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

newValue - the value after the value change

Since:

1.00

assignId

private static java.lang.String assignId(java.lang.String recId,
                                         java.lang.String caller,
                                         boolean directId)

Assign the proper recording id with respect to the object identity of the caller, i.e. check the actual type of caller and pass adjust the recording id if possible.

Parameters:

recId - the recording id delivered from instrumented code (by the caller)

caller - the name of the type of the calling object (may be null, e.g. in case of stream classes)

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

Returns:

the adjusted recording id

Since:

1.00

printCurrentState

public void printCurrentState()

Prints the current (aggregated) state to the output formatter. Do not lock this method as it may be called concurrently. [Java call, native call]

Specified by:

printCurrentState in class RecorderFrontend

Since:

1.00

printStatistics

public void printStatistics()

Emits the values collected so far. [Java call, native call]

Specified by:

printStatistics in class RecorderFrontend

Since:

1.00

notifyTimer

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

Notifies about a timer event. [Java call, native call]

Specified by:

notifyTimer in class RecorderFrontend

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 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. [Java call]

Specified by:

registerThisThread in class RecorderFrontend

Parameters:

register - register or unregister the thread

Since:

1.00

clearTemporaryData

public void clearTemporaryData()

Notify that temporary data e.g. from instrumentation shall be cleared. The specific cleanup implementation may decide upon this request whether a cleanup is actually required.

Specified by:

clearTemporaryData in class RecorderFrontend

Since:

1.00

isRecording

protected boolean isRecording()

Returns whether this recorder is recording.

Returns:

true if it is recording, false else

Since:

1.00

unallocated

public void unallocated(int recId,
                        long size)

Specified by:

unallocated in interface de.uni_hildesheim.sse.system.IMemoryUnallocationReceiver