com.oracle.truffle.object.Debug Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-api Show documentation
Show all versions of truffle-api Show documentation
Truffle is a multi-language framework for executing dynamic languages
that achieves high performance when combined with Graal.
/*
* Copyright (c) 2014, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.oracle.truffle.object;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.PrintWriter;
import java.io.UnsupportedEncodingException;
import java.nio.file.Paths;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.concurrent.ConcurrentLinkedQueue;
import com.oracle.truffle.api.object.DynamicObject;
import com.oracle.truffle.api.object.Property;
import com.oracle.truffle.api.object.Shape;
@SuppressWarnings("deprecation")
class Debug {
static final String INVALID = "!";
static final String BRANCH = "\u2443";
static final String LEAF = "\u22a5";
private static Collection allShapes;
static void trackShape(ShapeImpl newShape) {
allShapes.add(newShape);
}
static void trackObject(DynamicObject obj) {
assert ObjectStorageOptions.Profile;
ShapeProfiler.getInstance().track(obj);
}
static Iterable getAllShapes() {
return allShapes;
}
static String dumpObject(DynamicObject object, int level, int levelStop) {
List properties = object.getShape().getPropertyListInternal(true);
StringBuilder sb = new StringBuilder(properties.size() * 10);
sb.append("{\n");
for (Property property : properties) {
indent(sb, level + 1);
sb.append(property.getKey());
sb.append('[').append(property.getLocation()).append(']');
Object value = property.get(object, false);
if (value instanceof DynamicObject) {
if (level < levelStop) {
value = dumpObject((DynamicObject) value, level + 1, levelStop);
} else {
value = value.toString();
}
}
sb.append(": ");
sb.append(value);
if (property != properties.get(properties.size() - 1)) {
sb.append(",");
}
sb.append("\n");
}
indent(sb, level);
sb.append("}");
return sb.toString();
}
private static StringBuilder indent(StringBuilder sb, int level) {
for (int i = 0; i < level; i++) {
sb.append(' ');
}
return sb;
}
private static void dumpDOT() throws FileNotFoundException, UnsupportedEncodingException {
try (PrintWriter out = new PrintWriter(getOutputFile("dot"), "UTF-8")) {
GraphvizShapeVisitor visitor = new GraphvizShapeVisitor();
for (ShapeImpl shape : getAllShapes()) {
visitor.visitShape(shape);
}
out.println(visitor);
}
}
private static void dumpIGV() {
com.oracle.truffle.api.nodes.GraphPrintVisitor printer = new com.oracle.truffle.api.nodes.GraphPrintVisitor();
printer.beginGroup("shapes");
IGVShapeVisitor visitor = new IGVShapeVisitor(printer);
for (ShapeImpl shape : getAllShapes()) {
if (isRootShape(shape)) {
printer.beginGraph(getId(shape) + " (" + calcShapeGraphSize(shape) + ") (" + shape.getDynamicType() + ")");
visitor.visitShape(shape);
printer.endGraph();
}
}
printer.beginGraph("all shapes");
for (ShapeImpl shape : getAllShapes()) {
if (isRootShape(shape)) {
visitor.visitShape(shape);
}
}
printer.endGraph();
printer.endGroup();
printer.printToNetwork(false);
}
private static String calcShapeGraphSize(ShapeImpl shape) {
class Visitor implements DebugShapeVisitor {
final Set visitedShapes = new HashSet<>();
int invalidShapeCount;
int branchCount = 1;
int leafCount;
@Override
public Integer visitShape(ShapeImpl s, Map transitions) {
if (!visitedShapes.add(s)) {
return 0;
}
int shapeCount = 1;
if (!s.isValid()) {
invalidShapeCount++;
}
if (s.isLeaf()) {
leafCount++;
}
branchCount += Math.max(0, transitions.size() - 1);
for (Map.Entry entry : transitions.entrySet()) {
shapeCount += this.visitShape(entry.getValue());
}
return shapeCount;
}
}
Visitor v = new Visitor();
int shapeCount = v.visitShape(shape);
assert shapeCount == v.visitedShapes.size();
return shapeCount + (v.invalidShapeCount != 0 ? (", " + INVALID + v.invalidShapeCount) : "") + ", " + BRANCH + v.branchCount + ", " + LEAF + v.leafCount;
}
private static boolean isRootShape(ShapeImpl shape) {
return shape.getParent() == null;
}
private static File getOutputFile(String extension) {
return Paths.get(ObjectStorageOptions.DumpShapesPath, "shapes." + extension).toFile();
}
static String getId(Shape shape) {
return Integer.toHexString(shape.hashCode());
}
interface DebugShapeVisitor {
default R visitShape(ShapeImpl shape) {
return visitShape(shape, Collections.unmodifiableMap(shape.getTransitionMapForRead()));
}
R visitShape(ShapeImpl shape, Map transitions);
}
static class IGVShapeVisitor implements DebugShapeVisitor {
private final com.oracle.truffle.api.nodes.GraphPrintVisitor graphPrinter;
IGVShapeVisitor(com.oracle.truffle.api.nodes.GraphPrintVisitor printer) {
this.graphPrinter = printer;
}
@Override
public IGVShapeVisitor visitShape(final ShapeImpl shape, final Map transitions) {
graphPrinter.visit(shape, new com.oracle.truffle.api.nodes.GraphPrintVisitor.GraphPrintHandler() {
public void visit(Object node, com.oracle.truffle.api.nodes.GraphPrintVisitor.GraphPrintAdapter printer) {
if (!printer.visited(node)) {
ShapeImpl s = (ShapeImpl) node;
printer.createElementForNode(s);
String name;
if (isRootShape(s)) {
name = ("ROOT(" + s.getDynamicType() + ")");
} else {
name = s.getTransitionFromParent().toString();
if (!s.isValid()) {
name = INVALID + name;
}
}
printer.setNodeProperty(s, "name", name);
printer.setNodeProperty(s, "valid", s.isValid());
printer.setNodeProperty(s, "leaf", s.isLeaf());
printer.setNodeProperty(s, "identityHashCode", Integer.toHexString(System.identityHashCode(s)));
printer.setNodeProperty(s, "dynamicType", s.getDynamicType());
printer.setNodeProperty(s, "flags", s.getFlags());
printer.setNodeProperty(s, "shared", s.isShared());
for (Entry entry : transitions.entrySet()) {
ShapeImpl dst = entry.getValue();
IGVShapeVisitor.this.visitShape((dst));
assert printer.visited(dst);
printer.connectNodes(s, dst, entry.getKey().toString());
}
}
}
});
return this;
}
}
static class GraphvizShapeVisitor implements DebugShapeVisitor {
private final Set drawn;
private final StringBuilder sb = new StringBuilder();
GraphvizShapeVisitor() {
this.drawn = new HashSet<>();
}
@Override
public GraphvizShapeVisitor visitShape(ShapeImpl shape, Map transitions) {
if (!drawn.add(shape)) {
return this;
}
String prefix = "s";
sb.append(prefix).append(getId(shape));
sb.append(" [label=\"");
if (shape.getLastProperty() != null) {
sb.append(escapeString(shape.getLastProperty().toString()));
} else {
sb.append("ROOT");
}
sb.append("\"");
sb.append(", shape=\"rectangle\"");
if (!shape.isValid()) {
sb.append(", color=\"red\", style=dotted");
}
sb.append("];");
for (Entry entry : transitions.entrySet()) {
ShapeImpl dst = entry.getValue();
this.visitShape(dst);
assert drawn.contains(dst);
sb.append(prefix).append(getId(shape)).append("->").append(prefix).append(getId(dst));
sb.append(" [label=\"").append(escapeString(entry.getKey().toString())).append("\"]");
sb.append(";");
}
return this;
}
private static String escapeString(String str) {
return str.replaceAll("\\\\", "\\\\").replaceAll("\"", "\\\\\"");
}
@Override
public String toString() {
return new StringBuilder("digraph{").append(sb).append("}").toString();
}
}
static {
if (ObjectStorageOptions.DumpShapes) {
allShapes = new ConcurrentLinkedQueue<>();
}
if (ObjectStorageOptions.DumpShapes) {
Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
public void run() {
try {
if (ObjectStorageOptions.DumpShapesDOT) {
dumpDOT();
}
if (ObjectStorageOptions.DumpShapesIGV) {
dumpIGV();
}
} catch (FileNotFoundException | UnsupportedEncodingException e) {
throw new RuntimeException(e);
}
}
}));
}
}
}