Commit | Line | Data |
---|---|---|
20658947 FC |
1 | /******************************************************************************* |
2 | * Copyright (c) 2012 Ericsson | |
9b749023 | 3 | * |
20658947 FC |
4 | * All rights reserved. This program and the accompanying materials are |
5 | * made 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 | |
9b749023 | 8 | * |
20658947 FC |
9 | * Contributors: |
10 | * Francois Chouinard - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
13 | package org.eclipse.linuxtools.tmf.core.trace; | |
14 | ||
0316808c | 15 | import java.util.ArrayList; |
20658947 | 16 | import java.util.Collections; |
0316808c | 17 | import java.util.List; |
20658947 FC |
18 | |
19 | import org.eclipse.core.runtime.IProgressMonitor; | |
20 | import org.eclipse.core.runtime.IStatus; | |
21 | import org.eclipse.core.runtime.Status; | |
22 | import org.eclipse.core.runtime.jobs.Job; | |
3bd44ac8 | 23 | import org.eclipse.linuxtools.internal.tmf.core.trace.TmfExperimentContext; |
9b749023 | 24 | import org.eclipse.linuxtools.tmf.core.component.TmfDataProvider; |
20658947 FC |
25 | import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; |
26 | import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp; | |
27 | import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange; | |
20658947 FC |
28 | import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest; |
29 | import org.eclipse.linuxtools.tmf.core.request.ITmfEventRequest; | |
30 | import org.eclipse.linuxtools.tmf.core.request.TmfDataRequest; | |
31 | import org.eclipse.linuxtools.tmf.core.request.TmfEventRequest; | |
32 | import org.eclipse.linuxtools.tmf.core.signal.TmfTraceUpdatedSignal; | |
33 | ||
34 | /** | |
2848c377 | 35 | * A simple indexer that manages the trace index as an array of trace |
9b749023 | 36 | * checkpoints. Checkpoints are stored at fixed intervals (event rank) in |
2848c377 | 37 | * ascending timestamp order. |
20658947 FC |
38 | * <p> |
39 | * The goal being to access a random trace event reasonably fast from the user's | |
40 | * standpoint, picking the right interval value becomes a trade-off between speed | |
41 | * and memory usage (a shorter inter-event interval is faster but requires more | |
42 | * checkpoints). | |
43 | * <p> | |
44 | * Locating a specific checkpoint is trivial for both rank (rank % interval) and | |
45 | * timestamp (bsearch in the array). | |
9b749023 | 46 | * |
f7703ed6 FC |
47 | * @version 1.0 |
48 | * @author Francois Chouinard | |
49 | * | |
f7703ed6 FC |
50 | * @see ITmfTrace |
51 | * @see ITmfEvent | |
20658947 | 52 | */ |
6256d8ad | 53 | public class TmfCheckpointIndexer implements ITmfTraceIndexer { |
20658947 FC |
54 | |
55 | // ------------------------------------------------------------------------ | |
56 | // Attributes | |
57 | // ------------------------------------------------------------------------ | |
58 | ||
0316808c | 59 | // The event trace to index |
6256d8ad | 60 | protected final ITmfTrace fTrace; |
20658947 | 61 | |
0316808c FC |
62 | // The interval between checkpoints |
63 | private final int fCheckpointInterval; | |
20658947 | 64 | |
9e0640dc FC |
65 | // The event trace to index |
66 | private boolean fIsIndexing; | |
67 | ||
20658947 FC |
68 | /** |
69 | * The trace index. It is composed of checkpoints taken at intervals of | |
70 | * fCheckpointInterval events. | |
71 | */ | |
3bd44ac8 | 72 | protected final List<ITmfCheckpoint> fTraceIndex; |
20658947 | 73 | |
b5ee6881 | 74 | /** |
9b749023 | 75 | * The indexing request |
b5ee6881 | 76 | */ |
6256d8ad | 77 | private ITmfEventRequest fIndexingRequest = null; |
9b749023 | 78 | |
20658947 FC |
79 | // ------------------------------------------------------------------------ |
80 | // Construction | |
81 | // ------------------------------------------------------------------------ | |
82 | ||
83 | /** | |
84 | * Basic constructor that uses the default trace block size as checkpoints | |
85 | * intervals | |
9b749023 | 86 | * |
20658947 FC |
87 | * @param trace the trace to index |
88 | */ | |
6256d8ad | 89 | public TmfCheckpointIndexer(final ITmfTrace trace) { |
9b749023 | 90 | this(trace, TmfDataProvider.DEFAULT_BLOCK_SIZE); |
20658947 FC |
91 | } |
92 | ||
93 | /** | |
94 | * Full trace indexer | |
9b749023 | 95 | * |
20658947 FC |
96 | * @param trace the trace to index |
97 | * @param interval the checkpoints interval | |
98 | */ | |
6256d8ad | 99 | public TmfCheckpointIndexer(final ITmfTrace trace, final int interval) { |
20658947 FC |
100 | fTrace = trace; |
101 | fCheckpointInterval = interval; | |
3427112b | 102 | fTraceIndex = new ArrayList<ITmfCheckpoint>(); |
9e0640dc FC |
103 | fIsIndexing = false; |
104 | } | |
105 | ||
b5ee6881 FC |
106 | /* (non-Javadoc) |
107 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTraceIndexer#dispose() | |
108 | */ | |
109 | @Override | |
110 | public void dispose() { | |
111 | if ((fIndexingRequest != null) && !fIndexingRequest.isCompleted()) { | |
112 | fIndexingRequest.cancel(); | |
113 | fTraceIndex.clear(); | |
114 | } | |
115 | } | |
116 | ||
9e0640dc FC |
117 | // ------------------------------------------------------------------------ |
118 | // ITmfTraceIndexer - isIndexing | |
119 | // ------------------------------------------------------------------------ | |
120 | ||
121 | /* (non-Javadoc) | |
122 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTraceIndexer#isIndexing() | |
123 | */ | |
124 | @Override | |
125 | public boolean isIndexing() { | |
126 | return fIsIndexing; | |
20658947 FC |
127 | } |
128 | ||
129 | // ------------------------------------------------------------------------ | |
1703b536 | 130 | // ITmfTraceIndexer - buildIndex |
20658947 FC |
131 | // ------------------------------------------------------------------------ |
132 | ||
133 | /* (non-Javadoc) | |
9b749023 | 134 | * |
20658947 FC |
135 | * The index is a list of contexts that point to events at regular interval |
136 | * (rank-wise) in the trace. After it is built, the index can be used to | |
137 | * quickly access any event by rank or timestamp (using seekIndex()). | |
9b749023 | 138 | * |
20658947 | 139 | * The index is built simply by reading the trace |
9e0640dc FC |
140 | * |
141 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTraceIndexer#buildIndex(long, org.eclipse.linuxtools.tmf.core.event.TmfTimeRange, boolean) | |
20658947 FC |
142 | */ |
143 | @Override | |
9e0640dc FC |
144 | public void buildIndex(final long offset, final TmfTimeRange range, final boolean waitForCompletion) { |
145 | ||
9b749023 | 146 | // Don't do anything if we are already indexing |
9e0640dc FC |
147 | synchronized (fTraceIndex) { |
148 | if (fIsIndexing) { | |
149 | return; | |
150 | } | |
151 | fIsIndexing = true; | |
152 | } | |
20658947 FC |
153 | |
154 | // The monitoring job | |
155 | final Job job = new Job("Indexing " + fTrace.getName() + "...") { //$NON-NLS-1$ //$NON-NLS-2$ | |
156 | @Override | |
157 | protected IStatus run(final IProgressMonitor monitor) { | |
158 | while (!monitor.isCanceled()) { | |
159 | try { | |
160 | Thread.sleep(100); | |
161 | } catch (final InterruptedException e) { | |
162 | return Status.OK_STATUS; | |
163 | } | |
164 | } | |
165 | monitor.done(); | |
166 | return Status.OK_STATUS; | |
167 | } | |
168 | }; | |
169 | job.schedule(); | |
170 | ||
20658947 | 171 | // Build a background request for all the trace data. The index is |
07671572 | 172 | // updated as we go by readNextEvent(). |
6256d8ad | 173 | fIndexingRequest = new TmfEventRequest(ITmfEvent.class, |
9e0640dc | 174 | range, offset, TmfDataRequest.ALL_DATA, fCheckpointInterval, ITmfDataRequest.ExecutionType.BACKGROUND) |
d337369a | 175 | { |
20658947 FC |
176 | @Override |
177 | public void handleData(final ITmfEvent event) { | |
178 | super.handleData(event); | |
179 | if (event != null) { | |
20658947 FC |
180 | // Update the trace status at regular intervals |
181 | if ((getNbRead() % fCheckpointInterval) == 0) { | |
182 | updateTraceStatus(); | |
183 | } | |
184 | } | |
185 | } | |
186 | ||
187 | @Override | |
188 | public void handleSuccess() { | |
189 | updateTraceStatus(); | |
190 | } | |
191 | ||
192 | @Override | |
193 | public void handleCompleted() { | |
194 | job.cancel(); | |
195 | super.handleCompleted(); | |
9e0640dc | 196 | fIsIndexing = false; |
20658947 FC |
197 | } |
198 | ||
199 | private void updateTraceStatus() { | |
736988de PT |
200 | if (fTrace.getNbEvents() > 0) { |
201 | signalNewTimeRange(fTrace.getStartTime(), fTrace.getEndTime()); | |
20658947 FC |
202 | } |
203 | } | |
d337369a | 204 | }; |
20658947 | 205 | |
d337369a | 206 | // Submit the request and wait for completion if required |
b5ee6881 | 207 | fTrace.sendRequest(fIndexingRequest); |
d337369a FC |
208 | if (waitForCompletion) { |
209 | try { | |
b5ee6881 | 210 | fIndexingRequest.waitForCompletion(); |
d337369a FC |
211 | } catch (final InterruptedException e) { |
212 | } | |
213 | } | |
20658947 FC |
214 | } |
215 | ||
7e6347b0 FC |
216 | /** |
217 | * Notify the interested parties that the trace time range has changed | |
9b749023 | 218 | * |
7e6347b0 FC |
219 | * @param startTime the new start time |
220 | * @param endTime the new end time | |
221 | */ | |
222 | private void signalNewTimeRange(final ITmfTimestamp startTime, final ITmfTimestamp endTime) { | |
1703b536 FC |
223 | fTrace.broadcast(new TmfTraceUpdatedSignal(fTrace, fTrace, new TmfTimeRange(startTime, endTime))); |
224 | } | |
225 | ||
226 | // ------------------------------------------------------------------------ | |
227 | // ITmfTraceIndexer - updateIndex | |
228 | // ------------------------------------------------------------------------ | |
229 | ||
d337369a FC |
230 | /* (non-Javadoc) |
231 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTraceIndexer#updateIndex(org.eclipse.linuxtools.tmf.core.trace.ITmfContext, org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp) | |
232 | */ | |
1703b536 | 233 | @Override |
d337369a FC |
234 | public synchronized void updateIndex(final ITmfContext context, final ITmfTimestamp timestamp) { |
235 | final long rank = context.getRank(); | |
1703b536 FC |
236 | if ((rank % fCheckpointInterval) == 0) { |
237 | // Determine the table position | |
238 | final long position = rank / fCheckpointInterval; | |
239 | // Add new entry at proper location (if empty) | |
240 | if (fTraceIndex.size() == position) { | |
17324c9a | 241 | fTraceIndex.add(new TmfCheckpoint(timestamp.clone(), saveContext(context))); |
1703b536 FC |
242 | } |
243 | } | |
244 | } | |
245 | ||
246 | // ------------------------------------------------------------------------ | |
247 | // ITmfTraceIndexer - seekIndex | |
248 | // ------------------------------------------------------------------------ | |
20658947 FC |
249 | |
250 | /* (non-Javadoc) | |
251 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTraceIndexer#seekIndex(org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp) | |
252 | */ | |
253 | @Override | |
1703b536 | 254 | public synchronized ITmfContext seekIndex(final ITmfTimestamp timestamp) { |
20658947 | 255 | |
1703b536 | 256 | // A null timestamp indicates to seek the first event |
0316808c | 257 | if (timestamp == null) { |
7e6347b0 | 258 | return fTrace.seekEvent(0); |
0316808c | 259 | } |
20658947 | 260 | |
1703b536 FC |
261 | // Find the checkpoint at or before the requested timestamp. |
262 | // In the very likely event that the timestamp is not at a checkpoint | |
263 | // boundary, bsearch will return index = (- (insertion point + 1)). | |
264 | // It is then trivial to compute the index of the previous checkpoint. | |
265 | int index = Collections.binarySearch(fTraceIndex, new TmfCheckpoint(timestamp, null)); | |
20658947 FC |
266 | if (index < 0) { |
267 | index = Math.max(0, -(index + 2)); | |
268 | } | |
269 | ||
270 | // Position the trace at the checkpoint | |
408e65d2 | 271 | return restoreCheckpoint(index); |
20658947 FC |
272 | } |
273 | ||
1703b536 FC |
274 | /* (non-Javadoc) |
275 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTraceIndexer#seekIndex(long) | |
276 | */ | |
20658947 FC |
277 | @Override |
278 | public ITmfContext seekIndex(final long rank) { | |
279 | ||
f6ad2e3d FC |
280 | // A rank < 0 indicates to seek the first event |
281 | if (rank < 0) { | |
282 | return fTrace.seekEvent(0); | |
283 | } | |
1703b536 | 284 | |
f6ad2e3d FC |
285 | // Find the checkpoint at or before the requested rank. |
286 | final int index = (int) rank / fCheckpointInterval; | |
1703b536 | 287 | |
f6ad2e3d | 288 | // Position the trace at the checkpoint |
408e65d2 | 289 | return restoreCheckpoint(index); |
1703b536 FC |
290 | } |
291 | ||
292 | /** | |
293 | * Position the trace at the given checkpoint | |
9b749023 | 294 | * |
0316808c | 295 | * @param checkpoint the checkpoint index |
1703b536 FC |
296 | * @return the corresponding context |
297 | */ | |
408e65d2 | 298 | private ITmfContext restoreCheckpoint(final int checkpoint) { |
1e1bef82 | 299 | ITmfLocation location = null; |
3427112b | 300 | int index = 0; |
20658947 | 301 | synchronized (fTraceIndex) { |
1703b536 | 302 | if (!fTraceIndex.isEmpty()) { |
3427112b | 303 | index = checkpoint; |
20658947 FC |
304 | if (index >= fTraceIndex.size()) { |
305 | index = fTraceIndex.size() - 1; | |
306 | } | |
3bd44ac8 | 307 | return restoreContext(fTraceIndex.get(index).getContext()); |
20658947 FC |
308 | } |
309 | } | |
7e6347b0 | 310 | final ITmfContext context = fTrace.seekEvent(location); |
afc86f78 | 311 | context.setRank((long) index * fCheckpointInterval); |
20658947 FC |
312 | return context; |
313 | } | |
314 | ||
0316808c FC |
315 | // ------------------------------------------------------------------------ |
316 | // Getters | |
317 | // ------------------------------------------------------------------------ | |
318 | ||
319 | /** | |
320 | * @return the trace index | |
321 | */ | |
3427112b | 322 | protected List<ITmfCheckpoint> getTraceIndex() { |
0316808c FC |
323 | return fTraceIndex; |
324 | } | |
3bd44ac8 FC |
325 | |
326 | // ------------------------------------------------------------------------ | |
327 | // Context conversion functions | |
328 | // ------------------------------------------------------------------------ | |
329 | ||
17324c9a | 330 | private static ITmfContext saveContext(ITmfContext context) { |
3bd44ac8 | 331 | if (context instanceof TmfExperimentContext) { |
17324c9a | 332 | return saveExpContext(context); |
3bd44ac8 FC |
333 | } |
334 | TmfContext ctx = new TmfContext(context.getLocation().clone(), context.getRank()); | |
335 | return ctx; | |
336 | } | |
337 | ||
17324c9a | 338 | private static ITmfContext saveExpContext(ITmfContext context) { |
3bd44ac8 FC |
339 | TmfExperimentContext expContext = (TmfExperimentContext) context; |
340 | int size = expContext.getContexts().length; | |
341 | ITmfContext[] trcCtxts = new TmfContext[size]; | |
342 | for (int i = 0; i < size; i++) { | |
343 | ITmfContext ctx = expContext.getContexts()[i]; | |
344 | trcCtxts[i] = (ctx != null) ? new TmfContext(ctx.getLocation().clone(), ctx.getRank()) : null; | |
345 | } | |
346 | TmfExperimentContext expCtx = new TmfExperimentContext(trcCtxts); | |
347 | expCtx.setLocation(context.getLocation().clone()); | |
348 | expCtx.setRank(context.getRank()); | |
349 | ITmfEvent[] trcEvts = expCtx.getEvents(); | |
350 | for (int i = 0; i < size; i++) { | |
351 | ITmfEvent event = expContext.getEvents()[i]; | |
352 | trcEvts[i] = (event != null) ? event.clone() : null; | |
353 | } | |
354 | return expCtx; | |
355 | } | |
356 | ||
357 | private ITmfContext restoreContext(ITmfContext context) { | |
358 | if (context instanceof TmfExperimentContext) { | |
359 | return restoreExpContext(context); | |
360 | } | |
361 | ITmfContext ctx = fTrace.seekEvent(context.getLocation()); | |
362 | ctx.setRank(context.getRank()); | |
363 | return ctx; | |
364 | } | |
365 | ||
366 | private ITmfContext restoreExpContext(ITmfContext context) { | |
367 | TmfExperimentContext expContext = (TmfExperimentContext) context; | |
368 | int size = expContext.getContexts().length; | |
369 | ITmfContext[] trcCtxts = new ITmfContext[size]; | |
370 | for (int i = 0; i < size; i++) { | |
6256d8ad | 371 | ITmfTrace trace = ((TmfExperiment) fTrace).getTraces()[i]; |
3bd44ac8 FC |
372 | ITmfContext ctx = expContext.getContexts()[i]; |
373 | trcCtxts[i] = trace.seekEvent(ctx.getLocation().clone()); | |
374 | trcCtxts[i].setRank(ctx.getRank()); | |
375 | } | |
376 | TmfExperimentContext ctx = new TmfExperimentContext(trcCtxts); | |
377 | ctx.setLocation(context.getLocation().clone()); | |
378 | ctx.setRank(context.getRank()); | |
379 | ITmfEvent[] trcEvts = expContext.getEvents(); | |
380 | for (int i = 0; i < size; i++) { | |
381 | ITmfEvent event = trcEvts[i]; | |
382 | ctx.getEvents()[i] = (event != null) ? event.clone() : null; | |
383 | } | |
384 | return ctx; | |
385 | } | |
17324c9a | 386 | |
20658947 | 387 | } |