de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Class AbstractMultipleRecorderElement

java.lang.Object

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

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.AbstractMultipleRecorderElement

All Implemented Interfaces:

IMonitoringGroup

Direct Known Subclasses:

ContributingRecorderElement, MultipleRecorderElement

public abstract class AbstractMultipleRecorderElement
extends RecorderElement

Defines a recording element which represents multiple recorder elements by delegating to stored monitoring groups. This class has a different semantics than a ContributingRecorderElement because it passes the same recorded value to all represented recorder elements.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	distributeValues Stores whether values should be distributed in accountable fractions or passed to the elements as a whole.
private RecorderElement[]	elements Stores the contributing variant measurements.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMultipleRecorderElement(MonitoringGroupConfiguration conf) Creates a recorder element.
protected	AbstractMultipleRecorderElement(MonitoringGroupConfiguration conf, RecorderElement[] elements, boolean distributeValues) 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.
protected int	countAccountable(ResourceType type) Counts the accountable resources.
protected int	distributeIntValue(int value, ResourceType type) Distributes an int value to the accountable resources.
protected long	distributeLongValue(long value, ResourceType type) Distributes a long value to the accountable resources.
protected abstract boolean	enableRecording(RecorderElement elt, ResourceType resource) Returns whether the given element should record the specified resource.
protected void	ensureSize(int index, int max) Enlarges the array storing the elements if needed.
protected RecorderElement	firstElement() Returns the first non-null element.
long	getCpuTimeTicks() Returns the entire number of CPU time ticks recorded for this instance.
RecorderElement	getElement(int index) Returns a stored recording element.
int	getElementCount() Returns the number of stored recording elements.
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.
long	getStartCpuTime(long threadId) Returns the CPU time when recording was started.
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.
boolean	hasElement(RecorderElement rElt) Returns whether the given element is stored in this element.
(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.
protected void	setElement(int index, RecorderElement elt) Changes a given element.
(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.
(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, getContributing, getContributing, getContributingSize, 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

elements

private RecorderElement[] elements

Stores the contributing variant measurements.

distributeValues

private boolean distributeValues

Stores whether values should be distributed in accountable fractions or passed to the elements as a whole.

Constructor Detail

AbstractMultipleRecorderElement

protected AbstractMultipleRecorderElement(MonitoringGroupConfiguration conf)

Creates a recorder element. Distribute values.

Parameters:

conf - the monitoring group configuration

Since:

1.00

AbstractMultipleRecorderElement

protected AbstractMultipleRecorderElement(MonitoringGroupConfiguration conf,
                                          RecorderElement[] elements,
                                          boolean distributeValues)

Creates a recorder element.

Parameters:

conf - the monitoring group configuration

elements - the elements to be stored

distributeValues - account the fraction of the values according to the accountable elements or the entire value (indirect)

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

distributeLongValue

protected long distributeLongValue(long value,
                                   ResourceType type)

Distributes a long value to the accountable resources.

Parameters:

value - the value to be distributed

type - the resource type

Returns:

the distributed value (i.e. a fraction or the entire value depending on distributeValues)

Since:

1.00

distributeIntValue

protected int distributeIntValue(int value,
                                 ResourceType type)

Distributes an int value to the accountable resources.

Parameters:

value - the value to be distributed

type - the resource type

Returns:

the distributed value (i.e. a fraction or the entire value depending on distributeValues)

Since:

1.00

countAccountable

protected int countAccountable(ResourceType type)

Counts the accountable resources.

Parameters:

type - the resource type

Returns:

the number of accountable resources

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

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. This method does nothing because the program record should not be realized by this classes and unallocation recorded by instances should be notified individually via memoryFreed(long).

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

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

firstElement

protected RecorderElement firstElement()

Returns the first non-null element.

Returns:

the first element (might be null).

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

getStartCpuTime

public 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

Since:

1.00

getStartSystemTime

public 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

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

getElement

public RecorderElement getElement(int index)

Returns a stored recording element.

Parameters:

index - the element to be returned

Returns:

the element assigned to the given index

Throws:

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

Since:

1.00

hasElement

public boolean hasElement(RecorderElement rElt)

Returns whether the given element is stored in this element.

Parameters:

rElt - the element to search for

Returns:

true if it is stored, false else

Since:

1.00

getElementCount

public int getElementCount()

Returns the number of stored recording elements.

Returns:

the number of contributing recording elements

Since:

1.00

setElement

protected void setElement(int index,
                          RecorderElement elt)

Changes a given element. This function does not enlarge the array so call ensureSize(int, int) before if needed.

Parameters:

index - where to change the element

elt - the new recorder element

Throws:

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

Since:

1.00

ensureSize

protected void ensureSize(int index,
                          int max)

Enlarges the array storing the elements if needed.

Parameters:

index - the index to be used

max - the expected maximum size

Since:

1.00

enableRecording

protected abstract boolean enableRecording(RecorderElement elt,
                                           ResourceType resource)

Returns whether the given element should record the specified resource.

Parameters:

elt - the element to be considered

resource - the resource to be tested

Returns:

true if recording should be done, false else

Since:

1.00