1 /*******************************************************************************
2 * Copyright (c) 2009, 2010, 2011, 2012 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 * William Bourque - Initial API and implementation
11 * Yuriy Vashchuk - GUI reorganisation, simplification and some related code improvements.
12 * Yuriy Vashchuk - Histograms optimisation.
13 * Yuriy Vashchuk - Histogram Canvas Heritage correction
14 * Francois Chouinard - Cleanup and refactoring
15 * Francois Chouinard - Moved from LTTng to TMF
16 *******************************************************************************/
18 package org
.eclipse
.linuxtools
.tmf
.ui
.views
.histogram
;
20 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
21 import org
.eclipse
.linuxtools
.tmf
.core
.request
.ITmfDataRequest
.ExecutionType
;
22 import org
.eclipse
.linuxtools
.tmf
.core
.request
.TmfDataRequest
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfRangeSynchSignal
;
24 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfSignalHandler
;
25 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfSignalManager
;
26 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTimeSynchSignal
;
27 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceClosedSignal
;
28 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
29 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceRangeUpdatedSignal
;
30 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
31 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceUpdatedSignal
;
32 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.ITmfTimestamp
;
33 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.TmfTimeRange
;
34 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.TmfTimestamp
;
35 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfTrace
;
36 import org
.eclipse
.linuxtools
.tmf
.ui
.editors
.ITmfTraceEditor
;
37 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.TmfView
;
38 import org
.eclipse
.swt
.SWT
;
39 import org
.eclipse
.swt
.layout
.GridData
;
40 import org
.eclipse
.swt
.layout
.GridLayout
;
41 import org
.eclipse
.swt
.widgets
.Composite
;
42 import org
.eclipse
.ui
.IEditorPart
;
45 * The purpose of this view is to provide graphical time distribution statistics about the trace events.
47 * The view is composed of two histograms and two controls:
49 * <li>an event distribution histogram for the whole trace;
50 * <li>an event distribution histogram for current time window (window span);
51 * <li>the timestamp of the currently selected event;
52 * <li>the window span (size of the time window of the smaller histogram).
54 * The histograms x-axis show their respective time range.
57 * @author Francois Chouinard
59 public class HistogramView
extends TmfView
{
61 // ------------------------------------------------------------------------
63 // ------------------------------------------------------------------------
66 * The view ID as defined in plugin.xml
68 public static final String ID
= "org.eclipse.linuxtools.tmf.ui.views.histogram"; //$NON-NLS-1$
70 // ------------------------------------------------------------------------
72 // ------------------------------------------------------------------------
75 private Composite fParent
;
78 private ITmfTrace fTrace
;
80 // Current timestamp/time window - everything in the TIME_SCALE
81 private long fTraceStartTime
;
82 private long fTraceEndTime
;
83 private long fWindowStartTime
;
84 private long fWindowEndTime
;
85 private long fWindowSpan
;
86 private long fCurrentTimestamp
;
89 private HistogramTextControl fCurrentEventTimeControl
;
90 private HistogramTextControl fTimeSpanControl
;
92 // Histogram/request for the full trace range
93 private static FullTraceHistogram fFullTraceHistogram
;
94 private HistogramRequest fFullTraceRequest
;
96 // Histogram/request for the selected time range
97 private static TimeRangeHistogram fTimeRangeHistogram
;
98 private HistogramRequest fTimeRangeRequest
;
100 // ------------------------------------------------------------------------
102 // ------------------------------------------------------------------------
105 * Default constructor
107 public HistogramView() {
112 public void dispose() {
113 if ((fTimeRangeRequest
!= null) && !fTimeRangeRequest
.isCompleted()) {
114 fTimeRangeRequest
.cancel();
116 if ((fFullTraceRequest
!= null) && !fFullTraceRequest
.isCompleted()) {
117 fFullTraceRequest
.cancel();
119 fFullTraceHistogram
.dispose();
120 fTimeRangeHistogram
.dispose();
121 fCurrentEventTimeControl
.dispose();
122 fTimeSpanControl
.dispose();
126 // ------------------------------------------------------------------------
128 // ------------------------------------------------------------------------
131 public void createPartControl(Composite parent
) {
136 final String currentEventLabel
= Messages
.HistogramView_currentEventLabel
;
137 final String windowSpanLabel
= Messages
.HistogramView_windowSpanLabel
;
139 // --------------------------------------------------------------------
140 // Set the HistogramView layout
141 // --------------------------------------------------------------------
143 Composite viewComposite
= new Composite(fParent
, SWT
.FILL
);
144 GridLayout gridLayout
= new GridLayout();
145 gridLayout
.numColumns
= 2;
146 gridLayout
.horizontalSpacing
= 5;
147 gridLayout
.verticalSpacing
= 0;
148 gridLayout
.marginHeight
= 0;
149 gridLayout
.marginWidth
= 0;
150 viewComposite
.setLayout(gridLayout
);
152 // Use all available space
153 GridData gridData
= new GridData();
154 gridData
.horizontalAlignment
= SWT
.FILL
;
155 gridData
.verticalAlignment
= SWT
.FILL
;
156 gridData
.grabExcessHorizontalSpace
= true;
157 viewComposite
.setLayoutData(gridData
);
159 // --------------------------------------------------------------------
161 // --------------------------------------------------------------------
163 Composite controlsComposite
= new Composite(viewComposite
, SWT
.FILL
);
164 gridLayout
= new GridLayout();
165 gridLayout
.numColumns
= 2;
166 gridLayout
.marginHeight
= 0;
167 gridLayout
.marginWidth
= 0;
168 gridLayout
.horizontalSpacing
= 5;
169 gridLayout
.verticalSpacing
= 0;
170 gridLayout
.makeColumnsEqualWidth
= false;
171 gridLayout
.marginLeft
= 5;
172 gridLayout
.marginRight
= 5;
173 controlsComposite
.setLayout(gridLayout
);
175 // Current event time control
176 gridData
= new GridData();
177 gridData
.horizontalAlignment
= SWT
.CENTER
;
178 gridData
.verticalAlignment
= SWT
.CENTER
;
179 fCurrentEventTimeControl
= new HistogramCurrentTimeControl(this, controlsComposite
, currentEventLabel
, 0L);
180 fCurrentEventTimeControl
.setLayoutData(gridData
);
181 fCurrentEventTimeControl
.setValue(Long
.MIN_VALUE
);
183 // Window span time control
184 gridData
= new GridData();
185 gridData
.horizontalAlignment
= SWT
.CENTER
;
186 gridData
.verticalAlignment
= SWT
.CENTER
;
187 fTimeSpanControl
= new HistogramTimeRangeControl(this, controlsComposite
, windowSpanLabel
, 0L);
188 fTimeSpanControl
.setLayoutData(gridData
);
189 fTimeSpanControl
.setValue(Long
.MIN_VALUE
);
191 // --------------------------------------------------------------------
192 // Time range histogram
193 // --------------------------------------------------------------------
195 Composite timeRangeComposite
= new Composite(viewComposite
, SWT
.FILL
);
196 gridLayout
= new GridLayout();
197 gridLayout
.numColumns
= 1;
198 gridLayout
.marginHeight
= 0;
199 gridLayout
.marginWidth
= 0;
200 gridLayout
.marginTop
= 5;
201 gridLayout
.horizontalSpacing
= 0;
202 gridLayout
.verticalSpacing
= 0;
203 gridLayout
.marginLeft
= 5;
204 gridLayout
.marginRight
= 5;
205 timeRangeComposite
.setLayout(gridLayout
);
207 // Use remaining horizontal space
208 gridData
= new GridData();
209 gridData
.horizontalAlignment
= SWT
.FILL
;
210 gridData
.verticalAlignment
= SWT
.FILL
;
211 gridData
.grabExcessHorizontalSpace
= true;
212 timeRangeComposite
.setLayoutData(gridData
);
215 fTimeRangeHistogram
= new TimeRangeHistogram(this, timeRangeComposite
);
217 // --------------------------------------------------------------------
218 // Full range histogram
219 // --------------------------------------------------------------------
221 Composite fullRangeComposite
= new Composite(viewComposite
, SWT
.FILL
);
222 gridLayout
= new GridLayout();
223 gridLayout
.numColumns
= 1;
224 gridLayout
.marginHeight
= 0;
225 gridLayout
.marginWidth
= 0;
226 gridLayout
.marginTop
= 5;
227 gridLayout
.horizontalSpacing
= 0;
228 gridLayout
.verticalSpacing
= 0;
229 gridLayout
.marginLeft
= 5;
230 gridLayout
.marginRight
= 5;
231 fullRangeComposite
.setLayout(gridLayout
);
233 // Use remaining horizontal space
234 gridData
= new GridData();
235 gridData
.horizontalAlignment
= SWT
.FILL
;
236 gridData
.verticalAlignment
= SWT
.FILL
;
237 gridData
.horizontalSpan
= 2;
238 gridData
.grabExcessHorizontalSpace
= true;
239 fullRangeComposite
.setLayoutData(gridData
);
242 fFullTraceHistogram
= new FullTraceHistogram(this, fullRangeComposite
);
244 IEditorPart editor
= getSite().getPage().getActiveEditor();
245 if (editor
instanceof ITmfTraceEditor
) {
246 ITmfTrace trace
= ((ITmfTraceEditor
) editor
).getTrace();
248 traceSelected(new TmfTraceSelectedSignal(this, trace
));
254 public void setFocus() {
255 fFullTraceHistogram
.fCanvas
.setFocus();
259 fParent
.layout(true);
262 // ------------------------------------------------------------------------
264 // ------------------------------------------------------------------------
267 * Returns the current trace handled by the view
269 * @return the current trace
272 public ITmfTrace
getTrace() {
277 * Returns the time range of the current selected window (base on default time scale).
279 * @return the time range of current selected window.
282 public TmfTimeRange
getTimeRange() {
283 return new TmfTimeRange(
284 new TmfTimestamp(fWindowStartTime
, ITmfTimestamp
.NANOSECOND_SCALE
),
285 new TmfTimestamp(fWindowEndTime
, ITmfTimestamp
.NANOSECOND_SCALE
));
288 // ------------------------------------------------------------------------
290 // ------------------------------------------------------------------------
293 * Broadcast TmfSignal about new current time value.
294 * @param newTime the new current time.
296 void updateCurrentEventTime(long newTime
) {
297 if (fTrace
!= null) {
298 TmfTimeRange timeRange
= new TmfTimeRange(new TmfTimestamp(newTime
, ITmfTimestamp
.NANOSECOND_SCALE
), TmfTimestamp
.BIG_CRUNCH
);
299 HistogramRequest request
= new HistogramRequest(fTimeRangeHistogram
.getDataModel(), timeRange
, 0, 1, 0, ExecutionType
.FOREGROUND
) {
301 public void handleData(ITmfEvent event
) {
303 TmfTimeSynchSignal signal
= new TmfTimeSynchSignal(this, event
.getTimestamp());
304 TmfSignalManager
.dispatchSignal(signal
);
308 fTrace
.sendRequest(request
);
313 * Broadcast TmfSignal about new selected time range.
314 * @param startTime the new start time
315 * @param endTime the new end time
317 void updateTimeRange(long startTime
, long endTime
) {
318 if (fTrace
!= null) {
319 // Build the new time range; keep the current time
320 TmfTimeRange timeRange
= new TmfTimeRange(
321 new TmfTimestamp(startTime
, ITmfTimestamp
.NANOSECOND_SCALE
),
322 new TmfTimestamp(endTime
, ITmfTimestamp
.NANOSECOND_SCALE
));
323 ITmfTimestamp currentTime
= new TmfTimestamp(fCurrentTimestamp
, ITmfTimestamp
.NANOSECOND_SCALE
);
324 fTimeSpanControl
.setValue(endTime
- startTime
);
326 // Send the FW signal
327 TmfRangeSynchSignal signal
= new TmfRangeSynchSignal(this, timeRange
, currentTime
);
328 TmfSignalManager
.dispatchSignal(signal
);
333 * Broadcast TmfSignal about new selected time range.
334 * @param newDuration new duration (relative to current start time)
336 public synchronized void updateTimeRange(long newDuration
) {
337 if (fTrace
!= null) {
338 long delta
= newDuration
- fWindowSpan
;
339 long newStartTime
= fWindowStartTime
- (delta
/ 2);
340 setNewRange(newStartTime
, newDuration
);
344 private void setNewRange(long startTime
, long duration
) {
345 long realStart
= startTime
;
347 if (realStart
< fTraceStartTime
) {
348 realStart
= fTraceStartTime
;
351 long endTime
= realStart
+ duration
;
352 if (endTime
> fTraceEndTime
) {
353 endTime
= fTraceEndTime
;
354 if ((endTime
- duration
) > fTraceStartTime
) {
355 realStart
= endTime
- duration
;
357 realStart
= fTraceStartTime
;
360 updateTimeRange(realStart
, endTime
);
363 // ------------------------------------------------------------------------
365 // ------------------------------------------------------------------------
368 * Handles trace opened signal. Loads histogram if new trace time range is not
369 * equal <code>TmfTimeRange.NULL_RANGE</code>
370 * @param signal the trace selected signal
374 public void traceOpened(TmfTraceOpenedSignal signal
) {
375 assert (signal
!= null);
376 fTrace
= signal
.getTrace();
381 * Handles trace selected signal. Loads histogram if new trace time range is not
382 * equal <code>TmfTimeRange.NULL_RANGE</code>
383 * @param signal the trace selected signal
387 public void traceSelected(TmfTraceSelectedSignal signal
) {
388 assert (signal
!= null);
389 if (fTrace
!= signal
.getTrace()) {
390 fTrace
= signal
.getTrace();
395 private void loadTrace() {
396 initializeHistograms();
401 * Handles trace closed signal. Clears the view and data model and cancels requests.
402 * @param signal the trace closed signal
406 public void traceClosed(TmfTraceClosedSignal signal
) {
408 if (signal
.getTrace() != fTrace
) {
412 // Kill any running request
413 if ((fTimeRangeRequest
!= null) && !fTimeRangeRequest
.isCompleted()) {
414 fTimeRangeRequest
.cancel();
416 if ((fFullTraceRequest
!= null) && !fFullTraceRequest
.isCompleted()) {
417 fFullTraceRequest
.cancel();
420 // Initialize the internal data
422 fTraceStartTime
= 0L;
424 fWindowStartTime
= 0L;
427 fCurrentTimestamp
= 0L;
429 // Clear the UI widgets
430 fFullTraceHistogram
.clear();
431 fTimeRangeHistogram
.clear();
432 fCurrentEventTimeControl
.setValue(Long
.MIN_VALUE
);
434 fTimeSpanControl
.setValue(Long
.MIN_VALUE
);
438 * Handles trace range updated signal. Extends histogram according to the new time range. If a
439 * HistogramRequest is already ongoing, it will be cancelled and a new request with the new range
442 * @param signal the trace range updated signal
446 public void traceRangeUpdated(TmfTraceRangeUpdatedSignal signal
) {
448 if (signal
.getTrace() != fTrace
) {
452 TmfTimeRange fullRange
= signal
.getRange();
454 fTraceStartTime
= fullRange
.getStartTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
455 fTraceEndTime
= fullRange
.getEndTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
457 fFullTraceHistogram
.setFullRange(fTraceStartTime
, fTraceEndTime
);
458 fTimeRangeHistogram
.setFullRange(fTraceStartTime
, fTraceEndTime
);
460 sendFullRangeRequest(fullRange
);
464 * Handles the trace updated signal. Used to update time limits (start and end time)
465 * @param signal the trace updated signal
469 public void traceUpdated(TmfTraceUpdatedSignal signal
) {
470 if (signal
.getTrace() != fTrace
) {
473 TmfTimeRange fullRange
= signal
.getTrace().getTimeRange();
474 fTraceStartTime
= fullRange
.getStartTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
475 fTraceEndTime
= fullRange
.getEndTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
477 fFullTraceHistogram
.setFullRange(fTraceStartTime
, fTraceEndTime
);
478 fTimeRangeHistogram
.setFullRange(fTraceStartTime
, fTraceEndTime
);
480 fFullTraceHistogram
.setTimeRange(fTimeRangeHistogram
.getStartTime(), fWindowSpan
);
481 fTimeRangeHistogram
.setTimeRange(fTimeRangeHistogram
.getStartTime(), fWindowSpan
);
483 if ((fFullTraceRequest
!= null) && fFullTraceRequest
.getRange().getEndTime().compareTo(signal
.getRange().getEndTime()) < 0) {
484 sendFullRangeRequest(fullRange
);
489 * Handles the current time updated signal. Sets the current time in the time range
490 * histogram as well as the full histogram.
492 * @param signal the signal to process
495 public void currentTimeUpdated(TmfTimeSynchSignal signal
) {
496 // Because this can't happen :-)
497 assert (signal
!= null);
499 // Update the selected event time
500 ITmfTimestamp currentTime
= signal
.getCurrentTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
);
501 fCurrentTimestamp
= currentTime
.getValue();
503 // Notify the relevant widgets
504 fFullTraceHistogram
.setCurrentEvent(fCurrentTimestamp
);
505 fTimeRangeHistogram
.setCurrentEvent(fCurrentTimestamp
);
506 fCurrentEventTimeControl
.setValue(fCurrentTimestamp
);
510 * Updates the current time range in the time range histogram and full range histogram.
511 * @param signal the signal to process
514 public void timeRangeUpdated(TmfRangeSynchSignal signal
) {
515 // Because this can't happen :-)
516 assert (signal
!= null);
518 if (fTrace
!= null) {
519 // Validate the time range
520 TmfTimeRange range
= signal
.getCurrentRange().getIntersection(fTrace
.getTimeRange());
525 // Update the time range
526 fWindowStartTime
= range
.getStartTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
527 fWindowEndTime
= range
.getEndTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
528 fWindowSpan
= fWindowEndTime
- fWindowStartTime
;
530 // Notify the relevant widgets
531 sendTimeRangeRequest(fWindowStartTime
, fWindowEndTime
);
532 fFullTraceHistogram
.setTimeRange(fWindowStartTime
, fWindowSpan
);
534 fTimeSpanControl
.setValue(fWindowSpan
);
538 // ------------------------------------------------------------------------
540 // ------------------------------------------------------------------------
542 private void initializeHistograms() {
543 TmfTimeRange fullRange
= updateTraceTimeRange();
544 long timestamp
= fTrace
.getCurrentTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
545 long startTime
= fTrace
.getCurrentRange().getStartTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
546 long duration
= fTrace
.getCurrentRange().getEndTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue() - startTime
;
548 if ((fTimeRangeRequest
!= null) && !fTimeRangeRequest
.isCompleted()) {
549 fTimeRangeRequest
.cancel();
551 fTimeRangeHistogram
.clear();
552 fTimeRangeHistogram
.setFullRange(fTraceStartTime
, fTraceEndTime
);
553 fTimeRangeHistogram
.setTimeRange(startTime
, duration
);
554 fTimeRangeHistogram
.setCurrentEvent(timestamp
);
556 if ((fFullTraceRequest
!= null) && !fFullTraceRequest
.isCompleted()) {
557 fFullTraceRequest
.cancel();
559 fFullTraceHistogram
.clear();
560 fFullTraceHistogram
.setFullRange(fTraceStartTime
, fTraceEndTime
);
561 fFullTraceHistogram
.setTimeRange(startTime
, duration
);
562 fFullTraceHistogram
.setCurrentEvent(timestamp
);
564 fWindowStartTime
= startTime
;
565 fWindowSpan
= duration
;
566 fWindowEndTime
= startTime
+ duration
;
568 fCurrentTimestamp
= timestamp
;
569 fCurrentEventTimeControl
.setValue(fCurrentTimestamp
);
571 fTimeSpanControl
.setValue(duration
);
573 if (!fullRange
.equals(TmfTimeRange
.NULL_RANGE
)) {
574 sendTimeRangeRequest(startTime
, startTime
+ duration
);
575 sendFullRangeRequest(fullRange
);
579 private TmfTimeRange
updateTraceTimeRange() {
580 fTraceStartTime
= 0L;
583 TmfTimeRange timeRange
= fTrace
.getTimeRange();
584 if (!timeRange
.equals(TmfTimeRange
.NULL_RANGE
)) {
585 fTraceStartTime
= timeRange
.getStartTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
586 fTraceEndTime
= timeRange
.getEndTime().normalize(0, ITmfTimestamp
.NANOSECOND_SCALE
).getValue();
591 private void sendTimeRangeRequest(long startTime
, long endTime
) {
592 if ((fTimeRangeRequest
!= null) && !fTimeRangeRequest
.isCompleted()) {
593 fTimeRangeRequest
.cancel();
595 TmfTimestamp startTS
= new TmfTimestamp(startTime
, ITmfTimestamp
.NANOSECOND_SCALE
);
596 TmfTimestamp endTS
= new TmfTimestamp(endTime
, ITmfTimestamp
.NANOSECOND_SCALE
);
597 TmfTimeRange timeRange
= new TmfTimeRange(startTS
, endTS
);
599 fTimeRangeHistogram
.clear();
600 fTimeRangeHistogram
.setFullRange(fTraceStartTime
, fTraceEndTime
);
601 fTimeRangeHistogram
.setTimeRange(startTime
, endTime
- startTime
);
603 int cacheSize
= fTrace
.getCacheSize();
604 fTimeRangeRequest
= new HistogramRequest(fTimeRangeHistogram
.getDataModel(), timeRange
, 0, TmfDataRequest
.ALL_DATA
, cacheSize
, ExecutionType
.FOREGROUND
);
605 fTrace
.sendRequest(fTimeRangeRequest
);
608 private void sendFullRangeRequest(TmfTimeRange fullRange
) {
609 if ((fFullTraceRequest
!= null) && !fFullTraceRequest
.isCompleted()) {
610 fFullTraceRequest
.cancel();
612 int cacheSize
= fTrace
.getCacheSize();
613 fFullTraceRequest
= new HistogramRequest(fFullTraceHistogram
.getDataModel(), fullRange
, (int) fFullTraceHistogram
.fDataModel
.getNbEvents(),
614 TmfDataRequest
.ALL_DATA
, cacheSize
, ExecutionType
.BACKGROUND
);
615 fTrace
.sendRequest(fFullTraceRequest
);