Allowing caching of filter creation and speed up colorize filter

Author: tkrodriguez

visualizer/IdealGraphVisualizer/Filter/src/main/java/org/graalvm/visualizer/filter/CachedLanguageFilter.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package org.graalvm.visualizer.filter;
+
+import org.graalvm.visualizer.graph.Diagram;
+
+import java.util.ArrayList;
+
+/**
+ * This represents a cacheable filter generated by {@link CustomFilter}.  It permits a {@link CustomFilter} to build the
+ * filter once instead of having to construct the filter for each invocation of the filter.
+ */
+public class CachedLanguageFilter extends AbstractFilter {
+    private final ArrayList<AbstractFilter> filters = new ArrayList<>();
+    private String name = "CachedLanguageFilter";
+
+    public CachedLanguageFilter() {
+    }
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    @Override
+    public void apply(Diagram d) {
+        for (var filter : filters) {
+            filter.apply(d);
+        }
+    }
+
+    public void add(AbstractFilter filter) {
+        filters.add(filter);
+    }
+}

visualizer/IdealGraphVisualizer/Filter/src/main/java/org/graalvm/visualizer/filter/CustomFilter.java

@@ -77,6 +77,13 @@ public class CustomFilter extends AbstractFilter {
     private String code;
     private String name;
 
+    /**
+     * A cached version of the filter chain built by the filter invocation.  This permits reusing the filter instead of
+     * constructor it from scratch each time.  If the filter invocation returns an instance of {@link CachedLanguageFilter}
+     * then that object is saved and used for all future invocations.
+     */
+    private CachedLanguageFilter cachedFilter;
+
     public CustomFilter(String name, String code) {
         this(name, code, MIME_JAVASCRIPT, Lookup.EMPTY);
     }
@@ -113,6 +120,7 @@ public void setCode(String s) {
             return;
         }
         code = s;
+        cachedFilter = null;
         fireChangedEvent();
     }
 
@@ -265,6 +273,11 @@ private PreparedScript executeHelperScripts(FilterEnvironment env, Map<String, O
     })
     @Override
     public void applyWith(FilterEnvironment env) {
+        if (cachedFilter != null) {
+            cachedFilter.apply(env.getDiagram());
+            return;
+        }
+
         PreparedScript previous;
         synchronized (this) {
             previous = executingScript.put(env, null);
@@ -303,7 +316,12 @@ void applyWith0(FilterEnvironment env) {
             if (prep == null) {
                 throw new IllegalStateException(Bundle.ERR_CannotRunScript(name, mimeType));
             } else {
-                evalScript(env, prep, b);
+                Object result = evalScript(env, prep, b);
+                if (result instanceof CachedLanguageFilter) {
+                    cachedFilter = (CachedLanguageFilter) result;
+                    cachedFilter.setName(name);
+                    cachedFilter.apply(env.getDiagram());
+                }
             }
         } catch (ScriptCancelledException ex) {
             throw new FilterCanceledException(env, ex.getCause());

visualizer/IdealGraphVisualizer/Filter/src/main/resources/org/graalvm/visualizer/filter/resources/defaultFilters.properties

@@ -29,6 +29,7 @@ ColorRule=org.graalvm.visualizer.filter.ColorFilter$ColorRule
 CombineFilter=org.graalvm.visualizer.filter.CombineFilter
 ConnectionFilter=org.graalvm.visualizer.filter.ConnectionFilter
 CustomFilter=org.graalvm.visualizer.filter.CustomFilter
+CachedLanguageFilter=org.graalvm.visualizer.filter.CachedLanguageFilter
 EdgeColorIndexFilter=org.graalvm.visualizer.filter.EdgeColorIndexFilter
 GradientColorFilter=org.graalvm.visualizer.filter.GradientColorFilter
 RemoveFilter=org.graalvm.visualizer.filter.RemoveFilter

visualizer/IdealGraphVisualizer/Graal/src/main/java/org/graalvm/visualizer/graal/filters/PropertyColorFilter.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package org.graalvm.visualizer.graal.filters;
+
+import org.graalvm.visualizer.filter.AbstractFilter;
+import org.graalvm.visualizer.graph.Diagram;
+import org.graalvm.visualizer.graph.Figure;
+
+import java.awt.Color;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+
+
+/**
+ * A more efficient bulk coloring implementation.
+ */
+public class PropertyColorFilter extends AbstractFilter {
+    Map<String, Map<String, Color>> stringColorMap = new HashMap<>();
+
+    public PropertyColorFilter() {
+    }
+
+    @Override
+    public String getName() {
+        return getClass().getSimpleName();
+    }
+
+    @Override
+    public void apply(Diagram diagram) {
+        applyColorMap(diagram);
+    }
+
+    private void applyColorMap(Diagram diagram) {
+        Set<String> keys = stringColorMap.keySet();
+        for (Figure f : diagram.getFigures()) {
+            for (String property : keys) {
+                Object value = f.getProperties().get(property);
+                if (value == null) {
+                    continue;
+                }
+                Color color = stringColorMap.get(property).get(value.toString());
+                if (color != null) {
+                    f.setColor(color);
+                }
+            }
+        }
+    }
+
+    /**
+     * Color any {@link Figure} with the {@code property} equals to {@code value} with the color {@code color}.
+     */
+    public void addRule(String property, String value, Color color) {
+        stringColorMap.computeIfAbsent(property, x -> new HashMap<>()).put(value, color);
+    }
+}

visualizer/IdealGraphVisualizer/Graal/src/main/resources/org/graalvm/visualizer/graal/filters/color.filter

@@ -8,23 +8,44 @@ var gray = new Color(220, 220, 220);
 var violet = new Color(201, 148, 199);
 var black = new Color(0, 0, 0);
 
-colorize("category", "controlSink", red);
-colorize("category", "controlSplit", red);
-colorize("category", "merge", red);
-colorize("category", "begin", orange);
-colorize("category", "end", orange);
-colorize("category", "fixed", yellow);
-colorize("category", "state", lightGreen);
-colorize("category", "phi", middleBlue);
-colorize("category", "proxy", middleBlue);
-colorize("category", "floating", lightBlue);
-colorize("class", ".*\\.nodes\\..*ParameterNode$", gray);
-colorize("class", ".*\\.nodes\\..*ConstantNode$", gray);
-colorize("class", ".*\\.nodes\\..*GuardNode$", violet);
-colorize("class", ".*\\.nodes\\.debug\\.BlackholeNode$", black);
+var cachedFilter = new CachedLanguageFilter();
+
+var f = new PropertyColorFilter();
+f.addRule("category", "controlSink", red);
+f.addRule("category", "controlSplit", red);
+f.addRule("category", "merge", red);
+f.addRule("category", "begin", orange);
+f.addRule("category", "end", orange);
+f.addRule("category", "fixed", yellow);
+f.addRule("category", "state", lightGreen);
+f.addRule("category", "phi", middleBlue);
+f.addRule("category", "proxy", middleBlue);
+f.addRule("category", "floating", lightBlue);
+
+f.addRule("class", "com.oracle.graal.nodes.ParameterNode", gray);
+f.addRule("class", "jdk.graal.compiler.nodes.ParameterNode", gray);
+f.addRule("class", "org.graalvm.compiler.nodes.ParameterNode", gray);
+
+f.addRule("class", "com.oracle.graal.nodes.ConstantNode", gray);
+f.addRule("class", "jdk.graal.compiler.nodes.ConstantNode", gray);
+f.addRule("class", "org.graalvm.compiler.nodes.ConstantNode", gray);
+
+f.addRule("class", "com.oracle.graal.nodes.GuardNode", violet);
+f.addRule("class", "jdk.graal.compiler.nodes.GuardNode", violet);
+f.addRule("class", "org.graalvm.compiler.nodes.GuardNode", violet);
+
+f.addRule("class", "com.oracle.graal.nodes.debug.BlackholeNode", black);
+f.addRule("class", "jdk.graal.compiler.nodes.debug.BlackholeNode", black);
+f.addRule("class", "org.graalvm.compiler.nodes.debug.BlackholeNode", black);
+
+cachedFilter.add(f);
 
 var f = new GraalEdgeColorFilter();
 f.setUsageColor("Successor", red);
 f.setUsageColor("Value", blue);
 f.setUsageColor("Memory", new Color(0, 128, 0));
-f.apply(graph);
+
+cachedFilter.add(f);
+
+// return the cached filter
+cachedFilter

visualizer/IdealGraphVisualizer/Graal/src/main/resources/org/graalvm/visualizer/graal/filters/graalFilters.properties

@@ -4,3 +4,4 @@
 GraalCFGFilter=org.graalvm.visualizer.graal.filters.GraalCFGFilter
 GraalColoringFilter=org.graalvm.visualizer.graal.filters.GraalColoringFilter
 GraalEdgeColorFilter=org.graalvm.visualizer.graal.filters.GraalEdgeColorFilter
+PropertyColorFilter=org.graalvm.visualizer.graal.filters.PropertyColorFilter

visualizer/IdealGraphVisualizer/Graal/src/main/resources/org/graalvm/visualizer/graal/filters/removeState.filter

@@ -1 +1,3 @@
-remove("category", "state");
+// Removing orphans also removes any nodes which no longer have any uses.
+// This cleans up Constants which were only referenced by FrameStates
+removeIncludingOrphans("category", "state")