Commit | Line | Data |
---|---|---|
b1baa808 | 1 | /******************************************************************************* |
61759503 | 2 | * Copyright (c) 2012, 2013 Ericsson |
b1baa808 MK |
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 | *******************************************************************************/ | |
a3fc8213 AM |
11 | package org.eclipse.linuxtools.tmf.core.ctfadaptor; |
12 | ||
13 | import org.eclipse.linuxtools.ctf.core.trace.CTFTraceReader; | |
14 | import org.eclipse.linuxtools.ctf.core.trace.StreamInputReader; | |
15 | import org.eclipse.linuxtools.tmf.core.trace.ITmfContext; | |
16 | import org.eclipse.linuxtools.tmf.core.trace.ITmfLocation; | |
17 | ||
b1baa808 | 18 | /** |
d09f973b | 19 | * The CTF trace reader iterator. |
3eaea7e6 | 20 | * |
d09f973b FC |
21 | * It doesn't reserve a file handle, so many iterators can be used without worries |
22 | * of I/O errors or resource exhaustion. | |
3eaea7e6 | 23 | * |
d09f973b FC |
24 | * @version 1.0 |
25 | * @author Matthew Khouzam | |
b1baa808 | 26 | */ |
132a02b0 | 27 | public class CtfIterator extends CTFTraceReader implements ITmfContext, |
81a2d02e | 28 | Comparable<CtfIterator> { |
a3fc8213 AM |
29 | |
30 | private final CtfTmfTrace ctfTmfTrace; | |
31 | ||
9ac2eb62 MK |
32 | /** |
33 | * An invalid location | |
34 | */ | |
132a02b0 MK |
35 | final public static CtfLocation NULL_LOCATION = new CtfLocation(CtfLocation.INVALID_LOCATION); |
36 | ||
a3fc8213 AM |
37 | private CtfLocation curLocation; |
38 | private long curRank; | |
39 | ||
40 | /** | |
41 | * Create a new CTF trace iterator, which initially points at the first | |
42 | * event in the trace. | |
43 | * | |
132a02b0 MK |
44 | * @param trace |
45 | * the trace to iterate over | |
a3fc8213 | 46 | */ |
ce2388e0 | 47 | public CtfIterator(final CtfTmfTrace trace) { |
a3fc8213 AM |
48 | super(trace.getCTFTrace()); |
49 | this.ctfTmfTrace = trace; | |
57c073c5 | 50 | if (this.hasMoreEvents()) { |
57c073c5 MK |
51 | this.curLocation = new CtfLocation(trace.getStartTime()); |
52 | this.curRank = 0; | |
53 | } else { | |
54 | setUnknownLocation(); | |
55 | } | |
a3fc8213 AM |
56 | } |
57 | ||
57c073c5 | 58 | private void setUnknownLocation() { |
f474d36b | 59 | this.curLocation = NULL_LOCATION; |
57c073c5 MK |
60 | this.curRank = UNKNOWN_RANK; |
61 | } | |
62 | ||
b1baa808 MK |
63 | /** |
64 | * Constructor for CtfIterator. | |
132a02b0 MK |
65 | * |
66 | * @param trace | |
67 | * CtfTmfTrace the trace | |
68 | * @param ctfLocationData | |
69 | * long the timestamp in ns of the trace for positioning | |
70 | * @param rank | |
71 | * long the index of the trace for positioning | |
72 | * @since 2.0 | |
b1baa808 | 73 | */ |
132a02b0 | 74 | public CtfIterator(final CtfTmfTrace trace, |
f5df94f8 | 75 | final CtfLocationInfo ctfLocationData, final long rank) { |
a3fc8213 | 76 | super(trace.getCTFTrace()); |
57c073c5 | 77 | |
a3fc8213 | 78 | this.ctfTmfTrace = trace; |
57c073c5 | 79 | if (this.hasMoreEvents()) { |
132a02b0 | 80 | this.curLocation = new CtfLocation(ctfLocationData); |
58f3bc52 | 81 | if (this.getCurrentEvent().getTimestamp().getValue() != ctfLocationData.getTimestamp()) { |
132a02b0 | 82 | this.seek(ctfLocationData); |
57c073c5 MK |
83 | this.curRank = rank; |
84 | } | |
85 | } else { | |
86 | setUnknownLocation(); | |
87 | } | |
a3fc8213 | 88 | |
a3fc8213 AM |
89 | } |
90 | ||
b1baa808 MK |
91 | /** |
92 | * Method getCtfTmfTrace. gets a CtfTmfTrace | |
93 | * @return CtfTmfTrace | |
94 | */ | |
a3fc8213 AM |
95 | public CtfTmfTrace getCtfTmfTrace() { |
96 | return ctfTmfTrace; | |
97 | } | |
98 | ||
b1baa808 MK |
99 | /** |
100 | * Method getCurrentEvent. gets the current event | |
101 | * @return CtfTmfEvent | |
102 | */ | |
a3fc8213 | 103 | public CtfTmfEvent getCurrentEvent() { |
0594c61c | 104 | final StreamInputReader top = super.getPrio().peek(); |
57c073c5 | 105 | if (top != null) { |
6cfa0200 AM |
106 | return CtfTmfEventFactory.createEvent(top.getCurrentEvent(), |
107 | top.getFilename(), ctfTmfTrace); | |
57c073c5 | 108 | } |
a3fc8213 AM |
109 | return null; |
110 | } | |
111 | ||
23974d8a PT |
112 | @Override |
113 | public boolean seek(long timestamp) { | |
f5df94f8 | 114 | return seek(new CtfLocationInfo(timestamp, 0)); |
23974d8a PT |
115 | } |
116 | ||
b1baa808 | 117 | /** |
132a02b0 MK |
118 | * Seek this iterator to a given location. |
119 | * | |
120 | * @param ctfLocationData | |
121 | * The LocationData representing the position to seek to | |
b1baa808 | 122 | * @return boolean |
132a02b0 | 123 | * @since 2.0 |
b1baa808 | 124 | */ |
f5df94f8 | 125 | public boolean seek(final CtfLocationInfo ctfLocationData) { |
a3fc8213 | 126 | boolean ret = false; |
132a02b0 MK |
127 | |
128 | /* Adjust the timestamp depending on the trace's offset */ | |
129 | long currTimestamp = ctfLocationData.getTimestamp(); | |
77ef700d | 130 | final long offsetTimestamp = this.getCtfTmfTrace().getCTFTrace().timestampNanoToCycles(currTimestamp); |
57c073c5 | 131 | if (offsetTimestamp < 0) { |
3eaea7e6 | 132 | ret = super.seek(0L); |
57c073c5 | 133 | } else { |
ce2388e0 | 134 | ret = super.seek(offsetTimestamp); |
57c073c5 | 135 | } |
a3fc8213 | 136 | |
132a02b0 MK |
137 | /* |
138 | * Check if there is already one or more events for that timestamp, and | |
139 | * assign the location index correctly | |
140 | */ | |
132a02b0 | 141 | long index = 0; |
77ef700d | 142 | if (this.getCurrentEvent() != null) { |
58f3bc52 | 143 | currTimestamp = this.getCurrentEvent().getTimestamp().getValue(); |
77ef700d MK |
144 | |
145 | for (long i = 0; i < ctfLocationData.getIndex(); i++) { | |
58f3bc52 | 146 | if (currTimestamp == this.getCurrentEvent().getTimestamp().getValue()) { |
77ef700d MK |
147 | index++; |
148 | } else { | |
149 | index = 0; | |
150 | } | |
151 | this.advance(); | |
132a02b0 | 152 | } |
77ef700d MK |
153 | } else { |
154 | ret= false; | |
132a02b0 | 155 | } |
132a02b0 | 156 | /* Seek the current location accordingly */ |
57c073c5 | 157 | if (ret) { |
f5df94f8 | 158 | curLocation = new CtfLocation(new CtfLocationInfo(getCurrentEvent().getTimestamp().getValue(), index)); |
f474d36b PT |
159 | } else { |
160 | curLocation = NULL_LOCATION; | |
57c073c5 | 161 | } |
ce2388e0 FC |
162 | return ret; |
163 | } | |
164 | ||
b1baa808 MK |
165 | /** |
166 | * Method getRank. | |
167 | * @return long | |
168 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfContext#getRank() | |
169 | */ | |
a3fc8213 AM |
170 | @Override |
171 | public long getRank() { | |
f474d36b | 172 | return curRank; |
a3fc8213 AM |
173 | } |
174 | ||
b1baa808 MK |
175 | /** |
176 | * Method setRank. | |
177 | * @param rank long | |
178 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfContext#setRank(long) | |
179 | */ | |
a3fc8213 | 180 | @Override |
ce2388e0 | 181 | public void setRank(final long rank) { |
f474d36b | 182 | curRank = rank; |
a3fc8213 AM |
183 | } |
184 | ||
a3fc8213 AM |
185 | @Override |
186 | public CtfIterator clone() { | |
187 | CtfIterator clone = null; | |
5976d44a | 188 | clone = new CtfIterator(ctfTmfTrace, this.getLocation().getLocationInfo(), curRank); |
a3fc8213 AM |
189 | return clone; |
190 | } | |
191 | ||
b1baa808 MK |
192 | /** |
193 | * Method dispose. | |
194 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfContext#dispose() | |
195 | */ | |
a3fc8213 AM |
196 | @Override |
197 | public void dispose() { | |
5d1c6919 | 198 | super.dispose(); |
a3fc8213 AM |
199 | } |
200 | ||
b1baa808 MK |
201 | /** |
202 | * Method setLocation. | |
203 | * @param location ITmfLocation<?> | |
b1baa808 | 204 | */ |
a3fc8213 | 205 | @Override |
1e1bef82 | 206 | public void setLocation(final ITmfLocation location) { |
a3fc8213 AM |
207 | // FIXME alex: isn't there a cleaner way than a cast here? |
208 | this.curLocation = (CtfLocation) location; | |
5976d44a | 209 | seek(((CtfLocation) location).getLocationInfo()); |
a3fc8213 AM |
210 | } |
211 | ||
b1baa808 MK |
212 | /** |
213 | * Method getLocation. | |
214 | * @return CtfLocation | |
215 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfContext#getLocation() | |
216 | */ | |
a3fc8213 AM |
217 | @Override |
218 | public CtfLocation getLocation() { | |
219 | return curLocation; | |
220 | } | |
221 | ||
b1baa808 MK |
222 | /** |
223 | * Method increaseRank. | |
224 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfContext#increaseRank() | |
225 | */ | |
a3fc8213 | 226 | @Override |
cbdacf03 | 227 | public void increaseRank() { |
4a110860 AM |
228 | /* Only increase the rank if it's valid */ |
229 | if(hasValidRank()) { | |
230 | curRank++; | |
231 | } | |
a3fc8213 AM |
232 | } |
233 | ||
b1baa808 MK |
234 | /** |
235 | * Method hasValidRank, if the iterator is valid | |
236 | * @return boolean | |
237 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfContext#hasValidRank() | |
238 | */ | |
a3fc8213 | 239 | @Override |
cbdacf03 | 240 | public boolean hasValidRank() { |
bcbea6a6 | 241 | return (getRank() >= 0); |
a3fc8213 AM |
242 | } |
243 | ||
b1baa808 MK |
244 | /** |
245 | * Method advance go to the next event | |
246 | * @return boolean successful or not | |
247 | */ | |
a3fc8213 AM |
248 | @Override |
249 | public boolean advance() { | |
5976d44a FC |
250 | long index = curLocation.getLocationInfo().getIndex(); |
251 | long timestamp = curLocation.getLocationInfo().getTimestamp(); | |
f474d36b | 252 | boolean ret = super.advance(); |
132a02b0 | 253 | |
f474d36b | 254 | if (ret) { |
58f3bc52 | 255 | final long timestampValue = getCurrentEvent().getTimestamp().getValue(); |
132a02b0 | 256 | if (timestamp == timestampValue) { |
d62bb185 | 257 | curLocation = new CtfLocation(timestampValue, index + 1); |
132a02b0 | 258 | } else { |
d62bb185 | 259 | curLocation = new CtfLocation(timestampValue, 0L); |
132a02b0 | 260 | } |
f474d36b PT |
261 | } else { |
262 | curLocation = NULL_LOCATION; | |
263 | } | |
264 | return ret; | |
a3fc8213 AM |
265 | } |
266 | ||
b1baa808 MK |
267 | /** |
268 | * Method compareTo. | |
269 | * @param o CtfIterator | |
270 | * @return int -1, 0, 1 | |
271 | */ | |
a3fc8213 | 272 | @Override |
ce2388e0 | 273 | public int compareTo(final CtfIterator o) { |
57c073c5 | 274 | if (this.getRank() < o.getRank()) { |
a3fc8213 | 275 | return -1; |
57c073c5 | 276 | } else if (this.getRank() > o.getRank()) { |
a3fc8213 | 277 | return 1; |
57c073c5 | 278 | } |
a3fc8213 AM |
279 | return 0; |
280 | } | |
788ddcbc | 281 | |
b1baa808 MK |
282 | @Override |
283 | public int hashCode() { | |
284 | final int prime = 31; | |
285 | int result = super.hashCode(); | |
286 | result = (prime * result) | |
287 | + ((ctfTmfTrace == null) ? 0 : ctfTmfTrace.hashCode()); | |
288 | result = (prime * result) | |
289 | + ((curLocation == null) ? 0 : curLocation.hashCode()); | |
290 | result = (prime * result) + (int) (curRank ^ (curRank >>> 32)); | |
291 | return result; | |
292 | } | |
a3fc8213 | 293 | |
b1baa808 MK |
294 | @Override |
295 | public boolean equals(Object obj) { | |
296 | if (this == obj) { | |
297 | return true; | |
298 | } | |
299 | if (!super.equals(obj)) { | |
300 | return false; | |
301 | } | |
302 | if (!(obj instanceof CtfIterator)) { | |
303 | return false; | |
304 | } | |
305 | CtfIterator other = (CtfIterator) obj; | |
306 | if (ctfTmfTrace == null) { | |
307 | if (other.ctfTmfTrace != null) { | |
308 | return false; | |
309 | } | |
310 | } else if (!ctfTmfTrace.equals(other.ctfTmfTrace)) { | |
311 | return false; | |
312 | } | |
313 | if (curLocation == null) { | |
314 | if (other.curLocation != null) { | |
315 | return false; | |
316 | } | |
317 | } else if (!curLocation.equals(other.curLocation)) { | |
318 | return false; | |
319 | } | |
320 | if (curRank != other.curRank) { | |
321 | return false; | |
322 | } | |
323 | return true; | |
324 | } | |
ce2388e0 | 325 | } |