src/share/classes/com/sun/tools/javac/util/GraphUtils.java

Sat, 07 Nov 2020 10:30:02 +0800

author
aoqi
date
Sat, 07 Nov 2020 10:30:02 +0800
changeset 3938
93012e2a5d1d
parent 3295
859dc787b52b
permissions
-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package com.sun.tools.javac.util;
aoqi@0 27
aoqi@0 28 /** <p><b>This is NOT part of any supported API.
aoqi@0 29 * If you write code that depends on this, you do so at your own risk.
aoqi@0 30 * This code and its internal interfaces are subject to change or
aoqi@0 31 * deletion without notice.</b>
aoqi@0 32 */
aoqi@0 33 public class GraphUtils {
aoqi@0 34
aoqi@0 35 /**
aoqi@0 36 * Basic interface for defining various dependency kinds. All dependency kinds
aoqi@0 37 * must at least support basic capabilities to tell the DOT engine how to render them.
aoqi@0 38 */
aoqi@0 39 public interface DependencyKind {
aoqi@0 40 /**
aoqi@0 41 * Returns the DOT representation (to be used in a {@code style} attribute
aoqi@0 42 * that's most suited for this dependency kind.
aoqi@0 43 */
aoqi@0 44 String getDotStyle();
aoqi@0 45 }
aoqi@0 46
aoqi@0 47 /**
aoqi@0 48 * This class is a basic abstract class for representing a node.
aoqi@0 49 * A node is associated with a given data.
aoqi@0 50 */
aoqi@0 51 public static abstract class Node<D> {
aoqi@0 52 public final D data;
aoqi@0 53
aoqi@0 54 public Node(D data) {
aoqi@0 55 this.data = data;
aoqi@0 56 }
aoqi@0 57
aoqi@0 58 /**
aoqi@0 59 * Get an array of the dependency kinds supported by this node.
aoqi@0 60 */
aoqi@0 61 public abstract DependencyKind[] getSupportedDependencyKinds();
aoqi@0 62
aoqi@0 63 /**
aoqi@0 64 * Get all dependencies, regardless of their kind.
aoqi@0 65 */
aoqi@0 66 public abstract Iterable<? extends Node<D>> getAllDependencies();
aoqi@0 67
aoqi@0 68 /**
aoqi@0 69 * Get a name for the dependency (of given kind) linking this node to a given node
aoqi@0 70 */
aoqi@0 71 public abstract String getDependencyName(Node<D> to, DependencyKind dk);
aoqi@0 72
aoqi@0 73 @Override
aoqi@0 74 public String toString() {
aoqi@0 75 return data.toString();
aoqi@0 76 }
aoqi@0 77 }
aoqi@0 78
aoqi@0 79 /**
aoqi@0 80 * This class specialized Node, by adding elements that are required in order
aoqi@0 81 * to perform Tarjan computation of strongly connected components.
aoqi@0 82 */
aoqi@0 83 public static abstract class TarjanNode<D> extends Node<D> implements Comparable<TarjanNode<D>> {
aoqi@0 84 int index = -1;
aoqi@0 85 int lowlink;
aoqi@0 86 boolean active;
aoqi@0 87
aoqi@0 88 public TarjanNode(D data) {
aoqi@0 89 super(data);
aoqi@0 90 }
aoqi@0 91
aoqi@0 92 public abstract Iterable<? extends TarjanNode<D>> getAllDependencies();
aoqi@0 93
aoqi@0 94 public abstract Iterable<? extends TarjanNode<D>> getDependenciesByKind(DependencyKind dk);
aoqi@0 95
aoqi@0 96 public int compareTo(TarjanNode<D> o) {
aoqi@0 97 return (index < o.index) ? -1 : (index == o.index) ? 0 : 1;
aoqi@0 98 }
aoqi@0 99 }
aoqi@0 100
aoqi@0 101 /**
aoqi@0 102 * Tarjan's algorithm to determine strongly connected components of a
aoqi@0 103 * directed graph in linear time. Works on TarjanNode.
aoqi@0 104 */
aoqi@0 105 public static <D, N extends TarjanNode<D>> List<? extends List<? extends N>> tarjan(Iterable<? extends N> nodes) {
mcimadamore@3080 106 Tarjan<D, N> tarjan = new Tarjan<>();
mcimadamore@3080 107 return tarjan.findSCC(nodes);
mcimadamore@3080 108 }
mcimadamore@3080 109
mcimadamore@3080 110 //where
mcimadamore@3080 111 private static class Tarjan<D, N extends TarjanNode<D>> {
mcimadamore@3080 112
mcimadamore@3080 113 /** Unique node identifier. */
mcimadamore@3080 114 int index = 0;
mcimadamore@3080 115
mcimadamore@3080 116 /** List of SCCs found so far. */
mcimadamore@3080 117 ListBuffer<List<N>> sccs = new ListBuffer<>();
mcimadamore@3080 118
mcimadamore@3080 119 /** Stack of all reacheable nodes from given root. */
aoqi@0 120 ListBuffer<N> stack = new ListBuffer<>();
mcimadamore@3080 121
mcimadamore@3080 122 private List<? extends List<? extends N>> findSCC(Iterable<? extends N> nodes) {
mcimadamore@3080 123 for (N node : nodes) {
mcimadamore@3080 124 if (node.index == -1) {
mcimadamore@3080 125 findSCC(node);
mcimadamore@3080 126 }
mcimadamore@3080 127 }
mcimadamore@3080 128 return sccs.toList();
mcimadamore@3080 129 }
mcimadamore@3080 130
mcimadamore@3080 131 private void findSCC(N v) {
mcimadamore@3080 132 visitNode(v);
mcimadamore@3080 133 for (TarjanNode<D> tn : v.getAllDependencies()) {
mcimadamore@3080 134 @SuppressWarnings("unchecked")
mcimadamore@3080 135 N n = (N)tn;
mcimadamore@3080 136 if (n.index == -1) {
mcimadamore@3080 137 //it's the first time we see this node
mcimadamore@3080 138 findSCC(n);
mcimadamore@3080 139 v.lowlink = Math.min(v.lowlink, n.lowlink);
mcimadamore@3080 140 } else if (stack.contains(n)) {
mcimadamore@3080 141 //this node is already reachable from current root
mcimadamore@3080 142 v.lowlink = Math.min(v.lowlink, n.index);
mcimadamore@3080 143 }
mcimadamore@3080 144 }
mcimadamore@3080 145 if (v.lowlink == v.index) {
mcimadamore@3080 146 //v is the root of a SCC
mcimadamore@3080 147 addSCC(v);
aoqi@0 148 }
aoqi@0 149 }
aoqi@0 150
mcimadamore@3080 151 private void visitNode(N n) {
mcimadamore@3080 152 n.index = index;
mcimadamore@3080 153 n.lowlink = index;
mcimadamore@3080 154 index++;
mcimadamore@3080 155 stack.prepend(n);
mcimadamore@3080 156 n.active = true;
aoqi@0 157 }
mcimadamore@3080 158
mcimadamore@3080 159 private void addSCC(N v) {
aoqi@0 160 N n;
aoqi@0 161 ListBuffer<N> cycle = new ListBuffer<>();
aoqi@0 162 do {
aoqi@0 163 n = stack.remove();
aoqi@0 164 n.active = false;
aoqi@0 165 cycle.add(n);
aoqi@0 166 } while (n != v);
mcimadamore@3080 167 sccs.add(cycle.toList());
aoqi@0 168 }
aoqi@0 169 }
aoqi@0 170
aoqi@0 171 /**
aoqi@0 172 * Debugging: dot representation of a set of connected nodes. The resulting
aoqi@0 173 * dot representation will use {@code Node.toString} to display node labels
aoqi@0 174 * and {@code Node.printDependency} to display edge labels. The resulting
aoqi@0 175 * representation is also customizable with a graph name and a header.
aoqi@0 176 */
aoqi@0 177 public static <D> String toDot(Iterable<? extends TarjanNode<D>> nodes, String name, String header) {
aoqi@0 178 StringBuilder buf = new StringBuilder();
aoqi@0 179 buf.append(String.format("digraph %s {\n", name));
aoqi@0 180 buf.append(String.format("label = \"%s\";\n", header));
aoqi@0 181 //dump nodes
aoqi@0 182 for (TarjanNode<D> n : nodes) {
aoqi@0 183 buf.append(String.format("%s [label = \"%s\"];\n", n.hashCode(), n.toString()));
aoqi@0 184 }
aoqi@0 185 //dump arcs
aoqi@0 186 for (TarjanNode<D> from : nodes) {
aoqi@0 187 for (DependencyKind dk : from.getSupportedDependencyKinds()) {
aoqi@0 188 for (TarjanNode<D> to : from.getDependenciesByKind(dk)) {
aoqi@0 189 buf.append(String.format("%s -> %s [label = \" %s \" style = %s ];\n",
aoqi@0 190 from.hashCode(), to.hashCode(), from.getDependencyName(to, dk), dk.getDotStyle()));
aoqi@0 191 }
aoqi@0 192 }
aoqi@0 193 }
aoqi@0 194 buf.append("}\n");
aoqi@0 195 return buf.toString();
aoqi@0 196 }
aoqi@0 197 }

mercurial