com.xilinx.rapidwright.tests

Class CodePerfTracker

Object

com.xilinx.rapidwright.tests.CodePerfTracker

public class CodePerfTracker
extends Object

Simple tool for measuring code runtime and memory and reporting. Created on: Jun 29, 2016

Field Summary

Fields

Modifier and Type	Field and Description
static CodePerfTracker	SILENT

Constructor Summary

Constructors

Constructor and Description
CodePerfTracker(String name)
CodePerfTracker(String name, boolean printProgress)
CodePerfTracker(String name, boolean printProgress, boolean isVerbose)

Method Summary

Modifier and Type	Method and Description
Long	getMemUsage(String segmentName)
Long	getRuntime(String segmentName)
void	init(String name, boolean printProgress)
boolean	isReportingCurrOSMemUsage() Checks a flag that indicates current OS memory usage should be reported alongside peak OS memory usage.
boolean	isUsingGCCallsToTrackMemory() Gets the flag that determines if System.gc() is called at beginning and end of each segment to more accurately track memory usage.
boolean	isVerbose()
void	printSummary()
void	setReportingCurrOSMemUsage(boolean reportCurrOSMemUsage) Flag indicating if CodePerfTracker is running in Linux and is reporting memory usage, to also report current OS memory usage alongside peak OS memory usage.
void	setTrackOSMemUsage(boolean trackOSMemUsage) Sets tracking of OS memory usage (in Linux only).
void	setVerbose(boolean verbose)
CodePerfTracker	start(String segmentName)
CodePerfTracker	start(String segmentName, boolean nested)
CodePerfTracker	stop()
CodePerfTracker	stop(String segmentName)
void	updateName(String name)
void	useGCToTrackMemory(boolean useGCCalls) By setting this flag, more accurate memory usage numbers can be captured.

Methods inherited from class Object

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

Field Detail

SILENT

public static final CodePerfTracker SILENT

Constructor Detail

CodePerfTracker

public CodePerfTracker(String name)

CodePerfTracker

public CodePerfTracker(String name,
                       boolean printProgress)

CodePerfTracker

public CodePerfTracker(String name,
                       boolean printProgress,
                       boolean isVerbose)

Method Detail

init

public void init(String name,
                 boolean printProgress)

updateName

public void updateName(String name)

getRuntime

public Long getRuntime(String segmentName)

getMemUsage

public Long getMemUsage(String segmentName)

isVerbose

public boolean isVerbose()

setVerbose

public void setVerbose(boolean verbose)

start

public CodePerfTracker start(String segmentName)

stop

public CodePerfTracker stop()

start

public CodePerfTracker start(String segmentName,
                             boolean nested)

stop

public CodePerfTracker stop(String segmentName)

isUsingGCCallsToTrackMemory

public boolean isUsingGCCallsToTrackMemory()

Gets the flag that determines if System.gc() is called at beginning and end of each segment to more accurately track memory usage.

Returns:

True if this CodePerfTracker is using System.gc() calls at beginning and end of segments to obtain more accurate memory usages. False otherwise.

useGCToTrackMemory

public void useGCToTrackMemory(boolean useGCCalls)

By setting this flag, more accurate memory usage numbers can be captured. The tradeoff is that System.gc() calls can increase total runtime of the program (although the call is not included in measured runtime). When running in Linux, this also sets CodePerfTracker.setTrackOSMemUsage(boolean) as a convenience.

Parameters:

useGCCalls - Sets a flag that uses System.gc() calls at the beginning and end of segments to obtain more accurate memory usages.

setTrackOSMemUsage

public void setTrackOSMemUsage(boolean trackOSMemUsage)

Sets tracking of OS memory usage (in Linux only).

Parameters:

trackOSMemUsage - If true, will track curr and peak memory usage of the process as reported by the OS.

isReportingCurrOSMemUsage

public boolean isReportingCurrOSMemUsage()

Checks a flag that indicates current OS memory usage should be reported alongside peak OS memory usage. The default is false.

Returns:

True if the flag is set, false otherwise. Default is false.

setReportingCurrOSMemUsage

public void setReportingCurrOSMemUsage(boolean reportCurrOSMemUsage)

Flag indicating if CodePerfTracker is running in Linux and is reporting memory usage, to also report current OS memory usage alongside peak OS memory usage.

Parameters:

reportCurrOSMemUsage - Flag to report current OS memory usage, default is false.

printSummary

public void printSummary()