/*******************************************************************************
- * Copyright (c) 2009, 2011 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
*******************************************************************************/
package org.eclipse.linuxtools.tmf.core.trace;
-import java.io.FileNotFoundException;
+import java.util.Collections;
+import java.util.Map;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
-import org.eclipse.linuxtools.tmf.core.component.ITmfComponent;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.linuxtools.tmf.core.component.ITmfDataProvider;
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.exceptions.TmfTraceException;
+import org.eclipse.linuxtools.tmf.core.statesystem.ITmfStateSystem;
+import org.eclipse.linuxtools.tmf.core.statistics.ITmfStatistics;
+import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
+import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;
/**
- * <b><u>ITmfTrace</u></b>
+ * The event stream structure in TMF. In its basic form, a trace has:
+ * <ul>
+ * <li> an associated Eclipse resource
+ * <li> a path to its location on the file system
+ * <li> the type of the events it contains
+ * <li> the number of events it contains
+ * <li> the time range (span) of the events it contains
+ * </ul>
+ * Concrete ITmfTrace classes have to provide a parameter-less constructor and
+ * an initialization method (<i>initTrace</i>) if they are to be opened from
+ * the Project View. Also, a validation method (<i>validate</i>) has to be
+ * provided to ensure that the trace is of the correct type.
* <p>
+ * A trace can be accessed simultaneously from multiple threads by various
+ * application components. To avoid obvious multi-threading issues, the trace
+ * uses an ITmfContext as a synchronization aid for its read operations.
+ * <p>
+ * A proper ITmfContext can be obtained by performing a seek operation on the
+ * trace. Seek operations can be performed for a particular event (by rank or
+ * timestamp) or for a plain trace location.
+ * <p>
+ * <b>Example 1</b>: Process a whole trace
+ * <pre>
+ * ITmfContext context = trace.seekEvent(0);
+ * ITmfEvent event = trace.getNext(context);
+ * while (event != null) {
+ * processEvent(event);
+ * event = trace.getNext(context);
+ * }
+ * </pre>
+ * <b>Example 2</b>: Process 50 events starting from the 1000th event
+ * <pre>
+ * int nbEventsRead = 0;
+ * ITmfContext context = trace.seekEvent(1000);
+ * ITmfEvent event = trace.getNext(context);
+ * while (event != null && nbEventsRead < 50) {
+ * nbEventsRead++;
+ * processEvent(event);
+ * event = trace.getNext(context);
+ * }
+ * </pre>
+ * <b>Example 3</b>: Process the events between 2 timestamps (inclusive)
+ * <pre>
+ * ITmfTimestamp startTime = ...;
+ * ITmfTimestamp endTime = ...;
+ * ITmfContext context = trace.seekEvent(startTime);
+ * ITmfEvent event = trace.getNext(context);
+ * while (event != null && event.getTimestamp().compareTo(endTime) <= 0) {
+ * processEvent(event);
+ * event = trace.getNext(context);
+ * }
+ * </pre>
+ * A trace is also an event provider so it can process event requests
+ * asynchronously (and coalesce compatible, concurrent requests).
+ * <p>
+ * </pre>
+ * <b>Example 4</b>: Process a whole trace (see ITmfEventRequest for variants)
+ * <pre>
+ * ITmfRequest request = new TmfEventRequest<MyEventType>(MyEventType.class) {
+ * @Override
+ * public void handleData(MyEventType event) {
+ * super.handleData(event);
+ * processEvent(event);
+ * }
+ * @Override
+ * public void handleCompleted() {
+ * finish();
+ * super.handleCompleted();
+ * }
+ * };
+ *
+ * fTrace.handleRequest(request);
+ * if (youWant) {
+ * request.waitForCompletion();
+ * }
+ * </pre>
+ *
+ * @version 1.0
+ * @author Francois Chouinard
+ *
+ * @see ITmfContext
+ * @see ITmfEvent
+ * @see ITmfTraceIndexer
+ * @see ITmfEventParser
*/
-public interface ITmfTrace<T extends ITmfEvent> extends ITmfComponent {
+public interface ITmfTrace extends ITmfDataProvider {
+
+ // ------------------------------------------------------------------------
+ // Constants
+ // ------------------------------------------------------------------------
- // initTrace variants
- public void initTrace(String name, String path, Class<T> eventType) throws FileNotFoundException;
+ /**
+ * The default trace cache size
+ */
+ public static final int DEFAULT_TRACE_CACHE_SIZE = 1000;
- public void initTrace(String name, String path, Class<T> eventType, int cacheSize) throws FileNotFoundException;
+ // ------------------------------------------------------------------------
+ // Initializers
+ // ------------------------------------------------------------------------
+
+ /**
+ * Initialize a newly instantiated "empty" trace object. This is used to
+ * properly parameterize an ITmfTrace instantiated with its parameterless
+ * constructor.
+ * <p>
+ * Typically, the parameterless constructor will provide the block size
+ * and its associated parser and indexer.
+ *
+ * @param resource the trace resource
+ * @param path the trace path
+ * @param type the trace event type
+ * @throws TmfTraceException If we couldn't open the trace
+ */
+ void initTrace(IResource resource, String path, Class<? extends ITmfEvent> type) throws TmfTraceException;
- public void initTrace(String name, String path, Class<T> eventType, boolean indexTrace) throws FileNotFoundException;
+ /**
+ * Validate that the trace is of the correct type.
+ *
+ * @param project the eclipse project
+ * @param path the trace path
+ *
+ * @return an IStatus object with validation result. Use severity OK to indicate success.
+ * @since 2.0
+ */
+ IStatus validate(IProject project, String path);
- public void initTrace(String name, String path, Class<T> eventType, int cacheSize, boolean indexTrace) throws FileNotFoundException;
+ // ------------------------------------------------------------------------
+ // Basic getters
+ // ------------------------------------------------------------------------
- // Trace type validation
- public boolean validate(IProject project, String path);
+ /**
+ * @return the trace event type
+ */
+ Class<? extends ITmfEvent> getEventType();
- public ITmfTrace<T> copy();
+ /**
+ * @return the associated trace resource
+ */
+ IResource getResource();
/**
* @return the trace path
*/
- public String getPath();
+ String getPath();
/**
- * @return the trace name
+ * @return the trace cache size
*/
- @Override
- public String getName();
+ int getCacheSize();
/**
- * @return the cache size
+ * @return The statistics provider for this trace
+ * @since 2.0
*/
- public int getCacheSize();
+ ITmfStatistics getStatistics();
/**
- * @return the number of events in the trace
+ * Return the map of state systems associated with this trace.
+ *
+ * This view should be read-only (implementations should use
+ * {@link Collections#unmodifiableMap}).
+ *
+ * @return The map of state systems
+ * @since 2.0
*/
- public long getNbEvents();
+ Map<String, ITmfStateSystem> getStateSystems();
/**
- * Trace time range accesses
+ * If a state system is not build by the trace itself, it's possible to
+ * register it if it comes from another source. It will then be accessible
+ * with {@link #getStateSystems} normally.
+ *
+ * @param id
+ * The unique ID to assign to this state system. In case of
+ * conflicting ID's, the new one will overwrite the previous one
+ * (default Map behavior).
+ * @param ss
+ * The already-built state system
+ * @since 2.0
*/
- public TmfTimeRange getTimeRange();
+ void registerStateSystem(String id, ITmfStateSystem ss);
- public ITmfTimestamp getStartTime();
+ /**
+ * Index the trace. Depending on the trace type, this could be done at the
+ * constructor or initTrace phase too, so this could be implemented as a
+ * no-op.
+ *
+ * @param waitForCompletion
+ * Should we block the caller until indexing is finished, or not.
+ * @since 2.0
+ */
+ void indexTrace(boolean waitForCompletion);
- public ITmfTimestamp getEndTime();
+ // ------------------------------------------------------------------------
+ // Trace characteristics getters
+ // ------------------------------------------------------------------------
/**
- * @return the streaming interval in ms (0 if not streaming)
+ * @return the number of events in the trace
*/
- public long getStreamingInterval();
+ long getNbEvents();
/**
- * Positions the trace at the first event with the specified timestamp or index (i.e. the nth event in the trace).
- *
- * Returns a context which can later be used to read the event.
- *
- * @param location
- * @return a context object for subsequent reads
+ * @return the trace time range
+ * @since 2.0
*/
- public ITmfContext seekLocation(ITmfLocation<?> location);
+ TmfTimeRange getTimeRange();
- public ITmfContext seekEvent(ITmfTimestamp timestamp);
+ /**
+ * @return the timestamp of the first trace event
+ * @since 2.0
+ */
+ ITmfTimestamp getStartTime();
- public ITmfContext seekEvent(long rank);
+ /**
+ * @return the timestamp of the last trace event
+ * @since 2.0
+ */
+ ITmfTimestamp getEndTime();
/**
- * Positions the trace at the event located at the specified ratio.
- *
- * Returns a context which can later be used to read the event.
- *
- * @param ratio
- * a floating-point number between 0.0 (beginning) and 1.0 (end)
- * @return a context object for subsequent reads
+ * @return the streaming interval in ms (0 if not a streaming trace)
*/
- public ITmfContext seekLocation(double ratio);
+ long getStreamingInterval();
+
+ // ------------------------------------------------------------------------
+ // Trace positioning getters
+ // ------------------------------------------------------------------------
/**
- * Returns the ratio corresponding to the specified location.
- *
- * @param location
- * a trace location
+ * @return the current trace location
+ */
+ ITmfLocation getCurrentLocation();
+
+ /**
+ * Returns the ratio (proportion) corresponding to the specified location.
+ *
+ * @param location a trace specific location
* @return a floating-point number between 0.0 (beginning) and 1.0 (end)
*/
- public double getLocationRatio(ITmfLocation<?> location);
+ double getLocationRatio(ITmfLocation location);
- public ITmfLocation<?> getCurrentLocation();
+ // ------------------------------------------------------------------------
+ // SeekEvent operations (returning a trace context)
+ // ------------------------------------------------------------------------
/**
- * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event
- * (if any).
- *
- * @param timestamp the requested event timestamp
- * @return the corresponding event rank
+ * Position the trace at the specified (trace specific) location.
+ * <p>
+ * A null location is interpreted as seeking for the first event of the
+ * trace.
+ * <p>
+ * If not null, the location requested must be valid otherwise the returned
+ * context is undefined (up to the implementation to recover if possible).
+ * <p>
+ * @param location the trace specific location
+ * @return a context which can later be used to read the corresponding event
*/
- public long getRank(ITmfTimestamp timestamp);
+ ITmfContext seekEvent(ITmfLocation location);
/**
- * Return the event pointed by the supplied context (or null if no event left) and updates the context to the next
- * event.
- *
- * @return the next event in the stream
+ * Position the trace at the 'rank'th event in the trace.
+ * <p>
+ * A rank <= 0 is interpreted as seeking for the first event of the
+ * trace.
+ * <p>
+ * If the requested rank is beyond the last trace event, the context
+ * returned will yield a null event if used in a subsequent read.
+ *
+ * @param rank the event rank
+ * @return a context which can later be used to read the corresponding event
*/
- public ITmfEvent getNextEvent(ITmfContext context);
+ ITmfContext seekEvent(long rank);
/**
- * Return the event pointed by the supplied context (or null if no event left) and *does not* update the context.
- *
- * @return the next event in the stream
+ * Position the trace at the first event with the specified timestamp. If
+ * there is no event with the requested timestamp, a context pointing to
+ * the next chronological event is returned.
+ * <p>
+ * A null timestamp is interpreted as seeking for the first event of the
+ * trace.
+ * <p>
+ * If the requested timestamp is beyond the last trace event, the context
+ * returned will yield a null event if used in a subsequent read.
+ *
+ * @param timestamp the timestamp of desired event
+ * @return a context which can later be used to read the corresponding event
+ * @since 2.0
*/
- public ITmfEvent parseEvent(ITmfContext context);
+ ITmfContext seekEvent(ITmfTimestamp timestamp);
/**
- * Set the resource used for persistent properties on this trace
- * @param resource the properties resource
+ * Position the trace at the event located at the specified ratio in the
+ * trace file.
+ * <p>
+ * The notion of ratio (0.0 <= r <= 1.0) is trace specific and left
+ * voluntarily vague. Typically, it would refer to the event proportional
+ * rank (arguably more intuitive) or timestamp in the trace file.
+ *
+ * @param ratio the proportional 'rank' in the trace
+ * @return a context which can later be used to read the corresponding event
*/
- public void setResource(IResource resource);
+ ITmfContext seekEvent(double ratio);
/**
- * Get the resource used for persistent properties on this trace
- * @return the properties resource or null if none is set
+ * Returns the initial range offset
+ *
+ * @return the initial range offset
+ * @since 2.0
*/
- public IResource getResource();
+ ITmfTimestamp getInitialRangeOffset();
+
+ /**
+ * Returns the ID of the host this trace is from. The host ID is not
+ * necessarily the hostname, but should be a unique identifier for the
+ * machine on which the trace was taken. It can be used to determine if two
+ * traces were taken on the exact same machine (timestamp are already
+ * synchronized, resources with same id are the same if taken at the same
+ * time, etc).
+ *
+ * @return The host id of this trace
+ * @since 3.0
+ */
+ String getHostId();
+
}
projects / deliverable / tracecompass.git / blobdiff