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 org
.eclipse
.core
.resources
.IProject
;
17 import org
.eclipse
.core
.resources
.IResource
;
18 import org
.eclipse
.linuxtools
.tmf
.core
.component
.ITmfDataProvider
;
19 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
20 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfTimestamp
;
21 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfTimeRange
;
22 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.TmfTraceException
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.statesystem
.ITmfStateSystem
;
24 import org
.eclipse
.linuxtools
.tmf
.core
.statistics
.ITmfStatistics
;
27 * The event stream structure in TMF. In its basic form, a trace has:
29 * <li> an associated Eclipse resource
30 * <li> a path to its location on the file system
31 * <li> the type of the events it contains
32 * <li> the number of events it contains
33 * <li> the time range (span) of the events it contains
35 * Concrete ITmfTrace classes have to provide a parameter-less constructor and
36 * an initialization method (<i>initTrace</i>) if they are to be opened from
37 * the Project View. Also, a validation method (<i>validate</i>) has to be
38 * provided to ensure that the trace is of the correct type.
40 * A trace can be accessed simultaneously from multiple threads by various
41 * application components. To avoid obvious multi-threading issues, the trace
42 * uses an ITmfContext as a synchronization aid for its read operations.
44 * A proper ITmfContext can be obtained by performing a seek operation on the
45 * trace. Seek operations can be performed for a particular event (by rank or
46 * timestamp) or for a plain trace location.
48 * <b>Example 1</b>: Process a whole trace
50 * ITmfContext context = trace.seekEvent(0);
51 * ITmfEvent event = trace.getNext(context);
52 * while (event != null) {
53 * processEvent(event);
54 * event = trace.getNext(context);
57 * <b>Example 2</b>: Process 50 events starting from the 1000th event
59 * int nbEventsRead = 0;
60 * ITmfContext context = trace.seekEvent(1000);
61 * ITmfEvent event = trace.getNext(context);
62 * while (event != null && nbEventsRead < 50) {
64 * processEvent(event);
65 * event = trace.getNext(context);
68 * <b>Example 3</b>: Process the events between 2 timestamps (inclusive)
70 * ITmfTimestamp startTime = ...;
71 * ITmfTimestamp endTime = ...;
72 * ITmfContext context = trace.seekEvent(startTime);
73 * ITmfEvent event = trace.getNext(context);
74 * while (event != null && event.getTimestamp().compareTo(endTime) <= 0) {
75 * processEvent(event);
76 * event = trace.getNext(context);
79 * A trace is also an event provider so it can process event requests
80 * asynchronously (and coalesce compatible, concurrent requests).
83 * <b>Example 4</b>: Process a whole trace (see ITmfEventRequest for variants)
85 * ITmfRequest request = new TmfEventRequest<MyEventType>(MyEventType.class) {
87 * public void handleData(MyEventType event) {
88 * super.handleData(event);
89 * processEvent(event);
92 * public void handleCompleted() {
94 * super.handleCompleted();
98 * fTrace.handleRequest(request);
100 * request.waitForCompletion();
105 * @author Francois Chouinard
109 * @see ITmfTraceIndexer
110 * @see ITmfEventParser
112 public interface ITmfTrace
extends ITmfDataProvider
{
114 // ------------------------------------------------------------------------
116 // ------------------------------------------------------------------------
119 * The default trace cache size
121 public static final int DEFAULT_TRACE_CACHE_SIZE
= 1000;
123 // ------------------------------------------------------------------------
125 // ------------------------------------------------------------------------
128 * Initialize a newly instantiated "empty" trace object. This is used to
129 * properly parameterize an ITmfTrace instantiated with its parameterless
132 * Typically, the parameterless constructor will provide the block size
133 * and its associated parser and indexer.
135 * @param resource the trace resource
136 * @param path the trace path
137 * @param type the trace event type
138 * @throws TmfTraceException If we couldn't open the trace
140 public void initTrace(IResource resource
, String path
, Class
<?
extends ITmfEvent
> type
) throws TmfTraceException
;
143 * Validate that the trace is of the correct type.
145 * @param project the eclipse project
146 * @param path the trace path
148 * @return true if trace is valid
150 public boolean validate(IProject project
, String path
);
152 // ------------------------------------------------------------------------
154 // ------------------------------------------------------------------------
157 * @return the trace event type
159 public Class
<?
extends ITmfEvent
> getEventType();
162 * @return the associated trace resource
164 public IResource
getResource();
167 * @return the trace path
169 public String
getPath();
172 * @return the trace cache size
174 public int getCacheSize();
177 * @return The statistics provider for this trace
180 public ITmfStatistics
getStatistics();
183 * @return The state system that is associated with this trace
186 public ITmfStateSystem
getStateSystem();
188 // ------------------------------------------------------------------------
189 // Trace characteristics getters
190 // ------------------------------------------------------------------------
193 * @return the number of events in the trace
195 public long getNbEvents();
198 * @return the trace time range
200 public TmfTimeRange
getTimeRange();
203 * @return the timestamp of the first trace event
205 public ITmfTimestamp
getStartTime();
208 * @return the timestamp of the last trace event
210 public ITmfTimestamp
getEndTime();
213 * @return the streaming interval in ms (0 if not a streaming trace)
215 public long getStreamingInterval();
217 // ------------------------------------------------------------------------
218 // Trace positioning getters
219 // ------------------------------------------------------------------------
222 * @return the current trace location
224 public ITmfLocation
getCurrentLocation();
227 * Returns the ratio (proportion) corresponding to the specified location.
229 * @param location a trace specific location
230 * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
232 public double getLocationRatio(ITmfLocation location
);
234 // ------------------------------------------------------------------------
235 // SeekEvent operations (returning a trace context)
236 // ------------------------------------------------------------------------
239 * Position the trace at the specified (trace specific) location.
241 * A null location is interpreted as seeking for the first event of the
244 * If not null, the location requested must be valid otherwise the returned
245 * context is undefined (up to the implementation to recover if possible).
247 * @param location the trace specific location
248 * @return a context which can later be used to read the corresponding event
250 public ITmfContext
seekEvent(ITmfLocation location
);
253 * Position the trace at the 'rank'th event in the trace.
255 * A rank <= 0 is interpreted as seeking for the first event of the
258 * If the requested rank is beyond the last trace event, the context
259 * returned will yield a null event if used in a subsequent read.
261 * @param rank the event rank
262 * @return a context which can later be used to read the corresponding event
264 public ITmfContext
seekEvent(long rank
);
267 * Position the trace at the first event with the specified timestamp. If
268 * there is no event with the requested timestamp, a context pointing to
269 * the next chronological event is returned.
271 * A null timestamp is interpreted as seeking for the first event of the
274 * If the requested timestamp is beyond the last trace event, the context
275 * returned will yield a null event if used in a subsequent read.
277 * @param timestamp the timestamp of desired event
278 * @return a context which can later be used to read the corresponding event
280 public ITmfContext
seekEvent(ITmfTimestamp timestamp
);
283 * Position the trace at the event located at the specified ratio in the
286 * The notion of ratio (0.0 <= r <= 1.0) is trace specific and left
287 * voluntarily vague. Typically, it would refer to the event proportional
288 * rank (arguably more intuitive) or timestamp in the trace file.
290 * @param ratio the proportional 'rank' in the trace
291 * @return a context which can later be used to read the corresponding event
293 public ITmfContext
seekEvent(double ratio
);
296 * Return the current selected time.
298 * @return the current time stamp
301 public ITmfTimestamp
getCurrentTime();
304 * Return the current selected range.
306 * @return the current time range
309 public TmfTimeRange
getCurrentRange();
This page took 0.040089 seconds and 6 git commands to generate.