1 /*******************************************************************************
2 * Copyright (c) 2012, 2013 Ericsson, École Polytechnique de Montréal
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 * Patrick Tasse - Initial API and implementation
11 * Geneviève Bastien - Move code to provide base classes for time graph view
12 *******************************************************************************/
14 package org
.eclipse
.linuxtools
.internal
.lttng2
.kernel
.ui
.views
.controlflow
;
16 import java
.util
.ArrayList
;
17 import java
.util
.Collections
;
18 import java
.util
.Comparator
;
19 import java
.util
.List
;
21 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
22 import org
.eclipse
.jface
.action
.IToolBarManager
;
23 import org
.eclipse
.jface
.dialogs
.IDialogSettings
;
24 import org
.eclipse
.linuxtools
.internal
.lttng2
.kernel
.core
.Attributes
;
25 import org
.eclipse
.linuxtools
.internal
.lttng2
.kernel
.ui
.Activator
;
26 import org
.eclipse
.linuxtools
.internal
.lttng2
.kernel
.ui
.Messages
;
27 import org
.eclipse
.linuxtools
.lttng2
.kernel
.core
.trace
.LttngKernelTrace
;
28 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.AttributeNotFoundException
;
29 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.StateSystemDisposedException
;
30 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.StateValueTypeException
;
31 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.TimeRangeException
;
32 import org
.eclipse
.linuxtools
.tmf
.core
.interval
.ITmfStateInterval
;
33 import org
.eclipse
.linuxtools
.tmf
.core
.statesystem
.ITmfStateSystem
;
34 import org
.eclipse
.linuxtools
.tmf
.core
.statevalue
.ITmfStateValue
;
35 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfTrace
;
36 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.TmfTraceManager
;
37 import org
.eclipse
.linuxtools
.tmf
.ui
.views
.timegraph
.AbstractTimeGraphView
;
38 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.model
.ILinkEvent
;
39 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.model
.ITimeEvent
;
40 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.model
.ITimeGraphEntry
;
41 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.model
.TimeEvent
;
42 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.model
.TimeGraphEntry
;
43 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.model
.TimeLinkEvent
;
44 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.widgets
.Utils
;
45 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.widgets
.Utils
.Resolution
;
46 import org
.eclipse
.linuxtools
.tmf
.ui
.widgets
.timegraph
.widgets
.Utils
.TimeFormat
;
49 * The Control Flow view main object
52 public class ControlFlowView
extends AbstractTimeGraphView
{
54 // ------------------------------------------------------------------------
56 // ------------------------------------------------------------------------
61 public static final String ID
= "org.eclipse.linuxtools.lttng2.kernel.ui.views.controlflow"; //$NON-NLS-1$
63 private static final String PROCESS_COLUMN
= Messages
.ControlFlowView_processColumn
;
64 private static final String TID_COLUMN
= Messages
.ControlFlowView_tidColumn
;
65 private static final String PTID_COLUMN
= Messages
.ControlFlowView_ptidColumn
;
66 private static final String BIRTH_TIME_COLUMN
= Messages
.ControlFlowView_birthTimeColumn
;
67 private static final String TRACE_COLUMN
= Messages
.ControlFlowView_traceColumn
;
69 private static final String
[] COLUMN_NAMES
= new String
[] {
77 private static final String
[] FILTER_COLUMN_NAMES
= new String
[] {
82 // ------------------------------------------------------------------------
84 // ------------------------------------------------------------------------
89 public ControlFlowView() {
90 super(ID
, new ControlFlowPresentationProvider());
91 setTreeColumns(COLUMN_NAMES
);
92 setTreeLabelProvider(new ControlFlowTreeLabelProvider());
93 setFilterColumns(FILTER_COLUMN_NAMES
);
94 setEntryComparator(new ControlFlowEntryComparator());
98 protected void fillLocalToolBar(IToolBarManager manager
) {
99 super.fillLocalToolBar(manager
);
100 IDialogSettings settings
= Activator
.getDefault().getDialogSettings();
101 IDialogSettings section
= settings
.getSection(getClass().getName());
102 if (section
== null) {
103 section
= settings
.addNewSection(getClass().getName());
105 manager
.add(getTimeGraphCombo().getTimeGraphViewer().getHideArrowsAction(section
));
106 manager
.add(getTimeGraphCombo().getTimeGraphViewer().getFollowArrowBwdAction());
107 manager
.add(getTimeGraphCombo().getTimeGraphViewer().getFollowArrowFwdAction());
111 protected String
getNextText() {
112 return Messages
.ControlFlowView_nextProcessActionNameText
;
116 protected String
getNextTooltip() {
117 return Messages
.ControlFlowView_nextProcessActionToolTipText
;
121 protected String
getPrevText() {
122 return Messages
.ControlFlowView_previousProcessActionNameText
;
126 protected String
getPrevTooltip() {
127 return Messages
.ControlFlowView_previousProcessActionToolTipText
;
130 private static class ControlFlowEntryComparator
implements Comparator
<ITimeGraphEntry
> {
133 public int compare(ITimeGraphEntry o1
, ITimeGraphEntry o2
) {
137 if ((o1
instanceof ControlFlowEntry
) && (o2
instanceof ControlFlowEntry
)) {
138 ControlFlowEntry entry1
= (ControlFlowEntry
) o1
;
139 ControlFlowEntry entry2
= (ControlFlowEntry
) o2
;
140 result
= entry1
.getTrace().getStartTime().compareTo(entry2
.getTrace().getStartTime());
142 result
= entry1
.getTrace().getName().compareTo(entry2
.getTrace().getName());
145 result
= entry1
.getThreadId() < entry2
.getThreadId() ?
-1 : entry1
.getThreadId() > entry2
.getThreadId() ?
1 : 0;
150 result
= o1
.getStartTime() < o2
.getStartTime() ?
-1 : o1
.getStartTime() > o2
.getStartTime() ?
1 : 0;
161 protected static class ControlFlowTreeLabelProvider
extends TreeLabelProvider
{
164 public String
getColumnText(Object element
, int columnIndex
) {
165 ControlFlowEntry entry
= (ControlFlowEntry
) element
;
167 if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_processColumn
)) {
168 return entry
.getName();
169 } else if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_tidColumn
)) {
170 return Integer
.toString(entry
.getThreadId());
171 } else if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_ptidColumn
)) {
172 if (entry
.getParentThreadId() > 0) {
173 return Integer
.toString(entry
.getParentThreadId());
175 } else if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_birthTimeColumn
)) {
176 return Utils
.formatTime(entry
.getStartTime(), TimeFormat
.CALENDAR
, Resolution
.NANOSEC
);
177 } else if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_traceColumn
)) {
178 return entry
.getTrace().getName();
180 return ""; //$NON-NLS-1$
185 // ------------------------------------------------------------------------
187 // ------------------------------------------------------------------------
190 protected void buildEventList(final ITmfTrace trace
, IProgressMonitor monitor
) {
191 setStartTime(Long
.MAX_VALUE
);
192 setEndTime(Long
.MIN_VALUE
);
194 ArrayList
<ControlFlowEntry
> rootList
= new ArrayList
<ControlFlowEntry
>();
195 for (ITmfTrace aTrace
: TmfTraceManager
.getTraceSet(trace
)) {
196 if (monitor
.isCanceled()) {
199 if (aTrace
instanceof LttngKernelTrace
) {
200 ArrayList
<ControlFlowEntry
> entryList
= new ArrayList
<ControlFlowEntry
>();
201 LttngKernelTrace ctfKernelTrace
= (LttngKernelTrace
) aTrace
;
202 ITmfStateSystem ssq
= ctfKernelTrace
.getStateSystems().get(LttngKernelTrace
.STATE_ID
);
203 if (!ssq
.waitUntilBuilt()) {
206 long start
= ssq
.getStartTime();
207 long end
= ssq
.getCurrentEndTime() + 1;
208 setStartTime(Math
.min(getStartTime(), start
));
209 setEndTime(Math
.max(getEndTime(), end
));
210 List
<Integer
> threadQuarks
= ssq
.getQuarks(Attributes
.THREADS
, "*"); //$NON-NLS-1$
211 for (int threadQuark
: threadQuarks
) {
212 if (monitor
.isCanceled()) {
215 String threadName
= ssq
.getAttributeName(threadQuark
);
218 threadId
= Integer
.parseInt(threadName
);
219 } catch (NumberFormatException e1
) {
222 if (threadId
== 0) { // ignore the swapper thread
225 int execNameQuark
= -1;
228 execNameQuark
= ssq
.getQuarkRelative(threadQuark
, Attributes
.EXEC_NAME
);
229 } catch (AttributeNotFoundException e
) {
232 int ppidQuark
= ssq
.getQuarkRelative(threadQuark
, Attributes
.PPID
);
233 List
<ITmfStateInterval
> execNameIntervals
= ssq
.queryHistoryRange(execNameQuark
, start
, end
- 1);
234 // use monitor when available in api
235 if (monitor
.isCanceled()) {
238 ControlFlowEntry entry
= null;
239 for (ITmfStateInterval execNameInterval
: execNameIntervals
) {
240 if (monitor
.isCanceled()) {
243 if (!execNameInterval
.getStateValue().isNull() &&
244 execNameInterval
.getStateValue().getType() == ITmfStateValue
.Type
.STRING
) {
245 String execName
= execNameInterval
.getStateValue().unboxStr();
246 long startTime
= execNameInterval
.getStartTime();
247 long endTime
= execNameInterval
.getEndTime() + 1;
249 if (ppidQuark
!= -1) {
250 ITmfStateInterval ppidInterval
= ssq
.querySingleState(startTime
, ppidQuark
);
251 ppid
= ppidInterval
.getStateValue().unboxInt();
254 entry
= new ControlFlowEntry(threadQuark
, ctfKernelTrace
, execName
, threadId
, ppid
, startTime
, endTime
);
255 entryList
.add(entry
);
257 // update the name of the entry to the
259 entry
.setName(execName
);
261 entry
.addEvent(new TimeEvent(entry
, startTime
, endTime
- startTime
));
266 } catch (AttributeNotFoundException e
) {
268 } catch (TimeRangeException e
) {
270 } catch (StateValueTypeException e
) {
272 } catch (StateSystemDisposedException e
) {
276 buildTree(entryList
, rootList
);
278 Collections
.sort(rootList
, getEntryComparator());
279 putEntryList(trace
, new ArrayList
<TimeGraphEntry
>(rootList
));
281 if (trace
.equals(getTrace())) {
285 for (ControlFlowEntry entry
: rootList
) {
286 if (monitor
.isCanceled()) {
289 buildStatusEvents(entry
.getTrace(), entry
, monitor
);
293 private static void buildTree(ArrayList
<ControlFlowEntry
> entryList
,
294 ArrayList
<ControlFlowEntry
> rootList
) {
295 for (ControlFlowEntry entry
: entryList
) {
297 if (entry
.getParentThreadId() > 0) {
298 for (ControlFlowEntry parent
: entryList
) {
299 if (parent
.getThreadId() == entry
.getParentThreadId() &&
300 entry
.getStartTime() >= parent
.getStartTime() &&
301 entry
.getStartTime() <= parent
.getEndTime()) {
302 parent
.addChild(entry
);
314 private void buildStatusEvents(ITmfTrace trace
, ControlFlowEntry entry
, IProgressMonitor monitor
) {
315 ITmfStateSystem ssq
= entry
.getTrace().getStateSystems().get(LttngKernelTrace
.STATE_ID
);
317 long start
= ssq
.getStartTime();
318 long end
= ssq
.getCurrentEndTime() + 1;
319 long resolution
= Math
.max(1, (end
- start
) / getDisplayWidth());
320 List
<ITimeEvent
> eventList
= getEventList(entry
, entry
.getStartTime(), entry
.getEndTime(), resolution
, monitor
);
321 if (monitor
.isCanceled()) {
324 entry
.setEventList(eventList
);
325 if (trace
.equals(getTrace())) {
328 for (ITimeGraphEntry child
: entry
.getChildren()) {
329 if (monitor
.isCanceled()) {
332 buildStatusEvents(trace
, (ControlFlowEntry
) child
, monitor
);
337 protected List
<ITimeEvent
> getEventList(TimeGraphEntry tgentry
, long startTime
, long endTime
, long resolution
, IProgressMonitor monitor
) {
338 List
<ITimeEvent
> eventList
= null;
339 if (!(tgentry
instanceof ControlFlowEntry
)) {
342 ControlFlowEntry entry
= (ControlFlowEntry
) tgentry
;
343 final long realStart
= Math
.max(startTime
, entry
.getStartTime());
344 final long realEnd
= Math
.min(endTime
, entry
.getEndTime());
345 if (realEnd
<= realStart
) {
348 ITmfStateSystem ssq
= entry
.getTrace().getStateSystems().get(LttngKernelTrace
.STATE_ID
);
350 int statusQuark
= ssq
.getQuarkRelative(entry
.getThreadQuark(), Attributes
.STATUS
);
351 List
<ITmfStateInterval
> statusIntervals
= ssq
.queryHistoryRange(statusQuark
, realStart
, realEnd
- 1, resolution
, monitor
);
352 eventList
= new ArrayList
<ITimeEvent
>(statusIntervals
.size());
353 long lastEndTime
= -1;
354 for (ITmfStateInterval statusInterval
: statusIntervals
) {
355 if (monitor
.isCanceled()) {
358 long time
= statusInterval
.getStartTime();
359 long duration
= statusInterval
.getEndTime() - time
+ 1;
362 status
= statusInterval
.getStateValue().unboxInt();
363 } catch (StateValueTypeException e
) {
366 if (lastEndTime
!= time
&& lastEndTime
!= -1) {
367 eventList
.add(new TimeEvent(entry
, lastEndTime
, time
- lastEndTime
));
369 eventList
.add(new TimeEvent(entry
, time
, duration
, status
));
370 lastEndTime
= time
+ duration
;
372 } catch (AttributeNotFoundException e
) {
374 } catch (TimeRangeException e
) {
376 } catch (StateSystemDisposedException e
) {
383 * Returns a value corresponding to the selected entry.
385 * Used in conjunction with selectEntry to change the selected entry. If one
386 * of these methods is overridden in child class, then both should be.
389 * The currently selected time
390 * @return a value identifying the entry
392 private int getSelectionValue(long time
) {
394 for (ITmfTrace trace
: fTraceManager
.getActiveTraceSet()) {
398 if (trace
instanceof LttngKernelTrace
) {
399 LttngKernelTrace ctfKernelTrace
= (LttngKernelTrace
) trace
;
400 ITmfStateSystem ssq
= ctfKernelTrace
.getStateSystems().get(LttngKernelTrace
.STATE_ID
);
401 if (time
>= ssq
.getStartTime() && time
<= ssq
.getCurrentEndTime()) {
402 List
<Integer
> currentThreadQuarks
= ssq
.getQuarks(Attributes
.CPUS
, "*", Attributes
.CURRENT_THREAD
); //$NON-NLS-1$
403 for (int currentThreadQuark
: currentThreadQuarks
) {
405 ITmfStateInterval currentThreadInterval
= ssq
.querySingleState(time
, currentThreadQuark
);
406 int currentThread
= currentThreadInterval
.getStateValue().unboxInt();
407 if (currentThread
> 0) {
408 int statusQuark
= ssq
.getQuarkAbsolute(Attributes
.THREADS
, Integer
.toString(currentThread
), Attributes
.STATUS
);
409 ITmfStateInterval statusInterval
= ssq
.querySingleState(time
, statusQuark
);
410 if (statusInterval
.getStartTime() == time
) {
411 thread
= currentThread
;
415 } catch (AttributeNotFoundException e
) {
417 } catch (TimeRangeException e
) {
419 } catch (StateValueTypeException e
) {
421 } catch (StateSystemDisposedException e
) {
432 protected void synchingToTime(long time
) {
433 int selected
= getSelectionValue(time
);
435 for (Object element
: getTimeGraphViewer().getExpandedElements()) {
436 if (element
instanceof ControlFlowEntry
) {
437 ControlFlowEntry entry
= (ControlFlowEntry
) element
;
438 if (entry
.getThreadId() == selected
) {
439 getTimeGraphCombo().setSelection(entry
);
448 protected List
<ILinkEvent
> getLinkList(long startTime
, long endTime
, long resolution
, IProgressMonitor monitor
) {
449 List
<ILinkEvent
> list
= new ArrayList
<ILinkEvent
>();
450 ITmfTrace
[] traces
= TmfTraceManager
.getTraceSet(getTrace());
451 List
<TimeGraphEntry
> entryList
= getEntryListMap().get(getTrace());
452 if (traces
== null || entryList
== null) {
455 for (ITmfTrace trace
: traces
) {
456 if (trace
instanceof LttngKernelTrace
) {
457 ITmfStateSystem ssq
= trace
.getStateSystems().get(LttngKernelTrace
.STATE_ID
);
459 long start
= Math
.max(startTime
, ssq
.getStartTime());
460 long end
= Math
.min(endTime
, ssq
.getCurrentEndTime());
464 List
<Integer
> currentThreadQuarks
= ssq
.getQuarks(Attributes
.CPUS
, "*", Attributes
.CURRENT_THREAD
); //$NON-NLS-1$
465 for (int currentThreadQuark
: currentThreadQuarks
) {
466 List
<ITmfStateInterval
> currentThreadIntervals
= ssq
.queryHistoryRange(currentThreadQuark
, start
, end
, resolution
, monitor
);
469 for (ITmfStateInterval currentThreadInterval
: currentThreadIntervals
) {
470 if (monitor
.isCanceled()) {
473 long time
= currentThreadInterval
.getStartTime();
474 int thread
= currentThreadInterval
.getStateValue().unboxInt();
475 if (thread
> 0 && prevThread
> 0 && thread
!= prevThread
&& time
== prevEnd
) {
476 ITimeGraphEntry prevEntry
= findEntry(entryList
, trace
, prevThread
);
477 ITimeGraphEntry nextEntry
= findEntry(entryList
, trace
, thread
);
478 list
.add(new TimeLinkEvent(prevEntry
, nextEntry
, time
, 0, 0));
481 prevEnd
= currentThreadInterval
.getEndTime() + 1;
484 } catch (TimeRangeException e
) {
486 } catch (AttributeNotFoundException e
) {
488 } catch (StateValueTypeException e
) {
490 } catch (StateSystemDisposedException e
) {
498 private ControlFlowEntry
findEntry(List
<TimeGraphEntry
> entryList
, ITmfTrace trace
, int threadId
) {
499 for (TimeGraphEntry entry
: entryList
) {
500 if (entry
instanceof ControlFlowEntry
) {
501 ControlFlowEntry controlFlowEntry
= (ControlFlowEntry
) entry
;
502 if (controlFlowEntry
.getThreadId() == threadId
&& controlFlowEntry
.getTrace() == trace
) {
503 return controlFlowEntry
;
504 } else if (entry
.hasChildren()) {
505 controlFlowEntry
= findEntry(entry
.getChildren(), trace
, threadId
);
506 if (controlFlowEntry
!= null) {
507 return controlFlowEntry
;