analysis.graph: API cleanup for 10.0.0

Signed-off-by: Patrick Tasse <patrick.tasse@gmail.com>
eclipse-tracecompass · May 22, 2024 · 86190ed · 86190ed
1 parent c767772
commit 86190ed
Show file tree

Hide file tree

Showing 21 changed files with 114 additions and 312 deletions.
diff --git a/...c/org/eclipse/tracecompass/analysis/graph/core/tests/graph/TmfGraphLegacyWrapperTest.java b/...c/org/eclipse/tracecompass/analysis/graph/core/tests/graph/TmfGraphLegacyWrapperTest.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2022 École Polytechnique de Montréal
+ * Copyright (c) 2022, 2024 École Polytechnique de Montréal and others
  *
  * All rights reserved. This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0 which
@@ -13,8 +13,8 @@
 
 import java.io.IOException;
 
-import org.eclipse.tracecompass.analysis.graph.core.base.TmfGraph;
 import org.eclipse.tracecompass.analysis.graph.core.graph.ITmfGraph;
+import org.eclipse.tracecompass.internal.analysis.graph.core.base.TmfGraph;
 import org.eclipse.tracecompass.internal.analysis.graph.core.graph.legacy.TmfGraphLegacyWrapper;
 
 /**

diff --git a/...core.tests/src/org/eclipse/tracecompass/analysis/graph/core/tests/graph/TmfGraphTest.java b/...core.tests/src/org/eclipse/tracecompass/analysis/graph/core/tests/graph/TmfGraphTest.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2015 École Polytechnique de Montréal
+ * Copyright (c) 2015, 2024 École Polytechnique de Montréal and others
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License 2.0 which
@@ -27,14 +27,15 @@
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.tracecompass.analysis.graph.core.base.CycleDetectedException;
 import org.eclipse.tracecompass.analysis.graph.core.base.IGraphWorker;
-import org.eclipse.tracecompass.analysis.graph.core.base.ITmfGraphVisitor;
-import org.eclipse.tracecompass.analysis.graph.core.base.TmfEdge;
-import org.eclipse.tracecompass.analysis.graph.core.base.TmfEdge.EdgeType;
-import org.eclipse.tracecompass.analysis.graph.core.base.TmfGraph;
-import org.eclipse.tracecompass.analysis.graph.core.base.TmfVertex;
-import org.eclipse.tracecompass.analysis.graph.core.base.TmfVertex.EdgeDirection;
+import org.eclipse.tracecompass.analysis.graph.core.graph.ITmfGraphVisitor;
 import org.eclipse.tracecompass.analysis.graph.core.tests.stubs.TestGraphWorker;
+import org.eclipse.tracecompass.internal.analysis.graph.core.base.TmfEdge;
+import org.eclipse.tracecompass.internal.analysis.graph.core.base.TmfEdge.EdgeType;
+import org.eclipse.tracecompass.internal.analysis.graph.core.base.TmfGraph;
 import org.eclipse.tracecompass.internal.analysis.graph.core.base.TmfGraphStatistics;
+import org.eclipse.tracecompass.internal.analysis.graph.core.base.TmfGraphVisitor;
+import org.eclipse.tracecompass.internal.analysis.graph.core.base.TmfVertex;
+import org.eclipse.tracecompass.internal.analysis.graph.core.base.TmfVertex.EdgeDirection;
 import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
 import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimestamp;
 import org.junit.Test;
@@ -318,7 +319,7 @@ public void testCheckVertical() {
         n0.linkVertical(n1);
     }
 
-    private class ScanCountVertex implements ITmfGraphVisitor {
+    private class ScanCountVertex extends TmfGraphVisitor {
         public int nbVertex = 0;
         public int nbVLink = 0;
         public int nbHLink = 0;
@@ -433,7 +434,7 @@ public void testGraphStatistics() {
      * @author Francis Giraldeau
      *
      */
-    private class DuplicateDetectorVisitor implements ITmfGraphVisitor {
+    private class DuplicateDetectorVisitor extends TmfGraphVisitor {
         private final Set<TmfVertex> set = new HashSet<>();
         @Override
         public void visitHead(TmfVertex vertex) {

diff --git a/analysis/org.eclipse.tracecompass.analysis.graph.core/META-INF/MANIFEST.MF b/analysis/org.eclipse.tracecompass.analysis.graph.core/META-INF/MANIFEST.MF
@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
 Bundle-Vendor: %Bundle-Vendor
-Bundle-Version: 4.1.1.qualifier
+Bundle-Version: 5.0.0.qualifier
 Bundle-Localization: plugin
 Bundle-SymbolicName: org.eclipse.tracecompass.analysis.graph.core;singleton:=true
 Bundle-Activator: org.eclipse.tracecompass.internal.analysis.graph.core.Activator

diff --git a/...is.graph.core/src/org/eclipse/tracecompass/analysis/graph/core/base/ITmfGraphVisitor.java b/...is.graph.core/src/org/eclipse/tracecompass/analysis/graph/core/base/ITmfGraphVisitor.java
diff --git a/.../org/eclipse/tracecompass/analysis/graph/core/building/AbstractTmfGraphBuilderModule.java b/.../org/eclipse/tracecompass/analysis/graph/core/building/AbstractTmfGraphBuilderModule.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2015, 2022 École Polytechnique de Montréal
+ * Copyright (c) 2015, 2024 École Polytechnique de Montréal and others
  *
  * All rights reserved. This program and the accompanying materials are
  * made available under the terms of the Eclipse Public License 2.0 which
@@ -18,13 +18,11 @@
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 import org.eclipse.tracecompass.analysis.graph.core.base.IGraphWorker;
-import org.eclipse.tracecompass.analysis.graph.core.base.TmfGraph;
 import org.eclipse.tracecompass.analysis.graph.core.criticalpath.AbstractCriticalPathModule;
 import org.eclipse.tracecompass.analysis.graph.core.criticalpath.ICriticalPathProvider;
 import org.eclipse.tracecompass.analysis.graph.core.graph.ITmfGraph;
 import org.eclipse.tracecompass.analysis.graph.core.graph.WorkerSerializer;
 import org.eclipse.tracecompass.internal.analysis.graph.core.Activator;
-import org.eclipse.tracecompass.internal.analysis.graph.core.graph.legacy.TmfGraphLegacyWrapper;
 import org.eclipse.tracecompass.tmf.core.analysis.TmfAbstractAnalysisModule;
 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
 import org.eclipse.tracecompass.tmf.core.event.TmfEvent;
@@ -44,8 +42,7 @@
  */
 public abstract class AbstractTmfGraphBuilderModule extends TmfAbstractAnalysisModule implements ICriticalPathProvider {
 
-    private @Nullable TmfGraph fGraph;
-    private @Nullable ITmfGraph fNewGraph;
+    private @Nullable ITmfGraph fGraph;
     private @Nullable ITmfEventRequest fRequest;
     private final AbstractCriticalPathModule fCriticalPathModule;
 
@@ -71,34 +68,14 @@ public AbstractTmfGraphBuilderModule() {
      */
     protected abstract @Nullable ITmfGraph createGraphInstance(Path htFile, WorkerSerializer workerSerializer, long startTime, int version);
 
-    /**
-     * Gets the graph generated by the analysis
-     *
-     * @return The generated graph
-     * @deprecated Use the new {@link #getTmfGraph()} instead
-     */
-    @Deprecated
-    public @Nullable TmfGraph getGraph() {
-        return fGraph;
-    }
-
     /**
      * Gets the graph generated by the analysis
      *
      * @return The generated graph
      * @since 3.2
      */
     public @Nullable ITmfGraph getTmfGraph() {
-        ITmfGraph newGraph = fNewGraph;
-        if (newGraph != null) {
-            return newGraph;
-        }
-        // Try wrapping the legacy graph if available
-        TmfGraph graph = fGraph;
-        if (graph != null) {
-            return new TmfGraphLegacyWrapper(graph);
-        }
-        return null;
+        return fGraph;
     }
 
     // ------------------------------------------------------------------------
@@ -107,18 +84,15 @@ public AbstractTmfGraphBuilderModule() {
 
     @Override
     protected boolean executeAnalysis(final IProgressMonitor monitor) {
-        if (fGraph == null) {
-            final ITmfGraphProvider provider = getGraphProvider();
+        final ITmfGraphProvider provider = getGraphProvider();
 
-            /*
-             * TODO: This will eventually support multiple backends so we can
-             * save the graph on disk, like the state system, but for now, it is
-             * just in memory
-             */
-
-            createGraph(provider);
+        /*
+         * TODO: This will eventually support multiple backends so we can
+         * save the graph on disk, like the state system, but for now, it is
+         * just in memory
+         */
 
-        }
+        createGraph(provider);
         return !monitor.isCanceled();
     }
 
@@ -144,12 +118,11 @@ protected void canceling() {
     public void dispose() {
         fCriticalPathModule.dispose();
         super.dispose();
-        fGraph = null;
-        ITmfGraph newGraph = fNewGraph;
-        if (newGraph != null) {
-            newGraph.dispose();
+        ITmfGraph graph = fGraph;
+        if (graph != null) {
+            graph.dispose();
         }
-        fNewGraph = null;
+        fGraph = null;
     }
 
     // ------------------------------------------------------------------------
@@ -166,8 +139,7 @@ private void createGraph(ITmfGraphProvider provider) {
         Path htFile = Paths.get(fileDirectory + id + ".ht"); //$NON-NLS-1$
 
         ITmfGraph graph = createGraphInstance(htFile, getWorkerSerializer(), provider.getStartTime(), provider.getGraphFileVersion());
-        fNewGraph = graph;
-        fGraph = new TmfGraph();
+        fGraph = graph;
         if (graph != null) {
             provider.assignGraph(graph);
         }
@@ -230,7 +202,7 @@ private void build(ITmfGraphProvider provider, ITmfGraph graph) {
     private static class TmfGraphBuildRequest extends TmfEventRequest {
 
         private final ITmfGraphProvider fProvider;
-        private final ITmfGraph fGraph;
+        private final ITmfGraph fBuilderGraph;
         private long fLastEnd;
 
         /**
@@ -248,7 +220,7 @@ public TmfGraphBuildRequest(ITmfGraphProvider provider, ITmfGraph graph) {
                     ITmfEventRequest.ExecutionType.BACKGROUND);
 
             fProvider = provider;
-            fGraph = graph;
+            fBuilderGraph = graph;
         }
 
         @Override
@@ -262,7 +234,7 @@ public void handleData(final ITmfEvent event) {
         public synchronized void done() {
             super.done();
             fProvider.done();
-            fGraph.closeGraph(fLastEnd);
+            fBuilderGraph.closeGraph(fLastEnd);
         }
 
         @Override
@@ -273,17 +245,6 @@ public void handleCancel() {
 
     }
 
-    /**
-     * @since 1.1
-     * @deprecated Use the new API via the {@link #getCriticalPathGraph()}
-     *             method instead
-     */
-    @Deprecated
-    @Override
-    public @Nullable TmfGraph getCriticalPath() {
-        return fCriticalPathModule.getCriticalPath();
-    }
-
     @Override
     public @Nullable ITmfGraph getCriticalPathGraph() {
         return fCriticalPathModule.getCriticalPathGraph();

diff --git a/...e/src/org/eclipse/tracecompass/analysis/graph/core/building/AbstractTmfGraphProvider.java b/...e/src/org/eclipse/tracecompass/analysis/graph/core/building/AbstractTmfGraphProvider.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2015, 2022 École Polytechnique de Montréal
+ * Copyright (c) 2015, 2024 École Polytechnique de Montréal and others
  *
  * All rights reserved. This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0 which
@@ -18,10 +18,10 @@
 
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
-import org.eclipse.tracecompass.analysis.graph.core.base.TmfGraph;
 import org.eclipse.tracecompass.analysis.graph.core.graph.ITmfGraph;
 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
+
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.ImmutableList;
 
@@ -53,8 +53,7 @@ public abstract class AbstractTmfGraphProvider implements ITmfGraphProvider {
     private boolean fGraphAssigned;
 
     /** Graph in which to insert the state changes */
-    private @Nullable TmfGraph fGraph = null;
-    private @Nullable ITmfGraph fNewGraph = null;
+    private @Nullable ITmfGraph fGraph = null;
 
     /**
      * Instantiate a new graph builder plugin.
@@ -80,28 +79,15 @@ public long getStartTime() {
         return fTrace.getStartTime().toNanos();
     }
 
-    @Deprecated
-    @Override
-    public void assignTargetGraph(TmfGraph graph) {
-        fGraph = graph;
-        fGraphAssigned = true;
-    }
-
-    @Deprecated
-    @Override
-    public @Nullable TmfGraph getAssignedGraph() {
-        return fGraph;
-    }
-
     @Override
     public void assignGraph(@NonNull ITmfGraph graph) {
-        fNewGraph = graph;
+        fGraph = graph;
         fGraphAssigned = true;
     }
 
     @Override
     public @Nullable ITmfGraph getGraph() {
-        return fNewGraph;
+        return fGraph;
     }
 
     @Override
@@ -117,7 +103,6 @@ public void processEvent(ITmfEvent event) {
     public void dispose() {
         fGraphAssigned = false;
         fGraph = null;
-        fNewGraph = null;
     }
 
     @Override