de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies

Class ThreadData

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.recordingStrategies.ThreadData

public class ThreadData
extends java.lang.Object

Stores monitored information about a running or finished thread. In particular, this class maintains a local stack of recording elements in order to assign nested method calls to the correct threads.

Since:

1.00

Version:

1.21

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private long	cpuTimeTicks Stores the number of assigned CPU time ticks.
private long	nesting Stores the nesting of reentrant calls.
private RecorderElement	recorderElement Stores the recorder element assigned to this thread (to be used if no other recording element can be assigned).
private RecorderElement[]	stack Stores the recording elements retrieved from the stack.
private static int	STACK_INCREMENT Defines the stack increment in case that there is no more space and also the initial stack size.
private boolean[]	stackDuplicates Stores whether the element at a certain stack position is a duplicate.
private static CleaningLongHashMap<RecorderElement[]>	STACKPOOL Stores the stack pool, i.e. the pool of stack copies (without duplicates).
private static int	STACKPOOL_HASH_INCREMENT An internal increment in case that hash values are identical.
private int	stackSize Stores the current size of the stack.
private long	startCpuTimeTicks Stores the number of assigned CPU time ticks when first entering the thread.
private long	startUseTimeTicks Stores the CPU time ticks when using this thread started.
private long	totalUseTimeTicks Stores the total CPU usage time of this thread.

Constructor Summary

Constructors

Constructor and Description
ThreadData()

Method Summary

Modifier and Type	Method and Description
void	copyStackFrom(ThreadData threadData) Copies the stack entries from threadData to this thread.
RecorderElement[]	createStackCopy() Returns a the stack without duplicates.
void	end(long threadTicks) Ends recording for this thread as the thread ended.
long	getCpuTimeTicks() Returns the number of CPU time ticks allocated to this thread.
protected RecorderElement	getRecorderElement() Returns the recorder element to be used if no other recorder element can be assigned.
RecorderElement	getStackElement(int index) Returns the element at the given stack position.
int	getStackSize() Returns the stack size.
long	getTotalCpu() Returns the total use of this thread in CPU ticks.
boolean	isEnded() Returns if recording is finished.
boolean	isOnStack(RecorderElement elt, boolean includeTop) Returns whether the given elt is on the stack.
boolean	isStackElementDuplicated(int index) Returns whether the element at the given stack position is a duplicate.
void	pop(RecorderElement elt) Pushes the given recorder element (as a method call equivalent) from the call stack.
void	push(RecorderElement elt) Pushes the recorder element (as a method call equivalent) to the call stack.
static void	releaseStack(RecorderElement[] stack) Releases the given stack (to be obtained from createStackCopy()).
protected void	setRecorderElement(RecorderElement recorderElement) Changes the recorder element to be used if no other recorder element can be assigned.
int	stackIndex(RecorderElement elt) Returns the index of the given element.
int	stackSize() Returns the size of the stack.
void	start(long threadTicks) Starts recording for this thread (again) as the thread was created or reused.
(package private) void	startTimeRecording(long nanoTime, long threadTicks) Is called to notify about the start of recording.
(package private) void	stopTimeRecording(long nanoTime, long threadTicks) Is called to notify the end of recording.
RecorderElement	top() Returns the top of the call stack.
RecorderElement	top(int varId) Returns the top of the call stack and the top of the elements with same varId.
java.lang.String	toString() Returns a textual description of this instance for debugging.

Methods inherited from class java.lang.Object

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

Field Detail

STACKPOOL

private static final CleaningLongHashMap<RecorderElement[]> STACKPOOL

Stores the stack pool, i.e. the pool of stack copies (without duplicates).

STACKPOOL_HASH_INCREMENT

private static final int STACKPOOL_HASH_INCREMENT

An internal increment in case that hash values are identical.

See Also:

Constant Field Values

STACK_INCREMENT

private static final int STACK_INCREMENT

Defines the stack increment in case that there is no more space and also the initial stack size.

See Also:

Constant Field Values

startUseTimeTicks

private long startUseTimeTicks

Stores the CPU time ticks when using this thread started. This corresponds to totalUseTimeTicks. This information should not be confused with cpuTimeTicks as that time information needs to be collected in pairs of start/stop calls and may be completed by this information when finalizing this thread.

totalUseTimeTicks

private long totalUseTimeTicks

Stores the total CPU usage time of this thread.

cpuTimeTicks

private long cpuTimeTicks

Stores the number of assigned CPU time ticks.

startCpuTimeTicks

private long startCpuTimeTicks

Stores the number of assigned CPU time ticks when first entering the thread.

nesting

private long nesting

Stores the nesting of reentrant calls.

recorderElement

private RecorderElement recorderElement

Stores the recorder element assigned to this thread (to be used if no other recording element can be assigned).

stackSize

private int stackSize

Stores the current size of the stack.

stack

private RecorderElement[] stack

Stores the recording elements retrieved from the stack. This must not comply to the real stack but just states which recorder element occurred how often on the stack so far.

stackDuplicates

private boolean[] stackDuplicates

Stores whether the element at a certain stack position is a duplicate.

Constructor Detail

ThreadData

public ThreadData()

Method Detail

startTimeRecording

void startTimeRecording(long nanoTime,
                        long threadTicks)

Is called to notify about the start of recording.

Parameters:

nanoTime - the current time in nano seconds

threadTicks - the CPU time ticks consumed by this thread

Since:

1.00

stopTimeRecording

void stopTimeRecording(long nanoTime,
                       long threadTicks)

Is called to notify the end of recording.

Parameters:

nanoTime - the current time in nano seconds

threadTicks - the CPU time ticks consumed by this thread

Since:

1.00

start

public void start(long threadTicks)

Starts recording for this thread (again) as the thread was created or reused. Note, that a thread may be reused and, thus, start and end multiple times.

Parameters:

threadTicks - the CPU time when this thread ends

Since:

1.00

end

public void end(long threadTicks)

Ends recording for this thread as the thread ended. Note, that a thread may be reused and, thus, start and end multiple times.

Parameters:

threadTicks - the CPU time when this thread ends

Since:

1.00

getTotalCpu

public long getTotalCpu()

Returns the total use of this thread in CPU ticks.

Returns:

the total CPU ticks

Since:

1.00

isEnded

public boolean isEnded()

Returns if recording is finished.

Returns:

true if this thread is currently being recorded, false else

Since:

1.00

getCpuTimeTicks

public long getCpuTimeTicks()

Returns the number of CPU time ticks allocated to this thread.

Returns:

the number of CPU time ticks

Since:

1.00

push

public void push(RecorderElement elt)

Pushes the recorder element (as a method call equivalent) to the call stack.

Parameters:

elt - the recorder element to be pushed

Since:

1.00

pop

public void pop(RecorderElement elt)

Pushes the given recorder element (as a method call equivalent) from the call stack.

Parameters:

elt - the recorder element to be popped (just to be sure)

Since:

1.00

top

public RecorderElement top()

Returns the top of the call stack.

Returns:

the top of the call stack

Since:

1.00

stackIndex

public int stackIndex(RecorderElement elt)

Returns the index of the given element.

Parameters:

elt - the element to search for

Returns:

-1 of not found or the index otherwise

Since:

1.00

stackSize

public int stackSize()

Returns the size of the stack.

Returns:

the size of the stack

Since:

1.00

getStackElement

public RecorderElement getStackElement(int index)

Returns the element at the given stack position.

Parameters:

index - the index to return the element for

Returns:

the element

Throws:

java.lang.ArrayIndexOutOfBoundsException - in case that the index is invalid

Since:

1.00

isStackElementDuplicated

public boolean isStackElementDuplicated(int index)

Returns whether the element at the given stack position is a duplicate.

Parameters:

index - the index to return the element for

Returns:

whether the element is a duplicate

Throws:

java.lang.ArrayIndexOutOfBoundsException - in case that the index is invalid

Since:

1.00

isOnStack

public boolean isOnStack(RecorderElement elt,
                         boolean includeTop)

Returns whether the given elt is on the stack.

Parameters:

elt - the element to search for

includeTop - include the top element or not

Returns:

true if elt is on the stack,

Since:

1.00

top

public RecorderElement top(int varId)

Returns the top of the call stack and the top of the elements with same varId.

Parameters:

varId - the variability identification to be searched for

Returns:

the top of the call stack regarding varId

Since:

1.00

getStackSize

public int getStackSize()

Returns the stack size.

Returns:

the stack size

Since:

1.00

toString

public java.lang.String toString()

Returns a textual description of this instance for debugging.

Overrides:

toString in class java.lang.Object

Returns:

a textual instance

getRecorderElement

protected RecorderElement getRecorderElement()

Returns the recorder element to be used if no other recorder element can be assigned.

Returns:

the recorder element (may be null)

Since:

1.00

setRecorderElement

protected void setRecorderElement(RecorderElement recorderElement)

Changes the recorder element to be used if no other recorder element can be assigned.

Parameters:

recorderElement - new the recorder element (may be null)

Since:

1.00

copyStackFrom

public void copyStackFrom(ThreadData threadData)

Copies the stack entries from threadData to this thread.

Parameters:

threadData - the object to copy from

Since:

1.00

createStackCopy

public RecorderElement[] createStackCopy()

Returns a the stack without duplicates. This method uses shared memory in order to reduce memory usage, i.e. on same stack constellations excluding duplicates the same array may be returned. Instances returned by this method must be released via STACKPOOL

Returns:

the current stack (do not modify)

Since:

1.00

releaseStack

public static void releaseStack(RecorderElement[] stack)

Releases the given stack (to be obtained from createStackCopy()).

Parameters:

stack - the stack to be released

Since:

1.00