de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Class BlockingRecorderElement

java.lang.Object

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

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.BlockingRecorderElement

All Implemented Interfaces:

IMonitoringGroup

public class BlockingRecorderElement
extends RecorderElement

Implements a blocking recorder element which just does nothing and prevents recording. This is used to realize excluded methods and their call tree.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockingRecorderElement() Creates a recorder element.

Method Summary

Modifier and Type	Method and Description
boolean	accountResource(ResourceType type) Returns whether the specified resource should be accounted.
(package private) void	addNetBytes(long netInBytes, long netOutBytes) Adds an external amount of input or output bytes to this recording element.
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.
GroupAccountingType	getGroupAccounting() Stores the accounting type.
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.
ResourceType[]	getResources() Stores the resources to be accounted.
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	hasDebugStates(DebugState state) Returns if this instance has the given state selected.
boolean	isIndirectAccounting() Returns whether indirect accounting is activated, either in this instance or (if RecorderElement.getGroupAccounting() is GroupAccountingType.DEFAULT) than in Configuration.getGroupAccountingType().
(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 CPU 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.
(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

checkConf, copy, createForTest, getConfiguration, getInstanceRecorderElement, getVarId, instanceRecorderElements, instanceRecorderIds, isVisible, setVarId

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockingRecorderElement

protected BlockingRecorderElement()

Creates a recorder element.

Since:

1.00

Method Detail

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

getSystemTimeTicks

public long getSystemTimeTicks()

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

Returns:

the number of system time ticks

getCpuTimeTicks

public long getCpuTimeTicks()

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

Returns:

the number of CPU time ticks

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

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, may be negative if disabled

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, may be negative if disabled

getIoRead

public long getIoRead()

Returns the number of bytes read from files or network.

Returns:

the number of bytes read from files or network

getIoWrite

public long getIoWrite()

Returns the number of bytes written to files or network.

Returns:

the number of bytes written to files or network

getNetIn

public long getNetIn()

Returns the number of bytes read from network.

Returns:

the number of bytes read from network

getNetOut

public long getNetOut()

Returns the number of bytes written to network.

Returns:

the number of bytes written to network

getFileIn

public long getFileIn()

Returns the number of bytes read from files.

Returns:

the number of bytes read from files

getFileOut

public long getFileOut()

Returns the number of bytes written to files.

Returns:

the number of bytes written to files

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

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

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

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

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

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

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

setCpuTimeTicks

void setCpuTimeTicks(long cpuTimeTicks)

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

Specified by:

setCpuTimeTicks in class RecorderElement

Parameters:

cpuTimeTicks - the current CPU time ticks

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

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

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 (may be negative if not known)

factory - a factory to create new elements if needed

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

Returns:

the subelement or this instance

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

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

isIndirectAccounting

public boolean isIndirectAccounting()

Returns whether indirect accounting is activated, either in this instance or (if RecorderElement.getGroupAccounting() is GroupAccountingType.DEFAULT) than in Configuration.getGroupAccountingType().

Overrides:

isIndirectAccounting in class RecorderElement

Returns:

true if indirect is activated, false else

accountResource

public boolean accountResource(ResourceType type)

Returns whether the specified resource should be accounted.

Overrides:

accountResource in class RecorderElement

Parameters:

type - the type of the resource to query for

Returns:

true if it should be accounted, false else

getGroupAccounting

public GroupAccountingType getGroupAccounting()

Stores the accounting type.

Overrides:

getGroupAccounting in class RecorderElement

Returns:

the group accounting type

getResources

public ResourceType[] getResources()

Stores the resources to be accounted.

Overrides:

getResources in class RecorderElement

Returns:

the resources to be accounted (empty if all)

hasDebugStates

public boolean hasDebugStates(DebugState state)

Returns if this instance has the given state selected.

Overrides:

hasDebugStates in class RecorderElement

Parameters:

state - the state to be tested

Returns:

true if the state is selected, false else