Package org.eclipse.tracecompass.incubator.callstack.core.sampled.callgraph

Class ProfilingCallGraphAnalysisModule

java.lang.Object

org.eclipse.tracecompass.tmf.core.component.TmfComponent

org.eclipse.tracecompass.tmf.core.analysis.TmfAbstractAnalysisModule

org.eclipse.tracecompass.incubator.callstack.core.sampled.callgraph.ProfilingCallGraphAnalysisModule

All Implemented Interfaces:

IWeightedTreeProvider<@NonNull ICallStackSymbol,ICallStackElement,AggregatedCallSite>, ICallGraphProvider, IEventCallStackProvider, IAnalysisModule, IAnalysisRequirementProvider, ITmfComponent, ITmfPropertiesProvider

public abstract class ProfilingCallGraphAnalysisModule
extends TmfAbstractAnalysisModule
implements ICallGraphProvider, IEventCallStackProvider

The callgraph analysis module

Author:

Geneviève Bastien

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.tracecompass.incubator.analysis.core.weighted.tree.IWeightedTreeProvider

IWeightedTreeProvider.DataType, IWeightedTreeProvider.MetricType

Field Summary

Fields inherited from interface org.eclipse.tracecompass.incubator.analysis.core.weighted.tree.IWeightedTreeProvider

WEIGHT_TYPE

Constructor Summary

Constructors

Constructor	Description
ProfilingCallGraphAnalysisModule()

Method Summary

Modifier and Type	Method	Description
void	addRootElement(ICallStackElement element)	Add a root element to call graph
AggregatedCallSite	createCallSite(Object symbol)	Factory method to create an aggregated callsite for a symbol
CallGraph	getCallGraph()	Get the call graph for the full range of the trace.
CallGraph	getCallGraph(ITmfTimestamp start, ITmfTimestamp end)	Get the call graph for a given time range.
AggregatedCallSite	getCallSite(ICallStackElement dstGroup, long[] stackTrace, long ts)	Get a callsite from a stack trace.
String	getTitle()	A title for this tree provider.
@NonNull IWeightedTreeProvider.MetricType	getWeightType()	Get the metric type for the weight value.
@NonNull String	toDisplayString(@NonNull AggregatedCallSite callsite)	Get a user-facing text to identify a tree object.

Methods inherited from class org.eclipse.tracecompass.tmf.core.analysis.TmfAbstractAnalysisModule

addParameter, cancel, canExecute, dispose, fail, getAnalysisRequirements, getDependencyLevel, getHelpText, getHelpText, getId, getName, getOutputs, getParameter, getProperties, getTrace, isAutomatic, notifyParameterChanged, registerOutput, schedule, setAutomatic, setId, setName, setParameter, setTrace, traceClosed, traceSelected, waitForCompletion, waitForCompletion

Methods inherited from class org.eclipse.tracecompass.tmf.core.component.TmfComponent

broadcast, broadcastAsync, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModule

isQueryable

Methods inherited from interface org.eclipse.tracecompass.incubator.callstack.core.callgraph.ICallGraphProvider

getGroupDescriptor, getGroupDescriptors, getPalette, getSelection, getTreeSet

Methods inherited from interface org.eclipse.tracecompass.incubator.callstack.core.flamechart.IEventCallStackProvider

getCallStack

Methods inherited from interface org.eclipse.tracecompass.tmf.core.component.ITmfComponent

broadcast, broadcastAsync

Methods inherited from interface org.eclipse.tracecompass.incubator.analysis.core.weighted.tree.IWeightedTreeProvider

getAdditionalMetric, getAdditionalMetrics, getExtraDataSets, getStatistics

Constructor Details

ProfilingCallGraphAnalysisModule

public ProfilingCallGraphAnalysisModule()

Method Details

addRootElement

public void addRootElement(ICallStackElement element)

Add a root element to call graph

Parameters:

element - The root element to add

getCallGraph

public CallGraph getCallGraph(ITmfTimestamp start,
 ITmfTimestamp end)

Description copied from interface: ICallGraphProvider

Get the call graph for a given time range. This callgraph is for all the elements. The caller can then group the result by calling WeightedTreeGroupBy.groupWeightedTreeBy(IWeightedTreeGroupDescriptor, IWeightedTreeSet, IWeightedTreeProvider) method

Specified by:

getCallGraph in interface ICallGraphProvider

Parameters:

start - The start of the range

end - The end of the range

Returns:

The call graph object containing the CCTs for each element in the range.

getCallGraph

public CallGraph getCallGraph()

Description copied from interface: ICallGraphProvider

Get the call graph for the full range of the trace. This callgraph is for all the elements. The caller can then group the result by calling WeightedTreeGroupBy.groupWeightedTreeBy(IWeightedTreeGroupDescriptor, IWeightedTreeSet, IWeightedTreeProvider)

Specified by:

getCallGraph in interface ICallGraphProvider

Returns:

The call graph object containing the CCTs for each element in the range.

getWeightType

public @NonNull IWeightedTreeProvider.MetricType getWeightType()

Description copied from interface: IWeightedTreeProvider

Get the metric type for the weight value. The default metric is called "Weight" and is a number

Specified by:

getWeightType in interface IWeightedTreeProvider<@NonNull ICallStackSymbol,ICallStackElement,AggregatedCallSite>

Returns:

The metric type for the weight value.

getTitle

public String getTitle()

Description copied from interface: IWeightedTreeProvider

A title for this tree provider. This title will be visible by users and should describe what this tree provider's data represent.

Specified by:

getTitle in interface IWeightedTreeProvider<@NonNull ICallStackSymbol,ICallStackElement,AggregatedCallSite>

Returns:

The title of this provider

toDisplayString

public @NonNull String toDisplayString(@NonNull AggregatedCallSite callsite)

Description copied from interface: IWeightedTreeProvider

Get a user-facing text to identify a tree object. By default, it is the string representation of the object.

Specified by:

toDisplayString in interface IWeightedTreeProvider<@NonNull ICallStackSymbol,ICallStackElement,AggregatedCallSite>

Parameters:

callsite - The tree whose value to display

Returns:

A user-facing string to identify this node

createCallSite

public AggregatedCallSite createCallSite(Object symbol)

Description copied from interface: ICallGraphProvider

Factory method to create an aggregated callsite for a symbol

Specified by:

createCallSite in interface ICallGraphProvider

Parameters:

symbol - The symbol

Returns:

A new aggregated callsite

getCallSite

public AggregatedCallSite getCallSite(ICallStackElement dstGroup,
 long[] stackTrace,
 long ts)

Get a callsite from a stack trace. The array should be non-zero length and the symbol at position 0 is the top of the stack, ie the last symbol called.

Parameters:

dstGroup - The element to which to add this stack trace

stackTrace - The stack trace to add to the group

ts - The timestamp at which this stack trace is added

Returns:

The callsite

Throws:

ArrayIndexOutOfBoundsException - Exception thrown if the stackTrace is empty