tmf: Fix time unit of time stamp in TmfTrace.createTimestamp()
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.core / src / org / eclipse / linuxtools / tmf / core / trace / ITmfTrace.java
CommitLineData
8c8bf09f 1/*******************************************************************************
bcb8c2cb 2 * Copyright (c) 2009, 2014 Ericsson, École Polytechnique de Montréal
0283f7ff 3 *
8c8bf09f
ASL
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
0283f7ff 8 *
8c8bf09f
ASL
9 * Contributors:
10 * Francois Chouinard - Initial API and implementation
8636b448 11 * Francois Chouinard - Updated as per TMF Trace Model 1.0
e73a4ba5
GB
12 * Geneviève Bastien - Added timestamp transforms and timestamp
13 * creation functions
339d539c 14 * Patrick Tasse - Add support for folder elements
8c8bf09f
ASL
15 *******************************************************************************/
16
6c13869b 17package org.eclipse.linuxtools.tmf.core.trace;
8c8bf09f 18
12c155f5 19import org.eclipse.core.resources.IProject;
a1091415 20import org.eclipse.core.resources.IResource;
a94410d9 21import org.eclipse.core.runtime.IStatus;
ff3f02c8
AM
22import org.eclipse.jdt.annotation.NonNull;
23import org.eclipse.jdt.annotation.Nullable;
c068a752 24import org.eclipse.linuxtools.tmf.core.analysis.IAnalysisModule;
fd3f1eff 25import org.eclipse.linuxtools.tmf.core.component.ITmfEventProvider;
72f1e62a 26import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
b4f71e4a 27import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException;
e73a4ba5 28import org.eclipse.linuxtools.tmf.core.synchronization.ITmfTimestampTransform;
3bd46eef
AM
29import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
30import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;
a3db8436
AM
31import org.eclipse.linuxtools.tmf.core.trace.indexer.ITmfTraceIndexer;
32import org.eclipse.linuxtools.tmf.core.trace.location.ITmfLocation;
8c8bf09f
ASL
33
34/**
f17b2f70
FC
35 * The event stream structure in TMF. In its basic form, a trace has:
36 * <ul>
7e6347b0
FC
37 * <li> an associated Eclipse resource
38 * <li> a path to its location on the file system
f17b2f70
FC
39 * <li> the type of the events it contains
40 * <li> the number of events it contains
41 * <li> the time range (span) of the events it contains
42 * </ul>
43 * Concrete ITmfTrace classes have to provide a parameter-less constructor and
e73a4ba5
GB
44 * an initialization method (<i>initTrace</i>) if they are to be opened from the
45 * Project View. Also, a validation method (<i>validate</i>) has to be provided
46 * to ensure that the trace is of the correct type.
f17b2f70
FC
47 * <p>
48 * A trace can be accessed simultaneously from multiple threads by various
49 * application components. To avoid obvious multi-threading issues, the trace
50 * uses an ITmfContext as a synchronization aid for its read operations.
51 * <p>
52 * A proper ITmfContext can be obtained by performing a seek operation on the
53 * trace. Seek operations can be performed for a particular event (by rank or
54 * timestamp) or for a plain trace location.
55 * <p>
d337369a 56 * <b>Example 1</b>: Process a whole trace
f17b2f70 57 * <pre>
7e6347b0 58 * ITmfContext context = trace.seekEvent(0);
c32744d6 59 * ITmfEvent event = trace.getNext(context);
f17b2f70 60 * while (event != null) {
d337369a 61 * processEvent(event);
c32744d6 62 * event = trace.getNext(context);
f17b2f70
FC
63 * }
64 * </pre>
65 * <b>Example 2</b>: Process 50 events starting from the 1000th event
66 * <pre>
67 * int nbEventsRead = 0;
68 * ITmfContext context = trace.seekEvent(1000);
c32744d6 69 * ITmfEvent event = trace.getNext(context);
f17b2f70
FC
70 * while (event != null && nbEventsRead < 50) {
71 * nbEventsRead++;
d337369a 72 * processEvent(event);
c32744d6 73 * event = trace.getNext(context);
f17b2f70
FC
74 * }
75 * </pre>
76 * <b>Example 3</b>: Process the events between 2 timestamps (inclusive)
77 * <pre>
78 * ITmfTimestamp startTime = ...;
79 * ITmfTimestamp endTime = ...;
80 * ITmfContext context = trace.seekEvent(startTime);
c32744d6 81 * ITmfEvent event = trace.getNext(context);
f17b2f70 82 * while (event != null && event.getTimestamp().compareTo(endTime) <= 0) {
d337369a 83 * processEvent(event);
c32744d6 84 * event = trace.getNext(context);
f17b2f70
FC
85 * }
86 * </pre>
e73a4ba5 87 *
d337369a 88 * A trace is also an event provider so it can process event requests
7e6347b0 89 * asynchronously (and coalesce compatible, concurrent requests).
d337369a 90 * <p>
e73a4ba5
GB
91 *
92 * <b>Example 4</b>: Process a whole trace (see ITmfEventRequest for
93 * variants)
d337369a
FC
94 * <pre>
95 * ITmfRequest request = new TmfEventRequest&lt;MyEventType&gt;(MyEventType.class) {
e73a4ba5 96 * &#064;Override
d337369a
FC
97 * public void handleData(MyEventType event) {
98 * super.handleData(event);
99 * processEvent(event);
100 * }
e73a4ba5
GB
101 *
102 * &#064;Override
d337369a
FC
103 * public void handleCompleted() {
104 * finish();
105 * super.handleCompleted();
106 * }
107 * };
0283f7ff 108 *
d337369a
FC
109 * fTrace.handleRequest(request);
110 * if (youWant) {
111 * request.waitForCompletion();
0283f7ff 112 * }
d337369a 113 * </pre>
0283f7ff 114 *
5419a136 115 * @version 1.0
f7703ed6 116 * @author Francois Chouinard
0283f7ff 117 *
0316808c 118 * @see ITmfContext
d337369a 119 * @see ITmfEvent
0316808c
FC
120 * @see ITmfTraceIndexer
121 * @see ITmfEventParser
8c8bf09f 122 */
fd3f1eff 123public interface ITmfTrace extends ITmfEventProvider {
12c155f5 124
0316808c
FC
125 // ------------------------------------------------------------------------
126 // Constants
127 // ------------------------------------------------------------------------
128
129 /**
130 * The default trace cache size
131 */
132 public static final int DEFAULT_TRACE_CACHE_SIZE = 1000;
133
8636b448
FC
134 // ------------------------------------------------------------------------
135 // Initializers
136 // ------------------------------------------------------------------------
085d898f 137
3118edf1
FC
138 /**
139 * Initialize a newly instantiated "empty" trace object. This is used to
25e48683
FC
140 * properly parameterize an ITmfTrace instantiated with its parameterless
141 * constructor.
d337369a 142 * <p>
e73a4ba5
GB
143 * Typically, the parameterless constructor will provide the block size and
144 * its associated parser and indexer.
0283f7ff 145 *
e73a4ba5
GB
146 * @param resource
147 * the trace resource
148 * @param path
149 * the trace path
150 * @param type
151 * the trace event type
152 * @throws TmfTraceException
153 * If we couldn't open the trace
3118edf1 154 */
57a2a5ca 155 void initTrace(IResource resource, String path, Class<? extends ITmfEvent> type) throws TmfTraceException;
12c155f5 156
339d539c
PT
157 /**
158 * Initialize a newly instantiated "empty" trace object. This is used to
159 * properly parameterize an ITmfTrace instantiated with its parameterless
160 * constructor.
161 * <p>
162 * Typically, the parameterless constructor will provide the block size and
163 * its associated parser and indexer.
164 *
165 * @param resource
166 * the trace resource
167 * @param path
168 * the trace path
169 * @param type
170 * the trace event type
171 * @param name
172 * the trace name
173 * @throws TmfTraceException
174 * If we couldn't open the trace
175 */
176 void initTrace(IResource resource, String path, Class<? extends ITmfEvent> type, String name) throws TmfTraceException;
177
3118edf1 178 /**
bcb8c2cb
PT
179 * Validate that the trace is of the correct type. The implementation should
180 * return a TraceValidationStatus to indicate success with a certain level
181 * of confidence.
0283f7ff 182 *
e73a4ba5
GB
183 * @param project
184 * the eclipse project
185 * @param path
186 * the trace path
bcb8c2cb 187 *
e73a4ba5
GB
188 * @return an IStatus object with validation result. Use severity OK to
189 * indicate success.
bcb8c2cb 190 * @see {@link TraceValidationStatus}
a94410d9 191 * @since 2.0
3118edf1 192 */
57a2a5ca 193 IStatus validate(IProject project, String path);
12c155f5 194
8636b448 195 // ------------------------------------------------------------------------
3118edf1 196 // Basic getters
8636b448 197 // ------------------------------------------------------------------------
b0a282fb 198
abfad0aa 199 /**
25e48683 200 * @return the trace event type
12c155f5 201 */
57a2a5ca 202 Class<? extends ITmfEvent> getEventType();
12c155f5
FC
203
204 /**
25e48683 205 * @return the associated trace resource
12c155f5 206 */
57a2a5ca 207 IResource getResource();
12c155f5 208
25e48683
FC
209 /**
210 * @return the trace path
211 */
57a2a5ca 212 String getPath();
25e48683 213
20658947
FC
214 /**
215 * @return the trace cache size
216 */
57a2a5ca 217 int getCacheSize();
20658947 218
51e75066
AM
219 /**
220 * Index the trace. Depending on the trace type, this could be done at the
221 * constructor or initTrace phase too, so this could be implemented as a
222 * no-op.
223 *
224 * @param waitForCompletion
225 * Should we block the caller until indexing is finished, or not.
226 * @since 2.0
227 */
57a2a5ca 228 void indexTrace(boolean waitForCompletion);
51e75066 229
ff3f02c8
AM
230 // ------------------------------------------------------------------------
231 // Analysis getters
232 // ------------------------------------------------------------------------
233
c068a752 234 /**
ff3f02c8 235 * Returns an analysis module with the given ID.
c068a752 236 *
ff3f02c8
AM
237 * @param id
238 * The analysis module ID
239 * @return The {@link IAnalysisModule} object, or null if an analysis with
240 * the given ID does no exist.
c4767854 241 * @since 3.0
c068a752 242 */
ff3f02c8
AM
243 @Nullable
244 IAnalysisModule getAnalysisModule(String id);
c068a752
GB
245
246 /**
ff3f02c8 247 * Get a list of all analysis modules currently available for this trace.
c068a752 248 *
ff3f02c8 249 * @return An iterable view of the analysis modules
c4767854 250 * @since 3.0
c068a752 251 */
ff3f02c8
AM
252 @NonNull
253 Iterable<IAnalysisModule> getAnalysisModules();
c068a752
GB
254
255 /**
ff3f02c8
AM
256 * Get an analysis module belonging to this trace, with the specified ID and
257 * class.
c068a752 258 *
ff3f02c8
AM
259 * @param moduleClass
260 * Returned modules must extend this class
261 * @param id
262 * The ID of the analysis module
263 * @return The analysis module with specified class and ID, or null if no
264 * such module exists.
265 * @since 3.0
266 */
267 @Nullable
268 <T extends IAnalysisModule> T getAnalysisModuleOfClass(Class<T> moduleClass, String id);
269
270 /**
271 * Return the analysis modules that are of a given class. Module are already
272 * casted to the requested class.
c068a752 273 *
ff3f02c8
AM
274 * @param moduleClass
275 * Returned modules must extend this class
276 * @return List of modules of class moduleClass
c4767854 277 * @since 3.0
c068a752 278 */
ff3f02c8
AM
279 @NonNull
280 <T> Iterable<T> getAnalysisModulesOfClass(Class<T> moduleClass);
c068a752 281
25e48683
FC
282 // ------------------------------------------------------------------------
283 // Trace characteristics getters
284 // ------------------------------------------------------------------------
285
12c155f5
FC
286 /**
287 * @return the number of events in the trace
288 */
57a2a5ca 289 long getNbEvents();
12c155f5
FC
290
291 /**
3118edf1 292 * @return the trace time range
3bd46eef 293 * @since 2.0
12c155f5 294 */
57a2a5ca 295 TmfTimeRange getTimeRange();
12c155f5 296
3118edf1
FC
297 /**
298 * @return the timestamp of the first trace event
3bd46eef 299 * @since 2.0
3118edf1 300 */
57a2a5ca 301 ITmfTimestamp getStartTime();
12c155f5 302
3118edf1
FC
303 /**
304 * @return the timestamp of the last trace event
3bd46eef 305 * @since 2.0
3118edf1 306 */
57a2a5ca 307 ITmfTimestamp getEndTime();
62d1696a 308
13cb5f43
FC
309 /**
310 * @return the streaming interval in ms (0 if not a streaming trace)
311 */
57a2a5ca 312 long getStreamingInterval();
13cb5f43 313
25e48683
FC
314 // ------------------------------------------------------------------------
315 // Trace positioning getters
316 // ------------------------------------------------------------------------
1b70b6dc 317
3118edf1 318 /**
25e48683 319 * @return the current trace location
a3db8436 320 * @since 3.0
3118edf1 321 */
57a2a5ca 322 ITmfLocation getCurrentLocation();
3791b5df
FC
323
324 /**
25e48683 325 * Returns the ratio (proportion) corresponding to the specified location.
0283f7ff 326 *
e73a4ba5
GB
327 * @param location
328 * a trace specific location
25e48683 329 * @return a floating-point number between 0.0 (beginning) and 1.0 (end)
a3db8436 330 * @since 3.0
3791b5df 331 */
57a2a5ca 332 double getLocationRatio(ITmfLocation location);
3791b5df 333
8636b448 334 // ------------------------------------------------------------------------
7e6347b0 335 // SeekEvent operations (returning a trace context)
8636b448
FC
336 // ------------------------------------------------------------------------
337
12c155f5 338 /**
7e6347b0
FC
339 * Position the trace at the specified (trace specific) location.
340 * <p>
341 * A null location is interpreted as seeking for the first event of the
342 * trace.
25e48683 343 * <p>
7e6347b0
FC
344 * If not null, the location requested must be valid otherwise the returned
345 * context is undefined (up to the implementation to recover if possible).
25e48683 346 * <p>
e73a4ba5
GB
347 *
348 * @param location
349 * the trace specific location
3118edf1 350 * @return a context which can later be used to read the corresponding event
a3db8436 351 * @since 3.0
8c8bf09f 352 */
57a2a5ca 353 ITmfContext seekEvent(ITmfLocation location);
12c155f5 354
c76c54bb 355 /**
7e6347b0 356 * Position the trace at the 'rank'th event in the trace.
09e86496 357 * <p>
e73a4ba5 358 * A rank <= 0 is interpreted as seeking for the first event of the trace.
7e6347b0
FC
359 * <p>
360 * If the requested rank is beyond the last trace event, the context
361 * returned will yield a null event if used in a subsequent read.
0283f7ff 362 *
e73a4ba5
GB
363 * @param rank
364 * the event rank
3118edf1 365 * @return a context which can later be used to read the corresponding event
c76c54bb 366 */
57a2a5ca 367 ITmfContext seekEvent(long rank);
12c155f5 368
3118edf1
FC
369 /**
370 * Position the trace at the first event with the specified timestamp. If
e73a4ba5
GB
371 * there is no event with the requested timestamp, a context pointing to the
372 * next chronological event is returned.
09e86496
FC
373 * <p>
374 * A null timestamp is interpreted as seeking for the first event of the
375 * trace.
376 * <p>
377 * If the requested timestamp is beyond the last trace event, the context
378 * returned will yield a null event if used in a subsequent read.
0283f7ff 379 *
e73a4ba5
GB
380 * @param timestamp
381 * the timestamp of desired event
3118edf1 382 * @return a context which can later be used to read the corresponding event
3bd46eef 383 * @since 2.0
3118edf1 384 */
57a2a5ca 385 ITmfContext seekEvent(ITmfTimestamp timestamp);
3118edf1
FC
386
387 /**
7e6347b0
FC
388 * Position the trace at the event located at the specified ratio in the
389 * trace file.
09e86496 390 * <p>
7e6347b0
FC
391 * The notion of ratio (0.0 <= r <= 1.0) is trace specific and left
392 * voluntarily vague. Typically, it would refer to the event proportional
393 * rank (arguably more intuitive) or timestamp in the trace file.
0283f7ff 394 *
e73a4ba5
GB
395 * @param ratio
396 * the proportional 'rank' in the trace
3118edf1
FC
397 * @return a context which can later be used to read the corresponding event
398 */
57a2a5ca 399 ITmfContext seekEvent(double ratio);
3118edf1 400
66262ad8
BH
401 /**
402 * Returns the initial range offset
403 *
404 * @return the initial range offset
405 * @since 2.0
406 */
57a2a5ca 407 ITmfTimestamp getInitialRangeOffset();
bb52f9bc
GB
408
409 /**
410 * Returns the ID of the host this trace is from. The host ID is not
411 * necessarily the hostname, but should be a unique identifier for the
412 * machine on which the trace was taken. It can be used to determine if two
413 * traces were taken on the exact same machine (timestamp are already
414 * synchronized, resources with same id are the same if taken at the same
415 * time, etc).
416 *
417 * @return The host id of this trace
418 * @since 3.0
419 */
e73a4ba5
GB
420 String getHostId();
421
422 // ------------------------------------------------------------------------
423 // Timestamp transformation functions
424 // ------------------------------------------------------------------------
425
426 /**
427 * Returns the timestamp transformation for this trace
428 *
429 * @return the timestamp transform
430 * @since 3.0
431 */
432 ITmfTimestampTransform getTimestampTransform();
433
434 /**
435 * Sets the trace's timestamp transform
436 *
437 * @param tt
438 * The timestamp transform for all timestamps of this trace
439 * @since 3.0
440 */
441 void setTimestampTransform(final ITmfTimestampTransform tt);
442
443 /**
444 * Creates a timestamp for this trace, using the transformation formula
445 *
446 * @param ts
b2c463c5 447 * The time in nanoseconds with which to create the timestamp
e73a4ba5
GB
448 * @return The new timestamp
449 * @since 3.0
450 */
451 ITmfTimestamp createTimestamp(long ts);
bb52f9bc 452
8c8bf09f 453}
This page took 0.089155 seconds and 5 git commands to generate.