-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
scripting: Move the script event request to its own class
It is possible to make event requests without having an analysis. So now the trace module also provides a getEventIterator method for a trace, the request has been moved to its own file, and has a #getEventIterator method Change-Id: I73a1d51aafdb87960e6b91877fb4102e41b6a6d2 Signed-off-by: Geneviève Bastien <gbastien+lttng@versatic.net> Reviewed-on: https://git.eclipse.org/r/151118 Tested-by: CI Bot Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
- Loading branch information
Showing
4 changed files
with
195 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
124 changes: 124 additions & 0 deletions
124
.../org/eclipse/tracecompass/incubator/internal/scripting/core/trace/ScriptEventRequest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2019 École Polytechnique de Montréal | ||
| * | ||
| * All rights reserved. This program and the accompanying materials are | ||
| * made available under the terms of the Eclipse Public License v1.0 which | ||
| * accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| *******************************************************************************/ | ||
|
|
||
| package org.eclipse.tracecompass.incubator.internal.scripting.core.trace; | ||
|
|
||
| import java.util.Iterator; | ||
| import java.util.NoSuchElementException; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNull; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.eclipse.tracecompass.common.core.collect.BufferedBlockingQueue; | ||
| import org.eclipse.tracecompass.tmf.core.event.ITmfEvent; | ||
| import org.eclipse.tracecompass.tmf.core.event.TmfEvent; | ||
| import org.eclipse.tracecompass.tmf.core.request.ITmfEventRequest; | ||
| import org.eclipse.tracecompass.tmf.core.request.TmfEventRequest; | ||
| import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimeRange; | ||
| import org.eclipse.tracecompass.tmf.core.trace.ITmfContext; | ||
| import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace; | ||
|
|
||
| /** | ||
| * An event request for scripted analysis. This class has a {link | ||
| * #getEventIterator()} method which returns the iterator to go through the | ||
| * events. Callers need to explicitly send the request to a trace or experiment, | ||
| * using {@link ITmfTrace#sendRequest(ITmfEventRequest)}. | ||
| * | ||
| * @author Geneviève Bastien | ||
| */ | ||
| public class ScriptEventRequest extends TmfEventRequest { | ||
|
|
||
| private static final int DEFAULT_EVENTS_QUEUE_SIZE = 127; | ||
| private static final int DEFAULT_EVENTS_CHUNK_SIZE = 127; | ||
|
|
||
| /** | ||
| * Fake event indicating the build is over, and the provider should close | ||
| */ | ||
| private static class EndEvent extends TmfEvent { | ||
| public EndEvent() { | ||
| super(null, ITmfContext.UNKNOWN_RANK, null, null, null); | ||
| } | ||
| } | ||
|
|
||
| private static final EndEvent END_EVENT = new EndEvent(); | ||
|
|
||
| private final BufferedBlockingQueue<ITmfEvent> fEventsQueue; | ||
| private final EventIterator fEventIterator; | ||
|
|
||
| /** | ||
| * Constructor | ||
| */ | ||
| public ScriptEventRequest() { | ||
| super(ITmfEvent.class, TmfTimeRange.ETERNITY, 0, ITmfEventRequest.ALL_DATA, ExecutionType.BACKGROUND, 100); | ||
| fEventsQueue = new BufferedBlockingQueue<>(DEFAULT_EVENTS_QUEUE_SIZE, DEFAULT_EVENTS_CHUNK_SIZE); | ||
| fEventIterator = new EventIterator(fEventsQueue); | ||
| } | ||
|
|
||
| @Override | ||
| public void handleData(@NonNull ITmfEvent event) { | ||
| super.handleData(event); | ||
| fEventsQueue.put(event); | ||
| } | ||
|
|
||
| @Override | ||
| public synchronized void done() { | ||
| super.done(); | ||
| fEventsQueue.put(END_EVENT); | ||
| fEventsQueue.flushInputBuffer(); | ||
| } | ||
|
|
||
| @Override | ||
| public synchronized void cancel() { | ||
| super.cancel(); | ||
| fEventsQueue.put(END_EVENT); | ||
| fEventsQueue.flushInputBuffer(); | ||
| } | ||
|
|
||
| /** | ||
| * Get the event iterator that will contain the events being read. | ||
| * | ||
| * @return The event iterator | ||
| */ | ||
| public Iterator<ITmfEvent> getEventIterator() { | ||
| return fEventIterator; | ||
| } | ||
|
|
||
| private static class EventIterator implements Iterator<ITmfEvent> { | ||
|
|
||
| private final BufferedBlockingQueue<ITmfEvent> fEventsQueue; | ||
| private @Nullable ITmfEvent fNext; | ||
|
|
||
| public EventIterator(BufferedBlockingQueue<ITmfEvent> eventsQueue) { | ||
| fEventsQueue = eventsQueue; | ||
| } | ||
|
|
||
| @Override | ||
| public synchronized boolean hasNext() { | ||
| ITmfEvent next = fNext; | ||
| if (next == null) { | ||
| next = fEventsQueue.take(); | ||
| fNext = next; | ||
| } | ||
| return next != END_EVENT; | ||
| } | ||
|
|
||
| @Override | ||
| public synchronized ITmfEvent next() { | ||
| if (hasNext()) { | ||
| ITmfEvent next = fNext; | ||
| fNext = null; | ||
| if (next != null) { | ||
| return next; | ||
| } | ||
| } | ||
| throw new NoSuchElementException("No more elements in the queue"); //$NON-NLS-1$ | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters