de.uni_hildesheim.sse.monitoring.runtime.recording

Class SynchronizedRecorder

java.lang.Object

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

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

de.uni_hildesheim.sse.monitoring.runtime.recording.SynchronizedRecorder

All Implemented Interfaces:

de.uni_hildesheim.sse.system.IMemoryUnallocationReceiver

public class SynchronizedRecorder
extends Recorder

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SynchronizedRecorder.Unallocation Stores the information for a particular unallocation.
private class	SynchronizedRecorder.UnallocationThread Implements a thread which sends the gathered data to the specified server.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	unallocationLock The internal lock for the message producer-consumer.
private LinkedList<SynchronizedRecorder.Unallocation>	unallocations Stores the unallocation information (preventing deadlocks).

Fields inherited from class de.uni_hildesheim.sse.monitoring.runtime.recording.Recorder

CALIBRATE_RECORDER, COLLECTION_ENTRY_SIZE, isRecording, MAP_ENTRY_SIZE, programThreadId

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

instance

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	changeValueContext(java.lang.String id, boolean push) Notifies the recorder about changing the value context.
void	configurationChange(java.lang.String ids) Notify the recorder that a new variability configuration might have been entered.
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.
static void	initialize() Cause loading this class.
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	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.
private void	memoryFreedImpl(long tag, long size) Handles the unallocation (by calling the overridden superclass method).
void	notifyProgramEnd() Notifies about end of monitoring (this might occur at different point of time than Recorder.endSystem() and at multiple times).
void	notifyProgramStart() Notifies about start of monitoring.
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.
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.
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 de.uni_hildesheim.sse.monitoring.runtime.recording.Recorder

assignAllTo, clearTemporaryData, doUnallocationRecording, enableVariabilityDetection, endSystem, getId, isRecording, memoryAllocated, memoryFreed, notifyThreadEnd, notifyThreadEnd, notifyThreadStart, notifyThreadStart, printCurrentState, registerAsOverheadStream, registerAsOverheadStream, registerForRecording, registerThisThread, unallocated

Methods inherited from class java.lang.Object

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

Field Detail

unallocationLock

private java.lang.Object unallocationLock

The internal lock for the message producer-consumer.

unallocations

private LinkedList<SynchronizedRecorder.Unallocation> unallocations

Stores the unallocation information (preventing deadlocks).

Constructor Detail

SynchronizedRecorder

private SynchronizedRecorder()

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

notifyProgramStart

public final void notifyProgramStart()

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

Overrides:

notifyProgramStart in class Recorder

Since:

1.00

notifyProgramEnd

public final void notifyProgramEnd()

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

Overrides:

notifyProgramEnd in class Recorder

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]

Overrides:

enter in class Recorder

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

Overrides:

exit in class Recorder

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

Overrides:

configurationChange in class Recorder

Parameters:

ids - an optional list of group identifications

Since:

1.00

memoryAllocated

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

Overrides:

memoryAllocated in class Recorder

Parameters:

allocated - the allocated

Since:

1.00

memoryAllocated

public final void memoryAllocated(long tag,
                                  long size)

Notifies the recorder about an object allocated to memory. that dependent on the concrete instrumentation not all allocated objects might be cleaned up. [native call]

Overrides:

memoryAllocated in class Recorder

Parameters:

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

size - the allocated memory size

Since:

1.00

memoryFreed

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

Overrides:

memoryFreed in class Recorder

Parameters:

freed - the freed object

Since:

1.00

memoryFreed

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

Overrides:

memoryFreed in class Recorder

Parameters:

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

size - the size of the freed object

Since:

1.00

memoryFreedImpl

private final void memoryFreedImpl(long tag,
                                   long size)

Handles the unallocation (by calling the overridden superclass method).

Parameters:

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

size - the size of the freed object

Since:

1.00

readIo

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

Overrides:

readIo in class Recorder

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

Overrides:

writeIo in class Recorder

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 final void changeValueContext(java.lang.String id,
                                     boolean push)

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

Overrides:

changeValueContext in class Recorder

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 final void notifyValueChange(java.lang.String recId,
                                    java.lang.Object newValue)

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

notifyValueChange

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

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

Overrides:

notifyValueChange in class Recorder

Parameters:

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

newValue - the value after the value change

Since:

1.00

printStatistics

public final void printStatistics()

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

Overrides:

printStatistics in class Recorder

Since:

1.00

notifyTimer

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

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

Overrides:

notifyTimer in class Recorder

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