Commit | Line | Data |
---|---|---|
b1baa808 MK |
1 | /******************************************************************************* |
2 | * Copyright (c) 2012 Ericsson | |
3 | * | |
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 | |
8 | * | |
9 | * Contributors: Matthew Khouzam - Initial API and implementation | |
10 | *******************************************************************************/ | |
11 | ||
a3fc8213 AM |
12 | package org.eclipse.linuxtools.tmf.core.ctfadaptor; |
13 | ||
a3fc8213 AM |
14 | import org.eclipse.core.resources.IProject; |
15 | import org.eclipse.core.resources.IResource; | |
139d5c1a | 16 | import org.eclipse.core.runtime.CoreException; |
a3fc8213 AM |
17 | import org.eclipse.linuxtools.ctf.core.trace.CTFReaderException; |
18 | import org.eclipse.linuxtools.ctf.core.trace.CTFTrace; | |
1191a574 | 19 | import org.eclipse.linuxtools.tmf.core.ctfadaptor.CtfTmfTimestamp.TimestampType; |
64c2cb4c | 20 | import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp; |
6256d8ad | 21 | import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; |
a3fc8213 | 22 | import org.eclipse.linuxtools.tmf.core.event.TmfTimestamp; |
b4f71e4a | 23 | import org.eclipse.linuxtools.tmf.core.exceptions.TmfTraceException; |
18ab1d18 | 24 | import org.eclipse.linuxtools.tmf.core.statesystem.IStateSystemQuerier; |
a3fc8213 | 25 | import org.eclipse.linuxtools.tmf.core.trace.ITmfContext; |
4b7c469f | 26 | import org.eclipse.linuxtools.tmf.core.trace.ITmfEventParser; |
a3fc8213 | 27 | import org.eclipse.linuxtools.tmf.core.trace.ITmfLocation; |
4b7c469f | 28 | import org.eclipse.linuxtools.tmf.core.trace.TmfTrace; |
a3fc8213 | 29 | |
9ac2eb62 | 30 | /** |
d09f973b FC |
31 | * The CTf trace handler |
32 | * | |
33 | * @version 1.0 | |
34 | * @author Matthew khouzam | |
9ac2eb62 | 35 | */ |
1e1bef82 | 36 | public class CtfTmfTrace extends TmfTrace implements ITmfEventParser { |
a3fc8213 | 37 | |
788ddcbc | 38 | |
324a6a4a BH |
39 | //------------------------------------------- |
40 | // Constants | |
41 | //------------------------------------------- | |
42 | /** | |
43 | * Default cache size for CTF traces | |
44 | */ | |
45 | protected static final int DEFAULT_CACHE_SIZE = 50000; | |
64c2cb4c | 46 | |
4b7c469f MK |
47 | //------------------------------------------- |
48 | // Fields | |
49 | //------------------------------------------- | |
a3fc8213 | 50 | |
324a6a4a | 51 | /** Reference to the state system assigned to this trace */ |
d26f90fd | 52 | protected IStateSystemQuerier ss = null; |
11d6f468 | 53 | |
4b7c469f MK |
54 | /* Reference to the CTF Trace */ |
55 | private CTFTrace fTrace; | |
a3fc8213 | 56 | |
53b235e1 | 57 | |
788ddcbc | 58 | |
4b7c469f MK |
59 | //------------------------------------------- |
60 | // TmfTrace Overrides | |
61 | //------------------------------------------- | |
b1baa808 MK |
62 | /** |
63 | * Method initTrace. | |
063f0d27 AM |
64 | * |
65 | * @param resource | |
66 | * The resource associated with this trace | |
67 | * @param path | |
68 | * The path to the trace file | |
69 | * @param eventType | |
70 | * The type of events that will be read from this trace | |
b1baa808 | 71 | * @throws TmfTraceException |
063f0d27 | 72 | * If something when wrong while reading the trace |
b1baa808 | 73 | */ |
a3fc8213 | 74 | @Override |
6256d8ad | 75 | public void initTrace(final IResource resource, final String path, final Class<? extends ITmfEvent> eventType) |
b4f71e4a | 76 | throws TmfTraceException { |
4a110860 AM |
77 | /* |
78 | * Set the cache size. This has to be done before the call to super() | |
79 | * because the super needs to know the cache size. | |
80 | */ | |
81 | setCacheSize(); | |
4b7c469f | 82 | super.initTrace(resource, path, eventType); |
324a6a4a | 83 | |
e30ce12e AM |
84 | @SuppressWarnings("unused") |
85 | CtfTmfEventType type; | |
86 | ||
a3fc8213 AM |
87 | try { |
88 | this.fTrace = new CTFTrace(path); | |
53b235e1 MK |
89 | CtfIteratorManager.addTrace(this); |
90 | CtfTmfLightweightContext ctx; | |
99b483fe | 91 | /* Set the start and (current) end times for this trace */ |
132a02b0 MK |
92 | ctx = (CtfTmfLightweightContext) seekEvent(0L); |
93 | CtfTmfEvent event = getNext(ctx); | |
30bf5897 | 94 | if((ctx.getLocation().equals(CtfIterator.NULL_LOCATION)) || (ctx.getCurrentEvent() == null)) { |
99b483fe AM |
95 | /* Handle the case where the trace is empty */ |
96 | this.setStartTime(TmfTimestamp.BIG_BANG); | |
97 | } else { | |
132a02b0 | 98 | final ITmfTimestamp curTime = event.getTimestamp(); |
21fb02fa MK |
99 | this.setStartTime(curTime); |
100 | this.setEndTime(curTime); | |
99b483fe AM |
101 | } |
102 | ||
25e48683 | 103 | } catch (final CTFReaderException e) { |
a3fc8213 AM |
104 | /* |
105 | * If it failed at the init(), we can assume it's because the file | |
106 | * was not found or was not recognized as a CTF trace. Throw into | |
107 | * the new type of exception expected by the rest of TMF. | |
108 | */ | |
9fa32496 | 109 | throw new TmfTraceException(e.getMessage(), e); |
a3fc8213 | 110 | } |
99b483fe | 111 | |
99b483fe | 112 | //FIXME This should be called via the ExperimentUpdated signal |
11d6f468 | 113 | buildStateSystem(); |
139d5c1a AM |
114 | |
115 | /* Refresh the project, so it can pick up new files that got created. */ | |
116 | if ( resource != null) { | |
117 | try { | |
118 | resource.getProject().refreshLocal(IResource.DEPTH_INFINITE, null); | |
119 | } catch (CoreException e) { | |
9fa32496 | 120 | throw new TmfTraceException(e.getMessage(), e); |
139d5c1a AM |
121 | } |
122 | } | |
a3fc8213 AM |
123 | } |
124 | ||
53b235e1 MK |
125 | /* (non-Javadoc) |
126 | * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#dispose() | |
127 | */ | |
128 | @Override | |
129 | public synchronized void dispose() { | |
130 | CtfIteratorManager.removeTrace(this); | |
131 | super.dispose(); | |
132 | } | |
133 | ||
b1baa808 MK |
134 | /** |
135 | * Method validate. | |
136 | * @param project IProject | |
137 | * @param path String | |
138 | * @return boolean | |
139 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#validate(IProject, String) | |
140 | */ | |
a3fc8213 | 141 | @Override |
3bd44ac8 | 142 | public boolean validate(final IProject project, final String path) { |
a3fc8213 AM |
143 | try { |
144 | final CTFTrace temp = new CTFTrace(path); | |
145 | return temp.majortIsSet(); // random test | |
25e48683 | 146 | } catch (final CTFReaderException e) { |
90235d6b AM |
147 | /* Nope, not a CTF trace we can read */ |
148 | return false; | |
a3fc8213 | 149 | } |
a3fc8213 AM |
150 | } |
151 | ||
b1baa808 | 152 | /** |
f474d36b PT |
153 | * Method getCurrentLocation. This is not applicable in CTF |
154 | * @return null, since the trace has no knowledge of the current location | |
b1baa808 MK |
155 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getCurrentLocation() |
156 | */ | |
a3fc8213 | 157 | @Override |
1e1bef82 | 158 | public ITmfLocation getCurrentLocation() { |
f474d36b | 159 | return null; |
a3fc8213 AM |
160 | } |
161 | ||
a3fc8213 | 162 | |
a3fc8213 AM |
163 | |
164 | @Override | |
1e1bef82 | 165 | public double getLocationRatio(ITmfLocation location) { |
4b7c469f | 166 | final CtfLocation curLocation = (CtfLocation) location; |
53b235e1 MK |
167 | final CtfTmfLightweightContext context = new CtfTmfLightweightContext(this); |
168 | context.setLocation(curLocation); | |
5976d44a FC |
169 | context.seek(curLocation.getLocationInfo()); |
170 | final CtfLocationData currentTime = ((CtfLocationData)context.getLocation().getLocationInfo()); | |
53b235e1 MK |
171 | final long startTime = getIterator(this, context).getStartTime(); |
172 | final long endTime = getIterator(this, context).getEndTime(); | |
132a02b0 | 173 | return ((double) currentTime.getTimestamp() - startTime) |
53b235e1 | 174 | / (endTime - startTime); |
a3fc8213 AM |
175 | } |
176 | ||
53b235e1 MK |
177 | |
178 | ||
179 | ||
788ddcbc | 180 | |
64c2cb4c MK |
181 | /* (non-Javadoc) |
182 | * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp) | |
183 | */ | |
184 | @Override | |
185 | public synchronized ITmfContext seekEvent(ITmfTimestamp timestamp) { | |
186 | if( timestamp instanceof CtfTmfTimestamp){ | |
53b235e1 | 187 | CtfTmfLightweightContext iter = new CtfTmfLightweightContext(this); |
64c2cb4c MK |
188 | iter.seek(timestamp.getValue()); |
189 | return iter; | |
190 | } | |
191 | return super.seekEvent(timestamp); | |
192 | } | |
193 | ||
b1baa808 MK |
194 | /** |
195 | * Method seekEvent. | |
196 | * @param location ITmfLocation<?> | |
197 | * @return ITmfContext | |
b1baa808 | 198 | */ |
a3fc8213 | 199 | @Override |
1e1bef82 | 200 | public ITmfContext seekEvent(final ITmfLocation location) { |
ce2388e0 | 201 | CtfLocation currentLocation = (CtfLocation) location; |
53b235e1 | 202 | CtfTmfLightweightContext context = new CtfTmfLightweightContext(this); |
4a110860 AM |
203 | /* |
204 | * The rank is set to 0 if the iterator seeks the beginning. If not, it | |
205 | * will be set to UNKNOWN_RANK, since CTF traces don't support seeking | |
206 | * by rank for now. | |
207 | */ | |
11d6f468 | 208 | if (currentLocation == null) { |
132a02b0 | 209 | currentLocation = new CtfLocation(new CtfLocationData(0L, 0L)); |
4a110860 | 210 | context.setRank(0); |
11d6f468 | 211 | } |
5976d44a | 212 | if (currentLocation.getLocationInfo() == CtfLocation.INVALID_LOCATION) { |
4cf201de | 213 | ((CtfTmfTimestamp) getEndTime()).setType(TimestampType.NANOS); |
132a02b0 | 214 | currentLocation.setLocation(getEndTime().getValue() + 1, 0L); |
1191a574 | 215 | } |
f474d36b | 216 | context.setLocation(currentLocation); |
7f0bab07 PT |
217 | if (location == null) { |
218 | CtfTmfEvent event = getIterator(this, context).getCurrentEvent(); | |
219 | if (event != null) { | |
58f3bc52 | 220 | currentLocation.setLocation(event.getTimestamp().getValue(), 0); |
7f0bab07 PT |
221 | } |
222 | } | |
64c2cb4c | 223 | if(context.getRank() != 0) { |
3bd44ac8 | 224 | context.setRank(ITmfContext.UNKNOWN_RANK); |
64c2cb4c | 225 | } |
f474d36b | 226 | return context; |
a3fc8213 AM |
227 | } |
228 | ||
a3fc8213 | 229 | |
a3fc8213 | 230 | @Override |
4b7c469f | 231 | public ITmfContext seekEvent(double ratio) { |
53b235e1 | 232 | CtfTmfLightweightContext context = new CtfTmfLightweightContext(this); |
b2dc9e02 MK |
233 | final long end = this.getEndTime().getValue(); |
234 | final long start = this.getStartTime().getValue(); | |
235 | final long diff = end - start; | |
236 | final long ratioTs = (long) (diff * ratio) + start; | |
237 | context.seek(ratioTs); | |
f474d36b PT |
238 | context.setRank(ITmfContext.UNKNOWN_RANK); |
239 | return context; | |
a3fc8213 AM |
240 | } |
241 | ||
b1baa808 MK |
242 | /** |
243 | * Method readNextEvent. | |
244 | * @param context ITmfContext | |
245 | * @return CtfTmfEvent | |
c32744d6 | 246 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNext(ITmfContext) |
b1baa808 | 247 | */ |
a3fc8213 | 248 | @Override |
4b7c469f | 249 | public synchronized CtfTmfEvent getNext(final ITmfContext context) { |
f474d36b | 250 | CtfTmfEvent event = null; |
788ddcbc | 251 | if (context instanceof CtfTmfLightweightContext) { |
5976d44a | 252 | if (CtfLocation.INVALID_LOCATION.equals(context.getLocation().getLocationInfo())) { |
ae09313d PT |
253 | return null; |
254 | } | |
788ddcbc MK |
255 | CtfTmfLightweightContext ctfContext = (CtfTmfLightweightContext) context; |
256 | event = ctfContext.getCurrentEvent(); | |
4a110860 | 257 | |
324a6a4a BH |
258 | if (event != null) { |
259 | updateAttributes(context, event.getTimestamp()); | |
788ddcbc MK |
260 | ctfContext.advance(); |
261 | ctfContext.increaseRank(); | |
324a6a4a | 262 | } |
f474d36b | 263 | } |
4a110860 | 264 | |
aa572e22 | 265 | return event; |
a3fc8213 AM |
266 | } |
267 | ||
b1baa808 | 268 | /** |
4b7c469f MK |
269 | * Suppressing the warning, because the 'throws' will usually happen in |
270 | * sub-classes. | |
063f0d27 | 271 | * |
4b7c469f | 272 | * @throws TmfTraceException |
b1baa808 | 273 | */ |
063f0d27 | 274 | @SuppressWarnings("unused") |
4b7c469f MK |
275 | protected void buildStateSystem() throws TmfTraceException { |
276 | /* | |
277 | * Nothing is done in the basic implementation, please specify | |
278 | * how/if to build a state system in derived classes. | |
279 | */ | |
280 | return; | |
a3fc8213 AM |
281 | } |
282 | ||
b1baa808 MK |
283 | /** |
284 | * Method getStateSystem. | |
4b7c469f | 285 | * |
b1baa808 MK |
286 | * @return IStateSystemQuerier |
287 | */ | |
d26f90fd | 288 | public IStateSystemQuerier getStateSystem() { |
11d6f468 AM |
289 | return this.ss; |
290 | } | |
291 | ||
4b7c469f MK |
292 | /** |
293 | * gets the CTFtrace that this is wrapping | |
294 | * @return the CTF trace | |
295 | */ | |
296 | public CTFTrace getCTFTrace() { | |
a3fc8213 AM |
297 | return fTrace; |
298 | } | |
a1a24d68 | 299 | |
8636b448 | 300 | |
4b7c469f MK |
301 | //------------------------------------------- |
302 | // Environment Parameters | |
303 | //------------------------------------------- | |
d26f90fd | 304 | /** |
4b7c469f MK |
305 | * Method getNbEnvVars. |
306 | * | |
307 | * @return int | |
d26f90fd | 308 | */ |
4b7c469f MK |
309 | public int getNbEnvVars() { |
310 | return this.fTrace.getEnvironment().size(); | |
311 | } | |
312 | ||
313 | /** | |
314 | * Method getEnvNames. | |
315 | * | |
316 | * @return String[] | |
317 | */ | |
318 | public String[] getEnvNames() { | |
319 | final String[] s = new String[getNbEnvVars()]; | |
320 | return this.fTrace.getEnvironment().keySet().toArray(s); | |
321 | } | |
322 | ||
323 | /** | |
324 | * Method getEnvValue. | |
325 | * | |
326 | * @param key | |
327 | * String | |
328 | * @return String | |
329 | */ | |
330 | public String getEnvValue(final String key) { | |
331 | return this.fTrace.getEnvironment().get(key); | |
332 | } | |
333 | ||
bfe038ff MK |
334 | //------------------------------------------- |
335 | // Clocks | |
336 | //------------------------------------------- | |
337 | ||
9ac2eb62 MK |
338 | /** |
339 | * gets the clock offset | |
340 | * @return the clock offset in ns | |
341 | */ | |
bfe038ff MK |
342 | public long getOffset(){ |
343 | if( fTrace != null ) { | |
344 | return fTrace.getOffset(); | |
345 | } | |
346 | return 0; | |
347 | } | |
348 | ||
4b7c469f MK |
349 | //------------------------------------------- |
350 | // Parser | |
351 | //------------------------------------------- | |
352 | ||
353 | @Override | |
bfe038ff | 354 | public CtfTmfEvent parseEvent(ITmfContext context) { |
4b7c469f | 355 | CtfTmfEvent event = null; |
788ddcbc MK |
356 | if( context instanceof CtfTmfLightweightContext ){ |
357 | CtfTmfLightweightContext itt = (CtfTmfLightweightContext) context.clone(); | |
4b7c469f MK |
358 | event = itt.getCurrentEvent(); |
359 | } | |
360 | return event; | |
11d6f468 | 361 | } |
64c2cb4c | 362 | |
324a6a4a | 363 | /** |
64c2cb4c | 364 | * Sets the cache size for a CtfTmfTrace. |
324a6a4a BH |
365 | */ |
366 | protected void setCacheSize() { | |
367 | setCacheSize(DEFAULT_CACHE_SIZE); | |
368 | } | |
ce2388e0 | 369 | |
53b235e1 MK |
370 | //------------------------------------------- |
371 | // Helpers | |
372 | //------------------------------------------- | |
373 | ||
374 | private static CtfIterator getIterator(CtfTmfTrace trace, CtfTmfLightweightContext context) { | |
375 | return CtfIteratorManager.getIterator(trace, context); | |
376 | } | |
a3fc8213 | 377 | } |