1 /*******************************************************************************
2 * Copyright (c) 2009, 2014 Ericsson, École Polytechnique de Montréal
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Francois Chouinard - Initial API and implementation
11 * Francois Chouinard - Updated as per TMF Trace Model 1.0
12 * Geneviève Bastien - Added timestamp transforms and timestamp
14 * Patrick Tasse - Add support for folder elements
15 *******************************************************************************/
17 package org
.eclipse
.tracecompass
.tmf
.core
.trace
;
19 import org
.eclipse
.core
.resources
.IProject
;
20 import org
.eclipse
.core
.resources
.IResource
;
21 import org
.eclipse
.core
.runtime
.IStatus
;
22 import org
.eclipse
.jdt
.annotation
.NonNull
;
23 import org
.eclipse
.jdt
.annotation
.Nullable
;
24 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisModule
;
25 import org
.eclipse
.tracecompass
.tmf
.core
.component
.ITmfEventProvider
;
26 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
27 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.ITmfEventAspect
;
28 import org
.eclipse
.tracecompass
.tmf
.core
.exceptions
.TmfTraceException
;
29 import org
.eclipse
.tracecompass
.tmf
.core
.synchronization
.ITmfTimestampTransform
;
30 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
31 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimeRange
;
32 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.indexer
.ITmfTraceIndexer
;
33 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.location
.ITmfLocation
;
36 * The event stream structure in TMF. In its basic form, a trace has:
38 * <li> an associated Eclipse resource
39 * <li> a path to its location on the file system
40 * <li> the type of the events it contains
41 * <li> the number of events it contains
42 * <li> the time range (span) of the events it contains
44 * Concrete ITmfTrace classes have to provide a parameter-less constructor and
45 * an initialization method (<i>initTrace</i>) if they are to be opened from the
46 * Project View. Also, a validation method (<i>validate</i>) has to be provided
47 * to ensure that the trace is of the correct type.
49 * A trace can be accessed simultaneously from multiple threads by various
50 * application components. To avoid obvious multi-threading issues, the trace
51 * uses an ITmfContext as a synchronization aid for its read operations.
53 * A proper ITmfContext can be obtained by performing a seek operation on the
54 * trace. Seek operations can be performed for a particular event (by rank or
55 * timestamp) or for a plain trace location.
57 * <b>Example 1</b>: Process a whole trace
59 * ITmfContext context = trace.seekEvent(0);
60 * ITmfEvent event = trace.getNext(context);
61 * while (event != null) {
62 * processEvent(event);
63 * event = trace.getNext(context);
66 * <b>Example 2</b>: Process 50 events starting from the 1000th event
68 * int nbEventsRead = 0;
69 * ITmfContext context = trace.seekEvent(1000);
70 * ITmfEvent event = trace.getNext(context);
71 * while (event != null && nbEventsRead < 50) {
73 * processEvent(event);
74 * event = trace.getNext(context);
77 * <b>Example 3</b>: Process the events between 2 timestamps (inclusive)
79 * ITmfTimestamp startTime = ...;
80 * ITmfTimestamp endTime = ...;
81 * ITmfContext context = trace.seekEvent(startTime);
82 * ITmfEvent event = trace.getNext(context);
83 * while (event != null && event.getTimestamp().compareTo(endTime) <= 0) {
84 * processEvent(event);
85 * event = trace.getNext(context);
89 * A trace is also an event provider so it can process event requests
90 * asynchronously (and coalesce compatible, concurrent requests).
93 * <b>Example 4</b>: Process a whole trace (see ITmfEventRequest for
96 * ITmfRequest request = new TmfEventRequest<MyEventType>(MyEventType.class) {
98 * public void handleData(MyEventType event) {
99 * super.handleData(event);
100 * processEvent(event);
104 * public void handleCompleted() {
106 * super.handleCompleted();
110 * fTrace.handleRequest(request);
112 * request.waitForCompletion();
117 * @author Francois Chouinard
121 * @see ITmfTraceIndexer
122 * @see ITmfEventParser
124 public interface ITmfTrace
extends ITmfEventProvider
{
126 // ------------------------------------------------------------------------
128 // ------------------------------------------------------------------------
131 * The default trace cache size
133 public static final int DEFAULT_TRACE_CACHE_SIZE
= 1000;
135 // ------------------------------------------------------------------------
137 // ------------------------------------------------------------------------
140 * Initialize a newly instantiated "empty" trace object. This is used to
141 * properly parameterize an ITmfTrace instantiated with its parameterless
144 * Typically, the parameterless constructor will provide the block size and
145 * its associated parser and indexer.
150 * the trace path. The path should suitable for passing to
151 * <code>java.io.File(String)</code> and should use the
152 * platform-dependent path separator.
154 * the trace event type
155 * @throws TmfTraceException
156 * If we couldn't open the trace
158 void initTrace(IResource resource
, String path
, Class
<?
extends ITmfEvent
> type
) throws TmfTraceException
;
161 * Initialize a newly instantiated "empty" trace object. This is used to
162 * properly parameterize an ITmfTrace instantiated with its parameterless
165 * Typically, the parameterless constructor will provide the block size and
166 * its associated parser and indexer.
173 * the trace event type
178 * @throws TmfTraceException
179 * If we couldn't open the trace
181 void initTrace(IResource resource
, String path
, Class
<?
extends ITmfEvent
> type
, String name
, String traceTypeId
) throws TmfTraceException
;
184 * Validate that the trace is of the correct type. The implementation should
185 * return a TraceValidationStatus to indicate success with a certain level
189 * the eclipse project
191 * the trace path. The path should suitable for passing to
192 * <code>java.io.File(String)</code> and should use the
193 * platform-dependent path separator.
195 * @return an IStatus object with validation result. Use severity OK to
197 * @see TraceValidationStatus
199 IStatus
validate(IProject project
, String path
);
201 // ------------------------------------------------------------------------
203 // ------------------------------------------------------------------------
206 * @return the trace event type
208 Class
<?
extends ITmfEvent
> getEventType();
211 * @return the associated trace resource
213 IResource
getResource();
216 * Get the trace type id
218 * @return the trace type id
220 @Nullable String
getTraceTypeId();
223 * @return the trace path
228 * @return the trace cache size
233 * Index the trace. Depending on the trace type, this could be done at the
234 * constructor or initTrace phase too, so this could be implemented as a
237 * @param waitForCompletion
238 * Should we block the caller until indexing is finished, or not.
240 void indexTrace(boolean waitForCompletion
);
242 // ------------------------------------------------------------------------
244 // ------------------------------------------------------------------------
247 * Returns an analysis module with the given ID.
250 * The analysis module ID
251 * @return The {@link IAnalysisModule} object, or null if an analysis with
252 * the given ID does no exist.
254 @Nullable IAnalysisModule
getAnalysisModule(String id
);
257 * Get a list of all analysis modules currently available for this trace.
259 * @return An iterable view of the analysis modules
261 @NonNull Iterable
<IAnalysisModule
> getAnalysisModules();
263 // ------------------------------------------------------------------------
265 // ------------------------------------------------------------------------
268 * Return the pre-defined set of event aspects exposed by this trace.
270 * It should not be null, but could be empty. You are suggested to use at
271 * least the ones defined in {@link TmfTrace#BASE_ASPECTS}.
273 * @return The event aspects for this trace
275 @NonNull Iterable
<ITmfEventAspect
> getEventAspects();
277 // ------------------------------------------------------------------------
278 // Trace characteristics getters
279 // ------------------------------------------------------------------------
282 * @return the number of events in the trace
287 * @return the trace time range
289 TmfTimeRange
getTimeRange();
292 * @return the timestamp of the first trace event
294 ITmfTimestamp
getStartTime();
297 * @return the timestamp of the last trace event
299 ITmfTimestamp
getEndTime();
302 * @return the streaming interval in ms (0 if not a streaming trace)
304 long getStreamingInterval();
306 // ------------------------------------------------------------------------
307 // Trace positioning getters
308 // ------------------------------------------------------------------------
311 * @return the current trace location
313 ITmfLocation
getCurrentLocation();
316 * Returns the ratio (proportion) corresponding to the specified location.
319 * a trace specific location
320 * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
322 double getLocationRatio(ITmfLocation location
);
324 // ------------------------------------------------------------------------
325 // SeekEvent operations (returning a trace context)
326 // ------------------------------------------------------------------------
329 * Position the trace at the specified (trace specific) location.
331 * A null location is interpreted as seeking for the first event of the
334 * If not null, the location requested must be valid otherwise the returned
335 * context is undefined (up to the implementation to recover if possible).
339 * the trace specific location
340 * @return a context which can later be used to read the corresponding event
342 ITmfContext
seekEvent(ITmfLocation location
);
345 * Position the trace at the 'rank'th event in the trace.
347 * A rank <= 0 is interpreted as seeking for the first event of the trace.
349 * If the requested rank is beyond the last trace event, the context
350 * returned will yield a null event if used in a subsequent read.
354 * @return a context which can later be used to read the corresponding event
356 ITmfContext
seekEvent(long rank
);
359 * Position the trace at the first event with the specified timestamp. If
360 * there is no event with the requested timestamp, a context pointing to the
361 * next chronological event is returned.
363 * A null timestamp is interpreted as seeking for the first event of the
366 * If the requested timestamp is beyond the last trace event, the context
367 * returned will yield a null event if used in a subsequent read.
370 * the timestamp of desired event
371 * @return a context which can later be used to read the corresponding event
373 ITmfContext
seekEvent(ITmfTimestamp timestamp
);
376 * Position the trace at the event located at the specified ratio in the
379 * The notion of ratio (0.0 <= r <= 1.0) is trace specific and left
380 * voluntarily vague. Typically, it would refer to the event proportional
381 * rank (arguably more intuitive) or timestamp in the trace file.
384 * the proportional 'rank' in the trace
385 * @return a context which can later be used to read the corresponding event
387 ITmfContext
seekEvent(double ratio
);
390 * Returns the initial range offset
392 * @return the initial range offset
394 ITmfTimestamp
getInitialRangeOffset();
397 * Returns the ID of the host this trace is from. The host ID is not
398 * necessarily the hostname, but should be a unique identifier for the
399 * machine on which the trace was taken. It can be used to determine if two
400 * traces were taken on the exact same machine (timestamp are already
401 * synchronized, resources with same id are the same if taken at the same
404 * @return The host id of this trace
406 @NonNull String
getHostId();
408 // ------------------------------------------------------------------------
409 // Timestamp transformation functions
410 // ------------------------------------------------------------------------
413 * Returns the timestamp transformation for this trace
415 * @return the timestamp transform
417 ITmfTimestampTransform
getTimestampTransform();
420 * Sets the trace's timestamp transform
423 * The timestamp transform for all timestamps of this trace
425 void setTimestampTransform(final ITmfTimestampTransform tt
);
428 * Creates a timestamp for this trace, using the transformation formula
431 * The time in nanoseconds with which to create the timestamp
432 * @return The new timestamp
434 ITmfTimestamp
createTimestamp(long ts
);