aa9f8fe7da0e604855866f7d131415bd564f0ea2
[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.analysis.xml.ui / src / org / eclipse / tracecompass / internal / tmf / analysis / xml / ui / views / timegraph / XmlTimeGraphView.java
1 /*******************************************************************************
2 * Copyright (c) 2014, 2016 École Polytechnique de Montréal
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 * Florian Wininger - Initial API and implementation
11 * Geneviève Bastien - Review of the initial implementation
12 *******************************************************************************/
13
14 package org.eclipse.tracecompass.internal.tmf.analysis.xml.ui.views.timegraph;
15
16 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
17
18 import java.util.ArrayList;
19 import java.util.Collections;
20 import java.util.Comparator;
21 import java.util.HashMap;
22 import java.util.HashSet;
23 import java.util.LinkedList;
24 import java.util.List;
25 import java.util.Map;
26 import java.util.Set;
27 import java.util.TreeSet;
28
29 import org.eclipse.core.runtime.IProgressMonitor;
30 import org.eclipse.core.runtime.IStatus;
31 import org.eclipse.jdt.annotation.NonNull;
32 import org.eclipse.jface.util.IPropertyChangeListener;
33 import org.eclipse.jface.util.PropertyChangeEvent;
34 import org.eclipse.swt.widgets.Display;
35 import org.eclipse.tracecompass.common.core.NonNullUtils;
36 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.model.ITmfXmlModelFactory;
37 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.model.ITmfXmlStateAttribute;
38 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.model.readonly.TmfXmlReadOnlyModelFactory;
39 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.module.IXmlStateSystemContainer;
40 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.module.XmlUtils;
41 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.stateprovider.TmfXmlStrings;
42 import org.eclipse.tracecompass.internal.tmf.analysis.xml.ui.Activator;
43 import org.eclipse.tracecompass.internal.tmf.analysis.xml.ui.TmfXmlUiStrings;
44 import org.eclipse.tracecompass.internal.tmf.analysis.xml.ui.views.XmlViewInfo;
45 import org.eclipse.tracecompass.internal.tmf.analysis.xml.ui.views.timegraph.XmlEntry.EntryDisplayType;
46 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
47 import org.eclipse.tracecompass.statesystem.core.StateSystemUtils;
48 import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException;
49 import org.eclipse.tracecompass.statesystem.core.exceptions.StateSystemDisposedException;
50 import org.eclipse.tracecompass.statesystem.core.exceptions.StateValueTypeException;
51 import org.eclipse.tracecompass.statesystem.core.exceptions.TimeRangeException;
52 import org.eclipse.tracecompass.statesystem.core.interval.ITmfStateInterval;
53 import org.eclipse.tracecompass.tmf.core.statesystem.ITmfAnalysisModuleWithStateSystems;
54 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
55 import org.eclipse.tracecompass.tmf.core.trace.TmfTraceManager;
56 import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils;
57 import org.eclipse.tracecompass.tmf.ui.views.timegraph.AbstractTimeGraphView;
58 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.ITimeGraphPresentationProvider2;
59 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.ILinkEvent;
60 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.ITimeEvent;
61 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.ITimeGraphEntry;
62 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.NullTimeEvent;
63 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.TimeEvent;
64 import org.eclipse.tracecompass.tmf.ui.widgets.timegraph.model.TimeGraphEntry;
65 import org.w3c.dom.Element;
66
67 import com.google.common.collect.Iterables;
68
69 /**
70 * This view displays state system data in a time graph view. It uses an XML
71 * {@link TmfXmlUiStrings#TIME_GRAPH_VIEW} element from an XML file. This
72 * element defines which entries from the state system will be shown and also
73 * gives additional information on the presentation of the view (states, colors,
74 * etc)
75 *
76 * @author Florian Wininger
77 */
78 public class XmlTimeGraphView extends AbstractTimeGraphView {
79
80 /** View ID. */
81 public static final @NonNull String ID = "org.eclipse.linuxtools.tmf.analysis.xml.ui.views.timegraph"; //$NON-NLS-1$
82
83 private static final String[] DEFAULT_COLUMN_NAMES = new String[] {
84 Messages.XmlTimeGraphView_ColumnName,
85 Messages.XmlTimeGraphView_ColumnId,
86 Messages.XmlTimeGraphView_ColumnParentId,
87 };
88
89 private static final String[] DEFAULT_FILTER_COLUMN_NAMES = new String[] {
90 Messages.XmlTimeGraphView_ColumnName,
91 Messages.XmlTimeGraphView_ColumnId
92 };
93
94 /** The relative weight of the sash */
95 private static final int[] fWeight = { 1, 2 };
96
97 private static final String EMPTY_STRING = ""; //$NON-NLS-1$
98 private static final @NonNull String SPLIT_STRING = "/"; //$NON-NLS-1$
99
100 private final @NonNull XmlViewInfo fViewInfo = new XmlViewInfo(ID);
101 private final ITmfXmlModelFactory fFactory;
102
103 // ------------------------------------------------------------------------
104 // Constructors
105 // ------------------------------------------------------------------------
106
107 /**
108 * Default constructor
109 */
110 public XmlTimeGraphView() {
111 super(ID, new XmlPresentationProvider());
112 setWeight(fWeight);
113 setTreeColumns(DEFAULT_COLUMN_NAMES);
114 setTreeLabelProvider(new XmlTreeLabelProvider());
115 setFilterColumns(DEFAULT_FILTER_COLUMN_NAMES);
116 setFilterLabelProvider(new XmlTreeLabelProvider());
117 setEntryComparator(new XmlEntryComparator());
118 this.addPartPropertyListener(new IPropertyChangeListener() {
119 @Override
120 public void propertyChange(PropertyChangeEvent event) {
121 if (event.getProperty().equals(TmfXmlUiStrings.XML_OUTPUT_DATA)) {
122 Object newValue = event.getNewValue();
123 if (newValue instanceof String) {
124 String data = (String) newValue;
125 fViewInfo.setViewData(data);
126 loadNewXmlView();
127 }
128 }
129 }
130 });
131
132 fFactory = TmfXmlReadOnlyModelFactory.getInstance();
133 }
134
135 private void loadNewXmlView() {
136 rebuild();
137 }
138
139 private void setViewTitle(final String title) {
140 Display.getDefault().asyncExec(new Runnable() {
141 @Override
142 public void run() {
143 setPartName(title);
144 }
145 });
146
147 }
148
149 @Override
150 protected String getNextText() {
151 return Messages.XmlTimeGraphView_NextText;
152 }
153
154 @Override
155 protected String getNextTooltip() {
156 return Messages.XmlTimeGraphView_NextTooltip;
157 }
158
159 @Override
160 protected String getPrevText() {
161 return Messages.XmlTimeGraphView_PreviousText;
162 }
163
164 @Override
165 protected String getPrevTooltip() {
166 return Messages.XmlTimeGraphView_PreviousInterval;
167 }
168
169 /**
170 * Default label provider, it shows name, id and parent columns
171 *
172 * TODO: There should be a way to define columns in the XML
173 */
174 private static class XmlTreeLabelProvider extends TreeLabelProvider {
175
176 @Override
177 public String getColumnText(Object element, int columnIndex) {
178 XmlEntry entry = (XmlEntry) element;
179
180 if (DEFAULT_COLUMN_NAMES[columnIndex].equals(Messages.XmlTimeGraphView_ColumnName)) {
181 return entry.getName();
182 } else if (DEFAULT_COLUMN_NAMES[columnIndex].equals(Messages.XmlTimeGraphView_ColumnId)) {
183 return entry.getId();
184 } else if (DEFAULT_COLUMN_NAMES[columnIndex].equals(Messages.XmlTimeGraphView_ColumnParentId)) {
185 return entry.getParentId();
186 }
187 return EMPTY_STRING;
188 }
189
190 }
191
192 private static class XmlEntryComparator implements Comparator<ITimeGraphEntry> {
193
194 @Override
195 public int compare(ITimeGraphEntry o1, ITimeGraphEntry o2) {
196
197 int result = 0;
198
199 if ((o1 instanceof XmlEntry) && (o2 instanceof XmlEntry)) {
200 XmlEntry entry1 = (XmlEntry) o1;
201 XmlEntry entry2 = (XmlEntry) o2;
202 result = entry1.getTrace().getStartTime().compareTo(entry2.getTrace().getStartTime());
203 if (result == 0) {
204 result = entry1.getTrace().getName().compareTo(entry2.getTrace().getName());
205 }
206 if (result == 0) {
207 result = entry1.getName().compareTo(entry2.getName());
208 }
209 }
210
211 if (result == 0) {
212 result = o1.getStartTime() < o2.getStartTime() ? -1 : o1.getStartTime() > o2.getStartTime() ? 1 : 0;
213 }
214
215 return result;
216 }
217 }
218
219 // ------------------------------------------------------------------------
220 // Internal
221 // ------------------------------------------------------------------------
222
223 @Override
224 protected void buildEntryList(ITmfTrace trace, ITmfTrace parentTrace, IProgressMonitor monitor) {
225
226 /*
227 * Get the view element from the XML file. If the element can't be
228 * found, return.
229 */
230 Element viewElement = fViewInfo.getViewElement(TmfXmlUiStrings.TIME_GRAPH_VIEW);
231 if (viewElement == null) {
232 return;
233 }
234 ITimeGraphPresentationProvider2 pres = this.getPresentationProvider();
235 if (pres instanceof XmlPresentationProvider) {
236 /*
237 * TODO: Each entry of a line could have their own states/color.
238 * That will require an update to the presentation provider
239 */
240 ((XmlPresentationProvider) pres).loadNewStates(viewElement);
241 }
242
243 String title = fViewInfo.getViewTitle(viewElement);
244 if (title == null) {
245 title = Messages.XmlTimeGraphView_DefaultTitle;
246 }
247 setViewTitle(title);
248 Set<String> analysisIds = fViewInfo.getViewAnalysisIds(viewElement);
249
250 List<Element> entries = XmlUtils.getChildElements(viewElement, TmfXmlUiStrings.ENTRY_ELEMENT);
251 Set<XmlEntry> entryList = new TreeSet<>(getEntryComparator());
252 if (monitor.isCanceled()) {
253 return;
254 }
255
256 Set<@NonNull ITmfAnalysisModuleWithStateSystems> stateSystemModules = new HashSet<>();
257 if (analysisIds.isEmpty()) {
258 /*
259 * No analysis specified, take all state system analysis modules
260 */
261 Iterables.addAll(stateSystemModules, TmfTraceUtils.getAnalysisModulesOfClass(trace, ITmfAnalysisModuleWithStateSystems.class));
262 } else {
263 for (String moduleId : analysisIds) {
264 moduleId = checkNotNull(moduleId);
265 ITmfAnalysisModuleWithStateSystems module = TmfTraceUtils.getAnalysisModuleOfClass(trace, ITmfAnalysisModuleWithStateSystems.class, moduleId);
266 if (module != null) {
267 stateSystemModules.add(module);
268 }
269 }
270 }
271
272 for (ITmfAnalysisModuleWithStateSystems module : stateSystemModules) {
273 IStatus status = module.schedule();
274 if (!status.isOK()) {
275 return;
276 }
277 if (!module.waitForInitialization()) {
278 return;
279 }
280 for (ITmfStateSystem ssq : module.getStateSystems()) {
281 ssq.waitUntilBuilt();
282
283 long startTime = ssq.getStartTime();
284 long endTime = ssq.getCurrentEndTime();
285 XmlEntry groupEntry = new XmlEntry(-1, trace, trace.getName(), ssq);
286 entryList.add(groupEntry);
287 setStartTime(Math.min(getStartTime(), startTime));
288 setEndTime(Math.max(getEndTime(), endTime));
289
290 /* Add children entry of this entry for each line */
291 for (Element entry : entries) {
292 buildEntry(entry, groupEntry, -1);
293 }
294 }
295 }
296
297 addToEntryList(parentTrace, new ArrayList<TimeGraphEntry>(entryList));
298
299 if (parentTrace.equals(getTrace())) {
300 refresh();
301 }
302 for (XmlEntry traceEntry : entryList) {
303 if (monitor.isCanceled()) {
304 return;
305 }
306 long startTime = traceEntry.getStateSystem().getStartTime();
307 long endTime = traceEntry.getStateSystem().getCurrentEndTime() + 1;
308 buildStatusEvent(traceEntry, monitor, startTime, endTime);
309 }
310 }
311
312 private void buildEntry(Element entryElement, XmlEntry parentEntry, int baseQuark) {
313 /* Get the attribute string to display */
314 String path = entryElement.getAttribute(TmfXmlUiStrings.PATH);
315 if (path.isEmpty()) {
316 path = TmfXmlStrings.WILDCARD;
317 }
318
319 /*
320 * Make sure the XML element has either a display attribute or entries,
321 * otherwise issue a warning
322 */
323
324 List<Element> displayElements = XmlUtils.getChildElements(entryElement, TmfXmlUiStrings.DISPLAY_ELEMENT);
325 List<Element> entryElements = XmlUtils.getChildElements(entryElement, TmfXmlUiStrings.ENTRY_ELEMENT);
326
327 if (displayElements.isEmpty() && entryElements.isEmpty()) {
328 Activator.logWarning(String.format("XML view: entry for %s should have either a display element or entry elements", path)); //$NON-NLS-1$
329 return;
330 }
331
332 ITmfStateSystem ss = parentEntry.getStateSystem();
333
334 /* Get the list of quarks to process with this path */
335 String[] paths = path.split(SPLIT_STRING);
336 int i = 0;
337 List<Integer> quarks = Collections.singletonList(baseQuark);
338
339 while (i < paths.length) {
340 List<Integer> subQuarks = new LinkedList<>();
341 /* Replace * by .* to have a regex string */
342 String name = paths[i].replaceAll("\\*", ".*"); //$NON-NLS-1$ //$NON-NLS-2$
343 for (int relativeQuark : quarks) {
344 for (int quark : ss.getSubAttributes(relativeQuark, false, name)) {
345 subQuarks.add(quark);
346 }
347 }
348 quarks = subQuarks;
349 i++;
350 }
351
352 /* Process each quark */
353 XmlEntry currentEntry = parentEntry;
354 Element displayElement = null;
355 Map<String, XmlEntry> entryMap = new HashMap<>();
356 if (!displayElements.isEmpty()) {
357 displayElement = displayElements.get(0);
358 }
359 for (int quark : quarks) {
360 currentEntry = parentEntry;
361 /* Process the current entry, if specified */
362 if (displayElement != null) {
363 currentEntry = processEntry(entryElement, displayElement, parentEntry, quark, ss);
364 entryMap.put(currentEntry.getId(), currentEntry);
365 }
366 /* Process the children entry of this entry */
367 for (Element subEntryEl : entryElements) {
368 buildEntry(subEntryEl, currentEntry, quark);
369 }
370 }
371 if (!entryMap.isEmpty()) {
372 buildTree(entryMap, parentEntry);
373 }
374 }
375
376 private XmlEntry processEntry(@NonNull Element entryElement, @NonNull Element displayEl,
377 @NonNull XmlEntry parentEntry, int quark, ITmfStateSystem ss) {
378 /*
379 * Get the start time and end time of this entry from the display
380 * attribute
381 */
382 ITmfXmlStateAttribute display = fFactory.createStateAttribute(displayEl, parentEntry);
383 int displayQuark = display.getAttributeQuark(quark, null);
384 if (displayQuark == IXmlStateSystemContainer.ERROR_QUARK) {
385 return new XmlEntry(quark, parentEntry.getTrace(),
386 String.format("Unknown display quark for %s", ss.getAttributeName(quark)), ss); //$NON-NLS-1$
387 }
388
389 long entryStart = ss.getStartTime();
390 long entryEnd = ss.getCurrentEndTime();
391
392 try {
393
394 ITmfStateInterval oneInterval = ss.querySingleState(entryStart, displayQuark);
395
396 /* The entry start is the first non-null interval */
397 while (oneInterval.getStateValue().isNull()) {
398 long ts = oneInterval.getEndTime() + 1;
399 if (ts > ss.getCurrentEndTime()) {
400 break;
401 }
402 oneInterval = ss.querySingleState(ts, displayQuark);
403 }
404 entryStart = oneInterval.getStartTime();
405
406 /* The entry end is the last non-null interval */
407 oneInterval = ss.querySingleState(entryEnd, displayQuark);
408 while (oneInterval.getStateValue().isNull()) {
409 long ts = oneInterval.getStartTime() - 1;
410 if (ts < ss.getStartTime()) {
411 break;
412 }
413 oneInterval = ss.querySingleState(ts, displayQuark);
414 }
415 entryEnd = oneInterval.getEndTime();
416
417 } catch (StateSystemDisposedException e) {
418 }
419
420 return new XmlEntry(quark, displayQuark, parentEntry.getTrace(), ss.getAttributeName(quark),
421 entryStart, entryEnd, EntryDisplayType.DISPLAY, ss, entryElement);
422 }
423
424 private void buildStatusEvent(XmlEntry traceEntry, @NonNull IProgressMonitor monitor, long start, long end) {
425 long resolution = (end - start) / getDisplayWidth();
426 long startTime = Math.max(start, traceEntry.getStartTime());
427 long endTime = Math.min(end + 1, traceEntry.getEndTime());
428 List<ITimeEvent> eventList = getEventList(traceEntry, startTime, endTime, resolution, monitor);
429 if (monitor.isCanceled()) {
430 return;
431 }
432 traceEntry.setEventList(eventList);
433 redraw();
434
435 for (ITimeGraphEntry entry : traceEntry.getChildren()) {
436 if (monitor.isCanceled()) {
437 return;
438 }
439 XmlEntry xmlEntry = (XmlEntry) entry;
440 buildStatusEvent(xmlEntry, monitor, start, end);
441 }
442 }
443
444 /** Build a tree using getParentId() and getId() */
445 private static void buildTree(Map<String, XmlEntry> entryMap, XmlEntry rootEntry) {
446 for (XmlEntry entry : entryMap.values()) {
447 boolean root = true;
448 if (!entry.getParentId().isEmpty()) {
449 XmlEntry parent = entryMap.get(entry.getParentId());
450 /*
451 * Associate the parent entry only if their time overlap. A
452 * child entry may start before its parent, for example at the
453 * beginning of the trace if a parent has not yet appeared in
454 * the state system. We just want to make sure that the entry
455 * didn't start after the parent ended or ended before the
456 * parent started.
457 */
458 if (parent != null &&
459 !(entry.getStartTime() > parent.getEndTime() ||
460 entry.getEndTime() < parent.getStartTime())) {
461 parent.addChild(entry);
462 root = false;
463 }
464 }
465 if (root) {
466 rootEntry.addChild(entry);
467 }
468 }
469 }
470
471 @Override
472 protected List<ITimeEvent> getEventList(TimeGraphEntry entry, long startTime, long endTime, long resolution, IProgressMonitor monitor) {
473 if (!(entry instanceof XmlEntry)) {
474 return Collections.EMPTY_LIST;
475 }
476 XmlEntry xmlEntry = (XmlEntry) entry;
477 ITmfStateSystem ssq = xmlEntry.getStateSystem();
478 final long realStart = Math.max(startTime, entry.getStartTime());
479 final long realEnd = Math.min(endTime, entry.getEndTime());
480 if (realEnd <= realStart) {
481 return null;
482 }
483 List<ITimeEvent> eventList = null;
484 int quark = xmlEntry.getDisplayQuark();
485
486 try {
487 if (xmlEntry.getType() == EntryDisplayType.DISPLAY) {
488
489 List<ITmfStateInterval> statusIntervals = StateSystemUtils.queryHistoryRange(ssq, quark, realStart, realEnd - 1, resolution, monitor);
490 eventList = new ArrayList<>(statusIntervals.size());
491 long lastEndTime = -1;
492 for (ITmfStateInterval statusInterval : statusIntervals) {
493 if (monitor.isCanceled()) {
494 return null;
495 }
496 int status = statusInterval.getStateValue().unboxInt();
497 long time = statusInterval.getStartTime();
498 long duration = statusInterval.getEndTime() - time + 1;
499 if (!statusInterval.getStateValue().isNull()) {
500 if (lastEndTime != time && lastEndTime != -1) {
501 eventList.add(new TimeEvent(entry, lastEndTime, time - lastEndTime));
502 }
503 eventList.add(new TimeEvent(entry, time, duration, status));
504 } else if (lastEndTime == -1 || time + duration >= endTime) {
505 // add null event if it intersects the start or end time
506 eventList.add(new NullTimeEvent(entry, time, duration));
507 }
508 lastEndTime = time + duration;
509 }
510 }
511 } catch (AttributeNotFoundException | TimeRangeException | StateValueTypeException | StateSystemDisposedException e) {
512 /* Ignored */
513 }
514 return eventList;
515 }
516
517 @Override
518 protected List<ILinkEvent> getLinkList(long startTime, long endTime, long resolution, IProgressMonitor monitor) {
519 /* TODO: not implemented yet, need XML to go along */
520 return Collections.EMPTY_LIST;
521 }
522
523 /**
524 * This method will pre-filter the traces that contain analysis modules
525 * supported by this view, whether they are from a trace or an experiment.
526 */
527 @Override
528 protected Iterable<ITmfTrace> getTracesToBuild(ITmfTrace trace) {
529 /*
530 * Get the view element from the XML file. If the element can't be
531 * found, return.
532 */
533 Element viewElement = fViewInfo.getViewElement(TmfXmlUiStrings.TIME_GRAPH_VIEW);
534 if (viewElement == null) {
535 return super.getTracesToBuild(trace);
536 }
537
538 Set<String> analysisIds = fViewInfo.getViewAnalysisIds(viewElement);
539 Set<ITmfTrace> traces = new HashSet<>();
540
541 for (ITmfTrace aTrace : TmfTraceManager.getTraceSetWithExperiment(trace)) {
542 if (aTrace == null) {
543 continue;
544 }
545 if ((analysisIds.isEmpty() && TmfTraceUtils.getAnalysisModulesOfClass(aTrace, ITmfAnalysisModuleWithStateSystems.class).iterator().hasNext())) {
546 /*
547 * No analysis ID specified, so this trace will be built only if
548 * it has state system modules
549 */
550 traces.add(aTrace);
551 } else {
552 /* Build this trace only if it has one the requested modules */
553 for (String moduleId : analysisIds) {
554 if (TmfTraceUtils.getAnalysisModuleOfClass(aTrace, ITmfAnalysisModuleWithStateSystems.class, NonNullUtils.checkNotNull(moduleId)) != null) {
555 traces.add(aTrace);
556 }
557 }
558 }
559 }
560 if (traces.isEmpty()) {
561 return super.getTracesToBuild(trace);
562 }
563 return traces;
564 }
565 }
This page took 0.043725 seconds and 4 git commands to generate.