1 /******************************************************************************
2 * Copyright (c) 2015, 2016 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * France Lapointe Nguyen - Initial API and implementation
11 * Bernd Hufmann - Extracted abstract class from LatencyScatterGraphViewer
12 *******************************************************************************/
14 package org
.eclipse
.tracecompass
.analysis
.timing
.ui
.views
.segmentstore
.scatter
;
16 import java
.text
.Format
;
17 import java
.util
.ArrayList
;
18 import java
.util
.Collection
;
19 import java
.util
.Collections
;
20 import java
.util
.Iterator
;
21 import java
.util
.List
;
23 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
24 import org
.eclipse
.core
.runtime
.IStatus
;
25 import org
.eclipse
.core
.runtime
.Status
;
26 import org
.eclipse
.core
.runtime
.jobs
.Job
;
27 import org
.eclipse
.jdt
.annotation
.Nullable
;
28 import org
.eclipse
.swt
.widgets
.Composite
;
29 import org
.eclipse
.swt
.widgets
.Display
;
30 import org
.eclipse
.tracecompass
.analysis
.timing
.core
.segmentstore
.IAnalysisProgressListener
;
31 import org
.eclipse
.tracecompass
.analysis
.timing
.core
.segmentstore
.ISegmentStoreProvider
;
32 import org
.eclipse
.tracecompass
.analysis
.timing
.ui
.views
.segmentstore
.SubSecondTimeWithUnitFormat
;
33 import org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
;
34 import org
.eclipse
.tracecompass
.internal
.analysis
.timing
.ui
.Activator
;
35 import org
.eclipse
.tracecompass
.internal
.analysis
.timing
.ui
.views
.segmentstore
.scatter
.Messages
;
36 import org
.eclipse
.tracecompass
.internal
.analysis
.timing
.ui
.views
.segmentstore
.scatter
.SegmentStoreScatterGraphTooltipProvider
;
37 import org
.eclipse
.tracecompass
.segmentstore
.core
.ISegment
;
38 import org
.eclipse
.tracecompass
.segmentstore
.core
.ISegmentStore
;
39 import org
.eclipse
.tracecompass
.segmentstore
.core
.SegmentComparators
;
40 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisModule
;
41 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
42 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceClosedSignal
;
43 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
44 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
45 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfWindowRangeUpdatedSignal
;
46 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimeRange
;
47 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
48 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
49 import org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.xycharts
.linecharts
.TmfCommonXLineChartViewer
;
50 import org
.swtchart
.ILineSeries
;
51 import org
.swtchart
.ILineSeries
.PlotSymbolType
;
52 import org
.swtchart
.ISeries
.SeriesType
;
53 import org
.swtchart
.ISeriesSet
;
54 import org
.swtchart
.LineStyle
;
56 import com
.google
.common
.primitives
.Doubles
;
59 * Displays the segment store provider data in a scatter graph
61 * @author France Lapointe Nguyen
62 * @author Matthew Khouzam - reduced memory usage
65 public abstract class AbstractSegmentStoreScatterGraphViewer
extends TmfCommonXLineChartViewer
{
67 private static final Format FORMAT
= new SubSecondTimeWithUnitFormat();
69 private final class CompactingSegmentStoreQuery
extends Job
{
70 private static final long MAX_POINTS
= 1000;
71 private final TmfTimeRange fCurrentRange
;
73 private CompactingSegmentStoreQuery(TmfTimeRange currentRange
) {
74 super(Messages
.SegmentStoreScatterGraphViewer_compactTitle
);
75 fCurrentRange
= currentRange
;
79 protected IStatus
run(@Nullable IProgressMonitor monitor
) {
80 final IProgressMonitor statusMonitor
= monitor
;
81 if (statusMonitor
== null) {
82 return new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, "Monitor is null"); //$NON-NLS-1$
85 ISegmentStoreProvider segmentProvider
= getSegmentProvider();
86 final long startTimeInNanos
= fCurrentRange
.getStartTime().toNanos();
87 final long endTimeInNanos
= fCurrentRange
.getEndTime().toNanos();
88 if (segmentProvider
== null) {
89 setWindowRange(startTimeInNanos
, endTimeInNanos
);
90 redraw(statusMonitor
, startTimeInNanos
, startTimeInNanos
, Collections
.EMPTY_LIST
);
91 return new Status(IStatus
.WARNING
, Activator
.PLUGIN_ID
, "segment provider not available"); //$NON-NLS-1$
94 final ISegmentStore
<ISegment
> segStore
= segmentProvider
.getSegmentStore();
95 if (segStore
== null) {
96 setWindowRange(startTimeInNanos
, endTimeInNanos
);
97 redraw(statusMonitor
, startTimeInNanos
, startTimeInNanos
, Collections
.EMPTY_LIST
);
98 return new Status(IStatus
.INFO
, Activator
.PLUGIN_ID
, "Segment provider does not have segments"); //$NON-NLS-1$
101 final long startTime
= fCurrentRange
.getStartTime().getValue();
102 final long endTime
= fCurrentRange
.getEndTime().getValue();
103 fPixelStart
= startTime
;
104 fPixelSize
= Math
.max(1, (endTime
- startTime
) / MAX_POINTS
);
105 final Iterable
<ISegment
> intersectingElements
= segStore
.getIntersectingElements(startTime
, endTime
);
107 final List
<ISegment
> list
= convertIterableToList(intersectingElements
, statusMonitor
);
108 final List
<ISegment
> displayData
= (!list
.isEmpty()) ?
compactList(startTime
, list
, statusMonitor
) : list
;
110 setWindowRange(startTimeInNanos
, endTimeInNanos
);
111 redraw(statusMonitor
, startTime
, endTime
, displayData
);
113 if (statusMonitor
.isCanceled()) {
114 return Status
.CANCEL_STATUS
;
116 return Status
.OK_STATUS
;
120 private void redraw(final IProgressMonitor statusMonitor
, final long startTime
, final long endTime
, final List
<ISegment
> displayData
) {
121 fDisplayData
= displayData
;
122 Display
.getDefault().asyncExec(new Runnable() {
126 updateData(startTime
, endTime
, displayData
.size(), statusMonitor
);
131 private List
<ISegment
> compactList(final long startTime
, final List
<ISegment
> listToCompact
, final IProgressMonitor statusMonitor
) {
132 List
<ISegment
> displayData
= new ArrayList
<>();
133 ISegment last
= listToCompact
.get(0);
134 if (last
.getStart() >= startTime
) {
135 displayData
.add(last
);
137 for (ISegment next
: listToCompact
) {
138 if (next
.getStart() < startTime
) {
141 if (statusMonitor
.isCanceled()) {
142 return Collections
.EMPTY_LIST
;
144 if (!overlaps(last
, next
)) {
145 displayData
.add(next
);
152 private List
<ISegment
> convertIterableToList(final Iterable
<ISegment
> iterable
, final IProgressMonitor statusMonitor
) {
153 final List
<ISegment
> list
= new ArrayList
<>();
154 for (ISegment seg
: iterable
) {
155 if (statusMonitor
.isCanceled()) {
156 return Collections
.EMPTY_LIST
;
160 Collections
.sort(list
, SegmentComparators
.INTERVAL_START_COMPARATOR
);
164 private boolean overlaps(ISegment last
, ISegment next
) {
165 long timePerPix
= fPixelSize
;
166 final long start
= last
.getStart();
167 final long pixelStart
= fPixelStart
;
168 final long pixelDuration
= start
- pixelStart
;
169 long startPixBoundL
= pixelDuration
/ timePerPix
* timePerPix
+ pixelStart
;
170 long startPixBoundR
= startPixBoundL
+ timePerPix
;
171 final long currentStart
= next
.getStart();
172 if (currentStart
>= startPixBoundL
&& currentStart
<= startPixBoundR
) {
173 long length
= last
.getLength();
174 long lengthNext
= next
.getLength();
175 long lengthLow
= length
/ timePerPix
* timePerPix
;
176 long lengthHigh
= lengthLow
+ timePerPix
;
177 return (lengthNext
>= lengthLow
&& lengthNext
<= lengthHigh
);
183 // ------------------------------------------------------------------------
185 // ------------------------------------------------------------------------
188 * Listener to update the model with the segment store provider results once
189 * its segment store is fully completed
191 private final class SegmentStoreProviderProgressListener
implements IAnalysisProgressListener
{
194 public void onComplete(ISegmentStoreProvider segmentProvider
, ISegmentStore
<ISegment
> segmentStore
) {
195 // Only update the model if trace that was analyzed is active trace
196 if (segmentProvider
.equals(getSegmentProvider())) {
197 updateModel(segmentStore
);
198 updateRange(TmfTraceManager
.getInstance().getCurrentTraceContext().getWindowRange());
203 private long fPixelSize
= -1;
205 private long fPixelStart
= 0;
209 private Collection
<ISegment
> fDisplayData
= Collections
.EMPTY_LIST
;
212 * Provider completion listener
214 private SegmentStoreProviderProgressListener fListener
;
217 * Current segment provider
219 private @Nullable ISegmentStoreProvider fSegmentProvider
;
221 private @Nullable Job fCompactingJob
;
223 // ------------------------------------------------------------------------
225 // ------------------------------------------------------------------------
239 public AbstractSegmentStoreScatterGraphViewer(Composite parent
, String title
, String xLabel
, String yLabel
) {
240 super(parent
, title
, xLabel
, yLabel
);
241 setTooltipProvider(new SegmentStoreScatterGraphTooltipProvider(this));
242 fListener
= new SegmentStoreProviderProgressListener();
243 ITmfTrace trace
= TmfTraceManager
.getInstance().getActiveTrace();
244 initializeProvider(trace
);
245 getSwtChart().getLegend().setVisible(false);
246 getSwtChart().getAxisSet().getYAxis(0).getTick().setFormat(FORMAT
);
249 private final void initializeProvider(@Nullable ITmfTrace trace
) {
251 final ISegmentStoreProvider segmentStoreProvider
= getSegmentStoreProvider(trace
);
252 if (segmentStoreProvider
!= null) {
253 segmentStoreProvider
.addListener(fListener
);
254 setData(segmentStoreProvider
);
255 updateRange(TmfTraceManager
.getInstance().getCurrentTraceContext().getWindowRange());
260 // ------------------------------------------------------------------------
262 // ------------------------------------------------------------------------
265 * Update the data in the graph
270 public void updateModel(@Nullable ISegmentStore
<ISegment
> dataInput
) {
271 // Update new window range
272 TmfTimeRange currentRange
= TmfTraceManager
.getInstance().getCurrentTraceContext().getWindowRange();
273 long currentStart
= currentRange
.getStartTime().toNanos();
274 long currentEnd
= currentRange
.getEndTime().toNanos();
275 if (dataInput
== null) {
276 if (!getDisplay().isDisposed()) {
277 Display
.getDefault().syncExec(new Runnable() {
284 fDisplayData
= Collections
.EMPTY_LIST
;
286 Collection
<ISegment
> elements
= (Collection
<ISegment
>) dataInput
.getIntersectingElements(currentStart
, currentEnd
);
287 // getIntersectingElements can return an unsorted iterable, make
288 // sure our collection is sorted
289 ArrayList
<ISegment
> list
= new ArrayList
<>(elements
);
290 Collections
.sort(list
, SegmentComparators
.INTERVAL_START_COMPARATOR
);
293 setWindowRange(currentStart
, currentEnd
);
294 updateRange(currentRange
);
298 protected void initializeDataSource() {
299 ITmfTrace trace
= getTrace();
300 initializeProvider(trace
);
302 setData(getSegmentStoreProvider(trace
));
307 protected void updateData(final long start
, final long end
, int nb
, @Nullable IProgressMonitor monitor
) {
308 // Third parameter is not used by implementation
309 // Determine data that needs to be visible
310 Collection
<ISegment
> data
= fDisplayData
;
312 final int dataSize
= (nb
== 0) ? data
.size() : nb
;
313 if (dataSize
== 0 || end
== start
) {
317 List
<Double
> xSeries
= new ArrayList
<>(dataSize
);
318 List
<Double
> ySeries
= new ArrayList
<>(dataSize
);
319 // For each visible segments, add start time to x value and duration
321 Iterator
<ISegment
> modelIter
= data
.iterator();
322 while (modelIter
.hasNext()) {
323 ISegment segment
= modelIter
.next();
324 xSeries
.add((double) (segment
.getStart() - start
));
325 ySeries
.add((double) segment
.getLength());
327 setXAxis(Doubles
.toArray(xSeries
));
328 setSeries(Messages
.SegmentStoreScatterGraphViewer_legend
, Doubles
.toArray(ySeries
)); // $NON-NLS-1$
333 protected void setWindowRange(final long windowStartTime
, final long windowEndTime
) {
334 super.setWindowRange(windowStartTime
, windowEndTime
);
338 protected ILineSeries
addSeries(@Nullable String seriesName
) {
339 ISeriesSet seriesSet
= getSwtChart().getSeriesSet();
340 ILineSeries series
= (ILineSeries
) seriesSet
.createSeries(SeriesType
.LINE
, seriesName
);
341 series
.setVisible(true);
342 series
.enableArea(false);
343 series
.setLineStyle(LineStyle
.NONE
);
344 series
.setSymbolType(PlotSymbolType
.DIAMOND
);
349 * Set the data into the viewer. If the provider is an analysis, it will
350 * update the model if the analysis is completed or run the analysis if not
354 * Segment store provider
356 public void setData(@Nullable ISegmentStoreProvider provider
) {
357 if (provider
== null) {
361 ISegmentStore
<ISegment
> segStore
= provider
.getSegmentStore();
362 // If results are not null, then segment store is completed and model
364 if (segStore
!= null) {
365 updateModel(segStore
);
366 setSegmentProvider(provider
);
370 provider
.addListener(fListener
);
371 if (provider
instanceof IAnalysisModule
) {
372 ((IAnalysisModule
) provider
).schedule();
374 setSegmentProvider(provider
);
378 * Returns the segment store provider
381 * The trace to consider
382 * @return the segment store provider
384 protected @Nullable abstract ISegmentStoreProvider
getSegmentStoreProvider(ITmfTrace trace
);
386 // ------------------------------------------------------------------------
388 // ------------------------------------------------------------------------
392 * Signal received when a different trace is selected
396 public void traceSelected(@Nullable TmfTraceSelectedSignal signal
) {
397 super.traceSelected(signal
);
398 if (signal
== null) {
401 ITmfTrace trace
= signal
.getTrace();
404 final TmfTimeRange timeRange
= TmfTraceManager
.getInstance().getCurrentTraceContext().getWindowRange();
406 timeRange
.getStartTime().toNanos(),
407 timeRange
.getEndTime().toNanos());
408 setData(getSegmentStoreProvider(trace
));
409 updateRange(timeRange
);
415 * Signal received when trace is opened
419 public void traceOpened(@Nullable TmfTraceOpenedSignal signal
) {
420 super.traceOpened(signal
);
421 if (signal
== null) {
424 ITmfTrace trace
= signal
.getTrace();
428 final ISegmentStoreProvider segmentStoreProvider
= getSegmentStoreProvider(trace
);
429 final TmfTimeRange timeRange
= TmfTraceManager
.getInstance().getCurrentTraceContext().getWindowRange();
431 timeRange
.getStartTime().toNanos(),
432 timeRange
.getEndTime().toNanos());
433 setData(segmentStoreProvider
);
438 private void updateRange(final @Nullable TmfTimeRange timeRange
) {
439 Job compactingJob
= fCompactingJob
;
440 if (compactingJob
!= null && compactingJob
.getState() == Job
.RUNNING
) {
441 compactingJob
.cancel();
443 compactingJob
= new CompactingSegmentStoreQuery(NonNullUtils
.checkNotNull(timeRange
));
444 fCompactingJob
= compactingJob
;
445 compactingJob
.schedule();
450 * Signal received when last opened trace is closed
454 public void traceClosed(@Nullable TmfTraceClosedSignal signal
) {
455 super.traceClosed(signal
);
456 if (signal
!= null) {
457 // Check if there is no more opened trace
458 if (TmfTraceManager
.getInstance().getActiveTrace() == null) {
459 ISegmentStoreProvider provider
= getSegmentProvider();
460 if (provider
!= null) {
461 provider
.removeListener(fListener
);
471 * Signal received when window range is updated
475 public void windowRangeUpdated(@Nullable TmfWindowRangeUpdatedSignal signal
) {
476 super.windowRangeUpdated(signal
);
477 if (signal
== null) {
480 if (getTrace() != null) {
481 final TmfTimeRange currentRange
= signal
.getCurrentRange();
482 updateRange(currentRange
);
484 Activator
.getDefault().logInfo("No Trace to update"); //$NON-NLS-1$
488 private @Nullable ISegmentStoreProvider
getSegmentProvider() {
489 return fSegmentProvider
;
492 private void setSegmentProvider(ISegmentStoreProvider provider
) {
493 fSegmentProvider
= provider
;