1 /*******************************************************************************
2 * Copyright (c) 2012, 2015 Ericsson, École Polytechnique de Montréal
4 * All rights reserved. This program and the accompanying materials are made
5 * 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 * Matthew Khouzam - Initial API and implementation
11 * Patrick Tasse - Updated for removal of context clone
12 * Geneviève Bastien - Added the createTimestamp function
13 *******************************************************************************/
15 package org
.eclipse
.tracecompass
.tmf
.ctf
.core
.trace
;
17 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
19 import java
.nio
.BufferOverflowException
;
20 import java
.nio
.ByteBuffer
;
21 import java
.util
.ArrayList
;
22 import java
.util
.Collection
;
23 import java
.util
.Collections
;
24 import java
.util
.HashMap
;
25 import java
.util
.List
;
29 import org
.eclipse
.core
.resources
.IProject
;
30 import org
.eclipse
.core
.resources
.IResource
;
31 import org
.eclipse
.core
.runtime
.CoreException
;
32 import org
.eclipse
.core
.runtime
.IStatus
;
33 import org
.eclipse
.core
.runtime
.Status
;
34 import org
.eclipse
.jdt
.annotation
.NonNull
;
35 import org
.eclipse
.tracecompass
.ctf
.core
.CTFException
;
36 import org
.eclipse
.tracecompass
.ctf
.core
.event
.CTFClock
;
37 import org
.eclipse
.tracecompass
.ctf
.core
.event
.IEventDeclaration
;
38 import org
.eclipse
.tracecompass
.ctf
.core
.event
.types
.StructDeclaration
;
39 import org
.eclipse
.tracecompass
.ctf
.core
.trace
.CTFTrace
;
40 import org
.eclipse
.tracecompass
.ctf
.core
.trace
.CTFTraceReader
;
41 import org
.eclipse
.tracecompass
.ctf
.core
.trace
.Metadata
;
42 import org
.eclipse
.tracecompass
.internal
.tmf
.ctf
.core
.Activator
;
43 import org
.eclipse
.tracecompass
.internal
.tmf
.ctf
.core
.trace
.iterator
.CtfIterator
;
44 import org
.eclipse
.tracecompass
.internal
.tmf
.ctf
.core
.trace
.iterator
.CtfIteratorManager
;
45 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
46 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEventField
;
47 import org
.eclipse
.tracecompass
.tmf
.core
.event
.TmfEventField
;
48 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.ITmfEventAspect
;
49 import org
.eclipse
.tracecompass
.tmf
.core
.exceptions
.TmfTraceException
;
50 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
51 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfNanoTimestamp
;
52 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestamp
;
53 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfContext
;
54 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTraceProperties
;
55 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTraceWithPreDefinedEvents
;
56 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTrace
;
57 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TraceValidationStatus
;
58 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.indexer
.ITmfPersistentlyIndexable
;
59 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.indexer
.ITmfTraceIndexer
;
60 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.indexer
.TmfBTreeTraceIndexer
;
61 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.indexer
.checkpoint
.ITmfCheckpoint
;
62 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.indexer
.checkpoint
.TmfCheckpoint
;
63 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.location
.ITmfLocation
;
64 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.CtfConstants
;
65 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.context
.CtfLocation
;
66 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.context
.CtfLocationInfo
;
67 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.context
.CtfTmfContext
;
68 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.event
.CtfTmfEvent
;
69 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.event
.CtfTmfEventFactory
;
70 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.event
.CtfTmfEventType
;
71 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.event
.aspect
.CtfChannelAspect
;
72 import org
.eclipse
.tracecompass
.tmf
.ctf
.core
.event
.aspect
.CtfCpuAspect
;
74 import com
.google
.common
.collect
.ImmutableList
;
75 import com
.google
.common
.collect
.ImmutableSet
;
78 * The CTf trace handler
81 * @author Matthew khouzam
83 public class CtfTmfTrace
extends TmfTrace
84 implements ITmfTraceProperties
, ITmfPersistentlyIndexable
,
85 ITmfTraceWithPreDefinedEvents
{
87 // -------------------------------------------
89 // -------------------------------------------
92 * Default cache size for CTF traces
94 protected static final int DEFAULT_CACHE_SIZE
= 50000;
97 * Event aspects available for all CTF traces
100 protected static final @NonNull Collection
<ITmfEventAspect
> CTF_ASPECTS
=
101 checkNotNull(ImmutableList
.of(
102 ITmfEventAspect
.BaseAspects
.TIMESTAMP
,
103 new CtfChannelAspect(),
105 ITmfEventAspect
.BaseAspects
.EVENT_TYPE
,
106 ITmfEventAspect
.BaseAspects
.CONTENTS
110 * The Ctf clock unique identifier field
112 private static final String CLOCK_HOST_PROPERTY
= "uuid"; //$NON-NLS-1$
113 private static final int CONFIDENCE
= 10;
114 private static final int MIN_CONFIDENCE
= 1;
116 // -------------------------------------------
118 // -------------------------------------------
120 private final Map
<String
, CtfTmfEventType
> fContainedEventTypes
=
121 Collections
.synchronizedMap(new HashMap
<String
, CtfTmfEventType
>());
123 private final CtfIteratorManager fIteratorManager
=
124 new CtfIteratorManager(this);
126 private final @NonNull CtfTmfEventFactory fEventFactory
;
128 /** Reference to the CTF Trace */
129 private CTFTrace fTrace
;
131 // -------------------------------------------
133 // -------------------------------------------
136 * Default constructor
138 public CtfTmfTrace() {
141 /* Use default event factory */
142 fEventFactory
= CtfTmfEventFactory
.instance();
146 * Constructor for sub-classes to specify their own event factory.
148 * @param eventFactory
149 * The event factory to use to generate trace events
152 protected CtfTmfTrace(@NonNull CtfTmfEventFactory eventFactory
) {
154 fEventFactory
= eventFactory
;
157 // -------------------------------------------
158 // TmfTrace Overrides
159 // -------------------------------------------
164 * The resource associated with this trace
166 * The path to the trace file
168 * The type of events that will be read from this trace
169 * @throws TmfTraceException
170 * If something went wrong while reading the trace
173 public void initTrace(final IResource resource
, final String path
, final Class
<?
extends ITmfEvent
> eventType
)
174 throws TmfTraceException
{
176 * Set the cache size. This has to be done before the call to super()
177 * because the super needs to know the cache size.
181 super.initTrace(resource
, path
, eventType
);
184 this.fTrace
= new CTFTrace(path
);
186 /* Set the start and (current) end times for this trace */
187 ctx
= (CtfTmfContext
) seekEvent(0L);
188 CtfTmfEvent event
= getNext(ctx
);
189 if ((ctx
.getLocation().equals(CtfIterator
.NULL_LOCATION
)) || (ctx
.getCurrentEvent() == null)) {
190 /* Handle the case where the trace is empty */
191 this.setStartTime(TmfTimestamp
.BIG_BANG
);
193 final ITmfTimestamp curTime
= event
.getTimestamp();
194 this.setStartTime(curTime
);
195 this.setEndTime(curTime
);
198 * Register every event type. When you call getType, it will
199 * register a trace to that type in the TmfEventTypeManager
201 try (CtfIterator iter
= fIteratorManager
.getIterator(ctx
)) {
202 for (IEventDeclaration ied
: iter
.getEventDeclarations()) {
203 CtfTmfEventType ctfTmfEventType
= fContainedEventTypes
.get(ied
.getName());
204 if (ctfTmfEventType
== null) {
205 List
<ITmfEventField
> content
= new ArrayList
<>();
206 /* Should only return null the first time */
207 final StructDeclaration fields
= ied
.getFields();
208 if (fields
!= null) {
209 for (String fieldName
: fields
.getFieldsList()) {
210 content
.add(new TmfEventField(checkNotNull(fieldName
), null, null));
212 ITmfEventField contentTree
= new TmfEventField(
213 ITmfEventField
.ROOT_FIELD_ID
,
215 content
.toArray(new ITmfEventField
[content
.size()]));
217 ctfTmfEventType
= new CtfTmfEventType(ied
.getName(), contentTree
);
218 fContainedEventTypes
.put(ctfTmfEventType
.getName(), ctfTmfEventType
);
224 } catch (final CTFException e
) {
226 * If it failed at the init(), we can assume it's because the file
227 * was not found or was not recognized as a CTF trace. Throw into
228 * the new type of exception expected by the rest of TMF.
230 throw new TmfTraceException(e
.getMessage(), e
);
235 public synchronized void dispose() {
236 fIteratorManager
.dispose();
237 if (fTrace
!= null) {
246 * The default implementation of a CTF trace.
248 * Firstly a weak validation of the metadata is done to determine if the
249 * path is actually for a CTF trace. After that a full validation is done.
251 * If the weak and full validation are successful the confidence is set
254 * If the weak validation was successful, but the full validation fails
255 * a TraceValidationStatus with severity warning and confidence of 1 is
258 * If both weak and full validation fails an error status is returned.
261 public IStatus
validate(final IProject project
, final String path
) {
262 boolean isMetadataFile
= false;
264 isMetadataFile
= Metadata
.preValidate(path
);
265 } catch (final CTFException e
) {
266 return new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.CtfTmfTrace_ReadingError
+ ": " + e
.toString(), e
); //$NON-NLS-1$
269 if (isMetadataFile
) {
270 // Trace is pre-validated, continue will full validation
272 final CTFTrace trace
= new CTFTrace(path
);
273 if (!trace
.majorIsSet()) {
274 if (isMetadataFile
) {
275 return new TraceValidationStatus(MIN_CONFIDENCE
, IStatus
.WARNING
, Activator
.PLUGIN_ID
, Messages
.CtfTmfTrace_MajorNotSet
, null);
277 return new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.CtfTmfTrace_MajorNotSet
);
280 // Validate using reader initialization
281 try (CTFTraceReader ctfTraceReader
= new CTFTraceReader(trace
)) {}
283 // Trace is validated, return with confidence
284 return new CtfTraceValidationStatus(CONFIDENCE
, Activator
.PLUGIN_ID
, trace
.getEnvironment());
286 } catch (final CTFException
| BufferOverflowException e
) {
287 // return warning since it's a CTF trace but with errors in it
288 return new TraceValidationStatus(MIN_CONFIDENCE
, IStatus
.WARNING
, Activator
.PLUGIN_ID
, Messages
.CtfTmfTrace_ReadingError
+ ": " + e
.toString(), e
); //$NON-NLS-1$
291 return new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.CtfTmfTrace_ReadingError
);
295 public Iterable
<ITmfEventAspect
> getEventAspects() {
300 * Method getCurrentLocation. This is not applicable in CTF
302 * @return null, since the trace has no knowledge of the current location
303 * @see org.eclipse.tracecompass.tmf.core.trace.ITmfTrace#getCurrentLocation()
306 public ITmfLocation
getCurrentLocation() {
311 public double getLocationRatio(ITmfLocation location
) {
312 final CtfLocation curLocation
= (CtfLocation
) location
;
313 final long startTime
= getStartTime().getValue();
314 final double diff
= curLocation
.getLocationInfo().getTimestamp() - startTime
;
315 final double total
= getEndTime().getValue() - startTime
;
316 return Math
.max(0.0, Math
.min(1.0, diff
/ total
));
324 * @return ITmfContext
327 public synchronized ITmfContext
seekEvent(final ITmfLocation location
) {
328 CtfLocation currentLocation
= (CtfLocation
) location
;
329 CtfTmfContext context
= new CtfTmfContext(this);
330 if (fTrace
== null) {
331 context
.setLocation(null);
332 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
336 * The rank is set to 0 if the iterator seeks the beginning. If not, it
337 * will be set to UNKNOWN_RANK, since CTF traces don't support seeking
340 if (currentLocation
== null) {
341 currentLocation
= new CtfLocation(new CtfLocationInfo(0L, 0L));
344 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
346 /* This will seek and update the location after the seek */
347 context
.setLocation(currentLocation
);
352 public synchronized ITmfContext
seekEvent(double ratio
) {
353 CtfTmfContext context
= new CtfTmfContext(this);
354 if (fTrace
== null) {
355 context
.setLocation(null);
356 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
359 final long end
= getEndTime().getValue();
360 final long start
= getStartTime().getValue();
361 final long diff
= end
- start
;
362 final long ratioTs
= Math
.round(diff
* ratio
) + start
;
363 context
.seek(ratioTs
);
364 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
369 * Method readNextEvent.
373 * @return CtfTmfEvent
374 * @see org.eclipse.tracecompass.tmf.core.trace.ITmfTrace#getNext(ITmfContext)
377 public synchronized CtfTmfEvent
getNext(final ITmfContext context
) {
378 if (fTrace
== null) {
381 CtfTmfEvent event
= null;
382 if (context
instanceof CtfTmfContext
) {
383 if (context
.getLocation() == null || CtfLocation
.INVALID_LOCATION
.equals(context
.getLocation().getLocationInfo())) {
386 CtfTmfContext ctfContext
= (CtfTmfContext
) context
;
387 event
= ctfContext
.getCurrentEvent();
390 updateAttributes(context
, event
);
391 ctfContext
.advance();
392 ctfContext
.increaseRank();
400 * Ctf traces have a clock with a unique uuid that will be used to identify
401 * the host. Traces with the same clock uuid will be known to have been made
402 * on the same machine.
404 * Note: uuid is an optional field, it may not be there for a clock.
407 public String
getHostId() {
408 CTFClock clock
= fTrace
.getClock();
410 String clockHost
= (String
) clock
.getProperty(CLOCK_HOST_PROPERTY
);
411 if (clockHost
!= null) {
415 return super.getHostId();
419 * Get the CTF environment variables defined in this CTF trace, in <name,
420 * value> form. This comes from the trace's CTF metadata.
422 * @return The CTF environment
424 public Map
<String
, String
> getEnvironment() {
425 return fTrace
.getEnvironment();
428 // -------------------------------------------
429 // ITmfTraceProperties
430 // -------------------------------------------
433 public Map
<String
, String
> getTraceProperties() {
434 Map
<String
, String
> properties
= new HashMap
<>();
435 properties
.putAll(fTrace
.getEnvironment());
436 properties
.put(Messages
.CtfTmfTrace_HostID
, getHostId());
440 // -------------------------------------------
442 // -------------------------------------------
445 * gets the clock offset
447 * @return the clock offset in ns
449 public long getOffset() {
450 if (fTrace
!= null) {
451 return fTrace
.getOffset();
457 * Convert a CTF timestamp in CPU cycles to its equivalent in nanoseconds
461 * The timestamp in cycles
462 * @return The timestamp in nanoseconds
464 public long timestampCyclesToNanos(long cycles
) {
465 return fTrace
.timestampCyclesToNanos(cycles
);
469 * Convert a CTF timestamp in nanoseconds to its equivalent in CPU cycles
473 * The timestamp in nanoseconds
474 * @return The timestamp in cycles
476 public long timestampNanoToCycles(long nanos
) {
477 return fTrace
.timestampNanoToCycles(nanos
);
481 * Gets the list of declared events
484 public Set
<CtfTmfEventType
> getContainedEventTypes() {
485 return ImmutableSet
.copyOf(fContainedEventTypes
.values());
489 * Register an event type to this trace.
491 * Public visibility so that {@link CtfTmfEvent#getType} can call it.
493 * FIXME This could probably be made cleaner?
496 * The event type to register
498 public void registerEventType(CtfTmfEventType eventType
) {
499 fContainedEventTypes
.put(eventType
.getName(), eventType
);
502 // -------------------------------------------
504 // -------------------------------------------
507 public CtfTmfEvent
parseEvent(ITmfContext context
) {
508 CtfTmfEvent event
= null;
509 if (context
instanceof CtfTmfContext
) {
510 final ITmfContext tmpContext
= seekEvent(context
.getLocation());
511 event
= getNext(tmpContext
);
517 * Sets the cache size for a CtfTmfTrace.
519 protected void setCacheSize() {
520 setCacheSize(DEFAULT_CACHE_SIZE
);
523 // -------------------------------------------
524 // CtfIterator factory methods
525 // -------------------------------------------
528 * Get the event factory for this trace to generate new events for it.
530 * @return The event factory
533 public @NonNull CtfTmfEventFactory
getEventFactory() {
534 return fEventFactory
;
538 * Get an iterator to the trace
540 * @return an iterator to the trace
542 public ITmfContext
createIterator() {
544 return new CtfIterator(fTrace
, this);
545 } catch (CTFException e
) {
546 Activator
.getDefault().logError(e
.getMessage(), e
);
552 * Get an iterator to the trace, , which will initially point to the given
555 * @param ctfLocationData
556 * The initial timestamp the iterator will be pointing to
559 * @return The new iterator
561 public ITmfContext
createIterator(CtfLocationInfo ctfLocationData
, long rank
) {
563 return new CtfIterator(fTrace
, this, ctfLocationData
, rank
);
564 } catch (CTFException e
) {
565 Activator
.getDefault().logError(e
.getMessage(), e
);
571 * Create the 'CtfIterator' object from a CtfTmfContext.
574 * The iterator will initially be pointing to this context
575 * @return A new CtfIterator object
578 public ITmfContext
createIteratorFromContext(CtfTmfContext context
) {
579 return fIteratorManager
.getIterator(context
);
583 * Dispose an iterator that was create with
584 * {@link #createIteratorFromContext}
587 * The last context that was pointed to by the iterator (this is
588 * the 'key' to find the correct iterator to dispose).
591 public void disposeContext(CtfTmfContext context
) {
592 fIteratorManager
.removeIterator(context
);
595 // ------------------------------------------------------------------------
596 // Timestamp transformation functions
597 // ------------------------------------------------------------------------
603 public @NonNull TmfNanoTimestamp
createTimestamp(long ts
) {
604 return new TmfNanoTimestamp(getTimestampTransform().transform(ts
));
607 private static int fCheckpointSize
= -1;
610 public synchronized int getCheckpointSize() {
611 if (fCheckpointSize
== -1) {
612 TmfCheckpoint c
= new TmfCheckpoint(new TmfNanoTimestamp(0), new CtfLocation(0, 0), 0);
613 ByteBuffer b
= ByteBuffer
.allocate(ITmfCheckpoint
.MAX_SERIALIZE_SIZE
);
616 fCheckpointSize
= b
.position();
619 return fCheckpointSize
;
623 protected ITmfTraceIndexer
createIndexer(int interval
) {
624 return new TmfBTreeTraceIndexer(this, interval
);
628 public ITmfLocation
restoreLocation(ByteBuffer bufferIn
) {
629 return new CtfLocation(bufferIn
);
633 public boolean isComplete() {
634 if (getResource() == null) {
640 String sessionName
= null;
642 host
= getResource().getPersistentProperty(CtfConstants
.LIVE_HOST
);
643 port
= getResource().getPersistentProperty(CtfConstants
.LIVE_PORT
);
644 sessionName
= getResource().getPersistentProperty(CtfConstants
.LIVE_SESSION_NAME
);
645 } catch (CoreException e
) {
646 Activator
.getDefault().logError(e
.getMessage(), e
);
647 // Something happened to the resource, assume we won't get any more
651 return host
== null || port
== null || sessionName
== null;
655 public void setComplete(final boolean isComplete
) {
656 super.setComplete(isComplete
);
659 getResource().setPersistentProperty(CtfConstants
.LIVE_HOST
, null);
660 getResource().setPersistentProperty(CtfConstants
.LIVE_PORT
, null);
661 getResource().setPersistentProperty(CtfConstants
.LIVE_SESSION_NAME
, null);
663 } catch (CoreException e
) {
664 Activator
.getDefault().logError(e
.getMessage(), e
);