tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/trace/TmfTrace.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2015 Ericsson, École Polytechnique de Montréal
   3  *
   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
   8  *
   9  * Contributors:
  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  *******************************************************************************/
  16
  17 package org.eclipse.tracecompass.tmf.core.trace;
  18
  19 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  20
  21 import java.io.File;
  22 import java.util.Collection;
  23 import java.util.Collections;
  24 import java.util.HashSet;
  25 import java.util.LinkedHashMap;
  26 import java.util.Map;
  27 import java.util.Set;
  28
  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;
  62
  63 import com.google.common.collect.ImmutableList;
  64 import com.google.common.collect.Multimap;
  65
  66 /**
  67  * Abstract implementation of ITmfTrace.
  68  * <p>
  69  * Since the concept of 'location' is trace specific, the concrete classes have
  70  * to provide the related methods, namely:
  71  * <ul>
  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)
  77  * </ul>
  78  * <p>
  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().
  82  * <p>
  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.
  86  *
  87  * @version 1.0
  88  * @author Francois Chouinard
  89  *
  90  * @see ITmfEvent
  91  * @see ITmfTraceIndexer
  92  * @see ITmfEventParser
  93  */
  94 public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace, ITmfEventParser, ITmfTraceCompleteness {
  95
  96     // ------------------------------------------------------------------------
  97     // Class attributes
  98     // ------------------------------------------------------------------------
  99
 100     /**
 101      * Basic aspects that should be valid for all trace types.
 102      */
 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
 108                     ));
 109
 110     // ------------------------------------------------------------------------
 111     // Instance attributes
 112     // ------------------------------------------------------------------------
 113
 114     // The resource used for persistent properties for this trace
 115     private IResource fResource;
 116
 117     // The trace type id
 118     private @Nullable String fTraceTypeId;
 119
 120     // The trace path
 121     private String fPath;
 122
 123     // The trace cache page size
 124     private int fCacheSize = ITmfTrace.DEFAULT_TRACE_CACHE_SIZE;
 125
 126     // The number of events collected (so far)
 127     private volatile long fNbEvents = 0;
 128
 129     // The time span of the event stream
 130     private @NonNull ITmfTimestamp fStartTime = TmfTimestamp.BIG_BANG;
 131     private @NonNull ITmfTimestamp fEndTime = TmfTimestamp.BIG_BANG;
 132
 133     // The trace streaming interval (0 = no streaming)
 134     private long fStreamingInterval = 0;
 135
 136     // The trace indexer
 137     private ITmfTraceIndexer fIndexer;
 138
 139     private ITmfTimestampTransform fTsTransform;
 140
 141     private final Map<String, IAnalysisModule> fAnalysisModules =
 142             Collections.synchronizedMap(new LinkedHashMap<String, IAnalysisModule>());
 143
 144     // ------------------------------------------------------------------------
 145     // Construction
 146     // ------------------------------------------------------------------------
 147
 148     /**
 149      * The default, parameterless, constructor
 150      */
 151     public TmfTrace() {
 152         super();
 153         fIndexer = new TmfCheckpointIndexer(this);
 154     }
 155
 156     /**
 157      * Full constructor.
 158      *
 159      * @param resource
 160      *            The resource associated to the trace
 161      * @param type
 162      *            The type of events that will be read from this trace
 163      * @param path
 164      *            The path to the trace on the filesystem
 165      * @param cacheSize
 166      *            The trace cache size. Pass '-1' to use the default specified
 167      *            in {@link ITmfTrace#DEFAULT_TRACE_CACHE_SIZE}
 168      * @param interval
 169      *            The trace streaming interval. You can use '0' for post-mortem
 170      *            traces.
 171      * @throws TmfTraceException
 172      *             If something failed during the opening
 173      */
 174     protected TmfTrace(final IResource resource,
 175             final Class<? extends ITmfEvent> type,
 176             final String path,
 177             final int cacheSize,
 178             final long interval)
 179             throws TmfTraceException {
 180         super();
 181         fCacheSize = (cacheSize > 0) ? cacheSize : ITmfTrace.DEFAULT_TRACE_CACHE_SIZE;
 182         fStreamingInterval = interval;
 183         initialize(resource, path, type);
 184     }
 185
 186     /**
 187      * Copy constructor
 188      *
 189      * @param trace the original trace
 190      * @throws TmfTraceException Should not happen usually
 191      */
 192     public TmfTrace(final TmfTrace trace) throws TmfTraceException {
 193         super();
 194         if (trace == null) {
 195             throw new IllegalArgumentException();
 196         }
 197         fCacheSize = trace.getCacheSize();
 198         fStreamingInterval = trace.getStreamingInterval();
 199         initialize(trace.getResource(), trace.getPath(), trace.getEventType());
 200     }
 201
 202     /**
 203      * Creates the indexer instance. Classes extending this class can override
 204      * this to provide a different indexer implementation.
 205      *
 206      * @param interval the checkpoints interval
 207      *
 208      * @return the indexer
 209      */
 210     protected ITmfTraceIndexer createIndexer(int interval) {
 211         return new TmfCheckpointIndexer(this, interval);
 212     }
 213
 214     // ------------------------------------------------------------------------
 215     // ITmfTrace - Initializers
 216     // ------------------------------------------------------------------------
 217
 218     @Override
 219     public void initTrace(final IResource resource, final String path, final Class<? extends ITmfEvent> type, String name, String traceTypeId) throws TmfTraceException {
 220         if (name == null) {
 221             throw new IllegalArgumentException();
 222         }
 223         setName(name);
 224         fTraceTypeId = traceTypeId;
 225         initTrace(resource, path, type);
 226     }
 227
 228     @Override
 229     public void initTrace(final IResource resource, final String path, final Class<? extends ITmfEvent> type) throws TmfTraceException {
 230         initialize(resource, path, type);
 231     }
 232
 233     /**
 234      * Initialize the trace common attributes and the base component.
 235      *
 236      * @param resource the Eclipse resource (trace)
 237      * @param path the trace path
 238      * @param type the trace event type
 239      *
 240      * @throws TmfTraceException If something failed during the initialization
 241      */
 242     protected void initialize(final IResource resource,
 243             final String path,
 244             final Class<? extends ITmfEvent> type)
 245                     throws TmfTraceException {
 246         if (path == null) {
 247             throw new TmfTraceException("Invalid trace path"); //$NON-NLS-1$
 248         }
 249         fPath = path;
 250         fResource = resource;
 251         String traceName = getName();
 252         if (traceName.isEmpty()) {
 253             traceName = (resource != null) ? resource.getName() : new Path(path).lastSegment();
 254         }
 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) {
 259             fIndexer.dispose();
 260         }
 261         fIndexer = createIndexer(fCacheSize);
 262     }
 263
 264     /**
 265      * Indicates if the path points to an existing file/directory
 266      *
 267      * @param path the path to test
 268      * @return true if the file/directory exists
 269      */
 270     protected boolean fileExists(final String path) {
 271         final File file = new File(path);
 272         return file.exists();
 273     }
 274
 275     @Override
 276     public void indexTrace(boolean waitForCompletion) {
 277         getIndexer().buildIndex(0, TmfTimeRange.ETERNITY, waitForCompletion);
 278     }
 279
 280     /**
 281      * Instantiate the applicable analysis modules and executes the analysis
 282      * modules that are meant to be automatically executed
 283      *
 284      * @return An IStatus indicating whether the analysis could be run
 285      *         successfully or not
 286      */
 287     protected IStatus executeAnalysis() {
 288         MultiStatus status = new MultiStatus(Activator.PLUGIN_ID, IStatus.OK, null, null);
 289
 290         Multimap<String, IAnalysisModuleHelper> modules = TmfAnalysisManager.getAnalysisModules();
 291         for (IAnalysisModuleHelper helper : modules.values()) {
 292             try {
 293                 IAnalysisModule module = helper.newModule(this);
 294                 if (module == null) {
 295                     continue;
 296                 }
 297                 fAnalysisModules.put(module.getId(), module);
 298                 if (module.isAutomatic()) {
 299                     status.add(module.schedule());
 300                 }
 301             } catch (TmfAnalysisException e) {
 302                 status.add(new Status(IStatus.WARNING, Activator.PLUGIN_ID, e.getMessage()));
 303             }
 304         }
 305         return status;
 306     }
 307
 308     @Override
 309     public IAnalysisModule getAnalysisModule(String analysisId) {
 310         return fAnalysisModules.get(analysisId);
 311     }
 312
 313
 314     @Override
 315     public Iterable<IAnalysisModule> getAnalysisModules() {
 316         synchronized (fAnalysisModules) {
 317             Set<IAnalysisModule> modules = new HashSet<>(fAnalysisModules.values());
 318             return modules;
 319         }
 320     }
 321
 322     @Override
 323     public Iterable<ITmfEventAspect> getEventAspects() {
 324         /* By default we provide only the base aspects valid for all trace types */
 325         return BASE_ASPECTS;
 326     }
 327
 328     /**
 329      * Clears the trace
 330      */
 331     @Override
 332     public synchronized void dispose() {
 333         /* Clean up the index if applicable */
 334         if (getIndexer() != null) {
 335             getIndexer().dispose();
 336         }
 337
 338         /* Clean up the analysis modules */
 339         synchronized (fAnalysisModules) {
 340             for (IAnalysisModule module : fAnalysisModules.values()) {
 341                 module.dispose();
 342             }
 343             fAnalysisModules.clear();
 344         }
 345
 346         super.dispose();
 347     }
 348
 349     // ------------------------------------------------------------------------
 350     // ITmfTrace - Basic getters
 351     // ------------------------------------------------------------------------
 352
 353     @Override
 354     public IResource getResource() {
 355         return fResource;
 356     }
 357
 358     @Override
 359     public @Nullable String getTraceTypeId() {
 360         return fTraceTypeId;
 361     }
 362
 363     @Override
 364     public String getPath() {
 365         return fPath;
 366     }
 367
 368     @Override
 369     public int getCacheSize() {
 370         return fCacheSize;
 371     }
 372
 373     @Override
 374     public long getStreamingInterval() {
 375         return fStreamingInterval;
 376     }
 377
 378     /**
 379      * @return the trace indexer
 380      */
 381     protected ITmfTraceIndexer getIndexer() {
 382         return fIndexer;
 383     }
 384
 385     // ------------------------------------------------------------------------
 386     // ITmfTrace - Trace characteristics getters
 387     // ------------------------------------------------------------------------
 388
 389     @Override
 390     public long getNbEvents() {
 391         return fNbEvents;
 392     }
 393
 394     @Override
 395     public @NonNull TmfTimeRange getTimeRange() {
 396         return new TmfTimeRange(fStartTime, fEndTime);
 397     }
 398
 399     @Override
 400     public ITmfTimestamp getStartTime() {
 401         return fStartTime;
 402     }
 403
 404     @Override
 405     public ITmfTimestamp getEndTime() {
 406         return fEndTime;
 407     }
 408
 409     @Override
 410     public ITmfTimestamp getInitialRangeOffset() {
 411         final long DEFAULT_INITIAL_OFFSET_VALUE = (1L * 100 * 1000 * 1000); // .1sec
 412         return new TmfTimestamp(DEFAULT_INITIAL_OFFSET_VALUE, ITmfTimestamp.NANOSECOND_SCALE);
 413     }
 414
 415     @Override
 416     public String getHostId() {
 417         return this.getName();
 418     }
 419
 420     // ------------------------------------------------------------------------
 421     // Convenience setters
 422     // ------------------------------------------------------------------------
 423
 424     /**
 425      * Set the trace cache size. Must be done at initialization time.
 426      *
 427      * @param cacheSize The trace cache size
 428      */
 429     protected void setCacheSize(final int cacheSize) {
 430         fCacheSize = cacheSize;
 431     }
 432
 433     /**
 434      * Set the trace known number of events. This can be quite dynamic
 435      * during indexing or for live traces.
 436      *
 437      * @param nbEvents The number of events
 438      */
 439     protected synchronized void setNbEvents(final long nbEvents) {
 440         fNbEvents = (nbEvents > 0) ? nbEvents : 0;
 441     }
 442
 443     /**
 444      * Update the trace events time range
 445      *
 446      * @param range the new time range
 447      */
 448     protected void setTimeRange(final @NonNull TmfTimeRange range) {
 449         fStartTime = range.getStartTime();
 450         fEndTime = range.getEndTime();
 451     }
 452
 453     /**
 454      * Update the trace chronologically first event timestamp
 455      *
 456      * @param startTime the new first event timestamp
 457      */
 458     protected void setStartTime(final @NonNull ITmfTimestamp startTime) {
 459         fStartTime = startTime;
 460     }
 461
 462     /**
 463      * Update the trace chronologically last event timestamp
 464      *
 465      * @param endTime the new last event timestamp
 466      */
 467     protected void setEndTime(final @NonNull ITmfTimestamp endTime) {
 468         fEndTime = endTime;
 469     }
 470
 471     /**
 472      * Set the polling interval for live traces (default = 0 = no streaming).
 473      *
 474      * @param interval the new trace streaming interval
 475      */
 476     protected void setStreamingInterval(final long interval) {
 477         fStreamingInterval = (interval > 0) ? interval : 0;
 478     }
 479
 480     // ------------------------------------------------------------------------
 481     // ITmfTrace - SeekEvent operations (returning a trace context)
 482     // ------------------------------------------------------------------------
 483
 484     @Override
 485     public synchronized ITmfContext seekEvent(final long rank) {
 486
 487         // A rank <= 0 indicates to seek the first event
 488         if (rank <= 0) {
 489             ITmfContext context = seekEvent((ITmfLocation) null);
 490             context.setRank(0);
 491             return context;
 492         }
 493
 494         // Position the trace at the checkpoint
 495         final ITmfContext context = fIndexer.seekIndex(rank);
 496
 497         // And locate the requested event context
 498         long pos = context.getRank();
 499         if (pos < rank) {
 500             ITmfEvent event = getNext(context);
 501             while ((event != null) && (++pos < rank)) {
 502                 event = getNext(context);
 503             }
 504         }
 505         return context;
 506     }
 507
 508     @Override
 509     public synchronized ITmfContext seekEvent(final ITmfTimestamp timestamp) {
 510
 511         // A null timestamp indicates to seek the first event
 512         if (timestamp == null) {
 513             ITmfContext context = seekEvent((ITmfLocation) null);
 514             context.setRank(0);
 515             return context;
 516         }
 517
 518         // Position the trace at the checkpoint
 519         ITmfContext context = fIndexer.seekIndex(timestamp);
 520
 521         // And locate the requested event context
 522         ITmfLocation previousLocation = context.getLocation();
 523         long previousRank = context.getRank();
 524         ITmfEvent event = getNext(context);
 525         while (event != null && event.getTimestamp().compareTo(timestamp) < 0) {
 526             previousLocation = context.getLocation();
 527             previousRank = context.getRank();
 528             event = getNext(context);
 529         }
 530         if (event == null) {
 531             context.setLocation(null);
 532             context.setRank(ITmfContext.UNKNOWN_RANK);
 533         } else {
 534             context.dispose();
 535             context = seekEvent(previousLocation);
 536             context.setRank(previousRank);
 537         }
 538         return context;
 539     }
 540
 541     // ------------------------------------------------------------------------
 542     // Read operations (returning an actual event)
 543     // ------------------------------------------------------------------------
 544
 545     @Override
 546     public abstract ITmfEvent parseEvent(ITmfContext context);
 547
 548     @Override
 549     public synchronized ITmfEvent getNext(final ITmfContext context) {
 550         // parseEvent() does not update the context
 551         final ITmfEvent event = parseEvent(context);
 552         if (event != null) {
 553             updateAttributes(context, event);
 554             context.setLocation(getCurrentLocation());
 555             context.increaseRank();
 556         }
 557         return event;
 558     }
 559
 560     /**
 561      * Update the trace attributes
 562      *
 563      * @param context the current trace context
 564      * @param timestamp the corresponding timestamp
 565      * @deprecated Use {@link #updateAttributes(ITmfContext, ITmfEvent)}
 566      */
 567     @Deprecated
 568     protected synchronized void updateAttributes(final ITmfContext context, final @NonNull ITmfTimestamp timestamp) {
 569         updateAttributes(context, new TmfEvent(this, context.getRank(), timestamp, null, null));
 570     }
 571
 572     /**
 573      * Update the trace attributes
 574      *
 575      * @param context the current trace context
 576      * @param event the corresponding event
 577      * @since 1.1
 578      */
 579     protected synchronized void updateAttributes(final ITmfContext context, final @NonNull ITmfEvent event) {
 580         ITmfTimestamp timestamp = event.getTimestamp();
 581         ITmfTimestamp endTime = timestamp;
 582         if (event instanceof ITmfLostEvent) {
 583             endTime = ((ITmfLostEvent) event).getTimeRange().getEndTime();
 584         }
 585         if (fStartTime.equals(TmfTimestamp.BIG_BANG) || (fStartTime.compareTo(timestamp) > 0)) {
 586             fStartTime = timestamp;
 587         }
 588         if (fEndTime.equals(TmfTimestamp.BIG_CRUNCH) || (fEndTime.compareTo(endTime) < 0)) {
 589             fEndTime = endTime;
 590         }
 591         if (context.hasValidRank()) {
 592             long rank = context.getRank();
 593             if (fNbEvents <= rank) {
 594                 fNbEvents = rank + 1;
 595             }
 596             if (fIndexer != null) {
 597                 fIndexer.updateIndex(context, timestamp);
 598             }
 599         }
 600     }
 601
 602     // ------------------------------------------------------------------------
 603     // TmfDataProvider
 604     // ------------------------------------------------------------------------
 605
 606     @Override
 607     public synchronized ITmfContext armRequest(final ITmfEventRequest request) {
 608         if (executorIsShutdown()) {
 609             return null;
 610         }
 611         if (!TmfTimestamp.BIG_BANG.equals(request.getRange().getStartTime())
 612                 && (request.getIndex() == 0)) {
 613             final ITmfContext context = seekEvent(request.getRange().getStartTime());
 614             request.setStartIndex((int) context.getRank());
 615             return context;
 616
 617         }
 618         return seekEvent(request.getIndex());
 619     }
 620
 621     // ------------------------------------------------------------------------
 622     // Signal handlers
 623     // ------------------------------------------------------------------------
 624
 625     /**
 626      * Handler for the Trace Opened signal
 627      *
 628      * @param signal
 629      *            The incoming signal
 630      */
 631     @TmfSignalHandler
 632     public void traceOpened(TmfTraceOpenedSignal signal) {
 633         boolean signalIsForUs = false;
 634         for (ITmfTrace trace : TmfTraceManager.getTraceSet(signal.getTrace())) {
 635             if (trace == this) {
 636                 signalIsForUs = true;
 637                 break;
 638             }
 639         }
 640
 641         if (!signalIsForUs) {
 642             return;
 643         }
 644
 645         /*
 646          * The signal is either for this trace, or for an experiment containing
 647          * this trace.
 648          */
 649         IStatus status = executeAnalysis();
 650         if (!status.isOK()) {
 651             Activator.log(status);
 652         }
 653
 654         TmfTraceManager.refreshSupplementaryFiles(this);
 655
 656         if (signal.getTrace() == this) {
 657             /* Additionally, the signal is directly for this trace. */
 658             if (getNbEvents() == 0) {
 659                 return;
 660             }
 661
 662             /* For a streaming trace, the range updated signal should be sent
 663              * by the subclass when a new safe time is determined.
 664              */
 665             if (getStreamingInterval() > 0) {
 666                 return;
 667             }
 668
 669             if (isComplete()) {
 670                 final TmfTimeRange timeRange = new TmfTimeRange(getStartTime(), TmfTimestamp.BIG_CRUNCH);
 671                 final TmfTraceRangeUpdatedSignal rangeUpdatedsignal = new TmfTraceRangeUpdatedSignal(this, this, timeRange);
 672
 673                 // Broadcast in separate thread to prevent deadlock
 674                 broadcastAsync(rangeUpdatedsignal);
 675             }
 676             return;
 677         }
 678     }
 679
 680     /**
 681      * Signal handler for the TmfTraceRangeUpdatedSignal signal
 682      *
 683      * @param signal The incoming signal
 684      */
 685     @TmfSignalHandler
 686     public void traceRangeUpdated(final TmfTraceRangeUpdatedSignal signal) {
 687         if (signal.getTrace() == this) {
 688             getIndexer().buildIndex(getNbEvents(), signal.getRange(), false);
 689         }
 690     }
 691
 692     /**
 693      * Signal handler for the TmfTraceUpdatedSignal signal
 694      *
 695      * @param signal The incoming signal
 696      */
 697     @TmfSignalHandler
 698     public void traceUpdated(final TmfTraceUpdatedSignal signal) {
 699         if (signal.getSource() == getIndexer()) {
 700             fNbEvents = signal.getNbEvents();
 701             fStartTime = signal.getRange().getStartTime();
 702             fEndTime = signal.getRange().getEndTime();
 703         }
 704     }
 705
 706     // ------------------------------------------------------------------------
 707     // Timestamp transformation functions
 708     // ------------------------------------------------------------------------
 709
 710     @Override
 711     public ITmfTimestampTransform getTimestampTransform() {
 712         if (fTsTransform == null) {
 713             fTsTransform = TimestampTransformFactory.getTimestampTransform(getResource());
 714         }
 715         return fTsTransform;
 716     }
 717
 718     @Override
 719     public void setTimestampTransform(final ITmfTimestampTransform tt) {
 720         fTsTransform = tt;
 721         TimestampTransformFactory.setTimestampTransform(getResource(), tt);
 722     }
 723
 724     @Override
 725     public @NonNull ITmfTimestamp createTimestamp(long ts) {
 726         return new TmfNanoTimestamp(getTimestampTransform().transform(ts));
 727     }
 728
 729     // ------------------------------------------------------------------------
 730     // toString
 731     // ------------------------------------------------------------------------
 732
 733     @Override
 734     @SuppressWarnings("nls")
 735     public synchronized String toString() {
 736         return "TmfTrace [fPath=" + fPath + ", fCacheSize=" + fCacheSize
 737                 + ", fNbEvents=" + fNbEvents + ", fStartTime=" + fStartTime
 738                 + ", fEndTime=" + fEndTime + ", fStreamingInterval=" + fStreamingInterval + "]";
 739     }
 740
 741     @Override
 742     public boolean isComplete() {
 743         /*
 744          * Be default, all traces are "complete" which means no more data will
 745          * be added later
 746          */
 747         return true;
 748     }
 749
 750     @Override
 751     public void setComplete(boolean isComplete) {
 752         /*
 753          * This should be overridden by trace classes that can support live
 754          * reading (traces in an incomplete state)
 755          */
 756     }
 757 }