de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Class DefaultRecorderElement

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.RecorderElement

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.DefaultRecorderElement

All Implemented Interfaces:

IMonitoringGroup

Direct Known Subclasses:

InstanceRecorderElement

class DefaultRecorderElement
extends RecorderElement

Implements a recorder element containing the monitoring data for one monitoring group.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private long	cpuTimeTicks Stores the CPU time ticks elapsed and allocated to this class.
private long	fileInBytes Stores the amount of bytes written to files.
private long	fileOutBytes Stores the amount of bytes read from files.
private long	memAllocated Stores the amount of memory allocated to this monitoring group.
private long	memUse Stores the memory use, i.e. the difference between memory allocation and memory unallocation.
private long	netInBytes Stores the amount of bytes read from network interfaces.
private long	netOutBytes Stores the amount of bytes sent to network interfaces.
private TimeMap	startTimes Stores the system time when monitoring started on this group (temporary value).
private long	systemTimeTicks Stores the system time ticks elapsed and allocated to this class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultRecorderElement(MonitoringGroupConfiguration conf) Creates a recorder element.

Method Summary

Modifier and Type	Method and Description
(package private) void	addNetBytes(long netInBytes, long netOutBytes) Adds an external amount of input or output bytes to this recording element.
void	copy(RecorderElement from) Copies the data stored in from into this instance.
RecorderElement	getContributing(int index) Returns a contributing recording element, i.e. one of the elements assigned to individual variants in a variability configuration.
(package private) RecorderElement	getContributing(int index, RecorderElementFactory factory, int max) Returns the currently relevant recorder element (in case that multiple subelements are supported).
int	getContributingSize() Returns the number of contributing recording elements, i.e. the elements recording individual variants in a variability configuration.
long	getCpuTimeTicks() Returns the entire number of CPU time ticks recorded for this instance.
long	getFileIn() Returns the number of bytes read from files.
long	getFileOut() Returns the number of bytes written to files.
long	getIoRead() Returns the number of bytes read from files or network.
long	getIoWrite() Returns the number of bytes written to files or network.
long	getMemAllocated() Returns the amount of memory allocated for this instance.
long	getMemUse() Returns the amount of memory currently being used, i.e. difference between allocated and unallocated memory.
long	getNetIn() Returns the number of bytes read from network.
long	getNetOut() Returns the number of bytes written to network.
protected long	getStartCpuTime(long threadId) Returns the CPU time when recording was started.
protected long	getStartSystemTime(long threadId) Returns the system time when recording was started.
long	getSystemTimeTicks() Returns the entire number of system time ticks recorded for this instance.
(package private) void	memoryAllocated(long size) Records an amount of memory allocated by the underlying recording group.
(package private) void	memoryFreed(long size) Records an amount of memory freed within the underlying recording group (memory unallocation).
(package private) void	readIo(int bytes, StreamType type) Records an amount of bytes read from file or from network.
(package private) void	setCpuTimeTicks(long cpuTimeTicks) Sets the current CPI time ticks for finishing recording of the entire program.
(package private) boolean	startTimeRecording(long nanoTime, long threadTicks, long threadId) Start the time recording for this instance.
(package private) boolean	stopTimeRecording(long nanoTime, long threadTicks, long threadId) Stops the time recording for this instance.
private boolean	stopTimeRecordingImpl(long nanoTime, long threadTicks, long threadId) Stops the time recording for this instance.
(package private) void	timeCorrection(long timeDiff, long threadTimeFraction, boolean decrement, long threadId) Adds (overhead) time correction information.
(package private) void	updateMemoryFreedFromJvm() Updates freed memory from the JVM instead of recording this information individually (memory unallocation).
boolean	wasRecorded() Returns if data on this instance was recorded or if it a dummy instance created e.g. for some unused (automatic detected) variants.
(package private) void	writeIo(int bytes, StreamType type) Records an amount of bytes written to file or from network.

Methods inherited from class de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.RecorderElement

accountResource, checkConf, createForTest, getConfiguration, getGroupAccounting, getInstanceRecorderElement, getResources, getVarId, hasDebugStates, instanceRecorderElements, instanceRecorderIds, isIndirectAccounting, isVisible, setVarId

Methods inherited from class java.lang.Object

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

Field Detail

memUse

private long memUse

Stores the memory use, i.e. the difference between memory allocation and memory unallocation.

memAllocated

private long memAllocated

Stores the amount of memory allocated to this monitoring group.

startTimes

private TimeMap startTimes

Stores the system time when monitoring started on this group (temporary value). A negative value denotes that recording has not started. Zero may be possible in case of a just started thread.

systemTimeTicks

private long systemTimeTicks

Stores the system time ticks elapsed and allocated to this class.

cpuTimeTicks

private long cpuTimeTicks

Stores the CPU time ticks elapsed and allocated to this class.

netOutBytes

private long netOutBytes

Stores the amount of bytes sent to network interfaces.

netInBytes

private long netInBytes

Stores the amount of bytes read from network interfaces.

fileOutBytes

private long fileOutBytes

Stores the amount of bytes read from files.

fileInBytes

private long fileInBytes

Stores the amount of bytes written to files.

Constructor Detail

DefaultRecorderElement

protected DefaultRecorderElement(MonitoringGroupConfiguration conf)

Creates a recorder element.

Parameters:

conf - the configuration of the recorder element

Since:

1.00

Method Detail

copy

public void copy(RecorderElement from)

Copies the data stored in from into this instance. (Deep copy)

Overrides:

copy in class RecorderElement

Parameters:

from - the instance from where to copy (may also be a subclass)

Since:

1.00

startTimeRecording

boolean startTimeRecording(long nanoTime,
                           long threadTicks,
                           long threadId)

Start the time recording for this instance.

Specified by:

startTimeRecording in class RecorderElement

Parameters:

nanoTime - the current system time in nano seconds

threadTicks - the current number of thread ticks

threadId - the identifier of the thread causing the call

Returns:

true if recording started on this instance with this call, false if recording was yet active, e.g. in case of recursive or reentrant calls

Since:

1.00

stopTimeRecording

boolean stopTimeRecording(long nanoTime,
                          long threadTicks,
                          long threadId)

Stops the time recording for this instance.

Specified by:

stopTimeRecording in class RecorderElement

Parameters:

nanoTime - the current system time in nano seconds

threadTicks - the current number of thread ticks

threadId - the identifier of the thread causing the call

Returns:

true if recording stopped on this instance with this call, false if recording is still active, e.g. in case of recursive or reentrant calls, a negative value causes stopping time recording for all stored threaded times

Since:

1.00

stopTimeRecordingImpl

private boolean stopTimeRecordingImpl(long nanoTime,
                                      long threadTicks,
                                      long threadId)

Stops the time recording for this instance.

Parameters:

nanoTime - the current system time in nano seconds

threadTicks - the current number of thread ticks

threadId - the identifier of the thread causing the call

Returns:

true if recording stopped on this instance with this call, false if recording is still active, e.g. in case of recursive or reentrant calls

Since:

1.00

getStartCpuTime

protected long getStartCpuTime(long threadId)

Returns the CPU time when recording was started.

Specified by:

getStartCpuTime in class RecorderElement

Parameters:

threadId - the identifier of the thread the start time should be returned for

Returns:

the time when recording was started, may be negative if disabled

Since:

1.00

getStartSystemTime

protected long getStartSystemTime(long threadId)

Returns the system time when recording was started.

Specified by:

getStartSystemTime in class RecorderElement

Parameters:

threadId - the identifier of the thread the start time should be returned for

Returns:

the time when recording was started, may be negative if disabled

Since:

1.00

memoryAllocated

void memoryAllocated(long size)

Records an amount of memory allocated by the underlying recording group.

Specified by:

memoryAllocated in class RecorderElement

Parameters:

size - the amount of memory allocated

Since:

1.00

memoryFreed

void memoryFreed(long size)

Records an amount of memory freed within the underlying recording group (memory unallocation).

Specified by:

memoryFreed in class RecorderElement

Parameters:

size - the amount of memory freed

Since:

1.00

updateMemoryFreedFromJvm

void updateMemoryFreedFromJvm()

Updates freed memory from the JVM instead of recording this information individually (memory unallocation). Should be used for the (entire) program record only.

Specified by:

updateMemoryFreedFromJvm in class RecorderElement

Since:

1.00

readIo

void readIo(int bytes,
            StreamType type)

Records an amount of bytes read from file or from network.

Specified by:

readIo in class RecorderElement

Parameters:

bytes - the amount of bytes read

type - the type of stream used for reading

Since:

1.00

writeIo

void writeIo(int bytes,
             StreamType type)

Records an amount of bytes written to file or from network.

Specified by:

writeIo in class RecorderElement

Parameters:

bytes - the amount of bytes written

type - the type of stream used for writing

Since:

1.00

setCpuTimeTicks

void setCpuTimeTicks(long cpuTimeTicks)

Sets the current CPI time ticks for finishing recording of the entire program.

Specified by:

setCpuTimeTicks in class RecorderElement

Parameters:

cpuTimeTicks - the current CPU time ticks

Since:

1.00

addNetBytes

void addNetBytes(long netInBytes,
                 long netOutBytes)

Adds an external amount of input or output bytes to this recording element. This method is used for recording overhead bytes. (This method is currently available only for network overhead as networked monitoring may lead to uncontrolled recursive network recording).

Specified by:

addNetBytes in class RecorderElement

Parameters:

netInBytes - the amount of bytes read from network

netOutBytes - the amount of bytes written to network

Since:

1.00

wasRecorded

public boolean wasRecorded()

Returns if data on this instance was recorded or if it a dummy instance created e.g. for some unused (automatic detected) variants.

Returns:

true if valid data was recorded, false else

Since:

1.00

getSystemTimeTicks

public long getSystemTimeTicks()

Returns the entire number of system time ticks recorded for this instance.

Returns:

the number of system time ticks

Since:

1.00

getCpuTimeTicks

public long getCpuTimeTicks()

Returns the entire number of CPU time ticks recorded for this instance.

Returns:

the number of CPU time ticks

Since:

1.00

getMemAllocated

public long getMemAllocated()

Returns the amount of memory allocated for this instance.

Returns:

the amount of allocated memory

getMemUse

public long getMemUse()

Returns the amount of memory currently being used, i.e. difference between allocated and unallocated memory.

Returns:

the amount of memory being used

getIoRead

public long getIoRead()

Returns the number of bytes read from files or network.

Returns:

the number of bytes read from files or network

Since:

1.00

getIoWrite

public long getIoWrite()

Returns the number of bytes written to files or network.

Returns:

the number of bytes written to files or network

Since:

1.00

getNetIn

public long getNetIn()

Returns the number of bytes read from network.

Returns:

the number of bytes read from network

Since:

1.00

getNetOut

public long getNetOut()

Returns the number of bytes written to network.

Returns:

the number of bytes written to network

Since:

1.00

getFileIn

public long getFileIn()

Returns the number of bytes read from files.

Returns:

the number of bytes read from files

Since:

1.00

getFileOut

public long getFileOut()

Returns the number of bytes written to files.

Returns:

the number of bytes written to files

Since:

1.00

timeCorrection

void timeCorrection(long timeDiff,
                    long threadTimeFraction,
                    boolean decrement,
                    long threadId)

Adds (overhead) time correction information.

Specified by:

timeCorrection in class RecorderElement

Parameters:

timeDiff - time difference

threadTimeFraction - threaded time fraction

decrement - negative or positive correction

threadId - the thread id of the causing thread

Since:

1.00

getContributing

RecorderElement getContributing(int index,
                                RecorderElementFactory factory,
                                int max)

Returns the currently relevant recorder element (in case that multiple subelements are supported).

Specified by:

getContributing in class RecorderElement

Parameters:

index - the index of the sub element

factory - a factory to create new elements if needed

max - the (current) number of maximum required subelements ( variabilities)

Returns:

the subelement or this instance

Since:

1.00

getContributing

public RecorderElement getContributing(int index)

Returns a contributing recording element, i.e. one of the elements assigned to individual variants in a variability configuration.

Specified by:

getContributing in class RecorderElement

Parameters:

index - the element to be returned

Returns:

the element assigned to the given index (always this)

Throws:

java.lang.ArrayIndexOutOfBoundsException - if index<0 || index>=getContributingSize()

Since:

1.00

getContributingSize

public int getContributingSize()

Returns the number of contributing recording elements, i.e. the elements recording individual variants in a variability configuration.

Specified by:

getContributingSize in class RecorderElement

Returns:

the number of contributing recording elements (always 0)

Since:

1.00