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; | |
b7952ebe | 23 | import org.eclipse.linuxtools.internal.tmf.core.Messages; |
9b749023 | 24 | import org.eclipse.linuxtools.tmf.core.component.TmfDataProvider; |
20658947 | 25 | import org.eclipse.linuxtools.tmf.core.event.ITmfEvent; |
5419a136 AM |
26 | import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest; |
27 | import org.eclipse.linuxtools.tmf.core.request.ITmfEventRequest; | |
28 | import org.eclipse.linuxtools.tmf.core.request.TmfDataRequest; | |
29 | import org.eclipse.linuxtools.tmf.core.request.TmfEventRequest; | |
20658947 | 30 | import org.eclipse.linuxtools.tmf.core.signal.TmfTraceUpdatedSignal; |
3bd46eef AM |
31 | import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp; |
32 | import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange; | |
20658947 FC |
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 | ||
6f4e8ec0 | 59 | /** The event trace to index */ |
6256d8ad | 60 | protected final ITmfTrace fTrace; |
20658947 | 61 | |
6f4e8ec0 | 62 | /** The interval between checkpoints */ |
0316808c | 63 | private final int fCheckpointInterval; |
20658947 | 64 | |
6f4e8ec0 | 65 | /** The event trace to index */ |
9e0640dc FC |
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 | */ |
5419a136 | 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 | ||
3bd46eef AM |
133 | /** |
134 | * @since 2.0 | |
20658947 FC |
135 | */ |
136 | @Override | |
9e0640dc FC |
137 | public void buildIndex(final long offset, final TmfTimeRange range, final boolean waitForCompletion) { |
138 | ||
9b749023 | 139 | // Don't do anything if we are already indexing |
9e0640dc FC |
140 | synchronized (fTraceIndex) { |
141 | if (fIsIndexing) { | |
142 | return; | |
143 | } | |
144 | fIsIndexing = true; | |
145 | } | |
20658947 FC |
146 | |
147 | // The monitoring job | |
148 | final Job job = new Job("Indexing " + fTrace.getName() + "...") { //$NON-NLS-1$ //$NON-NLS-2$ | |
149 | @Override | |
150 | protected IStatus run(final IProgressMonitor monitor) { | |
b7952ebe | 151 | monitor.beginTask("", IProgressMonitor.UNKNOWN); //$NON-NLS-1$ |
20658947 FC |
152 | while (!monitor.isCanceled()) { |
153 | try { | |
b7952ebe PT |
154 | long prevNbEvents = fTrace.getNbEvents(); |
155 | Thread.sleep(250); | |
156 | long nbEvents = fTrace.getNbEvents(); | |
157 | setName(Messages.TmfCheckpointIndexer_Indexing + ' ' + fTrace.getName() + " (" + nbEvents + ")"); //$NON-NLS-1$ //$NON-NLS-2$ | |
158 | // setName doesn't refresh the UI, setTaskName does | |
159 | long rate = (nbEvents - prevNbEvents) * 4; | |
160 | monitor.setTaskName(rate + " " + Messages.TmfCheckpointIndexer_EventsPerSecond); //$NON-NLS-1$ | |
20658947 FC |
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(). |
5419a136 AM |
173 | fIndexingRequest = new TmfEventRequest(ITmfEvent.class, |
174 | range, offset, TmfDataRequest.ALL_DATA, fCheckpointInterval, ITmfDataRequest.ExecutionType.BACKGROUND) | |
d337369a | 175 | { |
20658947 | 176 | @Override |
5419a136 AM |
177 | public void handleData(final ITmfEvent event) { |
178 | super.handleData(event); | |
20658947 | 179 | if (event != null) { |
20658947 | 180 | // Update the trace status at regular intervals |
5419a136 | 181 | if ((getNbRead() % fCheckpointInterval) == 0) { |
20658947 FC |
182 | updateTraceStatus(); |
183 | } | |
184 | } | |
185 | } | |
186 | ||
187 | @Override | |
188 | public void handleSuccess() { | |
189 | updateTraceStatus(); | |
190 | } | |
191 | ||
192 | @Override | |
5419a136 | 193 | public void handleCompleted() { |
20658947 FC |
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 | ||
3bd46eef AM |
230 | /** |
231 | * @since 2.0 | |
d337369a | 232 | */ |
1703b536 | 233 | @Override |
d337369a | 234 | public synchronized void updateIndex(final ITmfContext context, final ITmfTimestamp timestamp) { |
ea271da6 | 235 | if ((context.getRank() % fCheckpointInterval) == 0) { |
1703b536 | 236 | // Determine the table position |
ea271da6 | 237 | final long position = context.getRank() / fCheckpointInterval; |
1703b536 FC |
238 | // Add new entry at proper location (if empty) |
239 | if (fTraceIndex.size() == position) { | |
ea271da6 | 240 | fTraceIndex.add(new TmfCheckpoint(timestamp, context.getLocation())); |
1703b536 FC |
241 | } |
242 | } | |
243 | } | |
244 | ||
245 | // ------------------------------------------------------------------------ | |
246 | // ITmfTraceIndexer - seekIndex | |
247 | // ------------------------------------------------------------------------ | |
20658947 | 248 | |
3bd46eef AM |
249 | /** |
250 | * @since 2.0 | |
20658947 FC |
251 | */ |
252 | @Override | |
1703b536 | 253 | public synchronized ITmfContext seekIndex(final ITmfTimestamp timestamp) { |
20658947 | 254 | |
1703b536 | 255 | // A null timestamp indicates to seek the first event |
0316808c | 256 | if (timestamp == null) { |
7e6347b0 | 257 | return fTrace.seekEvent(0); |
0316808c | 258 | } |
20658947 | 259 | |
1703b536 FC |
260 | // Find the checkpoint at or before the requested timestamp. |
261 | // In the very likely event that the timestamp is not at a checkpoint | |
262 | // boundary, bsearch will return index = (- (insertion point + 1)). | |
263 | // It is then trivial to compute the index of the previous checkpoint. | |
264 | int index = Collections.binarySearch(fTraceIndex, new TmfCheckpoint(timestamp, null)); | |
20658947 FC |
265 | if (index < 0) { |
266 | index = Math.max(0, -(index + 2)); | |
3eade83c BH |
267 | } else { |
268 | // If timestamp was in the list, use previous index to be able to find the | |
269 | // first event with the same timestamp before the checkpoint | |
270 | index = Math.max(0, index - 1); | |
20658947 FC |
271 | } |
272 | ||
273 | // Position the trace at the checkpoint | |
408e65d2 | 274 | return restoreCheckpoint(index); |
20658947 FC |
275 | } |
276 | ||
1703b536 FC |
277 | /* (non-Javadoc) |
278 | * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTraceIndexer#seekIndex(long) | |
279 | */ | |
20658947 FC |
280 | @Override |
281 | public ITmfContext seekIndex(final long rank) { | |
282 | ||
f6ad2e3d FC |
283 | // A rank < 0 indicates to seek the first event |
284 | if (rank < 0) { | |
285 | return fTrace.seekEvent(0); | |
286 | } | |
1703b536 | 287 | |
f6ad2e3d FC |
288 | // Find the checkpoint at or before the requested rank. |
289 | final int index = (int) rank / fCheckpointInterval; | |
1703b536 | 290 | |
f6ad2e3d | 291 | // Position the trace at the checkpoint |
408e65d2 | 292 | return restoreCheckpoint(index); |
1703b536 FC |
293 | } |
294 | ||
295 | /** | |
296 | * Position the trace at the given checkpoint | |
9b749023 | 297 | * |
0316808c | 298 | * @param checkpoint the checkpoint index |
1703b536 FC |
299 | * @return the corresponding context |
300 | */ | |
408e65d2 | 301 | private ITmfContext restoreCheckpoint(final int checkpoint) { |
1e1bef82 | 302 | ITmfLocation location = null; |
3427112b | 303 | int index = 0; |
20658947 | 304 | synchronized (fTraceIndex) { |
1703b536 | 305 | if (!fTraceIndex.isEmpty()) { |
3427112b | 306 | index = checkpoint; |
20658947 FC |
307 | if (index >= fTraceIndex.size()) { |
308 | index = fTraceIndex.size() - 1; | |
309 | } | |
ea271da6 | 310 | location = fTraceIndex.get(index).getLocation(); |
20658947 FC |
311 | } |
312 | } | |
7e6347b0 | 313 | final ITmfContext context = fTrace.seekEvent(location); |
afc86f78 | 314 | context.setRank((long) index * fCheckpointInterval); |
20658947 FC |
315 | return context; |
316 | } | |
317 | ||
0316808c FC |
318 | // ------------------------------------------------------------------------ |
319 | // Getters | |
320 | // ------------------------------------------------------------------------ | |
321 | ||
322 | /** | |
323 | * @return the trace index | |
324 | */ | |
3427112b | 325 | protected List<ITmfCheckpoint> getTraceIndex() { |
0316808c FC |
326 | return fTraceIndex; |
327 | } | |
3bd44ac8 | 328 | |
20658947 | 329 | } |