* Contributors: Matthew Khouzam - Initial API and implementation
*******************************************************************************/
+
package org.eclipse.linuxtools.tmf.core.ctfadaptor;
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.event.ITmfTimestamp;
-import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
+import org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfTimestamp.TimestampType;
+import org.eclipse.linuxtools.tmf.core.event.ITmfEventField;
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;
-
-/**
- */
-public class CtfTmfTrace extends TmfEventProvider<CtfTmfEvent> implements ITmfTrace<CtfTmfEvent> {
-
- // ------------------------------------------------------------------------
- // Constants
- // ------------------------------------------------------------------------
-
- // ------------------------------------------------------------------------
- // Attributes
- // ------------------------------------------------------------------------
-
- // the Ctf Trace
- private CTFTrace fTrace;
-
- // The number of events collected
- protected long fNbEvents = 0;
+import org.eclipse.linuxtools.tmf.core.trace.TmfTrace;
- // The time span of the event stream
- private ITmfTimestamp fStartTime = TmfTimestamp.BIG_CRUNCH;
- private ITmfTimestamp fEndTime = TmfTimestamp.BIG_BANG;
+public class CtfTmfTrace extends TmfTrace<CtfTmfEvent> implements ITmfEventParser<CtfTmfEvent>{
- // The trace resource
- private IResource fResource;
-
- /*
- * Since in TMF, "traces" can read events, this trace here will have its own
- * iterator. The user can instantiate extra iterator if they want to seek at
- * many places at the same time.
+ //-------------------------------------------
+ // Constants
+ //-------------------------------------------
+ /**
+ * Default cache size for CTF traces
*/
- protected CtfIterator iterator;
+ protected static final int DEFAULT_CACHE_SIZE = 50000;
+
+ //-------------------------------------------
+ // Fields
+ //-------------------------------------------
- /* Reference to the state system assigned to this trace */
+ /** Reference to the state system assigned to this trace */
protected IStateSystemQuerier ss = null;
- // ------------------------------------------------------------------------
- // Constructors
- // ------------------------------------------------------------------------
-
- public CtfTmfTrace() {
- super();
- }
+ /* Reference to the CTF Trace */
+ private CTFTrace fTrace;
+ //-------------------------------------------
+ // TmfTrace Overrides
+ //-------------------------------------------
/**
* Method initTrace.
* @param resource IResource
* @throws TmfTraceException
* @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#initTrace(IResource, String, Class<CtfTmfEvent>)
*/
- @SuppressWarnings("unused")
@Override
public void initTrace(final IResource resource, final String path, final Class<CtfTmfEvent> eventType)
throws TmfTraceException {
- this.fResource = resource;
+ /*
+ * 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);
+ EventDeclaration ed;
+ ITmfEventField eventField;
+
+ @SuppressWarnings("unused")
+ CtfTmfEventType type;
+
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);
+ }
+
+ /* 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)) {
+ /* Handle the case where the trace is empty */
+ this.setStartTime(TmfTimestamp.BIG_BANG);
+ } else {
+ this.setStartTime(iterator.getCurrentEvent().getTimestamp());
+ this.setEndTime(iterator.getCurrentEvent().getTimestamp());
+ }
+
} catch (final CTFReaderException e) {
/*
* If it failed at the init(), we can assume it's because the file
* 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());
- }
- this.iterator = new CtfIterator(this, 0, 0);
- setStartTime(TmfTimestamp.BIG_BANG);
- if( !this.iterator.getLocation().equals(CtfIterator.nullLocation)) {
- setStartTime(iterator.getCurrentEvent().getTimestamp());
+ throw new TmfTraceException(e.getMessage(), e);
}
- TmfSignalManager.register(this);
- // FIXME this should become a request
+
+ //FIXME This should be called via the ExperimentUpdated signal
buildStateSystem();
/* Refresh the project, so it can pick up new files that got created. */
try {
resource.getProject().refreshLocal(IResource.DEPTH_INFINITE, null);
} catch (CoreException e) {
- throw new TmfTraceException(e.getMessage());
+ throw new TmfTraceException(e.getMessage(), e);
}
}
}
- /**
- * Method dispose.
- * @see org.eclipse.linuxtools.tmf.core.component.ITmfComponent#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);
- }
-
/**
* Method validate.
* @param project IProject
* @return boolean
* @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#validate(IProject, String)
*/
- @SuppressWarnings("unused")
@Override
- public boolean validate(final IProject project, final String path) {
+ public boolean validate(@SuppressWarnings("unused") final IProject project, final String path) {
try {
final CTFTrace temp = new CTFTrace(path);
return temp.majortIsSet(); // random test
}
}
- // ------------------------------------------------------------------------
- // Accessors
- // ------------------------------------------------------------------------
-
- /**
- * Method getEventType.
- * @return the trace path
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEventType()
- */
- @Override
- public Class<CtfTmfEvent> getEventType() {
- return fType;
- }
-
/**
- * 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);
- }
-
- /**
- * 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()
- */
- @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;
- }
- 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;
- }
-
- /**
- * Method getTimeRange.
- * @return TmfTimeRange
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getTimeRange()
- */
- @Override
- public TmfTimeRange getTimeRange() {
- return new TmfTimeRange(this.fStartTime, this.fEndTime);
- }
-
- /**
- * 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;
- }
-
- /**
- * Method getCurrentLocation.
- * @return ITmfLocation<?>
+ * 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 ITmfLocation<?> getCurrentLocation() {
- return iterator.getLocation();
- }
-
- // ------------------------------------------------------------------------
- // Operators
- // ------------------------------------------------------------------------
-
- /**
- * Method setTimeRange.
- * @param range TmfTimeRange
- */
- protected void setTimeRange(final TmfTimeRange range) {
- this.fStartTime = range.getStartTime();
- this.fEndTime = range.getEndTime();
- }
-
- /**
- * Method setStartTime.
- * @param startTime ITmfTimestamp
- */
- protected void setStartTime(final ITmfTimestamp startTime) {
- this.fStartTime = startTime;
- }
-
- /**
- * Method setEndTime.
- * @param endTime ITmfTimestamp
- */
- protected void setEndTime(final ITmfTimestamp endTime) {
- this.fEndTime = endTime;
+ return null;
}
- // ------------------------------------------------------------------------
- // TmfProvider
- // ------------------------------------------------------------------------
- /**
- * Method armRequest.
- * @param request ITmfDataRequest<CtfTmfEvent>
- * @return ITmfContext
- */
- @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());
- }
- /**
- * 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
- */
- @SuppressWarnings("unused")
@Override
- public CtfTmfEvent getNext(final ITmfContext context) {
- iterator.advance();
- return iterator.getCurrentEvent();
+ public double getLocationRatio(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());
}
- // ------------------------------------------------------------------------
- // ITmfTrace
- // ------------------------------------------------------------------------
-
/**
* Method seekEvent.
* @param location ITmfLocation<?>
@Override
public ITmfContext seekEvent(final ITmfLocation<?> location) {
CtfLocation currentLocation = (CtfLocation) location;
+ CtfIterator context = new CtfIterator(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(0L);
+ context.setRank(0);
}
- if( !iterator.getLocation().equals(CtfIterator.nullLocation)) {
- iterator.setLocation(currentLocation);
+ if (currentLocation.getLocation() == CtfLocation.INVALID_LOCATION) {
+ ((CtfTmfTimestamp) getEndTime()).setType(TimestampType.NANOS);
+ currentLocation.setLocation(getEndTime().getValue() + 1);
}
- return iterator;
+ context.setLocation(currentLocation);
+ if(context.getRank() != 0)
+ context.setRank(ITmfContext.UNKNOWN_RANK);
+ return context;
}
- /**
- * Method getLocationRatio.
- * @param location ITmfLocation<?>
- * @return double
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getLocationRatio(ITmfLocation<?>)
- */
+
@Override
- public double getLocationRatio(final ITmfLocation<?> location) {
- final CtfLocation curLocation = (CtfLocation) location;
- iterator.seek(curLocation.getLocation());
- return ((double) iterator.getCurrentEvent().getTimestampValue() - iterator
- .getStartTime())
- / (iterator.getEndTime() - iterator.getStartTime());
+ public ITmfContext seekEvent(double ratio) {
+ CtfIterator context = new CtfIterator(this);
+ context.seek((long) (this.getNbEvents() * ratio));
+ context.setRank(ITmfContext.UNKNOWN_RANK);
+ return context;
}
/**
- * Method getStreamingInterval.
- * @return long
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStreamingInterval()
+ * Method readNextEvent.
+ * @param context ITmfContext
+ * @return CtfTmfEvent
+ * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNext(ITmfContext)
*/
@Override
- public long getStreamingInterval() {
- return 0;
+ public synchronized CtfTmfEvent getNext(final ITmfContext context) {
+ CtfTmfEvent event = null;
+ if (context instanceof CtfIterator) {
+ CtfIterator ctfIterator = (CtfIterator) context;
+ event = ctfIterator.getCurrentEvent();
+
+ if (event != null) {
+ updateAttributes(context, event.getTimestamp());
+ ctfIterator.advance();
+ ctfIterator.increaseRank();
+ }
+ }
+
+ return event;
}
/**
- * Method seekEvent.
- * @param timestamp ITmfTimestamp
- * @return ITmfContext
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(ITmfTimestamp)
+ * Suppressing the warning, because the 'throws' will usually happen in
+ * sub-classes.
+ * @throws TmfTraceException
*/
- @Override
- public ITmfContext seekEvent(final ITmfTimestamp timestamp) {
- iterator.seek(timestamp.getValue());
- return iterator;
+ @SuppressWarnings({ "static-method", "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;
}
/**
- * Seek by rank
- * @param rank long
- * @return ITmfContext
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(long)
+ * Method getStateSystem.
+ *
+ * @return IStateSystemQuerier
*/
- @Override
- public ITmfContext seekEvent(final long rank) {
- iterator.setRank(rank);
- return iterator;
+ public IStateSystemQuerier getStateSystem() {
+ return this.ss;
}
/**
- * Seek rank ratio
- * @param ratio double
- * @return ITmfContext
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(double)
+ *
+ * @param ed
+ * @return
*/
- @Override
- public ITmfContext seekEvent(final double ratio) {
- iterator.seek((long) (this.fNbEvents * ratio));
- return iterator;
+ private static ITmfEventField parseDeclaration(EventDeclaration ed) {
+ EventDefinition eventDef = ed.createDefinition(null);
+ return new CtfTmfContent(ITmfEventField.ROOT_FIELD_ID,
+ CtfTmfEvent.parseFields(eventDef));
}
/**
- * Method readNextEvent.
- * @param context ITmfContext
- * @return CtfTmfEvent
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#readNextEvent(ITmfContext)
+ * gets the CTFtrace that this is wrapping
+ * @return the CTF trace
*/
- @SuppressWarnings("unused")
- @Override
- public CtfTmfEvent readNextEvent(final ITmfContext context) {
- iterator.advance();
- return iterator.getCurrentEvent();
+ public CTFTrace getCTFTrace() {
+ return fTrace;
}
+
+ //-------------------------------------------
+ // Environment Parameters
+ //-------------------------------------------
/**
- * Method getResource.
- * @return IResource
- * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getResource()
+ * Method getNbEnvVars.
+ *
+ * @return int
*/
- @Override
- public IResource getResource() {
- return this.fResource;
+ public int getNbEnvVars() {
+ return this.fTrace.getEnvironment().size();
}
/**
- * Method getStateSystem.
- * @return IStateSystemQuerier
+ * Method getEnvNames.
+ *
+ * @return String[]
*/
- public IStateSystemQuerier getStateSystem() {
- return this.ss;
+ public String[] getEnvNames() {
+ final String[] s = new String[getNbEnvVars()];
+ return this.fTrace.getEnvironment().keySet().toArray(s);
}
/**
- * Method getCTFTrace.
- * @return CTFTrace
+ * Method getEnvValue.
+ *
+ * @param key
+ * String
+ * @return String
*/
- CTFTrace getCTFTrace() {
- return fTrace;
+ public String getEnvValue(final String key) {
+ return this.fTrace.getEnvironment().get(key);
}
+ //-------------------------------------------
+ // Clocks
+ //-------------------------------------------
+
+ public long getOffset(){
+ if( fTrace != null ) {
+ return fTrace.getOffset();
+ }
+ return 0;
+ }
+ //-------------------------------------------
+ // Parser
+ //-------------------------------------------
+
+ @Override
+ public CtfTmfEvent parseEvent(ITmfContext context) {
+ CtfTmfEvent event = null;
+ if( context instanceof CtfIterator ){
+ CtfIterator itt = (CtfIterator) context;
+ event = itt.getCurrentEvent();
+ }
+ return event;
+ }
+
/**
- * Suppressing the warning, because the 'throws' will usually happen in
- * sub-classes.
- * @throws TmfTraceException
+ * Sets the cache size for a CtfTmfTrace.
*/
- @SuppressWarnings({ "unused", "static-method" })
- 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;
+ protected void setCacheSize() {
+ setCacheSize(DEFAULT_CACHE_SIZE);
}
}
projects / deliverable / tracecompass.git / blobdiff