/*******************************************************************************
- * 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
* 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
+ * Patrick Tasse - Updated for ranks in experiment location
*******************************************************************************/
package org.eclipse.linuxtools.tmf.core.trace;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
+import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Status;
import org.eclipse.linuxtools.internal.tmf.core.trace.TmfExperimentContext;
import org.eclipse.linuxtools.internal.tmf.core.trace.TmfExperimentLocation;
import org.eclipse.linuxtools.internal.tmf.core.trace.TmfLocationArray;
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.TmfClearExperimentSignal;
-import org.eclipse.linuxtools.tmf.core.signal.TmfEndSynchSignal;
-import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentDisposedSignal;
-import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentRangeUpdatedSignal;
-import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentSelectedSignal;
-import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentUpdatedSignal;
import org.eclipse.linuxtools.tmf.core.signal.TmfSignalHandler;
-import org.eclipse.linuxtools.tmf.core.signal.TmfTraceUpdatedSignal;
+import org.eclipse.linuxtools.tmf.core.signal.TmfTraceOpenedSignal;
+import org.eclipse.linuxtools.tmf.core.signal.TmfTraceRangeUpdatedSignal;
+import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
+import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;
+import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimestamp;
+import org.eclipse.linuxtools.tmf.core.trace.indexer.checkpoint.TmfCheckpointIndexer;
+import org.eclipse.linuxtools.tmf.core.trace.location.ITmfLocation;
/**
* TmfExperiment presents a time-ordered, unified view of a set of ITmfTrace:s
// Attributes
// ------------------------------------------------------------------------
- /**
- * The currently selected experiment (null if none)
- */
- protected static TmfExperiment fCurrentExperiment = null;
-
/**
* The set of traces that constitute the experiment
*/
*/
private IFile fBookmarksFile;
-
- // Saved experiment context (optimization)
- private TmfExperimentContext fExperimentContext;
-
// ------------------------------------------------------------------------
// Construction
// ------------------------------------------------------------------------
* @param traces the experiment set of traces
*/
public TmfExperiment(final Class<? extends ITmfEvent> type, final String id, final ITmfTrace[] traces) {
- this(type, id, traces, DEFAULT_INDEX_PAGE_SIZE);
+ this(type, id, traces, DEFAULT_INDEX_PAGE_SIZE, null);
+ }
+
+ /**
+ * Constructor of experiment taking type, path, traces and resource
+ *
+ * @param type
+ * the event type
+ * @param id
+ * the experiment id
+ * @param traces
+ * the experiment set of traces
+ * @param resource
+ * the resource associated to the experiment
+ */
+ public TmfExperiment(final Class<? extends ITmfEvent> type, final String id, final ITmfTrace[] traces, IResource resource) {
+ this(type, id, traces, DEFAULT_INDEX_PAGE_SIZE, resource);
}
+
/**
* @param type the event type
* @param path the experiment path
* @param indexPageSize the experiment index page size
*/
public TmfExperiment(final Class<? extends ITmfEvent> type, final String path, final ITmfTrace[] traces, final int indexPageSize) {
+ this(type, path, traces, indexPageSize, null);
+ }
+
+ /**
+ * Full constructor of an experiment, taking the type, path, traces,
+ * indexPageSize and resource
+ *
+ * @param type
+ * the event type
+ * @param path
+ * the experiment path
+ * @param traces
+ * the experiment set of traces
+ * @param indexPageSize
+ * the experiment index page size
+ * @param resource
+ * the resource associated to the experiment
+ */
+ public TmfExperiment(final Class<? extends ITmfEvent> type, final String path, final ITmfTrace[] traces, final int indexPageSize, IResource resource) {
setCacheSize(indexPageSize);
setStreamingInterval(0);
setIndexer(new TmfCheckpointIndexer(this, indexPageSize));
setParser(this);
try {
- super.initialize(null, path, type);
+ super.initialize(resource, path, type);
} catch (TmfTraceException e) {
e.printStackTrace();
}
fTraces = traces;
- setTimeRange(TmfTimeRange.NULL_RANGE);
}
/**
@Override
public synchronized void dispose() {
- final TmfExperimentDisposedSignal signal = new TmfExperimentDisposedSignal(this, this);
- broadcast(signal);
-
- if (fCurrentExperiment == this) {
- fCurrentExperiment = null;
- }
-
// Clean up the index if applicable
if (getIndexer() != null) {
getIndexer().dispose();
super.dispose();
}
- /**
- * @param signal the clear view signal
- * @since 2.0
- */
- @TmfSignalHandler
- public void handleClearExperimentSignal(TmfClearExperimentSignal signal) {
- dispose();
- }
-
// ------------------------------------------------------------------------
// ITmfTrace - Initializers
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#initTrace(org.eclipse.core.resources.IResource, java.lang.String, java.lang.Class)
- */
@Override
public void initTrace(final IResource resource, final String path, final Class<? extends ITmfEvent> type) {
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#validate(org.eclipse.core.resources.IProject, java.lang.String)
+ /**
+ * @since 2.0
*/
@Override
- public boolean validate(final IProject project, final String path) {
- return true;
+ public IStatus validate(final IProject project, final String path) {
+ return Status.OK_STATUS;
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
/**
- * Selects the current, framework-wide, experiment
- *
- * @param experiment das experiment
- */
- public static void setCurrentExperiment(final TmfExperiment experiment) {
- if (fCurrentExperiment != null && fCurrentExperiment != experiment) {
- fCurrentExperiment.dispose();
- }
- fCurrentExperiment = experiment;
- }
-
- /**
- * @return das experiment
- */
- public static TmfExperiment getCurrentExperiment() {
- return fCurrentExperiment;
- }
-
- /**
- * Get the list of traces. Handle with care...
+ * Get the traces contained in this experiment.
*
- * @return the experiment traces
+ * @return The array of contained traces
*/
public ITmfTrace[] getTraces() {
return fTraces;
*
* @param index the event index (rank)
* @return the corresponding event timestamp
+ * @since 2.0
*/
public ITmfTimestamp getTimestamp(final int index) {
final ITmfContext context = seekEvent(index);
final ITmfEvent event = getNext(context);
+ context.dispose();
return (event != null) ? event.getTimestamp() : null;
}
// Request management
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#armRequest(org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest)
+ /**
+ * @since 2.0
*/
@Override
- protected synchronized ITmfContext armRequest(final ITmfDataRequest request) {
+ public synchronized ITmfContext armRequest(final ITmfDataRequest request) {
// Make sure we have something to read from
if (fTraces == null) {
}
- // Check if we are already at the right index
- if ((fExperimentContext != null) && fExperimentContext.getRank() == request.getIndex()) {
- return fExperimentContext;
- }
-
return seekEvent(request.getIndex());
}
// ITmfTrace trace positioning
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- *
- * Returns a brand new context based on the location provided and
- * initializes the event queues
- *
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfLocation)
+ /**
+ * @since 3.0
*/
@Override
public synchronized ITmfContext seekEvent(final ITmfLocation location) {
return null;
}
- // Instantiate the location
- final TmfExperimentLocation expLocation = (location == null)
- ? new TmfExperimentLocation(new TmfLocationArray(new ITmfLocation[fTraces.length]))
- : (TmfExperimentLocation) location.clone();
+ // Initialize the location array if necessary
+ TmfLocationArray locationArray = ((location == null) ?
+ new TmfLocationArray(fTraces.length) :
+ ((TmfExperimentLocation) location).getLocationInfo());
+
+ ITmfLocation[] locations = locationArray.getLocations();
+ long[] ranks = locationArray.getRanks();
// Create and populate the context's traces contexts
- final TmfExperimentContext context = new TmfExperimentContext(new ITmfContext[fTraces.length]);
+ final TmfExperimentContext context = new TmfExperimentContext(fTraces.length);
+ // Position the traces
+ long rank = 0;
for (int i = 0; i < fTraces.length; i++) {
// Get the relevant trace attributes
- final ITmfLocation trcLocation = expLocation.getLocationInfo().getLocations()[i];
- context.getContexts()[i] = fTraces[i].seekEvent(trcLocation);
- expLocation.getLocationInfo().getLocations()[i] = context.getContexts()[i].getLocation().clone();
- context.getEvents()[i] = fTraces[i].getNext(context.getContexts()[i]);
+ final ITmfContext traceContext = fTraces[i].seekEvent(locations[i]);
+ context.getContexts()[i] = traceContext;
+ traceContext.setRank(ranks[i]);
+ locations[i] = traceContext.getLocation(); // update location after seek
+ context.getEvents()[i] = fTraces[i].getNext(traceContext);
+ rank += ranks[i];
}
// Finalize context
- context.setLocation(expLocation);
+ context.setLocation(new TmfExperimentLocation(new TmfLocationArray(locations, ranks)));
context.setLastTrace(TmfExperimentContext.NO_TRACE);
- context.setRank((location == null) ? 0 : ITmfContext.UNKNOWN_RANK);
+ context.setRank(rank);
- fExperimentContext = context;
return context;
}
// ITmfTrace - SeekEvent operations (returning a trace context)
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(double)
- */
@Override
public ITmfContext seekEvent(final double ratio) {
- final ITmfContext context = seekEvent((long) (ratio * getNbEvents()));
+ final ITmfContext context = seekEvent(Math.round(ratio * getNbEvents()));
return context;
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getLocationRatio(org.eclipse.linuxtools.tmf.core.trace.ITmfLocation)
+ /**
+ * @since 3.0
*/
@Override
public double getLocationRatio(final ITmfLocation location) {
if (location instanceof TmfExperimentLocation) {
- return (double) seekEvent(location).getRank() / getNbEvents();
+ long rank = 0;
+ TmfLocationArray locationArray = ((TmfExperimentLocation) location).getLocationInfo();
+ for (int i = 0; i < locationArray.size(); i++) {
+ rank += locationArray.getRank(i);
+ }
+ return (double) rank / getNbEvents();
}
return 0.0;
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getCurrentLocation()
+ /**
+ * @since 3.0
*/
@Override
public ITmfLocation getCurrentLocation() {
- ITmfLocation[] locations = new ITmfLocation[fTraces.length];
- for (int i = 0; i < fTraces.length; i++) {
- locations[i] = fTraces[i].getCurrentLocation();
- }
- return new TmfExperimentLocation(new TmfLocationArray(locations));
+ // never used
+ return null;
}
// ------------------------------------------------------------------------
// ITmfTrace trace positioning
// ------------------------------------------------------------------------
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfEventParser#parseEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
- */
@Override
public synchronized ITmfEvent parseEvent(final ITmfContext context) {
- final ITmfContext savedContext = context.clone();
- final ITmfEvent event = getNext(savedContext);
+ final ITmfContext tmpContext = seekEvent(context.getLocation());
+ final ITmfEvent event = getNext(tmpContext);
return event;
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#getNext(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
- */
@Override
public synchronized ITmfEvent getNext(ITmfContext context) {
expContext.setLastTrace(trace);
final ITmfContext traceContext = expContext.getContexts()[trace];
- TmfExperimentLocation location = (TmfExperimentLocation) expContext.getLocation();
- if (location != null) {
- location.getLocationInfo().getLocations()[trace] = traceContext.getLocation().clone();
- }
+ // Update the experiment location
+ TmfLocationArray locationArray = new TmfLocationArray(
+ ((TmfExperimentLocation) expContext.getLocation()).getLocationInfo(),
+ trace, traceContext.getLocation(), traceContext.getRank());
+ expContext.setLocation(new TmfExperimentLocation(locationArray));
- fExperimentContext = expContext.clone();
processEvent(event);
}
}
return event;
}
- /* (non-Javadoc)
- * @see java.lang.Object#toString()
+ /**
+ * @since 2.0
*/
+ @Override
+ public ITmfTimestamp getInitialRangeOffset() {
+ if ((fTraces == null) || (fTraces.length == 0)) {
+ return super.getInitialRangeOffset();
+ }
+
+ ITmfTimestamp initTs = TmfTimestamp.BIG_CRUNCH;
+ for (int i = 0; i < fTraces.length; i++) {
+ ITmfTimestamp ts = fTraces[i].getInitialRangeOffset();
+ if (ts.compareTo(initTs) < 0) {
+ initTs = ts;
+ }
+ }
+ return initTs;
+ }
+
@Override
@SuppressWarnings("nls")
public synchronized String toString() {
if (getStreamingInterval() == 0) {
final ITmfContext context = seekEvent(0);
final ITmfEvent event = getNext(context);
+ context.dispose();
if (event == null) {
return;
}
- final TmfTimeRange timeRange = new TmfTimeRange(event.getTimestamp().clone(), TmfTimestamp.BIG_CRUNCH);
- final TmfExperimentRangeUpdatedSignal signal = new TmfExperimentRangeUpdatedSignal(this, this, timeRange);
+ final TmfTimeRange timeRange = new TmfTimeRange(event.getTimestamp(), TmfTimestamp.BIG_CRUNCH);
+ final TmfTraceRangeUpdatedSignal signal = new TmfTraceRangeUpdatedSignal(this, this, timeRange);
// Broadcast in separate thread to prevent deadlock
new Thread() {
}
safeTimestamp = endTimestamp;
if (timeRange != null) {
- final TmfExperimentRangeUpdatedSignal signal =
- new TmfExperimentRangeUpdatedSignal(TmfExperiment.this, TmfExperiment.this, timeRange);
+ final TmfTraceRangeUpdatedSignal signal =
+ new TmfTraceRangeUpdatedSignal(TmfExperiment.this, TmfExperiment.this, timeRange);
broadcast(signal);
}
}
thread.start();
}
- /* (non-Javadoc)
- * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getStreamingInterval()
- */
@Override
public long getStreamingInterval() {
long interval = 0;
// Signal handlers
// ------------------------------------------------------------------------
- private Integer fEndSynchReference;
-
- /**
- * Signal handler for the TmfExperimentSelectedSignal signal
- *
- * @param signal The incoming signal
- */
- @TmfSignalHandler
- public void experimentSelected(final TmfExperimentSelectedSignal signal) {
- final TmfExperiment experiment = signal.getExperiment();
- if (experiment == this) {
- setCurrentExperiment(experiment);
- fEndSynchReference = Integer.valueOf(signal.getReference());
- }
- }
-
- /**
- * Signal handler for the TmfEndSynchSignal signal
- *
- * @param signal The incoming signal
- */
- @TmfSignalHandler
- public void endSync(final TmfEndSynchSignal signal) {
- if (fEndSynchReference != null && fEndSynchReference.intValue() == signal.getReference()) {
- fEndSynchReference = null;
- initializeStreamingMonitor();
- }
- }
-
- /**
- * Signal handler for the TmfTraceUpdatedSignal signal
- *
- * @param signal The incoming signal
- */
+ @Override
@TmfSignalHandler
- public void traceUpdated(final TmfTraceUpdatedSignal signal) {
+ public void traceOpened(TmfTraceOpenedSignal signal) {
if (signal.getTrace() == this) {
- broadcast(new TmfExperimentUpdatedSignal(this, this));
- }
- }
-
- /**
- * Signal handler for the TmfExperimentRangeUpdatedSignal signal
- *
- * @param signal The incoming signal
- */
- @TmfSignalHandler
- public void experimentRangeUpdated(final TmfExperimentRangeUpdatedSignal signal) {
- if (signal.getExperiment() == this) {
- getIndexer().buildIndex(getNbEvents(), signal.getRange(), false);
+ initializeStreamingMonitor();
}
}