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
.linuxtools
.tmf
.core
.component
.ITmfDataProvider
;
22 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.TmfTraceException
;
24 import org
.eclipse
.linuxtools
.tmf
.core
.statesystem
.ITmfStateSystem
;
25 import org
.eclipse
.linuxtools
.tmf
.core
.statistics
.ITmfStatistics
;
26 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.ITmfTimestamp
;
27 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.TmfTimeRange
;
30 * The event stream structure in TMF. In its basic form, a trace has:
32 * <li> an associated Eclipse resource
33 * <li> a path to its location on the file system
34 * <li> the type of the events it contains
35 * <li> the number of events it contains
36 * <li> the time range (span) of the events it contains
38 * Concrete ITmfTrace classes have to provide a parameter-less constructor and
39 * an initialization method (<i>initTrace</i>) if they are to be opened from
40 * the Project View. Also, a validation method (<i>validate</i>) has to be
41 * provided to ensure that the trace is of the correct type.
43 * A trace can be accessed simultaneously from multiple threads by various
44 * application components. To avoid obvious multi-threading issues, the trace
45 * uses an ITmfContext as a synchronization aid for its read operations.
47 * A proper ITmfContext can be obtained by performing a seek operation on the
48 * trace. Seek operations can be performed for a particular event (by rank or
49 * timestamp) or for a plain trace location.
51 * <b>Example 1</b>: Process a whole trace
53 * ITmfContext context = trace.seekEvent(0);
54 * ITmfEvent event = trace.getNext(context);
55 * while (event != null) {
56 * processEvent(event);
57 * event = trace.getNext(context);
60 * <b>Example 2</b>: Process 50 events starting from the 1000th event
62 * int nbEventsRead = 0;
63 * ITmfContext context = trace.seekEvent(1000);
64 * ITmfEvent event = trace.getNext(context);
65 * while (event != null && nbEventsRead < 50) {
67 * processEvent(event);
68 * event = trace.getNext(context);
71 * <b>Example 3</b>: Process the events between 2 timestamps (inclusive)
73 * ITmfTimestamp startTime = ...;
74 * ITmfTimestamp endTime = ...;
75 * ITmfContext context = trace.seekEvent(startTime);
76 * ITmfEvent event = trace.getNext(context);
77 * while (event != null && event.getTimestamp().compareTo(endTime) <= 0) {
78 * processEvent(event);
79 * event = trace.getNext(context);
82 * A trace is also an event provider so it can process event requests
83 * asynchronously (and coalesce compatible, concurrent requests).
86 * <b>Example 4</b>: Process a whole trace (see ITmfEventRequest for variants)
88 * ITmfRequest request = new TmfEventRequest<MyEventType>(MyEventType.class) {
90 * public void handleData(MyEventType event) {
91 * super.handleData(event);
92 * processEvent(event);
95 * public void handleCompleted() {
97 * super.handleCompleted();
101 * fTrace.handleRequest(request);
103 * request.waitForCompletion();
108 * @author Francois Chouinard
112 * @see ITmfTraceIndexer
113 * @see ITmfEventParser
115 public interface ITmfTrace
extends ITmfDataProvider
{
117 // ------------------------------------------------------------------------
119 // ------------------------------------------------------------------------
122 * The default trace cache size
124 public static final int DEFAULT_TRACE_CACHE_SIZE
= 1000;
126 // ------------------------------------------------------------------------
128 // ------------------------------------------------------------------------
131 * Initialize a newly instantiated "empty" trace object. This is used to
132 * properly parameterize an ITmfTrace instantiated with its parameterless
135 * Typically, the parameterless constructor will provide the block size
136 * and its associated parser and indexer.
138 * @param resource the trace resource
139 * @param path the trace path
140 * @param type the trace event type
141 * @throws TmfTraceException If we couldn't open the trace
143 public void initTrace(IResource resource
, String path
, Class
<?
extends ITmfEvent
> type
) throws TmfTraceException
;
146 * Validate that the trace is of the correct type.
148 * @param project the eclipse project
149 * @param path the trace path
151 * @return true if trace is valid
153 public boolean validate(IProject project
, String path
);
155 // ------------------------------------------------------------------------
157 // ------------------------------------------------------------------------
160 * If this trace is used as a container for sub-traces, this can be used to
161 * get the sub-traces themselves. If the trace is stand-alone, this should
162 * return an array with only "this" inside. For this reason, be careful if
163 * calling this recursively.
165 * This offers a standard way of iterating through compound traces (like
168 * @return The array of sub-traces.
171 public ITmfTrace
[] getTraces();
174 * @return the trace event type
176 public Class
<?
extends ITmfEvent
> getEventType();
179 * @return the associated trace resource
181 public IResource
getResource();
184 * @return the trace path
186 public String
getPath();
189 * @return the trace cache size
191 public int getCacheSize();
194 * @return The statistics provider for this trace
197 public ITmfStatistics
getStatistics();
200 * Return the map of state systems associated with this trace.
202 * This view should be read-only (implementations should use
203 * {@link Collections#unmodifiableMap}).
205 * @return The map of state systems
208 public Map
<String
, ITmfStateSystem
> getStateSystems();
211 * If a state system is not build by the trace itself, it's possible to
212 * register it if it comes from another source. It will then be accessible
213 * with {@link #getStateSystems} normally.
216 * The unique ID to assign to this state system. In case of
217 * conflicting ID's, the new one will overwrite the previous one
218 * (default Map behavior).
220 * The already-built state system
223 public void registerStateSystem(String id
, ITmfStateSystem ss
);
225 // ------------------------------------------------------------------------
226 // Trace characteristics getters
227 // ------------------------------------------------------------------------
230 * @return the number of events in the trace
232 public long getNbEvents();
235 * @return the trace time range
238 public TmfTimeRange
getTimeRange();
241 * @return the timestamp of the first trace event
244 public ITmfTimestamp
getStartTime();
247 * @return the timestamp of the last trace event
250 public ITmfTimestamp
getEndTime();
253 * @return the streaming interval in ms (0 if not a streaming trace)
255 public long getStreamingInterval();
257 // ------------------------------------------------------------------------
258 // Trace positioning getters
259 // ------------------------------------------------------------------------
262 * @return the current trace location
264 public ITmfLocation
getCurrentLocation();
267 * Returns the ratio (proportion) corresponding to the specified location.
269 * @param location a trace specific location
270 * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
272 public double getLocationRatio(ITmfLocation location
);
274 // ------------------------------------------------------------------------
275 // SeekEvent operations (returning a trace context)
276 // ------------------------------------------------------------------------
279 * Position the trace at the specified (trace specific) location.
281 * A null location is interpreted as seeking for the first event of the
284 * If not null, the location requested must be valid otherwise the returned
285 * context is undefined (up to the implementation to recover if possible).
287 * @param location the trace specific location
288 * @return a context which can later be used to read the corresponding event
290 public ITmfContext
seekEvent(ITmfLocation location
);
293 * Position the trace at the 'rank'th event in the trace.
295 * A rank <= 0 is interpreted as seeking for the first event of the
298 * If the requested rank is beyond the last trace event, the context
299 * returned will yield a null event if used in a subsequent read.
301 * @param rank the event rank
302 * @return a context which can later be used to read the corresponding event
304 public ITmfContext
seekEvent(long rank
);
307 * Position the trace at the first event with the specified timestamp. If
308 * there is no event with the requested timestamp, a context pointing to
309 * the next chronological event is returned.
311 * A null timestamp is interpreted as seeking for the first event of the
314 * If the requested timestamp is beyond the last trace event, the context
315 * returned will yield a null event if used in a subsequent read.
317 * @param timestamp the timestamp of desired event
318 * @return a context which can later be used to read the corresponding event
321 public ITmfContext
seekEvent(ITmfTimestamp timestamp
);
324 * Position the trace at the event located at the specified ratio in the
327 * The notion of ratio (0.0 <= r <= 1.0) is trace specific and left
328 * voluntarily vague. Typically, it would refer to the event proportional
329 * rank (arguably more intuitive) or timestamp in the trace file.
331 * @param ratio the proportional 'rank' in the trace
332 * @return a context which can later be used to read the corresponding event
334 public ITmfContext
seekEvent(double ratio
);
337 * Returns the initial range offset
339 * @return the initial range offset
342 public ITmfTimestamp
getInitialRangeOffset();
345 * Return the current selected time.
347 * @return the current time stamp
350 public ITmfTimestamp
getCurrentTime();
353 * Return the current selected range.
355 * @return the current time range
358 public TmfTimeRange
getCurrentRange();
This page took 0.075432 seconds and 5 git commands to generate.