org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/trace/TmfExperiment.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010, 2012 Ericsson
   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  *******************************************************************************/
  13
  14 package org.eclipse.linuxtools.tmf.core.trace;
  15
  16 import org.eclipse.core.resources.IFile;
  17 import org.eclipse.core.resources.IProject;
  18 import org.eclipse.core.resources.IResource;
  19 import org.eclipse.linuxtools.internal.tmf.core.trace.TmfExperimentContext;
  20 import org.eclipse.linuxtools.internal.tmf.core.trace.TmfExperimentLocation;
  21 import org.eclipse.linuxtools.internal.tmf.core.trace.TmfLocationArray;
  22 import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
  23 import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
  24 import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
  25 import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp;
  26 import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException;
  27 import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest;
  28 import org.eclipse.linuxtools.tmf.core.request.ITmfEventRequest;
  29 import org.eclipse.linuxtools.tmf.core.signal.TmfEndSynchSignal;
  30 import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentDisposedSignal;
  31 import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentRangeUpdatedSignal;
  32 import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentSelectedSignal;
  33 import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentUpdatedSignal;
  34 import org.eclipse.linuxtools.tmf.core.signal.TmfSignalHandler;
  35 import org.eclipse.linuxtools.tmf.core.signal.TmfTraceUpdatedSignal;
  36
  37 /**
  38  * TmfExperiment presents a time-ordered, unified view of a set of ITmfTrace:s
  39  * that are part of a tracing experiment.
  40  *
  41  * @version 1.0
  42  * @author Francois Chouinard
  43  */
  44 public class TmfExperiment<T extends ITmfEvent> extends TmfTrace<T> implements ITmfEventParser<T> {
  45
  46     // ------------------------------------------------------------------------
  47     // Constants
  48     // ------------------------------------------------------------------------
  49
  50     /**
  51      * The default index page size
  52      */
  53     public static final int DEFAULT_INDEX_PAGE_SIZE = 5000;
  54
  55     // ------------------------------------------------------------------------
  56     // Attributes
  57     // ------------------------------------------------------------------------
  58
  59     /**
  60      * The currently selected experiment (null if none)
  61      */
  62     protected static TmfExperiment<?> fCurrentExperiment = null;
  63
  64     /**
  65      * The set of traces that constitute the experiment
  66      */
  67     protected ITmfTrace<T>[] fTraces;
  68
  69     /**
  70      * The set of traces that constitute the experiment
  71      */
  72     private boolean fInitialized = false;
  73
  74     /**
  75      * The experiment bookmarks file
  76      */
  77     private IFile fBookmarksFile;
  78
  79
  80     // Saved experiment context (optimization)
  81     private TmfExperimentContext fExperimentContext;
  82
  83     // ------------------------------------------------------------------------
  84     // Construction
  85     // ------------------------------------------------------------------------
  86
  87     /**
  88      * @param type
  89      * @param id
  90      * @param traces
  91      * @throws TmfTraceException
  92      */
  93     public TmfExperiment(final Class<T> type, final String id, final ITmfTrace<T>[] traces) {
  94         this(type, id, traces, DEFAULT_INDEX_PAGE_SIZE);
  95     }
  96
  97     /**
  98      * @param type
  99      * @param id
 100      * @param traces
 101      * @param indexPageSize
 102      * @throws TmfTraceException
 103      */
 104     @SuppressWarnings({ "unchecked", "rawtypes" })
 105     public TmfExperiment(final Class<T> type, final String path, final ITmfTrace<T>[] traces, final int indexPageSize) {
 106         setCacheSize(indexPageSize);
 107         setStreamingInterval(0);
 108         setIndexer(new TmfCheckpointIndexer(this, indexPageSize));
 109         setParser(this);
 110         try {
 111             super.initialize(null, path, type);
 112         } catch (TmfTraceException e) {
 113             e.printStackTrace();
 114         }
 115
 116         fTraces = traces;
 117         setTimeRange(TmfTimeRange.NULL_RANGE);
 118     }
 119
 120     /**
 121      * Clears the experiment
 122      */
 123     @Override
 124     @SuppressWarnings("rawtypes")
 125     public synchronized void dispose() {
 126
 127         final TmfExperimentDisposedSignal<T> signal = new TmfExperimentDisposedSignal<T>(this, this);
 128         broadcast(signal);
 129
 130         if (fCurrentExperiment == this) {
 131             fCurrentExperiment = null;
 132         }
 133
 134         // Clean up the index if applicable
 135         if (getIndexer() != null) {
 136             getIndexer().dispose();
 137         }
 138
 139         if (fTraces != null) {
 140             for (final ITmfTrace trace : fTraces)
 141                 trace.dispose();
 142             fTraces = null;
 143         }
 144         super.dispose();
 145     }
 146
 147     // ------------------------------------------------------------------------
 148     // ITmfTrace - Initializers
 149     // ------------------------------------------------------------------------
 150
 151     /* (non-Javadoc)
 152      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#validate(org.eclipse.core.resources.IProject, java.lang.String)
 153      */
 154     @Override
 155     public boolean validate(final IProject project, final String path) {
 156         return true;
 157     }
 158
 159     /* (non-Javadoc)
 160      * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#initTrace(org.eclipse.core.resources.IResource, java.lang.String, java.lang.Class)
 161      */
 162     @Override
 163     public void initTrace(final IResource resource, final String path, final Class<T> type) {
 164     }
 165
 166     // ------------------------------------------------------------------------
 167     // Accessors
 168     // ------------------------------------------------------------------------
 169
 170     /**
 171      * Selects the current, framework-wide, experiment
 172      *
 173      * @param experiment das experiment
 174      */
 175     public static void setCurrentExperiment(final TmfExperiment<?> experiment) {
 176         if (fCurrentExperiment != null && fCurrentExperiment != experiment) {
 177             fCurrentExperiment.dispose();
 178         }
 179         fCurrentExperiment = experiment;
 180     }
 181
 182     /**
 183      * @return das experiment
 184      */
 185     public static TmfExperiment<?> getCurrentExperiment() {
 186         return fCurrentExperiment;
 187     }
 188
 189     /**
 190      * Get the list of traces. Handle with care...
 191      *
 192      * @return the experiment traces
 193      */
 194     public ITmfTrace<T>[] getTraces() {
 195         return fTraces;
 196     }
 197
 198     /**
 199      * Returns the timestamp of the event at the requested index. If none,
 200      * returns null.
 201      *
 202      * @param index the event index (rank)
 203      * @return the corresponding event timestamp
 204      */
 205     public ITmfTimestamp getTimestamp(final int index) {
 206         final ITmfContext context = seekEvent(index);
 207         final ITmfEvent event = getNext(context);
 208         return (event != null) ? event.getTimestamp() : null;
 209     }
 210
 211     /**
 212      * Set the file to be used for bookmarks on this experiment
 213      *
 214      * @param file the bookmarks file
 215      */
 216     public void setBookmarksFile(final IFile file) {
 217         fBookmarksFile = file;
 218     }
 219
 220     /**
 221      * Get the file used for bookmarks on this experiment
 222      *
 223      * @return the bookmarks file or null if none is set
 224      */
 225     public IFile getBookmarksFile() {
 226         return fBookmarksFile;
 227     }
 228
 229     // ------------------------------------------------------------------------
 230     // Request management
 231     // ------------------------------------------------------------------------
 232
 233     /* (non-Javadoc)
 234      * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#armRequest(org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest)
 235      */
 236     @Override
 237     protected synchronized ITmfContext armRequest(final ITmfDataRequest<T> request) {
 238         if (request instanceof ITmfEventRequest<?>
 239             && !TmfTimestamp.BIG_BANG.equals(((ITmfEventRequest<T>) request).getRange().getStartTime())
 240             && request.getIndex() == 0)
 241         {
 242             final ITmfContext context = seekEvent(((ITmfEventRequest<T>) request).getRange().getStartTime());
 243             ((ITmfEventRequest<T>) request).setStartIndex((int) context.getRank());
 244             return context;
 245
 246         }
 247
 248         // Check if we are already at the right index
 249         if ((fExperimentContext != null) && fExperimentContext.getRank() == request.getIndex()) {
 250             return fExperimentContext;
 251         }
 252
 253         return seekEvent(request.getIndex());
 254     }
 255
 256     // ------------------------------------------------------------------------
 257     // ITmfTrace trace positioning
 258     // ------------------------------------------------------------------------
 259
 260     /* (non-Javadoc)
 261      * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#seekEvent(long)
 262      *
 263      * TmfTrace.seekEvent(rank) will return a context that will position the
 264      * trace to read the event at rank 'rank' in the trace. In the case of an
 265      * experiment context, that event has to be actually read in the fEvents
 266      * buffer and the corresponding trace context has to point to the next
 267      * event (rank + 1) in the trace (the sum of the traces contexts ranks
 268      * should equal [exp context rank + #traces] (corner cases not considered).
 269      *
 270      * In the likely case that TmfTrace.seekEvent() computed the context
 271      * by using a read loop (reading from the experiment), the 'lastTraceRead'
 272      * field will be set to the actual trace that needs to be read to obtain
 273      * event at rank 'rank'.
 274      *
 275      * Therefore, if 'lastTraceRead' is set, we need to read that particular
 276      * trace *and* then decrease the context rank (which has to correspond to
 277      * the rank of the event to be returned next by TmfExperiemnt.getNext().
 278      */
 279     @Override
 280     public synchronized ITmfContext seekEvent(final long rank) {
 281         TmfExperimentContext context = (TmfExperimentContext) super.seekEvent(rank);
 282         int lastTrace = context.getLastTrace();
 283         if (lastTrace != TmfExperimentContext.NO_TRACE) {
 284             getNext(context);
 285             context.setRank(rank);
 286             context.setLastTrace(TmfExperimentContext.NO_TRACE);
 287         }
 288         return context;
 289     }
 290
 291     /* (non-Javadoc)
 292      *
 293      * Returns a brand new context based on the location provided and
 294      * initializes the event queues
 295      *
 296      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfLocation)
 297      */
 298     @Override
 299     public synchronized ITmfContext seekEvent(final ITmfLocation<?> location) {
 300         // Validate the location
 301         if (location != null && !(location instanceof TmfExperimentLocation)) {
 302             return null; // Throw an exception?
 303         }
 304         // Make sure we have something to read from
 305         if (fTraces == null) {
 306             return null;
 307         }
 308
 309         // Instantiate the location
 310         final TmfExperimentLocation expLocation = (location == null)
 311                 ? new TmfExperimentLocation(new TmfLocationArray(new ITmfLocation<?>[fTraces.length]))
 312                 : (TmfExperimentLocation) location.clone();
 313
 314         // Create and populate the context's traces contexts
 315         final TmfExperimentContext context = new TmfExperimentContext(new ITmfContext[fTraces.length]);
 316
 317         for (int i = 0; i < fTraces.length; i++) {
 318             // Get the relevant trace attributes
 319             final ITmfLocation<?> trcLocation = expLocation.getLocation().getLocations()[i];
 320             context.getContexts()[i] = fTraces[i].seekEvent(trcLocation);
 321             expLocation.getLocation().getLocations()[i] = context.getContexts()[i].getLocation().clone();
 322             context.getEvents()[i] = fTraces[i].getNext(context.getContexts()[i]);
 323         }
 324
 325         // Finalize context
 326         context.setLocation(expLocation);
 327         context.setLastTrace(TmfExperimentContext.NO_TRACE);
 328         context.setRank(ITmfContext.UNKNOWN_RANK);
 329
 330         fExperimentContext = context;
 331         return (ITmfContext) context;
 332     }
 333
 334     // ------------------------------------------------------------------------
 335     // ITmfTrace - SeekEvent operations (returning a trace context)
 336     // ------------------------------------------------------------------------
 337
 338     /* (non-Javadoc)
 339      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(double)
 340      */
 341     @Override
 342     public ITmfContext seekEvent(final double ratio) {
 343         final ITmfContext context = seekEvent((long) (ratio * getNbEvents()));
 344         return context;
 345     }
 346
 347     /* (non-Javadoc)
 348      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getLocationRatio(org.eclipse.linuxtools.tmf.core.trace.ITmfLocation)
 349      */
 350     @Override
 351     public double getLocationRatio(final ITmfLocation<?> location) {
 352         if (location instanceof TmfExperimentLocation) {
 353             return (double) seekEvent(location).getRank() / getNbEvents();
 354         }
 355         return 0.0;
 356     }
 357
 358     /* (non-Javadoc)
 359      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getCurrentLocation()
 360      */
 361     @Override
 362     public ITmfLocation<?> getCurrentLocation() {
 363         ITmfLocation<?>[] locations = new ITmfLocation<?>[fTraces.length];
 364         for (int i = 0; i < fTraces.length; i++) {
 365             locations[i] = fTraces[i].getCurrentLocation();
 366         }
 367         return new TmfExperimentLocation(new TmfLocationArray(locations));
 368     }
 369
 370     // ------------------------------------------------------------------------
 371     // ITmfTrace trace positioning
 372     // ------------------------------------------------------------------------
 373
 374     /* (non-Javadoc)
 375      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfEventParser#parseEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
 376      */
 377     @Override
 378     public synchronized T parseEvent(final ITmfContext context) {
 379         final ITmfContext savedContext = context.clone();
 380         final T event = getNext(savedContext);
 381         return event;
 382     }
 383
 384     /* (non-Javadoc)
 385      * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#getNext(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
 386      */
 387     @Override
 388     @SuppressWarnings("unchecked")
 389     public synchronized T getNext(ITmfContext context) {
 390
 391         // Validate the context
 392         if (!(context instanceof TmfExperimentContext)) {
 393             return null; // Throw an exception?
 394         }
 395         TmfExperimentContext expContext = (TmfExperimentContext) context;
 396
 397         // If an event was consumed previously, first get the next one from that trace
 398         final int lastTrace = expContext.getLastTrace();
 399         if (lastTrace != TmfExperimentContext.NO_TRACE) {
 400             final ITmfContext traceContext = expContext.getContexts()[lastTrace];
 401
 402             TmfExperimentLocation location = (TmfExperimentLocation) expContext.getLocation();
 403             if (location != null) {
 404                 location.getLocation().getLocations()[lastTrace] = traceContext.getLocation().clone();
 405             }
 406
 407             expContext.getEvents()[lastTrace] = fTraces[lastTrace].getNext(traceContext);
 408             expContext.setLastTrace(TmfExperimentContext.NO_TRACE);
 409         }
 410
 411         // Scan the candidate events and identify the "next" trace to read from
 412         int trace = TmfExperimentContext.NO_TRACE;
 413         ITmfTimestamp timestamp = TmfTimestamp.BIG_CRUNCH;
 414         for (int i = 0; i < fTraces.length; i++) {
 415             final ITmfEvent event = expContext.getEvents()[i];
 416             if (event != null && event.getTimestamp() != null) {
 417                 final ITmfTimestamp otherTS = event.getTimestamp();
 418                 if (otherTS.compareTo(timestamp, true) < 0) {
 419                     trace = i;
 420                     timestamp = otherTS;
 421                 }
 422             }
 423         }
 424
 425         T event = null;
 426         if (trace != TmfExperimentContext.NO_TRACE) {
 427             event = (T) expContext.getEvents()[trace];
 428             if (event != null) {
 429                 updateAttributes(expContext, event.getTimestamp());
 430                 expContext.increaseRank();
 431                 expContext.setLastTrace(trace);
 432                 fExperimentContext = expContext;
 433                 processEvent(event);
 434             }
 435         }
 436
 437         return event;
 438     }
 439
 440     /* (non-Javadoc)
 441      * @see java.lang.Object#toString()
 442      */
 443     @Override
 444     @SuppressWarnings("nls")
 445     public String toString() {
 446         return "[TmfExperiment (" + getName() + ")]";
 447     }
 448
 449     // ------------------------------------------------------------------------
 450     // Streaming support
 451     // ------------------------------------------------------------------------
 452
 453     private synchronized void initializeStreamingMonitor() {
 454
 455         if (fInitialized) {
 456             return;
 457         }
 458         fInitialized = true;
 459
 460         if (getStreamingInterval() == 0) {
 461             final ITmfContext context = seekEvent(0);
 462             final ITmfEvent event = getNext(context);
 463             if (event == null)
 464                 return;
 465             final TmfTimeRange timeRange = new TmfTimeRange(event.getTimestamp().clone(), TmfTimestamp.BIG_CRUNCH);
 466             final TmfExperimentRangeUpdatedSignal signal = new TmfExperimentRangeUpdatedSignal(this, this, timeRange);
 467
 468             // Broadcast in separate thread to prevent deadlock
 469             new Thread() {
 470                 @Override
 471                 public void run() {
 472                     broadcast(signal);
 473                 }
 474             }.start();
 475             return;
 476         }
 477
 478         final Thread thread = new Thread("Streaming Monitor for experiment " + getName()) { //$NON-NLS-1$
 479             private ITmfTimestamp safeTimestamp = null;
 480             private TmfTimeRange timeRange = null;
 481
 482             @Override
 483             public void run() {
 484                 while (!fExecutor.isShutdown()) {
 485                     if (!getIndexer().isIndexing()) {
 486                         ITmfTimestamp startTimestamp = TmfTimestamp.BIG_CRUNCH;
 487                         ITmfTimestamp endTimestamp = TmfTimestamp.BIG_BANG;
 488                         for (final ITmfTrace<T> trace : fTraces) {
 489                             if (trace.getStartTime().compareTo(startTimestamp) < 0)
 490                                 startTimestamp = trace.getStartTime();
 491                             if (trace.getStreamingInterval() != 0 && trace.getEndTime().compareTo(endTimestamp) > 0)
 492                                 endTimestamp = trace.getEndTime();
 493                         }
 494                         if (safeTimestamp != null && safeTimestamp.compareTo(getTimeRange().getEndTime(), false) > 0)
 495                             timeRange = new TmfTimeRange(startTimestamp, safeTimestamp);
 496                         else
 497                             timeRange = null;
 498                         safeTimestamp = endTimestamp;
 499                         if (timeRange != null) {
 500                             final TmfExperimentRangeUpdatedSignal signal =
 501                                     new TmfExperimentRangeUpdatedSignal(TmfExperiment.this, TmfExperiment.this, timeRange);
 502                             broadcast(signal);
 503                         }
 504                     }
 505                     try {
 506                         Thread.sleep(getStreamingInterval());
 507                     } catch (final InterruptedException e) {
 508                         e.printStackTrace();
 509                     }
 510                 }
 511             }
 512         };
 513         thread.start();
 514     }
 515
 516     /* (non-Javadoc)
 517      * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getStreamingInterval()
 518      */
 519     @Override
 520     public long getStreamingInterval() {
 521         long interval = 0;
 522         for (final ITmfTrace<T> trace : fTraces)
 523             interval = Math.max(interval, trace.getStreamingInterval());
 524         return interval;
 525     }
 526
 527     // ------------------------------------------------------------------------
 528     // Signal handlers
 529     // ------------------------------------------------------------------------
 530
 531     private Integer fEndSynchReference;
 532
 533     /**
 534      * Signal handler for the TmfExperimentSelectedSignal signal
 535      *
 536      * @param signal
 537      */
 538     @TmfSignalHandler
 539     public void experimentSelected(final TmfExperimentSelectedSignal<T> signal) {
 540         final TmfExperiment<?> experiment = signal.getExperiment();
 541         if (experiment == this) {
 542             setCurrentExperiment(experiment);
 543             fEndSynchReference = Integer.valueOf(signal.getReference());
 544         }
 545     }
 546
 547     /**
 548      * Signal handler for the TmfEndSynchSignal signal
 549      *
 550      * @param signal
 551      */
 552     @TmfSignalHandler
 553     public void endSync(final TmfEndSynchSignal signal) {
 554         if (fEndSynchReference != null && fEndSynchReference.intValue() == signal.getReference()) {
 555             fEndSynchReference = null;
 556             initializeStreamingMonitor();
 557         }
 558     }
 559
 560     /**
 561      * Signal handler for the TmfTraceUpdatedSignal signal
 562      *
 563      * @param signal
 564      */
 565     @TmfSignalHandler
 566     public void traceUpdated(final TmfTraceUpdatedSignal signal) {
 567         if (signal.getTrace() == this) {
 568             broadcast(new TmfExperimentUpdatedSignal(this, this));
 569         }
 570     }
 571
 572     /**
 573      * Signal handler for the TmfExperimentRangeUpdatedSignal signal
 574      *
 575      * @param signal
 576      */
 577     @TmfSignalHandler
 578     public void experimentRangeUpdated(final TmfExperimentRangeUpdatedSignal signal) {
 579         if (signal.getExperiment() == this) {
 580             getIndexer().buildIndex(getNbEvents(), signal.getRange(), false);
 581         }
 582     }
 583
 584 }