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
;
16 import org
.eclipse
.core
.resources
.IFile
;
17 import org
.eclipse
.core
.resources
.IProject
;
18 import org
.eclipse
.core
.resources
.IResource
;
19 import org
.eclipse
.linuxtools
.internal
.tmf
.core
.trace
.TmfExperimentContext
;
20 import org
.eclipse
.linuxtools
.internal
.tmf
.core
.trace
.TmfExperimentLocation
;
21 import org
.eclipse
.linuxtools
.internal
.tmf
.core
.trace
.TmfLocationArray
;
22 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfTimestamp
;
24 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfTimeRange
;
25 import org
.eclipse
.linuxtools
.tmf
.core
.event
.TmfTimestamp
;
26 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.TmfTraceException
;
27 import org
.eclipse
.linuxtools
.tmf
.core
.request
.ITmfDataRequest
;
28 import org
.eclipse
.linuxtools
.tmf
.core
.request
.ITmfEventRequest
;
29 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfEndSynchSignal
;
30 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfExperimentDisposedSignal
;
31 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfExperimentRangeUpdatedSignal
;
32 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfExperimentSelectedSignal
;
33 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfExperimentUpdatedSignal
;
34 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfSignalHandler
;
35 import org
.eclipse
.linuxtools
.tmf
.core
.signal
.TmfTraceUpdatedSignal
;
38 * TmfExperiment presents a time-ordered, unified view of a set of ITmfTrace:s
39 * that are part of a tracing experiment.
42 * @author Francois Chouinard
44 public class TmfExperiment
<T
extends ITmfEvent
> extends TmfTrace
<T
> implements ITmfEventParser
<T
> {
46 // ------------------------------------------------------------------------
48 // ------------------------------------------------------------------------
51 * The default index page size
53 public static final int DEFAULT_INDEX_PAGE_SIZE
= 5000;
55 // ------------------------------------------------------------------------
57 // ------------------------------------------------------------------------
60 * The currently selected experiment (null if none)
62 protected static TmfExperiment
<?
> fCurrentExperiment
= null;
65 * The set of traces that constitute the experiment
67 protected ITmfTrace
<T
>[] fTraces
;
70 * The set of traces that constitute the experiment
72 private boolean fInitialized
= false;
75 * The experiment bookmarks file
77 private IFile fBookmarksFile
;
80 // Saved experiment context (optimization)
81 private TmfExperimentContext fExperimentContext
;
83 // ------------------------------------------------------------------------
85 // ------------------------------------------------------------------------
91 * @throws TmfTraceException
93 public TmfExperiment(final Class
<T
> type
, final String id
, final ITmfTrace
<T
>[] traces
) {
94 this(type
, id
, traces
, DEFAULT_INDEX_PAGE_SIZE
);
101 * @param indexPageSize
102 * @throws TmfTraceException
104 @SuppressWarnings({ "unchecked", "rawtypes" })
105 public TmfExperiment(final Class
<T
> type
, final String path
, final ITmfTrace
<T
>[] traces
, final int indexPageSize
) {
106 setCacheSize(indexPageSize
);
107 setStreamingInterval(0);
108 setIndexer(new TmfCheckpointIndexer(this, indexPageSize
));
111 super.initialize(null, path
, type
);
112 } catch (TmfTraceException e
) {
117 setTimeRange(TmfTimeRange
.NULL_RANGE
);
121 * Clears the experiment
124 @SuppressWarnings("rawtypes")
125 public synchronized void dispose() {
127 final TmfExperimentDisposedSignal
<T
> signal
= new TmfExperimentDisposedSignal
<T
>(this, this);
130 if (fCurrentExperiment
== this) {
131 fCurrentExperiment
= null;
134 // Clean up the index if applicable
135 if (getIndexer() != null) {
136 getIndexer().dispose();
139 if (fTraces
!= null) {
140 for (final ITmfTrace trace
: fTraces
)
147 // ------------------------------------------------------------------------
148 // ITmfTrace - Initializers
149 // ------------------------------------------------------------------------
152 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#validate(org.eclipse.core.resources.IProject, java.lang.String)
155 public boolean validate(final IProject project
, final String path
) {
160 * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#initTrace(org.eclipse.core.resources.IResource, java.lang.String, java.lang.Class)
163 public void initTrace(final IResource resource
, final String path
, final Class
<T
> type
) {
166 // ------------------------------------------------------------------------
168 // ------------------------------------------------------------------------
171 * Selects the current, framework-wide, experiment
173 * @param experiment das experiment
175 public static void setCurrentExperiment(final TmfExperiment
<?
> experiment
) {
176 if (fCurrentExperiment
!= null && fCurrentExperiment
!= experiment
) {
177 fCurrentExperiment
.dispose();
179 fCurrentExperiment
= experiment
;
183 * @return das experiment
185 public static TmfExperiment
<?
> getCurrentExperiment() {
186 return fCurrentExperiment
;
190 * Get the list of traces. Handle with care...
192 * @return the experiment traces
194 public ITmfTrace
<T
>[] getTraces() {
199 * Returns the timestamp of the event at the requested index. If none,
202 * @param index the event index (rank)
203 * @return the corresponding event timestamp
205 public ITmfTimestamp
getTimestamp(final int index
) {
206 final ITmfContext context
= seekEvent(index
);
207 final ITmfEvent event
= getNext(context
);
208 return (event
!= null) ? event
.getTimestamp() : null;
212 * Set the file to be used for bookmarks on this experiment
214 * @param file the bookmarks file
216 public void setBookmarksFile(final IFile file
) {
217 fBookmarksFile
= file
;
221 * Get the file used for bookmarks on this experiment
223 * @return the bookmarks file or null if none is set
225 public IFile
getBookmarksFile() {
226 return fBookmarksFile
;
229 // ------------------------------------------------------------------------
230 // Request management
231 // ------------------------------------------------------------------------
234 * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#armRequest(org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest)
237 protected synchronized ITmfContext
armRequest(final ITmfDataRequest
<T
> request
) {
239 // Make sure we have something to read from
240 if (fTraces
== null) {
244 if (request
instanceof ITmfEventRequest
<?
>
245 && !TmfTimestamp
.BIG_BANG
.equals(((ITmfEventRequest
<T
>) request
).getRange().getStartTime())
246 && request
.getIndex() == 0)
248 final ITmfContext context
= seekEvent(((ITmfEventRequest
<T
>) request
).getRange().getStartTime());
249 ((ITmfEventRequest
<T
>) request
).setStartIndex((int) context
.getRank());
254 // Check if we are already at the right index
255 if ((fExperimentContext
!= null) && fExperimentContext
.getRank() == request
.getIndex()) {
256 return fExperimentContext
;
259 return seekEvent(request
.getIndex());
262 // ------------------------------------------------------------------------
263 // ITmfTrace trace positioning
264 // ------------------------------------------------------------------------
268 * Returns a brand new context based on the location provided and
269 * initializes the event queues
271 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfLocation)
274 public synchronized ITmfContext
seekEvent(final ITmfLocation
<?
> location
) {
275 // Validate the location
276 if (location
!= null && !(location
instanceof TmfExperimentLocation
)) {
277 return null; // Throw an exception?
279 // Make sure we have something to read from
280 if (fTraces
== null) {
284 // Instantiate the location
285 final TmfExperimentLocation expLocation
= (location
== null)
286 ?
new TmfExperimentLocation(new TmfLocationArray(new ITmfLocation
<?
>[fTraces
.length
]))
287 : (TmfExperimentLocation
) location
.clone();
289 // Create and populate the context's traces contexts
290 final TmfExperimentContext context
= new TmfExperimentContext(new ITmfContext
[fTraces
.length
]);
292 for (int i
= 0; i
< fTraces
.length
; i
++) {
293 // Get the relevant trace attributes
294 final ITmfLocation
<?
> trcLocation
= expLocation
.getLocation().getLocations()[i
];
295 context
.getContexts()[i
] = fTraces
[i
].seekEvent(trcLocation
);
296 expLocation
.getLocation().getLocations()[i
] = context
.getContexts()[i
].getLocation().clone();
297 context
.getEvents()[i
] = fTraces
[i
].getNext(context
.getContexts()[i
]);
301 context
.setLocation(expLocation
);
302 context
.setLastTrace(TmfExperimentContext
.NO_TRACE
);
303 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
305 fExperimentContext
= context
;
306 return (ITmfContext
) context
;
309 // ------------------------------------------------------------------------
310 // ITmfTrace - SeekEvent operations (returning a trace context)
311 // ------------------------------------------------------------------------
314 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(double)
317 public ITmfContext
seekEvent(final double ratio
) {
318 final ITmfContext context
= seekEvent((long) (ratio
* getNbEvents()));
323 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getLocationRatio(org.eclipse.linuxtools.tmf.core.trace.ITmfLocation)
326 public double getLocationRatio(final ITmfLocation
<?
> location
) {
327 if (location
instanceof TmfExperimentLocation
) {
328 return (double) seekEvent(location
).getRank() / getNbEvents();
334 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getCurrentLocation()
337 public ITmfLocation
<?
> getCurrentLocation() {
338 ITmfLocation
<?
>[] locations
= new ITmfLocation
<?
>[fTraces
.length
];
339 for (int i
= 0; i
< fTraces
.length
; i
++) {
340 locations
[i
] = fTraces
[i
].getCurrentLocation();
342 return new TmfExperimentLocation(new TmfLocationArray(locations
));
345 // ------------------------------------------------------------------------
346 // ITmfTrace trace positioning
347 // ------------------------------------------------------------------------
350 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfEventParser#parseEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
353 public synchronized T
parseEvent(final ITmfContext context
) {
354 final ITmfContext savedContext
= context
.clone();
355 final T event
= getNext(savedContext
);
360 * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#getNext(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
363 @SuppressWarnings("unchecked")
364 public synchronized T
getNext(ITmfContext context
) {
366 // Validate the context
367 if (!(context
instanceof TmfExperimentContext
)) {
368 return null; // Throw an exception?
371 // Make sure that we have something to read from
372 if (fTraces
== null) {
376 TmfExperimentContext expContext
= (TmfExperimentContext
) context
;
378 // If an event was consumed previously, first get the next one from that trace
379 final int lastTrace
= expContext
.getLastTrace();
380 if (lastTrace
!= TmfExperimentContext
.NO_TRACE
) {
381 final ITmfContext traceContext
= expContext
.getContexts()[lastTrace
];
382 expContext
.getEvents()[lastTrace
] = fTraces
[lastTrace
].getNext(traceContext
);
383 expContext
.setLastTrace(TmfExperimentContext
.NO_TRACE
);
386 // Scan the candidate events and identify the "next" trace to read from
387 int trace
= TmfExperimentContext
.NO_TRACE
;
388 ITmfTimestamp timestamp
= TmfTimestamp
.BIG_CRUNCH
;
389 for (int i
= 0; i
< fTraces
.length
; i
++) {
390 final ITmfEvent event
= expContext
.getEvents()[i
];
391 if (event
!= null && event
.getTimestamp() != null) {
392 final ITmfTimestamp otherTS
= event
.getTimestamp();
393 if (otherTS
.compareTo(timestamp
, true) < 0) {
401 if (trace
!= TmfExperimentContext
.NO_TRACE
) {
402 event
= (T
) expContext
.getEvents()[trace
];
404 updateAttributes(expContext
, event
.getTimestamp());
405 expContext
.increaseRank();
406 expContext
.setLastTrace(trace
);
407 final TmfExperimentLocation location
= (TmfExperimentLocation
) expContext
.getLocation();
408 final ITmfContext traceContext
= expContext
.getContexts()[trace
];
409 location
.getLocation().getLocations()[trace
] = traceContext
.getLocation().clone();
410 fExperimentContext
= expContext
;
419 * @see java.lang.Object#toString()
422 @SuppressWarnings("nls")
423 public String
toString() {
424 return "[TmfExperiment (" + getName() + ")]";
427 // ------------------------------------------------------------------------
429 // ------------------------------------------------------------------------
431 private synchronized void initializeStreamingMonitor() {
438 if (getStreamingInterval() == 0) {
439 final ITmfContext context
= seekEvent(0);
440 final ITmfEvent event
= getNext(context
);
443 final TmfTimeRange timeRange
= new TmfTimeRange(event
.getTimestamp().clone(), TmfTimestamp
.BIG_CRUNCH
);
444 final TmfExperimentRangeUpdatedSignal signal
= new TmfExperimentRangeUpdatedSignal(this, this, timeRange
);
446 // Broadcast in separate thread to prevent deadlock
456 final Thread thread
= new Thread("Streaming Monitor for experiment " + getName()) { //$NON-NLS-1$
457 private ITmfTimestamp safeTimestamp
= null;
458 private TmfTimeRange timeRange
= null;
462 while (!fExecutor
.isShutdown()) {
463 if (!getIndexer().isIndexing()) {
464 ITmfTimestamp startTimestamp
= TmfTimestamp
.BIG_CRUNCH
;
465 ITmfTimestamp endTimestamp
= TmfTimestamp
.BIG_BANG
;
466 for (final ITmfTrace
<T
> trace
: fTraces
) {
467 if (trace
.getStartTime().compareTo(startTimestamp
) < 0)
468 startTimestamp
= trace
.getStartTime();
469 if (trace
.getStreamingInterval() != 0 && trace
.getEndTime().compareTo(endTimestamp
) > 0)
470 endTimestamp
= trace
.getEndTime();
472 if (safeTimestamp
!= null && safeTimestamp
.compareTo(getTimeRange().getEndTime(), false) > 0)
473 timeRange
= new TmfTimeRange(startTimestamp
, safeTimestamp
);
476 safeTimestamp
= endTimestamp
;
477 if (timeRange
!= null) {
478 final TmfExperimentRangeUpdatedSignal signal
=
479 new TmfExperimentRangeUpdatedSignal(TmfExperiment
.this, TmfExperiment
.this, timeRange
);
484 Thread
.sleep(getStreamingInterval());
485 } catch (final InterruptedException e
) {
495 * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getStreamingInterval()
498 public long getStreamingInterval() {
500 for (final ITmfTrace
<T
> trace
: fTraces
)
501 interval
= Math
.max(interval
, trace
.getStreamingInterval());
505 // ------------------------------------------------------------------------
507 // ------------------------------------------------------------------------
509 private Integer fEndSynchReference
;
512 * Signal handler for the TmfExperimentSelectedSignal signal
517 public void experimentSelected(final TmfExperimentSelectedSignal
<T
> signal
) {
518 final TmfExperiment
<?
> experiment
= signal
.getExperiment();
519 if (experiment
== this) {
520 setCurrentExperiment(experiment
);
521 fEndSynchReference
= Integer
.valueOf(signal
.getReference());
526 * Signal handler for the TmfEndSynchSignal signal
531 public void endSync(final TmfEndSynchSignal signal
) {
532 if (fEndSynchReference
!= null && fEndSynchReference
.intValue() == signal
.getReference()) {
533 fEndSynchReference
= null;
534 initializeStreamingMonitor();
539 * Signal handler for the TmfTraceUpdatedSignal signal
544 public void traceUpdated(final TmfTraceUpdatedSignal signal
) {
545 if (signal
.getTrace() == this) {
546 broadcast(new TmfExperimentUpdatedSignal(this, this));
551 * Signal handler for the TmfExperimentRangeUpdatedSignal signal
556 public void experimentRangeUpdated(final TmfExperimentRangeUpdatedSignal signal
) {
557 if (signal
.getExperiment() == this) {
558 getIndexer().buildIndex(getNbEvents(), signal
.getRange(), false);