8 The purpose of '''Trace Compass''' is to facilitate the integration of tracing
9 and monitoring tools into Eclipse, to provide out-of-the-box generic
10 functionalities/views and provide extension mechanisms of the base
11 functionalities for application specific purposes.
13 This guide goes over the internal components of the Trace Compass framework. It
14 should help developers trying to add new capabilities (support for new trace
15 type, new analysis or views, etc.) to the framework. End-users, using the RCP
16 for example, should not have to worry about the concepts explained here.
18 = Implementing a New Trace Type =
20 The framework can easily be extended to support more trace types. To make a new
21 trace type, one must define the following items:
27 * The ''org.eclipse.linuxtools.tmf.core.tracetype'' plug-in extension point
28 * (Optional) The ''org.eclipse.linuxtools.tmf.ui.tracetypeui'' plug-in extension point
30 The '''event type''' must implement an ''ITmfEvent'' or extend a class that
31 implements an ''ITmfEvent''. Typically it will extend ''TmfEvent''. The event
32 type must contain all the data of an event.
34 The '''trace type''' must be of an ''ITmfTrace'' type. The ''TmfTrace'' class
35 will supply many background operations so that the reader only needs to
36 implement certain functions. This includes the ''event aspects'' for events of
37 this trace type. See the section below.
39 The '''trace context''' can be seen as the internals of an iterator. It is
40 required by the trace reader to parse events as it iterates the trace and to
41 keep track of its rank and location. It can have a timestamp, a rank, a file
42 position, or any other element, it should be considered to be ephemeral.
44 The '''trace location''' is an element that is cloned often to store
45 checkpoints, it is generally persistent. It is used to rebuild a context,
46 therefore, it needs to contain enough information to unambiguously point to one
47 and only one event. Finally the ''tracetype'' plug-in extension associates a
48 given trace, non-programmatically to a trace type for use in the UI.
52 In Trace Compass, an ''event aspect'' represents any type of information that
53 can be extracted from a trace event. The simple case is information that is
54 present directly in the event. For example, the timestamp of an event, a field
55 of an LTTng event, or the "payload" that is on the same line of a text trace
56 entry. But it could also be the result of an indirect operation, for example a
57 state system query at the timestamp of the given event (see the section
58 [[#Generic State System]]).
60 All aspects should implement the '''ITmfEventAspect''' interface. The important
61 method in there is ''resolve(ITmfEvent)'', which tells this aspect what to
62 output for a given event. The singleton pattern fits well for pre-defined aspect
65 The aspects defined for a trace type determine the initial columns in the Event
66 Table, as well as the elements on which the trace can be filtered, among other
69 === Base and custom aspects ===
71 Some base aspects are defined in '''TmfTrace#BASE_ASPECTS'''. They use generic
72 methods found in '''ITmfEvent''', so they should be applicable for any event
73 type defined in the framework. If one does not override
74 '''TmfTrace#getEventAspects''', then only the base aspects will be used with
77 Overriding the method does not append to this list, it replaces it. So if you
78 wish to define additional aspects for a new trace type, do not forget to include
79 the BASE_ASPECTS you want to use, if any, within the list.
81 The order of the elements in the returned ''Iterable'' may matter to other
82 components. For instance, the initial ordering of the columns in the Events
85 Defining additional aspects allows to expose more data from the trace events
86 without having to update all the views using the aspects API.
88 === Creating event aspects programmatically ===
90 Another advantage of event aspects is that they can be created programmatically,
91 without having to modify the base trace or event classes. A new analysis
92 applying to a pre-existing trace type may wish to define additional aspects to
95 While the notion of event aspects should not be exposed to users directly, it is
96 possible to create new aspects based on user input. For example, an "event
97 field" dialog could ask the user to enter a field name, which would then create
98 an aspect that would look for the value of a field with this name in every
99 event. The user could then be able to display or filter on this aspect.
101 == Optional Trace Type Attributes ==
103 After defining the trace type as described in the previous chapters it is
104 possible to define optional attributes for the trace type.
106 === Default Editor ===
108 The '''defaultEditor''' attribute of the '''org.eclipse.linuxtools.tmf.ui.tracetypeui'''
109 extension point allows for configuring the editor to use for displaying the
110 events. If omitted, the ''TmfEventsEditor'' is used as default.
112 To configure an editor, first add the '''defaultEditor''' attribute to the trace
113 type in the extension definition. This can be done by selecting the trace type
114 in the plug-in manifest editor. Then click the right mouse button and select
115 '''New -> defaultEditor''' in the context sensitive menu. Then select the newly
116 added attribute. Now you can specify the editor id to use on the right side of
117 the manifest editor. For example, this attribute could be used to implement an
118 extension of the class ''org.eclipse.ui.part.MultiPageEditor''. The first page
119 could use the ''TmfEventsEditor''' to display the events in a table as usual and
120 other pages can display other aspects of the trace.
122 === Events Table Type ===
124 The '''eventsTableType''' attribute of the '''org.eclipse.linuxtools.tmf.ui.tracetypeui'''
125 extension point allows for configuring the events table class to use in the
126 default events editor. If omitted, the default events table will be used.
128 To configure a trace type specific events table, first add the
129 '''eventsTableType''' attribute to the trace type in the extension definition.
130 This can be done by selecting the trace type in the plug-in manifest editor.
131 Then click the right mouse button and select '''New -> eventsTableType''' in the
132 context sensitive menu. Then select the newly added attribute and click on
133 ''class'' on the right side of the manifest editor. The new class wizard will
134 open. The ''superclass'' field will be already filled with the class ''org.eclipse.tracecompass.tmf.ui.viewers.events.TmfEventsTable''.
136 By using this attribute, a table with different columns than the default columns
137 can be defined. See the class
138 ''org.eclipse.tracecompass.internal.gdbtrace.ui.views.events.GdbEventsTable''
139 for an example implementation.
141 == Other Considerations ==
143 Other views and components may provide additional features that are active only
144 when the event or trace type class implements certain additional interfaces.
146 === Collapsing of repetitive events ===
148 By implementing the interface
149 ''org.eclipse.tracecompass.tmf.core.event.collapse.ITmfCollapsibleEvent'' the
150 event table will allow to collapse repetitive events by selecting the menu item
151 '''Collapse Events''' after pressing the right mouse button in the table.
155 * Do not load the whole trace in RAM, it will limit the size of the trace that can be read.
156 * Reuse as much code as possible, it makes the trace format much easier to maintain.
157 * Use Eclipse's editor instead of editing the XML directly.
158 * Do not forget Java supports only signed data types, there may be special care needed to handle unsigned data.
159 * If the support for your trace has custom UI elements (like icons, views, etc.), split the core and UI parts in separate plugins, named identically except for a ''.core'' or ''.ui'' suffix.
160 ** Implement the ''tmf.core.tracetype'' extension in the core plugin, and the ''tmf.ui.tracetypeui'' extension in the UI plugin if applicable.
162 == An Example: Nexus-lite parser ==
164 === Description of the file ===
166 This is a very small subset of the nexus trace format, with some changes to make
167 it easier to read. There is one file. This file starts with 64 Strings
168 containing the event names, then an arbitrarily large number of events. The
169 events are each 64 bits long. the first 32 are the timestamp in microseconds,
170 the second 32 are split into 6 bits for the event type, and 26 for the data
173 The trace type will be made of two parts, part 1 is the event description, it is
174 just 64 strings, comma separated and then a line feed.
177 Startup,Stop,Load,Add, ... ,reserved\n
180 Then there will be the events in this format
183 |style="width: 50%; background-color: #ffffcc;"|timestamp (32 bits)
184 |style="width: 10%; background-color: #ffccff;"|type (6 bits)
185 |style="width: 40%; background-color: #ccffcc;"|payload (26 bits)
187 |style="background-color: #ffcccc;" colspan="3"|64 bits total
190 all events will be the same size (64 bits).
192 === NexusLite Plug-in ===
194 Create a '''New''', '''Project...''', '''Plug-in Project''', set the title to
195 '''com.example.nexuslite''', click '''Next >''' then click on '''Finish'''.
197 Now the structure for the Nexus trace Plug-in is set up.
199 Add a dependency to TMF core and UI by opening the '''MANIFEST.MF''' in
200 '''META-INF''', selecting the '''Dependencies''' tab and '''Add ...'''
201 '''org.eclipse.tracecompass.tmf.core''' and '''org.eclipse.tracecompass.tmf.ui'''.
203 [[Image:images/NTTAddDepend.png]]<br>
204 [[Image:images/NTTSelectProjects.png]]<br>
206 Now the project can access TMF classes.
210 The '''TmfEvent''' class will work for this example. No code required.
214 The trace reader will extend a '''TmfTrace''' class.
216 It will need to implement:
218 * validate (is the trace format valid?)
220 * initTrace (called as the trace is opened
222 * seekEvent (go to a position in the trace and create a context)
224 * getNext (implemented in the base class)
226 * parseEvent (read the next element in the trace)
228 For reference, there is an example implementation of the Nexus Trace file in
229 org.eclipse.tracecompass.tracing.examples.core.trace.nexus.NexusTrace.java.
231 In this example, the '''validate''' function first checks if the file
232 exists, then makes sure that it is really a file, and not a directory. Then we
233 attempt to read the file header, to make sure that it is really a Nexus Trace.
234 If that check passes, we return a TraceValidationStatus with a confidence of 20.
236 Typically, TraceValidationStatus confidences should range from 1 to 100. 1 meaning
237 "there is a very small chance that this trace is of this type", and 100 meaning
238 "it is this type for sure, and cannot be anything else". At run-time, the
239 auto-detection will pick the type which returned the highest confidence. So
240 checks of the type "does the file exist?" should not return a too high
241 confidence. If confidence 0 is returned the auto-detection won't pick this type.
243 Here we used a confidence of 20, to leave "room" for more specific trace types
244 in the Nexus format that could be defined in TMF.
246 The '''initTrace''' function will read the event names, and find where the data
247 starts. After this, the number of events is known, and since each event is 8
248 bytes long according to the specs, the seek is then trivial.
250 The '''seek''' here will just reset the reader to the right location.
252 The '''parseEvent''' method needs to parse and return the current event and
253 store the current location.
255 The '''getNext''' method (in base class) will read the next event and update the
256 context. It calls the '''parseEvent''' method to read the event and update the
257 location. It does not need to be overridden and in this example it is not. The
258 sequence of actions necessary are parse the next event from the trace, create an
259 '''ITmfEvent''' with that data, update the current location, call
260 '''updateAttributes''', update the context then return the event.
262 Traces will typically implement an index, to make seeking faster. The index can
263 be rebuilt every time the trace is opened. Alternatively, it can be saved to
264 disk, to make future openings of the same trace quicker. To do so, the trace
265 object can implement the '''ITmfPersistentlyIndexable''' interface.
267 === Trace Context ===
269 The trace context will be a '''TmfContext'''
271 === Trace Location ===
273 The trace location will be a long, representing the rank in the file. The
274 '''TmfLongLocation''' will be the used, once again, no code is required.
276 === The ''org.eclipse.linuxtools.tmf.core.tracetype'' and ''org.eclipse.linuxtools.tmf.ui.tracetypeui'' plug-in extension points ===
278 One should use the ''tmf.core.tracetype'' extension point in their own plug-in.
279 In this example, the Nexus trace plug-in will be modified.
281 The '''plugin.xml''' file in the ui plug-in needs to be updated if one wants
282 users to access the given event type. It can be updated in the Eclipse plug-in
285 # In Extensions tab, add the '''org.eclipse.linuxtools.tmf.core.tracetype''' extension point.
286 [[Image:images/NTTExtension.png]]<br>
287 [[Image:images/NTTTraceType.png]]<br>
288 [[Image:images/NTTExtensionPoint.png]]<br>
290 # Add in the '''org.eclipse.linuxtools.tmf.ui.tracetype''' extension a new type. To do that, '''right click''' on the extension then in the context menu, go to '''New >''', '''type'''.
292 [[Image:images/NTTAddType.png]]<br>
294 The '''id''' is the unique identifier used to refer to the trace.
296 The '''name''' is the field that shall be displayed when a trace type is selected.
298 The '''trace type''' is the canonical path refering to the class of the trace.
300 The '''event type''' is the canonical path refering to the class of the events of a given trace.
302 The '''category''' (optional) is the container in which this trace type will be stored.
304 # (Optional) To also add UI-specific properties to your trace type, use the '''org.eclipse.linuxtools.tmf.ui.tracetypeui''' extension. To do that, '''right click''' on the extension then in the context menu, go to '''New >''', '''type'''.
306 The '''tracetype''' here is the '''id''' of the
307 ''org.eclipse.linuxtools.tmf.core.tracetype'' mentioned above.
309 The '''icon''' is the image to associate with that trace type.
311 In the end, the extension menu should look like this.
313 [[Image:images/NTTPluginxmlComplete.png]]<br>
317 This tutorial describes how to create a simple view using the TMF framework and the SWTChart library. SWTChart is a library based on SWT that can draw several types of charts including a line chart which we will use in this tutorial. We will create a view containing a line chart that displays time stamps on the X axis and the corresponding event values on the Y axis.
319 This tutorial will cover concepts like:
322 * Signal handling (@TmfSignalHandler)
323 * Data requests (TmfEventRequest)
324 * SWTChart integration
326 '''Note''': Trace Compass 0.1.0 provides base implementations for generating SWTChart viewers and views. For more details please refer to chapter [[#TMF Built-in Views and Viewers]].
328 === Prerequisites ===
330 The tutorial is based on Eclipse 4.4 (Eclipse Luna), Trace Compass 0.1.0 and SWTChart 0.7.0. If you are using TMF from the source repository, SWTChart is already included in the target definition file (see org.eclipse.tracecompass.target). You can also install it manually by using the Orbit update site. http://download.eclipse.org/tools/orbit/downloads/
332 === Creating an Eclipse UI Plug-in ===
334 To create a new project with name org.eclipse.tracecompass.tmf.sample.ui select '''File -> New -> Project -> Plug-in Development -> Plug-in Project'''. <br>
335 [[Image:images/Screenshot-NewPlug-inProject1.png]]<br>
337 [[Image:images/Screenshot-NewPlug-inProject2.png]]<br>
339 [[Image:images/Screenshot-NewPlug-inProject3.png]]<br>
341 === Creating a View ===
343 To open the plug-in manifest, double-click on the MANIFEST.MF file. <br>
344 [[Image:images/SelectManifest.png]]<br>
346 Change to the Dependencies tab and select '''Add...''' of the ''Required Plug-ins'' section. A new dialog box will open. Next find plug-in ''org.eclipse.tracecompass.tmf.core'' and press '''OK'''<br>
347 Following the same steps, add ''org.eclipse.tracecompass.tmf.ui'' and ''org.swtchart''.<br>
348 [[Image:images/AddDependencyTmfUi.png]]<br>
350 Change to the Extensions tab and select '''Add...''' of the ''All Extension'' section. A new dialog box will open. Find the view extension ''org.eclipse.ui.views'' and press '''Finish'''.<br>
351 [[Image:images/AddViewExtension1.png]]<br>
353 To create a view, click the right mouse button. Then select '''New -> view'''<br>
354 [[Image:images/AddViewExtension2.png]]<br>
356 A new view entry has been created. Fill in the fields ''id'' and ''name''. For ''class'' click on the '''class hyperlink''' and it will show the New Java Class dialog. Enter the name ''SampleView'', change the superclass to ''TmfView'' and click Finish. This will create the source file and fill the ''class'' field in the process. We use TmfView as the superclass because it provides extra functionality like getting the active trace, pinning and it has support for signal handling between components.<br>
357 [[Image:images/FillSampleViewExtension.png]]<br>
359 This will generate an empty class. Once the quick fixes are applied, the following code is obtained:
362 package org.eclipse.tracecompass.tmf.sample.ui;
364 import org.eclipse.swt.widgets.Composite;
365 import org.eclipse.ui.part.ViewPart;
367 public class SampleView extends TmfView {
369 public SampleView(String viewName) {
371 // TODO Auto-generated constructor stub
375 public void createPartControl(Composite parent) {
376 // TODO Auto-generated method stub
381 public void setFocus() {
382 // TODO Auto-generated method stub
389 This creates an empty view, however the basic structure is now is place.
391 === Implementing a view ===
393 We will start by adding a empty chart then it will need to be populated with the trace data. Finally, we will make the chart more visually pleasing by adjusting the range and formating the time stamps.
395 ==== Adding an Empty Chart ====
397 First, we can add an empty chart to the view and initialize some of its components.
400 private static final String SERIES_NAME = "Series";
401 private static final String Y_AXIS_TITLE = "Signal";
402 private static final String X_AXIS_TITLE = "Time";
403 private static final String FIELD = "value"; // The name of the field that we want to display on the Y axis
404 private static final String VIEW_ID = "org.eclipse.tracecompass.tmf.sample.ui.view";
406 private ITmfTrace currentTrace;
408 public SampleView() {
413 public void createPartControl(Composite parent) {
414 chart = new Chart(parent, SWT.BORDER);
415 chart.getTitle().setVisible(false);
416 chart.getAxisSet().getXAxis(0).getTitle().setText(X_AXIS_TITLE);
417 chart.getAxisSet().getYAxis(0).getTitle().setText(Y_AXIS_TITLE);
418 chart.getSeriesSet().createSeries(SeriesType.LINE, SERIES_NAME);
419 chart.getLegend().setVisible(false);
423 public void setFocus() {
428 The view is prepared. Run the Example. To launch the an Eclipse Application select the ''Overview'' tab and click on '''Launch an Eclipse Application'''<br>
429 [[Image:images/RunEclipseApplication.png]]<br>
431 A new Eclipse application window will show. In the new window go to '''Windows -> Show View -> Other... -> Other -> Sample View'''.<br>
432 [[Image:images/ShowViewOther.png]]<br>
434 You should now see a view containing an empty chart<br>
435 [[Image:images/EmptySampleView.png]]<br>
437 ==== Signal Handling ====
439 We would like to populate the view when a trace is selected. To achieve this, we can use a signal hander which is specified with the '''@TmfSignalHandler''' annotation.
443 public void traceSelected(final TmfTraceSelectedSignal signal) {
448 ==== Requesting Data ====
450 Then we need to actually gather data from the trace. This is done asynchronously using a ''TmfEventRequest''
454 public void traceSelected(final TmfTraceSelectedSignal signal) {
455 // Don't populate the view again if we're already showing this trace
456 if (currentTrace == signal.getTrace()) {
459 currentTrace = signal.getTrace();
461 // Create the request to get data from the trace
463 TmfEventRequest req = new TmfEventRequest(TmfEvent.class,
464 TmfTimeRange.ETERNITY, 0, ITmfEventRequest.ALL_DATA,
465 ITmfEventRequest.ExecutionType.BACKGROUND) {
468 public void handleData(ITmfEvent data) {
469 // Called for each event
470 super.handleData(data);
474 public void handleSuccess() {
475 // Request successful, not more data available
476 super.handleSuccess();
480 public void handleFailure() {
481 // Request failed, not more data available
482 super.handleFailure();
485 ITmfTrace trace = signal.getTrace();
486 trace.sendRequest(req);
490 ==== Transferring Data to the Chart ====
492 The chart expects an array of doubles for both the X and Y axis values. To provide that, we can accumulate each event's time and value in their respective list then convert the list to arrays when all events are processed.
495 TmfEventRequest req = new TmfEventRequest(TmfEvent.class,
496 TmfTimeRange.ETERNITY, 0, ITmfEventRequest.ALL_DATA,
497 ITmfEventRequest.ExecutionType.BACKGROUND) {
499 ArrayList<Double> xValues = new ArrayList<Double>();
500 ArrayList<Double> yValues = new ArrayList<Double>();
503 public void handleData(ITmfEvent data) {
504 // Called for each event
505 super.handleData(data);
506 ITmfEventField field = data.getContent().getField(FIELD);
508 yValues.add((Double) field.getValue());
509 xValues.add((double) data.getTimestamp().getValue());
514 public void handleSuccess() {
515 // Request successful, not more data available
516 super.handleSuccess();
518 final double x[] = toArray(xValues);
519 final double y[] = toArray(yValues);
521 // This part needs to run on the UI thread since it updates the chart SWT control
522 Display.getDefault().asyncExec(new Runnable() {
526 chart.getSeriesSet().getSeries()[0].setXSeries(x);
527 chart.getSeriesSet().getSeries()[0].setYSeries(y);
536 * Convert List<Double> to double[]
538 private double[] toArray(List<Double> list) {
539 double[] d = new double[list.size()];
540 for (int i = 0; i < list.size(); ++i) {
549 ==== Adjusting the Range ====
551 The chart now contains values but they might be out of range and not visible. We can adjust the range of each axis by computing the minimum and maximum values as we add events.
555 ArrayList<Double> xValues = new ArrayList<Double>();
556 ArrayList<Double> yValues = new ArrayList<Double>();
557 private double maxY = -Double.MAX_VALUE;
558 private double minY = Double.MAX_VALUE;
559 private double maxX = -Double.MAX_VALUE;
560 private double minX = Double.MAX_VALUE;
563 public void handleData(ITmfEvent data) {
564 super.handleData(data);
565 ITmfEventField field = data.getContent().getField(FIELD);
567 Double yValue = (Double) field.getValue();
568 minY = Math.min(minY, yValue);
569 maxY = Math.max(maxY, yValue);
572 double xValue = (double) data.getTimestamp().getValue();
574 minX = Math.min(minX, xValue);
575 maxX = Math.max(maxX, xValue);
580 public void handleSuccess() {
581 super.handleSuccess();
582 final double x[] = toArray(xValues);
583 final double y[] = toArray(yValues);
585 // This part needs to run on the UI thread since it updates the chart SWT control
586 Display.getDefault().asyncExec(new Runnable() {
590 chart.getSeriesSet().getSeries()[0].setXSeries(x);
591 chart.getSeriesSet().getSeries()[0].setYSeries(y);
594 if (!xValues.isEmpty() && !yValues.isEmpty()) {
595 chart.getAxisSet().getXAxis(0).setRange(new Range(0, x[x.length - 1]));
596 chart.getAxisSet().getYAxis(0).setRange(new Range(minY, maxY));
598 chart.getAxisSet().getXAxis(0).setRange(new Range(0, 1));
599 chart.getAxisSet().getYAxis(0).setRange(new Range(0, 1));
601 chart.getAxisSet().adjustRange();
609 ==== Formatting the Time Stamps ====
611 To display the time stamps on the X axis nicely, we need to specify a format or else the time stamps will be displayed as ''long''. We use TmfTimestampFormat to make it consistent with the other TMF views. We also need to handle the '''TmfTimestampFormatUpdateSignal''' to make sure that the time stamps update when the preferences change.
615 public void createPartControl(Composite parent) {
618 chart.getAxisSet().getXAxis(0).getTick().setFormat(new TmfChartTimeStampFormat());
621 public class TmfChartTimeStampFormat extends SimpleDateFormat {
622 private static final long serialVersionUID = 1L;
624 public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) {
625 long time = date.getTime();
626 toAppendTo.append(TmfTimestampFormat.getDefaulTimeFormat().format(time));
632 public void timestampFormatUpdated(TmfTimestampFormatUpdateSignal signal) {
633 // Called when the time stamp preference is changed
634 chart.getAxisSet().getXAxis(0).getTick().setFormat(new TmfChartTimeStampFormat());
639 We also need to populate the view when a trace is already selected and the view is opened. We can reuse the same code by having the view send the '''TmfTraceSelectedSignal''' to itself.
643 public void createPartControl(Composite parent) {
646 ITmfTrace trace = getActiveTrace();
648 traceSelected(new TmfTraceSelectedSignal(this, trace));
653 The view is now ready but we need a proper trace to test it. For this example, a trace was generated using LTTng-UST so that it would produce a sine function.<br>
655 [[Image:images/SampleView.png]]<br>
657 In summary, we have implemented a simple TMF view using the SWTChart library. We made use of signals and requests to populate the view at the appropriate time and we formated the time stamps nicely. We also made sure that the time stamp format is updated when the preferences change.
659 == TMF Built-in Views and Viewers ==
661 TMF provides base implementations for several types of views and viewers for generating custom X-Y-Charts, Time Graphs, or Trees. They are well integrated with various TMF features such as reading traces and time synchronization with other views. They also handle mouse events for navigating the trace and view, zooming or presenting detailed information at mouse position. The code can be found in the TMF UI plug-in ''org.eclipse.tracecompass.tmf.ui''. See below for a list of relevant java packages:
664 ** ''org.eclipse.tracecompass.tmf.ui.views'': Common TMF view base classes
666 ** ''org.eclipse.tracecompass.tmf.ui.viewers.xycharts'': Common base classes for X-Y-Chart viewers based on SWTChart
667 ** ''org.eclipse.tracecompass.tmf.ui.viewers.xycharts.barcharts'': Base classes for bar charts
668 ** ''org.eclipse.tracecompass.tmf.ui.viewers.xycharts.linecharts'': Base classes for line charts
670 ** ''org.eclipse.tracecompass.tmf.ui.widgets.timegraph'': Base classes for time graphs e.g. Gantt-charts
672 ** ''org.eclipse.tracecompass.tmf.ui.viewers.tree'': Base classes for TMF specific tree viewers
674 Several features in TMF and the Eclipse LTTng integration are using this framework and can be used as example for further developments:
676 ** ''org.eclipse.tracecompass.internal.lttng2.ust.ui.views.memusage.MemUsageView.java''
677 ** ''org.eclipse.tracecompass.analysis.os.linux.ui.views.cpuusage.CpuUsageView.java''
678 ** ''org.eclipse.tracecompass.tracing.examples.ui.views.histogram.NewHistogramView.java''
680 ** ''org.eclipse.tracecompass.analysis.os.linux.ui.views.controlflow.ControlFlowView.java''
681 ** ''org.eclipse.tracecompass.analysis.os.linux.ui.views.resources.ResourcesView.java''
683 ** ''org.eclipse.tracecompass.tmf.ui.views.statesystem.TmfStateSystemExplorer.java''
684 ** ''org.eclipse.tracecompass.analysis.os.linux.ui.views.cpuusage.CpuUsageComposite.java''
686 = Component Interaction =
688 TMF provides a mechanism for different components to interact with each other using signals. The signals can carry information that is specific to each signal.
690 The TMF Signal Manager handles registration of components and the broadcasting of signals to their intended receivers.
692 Components can register as VIP receivers which will ensure they will receive the signal before non-VIP receivers.
694 == Sending Signals ==
696 In order to send a signal, an instance of the signal must be created and passed as argument to the signal manager to be dispatched. Every component that can handle the signal will receive it. The receivers do not need to be known by the sender.
699 TmfExampleSignal signal = new TmfExampleSignal(this, ...);
700 TmfSignalManager.dispatchSignal(signal);
703 If the sender is an instance of the class TmfComponent, the broadcast method can be used:
706 TmfExampleSignal signal = new TmfExampleSignal(this, ...);
710 == Receiving Signals ==
712 In order to receive any signal, the receiver must first be registered with the signal manager. The receiver can register as a normal or VIP receiver.
715 TmfSignalManager.register(this);
716 TmfSignalManager.registerVIP(this);
719 If the receiver is an instance of the class TmfComponent, it is automatically registered as a normal receiver in the constructor.
721 When the receiver is destroyed or disposed, it should deregister itself from the signal manager.
724 TmfSignalManager.deregister(this);
727 To actually receive and handle any specific signal, the receiver must use the @TmfSignalHandler annotation and implement a method that will be called when the signal is broadcast. The name of the method is irrelevant.
731 public void example(TmfExampleSignal signal) {
736 The source of the signal can be used, if necessary, by a component to filter out and ignore a signal that was broadcast by itself when the component is also a receiver of the signal but only needs to handle it when it was sent by another component or another instance of the component.
738 == Signal Throttling ==
740 It is possible for a TmfComponent instance to buffer the dispatching of signals so that only the last signal queued after a specified delay without any other signal queued is sent to the receivers. All signals that are preempted by a newer signal within the delay are discarded.
742 The signal throttler must first be initialized:
745 final int delay = 100; // in ms
746 TmfSignalThrottler throttler = new TmfSignalThrottler(this, delay);
749 Then the sending of signals should be queued through the throttler:
752 TmfExampleSignal signal = new TmfExampleSignal(this, ...);
753 throttler.queue(signal);
756 When the throttler is no longer needed, it should be disposed:
762 == Signal Reference ==
764 The following is a list of built-in signals defined in the framework.
766 === TmfStartSynchSignal ===
770 This signal is used to indicate the start of broadcasting of a signal. Internally, the data provider will not fire event requests until the corresponding TmfEndSynchSignal signal is received. This allows coalescing of requests triggered by multiple receivers of the broadcast signal.
774 Sent by TmfSignalManager before dispatching a signal to all receivers.
778 Received by TmfDataProvider.
780 === TmfEndSynchSignal ===
784 This signal is used to indicate the end of broadcasting of a signal. Internally, the data provider fire all pending event requests that were received and buffered since the corresponding TmfStartSynchSignal signal was received. This allows coalescing of requests triggered by multiple receivers of the broadcast signal.
788 Sent by TmfSignalManager after dispatching a signal to all receivers.
792 Received by TmfDataProvider.
794 === TmfTraceOpenedSignal ===
798 This signal is used to indicate that a trace has been opened in an editor.
802 Sent by a TmfEventsEditor instance when it is created.
806 Received by TmfTrace, TmfExperiment, TmfTraceManager and every view that shows trace data. Components that show trace data should handle this signal.
808 === TmfTraceSelectedSignal ===
812 This signal is used to indicate that a trace has become the currently selected trace.
816 Sent by a TmfEventsEditor instance when it receives focus. Components can send this signal to make a trace editor be brought to front.
820 Received by TmfTraceManager and every view that shows trace data. Components that show trace data should handle this signal.
822 === TmfTraceClosedSignal ===
826 This signal is used to indicate that a trace editor has been closed.
830 Sent by a TmfEventsEditor instance when it is disposed.
834 Received by TmfTraceManager and every view that shows trace data. Components that show trace data should handle this signal.
836 === TmfTraceRangeUpdatedSignal ===
840 This signal is used to indicate that the valid time range of a trace has been updated. This triggers indexing of the trace up to the end of the range. In the context of streaming, this end time is considered a safe time up to which all events are guaranteed to have been completely received. For non-streaming traces, the end time is set to infinity indicating that all events can be read immediately. Any processing of trace events that wants to take advantage of request coalescing should be triggered by this signal.
844 Sent by TmfExperiment and non-streaming TmfTrace. Streaming traces should send this signal in the TmfTrace subclass when a new safe time is determined by a specific implementation.
848 Received by TmfTrace, TmfExperiment and components that process trace events. Components that need to process trace events should handle this signal.
850 === TmfTraceUpdatedSignal ===
854 This signal is used to indicate that new events have been indexed for a trace.
858 Sent by TmfCheckpointIndexer when new events have been indexed and the number of events has changed.
862 Received by components that need to be notified of a new trace event count.
864 === TmfSelectionRangeUpdatedSignal ===
868 This signal is used to indicate that a new time or time range has been
869 selected. It contains a begin and end time. If a single time is selected then
870 the begin and end time are the same.
874 Sent by any component that allows the user to select a time or time range.
878 Received by any component that needs to be notified of the currently selected time or time range.
880 === TmfWindowRangeUpdatedSignal ===
884 This signal is used to indicate that a new time range window has been set.
888 Sent by any component that allows the user to set a time range window.
892 Received by any component that needs to be notified of the current visible time range window.
894 === TmfEventFilterAppliedSignal ===
898 This signal is used to indicate that a filter has been applied to a trace.
902 Sent by TmfEventsTable when a filter is applied.
906 Received by any component that shows trace data and needs to be notified of applied filters.
908 === TmfEventSearchAppliedSignal ===
912 This signal is used to indicate that a search has been applied to a trace.
916 Sent by TmfEventsTable when a search is applied.
920 Received by any component that shows trace data and needs to be notified of applied searches.
922 === TmfTimestampFormatUpdateSignal ===
926 This signal is used to indicate that the timestamp format preference has been updated.
930 Sent by TmfTimestampFormat when the default timestamp format preference is changed.
934 Received by any component that needs to refresh its display for the new timestamp format.
936 === TmfStatsUpdatedSignal ===
940 This signal is used to indicate that the statistics data model has been updated.
944 Sent by statistic providers when new statistics data has been processed.
948 Received by statistics viewers and any component that needs to be notified of a statistics update.
950 === TmfPacketStreamSelected ===
954 This signal is used to indicate that the user has selected a packet stream to analyze.
958 Sent by the Stream List View when the user selects a new packet stream.
962 Received by views that analyze packet streams.
966 TMF has built-in Eclipse tracing support for the debugging of signal interaction between components. To enable it, open the '''Run/Debug Configuration...''' dialog, select a configuration, click the '''Tracing''' tab, select the plug-in '''org.eclipse.tracecompass.tmf.core''', and check the '''signal''' item.
968 All signals sent and received will be logged to the file TmfTrace.log located in the Eclipse home directory.
970 = Generic State System =
974 The Generic State System is a utility available in TMF to track different states
975 over the duration of a trace. It works by first sending some or all events of
976 the trace into a state provider, which defines the state changes for a given
977 trace type. Once built, views and analysis modules can then query the resulting
978 database of states (called "state history") to get information.
980 For example, let's suppose we have the following sequence of events in a kernel
983 10 s, sys_open, fd = 5, file = /home/user/myfile
985 15 s, sys_read, fd = 5, size=32
987 20 s, sys_close, fd = 5
989 Now let's say we want to implement an analysis module which will track the
990 amount of bytes read and written to each file. Here, of course the sys_read is
991 interesting. However, by just looking at that event, we have no information on
992 which file is being read, only its fd (5) is known. To get the match
993 fd5 = /home/user/myfile, we have to go back to the sys_open event which happens
996 But since we don't know exactly where this sys_open event is, we will have to go
997 back to the very start of the trace, and look through events one by one! This is
998 obviously not efficient, and will not scale well if we want to analyze many
999 similar patterns, or for very large traces.
1001 A solution in this case would be to use the state system to keep track of the
1002 amount of bytes read/written to every *filename* (instead of every file
1003 descriptor, like we get from the events). Then the module could ask the state
1004 system "what is the amount of bytes read for file "/home/user/myfile" at time
1005 16 s", and it would return the answer "32" (assuming there is no other read
1006 than the one shown).
1008 == High-level components ==
1010 The State System infrastructure is composed of 3 parts:
1011 * The state provider
1012 * The central state system
1013 * The storage backend
1015 The state provider is the customizable part. This is where the mapping from
1016 trace events to state changes is done. This is what you want to implement for
1017 your specific trace type and analysis type. It's represented by the
1018 ITmfStateProvider interface (with a threaded implementation in
1019 AbstractTmfStateProvider, which you can extend).
1021 The core of the state system is exposed through the ITmfStateSystem and
1022 ITmfStateSystemBuilder interfaces. The former allows only read-only access and
1023 is typically used for views doing queries. The latter also allows writing to the
1024 state history, and is typically used by the state provider.
1026 Finally, each state system has its own separate backend. This determines how the
1027 intervals, or the "state history", are saved (in RAM, on disk, etc.) You can
1028 select the type of backend at construction time in the TmfStateSystemFactory.
1032 Before we dig into how to use the state system, we should go over some useful
1037 An attribute is the smallest element of the model that can be in any particular
1038 state. When we refer to the "full state", in fact it means we are interested in
1039 the state of every single attribute of the model.
1041 === Attribute Tree ===
1043 Attributes in the model can be placed in a tree-like structure, a bit like files
1044 and directories in a file system. However, note that an attribute can always
1045 have both a value and sub-attributes, so they are like files and directories at
1046 the same time. We are then able to refer to every single attribute with its
1049 For example, in the attribute tree for Linux kernel traces, we use the following
1050 attributes, among others:
1068 In this model, the attribute "Processes/1000/PPID" refers to the PPID of process
1069 with PID 1000. The attribute "CPUs/0/Status" represents the status (running,
1070 idle, etc.) of CPU 0. "Processes/1000/PPID" and "Processes/1001/PPID" are two
1071 different attribute, even though their base name is the same: the whole path is
1072 the unique identifier.
1074 The value of each attribute can change over the duration of the trace,
1075 independently of the other ones, and independently of its position in the tree.
1077 The tree-like organization is optional, all attributes could be at the same
1078 level. But it's possible to put them in a tree, and it helps make things
1083 In addition to a given path, each attribute also has a unique integer
1084 identifier, called the "quark". To continue with the file system analogy, this
1085 is like the inode number. When a new attribute is created, a new unique quark
1086 will be assigned automatically. They are assigned incrementally, so they will
1087 normally be equal to their order of creation, starting at 0.
1089 Methods are offered to get the quark of an attribute from its path. The API
1090 methods for inserting state changes and doing queries normally use quarks
1091 instead of paths. This is to encourage users to cache the quarks and re-use
1092 them, which avoids re-walking the attribute tree over and over, which avoids
1093 unneeded hashing of strings.
1097 The path and quark of an attribute will remain constant for the whole duration
1098 of the trace. However, the value carried by the attribute will change. The value
1099 of a specific attribute at a specific time is called the state value.
1101 In the TMF implementation, state values can be integers, longs, doubles, or strings.
1102 There is also a "null value" type, which is used to indicate that no particular
1103 value is active for this attribute at this time, but without resorting to a
1106 Any other type of value could be used, as long as the backend knows how to store
1109 Note that the TMF implementation also forces every attribute to always carry the
1110 same type of state value. This is to make it simpler for views, so they can
1111 expect that an attribute will always use a given type, without having to check
1112 every single time. Null values are an exception, they are always allowed for all
1113 attributes, since they can safely be "unboxed" into all types.
1115 === State change ===
1117 A state change is the element that is inserted in the state system. It consists
1119 * a timestamp (the time at which the state change occurs)
1120 * an attribute (the attribute whose value will change)
1121 * a state value (the new value that the attribute will carry)
1123 It's not an object per se in the TMF implementation (it's represented by a
1124 function call in the state provider). Typically, the state provider will insert
1125 zero, one or more state changes for every trace event, depending on its event
1128 Note, we use "timestamp" here, but it's in fact a generic term that could be
1129 referred to as "index". For example, if a given trace type has no notion of
1130 timestamp, the event rank could be used.
1132 In the TMF implementation, the timestamp is a long (64-bit integer).
1134 === State interval ===
1136 State changes are inserted into the state system, but state intervals are the
1137 objects that come out on the other side. Those are stocked in the storage
1138 backend. A state interval represents a "state" of an attribute we want to track.
1139 When doing queries on the state system, intervals are what is returned. The
1140 components of a state interval are:
1146 The start and end times represent the time range of the state. The state value
1147 is the same as the state value in the state change that started this interval.
1148 The interval also keeps a reference to its quark, although you normally know
1149 your quark in advance when you do queries.
1151 === State history ===
1153 The state history is the name of the container for all the intervals created by
1154 the state system. The exact implementation (how the intervals are stored) is
1155 determined by the storage backend that is used.
1157 Some backends will use a state history that is peristent on disk, others do not.
1158 When loading a trace, if a history file is available and the backend supports
1159 it, it will be loaded right away, skipping the need to go through another
1162 === Construction phase ===
1164 Before we can query a state system, we need to build the state history first. To
1165 do so, trace events are sent one-by-one through the state provider, which in
1166 turn sends state changes to the central component, which then creates intervals
1167 and stores them in the backend. This is called the construction phase.
1169 Note that the state system needs to receive its events into chronological order.
1170 This phase will end once the end of the trace is reached.
1172 Also note that it is possible to query the state system while it is being build.
1173 Any timestamp between the start of the trace and the current end time of the
1174 state system (available with ITmfStateSystem#getCurrentEndTime()) is a valid
1175 timestamp that can be queried.
1179 As mentioned previously, when doing queries on the state system, the returned
1180 objects will be state intervals. In most cases it's the state *value* we are
1181 interested in, but since the backend has to instantiate the interval object
1182 anyway, there is no additional cost to return the interval instead. This way we
1183 also get the start and end times of the state "for free".
1185 There are two types of queries that can be done on the state system:
1187 ==== Full queries ====
1189 A full query means that we want to retrieve the whole state of the model for one
1190 given timestamp. As we remember, this means "the state of every single attribute
1191 in the model". As parameter we only need to pass the timestamp (see the API
1192 methods below). The return value will be an array of intervals, where the offset
1193 in the array represents the quark of each attribute.
1195 ==== Single queries ====
1197 In other cases, we might only be interested in the state of one particular
1198 attribute at one given timestamp. For these cases it's better to use a
1199 single query. For a single query. we need to pass both a timestamp and a
1200 quark in parameter. The return value will be a single interval, representing
1201 the state that this particular attribute was at that time.
1203 Single queries are typically faster than full queries (but once again, this
1204 depends on the backend that is used), but not by much. Even if you only want the
1205 state of say 10 attributes out of 200, it could be faster to use a full query
1206 and only read the ones you need. Single queries should be used for cases where
1207 you only want one attribute per timestamp (for example, if you follow the state
1208 of the same attribute over a time range).
1211 == Relevant interfaces/classes ==
1213 This section will describe the public interface and classes that can be used if
1214 you want to use the state system.
1216 === Main classes in org.eclipse.tracecompass.tmf.core.statesystem ===
1218 ==== ITmfStateProvider / AbstractTmfStateProvider ====
1220 ITmfStateProvider is the interface you have to implement to define your state
1221 provider. This is where most of the work has to be done to use a state system
1222 for a custom trace type or analysis type.
1224 For first-time users, it's recommended to extend AbstractTmfStateProvider
1225 instead. This class takes care of all the initialization mumbo-jumbo, and also
1226 runs the event handler in a separate thread. You will only need to implement
1227 eventHandle, which is the call-back that will be called for every event in the
1230 For an example, you can look at StatsStateProvider in the TMF tree, or at the
1231 small example below.
1233 ==== TmfStateSystemFactory ====
1235 Once you have defined your state provider, you need to tell your trace type to
1236 build a state system with this provider during its initialization. This consists
1237 of overriding TmfTrace#buildStateSystems() and in there of calling the method in
1238 TmfStateSystemFactory that corresponds to the storage backend you want to use
1239 (see the section [[#Comparison of state system backends]]).
1241 You will have to pass in parameter the state provider you want to use, which you
1242 should have defined already. Each backend can also ask for more configuration
1245 You must then call registerStateSystem(id, statesystem) to make your state
1246 system visible to the trace objects and the views. The ID can be any string of
1247 your choosing. To access this particular state system, the views or modules will
1248 need to use this ID.
1250 Also, don't forget to call super.buildStateSystems() in your implementation,
1251 unless you know for sure you want to skip the state providers built by the
1254 You can look at how LttngKernelTrace does it for an example. It could also be
1255 possible to build a state system only under certain conditions (like only if the
1256 trace contains certain event types).
1259 ==== ITmfStateSystem ====
1261 ITmfStateSystem is the main interface through which views or analysis modules
1262 will access the state system. It offers a read-only view of the state system,
1263 which means that no states can be inserted, and no attributes can be created.
1264 Calling TmfTrace#getStateSystems().get(id) will return you a ITmfStateSystem
1265 view of the requested state system. The main methods of interest are:
1267 ===== getQuarkAbsolute()/getQuarkRelative() =====
1269 Those are the basic quark-getting methods. The goal of the state system is to
1270 return the state values of given attributes at given timestamps. As we've seen
1271 earlier, attributes can be described with a file-system-like path. The goal of
1272 these methods is to convert from the path representation of the attribute to its
1275 Since quarks are created on-the-fly, there is no guarantee that the same
1276 attributes will have the same quark for two traces of the same type. The views
1277 should always query their quarks when dealing with a new trace or a new state
1278 provider. Beyond that however, quarks should be cached and reused as much as
1279 possible, to avoid potentially costly string re-hashing.
1281 getQuarkAbsolute() takes a variable amount of Strings in parameter, which
1282 represent the full path to the attribute. Some of them can be constants, some
1283 can come programatically, often from the event's fields.
1285 getQuarkRelative() is to be used when you already know the quark of a certain
1286 attribute, and want to access on of its sub-attributes. Its first parameter is
1287 the origin quark, followed by a String varagrs which represent the relative path
1288 to the final attribute.
1290 These two methods will throw an AttributeNotFoundException if trying to access
1291 an attribute that does not exist in the model.
1293 These methods also imply that the view has the knowledge of how the attribute
1294 tree is organized. This should be a reasonable hypothesis, since the same
1295 analysis plugin will normally ship both the state provider and the view, and
1296 they will have been written by the same person. In other cases, it's possible to
1297 use getSubAttributes() to explore the organization of the attribute tree first.
1299 ===== waitUntilBuilt() =====
1301 This is a simple method used to block the caller until the construction phase of
1302 this state system is done. If the view prefers to wait until all information is
1303 available before starting to do queries (to get all known attributes right away,
1304 for example), this is the guy to call.
1306 ===== queryFullState() =====
1308 This is the method to do full queries. As mentioned earlier, you only need to
1309 pass a target timestamp in parameter. It will return a List of state intervals,
1310 in which the offset corresponds to the attribute quark. This will represent the
1311 complete state of the model at the requested time.
1313 ===== querySingleState() =====
1315 The method to do single queries. You pass in parameter both a timestamp and an
1316 attribute quark. This will return the single state matching this
1317 timestamp/attribute pair.
1319 Other methods are available, you are encouraged to read their Javadoc and see if
1320 they can be potentially useful.
1322 ==== ITmfStateSystemBuilder ====
1324 ITmfStateSystemBuilder is the read-write interface to the state system. It
1325 extends ITmfStateSystem itself, so all its methods are available. It then adds
1326 methods that can be used to write to the state system, either by creating new
1327 attributes of inserting state changes.
1329 It is normally reserved for the state provider and should not be visible to
1330 external components. However it will be available in AbstractTmfStateProvider,
1331 in the field 'ss'. That way you can call ss.modifyAttribute() etc. in your state
1332 provider to write to the state.
1334 The main methods of interest are:
1336 ===== getQuark*AndAdd() =====
1338 getQuarkAbsoluteAndAdd() and getQuarkRelativeAndAdd() work exactly like their
1339 non-AndAdd counterparts in ITmfStateSystem. The difference is that the -AndAdd
1340 versions will not throw any exception: if the requested attribute path does not
1341 exist in the system, it will be created, and its newly-assigned quark will be
1344 When in a state provider, the -AndAdd version should normally be used (unless
1345 you know for sure the attribute already exist and don't want to create it
1346 otherwise). This means that there is no need to define the whole attribute tree
1347 in advance, the attributes will be created on-demand.
1349 ===== modifyAttribute() =====
1351 This is the main state-change-insertion method. As was explained before, a state
1352 change is defined by a timestamp, an attribute and a state value. Those three
1353 elements need to be passed to modifyAttribute as parameters.
1355 Other state change insertion methods are available (increment-, push-, pop- and
1356 removeAttribute()), but those are simply convenience wrappers around
1357 modifyAttribute(). Check their Javadoc for more information.
1359 ===== closeHistory() =====
1361 When the construction phase is done, do not forget to call closeHistory() to
1362 tell the backend that no more intervals will be received. Depending on the
1363 backend type, it might have to save files, close descriptors, etc. This ensures
1364 that a persitent file can then be re-used when the trace is opened again.
1366 If you use the AbstractTmfStateProvider, it will call closeHistory()
1367 automatically when it reaches the end of the trace.
1369 === Other relevant interfaces ===
1371 ==== ITmfStateValue ====
1373 This is the interface used to represent state values. Those are used when
1374 inserting state changes in the provider, and is also part of the state intervals
1375 obtained when doing queries.
1377 The abstract TmfStateValue class contains the factory methods to create new
1378 state values of either int, long, double or string types. To retrieve the real
1379 object inside the state value, one can use the .unbox* methods.
1381 Note: Do not instantiate null values manually, use TmfStateValue.nullValue()
1383 ==== ITmfStateInterval ====
1385 This is the interface to represent the state intervals, which are stored in the
1386 state history backend, and are returned when doing state system queries. A very
1387 simple implementation is available in TmfStateInterval. Its methods should be
1392 The following exceptions, found in o.e.t.statesystem.core.exceptions, are related to
1393 state system activities.
1395 ==== AttributeNotFoundException ====
1397 This is thrown by getQuarkRelative() and getQuarkAbsolute() (but not byt the
1398 -AndAdd versions!) when passing an attribute path that is not present in the
1399 state system. This is to ensure that no new attribute is created when using
1400 these versions of the methods.
1402 Views can expect some attributes to be present, but they should handle these
1403 exceptions for when the attributes end up not being in the state system (perhaps
1404 this particular trace didn't have a certain type of events, etc.)
1406 ==== StateValueTypeException ====
1408 This exception will be thrown when trying to unbox a state value into a type
1409 different than its own. You should always check with ITmfStateValue#getType()
1410 beforehand if you are not sure about the type of a given state value.
1412 ==== TimeRangeException ====
1414 This exception is thrown when trying to do a query on the state system for a
1415 timestamp that is outside of its range. To be safe, you should check with
1416 ITmfStateSystem#getStartTime() and #getCurrentEndTime() for the current valid
1417 range of the state system. This is especially important when doing queries on
1418 a state system that is currently being built.
1420 ==== StateSystemDisposedException ====
1422 This exception is thrown when trying to access a state system that has been
1423 disposed, with its dispose() method. This can potentially happen at shutdown,
1424 since Eclipse is not always consistent with the order in which the components
1428 == Comparison of state system backends ==
1430 As we have seen in section [[#High-level components]], the state system needs
1431 a storage backend to save the intervals. Different implementations are
1432 available when building your state system from TmfStateSystemFactory.
1434 Do not confuse full/single queries with full/partial history! All backend types
1435 should be able to handle any type of queries defined in the ITmfStateSystem API,
1436 unless noted otherwise.
1438 === Full history ===
1440 Available with TmfStateSystemFactory#newFullHistory(). The full history uses a
1441 History Tree data structure, which is an optimized structure store state
1442 intervals on disk. Once built, it can respond to queries in a ''log(n)'' manner.
1444 You need to specify a file at creation time, which will be the container for
1445 the history tree. Once it's completely built, it will remain on disk (until you
1446 delete the trace from the project). This way it can be reused from one session
1447 to another, which makes subsequent loading time much faster.
1449 This the backend used by the LTTng kernel plugin. It offers good scalability and
1450 performance, even at extreme sizes (it's been tested with traces of sizes up to
1451 500 GB). Its main downside is the amount of disk space required: since every
1452 single interval is written to disk, the size of the history file can quite
1453 easily reach and even surpass the size of the trace itself.
1455 === Null history ===
1457 Available with TmfStateSystemFactory#newNullHistory(). As its name implies the
1458 null history is in fact an absence of state history. All its query methods will
1459 return null (see the Javadoc in NullBackend).
1461 Obviously, no file is required, and almost no memory space is used.
1463 It's meant to be used in cases where you are not interested in past states, but
1464 only in the "ongoing" one. It can also be useful for debugging and benchmarking.
1466 === In-memory history ===
1468 Available with TmfStateSystemFactory#newInMemHistory(). This is a simple wrapper
1469 using a TreeSet to store all state intervals in memory. The implementation at
1470 the moment is quite simple, it will perform a binary search on entries when
1471 doing queries to find the ones that match.
1473 The advantage of this method is that it's very quick to build and query, since
1474 all the information resides in memory. However, you are limited to 2^31 entries
1475 (roughly 2 billions), and depending on your state provider and trace type, that
1476 can happen really fast!
1478 There are no safeguards, so if you bust the limit you will end up with
1479 ArrayOutOfBoundsException's everywhere. If your trace or state history can be
1480 arbitrarily big, it's probably safer to use a Full History instead.
1482 === Partial history ===
1484 Available with TmfStateSystemFactory#newPartialHistory(). The partial history is
1485 a more advanced form of the full history. Instead of writing all state intervals
1486 to disk like with the full history, we only write a small fraction of them, and
1487 go back to read the trace to recreate the states in-between.
1489 It has a big advantage over a full history in terms of disk space usage. It's
1490 very possible to reduce the history tree file size by a factor of 1000, while
1491 keeping query times within a factor of two. Its main downside comes from the
1492 fact that you cannot do efficient single queries with it (they are implemented
1493 by doing full queries underneath).
1495 This makes it a poor choice for views like the Control Flow view, where you do
1496 a lot of range queries and single queries. However, it is a perfect fit for
1497 cases like statistics, where you usually do full queries already, and you store
1498 lots of small states which are very easy to "compress".
1500 However, it can't really be used until bug 409630 is fixed.
1502 == State System Operations ==
1504 TmfStateSystemOperations is a static class that implements additional
1505 statistical operations that can be performed on attributes of the state system.
1507 These operations require that the attribute be one of the numerical values
1508 (int, long or double).
1510 The speed of these operations can be greatly improved for large data sets if
1511 the attribute was inserted in the state system as a mipmap attribute. Refer to
1512 the [[#Mipmap feature | Mipmap feature]] section.
1514 ===== queryRangeMax() =====
1516 This method returns the maximum numerical value of an attribute in the
1517 specified time range. The attribute must be of type int, long or double.
1518 Null values are ignored. The returned value will be of the same state value
1519 type as the base attribute, or a null value if there is no state interval
1520 stored in the given time range.
1522 ===== queryRangeMin() =====
1524 This method returns the minimum numerical value of an attribute in the
1525 specified time range. The attribute must be of type int, long or double.
1526 Null values are ignored. The returned value will be of the same state value
1527 type as the base attribute, or a null value if there is no state interval
1528 stored in the given time range.
1530 ===== queryRangeAverage() =====
1532 This method returns the average numerical value of an attribute in the
1533 specified time range. The attribute must be of type int, long or double.
1534 Each state interval value is weighted according to time. Null values are
1535 counted as zero. The returned value will be a double primitive, which will
1536 be zero if there is no state interval stored in the given time range.
1540 Here is a small example of code that will use the state system. For this
1541 example, let's assume we want to track the state of all the CPUs in a LTTng
1542 kernel trace. To do so, we will watch for the "sched_switch" event in the state
1543 provider, and will update an attribute indicating if the associated CPU should
1544 be set to "running" or "idle".
1546 We will use an attribute tree that looks like this:
1560 The second-level attributes will be named from the information available in the
1561 trace events. Only the "Status" attributes will carry a state value (this means
1562 we could have just used "1", "2", "3",... directly, but we'll do it in a tree
1563 for the example's sake).
1565 Also, we will use integer state values to represent "running" or "idle", instead
1566 of saving the strings that would get repeated every time. This will help in
1567 reducing the size of the history file.
1569 First we will define a state provider in MyStateProvider. Then, we define an
1570 analysis module that takes care of creating the state provider. The analysis
1571 module will also contain code that can query the state system.
1573 === State Provider ===
1576 import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException;
1577 import org.eclipse.tracecompass.statesystem.core.exceptions.StateValueTypeException;
1578 import org.eclipse.tracecompass.statesystem.core.exceptions.TimeRangeException;
1579 import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue;
1580 import org.eclipse.tracecompass.statesystem.core.statevalue.TmfStateValue;
1581 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
1582 import org.eclipse.tracecompass.tmf.core.statesystem.AbstractTmfStateProvider;
1583 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
1584 import org.eclipse.tracecompass.tmf.ctf.core.event.CtfTmfEvent;
1587 * Example state system provider.
1589 * @author Alexandre Montplaisir
1591 public class MyStateProvider extends AbstractTmfStateProvider {
1593 /** State value representing the idle state */
1594 public static ITmfStateValue IDLE = TmfStateValue.newValueInt(0);
1596 /** State value representing the running state */
1597 public static ITmfStateValue RUNNING = TmfStateValue.newValueInt(1);
1603 * The trace to which this state provider is associated
1605 public MyStateProvider(ITmfTrace trace) {
1606 super(trace, CtfTmfEvent.class, "Example"); //$NON-NLS-1$
1608 * The third parameter here is not important, it's only used to name a
1609 * thread internally.
1614 public int getVersion() {
1616 * If the version of an existing file doesn't match the version supplied
1617 * in the provider, a rebuild of the history will be forced.
1623 public MyStateProvider getNewInstance() {
1624 return new MyStateProvider(getTrace());
1628 protected void eventHandle(ITmfEvent ev) {
1630 * AbstractStateChangeInput should have already checked for the correct
1633 CtfTmfEvent event = (CtfTmfEvent) ev;
1635 final long ts = event.getTimestamp().getValue();
1636 Integer nextTid = ((Long) event.getContent().getField("next_tid").getValue()).intValue();
1640 if (event.getType().getName().equals("sched_switch")) {
1641 ITmfStateSystemBuilder ss = getStateSystemBuilder();
1642 int quark = ss.getQuarkAbsoluteAndAdd("CPUs", String.valueOf(event.getCPU()), "Status");
1643 ITmfStateValue value;
1649 ss.modifyAttribute(ts, value, quark);
1652 } catch (TimeRangeException e) {
1654 * This should not happen, since the timestamp comes from a trace
1657 throw new IllegalStateException(e);
1658 } catch (AttributeNotFoundException e) {
1660 * This should not happen either, since we're only accessing a quark
1663 throw new IllegalStateException(e);
1664 } catch (StateValueTypeException e) {
1666 * This wouldn't happen here, but could potentially happen if we try
1667 * to insert mismatching state value types in the same attribute.
1669 e.printStackTrace();
1677 === Analysis module definition ===
1680 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
1682 import java.util.List;
1684 import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException;
1685 import org.eclipse.tracecompass.statesystem.core.exceptions.StateSystemDisposedException;
1686 import org.eclipse.tracecompass.statesystem.core.exceptions.TimeRangeException;
1687 import org.eclipse.tracecompass.statesystem.core.interval.ITmfStateInterval;
1688 import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue;
1689 import org.eclipse.tracecompass.tmf.core.statesystem.ITmfStateProvider;
1690 import org.eclipse.tracecompass.tmf.core.statesystem.TmfStateSystemAnalysisModule;
1691 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
1694 * Class showing examples of a StateSystemAnalysisModule with state system queries.
1696 * @author Alexandre Montplaisir
1698 public class MyStateSystemAnalysisModule extends TmfStateSystemAnalysisModule {
1701 protected ITmfStateProvider createStateProvider() {
1702 ITmfTrace trace = checkNotNull(getTrace());
1703 return new MyStateProvider(trace);
1707 protected StateSystemBackendType getBackendType() {
1708 return StateSystemBackendType.FULL;
1712 * Example method of querying one attribute in the state system.
1714 * We pass it a cpu and a timestamp, and it returns us if that cpu was
1715 * executing a process (true/false) at that time.
1720 * The timestamp of the query
1721 * @return True if the CPU was running, false otherwise
1723 public boolean cpuIsRunning(int cpu, long timestamp) {
1725 int quark = getStateSystem().getQuarkAbsolute("CPUs", String.valueOf(cpu), "Status");
1726 ITmfStateValue value = getStateSystem().querySingleState(timestamp, quark).getStateValue();
1728 if (value.equals(MyStateProvider.RUNNING)) {
1733 * Since at this level we have no guarantee on the contents of the state
1734 * system, it's important to handle these cases correctly.
1736 } catch (AttributeNotFoundException e) {
1738 * Handle the case where the attribute does not exist in the state
1739 * system (no CPU with this number, etc.)
1741 } catch (TimeRangeException e) {
1743 * Handle the case where 'timestamp' is outside of the range of the
1746 } catch (StateSystemDisposedException e) {
1748 * Handle the case where the state system is being disposed. If this
1749 * happens, it's normally when shutting down, so the view can just
1750 * return immediately and wait it out.
1758 * Example method of using a full query.
1760 * We pass it a timestamp, and it returns us how many CPUs were executing a
1761 * process at that moment.
1764 * The target timestamp
1765 * @return The amount of CPUs that were running at that time
1767 public int getNbRunningCpus(long timestamp) {
1771 /* Get the list of the quarks we are interested in. */
1772 List<Integer> quarks = getStateSystem().getQuarks("CPUs", "*", "Status");
1775 * Get the full state at our target timestamp (it's better than
1776 * doing an arbitrary number of single queries).
1778 List<ITmfStateInterval> state = getStateSystem().queryFullState(timestamp);
1780 /* Look at the value of the state for each quark */
1781 for (Integer quark : quarks) {
1782 ITmfStateValue value = state.get(quark).getStateValue();
1783 if (value.equals(MyStateProvider.RUNNING)) {
1788 } catch (TimeRangeException e) {
1790 * Handle the case where 'timestamp' is outside of the range of the
1793 } catch (StateSystemDisposedException e) {
1794 /* Handle the case where the state system is being disposed. */
1801 == Mipmap feature ==
1803 The mipmap feature allows attributes to be inserted into the state system with
1804 additional computations performed to automatically store sub-attributes that
1805 can later be used for statistical operations. The mipmap has a resolution which
1806 represents the number of state attribute changes that are used to compute the
1807 value at the next mipmap level.
1809 The supported mipmap features are: max, min, and average. Each one of these
1810 features requires that the base attribute be a numerical state value (int, long
1811 or double). An attribute can be mipmapped for one or more of the features at
1814 To use a mipmapped attribute in queries, call the corresponding methods of the
1815 static class [[#State System Operations | TmfStateSystemOperations]].
1817 === AbstractTmfMipmapStateProvider ===
1819 AbstractTmfMipmapStateProvider is an abstract provider class that allows adding
1820 features to a specific attribute into a mipmap tree. It extends AbstractTmfStateProvider.
1822 If a provider wants to add mipmapped attributes to its tree, it must extend
1823 AbstractTmfMipmapStateProvider and call modifyMipmapAttribute() in the event
1824 handler, specifying one or more mipmap features to compute. Then the structure
1825 of the attribute tree will be :
1829 | |- <mipmapFeature> (min/max/avg)
1834 | | |- n (maximum mipmap level)
1835 | |- <mipmapFeature> (min/max/avg)
1840 | | |- n (maximum mipmap level)
1844 = UML2 Sequence Diagram Framework =
1846 The purpose of the UML2 Sequence Diagram Framework of TMF is to provide a framework for generation of UML2 sequence diagrams. It provides
1847 *UML2 Sequence diagram drawing capabilities (i.e. lifelines, messages, activations, object creation and deletion)
1848 *a generic, re-usable Sequence Diagram View
1849 *Eclipse Extension Point for the creation of sequence diagrams
1850 *callback hooks for searching and filtering within the Sequence Diagram View
1852 The following chapters describe the Sequence Diagram Framework as well as a reference implementation and its usage.
1854 == TMF UML2 Sequence Diagram Extensions ==
1856 In the UML2 Sequence Diagram Framework an Eclipse extension point is defined so that other plug-ins can contribute code to create sequence diagram.
1858 '''Identifier''': org.eclipse.linuxtools.tmf.ui.uml2SDLoader<br>
1859 '''Description''': This extension point aims to list and connect any UML2 Sequence Diagram loader.<br>
1860 '''Configuration Markup''':<br>
1863 <!ELEMENT extension (uml2SDLoader)+>
1865 point CDATA #REQUIRED
1871 *point - A fully qualified identifier of the target extension point.
1872 *id - An optional identifier of the extension instance.
1873 *name - An optional name of the extension instance.
1876 <!ELEMENT uml2SDLoader EMPTY>
1877 <!ATTLIST uml2SDLoader
1879 name CDATA #REQUIRED
1880 class CDATA #REQUIRED
1881 view CDATA #REQUIRED
1882 default (true | false)
1885 *id - A unique identifier for this uml2SDLoader. This is not mandatory as long as the id attribute cannot be retrieved by the provider plug-in. The class attribute is the one on which the underlying algorithm relies.
1886 *name - An name of the extension instance.
1887 *class - The implementation of this UML2 SD viewer loader. The class must implement org.eclipse.tracecompass.tmf.ui.views.uml2sd.load.IUml2SDLoader.
1888 *view - The view ID of the view that this loader aims to populate. Either org.eclipse.tracecompass.tmf.ui.views.uml2sd.SDView itself or a extension of org.eclipse.tracecompass.tmf.ui.views.uml2sd.SDView.
1889 *default - Set to true to make this loader the default one for the view; in case of several default loaders, first one coming from extensions list is taken.
1892 == Management of the Extension Point ==
1894 The TMF UI plug-in is responsible for evaluating each contribution to the extension point.
1897 With this extension point, a loader class is associated with a Sequence Diagram View. Multiple loaders can be associated to a single Sequence Diagram View. However, additional means have to be implemented to specify which loader should be used when opening the view. For example, an eclipse action or command could be used for that. This additional code is not necessary if there is only one loader for a given Sequence Diagram View associated and this loader has the attribute "default" set to "true". (see also [[#Using one Sequence Diagram View with Multiple Loaders | Using one Sequence Diagram View with Multiple Loaders]])
1899 == Sequence Diagram View ==
1901 For this extension point a Sequence Diagram View has to be defined as well. The Sequence Diagram View class implementation is provided by the plug-in ''org.eclipse.tracecompass.tmf.ui'' (''org.eclipse.tracecompass.tmf.ui.views.uml2sd.SDView'') and can be used as is or can also be sub-classed. For that, a view extension has to be added to the ''plugin.xml''.
1903 === Supported Widgets ===
1905 The loader class provides a frame containing all the UML2 widgets to be displayed. The following widgets exist:
1909 *Synchronous Message
1910 *Asynchronous Message
1911 *Synchronous Message Return
1912 *Asynchronous Message Return
1915 For a lifeline, a category can be defined. The lifeline category defines icons, which are displayed in the lifeline header.
1919 The Sequence Diagram View allows the user to zoom in, zoom out and reset the zoom factor.
1923 It is possible to print the whole sequence diagram as well as part of it.
1925 === Key Bindings ===
1927 *SHIFT+ALT+ARROW-DOWN - to scroll down within sequence diagram one view page at a time
1928 *SHIFT+ALT+ARROW-UP - to scroll up within sequence diagram one view page at a time
1929 *SHIFT+ALT+ARROW-RIGHT - to scroll right within sequence diagram one view page at a time
1930 *SHIFT+ALT+ARROW-LEFT - to scroll left within sequence diagram one view page at a time
1931 *SHIFT+ALT+ARROW-HOME - to jump to the beginning of the selected message if not already visible in page
1932 *SHIFT+ALT+ARROW-END - to jump to the end of the selected message if not already visible in page
1933 *CTRL+F - to open find dialog if either the basic or extended find provider is defined (see [[#Using the Find Provider Interface | Using the Find Provider Interface]])
1934 *CTRL+P - to open print dialog
1938 The UML2 Sequence Diagram Framework provides preferences to customize the appearance of the Sequence Diagram View. The color of all widgets and text as well as the fonts of the text of all widget can be adjust. Amongst others the default lifeline width can be alternated. To change preferences select '''Windows->Preferences->Tracing->UML2 Sequence Diagrams'''. The following preference page will show:<br>
1939 [[Image:images/SeqDiagramPref.png]] <br>
1940 After changing the preferences select '''OK'''.
1942 === Callback hooks ===
1944 The Sequence Diagram View provides several callback hooks so that extension can provide application specific functionality. The following interfaces can be provided:
1945 * Basic find provider or extended find Provider<br> For finding within the sequence diagram
1946 * Basic filter provider and extended Filter Provider<br> For filtering within the sequnce diagram.
1947 * Basic paging provider or advanced paging provider<br> For scalability reasons, used to limit number of displayed messages
1948 * Properies provider<br> To provide properties of selected elements
1949 * Collapse provider <br> To collapse areas of the sequence diagram
1953 This tutorial describes how to create a UML2 Sequence Diagram Loader extension and use this loader in the in Eclipse.
1955 === Prerequisites ===
1957 The tutorial is based on Eclipse 4.4 (Eclipse Luna) and TMF 3.0.0.
1959 === Creating an Eclipse UI Plug-in ===
1961 To create a new project with name org.eclipse.tracecompass.tmf.sample.ui select '''File -> New -> Project -> Plug-in Development -> Plug-in Project'''. <br>
1962 [[Image:images/Screenshot-NewPlug-inProject1.png]]<br>
1964 [[Image:images/Screenshot-NewPlug-inProject2.png]]<br>
1966 [[Image:images/Screenshot-NewPlug-inProject3.png]]<br>
1968 === Creating a Sequence Diagram View ===
1970 To open the plug-in manifest, double-click on the MANIFEST.MF file. <br>
1971 [[Image:images/SelectManifest.png]]<br>
1973 Change to the Dependencies tab and select '''Add...''' of the ''Required Plug-ins'' section. A new dialog box will open. Next find plug-ins ''org.eclipse.tracecompass.tmf.ui'' and ''org.eclipse.tracecompass.tmf.core'' and then press '''OK'''<br>
1974 [[Image:images/AddDependencyTmfUi.png]]<br>
1976 Change to the Extensions tab and select '''Add...''' of the ''All Extension'' section. A new dialog box will open. Find the view extension ''org.eclipse.ui.views'' and press '''Finish'''.<br>
1977 [[Image:images/AddViewExtension1.png]]<br>
1979 To create a Sequence Diagram View, click the right mouse button. Then select '''New -> view'''<br>
1980 [[Image:images/AddViewExtension2.png]]<br>
1982 A new view entry has been created. Fill in the fields ''id'', ''name'' and ''class''. Note that for ''class'' the SD view implementation (''org.eclipse.tracecompass.tmf.ui.views.SDView'') of the TMF UI plug-in is used.<br>
1983 [[Image:images/FillSampleSeqDiagram.png]]<br>
1985 The view is prepared. Run the Example. To launch the an Eclipse Application select the ''Overview'' tab and click on '''Launch an Eclipse Application'''<br>
1986 [[Image:images/RunEclipseApplication.png]]<br>
1988 A new Eclipse application window will show. In the new window go to '''Windows -> Show View -> Other... -> Other -> Sample Sequence Diagram'''.<br>
1989 [[Image:images/ShowViewOther.png]]<br>
1991 The Sequence Diagram View will open with an blank page.<br>
1992 [[Image:images/BlankSampleSeqDiagram.png]]<br>
1994 Close the Example Application.
1996 === Defining the uml2SDLoader Extension ===
1998 After defining the Sequence Diagram View it's time to create the ''uml2SDLoader'' Extension. <br>
2000 To create the loader extension, change to the Extensions tab and select '''Add...''' of the ''All Extension'' section. A new dialog box will open. Find the extension ''org.eclipse.linuxtools.tmf.ui.uml2SDLoader'' and press '''Finish'''.<br>
2001 [[Image:images/AddTmfUml2SDLoader.png]]<br>
2003 A new 'uml2SDLoader'' extension has been created. Fill in fields ''id'', ''name'', ''class'', ''view'' and ''default''. Use ''default'' equal true for this example. For the view add the id of the Sequence Diagram View of chapter [[#Creating a Sequence Diagram View | Creating a Sequence Diagram View]]. <br>
2004 [[Image:images/FillSampleLoader.png]]<br>
2006 Then click on ''class'' (see above) to open the new class dialog box. Fill in the relevant fields and select '''Finish'''. <br>
2007 [[Image:images/NewSampleLoaderClass.png]]<br>
2009 A new Java class will be created which implements the interface ''org.eclipse.tracecompass.tmf.ui.views.uml2sd.load.IUml2SDLoader''.<br>
2012 package org.eclipse.tracecompass.tmf.sample.ui;
2014 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.SDView;
2015 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.load.IUml2SDLoader;
2017 public class SampleLoader implements IUml2SDLoader {
2019 public SampleLoader() {
2020 // TODO Auto-generated constructor stub
2024 public void dispose() {
2025 // TODO Auto-generated method stub
2030 public String getTitleString() {
2031 // TODO Auto-generated method stub
2036 public void setViewer(SDView arg0) {
2037 // TODO Auto-generated method stub
2042 === Implementing the Loader Class ===
2044 Next is to implement the methods of the IUml2SDLoader interface method. The following code snippet shows how to create the major sequence diagram elements. Please note that no time information is stored.<br>
2047 package org.eclipse.tracecompass.tmf.sample.ui;
2049 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.SDView;
2050 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.AsyncMessage;
2051 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.AsyncMessageReturn;
2052 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.EllipsisMessage;
2053 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.ExecutionOccurrence;
2054 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.Frame;
2055 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.Lifeline;
2056 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.Stop;
2057 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.SyncMessage;
2058 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.SyncMessageReturn;
2059 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.load.IUml2SDLoader;
2061 public class SampleLoader implements IUml2SDLoader {
2063 private SDView fSdView;
2065 public SampleLoader() {
2069 public void dispose() {
2073 public String getTitleString() {
2074 return "Sample Diagram";
2078 public void setViewer(SDView arg0) {
2083 private void createFrame() {
2085 Frame testFrame = new Frame();
2086 testFrame.setName("Sample Frame");
2092 Lifeline lifeLine1 = new Lifeline();
2093 lifeLine1.setName("Object1");
2094 testFrame.addLifeLine(lifeLine1);
2096 Lifeline lifeLine2 = new Lifeline();
2097 lifeLine2.setName("Object2");
2098 testFrame.addLifeLine(lifeLine2);
2102 * Create Sync Message
2104 // Get new occurrence on lifelines
2105 lifeLine1.getNewEventOccurrence();
2107 // Get Sync message instances
2108 SyncMessage start = new SyncMessage();
2109 start.setName("Start");
2110 start.setEndLifeline(lifeLine1);
2111 testFrame.addMessage(start);
2114 * Create Sync Message
2116 // Get new occurrence on lifelines
2117 lifeLine1.getNewEventOccurrence();
2118 lifeLine2.getNewEventOccurrence();
2120 // Get Sync message instances
2121 SyncMessage syn1 = new SyncMessage();
2122 syn1.setName("Sync Message 1");
2123 syn1.setStartLifeline(lifeLine1);
2124 syn1.setEndLifeline(lifeLine2);
2125 testFrame.addMessage(syn1);
2128 * Create corresponding Sync Message Return
2131 // Get new occurrence on lifelines
2132 lifeLine1.getNewEventOccurrence();
2133 lifeLine2.getNewEventOccurrence();
2135 SyncMessageReturn synReturn1 = new SyncMessageReturn();
2136 synReturn1.setName("Sync Message Return 1");
2137 synReturn1.setStartLifeline(lifeLine2);
2138 synReturn1.setEndLifeline(lifeLine1);
2139 synReturn1.setMessage(syn1);
2140 testFrame.addMessage(synReturn1);
2143 * Create Activations (Execution Occurrence)
2145 ExecutionOccurrence occ1 = new ExecutionOccurrence();
2146 occ1.setStartOccurrence(start.getEventOccurrence());
2147 occ1.setEndOccurrence(synReturn1.getEventOccurrence());
2148 lifeLine1.addExecution(occ1);
2149 occ1.setName("Activation 1");
2151 ExecutionOccurrence occ2 = new ExecutionOccurrence();
2152 occ2.setStartOccurrence(syn1.getEventOccurrence());
2153 occ2.setEndOccurrence(synReturn1.getEventOccurrence());
2154 lifeLine2.addExecution(occ2);
2155 occ2.setName("Activation 2");
2158 * Create Sync Message
2160 // Get new occurrence on lifelines
2161 lifeLine1.getNewEventOccurrence();
2162 lifeLine2.getNewEventOccurrence();
2164 // Get Sync message instances
2165 AsyncMessage asyn1 = new AsyncMessage();
2166 asyn1.setName("Async Message 1");
2167 asyn1.setStartLifeline(lifeLine1);
2168 asyn1.setEndLifeline(lifeLine2);
2169 testFrame.addMessage(asyn1);
2172 * Create corresponding Sync Message Return
2175 // Get new occurrence on lifelines
2176 lifeLine1.getNewEventOccurrence();
2177 lifeLine2.getNewEventOccurrence();
2179 AsyncMessageReturn asynReturn1 = new AsyncMessageReturn();
2180 asynReturn1.setName("Async Message Return 1");
2181 asynReturn1.setStartLifeline(lifeLine2);
2182 asynReturn1.setEndLifeline(lifeLine1);
2183 asynReturn1.setMessage(asyn1);
2184 testFrame.addMessage(asynReturn1);
2190 // Get new occurrence on lifelines
2191 lifeLine1.getNewEventOccurrence();
2193 EllipsisMessage info = new EllipsisMessage();
2194 info.setName("Object deletion");
2195 info.setStartLifeline(lifeLine2);
2196 testFrame.addNode(info);
2201 Stop stop = new Stop();
2202 stop.setLifeline(lifeLine2);
2203 stop.setEventOccurrence(lifeLine2.getNewEventOccurrence());
2204 lifeLine2.addNode(stop);
2206 fSdView.setFrame(testFrame);
2211 Now it's time to run the example application. To launch the Example Application select the ''Overview'' tab and click on '''Launch an Eclipse Application'''<br>
2212 [[Image:images/SampleDiagram1.png]] <br>
2214 === Adding time information ===
2216 To add time information in sequence diagram the timestamp has to be set for each message. The sequence diagram framework uses the ''TmfTimestamp'' class of plug-in ''org.eclipse.tracecompass.tmf.core''. Use ''setTime()'' on each message ''SyncMessage'' since start and end time are the same. For each ''AsyncMessage'' set start and end time separately by using methods ''setStartTime'' and ''setEndTime''. For example: <br>
2219 private void createFrame() {
2221 start.setTime(new TmfTimestamp(1000, -3));
2222 syn1.setTime(new TmfTimestamp(1005, -3));
2223 synReturn1.setTime(new TmfTimestamp(1050, -3));
2224 asyn1.setStartTime(new TmfTimestamp(1060, -3));
2225 asyn1.setEndTime(new TmfTimestamp(1070, -3));
2226 asynReturn1.setStartTime(new TmfTimestamp(1060, -3));
2227 asynReturn1.setEndTime(new TmfTimestamp(1070, -3));
2232 When running the example application, a time compression bar on the left appears which indicates the time elapsed between consecutive events. The time compression scale shows where the time falls between the minimum and maximum delta times. The intensity of the color is used to indicate the length of time, namely, the deeper the intensity, the higher the delta time. The minimum and maximum delta times are configurable through the collbar menu ''Configure Min Max''. The time compression bar and scale may provide an indication about which events consumes the most time. By hovering over the time compression bar a tooltip appears containing more information. <br>
2234 [[Image:images/SampleDiagramTimeComp.png]] <br>
2236 By hovering over a message it will show the time information in the appearing tooltip. For each ''SyncMessage'' it shows its time occurrence and for each ''AsyncMessage'' it shows the start and end time.
2238 [[Image:images/SampleDiagramSyncMessage.png]] <br>
2239 [[Image:images/SampleDiagramAsyncMessage.png]] <br>
2241 To see the time elapsed between 2 messages, select one message and hover over a second message. A tooltip will show with the delta in time. Note if the second message is before the first then a negative delta is displayed. Note that for ''AsyncMessage'' the end time is used for the delta calculation.<br>
2242 [[Image:images/SampleDiagramMessageDelta.png]] <br>
2244 === Default Coolbar and Menu Items ===
2246 The Sequence Diagram View comes with default coolbar and menu items. By default, each sequence diagram shows the following actions:
2251 * Configure Min Max (drop-down menu only)
2252 * Navigation -> Show the node end (drop-down menu only)
2253 * Navigation -> Show the node start (drop-down menu only)
2255 [[Image:images/DefaultCoolbarMenu.png]]<br>
2257 === Implementing Optional Callbacks ===
2259 The following chapters describe how to use all supported provider interfaces.
2261 ==== Using the Paging Provider Interface ====
2263 For scalability reasons, the paging provider interfaces exists to limit the number of messages displayed in the Sequence Diagram View at a time. For that, two interfaces exist, the basic paging provider and the advanced paging provider. When using the basic paging interface, actions for traversing page by page through the sequence diagram of a trace will be provided.
2265 To use the basic paging provider, first the interface methods of the ''ISDPagingProvider'' have to be implemented by a class. (i.e. ''hasNextPage()'', ''hasPrevPage()'', ''nextPage()'', ''prevPage()'', ''firstPage()'' and ''endPage()''. Typically, this is implemented in the loader class. Secondly, the provider has to be set in the Sequence Diagram View. This will be done in the ''setViewer()'' method of the loader class. Lastly, the paging provider has to be removed from the view, when the ''dispose()'' method of the loader class is called.
2268 public class SampleLoader implements IUml2SDLoader, ISDPagingProvider {
2270 private int page = 0;
2273 public void dispose() {
2274 if (fSdView != null) {
2275 fSdView.resetProviders();
2280 public void setViewer(SDView arg0) {
2282 fSdView.setSDPagingProvider(this);
2286 private void createSecondFrame() {
2287 Frame testFrame = new Frame();
2288 testFrame.setName("SecondFrame");
2289 Lifeline lifeline = new Lifeline();
2290 lifeline.setName("LifeLine 0");
2291 testFrame.addLifeLine(lifeline);
2292 lifeline = new Lifeline();
2293 lifeline.setName("LifeLine 1");
2294 testFrame.addLifeLine(lifeline);
2295 for (int i = 1; i < 5; i++) {
2296 SyncMessage message = new SyncMessage();
2297 message.autoSetStartLifeline(testFrame.getLifeline(0));
2298 message.autoSetEndLifeline(testFrame.getLifeline(0));
2299 message.setName((new StringBuilder("Message ")).append(i).toString());
2300 testFrame.addMessage(message);
2302 SyncMessageReturn messageReturn = new SyncMessageReturn();
2303 messageReturn.autoSetStartLifeline(testFrame.getLifeline(0));
2304 messageReturn.autoSetEndLifeline(testFrame.getLifeline(0));
2306 testFrame.addMessage(messageReturn);
2307 messageReturn.setName((new StringBuilder("Message return ")).append(i).toString());
2308 ExecutionOccurrence occ = new ExecutionOccurrence();
2309 occ.setStartOccurrence(testFrame.getSyncMessage(i - 1).getEventOccurrence());
2310 occ.setEndOccurrence(testFrame.getSyncMessageReturn(i - 1).getEventOccurrence());
2311 testFrame.getLifeline(0).addExecution(occ);
2313 fSdView.setFrame(testFrame);
2317 public boolean hasNextPage() {
2322 public boolean hasPrevPage() {
2327 public void nextPage() {
2329 createSecondFrame();
2333 public void prevPage() {
2339 public void firstPage() {
2345 public void lastPage() {
2347 createSecondFrame();
2354 When running the example application, new actions will be shown in the coolbar and the coolbar menu. <br>
2356 [[Image:images/PageProviderAdded.png]]
2359 To use the advanced paging provider, the interface ''ISDAdvancePagingProvider'' has to be implemented. It extends the basic paging provider. The methods ''currentPage()'', ''pagesCount()'' and ''pageNumberChanged()'' have to be added.
2362 ==== Using the Find Provider Interface ====
2364 For finding nodes in a sequence diagram two interfaces exists. One for basic finding and one for extended finding. The basic find comes with a dialog box for entering find criteria as regular expressions. This find criteria can be used to execute the find. Find criteria a persisted in the Eclipse workspace.
2366 For the extended find provider interface a ''org.eclipse.jface.action.Action'' class has to be provided. The actual find handling has to be implemented and triggered by the action.
2368 Only on at a time can be active. If the extended find provder is defined it obsoletes the basic find provider.
2370 To use the basic find provider, first the interface methods of the ''ISDFindProvider'' have to be implemented by a class. Typically, this is implemented in the loader class. Add the ISDFindProvider to the list of implemented interfaces, implement the methods ''find()'' and ''cancel()'' and set the provider in the ''setViewer()'' method as well as remove the provider in the ''dispose()'' method of the loader class. Please note that the ''ISDFindProvider'' extends the interface ''ISDGraphNodeSupporter'' which methods (''isNodeSupported()'' and ''getNodeName()'') have to be implemented, too. The following shows an example implementation. Please note that only search for lifelines and SynchMessage are supported. The find itself will always find only the first occurrence the pattern to match.
2373 public class SampleLoader implements IUml2SDLoader, ISDPagingProvider, ISDFindProvider {
2377 public void dispose() {
2378 if (fSdView != null) {
2379 fSdView.resetProviders();
2384 public void setViewer(SDView arg0) {
2386 fSdView.setSDPagingProvider(this);
2387 fSdView.setSDFindProvider(this);
2392 public boolean isNodeSupported(int nodeType) {
2394 case ISDGraphNodeSupporter.LIFELINE:
2395 case ISDGraphNodeSupporter.SYNCMESSAGE:
2405 public String getNodeName(int nodeType, String loaderClassName) {
2407 case ISDGraphNodeSupporter.LIFELINE:
2409 case ISDGraphNodeSupporter.SYNCMESSAGE:
2410 return "Sync Message";
2416 public boolean find(Criteria criteria) {
2417 Frame frame = fSdView.getFrame();
2418 if (criteria.isLifeLineSelected()) {
2419 for (int i = 0; i < frame.lifeLinesCount(); i++) {
2420 if (criteria.matches(frame.getLifeline(i).getName())) {
2421 fSdView.getSDWidget().moveTo(frame.getLifeline(i));
2426 if (criteria.isSyncMessageSelected()) {
2427 for (int i = 0; i < frame.syncMessageCount(); i++) {
2428 if (criteria.matches(frame.getSyncMessage(i).getName())) {
2429 fSdView.getSDWidget().moveTo(frame.getSyncMessage(i));
2438 public void cancel() {
2439 // reset find parameters
2445 When running the example application, the find action will be shown in the coolbar and the coolbar menu. <br>
2446 [[Image:images/FindProviderAdded.png]]
2448 To find a sequence diagram node press on the find button of the coolbar (see above). A new dialog box will open. Enter a regular expression in the ''Matching String'' text box, select the node types (e.g. Sync Message) and press '''Find'''. If found the corresponding node will be selected. If not found the dialog box will indicate not found. <br>
2449 [[Image:images/FindDialog.png]]<br>
2451 Note that the find dialog will be opened by typing the key shortcut CRTL+F.
2453 ==== Using the Filter Provider Interface ====
2455 For filtering of sequence diagram elements two interfaces exist. One basic for filtering and one for extended filtering. The basic filtering comes with two dialog for entering filter criteria as regular expressions and one for selecting the filter to be used. Multiple filters can be active at a time. Filter criteria are persisted in the Eclipse workspace.
2457 To use the basic filter provider, first the interface method of the ''ISDFilterProvider'' has to be implemented by a class. Typically, this is implemented in the loader class. Add the ''ISDFilterProvider'' to the list of implemented interfaces, implement the method ''filter()''and set the provider in the ''setViewer()'' method as well as remove the provider in the ''dispose()'' method of the loader class. Please note that the ''ISDFindProvider'' extends the interface ''ISDGraphNodeSupporter'' which methods (''isNodeSupported()'' and ''getNodeName()'') have to be implemented, too. <br>
2458 Note that no example implementation of ''filter()'' is provided.
2462 public class SampleLoader implements IUml2SDLoader, ISDPagingProvider, ISDFindProvider, ISDFilterProvider {
2466 public void dispose() {
2467 if (fSdView != null) {
2468 fSdView.resetProviders();
2473 public void setViewer(SDView arg0) {
2475 fSdView.setSDPagingProvider(this);
2476 fSdView.setSDFindProvider(this);
2477 fSdView.setSDFilterProvider(this);
2482 public boolean filter(List<FilterCriteria> list) {
2489 When running the example application, the filter action will be shown in the coolbar menu. <br>
2490 [[Image:images/HidePatternsMenuItem.png]]
2492 To filter select the '''Hide Patterns...''' of the coolbar menu. A new dialog box will open. <br>
2493 [[Image:images/DialogHidePatterns.png]]
2495 To Add a new filter press '''Add...'''. A new dialog box will open. Enter a regular expression in the ''Matching String'' text box, select the node types (e.g. Sync Message) and press '''Create''''. <br>
2496 [[Image:images/DialogHidePatterns.png]] <br>
2498 Now back at the Hide Pattern dialog. Select one or more filter and select '''OK'''.
2500 To use the extended filter provider, the interface ''ISDExtendedFilterProvider'' has to be implemented. It will provide a ''org.eclipse.jface.action.Action'' class containing the actual filter handling and filter algorithm.
2502 ==== Using the Extended Action Bar Provider Interface ====
2504 The extended action bar provider can be used to add customized actions to the Sequence Diagram View.
2505 To use the extended action bar provider, first the interface method of the interface ''ISDExtendedActionBarProvider'' has to be implemented by a class. Typically, this is implemented in the loader class. Add the ''ISDExtendedActionBarProvider'' to the list of implemented interfaces, implement the method ''supplementCoolbarContent()'' and set the provider in the ''setViewer()'' method as well as remove the provider in the ''dispose()'' method of the loader class. <br>
2508 public class SampleLoader implements IUml2SDLoader, ISDPagingProvider, ISDFindProvider, ISDFilterProvider, ISDExtendedActionBarProvider {
2512 public void dispose() {
2513 if (fSdView != null) {
2514 fSdView.resetProviders();
2519 public void setViewer(SDView arg0) {
2521 fSdView.setSDPagingProvider(this);
2522 fSdView.setSDFindProvider(this);
2523 fSdView.setSDFilterProvider(this);
2524 fSdView.setSDExtendedActionBarProvider(this);
2529 public void supplementCoolbarContent(IActionBars iactionbars) {
2530 Action action = new Action("Refresh") {
2533 System.out.println("Refreshing...");
2536 iactionbars.getMenuManager().add(action);
2537 iactionbars.getToolBarManager().add(action);
2543 When running the example application, all new actions will be added to the coolbar and coolbar menu according to the implementation of ''supplementCoolbarContent()''<br>.
2544 For the example above the coolbar and coolbar menu will look as follows.
2546 [[Image:images/SupplCoolbar.png]]
2548 ==== Using the Properties Provider Interface====
2550 This interface can be used to provide property information. A property provider which returns an ''IPropertyPageSheet'' (see ''org.eclipse.ui.views'') has to be implemented and set in the Sequence Diagram View. <br>
2552 To use the property provider, first the interface method of the ''ISDPropertiesProvider'' has to be implemented by a class. Typically, this is implemented in the loader class. Add the ''ISDPropertiesProvider'' to the list of implemented interfaces, implement the method ''getPropertySheetEntry()'' and set the provider in the ''setViewer()'' method as well as remove the provider in the ''dispose()'' method of the loader class. Please note that no example is provided here.
2554 Please refer to the following Eclipse articles for more information about properties and tabed properties.
2555 *[http://www.eclipse.org/articles/Article-Properties-View/properties-view.html | Take control of your properties]
2556 *[http://www.eclipse.org/articles/Article-Tabbed-Properties/tabbed_properties_view.html | The Eclipse Tabbed Properties View]
2558 ==== Using the Collapse Provider Interface ====
2560 This interface can be used to define a provider which responsibility is to collapse two selected lifelines. This can be used to hide a pair of lifelines.
2562 To use the collapse provider, first the interface method of the ''ISDCollapseProvider'' has to be implemented by a class. Typically, this is implemented in the loader class. Add the ISDCollapseProvider to the list of implemented interfaces, implement the method ''collapseTwoLifelines()'' and set the provider in the ''setViewer()'' method as well as remove the provider in the ''dispose()'' method of the loader class. Please note that no example is provided here.
2564 ==== Using the Selection Provider Service ====
2566 The Sequence Diagram View comes with a build in selection provider service. To this service listeners can be added. To use the selection provider service, the interface ''ISelectionListener'' of plug-in ''org.eclipse.ui'' has to implemented. Typically this is implemented in loader class. Firstly, add the ''ISelectionListener'' interface to the list of implemented interfaces, implement the method ''selectionChanged()'' and set the listener in method ''setViewer()'' as well as remove the listener in the ''dispose()'' method of the loader class.
2569 public class SampleLoader implements IUml2SDLoader, ISDPagingProvider, ISDFindProvider, ISDFilterProvider, ISDExtendedActionBarProvider, ISelectionListener {
2573 public void dispose() {
2574 if (fSdView != null) {
2575 PlatformUI.getWorkbench().getActiveWorkbenchWindow().getSelectionService().removePostSelectionListener(this);
2576 fSdView.resetProviders();
2581 public String getTitleString() {
2582 return "Sample Diagram";
2586 public void setViewer(SDView arg0) {
2588 PlatformUI.getWorkbench().getActiveWorkbenchWindow().getSelectionService().addPostSelectionListener(this);
2589 fSdView.setSDPagingProvider(this);
2590 fSdView.setSDFindProvider(this);
2591 fSdView.setSDFilterProvider(this);
2592 fSdView.setSDExtendedActionBarProvider(this);
2598 public void selectionChanged(IWorkbenchPart part, ISelection selection) {
2599 ISelection sel = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getSelectionService().getSelection();
2600 if (sel != null && (sel instanceof StructuredSelection)) {
2601 StructuredSelection stSel = (StructuredSelection) sel;
2602 if (stSel.getFirstElement() instanceof BaseMessage) {
2603 BaseMessage syncMsg = ((BaseMessage) stSel.getFirstElement());
2604 System.out.println("Message '" + syncMsg.getName() + "' selected.");
2613 === Printing a Sequence Diagram ===
2615 To print a the whole sequence diagram or only parts of it, select the Sequence Diagram View and select '''File -> Print...''' or type the key combination ''CTRL+P''. A new print dialog will open. <br>
2617 [[Image:images/PrintDialog.png]] <br>
2619 Fill in all the relevant information, select '''Printer...''' to choose the printer and the press '''OK'''.
2621 === Using one Sequence Diagram View with Multiple Loaders ===
2623 A Sequence Diagram View definition can be used with multiple sequence diagram loaders. However, the active loader to be used when opening the view has to be set. For this define an Eclipse action or command and assign the current loader to the view. Here is a code snippet for that:
2626 public class OpenSDView extends AbstractHandler {
2628 public Object execute(ExecutionEvent event) throws ExecutionException {
2630 IWorkbenchPage persp = TmfUiPlugin.getDefault().getWorkbench().getActiveWorkbenchWindow().getActivePage();
2631 SDView view = (SDView) persp.showView("org.eclipse.linuxtools.ust.examples.ui.componentinteraction");
2632 LoadersManager.getLoadersManager().createLoader("org.eclipse.tracecompass.tmf.ui.views.uml2sd.impl.TmfUml2SDSyncLoader", view);
2633 } catch (PartInitException e) {
2634 throw new ExecutionException("PartInitException caught: ", e);
2641 === Downloading the Tutorial ===
2643 Use the following link to download the source code of the tutorial [https://wiki.eclipse.org/images/7/79/SamplePluginTC.zip Plug-in of Tutorial].
2645 == Integration of Tracing and Monitoring Framework with Sequence Diagram Framework ==
2647 In the previous sections the Sequence Diagram Framework has been described and a tutorial was provided. In the following sections the integration of the Sequence Diagram Framework with other features of TMF will be described. Together it is a powerful framework to analyze and visualize content of traces. The integration is explained using the reference implementation of a UML2 sequence diagram loader which part of the TMF UI delivery. The reference implementation can be used as is, can be sub-classed or simply be an example for other sequence diagram loaders to be implemented.
2649 === Reference Implementation ===
2651 A Sequence Diagram View Extension is defined in the plug-in TMF UI as well as a uml2SDLoader Extension with the reference loader.
2653 [[Image:images/ReferenceExtensions.png]]
2655 === Used Sequence Diagram Features ===
2657 Besides the default features of the Sequence Diagram Framework, the reference implementation uses the following additional features:
2663 ==== Advanced paging ====
2665 The reference loader implements the interface ''ISDAdvancedPagingProvider'' interface. Please refer to section [[#Using the Paging Provider Interface | Using the Paging Provider Interface]] for more details about the advanced paging feature.
2667 ==== Basic finding ====
2669 The reference loader implements the interface ''ISDFindProvider'' interface. The user can search for ''Lifelines'' and ''Interactions''. The find is done across pages. If the expression to match is not on the current page a new thread is started to search on other pages. If expression is found the corresponding page is shown as well as the searched item is displayed. If not found then a message is displayed in the ''Progress View'' of Eclipse. Please refer to section [[#Using the Find Provider Interface | Using the Find Provider Interface]] for more details about the basic find feature.
2671 ==== Basic filtering ====
2673 The reference loader implements the interface ''ISDFilterProvider'' interface. The user can filter on ''Lifelines'' and ''Interactions''. Please refer to section [[#Using the Filter Provider Interface | Using the Filter Provider Interface]] for more details about the basic filter feature.
2675 ==== Selection Service ====
2677 The reference loader implements the interface ''ISelectionListener'' interface. When an interaction is selected a ''TmfTimeSynchSignal'' is broadcast (see [[#TMF Signal Framework | TMF Signal Framework]]). Please also refer to section [[#Using the Selection Provider Service | Using the Selection Provider Service]] for more details about the selection service and .
2679 === Used TMF Features ===
2681 The reference implementation uses the following features of TMF:
2682 *TMF Experiment and Trace for accessing traces
2683 *Event Request Framework to request TMF events from the experiment and respective traces
2684 *Signal Framework for broadcasting and receiving TMF signals for synchronization purposes
2686 ==== TMF Experiment and Trace for accessing traces ====
2688 The reference loader uses TMF Experiments to access traces and to request data from the traces.
2690 ==== TMF Event Request Framework ====
2692 The reference loader use the TMF Event Request Framework to request events from the experiment and its traces.
2694 When opening a trace (which is triggered by signal ''TmfTraceSelectedSignal'') or when opening the Sequence Diagram View after a trace had been opened previously, a TMF background request is initiated to index the trace and to fill in the first page of the sequence diagram. The purpose of the indexing is to store time ranges for pages with 10000 messages per page. This allows quickly to move to certain pages in a trace without having to re-parse from the beginning. The request is called indexing request.
2696 When switching pages, the a TMF foreground event request is initiated to retrieve the corresponding events from the experiment. It uses the time range stored in the index for the respective page.
2698 A third type of event request is issued for finding specific data across pages.
2700 ==== TMF Signal Framework ====
2702 The reference loader extends the class ''TmfComponent''. By doing that the loader is registered as a TMF signal handler for sending and receiving TMF signals. The loader implements signal handlers for the following TMF signals:
2703 *''TmfTraceSelectedSignal''
2704 This signal indicates that a trace or experiment was selected. When receiving this signal the indexing request is initiated and the first page is displayed after receiving the relevant information.
2705 *''TmfTraceClosedSignal''
2706 This signal indicates that a trace or experiment was closed. When receiving this signal the loader resets its data and a blank page is loaded in the Sequence Diagram View.
2707 *''TmfTimeSynchSignal''
2708 This signal is used to indicate that a new time or time range has been selected. It contains a begin and end time. If a single time is selected then the begin and end time are the same. When receiving this signal the corresponding message matching the begin time is selected in the Sequence Diagram View. If necessary, the page is changed.
2709 *''TmfRangeSynchSignal''
2710 This signal indicates that a new time range is in focus. When receiving this signal the loader loads the page which corresponds to the start time of the time range signal. The message with the start time will be in focus.
2712 Besides acting on receiving signals, the reference loader is also sending signals. A ''TmfTimeSynchSignal'' is broadcasted with the timestamp of the message which was selected in the Sequence Diagram View. ''TmfRangeSynchSignal'' is sent when a page is changed in the Sequence Diagram View. The start timestamp of the time range sent is the timestamp of the first message. The end timestamp sent is the timestamp of the first message plus the current time range window. The current time range window is the time window that was indicated in the last received ''TmfRangeSynchSignal''.
2714 === Supported Traces ===
2716 The reference implementation is able to analyze traces from a single component that traces the interaction with other components. For example, a server node could have trace information about its interaction with client nodes. The server node could be traced and then analyzed using TMF and the Sequence Diagram Framework of TMF could used to visualize the interactions with the client nodes.<br>
2718 Note that combined traces of multiple components, that contain the trace information about the same interactions are not supported in the reference implementation!
2720 === Trace Format ===
2722 The reference implementation in class ''TmfUml2SDSyncLoader'' in package ''org.eclipse.tracecompass.tmf.ui.views.uml2sd.impl'' analyzes events from type ''ITmfEvent'' and creates events type ''ITmfSyncSequenceDiagramEvent'' if the ''ITmfEvent'' contains all relevant information information. The parsing algorithm looks like as follows:
2726 * @param tmfEvent Event to parse for sequence diagram event details
2727 * @return sequence diagram event if details are available else null
2729 protected ITmfSyncSequenceDiagramEvent getSequenceDiagramEvent(ITmfEvent tmfEvent){
2730 //type = .*RECEIVE.* or .*SEND.*
2731 //content = sender:<sender name>:receiver:<receiver name>,signal:<signal name>
2732 String eventType = tmfEvent.getType().toString();
2733 if (eventType.contains(Messages.TmfUml2SDSyncLoader_EventTypeSend) || eventType.contains(Messages.TmfUml2SDSyncLoader_EventTypeReceive)) {
2734 Object sender = tmfEvent.getContent().getField(Messages.TmfUml2SDSyncLoader_FieldSender);
2735 Object receiver = tmfEvent.getContent().getField(Messages.TmfUml2SDSyncLoader_FieldReceiver);
2736 Object name = tmfEvent.getContent().getField(Messages.TmfUml2SDSyncLoader_FieldSignal);
2737 if ((sender instanceof ITmfEventField) && (receiver instanceof ITmfEventField) && (name instanceof ITmfEventField)) {
2738 ITmfSyncSequenceDiagramEvent sdEvent = new TmfSyncSequenceDiagramEvent(tmfEvent,
2739 ((ITmfEventField) sender).getValue().toString(),
2740 ((ITmfEventField) receiver).getValue().toString(),
2741 ((ITmfEventField) name).getValue().toString());
2750 The analysis looks for event type Strings containing ''SEND'' and ''RECEIVE''. If event type matches these key words, the analyzer will look for strings ''sender'', ''receiver'' and ''signal'' in the event fields of type ''ITmfEventField''. If all the data is found a sequence diagram event can be created using this information. Note that Sync Messages are assumed, which means start and end time are the same.
2752 === How to use the Reference Implementation ===
2754 An example CTF (Common Trace Format) trace is provided that contains trace events with sequence diagram information. To download the reference trace, use the following link: [https://wiki.eclipse.org/images/3/35/ReferenceTrace.zip Reference Trace].
2756 Run an Eclipse application with Trace Compass 0.1.0 or later installed. To open the Reference Sequence Diagram View, select '''Windows -> Show View -> Other... -> Tracing -> Sequence Diagram''' <br>
2757 [[Image:images/ShowTmfSDView.png]]<br>
2759 A blank Sequence Diagram View will open.
2761 Then import the reference trace to the '''Project Explorer''' using the '''Import Trace Package...''' menu option.<br>
2762 [[Image:images/ImportTracePackage.png]]
2764 Next, open the trace by double-clicking on the trace element in the '''Project Explorer'''. The trace will be opened and the Sequence Diagram view will be filled.
2765 [[Image:images/ReferenceSeqDiagram.png]]<br>
2767 Now the reference implementation can be explored. To demonstrate the view features try the following things:
2768 *Select a message in the Sequence diagram. As result the corresponding event will be selected in the Events View.
2769 *Select an event in the Events View. As result the corresponding message in the Sequence Diagram View will be selected. If necessary, the page will be changed.
2770 *In the Events View, press key ''End''. As result, the Sequence Diagram view will jump to the last page.
2771 *In the Events View, press key ''Home''. As result, the Sequence Diagram view will jump to the first page.
2772 *In the Sequence Diagram View select the find button. Enter the expression '''REGISTER.*''', select '''Search for Interaction''' and press '''Find'''. As result the corresponding message will be selected in the Sequence Diagram and the corresponding event in the Events View will be selected. Select again '''Find''' the next occurrence of will be selected. Since the second occurrence is on a different page than the first, the corresponding page will be loaded.
2773 * In the Sequence Diagram View, select menu item '''Hide Patterns...'''. Add the filter '''BALL.*''' for '''Interaction''' only and select '''OK'''. As result all messages with name ''BALL_REQUEST'' and ''BALL_REPLY'' will be hidden. To remove the filter, select menu item '''Hide Patterns...''', deselect the corresponding filter and press '''OK'''. All the messages will be shown again.<br>
2775 === Extending the Reference Loader ===
2777 In some case it might be necessary to change the implementation of the analysis of each ''TmfEvent'' for the generation of ''Sequence Diagram Events''. For that just extend the class ''TmfUml2SDSyncLoader'' and overwrite the method ''protected ITmfSyncSequenceDiagramEvent getSequenceDiagramEvent(ITmfEvent tmfEvent)'' with your own implementation.
2782 CTF is a format used to store traces. It is self defining, binary and made to be easy to write to.
2783 Before going further, the full specification of the CTF file format can be found at http://www.efficios.com/ .
2785 For the purpose of the reader some basic description will be given. A CTF trace typically is made of several files all in the same folder.
2787 These files can be split into two types :
2792 The metadata is either raw text or packetized text. It is TSDL encoded. it contains a description of the type of data in the event streams. It can grow over time if new events are added to a trace but it will never overwrite what is already there.
2794 === Event Streams ===
2795 The event streams are a file per stream per cpu. These streams are binary and packet based. The streams store events and event information (ie lost events) The event data is stored in headers and field payloads.
2797 So if you have two streams (channels) "channel1" and "channel2" and 4 cores, you will have the following files in your trace directory: "channel1_0" , "channel1_1" , "channel1_2" , "channel1_3" , "channel2_0" , "channel2_1" , "channel2_2" & "channel2_3"
2799 == Reading a trace ==
2800 In order to read a CTF trace, two steps must be done.
2801 * The metadata must be read to know how to read the events.
2802 * the events must be read.
2804 The metadata is a written in a subset of the C language called TSDL. To read it, first it is depacketized (if it is not in plain text) then the raw text is parsed by an antlr grammar. The parsing is done in two phases. There is a lexer (CTFLexer.g) which separated the metatdata text into tokens. The tokens are then pattern matched using the parser (CTFParser.g) to form an AST. This AST is walked through using "IOStructGen.java" to populate streams and traces in trace parent object.
2806 When the metadata is loaded and read, the trace object will be populated with 3 items:
2807 * the event definitions available per stream: a definition is a description of the datatype.
2808 * the event declarations available per stream: this will save declaration creation on a per event basis. They will all be created in advance, just not populated.
2809 * the beginning of a packet index.
2811 Now all the trace readers for the event streams have everything they need to read a trace. They will each point to one file, and read the file from packet to packet. Every time the trace reader changes packet, the index is updated with the new packet's information. The readers are in a priority queue and sorted by timestamp. This ensures that the events are read in a sequential order. They are also sorted by file name so that in the eventuality that two events occur at the same time, they stay in the same order.
2813 == Seeking in a trace ==
2814 The reason for maintaining an index is to speed up seeks. In the case that a user wishes to seek to a certain timestamp, they just have to find the index entry that contains the timestamp, and go there to iterate in that packet until the proper event is found. this will reduce the searches time by an order of 8000 for a 256k packet size (kernel default).
2816 == Interfacing to TMF ==
2817 The trace can be read easily now but the data is still awkward to extract.
2820 A location in a given trace, it is currently the timestamp of a trace and the index of the event. The index shows for a given timestamp if it is the first second or nth element.
2823 The CtfTmfTrace is a wrapper for the standard CTF trace that allows it to perform the following actions:
2824 * '''initTrace()''' create a trace
2825 * '''validateTrace()''' is the trace a CTF trace?
2826 * '''getLocationRatio()''' how far in the trace is my location?
2827 * '''seekEvent()''' sets the cursor to a certain point in a trace.
2828 * '''readNextEvent()''' reads the next event and then advances the cursor
2829 * '''getTraceProperties()''' gets the 'env' structures of the metadata
2832 The CtfIterator is a wrapper to the CTF file reader. It behaves like an iterator on a trace. However, it contains a file pointer and thus cannot be duplicated too often or the system will run out of file handles. To alleviate the situation, a pool of iterators is created at the very beginning and stored in the CtfTmfTrace. They can be retried by calling the GetIterator() method.
2834 === CtfIteratorManager ===
2835 Since each CtfIterator will have a file reader, the OS will run out of handles if too many iterators are spawned. The solution is to use the iterator manager. This will allow the user to get an iterator. If there is a context at the requested position, the manager will return that one, if not, a context will be selected at random and set to the correct location. Using random replacement minimizes contention as it will settle quickly at a new balance point.
2837 === CtfTmfContext ===
2838 The CtfTmfContext implements the ITmfContext type. It is the CTF equivalent of TmfContext. It has a CtfLocation and points to an iterator in the CtfTmfTrace iterator pool as well as the parent trace. it is made to be cloned easily and not affect system resources much. Contexts behave much like C file pointers (FILE*) but they can be copied until one runs out of RAM.
2840 === CtfTmfTimestamp ===
2841 The CtfTmfTimestamp take a CTF time (normally a long int) and outputs the time formats it as a TmfTimestamp, allowing it to be compared to other timestamps. The time is stored with the UTC offset already applied. It also features a simple toString() function that allows it to output the time in more Human readable ways: "yyyy/mm/dd/hh:mm:ss.nnnnnnnnn ns" for example. An additional feature is the getDelta() function that allows two timestamps to be substracted, showing the time difference between A and B.
2844 The CtfTmfEvent is an ITmfEvent that is used to wrap event declarations and event definitions from the CTF side into easier to read and parse chunks of information. It is a final class with final fields made to be newed very often without incurring performance costs. Most of the information is already available. It should be noted that one type of event can appear called "lost event" these are synthetic events that do not exist in the trace. They will not appear in other trace readers such as babeltrace.
2847 There are other helper files that format given events for views, they are simpler and the architecture does not depend on them.
2850 For the moment live trace reading is not supported, there are no sources of traces to test on.
2852 = Event matching and trace synchronization =
2854 Event matching consists in taking an event from a trace and linking it to another event in a possibly different trace. The example that comes to mind is matching network packets sent from one traced machine to another traced machine. These matches can be used to synchronize traces.
2856 Trace synchronization consists in taking traces, taken on different machines, with a different time reference, and finding the formula to transform the timestamps of some of the traces, so that they all have the same time reference.
2858 == Event matching interfaces ==
2860 Here's a description of the major parts involved in event matching. These classes are all in the ''org.eclipse.tracecompass.tmf.core.event.matching'' package:
2862 * '''ITmfEventMatching''': Controls the event matching process
2863 * '''ITmfMatchEventDefinition''': Describes how events are matched
2864 * '''IMatchProcessingUnit''': Processes the matched events
2866 == Implementation details and how to extend it ==
2868 === ITmfEventMatching interface and derived classes ===
2870 This interface and its default abstract implementation '''TmfEventMatching''' control the event matching itself. Their only public method is ''matchEvents''. The class needs to manage how to setup the traces, and any initialization or finalization procedures.
2872 The abstract class generates an event request for each trace from which events are matched and waits for the request to complete before calling the one from another trace. The ''handleData'' method from the request calls the ''matchEvent'' method that needs to be implemented in children classes.
2874 Class '''TmfNetworkEventMatching''' is a concrete implementation of this interface. It applies to all use cases where a ''in'' event can be matched with a ''out' event (''in'' and ''out'' can be the same event, with different data). It creates a '''TmfEventDependency''' between the source and destination events. The dependency is added to the processing unit.
2876 To match events requiring other mechanisms (for instance, a series of events can be matched with another series of events), one would need to implement another class either extending '''TmfEventMatching''' or implementing '''ITmfEventMatching'''. It would most probably also require a new '''ITmfMatchEventDefinition''' implementation.
2878 === ITmfMatchEventDefinition interface and its derived classes ===
2880 These are the classes that describe how to actually match specific events together.
2882 The '''canMatchTrace''' method will tell if a definition is compatible with a given trace.
2884 The '''getEventKey''' method will return a key for an event that uniquely identifies this event and will match the key from another event.
2886 Typically, there would be a match definition abstract class/interface per event matching type.
2888 The interface '''ITmfNetworkMatchDefinition''' adds the ''getDirection'' method to indicate whether this event is a ''in'' or ''out'' event to be matched with one from the opposite direction.
2890 As examples, two concrete network match definitions have been implemented in the ''org.eclipse.tracecompass.internal.lttng2.kernel.core.event.matching'' package for two compatible methods of matching TCP packets (See the Trace Compass User Guide on ''trace synchronization'' for information on those matching methods). Each one tells which events need to be present in the metadata of a CTF trace for this matching method to be applicable. It also returns the field values from each event that will uniquely match 2 events together.
2892 === IMatchProcessingUnit interface and derived classes ===
2894 While matching events is an exercise in itself, it's what to do with the match that really makes this functionality interesting. This is the job of the '''IMatchProcessingUnit''' interface.
2896 '''TmfEventMatches''' provides a default implementation that only stores the matches to count them. When a new match is obtained, the ''addMatch'' is called with the match and the processing unit can do whatever needs to be done with it.
2898 A match processing unit can be an analysis in itself. For example, trace synchronization is done through such a processing unit. One just needs to set the processing unit in the TmfEventMatching constructor.
2902 === Using network packets matching in an analysis ===
2904 This example shows how one can create a processing unit inline to create a link between two events. In this example, the code already uses an event request, so there is no need here to call the ''matchEvents'' method, that will only create another request.
2907 class MyAnalysis extends TmfAbstractAnalysisModule {
2909 private TmfNetworkEventMatching tcpMatching;
2913 protected void executeAnalysis() {
2915 IMatchProcessingUnit matchProcessing = new IMatchProcessingUnit() {
2917 public void matchingEnded() {
2921 public void init(ITmfTrace[] fTraces) {
2925 public int countMatches() {
2930 public void addMatch(TmfEventDependency match) {
2931 log.debug("we got a tcp match! " + match.getSourceEvent().getContent() + " " + match.getDestinationEvent().getContent());
2932 TmfEvent source = match.getSourceEvent();
2933 TmfEvent destination = match.getDestinationEvent();
2934 /* Create a link between the two events */
2938 ITmfTrace[] traces = { getTrace() };
2939 tcpMatching = new TmfNetworkEventMatching(traces, matchProcessing);
2940 tcpMatching.initMatching();
2942 MyEventRequest request = new MyEventRequest(this, i);
2943 getTrace().sendRequest(request);
2946 public void analyzeEvent(TmfEvent event) {
2948 tcpMatching.matchEvent(event, 0);
2956 class MyEventRequest extends TmfEventRequest {
2958 private final MyAnalysis analysis;
2960 MyEventRequest(MyAnalysis analysis, int traceno) {
2961 super(CtfTmfEvent.class,
2962 TmfTimeRange.ETERNITY,
2964 TmfDataRequest.ALL_DATA,
2965 ITmfDataRequest.ExecutionType.FOREGROUND);
2966 this.analysis = analysis;
2970 public void handleData(final ITmfEvent event) {
2971 super.handleData(event);
2972 if (event != null) {
2973 analysis.analyzeEvent(event);
2979 === Match network events from UST traces ===
2981 Suppose a client-server application is instrumented using LTTng-UST. Traces are collected on the server and some clients on different machines. The traces can be synchronized using network event matching.
2983 The following metadata describes the events:
2987 name = "myapp:send";
2992 integer { size = 32; align = 8; signed = 1; encoding = none; base = 10; } _sendto;
2993 integer { size = 64; align = 8; signed = 1; encoding = none; base = 10; } _messageid;
2994 integer { size = 64; align = 8; signed = 1; encoding = none; base = 10; } _data;
2999 name = "myapp:receive";
3004 integer { size = 32; align = 8; signed = 1; encoding = none; base = 10; } _from;
3005 integer { size = 64; align = 8; signed = 1; encoding = none; base = 10; } _messageid;
3006 integer { size = 64; align = 8; signed = 1; encoding = none; base = 10; } _data;
3011 One would need to write an event match definition for those 2 events as follows:
3014 public class MyAppUstEventMatching implements ITmfNetworkMatchDefinition {
3017 public Direction getDirection(ITmfEvent event) {
3018 String evname = event.getType().getName();
3019 if (evname.equals("myapp:receive")) {
3020 return Direction.IN;
3021 } else if (evname.equals("myapp:send")) {
3022 return Direction.OUT;
3028 public IEventMatchingKey getEventKey(ITmfEvent event) {
3029 IEventMatchingKey key;
3031 if (evname.equals("myapp:receive")) {
3032 key = new MyEventMatchingKey(event.getContent().getField("from").getValue(),
3033 event.getContent().getField("messageid").getValue());
3035 key = new MyEventMatchingKey(event.getContent().getField("sendto").getValue(),
3036 event.getContent().getField("messageid").getValue());
3043 public boolean canMatchTrace(ITmfTrace trace) {
3044 if (!(trace instanceof CtfTmfTrace)) {
3047 CtfTmfTrace ktrace = (CtfTmfTrace) trace;
3048 String[] events = { "myapp:receive", "myapp:send" };
3049 return ktrace.hasAtLeastOneOfEvents(events);
3053 public MatchingType[] getApplicableMatchingTypes() {
3054 MatchingType[] types = { MatchingType.NETWORK };
3061 Somewhere in code that will be executed at the start of the plugin (like in the Activator), the following code will have to be run:
3064 TmfEventMatching.registerMatchObject(new MyAppUstEventMatching());
3067 Now, only adding the traces in an experiment and clicking the '''Synchronize traces''' menu element would synchronize the traces using the new definition for event matching.
3069 == Trace synchronization ==
3071 Trace synchronization classes and interfaces are located in the ''org.eclipse.tracecompass.tmf.core.synchronization'' package.
3073 === Synchronization algorithm ===
3075 Synchronization algorithms are used to synchronize traces from events matched between traces. After synchronization, traces taken on different machines with different time references see their timestamps modified such that they all use the same time reference (typically, the time of at least one of the traces). With traces from different machines, it is impossible to have perfect synchronization, so the result is a best approximation that takes network latency into account.
3077 The abstract class '''SynchronizationAlgorithm''' is a processing unit for matches. New synchronization algorithms must extend this one, it already contains the functions to get the timestamp transforms for different traces.
3079 The ''fully incremental convex hull'' synchronization algorithm is the default synchronization algorithm.
3081 While the synchronization system provisions for more synchronization algorithms, there is not yet a way to select one, the experiment's trace synchronization uses the default algorithm. To test a new synchronization algorithm, the synchronization should be called directly like this:
3084 SynchronizationAlgorithm syncAlgo = new MyNewSynchronizationAlgorithm();
3085 syncAlgo = SynchronizationManager.synchronizeTraces(syncFile, traces, syncAlgo, true);
3088 === Timestamp transforms ===
3090 Timestamp transforms are the formulae used to transform the timestamps from a trace into the reference time. The '''ITmfTimestampTransform''' is the interface to implement to add a new transform.
3092 The following classes implement this interface:
3094 * '''TmfTimestampTransform''': default transform. It cannot be instantiated, it has a single static object TmfTimestampTransform.IDENTITY, which returns the original timestamp.
3095 * '''TmfTimestampTransformLinear''': transforms the timestamp using a linear formula: ''f(t) = at + b'', where ''a'' and ''b'' are computed by the synchronization algorithm.
3097 One could extend the interface for other timestamp transforms, for instance to have a transform where the formula would change over the course of the trace.
3101 Here's a list of features not yet implemented that would enhance trace synchronization and event matching:
3103 * Ability to select a synchronization algorithm
3104 * Implement a better way to select the reference trace instead of arbitrarily taking the first in alphabetical order (for instance, the minimum spanning tree algorithm by Masoume Jabbarifar (article on the subject not published yet))
3105 * Ability to join traces from the same host so that even if one of the traces is not synchronized with the reference trace, it will take the same timestamp transform as the one on the same machine.
3106 * Instead of having the timestamp transforms per trace, have the timestamp transform as part of an experiment context, so that the trace's specific analysis, like the state system, are in the original trace, but are transformed only when needed for an experiment analysis.
3107 * Add more views to display the synchronization information (only textual statistics are available for now)
3109 = Analysis Framework =
3111 Analysis modules are useful to tell the user exactly what can be done with a trace. The analysis framework provides an easy way to access and execute the modules and open the various outputs available.
3113 Analyses can have parameters they can use in their code. They also have outputs registered to them to display the results from their execution.
3115 == Creating a new module ==
3117 All analysis modules must implement the '''IAnalysisModule''' interface from the o.e.l.tmf.core project. An abstract class, '''TmfAbstractAnalysisModule''', provides a good base implementation. It is strongly suggested to use it as a superclass of any new analysis.
3121 This example shows how to add a simple analysis module for an LTTng kernel trace with two parameters. It also specifies two mandatory events by overriding '''getAnalysisRequirements'''. The analysis requirements are further explained in the section [[#Providing requirements to analyses]].
3124 public class MyLttngKernelAnalysis extends TmfAbstractAnalysisModule {
3126 public static final String PARAM1 = "myparam";
3127 public static final String PARAM2 = "myotherparam";
3130 public Iterable<TmfAnalysisRequirement> getAnalysisRequirements() {
3132 // initialize the requirement: domain and events
3133 TmfAnalysisRequirement domainReq = new TmfAnalysisRequirement(SessionConfigStrings.CONFIG_ELEMENT_DOMAIN);
3134 domainReq.addValue(SessionConfigStrings.CONFIG_DOMAIN_TYPE_KERNEL, ValuePriorityLevel.MANDATORY);
3136 List<String> requiredEvents = ImmutableList.of("sched_switch", "sched_wakeup");
3137 TmfAnalysisRequirement eventReq = new TmfAnalysisRequirement(SessionConfigStrings.CONFIG_ELEMENT_EVENT,
3138 requiredEvents, ValuePriorityLevel.MANDATORY);
3140 return ImmutableList.of(domainReq, eventReq);
3144 protected void canceling() {
3145 /* The job I am running in is being cancelled, let's clean up */
3149 protected boolean executeAnalysis(final IProgressMonitor monitor) {
3151 * I am running in an Eclipse job, and I already know I can execute
3154 * In the end, I will return true if I was successfully completed or
3155 * false if I was either interrupted or something wrong occurred.
3157 Object param1 = getParameter(PARAM1);
3158 int param2 = (Integer) getParameter(PARAM2);
3162 public Object getParameter(String name) {
3163 Object value = super.getParameter(name);
3164 /* Make sure the value of param2 is of the right type. For sake of
3165 simplicity, the full parameter format validation is not presented
3167 if ((value != null) && name.equals(PARAM2) && (value instanceof String)) {
3168 return Integer.parseInt((String) value);
3176 === Available base analysis classes and interfaces ===
3178 The following are available as base classes for analysis modules. They also extend the abstract '''TmfAbstractAnalysisModule'''
3180 * '''TmfStateSystemAnalysisModule''': A base analysis module that builds one state system. A module extending this class only needs to provide a state provider and the type of state system backend to use. All state systems should now use this base class as it also contains all the methods to actually create the state sytem with a given backend.
3182 The following interfaces can optionally be implemented by analysis modules if they use their functionalities. For instance, some utility views, like the State System Explorer, may have access to the module's data through these interfaces.
3184 * '''ITmfAnalysisModuleWithStateSystems''': Modules implementing this have one or more state systems included in them. For example, a module may "hide" 2 state system modules for its internal workings. By implementing this interface, it tells that it has state systems and can return them if required.
3186 === How it works ===
3188 Analyses are managed through the '''TmfAnalysisManager'''. The analysis manager is a singleton in the application and keeps track of all available analysis modules, with the help of '''IAnalysisModuleHelper'''. It can be queried to get the available analysis modules, either all of them or only those for a given tracetype. The helpers contain the non-trace specific information on an analysis module: its id, its name, the tracetypes it applies to, etc.
3190 When a trace is opened, the helpers for the applicable analysis create new instances of the analysis modules. The analysis are then kept in a field of the trace and can be executed automatically or on demand.
3192 The analysis is executed by calling the '''IAnalysisModule#schedule()''' method. This method makes sure the analysis is executed only once and, if it is already running, it won't start again. The analysis itself is run inside an Eclipse job that can be cancelled by the user or the application. The developer must consider the progress monitor that comes as a parameter of the '''executeAnalysis()''' method, to handle the proper cancellation of the processing. The '''IAnalysisModule#waitForCompletion()''' method will block the calling thread until the analysis is completed. The method will return whether the analysis was successfully completed or if it was cancelled.
3194 A running analysis can be cancelled by calling the '''IAnalysisModule#cancel()''' method. This will set the analysis as done, so it cannot start again unless it is explicitly reset. This is done by calling the protected method '''resetAnalysis'''.
3196 == Telling TMF about the analysis module ==
3198 Now that the analysis module class exists, it is time to hook it to the rest of TMF so that it appears under the traces in the project explorer. The way to do so is to add an extension of type ''org.eclipse.linuxtools.tmf.core.analysis'' to a plugin, either through the ''Extensions'' tab of the Plug-in Manifest Editor or by editing directly the plugin.xml file.
3200 The following code shows what the resulting plugin.xml file should look like.
3204 point="org.eclipse.linuxtools.tmf.core.analysis">
3206 id="my.lttng.kernel.analysis.id"
3207 name="My LTTng Kernel Analysis"
3208 analysis_module="my.plugin.package.MyLttngKernelAnalysis"
3215 name="myotherparam">
3217 class="org.eclipse.tracecompass.lttng2.kernel.core.trace.LttngKernelTrace">
3223 This defines an analysis module where the ''analysis_module'' attribute corresponds to the module class and must implement IAnalysisModule. This module has 2 parameters: ''myparam'' and ''myotherparam'' which has default value of 3. The ''tracetype'' element tells which tracetypes this analysis applies to. There can be many tracetypes. Also, the ''automatic'' attribute of the module indicates whether this analysis should be run when the trace is opened, or wait for the user's explicit request.
3225 Note that with these extension points, it is possible to use the same module class for more than one analysis (with different ids and names). That is a desirable behavior. For instance, a third party plugin may add a new tracetype different from the one the module is meant for, but on which the analysis can run. Also, different analyses could provide different results with the same module class but with different default values of parameters.
3227 == Attaching outputs and views to the analysis module ==
3229 Analyses will typically produce outputs the user can examine. Outputs can be a text dump, a .dot file, an XML file, a view, etc. All output types must implement the '''IAnalysisOutput''' interface.
3231 An output can be registered to an analysis module at any moment by calling the '''IAnalysisModule#registerOutput()''' method. Analyses themselves may know what outputs are available and may register them in the analysis constructor or after analysis completion.
3233 The various concrete output types are:
3235 * '''TmfAnalysisViewOutput''': It takes a view ID as parameter and, when selected, opens the view.
3237 === Using the extension point to add outputs ===
3239 Analysis outputs can also be hooked to an analysis using the same extension point ''org.eclipse.linuxtools.tmf.core.analysis'' in the plugin.xml file. Outputs can be matched either to a specific analysis identified by an ID, or to all analysis modules extending or implementing a given class or interface.
3241 The following code shows how to add a view output to the analysis defined above directly in the plugin.xml file. This extension does not have to be in the same plugin as the extension defining the analysis. Typically, an analysis module can be defined in a core plugin, along with some outputs that do not require UI elements. Other outputs, like views, who need UI elements, will be defined in a ui plugin.
3245 point="org.eclipse.linuxtools.tmf.core.analysis">
3247 class="org.eclipse.tracecompass.tmf.ui.analysis.TmfAnalysisViewOutput"
3248 id="my.plugin.package.ui.views.myView">
3250 id="my.lttng.kernel.analysis.id">
3254 class="org.eclipse.tracecompass.tmf.ui.analysis.TmfAnalysisViewOutput"
3255 id="my.plugin.package.ui.views.myMoreGenericView">
3256 <analysisModuleClass
3257 class="my.plugin.package.core.MyAnalysisModuleClass">
3258 </analysisModuleClass>
3263 == Providing help for the module ==
3265 For now, the only way to provide a meaningful help message to the user is by overriding the '''IAnalysisModule#getHelpText()''' method and return a string that will be displayed in a message box.
3267 What still needs to be implemented is for a way to add a full user/developer documentation with mediawiki text file for each module and automatically add it to Eclipse Help. Clicking on the Help menu item of an analysis module would open the corresponding page in the help.
3269 == Using analysis parameter providers ==
3271 An analysis may have parameters that can be used during its execution. Default values can be set when describing the analysis module in the plugin.xml file, or they can use the '''IAnalysisParameterProvider''' interface to provide values for parameters. '''TmfAbstractAnalysisParamProvider''' provides an abstract implementation of this interface, that automatically notifies the module of a parameter change.
3273 === Example parameter provider ===
3275 The following example shows how to have a parameter provider listen to a selection in the LTTng kernel Control Flow view and send the thread id to the analysis.
3278 public class MyLttngKernelParameterProvider extends TmfAbstractAnalysisParamProvider {
3280 private ControlFlowEntry fCurrentEntry = null;
3282 private static final String NAME = "My Lttng kernel parameter provider"; //$NON-NLS-1$
3284 private ISelectionListener selListener = new ISelectionListener() {
3286 public void selectionChanged(IWorkbenchPart part, ISelection selection) {
3287 if (selection instanceof IStructuredSelection) {
3288 Object element = ((IStructuredSelection) selection).getFirstElement();
3289 if (element instanceof ControlFlowEntry) {
3290 ControlFlowEntry entry = (ControlFlowEntry) element;
3291 setCurrentThreadEntry(entry);
3300 public MyLttngKernelParameterProvider() {
3306 public String getName() {
3311 public Object getParameter(String name) {
3312 if (fCurrentEntry == null) {
3315 if (name.equals(MyLttngKernelAnalysis.PARAM1)) {
3316 return fCurrentEntry.getThreadId();
3322 public boolean appliesToTrace(ITmfTrace trace) {
3323 return (trace instanceof LttngKernelTrace);
3326 private void setCurrentThreadEntry(ControlFlowEntry entry) {
3327 if (!entry.equals(fCurrentEntry)) {
3328 fCurrentEntry = entry;
3329 this.notifyParameterChanged(MyLttngKernelAnalysis.PARAM1);
3333 private void registerListener() {
3334 final IWorkbench wb = PlatformUI.getWorkbench();
3336 final IWorkbenchPage activePage = wb.getActiveWorkbenchWindow().getActivePage();
3338 /* Add the listener to the control flow view */
3339 view = activePage.findView(ControlFlowView.ID);
3341 view.getSite().getWorkbenchWindow().getSelectionService().addPostSelectionListener(selListener);
3342 view.getSite().getWorkbenchWindow().getPartService().addPartListener(partListener);
3349 === Register the parameter provider to the analysis ===
3351 To have the parameter provider class register to analysis modules, it must first register through the analysis manager. It can be done in a plugin's activator as follows:
3355 public void start(BundleContext context) throws Exception {
3357 TmfAnalysisManager.registerParameterProvider("my.lttng.kernel.analysis.id", MyLttngKernelParameterProvider.class)
3361 where '''MyLttngKernelParameterProvider''' will be registered to analysis ''"my.lttng.kernel.analysis.id"''. When the analysis module is created, the new module will register automatically to the singleton parameter provider instance. Only one module is registered to a parameter provider at a given time, the one corresponding to the currently selected trace.
3363 == Providing requirements to analyses ==
3365 === Analysis requirement provider API ===
3367 A requirement defines the needs of an analysis. For example, an analysis could need an event named ''"sched_switch"'' in order to be properly executed. The requirements are represented by the class '''TmfAnalysisRequirement'''. Since '''IAnalysisModule''' extends the '''IAnalysisRequirementProvider''' interface, all analysis modules must provide their requirements. If the analysis module extends '''TmfAbstractAnalysisModule''', it has the choice between overriding the requirements getter ('''IAnalysisRequirementProvider#getAnalysisRequirements()''') or not, since the abstract class returns an empty collection by default (no requirements).
3369 === Requirement values ===
3371 When instantiating a requirement, the developer needs to specify a type to which all the values added to the requirement will be linked. In the earlier example, there would be an ''"event"'' or ''"eventName"'' type. The type is represented by a string, like all values added to the requirement object. With an 'event' type requirement, a trace generator like the LTTng Control could automatically enable the required events. This is possible by calling the '''TmfAnalysisRequirementHelper''' class. Another point we have to take into consideration is the priority level of each value added to the requirement object. The enum '''TmfAnalysisRequirement#ValuePriorityLevel''' gives the choice between '''ValuePriorityLevel#MANDATORY''' and '''ValuePriorityLevel#OPTIONAL'''. That way, we can tell if an analysis can run without a value or not. To add values, one must call '''TmfAnalysisRequirement#addValue()'''.
3373 Moreover, information can be added to requirements. That way, the developer can explicitly give help details at the requirement level instead of at the analysis level (which would just be a general help text). To add information to a requirement, the method '''TmfAnalysisRequirement#addInformation()''' must be called. Adding information is not mandatory.
3375 === Example of providing requirements ===
3377 In this example, we will implement a method that initializes a requirement object and return it in the '''IAnalysisRequirementProvider#getAnalysisRequirements()''' getter. The example method will return a set with two requirements. The first one will indicate the events needed by a specific analysis and the last one will tell on what domain type the analysis applies. In the event type requirement, we will indicate that the analysis needs a mandatory event and an optional one.
3381 public Iterable<TmfAnalysisRequirement> getAnalysisRequirements() {
3382 Set<TmfAnalysisRequirement> requirements = new HashSet<>();
3384 /* Create requirements of type 'event' and 'domain' */
3385 TmfAnalysisRequirement eventRequirement = new TmfAnalysisRequirement("event");
3386 TmfAnalysisRequirement domainRequirement = new TmfAnalysisRequirement("domain");
3388 /* Add the values */
3389 domainRequirement.addValue("kernel", TmfAnalysisRequirement.ValuePriorityLevel.MANDATORY);
3390 eventRequirement.addValue("sched_switch", TmfAnalysisRequirement.ValuePriorityLevel.MANDATORY);
3391 eventRequirement.addValue("sched_wakeup", TmfAnalysisRequirement.ValuePriorityLevel.OPTIONAL);
3393 /* An information about the events */
3394 eventRequirement.addInformation("The event sched_wakeup is optional because it's not properly handled by this analysis yet.");
3396 /* Add them to the set */
3397 requirements.add(domainRequirement);
3398 requirements.add(eventRequirement);
3400 return requirements;
3407 Here's a list of features not yet implemented that would improve the analysis module user experience:
3409 * Implement help using the Eclipse Help facility (without forgetting an eventual command line request)
3410 * The abstract class '''TmfAbstractAnalysisModule''' executes an analysis as a job, but nothing compels a developer to do so for an analysis implementing the '''IAnalysisModule''' interface. We should force the execution of the analysis as a job, either from the trace itself or using the TmfAnalysisManager or by some other mean.
3411 * Views and outputs are often registered by the analysis themselves (forcing them often to be in the .ui packages because of the views), because there is no other easy way to do so. We should extend the analysis extension point so that .ui plugins or other third-party plugins can add outputs to a given analysis that resides in the core.
3412 * Improve the user experience with the analysis:
3413 ** Allow the user to select which analyses should be available, per trace or per project.
3414 ** Allow the user to view all available analyses even though he has no imported traces.
3415 ** Allow the user to generate traces for a given analysis, or generate a template to generate the trace that can be sent as parameter to the tracer.
3416 ** Give the user a visual status of the analysis: not executed, in progress, completed, error.
3417 ** Give a small screenshot of the output as icon for it.
3418 ** Allow to specify parameter values from the GUI.
3419 * Add the possibility for an analysis requirement to be composed of another requirement.
3420 * Generate a trace session from analysis requirements.
3423 = Performance Tests =
3425 Performance testing allows to calculate some metrics (CPU time, Memory Usage, etc) that some part of the code takes during its execution. These metrics can then be used as is for information on the system's execution, or they can be compared either with other execution scenarios, or previous runs of the same scenario, for instance, after some optimization has been done on the code.
3427 For automatic performance metric computation, we use the ''org.eclipse.test.performance'' plugin, provided by the Eclipse Test Feature.
3429 == Add performance tests ==
3433 Performance tests are unit tests and they are added to the corresponding unit tests plugin. To separate performance tests from unit tests, a separate source folder, typically named ''perf'', is added to the plug-in.
3435 Tests are to be added to a package under the ''perf'' directory, the package name would typically match the name of the package it is testing. For each package, a class named '''AllPerfTests''' would list all the performance tests classes inside this package. And like for unit tests, a class named '''AllPerfTests''' for the plug-in would list all the packages' '''AllPerfTests''' classes.
3437 When adding performance tests for the first time in a plug-in, the plug-in's '''AllPerfTests''' class should be added to the global list of performance tests, found in package ''org.eclipse.tracecompass.alltests'', in class '''RunAllPerfTests'''. This will ensure that performance tests for the plug-in are run along with the other performance tests
3441 TMF is using the org.eclipse.test.performance framework for performance tests. Using this, performance metrics are automatically taken and, if many runs of the tests are run, average and standard deviation are automatically computed. Results can optionally be stored to a database for later use.
3443 Here is an example of how to use the test framework in a performance test:
3446 public class AnalysisBenchmark {
3448 private static final String TEST_ID = "org.eclipse.linuxtools#LTTng kernel analysis";
3449 private static final CtfTmfTestTrace testTrace = CtfTmfTestTrace.TRACE2;
3450 private static final int LOOP_COUNT = 10;
3456 public void testTrace() {
3457 assumeTrue(testTrace.exists());
3459 /** Create a new performance meter for this scenario */
3460 Performance perf = Performance.getDefault();
3461 PerformanceMeter pm = perf.createPerformanceMeter(TEST_ID);
3463 /** Optionally, tag this test for summary or global summary on a given dimension */
3464 perf.tagAsSummary(pm, "LTTng Kernel Analysis", Dimension.CPU_TIME);
3465 perf.tagAsGlobalSummary(pm, "LTTng Kernel Analysis", Dimension.CPU_TIME);
3467 /** The test will be run LOOP_COUNT times */
3468 for (int i = 0; i < LOOP_COUNT; i++) {
3470 /** Start each run of the test with new objects to avoid different code paths */
3471 try (IAnalysisModule module = new KernelAnalysis();
3472 LttngKernelTrace trace = new LttngKernelTrace()) {
3473 module.setId("test");
3474 trace.initTrace(null, testTrace.getPath(), CtfTmfEvent.class);
3475 module.setTrace(trace);
3477 /** The analysis execution is being tested, so performance metrics
3478 * are taken before and after the execution */
3480 TmfTestHelper.executeAnalysis(module);
3484 * Delete the supplementary files, so next iteration rebuilds
3487 File suppDir = new File(TmfTraceManager.getSupplementaryFileDir(trace));
3488 for (File file : suppDir.listFiles()) {
3492 } catch (TmfAnalysisException | TmfTraceException e) {
3493 fail(e.getMessage());
3497 /** Once the test has been run many times, committing the results will
3498 * calculate average, standard deviation, and, if configured, save the
3499 * data to a database */
3506 For more information, see [http://wiki.eclipse.org/Performance/Automated_Tests The Eclipse Performance Test How-to]
3508 Some rules to help write performance tests are explained in section [[#ABC of performance testing | ABC of performance testing]].
3510 === Run a performance test ===
3512 Performance tests are unit tests, so, just like unit tests, they can be run by right-clicking on a performance test class and selecting ''Run As'' -> ''Junit Plug-in Test''.
3514 By default, if no database has been configured, results will be displayed in the Console at the end of the test.
3516 Here is the sample output from the test described in the previous section. It shows all the metrics that have been calculated during the test.
3519 Scenario 'org.eclipse.linuxtools#LTTng kernel analysis' (average over 10 samples):
3520 System Time: 3.04s (95% in [2.77s, 3.3s]) Measurable effect: 464ms (1.3 SDs) (required sample size for an effect of 5% of mean: 94)
3521 Used Java Heap: -1.43M (95% in [-33.67M, 30.81M]) Measurable effect: 57.01M (1.3 SDs) (required sample size for an effect of 5% of stdev: 6401)
3522 Working Set: 14.43M (95% in [-966.01K, 29.81M]) Measurable effect: 27.19M (1.3 SDs) (required sample size for an effect of 5% of stdev: 6400)
3523 Elapsed Process: 3.04s (95% in [2.77s, 3.3s]) Measurable effect: 464ms (1.3 SDs) (required sample size for an effect of 5% of mean: 94)
3524 Kernel time: 621ms (95% in [586ms, 655ms]) Measurable effect: 60ms (1.3 SDs) (required sample size for an effect of 5% of mean: 39)
3525 CPU Time: 6.06s (95% in [5.02s, 7.09s]) Measurable effect: 1.83s (1.3 SDs) (required sample size for an effect of 5% of mean: 365)
3526 Hard Page Faults: 0 (95% in [0, 0]) Measurable effect: 0 (1.3 SDs) (required sample size for an effect of 5% of stdev: 6400)
3527 Soft Page Faults: 9.27K (95% in [3.28K, 15.27K]) Measurable effect: 10.6K (1.3 SDs) (required sample size for an effect of 5% of mean: 5224)
3528 Text Size: 0 (95% in [0, 0])
3529 Data Size: 0 (95% in [0, 0])
3530 Library Size: 32.5M (95% in [-12.69M, 77.69M]) Measurable effect: 79.91M (1.3 SDs) (required sample size for an effect of 5% of stdev: 6401)
3533 Results from performance tests can be saved automatically to a derby database. Derby can be run either in embedded mode, locally on a machine, or on a server. More information on setting up derby for performance tests can be found here: [http://wiki.eclipse.org/Performance/Automated_Tests The Eclipse Performance Test How-to]. The following documentation will show how to configure an Eclipse run configuration to store results on a derby database located on a server.
3535 Note that to store results in a derby database, the ''org.apache.derby'' plug-in must be available within your Eclipse. Since it is an optional dependency, it is not included in the target definition. It can be installed via the '''Orbit''' repository, in ''Help'' -> ''Install new software...''. If the '''Orbit''' repository is not listed, click on the latest one from [http://download.eclipse.org/tools/orbit/downloads/] and copy the link under ''Orbit Build Repository''.
3537 To store the data to a database, it needs to be configured in the run configuration. In ''Run'' -> ''Run configurations..'', under ''Junit Plug-in Test'', find the run configuration that corresponds to the test you wish to run, or create one if it is not present yet.
3539 In the ''Arguments'' tab, in the box under ''VM Arguments'', add on separate lines the following information
3542 -Declipse.perf.dbloc=//javaderby.dorsal.polymtl.ca
3543 -Declipse.perf.config=build=mybuild;host=myhost;config=linux;jvm=1.7
3546 The ''eclipse.perf.dbloc'' parameter is the url (or filename) of the derby database. The database is by default named ''perfDB'', with username and password ''guest''/''guest''. If the database does not exist, it will be created, initialized and populated.
3548 The ''eclipse.perf.config'' parameter identifies a '''variation''': It typically identifies the build on which is it run (commitId and/or build date, etc), the machine (host) on which it is run, the configuration of the system (for example Linux or Windows), the jvm etc. That parameter is a list of ';' separated key-value pairs. To be backward-compatible with the Eclipse Performance Tests Framework, the 4 keys mentioned above are mandatory, but any key-value pairs can be used.
3550 == ABC of performance testing ==
3552 Here follow some rules to help design good and meaningful performance tests.
3554 === Determine what to test ===
3556 For tests to be significant, it is important to choose what exactly is to be tested and make sure it is reproducible every run. To limit the amount of noise caused by the TMF framework, the performance test code should be tweaked so that only the method under test is run. For instance, a trace should not be "opened" (by calling the ''traceOpened()'' method) to test an analysis, since the ''traceOpened'' method will also trigger the indexing and the execution of all applicable automatic analysis.
3558 For each code path to test, multiple scenarios can be defined. For instance, an analysis could be run on different traces, with different sizes. The results will show how the system scales and/or varies depending on the objects it is executed on.
3560 The number of '''samples''' used to compute the results is also important. The code to test will typically be inside a '''for''' loop that runs exactly the same code each time for a given number of times. All objects used for the test must start in the same state at each iteration of the loop. For instance, any trace used during an execution should be disposed of at the end of the loop, and any supplementary file that may have been generated in the run should be deleted.
3562 Before submitting a performance test to the code review, you should run it a few times (with results in the Console) and see if the standard deviation is not too large and if the results are reproducible.
3564 === Metrics descriptions and considerations ===
3566 CPU time: CPU time represent the total time spent on CPU by the current process, for the time of the test execution. It is the sum of the time spent by all threads. On one hand, it is more significant than the elapsed time, since it should be the same no matter how many CPU cores the computer has. But since it calculates the time of every thread, one has to make sure that only threads related to what is being tested are executed during that time, or else the results will include the times of those other threads. For an application like TMF, it is hard to control all the threads, and empirically, it is found to vary a lot more than the system time from one run to the other.
3568 System time (Elapsed time): The time between the start and the end of the execution. It will vary depending on the parallelization of the threads and the load of the machine.
3570 Kernel time: Time spent in kernel mode
3572 Used Java Heap: It is the difference between the memory used at the beginning of the execution and at the end. This metric may be useful to calculate the overall size occupied by the data generated by the test run, by forcing a garbage collection before taking the metrics at the beginning and at the end of the execution. But it will not show the memory used throughout the execution. There can be a large standard deviation. The reason for this is that when benchmarking methods that trigger tasks in different threads, like signals and/or analysis, these other threads might be in various states at each run of the test, which will impact the memory usage calculated. When using this metric, either make sure the method to test does not trigger external threads or make sure you wait for them to finish.
3576 == Adding a protocol ==
3578 Supporting a new network protocol in TMF is straightforward. Minimal effort is required to support new protocols. In this tutorial, the UDP protocol will be added to the list of supported protocols.
3580 === Architecture ===
3582 All the TMF pcap-related code is divided in three projects (not considering the tests plugins):
3583 * '''org.eclipse.tracecompass.pcap.core''', which contains the parser that will read pcap files and constructs the different packets from a ByteBuffer. It also contains means to build packet streams, which are conversation (list of packets) between two endpoints. To add a protocol, almost all of the work will be in that project.
3584 * '''org.eclipse.tracecompass.tmf.pcap.core''', which contains TMF-specific concepts and act as a wrapper between TMF and the pcap parsing library. It only depends on org.eclipse.tracecompass.tmf.core and org.eclipse.tracecompass.pcap.core. To add a protocol, one file must be edited in this project.
3585 * '''org.eclipse.tracecompass.tmf.pcap.ui''', which contains all TMF pcap UI-specific concepts, such as the views and perspectives. No work is needed in that project.
3587 === UDP Packet Structure ===
3589 The UDP is a transport-layer protocol that does not guarantee message delivery nor in-order message reception. A UDP packet (datagram) has the following [http://en.wikipedia.org/wiki/User_Datagram_Protocol#Packet_structure structure]:
3591 {| class="wikitable" style="margin: 0 auto; text-align: center;"
3593 ! style="border-bottom:none; border-right:none;"| ''Offsets''
3594 ! style="border-left:none;"| Octet
3600 ! style="border-top: none" | Octet
3601 ! <tt>Bit</tt>!!<tt> 0</tt>!!<tt> 1</tt>!!<tt> 2</tt>!!<tt> 3</tt>!!<tt> 4</tt>!!<tt> 5</tt>!!<tt> 6</tt>!!<tt> 7</tt>!!<tt> 8</tt>!!<tt> 9</tt>!!<tt>10</tt>!!<tt>11</tt>!!<tt>12</tt>!!<tt>13</tt>!!<tt>14</tt>!!<tt>15</tt>!!<tt>16</tt>!!<tt>17</tt>!!<tt>18</tt>!!<tt>19</tt>!!<tt>20</tt>!!<tt>21</tt>!!<tt>22</tt>!!<tt>23</tt>!!<tt>24</tt>!!<tt>25</tt>!!<tt>26</tt>!!<tt>27</tt>!!<tt>28</tt>!!<tt>29</tt>!!<tt>30</tt>!!<tt>31</tt>
3605 | colspan="16" style="background:#fdd;"| Source port || colspan="16"| Destination port
3609 | colspan="16"| Length || colspan="16" style="background:#fdd;"| Checksum
3612 Knowing that, we can define an UDPPacket class that contains those fields.
3614 === Creating the UDPPacket ===
3616 First, in org.eclipse.tracecompass.pcap.core, create a new package named '''org.eclipse.tracecompass.pcap.core.protocol.name''' with name being the name of the new protocol. In our case name is udp so we create the package '''org.eclipse.tracecompass.pcap.core.protocol.udp'''. All our work is going in this package.
3618 In this package, we create a new class named UDPPacket that extends Packet. All new protocol must define a packet type that extends the abstract class Packet. We also add different fields:
3619 * ''Packet'' '''fChildPacket''', which is the packet encapsulated by this UDP packet, if it exists. This field will be initialized by findChildPacket().
3620 * ''ByteBuffer'' '''fPayload''', which is the payload of this packet. Basically, it is the UDP packet without its header.
3621 * ''int'' '''fSourcePort''', which is an unsigned 16-bits field, that contains the source port of the packet (see packet structure).
3622 * ''int'' '''fDestinationPort''', which is an unsigned 16-bits field, that contains the destination port of the packet (see packet structure).
3623 * ''int'' '''fTotalLength''', which is an unsigned 16-bits field, that contains the total length (header + payload) of the packet.
3624 * ''int'' '''fChecksum''', which is an unsigned 16-bits field, that contains a checksum to verify the integrity of the data.
3625 * ''UDPEndpoint'' '''fSourceEndpoint''', which contains the source endpoint of the UDPPacket. The UDPEndpoint class will be created later in this tutorial.
3626 * ''UDPEndpoint'' '''fDestinationEndpoint''', which contains the destination endpoint of the UDPPacket.
3627 * ''ImmutableMap<String, String>'' '''fFields''', which is a map that contains all the packet fields (see in data structure) which assign a field name with its value. Those values will be displayed on the UI.
3629 We also create the UDPPacket(PcapFile file, @Nullable Packet parent, ByteBuffer packet) constructor. The parameters are:
3630 * ''PcapFile'' '''file''', which is the pcap file to which this packet belongs.
3631 * ''Packet'' '''parent''', which is the packet encasulating this UDPPacket
3632 * ''ByteBuffer'' '''packet''', which is a ByteBuffer that contains all the data necessary to initialize the fields of this UDPPacket. We will retrieve bytes from it during object construction.
3634 The following class is obtained:
3637 package org.eclipse.tracecompass.pcap.core.protocol.udp;
3639 import java.nio.ByteBuffer;
3640 import java.util.Map;
3642 import org.eclipse.tracecompass.internal.pcap.core.endpoint.ProtocolEndpoint;
3643 import org.eclipse.tracecompass.internal.pcap.core.packet.BadPacketException;
3644 import org.eclipse.tracecompass.internal.pcap.core.packet.Packet;
3646 public class UDPPacket extends Packet {
3648 private final @Nullable Packet fChildPacket;
3649 private final @Nullable ByteBuffer fPayload;
3651 private final int fSourcePort;
3652 private final int fDestinationPort;
3653 private final int fTotalLength;
3654 private final int fChecksum;
3656 private @Nullable UDPEndpoint fSourceEndpoint;
3657 private @Nullable UDPEndpoint fDestinationEndpoint;
3659 private @Nullable ImmutableMap<String, String> fFields;
3662 * Constructor of the UDP Packet class.
3665 * The file that contains this packet.
3667 * The parent packet of this packet (the encapsulating packet).
3669 * The entire packet (header and payload).
3670 * @throws BadPacketException
3671 * Thrown when the packet is erroneous.
3673 public UDPPacket(PcapFile file, @Nullable Packet parent, ByteBuffer packet) throws BadPacketException {
3674 super(file, parent, PcapProtocol.UDP);
3675 // TODO Auto-generated constructor stub
3680 public Packet getChildPacket() {
3681 // TODO Auto-generated method stub
3686 public ByteBuffer getPayload() {
3687 // TODO Auto-generated method stub
3692 public boolean validate() {
3693 // TODO Auto-generated method stub
3698 protected Packet findChildPacket() throws BadPacketException {
3699 // TODO Auto-generated method stub
3704 public ProtocolEndpoint getSourceEndpoint() {
3705 // TODO Auto-generated method stub
3710 public ProtocolEndpoint getDestinationEndpoint() {
3711 // TODO Auto-generated method stub
3716 public Map<String, String> getFields() {
3717 // TODO Auto-generated method stub
3722 public String getLocalSummaryString() {
3723 // TODO Auto-generated method stub
3728 protected String getSignificationString() {
3729 // TODO Auto-generated method stub
3734 public boolean equals(Object obj) {
3735 // TODO Auto-generated method stub
3740 public int hashCode() {
3741 // TODO Auto-generated method stub
3748 Now, we implement the constructor. It is done in four steps:
3749 * We initialize fSourceEndpoint, fDestinationEndpoint and fFields to null, since those are lazy-loaded. This allows faster construction of the packet and thus faster parsing.
3750 * We initialize fSourcePort, fDestinationPort, fTotalLength, fChecksum using ByteBuffer packet. Thanks to the packet data structure, we can simply retrieve packet.getShort() to get the value. Since there is no unsigned in Java, special care is taken to avoid negative number. We use the utility method ConversionHelper.unsignedShortToInt() to convert it to an integer, and initialize the fields.
3751 * Now that the header is parsed, we take the rest of the ByteBuffer packet to initialize the payload, if there is one. To do this, we simply generate a new ByteBuffer starting from the current position.
3752 * We initialize the field fChildPacket using the method findChildPacket()
3754 The following constructor is obtained:
3756 public UDPPacket(PcapFile file, @Nullable Packet parent, ByteBuffer packet) throws BadPacketException {
3757 super(file, parent, Protocol.UDP);
3759 // The endpoints and fFields are lazy loaded. They are defined in the get*Endpoint()
3761 fSourceEndpoint = null;
3762 fDestinationEndpoint = null;
3765 // Initialize the fields from the ByteBuffer
3766 packet.order(ByteOrder.BIG_ENDIAN);
3769 fSourcePort = ConversionHelper.unsignedShortToInt(packet.getShort());
3770 fDestinationPort = ConversionHelper.unsignedShortToInt(packet.getShort());
3771 fTotalLength = ConversionHelper.unsignedShortToInt(packet.getShort());
3772 fChecksum = ConversionHelper.unsignedShortToInt(packet.getShort());
3774 // Initialize the payload
3775 if (packet.array().length - packet.position() > 0) {
3776 byte[] array = new byte[packet.array().length - packet.position()];
3779 ByteBuffer payload = ByteBuffer.wrap(array);
3780 payload.order(ByteOrder.BIG_ENDIAN);
3781 payload.position(0);
3788 fChildPacket = findChildPacket();
3793 Then, we implement the following methods:
3794 * ''public Packet'' '''getChildPacket()''': simple getter of fChildPacket
3795 * ''public ByteBuffer'' '''getPayload()''': simple getter of fPayload
3796 * ''public boolean'' '''validate()''': method that checks if the packet is valid. In our case, the packet is valid if the retrieved checksum fChecksum and the real checksum (that we can compute using the fields and payload of UDPPacket) are the same.
3797 * ''protected Packet'' '''findChildPacket()''': method that create a new packet if a encapsulated protocol is found. For instance, based on the fDestinationPort, it could determine what the encapsulated protocol is and creates a new packet object.
3798 * ''public ProtocolEndpoint'' '''getSourceEndpoint()''': method that initializes and returns the source endpoint.
3799 * ''public ProtocolEndpoint'' '''getDestinationEndpoint()''': method that initializes and returns the destination endpoint.
3800 * ''public Map<String, String>'' '''getFields()''': method that initializes and returns the map containing the fields matched to their value.
3801 * ''public String'' '''getLocalSummaryString()''': method that returns a string summarizing the most important fields of the packet. There is no need to list all the fields, just the most important one. This will be displayed on UI.
3802 * ''protected String'' '''getSignificationString()''': method that returns a string describing the meaning of the packet. If there is no particular meaning, it is possible to return getLocalSummaryString().
3803 * public boolean'' '''equals(Object obj)''': Object's equals method.
3804 * public int'' '''hashCode()''': Object's hashCode method.
3806 We get the following code:
3809 public @Nullable Packet getChildPacket() {
3810 return fChildPacket;
3814 public @Nullable ByteBuffer getPayload() {
3819 * Getter method that returns the UDP Source Port.
3821 * @return The source Port.
3823 public int getSourcePort() {
3828 * Getter method that returns the UDP Destination Port.
3830 * @return The destination Port.
3832 public int getDestinationPort() {
3833 return fDestinationPort;
3839 * See http://www.iana.org/assignments/service-names-port-numbers/service-
3840 * names-port-numbers.xhtml or
3841 * http://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers
3844 protected @Nullable Packet findChildPacket() throws BadPacketException {
3845 // When more protocols are implemented, we can simply do a switch on the fDestinationPort field to find the child packet.
3846 // For instance, if the destination port is 80, then chances are the HTTP protocol is encapsulated. We can create a new HTTP
3847 // packet (after some verification that it is indeed the HTTP protocol).
3848 ByteBuffer payload = fPayload;
3849 if (payload == null) {
3853 return new UnknownPacket(getPcapFile(), this, payload);
3857 public boolean validate() {
3858 // Not yet implemented. ATM, we consider that all packets are valid.
3859 // TODO Implement it. We can compute the real checksum and compare it to fChecksum.
3864 public UDPEndpoint getSourceEndpoint() {
3866 UDPEndpoint endpoint = fSourceEndpoint;
3867 if (endpoint == null) {
3868 endpoint = new UDPEndpoint(this, true);
3870 fSourceEndpoint = endpoint;
3871 return fSourceEndpoint;
3875 public UDPEndpoint getDestinationEndpoint() {
3876 @Nullable UDPEndpoint endpoint = fDestinationEndpoint;
3877 if (endpoint == null) {
3878 endpoint = new UDPEndpoint(this, false);
3880 fDestinationEndpoint = endpoint;
3881 return fDestinationEndpoint;
3885 public Map<String, String> getFields() {
3886 ImmutableMap<String, String> map = fFields;
3888 @SuppressWarnings("null")
3889 @NonNull ImmutableMap<String, String> newMap = ImmutableMap.<String, String> builder()
3890 .put("Source Port", String.valueOf(fSourcePort)) //$NON-NLS-1$
3891 .put("Destination Port", String.valueOf(fDestinationPort)) //$NON-NLS-1$
3892 .put("Length", String.valueOf(fTotalLength) + " bytes") //$NON-NLS-1$ //$NON-NLS-2$
3893 .put("Checksum", String.format("%s%04x", "0x", fChecksum)) //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
3902 public String getLocalSummaryString() {
3903 return "Src Port: " + fSourcePort + ", Dst Port: " + fDestinationPort; //$NON-NLS-1$ //$NON-NLS-2$
3907 protected String getSignificationString() {
3908 return "Source Port: " + fSourcePort + ", Destination Port: " + fDestinationPort; //$NON-NLS-1$ //$NON-NLS-2$
3912 public int hashCode() {
3913 final int prime = 31;
3915 result = prime * result + fChecksum;
3916 final Packet child = fChildPacket;
3917 if (child != null) {
3918 result = prime * result + child.hashCode();
3920 result = prime * result;
3922 result = prime * result + fDestinationPort;
3923 final ByteBuffer payload = fPayload;
3924 if (payload != null) {
3925 result = prime * result + payload.hashCode();
3927 result = prime * result;
3929 result = prime * result + fSourcePort;
3930 result = prime * result + fTotalLength;
3935 public boolean equals(@Nullable Object obj) {
3942 if (getClass() != obj.getClass()) {
3945 UDPPacket other = (UDPPacket) obj;
3946 if (fChecksum != other.fChecksum) {
3949 final Packet child = fChildPacket;
3950 if (child != null) {
3951 if (!child.equals(other.fChildPacket)) {
3955 if (other.fChildPacket != null) {
3959 if (fDestinationPort != other.fDestinationPort) {
3962 final ByteBuffer payload = fPayload;
3963 if (payload != null) {
3964 if (!payload.equals(other.fPayload)) {
3968 if (other.fPayload != null) {
3972 if (fSourcePort != other.fSourcePort) {
3975 if (fTotalLength != other.fTotalLength) {
3982 The UDPPacket class is implemented. We now have the define the UDPEndpoint.
3984 === Creating the UDPEndpoint ===
3986 For the UDP protocol, an endpoint will be its source or its destination port, depending if it is the source endpoint or destination endpoint. Knowing that, we can create our UDPEndpoint class.
3988 We create in our package a new class named UDPEndpoint that extends ProtocolEndpoint. We also add a field: fPort, which contains the source or destination port. We finally add a constructor public ExampleEndpoint(Packet packet, boolean isSourceEndpoint):
3989 * ''Packet'' '''packet''': the packet to build the endpoint from.
3990 * ''boolean'' '''isSourceEndpoint''': whether the endpoint is the source endpoint or destination endpoint.
3992 We obtain the following unimplemented class:
3995 package org.eclipse.tracecompass.pcap.core.protocol.udp;
3997 import org.eclipse.tracecompass.internal.pcap.core.endpoint.ProtocolEndpoint;
3998 import org.eclipse.tracecompass.internal.pcap.core.packet.Packet;
4000 public class UDPEndpoint extends ProtocolEndpoint {
4002 private final int fPort;
4004 public UDPEndpoint(Packet packet, boolean isSourceEndpoint) {
4005 super(packet, isSourceEndpoint);
4006 // TODO Auto-generated constructor stub
4010 public int hashCode() {
4011 // TODO Auto-generated method stub
4016 public boolean equals(Object obj) {
4017 // TODO Auto-generated method stub
4022 public String toString() {
4023 // TODO Auto-generated method stub
4030 For the constructor, we simply initialize fPort. If isSourceEndpoint is true, then we take packet.getSourcePort(), else we take packet.getDestinationPort().
4034 * Constructor of the {@link UDPEndpoint} class. It takes a packet to get
4035 * its endpoint. Since every packet has two endpoints (source and
4036 * destination), the isSourceEndpoint parameter is used to specify which
4040 * The packet that contains the endpoints.
4041 * @param isSourceEndpoint
4042 * Whether to take the source or the destination endpoint of the
4045 public UDPEndpoint(UDPPacket packet, boolean isSourceEndpoint) {
4046 super(packet, isSourceEndpoint);
4047 fPort = isSourceEndpoint ? packet.getSourcePort() : packet.getDestinationPort();
4051 Then we implement the methods:
4052 * ''public int'' '''hashCode()''': method that returns an integer based on the fields value. In our case, it will return an integer depending on fPort, and the parent endpoint that we can retrieve with getParentEndpoint().
4053 * ''public boolean'' '''equals(Object obj)''': method that returns true if two objects are equals. In our case, two UDPEndpoints are equal if they both have the same fPort and have the same parent endpoint that we can retrieve with getParentEndpoint().
4054 * ''public String'' '''toString()''': method that returns a description of the UDPEndpoint as a string. In our case, it will be a concatenation of the string of the parent endpoint and fPort as a string.
4058 public int hashCode() {
4059 final int prime = 31;
4061 ProtocolEndpoint endpoint = getParentEndpoint();
4062 if (endpoint == null) {
4065 result = endpoint.hashCode();
4067 result = prime * result + fPort;
4072 public boolean equals(@Nullable Object obj) {
4076 if (!(obj instanceof UDPEndpoint)) {
4080 UDPEndpoint other = (UDPEndpoint) obj;
4083 boolean localEquals = (fPort == other.fPort);
4088 // Check above layers.
4089 ProtocolEndpoint endpoint = getParentEndpoint();
4090 if (endpoint != null) {
4091 return endpoint.equals(other.getParentEndpoint());
4097 public String toString() {
4098 ProtocolEndpoint endpoint = getParentEndpoint();
4099 if (endpoint == null) {
4100 @SuppressWarnings("null")
4101 @NonNull String ret = String.valueOf(fPort);
4104 return endpoint.toString() + '/' + fPort;
4108 === Registering the UDP protocol ===
4110 The last step is to register the new protocol. There are three places where the protocol has to be registered. First, the parser has to know that a new protocol has been added. This is defined in the enum org.eclipse.tracecompass.internal.pcap.core.protocol.PcapProtocol. Simply add the protocol name here, along with a few arguments:
4111 * ''String'' '''longname''', which is the long version of name of the protocol. In our case, it is "User Datagram Protocol".
4112 * ''String'' '''shortName''', which is the shortened name of the protocol. In our case, it is "UDP".
4113 * ''Layer'' '''layer''', which is the layer to which the protocol belongs in the OSI model. In our case, this is the layer 4.
4114 * ''boolean'' '''supportsStream''', which defines whether or not the protocol supports packet streams. In our case, this is set to true.
4116 Thus, the following line is added in the PcapProtocol enum:
4118 UDP("User Datagram Protocol", "udp", Layer.LAYER_4, true),
4121 Also, TMF has to know about the new protocol. This is defined in org.eclipse.tracecompass.internal.tmf.pcap.core.protocol.TmfPcapProtocol. We simply add it, with a reference to the corresponding protocol in PcapProtocol. Thus, the following line is added in the TmfPcapProtocol enum:
4123 UDP(PcapProtocol.UDP),
4126 You will also have to update the ''ProtocolConversion'' class to register the protocol in the switch statements. Thus, for UDP, we add:
4129 return TmfPcapProtocol.UDP;
4134 return PcapProtocol.UDP;
4137 Finally, all the protocols that could be the parent of the new protocol (in our case, IPv4 and IPv6) have to be notified of the new protocol. This is done by modifying the findChildPacket() method of the packet class of those protocols. For instance, in IPv4Packet, we add a case in the switch statement of findChildPacket, if the Protocol number matches UDP's protocol number at the network layer:
4140 protected @Nullable Packet findChildPacket() throws BadPacketException {
4141 ByteBuffer payload = fPayload;
4142 if (payload == null) {
4146 switch (fIpDatagramProtocol) {
4147 case IPProtocolNumberHelper.PROTOCOL_NUMBER_TCP:
4148 return new TCPPacket(getPcapFile(), this, payload);
4149 case IPProtocolNumberHelper.PROTOCOL_NUMBER_UDP:
4150 return new UDPPacket(getPcapFile(), this, payload);
4152 return new UnknownPacket(getPcapFile(), this, payload);
4157 The new protocol has been added. Running TMF should work just fine, and the new protocol is now recognized.
4159 == Adding stream-based views ==
4161 To add a stream-based View, simply monitor the TmfPacketStreamSelectedSignal in your view. It contains the new stream that you can retrieve with signal.getStream(). You must then make an event request to the current trace to get the events, and use the stream to filter the events of interest. Therefore, you must also monitor TmfTraceOpenedSignal, TmfTraceClosedSignal and TmfTraceSelectedSignal. Examples of stream-based views include a view that represents the packets as a sequence diagram, or that shows the TCP connection state based on the packets SYN/ACK/FIN/RST flags. A (very very very early) draft of such a view can be found at https://git.eclipse.org/r/#/c/31054/.
4165 * Add more protocols. At the moment, only four protocols are supported. The following protocols would need to be implemented: ARP, SLL, WLAN, USB, IPv6, ICMP, ICMPv6, IGMP, IGMPv6, SCTP, DNS, FTP, HTTP, RTP, SIP, SSH and Telnet. Other VoIP protocols would be nice.
4166 * Add a network graph view. It would be useful to produce graphs that are meaningful to network engineers, and that they could use (for presentation purpose, for instance). We could use the XML-based analysis to do that!
4167 * Add a Stream Diagram view. This view would represent a stream as a Sequence Diagram. It would be updated when a TmfNewPacketStreamSignal is thrown. It would be easy to see the packet exchange and the time delta between each packet. Also, when a packet is selected in the Stream Diagram, it should be selected in the event table and its content should be shown in the Properties View. See https://git.eclipse.org/r/#/c/31054/ for a draft of such a view.
4168 * Make adding protocol more "plugin-ish", via extension points for instance. This would make it easier to support new protocols, without modifying the source code.
4169 * Control dumpcap directly from eclipse, similar to how LTTng is controlled in the Control View.
4170 * Support pcapng. See: http://www.winpcap.org/ntar/draft/PCAP-DumpFileFormat.html for the file format.
4171 * Add SWTBOT tests to org.eclipse.tracecompass.tmf.pcap.ui
4172 * Add a Raw Viewer, similar to Wireshark. We could use the “Show Raw” in the event editor to do that.
4173 * Externalize strings in org.eclipse.tracecompass.pcap.core. At the moment, all the strings are hardcoded. It would be good to externalize them all.