tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/callstack/CallStackView.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2016 Ericsson and others.
   3  *
   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
   8  *
   9  * Contributors:
  10  *   Patrick Tasse - Initial API and implementation
  11  *   Bernd Hufmann - Updated signal handling
  12  *   Marc-Andre Laperle - Map from binary file
  13  *******************************************************************************/
  14
  15 package org.eclipse.tracecompass.tmf.ui.views.callstack;
  16
  17 import java.util.ArrayList;
  18 import java.util.Collections;
  19 import java.util.Comparator;
  20 import java.util.HashMap;
  21 import java.util.Iterator;
  22 import java.util.List;
  23 import java.util.Map;
  24 import java.util.function.Consumer;
  25
  26 import org.eclipse.core.runtime.IProgressMonitor;
  27 import org.eclipse.jdt.annotation.NonNull;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.eclipse.jface.action.Action;
  30 import org.eclipse.jface.action.GroupMarker;
  31 import org.eclipse.jface.action.IAction;
  32 import org.eclipse.jface.action.IMenuManager;
  33 import org.eclipse.jface.action.IToolBarManager;
  34 import org.eclipse.jface.action.Separator;
  35 import org.eclipse.jface.dialogs.IDialogConstants;
  36 import org.eclipse.jface.dialogs.IDialogSettings;
  37 import org.eclipse.jface.resource.ImageDescriptor;
  38 import org.eclipse.jface.util.IPropertyChangeListener;
  39 import org.eclipse.jface.util.PropertyChangeEvent;
  40 import org.eclipse.jface.viewers.DoubleClickEvent;
  41 import org.eclipse.jface.viewers.IDoubleClickListener;
  42 import org.eclipse.jface.viewers.ISelection;
  43 import org.eclipse.jface.viewers.IStructuredSelection;
  44 import org.eclipse.swt.SWT;
  45 import org.eclipse.swt.events.MouseAdapter;
  46 import org.eclipse.swt.events.MouseEvent;
  47 import org.eclipse.swt.graphics.Image;
  48 import org.eclipse.swt.widgets.Composite;
  49 import org.eclipse.swt.widgets.Display;
  50 import org.eclipse.tracecompass.internal.tmf.ui.Activator;
  51 import org.eclipse.tracecompass.internal.tmf.ui.ITmfImageConstants;
  52 import org.eclipse.tracecompass.internal.tmf.ui.Messages;
  53 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
  54 import org.eclipse.tracecompass.statesystem.core.StateSystemUtils;
  55 import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException;
  56 import org.eclipse.tracecompass.statesystem.core.exceptions.StateSystemDisposedException;
  57 import org.eclipse.tracecompass.statesystem.core.exceptions.StateValueTypeException;
  58 import org.eclipse.tracecompass.statesystem.core.exceptions.TimeRangeException;
  59 import org.eclipse.tracecompass.statesystem.core.interval.ITmfStateInterval;
  60 import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue;
  61 import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue.Type;
  62 import org.eclipse.tracecompass.tmf.core.signal.TmfSelectionRangeUpdatedSignal;
  63 import org.eclipse.tracecompass.tmf.core.signal.TmfSignalHandler;
  64 import org.eclipse.tracecompass.tmf.core.signal.TmfTraceClosedSignal;
  65 import org.eclipse.tracecompass.tmf.core.signal.TmfTraceSelectedSignal;
  66 import org.eclipse.tracecompass.tmf.core.signal.TmfWindowRangeUpdatedSignal;
  67 import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
  68 import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimeRange;
  69 import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp;
  70 import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestampDelta;
  71 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  72 import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils;
  73 import org.eclipse.tracecompass.tmf.ui.editors.ITmfTraceEditor;
  74 import org.eclipse.tracecompass.tmf.ui.symbols.ISymbolProvider;
  75 import org.eclipse.tracecompass.tmf.ui.symbols.ISymbolProviderPreferencePage;
  76 import org.eclipse.tracecompass.tmf.ui.symbols.SymbolProviderConfigDialog;
  77 import org.eclipse.tracecompass.tmf.ui.symbols.SymbolProviderManager;
  78 import org.eclipse.tracecompass.tmf.ui.views.timegraph.AbstractTimeGraphView;
  79 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.ITimeGraphTimeListener;
  80 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.TimeGraphContentProvider;
  81 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.TimeGraphTimeEvent;
  82 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.TimeGraphViewer;
  83 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.ITimeEvent;
  84 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.ITimeGraphEntry;
  85 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.NullTimeEvent;
  86 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.TimeEvent;
  87 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.TimeGraphEntry;
  88 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.widgets.TimeGraphControl;
  89 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.widgets.TimeGraphSelection;
  90 import org.eclipse.ui.IEditorPart;
  91 import org.eclipse.ui.IWorkbenchActionConstants;
  92
  93 /**
  94  * Main implementation for the Call Stack view
  95  *
  96  * @author Patrick Tasse
  97  */
  98 public class CallStackView extends AbstractTimeGraphView {
  99
 100     // ------------------------------------------------------------------------
 101     // Constants
 102     // ------------------------------------------------------------------------
 103
 104     /** View ID. */
 105     public static final String ID = "org.eclipse.linuxtools.tmf.ui.views.callstack"; //$NON-NLS-1$
 106
 107     private static final String[] COLUMN_NAMES = new String[] {
 108             Messages.CallStackView_FunctionColumn,
 109             Messages.CallStackView_DepthColumn,
 110             Messages.CallStackView_EntryTimeColumn,
 111             Messages.CallStackView_ExitTimeColumn,
 112             Messages.CallStackView_DurationColumn
 113     };
 114
 115     private static final String[] FILTER_COLUMN_NAMES = new String[] {
 116             Messages.CallStackView_ThreadColumn
 117     };
 118
 119     /** Timeout between updates in the build thread in ms */
 120     private static final long BUILD_UPDATE_TIMEOUT = 500;
 121
 122     // Fraction of a function duration to be added as spacing
 123     private static final double SPACING_RATIO = 0.01;
 124
 125     private static final Image PROCESS_IMAGE = Activator.getDefault().getImageFromPath("icons/obj16/process_obj.gif"); //$NON-NLS-1$
 126     private static final Image THREAD_IMAGE = Activator.getDefault().getImageFromPath("icons/obj16/thread_obj.gif"); //$NON-NLS-1$
 127     private static final Image STACKFRAME_IMAGE = Activator.getDefault().getImageFromPath("icons/obj16/stckframe_obj.gif"); //$NON-NLS-1$
 128
 129     private static final String IMPORT_BINARY_ICON_PATH = "icons/obj16/binaries_obj.gif"; //$NON-NLS-1$
 130
 131     private static final ImageDescriptor SORT_BY_NAME_ICON = Activator.getDefault().getImageDescripterFromPath("icons/etool16/sort_alpha.gif"); //$NON-NLS-1$
 132     private static final ImageDescriptor SORT_BY_NAME_REV_ICON = Activator.getDefault().getImageDescripterFromPath("icons/etool16/sort_alpha_rev.gif"); //$NON-NLS-1$
 133     private static final ImageDescriptor SORT_BY_ID_ICON = Activator.getDefault().getImageDescripterFromPath("icons/etool16/sort_num.gif"); //$NON-NLS-1$
 134     private static final ImageDescriptor SORT_BY_ID_REV_ICON = Activator.getDefault().getImageDescripterFromPath("icons/etool16/sort_num_rev.gif"); //$NON-NLS-1$
 135     private static final ImageDescriptor SORT_BY_TIME_ICON = Activator.getDefault().getImageDescripterFromPath("icons/etool16/sort_time.gif"); //$NON-NLS-1$
 136     private static final ImageDescriptor SORT_BY_TIME_REV_ICON = Activator.getDefault().getImageDescripterFromPath("icons/etool16/sort_time_rev.gif"); //$NON-NLS-1$
 137     private static final String SORT_OPTION_KEY = "sort.option"; //$NON-NLS-1$
 138
 139     private enum SortOption {
 140         BY_NAME, BY_NAME_REV, BY_ID, BY_ID_REV, BY_TIME, BY_TIME_REV
 141     }
 142
 143     private @NonNull SortOption fSortOption = SortOption.BY_NAME;
 144     private @NonNull Comparator<ITimeGraphEntry> fThreadComparator = new ThreadNameComparator(false);
 145     private Action fSortByNameAction;
 146     private Action fSortByIdAction;
 147     private Action fSortByTimeAction;
 148
 149     // ------------------------------------------------------------------------
 150     // Fields
 151     // ------------------------------------------------------------------------
 152
 153     private final Map<ITmfTrace, ISymbolProvider> fSymbolProviders = new HashMap<>();
 154
 155     // The next event action
 156     private Action fNextEventAction;
 157
 158     // The previous event action
 159     private Action fPrevEventAction;
 160
 161     // The next item action
 162     private Action fNextItemAction;
 163
 164     // The previous item action
 165     private Action fPreviousItemAction;
 166
 167     // The action to import a binary file mapping */
 168     private Action fConfigureSymbolsAction;
 169
 170     // The saved time sync. signal used when switching off the pinning of a view
 171     private TmfSelectionRangeUpdatedSignal fSavedTimeSyncSignal;
 172
 173     // The saved window range signal used when switching off the pinning of
 174     // a view
 175     private TmfWindowRangeUpdatedSignal fSavedRangeSyncSignal;
 176
 177     // When set to true, syncToTime() will select the first call stack entry
 178     // whose current state start time exactly matches the sync time.
 179     private boolean fSyncSelection = false;
 180
 181     // ------------------------------------------------------------------------
 182     // Classes
 183     // ------------------------------------------------------------------------
 184
 185     private static class TraceEntry extends TimeGraphEntry {
 186         public TraceEntry(String name, long startTime, long endTime) {
 187             super(name, startTime, endTime);
 188         }
 189
 190         @Override
 191         public boolean hasTimeEvents() {
 192             return false;
 193         }
 194     }
 195
 196     private static class ProcessEntry extends TimeGraphEntry {
 197
 198         private final int fProcessId;
 199
 200         public ProcessEntry(String name, int processId, long startTime, long endTime) {
 201             super(name, startTime, endTime);
 202             fProcessId = processId;
 203         }
 204
 205         @Override
 206         public boolean hasTimeEvents() {
 207             return false;
 208         }
 209     }
 210
 211     private static class ThreadEntry extends TimeGraphEntry {
 212         // The thread id
 213         private final long fThreadId;
 214
 215         public ThreadEntry(String name, long threadId, long startTime, long endTime) {
 216             super(name, startTime, endTime);
 217             fThreadId = threadId;
 218         }
 219
 220         @Override
 221         public boolean hasTimeEvents() {
 222             return false;
 223         }
 224
 225         public long getThreadId() {
 226             return fThreadId;
 227         }
 228     }
 229
 230     private class CallStackComparator implements Comparator<ITimeGraphEntry> {
 231         @Override
 232         public int compare(ITimeGraphEntry o1, ITimeGraphEntry o2) {
 233             if (o1 instanceof ThreadEntry && o2 instanceof ThreadEntry) {
 234                 return fThreadComparator.compare(o1, o2);
 235             } else if (o1 instanceof ProcessEntry && o2 instanceof ProcessEntry) {
 236                 return Integer.compare(((ProcessEntry) o1).fProcessId, ((ProcessEntry) o2).fProcessId);
 237             }
 238             return 0;
 239         }
 240     }
 241
 242     private static class ThreadNameComparator implements Comparator<ITimeGraphEntry> {
 243         private boolean reverse;
 244
 245         public ThreadNameComparator(boolean reverse) {
 246             this.reverse = reverse;
 247         }
 248
 249         @Override
 250         public int compare(ITimeGraphEntry o1, ITimeGraphEntry o2) {
 251             return reverse ? o2.getName().compareTo(o1.getName()) :
 252                     o1.getName().compareTo(o2.getName());
 253         }
 254     }
 255
 256     private static class ThreadIdComparator implements Comparator<ITimeGraphEntry> {
 257         private boolean reverse;
 258
 259         public ThreadIdComparator(boolean reverse) {
 260             this.reverse = reverse;
 261         }
 262
 263         @Override
 264         public int compare(ITimeGraphEntry o1, ITimeGraphEntry o2) {
 265             if (o1 instanceof ThreadEntry && o2 instanceof ThreadEntry) {
 266                 ThreadEntry t1 = (ThreadEntry) o1;
 267                 ThreadEntry t2 = (ThreadEntry) o2;
 268                 return reverse ? Long.compare(t2.getThreadId(), t1.getThreadId()) :
 269                     Long.compare(t1.getThreadId(), t2.getThreadId());
 270             }
 271             return 0;
 272         }
 273     }
 274
 275     private static class ThreadTimeComparator implements Comparator<ITimeGraphEntry> {
 276         private boolean reverse;
 277
 278         public ThreadTimeComparator(boolean reverse) {
 279             this.reverse = reverse;
 280         }
 281
 282         @Override
 283         public int compare(ITimeGraphEntry o1, ITimeGraphEntry o2) {
 284             return reverse ? Long.compare(o2.getStartTime(), o1.getStartTime()) :
 285                     Long.compare(o1.getStartTime(), o2.getStartTime());
 286         }
 287     }
 288
 289     private static class CallStackTreeLabelProvider extends TreeLabelProvider {
 290
 291         @Override
 292         public Image getColumnImage(Object element, int columnIndex) {
 293             if (columnIndex == 0) {
 294                 if (element instanceof ProcessEntry) {
 295                     return PROCESS_IMAGE;
 296                 } else if (element instanceof ThreadEntry) {
 297                     return THREAD_IMAGE;
 298                 } else if (element instanceof CallStackEntry) {
 299                     CallStackEntry entry = (CallStackEntry) element;
 300                     if (entry.getFunctionName().length() > 0) {
 301                         return STACKFRAME_IMAGE;
 302                     }
 303                 }
 304             }
 305             return null;
 306         }
 307
 308         @Override
 309         public String getColumnText(Object element, int columnIndex) {
 310             if (element instanceof CallStackEntry) {
 311                 CallStackEntry entry = (CallStackEntry) element;
 312                 if (columnIndex == 0) {
 313                     return entry.getFunctionName();
 314                 } else if (columnIndex == 1 && entry.getFunctionName().length() > 0) {
 315                     int depth = entry.getStackLevel();
 316                     return Integer.toString(depth);
 317                 } else if (columnIndex == 2 && entry.getFunctionName().length() > 0) {
 318                     ITmfTimestamp ts = TmfTimestamp.fromNanos(entry.getFunctionEntryTime());
 319                     return ts.toString();
 320                 } else if (columnIndex == 3 && entry.getFunctionName().length() > 0) {
 321                     ITmfTimestamp ts = TmfTimestamp.fromNanos(entry.getFunctionExitTime());
 322                     return ts.toString();
 323                 } else if (columnIndex == 4 && entry.getFunctionName().length() > 0) {
 324                     ITmfTimestamp ts = new TmfTimestampDelta(entry.getFunctionExitTime() - entry.getFunctionEntryTime(), ITmfTimestamp.NANOSECOND_SCALE);
 325                     return ts.toString();
 326                 }
 327             } else if (element instanceof ITimeGraphEntry) {
 328                 if (columnIndex == 0) {
 329                     return ((ITimeGraphEntry) element).getName();
 330                 }
 331             }
 332             return ""; //$NON-NLS-1$
 333         }
 334
 335     }
 336
 337     private class CallStackFilterContentProvider extends TimeGraphContentProvider {
 338         @Override
 339         public boolean hasChildren(Object element) {
 340             if (element instanceof TraceEntry) {
 341                 return super.hasChildren(element);
 342             }
 343             return false;
 344         }
 345
 346         @Override
 347         public ITimeGraphEntry[] getChildren(Object parentElement) {
 348             if (parentElement instanceof TraceEntry) {
 349                 return super.getChildren(parentElement);
 350             }
 351             return new ITimeGraphEntry[0];
 352         }
 353     }
 354
 355     // ------------------------------------------------------------------------
 356     // Constructors
 357     // ------------------------------------------------------------------------
 358
 359     /**
 360      * Default constructor
 361      */
 362     public CallStackView() {
 363         super(ID, new CallStackPresentationProvider());
 364         ((CallStackPresentationProvider) getPresentationProvider()).setCallStackView(this);
 365         setTreeColumns(COLUMN_NAMES);
 366         setTreeLabelProvider(new CallStackTreeLabelProvider());
 367         setEntryComparator(new CallStackComparator());
 368         setFilterColumns(FILTER_COLUMN_NAMES);
 369         setFilterContentProvider(new CallStackFilterContentProvider());
 370         setFilterLabelProvider(new CallStackTreeLabelProvider());
 371     }
 372
 373     // ------------------------------------------------------------------------
 374     // ViewPart
 375     // ------------------------------------------------------------------------
 376
 377     @Override
 378     public void createPartControl(Composite parent) {
 379         super.createPartControl(parent);
 380
 381         getTimeGraphViewer().addTimeListener(new ITimeGraphTimeListener() {
 382             @Override
 383             public void timeSelected(TimeGraphTimeEvent event) {
 384                 synchingToTime(event.getBeginTime());
 385             }
 386         });
 387
 388         getTimeGraphCombo().getTreeViewer().addDoubleClickListener(new IDoubleClickListener() {
 389             @Override
 390             public void doubleClick(DoubleClickEvent event) {
 391                 Object selection = ((IStructuredSelection) event.getSelection()).getFirstElement();
 392                 if (selection instanceof CallStackEntry) {
 393                     CallStackEntry entry = (CallStackEntry) selection;
 394                     if (entry.getFunctionName().length() > 0) {
 395                         long entryTime = entry.getFunctionEntryTime();
 396                         long exitTime = entry.getFunctionExitTime();
 397                         long spacingTime = (long) ((exitTime - entryTime) * SPACING_RATIO);
 398                         entryTime -= spacingTime;
 399                         exitTime += spacingTime;
 400                         TmfTimeRange range = new TmfTimeRange(TmfTimestamp.fromNanos(entryTime), TmfTimestamp.fromNanos(exitTime));
 401                         broadcast(new TmfWindowRangeUpdatedSignal(CallStackView.this, range));
 402                         getTimeGraphViewer().setStartFinishTime(entryTime, exitTime);
 403                         startZoomThread(entryTime, exitTime);
 404                     }
 405                 }
 406             }
 407         });
 408
 409         getTimeGraphViewer().getTimeGraphControl().addMouseListener(new MouseAdapter() {
 410             @Override
 411             public void mouseDoubleClick(MouseEvent e) {
 412                 TimeGraphControl timeGraphControl = getTimeGraphViewer().getTimeGraphControl();
 413                 ISelection selection = timeGraphControl.getSelection();
 414                 if (selection instanceof TimeGraphSelection) {
 415                     Object o = ((TimeGraphSelection) selection).getFirstElement();
 416                     if (o instanceof CallStackEvent) {
 417                         CallStackEvent event = (CallStackEvent) o;
 418                         long startTime = event.getTime();
 419                         long endTime = startTime + event.getDuration();
 420                         long spacingTime = (long) ((endTime - startTime) * SPACING_RATIO);
 421                         startTime -= spacingTime;
 422                         endTime += spacingTime;
 423                         TmfTimeRange range = new TmfTimeRange(TmfTimestamp.fromNanos(startTime), TmfTimestamp.fromNanos(endTime));
 424                         broadcast(new TmfWindowRangeUpdatedSignal(CallStackView.this, range));
 425                         getTimeGraphViewer().setStartFinishTime(startTime, endTime);
 426                         startZoomThread(startTime, endTime);
 427                     }
 428                 }
 429             }
 430         });
 431
 432         contributeToActionBars();
 433         loadSortOption();
 434
 435         IEditorPart editor = getSite().getPage().getActiveEditor();
 436         if (editor instanceof ITmfTraceEditor) {
 437             ITmfTrace trace = ((ITmfTraceEditor) editor).getTrace();
 438             if (trace != null) {
 439                 traceSelected(new TmfTraceSelectedSignal(this, trace));
 440             }
 441         }
 442     }
 443
 444     /**
 445      * Handler for the selection range signal.
 446      *
 447      * @param signal
 448      *            The incoming signal
 449      * @since 1.0
 450      */
 451     @Override
 452     @TmfSignalHandler
 453     public void selectionRangeUpdated(final TmfSelectionRangeUpdatedSignal signal) {
 454
 455         fSavedTimeSyncSignal = isPinned() ? new TmfSelectionRangeUpdatedSignal(signal.getSource(), signal.getBeginTime(), signal.getEndTime()) : null;
 456
 457         if (signal.getSource() == this || getTrace() == null || isPinned()) {
 458             return;
 459         }
 460         final long beginTime = signal.getBeginTime().toNanos();
 461         final long endTime = signal.getEndTime().toNanos();
 462         Display.getDefault().asyncExec(new Runnable() {
 463             @Override
 464             public void run() {
 465                 if (getTimeGraphCombo().isDisposed()) {
 466                     return;
 467                 }
 468                 if (beginTime == endTime) {
 469                     getTimeGraphViewer().setSelectedTime(beginTime, true);
 470                 } else {
 471                     getTimeGraphViewer().setSelectionRange(beginTime, endTime, true);
 472                 }
 473                 fSyncSelection = true;
 474                 synchingToTime(beginTime);
 475                 fSyncSelection = false;
 476                 startZoomThread(getTimeGraphViewer().getTime0(), getTimeGraphViewer().getTime1());
 477             }
 478         });
 479
 480     }
 481
 482     /**
 483      * @since 2.0
 484      */
 485     @Override
 486     @TmfSignalHandler
 487     public void windowRangeUpdated(final TmfWindowRangeUpdatedSignal signal) {
 488
 489         if (isPinned()) {
 490             fSavedRangeSyncSignal = new TmfWindowRangeUpdatedSignal(signal.getSource(), signal.getCurrentRange());
 491             fSavedTimeSyncSignal = null;
 492         }
 493
 494         if ((signal.getSource() == this) || isPinned()) {
 495             return;
 496         }
 497         super.windowRangeUpdated(signal);
 498     }
 499
 500     // ------------------------------------------------------------------------
 501     // Internal
 502     // ------------------------------------------------------------------------
 503
 504     @Override
 505     @TmfSignalHandler
 506     public void traceClosed(TmfTraceClosedSignal signal) {
 507         super.traceClosed(signal);
 508         synchronized(fSymbolProviders){
 509             for(ITmfTrace trace : getTracesToBuild(signal.getTrace())){
 510                 fSymbolProviders.remove(trace);
 511             }
 512         }
 513     }
 514
 515     /**
 516      * @since 2.0
 517      */
 518     @Override
 519     protected void refresh() {
 520         super.refresh();
 521         updateConfigureSymbolsAction();
 522     }
 523
 524     @Override
 525     protected void buildEntryList(final ITmfTrace trace, final ITmfTrace parentTrace, final IProgressMonitor monitor) {
 526         if (monitor.isCanceled()) {
 527             return;
 528         }
 529         AbstractCallStackAnalysis module = getCallStackModule(trace);
 530         if (module == null) {
 531             addUnavailableEntry(trace, parentTrace);
 532             return;
 533         }
 534         ITmfStateSystem ss = module.getStateSystem();
 535         if (ss == null) {
 536             addUnavailableEntry(trace, parentTrace);
 537             return;
 538         }
 539
 540         Map<ITmfTrace, TraceEntry> traceEntryMap = new HashMap<>();
 541         Map<Integer, ProcessEntry> processEntryMap = new HashMap<>();
 542         Map<Integer, ThreadEntry> threadEntryMap = new HashMap<>();
 543
 544         long start = ss.getStartTime();
 545
 546         boolean complete = false;
 547         while (!complete) {
 548             if (monitor.isCanceled()) {
 549                 return;
 550             }
 551             complete = ss.waitUntilBuilt(BUILD_UPDATE_TIMEOUT);
 552             if (ss.isCancelled()) {
 553                 return;
 554             }
 555             long end = ss.getCurrentEndTime();
 556             if (start == end && !complete) { // when complete execute one last time regardless of end time
 557                 continue;
 558             }
 559
 560             ISymbolProvider provider = fSymbolProviders.get(trace);
 561             if (provider == null) {
 562                 provider = SymbolProviderManager.getInstance().getSymbolProvider(trace);
 563                 provider.loadConfiguration(monitor);
 564                 fSymbolProviders.put(trace, provider);
 565             }
 566
 567             getConfigureSymbolsAction().setEnabled(true);
 568
 569
 570             TraceEntry traceEntry = traceEntryMap.get(trace);
 571             if (traceEntry == null) {
 572                 traceEntry = new TraceEntry(trace.getName(), start, end + 1);
 573                 traceEntryMap.put(trace, traceEntry);
 574                 traceEntry.sortChildren(fThreadComparator);
 575                 addToEntryList(parentTrace, Collections.singletonList(traceEntry));
 576             } else {
 577                 traceEntry.updateEndTime(end);
 578             }
 579
 580             try {
 581                 List<ITmfStateInterval> endStates = ss.queryFullState(ss.getCurrentEndTime());
 582
 583                 List<Integer> processQuarks = ss.getQuarks(module.getProcessesPattern());
 584                 for (int processQuark : processQuarks) {
 585
 586                     /*
 587                      * Default to trace entry, overwrite if a process entry exists.
 588                      */
 589                     TimeGraphEntry threadParent = traceEntry;
 590                     int processId = -1;
 591                     if (processQuark != ITmfStateSystem.ROOT_ATTRIBUTE) {
 592                         /* Create the entry for the process */
 593                         ProcessEntry processEntry = processEntryMap.get(processQuark);
 594                         if (processEntry == null) {
 595                             String processName = ss.getAttributeName(processQuark);
 596                             ITmfStateValue processStateValue = endStates.get(processQuark).getStateValue();
 597                             if (processStateValue.getType() == Type.INTEGER) {
 598                                 processId = processStateValue.unboxInt();
 599                             } else {
 600                                 try {
 601                                     processId = Integer.parseInt(processName);
 602                                 } catch (NumberFormatException e) {
 603                                     /* use default processId */
 604                                 }
 605                             }
 606                             processEntry = new ProcessEntry(processName, processId, start, end);
 607                             processEntryMap.put(processQuark, processEntry);
 608                             traceEntry.addChild(processEntry);
 609                         } else {
 610                             processEntry.updateEndTime(end);
 611                         }
 612                         /* The parent of the thread entries will be a process */
 613                         threadParent = processEntry;
 614                     }
 615
 616                     /* Create the threads under the process */
 617                     List<Integer> threadQuarks = ss.getQuarks(processQuark, module.getThreadsPattern());
 618
 619                     /*
 620                      * Only query startStates if necessary (threadEntry == null)
 621                      */
 622                     List<ITmfStateInterval> startStates = null;
 623                     for (int threadQuark : threadQuarks) {
 624                         if (monitor.isCanceled()) {
 625                             return;
 626                         }
 627
 628                         String[] callStackPath = module.getCallStackPath();
 629                         int callStackQuark = ss.getQuarkRelative(threadQuark, callStackPath);
 630                         String threadName = ss.getAttributeName(threadQuark);
 631                         long threadEnd = end + 1;
 632                         ITmfStateInterval endInterval = endStates.get(callStackQuark);
 633                         if (endInterval.getStateValue().isNull() && endInterval.getStartTime() != ss.getStartTime()) {
 634                             threadEnd = endInterval.getStartTime();
 635                         }
 636                         /*
 637                          * Default to process/trace entry, overwrite if a thread entry exists.
 638                          */
 639                         TimeGraphEntry callStackParent = threadParent;
 640                         if (threadQuark != processQuark) {
 641                             ThreadEntry threadEntry = threadEntryMap.get(threadQuark);
 642                             if (threadEntry == null) {
 643                                 if (startStates == null) {
 644                                     startStates = ss.queryFullState(ss.getStartTime());
 645                                 }
 646                                 long threadId = -1;
 647                                 ITmfStateValue threadStateValue = endStates.get(threadQuark).getStateValue();
 648                                 if (threadStateValue.getType() == Type.LONG || threadStateValue.getType() == Type.INTEGER) {
 649                                     threadId = threadStateValue.unboxLong();
 650                                 } else {
 651                                     try {
 652                                         threadId = Long.parseLong(threadName);
 653                                     } catch (NumberFormatException e) {
 654                                         /* use default threadId */
 655                                     }
 656                                 }
 657                                 long threadStart = start;
 658                                 ITmfStateInterval startInterval = startStates.get(callStackQuark);
 659                                 if (startInterval.getStateValue().isNull()) {
 660                                     threadStart = Math.min(startInterval.getEndTime() + 1, end + 1);
 661                                 }
 662                                 threadEntry = new ThreadEntry(threadName, threadId, threadStart, threadEnd);
 663                                 threadEntryMap.put(threadQuark, threadEntry);
 664                                 threadParent.addChild(threadEntry);
 665                             } else {
 666                                 threadEntry.updateEndTime(threadEnd);
 667                             }
 668                             /* The parent of the call stack entries will be a thread */
 669                             callStackParent = threadEntry;
 670                         }
 671                         int level = 1;
 672                         for (int stackLevelQuark : ss.getSubAttributes(callStackQuark, false)) {
 673                             if (level > callStackParent.getChildren().size()) {
 674                                 CallStackEntry callStackEntry = new CallStackEntry(threadName, stackLevelQuark, level, processId, trace, ss);
 675                                 callStackParent.addChild(callStackEntry);
 676                             }
 677                             level++;
 678                         }
 679                     }
 680                 }
 681             } catch (AttributeNotFoundException e) {
 682                 Activator.getDefault().logError("Error querying state system", e); //$NON-NLS-1$
 683             } catch (StateSystemDisposedException e) {
 684                 /* Ignored */
 685             }
 686
 687             if (parentTrace == getTrace()) {
 688                 synchronized (this) {
 689                     setStartTime(getStartTime() == SWT.DEFAULT ? start : Math.min(getStartTime(), start));
 690                     setEndTime(getEndTime() == SWT.DEFAULT ? end + 1 : Math.max(getEndTime(), end + 1));
 691                 }
 692                 synchingToTime(getTimeGraphViewer().getSelectionBegin());
 693                 refresh();
 694             }
 695
 696             Consumer<TimeGraphEntry> consumer = new Consumer<TimeGraphEntry>() {
 697                 @Override
 698                 public void accept(TimeGraphEntry entry) {
 699                     if (monitor.isCanceled()) {
 700                         return;
 701                     }
 702                     if (entry instanceof CallStackEntry) {
 703                         buildStatusEvents(parentTrace, (CallStackEntry) entry, monitor, ss.getStartTime(), end);
 704                         return;
 705                     }
 706                     entry.getChildren().forEach(this);
 707                 }
 708             };
 709             traceEntry.getChildren().forEach(consumer);
 710
 711             start = end;
 712         }
 713     }
 714
 715     private void addUnavailableEntry(ITmfTrace trace, ITmfTrace parentTrace) {
 716         String name = Messages.CallStackView_StackInfoNotAvailable + ' ' + '(' + trace.getName() + ')';
 717         TraceEntry unavailableEntry = new TraceEntry(name, 0, 0);
 718         addToEntryList(parentTrace, Collections.singletonList(unavailableEntry));
 719         if (parentTrace == getTrace()) {
 720             refresh();
 721         }
 722     }
 723
 724     private void buildStatusEvents(ITmfTrace trace, CallStackEntry entry, @NonNull IProgressMonitor monitor, long start, long end) {
 725         ITmfStateSystem ss = entry.getStateSystem();
 726         long resolution = Math.max(1, (end - ss.getStartTime()) / getDisplayWidth());
 727         List<ITimeEvent> eventList = getEventList(entry, start, end + 1, resolution, monitor);
 728         if (eventList != null) {
 729             entry.setEventList(eventList);
 730         }
 731         if (trace == getTrace()) {
 732             redraw();
 733         }
 734     }
 735
 736     /**
 737      * @since 1.2
 738      */
 739     @Override
 740     protected final List<ITimeEvent> getEventList(TimeGraphEntry tgentry, long startTime, long endTime, long resolution, IProgressMonitor monitor) {
 741         if (!(tgentry instanceof CallStackEntry)) {
 742             return null;
 743         }
 744         CallStackEntry entry = (CallStackEntry) tgentry;
 745         ITmfStateSystem ss = entry.getStateSystem();
 746         long start = Math.max(startTime, ss.getStartTime());
 747         long end = Math.min(endTime, ss.getCurrentEndTime() + 1);
 748         if (end <= start) {
 749             return null;
 750         }
 751         boolean isZoomThread = Thread.currentThread() instanceof ZoomThread;
 752         List<ITimeEvent> eventList = null;
 753         try {
 754             List<ITmfStateInterval> stackIntervals = StateSystemUtils.queryHistoryRange(ss, entry.getQuark(), start, end - 1, resolution, monitor);
 755             eventList = new ArrayList<>(stackIntervals.size());
 756             long lastEndTime = -1;
 757             boolean lastIsNull = false;
 758             for (ITmfStateInterval statusInterval : stackIntervals) {
 759                 if (monitor.isCanceled()) {
 760                     return null;
 761                 }
 762                 long time = statusInterval.getStartTime();
 763                 long duration = statusInterval.getEndTime() - time + 1;
 764                 if (!statusInterval.getStateValue().isNull()) {
 765                     final int modulo = CallStackPresentationProvider.NUM_COLORS / 2;
 766                     int value = statusInterval.getStateValue().toString().hashCode() % modulo + modulo;
 767                     eventList.add(new CallStackEvent(entry, time, duration, value));
 768                     lastIsNull = false;
 769                 } else {
 770                     if (lastEndTime == -1 && isZoomThread) {
 771                         // add null event if it intersects the start time
 772                         eventList.add(new NullTimeEvent(entry, time, duration));
 773                     } else {
 774                         if (lastEndTime != time && lastIsNull) {
 775                             // add unknown event if between two null states
 776                             eventList.add(new TimeEvent(entry, lastEndTime, time - lastEndTime));
 777                         }
 778                         if (time + duration >= endTime && isZoomThread) {
 779                             // add null event if it intersects the end time
 780                             eventList.add(new NullTimeEvent(entry, time, duration));
 781                         }
 782                     }
 783                     lastIsNull = true;
 784                 }
 785                 lastEndTime = time + duration;
 786             }
 787         } catch (AttributeNotFoundException e) {
 788             Activator.getDefault().logError("Error querying state system", e); //$NON-NLS-1$
 789         } catch (TimeRangeException e) {
 790             Activator.getDefault().logError("Error querying state system", e); //$NON-NLS-1$
 791         } catch (StateSystemDisposedException e) {
 792             /* Ignored */
 793         }
 794         return eventList;
 795     }
 796
 797     /**
 798      * @since 1.2
 799      */
 800     @Override
 801     protected void synchingToTime(final long time) {
 802         List<TimeGraphEntry> traceEntries = getEntryList(getTrace());
 803         Map<ITmfStateSystem, List<ITmfStateInterval>> fullStateMap = new HashMap<>();
 804         if (traceEntries == null) {
 805             return;
 806         }
 807         Consumer<TimeGraphEntry> consumer = new Consumer<TimeGraphEntry>() {
 808             @Override
 809             public void accept(TimeGraphEntry entry) {
 810                 if (entry instanceof CallStackEntry) {
 811                     CallStackEntry callStackEntry = (CallStackEntry) entry;
 812                     ITmfStateSystem ss = callStackEntry.getStateSystem();
 813                     if (time < ss.getStartTime() || time > ss.getCurrentEndTime()) {
 814                         return;
 815                     }
 816                     ITmfTrace trace = callStackEntry.getTrace();
 817                     try {
 818                         List<ITmfStateInterval> fullState = getFullState(ss);
 819                         ITmfStateInterval stackLevelInterval = fullState.get(callStackEntry.getQuark());
 820                         ITmfStateValue nameValue = stackLevelInterval.getStateValue();
 821
 822                         String name = getFunctionName(trace, callStackEntry.getProcessId(), time, nameValue);
 823                         callStackEntry.setFunctionName(name);
 824                         if (!name.isEmpty()) {
 825                             callStackEntry.setFunctionEntryTime(stackLevelInterval.getStartTime());
 826                             callStackEntry.setFunctionExitTime(stackLevelInterval.getEndTime() + 1);
 827                         }
 828                         if (fSyncSelection) {
 829                             int callStackQuark = ss.getParentAttributeQuark(callStackEntry.getQuark());
 830                             ITmfStateInterval stackInterval = fullState.get(callStackQuark);
 831                             if (time == stackInterval.getStartTime()) {
 832                                 ITmfStateValue stackLevelState = stackInterval.getStateValue();
 833                                 if (stackLevelState.unboxInt() == callStackEntry.getStackLevel() || stackLevelState.isNull()) {
 834                                     Display.getDefault().asyncExec(() -> {
 835                                         getTimeGraphCombo().setSelection(callStackEntry);
 836                                         getTimeGraphViewer().getTimeGraphControl().fireSelectionChanged();
 837                                         fSyncSelection = false;
 838                                     });
 839                                 }
 840                             }
 841                         }
 842                     } catch (StateSystemDisposedException e) {
 843                         /* Ignored */
 844                     }
 845                     return;
 846                 }
 847                 entry.getChildren().forEach(this);
 848             }
 849
 850             private List<ITmfStateInterval> getFullState(ITmfStateSystem ss) throws StateSystemDisposedException {
 851                 List<ITmfStateInterval> fullState = fullStateMap.get(ss);
 852                 if (fullState == null) {
 853                     fullState = ss.queryFullState(time);
 854                     fullStateMap.put(ss, fullState);
 855                 }
 856                 return fullState;
 857             }
 858         };
 859         traceEntries.forEach(consumer);
 860         if (Display.getCurrent() != null) {
 861             getTimeGraphCombo().refresh();
 862         }
 863     }
 864
 865     String getFunctionName(ITmfTrace trace, int processId, long timestamp, ITmfStateValue nameValue) {
 866         long address = Long.MAX_VALUE;
 867         String name = ""; //$NON-NLS-1$
 868         try {
 869             if (nameValue.getType() == Type.STRING) {
 870                 name = nameValue.unboxStr();
 871                 try {
 872                     address = Long.parseLong(name, 16);
 873                 } catch (NumberFormatException e) {
 874                     // ignore
 875                 }
 876             } else if (nameValue.getType() == Type.INTEGER) {
 877                 name = "0x" + Integer.toUnsignedString(nameValue.unboxInt(), 16); //$NON-NLS-1$
 878                 address = nameValue.unboxInt();
 879             } else if (nameValue.getType() == Type.LONG) {
 880                 name = "0x" + Long.toUnsignedString(nameValue.unboxLong(), 16); //$NON-NLS-1$
 881                 address = nameValue.unboxLong();
 882             }
 883         } catch (StateValueTypeException e) {
 884         }
 885         if (address != Long.MAX_VALUE) {
 886             ISymbolProvider provider = fSymbolProviders.get(trace);
 887             if (provider != null) {
 888                 String symbol = provider.getSymbolText(processId, timestamp, address);
 889                 if (symbol != null) {
 890                     name = symbol;
 891                 }
 892             }
 893         }
 894         return name;
 895     }
 896
 897     private void makeActions() {
 898         fPreviousItemAction = getTimeGraphViewer().getPreviousItemAction();
 899         fPreviousItemAction.setText(Messages.TmfTimeGraphViewer_PreviousItemActionNameText);
 900         fPreviousItemAction.setToolTipText(Messages.TmfTimeGraphViewer_PreviousItemActionToolTipText);
 901         fNextItemAction = getTimeGraphViewer().getNextItemAction();
 902         fNextItemAction.setText(Messages.TmfTimeGraphViewer_NextItemActionNameText);
 903         fNextItemAction.setToolTipText(Messages.TmfTimeGraphViewer_NextItemActionToolTipText);
 904     }
 905
 906     private void contributeToActionBars() {
 907         // Create pin action
 908         contributePinActionToToolBar();
 909         fPinAction.addPropertyChangeListener(new IPropertyChangeListener() {
 910             @Override
 911             public void propertyChange(PropertyChangeEvent event) {
 912                 if (IAction.CHECKED.equals(event.getProperty()) && !isPinned()) {
 913                     if (fSavedRangeSyncSignal != null) {
 914                         windowRangeUpdated(fSavedRangeSyncSignal);
 915                         fSavedRangeSyncSignal = null;
 916                     }
 917
 918                     if (fSavedTimeSyncSignal != null) {
 919                         selectionRangeUpdated(fSavedTimeSyncSignal);
 920                         fSavedTimeSyncSignal = null;
 921                     }
 922                 }
 923             }
 924         });
 925     }
 926
 927     /**
 928      * @since 1.2
 929      */
 930     @Override
 931     protected void fillLocalToolBar(IToolBarManager manager) {
 932         makeActions();
 933         manager.add(getConfigureSymbolsAction());
 934         manager.add(new Separator());
 935         manager.add(getSortByNameAction());
 936         manager.add(getSortByIdAction());
 937         manager.add(getSortByTimeAction());
 938         manager.add(new Separator());
 939         manager.add(getTimeGraphCombo().getShowFilterDialogAction());
 940         manager.add(new Separator());
 941         manager.add(getTimeGraphViewer().getResetScaleAction());
 942         manager.add(getPreviousEventAction());
 943         manager.add(getNextEventAction());
 944         manager.add(new Separator());
 945         manager.add(getTimeGraphViewer().getToggleBookmarkAction());
 946         manager.add(getTimeGraphViewer().getPreviousMarkerAction());
 947         manager.add(getTimeGraphViewer().getNextMarkerAction());
 948         manager.add(new Separator());
 949         manager.add(fPreviousItemAction);
 950         manager.add(fNextItemAction);
 951         manager.add(getTimeGraphViewer().getZoomInAction());
 952         manager.add(getTimeGraphViewer().getZoomOutAction());
 953     }
 954
 955     /**
 956      * @since 2.0
 957      */
 958     @Override
 959     protected void fillTimeGraphEntryContextMenu(IMenuManager contextMenu) {
 960         contextMenu.add(new GroupMarker(IWorkbenchActionConstants.GROUP_REORGANIZE));
 961         contextMenu.add(getSortByNameAction());
 962         contextMenu.add(getSortByIdAction());
 963         contextMenu.add(getSortByTimeAction());
 964     }
 965
 966     /**
 967      * Get the the next event action.
 968      *
 969      * @return The action object
 970      */
 971     private Action getNextEventAction() {
 972         if (fNextEventAction == null) {
 973             fNextEventAction = new Action() {
 974                 @Override
 975                 public void run() {
 976                     TimeGraphViewer viewer = getTimeGraphViewer();
 977                     ITimeGraphEntry entry = viewer.getSelection();
 978                     if (entry instanceof CallStackEntry) {
 979                         try {
 980                             CallStackEntry callStackEntry = (CallStackEntry) entry;
 981                             ITmfStateSystem ss = callStackEntry.getStateSystem();
 982                             long time = Math.max(ss.getStartTime(), Math.min(ss.getCurrentEndTime(), viewer.getSelectionBegin()));
 983                             ThreadEntry threadEntry = (ThreadEntry) callStackEntry.getParent();
 984                             int quark = ss.getParentAttributeQuark(callStackEntry.getQuark());
 985                             ITmfStateInterval stackInterval = ss.querySingleState(time, quark);
 986                             long newTime = stackInterval.getEndTime() + 1;
 987                             viewer.setSelectedTimeNotify(newTime, true);
 988                             stackInterval = ss.querySingleState(Math.min(ss.getCurrentEndTime(), newTime), quark);
 989                             int stackLevel = stackInterval.getStateValue().unboxInt();
 990                             ITimeGraphEntry selectedEntry = threadEntry.getChildren().get(Math.max(0, stackLevel - 1));
 991                             getTimeGraphCombo().setSelection(selectedEntry);
 992                             viewer.getTimeGraphControl().fireSelectionChanged();
 993                             startZoomThread(viewer.getTime0(), viewer.getTime1());
 994
 995                         } catch (TimeRangeException | StateSystemDisposedException | StateValueTypeException e) {
 996                             Activator.getDefault().logError("Error querying state system", e); //$NON-NLS-1$
 997                         }
 998                     }
 999                 }
1000             };
1001
1002             fNextEventAction.setText(Messages.TmfTimeGraphViewer_NextEventActionNameText);
1003             fNextEventAction.setToolTipText(Messages.TmfTimeGraphViewer_NextEventActionToolTipText);
1004             fNextEventAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_NEXT_EVENT));
1005         }
1006
1007         return fNextEventAction;
1008     }
1009
1010     /**
1011      * Get the previous event action.
1012      *
1013      * @return The Action object
1014      */
1015     private Action getPreviousEventAction() {
1016         if (fPrevEventAction == null) {
1017             fPrevEventAction = new Action() {
1018                 @Override
1019                 public void run() {
1020                     TimeGraphViewer viewer = getTimeGraphCombo().getTimeGraphViewer();
1021                     ITimeGraphEntry entry = viewer.getSelection();
1022                     if (entry instanceof CallStackEntry) {
1023                         try {
1024                             CallStackEntry callStackEntry = (CallStackEntry) entry;
1025                             ITmfStateSystem ss = callStackEntry.getStateSystem();
1026                             long time = Math.max(ss.getStartTime(), Math.min(ss.getCurrentEndTime(), viewer.getSelectionBegin()));
1027                             ThreadEntry threadEntry = (ThreadEntry) callStackEntry.getParent();
1028                             int quark = ss.getParentAttributeQuark(callStackEntry.getQuark());
1029                             ITmfStateInterval stackInterval = ss.querySingleState(time, quark);
1030                             if (stackInterval.getStartTime() == time && time > ss.getStartTime()) {
1031                                 stackInterval = ss.querySingleState(time - 1, quark);
1032                             }
1033                             viewer.setSelectedTimeNotify(stackInterval.getStartTime(), true);
1034                             int stackLevel = stackInterval.getStateValue().unboxInt();
1035                             ITimeGraphEntry selectedEntry = threadEntry.getChildren().get(Math.max(0, stackLevel - 1));
1036                             getTimeGraphCombo().setSelection(selectedEntry);
1037                             viewer.getTimeGraphControl().fireSelectionChanged();
1038                             startZoomThread(viewer.getTime0(), viewer.getTime1());
1039
1040                         } catch (TimeRangeException | StateSystemDisposedException | StateValueTypeException e) {
1041                             Activator.getDefault().logError("Error querying state system", e); //$NON-NLS-1$
1042                         }
1043                     }
1044                 }
1045             };
1046
1047             fPrevEventAction.setText(Messages.TmfTimeGraphViewer_PreviousEventActionNameText);
1048             fPrevEventAction.setToolTipText(Messages.TmfTimeGraphViewer_PreviousEventActionToolTipText);
1049             fPrevEventAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(ITmfImageConstants.IMG_UI_PREV_EVENT));
1050         }
1051
1052         return fPrevEventAction;
1053     }
1054
1055     private static @Nullable AbstractCallStackAnalysis getCallStackModule(@NonNull ITmfTrace trace) {
1056         /*
1057          * Since we cannot know the exact analysis ID (in separate plugins), we
1058          * will search using the analysis type.
1059          */
1060         Iterable<AbstractCallStackAnalysis> modules =
1061                 TmfTraceUtils.getAnalysisModulesOfClass(trace, AbstractCallStackAnalysis.class);
1062         Iterator<AbstractCallStackAnalysis> it = modules.iterator();
1063         if (!it.hasNext()) {
1064             /* This trace does not provide a call-stack analysis */
1065             return null;
1066         }
1067
1068         /*
1069          * We only look at the first module we find.
1070          *
1071          * TODO Handle the advanced case where one trace provides more than one
1072          * call-stack analysis.
1073          */
1074         AbstractCallStackAnalysis module = it.next();
1075         /* This analysis is not automatic, we need to schedule it on-demand */
1076         module.schedule();
1077         if (!module.waitForInitialization()) {
1078             /* The initialization did not succeed */
1079             return null;
1080         }
1081         return module;
1082     }
1083
1084     // ------------------------------------------------------------------------
1085     // Methods related to function name mapping
1086     // ------------------------------------------------------------------------
1087
1088     private Action getSortByNameAction() {
1089         if (fSortByNameAction == null) {
1090             fSortByNameAction = new Action(Messages.CallStackView_SortByThreadName, IAction.AS_CHECK_BOX) {
1091                 @Override
1092                 public void run() {
1093                     if (fSortOption == SortOption.BY_NAME) {
1094                         saveSortOption(SortOption.BY_NAME_REV);
1095                     } else {
1096                         saveSortOption(SortOption.BY_NAME);
1097                     }
1098                 }
1099             };
1100             fSortByNameAction.setToolTipText(Messages.CallStackView_SortByThreadName);
1101             fSortByNameAction.setImageDescriptor(SORT_BY_NAME_ICON);
1102         }
1103         return fSortByNameAction;
1104     }
1105
1106     private Action getSortByIdAction() {
1107         if (fSortByIdAction == null) {
1108             fSortByIdAction = new Action(Messages.CallStackView_SortByThreadId, IAction.AS_CHECK_BOX) {
1109                 @Override
1110                 public void run() {
1111                     if (fSortOption == SortOption.BY_ID) {
1112                         saveSortOption(SortOption.BY_ID_REV);
1113                     } else {
1114                         saveSortOption(SortOption.BY_ID);
1115                     }
1116                 }
1117             };
1118             fSortByIdAction.setToolTipText(Messages.CallStackView_SortByThreadId);
1119             fSortByIdAction.setImageDescriptor(SORT_BY_ID_ICON);
1120         }
1121         return fSortByIdAction;
1122     }
1123
1124     private Action getSortByTimeAction() {
1125         if (fSortByTimeAction == null) {
1126             fSortByTimeAction = new Action(Messages.CallStackView_SortByThreadTime, IAction.AS_CHECK_BOX) {
1127                 @Override
1128                 public void run() {
1129                     if (fSortOption == SortOption.BY_TIME) {
1130                         saveSortOption(SortOption.BY_TIME_REV);
1131                     } else {
1132                         saveSortOption(SortOption.BY_TIME);
1133                     }
1134                 }
1135             };
1136             fSortByTimeAction.setToolTipText(Messages.CallStackView_SortByThreadTime);
1137             fSortByTimeAction.setImageDescriptor(SORT_BY_TIME_ICON);
1138         }
1139         return fSortByTimeAction;
1140     }
1141
1142     private void loadSortOption() {
1143         IDialogSettings settings = Activator.getDefault().getDialogSettings();
1144         IDialogSettings section = settings.getSection(getClass().getName());
1145         if (section == null) {
1146             return;
1147         }
1148         String sortOption = section.get(SORT_OPTION_KEY);
1149         if (sortOption == null) {
1150             return;
1151         }
1152
1153         // reset defaults
1154         getSortByNameAction().setChecked(false);
1155         getSortByNameAction().setImageDescriptor(SORT_BY_NAME_ICON);
1156         getSortByIdAction().setChecked(false);
1157         getSortByIdAction().setImageDescriptor(SORT_BY_ID_ICON);
1158         getSortByTimeAction().setChecked(false);
1159         getSortByTimeAction().setImageDescriptor(SORT_BY_TIME_ICON);
1160
1161         if (sortOption.equals(SortOption.BY_NAME.name())) {
1162             fSortOption = SortOption.BY_NAME;
1163             fThreadComparator = new ThreadNameComparator(false);
1164             getSortByNameAction().setChecked(true);
1165         } else if (sortOption.equals(SortOption.BY_NAME_REV.name())) {
1166             fSortOption = SortOption.BY_NAME_REV;
1167             fThreadComparator = new ThreadNameComparator(true);
1168             getSortByNameAction().setChecked(true);
1169             getSortByNameAction().setImageDescriptor(SORT_BY_NAME_REV_ICON);
1170         } else if (sortOption.equals(SortOption.BY_ID.name())) {
1171             fSortOption = SortOption.BY_ID;
1172             fThreadComparator = new ThreadIdComparator(false);
1173             getSortByIdAction().setChecked(true);
1174         } else if (sortOption.equals(SortOption.BY_ID_REV.name())) {
1175             fSortOption = SortOption.BY_ID_REV;
1176             fThreadComparator = new ThreadIdComparator(true);
1177             getSortByIdAction().setChecked(true);
1178             getSortByIdAction().setImageDescriptor(SORT_BY_ID_REV_ICON);
1179         } else if (sortOption.equals(SortOption.BY_TIME.name())) {
1180             fSortOption = SortOption.BY_TIME;
1181             fThreadComparator = new ThreadTimeComparator(false);
1182             getSortByTimeAction().setChecked(true);
1183         } else if (sortOption.equals(SortOption.BY_TIME_REV.name())) {
1184             fSortOption = SortOption.BY_TIME_REV;
1185             fThreadComparator = new ThreadTimeComparator(true);
1186             getSortByTimeAction().setChecked(true);
1187             getSortByTimeAction().setImageDescriptor(SORT_BY_TIME_REV_ICON);
1188         }
1189     }
1190
1191     private void saveSortOption(SortOption sortOption) {
1192         IDialogSettings settings = Activator.getDefault().getDialogSettings();
1193         IDialogSettings section = settings.getSection(getClass().getName());
1194         if (section == null) {
1195             section = settings.addNewSection(getClass().getName());
1196         }
1197         section.put(SORT_OPTION_KEY, sortOption.name());
1198         loadSortOption();
1199         List<TimeGraphEntry> entryList = getEntryList(getTrace());
1200         if (entryList == null) {
1201             return;
1202         }
1203         for (TimeGraphEntry traceEntry : entryList) {
1204             traceEntry.sortChildren(fThreadComparator);
1205         }
1206         refresh();
1207     }
1208
1209     private Action getConfigureSymbolsAction() {
1210         if (fConfigureSymbolsAction != null) {
1211             return fConfigureSymbolsAction;
1212         }
1213
1214         fConfigureSymbolsAction = new Action(Messages.CallStackView_ConfigureSymbolProvidersText) {
1215             @Override
1216             public void run() {
1217                 SymbolProviderConfigDialog dialog = new SymbolProviderConfigDialog(getSite().getShell(), getProviderPages());
1218                 if (dialog.open() == IDialogConstants.OK_ID) {
1219                     refresh();
1220                 }
1221             }
1222         };
1223
1224         fConfigureSymbolsAction.setToolTipText(Messages.CallStackView_ConfigureSymbolProvidersTooltip);
1225         fConfigureSymbolsAction.setImageDescriptor(Activator.getDefault().getImageDescripterFromPath(IMPORT_BINARY_ICON_PATH));
1226         fConfigureSymbolsAction.setEnabled(false);
1227
1228         return fConfigureSymbolsAction;
1229     }
1230
1231     /**
1232      * @return an array of {@link ISymbolProviderPreferencePage} that will
1233      *         configure the current traces
1234      */
1235     private ISymbolProviderPreferencePage[] getProviderPages() {
1236         List<ISymbolProviderPreferencePage> pages = new ArrayList<>();
1237         ITmfTrace trace = getTrace();
1238         if (trace != null) {
1239             for (ITmfTrace subTrace : getTracesToBuild(trace)) {
1240                 ISymbolProvider provider = fSymbolProviders.get(subTrace);
1241                 if (provider != null) {
1242                     ISymbolProviderPreferencePage page = provider.createPreferencePage();
1243                     if (page != null) {
1244                         pages.add(page);
1245                     }
1246                 }
1247             }
1248         }
1249         return pages.toArray(new ISymbolProviderPreferencePage[pages.size()]);
1250     }
1251
1252     /**
1253      * Update the enable status of the configure symbols action
1254      */
1255     private void updateConfigureSymbolsAction() {
1256         ISymbolProviderPreferencePage[] providerPages = getProviderPages();
1257         getConfigureSymbolsAction().setEnabled(providerPages.length > 0);
1258     }
1259
1260 }