1 /*******************************************************************************
2 * Copyright (c) 2009, 2010 Ericsson
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
10 * Francois Chouinard - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.trace
;
16 import java
.io
.FileNotFoundException
;
17 import java
.util
.Collections
;
18 import java
.util
.Vector
;
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
;
36 * <b><u>TmfTrace</u></b>
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.
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
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.
50 * TODO: Add support for live streaming (notifications, incremental indexing, ...)
52 public abstract class TmfTrace
<T
extends TmfEvent
> extends TmfEventProvider
<T
> implements ITmfTrace
<T
>, Cloneable
{
54 // ------------------------------------------------------------------------
56 // ------------------------------------------------------------------------
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;
62 // ------------------------------------------------------------------------
64 // ------------------------------------------------------------------------
70 private String fTraceName
;
72 // The cache page size AND checkpoints interval
73 protected int fIndexPageSize
= DEFAULT_INDEX_PAGE_SIZE
;
75 // The set of event stream checkpoints (for random access)
76 protected Vector
<TmfCheckpoint
> fCheckpoints
= new Vector
<TmfCheckpoint
>();
78 // The number of events collected
79 protected long fNbEvents
= 0;
81 // The time span of the event stream
82 private TmfTimestamp fStartTime
= TmfTimestamp
.BigCrunch
;
83 private TmfTimestamp fEndTime
= TmfTimestamp
.BigBang
;
85 // ------------------------------------------------------------------------
87 // ------------------------------------------------------------------------
94 public void initTrace(String path
, Class
<T
> eventType
) throws FileNotFoundException
{
95 initTmfTrace(path
, eventType
, DEFAULT_INDEX_PAGE_SIZE
, false);
99 public void initTrace(String path
, Class
<T
> eventType
, int cacheSize
) throws FileNotFoundException
{
100 initTmfTrace(path
, eventType
, cacheSize
, false);
104 public void initTrace(String path
, Class
<T
> eventType
, boolean indexTrace
) throws FileNotFoundException
{
105 initTmfTrace(path
, eventType
, DEFAULT_INDEX_PAGE_SIZE
, indexTrace
);
109 public void initTrace(String path
, Class
<T
> eventType
, int cacheSize
, boolean indexTrace
) throws FileNotFoundException
{
110 initTmfTrace(path
, eventType
, cacheSize
, indexTrace
);
113 private void initTmfTrace(String path
, Class
<T
> eventType
, int cacheSize
, boolean indexTrace
) throws FileNotFoundException
{
115 if (fTraceName
== null) {
116 fTraceName
= ""; //$NON-NLS-1$
118 int sep
= path
.lastIndexOf(File
.separator
);
119 fTraceName
= (sep
>= 0) ? path
.substring(sep
+ 1) : path
;
122 super.init(fTraceName
, eventType
);
123 fIndexPageSize
= (cacheSize
> 0) ? cacheSize
: DEFAULT_INDEX_PAGE_SIZE
;
129 public boolean validate(IProject project
, String path
) {
130 File file
= new File(path
);
131 return file
.exists();
136 * @throws FileNotFoundException
138 protected TmfTrace(String name
, Class
<T
> type
, String path
) throws FileNotFoundException
{
139 this(name
, type
, path
, DEFAULT_INDEX_PAGE_SIZE
, true);
145 * @throws FileNotFoundException
147 protected TmfTrace(String name
, Class
<T
> type
, String path
, int cacheSize
) throws FileNotFoundException
{
148 this(name
, type
, path
, cacheSize
, true);
154 * @throws FileNotFoundException
156 protected TmfTrace(String name
, Class
<T
> type
, String path
, boolean indexTrace
) throws FileNotFoundException
{
157 this(name
, type
, path
, DEFAULT_INDEX_PAGE_SIZE
, indexTrace
);
164 * @throws FileNotFoundException
166 protected TmfTrace(String name
, Class
<T
> type
, String path
, int cacheSize
, boolean indexTrace
) throws FileNotFoundException
{
169 initTrace(path
, type
, cacheSize
, indexTrace
);
172 @SuppressWarnings("unchecked")
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
);
182 // ------------------------------------------------------------------------
184 // ------------------------------------------------------------------------
187 * @return the trace path
190 public String
getPath() {
195 * @see org.eclipse.linuxtools.tmf.stream.ITmfEventStream#getNbEvents()
198 public long getNbEvents() {
203 * @return the size of the cache
206 public int getCacheSize() {
207 return fIndexPageSize
;
211 * @see org.eclipse.linuxtools.tmf.stream.ITmfEventStream#getTimeRange()
214 public TmfTimeRange
getTimeRange() {
215 return new TmfTimeRange(fStartTime
, fEndTime
);
219 * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getStartTime()
222 public TmfTimestamp
getStartTime() {
227 * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getEndTime()
230 public TmfTimestamp
getEndTime() {
234 @SuppressWarnings("unchecked")
235 public Vector
<TmfCheckpoint
> getCheckpoints() {
236 return (Vector
<TmfCheckpoint
>) fCheckpoints
.clone();
240 * Returns the rank of the first event with the requested timestamp. If none, returns the index of the next event
247 public long getRank(TmfTimestamp timestamp
) {
248 TmfContext context
= seekEvent(timestamp
);
249 return context
.getRank();
252 // ------------------------------------------------------------------------
254 // ------------------------------------------------------------------------
256 protected void setTimeRange(TmfTimeRange range
) {
257 fStartTime
= range
.getStartTime();
258 fEndTime
= range
.getEndTime();
261 protected void setStartTime(TmfTimestamp startTime
) {
262 fStartTime
= startTime
;
265 protected void setEndTime(TmfTimestamp endTime
) {
269 // ------------------------------------------------------------------------
271 // ------------------------------------------------------------------------
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());
282 return seekEvent(request
.getIndex());
286 * Return the next piece of data based on the context supplied. The context would typically be updated for the
292 @SuppressWarnings("unchecked")
294 public T
getNext(ITmfContext context
) {
295 if (context
instanceof TmfContext
) {
296 return (T
) getNextEvent((TmfContext
) context
);
301 // ------------------------------------------------------------------------
303 // ------------------------------------------------------------------------
306 * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.event.TmfTimestamp)
309 public TmfContext
seekEvent(TmfTimestamp timestamp
) {
311 if (timestamp
== null) {
312 timestamp
= TmfTimestamp
.BigBang
;
315 // First, find the right checkpoint
316 int index
= Collections
.binarySearch(fCheckpoints
, new TmfCheckpoint(timestamp
, null));
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.
322 index
= Math
.max(0, -(index
+ 2));
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;
332 location
= fCheckpoints
.elementAt(index
).getLocation();
337 TmfContext context
= seekLocation(location
);
338 context
.setRank(index
* fIndexPageSize
);
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
);
353 * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#seekEvent(int)
356 public TmfContext
seekEvent(long rank
) {
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) {
365 if (index
>= fCheckpoints
.size()) {
366 index
= fCheckpoints
.size() - 1;
368 location
= fCheckpoints
.elementAt(index
).getLocation();
372 TmfContext context
= seekLocation(location
);
373 long pos
= index
* fIndexPageSize
;
374 context
.setRank(pos
);
377 TmfEvent event
= getNextEvent(context
);
378 while (event
!= null && ++pos
< rank
) {
379 event
= getNextEvent(context
);
389 * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getNextEvent(org.eclipse.
390 * linuxtools.tmf.trace.ITmfTrace.TraceContext)
393 public synchronized TmfEvent
getNextEvent(TmfContext context
) {
394 // parseEvent() does not update the context
395 TmfEvent event
= parseEvent(context
);
397 updateIndex(context
, context
.getRank(), event
.getTimestamp());
398 context
.setLocation(getCurrentLocation());
399 context
.updateRank(1);
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());
429 * Hook for special processing by the concrete class (called by getNextEvent())
433 protected void processEvent(TmfEvent event
) {
434 // Do nothing by default
437 // ------------------------------------------------------------------------
439 // ------------------------------------------------------------------------
442 * @see java.lang.Object#toString()
445 @SuppressWarnings("nls")
446 public String
toString() {
447 return "[TmfTrace (" + getName() + ")]";
450 // ------------------------------------------------------------------------
452 // ------------------------------------------------------------------------
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
460 @SuppressWarnings({ "unchecked" })
461 protected void indexTrace(boolean waitForCompletion
) {
463 final Job job
= new Job("Indexing " + getName() + "...") { //$NON-NLS-1$ //$NON-NLS-2$
465 protected IStatus
run(IProgressMonitor monitor
) {
466 while (!monitor
.isCanceled()) {
469 } catch (InterruptedException e
) {
470 return Status
.OK_STATUS
;
474 return Status
.OK_STATUS
;
479 fCheckpoints
.clear();
480 ITmfEventRequest
<TmfEvent
> request
= new TmfEventRequest
<TmfEvent
>(TmfEvent
.class, TmfTimeRange
.Eternity
, TmfDataRequest
.ALL_DATA
,
481 fIndexPageSize
, ITmfDataRequest
.ExecutionType
.BACKGROUND
) {
483 TmfTimestamp startTime
= null;
484 TmfTimestamp lastTime
= null;
487 public void handleData(TmfEvent event
) {
488 super.handleData(event
);
490 TmfTimestamp ts
= event
.getTimestamp();
491 if (startTime
== null)
492 startTime
= new TmfTimestamp(ts
);
493 lastTime
= new TmfTimestamp(ts
);
495 if ((getNbRead() % fIndexPageSize
) == 0) {
502 public void handleSuccess() {
507 public void handleCompleted() {
509 super.handleCompleted();
512 private void updateTrace() {
513 int nbRead
= getNbRead();
515 fStartTime
= startTime
;
523 sendRequest((ITmfDataRequest
<T
>) request
);
524 if (waitForCompletion
)
526 request
.waitForCompletion();
527 } catch (InterruptedException e
) {
532 protected void notifyListeners() {
533 broadcast(new TmfTraceUpdatedSignal(this, this, new TmfTimeRange(fStartTime
, fEndTime
)));