/*******************************************************************************
- * Copyright (c) 2009, 2010, 2012 Ericsson
- *
+ * Copyright (c) 2009, 2013 Ericsson
+ *
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
- *
+ *
* Contributors:
* Francois Chouinard - Initial API and implementation
* Francois Chouinard - Updated as per TMF Trace Model 1.0
+ * Patrick Tasse - Updated for removal of context clone
*******************************************************************************/
package org.eclipse.linuxtools.tmf.core.trace;
import java.io.File;
-import java.io.FileNotFoundException;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.Map;
-import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
-import org.eclipse.core.runtime.Path;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IPath;
import org.eclipse.linuxtools.tmf.core.component.TmfEventProvider;
import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
-import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
-import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
-import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp;
+import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException;
import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest;
import org.eclipse.linuxtools.tmf.core.request.ITmfEventRequest;
+import org.eclipse.linuxtools.tmf.core.signal.TmfRangeSynchSignal;
+import org.eclipse.linuxtools.tmf.core.signal.TmfSignalHandler;
+import org.eclipse.linuxtools.tmf.core.signal.TmfTimeSynchSignal;
+import org.eclipse.linuxtools.tmf.core.signal.TmfTraceOpenedSignal;
+import org.eclipse.linuxtools.tmf.core.signal.TmfTraceRangeUpdatedSignal;
+import org.eclipse.linuxtools.tmf.core.statesystem.ITmfStateSystem;
+import org.eclipse.linuxtools.tmf.core.statistics.ITmfStatistics;
+import org.eclipse.linuxtools.tmf.core.statistics.TmfStateStatistics;
+import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
+import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;
+import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimestamp;
/**
- * <b><u>TmfTrace</u></b>
- * <p>
* Abstract implementation of ITmfTrace.
* <p>
- * Document me...
+ * Since the concept of 'location' is trace specific, the concrete classes have
+ * to provide the related methods, namely:
+ * <ul>
+ * <li> public ITmfLocation<?> getCurrentLocation()
+ * <li> public double getLocationRatio(ITmfLocation<?> location)
+ * <li> public ITmfContext seekEvent(ITmfLocation<?> location)
+ * <li> public ITmfContext seekEvent(double ratio)
+ * <li> public boolean validate(IProject project, String path)
+ * </ul>
+ * A concrete trace must provide its corresponding parser. A common way to
+ * accomplish this is by making the concrete class extend TmfTrace and
+ * implement ITmfEventParser.
+ * <p>
+ * The concrete class can either specify its own indexer or use the provided
+ * TmfCheckpointIndexer (default). In this case, the trace cache size will be
+ * used as checkpoint interval.
+ *
+ * @version 1.0
+ * @author Francois Chouinard
+ *
+ * @see ITmfEvent
+ * @see ITmfTraceIndexer
+ * @see ITmfEventParser
*/
-public abstract class TmfTrace<T extends ITmfEvent> extends TmfEventProvider<T> implements ITmfTrace<T> {
-
- // ------------------------------------------------------------------------
- // Constants
- // ------------------------------------------------------------------------
-
- /**
- * The default trace cache size
- */
- public static final int DEFAULT_TRACE_CACHE_SIZE = 1000;
+public abstract class TmfTrace extends TmfEventProvider implements ITmfTrace {
// ------------------------------------------------------------------------
// Attributes
// The trace path
private String fPath;
- /**
- * The cache page size AND trace checkpoints interval
- */
- protected int fCacheSize = DEFAULT_TRACE_CACHE_SIZE;
-
- // The set of event stream checkpoints
-// protected Vector<TmfCheckpoint> fCheckpoints = new Vector<TmfCheckpoint>();
+ // The trace cache page size
+ private int fCacheSize = ITmfTrace.DEFAULT_TRACE_CACHE_SIZE;
- // The number of events collected
- protected long fNbEvents = 0;
+ // The number of events collected (so far)
+ private long fNbEvents = 0;
// The time span of the event stream
- private ITmfTimestamp fStartTime = TmfTimestamp.BIG_CRUNCH;
+ private ITmfTimestamp fStartTime = TmfTimestamp.BIG_BANG;
private ITmfTimestamp fEndTime = TmfTimestamp.BIG_BANG;
- /**
- * The trace streaming interval (0 = no streaming)
- */
- protected long fStreamingInterval = 0;
+ // The trace streaming interval (0 = no streaming)
+ private long fStreamingInterval = 0;
+
+ // The trace indexer
+ private ITmfTraceIndexer fIndexer;
+
+ // The trace parser
+ private ITmfEventParser fParser;
+
+ // The trace's statistics
+ private ITmfStatistics fStatistics;
+
+ // The current selected time
+ private ITmfTimestamp fCurrentTime = TmfTimestamp.ZERO;
+
+ // The current selected range
+ private TmfTimeRange fCurrentRange = TmfTimeRange.NULL_RANGE;
/**
- * The trace indexer
+ * The collection of state systems that are registered with this trace. Each
+ * sub-class can decide to add its (one or many) state system to this map
+ * during their {@link #buildStateSystem()}.
+ *
+ * @since 2.0
*/
- protected ITmfTraceIndexer<ITmfTrace<ITmfEvent>> fIndexer;
+ protected final Map<String, ITmfStateSystem> fStateSystems =
+ new LinkedHashMap<String, ITmfStateSystem>();
// ------------------------------------------------------------------------
// Construction
/**
* The default, parameterless, constructor
*/
- @SuppressWarnings({ "unchecked", "rawtypes" })
public TmfTrace() {
super();
- fIndexer = new TmfTraceIndexer(this);
- }
-
- /**
- * The standard constructor (non-live trace)
- *
- * @param resource the resource associated to the trace
- * @param type the trace event type
- * @param path the trace path
- * @param cacheSize the trace cache size
- * @throws FileNotFoundException
- */
- protected TmfTrace(final IResource resource, final Class<T> type, final String path, final int cacheSize) throws FileNotFoundException {
- this(resource, type, path, cacheSize, 0, null);
- }
-
- /**
- * The standard constructor (live trace)
- *
- * @param resource the resource associated to the trace
- * @param type the trace event type
- * @param path the trace path
- * @param cacheSize the trace cache size
- * @param interval the trace streaming interval
- * @throws FileNotFoundException
- */
- protected TmfTrace(final IResource resource, final Class<T> type, final String path, final int cacheSize, final long interval) throws FileNotFoundException {
- this(resource, type, path, cacheSize, interval, null);
}
/**
- * The full constructor
- *
- * @param resource the resource associated to the trace
- * @param type the trace event type
- * @param path the trace path
- * @param cacheSize the trace cache size
- * @param indexer the trace indexer
- * @throws FileNotFoundException
- */
- @SuppressWarnings({ "unchecked", "rawtypes" })
- protected TmfTrace(final IResource resource, final Class<T> type, final String path, final int cacheSize,
- final long interval, final ITmfTraceIndexer<?> indexer) throws FileNotFoundException {
+ * Full constructor.
+ *
+ * @param resource
+ * The resource associated to the trace
+ * @param type
+ * The type of events that will be read from this trace
+ * @param path
+ * The path to the trace on the filesystem
+ * @param cacheSize
+ * The trace cache size. Pass '-1' to use the default specified
+ * in {@link ITmfTrace#DEFAULT_TRACE_CACHE_SIZE}
+ * @param interval
+ * The trace streaming interval. You can use '0' for post-mortem
+ * traces.
+ * @param indexer
+ * The trace indexer. You can pass 'null' to use a default
+ * checkpoint indexer.
+ * @param parser
+ * The trace event parser. Use 'null' if (and only if) the trace
+ * object itself is also the ITmfEventParser to be used.
+ * @throws TmfTraceException
+ * If something failed during the opening
+ */
+ protected TmfTrace(final IResource resource,
+ final Class<? extends ITmfEvent> type,
+ final String path,
+ final int cacheSize,
+ final long interval,
+ final ITmfTraceIndexer indexer,
+ final ITmfEventParser parser)
+ throws TmfTraceException {
super();
- fCacheSize = (cacheSize > 0) ? cacheSize : DEFAULT_TRACE_CACHE_SIZE;
+ fCacheSize = (cacheSize > 0) ? cacheSize : ITmfTrace.DEFAULT_TRACE_CACHE_SIZE;
fStreamingInterval = interval;
- fIndexer = (indexer != null) ? indexer : new TmfTraceIndexer(this, fCacheSize);
+ fIndexer = (indexer != null) ? indexer : new TmfCheckpointIndexer(this, fCacheSize);
+ fParser = parser;
initialize(resource, path, type);
}
/**
* Copy constructor
- *
+ *
* @param trace the original trace
+ * @throws TmfTraceException Should not happen usually
*/
- @SuppressWarnings({ "unchecked", "rawtypes" })
- public TmfTrace(final TmfTrace<T> trace) throws FileNotFoundException {
+ public TmfTrace(final TmfTrace trace) throws TmfTraceException {
super();
- if (trace == null)
+ if (trace == null) {
throw new IllegalArgumentException();
+ }
fCacheSize = trace.getCacheSize();
fStreamingInterval = trace.getStreamingInterval();
- fIndexer = new TmfTraceIndexer(this);
- initialize(trace.getResource(), trace.getPath(), trace.getType());
+ fIndexer = new TmfCheckpointIndexer(this);
+ fParser = trace.fParser;
+ initialize(trace.getResource(), trace.getPath(), trace.getEventType());
+ }
+
+ // ------------------------------------------------------------------------
+ // ITmfTrace - Initializers
+ // ------------------------------------------------------------------------
+
+ @Override
+ public void initTrace(final IResource resource, final String path, final Class<? extends ITmfEvent> type) throws TmfTraceException {
+ fIndexer = new TmfCheckpointIndexer(this, fCacheSize);
+ initialize(resource, path, type);
}
/**
* Initialize the trace common attributes and the base component.
- *
- * @param resource the Eclipse resource (trace)
+ *
+ * @param resource the Eclipse resource (trace)
* @param path the trace path
* @param type the trace event type
- *
- * @throws FileNotFoundException
+ *
+ * @throws TmfTraceException If something failed during the initialization
*/
- protected void initialize(final IResource resource, final String path, final Class<T> type) throws FileNotFoundException {
- if (path == null)
- throw new FileNotFoundException();
+ protected void initialize(final IResource resource, final String path, final Class<? extends ITmfEvent> type) throws TmfTraceException {
+ if (path == null) {
+ throw new TmfTraceException("Invalid trace path"); //$NON-NLS-1$
+ }
fPath = path;
fResource = resource;
String traceName = (resource != null) ? resource.getName() : null;
// If no resource was provided, extract the display name the trace path
if (traceName == null) {
- final int sep = path.lastIndexOf(Path.SEPARATOR);
+ final int sep = path.lastIndexOf(IPath.SEPARATOR);
traceName = (sep >= 0) ? path.substring(sep + 1) : path;
}
+ if (fParser == null) {
+ if (this instanceof ITmfEventParser) {
+ fParser = (ITmfEventParser) this;
+ } else {
+ throw new TmfTraceException("Invalid trace parser"); //$NON-NLS-1$
+ }
+ }
super.init(traceName, type);
}
- // ------------------------------------------------------------------------
- // ITmfTrace - Initializers
- // ------------------------------------------------------------------------
+ /**
+ * Indicates if the path points to an existing file/directory
+ *
+ * @param path the path to test
+ * @return true if the file/directory exists
+ */
+ protected boolean fileExists(final String path) {
+ final File file = new File(path);
+ return file.exists();
+ }
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#initTrace(org.eclipse.core.resources.IResource, java.lang.String, java.lang.Class)
+ /**
+ * Index the trace
+ *
+ * @param waitForCompletion index synchronously (true) or not (false)
*/
- @Override
- public void initTrace(final IResource resource, final String path, final Class<T> type) throws FileNotFoundException {
- initialize(resource, path, type);
- fIndexer.buildIndex(false);
+ protected void indexTrace(boolean waitForCompletion) {
+ getIndexer().buildIndex(0, TmfTimeRange.ETERNITY, waitForCompletion);
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#validate(org.eclipse.core.resources.IProject, java.lang.String)
- *
- * Default validation: make sure the trace file exists.
+ /**
+ * The default implementation of TmfTrace uses a TmfStatistics back-end.
+ * Override this if you want to specify another type (or none at all).
+ *
+ * @throws TmfTraceException
+ * If there was a problem setting up the statistics
+ * @since 2.0
+ */
+ protected void buildStatistics() throws TmfTraceException {
+ /*
+ * Initialize the statistics provider, but only if a Resource has been
+ * set (so we don't build it for experiments, for unit tests, etc.)
+ */
+ fStatistics = (fResource == null ? null : new TmfStateStatistics(this) );
+ }
+
+ /**
+ * Build the state system(s) associated with this trace type.
+ *
+ * Suppressing the warning, because the 'throws' will usually happen in
+ * sub-classes.
+ *
+ * @throws TmfTraceException
+ * If there is a problem during the build
+ * @since 2.0
+ */
+ @SuppressWarnings("unused")
+ protected void buildStateSystem() throws TmfTraceException {
+ /*
+ * Nothing is done in the base implementation, please specify
+ * how/if to register a new state system in derived classes.
+ */
+ return;
+ }
+
+ /**
+ * Clears the trace
*/
@Override
- public boolean validate(final IProject project, final String path) {
- final File file = new File(path);
- return file.exists();
+ public synchronized void dispose() {
+ /* Clean up the index if applicable */
+ if (getIndexer() != null) {
+ getIndexer().dispose();
+ }
+
+ /* Clean up the statistics */
+ if (fStatistics != null) {
+ fStatistics.dispose();
+ }
+
+ /* Clean up the state systems */
+ for (ITmfStateSystem ss : fStateSystems.values()) {
+ ss.dispose();
+ }
+
+ super.dispose();
}
// ------------------------------------------------------------------------
// ITmfTrace - Basic getters
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.component.TmfDataProvider#getType()
+ /**
+ * @since 2.0
*/
@Override
- @SuppressWarnings("unchecked")
- public Class<T> getType() {
- return (Class<T>) super.getType();
+ public ITmfTrace[] getTraces() {
+ return new ITmfTrace[] { this };
+ }
+
+ @Override
+ public Class<ITmfEvent> getEventType() {
+ return (Class<ITmfEvent>) super.getType();
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getResource()
- */
@Override
public IResource getResource() {
return fResource;
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getPath()
- */
@Override
public String getPath() {
return fPath;
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getIndexPageSize()
- */
@Override
public int getCacheSize() {
return fCacheSize;
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStreamingInterval()
- */
@Override
public long getStreamingInterval() {
return fStreamingInterval;
}
+ /**
+ * @return the trace indexer
+ */
+ protected ITmfTraceIndexer getIndexer() {
+ return fIndexer;
+ }
+
+ /**
+ * @return the trace parser
+ */
+ protected ITmfEventParser getParser() {
+ return fParser;
+ }
+
+ /**
+ * @since 2.0
+ */
+ @Override
+ public ITmfStatistics getStatistics() {
+ return fStatistics;
+ }
+
+ /**
+ * @since 2.0
+ */
+ @Override
+ public final Map<String, ITmfStateSystem> getStateSystems() {
+ return Collections.unmodifiableMap(fStateSystems);
+ }
+
+ /**
+ * @since 2.0
+ */
+ @Override
+ public final void registerStateSystem(String id, ITmfStateSystem ss) {
+ fStateSystems.put(id, ss);
+ }
+
// ------------------------------------------------------------------------
// ITmfTrace - Trace characteristics getters
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNbEvents()
- */
@Override
- public long getNbEvents() {
+ public synchronized long getNbEvents() {
return fNbEvents;
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getTimeRange()
+ /**
+ * @since 2.0
*/
@Override
public TmfTimeRange getTimeRange() {
return new TmfTimeRange(fStartTime, fEndTime);
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStartTime()
+ /**
+ * @since 2.0
*/
@Override
public ITmfTimestamp getStartTime() {
- return fStartTime.clone();
+ return fStartTime;
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEndTime()
+ /**
+ * @since 2.0
*/
@Override
public ITmfTimestamp getEndTime() {
- return fEndTime.clone();
+ return fEndTime;
+ }
+
+ /**
+ * @since 2.0
+ */
+ @Override
+ public ITmfTimestamp getCurrentTime() {
+ return fCurrentTime;
+ }
+
+ /**
+ * @since 2.0
+ */
+ @Override
+ public TmfTimeRange getCurrentRange() {
+ return fCurrentRange;
+ }
+
+ /**
+ * @since 2.0
+ */
+ @Override
+ public ITmfTimestamp getInitialRangeOffset() {
+ final long DEFAULT_INITIAL_OFFSET_VALUE = (1L * 100 * 1000 * 1000); // .1sec
+ return new TmfTimestamp(DEFAULT_INITIAL_OFFSET_VALUE, ITmfTimestamp.NANOSECOND_SCALE);
}
// ------------------------------------------------------------------------
// Convenience setters
// ------------------------------------------------------------------------
+ /**
+ * Set the trace cache size. Must be done at initialization time.
+ *
+ * @param cacheSize The trace cache size
+ */
+ protected void setCacheSize(final int cacheSize) {
+ fCacheSize = cacheSize;
+ }
+
+ /**
+ * Set the trace known number of events. This can be quite dynamic
+ * during indexing or for live traces.
+ *
+ * @param nbEvents The number of events
+ */
+ protected synchronized void setNbEvents(final long nbEvents) {
+ fNbEvents = (nbEvents > 0) ? nbEvents : 0;
+ }
+
/**
* Update the trace events time range
- *
+ *
* @param range the new time range
+ * @since 2.0
*/
protected void setTimeRange(final TmfTimeRange range) {
- fStartTime = range.getStartTime().clone();
- fEndTime = range.getEndTime().clone();
+ fStartTime = range.getStartTime();
+ fEndTime = range.getEndTime();
}
/**
* Update the trace chronologically first event timestamp
- *
+ *
* @param startTime the new first event timestamp
+ * @since 2.0
*/
protected void setStartTime(final ITmfTimestamp startTime) {
- fStartTime = startTime.clone();
+ fStartTime = startTime;
}
/**
* Update the trace chronologically last event timestamp
- *
+ *
* @param endTime the new last event timestamp
+ * @since 2.0
*/
protected void setEndTime(final ITmfTimestamp endTime) {
- fEndTime = endTime.clone();
+ fEndTime = endTime;
}
/**
- * Update the trace streaming interval
- *
+ * Set the polling interval for live traces (default = 0 = no streaming).
+ *
* @param interval the new trace streaming interval
*/
protected void setStreamingInterval(final long interval) {
fStreamingInterval = (interval > 0) ? interval : 0;
}
+ /**
+ * Set the trace indexer. Must be done at initialization time.
+ *
+ * @param indexer the trace indexer
+ */
+ protected void setIndexer(final ITmfTraceIndexer indexer) {
+ fIndexer = indexer;
+ }
+
+ /**
+ * Set the trace parser. Must be done at initialization time.
+ *
+ * @param parser the new trace parser
+ */
+ protected void setParser(final ITmfEventParser parser) {
+ fParser = parser;
+ }
+
// ------------------------------------------------------------------------
- // ITmfTrace - Seek operations (returning a reading context)
+ // ITmfTrace - SeekEvent operations (returning a trace context)
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp)
- */
@Override
- public synchronized ITmfContext seekEvent(final ITmfTimestamp timestamp) {
+ public synchronized ITmfContext seekEvent(final long rank) {
- // A null timestamp indicates to seek the first event
- if (timestamp == null)
- return seekLocation(null);
+ // A rank <= 0 indicates to seek the first event
+ if (rank <= 0) {
+ ITmfContext context = seekEvent((ITmfLocation) null);
+ context.setRank(0);
+ return context;
+ }
// Position the trace at the checkpoint
- final ITmfContext context = fIndexer.seekIndex(timestamp);
+ final ITmfContext context = fIndexer.seekIndex(rank);
// And locate the requested event context
- final ITmfContext nextEventContext = context.clone(); // Must use clone() to get the right subtype...
- ITmfEvent event = getNextEvent(nextEventContext);
- while (event != null && event.getTimestamp().compareTo(timestamp, false) < 0) {
- context.setLocation(nextEventContext.getLocation().clone());
- context.increaseRank();
- event = getNextEvent(nextEventContext);
+ long pos = context.getRank();
+ if (pos < rank) {
+ ITmfEvent event = getNext(context);
+ while ((event != null) && (++pos < rank)) {
+ event = getNext(context);
+ }
}
return context;
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(long)
+ /**
+ * @since 2.0
*/
@Override
- public synchronized ITmfContext seekEvent(final long rank) {
+ public synchronized ITmfContext seekEvent(final ITmfTimestamp timestamp) {
- // A rank <= 0 indicates to seek the first event
- if (rank <= 0)
- return seekLocation(null);
+ // A null timestamp indicates to seek the first event
+ if (timestamp == null) {
+ ITmfContext context = seekEvent((ITmfLocation) null);
+ context.setRank(0);
+ return context;
+ }
// Position the trace at the checkpoint
- final ITmfContext context = fIndexer.seekIndex(rank);
+ ITmfContext context = fIndexer.seekIndex(timestamp);
// And locate the requested event context
- long pos = context.getRank();
- if (pos < rank) {
- ITmfEvent event = getNextEvent(context);
- while (event != null && ++pos < rank) {
- event = getNextEvent(context);
- }
+ ITmfLocation previousLocation = context.getLocation();
+ long previousRank = context.getRank();
+ ITmfEvent event = getNext(context);
+ while (event != null && event.getTimestamp().compareTo(timestamp, false) < 0) {
+ previousLocation = context.getLocation();
+ previousRank = context.getRank();
+ event = getNext(context);
+ }
+ if (event == null) {
+ context.setLocation(null);
+ context.setRank(ITmfContext.UNKNOWN_RANK);
+ } else {
+ context.dispose();
+ context = seekEvent(previousLocation);
+ context.setRank(previousRank);
}
return context;
}
// ITmfTrace - Read operations (returning an actual event)
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#parseEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
- */
- @Override
- public synchronized ITmfEvent parseEvent(final ITmfContext context) {
- final ITmfContext tmpContext = context.clone();
- final ITmfEvent event = getNextEvent(tmpContext);
- return event;
- }
-
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNextEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
- */
@Override
- public synchronized ITmfEvent getNextEvent(final ITmfContext context) {
+ public synchronized ITmfEvent getNext(final ITmfContext context) {
// parseEvent() does not update the context
- final ITmfEvent event = parseEvent(context);
+ final ITmfEvent event = fParser.parseEvent(context);
if (event != null) {
updateAttributes(context, event.getTimestamp());
context.setLocation(getCurrentLocation());
/**
* Hook for special event processing by the concrete class
- * (called by TmfTrace.getNextEvent())
- *
+ * (called by TmfTrace.getEvent())
+ *
* @param event the event
*/
protected void processEvent(final ITmfEvent event) {
/**
* Update the trace attributes
- *
+ *
* @param context the current trace context
- * @param rank
- * @param timestamp
+ * @param timestamp the corresponding timestamp
+ * @since 2.0
*/
protected synchronized void updateAttributes(final ITmfContext context, final ITmfTimestamp timestamp) {
- if (fStartTime.compareTo(timestamp, false) > 0) {
+ if (fStartTime.equals(TmfTimestamp.BIG_BANG) || (fStartTime.compareTo(timestamp, false) > 0)) {
fStartTime = timestamp;
}
- if (fEndTime.compareTo(timestamp, false) < 0) {
+ if (fEndTime.equals(TmfTimestamp.BIG_CRUNCH) || (fEndTime.compareTo(timestamp, false) < 0)) {
fEndTime = timestamp;
}
+ if (fCurrentRange == TmfTimeRange.NULL_RANGE) {
+ fCurrentTime = timestamp;
+ ITmfTimestamp initialOffset = getInitialRangeOffset();
+ long endValue = timestamp.getValue() + initialOffset.normalize(0, timestamp.getScale()).getValue();
+ ITmfTimestamp endTimestamp = new TmfTimestamp(endValue, timestamp.getScale());
+ fCurrentRange = new TmfTimeRange(timestamp, endTimestamp);
+ }
if (context.hasValidRank()) {
long rank = context.getRank();
if (fNbEvents <= rank) {
fNbEvents = rank + 1;
}
- fIndexer.updateIndex(context, timestamp);
+ if (fIndexer != null) {
+ fIndexer.updateIndex(context, timestamp);
+ }
}
}
// TmfDataProvider
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.component.TmfDataProvider#armRequest(org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest)
+ /**
+ * @since 2.0
*/
@Override
- public ITmfContext armRequest(final ITmfDataRequest<T> request) {
- if (request instanceof ITmfEventRequest<?>
- && !TmfTimestamp.BIG_BANG.equals(((ITmfEventRequest<T>) request).getRange().getStartTime())
- && request.getIndex() == 0) {
- final ITmfContext context = seekEvent(((ITmfEventRequest<T>) request).getRange().getStartTime());
- ((ITmfEventRequest<T>) request).setStartIndex((int) context.getRank());
+ public synchronized ITmfContext armRequest(final ITmfDataRequest request) {
+ if (executorIsShutdown()) {
+ return null;
+ }
+ if ((request instanceof ITmfEventRequest)
+ && !TmfTimestamp.BIG_BANG.equals(((ITmfEventRequest) request).getRange().getStartTime())
+ && (request.getIndex() == 0))
+ {
+ final ITmfContext context = seekEvent(((ITmfEventRequest) request).getRange().getStartTime());
+ ((ITmfEventRequest) request).setStartIndex((int) context.getRank());
return context;
}
return seekEvent(request.getIndex());
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.component.TmfDataProvider#getNext(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
- */
- @Override
- @SuppressWarnings("unchecked")
- public T getNext(final ITmfContext context) {
- if (context instanceof TmfContext)
- return (T) getNextEvent(context);
- return null;
+ // ------------------------------------------------------------------------
+ // Signal handlers
+ // ------------------------------------------------------------------------
+
+ /**
+ * Handler for the Trace Opened signal
+ *
+ * @param signal
+ * The incoming signal
+ * @since 2.0
+ */
+ @TmfSignalHandler
+ public void traceOpened(TmfTraceOpenedSignal signal) {
+ ITmfTrace trace = null;
+ for (ITmfTrace expTrace : signal.getTrace().getTraces()) {
+ if (expTrace == this) {
+ trace = expTrace;
+ break;
+ }
+ }
+
+ if (trace == null) {
+ /* This signal is not for us */
+ return;
+ }
+
+ /*
+ * The signal is for this trace, or for an experiment containing
+ * this trace.
+ */
+ try {
+ buildStatistics();
+ buildStateSystem();
+ } catch (TmfTraceException e) {
+ e.printStackTrace();
+ }
+
+ /* Refresh the project, so it can pick up new files that got created. */
+ try {
+ if (fResource != null) {
+ fResource.getProject().refreshLocal(IResource.DEPTH_INFINITE, null);
+ }
+ } catch (CoreException e) {
+ e.printStackTrace();
+ }
+
+ if (signal.getTrace() == this) {
+ /* Additionally, the signal is directly for this trace or experiment. */
+ if (getNbEvents() == 0) {
+ return;
+ }
+
+ final TmfTimeRange timeRange = new TmfTimeRange(getStartTime(), TmfTimestamp.BIG_CRUNCH);
+ final TmfTraceRangeUpdatedSignal rangeUpdatedsignal = new TmfTraceRangeUpdatedSignal(this, this, timeRange);
+
+ // Broadcast in separate thread to prevent deadlock
+ new Thread() {
+ @Override
+ public void run() {
+ broadcast(rangeUpdatedsignal);
+ }
+ }.start();
+ return;
+ }
}
+ /**
+ * Signal handler for the TmfTraceRangeUpdatedSignal signal
+ *
+ * @param signal The incoming signal
+ * @since 2.0
+ */
+ @TmfSignalHandler
+ public void traceRangeUpdated(final TmfTraceRangeUpdatedSignal signal) {
+ if (signal.getTrace() == this) {
+ getIndexer().buildIndex(getNbEvents(), signal.getRange(), false);
+ }
+ }
+
+ /**
+ * Signal handler for the TmfTimeSynchSignal signal
+ *
+ * @param signal The incoming signal
+ * @since 2.0
+ */
+ @TmfSignalHandler
+ public void synchToTime(final TmfTimeSynchSignal signal) {
+ if (signal.getCurrentTime().compareTo(fStartTime) >= 0 && signal.getCurrentTime().compareTo(fEndTime) <= 0) {
+ fCurrentTime = signal.getCurrentTime();
+ }
+ }
+
+ /**
+ * Signal handler for the TmfRangeSynchSignal signal
+ *
+ * @param signal The incoming signal
+ * @since 2.0
+ */
+ @TmfSignalHandler
+ public void synchToRange(final TmfRangeSynchSignal signal) {
+ if (signal.getCurrentTime().compareTo(fStartTime) >= 0 && signal.getCurrentTime().compareTo(fEndTime) <= 0) {
+ fCurrentTime = signal.getCurrentTime();
+ }
+ if (signal.getCurrentRange().getIntersection(getTimeRange()) != null) {
+ fCurrentRange = signal.getCurrentRange().getIntersection(getTimeRange());
+ }
+ }
// ------------------------------------------------------------------------
// toString
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see java.lang.Object#toString()
- */
@Override
@SuppressWarnings("nls")
- public String toString() {
+ public synchronized String toString() {
return "TmfTrace [fPath=" + fPath + ", fCacheSize=" + fCacheSize
+ ", fNbEvents=" + fNbEvents + ", fStartTime=" + fStartTime
+ ", fEndTime=" + fEndTime + ", fStreamingInterval=" + fStreamingInterval + "]";