1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
|
/*******************************************************************************
* Copyright (c) 2012, 2015 Ericsson
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Mathieu Denis <mathieu.denis@polymtl.ca> - Initial API and implementation
* Alexandre Montplaisir - Port to ITmfStatistics provider
* Patrick Tasse - Support selection range
* Bernd Hufmann - Fix range selection updates
*******************************************************************************/
package org.eclipse.tracecompass.tmf.ui.viewers.statistics;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
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.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Cursor;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
import org.eclipse.tracecompass.tmf.core.component.TmfComponent;
import org.eclipse.tracecompass.tmf.core.request.ITmfEventRequest;
import org.eclipse.tracecompass.tmf.core.signal.TmfSignalHandler;
import org.eclipse.tracecompass.tmf.core.signal.TmfTimeSynchSignal;
import org.eclipse.tracecompass.tmf.core.signal.TmfTraceRangeUpdatedSignal;
import org.eclipse.tracecompass.tmf.core.statistics.ITmfStatistics;
import org.eclipse.tracecompass.tmf.core.statistics.TmfStatisticsEventTypesModule;
import org.eclipse.tracecompass.tmf.core.statistics.TmfStatisticsModule;
import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimeRange;
import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
import org.eclipse.tracecompass.tmf.core.trace.TmfTraceManager;
import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils;
import org.eclipse.tracecompass.tmf.core.trace.experiment.TmfExperiment;
import org.eclipse.tracecompass.tmf.ui.TmfUiRefreshHandler;
import org.eclipse.tracecompass.tmf.ui.viewers.TmfViewer;
import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfBaseColumnData;
import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfBaseColumnDataProvider;
import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfStatisticsFormatter;
import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfStatisticsTree;
import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfStatisticsTreeManager;
import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfStatisticsTreeNode;
import org.eclipse.tracecompass.tmf.ui.viewers.statistics.model.TmfTreeContentProvider;
/**
* A basic viewer to display statistics in the statistics view.
*
* It is linked to a single ITmfTrace until its disposal.
*
* @author Mathieu Denis
* @since 2.0
*/
public class TmfStatisticsViewer extends TmfViewer {
/** Timestamp scale used for all statistics (nanosecond) */
private static final byte TIME_SCALE = ITmfTimestamp.NANOSECOND_SCALE;
/** The delay (in ms) between each update in live-reading mode */
private static final long LIVE_UPDATE_DELAY = 1000;
/** The actual tree viewer to display */
private TreeViewer fTreeViewer;
/** The statistics tree linked to this viewer */
private TmfStatisticsTree fStatisticsData;
/** Update range synchronization object */
private final Object fStatisticsRangeUpdateSyncObj = new Object();
/** The trace that is displayed by this viewer */
private ITmfTrace fTrace;
/** Indicates to process all events */
private boolean fProcessAll;
/** View instance counter (for multiple statistics views) */
private static int fCountInstance = 0;
/** Number of this instance. Used as an instance ID. */
private int fInstanceNb;
/** Object to store the cursor while waiting for the trace to load */
private Cursor fWaitCursor = null;
/**
* Counts the number of times waitCursor() has been called. It avoids
* removing the waiting cursor, since there may be multiple requests running
* at the same time.
*/
private int fWaitCursorCount = 0;
/** 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;
private final Map<ITmfTrace, Job> fUpdateJobsPartial = new HashMap<>();
private final Map<ITmfTrace, Job> fUpdateJobsGlobal = new HashMap<>();
private TmfTimeRange fTimeRange;
private TmfTimeRange fTimeRangePartial;
/**
* Create a basic statistics viewer. To be used in conjunction with
* {@link TmfStatisticsViewer#init(Composite, String, ITmfTrace)}
*
* @param parent
* The parent composite that will hold the viewer
* @param viewerName
* The name that will be assigned to this viewer
* @param trace
* The trace that is displayed by this viewer
* @see TmfComponent
*/
public TmfStatisticsViewer(Composite parent, String viewerName, ITmfTrace trace) {
init(parent, viewerName, trace);
fTraceManager = TmfTraceManager.getInstance();
}
/**
* Initialize the statistics viewer.
*
* @param parent
* The parent component of the viewer.
* @param viewerName
* The name to give to the viewer.
* @param trace
* The trace that will be displayed by the viewer.
*/
public void init(Composite parent, String viewerName, ITmfTrace trace) {
super.init(parent, viewerName);
// Increment a counter to make sure the tree ID is unique.
fCountInstance++;
fInstanceNb = fCountInstance;
fTrace = trace;
// The viewer will process all events if he is assigned to an experiment
fProcessAll = (trace instanceof TmfExperiment);
initContent(parent);
initInput();
}
@Override
public void dispose() {
super.dispose();
if (fWaitCursor != null) {
fWaitCursor.dispose();
}
for (Job j : fUpdateJobsGlobal.values()) {
j.cancel();
}
for (Job j : fUpdateJobsPartial.values()) {
j.cancel();
}
// Clean the model for this viewer
TmfStatisticsTreeManager.removeStatTreeRoot(getTreeID());
}
// ------------------------------------------------------------------------
// Signal handlers
// ------------------------------------------------------------------------
/**
* Handles the signal about new trace range.
*
* @param signal
* The trace range updated signal
*/
@TmfSignalHandler
public void traceRangeUpdated(TmfTraceRangeUpdatedSignal signal) {
ITmfTrace trace = signal.getTrace();
// validate
if (!isListeningTo(trace)) {
return;
}
synchronized (fStatisticsRangeUpdateSyncObj) {
// Sends the time range request only once from this method.
if (fSendRangeRequest) {
fSendRangeRequest = false;
ITmfTimestamp begin = fTraceManager.getSelectionBeginTime();
ITmfTimestamp end = fTraceManager.getSelectionEndTime();
TmfTimeRange timeRange = new TmfTimeRange(begin, end);
requestTimeRangeData(trace, timeRange);
}
}
requestData(trace, signal.getRange());
}
/**
* 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.
*
* @return the SWT control which displays this viewer's content
*/
@Override
public Control getControl() {
return fTreeViewer.getControl();
}
/**
* Get the input of the viewer.
*
* @return an object representing the input of the statistics viewer.
*/
public Object getInput() {
return fTreeViewer.getInput();
}
/**
* This method can be overridden to implement another way of representing
* the statistics data and to retrieve the information for display.
*
* @return a TmfStatisticsData object.
*/
public TmfStatisticsTree getStatisticData() {
if (fStatisticsData == null) {
fStatisticsData = new TmfStatisticsTree();
}
return fStatisticsData;
}
/**
* Returns a unique ID based on name to be associated with the statistics
* tree for this viewer. For a same name, it will always return the same ID.
*
* @return a unique statistics tree ID.
*/
public String getTreeID() {
return getName() + fInstanceNb;
}
@Override
public void refresh() {
final Control viewerControl = getControl();
// Ignore update if disposed
if (viewerControl.isDisposed()) {
return;
}
TmfUiRefreshHandler.getInstance().queueUpdate(this, new Runnable() {
@Override
public void run() {
if (!viewerControl.isDisposed()) {
fTreeViewer.refresh();
}
}
});
}
/**
* Will force a request on the partial event count if one is needed.
*/
public void sendPartialRequestOnNextUpdate() {
synchronized (fStatisticsRangeUpdateSyncObj) {
fSendRangeRequest = true;
}
}
/**
* Focus on the statistics tree of the viewer
*/
public void setFocus() {
fTreeViewer.getTree().setFocus();
}
/**
* Cancels the request if it is not already completed
*
* @param request
* The request to be canceled
* @since 3.0
*/
protected void cancelOngoingRequest(ITmfEventRequest request) {
if (request != null && !request.isCompleted()) {
request.cancel();
}
}
/**
* This method can be overridden to change the representation of the data in
* the columns.
*
* @return An object of type {@link TmfBaseColumnDataProvider}.
* @since 3.0
*/
protected TmfBaseColumnDataProvider getColumnDataProvider() {
return new TmfBaseColumnDataProvider();
}
/**
* Initialize the content that will be drawn in this viewer
*
* @param parent
* The parent of the control to create
*/
protected void initContent(Composite parent) {
final List<TmfBaseColumnData> columnDataList = getColumnDataProvider().getColumnData();
fTreeViewer = new TreeViewer(parent, SWT.BORDER | SWT.H_SCROLL | SWT.V_SCROLL);
fTreeViewer.setContentProvider(new TmfTreeContentProvider());
fTreeViewer.getTree().setHeaderVisible(true);
fTreeViewer.setUseHashlookup(true);
// Creates the columns defined by the column data provider
for (final TmfBaseColumnData columnData : columnDataList) {
final TreeViewerColumn treeColumn = new TreeViewerColumn(fTreeViewer, columnData.getAlignment());
treeColumn.getColumn().setText(columnData.getHeader());
treeColumn.getColumn().setWidth(columnData.getWidth());
treeColumn.getColumn().setToolTipText(columnData.getTooltip());
// If is dummy column
if (columnData == columnDataList.get(TmfBaseColumnDataProvider.StatsColumn.DUMMY.getIndex())) {
treeColumn.getColumn().setResizable(false);
}
// A comparator is defined.
if (columnData.getComparator() != null) {
// Adds a listener on the columns header for sorting purpose.
treeColumn.getColumn().addSelectionListener(new SelectionAdapter() {
private ViewerComparator reverseComparator;
@Override
public void widgetSelected(SelectionEvent e) {
// Initializes the reverse comparator once.
if (reverseComparator == null) {
reverseComparator = new ViewerComparator() {
@Override
public int compare(Viewer viewer, Object e1, Object e2) {
return -1 * columnData.getComparator().compare(viewer, e1, e2);
}
};
}
if (fTreeViewer.getTree().getSortDirection() == SWT.UP
|| fTreeViewer.getTree().getSortColumn() != treeColumn.getColumn()) {
/*
* Puts the descendant order if the old order was up
* or if the selected column has changed.
*/
fTreeViewer.setComparator(columnData.getComparator());
fTreeViewer.getTree().setSortDirection(SWT.DOWN);
} else {
/*
* Puts the ascendant ordering if the selected
* column hasn't changed.
*/
fTreeViewer.setComparator(reverseComparator);
fTreeViewer.getTree().setSortDirection(SWT.UP);
}
fTreeViewer.getTree().setSortColumn(treeColumn.getColumn());
}
});
}
treeColumn.setLabelProvider(columnData.getLabelProvider());
}
// Handler that will draw the percentages and the bar charts.
fTreeViewer.getTree().addListener(SWT.EraseItem, new Listener() {
@Override
public void handleEvent(Event event) {
if (columnDataList.get(event.index).getPercentageProvider() != null) {
TmfStatisticsTreeNode node = (TmfStatisticsTreeNode) event.item.getData();
// If node is hidden, exit immediately.
if (TmfBaseColumnDataProvider.HIDDEN_FOLDER_LEVELS.contains(node.getName())) {
return;
}
// Otherwise, get percentage and draw bar and text if applicable.
double percentage = columnDataList.get(event.index).getPercentageProvider().getPercentage(node);
// The item is selected.
if ((event.detail & SWT.SELECTED) > 0) {
// Draws our own background to avoid overwriting the bar.
event.gc.fillRectangle(event.x, event.y, event.width, event.height);
event.detail &= ~SWT.SELECTED;
}
// Drawing the percentage text
// if events are present in top node
// and the current node is not the top node
// and if is total or partial events column.
// If not, exit the method.
if (!((event.index == TmfBaseColumnDataProvider.StatsColumn.TOTAL.getIndex() || event.index == TmfBaseColumnDataProvider.StatsColumn.PARTIAL.getIndex())
&& node != node.getTop())) {
return;
}
long eventValue = event.index == TmfBaseColumnDataProvider.StatsColumn.TOTAL.getIndex() ?
node.getTop().getValues().getTotal() : node.getTop().getValues().getPartial();
if (eventValue != 0) {
int oldAlpha = event.gc.getAlpha();
Color oldForeground = event.gc.getForeground();
Color oldBackground = event.gc.getBackground();
// Bar to draw
if (percentage != 0) {
/*
* Draws a transparent gradient rectangle from the
* color of foreground and background.
*/
int barWidth = (int) ((fTreeViewer.getTree().getColumn(event.index).getWidth() - 8) * percentage);
event.gc.setAlpha(64);
event.gc.setForeground(event.item.getDisplay().getSystemColor(SWT.COLOR_BLUE));
event.gc.setBackground(event.item.getDisplay().getSystemColor(SWT.COLOR_LIST_BACKGROUND));
event.gc.fillGradientRectangle(event.x, event.y, barWidth, event.height, true);
event.gc.drawRectangle(event.x, event.y, barWidth, event.height);
// Restore old values
event.gc.setBackground(oldBackground);
event.gc.setAlpha(oldAlpha);
event.detail &= ~SWT.BACKGROUND;
}
String percentageText = TmfStatisticsFormatter.toPercentageText(percentage);
String absoluteNumberText = TmfStatisticsFormatter.toColumnData(node, TmfBaseColumnDataProvider.StatsColumn.getColumn(event.index));
if (event.width > event.gc.stringExtent(percentageText).x + event.gc.stringExtent(absoluteNumberText).x) {
int textHeight = event.gc.stringExtent(percentageText).y;
event.gc.setForeground(event.item.getDisplay().getSystemColor(SWT.COLOR_DARK_GRAY));
event.gc.drawText(percentageText, event.x, event.y + (event.height - textHeight) / 2, true);
}
// Restores old values
event.gc.setForeground(oldForeground);
}
}
}
});
// Initializes the comparator parameters
fTreeViewer.setComparator(columnDataList.get(0).getComparator());
fTreeViewer.getTree().setSortColumn(fTreeViewer.getTree().getColumn(0));
fTreeViewer.getTree().setSortDirection(SWT.DOWN);
}
/**
* Initializes the input for the tree viewer.
*/
protected void initInput() {
String treeID = getTreeID();
TmfStatisticsTreeNode statisticsTreeNode;
if (TmfStatisticsTreeManager.containsTreeRoot(treeID)) {
// The statistics root is already present
statisticsTreeNode = TmfStatisticsTreeManager.getStatTreeRoot(treeID);
// Checks if the trace is already in the statistics tree.
int numNodeTraces = statisticsTreeNode.getNbChildren();
Collection<ITmfTrace> traces = TmfTraceManager.getTraceSet(fTrace);
int numTraces = traces.size();
if (numTraces == numNodeTraces) {
boolean same = true;
/*
* Checks if the experiment contains the same traces as when
* previously selected.
*/
for (ITmfTrace trace : traces) {
String traceName = trace.getName();
if (!statisticsTreeNode.containsChild(traceName)) {
same = false;
break;
}
}
if (same) {
// No need to reload data, all traces are already loaded
fTreeViewer.setInput(statisticsTreeNode);
return;
}
// Clears the old content to start over
statisticsTreeNode.reset();
}
} else {
// Creates a new tree
statisticsTreeNode = TmfStatisticsTreeManager.addStatsTreeRoot(treeID, getStatisticData());
}
// Sets the input to a clean data model
fTreeViewer.setInput(statisticsTreeNode);
}
/**
* Tells if the viewer is listening to a trace.
*
* @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(ITmfTrace trace) {
if (fProcessAll || trace == fTrace) {
return true;
}
return false;
}
/**
* Called when an trace request has been completed successfully.
*
* @param global
* Tells if the request is a global or time range (partial)
* request.
*/
protected void modelComplete(boolean global) {
refresh();
waitCursor(false);
}
/**
* Called when an trace request has failed or has been cancelled.
*
* @param isGlobalRequest
* Tells if the request is a global or time range (partial)
* request.
*/
protected void modelIncomplete(boolean isGlobalRequest) {
if (isGlobalRequest) { // Clean the global statistics
/*
* No need to reset the global number of events, since the index of
* the last requested event is known.
*/
} else { // Clean the partial statistics
resetTimeRangeValue();
}
refresh();
waitCursor(false);
}
/**
* Sends the request to the trace for the whole trace
*
* @param trace
* The trace used to send the request
* @param timeRange
* The range to request to the trace
*/
protected void requestData(final ITmfTrace trace, final TmfTimeRange timeRange) {
buildStatisticsTree(trace, timeRange, true);
}
/**
* Sends the time range request from the trace
*
* @param trace
* The trace used to send the request
* @param timeRange
* The range to request to the trace
*/
protected void requestTimeRangeData(final ITmfTrace trace, final TmfTimeRange timeRange) {
buildStatisticsTree(trace, timeRange, false);
}
/**
* 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 may receive an
* experiment rather than a single trace. The filtering is done with the
* method {@link #isListeningTo(String trace)}.
*
* @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 ITmfTrace trace, final TmfTimeRange timeRange, final boolean isGlobal) {
final TmfStatisticsTree statsData = TmfStatisticsTreeManager.getStatTree(getTreeID());
if (statsData == null) {
return;
}
Map<ITmfTrace, Job> updateJobs;
if (isGlobal) {
updateJobs = fUpdateJobsGlobal;
fTimeRange = timeRange;
} else {
updateJobs = fUpdateJobsPartial;
fTimeRangePartial = timeRange;
}
for (final ITmfTrace aTrace : TmfTraceManager.getTraceSet(trace)) {
if (!isListeningTo(aTrace)) {
continue;
}
/* Retrieve the statistics object */
final TmfStatisticsModule statsMod = TmfTraceUtils.getAnalysisModuleOfClass(aTrace, TmfStatisticsModule.class, TmfStatisticsModule.ID);
if (statsMod == null) {
/* No statistics module available for this trace */
continue;
}
Job job = updateJobs.get(aTrace);
if (job == null) {
job = new UpdateJob("Statistics update", aTrace, isGlobal, statsMod); //$NON-NLS-1$
updateJobs.put(aTrace, job);
job.setSystem(true);
job.schedule();
}
}
}
private class UpdateJob extends Job {
private final ITmfTrace fJobTrace;
private final boolean fIsGlobal;
private final TmfStatisticsModule fStatsMod;
private UpdateJob(String name, ITmfTrace trace, boolean isGlobal, TmfStatisticsModule statsMod) {
super(name);
fJobTrace = trace;
fIsGlobal = isGlobal;
fStatsMod = statsMod;
}
@Override
protected IStatus run(IProgressMonitor monitor) {
/* Wait until the analysis is ready to be queried */
fStatsMod.waitForInitialization();
ITmfStatistics stats = fStatsMod.getStatistics();
if (stats == null) {
/* It should have worked, but didn't */
throw new IllegalStateException();
}
/*
* TODO Eventually this could be exposed through the
* TmfStateSystemAnalysisModule directly.
*/
ITmfStateSystem ss = fStatsMod.getStateSystem(TmfStatisticsEventTypesModule.ID);
if (ss == null) {
/* It should be instantiated after the
* statsMod.waitForInitialization() above. */
throw new IllegalStateException();
}
/*
* Periodically update the statistics while they are
* being built (or, if the back-end is already completely
* built, it will skip over the while() immediately.
*/
long start = 0;
long end = 0;
boolean finished = false;
do {
if (monitor.isCanceled()) {
return Status.CANCEL_STATUS;
}
finished = ss.waitUntilBuilt(LIVE_UPDATE_DELAY);
TmfTimeRange localtimeRange = fIsGlobal ? fTimeRange : fTimeRangePartial;
/*
* The generic statistics are stored in nanoseconds, so
* we must make sure the time range is scaled correctly.
*/
start = localtimeRange.getStartTime().normalize(0, TIME_SCALE).getValue();
end = localtimeRange.getEndTime().normalize(0, TIME_SCALE).getValue();
Map<String, Long> map = stats.getEventTypesInRange(start, end);
updateStats(map);
} while (!finished);
/* Query one last time for the final values */
Map<String, Long> map = stats.getEventTypesInRange(start, end);
updateStats(map);
/*
* Remove job from map so that new range selection updates can
* be processed.
*/
Map<ITmfTrace, Job> updateJobs;
if (fIsGlobal) {
updateJobs = fUpdateJobsGlobal;
} else {
updateJobs = fUpdateJobsPartial;
}
updateJobs.remove(fJobTrace);
return Status.OK_STATUS;
}
/*
* Update statistics for a given trace
*/
private void updateStats(Map<String, Long> eventsPerType) {
final TmfStatisticsTree statsData = TmfStatisticsTreeManager.getStatTree(getTreeID());
if (statsData == null) {
/* The stat tree has been disposed, abort mission. */
return;
}
Map<String, Long> map = eventsPerType;
String name = fJobTrace.getName();
/*
* "Global", "partial", "total", etc., it's all very confusing...
*
* The base view shows the total count for the trace and for
* each even types, organized in columns like this:
*
* | Global | Time range |
* trace name | A | B |
* Event Type | | |
* <event 1> | C | D |
* <event 2> | ... | ... |
* ... | | |
*
* Here, we called the cells like this:
* A : GlobalTotal
* B : TimeRangeTotal
* C : GlobalTypeCount(s)
* D : TimeRangeTypeCount(s)
*/
/* Fill in an the event counts (either cells C or D) */
for (Map.Entry<String, Long> entry : map.entrySet()) {
statsData.setTypeCount(name, entry.getKey(), fIsGlobal, entry.getValue());
}
/*
* 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 = 0;
for (long val : map.values()) {
globalTotal += val;
}
statsData.setTotal(name, fIsGlobal, globalTotal);
modelComplete(fIsGlobal);
}
}
/**
* Resets the number of events within the time range
*/
protected void resetTimeRangeValue() {
TmfStatisticsTreeNode treeModelRoot = TmfStatisticsTreeManager.getStatTreeRoot(getTreeID());
if (treeModelRoot != null && treeModelRoot.hasChildren()) {
treeModelRoot.resetTimeRangeValue();
}
}
/**
* 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.
*
* @param waitRequested
* Indicates if we need to show the waiting cursor, or the
* default one.
*/
protected void waitCursor(final boolean waitRequested) {
if ((fTreeViewer == null) || (fTreeViewer.getTree().isDisposed())) {
return;
}
boolean needsUpdate = false;
Display display = fTreeViewer.getControl().getDisplay();
if (waitRequested) {
fWaitCursorCount++;
if (fWaitCursor == null) { // The cursor hasn't been initialized yet
fWaitCursor = new Cursor(display, SWT.CURSOR_WAIT);
}
if (fWaitCursorCount == 1) { // The cursor is not in waiting mode
needsUpdate = true;
}
} else {
if (fWaitCursorCount > 0) { // The cursor is in waiting mode
fWaitCursorCount--;
if (fWaitCursorCount == 0) { // No more reason to wait
// Put back the default cursor
needsUpdate = true;
}
}
}
if (needsUpdate) {
// Performs the updates on the UI thread
display.asyncExec(new Runnable() {
@Override
public void run() {
if ((fTreeViewer != null)
&& (!fTreeViewer.getTree().isDisposed())) {
Cursor cursor = null; // indicates default
if (waitRequested) {
cursor = fWaitCursor;
}
fTreeViewer.getControl().setCursor(cursor);
}
}
});
}
}
}
|