1 /*******************************************************************************
2 * Copyright (c) 2013, 2014 École Polytechnique de Montréal
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 * Geneviève Bastien - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.tracecompass
.tmf
.core
.analysis
;
15 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
17 import java
.util
.ArrayList
;
18 import java
.util
.Collections
;
19 import java
.util
.HashMap
;
20 import java
.util
.List
;
23 import java
.util
.concurrent
.CountDownLatch
;
24 import java
.util
.concurrent
.TimeUnit
;
26 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
27 import org
.eclipse
.core
.runtime
.IStatus
;
28 import org
.eclipse
.core
.runtime
.NullProgressMonitor
;
29 import org
.eclipse
.core
.runtime
.Status
;
30 import org
.eclipse
.core
.runtime
.jobs
.Job
;
31 import org
.eclipse
.jdt
.annotation
.NonNullByDefault
;
32 import org
.eclipse
.jdt
.annotation
.Nullable
;
33 import org
.eclipse
.osgi
.util
.NLS
;
34 import org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
;
35 import org
.eclipse
.tracecompass
.internal
.tmf
.core
.Activator
;
36 import org
.eclipse
.tracecompass
.internal
.tmf
.core
.TmfCoreTracer
;
37 import org
.eclipse
.tracecompass
.tmf
.core
.analysis
.TmfAnalysisRequirement
.ValuePriorityLevel
;
38 import org
.eclipse
.tracecompass
.tmf
.core
.component
.TmfComponent
;
39 import org
.eclipse
.tracecompass
.tmf
.core
.exceptions
.TmfAnalysisException
;
40 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfSignalHandler
;
41 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfStartAnalysisSignal
;
42 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceClosedSignal
;
43 import org
.eclipse
.tracecompass
.tmf
.core
.signal
.TmfTraceSelectedSignal
;
44 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.ITmfTrace
;
45 import org
.eclipse
.tracecompass
.tmf
.core
.trace
.TmfTraceManager
;
48 * Base class that analysis modules main class may extend. It provides default
49 * behavior to some methods of the analysis module
51 * @author Geneviève Bastien
54 public abstract class TmfAbstractAnalysisModule
extends TmfComponent
implements IAnalysisModule
{
56 private @Nullable String fId
;
57 private boolean fAutomatic
= false, fStarted
= false;
58 private volatile @Nullable ITmfTrace fTrace
;
59 private final Map
<String
, Object
> fParameters
= new HashMap
<>();
60 private final List
<String
> fParameterNames
= new ArrayList
<>();
61 private final List
<IAnalysisOutput
> fOutputs
= new ArrayList
<>();
62 private List
<IAnalysisParameterProvider
> fParameterProviders
= new ArrayList
<>();
63 private @Nullable Job fJob
= null;
65 private final Object syncObj
= new Object();
67 /* Latch tracking if the analysis is completed or not */
68 private CountDownLatch fFinishedLatch
= new CountDownLatch(0);
70 private boolean fAnalysisCancelled
= false;
73 public boolean isAutomatic() {
78 public String
getName() {
79 return super.getName();
83 public void setName(String name
) {
88 public void setId(String id
) {
93 public String
getId() {
96 id
= this.getClass().getCanonicalName();
99 * Some types, like anonymous classes, don't have a canonical
100 * name. Just use the default name instead.
102 id
= checkNotNull(this.getClass().getName());
110 public void setAutomatic(boolean auto
) {
118 public boolean setTrace(ITmfTrace trace
) throws TmfAnalysisException
{
119 if (fTrace
!= null) {
120 throw new TmfAnalysisException(NLS
.bind(Messages
.TmfAbstractAnalysisModule_TraceSetMoreThanOnce
, getName()));
123 TmfCoreTracer
.traceAnalysis(getId(), trace
, "setting trace for analysis"); //$NON-NLS-1$
125 /* Check that analysis can be executed */
126 if (!canExecute(trace
)) {
131 /* Get the parameter providers for this trace */
132 fParameterProviders
= TmfAnalysisManager
.getParameterProviders(this, trace
);
133 for (IAnalysisParameterProvider provider
: fParameterProviders
) {
134 TmfCoreTracer
.traceAnalysis(getId(), trace
, "registered to parameter provider " + provider
.getName()); //$NON-NLS-1$
135 provider
.registerModule(this);
147 protected @Nullable ITmfTrace
getTrace() {
152 public void addParameter(String name
) {
153 fParameterNames
.add(name
);
157 public synchronized void setParameter(String name
, @Nullable Object value
) {
158 if (!fParameterNames
.contains(name
)) {
159 throw new RuntimeException(NLS
.bind(Messages
.TmfAbstractAnalysisModule_InvalidParameter
, name
, getName()));
161 Object oldValue
= fParameters
.get(name
);
162 fParameters
.put(name
, value
);
163 if ((value
!= null) && !(value
.equals(oldValue
))) {
164 parameterChanged(name
);
169 public synchronized void notifyParameterChanged(String name
) {
170 if (!fParameterNames
.contains(name
)) {
171 throw new RuntimeException(NLS
.bind(Messages
.TmfAbstractAnalysisModule_InvalidParameter
, name
, getName()));
173 Object oldValue
= fParameters
.get(name
);
174 Object value
= getParameter(name
);
175 if ((value
!= null) && !(value
.equals(oldValue
))) {
176 parameterChanged(name
);
181 * Used to indicate that a parameter value has been changed
184 * The name of the modified parameter
186 protected void parameterChanged(String name
) {
191 public @Nullable Object
getParameter(String name
) {
192 Object paramValue
= fParameters
.get(name
);
193 /* The parameter is not set, maybe it can be provided by someone else */
194 if ((paramValue
== null) && (fTrace
!= null)) {
195 for (IAnalysisParameterProvider provider
: fParameterProviders
) {
196 paramValue
= provider
.getParameter(name
);
197 if (paramValue
!= null) {
206 public boolean canExecute(ITmfTrace trace
) {
207 for (TmfAnalysisRequirement requirement
: getAnalysisRequirements()) {
208 if (!requirement
.isFulfilled(trace
)) {
216 * Set the countdown latch back to 1 so the analysis can be executed again
218 protected void resetAnalysis() {
219 TmfCoreTracer
.traceAnalysis(getId(), getTrace(), "reset: ready for execution"); //$NON-NLS-1$
220 fFinishedLatch
.countDown();
221 fFinishedLatch
= new CountDownLatch(1);
225 * Actually executes the analysis itself
229 * @return Whether the analysis was completed successfully or not
230 * @throws TmfAnalysisException
231 * Method may throw an analysis exception
233 protected abstract boolean executeAnalysis(final IProgressMonitor monitor
) throws TmfAnalysisException
;
236 * Indicate the analysis has been canceled. It is abstract to force
237 * implementing class to cleanup what they are running. This is called by
238 * the job's canceling. It does not need to be called directly.
240 protected abstract void canceling();
243 * To be called when the analysis is completed, whether normally or because
244 * it was cancelled or for any other reason.
246 * It has to be called inside a synchronized block
248 private void setAnalysisCompleted() {
249 synchronized (syncObj
) {
252 fFinishedLatch
.countDown();
257 * Cancels the analysis if it is executing
260 public final void cancel() {
261 synchronized (syncObj
) {
262 TmfCoreTracer
.traceAnalysis(getId(), getTrace(), "cancelled by application"); //$NON-NLS-1$
265 fAnalysisCancelled
= true;
266 setAnalysisCompleted();
274 public void dispose() {
280 * Get an iterable list of all analyzes this analysis depends on. These
281 * analyzes will be scheduled before this analysis starts and the current
282 * analysis will not be considered completed until all the dependent
283 * analyzes are finished.
285 * @return An iterable list of analysis this analyzes depends on.
287 protected Iterable
<IAnalysisModule
> getDependentAnalyses() {
288 return checkNotNull(Collections
.EMPTY_LIST
);
291 private void execute(final ITmfTrace trace
) {
293 * TODO: The analysis in a job should be done at the analysis manager
294 * level instead of depending on this abstract class implementation,
295 * otherwise another analysis implementation may block the main thread
298 /* Do not execute if analysis has already run */
299 if (fFinishedLatch
.getCount() == 0) {
300 TmfCoreTracer
.traceAnalysis(getId(), getTrace(), "already executed"); //$NON-NLS-1$
304 /* Do not execute if analysis already running */
305 synchronized (syncObj
) {
307 TmfCoreTracer
.traceAnalysis(getId(), getTrace(), "already started, not starting again"); //$NON-NLS-1$
313 /* Execute dependent analyses before creating the job for this one */
314 final Iterable
<IAnalysisModule
> dependentAnalyses
= getDependentAnalyses();
315 for (IAnalysisModule module
: dependentAnalyses
) {
320 * Actual analysis will be run on a separate thread
322 String jobName
= checkNotNull(NLS
.bind(Messages
.TmfAbstractAnalysisModule_RunningAnalysis
, getName()));
323 fJob
= new Job(jobName
) {
325 protected @Nullable IStatus
run(final @Nullable IProgressMonitor monitor
) {
326 IProgressMonitor mon
= monitor
;
328 mon
= new NullProgressMonitor();
331 mon
.beginTask("", IProgressMonitor
.UNKNOWN
); //$NON-NLS-1$
332 broadcast(new TmfStartAnalysisSignal(TmfAbstractAnalysisModule
.this, TmfAbstractAnalysisModule
.this));
333 TmfCoreTracer
.traceAnalysis(TmfAbstractAnalysisModule
.this.getId(), TmfAbstractAnalysisModule
.this.getTrace(), "started"); //$NON-NLS-1$
334 fAnalysisCancelled
= !executeAnalysis(mon
);
335 for (IAnalysisModule module
: dependentAnalyses
) {
336 module
.waitForCompletion(mon
);
338 TmfCoreTracer
.traceAnalysis(TmfAbstractAnalysisModule
.this.getId(), TmfAbstractAnalysisModule
.this.getTrace(), "finished"); //$NON-NLS-1$
339 } catch (TmfAnalysisException e
) {
340 Activator
.logError("Error executing analysis with trace " + trace
.getName(), e
); //$NON-NLS-1$
342 synchronized (syncObj
) {
344 setAnalysisCompleted();
346 TmfTraceManager
.refreshSupplementaryFiles(trace
);
348 if (!fAnalysisCancelled
) {
349 return Status
.OK_STATUS
;
351 // Reset analysis so that it can be executed again.
353 return Status
.CANCEL_STATUS
;
357 protected void canceling() {
358 TmfCoreTracer
.traceAnalysis(getId(), getTrace(), "job cancelled"); //$NON-NLS-1$
359 TmfAbstractAnalysisModule
.this.canceling();
367 public IStatus
schedule() {
368 synchronized (syncObj
) {
369 final ITmfTrace trace
= getTrace();
371 return new Status(IStatus
.ERROR
, Activator
.PLUGIN_ID
, String
.format("No trace specified for analysis %s", getName())); //$NON-NLS-1$
373 TmfCoreTracer
.traceAnalysis(getId(), getTrace(), "scheduled"); //$NON-NLS-1$
377 return checkNotNull(Status
.OK_STATUS
);
381 public Iterable
<IAnalysisOutput
> getOutputs() {
386 public void registerOutput(IAnalysisOutput output
) {
387 if (!fOutputs
.contains(output
)) {
388 fOutputs
.add(output
);
393 public boolean waitForCompletion() {
395 fFinishedLatch
.await();
396 } catch (InterruptedException e
) {
397 Activator
.logError("Error while waiting for module completion", e
); //$NON-NLS-1$
399 return !fAnalysisCancelled
;
403 public boolean waitForCompletion(IProgressMonitor monitor
) {
405 while (!fFinishedLatch
.await(500, TimeUnit
.MILLISECONDS
)) {
406 if (fAnalysisCancelled
|| monitor
.isCanceled()) {
407 fAnalysisCancelled
= true;
411 } catch (InterruptedException e
) {
412 Activator
.logError("Error while waiting for module completion", e
); //$NON-NLS-1$
414 return !fAnalysisCancelled
;
418 * Signal handler for trace closing
421 * Trace closed signal
424 public void traceClosed(TmfTraceClosedSignal signal
) {
425 /* Is the closing trace the one that was requested? */
426 synchronized (syncObj
) {
427 if (signal
.getTrace() == fTrace
) {
435 * Signal handler for when the trace becomes active
438 * Trace selected signal
441 public void traceSelected(TmfTraceSelectedSignal signal
) {
443 * Since some parameter providers may handle many traces, we need to
444 * register the current trace to it
446 if (signal
.getTrace() == fTrace
) {
447 for (IAnalysisParameterProvider provider
: fParameterProviders
) {
448 provider
.registerModule(this);
454 * Returns a full help text to display
456 * @return Full help text for the module
458 protected String
getFullHelpText() {
459 return NonNullUtils
.nullToEmptyString(NLS
.bind(
460 Messages
.TmfAbstractAnalysisModule_AnalysisModule
,
465 * Gets a short help text, to display as header to other help text
468 * The trace to show help for
470 * @return Short help text describing the module
472 protected String
getShortHelpText(ITmfTrace trace
) {
473 return NonNullUtils
.nullToEmptyString(NLS
.bind(
474 Messages
.TmfAbstractAnalysisModule_AnalysisForTrace
,
475 getName(), trace
.getName()));
479 * Gets the help text specific for a trace who does not have required
480 * characteristics for module to execute. The default implementation uses
481 * the analysis requirements.
484 * The trace to apply the analysis to
487 protected String
getTraceCannotExecuteHelpText(ITmfTrace trace
) {
488 StringBuilder builder
= new StringBuilder();
489 builder
.append(NLS
.bind(Messages
.TmfAbstractAnalysisModule_AnalysisCannotExecute
, getName()));
490 for (TmfAnalysisRequirement requirement
: getAnalysisRequirements()) {
491 if (!requirement
.isFulfilled(trace
)) {
492 builder
.append("\n\n"); //$NON-NLS-1$
493 builder
.append(NLS
.bind(Messages
.TmfAnalysis_RequirementNotFulfilled
, requirement
.getType()));
494 builder
.append("\n"); //$NON-NLS-1$
495 builder
.append(NLS
.bind(Messages
.TmfAnalysis_RequirementMandatoryValues
, requirement
.getValues(ValuePriorityLevel
.MANDATORY
)));
496 Set
<String
> information
= requirement
.getInformation();
497 if (!information
.isEmpty()) {
498 builder
.append("\n"); //$NON-NLS-1$
499 builder
.append(NLS
.bind(Messages
.TmfAnalysis_RequirementInformation
, information
));
503 return checkNotNull(builder
.toString());
507 public String
getHelpText() {
508 return getFullHelpText();
512 public String
getHelpText(ITmfTrace trace
) {
513 String text
= getShortHelpText(trace
);
514 if (!canExecute(trace
)) {
515 text
= text
+ "\n\n" + getTraceCannotExecuteHelpText(trace
); //$NON-NLS-1$
521 public Iterable
<TmfAnalysisRequirement
> getAnalysisRequirements() {
522 return checkNotNull(Collections
.EMPTY_SET
);