1 /*******************************************************************************
2 * Copyright (c) 2012, 2013 Ericsson
4 * All rights reserved. This program and the accompanying materials are made
5 * available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Matthew Khouzam - Initial API and implementation
11 * Patrick Tasse - Updated for removal of context clone
12 *******************************************************************************/
14 package org
.eclipse
.linuxtools
.tmf
.core
.ctfadaptor
;
16 import java
.nio
.BufferOverflowException
;
17 import java
.util
.Collections
;
20 import org
.eclipse
.core
.resources
.IProject
;
21 import org
.eclipse
.core
.resources
.IResource
;
22 import org
.eclipse
.core
.runtime
.IStatus
;
23 import org
.eclipse
.core
.runtime
.Status
;
24 import org
.eclipse
.linuxtools
.ctf
.core
.event
.IEventDeclaration
;
25 import org
.eclipse
.linuxtools
.ctf
.core
.event
.CTFClock
;
26 import org
.eclipse
.linuxtools
.ctf
.core
.trace
.CTFReaderException
;
27 import org
.eclipse
.linuxtools
.ctf
.core
.trace
.CTFTrace
;
28 import org
.eclipse
.linuxtools
.ctf
.core
.trace
.CTFTraceReader
;
29 import org
.eclipse
.linuxtools
.internal
.tmf
.core
.Activator
;
30 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
31 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.TmfTraceException
;
32 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.ITmfTimestamp
;
33 import org
.eclipse
.linuxtools
.tmf
.core
.timestamp
.TmfTimestamp
;
34 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfContext
;
35 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfEventParser
;
36 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfTraceProperties
;
37 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.TmfTrace
;
38 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.location
.ITmfLocation
;
41 * The CTf trace handler
44 * @author Matthew khouzam
46 public class CtfTmfTrace
extends TmfTrace
47 implements ITmfEventParser
, ITmfTraceProperties
{
49 // -------------------------------------------
51 // -------------------------------------------
53 * Default cache size for CTF traces
55 protected static final int DEFAULT_CACHE_SIZE
= 50000;
58 * The Ctf clock unique identifier field
60 private static final String CLOCK_HOST_PROPERTY
= "uuid"; //$NON-NLS-1$
62 // -------------------------------------------
64 // -------------------------------------------
66 /* Reference to the CTF Trace */
67 private CTFTrace fTrace
;
69 // -------------------------------------------
71 // -------------------------------------------
76 * The resource associated with this trace
78 * The path to the trace file
80 * The type of events that will be read from this trace
81 * @throws TmfTraceException
82 * If something when wrong while reading the trace
85 public void initTrace(final IResource resource
, final String path
, final Class
<?
extends ITmfEvent
> eventType
)
86 throws TmfTraceException
{
88 * Set the cache size. This has to be done before the call to super()
89 * because the super needs to know the cache size.
93 super.initTrace(resource
, path
, eventType
);
95 @SuppressWarnings("unused")
99 this.fTrace
= new CTFTrace(path
);
100 CtfIteratorManager
.addTrace(this);
102 /* Set the start and (current) end times for this trace */
103 ctx
= (CtfTmfContext
) seekEvent(0L);
104 CtfTmfEvent event
= getNext(ctx
);
105 if ((ctx
.getLocation().equals(CtfIterator
.NULL_LOCATION
)) || (ctx
.getCurrentEvent() == null)) {
106 /* Handle the case where the trace is empty */
107 this.setStartTime(TmfTimestamp
.BIG_BANG
);
109 final ITmfTimestamp curTime
= event
.getTimestamp();
110 this.setStartTime(curTime
);
111 this.setEndTime(curTime
);
114 } catch (final CTFReaderException e
) {
116 * If it failed at the init(), we can assume it's because the file
117 * was not found or was not recognized as a CTF trace. Throw into
118 * the new type of exception expected by the rest of TMF.
120 throw new TmfTraceException(e
.getMessage(), e
);
125 public synchronized void dispose() {
126 CtfIteratorManager
.removeTrace(this);
127 if (fTrace
!= null) {
141 * @return IStatus IStatus.error or Status.OK_STATUS
142 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#validate(IProject, String)
146 public IStatus
validate(final IProject project
, final String path
) {
147 IStatus validTrace
= Status
.OK_STATUS
;
149 final CTFTrace temp
= new CTFTrace(path
);
150 if (!temp
.majortIsSet()) {
151 validTrace
= new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.CtfTmfTrace_MajorNotSet
);
153 CTFTraceReader ctfTraceReader
= new CTFTraceReader(temp
);
154 if (!ctfTraceReader
.hasMoreEvents()) {
155 // TODO: This will need an additional check when we support live traces
156 // because having no event is valid for a live trace
157 validTrace
= new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.CtfTmfTrace_NoEvent
);
159 ctfTraceReader
.dispose();
162 } catch (final CTFReaderException e
) {
163 validTrace
= new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.CtfTmfTrace_ReadingError
+": " + e
.toString()); //$NON-NLS-1$
164 } catch (final BufferOverflowException e
){
165 validTrace
= new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, Messages
.CtfTmfTrace_ReadingError
+": " + Messages
.CtfTmfTrace_BufferOverflowErrorMessage
); //$NON-NLS-1$
172 * Method getCurrentLocation. This is not applicable in CTF
174 * @return null, since the trace has no knowledge of the current location
175 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getCurrentLocation()
179 public ITmfLocation
getCurrentLocation() {
187 public double getLocationRatio(ITmfLocation location
) {
188 final CtfLocation curLocation
= (CtfLocation
) location
;
189 final CtfTmfContext context
= new CtfTmfContext(this);
190 context
.setLocation(curLocation
);
191 context
.seek(curLocation
.getLocationInfo());
192 final CtfLocationInfo currentTime
= ((CtfLocationInfo
) context
.getLocation().getLocationInfo());
193 final long startTime
= getIterator(this, context
).getStartTime();
194 final long endTime
= getIterator(this, context
).getEndTime();
195 return ((double) currentTime
.getTimestamp() - startTime
)
196 / (endTime
- startTime
);
204 * @return ITmfContext
208 public synchronized ITmfContext
seekEvent(final ITmfLocation location
) {
209 CtfLocation currentLocation
= (CtfLocation
) location
;
210 CtfTmfContext context
= new CtfTmfContext(this);
211 if (fTrace
== null) {
212 context
.setLocation(null);
213 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
217 * The rank is set to 0 if the iterator seeks the beginning. If not, it
218 * will be set to UNKNOWN_RANK, since CTF traces don't support seeking
221 if (currentLocation
== null) {
222 currentLocation
= new CtfLocation(new CtfLocationInfo(0L, 0L));
225 if (currentLocation
.getLocationInfo() == CtfLocation
.INVALID_LOCATION
) {
226 currentLocation
= new CtfLocation(getEndTime().getValue() + 1, 0L);
228 context
.setLocation(currentLocation
);
229 if (location
== null) {
230 CtfTmfEvent event
= getIterator(this, context
).getCurrentEvent();
232 currentLocation
= new CtfLocation(event
.getTimestamp().getValue(), 0);
235 if (context
.getRank() != 0) {
236 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
242 public synchronized ITmfContext
seekEvent(double ratio
) {
243 CtfTmfContext context
= new CtfTmfContext(this);
244 if (fTrace
== null) {
245 context
.setLocation(null);
246 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
249 final long end
= this.getEndTime().getValue();
250 final long start
= this.getStartTime().getValue();
251 final long diff
= end
- start
;
252 final long ratioTs
= Math
.round(diff
* ratio
) + start
;
253 context
.seek(ratioTs
);
254 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
259 * Method readNextEvent.
263 * @return CtfTmfEvent
264 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNext(ITmfContext)
267 public synchronized CtfTmfEvent
getNext(final ITmfContext context
) {
268 if (fTrace
== null) {
271 CtfTmfEvent event
= null;
272 if (context
instanceof CtfTmfContext
) {
273 if (context
.getLocation() == null || CtfLocation
.INVALID_LOCATION
.equals(context
.getLocation().getLocationInfo())) {
276 CtfTmfContext ctfContext
= (CtfTmfContext
) context
;
277 event
= ctfContext
.getCurrentEvent();
280 updateAttributes(context
, event
.getTimestamp());
281 ctfContext
.advance();
282 ctfContext
.increaseRank();
290 * gets the CTFtrace that this is wrapping
292 * @return the CTF trace
294 public CTFTrace
getCTFTrace() {
299 * Ctf traces have a clock with a unique uuid that will be used to identify
300 * the host. Traces with the same clock uuid will be known to have been made
301 * on the same machine.
303 * Note: uuid is an optional field, it may not be there for a clock.
306 public String
getHostId() {
307 CTFClock clock
= getCTFTrace().getClock();
309 String clockHost
= (String
) clock
.getProperty(CLOCK_HOST_PROPERTY
);
310 if (clockHost
!= null) {
314 return super.getHostId();
317 // -------------------------------------------
318 // ITmfTraceProperties
319 // -------------------------------------------
325 public Map
<String
, String
> getTraceProperties() {
326 return Collections
.unmodifiableMap(fTrace
.getEnvironment());
329 // -------------------------------------------
331 // -------------------------------------------
334 * gets the clock offset
336 * @return the clock offset in ns
338 public long getOffset() {
339 if (fTrace
!= null) {
340 return fTrace
.getOffset();
346 * Returns whether or not an event is in the metadata of the trace,
347 * therefore if it can possibly be in the trace. It does not verify whether
348 * or not the event is actually in the trace
351 * The name of the event to check
352 * @return Whether the event is in the metadata or not
355 public boolean hasEvent(final String eventName
) {
356 Map
<Long
, IEventDeclaration
> events
= fTrace
.getEvents(0L);
357 if (events
!= null) {
358 for (IEventDeclaration decl
: events
.values()) {
359 if (decl
.getName().equals(eventName
)) {
368 * Return whether all requested events are in the metadata
371 * The array of events to check for
372 * @return Whether all events are in the metadata
375 public boolean hasAllEvents(String
[] names
) {
376 for (String name
: names
) {
377 if (!hasEvent(name
)) {
385 * Returns whether the metadata contains at least one of the requested
389 * The array of event names of check for
390 * @return Whether one of the event is present in trace metadata
393 public boolean hasAtLeastOneOfEvents(String
[] names
) {
394 for (String name
: names
) {
395 if (hasEvent(name
)) {
402 // -------------------------------------------
404 // -------------------------------------------
407 public CtfTmfEvent
parseEvent(ITmfContext context
) {
408 CtfTmfEvent event
= null;
409 if (context
instanceof CtfTmfContext
) {
410 final ITmfContext tmpContext
= seekEvent(context
.getLocation());
411 event
= getNext(tmpContext
);
417 * Sets the cache size for a CtfTmfTrace.
419 protected void setCacheSize() {
420 setCacheSize(DEFAULT_CACHE_SIZE
);
423 // -------------------------------------------
425 // -------------------------------------------
427 private static CtfIterator
getIterator(CtfTmfTrace trace
, CtfTmfContext context
) {
428 return CtfIteratorManager
.getIterator(trace
, context
);
432 * Get an iterator to the trace
434 * @return an iterator to the trace
437 public CtfIterator
createIterator() {
438 return new CtfIterator(this);