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 protected ITmfContext
armRequest(final ITmfDataRequest
<T
> request
) {
235 if (request
instanceof ITmfEventRequest
<?
>
236 && !TmfTimestamp
.BIG_BANG
.equals(((ITmfEventRequest
<T
>) request
).getRange().getStartTime())
237 && request
.getIndex() == 0)
239 final ITmfContext context
= seekEvent(((ITmfEventRequest
<T
>) request
).getRange().getStartTime());
240 ((ITmfEventRequest
<T
>) request
).setStartIndex((int) context
.getRank());
245 // Check if we are already at the right index
246 if ((fExperimentContext
!= null) && fExperimentContext
.getRank() == request
.getIndex()) {
247 return fExperimentContext
;
250 return seekEvent(request
.getIndex());
253 // ------------------------------------------------------------------------
254 // ITmfTrace trace positioning
255 // ------------------------------------------------------------------------
259 * Returns a brand new context based on the location provided and
260 * initializes the event queues
262 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfLocation)
265 public synchronized ITmfContext
seekEvent(final ITmfLocation
<?
> location
) {
266 // Validate the location
267 if (location
!= null && !(location
instanceof TmfExperimentLocation
)) {
268 return null; // Throw an exception?
270 // Make sure we have something to read from
271 if (fTraces
== null) {
275 // Instantiate the location
276 final TmfExperimentLocation expLocation
= (location
== null)
277 ?
new TmfExperimentLocation(new TmfLocationArray(new ITmfLocation
<?
>[fTraces
.length
]))
278 : (TmfExperimentLocation
) location
.clone();
280 // Create and populate the context's traces contexts
281 final TmfExperimentContext context
= new TmfExperimentContext(new ITmfContext
[fTraces
.length
]);
283 for (int i
= 0; i
< fTraces
.length
; i
++) {
284 // Get the relevant trace attributes
285 final ITmfLocation
<?
> traceLocation
= expLocation
.getLocation().getLocations()[i
];
286 context
.getContexts()[i
] = fTraces
[i
].seekEvent(traceLocation
);
287 expLocation
.getLocation().getLocations()[i
] = context
.getContexts()[i
].getLocation().clone();
288 context
.getEvents()[i
] = fTraces
[i
].getNext(context
.getContexts()[i
]);
292 context
.setLocation(expLocation
);
293 context
.setLastTrace(TmfExperimentContext
.NO_TRACE
);
294 context
.setRank(ITmfContext
.UNKNOWN_RANK
);
296 fExperimentContext
= context
;
298 return (ITmfContext
) context
;
302 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#seekEvent(double)
305 public ITmfContext
seekEvent(final double ratio
) {
306 final ITmfContext context
= seekEvent((long) (ratio
* getNbEvents()));
311 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getLocationRatio(org.eclipse.linuxtools.tmf.core.trace.ITmfLocation)
314 public double getLocationRatio(final ITmfLocation
<?
> location
) {
315 if (location
instanceof TmfExperimentLocation
) {
316 return (double) seekEvent(location
).getRank() / getNbEvents();
322 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfTrace#getCurrentLocation()
325 public ITmfLocation
<?
> getCurrentLocation() {
326 ITmfLocation
<?
>[] locations
= new ITmfLocation
<?
>[fTraces
.length
];
327 for (int i
= 0; i
< fTraces
.length
; i
++) {
328 locations
[i
] = fTraces
[i
].getCurrentLocation();
330 return new TmfExperimentLocation(new TmfLocationArray(locations
));
333 // ------------------------------------------------------------------------
334 // ITmfTrace trace positioning
335 // ------------------------------------------------------------------------
338 * @see org.eclipse.linuxtools.tmf.core.trace.TmfTrace#getNext(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
341 public synchronized T
getNext(final ITmfContext context
) {
342 final ITmfContext previousContext
= (TmfExperimentContext
) context
.clone();
343 final T event
= parseEvent(context
);
345 updateAttributes(previousContext
, event
.getTimestamp());
347 fExperimentContext
= (TmfExperimentContext
) context
;
348 int trace
= fExperimentContext
.getLastTrace();
349 if (trace
!= TmfExperimentContext
.NO_TRACE
) {
350 TmfExperimentLocation location
= (TmfExperimentLocation
) fExperimentContext
.getLocation();
351 location
.getLocation().getLocations()[trace
] = fExperimentContext
.getContexts()[trace
].getLocation();
354 context
.increaseRank();
361 * @see org.eclipse.linuxtools.tmf.core.trace.ITmfEventParser#parseEvent(org.eclipse.linuxtools.tmf.core.trace.ITmfContext)
363 @SuppressWarnings("unchecked")
365 public T
parseEvent(ITmfContext context
) {
367 // Validate the context
368 if (!(context
instanceof TmfExperimentContext
)) {
369 return null; // Throw an exception?
372 TmfExperimentContext expContext
= (TmfExperimentContext
) context
;
374 // If an event was consumed previously, first get the next one from that trace
375 final int lastTrace
= expContext
.getLastTrace();
376 if (lastTrace
!= TmfExperimentContext
.NO_TRACE
) {
377 final ITmfContext traceContext
= expContext
.getContexts()[lastTrace
];
378 expContext
.getEvents()[lastTrace
] = fTraces
[lastTrace
].getNext(traceContext
);
379 expContext
.setLastTrace(TmfExperimentContext
.NO_TRACE
);
382 // Scan the candidate events and identify the "next" trace to read from
383 int trace
= TmfExperimentContext
.NO_TRACE
;
384 ITmfTimestamp timestamp
= TmfTimestamp
.BIG_CRUNCH
;
385 for (int i
= 0; i
< fTraces
.length
; i
++) {
386 final ITmfEvent event
= expContext
.getEvents()[i
];
387 if (event
!= null && event
.getTimestamp() != null) {
388 final ITmfTimestamp otherTS
= event
.getTimestamp();
389 if (otherTS
.compareTo(timestamp
, true) < 0) {
397 if (trace
!= TmfExperimentContext
.NO_TRACE
) {
398 event
= (T
) expContext
.getEvents()[trace
];
401 expContext
.setLastTrace(trace
);
406 * @see java.lang.Object#toString()
409 @SuppressWarnings("nls")
410 public String
toString() {
411 return "[TmfExperiment (" + getName() + ")]";
414 // ------------------------------------------------------------------------
416 // ------------------------------------------------------------------------
418 private synchronized void initializeStreamingMonitor() {
425 if (getStreamingInterval() == 0) {
426 final ITmfContext context
= seekEvent(0);
427 final ITmfEvent event
= getNext(context
);
430 final TmfTimeRange timeRange
= new TmfTimeRange(event
.getTimestamp().clone(), TmfTimestamp
.BIG_CRUNCH
);
431 final TmfExperimentRangeUpdatedSignal signal
= new TmfExperimentRangeUpdatedSignal(this, this, timeRange
);
433 // Broadcast in separate thread to prevent deadlock
443 final Thread thread
= new Thread("Streaming Monitor for experiment " + getName()) { //$NON-NLS-1$
444 private ITmfTimestamp safeTimestamp
= null;
445 private TmfTimeRange timeRange
= null;
449 while (!fExecutor
.isShutdown()) {
450 if (!getIndexer().isIndexing()) {
451 ITmfTimestamp startTimestamp
= TmfTimestamp
.BIG_CRUNCH
;
452 ITmfTimestamp endTimestamp
= TmfTimestamp
.BIG_BANG
;
453 for (final ITmfTrace
<T
> trace
: fTraces
) {
454 if (trace
.getStartTime().compareTo(startTimestamp
) < 0)
455 startTimestamp
= trace
.getStartTime();
456 if (trace
.getStreamingInterval() != 0 && trace
.getEndTime().compareTo(endTimestamp
) > 0)
457 endTimestamp
= trace
.getEndTime();
459 if (safeTimestamp
!= null && safeTimestamp
.compareTo(getTimeRange().getEndTime(), false) > 0)
460 timeRange
= new TmfTimeRange(startTimestamp
, safeTimestamp
);
463 safeTimestamp
= endTimestamp
;
464 if (timeRange
!= null) {
465 final TmfExperimentRangeUpdatedSignal signal
=
466 new TmfExperimentRangeUpdatedSignal(TmfExperiment
.this, TmfExperiment
.this, timeRange
);
471 Thread
.sleep(getStreamingInterval());
472 } catch (final InterruptedException e
) {
482 * @see org.eclipse.linuxtools.tmf.trace.ITmfTrace#getStreamingInterval()
485 public long getStreamingInterval() {
487 for (final ITmfTrace
<T
> trace
: fTraces
)
488 interval
= Math
.max(interval
, trace
.getStreamingInterval());
492 // ------------------------------------------------------------------------
494 // ------------------------------------------------------------------------
496 private Integer fEndSynchReference
;
499 * Signal handler for the TmfExperimentSelectedSignal signal
504 public void experimentSelected(final TmfExperimentSelectedSignal
<T
> signal
) {
505 final TmfExperiment
<?
> experiment
= signal
.getExperiment();
506 if (experiment
== this) {
507 setCurrentExperiment(experiment
);
508 fEndSynchReference
= Integer
.valueOf(signal
.getReference());
513 * Signal handler for the TmfEndSynchSignal signal
518 public void endSync(final TmfEndSynchSignal signal
) {
519 if (fEndSynchReference
!= null && fEndSynchReference
.intValue() == signal
.getReference()) {
520 fEndSynchReference
= null;
521 initializeStreamingMonitor();
526 * Signal handler for the TmfTraceUpdatedSignal signal
531 public void traceUpdated(final TmfTraceUpdatedSignal signal
) {
532 if (signal
.getTrace() == this) {
533 broadcast(new TmfExperimentUpdatedSignal(this, this));
538 * Signal handler for the TmfExperimentRangeUpdatedSignal signal
543 public void experimentRangeUpdated(final TmfExperimentRangeUpdatedSignal signal
) {
544 if (signal
.getExperiment() == this) {
545 getIndexer().buildIndex(getNbEvents(), signal
.getRange(), false);