/*******************************************************************************
- * Copyright (c) 2009, 2011, 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
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.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>
- * <p>
* The event stream structure in TMF. In its basic form, a trace has:
* <ul>
- * <li> the associated Eclipse resource
- * <li> the path to its location on the file system
+ * <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 (initTace())if they are to be opened from the
- * Project View. Also, a validation (validate()) method has to be provided to
- * ensure that the trace is of the correct type.
+ * 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
* 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>: Read a whole trace
+ * <b>Example 1</b>: Process a whole trace
* <pre>
- * ITmfContext context = trace.seekLocationt(null);
- * ITmfEvent event = trace.getEvent(context);
+ * ITmfContext context = trace.seekEvent(0);
+ * ITmfEvent event = trace.getNext(context);
* while (event != null) {
- * // Do something ...
- * event = trace.getEvent(context);
+ * 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.getEvent(context);
+ * ITmfEvent event = trace.getNext(context);
* while (event != null && nbEventsRead < 50) {
* nbEventsRead++;
- * // Do something ...
- * event = trace.getEvent(context);
+ * processEvent(event);
+ * event = trace.getNext(context);
* }
* </pre>
* <b>Example 3</b>: Process the events between 2 timestamps (inclusive)
* ITmfTimestamp startTime = ...;
* ITmfTimestamp endTime = ...;
* ITmfContext context = trace.seekEvent(startTime);
- * ITmfEvent event = trace.getEvent(context);
+ * ITmfEvent event = trace.getNext(context);
* while (event != null && event.getTimestamp().compareTo(endTime) <= 0) {
- * // Do something ...
- * event = trace.getEvent(context);
+ * 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 ITmfDataProvider<T> {
+public interface ITmfTrace extends ITmfDataProvider {
+
+ // ------------------------------------------------------------------------
+ // Constants
+ // ------------------------------------------------------------------------
+
+ /**
+ * The default trace cache size
+ */
+ public static final int DEFAULT_TRACE_CACHE_SIZE = 1000;
// ------------------------------------------------------------------------
// 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 FileNotFoundException
+ * @throws TmfTraceException If we couldn't open the trace
*/
- public void initTrace(IResource resource, String path, Class<T> type) throws FileNotFoundException;
+ public void initTrace(IResource resource, String path, Class<? extends ITmfEvent> type) throws TmfTraceException;
/**
* Validate that the trace is of the correct type.
- *
+ *
* @param project the eclipse project
* @param path the trace path
- *
+ *
* @return true if trace is valid
+ * @since 2.0
*/
- public boolean validate(IProject project, String path);
+ public IStatus validate(IProject project, String path);
// ------------------------------------------------------------------------
// Basic getters
// ------------------------------------------------------------------------
+ /**
+ * If this trace is used as a container for sub-traces, this can be used to
+ * get the sub-traces themselves. If the trace is stand-alone, this should
+ * return an array with only "this" inside. For this reason, be careful if
+ * calling this recursively.
+ *
+ * This offers a standard way of iterating through compound traces (like
+ * experiments).
+ *
+ * @return The array of sub-traces.
+ * @since 2.0
+ */
+ public ITmfTrace[] getTraces();
+
/**
* @return the trace event type
*/
- public Class<T> getType();
+ public Class<? extends ITmfEvent> getEventType();
/**
* @return the associated trace resource
*/
public int getCacheSize();
+ /**
+ * @return The statistics provider for this trace
+ * @since 2.0
+ */
+ public ITmfStatistics getStatistics();
+
+ /**
+ * 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 Map<String, ITmfStateSystem> getStateSystems();
+
+ /**
+ * 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 void registerStateSystem(String id, ITmfStateSystem ss);
+
// ------------------------------------------------------------------------
// Trace characteristics getters
// ------------------------------------------------------------------------
/**
* @return the trace time range
+ * @since 2.0
*/
public TmfTimeRange getTimeRange();
/**
* @return the timestamp of the first trace event
+ * @since 2.0
*/
public ITmfTimestamp getStartTime();
/**
* @return the timestamp of the last trace event
+ * @since 2.0
*/
public ITmfTimestamp getEndTime();
+ /**
+ * @return the streaming interval in ms (0 if not a streaming trace)
+ */
+ public long getStreamingInterval();
+
// ------------------------------------------------------------------------
// Trace positioning getters
// ------------------------------------------------------------------------
/**
* @return the current trace location
*/
- public ITmfLocation<?> getCurrentLocation();
+ public 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);
+ public double getLocationRatio(ITmfLocation location);
// ------------------------------------------------------------------------
- // Seek operations (returning a reading context)
+ // SeekEvent operations (returning a trace context)
// ------------------------------------------------------------------------
/**
- * Position the trace at the specified location. The null location
- * is used to indicate that the first trace event is requested.
+ * 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>
- * <ul>
- * <li> a <b>null</b> location returns the context of the first event
- * <li> an invalid location, including beyond the last event, returns a null context
- * </ul>
+ * 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 (null for 1st event)
+ * @param location the trace specific location
* @return a context which can later be used to read the corresponding event
*/
- public ITmfContext seekLocation(ITmfLocation<?> location);
+ public ITmfContext seekEvent(ITmfLocation location);
/**
- * Position the trace at the event located at the specified ratio in the
- * trace file.
+ * Position the trace at the 'rank'th event in the trace.
* <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
+ * 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 ITmfContext seekLocation(double ratio);
+ public ITmfContext seekEvent(long rank);
/**
* Position the trace at the first event with the specified timestamp. If
* <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 ITmfContext seekEvent(ITmfTimestamp timestamp);
/**
- * Position the trace at the 'rank'th event in the trace.
+ * Position the trace at the event located at the specified ratio in the
+ * trace file.
* <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
+ * 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 ITmfContext seekEvent(long rank);
-
- // ------------------------------------------------------------------------
- // Read operations (returning an actual event)
- // ------------------------------------------------------------------------
+ public ITmfContext seekEvent(double ratio);
/**
- * Return the event pointed by the supplied context (or null if no event
- * left) and updates the context to point the next event.
- *
- * @param context the read context (will be updated)
- * @return the event pointed to by the context
+ * Returns the initial range offset
+ *
+ * @return the initial range offset
+ * @since 2.0
*/
- public ITmfEvent getNextEvent(ITmfContext context);
+ public ITmfTimestamp getInitialRangeOffset();
/**
- * Return the event pointed by the supplied context (or null if no event
- * left) and *does not* update the context.
- *
- * @param context the read context
- * @return the next event in the stream
+ * Return the current selected time.
+ *
+ * @return the current time stamp
+ * @since 2.0
*/
- public ITmfEvent parseEvent(ITmfContext context);
-
- // ------------------------------------------------------------------------
- // ------------------------------------------------------------------------
+ public ITmfTimestamp getCurrentTime();
/**
- * @return the streaming interval in ms (0 if not a streaming trace)
+ * Return the current selected range.
+ *
+ * @return the current time range
+ * @since 2.0
*/
- public long getStreamingInterval();
-
+ public TmfTimeRange getCurrentRange();
}
projects / deliverable / tracecompass.git / blobdiff