1 /*******************************************************************************
2 * Copyright (c) 2009, 2013 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
.Collections
;
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
.linuxtools
.tmf
.core
.component
.ITmfDataProvider
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
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
;
27 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.ITmfTimestamp
;
28 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.TmfTimeRange
;
31 * The event stream structure in TMF. In its basic form, a trace has:
33 * <li> an associated Eclipse resource
34 * <li> a path to its location on the file system
35 * <li> the type of the events it contains
36 * <li> the number of events it contains
37 * <li> the time range (span) of the events it contains
39 * Concrete ITmfTrace classes have to provide a parameter-less constructor and
40 * an initialization method (<i>initTrace</i>) if they are to be opened from
41 * the Project View. Also, a validation method (<i>validate</i>) has to be
42 * provided to ensure that the trace is of the correct type.
44 * A trace can be accessed simultaneously from multiple threads by various
45 * application components. To avoid obvious multi-threading issues, the trace
46 * uses an ITmfContext as a synchronization aid for its read operations.
48 * A proper ITmfContext can be obtained by performing a seek operation on the
49 * trace. Seek operations can be performed for a particular event (by rank or
50 * timestamp) or for a plain trace location.
52 * <b>Example 1</b>: Process a whole trace
54 * ITmfContext context = trace.seekEvent(0);
55 * ITmfEvent event = trace.getNext(context);
56 * while (event != null) {
57 * processEvent(event);
58 * event = trace.getNext(context);
61 * <b>Example 2</b>: Process 50 events starting from the 1000th event
63 * int nbEventsRead = 0;
64 * ITmfContext context = trace.seekEvent(1000);
65 * ITmfEvent event = trace.getNext(context);
66 * while (event != null && nbEventsRead < 50) {
68 * processEvent(event);
69 * event = trace.getNext(context);
72 * <b>Example 3</b>: Process the events between 2 timestamps (inclusive)
74 * ITmfTimestamp startTime = ...;
75 * ITmfTimestamp endTime = ...;
76 * ITmfContext context = trace.seekEvent(startTime);
77 * ITmfEvent event = trace.getNext(context);
78 * while (event != null && event.getTimestamp().compareTo(endTime) <= 0) {
79 * processEvent(event);
80 * event = trace.getNext(context);
83 * A trace is also an event provider so it can process event requests
84 * asynchronously (and coalesce compatible, concurrent requests).
87 * <b>Example 4</b>: Process a whole trace (see ITmfEventRequest for variants)
89 * ITmfRequest request = new TmfEventRequest<MyEventType>(MyEventType.class) {
91 * public void handleData(MyEventType event) {
92 * super.handleData(event);
93 * processEvent(event);
96 * public void handleCompleted() {
98 * super.handleCompleted();
102 * fTrace.handleRequest(request);
104 * request.waitForCompletion();
109 * @author Francois Chouinard
113 * @see ITmfTraceIndexer
114 * @see ITmfEventParser
116 public interface ITmfTrace
extends ITmfDataProvider
{
118 // ------------------------------------------------------------------------
120 // ------------------------------------------------------------------------
123 * The default trace cache size
125 public static final int DEFAULT_TRACE_CACHE_SIZE
= 1000;
127 // ------------------------------------------------------------------------
129 // ------------------------------------------------------------------------
132 * Initialize a newly instantiated "empty" trace object. This is used to
133 * properly parameterize an ITmfTrace instantiated with its parameterless
136 * Typically, the parameterless constructor will provide the block size
137 * and its associated parser and indexer.
139 * @param resource the trace resource
140 * @param path the trace path
141 * @param type the trace event type
142 * @throws TmfTraceException If we couldn't open the trace
144 public void initTrace(IResource resource
, String path
, Class
<?
extends ITmfEvent
> type
) throws TmfTraceException
;
147 * Validate that the trace is of the correct type.
149 * @param project the eclipse project
150 * @param path the trace path
152 * @return true if trace is valid
155 public IStatus
validate(IProject project
, String path
);
157 // ------------------------------------------------------------------------
159 // ------------------------------------------------------------------------
162 * If this trace is used as a container for sub-traces, this can be used to
163 * get the sub-traces themselves. If the trace is stand-alone, this should
164 * return an array with only "this" inside. For this reason, be careful if
165 * calling this recursively.
167 * This offers a standard way of iterating through compound traces (like
170 * @return The array of sub-traces.
173 public ITmfTrace
[] getTraces();
176 * @return the trace event type
178 public Class
<?
extends ITmfEvent
> getEventType();
181 * @return the associated trace resource
183 public IResource
getResource();
186 * @return the trace path
188 public String
getPath();
191 * @return the trace cache size
193 public int getCacheSize();
196 * @return The statistics provider for this trace
199 public ITmfStatistics
getStatistics();
202 * Return the map of state systems associated with this trace.
204 * This view should be read-only (implementations should use
205 * {@link Collections#unmodifiableMap}).
207 * @return The map of state systems
210 public Map
<String
, ITmfStateSystem
> getStateSystems();
213 * If a state system is not build by the trace itself, it's possible to
214 * register it if it comes from another source. It will then be accessible
215 * with {@link #getStateSystems} normally.
218 * The unique ID to assign to this state system. In case of
219 * conflicting ID's, the new one will overwrite the previous one
220 * (default Map behavior).
222 * The already-built state system
225 public void registerStateSystem(String id
, ITmfStateSystem ss
);
228 * Index the trace. Depending on the trace type, this could be done at the
229 * constructor or initTrace phase too, so this could be implemented as a
232 * @param waitForCompletion
233 * Should we block the caller until indexing is finished, or not.
236 public void indexTrace(boolean waitForCompletion
);
238 // ------------------------------------------------------------------------
239 // Trace characteristics getters
240 // ------------------------------------------------------------------------
243 * @return the number of events in the trace
245 public long getNbEvents();
248 * @return the trace time range
251 public TmfTimeRange
getTimeRange();
254 * @return the timestamp of the first trace event
257 public ITmfTimestamp
getStartTime();
260 * @return the timestamp of the last trace event
263 public ITmfTimestamp
getEndTime();
266 * @return the streaming interval in ms (0 if not a streaming trace)
268 public long getStreamingInterval();
270 // ------------------------------------------------------------------------
271 // Trace positioning getters
272 // ------------------------------------------------------------------------
275 * @return the current trace location
277 public ITmfLocation
getCurrentLocation();
280 * Returns the ratio (proportion) corresponding to the specified location.
282 * @param location a trace specific location
283 * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
285 public double getLocationRatio(ITmfLocation location
);
287 // ------------------------------------------------------------------------
288 // SeekEvent operations (returning a trace context)
289 // ------------------------------------------------------------------------
292 * Position the trace at the specified (trace specific) location.
294 * A null location is interpreted as seeking for the first event of the
297 * If not null, the location requested must be valid otherwise the returned
298 * context is undefined (up to the implementation to recover if possible).
300 * @param location the trace specific location
301 * @return a context which can later be used to read the corresponding event
303 public ITmfContext
seekEvent(ITmfLocation location
);
306 * Position the trace at the 'rank'th event in the trace.
308 * A rank <= 0 is interpreted as seeking for the first event of the
311 * If the requested rank is beyond the last trace event, the context
312 * returned will yield a null event if used in a subsequent read.
314 * @param rank the event rank
315 * @return a context which can later be used to read the corresponding event
317 public ITmfContext
seekEvent(long rank
);
320 * Position the trace at the first event with the specified timestamp. If
321 * there is no event with the requested timestamp, a context pointing to
322 * the next chronological event is returned.
324 * A null timestamp is interpreted as seeking for the first event of the
327 * If the requested timestamp is beyond the last trace event, the context
328 * returned will yield a null event if used in a subsequent read.
330 * @param timestamp the timestamp of desired event
331 * @return a context which can later be used to read the corresponding event
334 public ITmfContext
seekEvent(ITmfTimestamp timestamp
);
337 * Position the trace at the event located at the specified ratio in the
340 * The notion of ratio (0.0 <= r <= 1.0) is trace specific and left
341 * voluntarily vague. Typically, it would refer to the event proportional
342 * rank (arguably more intuitive) or timestamp in the trace file.
344 * @param ratio the proportional 'rank' in the trace
345 * @return a context which can later be used to read the corresponding event
347 public ITmfContext
seekEvent(double ratio
);
350 * Returns the initial range offset
352 * @return the initial range offset
355 public ITmfTimestamp
getInitialRangeOffset();
358 * Return the current selected time.
360 * @return the current time stamp
363 public ITmfTimestamp
getCurrentTime();
366 * Return the current selected range.
368 * @return the current time range
371 public TmfTimeRange
getCurrentRange();
This page took 0.042397 seconds and 6 git commands to generate.