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

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010 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  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.core.trace;
  14
  15 import java.io.File;
  16 import java.io.FileNotFoundException;
  17 import java.util.Collections;
  18 import java.util.Vector;
  19
  20 import org.eclipse.core.resources.IProject;
  21 import org.eclipse.core.resources.IResource;
  22 import org.eclipse.core.runtime.IProgressMonitor;
  23 import org.eclipse.core.runtime.IStatus;
  24 import org.eclipse.core.runtime.Path;
  25 import org.eclipse.core.runtime.Status;
  26 import org.eclipse.core.runtime.jobs.Job;
  27 import org.eclipse.linuxtools.tmf.core.component.TmfEventProvider;
  28 import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
  29 import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
  30 import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
  31 import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp;
  32 import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest;
  33 import org.eclipse.linuxtools.tmf.core.request.ITmfEventRequest;
  34 import org.eclipse.linuxtools.tmf.core.request.TmfDataRequest;
  35 import org.eclipse.linuxtools.tmf.core.request.TmfEventRequest;
  36 import org.eclipse.linuxtools.tmf.core.signal.TmfTraceUpdatedSignal;
  37
  38 /**
  39  * <b><u>TmfTrace</u></b>
  40  * <p>
  41  * Abstract implementation of ITmfTrace. It should be sufficient to extend this class and provide implementation for
  42  * <code>getCurrentLocation()</code> and <code>seekLocation()</code>, as well as a proper parser, to have a working
  43  * concrete implementation.
  44  * <p>
  45  * Note: The notion of event rank is still under heavy discussion. Although used by the Events View and probably useful
  46  * in the general case, there is no easy way to implement it for LTTng (actually a strong case is being made that this
  47  * is useless).
  48  * <p>
  49  * That it is not supported by LTTng does by no mean indicate that it is not useful for (just about) every other tracing
  50  * tool. Therefore, this class provides a minimal (and partial) implementation of rank. However, the current
  51  * implementation should not be relied on in the general case.
  52  *
  53  * TODO: Add support for live streaming (notifications, incremental indexing, ...)
  54  */
  55 public abstract class TmfTrace<T extends ITmfEvent> extends TmfEventProvider<T> implements ITmfTrace<T>, Cloneable {
  56
  57     // ------------------------------------------------------------------------
  58     // Constants
  59     // ------------------------------------------------------------------------
  60
  61     // The default number of events to cache
  62     // TODO: Make the DEFAULT_CACHE_SIZE a preference
  63     public static final int DEFAULT_INDEX_PAGE_SIZE = 50000;
  64
  65     // ------------------------------------------------------------------------
  66     // Attributes
  67     // ------------------------------------------------------------------------
  68
  69     // The trace path
  70     private String fPath;
  71
  72     // The trace name
  73     private String fTraceName;
  74
  75     // The cache page size AND checkpoints interval
  76     protected int fIndexPageSize = DEFAULT_INDEX_PAGE_SIZE;
  77
  78     // The set of event stream checkpoints (for random access)
  79     protected Vector<TmfCheckpoint> fCheckpoints = new Vector<TmfCheckpoint>();
  80
  81     // The number of events collected
  82     protected long fNbEvents = 0;
  83
  84     // The time span of the event stream
  85     private ITmfTimestamp fStartTime = TmfTimestamp.BIG_CRUNCH;
  86     private ITmfTimestamp fEndTime = TmfTimestamp.BIG_BANG;
  87
  88     // The properties resource
  89     private IResource fResource;
  90
  91     // ------------------------------------------------------------------------
  92     // Constructors
  93     // ------------------------------------------------------------------------
  94
  95     public TmfTrace() {
  96         super();
  97     }
  98
  99     @Override
 100     public void initTrace(String name, String path, Class<T> eventType) throws FileNotFoundException {
 101         initTmfTrace(name, path, eventType, DEFAULT_INDEX_PAGE_SIZE, false);
 102     }
 103
 104     @Override
 105     public void initTrace(String name, String path, Class<T> eventType, int cacheSize) throws FileNotFoundException {
 106         initTmfTrace(name, path, eventType, cacheSize, false);
 107     }
 108
 109     @Override
 110     public void initTrace(String name, String path, Class<T> eventType, boolean indexTrace) throws FileNotFoundException {
 111         initTmfTrace(name, path, eventType, DEFAULT_INDEX_PAGE_SIZE, indexTrace);
 112     }
 113
 114     @Override
 115     public void initTrace(String name, String path, Class<T> eventType, int cacheSize, boolean indexTrace) throws FileNotFoundException {
 116         initTmfTrace(name, path, eventType, cacheSize, indexTrace);
 117     }
 118
 119     private void initTmfTrace(String name, String path, Class<T> eventType, int cacheSize, boolean indexTrace) throws FileNotFoundException {
 120         fPath = path;
 121         if (name != null) {
 122             fTraceName = name;
 123         }
 124         if (fTraceName == null) {
 125             fTraceName = ""; //$NON-NLS-1$
 126             if (path != null) {
 127                 int sep = path.lastIndexOf(Path.SEPARATOR);
 128                 fTraceName = (sep >= 0) ? path.substring(sep + 1) : path;
 129             }
 130         }
 131         super.init(fTraceName, eventType);
 132         fIndexPageSize = (cacheSize > 0) ? cacheSize : DEFAULT_INDEX_PAGE_SIZE;
 133         if (indexTrace)
 134             indexTrace(false);
 135     }
 136
 137     @Override
 138     public boolean validate(IProject project, String path) {
 139         File file = new File(path);
 140         return file.exists();
 141     }
 142
 143     /**
 144      * @param path
 145      * @throws FileNotFoundException
 146      */
 147     protected TmfTrace(String name, Class<T> type, String path) throws FileNotFoundException {
 148         this(name, type, path, DEFAULT_INDEX_PAGE_SIZE, true);
 149     }
 150
 151     /**
 152      * @param path
 153      * @param cacheSize
 154      * @throws FileNotFoundException
 155      */
 156     protected TmfTrace(String name, Class<T> type, String path, int cacheSize) throws FileNotFoundException {
 157         this(name, type, path, cacheSize, true);
 158     }
 159
 160     /**
 161      * @param path
 162      * @param indexTrace
 163      * @throws FileNotFoundException
 164      */
 165     protected TmfTrace(String name, Class<T> type, String path, boolean indexTrace) throws FileNotFoundException {
 166         this(name, type, path, DEFAULT_INDEX_PAGE_SIZE, indexTrace);
 167     }
 168
 169     /**
 170      * @param path
 171      * @param cacheSize
 172      * @param indexTrace
 173      * @throws FileNotFoundException
 174      */
 175     protected TmfTrace(String name, Class<T> type, String path, int cacheSize, boolean indexTrace) throws FileNotFoundException {
 176         super();
 177         fTraceName = name;
 178         initTrace(name, path, type, cacheSize, indexTrace);
 179     }
 180
 181     @SuppressWarnings("unchecked")
 182     @Override
 183     public TmfTrace<T> clone() throws CloneNotSupportedException {
 184         TmfTrace<T> clone = (TmfTrace<T>) super.clone();
 185         clone.fCheckpoints = fCheckpoints;
 186         clone.fStartTime = fStartTime.clone();
 187         clone.fEndTime = fEndTime.clone();
 188         return clone;
 189     }
 190
 191     // ------------------------------------------------------------------------
 192     // Accessors
 193     // ------------------------------------------------------------------------
 194
 195     /**
 196      * @return the trace path
 197      */
 198     @Override
 199     public String getPath() {
 200         return fPath;
 201     }
 202
 203     /* (non-Javadoc)
 204      * @see org.eclipse.linuxtools.tmf.stream.ITmfEventStream#getNbEvents()
 205      */
 206     @Override
 207     public synchronized long getNbEvents() {
 208         return fNbEvents;
 209     }
 210
 211     /**
 212      * @return the size of the cache
 213      */
 214     @Override
 215     public int getCacheSize() {
 216         return fIndexPageSize;
 217     }
 218
 219     /* (non-Javadoc)
 220      * @see org.eclipse.linuxtools.tmf.stream.ITmfEventStream#getTimeRange()
 221      */
 222     @Override
 223     public TmfTimeRange getTimeRange() {
 224         return new TmfTimeRange(fStartTime, fEndTime);
 225     }
 226
 227     /* (non-Javadoc)
 228      * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getStartTime()
 229      */
 230     @Override
 231     public ITmfTimestamp getStartTime() {
 232         return fStartTime;
 233     }
 234
 235     /* (non-Javadoc)
 236      * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getEndTime()
 237      */
 238     @Override
 239     public ITmfTimestamp getEndTime() {
 240         return fEndTime;
 241     }
 242
 243     /* (non-Javadoc)
 244      * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getStreamingInterval()
 245      */
 246     @Override
 247     public long getStreamingInterval() {
 248         return 0;
 249     }
 250
 251     @SuppressWarnings("unchecked")
 252     public Vector<TmfCheckpoint> getCheckpoints() {
 253         return (Vector<TmfCheckpoint>) fCheckpoints.clone();
 254     }
 255
 256     /**
 257      * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event
 258      * (if any).
 259      *
 260      * @param timestamp the requested event timestamp
 261      * @return the corresponding event rank
 262      */
 263     @Override
 264     public long getRank(ITmfTimestamp timestamp) {
 265         TmfContext context = seekEvent(timestamp);
 266         return context.getRank();
 267     }
 268
 269     // ------------------------------------------------------------------------
 270     // Operators
 271     // ------------------------------------------------------------------------
 272
 273     protected void setTimeRange(TmfTimeRange range) {
 274         fStartTime = range.getStartTime();
 275         fEndTime = range.getEndTime();
 276     }
 277
 278     protected void setStartTime(ITmfTimestamp startTime) {
 279         fStartTime = startTime;
 280     }
 281
 282     protected void setEndTime(ITmfTimestamp endTime) {
 283         fEndTime = endTime;
 284     }
 285
 286     // ------------------------------------------------------------------------
 287     // TmfProvider
 288     // ------------------------------------------------------------------------
 289
 290     @Override
 291     public ITmfContext armRequest(ITmfDataRequest<T> request) {
 292         if (request instanceof ITmfEventRequest<?>
 293                 && !TmfTimestamp.BIG_BANG.equals(((ITmfEventRequest<T>) request).getRange().getStartTime()) && request.getIndex() == 0) {
 294             ITmfContext context = seekEvent(((ITmfEventRequest<T>) request).getRange().getStartTime());
 295             ((ITmfEventRequest<T>) request).setStartIndex((int) context.getRank());
 296             return context;
 297
 298         }
 299         return seekEvent(request.getIndex());
 300     }
 301
 302     /**
 303      * Return the next piece of data based on the context supplied. The context would typically be updated for the
 304      * subsequent read.
 305      *
 306      * @param context
 307      * @return the event referred to by context
 308      */
 309     @SuppressWarnings("unchecked")
 310     @Override
 311     public T getNext(ITmfContext context) {
 312         if (context instanceof TmfContext) {
 313             return (T) getNextEvent((TmfContext) context);
 314         }
 315         return null;
 316     }
 317
 318     // ------------------------------------------------------------------------
 319     // ITmfTrace
 320     // ------------------------------------------------------------------------
 321
 322     @Override
 323     public abstract TmfContext seekLocation(ITmfLocation<?> location);
 324
 325     /* (non-Javadoc)
 326      * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.event.TmfTimestamp)
 327      */
 328     @Override
 329     public TmfContext seekEvent(ITmfTimestamp ts) {
 330
 331         ITmfTimestamp timestamp = ts;
 332         if (timestamp == null) {
 333             timestamp = TmfTimestamp.BIG_BANG;
 334         }
 335
 336         // First, find the right checkpoint
 337         int index = Collections.binarySearch(fCheckpoints, new TmfCheckpoint(timestamp, null));
 338
 339         // In the very likely case that the checkpoint was not found, bsearch
 340         // returns its negated would-be location (not an offset...). From that
 341         // index, we can then position the stream and get the event.
 342         if (index < 0) {
 343             index = Math.max(0, -(index + 2));
 344         }
 345
 346         // Position the stream at the checkpoint
 347         ITmfLocation<?> location;
 348         synchronized (fCheckpoints) {
 349             if (!fCheckpoints.isEmpty()) {
 350                 if (index >= fCheckpoints.size()) {
 351                     index = fCheckpoints.size() - 1;
 352                 }
 353                 location = fCheckpoints.elementAt(index).getLocation();
 354             } else {
 355                 location = null;
 356             }
 357         }
 358         TmfContext context = seekLocation(location);
 359         context.setRank(index * fIndexPageSize);
 360
 361         // And locate the event
 362         TmfContext nextEventContext = context.clone(); // Must use clone() to get the right subtype...
 363         ITmfEvent event = getNextEvent(nextEventContext);
 364         while (event != null && event.getTimestamp().compareTo(timestamp, false) < 0) {
 365             context.setLocation(nextEventContext.getLocation().clone());
 366             context.updateRank(1);
 367             event = getNextEvent(nextEventContext);
 368         }
 369
 370         return context;
 371     }
 372
 373     /* (non-Javadoc)
 374      * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#seekEvent(int)
 375      */
 376     @Override
 377     public TmfContext seekEvent(long rank) {
 378
 379         // Position the stream at the previous checkpoint
 380         int index = (int) rank / fIndexPageSize;
 381         ITmfLocation<?> location;
 382         synchronized (fCheckpoints) {
 383             if (fCheckpoints.isEmpty()) {
 384                 location = null;
 385             } else {
 386                 if (index >= fCheckpoints.size()) {
 387                     index = fCheckpoints.size() - 1;
 388                 }
 389                 location = fCheckpoints.elementAt(index).getLocation();
 390             }
 391         }
 392
 393         TmfContext context = seekLocation(location);
 394         long pos = index * fIndexPageSize;
 395         context.setRank(pos);
 396
 397         if (pos < rank) {
 398             ITmfEvent event = getNextEvent(context);
 399             while (event != null && ++pos < rank) {
 400                 event = getNextEvent(context);
 401             }
 402         }
 403
 404         return context;
 405     }
 406
 407     /*
 408      * (non-Javadoc)
 409      *
 410      * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getNextEvent(org.eclipse.
 411      * linuxtools.tmf.trace.ITmfTrace.TraceContext)
 412      */
 413     @Override
 414     public synchronized ITmfEvent getNextEvent(ITmfContext context) {
 415         // parseEvent() does not update the context
 416         ITmfEvent event = parseEvent(context);
 417         if (event != null) {
 418             updateIndex(context, context.getRank(), event.getTimestamp());
 419             context.setLocation(getCurrentLocation());
 420             context.updateRank(1);
 421             processEvent(event);
 422         }
 423         return event;
 424     }
 425
 426     protected synchronized void updateIndex(ITmfContext context, long rank, ITmfTimestamp timestamp) {
 427         if (fStartTime.compareTo(timestamp, false) > 0)
 428             fStartTime = timestamp;
 429         if (fEndTime.compareTo(timestamp, false) < 0)
 430             fEndTime = timestamp;
 431         if (context.isValidRank()) {
 432             if (fNbEvents <= rank)
 433                 fNbEvents = rank + 1;
 434             // Build the index as we go along
 435             if ((rank % fIndexPageSize) == 0) {
 436                 // Determine the table position
 437                 long position = rank / fIndexPageSize;
 438                 // Add new entry at proper location (if empty)
 439                 if (fCheckpoints.size() == position) {
 440                     ITmfLocation<?> location = context.getLocation().clone();
 441                     fCheckpoints.add(new TmfCheckpoint(timestamp.clone(), location));
 442                     // System.out.println(getName() + "[" + (fCheckpoints.size()
 443                     // - 1) + "] " + timestamp + ", " + location.toString());
 444                 }
 445             }
 446         }
 447     }
 448
 449     /**
 450      * Hook for special processing by the concrete class (called by getNextEvent())
 451      *
 452      * @param event
 453      */
 454     protected void processEvent(ITmfEvent event) {
 455         // Do nothing by default
 456     }
 457
 458     // ------------------------------------------------------------------------
 459     // toString
 460     // ------------------------------------------------------------------------
 461
 462     /* (non-Javadoc)
 463      * @see java.lang.Object#toString()
 464      */
 465     @Override
 466     @SuppressWarnings("nls")
 467     public String toString() {
 468         return "[TmfTrace (" + getName() + ")]";
 469     }
 470
 471     // ------------------------------------------------------------------------
 472     // Indexing
 473     // ------------------------------------------------------------------------
 474
 475     /*
 476      * The purpose of the index is to keep the information needed to rapidly
 477      * restore the traces contexts at regular intervals (every INDEX_PAGE_SIZE
 478      * event).
 479      */
 480
 481     @SuppressWarnings({ "unchecked" })
 482     protected void indexTrace(boolean waitForCompletion) {
 483
 484         final Job job = new Job("Indexing " + getName() + "...") { //$NON-NLS-1$ //$NON-NLS-2$
 485             @Override
 486             protected IStatus run(IProgressMonitor monitor) {
 487                 while (!monitor.isCanceled()) {
 488                     try {
 489                         Thread.sleep(100);
 490                     } catch (InterruptedException e) {
 491                         return Status.OK_STATUS;
 492                     }
 493                 }
 494                 monitor.done();
 495                 return Status.OK_STATUS;
 496             }
 497         };
 498         job.schedule();
 499
 500         fCheckpoints.clear();
 501         ITmfEventRequest<ITmfEvent> request = new TmfEventRequest<ITmfEvent>(ITmfEvent.class, TmfTimeRange.ETERNITY, TmfDataRequest.ALL_DATA,
 502                 fIndexPageSize, ITmfDataRequest.ExecutionType.BACKGROUND) {
 503
 504             ITmfTimestamp startTime = null;
 505             ITmfTimestamp lastTime = null;
 506
 507             @Override
 508             public void handleData(ITmfEvent event) {
 509                 super.handleData(event);
 510                 if (event != null) {
 511                     ITmfTimestamp ts = event.getTimestamp();
 512                     if (startTime == null)
 513                         startTime = ts.clone();
 514                     lastTime = ts.clone();
 515
 516                     if ((getNbRead() % fIndexPageSize) == 0) {
 517                         updateTrace();
 518                     }
 519                 }
 520             }
 521
 522             @Override
 523             public void handleSuccess() {
 524                 updateTrace();
 525             }
 526
 527             @Override
 528             public void handleCompleted() {
 529                 job.cancel();
 530                 super.handleCompleted();
 531             }
 532
 533             private synchronized void updateTrace() {
 534                 int nbRead = getNbRead();
 535                 if (nbRead != 0) {
 536                     fStartTime = startTime;
 537                     fEndTime = lastTime;
 538                     fNbEvents = nbRead;
 539                     notifyListeners();
 540                 }
 541             }
 542         };
 543
 544         sendRequest((ITmfDataRequest<T>) request);
 545         if (waitForCompletion)
 546             try {
 547                 request.waitForCompletion();
 548             } catch (InterruptedException e) {
 549 //                e.printStackTrace();
 550             }
 551     }
 552
 553     protected void notifyListeners() {
 554         broadcast(new TmfTraceUpdatedSignal(this, this, new TmfTimeRange(fStartTime, fEndTime)));
 555     }
 556
 557     /*
 558      * (non-Javadoc)
 559      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#setResource(org.eclipse.core.resources.IResource)
 560      */
 561     @Override
 562     public void setResource(IResource resource) {
 563         fResource = resource;
 564     }
 565
 566     /*
 567      * (non-Javadoc)
 568      * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getResource()
 569      */
 570     @Override
 571     public IResource getResource() {
 572         return fResource;
 573     }
 574 }