import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;
-import org.eclipse.core.runtime.IPath;
-import org.eclipse.linuxtools.ctf.core.event.EventDeclaration;
-import org.eclipse.linuxtools.ctf.core.event.EventDefinition;
import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException;
import org.eclipse.linuxtools.ctf.core.trace.CTFTrace;
-import org.eclipse.linuxtools.tmf.core.component.TmfEventProvider;
import org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfTimestamp.TimestampType;
-import org.eclipse.linuxtools.tmf.core.event.ITmfEventField;
import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
-import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
+import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
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.TmfSignal;
-import org.eclipse.linuxtools.tmf.core.signal.TmfSignalManager;
import org.eclipse.linuxtools.tmf.core.statesystem.IStateSystemQuerier;
import org.eclipse.linuxtools.tmf.core.trace.ITmfContext;
+import org.eclipse.linuxtools.tmf.core.trace.ITmfEventParser;
import org.eclipse.linuxtools.tmf.core.trace.ITmfLocation;
-import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
+import org.eclipse.linuxtools.tmf.core.trace.TmfTrace;
/**
+ * The CTf trace handler
+ *
+ * @version 1.0
+ * @author Matthew khouzam
*/
-public class CtfTmfTrace extends TmfEventProvider<CtfTmfEvent> implements ITmfTrace<CtfTmfEvent> {
-
- // ------------------------------------------------------------------------
- // Constants
- // ------------------------------------------------------------------------
+public class CtfTmfTrace extends TmfTrace implements ITmfEventParser {
- // ------------------------------------------------------------------------
- // Attributes
- // ------------------------------------------------------------------------
-
- // the Ctf Trace
- private CTFTrace fTrace;
- // The number of events collected
- protected long fNbEvents = 0;
-
- // The time span of the event stream
- private ITmfTimestamp fStartTime = TmfTimestamp.BIG_CRUNCH;
- private ITmfTimestamp fEndTime = TmfTimestamp.BIG_BANG;
+ //-------------------------------------------
+ // Constants
+ //-------------------------------------------
+ /**
+ * Default cache size for CTF traces
+ */
+ protected static final int DEFAULT_CACHE_SIZE = 50000;
- // The trace resource
- private IResource fResource;
+ //-------------------------------------------
+ // Fields
+ //-------------------------------------------
- /* Reference to the state system assigned to this trace */
+ /** Reference to the state system assigned to this trace */
protected IStateSystemQuerier ss = null;
- // ------------------------------------------------------------------------
- // Constructors
- // ------------------------------------------------------------------------
+ /* Reference to the CTF Trace */
+ private CTFTrace fTrace;
+
- public CtfTmfTrace() {
- super();
- }
+ //-------------------------------------------
+ // TmfTrace Overrides
+ //-------------------------------------------
/**
* Method initTrace.
- * @param resource IResource
- * @param path String
- * @param eventType Class<CtfTmfEvent>
+ *
+ * @param resource
+ * The resource associated with this trace
+ * @param path
+ * The path to the trace file
+ * @param eventType
+ * The type of events that will be read from this trace
* @throws TmfTraceException
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#initTrace(IResource, String, Class<CtfTmfEvent>)
+ * If something when wrong while reading the trace
*/
@Override
- public void initTrace(final IResource resource, final String path, final Class<CtfTmfEvent> eventType)
+ public void initTrace(final IResource resource, final String path, final Class<? extends ITmfEvent> eventType)
throws TmfTraceException {
- EventDeclaration ed;
- ITmfEventField eventField;
+ /*
+ * Set the cache size. This has to be done before the call to super()
+ * because the super needs to know the cache size.
+ */
+ setCacheSize();
+ super.initTrace(resource, path, eventType);
+
@SuppressWarnings("unused")
CtfTmfEventType type;
- this.fResource = resource;
try {
this.fTrace = new CTFTrace(path);
- for( int i =0 ; i< this.fTrace.getNbEventTypes(); i++) {
- ed = this.fTrace.getEventType(i);
- eventField = parseDeclaration(ed);
- /*
- * Populate the event manager with event types that are there in
- * the beginning.
- */
- type = new CtfTmfEventType(ed.getName(), eventField);
- }
-
+ CtfIteratorManager.addTrace(this);
+ CtfTmfLightweightContext ctx;
/* Set the start and (current) end times for this trace */
- final CtfIterator iterator = new CtfIterator(this, 0, 0);
- if(iterator.getLocation().equals(CtfIterator.NULL_LOCATION)) {
+ ctx = (CtfTmfLightweightContext) seekEvent(0L);
+ CtfTmfEvent event = getNext(ctx);
+ if((ctx.getLocation().equals(CtfIterator.NULL_LOCATION)) || (ctx.getCurrentEvent() == null)) {
/* Handle the case where the trace is empty */
this.setStartTime(TmfTimestamp.BIG_BANG);
} else {
- this.setStartTime(iterator.getCurrentEvent().getTimestamp());
- iterator.goToLastEvent();
- this.setEndTime(iterator.getCurrentEvent().getTimestamp());
+ final ITmfTimestamp curTime = event.getTimestamp();
+ this.setStartTime(curTime);
+ this.setEndTime(curTime);
}
} catch (final CTFReaderException e) {
* was not found or was not recognized as a CTF trace. Throw into
* the new type of exception expected by the rest of TMF.
*/
- throw new TmfTraceException(e.getMessage());
+ throw new TmfTraceException(e.getMessage(), e);
}
- TmfSignalManager.register(this);
//FIXME This should be called via the ExperimentUpdated signal
buildStateSystem();
try {
resource.getProject().refreshLocal(IResource.DEPTH_INFINITE, null);
} catch (CoreException e) {
- throw new TmfTraceException(e.getMessage());
+ throw new TmfTraceException(e.getMessage(), e);
}
}
}
- private static ITmfEventField parseDeclaration(EventDeclaration ed) {
- EventDefinition eventDef = ed.createDefinition(null);
- return new CtfTmfContent(ITmfEventField.ROOT_FIELD_ID,
- CtfTmfEvent.parseFields(eventDef));
- }
-
- /**
- * Method dispose.
- * @see org.eclipse.linuxtools.tmf.core.component.ITmfComponent#dispose()
+ /* (non-Javadoc)
+ * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#dispose()
*/
@Override
- public void dispose() {
- TmfSignalManager.deregister(this);
- }
-
- /**
- * Method broadcast.
- * @param signal TmfSignal
- * @see org.eclipse.linuxtools.tmf.core.component.ITmfComponent#broadcast(TmfSignal)
- */
- @Override
- public void broadcast(final TmfSignal signal) {
- TmfSignalManager.dispatchSignal(signal);
+ public synchronized void dispose() {
+ CtfIteratorManager.removeTrace(this);
+ super.dispose();
}
/**
}
}
- // ------------------------------------------------------------------------
- // Accessors
- // ------------------------------------------------------------------------
-
/**
- * Method getEventType.
- * @return the trace path
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEventType()
+ * Method getCurrentLocation. This is not applicable in CTF
+ * @return null, since the trace has no knowledge of the current location
+ * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getCurrentLocation()
*/
@Override
- public Class<CtfTmfEvent> getEventType() {
- return fType;
+ public ITmfLocation getCurrentLocation() {
+ return null;
}
- /**
- * Method getNbEnvVars.
- * @return int
- */
- public int getNbEnvVars() {
- return this.fTrace.getEnvironment().size();
- }
- /**
- * Method getEnvNames.
- * @return String[]
- */
- public String[] getEnvNames() {
- final String[] s = new String[getNbEnvVars()];
- return this.fTrace.getEnvironment().keySet().toArray(s);
+ @Override
+ public double getLocationRatio(ITmfLocation location) {
+ final CtfLocation curLocation = (CtfLocation) location;
+ final CtfTmfLightweightContext context = new CtfTmfLightweightContext(this);
+ context.setLocation(curLocation);
+ context.seek(curLocation.getLocationData());
+ final CtfLocationData currentTime = ((CtfLocationData)context.getLocation().getLocationData());
+ final long startTime = getIterator(this, context).getStartTime();
+ final long endTime = getIterator(this, context).getEndTime();
+ return ((double) currentTime.getTimestamp() - startTime)
+ / (endTime - startTime);
}
- /**
- * Method getEnvValue.
- * @param key String
- * @return String
- */
- public String getEnvValue(final String key) {
- return this.fTrace.getEnvironment().get(key);
- }
- /**
- * @return the trace path * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getPath()
- */
- @Override
- public String getPath() {
- return this.fTrace.getPath();
- }
- /**
- * Method getName.
- * @return String
- * @see org.eclipse.linuxtools.tmf.core.component.ITmfComponent#getName()
+ /* (non-Javadoc)
+ * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp)
*/
@Override
- public String getName() {
- String traceName = (fResource != null) ? fResource.getName() : null;
- // If no resource was provided, extract the display name the trace path
- if (traceName == null) {
- final String path = this.fTrace.getPath();
- final int sep = path.lastIndexOf(IPath.SEPARATOR);
- traceName = (sep >= 0) ? path.substring(sep + 1) : path;
+ public synchronized ITmfContext seekEvent(ITmfTimestamp timestamp) {
+ if( timestamp instanceof CtfTmfTimestamp){
+ CtfTmfLightweightContext iter = new CtfTmfLightweightContext(this);
+ iter.seek(timestamp.getValue());
+ return iter;
}
- return traceName;
- }
-
- /**
- * Method getCacheSize.
- * @return int
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getCacheSize()
- */
- @Override
- public int getCacheSize() {
- return 50000; // not true, but it works
- }
-
- /**
- * Method getNbEvents.
- * @return long
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNbEvents()
- */
- @Override
- public long getNbEvents() {
- return this.fNbEvents;
+ return super.seekEvent(timestamp);
}
/**
- * Method getTimeRange.
- * @return TmfTimeRange
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getTimeRange()
+ * Method seekEvent.
+ * @param location ITmfLocation<?>
+ * @return ITmfContext
*/
@Override
- public TmfTimeRange getTimeRange() {
- return new TmfTimeRange(this.fStartTime, this.fEndTime);
+ public ITmfContext seekEvent(final ITmfLocation location) {
+ CtfLocation currentLocation = (CtfLocation) location;
+ CtfTmfLightweightContext context = new CtfTmfLightweightContext(this);
+ /*
+ * The rank is set to 0 if the iterator seeks the beginning. If not, it
+ * will be set to UNKNOWN_RANK, since CTF traces don't support seeking
+ * by rank for now.
+ */
+ if (currentLocation == null) {
+ currentLocation = new CtfLocation(new CtfLocationData(0L, 0L));
+ context.setRank(0);
+ }
+ if (currentLocation.getLocationData() == CtfLocation.INVALID_LOCATION) {
+ ((CtfTmfTimestamp) getEndTime()).setType(TimestampType.NANOS);
+ currentLocation.setLocation(getEndTime().getValue() + 1, 0L);
+ }
+ context.setLocation(currentLocation);
+ if (location == null) {
+ CtfTmfEvent event = getIterator(this, context).getCurrentEvent();
+ if (event != null) {
+ currentLocation.setLocation(event.getTimestamp().getValue(), 0);
+ }
+ }
+ if(context.getRank() != 0) {
+ context.setRank(ITmfContext.UNKNOWN_RANK);
+ }
+ return context;
}
- /**
- * Method getStartTime.
- * @return ITmfTimestamp
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStartTime()
- */
- @Override
- public ITmfTimestamp getStartTime() {
- return this.fStartTime;
- }
- /**
- * Method getEndTime.
- * @return ITmfTimestamp
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEndTime()
- */
@Override
- public ITmfTimestamp getEndTime() {
- return this.fEndTime;
+ public ITmfContext seekEvent(double ratio) {
+ CtfTmfLightweightContext context = new CtfTmfLightweightContext(this);
+ final long end = this.getEndTime().getValue();
+ final long start = this.getStartTime().getValue();
+ final long diff = end - start;
+ final long ratioTs = (long) (diff * ratio) + start;
+ context.seek(ratioTs);
+ context.setRank(ITmfContext.UNKNOWN_RANK);
+ return context;
}
/**
- * Method getCurrentLocation. This is not applicable in CTF
- * @return null, since the trace has no knowledge of the current location
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getCurrentLocation()
+ * Method readNextEvent.
+ * @param context ITmfContext
+ * @return CtfTmfEvent
+ * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNext(ITmfContext)
*/
@Override
- public ITmfLocation<?> getCurrentLocation() {
- return null;
- }
+ public synchronized CtfTmfEvent getNext(final ITmfContext context) {
+ CtfTmfEvent event = null;
+ if (context instanceof CtfTmfLightweightContext) {
+ if (CtfLocation.INVALID_LOCATION.equals(context.getLocation().getLocationData())) {
+ return null;
+ }
+ CtfTmfLightweightContext ctfContext = (CtfTmfLightweightContext) context;
+ event = ctfContext.getCurrentEvent();
- // ------------------------------------------------------------------------
- // Operators
- // ------------------------------------------------------------------------
+ if (event != null) {
+ updateAttributes(context, event.getTimestamp());
+ ctfContext.advance();
+ ctfContext.increaseRank();
+ }
+ }
- /**
- * Method setTimeRange.
- * @param range TmfTimeRange
- */
- protected void setTimeRange(final TmfTimeRange range) {
- this.fStartTime = range.getStartTime();
- this.fEndTime = range.getEndTime();
+ return event;
}
/**
- * Method setStartTime.
- * @param startTime ITmfTimestamp
+ * Suppressing the warning, because the 'throws' will usually happen in
+ * sub-classes.
+ *
+ * @throws TmfTraceException
*/
- protected void setStartTime(final ITmfTimestamp startTime) {
- this.fStartTime = startTime;
+ @SuppressWarnings("unused")
+ protected void buildStateSystem() throws TmfTraceException {
+ /*
+ * Nothing is done in the basic implementation, please specify
+ * how/if to build a state system in derived classes.
+ */
+ return;
}
/**
- * Method setEndTime.
- * @param endTime ITmfTimestamp
+ * Method getStateSystem.
+ *
+ * @return IStateSystemQuerier
*/
- protected void setEndTime(final ITmfTimestamp endTime) {
- this.fEndTime = endTime;
+ public IStateSystemQuerier getStateSystem() {
+ return this.ss;
}
- // ------------------------------------------------------------------------
- // TmfProvider
- // ------------------------------------------------------------------------
-
/**
- * Method armRequest.
- * @param request ITmfDataRequest<CtfTmfEvent>
- * @return ITmfContext
+ * gets the CTFtrace that this is wrapping
+ * @return the CTF trace
*/
- @Override
- public ITmfContext armRequest(final ITmfDataRequest<CtfTmfEvent> request) {
- if ((request instanceof ITmfEventRequest<?>)
- && !TmfTimestamp.BIG_BANG
- .equals(((ITmfEventRequest<CtfTmfEvent>) request)
- .getRange().getStartTime())
- && (request.getIndex() == 0)) {
- final ITmfContext context = seekEvent(((ITmfEventRequest<CtfTmfEvent>) request)
- .getRange().getStartTime());
- ((ITmfEventRequest<CtfTmfEvent>) request)
- .setStartIndex((int) context.getRank());
- return context;
- }
- return seekEvent(request.getIndex());
+ public CTFTrace getCTFTrace() {
+ return fTrace;
}
-// /**
-// * The trace reader keeps its own iterator: the "context" parameter here
-// * will be ignored.
-// *
-// * If you wish to specify a new context, instantiate a new CtfIterator and
-// * seek() it to where you want, and use that to read events.
-// *
-// * FIXME merge with getNextEvent below once they both use the same parameter
-// * type.
-// * @param context ITmfContext
-// * @return CtfTmfEvent
-// */
-// @Override
-// public CtfTmfEvent getNext(final ITmfContext context) {
-// return readNextEvent(context);
-// }
-
- // ------------------------------------------------------------------------
- // ITmfTrace
- // ------------------------------------------------------------------------
+ //-------------------------------------------
+ // Environment Parameters
+ //-------------------------------------------
/**
- * Method seekEvent.
- * @param location ITmfLocation<?>
- * @return ITmfContext
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(ITmfLocation<?>)
+ * Method getNbEnvVars.
+ *
+ * @return int
*/
- @Override
- public ITmfContext seekEvent(final ITmfLocation<?> location) {
- CtfLocation currentLocation = (CtfLocation) location;
- if (currentLocation == null) {
- currentLocation = new CtfLocation(0L);
- }
- CtfIterator context = new CtfIterator(this);
-
- if (currentLocation.getLocation() == CtfLocation.INVALID_LOCATION) {
- ((CtfTmfTimestamp)getEndTime()).setType(TimestampType.NANOS);
- currentLocation.setLocation( getEndTime().getValue() + 1);
- }
- context.setLocation(currentLocation);
- context.setRank(ITmfContext.UNKNOWN_RANK);
- return context;
+ public int getNbEnvVars() {
+ return this.fTrace.getEnvironment().size();
}
/**
- * Method getLocationRatio.
- * @param location ITmfLocation<?>
- * @return double
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getLocationRatio(ITmfLocation<?>)
+ * Method getEnvNames.
+ *
+ * @return String[]
*/
- @Override
- public double getLocationRatio(final ITmfLocation<?> location) {
- final CtfLocation curLocation = (CtfLocation) location;
- CtfIterator iterator = new CtfIterator(this);
- iterator.seek(curLocation.getLocation());
- return ((double) iterator.getCurrentEvent().getTimestampValue() - iterator
- .getStartTime())
- / (iterator.getEndTime() - iterator.getStartTime());
+ public String[] getEnvNames() {
+ final String[] s = new String[getNbEnvVars()];
+ return this.fTrace.getEnvironment().keySet().toArray(s);
}
/**
- * Method getStreamingInterval.
- * @return long
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStreamingInterval()
+ * Method getEnvValue.
+ *
+ * @param key
+ * String
+ * @return String
*/
- @Override
- public long getStreamingInterval() {
- return 0;
+ public String getEnvValue(final String key) {
+ return this.fTrace.getEnvironment().get(key);
}
- /**
- * Method seekEvent.
- * @param timestamp ITmfTimestamp
- * @return ITmfContext
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(ITmfTimestamp)
- */
- @Override
- public ITmfContext seekEvent(final ITmfTimestamp timestamp) {
- CtfIterator context = new CtfIterator(this);
- context.seek(timestamp.getValue());
- context.setRank(ITmfContext.UNKNOWN_RANK);
- return context;
- }
+ //-------------------------------------------
+ // Clocks
+ //-------------------------------------------
/**
- * Seek by rank
- * @param rank long
- * @return ITmfContext
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(long)
+ * gets the clock offset
+ * @return the clock offset in ns
*/
- @Override
- public ITmfContext seekEvent(final long rank) {
- CtfIterator context = new CtfIterator(this);
- context.seekRank(rank);
- context.setRank(rank);
- return context;
+ public long getOffset(){
+ if( fTrace != null ) {
+ return fTrace.getOffset();
+ }
+ return 0;
}
- /**
- * Seek rank ratio
- * @param ratio double
- * @return ITmfContext
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(double)
- */
- @Override
- public ITmfContext seekEvent(final double ratio) {
- CtfIterator context = new CtfIterator(this);
- context.seek((long) (this.fNbEvents * ratio));
- context.setRank(ITmfContext.UNKNOWN_RANK);
- return context;
- }
+ //-------------------------------------------
+ // Parser
+ //-------------------------------------------
- /**
- * Method readNextEvent.
- * @param context ITmfContext
- * @return CtfTmfEvent
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNext(ITmfContext)
- */
@Override
- public CtfTmfEvent getNext(final ITmfContext context) {
+ public CtfTmfEvent parseEvent(ITmfContext context) {
CtfTmfEvent event = null;
- if (context instanceof CtfIterator) {
- CtfIterator ctfIterator = (CtfIterator) context;
- event = ctfIterator.getCurrentEvent();
- ctfIterator.advance();
+ if( context instanceof CtfTmfLightweightContext ){
+ CtfTmfLightweightContext itt = (CtfTmfLightweightContext) context.clone();
+ event = itt.getCurrentEvent();
}
return event;
}
/**
- * Method getResource.
- * @return IResource
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getResource()
+ * Sets the cache size for a CtfTmfTrace.
*/
- @Override
- public IResource getResource() {
- return this.fResource;
+ protected void setCacheSize() {
+ setCacheSize(DEFAULT_CACHE_SIZE);
}
- /**
- * Method getStateSystem.
- * @return IStateSystemQuerier
- */
- public IStateSystemQuerier getStateSystem() {
- return this.ss;
- }
+ //-------------------------------------------
+ // Helpers
+ //-------------------------------------------
- /**
- * Method getCTFTrace.
- * @return CTFTrace
- */
- CTFTrace getCTFTrace() {
- return fTrace;
+ private static CtfIterator getIterator(CtfTmfTrace trace, CtfTmfLightweightContext context) {
+ return CtfIteratorManager.getIterator(trace, context);
}
-
-
- /**
- * Suppressing the warning, because the 'throws' will usually happen in
- * sub-classes.
- * @throws TmfTraceException
- */
- protected void buildStateSystem() throws TmfTraceException {
- /*
- * Nothing is done in the basic implementation, please specify
- * how/if to build a state system in derived classes.
- */
- return;
- }
-
}