1 /*******************************************************************************
2 * Copyright (c) 2012, 2016 Ericsson, École Polytechnique de Montréal and others.
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 * Christian Mansky - Add check active / uncheck inactive buttons
13 * Mahdi Zolnouri & Samuel Gagnon - Add flat / hierarchical button
14 *******************************************************************************/
16 package org
.eclipse
.tracecompass
.internal
.analysis
.os
.linux
.ui
.views
.controlflow
;
18 import java
.util
.ArrayList
;
19 import java
.util
.Collection
;
20 import java
.util
.Collections
;
21 import java
.util
.Comparator
;
22 import java
.util
.HashMap
;
23 import java
.util
.HashSet
;
24 import java
.util
.List
;
27 import java
.util
.function
.Function
;
28 import java
.util
.function
.Predicate
;
29 import java
.util
.stream
.Collectors
;
30 import java
.util
.stream
.Stream
;
32 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
33 import org
.eclipse
.core
.runtime
.IStatus
;
34 import org
.eclipse
.core
.runtime
.Status
;
35 import org
.eclipse
.core
.runtime
.jobs
.ISchedulingRule
;
36 import org
.eclipse
.core
.runtime
.jobs
.Job
;
37 import org
.eclipse
.jdt
.annotation
.NonNull
;
38 import org
.eclipse
.jdt
.annotation
.Nullable
;
39 import org
.eclipse
.jface
.action
.Action
;
40 import org
.eclipse
.jface
.action
.IAction
;
41 import org
.eclipse
.jface
.action
.IMenuManager
;
42 import org
.eclipse
.jface
.action
.IToolBarManager
;
43 import org
.eclipse
.jface
.action
.MenuManager
;
44 import org
.eclipse
.jface
.action
.Separator
;
45 import org
.eclipse
.jface
.dialogs
.IDialogSettings
;
46 import org
.eclipse
.jface
.viewers
.ISelection
;
47 import org
.eclipse
.jface
.viewers
.StructuredSelection
;
48 import org
.eclipse
.swt
.widgets
.Composite
;
49 import org
.eclipse
.swt
.widgets
.Event
;
50 import org
.eclipse
.tracecompass
.analysis
.os
.linux
.core
.kernel
.KernelAnalysisModule
;
51 import org
.eclipse
.tracecompass
.analysis
.os
.linux
.core
.kernel
.KernelTidAspect
;
52 import org
.eclipse
.tracecompass
.common
.core
.StreamUtils
.StreamFlattener
;
53 import org
.eclipse
.tracecompass
.internal
.analysis
.os
.linux
.core
.kernel
.Attributes
;
54 import org
.eclipse
.tracecompass
.internal
.analysis
.os
.linux
.ui
.Activator
;
55 import org
.eclipse
.tracecompass
.internal
.analysis
.os
.linux
.ui
.Messages
;
56 import org
.eclipse
.tracecompass
.internal
.analysis
.os
.linux
.ui
.actions
.FollowThreadAction
;
57 import org
.eclipse
.tracecompass
.statesystem
.core
.ITmfStateSystem
;
58 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.AttributeNotFoundException
;
59 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.StateSystemDisposedException
;
60 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.StateValueTypeException
;
61 import org
.eclipse
.tracecompass
.statesystem
.core
.exceptions
.TimeRangeException
;
62 import org
.eclipse
.tracecompass
.statesystem
.core
.interval
.ITmfStateInterval
;
63 import org
.eclipse
.tracecompass
.statesystem
.core
.statevalue
.ITmfStateValue
;
64 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
65 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSelectionRangeUpdatedSignal
;
66 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
67 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalManager
;
68 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
69 import org
.eclipse
.tracecompass
.tmf
.core
.statesystem
.TmfStateSystemAnalysisModule
;
70 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestamp
;
71 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfContext
;
72 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
73 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
74 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceUtils
;
75 import org
.eclipse
.tracecompass
.tmf
.core
.util
.Pair
;
76 import org
.eclipse
.tracecompass
.tmf
.ui
.views
.timegraph
.AbstractStateSystemTimeGraphView
;
77 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.model
.ILinkEvent
;
78 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.model
.ITimeEvent
;
79 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.model
.ITimeGraphEntry
;
80 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.model
.NullTimeEvent
;
81 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.model
.TimeEvent
;
82 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.model
.TimeGraphEntry
;
83 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.model
.TimeLinkEvent
;
84 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.widgets
.TimeGraphControl
;
85 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.widgets
.Utils
;
86 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.widgets
.Utils
.Resolution
;
87 import org
.eclipse
.tracecompass
.tmf
.ui
.widgets
.timegraph
.widgets
.Utils
.TimeFormat
;
89 import com
.google
.common
.collect
.ImmutableList
;
92 * The Control Flow view main object
95 public class ControlFlowView
extends AbstractStateSystemTimeGraphView
{
97 // ------------------------------------------------------------------------
99 // ------------------------------------------------------------------------
103 public static final @NonNull String ID
= "org.eclipse.tracecompass.analysis.os.linux.views.controlflow"; //$NON-NLS-1$
105 private static final String ICONS_PATH
= "icons/"; //$NON-NLS-1$
106 private static final String OPTIMIZE_ICON
= ICONS_PATH
+ "elcl16/Optimization.png"; //$NON-NLS-1$
108 private static final String PROCESS_COLUMN
= Messages
.ControlFlowView_processColumn
;
109 private static final String TID_COLUMN
= Messages
.ControlFlowView_tidColumn
;
110 private static final String PTID_COLUMN
= Messages
.ControlFlowView_ptidColumn
;
111 private static final String BIRTH_TIME_COLUMN
= Messages
.ControlFlowView_birthTimeColumn
;
112 private static final String INVISIBLE_COLUMN
= Messages
.ControlFlowView_invisibleColumn
;
113 private Action fOptimizationAction
;
115 private static final String NEXT_EVENT_ICON_PATH
= "icons/elcl16/shift_r_edit.gif"; //$NON-NLS-1$
116 private static final String PREV_EVENT_ICON_PATH
= "icons/elcl16/shift_l_edit.gif"; //$NON-NLS-1$
118 private static final String
[] COLUMN_NAMES
= new String
[] {
125 private static final String
[] FILTER_COLUMN_NAMES
= new String
[] {
130 // Timeout between updates in the build thread in ms
131 private static final long BUILD_UPDATE_TIMEOUT
= 500;
133 private static final Comparator
<ITimeGraphEntry
>[] COLUMN_COMPARATORS
;
135 private final Function
<Collection
<ILinkEvent
>, Map
<Integer
, Long
>> UPDATE_SCHEDULING_COLUMN_ALGO
= new NaiveOptimizationAlgorithm();
137 private static final int INITIAL_SORT_COLUMN_INDEX
= 3;
140 ImmutableList
.Builder
<Comparator
<ITimeGraphEntry
>> builder
= ImmutableList
.builder();
141 builder
.add(ControlFlowColumnComparators
.PROCESS_NAME_COLUMN_COMPARATOR
)
142 .add(ControlFlowColumnComparators
.TID_COLUMN_COMPARATOR
)
143 .add(ControlFlowColumnComparators
.PTID_COLUMN_COMPARATOR
)
144 .add(ControlFlowColumnComparators
.BIRTH_TIME_COLUMN_COMPARATOR
);
145 List
<Comparator
<ITimeGraphEntry
>> l
= builder
.build();
146 COLUMN_COMPARATORS
= l
.toArray(new Comparator
[l
.size()]);
150 * Mutex rule for search action jobs, making sure they execute sequentially
152 private final ISchedulingRule fSearchActionMutexRule
= new ISchedulingRule() {
154 public boolean isConflicting(ISchedulingRule rule
) {
155 return (rule
== this);
159 public boolean contains(ISchedulingRule rule
) {
160 return (rule
== this);
164 private final Set
<ITmfTrace
> fFlatTraces
= new HashSet
<>();
166 private IAction fFlatAction
;
168 private IAction fHierarchicalAction
;
170 // ------------------------------------------------------------------------
172 // ------------------------------------------------------------------------
177 public ControlFlowView() {
178 super(ID
, new ControlFlowPresentationProvider());
179 setTreeColumns(COLUMN_NAMES
, COLUMN_COMPARATORS
, INITIAL_SORT_COLUMN_INDEX
);
180 setTreeLabelProvider(new ControlFlowTreeLabelProvider());
181 setFilterColumns(FILTER_COLUMN_NAMES
);
182 setFilterLabelProvider(new ControlFlowFilterLabelProvider());
183 setEntryComparator(ControlFlowColumnComparators
.BIRTH_TIME_COLUMN_COMPARATOR
);
187 public void createPartControl(Composite parent
) {
188 super.createPartControl(parent
);
189 // add "Check active" Button to TimeGraphFilterDialog
190 super.getTimeGraphCombo().addTimeGraphFilterCheckActiveButton(
191 new ControlFlowCheckActiveProvider(Messages
.ControlFlowView_checkActiveLabel
, Messages
.ControlFlowView_checkActiveToolTip
));
192 // add "Uncheck inactive" Button to TimeGraphFilterDialog
193 super.getTimeGraphCombo().addTimeGraphFilterUncheckInactiveButton(
194 new ControlFlowCheckActiveProvider(Messages
.ControlFlowView_uncheckInactiveLabel
, Messages
.ControlFlowView_uncheckInactiveToolTip
));
201 protected void fillTimeGraphEntryContextMenu(@NonNull IMenuManager menuManager
) {
202 ISelection selection
= getSite().getSelectionProvider().getSelection();
203 if (selection
instanceof StructuredSelection
) {
204 StructuredSelection sSel
= (StructuredSelection
) selection
;
205 if (sSel
.getFirstElement() instanceof ControlFlowEntry
) {
206 ControlFlowEntry entry
= (ControlFlowEntry
) sSel
.getFirstElement();
207 menuManager
.add(new FollowThreadAction(ControlFlowView
.this, entry
.getName(), entry
.getThreadId(), entry
.getTrace()));
213 protected void fillLocalToolBar(IToolBarManager manager
) {
214 // add "Optimization" Button to local tool bar of Controlflow
215 IAction optimizationAction
= getOptimizationAction();
216 manager
.add(optimizationAction
);
218 // add a separator to local tool bar
219 manager
.add(new Separator());
221 super.fillLocalToolBar(manager
);
222 IDialogSettings settings
= Activator
.getDefault().getDialogSettings();
223 IDialogSettings section
= settings
.getSection(getClass().getName());
224 if (section
== null) {
225 section
= settings
.addNewSection(getClass().getName());
228 IAction hideArrowsAction
= getTimeGraphCombo().getTimeGraphViewer().getHideArrowsAction(section
);
229 manager
.add(hideArrowsAction
);
231 IAction followArrowBwdAction
= getTimeGraphCombo().getTimeGraphViewer().getFollowArrowBwdAction();
232 followArrowBwdAction
.setText(Messages
.ControlFlowView_followCPUBwdText
);
233 followArrowBwdAction
.setToolTipText(Messages
.ControlFlowView_followCPUBwdText
);
234 manager
.add(followArrowBwdAction
);
236 IAction followArrowFwdAction
= getTimeGraphCombo().getTimeGraphViewer().getFollowArrowFwdAction();
237 followArrowFwdAction
.setText(Messages
.ControlFlowView_followCPUFwdText
);
238 followArrowFwdAction
.setToolTipText(Messages
.ControlFlowView_followCPUFwdText
);
239 manager
.add(followArrowFwdAction
);
241 IAction previousEventAction
= new SearchEventAction(false, PackageMessages
.ControlFlowView_PreviousEventJobName
);
242 previousEventAction
.setText(PackageMessages
.ControlFlowView_PreviousEventActionName
);
243 previousEventAction
.setToolTipText(PackageMessages
.ControlFlowView_PreviousEventActionTooltip
);
244 previousEventAction
.setImageDescriptor(Activator
.getDefault().getImageDescripterFromPath(PREV_EVENT_ICON_PATH
));
245 manager
.add(previousEventAction
);
247 IAction nextEventAction
= new SearchEventAction(true, PackageMessages
.ControlFlowView_NextEventJobName
);
248 nextEventAction
.setText(PackageMessages
.ControlFlowView_NextEventActionName
);
249 nextEventAction
.setToolTipText(PackageMessages
.ControlFlowView_NextEventActionTooltip
);
250 nextEventAction
.setImageDescriptor(Activator
.getDefault().getImageDescripterFromPath(NEXT_EVENT_ICON_PATH
));
251 manager
.add(nextEventAction
);
254 private IAction
getOptimizationAction() {
255 if (fOptimizationAction
== null) {
256 fOptimizationAction
= new OptimizationAction();
257 fOptimizationAction
.setImageDescriptor(Activator
.getDefault().getImageDescripterFromPath(OPTIMIZE_ICON
));
258 fOptimizationAction
.setText(Messages
.ControlFlowView_optimizeLabel
);
259 fOptimizationAction
.setToolTipText(Messages
.ControlFlowView_optimizeToolTip
);
261 return fOptimizationAction
;
265 protected void fillLocalMenu(IMenuManager manager
) {
266 super.fillLocalMenu(manager
);
267 final MenuManager item
= new MenuManager(Messages
.ControlFlowView_threadPresentation
);
268 fFlatAction
= createFlatAction();
269 item
.add(fFlatAction
);
271 fHierarchicalAction
= createHierarchicalAction();
272 item
.add(fHierarchicalAction
);
278 * Base Action for the "Go to Next/Previous Event for thread" actions
280 private class SearchEventAction
extends Action
{
282 private final boolean ifDirection
;
283 private final String ifJobName
;
289 * The direction of the search, "true" for forwards and
290 * "false" for backwards.
292 * The name of the job that will be spawned
294 public SearchEventAction(boolean direction
, String jobName
) {
295 ifDirection
= direction
;
301 Job job
= new Job(ifJobName
) {
303 protected IStatus
run(IProgressMonitor monitor
) {
304 TimeGraphControl ctrl
= getTimeGraphViewer().getTimeGraphControl();
305 ITimeGraphEntry traceEntry
= ctrl
.getSelectedTrace();
307 long ts
= getTimeGraphViewer().getSelectionBegin();
308 ITimeEvent selectedState
= Utils
.findEvent(traceEntry
, ts
, 0);
310 if (selectedState
== null) {
311 /* No selection currently in the view, do nothing */
312 return Status
.OK_STATUS
;
314 ITimeGraphEntry entry
= selectedState
.getEntry();
315 if (!(entry
instanceof ControlFlowEntry
)) {
316 return Status
.OK_STATUS
;
318 ControlFlowEntry cfEntry
= (ControlFlowEntry
) entry
;
319 int tid
= cfEntry
.getThreadId();
321 ITmfTrace trace
= cfEntry
.getTrace();
322 ITmfContext ctx
= trace
.seekEvent(TmfTimestamp
.fromNanos(ts
));
323 long rank
= ctx
.getRank();
326 Predicate
<@NonNull ITmfEvent
> predicate
= event
-> {
328 * TODO Specific to the Control Flow View and kernel
329 * traces for now. Could be eventually generalized to
330 * anything represented by the time graph row.
332 Integer eventTid
= KernelTidAspect
.INSTANCE
.resolve(event
);
333 return (eventTid
!= null && eventTid
.intValue() == tid
);
336 ITmfEvent event
= (ifDirection ?
337 TmfTraceUtils
.getNextEventMatching(cfEntry
.getTrace(), rank
, predicate
, monitor
) :
338 TmfTraceUtils
.getPreviousEventMatching(cfEntry
.getTrace(), rank
, predicate
, monitor
));
340 TmfSignalManager
.dispatchSignal(new TmfSelectionRangeUpdatedSignal(this, event
.getTimestamp()));
342 return Status
.OK_STATUS
;
347 * Make subsequent jobs not run concurrently, but wait after one
350 job
.setRule(fSearchActionMutexRule
);
355 private IAction
createHierarchicalAction() {
356 IAction action
= new Action(Messages
.ControlFlowView_hierarchicalViewLabel
, IAction
.AS_RADIO_BUTTON
) {
359 ITmfTrace parentTrace
= getTrace();
360 synchronized (fFlatTraces
) {
361 fFlatTraces
.remove(parentTrace
);
362 for (ITmfTrace trace
: TmfTraceManager
.getTraceSet(parentTrace
)) {
363 final ITmfStateSystem ss
= TmfStateSystemAnalysisModule
.getStateSystem(trace
, KernelAnalysisModule
.ID
);
364 for (TimeGraphEntry traceEntry
: getEntryList(ss
)) {
365 List
<ControlFlowEntry
> currentRootList
= traceEntry
.getChildren().stream()
366 .filter(e
-> e
instanceof ControlFlowEntry
)
367 .map(e
-> (ControlFlowEntry
) e
)
368 .collect(Collectors
.toList());
369 addEntriesToHierarchicalTree(currentRootList
, traceEntry
);
376 action
.setChecked(true);
377 action
.setToolTipText(Messages
.ControlFlowView_hierarchicalViewToolTip
);
381 private IAction
createFlatAction() {
382 IAction action
= new Action(Messages
.ControlFlowView_flatViewLabel
, IAction
.AS_RADIO_BUTTON
) {
385 ITmfTrace parentTrace
= getTrace();
386 synchronized (fFlatTraces
) {
387 fFlatTraces
.add(parentTrace
);
388 for (ITmfTrace trace
: TmfTraceManager
.getTraceSet(parentTrace
)) {
389 final ITmfStateSystem ss
= TmfStateSystemAnalysisModule
.getStateSystem(trace
, KernelAnalysisModule
.ID
);
390 for (TimeGraphEntry traceEntry
: getEntryList(ss
)) {
391 hierarchicalToFlatTree(traceEntry
);
398 action
.setToolTipText(Messages
.ControlFlowView_flatViewToolTip
);
403 protected String
getNextText() {
404 return Messages
.ControlFlowView_nextProcessActionNameText
;
408 protected String
getNextTooltip() {
409 return Messages
.ControlFlowView_nextProcessActionToolTipText
;
413 protected String
getPrevText() {
414 return Messages
.ControlFlowView_previousProcessActionNameText
;
418 protected String
getPrevTooltip() {
419 return Messages
.ControlFlowView_previousProcessActionToolTipText
;
423 * Get the optimization function for the scheduling column. In the base
424 * implementation, this optimizes by Line arrows, but can be overidden.
426 * It takes a collection of link events, looking at the entries being
427 * linked, and returns a list of the proposed order. The list of indexes
428 * should be in ascending order. There can be duplicates, but the values and
429 * order should always be the same for the same input.
431 * @return the returned column order, where the integer is the tid of the
432 * entry, and the return value is the position, there can be
435 public Function
<Collection
<ILinkEvent
>, Map
<Integer
, Long
>> getUpdatedSchedulingColumn() {
436 return UPDATE_SCHEDULING_COLUMN_ALGO
;
440 * This is an optimization action used to find cliques of entries due to
441 * links and put them closer together
443 * @author Samuel Gagnon
445 private final class OptimizationAction
extends Action
{
448 public void runWithEvent(Event event
) {
449 ITmfTrace trace
= getTrace();
454 createFlatAction().run();
457 * This method only returns the arrows in the current time interval
458 * [a,b] of ControlFlowView. Thus, we only optimize for that time
461 List
<ILinkEvent
> arrows
= getTimeGraphViewer().getTimeGraphControl().getArrows();
462 final ITmfStateSystem ss
= TmfStateSystemAnalysisModule
.getStateSystem(trace
, KernelAnalysisModule
.ID
);
463 List
<TimeGraphEntry
> currentList
= getEntryList(ss
);
465 Map
<Integer
, Long
> orderedTidMap
= getUpdatedSchedulingColumn().apply(arrows
);
468 * Now that we have our list of ordered tid, it's time to assign a
469 * position for each threads in the view. For this, we assign a
470 * value to an invisible column and sort according to the values in
473 for (TimeGraphEntry entry
: currentList
) {
474 if (entry
instanceof TraceEntry
) {
475 for (TimeGraphEntry child
: ((TraceEntry
) entry
).getChildren()) {
476 if (child
instanceof ControlFlowEntry
) {
477 ControlFlowEntry cEntry
= (ControlFlowEntry
) child
;
479 * If the thread is in our list, we give it a
480 * position. Otherwise, it means there's no activity
481 * in the current interval for that thread. We set
482 * its position to Long.MAX_VALUE so it goes to the
485 cEntry
.setSchedulingPosition(orderedTidMap
.getOrDefault(cEntry
.getThreadId(), Long
.MAX_VALUE
));
491 setEntryComparator(ControlFlowColumnComparators
.SCHEDULING_COLUMN_COMPARATOR
);
501 protected static class ControlFlowTreeLabelProvider
extends TreeLabelProvider
{
504 public String
getColumnText(Object element
, int columnIndex
) {
505 if (element
instanceof TraceEntry
) {
506 if (columnIndex
== 0) {
507 return ((TraceEntry
) element
).getName();
509 return ""; //$NON-NLS-1$
511 ControlFlowEntry entry
= (ControlFlowEntry
) element
;
513 if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_processColumn
)) {
514 return entry
.getName();
515 } else if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_tidColumn
)) {
516 return Integer
.toString(entry
.getThreadId());
517 } else if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_ptidColumn
)) {
518 if (entry
.getParentThreadId() > 0) {
519 return Integer
.toString(entry
.getParentThreadId());
521 } else if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_birthTimeColumn
)) {
522 return Utils
.formatTime(entry
.getStartTime(), TimeFormat
.CALENDAR
, Resolution
.NANOSEC
);
523 } else if (COLUMN_NAMES
[columnIndex
].equals(Messages
.ControlFlowView_traceColumn
)) {
524 return entry
.getTrace().getName();
525 } else if (COLUMN_NAMES
[columnIndex
].equals(INVISIBLE_COLUMN
)) {
526 return Long
.toString(entry
.getSchedulingPosition());
528 return ""; //$NON-NLS-1$
533 private static class ControlFlowFilterLabelProvider
extends TreeLabelProvider
{
536 public String
getColumnText(Object element
, int columnIndex
) {
537 if (element
instanceof TraceEntry
) {
538 if (columnIndex
== 0) {
539 return ((TraceEntry
) element
).getName();
541 return ""; //$NON-NLS-1$
543 ControlFlowEntry entry
= (ControlFlowEntry
) element
;
545 if (columnIndex
== 0) {
546 return entry
.getName();
547 } else if (columnIndex
== 1) {
548 return Integer
.toString(entry
.getThreadId());
550 return ""; //$NON-NLS-1$
555 private static class TraceEntry
extends TimeGraphEntry
{
557 public TraceEntry(String name
, long startTime
, long endTime
) {
558 super(name
, startTime
, endTime
);
562 public boolean hasTimeEvents() {
569 public void traceClosed(org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceClosedSignal signal
) {
570 super.traceClosed(signal
);
571 synchronized (fFlatTraces
) {
572 fFlatTraces
.remove(signal
.getTrace());
578 public void traceSelected(TmfTraceSelectedSignal signal
) {
579 super.traceSelected(signal
);
580 synchronized (fFlatTraces
) {
581 if (fFlatTraces
.contains(signal
.getTrace())) {
582 fHierarchicalAction
.setChecked(false);
583 fFlatAction
.setChecked(true);
585 fFlatAction
.setChecked(false);
586 fHierarchicalAction
.setChecked(true);
591 // ------------------------------------------------------------------------
593 // ------------------------------------------------------------------------
596 protected void buildEntryList(final ITmfTrace trace
, final ITmfTrace parentTrace
, final IProgressMonitor monitor
) {
597 final ITmfStateSystem ssq
= TmfStateSystemAnalysisModule
.getStateSystem(trace
, KernelAnalysisModule
.ID
);
602 final List
<ControlFlowEntry
> entryList
= new ArrayList
<>();
603 /** Map of trace entries */
604 Map
<ITmfTrace
, TraceEntry
> traceEntryMap
= new HashMap
<>();
605 /** Map of control flow entries, key is a pair [threadId, cpuId] */
606 final Map
<Pair
<Integer
, Integer
>, ControlFlowEntry
> entryMap
= new HashMap
<>();
608 long start
= ssq
.getStartTime();
609 setStartTime(Math
.min(getStartTime(), start
));
611 boolean complete
= false;
613 if (monitor
.isCanceled()) {
616 complete
= ssq
.waitUntilBuilt(BUILD_UPDATE_TIMEOUT
);
617 if (ssq
.isCancelled()) {
620 long end
= ssq
.getCurrentEndTime();
621 if (start
== end
&& !complete
) { // when complete execute one last time regardless of end time
625 TraceEntry aTraceEntry
= traceEntryMap
.get(trace
);
626 if (aTraceEntry
== null) {
627 aTraceEntry
= new TraceEntry(trace
.getName(), start
, end
+ 1);
628 traceEntryMap
.put(trace
, aTraceEntry
);
629 addToEntryList(parentTrace
, ssq
, Collections
.singletonList(aTraceEntry
));
631 aTraceEntry
.updateEndTime(end
+ 1);
633 final TraceEntry traceEntry
= aTraceEntry
;
635 final long resolution
= Math
.max(1, (end
- ssq
.getStartTime()) / getDisplayWidth());
636 setEndTime(Math
.max(getEndTime(), end
+ 1));
637 final List
<Integer
> threadQuarks
= ssq
.getQuarks(Attributes
.THREADS
, "*"); //$NON-NLS-1$
638 queryFullStates(ssq
, start
, end
, resolution
, monitor
, new IQueryHandler() {
640 public void handle(List
<List
<ITmfStateInterval
>> fullStates
, List
<ITmfStateInterval
> prevFullState
) {
641 for (int threadQuark
: threadQuarks
) {
642 String threadAttributeName
= ssq
.getAttributeName(threadQuark
);
644 Pair
<Integer
, Integer
> entryKey
= Attributes
.parseThreadAttributeName(threadAttributeName
);
645 int threadId
= entryKey
.getFirst();
647 if (threadId
< 0) { // ignore the 'unknown' (-1) thread
654 execNameQuark
= ssq
.getQuarkRelative(threadQuark
, Attributes
.EXEC_NAME
);
655 ppidQuark
= ssq
.getQuarkRelative(threadQuark
, Attributes
.PPID
);
656 } catch (AttributeNotFoundException e
) {
657 /* No information on this thread (yet?), skip it for now */
660 ITmfStateInterval lastExecNameInterval
= prevFullState
== null || execNameQuark
>= prevFullState
.size() ?
null : prevFullState
.get(execNameQuark
);
661 long lastExecNameStartTime
= lastExecNameInterval
== null ?
-1 : lastExecNameInterval
.getStartTime();
662 long lastExecNameEndTime
= lastExecNameInterval
== null ?
-1 : lastExecNameInterval
.getEndTime() + 1;
663 long lastPpidStartTime
= prevFullState
== null || ppidQuark
>= prevFullState
.size() ?
-1 : prevFullState
.get(ppidQuark
).getStartTime();
664 for (List
<ITmfStateInterval
> fullState
: fullStates
) {
665 if (monitor
.isCanceled()) {
668 if (execNameQuark
>= fullState
.size() || ppidQuark
>= fullState
.size()) {
669 /* No information on this thread (yet?), skip it for now */
672 ITmfStateInterval execNameInterval
= fullState
.get(execNameQuark
);
673 ITmfStateInterval ppidInterval
= fullState
.get(ppidQuark
);
674 long startTime
= execNameInterval
.getStartTime();
675 long endTime
= execNameInterval
.getEndTime() + 1;
676 if (startTime
== lastExecNameStartTime
&& ppidInterval
.getStartTime() == lastPpidStartTime
) {
679 boolean isNull
= execNameInterval
.getStateValue().isNull();
680 if (isNull
&& lastExecNameEndTime
< startTime
&& lastExecNameEndTime
!= -1) {
682 * There was a non-null interval in between the
683 * full states, try to use it.
686 execNameInterval
= ssq
.querySingleState(startTime
- 1, execNameQuark
);
687 ppidInterval
= ssq
.querySingleState(startTime
- 1, ppidQuark
);
688 startTime
= execNameInterval
.getStartTime();
689 endTime
= execNameInterval
.getEndTime() + 1;
690 } catch (StateSystemDisposedException e
) {
694 if (!execNameInterval
.getStateValue().isNull() &&
695 execNameInterval
.getStateValue().getType() == ITmfStateValue
.Type
.STRING
) {
696 String execName
= execNameInterval
.getStateValue().unboxStr();
697 int ppid
= ppidInterval
.getStateValue().unboxInt();
698 ControlFlowEntry entry
= entryMap
.get(entryKey
);
700 entry
= new ControlFlowEntry(threadQuark
, trace
, execName
, threadId
, ppid
, startTime
, endTime
);
701 entryList
.add(entry
);
702 entryMap
.put(entryKey
, entry
);
705 * Update the name of the entry to the
706 * latest execName and the parent thread id
707 * to the latest ppid.
709 entry
.setName(execName
);
710 entry
.setParentThreadId(ppid
);
711 entry
.updateEndTime(endTime
);
715 entryMap
.remove(entryKey
);
717 lastExecNameStartTime
= startTime
;
718 lastExecNameEndTime
= endTime
;
719 lastPpidStartTime
= ppidInterval
.getStartTime();
722 synchronized (fFlatTraces
) {
723 if (fFlatTraces
.contains(parentTrace
)) {
724 addEntriesToFlatTree(entryList
, traceEntry
);
726 addEntriesToHierarchicalTree(entryList
, traceEntry
);
732 queryFullStates(ssq
, ssq
.getStartTime(), end
, resolution
, monitor
, new IQueryHandler() {
734 public void handle(@NonNull List
<List
<ITmfStateInterval
>> fullStates
, @Nullable List
<ITmfStateInterval
> prevFullState
) {
735 for (final TimeGraphEntry entry
: traceEntry
.getChildren()) {
736 if (monitor
.isCanceled()) {
739 buildStatusEvents(trace
, parentTrace
, ssq
, fullStates
, prevFullState
, (ControlFlowEntry
) entry
, monitor
, ssq
.getStartTime(), end
);
744 if (parentTrace
.equals(getTrace())) {
753 * Add entries to the traces's child list in a flat fashion (no hierarchy).
754 * If one entry has children, we do a depth first search to add each child
755 * to the trace's child list and update the parent and child relations.
757 private static void hierarchicalToFlatTree(TimeGraphEntry traceEntry
) {
758 List
<@NonNull TimeGraphEntry
> rootList
= traceEntry
.getChildren();
759 // We visit the children of every entry to add
760 StreamFlattener
<TimeGraphEntry
> sf
= new StreamFlattener
<>(entry
-> entry
.getChildren().stream());
761 Stream
<TimeGraphEntry
> allEntries
= rootList
.stream().flatMap(entry
-> sf
.flatten(entry
));
763 // We add every entry that is missing from the trace's entry list
764 List
<@NonNull TimeGraphEntry
> rootListToAdd
= allEntries
765 .filter(entry
-> !rootList
.contains(entry
))
766 .collect(Collectors
.toList());
767 rootList
.forEach(entry
-> {
768 entry
.clearChildren();
770 rootListToAdd
.forEach(entry
-> {
771 traceEntry
.addChild(entry
);
772 entry
.clearChildren();
777 * Add entries to the traces's child list in a flat fashion (no hierarchy).
779 private static void addEntriesToFlatTree(List
<@NonNull ControlFlowEntry
> entryList
, TimeGraphEntry traceEntry
) {
780 List
<TimeGraphEntry
> rootList
= traceEntry
.getChildren();
781 for (ControlFlowEntry entry
: entryList
) {
782 if (!rootList
.contains(entry
)) {
783 traceEntry
.addChild(entry
);
789 * Add entries to the trace's child list in a hierarchical fashion.
791 private static void addEntriesToHierarchicalTree(List
<ControlFlowEntry
> entryList
, TimeGraphEntry traceEntry
) {
792 List
<TimeGraphEntry
> rootList
= traceEntry
.getChildren();
794 for (ControlFlowEntry entry
: entryList
) {
795 boolean root
= (entry
.getParent() == null || entry
.getParent() == traceEntry
);
796 if (root
&& entry
.getParentThreadId() > 0) {
797 for (ControlFlowEntry parent
: entryList
) {
799 * Associate the parent entry only if their time overlap. A
800 * child entry may start before its parent, for example at
801 * the beginning of the trace if a parent has not yet
802 * appeared in the state system. We just want to make sure
803 * that the entry didn't start after the parent ended or
804 * ended before the parent started.
806 if (parent
.getThreadId() == entry
.getParentThreadId() &&
807 !(entry
.getStartTime() > parent
.getEndTime() ||
808 entry
.getEndTime() < parent
.getStartTime())) {
809 parent
.addChild(entry
);
811 if (rootList
.contains(entry
)) {
812 traceEntry
.removeChild(entry
);
818 if (root
&& (!rootList
.contains(entry
))) {
819 traceEntry
.addChild(entry
);
824 private void buildStatusEvents(ITmfTrace trace
, ITmfTrace parentTrace
, ITmfStateSystem ss
, @NonNull List
<List
<ITmfStateInterval
>> fullStates
,
825 @Nullable List
<ITmfStateInterval
> prevFullState
, ControlFlowEntry entry
, @NonNull IProgressMonitor monitor
, long start
, long end
) {
826 if (start
< entry
.getEndTime() && end
> entry
.getStartTime()) {
827 List
<ITimeEvent
> eventList
= getEventList(entry
, ss
, fullStates
, prevFullState
, monitor
);
828 if (eventList
== null) {
831 /* Start a new event list on first iteration, then append to it */
832 if (prevFullState
== null) {
833 entry
.setEventList(eventList
);
835 for (ITimeEvent event
: eventList
) {
836 entry
.addEvent(event
);
839 if (parentTrace
.equals(getTrace())) {
843 for (ITimeGraphEntry child
: entry
.getChildren()) {
844 if (monitor
.isCanceled()) {
847 buildStatusEvents(trace
, parentTrace
, ss
, fullStates
, prevFullState
, (ControlFlowEntry
) child
, monitor
, start
, end
);
852 protected @Nullable List
<ITimeEvent
> getEventList(@NonNull TimeGraphEntry tgentry
, ITmfStateSystem ss
,
853 @NonNull List
<List
<ITmfStateInterval
>> fullStates
, @Nullable List
<ITmfStateInterval
> prevFullState
, @NonNull IProgressMonitor monitor
) {
854 List
<ITimeEvent
> eventList
= null;
855 if (!(tgentry
instanceof ControlFlowEntry
)) {
858 ControlFlowEntry entry
= (ControlFlowEntry
) tgentry
;
860 int threadQuark
= entry
.getThreadQuark();
861 int statusQuark
= ss
.getQuarkRelative(threadQuark
, Attributes
.STATUS
);
862 eventList
= new ArrayList
<>(fullStates
.size());
863 ITmfStateInterval lastInterval
= prevFullState
== null || statusQuark
>= prevFullState
.size() ?
null : prevFullState
.get(statusQuark
);
864 long lastStartTime
= lastInterval
== null ?
-1 : lastInterval
.getStartTime();
865 long lastEndTime
= lastInterval
== null ?
-1 : lastInterval
.getEndTime() + 1;
866 for (List
<ITmfStateInterval
> fullState
: fullStates
) {
867 if (monitor
.isCanceled()) {
870 if (statusQuark
>= fullState
.size()) {
871 /* No information on this thread (yet?), skip it for now */
874 ITmfStateInterval statusInterval
= fullState
.get(statusQuark
);
875 long time
= statusInterval
.getStartTime();
876 if (time
== lastStartTime
) {
879 long duration
= statusInterval
.getEndTime() - time
+ 1;
882 status
= statusInterval
.getStateValue().unboxInt();
883 } catch (StateValueTypeException e
) {
884 Activator
.getDefault().logError(e
.getMessage());
886 if (lastEndTime
!= time
&& lastEndTime
!= -1) {
887 eventList
.add(new TimeEvent(entry
, lastEndTime
, time
- lastEndTime
));
889 if (!statusInterval
.getStateValue().isNull()) {
890 eventList
.add(new TimeEvent(entry
, time
, duration
, status
));
892 eventList
.add(new NullTimeEvent(entry
, time
, duration
));
894 lastStartTime
= time
;
895 lastEndTime
= time
+ duration
;
897 } catch (AttributeNotFoundException
| TimeRangeException e
) {
898 Activator
.getDefault().logError(e
.getMessage());
904 * Returns a value corresponding to the selected entry.
906 * Used in conjunction with synchingToTime to change the selected entry. If
907 * one of these methods is overridden in child class, then both should be.
910 * The currently selected time
911 * @return a value identifying the entry
913 private int getSelectionValue(long time
) {
915 for (ITmfTrace trace
: TmfTraceManager
.getTraceSet(getTrace())) {
919 ITmfStateSystem ssq
= TmfStateSystemAnalysisModule
.getStateSystem(trace
, KernelAnalysisModule
.ID
);
923 if (time
>= ssq
.getStartTime() && time
<= ssq
.getCurrentEndTime()) {
924 List
<Integer
> currentThreadQuarks
= ssq
.getQuarks(Attributes
.CPUS
, "*", Attributes
.CURRENT_THREAD
); //$NON-NLS-1$
925 for (int currentThreadQuark
: currentThreadQuarks
) {
927 ITmfStateInterval currentThreadInterval
= ssq
.querySingleState(time
, currentThreadQuark
);
928 int currentThread
= currentThreadInterval
.getStateValue().unboxInt();
929 if (currentThread
> 0) {
930 int statusQuark
= ssq
.getQuarkAbsolute(Attributes
.THREADS
, Integer
.toString(currentThread
), Attributes
.STATUS
);
931 ITmfStateInterval statusInterval
= ssq
.querySingleState(time
, statusQuark
);
932 if (statusInterval
.getStartTime() == time
) {
933 thread
= currentThread
;
937 } catch (AttributeNotFoundException
| TimeRangeException
| StateValueTypeException e
) {
938 Activator
.getDefault().logError(e
.getMessage());
939 } catch (StateSystemDisposedException e
) {
949 protected void synchingToTime(long time
) {
950 int selected
= getSelectionValue(time
);
952 for (Object element
: getTimeGraphViewer().getExpandedElements()) {
953 if (element
instanceof ControlFlowEntry
) {
954 ControlFlowEntry entry
= (ControlFlowEntry
) element
;
955 if (entry
.getThreadId() == selected
) {
956 getTimeGraphCombo().setSelection(entry
);
965 protected @NonNull List
<ILinkEvent
> getLinkList(ITmfStateSystem ss
,
966 @NonNull List
<List
<ITmfStateInterval
>> fullStates
, @Nullable List
<ITmfStateInterval
> prevFullState
, @NonNull IProgressMonitor monitor
) {
967 List
<ILinkEvent
> list
= new ArrayList
<>();
968 List
<TimeGraphEntry
> entryList
= getEntryList(ss
);
969 if (entryList
== null) {
972 for (ITmfTrace trace
: TmfTraceManager
.getTraceSet(getTrace())) {
973 List
<Integer
> currentThreadQuarks
= ss
.getQuarks(Attributes
.CPUS
, "*", Attributes
.CURRENT_THREAD
); //$NON-NLS-1$
974 for (int currentThreadQuark
: currentThreadQuarks
) {
975 if (currentThreadQuark
>= fullStates
.get(0).size()) {
976 /* No information on this cpu (yet?), skip it for now */
979 List
<ITmfStateInterval
> currentThreadIntervals
= new ArrayList
<>(fullStates
.size() + 2);
982 * Add the previous interval if it is the first query
983 * iteration and the first interval has currentThread=0. Add
984 * the following interval if the last interval has
985 * currentThread=0. These are diagonal arrows crossing the
986 * query iteration range.
988 if (prevFullState
== null) {
989 ITmfStateInterval currentThreadInterval
= fullStates
.get(0).get(currentThreadQuark
);
990 if (currentThreadInterval
.getStateValue().unboxInt() == 0) {
991 long start
= Math
.max(currentThreadInterval
.getStartTime() - 1, ss
.getStartTime());
992 currentThreadIntervals
.add(ss
.querySingleState(start
, currentThreadQuark
));
995 for (List
<ITmfStateInterval
> fullState
: fullStates
) {
996 currentThreadIntervals
.add(fullState
.get(currentThreadQuark
));
998 ITmfStateInterval currentThreadInterval
= fullStates
.get(fullStates
.size() - 1).get(currentThreadQuark
);
999 if (currentThreadInterval
.getStateValue().unboxInt() == 0) {
1000 long end
= Math
.min(currentThreadInterval
.getEndTime() + 1, ss
.getCurrentEndTime());
1001 currentThreadIntervals
.add(ss
.querySingleState(end
, currentThreadQuark
));
1003 } catch (StateSystemDisposedException e
) {
1010 for (ITmfStateInterval currentThreadInterval
: currentThreadIntervals
) {
1011 if (monitor
.isCanceled()) {
1014 if (currentThreadInterval
.getEndTime() + 1 == lastEnd
) {
1017 long time
= currentThreadInterval
.getStartTime();
1018 if (time
!= lastEnd
) {
1019 // don't create links where there are gaps in intervals due to the resolution
1023 int thread
= currentThreadInterval
.getStateValue().unboxInt();
1024 if (thread
> 0 && prevThread
> 0) {
1025 ITimeGraphEntry prevEntry
= findEntry(entryList
, trace
, prevThread
);
1026 ITimeGraphEntry nextEntry
= findEntry(entryList
, trace
, thread
);
1027 list
.add(new TimeLinkEvent(prevEntry
, nextEntry
, prevEnd
, time
- prevEnd
, 0));
1029 lastEnd
= currentThreadInterval
.getEndTime() + 1;
1031 prevThread
= thread
;
1040 private ControlFlowEntry
findEntry(List
<TimeGraphEntry
> entryList
, ITmfTrace trace
, int threadId
) {
1041 for (TimeGraphEntry entry
: entryList
) {
1042 if (entry
instanceof ControlFlowEntry
) {
1043 ControlFlowEntry controlFlowEntry
= (ControlFlowEntry
) entry
;
1044 if (controlFlowEntry
.getThreadId() == threadId
&& controlFlowEntry
.getTrace() == trace
) {
1045 return controlFlowEntry
;
1048 if (entry
.hasChildren()) {
1049 ControlFlowEntry controlFlowEntry
= findEntry(entry
.getChildren(), trace
, threadId
);
1050 if (controlFlowEntry
!= null) {
1051 return controlFlowEntry
;