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
99 * The standard constructor (non-live trace). Applicable when the trace
100 * implements its own parser and if at checkpoint-based index is OK.
102 * @param resource the resource associated to the trace
103 * @param type the trace event type
104 * @param path the trace path
105 * @param cacheSize the trace cache size
106 * @throws TmfTraceException
108 protected TmfTrace(final IResource resource
, final Class
<T
> type
, final String path
, final int cacheSize
) throws TmfTraceException
{
109 this(resource
, type
, path
, cacheSize
, 0);
113 * The standard constructor (live trace). Applicable when the trace
114 * implements its own parser and if at checkpoint-based index is OK.
116 * @param resource the resource associated to the trace
117 * @param type the trace event type
118 * @param path the trace path
119 * @param cacheSize the trace cache size
120 * @param interval the trace streaming interval
121 * @throws TmfTraceException
123 protected TmfTrace(final IResource resource
, final Class
<T
> type
, final String path
, final int cacheSize
, final long interval
) throws TmfTraceException
{
124 this(resource
, type
, path
, cacheSize
, interval
, null);
128 * The 'non-default indexer' constructor. Allows to provide a trace
131 * @param resource the resource associated to the trace
132 * @param type the trace event type
133 * @param path the trace path
134 * @param cacheSize the trace cache size
135 * @param indexer the trace indexer
136 * @throws TmfTraceException
138 protected TmfTrace(final IResource resource
, final Class
<T
> type
, final String path
, final int cacheSize
,
139 final long interval
, final ITmfTraceIndexer
<?
> indexer
) throws TmfTraceException
{
140 this(resource
, type
, path
, cacheSize
, interval
, indexer
, null);
144 * The full constructor where trace specific indexer/parser are provided.
146 * @param resource the resource associated to the trace
147 * @param type the trace event type
148 * @param path the trace path
149 * @param cacheSize the trace cache size
150 * @param indexer the trace indexer
151 * @param parser the trace event parser
152 * @throws TmfTraceException
154 @SuppressWarnings({ "unchecked", "rawtypes" })
155 protected TmfTrace(final IResource resource
, final Class
<T
> type
, final String path
, final int cacheSize
,
156 final long interval
, final ITmfTraceIndexer
<?
> indexer
, final ITmfEventParser
<T
> parser
) throws TmfTraceException
{
158 fCacheSize
= (cacheSize
> 0) ? cacheSize
: ITmfTrace
.DEFAULT_TRACE_CACHE_SIZE
;
159 fStreamingInterval
= interval
;
160 fIndexer
= (indexer
!= null) ? indexer
: new TmfCheckpointIndexer(this, fCacheSize
);
162 initialize(resource
, path
, type
);
168 * @param trace the original trace
170 @SuppressWarnings({ "unchecked", "rawtypes" })
171 public TmfTrace(final TmfTrace
<T
> trace
) throws TmfTraceException
{
174 throw new IllegalArgumentException();
176 fCacheSize
= trace
.getCacheSize();
177 fStreamingInterval
= trace
.getStreamingInterval();
178 fIndexer
= new TmfCheckpointIndexer(this);
179 fParser
= trace
.fParser
;
180 initialize(trace
.getResource(), trace
.getPath(), trace
.getEventType());
183 // ------------------------------------------------------------------------
184 // ITmfTrace - Initializers
185 // ------------------------------------------------------------------------
188 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#initTrace(org.eclipse.core.resources.IResource, java.lang.String, java.lang.Class)
191 @SuppressWarnings({ "unchecked", "rawtypes" })
192 public void initTrace(final IResource resource
, final String path
, final Class
<T
> type
) throws TmfTraceException
{
193 fIndexer
= new TmfCheckpointIndexer(this, fCacheSize
);
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(0, TmfTimeRange
.ETERNITY
, waitForCompletion
);
253 public synchronized void dispose() {
254 // Clean up the index if applicable
255 if (getIndexer() != null) {
256 getIndexer().dispose();
261 // ------------------------------------------------------------------------
262 // ITmfTrace - Basic getters
263 // ------------------------------------------------------------------------
266 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEventType()
269 @SuppressWarnings("unchecked")
270 public Class
<T
> getEventType() {
271 return (Class
<T
>) super.getType();
275 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getResource()
278 public IResource
getResource() {
283 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getPath()
286 public String
getPath() {
291 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getIndexPageSize()
294 public int getCacheSize() {
299 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStreamingInterval()
302 public long getStreamingInterval() {
303 return fStreamingInterval
;
307 * @return the trace indexer
309 protected ITmfTraceIndexer
<ITmfTrace
<ITmfEvent
>> getIndexer() {
314 * @return the trace parser
316 protected ITmfEventParser
<T
> getParser() {
320 // ------------------------------------------------------------------------
321 // ITmfTrace - Trace characteristics getters
322 // ------------------------------------------------------------------------
325 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getNbEvents()
328 public synchronized long getNbEvents() {
333 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getTimeRange()
336 public TmfTimeRange
getTimeRange() {
337 return new TmfTimeRange(fStartTime
, fEndTime
);
341 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getStartTime()
344 public ITmfTimestamp
getStartTime() {
345 return fStartTime
.clone();
349 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getEndTime()
352 public ITmfTimestamp
getEndTime() {
353 return fEndTime
.clone();
356 // ------------------------------------------------------------------------
357 // Convenience setters/getters
358 // ------------------------------------------------------------------------
361 * Set the trace cache size. Must be done at initialization time.
363 * @param cacheSize The trace cache size
365 protected void setCacheSize(final int cacheSize
) {
366 fCacheSize
= cacheSize
;
370 * Set the trace known number of events. This can be quite dynamic
371 * during indexing or for live traces.
373 * @param nbEvents The number of events
375 protected synchronized void setNbEvents(final long nbEvents
) {
376 fNbEvents
= (nbEvents
> 0) ? nbEvents
: 0;
380 * Update the trace events time range
382 * @param range the new time range
384 protected void setTimeRange(final TmfTimeRange range
) {
385 fStartTime
= range
.getStartTime().clone();
386 fEndTime
= range
.getEndTime().clone();
390 * Update the trace chronologically first event timestamp
392 * @param startTime the new first event timestamp
394 protected void setStartTime(final ITmfTimestamp startTime
) {
395 fStartTime
= startTime
.clone();
399 * Update the trace chronologically last event timestamp
401 * @param endTime the new last event timestamp
403 protected void setEndTime(final ITmfTimestamp endTime
) {
404 fEndTime
= endTime
.clone();
408 * Set the polling interval for live traces (default = 0 = no streaming).
410 * @param interval the new trace streaming interval
412 protected void setStreamingInterval(final long interval
) {
413 fStreamingInterval
= (interval
> 0) ? interval
: 0;
417 * Set the trace indexer. Must be done at initialization time.
419 * @param indexer the trace indexer
421 protected void setIndexer(final ITmfTraceIndexer
<ITmfTrace
<ITmfEvent
>> indexer
) {
426 * Set the trace parser. Must be done at initialization time.
428 * @param parser the new trace parser
430 protected void setParser(final ITmfEventParser
<T
> parser
) {
434 // ------------------------------------------------------------------------
435 // ITmfTrace - SeekEvent operations (returning a trace context)
436 // ------------------------------------------------------------------------
439 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(long)
442 public synchronized ITmfContext
seekEvent(final long rank
) {
444 // A rank <= 0 indicates to seek the first event
446 ITmfContext context
= seekEvent((ITmfLocation
<?
>) null);
451 // Position the trace at the checkpoint
452 final ITmfContext context
= fIndexer
.seekIndex(rank
);
454 // And locate the requested event context
455 long pos
= context
.getRank();
457 ITmfEvent event
= getNext(context
);
458 while (event
!= null && ++pos
< rank
) {
459 event
= getNext(context
);
466 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp)
469 public synchronized ITmfContext
seekEvent(final ITmfTimestamp timestamp
) {
471 // A null timestamp indicates to seek the first event
472 if (timestamp
== null) {
473 ITmfContext context
= seekEvent((ITmfLocation
<?
>) null);
478 // Position the trace at the checkpoint
479 ITmfContext context
= fIndexer
.seekIndex(timestamp
);
481 // And locate the requested event context
482 final ITmfContext nextEventContext
= context
.clone(); // Must use clone() to get the right subtype...
483 ITmfEvent event
= getNext(nextEventContext
);
484 while (event
!= null && event
.getTimestamp().compareTo(timestamp
, false) < 0) {
486 event
= getNext(nextEventContext
);
489 context
.setLocation(null);
490 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
495 // ------------------------------------------------------------------------
496 // ITmfTrace - Read operations (returning an actual event)
497 // ------------------------------------------------------------------------
500 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#readNextEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
503 public synchronized T
getNext(final ITmfContext context
) {
504 // parseEvent() does not update the context
505 final T event
= fParser
.parseEvent(context
);
507 updateAttributes(context
, event
.getTimestamp());
508 context
.setLocation(getCurrentLocation());
509 context
.increaseRank();
516 * Hook for special event processing by the concrete class
517 * (called by TmfTrace.getEvent())
519 * @param event the event
521 protected void processEvent(final ITmfEvent event
) {
526 * Update the trace attributes
528 * @param context the current trace context
529 * @param timestamp the corresponding timestamp
531 protected synchronized void updateAttributes(final ITmfContext context
, final ITmfTimestamp timestamp
) {
532 if (fStartTime
.equals(TmfTimestamp
.BIG_BANG
) || fStartTime
.compareTo(timestamp
, false) > 0) {
533 fStartTime
= timestamp
.clone();
535 if (fEndTime
.equals(TmfTimestamp
.BIG_CRUNCH
) || fEndTime
.compareTo(timestamp
, false) < 0) {
536 fEndTime
= timestamp
.clone();
538 if (context
.hasValidRank()) {
539 long rank
= context
.getRank();
540 if (fNbEvents
<= rank
) {
541 fNbEvents
= rank
+ 1;
543 fIndexer
.updateIndex(context
, timestamp
);
547 // ------------------------------------------------------------------------
549 // ------------------------------------------------------------------------
552 * @see org.eclipse.linuxtools.tmf.core.component.TmfDataProvider#armRequest(org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest)
555 protected ITmfContext
armRequest(final ITmfDataRequest
<T
> request
) {
556 if (request
instanceof ITmfEventRequest
<?
>
557 && !TmfTimestamp
.BIG_BANG
.equals(((ITmfEventRequest
<T
>) request
).getRange().getStartTime())
558 && request
.getIndex() == 0)
560 final ITmfContext context
= seekEvent(((ITmfEventRequest
<T
>) request
).getRange().getStartTime());
561 ((ITmfEventRequest
<T
>) request
).setStartIndex((int) context
.getRank());
565 return seekEvent(request
.getIndex());
568 // ------------------------------------------------------------------------
570 // ------------------------------------------------------------------------
573 * @see java.lang.Object#toString()
576 @SuppressWarnings("nls")
577 public synchronized String
toString() {
578 return "TmfTrace [fPath=" + fPath
+ ", fCacheSize=" + fCacheSize
579 + ", fNbEvents=" + fNbEvents
+ ", fStartTime=" + fStartTime
580 + ", fEndTime=" + fEndTime
+ ", fStreamingInterval=" + fStreamingInterval
+ "]";