1 /*******************************************************************************
2 * Copyright (c) 2011, 2014 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 * Patrick Tasse - Initial API and implementation
11 * Bernd Hufmann - Add support for event collapsing
12 ******************************************************************************/
14 package org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
;
16 import java
.util
.ArrayList
;
17 import java
.util
.Arrays
;
18 import java
.util
.List
;
20 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
21 import org
.eclipse
.core
.runtime
.IStatus
;
22 import org
.eclipse
.core
.runtime
.Status
;
23 import org
.eclipse
.core
.runtime
.jobs
.Job
;
24 import org
.eclipse
.tracecompass
.internal
.tmf
.core
.filter
.TmfCollapseFilter
;
25 import org
.eclipse
.tracecompass
.internal
.tmf
.ui
.Activator
;
26 import org
.eclipse
.tracecompass
.tmf
.core
.component
.ITmfEventProvider
;
27 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
28 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEventField
;
29 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEventType
;
30 import org
.eclipse
.tracecompass
.tmf
.core
.filter
.ITmfFilter
;
31 import org
.eclipse
.tracecompass
.tmf
.core
.request
.ITmfEventRequest
;
32 import org
.eclipse
.tracecompass
.tmf
.core
.request
.TmfEventRequest
;
33 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
34 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.TmfTimeRange
;
35 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
38 * The generic TMF Events table events cache
40 * This can help avoid re-reading the trace when the user scrolls a window,
43 * @author Patrick Tasse
45 public class TmfEventsCache
{
48 * The generic TMF Events table cached event.
50 * @author Patrick Tasse
52 public static class CachedEvent
implements ITmfEvent
{
56 * When {@link TmfCollapseFilter} is active then it's event reference
57 * of the first event of repeated events.
63 * When {@link TmfCollapseFilter} is active then it's event rank of the
64 * first event of repeated events.
68 * Number times event is repeated. Updated by using {@link TmfCollapseFilter}
73 * Constructor for new cached events.
76 * The original trace event
78 * The rank of this event in the trace
80 public CachedEvent (ITmfEvent iTmfEvent
, long rank
) {
81 this.event
= iTmfEvent
;
88 public Object
getAdapter(Class adapter
) {
89 return event
.getAdapter(adapter
);
95 public ITmfTrace
getTrace() {
96 return event
.getTrace();
102 public long getRank() {
103 return event
.getRank();
109 public ITmfTimestamp
getTimestamp() {
110 return event
.getTimestamp();
116 public String
getSource() {
117 return event
.getSource();
123 public ITmfEventType
getType() {
124 return event
.getType();
130 public ITmfEventField
getContent() {
131 return event
.getContent();
137 public String
getReference() {
138 return event
.getReference();
142 private final CachedEvent
[] fCache
;
143 private final int fCacheSize
;
144 private int fCacheStartIndex
= 0;
145 private int fCacheEndIndex
= 0;
147 private ITmfTrace fTrace
;
148 private final TmfEventsTable fTable
;
149 private ITmfFilter fFilter
;
150 private final List
<Integer
> fFilterIndex
= new ArrayList
<>(); // contains the event rank at each 'cache size' filtered events
153 * Constructor for the event cache
156 * The size of the cache, in number of events
158 * The Events table this cache will cover
160 public TmfEventsCache(int cacheSize
, TmfEventsTable table
) {
161 fCacheSize
= cacheSize
;
162 fCache
= new CachedEvent
[cacheSize
* 2]; // the cache holds two blocks of cache size
167 * Assign a new trace to this events cache. This clears the current
171 * The trace to assign.
173 public void setTrace(ITmfTrace trace
) {
179 * Clear the current contents of this cache.
181 public synchronized void clear() {
182 if (job
!= null && job
.getState() != Job
.NONE
) {
185 Arrays
.fill(fCache
, null);
186 fCacheStartIndex
= 0;
188 fFilterIndex
.clear();
192 * Apply a filter on this event cache. This clears the current cache
196 * The ITmfFilter to apply.
198 public void applyFilter(ITmfFilter filter
) {
204 * Clear the current filter on this cache. This also clears the current
207 public void clearFilter() {
213 * Get an event from the cache. If the cache does not contain the event,
214 * a cache population request is triggered.
217 * The index of this event in the cache
218 * @return The cached event, or 'null' if the event is not in the cache
220 public synchronized CachedEvent
getEvent(int index
) {
221 if ((index
>= fCacheStartIndex
) && (index
< fCacheEndIndex
)) {
222 int i
= index
- fCacheStartIndex
;
225 populateCache(index
);
230 * Peek an event in the cache. Does not trigger cache population.
233 * Index of the event to peek
234 * @return The cached event, or 'null' if the event is not in the cache
236 public synchronized CachedEvent
peekEvent(int index
) {
237 if ((index
>= fCacheStartIndex
) && (index
< fCacheEndIndex
)) {
238 int i
= index
- fCacheStartIndex
;
245 * Add a trace event to the cache.
248 * The original trace event to be cached
250 * The rank of this event in the trace
252 * The index this event will occupy in the cache
254 public synchronized void storeEvent(ITmfEvent event
, long rank
, int index
) {
255 if (index
== fCacheEndIndex
) {
256 int i
= index
- fCacheStartIndex
;
257 if (i
< fCache
.length
) {
258 fCache
[i
] = new CachedEvent(event
, rank
);
262 if ((fFilter
!= null) && ((index
% fCacheSize
) == 0)) {
263 int i
= index
/ fCacheSize
;
264 fFilterIndex
.add(i
, Integer
.valueOf((int) rank
));
269 * Update event repeat count at index
272 * The index this event occupies in the cache
276 public synchronized void updateCollapsedEvent(int index
) {
277 int i
= index
- fCacheStartIndex
;
278 if (i
< fCache
.length
) {
279 fCache
[i
].repeatCount
++;
284 * Get the cache index of an event from his rank in the trace. This will
285 * take in consideration any filter that might be applied.
288 * The rank of the event in the trace
289 * @return The position (index) this event should use once cached
291 public int getFilteredEventIndex(final long rank
) {
294 TmfEventRequest request
;
295 final ITmfFilter filter
= fFilter
;
296 synchronized (this) {
298 int end
= fFilterIndex
.size();
300 if ((fCacheEndIndex
- fCacheStartIndex
) > 1) {
301 if (rank
< fCache
[0].rank
) {
302 end
= (fCacheStartIndex
/ fCacheSize
) + 1;
303 } else if (rank
> fCache
[fCacheEndIndex
- fCacheStartIndex
- 1].rank
) {
304 start
= fCacheEndIndex
/ fCacheSize
;
306 for (int i
= 0; i
< (fCacheEndIndex
- fCacheStartIndex
); i
++) {
307 if (fCache
[i
].rank
>= rank
) {
308 return fCacheStartIndex
+ i
;
311 return fCacheEndIndex
;
315 current
= (start
+ end
) / 2;
316 while (current
!= start
) {
317 if (rank
< fFilterIndex
.get(current
)) {
319 current
= (start
+ end
) / 2;
322 current
= (start
+ end
) / 2;
325 startRank
= fFilterIndex
.size() > 0 ? fFilterIndex
.get(current
) : 0;
328 final int index
= current
* fCacheSize
;
330 class DataRequest
extends TmfEventRequest
{
331 ITmfFilter requestFilter
;
335 DataRequest(Class
<?
extends ITmfEvent
> dataType
, ITmfFilter reqFilter
, int start
, int nbRequested
) {
336 super(dataType
, TmfTimeRange
.ETERNITY
, start
, nbRequested
,
337 TmfEventRequest
.ExecutionType
.FOREGROUND
);
338 requestFilter
= reqFilter
;
340 requestIndex
= index
;
344 public void handleData(ITmfEvent event
) {
345 super.handleData(event
);
349 if (requestRank
>= rank
) {
354 if (requestFilter
.matches(event
)) {
359 public int getFilteredIndex() {
364 request
= new DataRequest(ITmfEvent
.class, filter
, startRank
, ITmfEventRequest
.ALL_DATA
);
365 ((ITmfEventProvider
) fTrace
).sendRequest(request
);
367 request
.waitForCompletion();
368 return ((DataRequest
) request
).getFilteredIndex();
369 } catch (InterruptedException e
) {
370 Activator
.getDefault().logError("Filter request interrupted!", e
); //$NON-NLS-1$
375 // ------------------------------------------------------------------------
376 // Event cache population
377 // ------------------------------------------------------------------------
379 // The event fetching job
381 private synchronized void populateCache(final int index
) {
383 /* Check if the current job will fetch the requested event:
384 * 1. The job must exist
385 * 2. It must be running (i.e. not completed)
386 * 3. The requested index must be within the cache range
388 * If the job meets these conditions, we simply exit.
389 * Otherwise, we create a new job but we might have to cancel
390 * an existing job for an obsolete range.
393 if (job
.getState() != Job
.NONE
) {
394 if ((index
>= fCacheStartIndex
) && (index
< (fCacheStartIndex
+ fCache
.length
))) {
397 // The new index is out of the requested range
398 // Kill the job and start a new one
403 // Populate the cache starting at the index that is one block less
404 // of cache size than the requested index. The cache will hold two
405 // consecutive blocks of cache size, centered on the requested index.
406 fCacheStartIndex
= Math
.max(0, index
- fCacheSize
);
407 fCacheEndIndex
= fCacheStartIndex
;
409 job
= new Job("Fetching Events") { //$NON-NLS-1$
410 private int startIndex
= fCacheStartIndex
;
411 private int skipCount
= 0;
413 protected IStatus
run(final IProgressMonitor monitor
) {
416 if (fFilter
== null) {
417 nbRequested
= fCache
.length
;
419 nbRequested
= ITmfEventRequest
.ALL_DATA
;
420 int i
= startIndex
/ fCacheSize
;
421 if (i
< fFilterIndex
.size()) {
422 skipCount
= startIndex
- (i
* fCacheSize
);
423 startIndex
= fFilterIndex
.get(i
);
427 TmfEventRequest request
= new TmfEventRequest(ITmfEvent
.class,
428 TmfTimeRange
.ETERNITY
,
431 TmfEventRequest
.ExecutionType
.FOREGROUND
) {
432 private int count
= 0;
433 private long rank
= startIndex
;
435 public void handleData(ITmfEvent event
) {
436 // If the job is canceled, cancel the request so waitForCompletion() will unlock
437 if (monitor
.isCanceled()) {
441 super.handleData(event
);
442 if (((fFilter
== null) || fFilter
.matches(event
)) && (skipCount
-- <= 0)) {
443 synchronized (TmfEventsCache
.this) {
444 if (monitor
.isCanceled()) {
447 fCache
[count
] = new CachedEvent(event
, rank
);
451 if (fFilter
!= null) {
452 fTable
.cacheUpdated(false);
454 } else if (((fFilter
!= null) && !fFilter
.matches(event
)) && (skipCount
<= 0)) { // TODO fix duplicated call to matches()
455 if ((count
> 0) && (fFilter
instanceof TmfCollapseFilter
)) {
456 fCache
[count
- 1].repeatCount
++;
459 if (count
>= fCache
.length
) {
461 } else if ((fFilter
!= null) && (count
>= (fTable
.getTable().getItemCount() - 3))) { // -1 for header row, -2 for top and bottom filter status rows
468 ((ITmfEventProvider
) fTrace
).sendRequest(request
);
470 request
.waitForCompletion();
471 } catch (InterruptedException e
) {
472 Activator
.getDefault().logError("Wait for completion interrupted for populateCache ", e
); //$NON-NLS-1$
475 fTable
.cacheUpdated(true);
477 // Flag the UI thread that the cache is ready
478 if (monitor
.isCanceled()) {
479 return Status
.CANCEL_STATUS
;
481 return Status
.OK_STATUS
;
484 //job.setSystem(true);
485 job
.setPriority(Job
.SHORT
);
This page took 0.041815 seconds and 5 git commands to generate.