1 /*******************************************************************************
2 * Copyright (c) 2009, 2010, 2012 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 * Francois Chouinard - Updated as per TMF Trace Model 1.0
12 *******************************************************************************/
14 package org
.eclipse
.linuxtools
.tmf
.core
.trace
;
18 import org
.eclipse
.core
.resources
.IResource
;
19 import org
.eclipse
.core
.runtime
.Path
;
20 import org
.eclipse
.linuxtools
.tmf
.core
.component
.TmfEventProvider
;
21 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
22 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfTimestamp
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfTimeRange
;
24 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfTimestamp
;
25 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.TmfTraceException
;
26 import org
.eclipse
.linuxtools
.tmf
.core
.request
.ITmfDataRequest
;
27 import org
.eclipse
.linuxtools
.tmf
.core
.request
.ITmfEventRequest
;
30 * Abstract implementation of ITmfTrace.
32 * Since the concept of 'location' is trace specific, the concrete classes have
33 * to provide the related methods, namely:
35 * <li> public ITmfLocation<?> getCurrentLocation()
36 * <li> public double getLocationRatio(ITmfLocation<?> location)
37 * <li> public ITmfContext seekEvent(ITmfLocation<?> location)
38 * <li> public ITmfContext seekEvent(double ratio)
39 * <li> public boolean validate(IProject project, String path)
41 * A concrete trace must provide its corresponding parser. A common way to
42 * accomplish this is by making the concrete class extend TmfTrace and
43 * implement ITmfEventParser.
45 * The concrete class can either specify its own indexer or use the provided
46 * TmfCheckpointIndexer (default). In this case, the trace cache size will be
47 * used as checkpoint interval.
50 * @author Francois Chouinard
53 * @see ITmfTraceIndexer
54 * @see ITmfEventParser
56 public abstract class TmfTrace
<T
extends ITmfEvent
> extends TmfEventProvider
<T
> implements ITmfTrace
<T
> {
58 // ------------------------------------------------------------------------
60 // ------------------------------------------------------------------------
62 // The resource used for persistent properties for this trace
63 private IResource fResource
;
68 // The trace cache page size
69 private int fCacheSize
= ITmfTrace
.DEFAULT_TRACE_CACHE_SIZE
;
71 // The number of events collected (so far)
72 private long fNbEvents
= 0;
74 // The time span of the event stream
75 private ITmfTimestamp fStartTime
= TmfTimestamp
.BIG_CRUNCH
;
76 private ITmfTimestamp fEndTime
= TmfTimestamp
.BIG_BANG
;
78 // The trace streaming interval (0 = no streaming)
79 private long fStreamingInterval
= 0;
82 private ITmfTraceIndexer
<ITmfTrace
<ITmfEvent
>> fIndexer
;
85 private ITmfEventParser
<T
> fParser
;
87 // ------------------------------------------------------------------------
89 // ------------------------------------------------------------------------
92 * The default, parameterless, constructor
94 @SuppressWarnings({ "unchecked", "rawtypes" })
97 fIndexer
= new TmfCheckpointIndexer(this);
101 * The standard constructor (non-live trace). Applicable when the trace
102 * implements its own parser and if at checkpoint-based index is OK.
104 * @param resource the resource associated to the trace
105 * @param type the trace event type
106 * @param path the trace path
107 * @param cacheSize the trace cache size
108 * @throws TmfTraceException
110 protected TmfTrace(final IResource resource
, final Class
<T
> type
, final String path
, final int cacheSize
) throws TmfTraceException
{
111 this(resource
, type
, path
, cacheSize
, 0, null);
115 * The standard constructor (live trace). Applicable when the trace
116 * implements its own parser and if at checkpoint-based index is OK.
118 * @param resource the resource associated to the trace
119 * @param type the trace event type
120 * @param path the trace path
121 * @param cacheSize the trace cache size
122 * @param interval the trace streaming interval
123 * @throws TmfTraceException
125 protected TmfTrace(final IResource resource
, final Class
<T
> type
, final String path
, final int cacheSize
, final long interval
) throws TmfTraceException
{
126 this(resource
, type
, path
, cacheSize
, interval
, null);
130 * The 'non-default indexer' constructor. Allows to provide a trace
133 * @param resource the resource associated to the trace
134 * @param type the trace event type
135 * @param path the trace path
136 * @param cacheSize the trace cache size
137 * @param indexer the trace indexer
138 * @throws TmfTraceException
140 protected TmfTrace(final IResource resource
, final Class
<T
> type
, final String path
, final int cacheSize
,
141 final long interval
, final ITmfTraceIndexer
<?
> indexer
) throws TmfTraceException
{
142 this(resource
, type
, path
, cacheSize
, interval
, indexer
, null);
146 * The full constructor where trace specific indexer/parser are provided.
148 * @param resource the resource associated to the trace
149 * @param type the trace event type
150 * @param path the trace path
151 * @param cacheSize the trace cache size
152 * @param indexer the trace indexer
153 * @param parser the trace event parser
154 * @throws TmfTraceException
156 @SuppressWarnings({ "unchecked", "rawtypes" })
157 protected TmfTrace(final IResource resource
, final Class
<T
> type
, final String path
, final int cacheSize
,
158 final long interval
, final ITmfTraceIndexer
<?
> indexer
, final ITmfEventParser
<T
> parser
) throws TmfTraceException
{
160 fCacheSize
= (cacheSize
> 0) ? cacheSize
: ITmfTrace
.DEFAULT_TRACE_CACHE_SIZE
;
161 fStreamingInterval
= interval
;
162 fIndexer
= (indexer
!= null) ? indexer
: new TmfCheckpointIndexer(this, fCacheSize
);
164 initialize(resource
, path
, type
);
170 * @param trace the original trace
172 @SuppressWarnings({ "unchecked", "rawtypes" })
173 public TmfTrace(final TmfTrace
<T
> trace
) throws TmfTraceException
{
176 throw new IllegalArgumentException();
178 fCacheSize
= trace
.getCacheSize();
179 fStreamingInterval
= trace
.getStreamingInterval();
180 fIndexer
= new TmfCheckpointIndexer(this);
181 fParser
= trace
.fParser
;
182 initialize(trace
.getResource(), trace
.getPath(), trace
.getEventType());
185 // ------------------------------------------------------------------------
186 // ITmfTrace - Initializers
187 // ------------------------------------------------------------------------
190 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#initTrace(org.eclipse.core.resources.IResource, java.lang.String, java.lang.Class)
193 public void initTrace(final IResource resource
, final String path
, final Class
<T
> type
) throws TmfTraceException
{
194 initialize(resource
, path
, type
);
198 * Initialize the trace common attributes and the base component.
200 * @param resource the Eclipse resource (trace)
201 * @param path the trace path
202 * @param type the trace event type
204 * @throws TmfTraceException
206 @SuppressWarnings("unchecked")
207 protected void initialize(final IResource resource
, final String path
, final Class
<T
> type
) throws TmfTraceException
{
209 throw new TmfTraceException("Invalid trace path"); //$NON-NLS-1$
212 fResource
= resource
;
213 String traceName
= (resource
!= null) ? resource
.getName() : null;
214 // If no resource was provided, extract the display name the trace path
215 if (traceName
== null) {
216 final int sep
= path
.lastIndexOf(Path
.SEPARATOR
);
217 traceName
= (sep
>= 0) ? path
.substring(sep
+ 1) : path
;
219 if (fParser
== null) {
220 if (this instanceof ITmfEventParser
) {
221 fParser
= (ITmfEventParser
<T
>) this;
223 throw new TmfTraceException("Invalid trace parser"); //$NON-NLS-1$
226 super.init(traceName
, type
);
230 * Indicates if the path points to an existing file/directory
232 * @param path the path to test
233 * @return true if the file/directory exists
235 protected boolean fileExists(final String path
) {
236 final File file
= new File(path
);
237 return file
.exists();
243 * @param waitForCompletion index synchronously (true) or not (false)
245 protected void indexTrace(boolean waitForCompletion
) {
246 getIndexer().buildIndex(waitForCompletion
);
249 // ------------------------------------------------------------------------
250 // ITmfTrace - Basic getters
251 // ------------------------------------------------------------------------
254 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEventType()
257 @SuppressWarnings("unchecked")
258 public Class
<T
> getEventType() {
259 return (Class
<T
>) super.getType();
263 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getResource()
266 public IResource
getResource() {
271 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getPath()
274 public String
getPath() {
279 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getIndexPageSize()
282 public int getCacheSize() {
287 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStreamingInterval()
290 public long getStreamingInterval() {
291 return fStreamingInterval
;
295 * @return the trace indexer
297 protected ITmfTraceIndexer
<ITmfTrace
<ITmfEvent
>> getIndexer() {
302 * @return the trace parser
304 protected ITmfEventParser
<T
> getParser() {
308 // ------------------------------------------------------------------------
309 // ITmfTrace - Trace characteristics getters
310 // ------------------------------------------------------------------------
313 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNbEvents()
316 public synchronized long getNbEvents() {
321 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getTimeRange()
324 public TmfTimeRange
getTimeRange() {
325 return new TmfTimeRange(fStartTime
, fEndTime
);
329 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStartTime()
332 public ITmfTimestamp
getStartTime() {
333 return fStartTime
.clone();
337 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEndTime()
340 public ITmfTimestamp
getEndTime() {
341 return fEndTime
.clone();
344 // ------------------------------------------------------------------------
345 // Convenience setters/getters
346 // ------------------------------------------------------------------------
349 * Set the trace cache size. Must be done at initialization time.
351 * @param cacheSize The trace cache size
353 protected void setCacheSize(final int cacheSize
) {
354 fCacheSize
= cacheSize
;
358 * Set the trace known number of events. This can be quite dynamic
359 * during indexing or for live traces.
361 * @param nbEvents The number of events
363 protected synchronized void setNbEvents(final long nbEvents
) {
364 fNbEvents
= (nbEvents
> 0) ? nbEvents
: 0;
368 * Update the trace events time range
370 * @param range the new time range
372 protected void setTimeRange(final TmfTimeRange range
) {
373 fStartTime
= range
.getStartTime().clone();
374 fEndTime
= range
.getEndTime().clone();
378 * Update the trace chronologically first event timestamp
380 * @param startTime the new first event timestamp
382 protected void setStartTime(final ITmfTimestamp startTime
) {
383 fStartTime
= startTime
.clone();
387 * Update the trace chronologically last event timestamp
389 * @param endTime the new last event timestamp
391 protected void setEndTime(final ITmfTimestamp endTime
) {
392 fEndTime
= endTime
.clone();
396 * Set the polling interval for live traces (default = 0 = no streaming).
398 * @param interval the new trace streaming interval
400 protected void setStreamingInterval(final long interval
) {
401 fStreamingInterval
= (interval
> 0) ? interval
: 0;
405 * Set the trace indexer. Must be done at initialization time.
407 * @param indexer the trace indexer
409 protected void setIndexer(final ITmfTraceIndexer
<ITmfTrace
<ITmfEvent
>> indexer
) {
414 * Set the trace parser. Must be done at initialization time.
416 * @param parser the new trace parser
418 protected void setParser(final ITmfEventParser
<T
> parser
) {
422 // ------------------------------------------------------------------------
423 // ITmfTrace - SeekEvent operations (returning a trace context)
424 // ------------------------------------------------------------------------
427 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(long)
430 public synchronized ITmfContext
seekEvent(final long rank
) {
432 // A rank <= 0 indicates to seek the first event
434 ITmfContext context
= seekEvent((ITmfLocation
<?
>) null);
439 // Position the trace at the checkpoint
440 final ITmfContext context
= fIndexer
.seekIndex(rank
);
442 // And locate the requested event context
443 long pos
= context
.getRank();
445 ITmfEvent event
= getNext(context
);
446 while (event
!= null && ++pos
< rank
) {
447 event
= getNext(context
);
454 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp)
457 public synchronized ITmfContext
seekEvent(final ITmfTimestamp timestamp
) {
459 // A null timestamp indicates to seek the first event
460 if (timestamp
== null) {
461 ITmfContext context
= seekEvent((ITmfLocation
<?
>) null);
466 // Position the trace at the checkpoint
467 final ITmfContext context
= fIndexer
.seekIndex(timestamp
);
469 // And locate the requested event context
470 final ITmfContext nextEventContext
= context
.clone(); // Must use clone() to get the right subtype...
471 ITmfEvent event
= getNext(nextEventContext
);
472 while (event
!= null && event
.getTimestamp().compareTo(timestamp
, false) < 0) {
473 context
.setLocation(nextEventContext
.getLocation().clone());
474 context
.increaseRank();
475 event
= getNext(nextEventContext
);
478 context
.setLocation(null);
479 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
484 // ------------------------------------------------------------------------
485 // ITmfTrace - Read operations (returning an actual event)
486 // ------------------------------------------------------------------------
489 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#readNextEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
492 public synchronized T
getNext(final ITmfContext context
) {
493 // parseEvent() does not update the context
494 final T event
= fParser
.parseEvent(context
);
496 updateAttributes(context
, event
.getTimestamp());
497 context
.setLocation(getCurrentLocation());
498 context
.increaseRank();
505 * Hook for special event processing by the concrete class
506 * (called by TmfTrace.getEvent())
508 * @param event the event
510 protected void processEvent(final ITmfEvent event
) {
515 * Update the trace attributes
517 * @param context the current trace context
518 * @param timestamp the corresponding timestamp
520 protected synchronized void updateAttributes(final ITmfContext context
, final ITmfTimestamp timestamp
) {
521 if (fStartTime
.compareTo(timestamp
, false) > 0) {
522 fStartTime
= timestamp
;
524 if (fEndTime
.compareTo(timestamp
, false) < 0) {
525 fEndTime
= timestamp
;
527 if (context
.hasValidRank()) {
528 long rank
= context
.getRank();
529 if (fNbEvents
<= rank
) {
530 fNbEvents
= rank
+ 1;
532 fIndexer
.updateIndex(context
, timestamp
);
536 // ------------------------------------------------------------------------
538 // ------------------------------------------------------------------------
541 * @see org.eclipse.linuxtools.tmf.core.component.TmfDataProvider#armRequest(org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest)
544 public ITmfContext
armRequest(final ITmfDataRequest
<T
> request
) {
545 if (request
instanceof ITmfEventRequest
<?
>
546 && !TmfTimestamp
.BIG_BANG
.equals(((ITmfEventRequest
<T
>) request
).getRange().getStartTime())
547 && request
.getIndex() == 0)
549 final ITmfContext context
= seekEvent(((ITmfEventRequest
<T
>) request
).getRange().getStartTime());
550 ((ITmfEventRequest
<T
>) request
).setStartIndex((int) context
.getRank());
554 return seekEvent(request
.getIndex());
558 // * @see org.eclipse.linuxtools.tmf.core.component.TmfDataProvider#getNext(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
561 // @SuppressWarnings("unchecked")
562 // public T getNext(final ITmfContext context) {
563 // if (context instanceof TmfContext) {
564 // return (T) readNextEvent(context);
570 // ------------------------------------------------------------------------
572 // ------------------------------------------------------------------------
575 * @see java.lang.Object#toString()
578 @SuppressWarnings("nls")
579 public synchronized String
toString() {
580 return "TmfTrace [fPath=" + fPath
+ ", fCacheSize=" + fCacheSize
581 + ", fNbEvents=" + fNbEvents
+ ", fStartTime=" + fStartTime
582 + ", fEndTime=" + fEndTime
+ ", fStreamingInterval=" + fStreamingInterval
+ "]";