1 /*******************************************************************************
2 * Copyright (c) 2009, 2011, 2012 Ericsson
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 *******************************************************************************/
14 package org
.eclipse
.linuxtools
.tmf
.core
.trace
;
16 import java
.util
.Collection
;
18 import org
.eclipse
.core
.resources
.IProject
;
19 import org
.eclipse
.core
.resources
.IResource
;
20 import org
.eclipse
.linuxtools
.tmf
.core
.component
.ITmfDataProvider
;
21 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
22 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfTimestamp
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfTimeRange
;
24 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.TmfTraceException
;
25 import org
.eclipse
.linuxtools
.tmf
.core
.statesystem
.ITmfStateSystem
;
26 import org
.eclipse
.linuxtools
.tmf
.core
.statistics
.ITmfStatistics
;
29 * The event stream structure in TMF. In its basic form, a trace has:
31 * <li> an associated Eclipse resource
32 * <li> a path to its location on the file system
33 * <li> the type of the events it contains
34 * <li> the number of events it contains
35 * <li> the time range (span) of the events it contains
37 * Concrete ITmfTrace classes have to provide a parameter-less constructor and
38 * an initialization method (<i>initTrace</i>) if they are to be opened from
39 * the Project View. Also, a validation method (<i>validate</i>) has to be
40 * provided to ensure that the trace is of the correct type.
42 * A trace can be accessed simultaneously from multiple threads by various
43 * application components. To avoid obvious multi-threading issues, the trace
44 * uses an ITmfContext as a synchronization aid for its read operations.
46 * A proper ITmfContext can be obtained by performing a seek operation on the
47 * trace. Seek operations can be performed for a particular event (by rank or
48 * timestamp) or for a plain trace location.
50 * <b>Example 1</b>: Process a whole trace
52 * ITmfContext context = trace.seekEvent(0);
53 * ITmfEvent event = trace.getNext(context);
54 * while (event != null) {
55 * processEvent(event);
56 * event = trace.getNext(context);
59 * <b>Example 2</b>: Process 50 events starting from the 1000th event
61 * int nbEventsRead = 0;
62 * ITmfContext context = trace.seekEvent(1000);
63 * ITmfEvent event = trace.getNext(context);
64 * while (event != null && nbEventsRead < 50) {
66 * processEvent(event);
67 * event = trace.getNext(context);
70 * <b>Example 3</b>: Process the events between 2 timestamps (inclusive)
72 * ITmfTimestamp startTime = ...;
73 * ITmfTimestamp endTime = ...;
74 * ITmfContext context = trace.seekEvent(startTime);
75 * ITmfEvent event = trace.getNext(context);
76 * while (event != null && event.getTimestamp().compareTo(endTime) <= 0) {
77 * processEvent(event);
78 * event = trace.getNext(context);
81 * A trace is also an event provider so it can process event requests
82 * asynchronously (and coalesce compatible, concurrent requests).
85 * <b>Example 4</b>: Process a whole trace (see ITmfEventRequest for variants)
87 * ITmfRequest request = new TmfEventRequest<MyEventType>(MyEventType.class) {
89 * public void handleData(MyEventType event) {
90 * super.handleData(event);
91 * processEvent(event);
94 * public void handleCompleted() {
96 * super.handleCompleted();
100 * fTrace.handleRequest(request);
102 * request.waitForCompletion();
107 * @author Francois Chouinard
111 * @see ITmfTraceIndexer
112 * @see ITmfEventParser
114 public interface ITmfTrace
extends ITmfDataProvider
{
116 // ------------------------------------------------------------------------
118 // ------------------------------------------------------------------------
121 * The default trace cache size
123 public static final int DEFAULT_TRACE_CACHE_SIZE
= 1000;
125 // ------------------------------------------------------------------------
127 // ------------------------------------------------------------------------
130 * Initialize a newly instantiated "empty" trace object. This is used to
131 * properly parameterize an ITmfTrace instantiated with its parameterless
134 * Typically, the parameterless constructor will provide the block size
135 * and its associated parser and indexer.
137 * @param resource the trace resource
138 * @param path the trace path
139 * @param type the trace event type
140 * @throws TmfTraceException If we couldn't open the trace
142 public void initTrace(IResource resource
, String path
, Class
<?
extends ITmfEvent
> type
) throws TmfTraceException
;
145 * Validate that the trace is of the correct type.
147 * @param project the eclipse project
148 * @param path the trace path
150 * @return true if trace is valid
152 public boolean validate(IProject project
, String path
);
154 // ------------------------------------------------------------------------
156 // ------------------------------------------------------------------------
159 * @return the trace event type
161 public Class
<?
extends ITmfEvent
> getEventType();
164 * @return the associated trace resource
166 public IResource
getResource();
169 * @return the trace path
171 public String
getPath();
174 * @return the trace cache size
176 public int getCacheSize();
179 * @return The statistics provider for this trace
182 public ITmfStatistics
getStatistics();
185 * Retrieve a state system that belongs to this trace
188 * The ID of the state system to retrieve.
189 * @return The state system that is associated with this trace and ID, or
190 * 'null' if such a match doesn't exist.
193 public ITmfStateSystem
getStateSystem(String id
);
196 * Return the list of existing state systems registered with this trace.
198 * @return A Collection view of the available state systems. The collection
199 * could be empty, but should not be null.
202 public Collection
<String
> listStateSystems();
204 // ------------------------------------------------------------------------
205 // Trace characteristics getters
206 // ------------------------------------------------------------------------
209 * @return the number of events in the trace
211 public long getNbEvents();
214 * @return the trace time range
216 public TmfTimeRange
getTimeRange();
219 * @return the timestamp of the first trace event
221 public ITmfTimestamp
getStartTime();
224 * @return the timestamp of the last trace event
226 public ITmfTimestamp
getEndTime();
229 * @return the streaming interval in ms (0 if not a streaming trace)
231 public long getStreamingInterval();
233 // ------------------------------------------------------------------------
234 // Trace positioning getters
235 // ------------------------------------------------------------------------
238 * @return the current trace location
240 public ITmfLocation
getCurrentLocation();
243 * Returns the ratio (proportion) corresponding to the specified location.
245 * @param location a trace specific location
246 * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
248 public double getLocationRatio(ITmfLocation location
);
250 // ------------------------------------------------------------------------
251 // SeekEvent operations (returning a trace context)
252 // ------------------------------------------------------------------------
255 * Position the trace at the specified (trace specific) location.
257 * A null location is interpreted as seeking for the first event of the
260 * If not null, the location requested must be valid otherwise the returned
261 * context is undefined (up to the implementation to recover if possible).
263 * @param location the trace specific location
264 * @return a context which can later be used to read the corresponding event
266 public ITmfContext
seekEvent(ITmfLocation location
);
269 * Position the trace at the 'rank'th event in the trace.
271 * A rank <= 0 is interpreted as seeking for the first event of the
274 * If the requested rank is beyond the last trace event, the context
275 * returned will yield a null event if used in a subsequent read.
277 * @param rank the event rank
278 * @return a context which can later be used to read the corresponding event
280 public ITmfContext
seekEvent(long rank
);
283 * Position the trace at the first event with the specified timestamp. If
284 * there is no event with the requested timestamp, a context pointing to
285 * the next chronological event is returned.
287 * A null timestamp is interpreted as seeking for the first event of the
290 * If the requested timestamp is beyond the last trace event, the context
291 * returned will yield a null event if used in a subsequent read.
293 * @param timestamp the timestamp of desired event
294 * @return a context which can later be used to read the corresponding event
296 public ITmfContext
seekEvent(ITmfTimestamp timestamp
);
299 * Position the trace at the event located at the specified ratio in the
302 * The notion of ratio (0.0 <= r <= 1.0) is trace specific and left
303 * voluntarily vague. Typically, it would refer to the event proportional
304 * rank (arguably more intuitive) or timestamp in the trace file.
306 * @param ratio the proportional 'rank' in the trace
307 * @return a context which can later be used to read the corresponding event
309 public ITmfContext
seekEvent(double ratio
);
312 * Returns the initial range offset
314 * @return the initial range offset
317 public ITmfTimestamp
getInitialRangeOffset();
320 * Return the current selected time.
322 * @return the current time stamp
325 public ITmfTimestamp
getCurrentTime();
328 * Return the current selected range.
330 * @return the current time range
333 public TmfTimeRange
getCurrentRange();
This page took 0.038236 seconds and 5 git commands to generate.