| 1 | /******************************************************************************* |
| 2 | * Copyright (c) 2009, 2010 Ericsson |
| 3 | * |
| 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 |
| 8 | * |
| 9 | * Contributors: |
| 10 | * Francois Chouinard - Initial API and implementation |
| 11 | *******************************************************************************/ |
| 12 | |
| 13 | package org.eclipse.linuxtools.tmf.trace; |
| 14 | |
| 15 | import java.io.File; |
| 16 | import java.io.FileNotFoundException; |
| 17 | import java.util.Collections; |
| 18 | import java.util.Vector; |
| 19 | |
| 20 | import org.eclipse.core.resources.IProject; |
| 21 | import org.eclipse.core.runtime.IProgressMonitor; |
| 22 | import org.eclipse.core.runtime.IStatus; |
| 23 | import org.eclipse.core.runtime.Status; |
| 24 | import org.eclipse.core.runtime.jobs.Job; |
| 25 | import org.eclipse.linuxtools.tmf.component.TmfEventProvider; |
| 26 | import org.eclipse.linuxtools.tmf.event.TmfEvent; |
| 27 | import org.eclipse.linuxtools.tmf.event.TmfTimeRange; |
| 28 | import org.eclipse.linuxtools.tmf.event.TmfTimestamp; |
| 29 | import org.eclipse.linuxtools.tmf.request.ITmfDataRequest; |
| 30 | import org.eclipse.linuxtools.tmf.request.ITmfEventRequest; |
| 31 | import org.eclipse.linuxtools.tmf.request.TmfDataRequest; |
| 32 | import org.eclipse.linuxtools.tmf.request.TmfEventRequest; |
| 33 | import org.eclipse.linuxtools.tmf.signal.TmfTraceUpdatedSignal; |
| 34 | |
| 35 | /** |
| 36 | * <b><u>TmfTrace</u></b> |
| 37 | * <p> |
| 38 | * Abstract implementation of ITmfTrace. It should be sufficient to extend this class and provide implementation for |
| 39 | * <code>getCurrentLocation()</code> and <code>seekLocation()</code>, as well as a proper parser, to have a working |
| 40 | * concrete implementation. |
| 41 | * <p> |
| 42 | * Note: The notion of event rank is still under heavy discussion. Although used by the Events View and probably useful |
| 43 | * in the general case, there is no easy way to implement it for LTTng (actually a strong case is being made that this |
| 44 | * is useless). |
| 45 | * <p> |
| 46 | * That it is not supported by LTTng does by no mean indicate that it is not useful for (just about) every other tracing |
| 47 | * tool. Therefore, this class provides a minimal (and partial) implementation of rank. However, the current |
| 48 | * implementation should not be relied on in the general case. |
| 49 | * |
| 50 | * TODO: Add support for live streaming (notifications, incremental indexing, ...) |
| 51 | */ |
| 52 | public abstract class TmfTrace<T extends TmfEvent> extends TmfEventProvider<T> implements ITmfTrace<T>, Cloneable { |
| 53 | |
| 54 | // ------------------------------------------------------------------------ |
| 55 | // Constants |
| 56 | // ------------------------------------------------------------------------ |
| 57 | |
| 58 | // The default number of events to cache |
| 59 | // TODO: Make the DEFAULT_CACHE_SIZE a preference |
| 60 | public static final int DEFAULT_INDEX_PAGE_SIZE = 50000; |
| 61 | |
| 62 | // ------------------------------------------------------------------------ |
| 63 | // Attributes |
| 64 | // ------------------------------------------------------------------------ |
| 65 | |
| 66 | // The trace path |
| 67 | private String fPath; |
| 68 | |
| 69 | // The trace name |
| 70 | private String fTraceName; |
| 71 | |
| 72 | // The cache page size AND checkpoints interval |
| 73 | protected int fIndexPageSize = DEFAULT_INDEX_PAGE_SIZE; |
| 74 | |
| 75 | // The set of event stream checkpoints (for random access) |
| 76 | protected Vector<TmfCheckpoint> fCheckpoints = new Vector<TmfCheckpoint>(); |
| 77 | |
| 78 | // The number of events collected |
| 79 | protected long fNbEvents = 0; |
| 80 | |
| 81 | // The time span of the event stream |
| 82 | private TmfTimestamp fStartTime = TmfTimestamp.BigCrunch; |
| 83 | private TmfTimestamp fEndTime = TmfTimestamp.BigBang; |
| 84 | |
| 85 | // ------------------------------------------------------------------------ |
| 86 | // Constructors |
| 87 | // ------------------------------------------------------------------------ |
| 88 | |
| 89 | public TmfTrace() { |
| 90 | super(); |
| 91 | } |
| 92 | |
| 93 | @Override |
| 94 | public void initTrace(String path, Class<T> eventType) throws FileNotFoundException { |
| 95 | initTmfTrace(path, eventType, DEFAULT_INDEX_PAGE_SIZE, false); |
| 96 | } |
| 97 | |
| 98 | @Override |
| 99 | public void initTrace(String path, Class<T> eventType, int cacheSize) throws FileNotFoundException { |
| 100 | initTmfTrace(path, eventType, cacheSize, false); |
| 101 | } |
| 102 | |
| 103 | @Override |
| 104 | public void initTrace(String path, Class<T> eventType, boolean indexTrace) throws FileNotFoundException { |
| 105 | initTmfTrace(path, eventType, DEFAULT_INDEX_PAGE_SIZE, indexTrace); |
| 106 | } |
| 107 | |
| 108 | @Override |
| 109 | public void initTrace(String path, Class<T> eventType, int cacheSize, boolean indexTrace) throws FileNotFoundException { |
| 110 | initTmfTrace(path, eventType, cacheSize, indexTrace); |
| 111 | } |
| 112 | |
| 113 | private void initTmfTrace(String path, Class<T> eventType, int cacheSize, boolean indexTrace) throws FileNotFoundException { |
| 114 | fPath = path; |
| 115 | if (fTraceName == null) { |
| 116 | fTraceName = ""; //$NON-NLS-1$ |
| 117 | if (path != null) { |
| 118 | int sep = path.lastIndexOf(File.separator); |
| 119 | fTraceName = (sep >= 0) ? path.substring(sep + 1) : path; |
| 120 | } |
| 121 | } |
| 122 | super.init(fTraceName, eventType); |
| 123 | fIndexPageSize = (cacheSize > 0) ? cacheSize : DEFAULT_INDEX_PAGE_SIZE; |
| 124 | if (indexTrace) |
| 125 | indexTrace(false); |
| 126 | } |
| 127 | |
| 128 | @Override |
| 129 | public boolean validate(IProject project, String path) { |
| 130 | File file = new File(path); |
| 131 | return file.exists(); |
| 132 | } |
| 133 | |
| 134 | /** |
| 135 | * @param path |
| 136 | * @throws FileNotFoundException |
| 137 | */ |
| 138 | protected TmfTrace(String name, Class<T> type, String path) throws FileNotFoundException { |
| 139 | this(name, type, path, DEFAULT_INDEX_PAGE_SIZE, true); |
| 140 | } |
| 141 | |
| 142 | /** |
| 143 | * @param path |
| 144 | * @param cacheSize |
| 145 | * @throws FileNotFoundException |
| 146 | */ |
| 147 | protected TmfTrace(String name, Class<T> type, String path, int cacheSize) throws FileNotFoundException { |
| 148 | this(name, type, path, cacheSize, true); |
| 149 | } |
| 150 | |
| 151 | /** |
| 152 | * @param path |
| 153 | * @param indexTrace |
| 154 | * @throws FileNotFoundException |
| 155 | */ |
| 156 | protected TmfTrace(String name, Class<T> type, String path, boolean indexTrace) throws FileNotFoundException { |
| 157 | this(name, type, path, DEFAULT_INDEX_PAGE_SIZE, indexTrace); |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * @param path |
| 162 | * @param cacheSize |
| 163 | * @param indexTrace |
| 164 | * @throws FileNotFoundException |
| 165 | */ |
| 166 | protected TmfTrace(String name, Class<T> type, String path, int cacheSize, boolean indexTrace) throws FileNotFoundException { |
| 167 | super(); |
| 168 | fTraceName = name; |
| 169 | initTrace(path, type, cacheSize, indexTrace); |
| 170 | } |
| 171 | |
| 172 | @SuppressWarnings("unchecked") |
| 173 | @Override |
| 174 | public TmfTrace<T> clone() throws CloneNotSupportedException { |
| 175 | TmfTrace<T> clone = (TmfTrace<T>) super.clone(); |
| 176 | clone.fCheckpoints = fCheckpoints; |
| 177 | clone.fStartTime = new TmfTimestamp(fStartTime); |
| 178 | clone.fEndTime = new TmfTimestamp(fEndTime); |
| 179 | return clone; |
| 180 | } |
| 181 | |
| 182 | // ------------------------------------------------------------------------ |
| 183 | // Accessors |
| 184 | // ------------------------------------------------------------------------ |
| 185 | |
| 186 | /** |
| 187 | * @return the trace path |
| 188 | */ |
| 189 | @Override |
| 190 | public String getPath() { |
| 191 | return fPath; |
| 192 | } |
| 193 | |
| 194 | /* (non-Javadoc) |
| 195 | * @see org.eclipse.linuxtools.tmf.stream.ITmfEventStream#getNbEvents() |
| 196 | */ |
| 197 | @Override |
| 198 | public long getNbEvents() { |
| 199 | return fNbEvents; |
| 200 | } |
| 201 | |
| 202 | /** |
| 203 | * @return the size of the cache |
| 204 | */ |
| 205 | @Override |
| 206 | public int getCacheSize() { |
| 207 | return fIndexPageSize; |
| 208 | } |
| 209 | |
| 210 | /* (non-Javadoc) |
| 211 | * @see org.eclipse.linuxtools.tmf.stream.ITmfEventStream#getTimeRange() |
| 212 | */ |
| 213 | @Override |
| 214 | public TmfTimeRange getTimeRange() { |
| 215 | return new TmfTimeRange(fStartTime, fEndTime); |
| 216 | } |
| 217 | |
| 218 | /* (non-Javadoc) |
| 219 | * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getStartTime() |
| 220 | */ |
| 221 | @Override |
| 222 | public TmfTimestamp getStartTime() { |
| 223 | return fStartTime; |
| 224 | } |
| 225 | |
| 226 | /* (non-Javadoc) |
| 227 | * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getEndTime() |
| 228 | */ |
| 229 | @Override |
| 230 | public TmfTimestamp getEndTime() { |
| 231 | return fEndTime; |
| 232 | } |
| 233 | |
| 234 | @SuppressWarnings("unchecked") |
| 235 | public Vector<TmfCheckpoint> getCheckpoints() { |
| 236 | return (Vector<TmfCheckpoint>) fCheckpoints.clone(); |
| 237 | } |
| 238 | |
| 239 | /** |
| 240 | * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event |
| 241 | * (if any). |
| 242 | * |
| 243 | * @param timestamp |
| 244 | * @return |
| 245 | */ |
| 246 | @Override |
| 247 | public long getRank(TmfTimestamp timestamp) { |
| 248 | TmfContext context = seekEvent(timestamp); |
| 249 | return context.getRank(); |
| 250 | } |
| 251 | |
| 252 | // ------------------------------------------------------------------------ |
| 253 | // Operators |
| 254 | // ------------------------------------------------------------------------ |
| 255 | |
| 256 | protected void setTimeRange(TmfTimeRange range) { |
| 257 | fStartTime = range.getStartTime(); |
| 258 | fEndTime = range.getEndTime(); |
| 259 | } |
| 260 | |
| 261 | protected void setStartTime(TmfTimestamp startTime) { |
| 262 | fStartTime = startTime; |
| 263 | } |
| 264 | |
| 265 | protected void setEndTime(TmfTimestamp endTime) { |
| 266 | fEndTime = endTime; |
| 267 | } |
| 268 | |
| 269 | // ------------------------------------------------------------------------ |
| 270 | // TmfProvider |
| 271 | // ------------------------------------------------------------------------ |
| 272 | |
| 273 | @Override |
| 274 | public ITmfContext armRequest(ITmfDataRequest<T> request) { |
| 275 | if (request instanceof ITmfEventRequest<?> |
| 276 | && !TmfTimestamp.BigBang.equals(((ITmfEventRequest<T>) request).getRange().getStartTime()) && request.getIndex() == 0) { |
| 277 | ITmfContext context = seekEvent(((ITmfEventRequest<T>) request).getRange().getStartTime()); |
| 278 | ((ITmfEventRequest<T>) request).setStartIndex((int) context.getRank()); |
| 279 | return context; |
| 280 | |
| 281 | } |
| 282 | return seekEvent(request.getIndex()); |
| 283 | } |
| 284 | |
| 285 | /** |
| 286 | * Return the next piece of data based on the context supplied. The context would typically be updated for the |
| 287 | * subsequent read. |
| 288 | * |
| 289 | * @param context |
| 290 | * @return |
| 291 | */ |
| 292 | @SuppressWarnings("unchecked") |
| 293 | @Override |
| 294 | public T getNext(ITmfContext context) { |
| 295 | if (context instanceof TmfContext) { |
| 296 | return (T) getNextEvent((TmfContext) context); |
| 297 | } |
| 298 | return null; |
| 299 | } |
| 300 | |
| 301 | // ------------------------------------------------------------------------ |
| 302 | // ITmfTrace |
| 303 | // ------------------------------------------------------------------------ |
| 304 | |
| 305 | /* (non-Javadoc) |
| 306 | * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.event.TmfTimestamp) |
| 307 | */ |
| 308 | @Override |
| 309 | public TmfContext seekEvent(TmfTimestamp timestamp) { |
| 310 | |
| 311 | if (timestamp == null) { |
| 312 | timestamp = TmfTimestamp.BigBang; |
| 313 | } |
| 314 | |
| 315 | // First, find the right checkpoint |
| 316 | int index = Collections.binarySearch(fCheckpoints, new TmfCheckpoint(timestamp, null)); |
| 317 | |
| 318 | // In the very likely case that the checkpoint was not found, bsearch |
| 319 | // returns its negated would-be location (not an offset...). From that |
| 320 | // index, we can then position the stream and get the event. |
| 321 | if (index < 0) { |
| 322 | index = Math.max(0, -(index + 2)); |
| 323 | } |
| 324 | |
| 325 | // Position the stream at the checkpoint |
| 326 | ITmfLocation<?> location; |
| 327 | synchronized (fCheckpoints) { |
| 328 | if (fCheckpoints.size() > 0) { |
| 329 | if (index >= fCheckpoints.size()) { |
| 330 | index = fCheckpoints.size() - 1; |
| 331 | } |
| 332 | location = fCheckpoints.elementAt(index).getLocation(); |
| 333 | } else { |
| 334 | location = null; |
| 335 | } |
| 336 | } |
| 337 | TmfContext context = seekLocation(location); |
| 338 | context.setRank(index * fIndexPageSize); |
| 339 | |
| 340 | // And locate the event |
| 341 | TmfContext nextEventContext = context.clone(); // Must use clone() to get the right subtype... |
| 342 | TmfEvent event = getNextEvent(nextEventContext); |
| 343 | while (event != null && event.getTimestamp().compareTo(timestamp, false) < 0) { |
| 344 | context.setLocation(nextEventContext.getLocation().clone()); |
| 345 | context.updateRank(1); |
| 346 | event = getNextEvent(nextEventContext); |
| 347 | } |
| 348 | |
| 349 | return context; |
| 350 | } |
| 351 | |
| 352 | /* (non-Javadoc) |
| 353 | * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#seekEvent(int) |
| 354 | */ |
| 355 | @Override |
| 356 | public TmfContext seekEvent(long rank) { |
| 357 | |
| 358 | // Position the stream at the previous checkpoint |
| 359 | int index = (int) rank / fIndexPageSize; |
| 360 | ITmfLocation<?> location; |
| 361 | synchronized (fCheckpoints) { |
| 362 | if (fCheckpoints.size() == 0) { |
| 363 | location = null; |
| 364 | } else { |
| 365 | if (index >= fCheckpoints.size()) { |
| 366 | index = fCheckpoints.size() - 1; |
| 367 | } |
| 368 | location = fCheckpoints.elementAt(index).getLocation(); |
| 369 | } |
| 370 | } |
| 371 | |
| 372 | TmfContext context = seekLocation(location); |
| 373 | long pos = index * fIndexPageSize; |
| 374 | context.setRank(pos); |
| 375 | |
| 376 | if (pos < rank) { |
| 377 | TmfEvent event = getNextEvent(context); |
| 378 | while (event != null && ++pos < rank) { |
| 379 | event = getNextEvent(context); |
| 380 | } |
| 381 | } |
| 382 | |
| 383 | return context; |
| 384 | } |
| 385 | |
| 386 | /* |
| 387 | * (non-Javadoc) |
| 388 | * |
| 389 | * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getNextEvent(org.eclipse. |
| 390 | * linuxtools.tmf.trace.ITmfTrace.TraceContext) |
| 391 | */ |
| 392 | @Override |
| 393 | public synchronized TmfEvent getNextEvent(TmfContext context) { |
| 394 | // parseEvent() does not update the context |
| 395 | TmfEvent event = parseEvent(context); |
| 396 | if (event != null) { |
| 397 | updateIndex(context, context.getRank(), event.getTimestamp()); |
| 398 | context.setLocation(getCurrentLocation()); |
| 399 | context.updateRank(1); |
| 400 | processEvent(event); |
| 401 | } |
| 402 | return event; |
| 403 | } |
| 404 | |
| 405 | protected synchronized void updateIndex(ITmfContext context, long rank, TmfTimestamp timestamp) { |
| 406 | if (fStartTime.compareTo(timestamp, false) > 0) |
| 407 | fStartTime = timestamp; |
| 408 | if (fEndTime.compareTo(timestamp, false) < 0) |
| 409 | fEndTime = timestamp; |
| 410 | if (context.isValidRank()) { |
| 411 | if (fNbEvents <= rank) |
| 412 | fNbEvents = rank + 1; |
| 413 | // Build the index as we go along |
| 414 | if ((rank % fIndexPageSize) == 0) { |
| 415 | // Determine the table position |
| 416 | long position = rank / fIndexPageSize; |
| 417 | // Add new entry at proper location (if empty) |
| 418 | if (fCheckpoints.size() == position) { |
| 419 | ITmfLocation<?> location = context.getLocation().clone(); |
| 420 | fCheckpoints.add(new TmfCheckpoint(timestamp.clone(), location)); |
| 421 | // System.out.println(getName() + "[" + (fCheckpoints.size() |
| 422 | // - 1) + "] " + timestamp + ", " + location.toString()); |
| 423 | } |
| 424 | } |
| 425 | } |
| 426 | } |
| 427 | |
| 428 | /** |
| 429 | * Hook for special processing by the concrete class (called by getNextEvent()) |
| 430 | * |
| 431 | * @param event |
| 432 | */ |
| 433 | protected void processEvent(TmfEvent event) { |
| 434 | // Do nothing by default |
| 435 | } |
| 436 | |
| 437 | // ------------------------------------------------------------------------ |
| 438 | // toString |
| 439 | // ------------------------------------------------------------------------ |
| 440 | |
| 441 | /* (non-Javadoc) |
| 442 | * @see java.lang.Object#toString() |
| 443 | */ |
| 444 | @Override |
| 445 | @SuppressWarnings("nls") |
| 446 | public String toString() { |
| 447 | return "[TmfTrace (" + getName() + ")]"; |
| 448 | } |
| 449 | |
| 450 | // ------------------------------------------------------------------------ |
| 451 | // Indexing |
| 452 | // ------------------------------------------------------------------------ |
| 453 | |
| 454 | /* |
| 455 | * The purpose of the index is to keep the information needed to rapidly |
| 456 | * restore the traces contexts at regular intervals (every INDEX_PAGE_SIZE |
| 457 | * event). |
| 458 | */ |
| 459 | |
| 460 | @SuppressWarnings({ "unchecked" }) |
| 461 | protected void indexTrace(boolean waitForCompletion) { |
| 462 | |
| 463 | final Job job = new Job("Indexing " + getName() + "...") { //$NON-NLS-1$ //$NON-NLS-2$ |
| 464 | @Override |
| 465 | protected IStatus run(IProgressMonitor monitor) { |
| 466 | while (!monitor.isCanceled()) { |
| 467 | try { |
| 468 | Thread.sleep(100); |
| 469 | } catch (InterruptedException e) { |
| 470 | return Status.OK_STATUS; |
| 471 | } |
| 472 | } |
| 473 | monitor.done(); |
| 474 | return Status.OK_STATUS; |
| 475 | } |
| 476 | }; |
| 477 | job.schedule(); |
| 478 | |
| 479 | fCheckpoints.clear(); |
| 480 | ITmfEventRequest<TmfEvent> request = new TmfEventRequest<TmfEvent>(TmfEvent.class, TmfTimeRange.Eternity, TmfDataRequest.ALL_DATA, |
| 481 | fIndexPageSize, ITmfDataRequest.ExecutionType.BACKGROUND) { |
| 482 | |
| 483 | TmfTimestamp startTime = null; |
| 484 | TmfTimestamp lastTime = null; |
| 485 | |
| 486 | @Override |
| 487 | public void handleData(TmfEvent event) { |
| 488 | super.handleData(event); |
| 489 | if (event != null) { |
| 490 | TmfTimestamp ts = event.getTimestamp(); |
| 491 | if (startTime == null) |
| 492 | startTime = new TmfTimestamp(ts); |
| 493 | lastTime = new TmfTimestamp(ts); |
| 494 | |
| 495 | if ((getNbRead() % fIndexPageSize) == 0) { |
| 496 | updateTrace(); |
| 497 | } |
| 498 | } |
| 499 | } |
| 500 | |
| 501 | @Override |
| 502 | public void handleSuccess() { |
| 503 | updateTrace(); |
| 504 | } |
| 505 | |
| 506 | @Override |
| 507 | public void handleCompleted() { |
| 508 | job.cancel(); |
| 509 | super.handleCompleted(); |
| 510 | } |
| 511 | |
| 512 | private void updateTrace() { |
| 513 | int nbRead = getNbRead(); |
| 514 | if (nbRead != 0) { |
| 515 | fStartTime = startTime; |
| 516 | fEndTime = lastTime; |
| 517 | fNbEvents = nbRead; |
| 518 | notifyListeners(); |
| 519 | } |
| 520 | } |
| 521 | }; |
| 522 | |
| 523 | sendRequest((ITmfDataRequest<T>) request); |
| 524 | if (waitForCompletion) |
| 525 | try { |
| 526 | request.waitForCompletion(); |
| 527 | } catch (InterruptedException e) { |
| 528 | e.printStackTrace(); |
| 529 | } |
| 530 | } |
| 531 | |
| 532 | protected void notifyListeners() { |
| 533 | broadcast(new TmfTraceUpdatedSignal(this, this, new TmfTimeRange(fStartTime, fEndTime))); |
| 534 | } |
| 535 | } |