1 /*******************************************************************************
2 * Copyright (c) 2009 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 * Yann N. Dauphin (dhaemon@gmail.com) - Implementation
11 * Francois Chouinard (fchouinard@gmail.com) - Initial API
12 *******************************************************************************/
14 package org
.eclipse
.linuxtools
.lttng
.ui
.views
.statistics
;
16 import java
.text
.DecimalFormat
;
17 import java
.util
.Arrays
;
18 import java
.util
.HashSet
;
21 import org
.eclipse
.jface
.viewers
.ColumnLabelProvider
;
22 import org
.eclipse
.jface
.viewers
.ITreeContentProvider
;
23 import org
.eclipse
.jface
.viewers
.TreeViewer
;
24 import org
.eclipse
.jface
.viewers
.TreeViewerColumn
;
25 import org
.eclipse
.jface
.viewers
.Viewer
;
26 import org
.eclipse
.jface
.viewers
.ViewerComparator
;
27 import org
.eclipse
.linuxtools
.lttng
.state
.IStateDataRequestListener
;
28 import org
.eclipse
.linuxtools
.lttng
.state
.RequestCompletedSignal
;
29 import org
.eclipse
.linuxtools
.lttng
.state
.RequestStartedSignal
;
30 import org
.eclipse
.linuxtools
.lttng
.state
.evProcessor
.EventProcessorProxy
;
31 import org
.eclipse
.linuxtools
.lttng
.state
.experiment
.StateExperimentManager
;
32 import org
.eclipse
.linuxtools
.lttng
.state
.experiment
.StateManagerFactory
;
33 import org
.eclipse
.linuxtools
.lttng
.ui
.views
.statistics
.evProcessor
.StatsEventCountHandlerFactory
;
34 import org
.eclipse
.linuxtools
.lttng
.ui
.views
.statistics
.evProcessor
.StatsTimeCountHandlerFactory
;
35 import org
.eclipse
.linuxtools
.lttng
.ui
.views
.statistics
.model
.StatisticsTreeFactory
;
36 import org
.eclipse
.linuxtools
.lttng
.ui
.views
.statistics
.model
.StatisticsTreeNode
;
37 import org
.eclipse
.linuxtools
.tmf
.signal
.TmfSignalHandler
;
38 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.TmfView
;
39 import org
.eclipse
.swt
.SWT
;
40 import org
.eclipse
.swt
.events
.SelectionAdapter
;
41 import org
.eclipse
.swt
.events
.SelectionEvent
;
42 import org
.eclipse
.swt
.graphics
.Color
;
43 import org
.eclipse
.swt
.graphics
.Image
;
44 import org
.eclipse
.swt
.layout
.FillLayout
;
45 import org
.eclipse
.swt
.widgets
.Composite
;
46 import org
.eclipse
.swt
.widgets
.Event
;
47 import org
.eclipse
.swt
.widgets
.Listener
;
48 import org
.eclipse
.ui
.ISharedImages
;
49 import org
.eclipse
.ui
.PlatformUI
;
52 * <b><u>StatisticsView</u></b>
54 * The Statistics View displays statistics for traces.
56 * It is implemented according to the MVC pattern. - The model is a
57 * StatisticsTreeNode built by the State Manager. - The view is built with a
58 * TreeViewer. - The controller that keeps model and view synchronised is an
59 * observer of the model.
61 public class StatisticsView
extends TmfView
implements IStateDataRequestListener
{
63 public static final String ID
= "org.eclipse.linuxtools.lttng.ui.views.statistics";
65 private TreeViewer treeViewer
;
68 private final String LEVEL_COLUMN
= "Level";
69 private final String EVENTS_COUNT_COLUMN
= "Number of Events";
70 private final String CPU_TIME_COLUMN
= "CPU Time";
71 private final String CUMULATIVE_CPU_TIME_COLUMN
= "Cumulative CPU Time";
72 private final String ELAPSED_TIME_COLUMN
= "Elapsed Time";
74 // Table column tooltips
75 private final String LEVEL_COLUMN_TIP
= "Level at which statistics apply.";
76 private final String EVENTS_COUNT_COLUMN_TIP
= "Total amount of events that are tied to given resource.";
77 private final String CPU_TIME_COLUMN_TIP
= "Total amount of time the CPU was used excluding wait times(I/O, etc.) at that level.";
78 private final String CUMULATIVE_CPU_TIME_COLUMN_TIP
= "Total amount of time between the first and last event excluding wait times in a level.";
79 private final String ELAPSED_TIME_COLUMN_TIP
= "Total amount of time the CPU was used including wait times(I/O, etc.) at that level.";
81 // Level for which statistics should not be displayed.
82 private Set
<String
> folderLevels
= new HashSet
<String
>(Arrays
83 .asList(new String
[] { "Event Types", "Modes", "Submodes", "CPUs",
84 "Processes", "Functions" }));
86 // Levels for which sub-levels should not contain time-related statistics.
87 private Set
<String
> levelsWithEmptyTime
= new HashSet
<String
>(Arrays
88 .asList(new String
[] { "Event Types" }));
90 private DecimalFormat decimalFormat
= new DecimalFormat("0.#########");
92 // Used to draw bar charts in columns.
93 private interface ColumnPercentageProvider
{
94 public double getPercentage(StatisticsTreeNode node
);
98 * Contains all the information necessary to build a column of the table.
100 private class ColumnData
{
101 // Name of the column.
102 public final String header
;
103 // Width of the column.
104 public final int width
;
105 // Alignment of the column.
106 public final int alignment
;
107 // Tooltip of the column.
108 public final String tooltip
;
109 // Adapts a StatisticsTreeNode into the content of it's corresponding
110 // cell for that column.
111 public final ColumnLabelProvider labelProvider
;
112 // Used to sort elements of this column. Can be null.
113 public final ViewerComparator comparator
;
114 // Used to draw bar charts in this column. Can be null.
115 public final ColumnPercentageProvider percentageProvider
;
117 public ColumnData(String h
, int w
, int a
, String t
,
118 ColumnLabelProvider l
, ViewerComparator c
,
119 ColumnPercentageProvider p
) {
126 percentageProvider
= p
;
130 // List that will be used to create the table.
131 private ColumnData
[] columnDataList
= new ColumnData
[] {
132 new ColumnData(LEVEL_COLUMN
, 200, SWT
.LEFT
, LEVEL_COLUMN_TIP
,
133 new ColumnLabelProvider() {
135 public String
getText(Object element
) {
136 return ((StatisticsTreeNode
) element
).getKey();
140 public Image
getImage(Object element
) {
141 StatisticsTreeNode node
= (StatisticsTreeNode
) element
;
142 if (folderLevels
.contains(node
.getKey())) {
143 return PlatformUI
.getWorkbench()
144 .getSharedImages().getImage(
145 ISharedImages
.IMG_OBJ_FOLDER
);
147 return PlatformUI
.getWorkbench()
148 .getSharedImages().getImage(
149 ISharedImages
.IMG_OBJ_ELEMENT
);
152 }, new ViewerComparator() {
154 public int compare(Viewer viewer
, Object e1
, Object e2
) {
155 StatisticsTreeNode n1
= (StatisticsTreeNode
) e1
;
156 StatisticsTreeNode n2
= (StatisticsTreeNode
) e2
;
158 return n1
.getKey().compareTo(n2
.getKey());
161 new ColumnData(EVENTS_COUNT_COLUMN
, 125, SWT
.LEFT
,
162 EVENTS_COUNT_COLUMN_TIP
, new ColumnLabelProvider() {
164 public String
getText(Object element
) {
165 StatisticsTreeNode node
= (StatisticsTreeNode
) element
;
166 if (!folderLevels
.contains(node
.getKey())) {
167 return Long
.toString(node
.getValue().nbEvents
);
172 }, new ViewerComparator() {
174 public int compare(Viewer viewer
, Object e1
, Object e2
) {
175 StatisticsTreeNode n1
= (StatisticsTreeNode
) e1
;
176 StatisticsTreeNode n2
= (StatisticsTreeNode
) e2
;
178 return (int) (n1
.getValue().nbEvents
- n2
179 .getValue().nbEvents
);
181 }, new ColumnPercentageProvider() {
182 public double getPercentage(StatisticsTreeNode node
) {
183 StatisticsTreeNode parent
= node
;
185 parent
= parent
.getParent();
186 } while (parent
!= null
187 && parent
.getValue().nbEvents
== 0);
189 if (parent
== null) {
192 return (double) node
.getValue().nbEvents
193 / parent
.getValue().nbEvents
;
197 new ColumnData(CPU_TIME_COLUMN
, 125, SWT
.LEFT
, CPU_TIME_COLUMN_TIP
,
198 new ColumnLabelProvider() {
200 public String
getText(Object element
) {
201 StatisticsTreeNode node
= (StatisticsTreeNode
) element
;
203 if (folderLevels
.contains(node
.getKey())) {
205 } else if (node
.getParent() != null
206 && levelsWithEmptyTime
.contains(node
207 .getParent().getKey())) {
211 .format(node
.getValue().cpuTime
216 new ColumnData(CUMULATIVE_CPU_TIME_COLUMN
, 155, SWT
.LEFT
,
217 CUMULATIVE_CPU_TIME_COLUMN_TIP
, new ColumnLabelProvider() {
219 public String
getText(Object element
) {
220 StatisticsTreeNode node
= (StatisticsTreeNode
) element
;
221 if (folderLevels
.contains(node
.getKey())) {
223 } else if (node
.getParent() != null
224 && levelsWithEmptyTime
.contains(node
225 .getParent().getKey())) {
229 .format(node
.getValue().cumulativeCpuTime
234 new ColumnData(ELAPSED_TIME_COLUMN
, 100, SWT
.LEFT
,
235 ELAPSED_TIME_COLUMN_TIP
, new ColumnLabelProvider() {
237 public String
getText(Object element
) {
238 StatisticsTreeNode node
= (StatisticsTreeNode
) element
;
239 if (folderLevels
.contains(node
.getKey())) {
241 } else if (node
.getParent() != null
242 && levelsWithEmptyTime
.contains(node
243 .getParent().getKey())) {
247 .format(node
.getValue().elapsedTime
254 * Adapter TreeViewers can use to interact with StatisticsTreeNode objects.
256 * @see org.eclipse.jface.viewers.ITreeContentProvider
258 class TreeContentProvider
implements ITreeContentProvider
{
263 * org.eclipse.jface.viewers.ITreeContentProvider#getChildren(java.lang
266 public Object
[] getChildren(Object parentElement
) {
267 return ((StatisticsTreeNode
) parentElement
).getChildren().toArray();
274 * org.eclipse.jface.viewers.ITreeContentProvider#getParent(java.lang
277 public Object
getParent(Object element
) {
278 return ((StatisticsTreeNode
) element
).getParent();
285 * org.eclipse.jface.viewers.ITreeContentProvider#hasChildren(java.lang
288 public boolean hasChildren(Object element
) {
289 return ((StatisticsTreeNode
) element
).hasChildren();
296 * org.eclipse.jface.viewers.IStructuredContentProvider#getElements(
299 public Object
[] getElements(Object inputElement
) {
300 return getChildren(inputElement
);
306 * @see org.eclipse.jface.viewers.IContentProvider#dispose()
308 public void dispose() {
315 * org.eclipse.jface.viewers.IContentProvider#inputChanged(org.eclipse
316 * .jface.viewers.Viewer, java.lang.Object, java.lang.Object)
319 public void inputChanged(Viewer viewer
, Object oldInput
, Object newInput
) {
323 public StatisticsView(String viewName
) {
327 public StatisticsView() {
328 this("StatisticsView");
335 * org.eclipse.ui.part.WorkbenchPart#createPartControl(org.eclipse.swt.widgets
339 public void createPartControl(Composite parent
) {
340 EventProcessorProxy
.getInstance().addEventProcessorFactory(
341 StatsTimeCountHandlerFactory
.getInstance());
342 EventProcessorProxy
.getInstance().addEventProcessorFactory(
343 StatsEventCountHandlerFactory
.getInstance());
345 parent
.setLayout(new FillLayout());
347 treeViewer
= new TreeViewer(parent
, SWT
.BORDER
| SWT
.H_SCROLL
349 treeViewer
.setContentProvider(new TreeContentProvider());
350 treeViewer
.getTree().setHeaderVisible(true);
351 treeViewer
.setUseHashlookup(true);
353 for (final ColumnData columnData
: columnDataList
) {
354 final TreeViewerColumn treeColumn
= new TreeViewerColumn(
355 treeViewer
, columnData
.alignment
);
356 treeColumn
.getColumn().setText(columnData
.header
);
357 treeColumn
.getColumn().setWidth(columnData
.width
);
358 treeColumn
.getColumn().setToolTipText(columnData
.tooltip
);
359 if (columnData
.comparator
!= null) {
360 treeColumn
.getColumn().addSelectionListener(
361 new SelectionAdapter() {
363 public void widgetSelected(SelectionEvent e
) {
364 if (treeViewer
.getTree().getSortDirection() == SWT
.UP
365 || treeViewer
.getTree().getSortColumn() != treeColumn
368 .setComparator(columnData
.comparator
);
369 treeViewer
.getTree().setSortDirection(
373 .setComparator(new ViewerComparator() {
377 Object e1
, Object e2
) {
379 * columnData
.comparator
386 treeViewer
.getTree().setSortDirection(
389 treeViewer
.getTree().setSortColumn(
390 treeColumn
.getColumn());
394 treeColumn
.setLabelProvider(columnData
.labelProvider
);
397 // Handler that will draw the bar charts.
398 treeViewer
.getTree().addListener(SWT
.EraseItem
, new Listener() {
400 public void handleEvent(Event event
) {
401 if (columnDataList
[event
.index
].percentageProvider
!= null) {
402 StatisticsTreeNode node
= (StatisticsTreeNode
) event
.item
405 double percentage
= columnDataList
[event
.index
].percentageProvider
406 .getPercentage(node
);
407 if (percentage
== 0) {
411 if ((event
.detail
& SWT
.SELECTED
) > 0) {
412 Color oldForeground
= event
.gc
.getForeground();
413 event
.gc
.setForeground(event
.item
.getDisplay()
414 .getSystemColor(SWT
.COLOR_LIST_SELECTION
));
415 event
.gc
.fillRectangle(event
.x
, event
.y
, event
.width
,
417 event
.gc
.setForeground(oldForeground
);
418 event
.detail
&= ~SWT
.SELECTED
;
421 int barWidth
= (int) ((treeViewer
.getTree().getColumn(1)
422 .getWidth() - 8) * percentage
);
423 int oldAlpha
= event
.gc
.getAlpha();
424 Color oldForeground
= event
.gc
.getForeground();
425 Color oldBackground
= event
.gc
.getBackground();
426 event
.gc
.setAlpha(64);
427 event
.gc
.setForeground(event
.item
.getDisplay()
428 .getSystemColor(SWT
.COLOR_BLUE
));
429 event
.gc
.setBackground(event
.item
.getDisplay()
430 .getSystemColor(SWT
.COLOR_LIST_BACKGROUND
));
431 event
.gc
.fillGradientRectangle(event
.x
, event
.y
, barWidth
,
433 event
.gc
.drawRectangle(event
.x
, event
.y
, barWidth
,
435 event
.gc
.setForeground(oldForeground
);
436 event
.gc
.setBackground(oldBackground
);
437 event
.gc
.setAlpha(oldAlpha
);
438 event
.detail
&= ~SWT
.BACKGROUND
;
443 treeViewer
.setComparator(columnDataList
[0].comparator
);
444 treeViewer
.getTree().setSortColumn(treeViewer
.getTree().getColumn(0));
445 treeViewer
.getTree().setSortDirection(SWT
.DOWN
);
447 treeViewer
.setInput(StatisticsTreeFactory
448 .getStatisticsTree("Experiment"));
450 // Read current data if any available
451 StateExperimentManager experimentManger
= StateManagerFactory
452 .getExperimentManager();
453 experimentManger
.readExperiment("statisticsView", this);
457 public void dispose() {
459 EventProcessorProxy
.getInstance().removeEventProcessorFactory(
460 StatsTimeCountHandlerFactory
.getInstance());
461 EventProcessorProxy
.getInstance().removeEventProcessorFactory(
462 StatsEventCountHandlerFactory
.getInstance());
469 * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
472 public void setFocus() {
473 treeViewer
.getTree().setFocus();
477 public void processingStarted(RequestStartedSignal request
) {
478 // Nothing to do for the time being
483 public void processingCompleted(RequestCompletedSignal signal
) {
484 treeViewer
.getTree().getDisplay().asyncExec(new Runnable() {
487 treeViewer
.refresh();