Mercurial > hg > graal-compiler
diff graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/GraphPrintVisitor.java @ 7267:a4b84ba6dc2e
Introduction of the Truffle API for efficient implementation of dynamic languages on top of the Graal VM. New projects com.oracle.truffle.api for the API definition and com.oracle.truffle.api.test for API tests and documentation.
author | Thomas Wuerthinger <thomas.wuerthinger@oracle.com> |
---|---|
date | Tue, 18 Dec 2012 15:33:55 +0100 |
parents | |
children | 5e3d1a68664e |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/GraphPrintVisitor.java Tue Dec 18 15:33:55 2012 +0100 @@ -0,0 +1,385 @@ +/* + * Copyright (c) 2012, 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 com.oracle.truffle.api.nodes; + +import java.io.*; +import java.lang.annotation.*; +import java.lang.reflect.*; +import java.net.*; +import java.util.*; + +import javax.xml.parsers.*; +import javax.xml.transform.*; +import javax.xml.transform.dom.*; +import javax.xml.transform.stream.*; + +import org.w3c.dom.*; + +/** + * Utility class for creating output for the ideal graph visualizer. + */ +public class GraphPrintVisitor { + + public static final String GraphVisualizerAddress = "127.0.0.1"; + public static final int GraphVisualizerPort = 4444; + + private Document dom; + private Map<Object, Element> nodeMap; + private List<Element> edgeList; + private Map<Object, Element> prevNodeMap; + private int id; + private Element graphDocument; + private Element groupElement; + private Element graphElement; + private Element nodesElement; + private Element edgesElement; + + public GraphPrintVisitor() { + DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); + try { + DocumentBuilder db = dbf.newDocumentBuilder(); + + dom = db.newDocument(); + } catch (ParserConfigurationException ex) { + System.out.println("Error while trying to instantiate DocumentBuilder " + ex); + } + + graphDocument = dom.createElement("graphDocument"); + dom.appendChild(graphDocument); + } + + public GraphPrintVisitor beginGroup(String groupName) { + groupElement = dom.createElement("group"); + graphDocument.appendChild(groupElement); + Element properties = dom.createElement("properties"); + groupElement.appendChild(properties); + + if (!groupName.isEmpty()) { + // set group name + Element propName = dom.createElement("p"); + propName.setAttribute("name", "name"); + propName.setTextContent(groupName); + properties.appendChild(propName); + } + + // forget old nodes + nodeMap = prevNodeMap = null; + edgeList = null; + + return this; + } + + public GraphPrintVisitor beginGraph(String graphName) { + if (null == groupElement) { + beginGroup(""); + } else if (null != prevNodeMap) { + // TODO: difference (create removeNode,removeEdge elements) + } + + graphElement = dom.createElement("graph"); + groupElement.appendChild(graphElement); + Element properties = dom.createElement("properties"); + graphElement.appendChild(properties); + nodesElement = dom.createElement("nodes"); + graphElement.appendChild(nodesElement); + edgesElement = dom.createElement("edges"); + graphElement.appendChild(edgesElement); + + // set graph name + Element propName = dom.createElement("p"); + propName.setAttribute("name", "name"); + propName.setTextContent(graphName); + properties.appendChild(propName); + + // save old nodes + prevNodeMap = nodeMap; + nodeMap = new HashMap<>(); + edgeList = new ArrayList<>(); + + return this; + } + + @Override + public String toString() { + if (null != dom) { + try { + Transformer tr = TransformerFactory.newInstance().newTransformer(); + tr.setOutputProperty(OutputKeys.INDENT, "yes"); + tr.setOutputProperty(OutputKeys.METHOD, "xml"); + tr.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2"); + + StringWriter strWriter = new StringWriter(); + tr.transform(new DOMSource(dom), new StreamResult(strWriter)); + return strWriter.toString(); + } catch (TransformerException e) { + e.printStackTrace(); + } + } + return ""; + } + + public void printToFile(File f) { + try { + Transformer tr = TransformerFactory.newInstance().newTransformer(); + tr.setOutputProperty(OutputKeys.INDENT, "yes"); + tr.setOutputProperty(OutputKeys.METHOD, "xml"); + tr.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2"); + + tr.transform(new DOMSource(dom), new StreamResult(new FileOutputStream(f))); + } catch (TransformerException | FileNotFoundException e) { + e.printStackTrace(); + } + } + + public void printToSysout() { + try { + Transformer tr = TransformerFactory.newInstance().newTransformer(); + tr.setOutputProperty(OutputKeys.INDENT, "yes"); + tr.setOutputProperty(OutputKeys.METHOD, "xml"); + tr.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2"); + + tr.transform(new DOMSource(dom), new StreamResult(System.out)); + } catch (TransformerException e) { + e.printStackTrace(); + } + } + + public void printToNetwork() { + try { + Transformer tr = TransformerFactory.newInstance().newTransformer(); + tr.setOutputProperty(OutputKeys.METHOD, "xml"); + + Socket socket = new Socket(GraphVisualizerAddress, GraphVisualizerPort); + BufferedOutputStream stream = new BufferedOutputStream(socket.getOutputStream(), 0x4000); + tr.transform(new DOMSource(dom), new StreamResult(stream)); + } catch (TransformerException | IOException e) { + e.printStackTrace(); + } + } + + private String nextId() { + return String.valueOf(id++); + } + + private String oldOrNextId(Object node) { + if (null != prevNodeMap && prevNodeMap.containsKey(node)) { + Element nodeElem = prevNodeMap.get(node); + return nodeElem.getAttribute("id"); + } else { + return nextId(); + } + } + + protected Element getElementByObject(Object op) { + return nodeMap.get(op); + } + + protected void createElementForNode(Object node) { + boolean exists = nodeMap.containsKey(node); + if (!exists || NodeUtil.findAnnotation(node.getClass(), GraphDuplicate.class) != null) { + Element nodeElem = dom.createElement("node"); + nodeElem.setAttribute("id", !exists ? oldOrNextId(node) : nextId()); + nodeMap.put(node, nodeElem); + Element properties = dom.createElement("properties"); + nodeElem.appendChild(properties); + nodesElement.appendChild(nodeElem); + + setNodeProperty(node, "name", node.getClass().getSimpleName().replaceFirst("Node$", "")); + NodeInfo nodeInfo = node.getClass().getAnnotation(NodeInfo.class); + if (nodeInfo != null && !nodeInfo.shortName().isEmpty()) { + setNodeProperty(node, "shortName", nodeInfo.shortName()); + } + setNodeProperty(node, "nodeType", (Node.class.isAssignableFrom(node.getClass()) ? Node.class.getSimpleName() : "other")); + setNodeProperty(node, "nodeClass", node.getClass().getSimpleName()); + copyDebugProperties(node); // TODO: may overwrite property "name"? (currently allowed) + readNodeProperties(node); + } + } + + private Element getPropertyElement(Object node, String propertyName) { + Element nodeElem = getElementByObject(node); + Element propertiesElem = (Element) nodeElem.getElementsByTagName("properties").item(0); + if (propertiesElem == null) { + return null; + } + + NodeList propList = propertiesElem.getElementsByTagName("p"); + for (int i = 0; i < propList.getLength(); i++) { + Element p = (Element) propList.item(i); + if (propertyName.equals(p.getAttribute("name"))) { + return p; + } + } + return null; + } + + protected void setNodeProperty(Object node, String propertyName, Object value) { + Element nodeElem = getElementByObject(node); + Element propElem = getPropertyElement(node, propertyName); // if property exists, replace its value + if (null == propElem) { // if property doesn't exist, create one + propElem = dom.createElement("p"); + propElem.setAttribute("name", propertyName); + nodeElem.getElementsByTagName("properties").item(0).appendChild(propElem); + } + propElem.setTextContent(String.valueOf(value)); + } + + private void copyDebugProperties(Object node) { + if (node instanceof Node) { + Map<String, Object> debugProperties = ((Node) node).getDebugProperties(); + for (Map.Entry<String, Object> property : debugProperties.entrySet()) { + setNodeProperty(node, property.getKey(), property.getValue()); + } + } + } + + private void readNodeProperties(Object node) { + Field[] fields = NodeUtil.getAllFields(node.getClass()); + for (Field field : fields) { + if (Modifier.isStatic(field.getModifiers())) { + continue; + } + if (Node.class.isAssignableFrom(field.getType()) || (field.getType().getComponentType() != null && Node.class.isAssignableFrom(field.getType()))) { + continue; + } + String key = field.getName(); + if (field.getAnnotation(HiddenField.class) == null && getPropertyElement(node, key) == null) { + try { + field.setAccessible(true); + Object value = field.get(node); + setNodeProperty(node, key, value); + } catch (IllegalArgumentException | IllegalAccessException e) { + assert false : e; + } + } + } + } + + protected void connectNodes(Object a, Object b) { + if (nodeMap.get(a) == null || nodeMap.get(b) == null) { + return; + } + + String fromId = nodeMap.get(a).getAttribute("id"); + String toId = nodeMap.get(b).getAttribute("id"); + + // count existing to-edges + int count = 0; + for (Element e : edgeList) { + if (e.getAttribute("to").equals(toId)) { + ++count; + } + } + + Element edgeElem = dom.createElement("edge"); + edgeElem.setAttribute("from", fromId); + edgeElem.setAttribute("to", toId); + edgeElem.setAttribute("index", String.valueOf(count)); + edgesElement.appendChild(edgeElem); + edgeList.add(edgeElem); + } + + public GraphPrintVisitor visit(Object node) { + if (null == graphElement) { + beginGraph("truffle tree"); + } + + // if node is visited once again, skip + if (getElementByObject(node) == null || NodeUtil.findAnnotation(node.getClass(), GraphDuplicate.class) != null) { + visitAny(node); + } + + return this; + } + + private void visitAny(Object node) { + // respect node's custom handler + if (NodeUtil.findAnnotation(node.getClass(), NullGraphPrintHandler.class) != null) { + return; + } + if (NodeUtil.findAnnotation(node.getClass(), CustomGraphPrintHandler.class) != null) { + Class<? extends GraphPrintHandler> gpHandlerClass = NodeUtil.findAnnotation(node.getClass(), CustomGraphPrintHandler.class).handler(); + try { + GraphPrintHandler gpHandler = gpHandlerClass.newInstance(); + gpHandler.visit(node, new GraphPrintAdapter()); + } catch (InstantiationException e) { + assert false; + } catch (IllegalAccessException e) { + assert false; + } + return; + } + + // default handler + createElementForNode(node); + + List<Object> children = NodeUtil.findNodeChildren(node); + for (Object child : children) { + if (child == null) { + continue; + } else if (child instanceof Node) { + visit(child); + } else { + continue; + } + connectNodes(node, child); + } + } + + public class GraphPrintAdapter { + public void createElementForNode(Object node) { + GraphPrintVisitor.this.createElementForNode(node); + } + public void visit(Object node) { + GraphPrintVisitor.this.visit(node); + } + public void connectNodes(Object node, Object child) { + GraphPrintVisitor.this.connectNodes(node, child); + } + public void setNodeProperty(Object node, String propertyName, Object value) { + GraphPrintVisitor.this.setNodeProperty(node, propertyName, value); + } + } + + public interface GraphPrintHandler { + void visit(Object node, GraphPrintAdapter gPrinter); + } + + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.TYPE) + public @interface CustomGraphPrintHandler { + Class<? extends GraphPrintHandler> handler(); + } + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.TYPE) + public @interface NullGraphPrintHandler { + } + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.TYPE) + public @interface GraphDuplicate { + } + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.FIELD) + public @interface HiddenField { + } +}