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