/*******************************************************************************
- * Copyright (c) 2012 Ericsson
+ * Copyright (c) 2012, 2013 Ericsson
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* Contributors:
* Mathieu Denis <mathieu.denis@polymtl.ca> - Initial API and implementation
* Alexandre Montplaisir - Port to ITmfStatistics provider
+ * Patrick Tasse - Support selection range
*******************************************************************************/
package org.eclipse.linuxtools.tmf.ui.viewers.statistics;
import java.util.List;
import java.util.Map;
+import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.TreeViewerColumn;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerComparator;
import org.eclipse.linuxtools.tmf.core.component.TmfComponent;
-import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
-import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
-import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp;
-import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest;
-import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentRangeUpdatedSignal;
+import org.eclipse.linuxtools.tmf.core.request.ITmfEventRequest;
import org.eclipse.linuxtools.tmf.core.signal.TmfRangeSynchSignal;
import org.eclipse.linuxtools.tmf.core.signal.TmfSignalHandler;
-import org.eclipse.linuxtools.tmf.core.signal.TmfStateSystemBuildCompleted;
+import org.eclipse.linuxtools.tmf.core.signal.TmfTimeSynchSignal;
+import org.eclipse.linuxtools.tmf.core.signal.TmfTraceRangeUpdatedSignal;
import org.eclipse.linuxtools.tmf.core.statistics.ITmfStatistics;
-import org.eclipse.linuxtools.tmf.core.statistics.TmfStatistics;
+import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
+import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;
import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;
+import org.eclipse.linuxtools.tmf.core.trace.TmfTraceManager;
import org.eclipse.linuxtools.tmf.ui.viewers.TmfViewer;
import org.eclipse.linuxtools.tmf.ui.viewers.statistics.model.ITmfColumnDataProvider;
import org.eclipse.linuxtools.tmf.ui.viewers.statistics.model.TmfBaseColumnData;
import org.eclipse.linuxtools.tmf.ui.viewers.statistics.model.TmfStatisticsTreeManager;
import org.eclipse.linuxtools.tmf.ui.viewers.statistics.model.TmfStatisticsTreeNode;
import org.eclipse.linuxtools.tmf.ui.viewers.statistics.model.TmfTreeContentProvider;
+import org.eclipse.linuxtools.tmf.ui.views.statistics.TmfStatisticsModule;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
*/
public class TmfStatisticsViewer extends TmfViewer {
- /**
- * The initial window span (in nanoseconds)
- */
- public static final long INITIAL_WINDOW_SPAN = (1L * 100 * 1000 * 1000); // .1sec
-
/**
* Timestamp scale (nanosecond)
*/
- public static final byte TIME_SCALE = -9;
+ public static final byte TIME_SCALE = ITmfTimestamp.NANOSECOND_SCALE;
/**
* Default PAGE_SIZE for background requests.
private int fInstanceNb;
/**
- * Object to store the cursor while waiting for the experiment to load
+ * Object to store the cursor while waiting for the trace to load
*/
private Cursor fWaitCursor = null;
private int fWaitCursorCount = 0;
/**
- * Tells to send a time range request when the experiment gets updated.
+ * Tells to send a time range request when the trace gets updated.
*/
private boolean fSendRangeRequest = true;
+ /** Reference to the trace manager */
+ private final TmfTraceManager fTraceManager;
+
/**
* Empty constructor. To be used in conjunction with
* {@link TmfStatisticsViewer#init(Composite, String, ITmfTrace)}
*/
public TmfStatisticsViewer() {
super();
+ fTraceManager = TmfTraceManager.getInstance();
}
/**
*/
public TmfStatisticsViewer(Composite parent, String viewerName, ITmfTrace trace) {
init(parent, viewerName, trace);
+ fTraceManager = TmfTraceManager.getInstance();
}
/**
fInstanceNb = fCountInstance;
fTrace = trace;
- // The viewer will process all events if he is assigned to the experiment
+ // The viewer will process all events if he is assigned to an experiment
fProcessAll = (trace instanceof TmfExperiment);
initContent(parent);
initInput();
}
- /*
- * (non-Javadoc)
- *
- * @see org.eclipse.linuxtools.tmf.core.component.TmfComponent#dispose()
- */
@Override
public void dispose() {
super.dispose();
TmfStatisticsTreeManager.removeStatTreeRoot(getTreeID());
}
- /**
- * Handler for the state system build completed signal
- *
- * @param signal
- * The signal that's received
- */
- @TmfSignalHandler
- public void stateSystemBuildCompleted(final TmfStateSystemBuildCompleted signal) {
- if (isListeningTo(signal.getTrace().getName()) && signal.getID().equals(TmfStatistics.STATE_ID)) {
- TmfExperiment experiment = TmfExperiment.getCurrentExperiment();
- requestData(experiment, experiment.getTimeRange());
- requestTimeRangeData(experiment, fRequestedTimerange);
- }
- }
+ // ------------------------------------------------------------------------
+ // Signal handlers
+ // ------------------------------------------------------------------------
/**
- * Handles the signal about new experiment range.
+ * Handles the signal about new trace range.
*
* @param signal
- * The experiment range updated signal
+ * The trace range updated signal
*/
@TmfSignalHandler
- public void experimentRangeUpdated(TmfExperimentRangeUpdatedSignal signal) {
- TmfExperiment experiment = signal.getExperiment();
+ public void traceRangeUpdated(TmfTraceRangeUpdatedSignal signal) {
+ ITmfTrace trace = signal.getTrace();
// validate
- if (!experiment.equals(TmfExperiment.getCurrentExperiment())) {
+ if (!isListeningTo(trace)) {
return;
}
// Sends the time range request only once from this method.
if (fSendRangeRequest) {
fSendRangeRequest = false;
- // Calculate the selected time range to request
- long startTime = signal.getRange().getStartTime().normalize(0, TIME_SCALE).getValue();
- TmfTimestamp startTS = new TmfTimestamp(startTime, TIME_SCALE);
- TmfTimestamp endTS = new TmfTimestamp(startTime + INITIAL_WINDOW_SPAN, TIME_SCALE);
- TmfTimeRange timeRange = new TmfTimeRange(startTS, endTS);
-
- requestTimeRangeData(experiment, timeRange);
+ ITmfTimestamp begin = fTraceManager.getSelectionBeginTime();
+ ITmfTimestamp end = fTraceManager.getSelectionEndTime();
+ TmfTimeRange timeRange = new TmfTimeRange(begin, end);
+ requestTimeRangeData(trace, timeRange);
}
}
- requestData(experiment, signal.getRange());
+ requestData(trace, signal.getRange());
}
/**
*
* @param signal
* Contains the information about the new selected time range.
+ * @deprecated
+ * As of 2.1, use {@link #timeSynchUpdated(TmfTimeSynchSignal)}
*/
+ @Deprecated
@TmfSignalHandler
public void timeRangeUpdated(TmfRangeSynchSignal signal) {
- requestTimeRangeData(TmfExperiment.getCurrentExperiment(), signal.getCurrentRange());
}
+ /**
+ * Handles the time synch updated signal. It updates the time range
+ * statistics.
+ *
+ * @param signal
+ * Contains the information about the new selected time range.
+ * @since 2.1
+ */
+ @TmfSignalHandler
+ public void timeSynchUpdated(TmfTimeSynchSignal signal) {
+ if (fTrace == null) {
+ return;
+ }
+ ITmfTimestamp begin = signal.getBeginTime();
+ ITmfTimestamp end = signal.getEndTime();
+ TmfTimeRange timeRange = new TmfTimeRange(begin, end);
+ requestTimeRangeData(fTrace, timeRange);
+ }
+
+ // ------------------------------------------------------------------------
+ // Class methods
+ // ------------------------------------------------------------------------
+
/*
* Returns the primary control associated with this viewer.
*
*
* @param request
* The request to be canceled
+ * @since 3.0
*/
- protected void cancelOngoingRequest(ITmfDataRequest request) {
+ protected void cancelOngoingRequest(ITmfEventRequest request) {
if (request != null && !request.isCompleted()) {
request.cancel();
}
/**
* Initializes the input for the tree viewer.
- *
- * @param input
- * The input of this viewer, or <code>null</code> if none
*/
protected void initInput() {
String treeID = getTreeID();
- TmfStatisticsTreeNode experimentTreeNode;
+ TmfStatisticsTreeNode statisticsTreeNode;
if (TmfStatisticsTreeManager.containsTreeRoot(treeID)) {
- // The experiment root is already present
- experimentTreeNode = TmfStatisticsTreeManager.getStatTreeRoot(treeID);
+ // The statistics root is already present
+ statisticsTreeNode = TmfStatisticsTreeManager.getStatTreeRoot(treeID);
// Checks if the trace is already in the statistics tree.
- int numNodeTraces = experimentTreeNode.getNbChildren();
-
- int numTraces = 1;
- ITmfTrace[] trace = { fTrace };
- // For experiment, gets all the traces within it
- if (fTrace instanceof TmfExperiment) {
- TmfExperiment experiment = (TmfExperiment) fTrace;
- numTraces = experiment.getTraces().length;
- trace = experiment.getTraces();
- }
+ int numNodeTraces = statisticsTreeNode.getNbChildren();
+
+ ITmfTrace[] traces = TmfTraceManager.getTraceSet(fTrace);
+ int numTraces = traces.length;
if (numTraces == numNodeTraces) {
boolean same = true;
* previously selected.
*/
for (int i = 0; i < numTraces; i++) {
- String traceName = trace[i].getName();
- if (!experimentTreeNode.containsChild(traceName)) {
+ String traceName = traces[i].getName();
+ if (!statisticsTreeNode.containsChild(traceName)) {
same = false;
break;
}
if (same) {
// No need to reload data, all traces are already loaded
- fTreeViewer.setInput(experimentTreeNode);
+ fTreeViewer.setInput(statisticsTreeNode);
return;
}
// Clears the old content to start over
- experimentTreeNode.reset();
+ statisticsTreeNode.reset();
}
} else {
// Creates a new tree
- experimentTreeNode = TmfStatisticsTreeManager.addStatsTreeRoot(treeID, getStatisticData());
+ statisticsTreeNode = TmfStatisticsTreeManager.addStatsTreeRoot(treeID, getStatisticData());
}
// Sets the input to a clean data model
- fTreeViewer.setInput(experimentTreeNode);
+ fTreeViewer.setInput(statisticsTreeNode);
resetUpdateSynchronization();
}
/**
- * Tells if the viewer is listening to a trace from the selected experiment.
+ * Tells if the viewer is listening to a trace.
*
- * @param traceName
+ * @param trace
* The trace that the viewer may be listening
* @return true if the viewer is listening to the trace, false otherwise
*/
- protected boolean isListeningTo(String traceName) {
- if (fProcessAll || traceName.equals(fTrace.getName())) {
+ protected boolean isListeningTo(ITmfTrace trace) {
+ if (fProcessAll || trace == fTrace) {
return true;
}
return false;
}
/**
- * Called when an experiment request has been completed successfully.
+ * Called when an trace request has been completed successfully.
*
* @param global
* Tells if the request is a global or time range (partial)
}
/**
- * Called when an experiment request has failed or has been cancelled.
+ * Called when an trace request has failed or has been cancelled.
*
* @param isGlobalRequest
* Tells if the request is a global or time range (partial)
}
/**
- * Sends the request to the experiment for the whole trace
+ * Sends the request to the trace for the whole trace
*
- * @param experiment
- * The experiment used to send the request
- * @param range
- * The range to request to the experiment
+ * @param trace
+ * The trace used to send the request
+ * @param timeRange
+ * The range to request to the trace
*/
- protected void requestData(final TmfExperiment experiment, final TmfTimeRange timeRange) {
- final Thread thread = new Thread("Statistics view build") { //$NON-NLS-1$
- @Override
- public void run() {
- buildStatisticsTree(experiment, timeRange, true);
- }
- };
- thread.start();
+ protected void requestData(final ITmfTrace trace, final TmfTimeRange timeRange) {
+ buildStatisticsTree(trace, timeRange, true);
}
/**
- * Sends the time range request from the experiment
+ * Sends the time range request from the trace
*
- * @param experiment
- * The experiment used to send the request
- * @param range
- * The range to request to the experiment
+ * @param trace
+ * The trace used to send the request
+ * @param timeRange
+ * The range to request to the trace
*/
- protected void requestTimeRangeData(final TmfExperiment experiment, final TmfTimeRange timeRange) {
+ protected void requestTimeRangeData(final ITmfTrace trace, final TmfTimeRange timeRange) {
fRequestedTimerange = timeRange;
-
- final Thread thread = new Thread("Statistics view build") { //$NON-NLS-1$
- @Override
- public void run() {
- buildStatisticsTree(experiment, timeRange, false);
- }
- };
- thread.start();
+ buildStatisticsTree(trace, timeRange, false);
}
/**
- * Requests all the data of the experiment to the state system which
+ * Requests all the data of the trace to the state system which
* contains information about the statistics.
*
- * Since the viewer may be listening to multiple traces, it have to receive
- * the experiment rather than a single trace. The filtering is done with the
+ * Since the viewer may be listening to multiple traces, it may receive
+ * an experiment rather than a single trace. The filtering is done with the
* method {@link #isListeningTo(String trace)}.
*
- * @param experiment
- * The experiment for which a request must be done
+ * @param trace
+ * The trace for which a request must be done
* @param timeRange
* The time range that will be requested to the state system
* @param isGlobal
* Tells if the request is for the global event count or the
* partial one.
*/
- private void buildStatisticsTree(final TmfExperiment experiment, TmfTimeRange timeRange, boolean isGlobal) {
+ private void buildStatisticsTree(final ITmfTrace trace, final TmfTimeRange timeRange, final boolean isGlobal) {
final TmfStatisticsTreeNode statTree = TmfStatisticsTreeManager.getStatTreeRoot(getTreeID());
final TmfStatisticsTree statsData = TmfStatisticsTreeManager.getStatTree(getTreeID());
if (statsData == null) {
statTree.resetTimeRangeValue();
}
- /*
- * Checks each trace in the experiment, since the viewer may be
- * listening to multiple traces.
- */
- for (final ITmfTrace trace : experiment.getTraces()) {
- if (!isListeningTo(trace.getName())) {
+ for (final ITmfTrace aTrace : TmfTraceManager.getTraceSet(trace)) {
+ if (!isListeningTo(aTrace)) {
continue;
}
- /* Retrieves the statistics object */
- final ITmfStatistics stats = trace.getStatistics();
- if (stats == null) {
- /*
- * The state system is not accessible yet for this trace.
- * Try the next one.
- */
+ /* Retrieve the statistics object */
+ final TmfStatisticsModule statsMod = aTrace.getAnalysisModuleOfClass(TmfStatisticsModule.class, TmfStatisticsModule.ID);
+ if (statsMod == null) {
+ /* No statistics module available for this trace */
continue;
}
- updateValues(statsData, trace, timeRange, isGlobal);
+ /* Run the potentially long queries in a separate thread */
+ Thread statsThread = new Thread("Statistics update") { //$NON-NLS-1$
+ @Override
+ public void run() {
+ /* Wait until the analysis is ready */
+ if (!statsMod.waitForCompletion(new NullProgressMonitor())) {
+ return;
+ }
- modelComplete(isGlobal);
+ ITmfStatistics stats = statsMod.getStatistics();
+ if (stats == null) {
+ /* It should have worked, but didn't */
+ return;
+ }
+
+ /*
+ * The generic statistics are stored in nanoseconds, so
+ * we must make sure the time range is scaled correctly.
+ */
+ long start = timeRange.getStartTime().normalize(0, TIME_SCALE).getValue();
+ long end = timeRange.getEndTime().normalize(0, TIME_SCALE).getValue();
+
+ Map<String, Long> map = stats.getEventTypesInRange(start, end);
+ updateStats(isGlobal, map);
+ }
+ };
+ statsThread.start();
+ return;
}
}
}
/**
- * Update the statistics values. It can be extended by subclasses if they
- * want to show something other than the base information in their viewer.
- * They can decide to show the base information too, by calling
- * super.updateValues() or not.
+ * Whenever a trace's statistics back-end finishes computing the statistics
+ * for a given interval, it will send the StatsUpdated signal. This method
+ * will receive this signal and update the statistics view accordingly.
*
- * @param statsData
- * The statistics tree we are updating
- * @param trace
- * The trace related to these statistics
- * @param timeRange
- * The time range for which we are updating. For updates to the
- * global data this should be the whole (available) time range of
- * the trace.
- * @param isGlobal
- * Are we updating the Global data (for the complete time range
- * of the trace), or the selected time range data?
+ * @param sig
+ * The signal that is received
*/
- protected void updateValues(TmfStatisticsTree statsData, ITmfTrace trace,
- TmfTimeRange timeRange, boolean isGlobal) {
- ITmfStatistics stats = trace.getStatistics();
+ private void updateStats(boolean isGlobal, Map<String, Long> eventsPerType) {
+
+ final TmfStatisticsTree statsData = TmfStatisticsTreeManager.getStatTree(getTreeID());
+ Map<String, Long> map = eventsPerType;
+ String name = fTrace.getName();
/*
* "Global", "partial", "total", etc., it's all very confusing...
* D : TimeRangeTypeCount(s)
*/
- /* The generic statistics are stored in nanoseconds, so we must make
- * sure the time range is scaled correctly. */
- ITmfTimestamp start = timeRange.getStartTime().normalize(0, TIME_SCALE);
- ITmfTimestamp end = timeRange.getEndTime().normalize(0, TIME_SCALE);
- String name = trace.getName();
+ /* Fill in an the event counts (either cells C or D) */
+ for (Map.Entry<String, Long> entry : map.entrySet()) {
+ statsData.setTypeCount(name, entry.getKey(), isGlobal, entry.getValue());
+ }
/*
- * Fill in the Total row (cell A or B, depending if isGlobal)
- * (we can still use .getEventsInRange(), even if it's global,
- * start and end will cover the whole trace)
+ * Calculate the totals (cell A or B, depending if isGlobal). We will
+ * use the results of the previous request instead of sending another
+ * one.
*/
- long globalTotal = stats.getEventsInRange(start, end);
+ long globalTotal = 0;
+ for (long val : map.values()) {
+ globalTotal += val;
+ }
statsData.setTotal(name, isGlobal, globalTotal);
- /* Fill in an the event counts (either cells C or D) */
- Map<String, Long> map = stats.getEventTypesInRange(start, end);
- for (Map.Entry<String, Long> entry : map.entrySet()) {
- statsData.setTypeCount(name, entry.getKey(), isGlobal, entry.getValue());
- }
+ modelComplete(isGlobal);
}
/**
}
/**
- * When the experiment is loading the cursor will be different so the user
+ * When the trace is loading the cursor will be different so the user
* knows that the processing is not finished yet.
*
* Calls to this method are stacked.
fStatisticsUpdateBusy = false;
if (fStatisticsUpdatePending) {
fStatisticsUpdatePending = false;
- requestData(TmfExperiment.getCurrentExperiment(), fStatisticsUpdateRange);
+ requestData(fTrace, fStatisticsUpdateRange);
fStatisticsUpdateRange = null;
}
}
projects / deliverable / tracecompass.git / blobdiff