de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Class DefaultRecorderStrategy

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.AbstractRecorderStrategy

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.DefaultRecorderStrategy

All Implemented Interfaces:

RecorderStrategy

public class DefaultRecorderStrategy
extends AbstractRecorderStrategy

Implements the default recorder strategy for in-memory recording. Please note that in this class and dependent classes no local access to threads or timing calculation should be done, because this and dependent classes may be executed remotely. Thus, any relevant client-related information must be passed in by appropriate parameters.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultRecorderStrategy.RecorderElementEntryComparator Implements a comparator for recorder element mappings (for output).
private static class	DefaultRecorderStrategy.ThreadDataMapElementComparator Implements a comparator for thread data entries (for output).

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ENABLE_DEBUG Defines whether debugging output should be enabled.
private RecorderElement	excluded Stores the pseudo recording element for the blocking monitoring overhead, i.e. exclusion of monitoring.
private ResultFormatter	formatter Stores the formatter for output formatting.
private boolean	formatterConfigured Stores if the formatter was configured.
private ProcessData.Measurements	jvmNotificationInstance Internal singleton instance passed to the plugin event mechanism in case of new JVM measurement information.
private java.io.OutputStream	logStream Stores the output log stream.
private RecorderElement	programRecord Stores the recording element for the program itself, i.e. all unassigned recordings.
private ProcessData.Measurements	systemNotificationInstance Internal singleton instance passed to the plugin event mechanism in case of new system measurement information.
private LongHashMap<ThreadData>	threads Stores the relation among thread id and information collected on running threads.
private HashMap<java.lang.String,TimerInfo>	timers Stores information about the timers.

Fields inherited from interface de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.RecorderStrategy

REGISTER_END, REGISTER_FORCE

Constructor Summary

Constructors

Constructor and Description
DefaultRecorderStrategy(ResultFormatter formatter) Creates the recorder strategy.

Method Summary

Modifier and Type	Method and Description
boolean	assignAllTo(java.lang.String recId, boolean enter, long now, ThreadsInfo threadInfo) Notifies that the following values (if not further calls to this method or other recording ids occur) should be assigned to the given recId.
protected RecorderElement	assignByStackTrace(java.lang.String recId, java.lang.String caller, long threadId, boolean exclude, long instanceId) Retrieves the recorder element to be used for recording based on the given recorder identification and the thread identification.
void	clearTemporaryData() Notify that temporary data e.g. from instrumentation shall be cleared.
private void	configureFormatter() Configures the formatter for output based on the data in Configuration and stores an output file instance in logStream.
void	endSystem() Called as the last event from the monitored program.
boolean	enter(java.lang.String recId, long now, ThreadsInfo threadInfo, boolean exclude) Notifies the recorder about a method being called.
void	enterConfiguration(java.lang.String ids) Notify the recorder that a new variability configuration might have been entered.
boolean	exit(java.lang.String recId, long now, ThreadsInfo threadInfo, boolean exclude) Notifies the recorder about a method being called.
boolean	finishRecording(long now, long threadId, LongLongHashMap curCpuTimes) Notifies this strategy that recording should be stopped (second stage of stopping the recorder).
private ThreadData	getThread(long id, long ticks, long now) Returns or registers a thread to threads if not registered before.
private void	log(RecorderElement elt, RecorderElement cElt, DebugState state, java.lang.Object value, ResourceType rType) Debugging helper method.
void	memoryAllocated(java.lang.String recId, long threadId, long id, long size) Notifies the recorder about an object allocated to memory.
void	memoryFreedByRecId(java.lang.String recId, long size) Notifies the recorder about an object freed from memory.
void	notifyProgramRecordCreation() Notify the listeners about the program record creation (if not done implicitly before).
void	notifyTimer(java.lang.String id, TimerState state, long now, long threadId) Notifies about a timer event.
void	notifyValueChange(java.lang.String id, ValueType type, java.lang.Object value) Notifies about a changing attribute value.
boolean	printCurrentState(ProcessData pData) Prints the current (aggregated) state to the output formatter.
private static void	printNonRecorderStackElement(boolean firstOnly) Prints the stack trace elements for which the code is not located in the recorder packages.
boolean	printStatistics(ProcessData pData) Emits the values collected so far.
void	readIo(java.lang.String recId, java.lang.String caller, long threadId, int bytes, StreamType type) Notifies the recorder about an amount of bytes read from some I/O channel.
void	register(long threadId, long newId, long threadTicks, long now) Registers a thread id with a recording id.
void	startRecording(long now, long threadId, long threadTicks) Notifies this strategy that recording should be start.
boolean	stopTimeRecording(long now, ThreadsInfo threadInfo) Notifies this strategy that time recording should be stopped (first stage of stopping the recorder).
void	writeIo(java.lang.String recId, java.lang.String caller, long threadId, 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.recordingStrategies.AbstractRecorderStrategy

enableVariabilityDetection, getRecorderElement, getRecorderElements, getRecorderId, getStorage, getVariabilitySeparatorChar, isVariabilityDetectionEnabled, registerForRecording

Methods inherited from class java.lang.Object

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

Field Detail

ENABLE_DEBUG

public static final boolean ENABLE_DEBUG

Defines whether debugging output should be enabled.

See Also:

Constant Field Values

programRecord

private RecorderElement programRecord

Stores the recording element for the program itself, i.e. all unassigned recordings.

excluded

private RecorderElement excluded

Stores the pseudo recording element for the blocking monitoring overhead, i.e. exclusion of monitoring.

threads

private final LongHashMap<ThreadData> threads

Stores the relation among thread id and information collected on running threads.

timers

private final HashMap<java.lang.String,TimerInfo> timers

Stores information about the timers.

formatter

private ResultFormatter formatter

Stores the formatter for output formatting.

logStream

private java.io.OutputStream logStream

Stores the output log stream. The attribute is valid only for the lifetime of this object.

formatterConfigured

private boolean formatterConfigured

Stores if the formatter was configured.

systemNotificationInstance

private ProcessData.Measurements systemNotificationInstance

Internal singleton instance passed to the plugin event mechanism in case of new system measurement information.

jvmNotificationInstance

private ProcessData.Measurements jvmNotificationInstance

Internal singleton instance passed to the plugin event mechanism in case of new JVM measurement information.

Constructor Detail

DefaultRecorderStrategy

public DefaultRecorderStrategy(ResultFormatter formatter)

Creates the recorder strategy.

Parameters:

formatter - the formatter for printing the results

Since:

1.00

Method Detail

stopTimeRecording

public boolean stopTimeRecording(long now,
                                 ThreadsInfo threadInfo)

Notifies this strategy that time recording should be stopped (first stage of stopping the recorder).

Parameters:

now - the current time in nano seconds

threadInfo - the information on the current thread and its timing

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

finishRecording

public boolean finishRecording(long now,
                               long threadId,
                               LongLongHashMap curCpuTimes)

Notifies this strategy that recording should be stopped (second stage of stopping the recorder).

Parameters:

now - the current time in nano seconds

threadId - the id of the current thread

curCpuTimes - the current thread ticks

Returns:

true if the curCpuTime object should be released to the pool, false if it should not be released

Since:

1.00

startRecording

public void startRecording(long now,
                           long threadId,
                           long threadTicks)

Notifies this strategy that recording should be start.

Parameters:

now - the current time in nano seconds

threadId - the thread id of the executing (main) thread

threadTicks - the thread ticks for threadId

Since:

1.00

configureFormatter

private void configureFormatter()

Configures the formatter for output based on the data in Configuration and stores an output file instance in logStream.

Since:

1.00

printStatistics

public boolean printStatistics(ProcessData pData)

Emits the values collected so far.

Parameters:

pData - process data

Returns:

true if the data object should be released to the pool, false if it should not be released

Since:

1.00

endSystem

public void endSystem()

Called as the last event from the monitored program. This is after finishRecording(long, long, de.uni_hildesheim.sse.monitoring.runtime.utils.LongLongHashMap) and optionally printStatistics(de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ProcessData). This method closes logStream if it was opened before.

Since:

1.00

enter

public boolean enter(java.lang.String recId,
                     long now,
                     ThreadsInfo threadInfo,
                     boolean exclude)

Notifies the recorder about a method being called.

Parameters:

recId - a unique identification where to assign this event to

now - the current system time in nano seconds

threadInfo - timing information on the currently running thread

exclude - exclude from monitoring

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

assignAllTo

public boolean assignAllTo(java.lang.String recId,
                           boolean enter,
                           long now,
                           ThreadsInfo threadInfo)

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

now - the current system time

threadInfo - information on the current thread

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

exit

public boolean exit(java.lang.String recId,
                    long now,
                    ThreadsInfo threadInfo,
                    boolean exclude)

Notifies the recorder about a method being called.

Parameters:

recId - a unique identification where to assign this event to

now - the current time in nano seconds

threadInfo - timing information on the currently running thread

exclude - exclude from monitoring

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

register

public void register(long threadId,
                     long newId,
                     long threadTicks,
                     long now)

Registers a thread id with a recording id. This method is used to assign unregistered method calls to monitored threads as well as to register system threads

Parameters:

threadId - the thread id to be recorded

newId -

• if positive, the new thread
• if RecorderStrategy.REGISTER_FORCE the thread specified by threadId and threadTicks is registered with the recorder
• if RecorderStrategy.REGISTER_END the thread specified by threadId and threadTicks is marked as terminated in the recorder

threadTicks - the ticks of threadId

now - the current time in nano seconds

Since:

1.00

getThread

private ThreadData getThread(long id,
                             long ticks,
                             long now)

Returns or registers a thread to threads if not registered before.

Parameters:

id - the Java thread id

ticks - the current thread ticks

now - the current system time in nanoseconds

Returns:

the thread data object, either created or a previously registered one

Since:

1.00

memoryAllocated

public void memoryAllocated(java.lang.String recId,
                            long threadId,
                            long id,
                            long size)

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:

recId - a unique identification where to assign this event to

threadId - the identification of the current thread

id - the unique identification of the object being allocated (may be 0 to avoid recording of uninstrumented classes)

size - the affected amount of bytes in memory

Since:

1.00

memoryFreedByRecId

public void memoryFreedByRecId(java.lang.String recId,
                               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).

Parameters:

recId - a unique identification where to assign this event to

size - the affected amount of bytes in memory

Since:

1.00

log

private void log(RecorderElement elt,
                 RecorderElement cElt,
                 DebugState state,
                 java.lang.Object value,
                 ResourceType rType)

Debugging helper method.

Parameters:

elt - the recorder element for the component / group (must not be null)

cElt - the configuration recorder element (may be null)

state - the debug state to be checked for this log (don't check if null)

value - the value to be printed

rType - the type of the accounted resource

Since:

1.00

readIo

public void readIo(java.lang.String recId,
                   java.lang.String caller,
                   long threadId,
                   int bytes,
                   StreamType type)

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

Parameters:

recId - a unique identification where to assign this event to

caller - optional class name of the calling class

threadId - the identification of the current thread

bytes - the number of bytes

type - the type of the channel

Since:

1.00

writeIo

public void writeIo(java.lang.String recId,
                    java.lang.String caller,
                    long threadId,
                    int bytes,
                    StreamType type)

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

Parameters:

recId - a unique identification where to assign this event to

caller - optional class name of the calling class

threadId - the identification of the current thread

bytes - the number of bytes

type - the type of the channel

Since:

1.00

enterConfiguration

public void enterConfiguration(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 identification

Since:

1.00

assignByStackTrace

protected RecorderElement assignByStackTrace(java.lang.String recId,
                                             java.lang.String caller,
                                             long threadId,
                                             boolean exclude,
                                             long instanceId)

Retrieves the recorder element to be used for recording based on the given recorder identification and the thread identification. This method searches (if available) the current thread and within the thread the current (recorded) call stack (most specific call if appropriate). Otherwise it considers the default recording element of the thread (if assigned during thread startup) or simply the top of the stack.

Parameters:

recId - the recorder element

caller - optional class name of the calling class

threadId - the thread identification

exclude - force exclusion from monitoring

instanceId - the instance identifier (may be 0 for disabled)

Returns:

the most appropriate recorder element (may be null, denotes that the information provided cannot be used to derive the recorder element and, thus, the information should be recorded for the entire program only).

Since:

1.00

printCurrentState

public boolean printCurrentState(ProcessData pData)

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

Parameters:

pData - additional information collected for system and JVM process (may be null)

Returns:

true if the threadsInfo object should be released to the pool, false if it should not be released

Since:

1.00

notifyTimer

public void notifyTimer(java.lang.String id,
                        TimerState state,
                        long now,
                        long threadId)

Notifies about a timer event.

Parameters:

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

state - the new timer state

now - the current system time in milliseconds

threadId - the id of the currently executing thread, may be negative if it should be ignored

Since:

1.00

notifyValueChange

public void notifyValueChange(java.lang.String id,
                              ValueType type,
                              java.lang.Object value)

Notifies about a changing attribute value.

Parameters:

id - the identification of the attribute (may overlap with recorder ids)

type - the type of the value

value - the new value (after changing)

Since:

1.00

notifyProgramRecordCreation

public void notifyProgramRecordCreation()

Notify the listeners about the program record creation (if not done implicitly before).

printNonRecorderStackElement

private static void printNonRecorderStackElement(boolean firstOnly)

Prints the stack trace elements for which the code is not located in the recorder packages.

Parameters:

firstOnly - print the first occurrence outside only, else the entire stack outside

Since:

1.00

clearTemporaryData

public void clearTemporaryData()

Notify that temporary data e.g. from instrumentation shall be cleared. This is in particular required to synchronize event-based implementations.