1 /*******************************************************************************
2 * Copyright (c) 2009, 2015 Ericsson, École Polytechnique de Montréal
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 * Patrick Tasse - Updated for removal of context clone
13 * Geneviève Bastien - Added timestamp transforms, its saving to file and
14 * timestamp creation functions
15 *******************************************************************************/
17 package org
.eclipse
.tracecompass
.tmf
.core
.trace
;
19 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
22 import java
.util
.Collection
;
23 import java
.util
.Collections
;
24 import java
.util
.HashSet
;
25 import java
.util
.LinkedHashMap
;
29 import org
.eclipse
.core
.resources
.IResource
;
30 import org
.eclipse
.core
.runtime
.IStatus
;
31 import org
.eclipse
.core
.runtime
.MultiStatus
;
32 import org
.eclipse
.core
.runtime
.Path
;
33 import org
.eclipse
.core
.runtime
.Status
;
34 import org
.eclipse
.jdt
.annotation
.NonNull
;
35 import org
.eclipse
.jdt
.annotation
.Nullable
;
36 import org
.eclipse
.tracecompass
.internal
.tmf
.core
.Activator
;
37 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisModule
;
38 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.IAnalysisModuleHelper
;
39 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.TmfAnalysisManager
;
40 import org
.eclipse
.tracecompass
.tmf
.core
.component
.TmfEventProvider
;
41 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
42 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfLostEvent
;
43 import org
.eclipse
.tracecompass
.tmf
.core
.event
.TmfEvent
;
44 import org
.eclipse
.tracecompass
.tmf
.core
.event
.aspect
.ITmfEventAspect
;
45 import org
.eclipse
.tracecompass
.tmf
.core
.exceptions
.TmfAnalysisException
;
46 import org
.eclipse
.tracecompass
.tmf
.core
.exceptions
.TmfTraceException
;
47 import org
.eclipse
.tracecompass
.tmf
.core
.request
.ITmfEventRequest
;
48 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
49 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalManager
;
50 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceOpenedSignal
;
51 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceRangeUpdatedSignal
;
52 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceUpdatedSignal
;
53 import org
.eclipse
.tracecompass
.tmf
.core
.synchronization
.ITmfTimestampTransform
;
54 import org
.eclipse
.tracecompass
.tmf
.core
.synchronization
.TimestampTransformFactory
;
55 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
56 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfNanoTimestamp
;
57 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimeRange
;
58 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimestamp
;
59 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.indexer
.ITmfTraceIndexer
;
60 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.indexer
.checkpoint
.TmfCheckpointIndexer
;
61 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.location
.ITmfLocation
;
63 import com
.google
.common
.collect
.ImmutableList
;
64 import com
.google
.common
.collect
.Multimap
;
67 * Abstract implementation of ITmfTrace.
69 * Since the concept of 'location' is trace specific, the concrete classes have
70 * to provide the related methods, namely:
72 * <li> public ITmfLocation<?> getCurrentLocation()
73 * <li> public double getLocationRatio(ITmfLocation<?> location)
74 * <li> public ITmfContext seekEvent(ITmfLocation<?> location)
75 * <li> public ITmfContext seekEvent(double ratio)
76 * <li> public IStatus validate(IProject project, String path)
79 * When constructing an event, the concrete trace should use the trace's
80 * timestamp transform to create the timestamp, by either transforming the
81 * parsed time value directly or by using the method createTimestamp().
83 * The concrete class can either specify its own indexer or use the provided
84 * TmfCheckpointIndexer (default). In this case, the trace cache size will be
85 * used as checkpoint interval.
88 * @author Francois Chouinard
91 * @see ITmfTraceIndexer
92 * @see ITmfEventParser
94 public abstract class TmfTrace
extends TmfEventProvider
implements ITmfTrace
, ITmfEventParser
, ITmfTraceCompleteness
{
96 // ------------------------------------------------------------------------
98 // ------------------------------------------------------------------------
101 * Basic aspects that should be valid for all trace types.
103 public static final @NonNull Collection
<ITmfEventAspect
> BASE_ASPECTS
=
104 checkNotNull(ImmutableList
.of(
105 ITmfEventAspect
.BaseAspects
.TIMESTAMP
,
106 ITmfEventAspect
.BaseAspects
.EVENT_TYPE
,
107 ITmfEventAspect
.BaseAspects
.CONTENTS
110 // ------------------------------------------------------------------------
111 // Instance attributes
112 // ------------------------------------------------------------------------
114 // The resource used for persistent properties for this trace
115 private IResource fResource
;
118 private @Nullable String fTraceTypeId
;
121 private String fPath
;
123 // The trace cache page size
124 private int fCacheSize
= ITmfTrace
.DEFAULT_TRACE_CACHE_SIZE
;
126 // The number of events collected (so far)
127 private volatile long fNbEvents
= 0;
129 // The time span of the event stream
130 private @NonNull ITmfTimestamp fStartTime
= TmfTimestamp
.BIG_BANG
;
131 private @NonNull ITmfTimestamp fEndTime
= TmfTimestamp
.BIG_BANG
;
133 // The trace streaming interval (0 = no streaming)
134 private long fStreamingInterval
= 0;
137 private ITmfTraceIndexer fIndexer
;
139 private ITmfTimestampTransform fTsTransform
;
141 private final Map
<String
, IAnalysisModule
> fAnalysisModules
=
142 Collections
.synchronizedMap(new LinkedHashMap
<String
, IAnalysisModule
>());
144 // ------------------------------------------------------------------------
146 // ------------------------------------------------------------------------
149 * The default, parameterless, constructor
153 fIndexer
= new TmfCheckpointIndexer(this);
160 * The resource associated to the trace
162 * The type of events that will be read from this trace
164 * The path to the trace on the filesystem
166 * The trace cache size. Pass '-1' to use the default specified
167 * in {@link ITmfTrace#DEFAULT_TRACE_CACHE_SIZE}
169 * The trace streaming interval. You can use '0' for post-mortem
171 * @throws TmfTraceException
172 * If something failed during the opening
174 protected TmfTrace(final IResource resource
,
175 final Class
<?
extends ITmfEvent
> type
,
179 throws TmfTraceException
{
181 fCacheSize
= (cacheSize
> 0) ? cacheSize
: ITmfTrace
.DEFAULT_TRACE_CACHE_SIZE
;
182 fStreamingInterval
= interval
;
183 initialize(resource
, path
, type
);
189 * @param trace the original trace
190 * @throws TmfTraceException Should not happen usually
192 public TmfTrace(final TmfTrace trace
) throws TmfTraceException
{
195 throw new IllegalArgumentException();
197 fCacheSize
= trace
.getCacheSize();
198 fStreamingInterval
= trace
.getStreamingInterval();
199 initialize(trace
.getResource(), trace
.getPath(), trace
.getEventType());
203 * Creates the indexer instance. Classes extending this class can override
204 * this to provide a different indexer implementation.
206 * @param interval the checkpoints interval
208 * @return the indexer
210 protected ITmfTraceIndexer
createIndexer(int interval
) {
211 return new TmfCheckpointIndexer(this, interval
);
214 // ------------------------------------------------------------------------
215 // ITmfTrace - Initializers
216 // ------------------------------------------------------------------------
219 public void initTrace(final IResource resource
, final String path
, final Class
<?
extends ITmfEvent
> type
, String name
, String traceTypeId
) throws TmfTraceException
{
221 throw new IllegalArgumentException();
224 fTraceTypeId
= traceTypeId
;
225 initTrace(resource
, path
, type
);
229 public void initTrace(final IResource resource
, final String path
, final Class
<?
extends ITmfEvent
> type
) throws TmfTraceException
{
230 initialize(resource
, path
, type
);
234 * Initialize the trace common attributes and the base component.
236 * @param resource the Eclipse resource (trace)
237 * @param path the trace path
238 * @param type the trace event type
240 * @throws TmfTraceException If something failed during the initialization
242 protected void initialize(final IResource resource
,
244 final Class
<?
extends ITmfEvent
> type
)
245 throws TmfTraceException
{
247 throw new TmfTraceException("Invalid trace path"); //$NON-NLS-1$
250 fResource
= resource
;
251 String traceName
= getName();
252 if (traceName
.isEmpty()) {
253 traceName
= (resource
!= null) ? resource
.getName() : new Path(path
).lastSegment();
255 super.init(traceName
, type
);
256 // register as VIP after super.init() because TmfComponent registers to signal manager there
257 TmfSignalManager
.registerVIP(this);
258 if (fIndexer
!= null) {
261 fIndexer
= createIndexer(fCacheSize
);
265 * Indicates if the path points to an existing file/directory
267 * @param path the path to test
268 * @return true if the file/directory exists
270 protected boolean fileExists(final String path
) {
271 final File file
= new File(path
);
272 return file
.exists();
276 public void indexTrace(boolean waitForCompletion
) {
277 getIndexer().buildIndex(0, TmfTimeRange
.ETERNITY
, waitForCompletion
);
281 * Instantiate the applicable analysis modules and executes the analysis
282 * modules that are meant to be automatically executed
284 * @return An IStatus indicating whether the analysis could be run
285 * successfully or not
287 protected IStatus
executeAnalysis() {
288 MultiStatus status
= new MultiStatus(Activator
.PLUGIN_ID
, IStatus
.OK
, null, null);
290 Multimap
<String
, IAnalysisModuleHelper
> modules
= TmfAnalysisManager
.getAnalysisModules();
291 for (IAnalysisModuleHelper helper
: modules
.values()) {
293 IAnalysisModule module
= helper
.newModule(this);
294 if (module
== null) {
297 fAnalysisModules
.put(module
.getId(), module
);
298 if (module
.isAutomatic()) {
299 status
.add(module
.schedule());
301 } catch (TmfAnalysisException e
) {
302 status
.add(new Status(IStatus
.WARNING
, Activator
.PLUGIN_ID
, e
.getMessage()));
309 public IAnalysisModule
getAnalysisModule(String analysisId
) {
310 return fAnalysisModules
.get(analysisId
);
315 public Iterable
<IAnalysisModule
> getAnalysisModules() {
316 synchronized (fAnalysisModules
) {
317 Set
<IAnalysisModule
> modules
= new HashSet
<>(fAnalysisModules
.values());
323 public Iterable
<ITmfEventAspect
> getEventAspects() {
324 /* By default we provide only the base aspects valid for all trace types */
332 public synchronized void dispose() {
333 /* Clean up the index if applicable */
334 if (getIndexer() != null) {
335 getIndexer().dispose();
338 /* Clean up the analysis modules */
339 synchronized (fAnalysisModules
) {
340 for (IAnalysisModule module
: fAnalysisModules
.values()) {
343 fAnalysisModules
.clear();
349 // ------------------------------------------------------------------------
350 // ITmfTrace - Basic getters
351 // ------------------------------------------------------------------------
354 public Class
<?
extends ITmfEvent
> getEventType() {
355 return super.getType();
359 public IResource
getResource() {
364 public @Nullable String
getTraceTypeId() {
369 public String
getPath() {
374 public int getCacheSize() {
379 public long getStreamingInterval() {
380 return fStreamingInterval
;
384 * @return the trace indexer
386 protected ITmfTraceIndexer
getIndexer() {
390 // ------------------------------------------------------------------------
391 // ITmfTrace - Trace characteristics getters
392 // ------------------------------------------------------------------------
395 public long getNbEvents() {
400 public @NonNull TmfTimeRange
getTimeRange() {
401 return new TmfTimeRange(fStartTime
, fEndTime
);
405 public ITmfTimestamp
getStartTime() {
410 public ITmfTimestamp
getEndTime() {
415 public ITmfTimestamp
getInitialRangeOffset() {
416 final long DEFAULT_INITIAL_OFFSET_VALUE
= (1L * 100 * 1000 * 1000); // .1sec
417 return new TmfTimestamp(DEFAULT_INITIAL_OFFSET_VALUE
, ITmfTimestamp
.NANOSECOND_SCALE
);
421 public String
getHostId() {
422 return this.getName();
425 // ------------------------------------------------------------------------
426 // Convenience setters
427 // ------------------------------------------------------------------------
430 * Set the trace cache size. Must be done at initialization time.
432 * @param cacheSize The trace cache size
434 protected void setCacheSize(final int cacheSize
) {
435 fCacheSize
= cacheSize
;
439 * Set the trace known number of events. This can be quite dynamic
440 * during indexing or for live traces.
442 * @param nbEvents The number of events
444 protected synchronized void setNbEvents(final long nbEvents
) {
445 fNbEvents
= (nbEvents
> 0) ? nbEvents
: 0;
449 * Update the trace events time range
451 * @param range the new time range
453 protected void setTimeRange(final @NonNull TmfTimeRange range
) {
454 fStartTime
= range
.getStartTime();
455 fEndTime
= range
.getEndTime();
459 * Update the trace chronologically first event timestamp
461 * @param startTime the new first event timestamp
463 protected void setStartTime(final @NonNull ITmfTimestamp startTime
) {
464 fStartTime
= startTime
;
468 * Update the trace chronologically last event timestamp
470 * @param endTime the new last event timestamp
472 protected void setEndTime(final @NonNull ITmfTimestamp endTime
) {
477 * Set the polling interval for live traces (default = 0 = no streaming).
479 * @param interval the new trace streaming interval
481 protected void setStreamingInterval(final long interval
) {
482 fStreamingInterval
= (interval
> 0) ? interval
: 0;
485 // ------------------------------------------------------------------------
486 // ITmfTrace - SeekEvent operations (returning a trace context)
487 // ------------------------------------------------------------------------
490 public synchronized ITmfContext
seekEvent(final long rank
) {
492 // A rank <= 0 indicates to seek the first event
494 ITmfContext context
= seekEvent((ITmfLocation
) null);
499 // Position the trace at the checkpoint
500 final ITmfContext context
= fIndexer
.seekIndex(rank
);
502 // And locate the requested event context
503 long pos
= context
.getRank();
505 ITmfEvent event
= getNext(context
);
506 while ((event
!= null) && (++pos
< rank
)) {
507 event
= getNext(context
);
514 public synchronized ITmfContext
seekEvent(final ITmfTimestamp timestamp
) {
516 // A null timestamp indicates to seek the first event
517 if (timestamp
== null) {
518 ITmfContext context
= seekEvent((ITmfLocation
) null);
523 // Position the trace at the checkpoint
524 ITmfContext context
= fIndexer
.seekIndex(timestamp
);
526 // And locate the requested event context
527 ITmfLocation previousLocation
= context
.getLocation();
528 long previousRank
= context
.getRank();
529 ITmfEvent event
= getNext(context
);
530 while (event
!= null && event
.getTimestamp().compareTo(timestamp
) < 0) {
531 previousLocation
= context
.getLocation();
532 previousRank
= context
.getRank();
533 event
= getNext(context
);
536 context
.setLocation(null);
537 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
540 context
= seekEvent(previousLocation
);
541 context
.setRank(previousRank
);
546 // ------------------------------------------------------------------------
547 // Read operations (returning an actual event)
548 // ------------------------------------------------------------------------
551 public abstract ITmfEvent
parseEvent(ITmfContext context
);
554 public synchronized ITmfEvent
getNext(final ITmfContext context
) {
555 // parseEvent() does not update the context
556 final ITmfEvent event
= parseEvent(context
);
558 updateAttributes(context
, event
);
559 context
.setLocation(getCurrentLocation());
560 context
.increaseRank();
566 * Update the trace attributes
568 * @param context the current trace context
569 * @param timestamp the corresponding timestamp
570 * @deprecated Use {@link #updateAttributes(ITmfContext, ITmfEvent)}
573 protected synchronized void updateAttributes(final ITmfContext context
, final @NonNull ITmfTimestamp timestamp
) {
574 updateAttributes(context
, new TmfEvent(this, context
.getRank(), timestamp
, null, null));
578 * Update the trace attributes
580 * @param context the current trace context
581 * @param event the corresponding event
584 protected synchronized void updateAttributes(final ITmfContext context
, final @NonNull ITmfEvent event
) {
585 ITmfTimestamp timestamp
= event
.getTimestamp();
586 ITmfTimestamp endTime
= timestamp
;
587 if (event
instanceof ITmfLostEvent
) {
588 endTime
= ((ITmfLostEvent
) event
).getTimeRange().getEndTime();
590 if (fStartTime
.equals(TmfTimestamp
.BIG_BANG
) || (fStartTime
.compareTo(timestamp
) > 0)) {
591 fStartTime
= timestamp
;
593 if (fEndTime
.equals(TmfTimestamp
.BIG_CRUNCH
) || (fEndTime
.compareTo(endTime
) < 0)) {
596 if (context
.hasValidRank()) {
597 long rank
= context
.getRank();
598 if (fNbEvents
<= rank
) {
599 fNbEvents
= rank
+ 1;
601 if (fIndexer
!= null) {
602 fIndexer
.updateIndex(context
, timestamp
);
607 // ------------------------------------------------------------------------
609 // ------------------------------------------------------------------------
612 public synchronized ITmfContext
armRequest(final ITmfEventRequest request
) {
613 if (executorIsShutdown()) {
616 if (!TmfTimestamp
.BIG_BANG
.equals(request
.getRange().getStartTime())
617 && (request
.getIndex() == 0)) {
618 final ITmfContext context
= seekEvent(request
.getRange().getStartTime());
619 request
.setStartIndex((int) context
.getRank());
623 return seekEvent(request
.getIndex());
626 // ------------------------------------------------------------------------
628 // ------------------------------------------------------------------------
631 * Handler for the Trace Opened signal
634 * The incoming signal
637 public void traceOpened(TmfTraceOpenedSignal signal
) {
638 boolean signalIsForUs
= false;
639 for (ITmfTrace trace
: TmfTraceManager
.getTraceSet(signal
.getTrace())) {
641 signalIsForUs
= true;
646 if (!signalIsForUs
) {
651 * The signal is either for this trace, or for an experiment containing
654 IStatus status
= executeAnalysis();
655 if (!status
.isOK()) {
656 Activator
.log(status
);
659 TmfTraceManager
.refreshSupplementaryFiles(this);
661 if (signal
.getTrace() == this) {
662 /* Additionally, the signal is directly for this trace. */
663 if (getNbEvents() == 0) {
667 /* For a streaming trace, the range updated signal should be sent
668 * by the subclass when a new safe time is determined.
670 if (getStreamingInterval() > 0) {
675 final TmfTimeRange timeRange
= new TmfTimeRange(getStartTime(), TmfTimestamp
.BIG_CRUNCH
);
676 final TmfTraceRangeUpdatedSignal rangeUpdatedsignal
= new TmfTraceRangeUpdatedSignal(this, this, timeRange
);
678 // Broadcast in separate thread to prevent deadlock
679 broadcastAsync(rangeUpdatedsignal
);
686 * Signal handler for the TmfTraceRangeUpdatedSignal signal
688 * @param signal The incoming signal
691 public void traceRangeUpdated(final TmfTraceRangeUpdatedSignal signal
) {
692 if (signal
.getTrace() == this) {
693 getIndexer().buildIndex(getNbEvents(), signal
.getRange(), false);
698 * Signal handler for the TmfTraceUpdatedSignal signal
700 * @param signal The incoming signal
703 public void traceUpdated(final TmfTraceUpdatedSignal signal
) {
704 if (signal
.getSource() == getIndexer()) {
705 fNbEvents
= signal
.getNbEvents();
706 fStartTime
= signal
.getRange().getStartTime();
707 fEndTime
= signal
.getRange().getEndTime();
711 // ------------------------------------------------------------------------
712 // Timestamp transformation functions
713 // ------------------------------------------------------------------------
716 public ITmfTimestampTransform
getTimestampTransform() {
717 if (fTsTransform
== null) {
718 fTsTransform
= TimestampTransformFactory
.getTimestampTransform(getResource());
724 public void setTimestampTransform(final ITmfTimestampTransform tt
) {
726 TimestampTransformFactory
.setTimestampTransform(getResource(), tt
);
730 public @NonNull ITmfTimestamp
createTimestamp(long ts
) {
731 return new TmfNanoTimestamp(getTimestampTransform().transform(ts
));
734 // ------------------------------------------------------------------------
736 // ------------------------------------------------------------------------
739 @SuppressWarnings("nls")
740 public synchronized String
toString() {
741 return "TmfTrace [fPath=" + fPath
+ ", fCacheSize=" + fCacheSize
742 + ", fNbEvents=" + fNbEvents
+ ", fStartTime=" + fStartTime
743 + ", fEndTime=" + fEndTime
+ ", fStreamingInterval=" + fStreamingInterval
+ "]";
747 public boolean isComplete() {
749 * Be default, all traces are "complete" which means no more data will
756 public void setComplete(boolean isComplete
) {
758 * This should be overridden by trace classes that can support live
759 * reading (traces in an incomplete state)