package com.oracle.truffle.api.nodes;
import java.io.OutputStream;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.lang.annotation.Annotation;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import com.oracle.truffle.api.CompilerAsserts;
import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
import com.oracle.truffle.api.TruffleOptions;
import com.oracle.truffle.api.source.SourceSection;
public final class NodeUtil {
private NodeUtil() {
}
@SuppressWarnings("unchecked")
public static <T extends Node> T cloneNode(T orig) {
return (T) orig.deepCopy();
}
static Node deepCopyImpl(Node orig) {
CompilerAsserts.neverPartOfCompilation("do not call Node.deepCopyImpl from compiled code");
final Node clone = orig.copy();
NodeClass nodeClass = clone.getNodeClass();
clone.setParent(null);
for (Object field : nodeClass.getNodeFieldArray()) {
if (nodeClass.isChildField(field)) {
Node child = (Node) nodeClass.getFieldObject(field, orig);
if (child != null) {
Node clonedChild = child.deepCopy();
clonedChild.setParent(clone);
nodeClass.putFieldObject(field, clone, clonedChild);
}
} else if (nodeClass.isChildrenField(field)) {
Object[] children = (Object[]) nodeClass.getFieldObject(field, orig);
if (children != null) {
Object[] clonedChildren;
if (children.length > 0) {
clonedChildren = (Object[]) Array.newInstance(children.getClass().getComponentType(), children.length);
for (int i = 0; i < children.length; i++) {
if (children[i] != null) {
Node clonedChild = ((Node) children[i]).deepCopy();
clonedChild.setParent(clone);
clonedChildren[i] = clonedChild;
}
}
} else {
clonedChildren = children;
}
nodeClass.putFieldObject(field, clone, clonedChildren);
}
} else if (nodeClass.isCloneableField(field)) {
Object cloneable = nodeClass.getFieldObject(field, clone);
if (cloneable != null && cloneable == nodeClass.getFieldObject(field, orig)) {
nodeClass.putFieldObject(field, clone, ((NodeCloneable) cloneable).clone());
}
} else if (nodeClass.nodeFieldsOrderedByKind()) {
break;
}
}
return clone;
}
public static List<Node> findNodeChildren(Node node) {
CompilerAsserts.neverPartOfCompilation("do not call Node.findNodeChildren from compiled code");
List<Node> nodes = new ArrayList<>();
NodeClass nodeClass = node.getNodeClass();
for (Object nodeField : nodeClass.getNodeFieldArray()) {
if (nodeClass.isChildField(nodeField)) {
Object child = nodeClass.getFieldObject(nodeField, node);
if (child != null) {
nodes.add((Node) child);
}
} else if (nodeClass.isChildrenField(nodeField)) {
Object[] children = (Object[]) nodeClass.getFieldObject(nodeField, node);
if (children != null) {
for (Object child : children) {
if (child != null) {
nodes.add((Node) child);
}
}
}
} else if (nodeClass.nodeFieldsOrderedByKind()) {
break;
}
}
return nodes;
}
public static <T extends Node> T nonAtomicReplace(Node oldNode, T newNode, CharSequence reason) {
oldNode.replaceHelper(newNode, reason);
return newNode;
}
public static boolean replaceChild(Node parent, Node oldChild, Node newChild) {
return replaceChild(parent, oldChild, newChild, false);
}
@Deprecated
@TruffleBoundary
public static Node getCurrentEncapsulatingNode() {
return EncapsulatingNodeReference.getCurrent().get();
}
@Deprecated
@TruffleBoundary
public static Node pushEncapsulatingNode(Node node) {
return EncapsulatingNodeReference.getCurrent().set(node);
}
@Deprecated
@TruffleBoundary
public static void popEncapsulatingNode(Node prev) {
EncapsulatingNodeReference.getCurrent().set(prev);
}
static void adoptChildrenHelper(Node currentNode) {
NodeClass clazz = currentNode.getNodeClass();
for (Object field : clazz.getNodeFieldArray()) {
if (clazz.isChildField(field)) {
Object child = clazz.getFieldObject(field, currentNode);
if (child != null) {
Node node = (Node) child;
if (node.getParent() != currentNode) {
currentNode.adoptHelper(node);
}
}
} else if (clazz.isChildrenField(field)) {
Object arrayObject = clazz.getFieldObject(field, currentNode);
if (arrayObject == null) {
continue;
}
Object[] array = (Object[]) arrayObject;
for (int i = 0; i < array.length; i++) {
Object child = array[i];
if (child != null) {
Node node = (Node) child;
if (node.getParent() != currentNode) {
currentNode.adoptHelper(node);
}
}
}
} else if (clazz.nodeFieldsOrderedByKind()) {
break;
}
}
}
static int adoptChildrenAndCountHelper(Node currentNode) {
int count = 0;
NodeClass clazz = currentNode.getNodeClass();
for (Object field : clazz.getNodeFieldArray()) {
if (clazz.isChildField(field)) {
Object child = clazz.getFieldObject(field, currentNode);
if (child != null) {
Node node = (Node) child;
count += currentNode.adoptAndCountHelper(node);
}
} else if (clazz.isChildrenField(field)) {
Object arrayObject = clazz.getFieldObject(field, currentNode);
if (arrayObject == null) {
continue;
}
Object[] array = (Object[]) arrayObject;
for (int i = 0; i < array.length; i++) {
Object child = array[i];
if (child != null) {
Node node = (Node) child;
count += currentNode.adoptAndCountHelper(node);
}
}
} else if (clazz.nodeFieldsOrderedByKind()) {
break;
}
}
return count;
}
static boolean replaceChild(Node parent, Node oldChild, Node newChild, boolean adopt) {
CompilerAsserts.neverPartOfCompilation("do not replace Node child from compiled code");
NodeClass nodeClass = parent.getNodeClass();
for (Object nodeField : nodeClass.getNodeFieldArray()) {
if (nodeClass.isChildField(nodeField)) {
if (nodeClass.getFieldObject(nodeField, parent) == oldChild) {
if (adopt) {
parent.adoptHelper(newChild);
}
nodeClass.putFieldObject(nodeField, parent, newChild);
return true;
}
} else if (nodeClass.isChildrenField(nodeField)) {
Object arrayObject = nodeClass.getFieldObject(nodeField, parent);
if (arrayObject != null) {
Object[] array = (Object[]) arrayObject;
for (int i = 0; i < array.length; i++) {
if (array[i] == oldChild) {
if (adopt) {
parent.adoptHelper(newChild);
}
try {
array[i] = newChild;
} catch (ArrayStoreException e) {
throw replaceChildIllegalArgumentException(nodeField, array.getClass(), newChild);
}
return true;
}
}
}
} else if (nodeClass.nodeFieldsOrderedByKind()) {
break;
}
}
return false;
}
private static IllegalArgumentException replaceChildIllegalArgumentException(Object nodeField, Class<?> fieldType, Node newChild) {
return new IllegalArgumentException("Cannot set element of " + fieldType.getName() + " field " + nodeField + " to " + (newChild == null ? "null" : newChild.getClass().getName()));
}
@SuppressWarnings("deprecation")
@Deprecated
public static NodeFieldAccessor findChildField(Node parent, Node child) {
assert child != null;
NodeClass parentNodeClass = parent.getNodeClass();
for (NodeFieldAccessor field : parentNodeClass.getFields()) {
if (field.getKind() == NodeFieldAccessor.NodeFieldKind.CHILD) {
if (field.getObject(parent) == child) {
return field;
}
} else if (field.getKind() == NodeFieldAccessor.NodeFieldKind.CHILDREN) {
Object arrayObject = field.getObject(parent);
if (arrayObject != null) {
Object[] array = (Object[]) arrayObject;
for (int i = 0; i < array.length; i++) {
if (array[i] == child) {
return field;
}
}
}
}
}
return null;
}
public static boolean isReplacementSafe(Node parent, Node oldChild, Node newChild) {
if (parent != null) {
if (!parent.isAdoptable()) {
return false;
}
NodeClass nodeClass = parent.getNodeClass();
for (Object field : nodeClass.getNodeFieldArray()) {
if (nodeClass.isChildField(field)) {
if (nodeClass.getFieldObject(field, parent) == oldChild) {
return nodeClass.getFieldType(field).isAssignableFrom(newChild.getClass());
}
} else if (nodeClass.isChildrenField(field)) {
Object arrayObject = nodeClass.getFieldObject(field, parent);
if (arrayObject != null) {
Object[] array = (Object[]) arrayObject;
for (int i = 0; i < array.length; i++) {
if (array[i] == oldChild) {
return nodeClass.getFieldType(field).getComponentType().isAssignableFrom(newChild.getClass());
}
}
}
} else if (nodeClass.nodeFieldsOrderedByKind()) {
break;
}
}
return true;
}
return false;
}
public static boolean forEachChild(Node parent, NodeVisitor visitor) {
CompilerAsserts.neverPartOfCompilation("do not iterate over Node children from compiled code");
Objects.requireNonNull(visitor);
NodeClass nodeClass = parent.getNodeClass();
for (Object field : nodeClass.getNodeFieldArray()) {
if (nodeClass.isChildField(field)) {
Object child = nodeClass.getFieldObject(field, parent);
if (child != null) {
if (!visitor.visit((Node) child)) {
return false;
}
}
} else if (nodeClass.isChildrenField(field)) {
Object arrayObject = nodeClass.getFieldObject(field, parent);
if (arrayObject != null) {
Object[] array = (Object[]) arrayObject;
for (int i = 0; i < array.length; i++) {
Object child = array[i];
if (child != null) {
if (!visitor.visit((Node) child)) {
return false;
}
}
}
}
} else if (nodeClass.nodeFieldsOrderedByKind()) {
break;
}
}
return true;
}
static boolean forEachChildRecursive(Node parent, NodeVisitor visitor) {
NodeClass nodeClass = parent.getNodeClass();
for (Object field : nodeClass.getNodeFieldArray()) {
if (nodeClass.isChildField(field)) {
if (!visitChild((Node) nodeClass.getFieldObject(field, parent), visitor)) {
return false;
}
} else if (nodeClass.isChildrenField(field)) {
Object arrayObject = nodeClass.getFieldObject(field, parent);
if (arrayObject == null) {
continue;
}
Object[] array = (Object[]) arrayObject;
for (int i = 0; i < array.length; i++) {
if (!visitChild((Node) array[i], visitor)) {
return false;
}
}
} else if (nodeClass.nodeFieldsOrderedByKind()) {
break;
}
}
return true;
}
private static boolean visitChild(Node child, NodeVisitor visitor) {
if (child == null) {
return true;
}
if (!visitor.visit(child)) {
return false;
}
if (!forEachChildRecursive(child, visitor)) {
return false;
}
return true;
}
public static <T> T[] concat(T[] first, T[] second) {
T[] result = Arrays.copyOf(first, first.length + second.length);
System.arraycopy(second, 0, result, first.length, second.length);
return result;
}
public static Node getNthParent(Node node, int n) {
Node parent = node;
for (int i = 0; i < n; i++) {
parent = parent.getParent();
if (parent == null) {
return null;
}
}
return parent;
}
public static <T extends Annotation> T findAnnotation(Class<?> clazz, Class<T> annotationClass) {
if (clazz.getAnnotation(annotationClass) != null) {
return clazz.getAnnotation(annotationClass);
} else {
if (!TruffleOptions.AOT) {
for (Class<?> intf : clazz.getInterfaces()) {
if (intf.getAnnotation(annotationClass) != null) {
return intf.getAnnotation(annotationClass);
}
}
}
if (clazz.getSuperclass() != null) {
return findAnnotation(clazz.getSuperclass(), annotationClass);
}
}
return null;
}
public static <T> T findParent(Node start, Class<T> clazz) {
Node parent = start.getParent();
if (parent == null) {
return null;
} else if (clazz.isInstance(parent)) {
return clazz.cast(parent);
} else {
return findParent(parent, clazz);
}
}
public static <T> List<T> findAllParents(Node start, Class<T> clazz) {
List<T> parents = new ArrayList<>();
T parent = findParent(start, clazz);
while (parent != null) {
parents.add(parent);
parent = findParent((Node) parent, clazz);
}
return parents;
}
public static List<Node> collectNodes(Node parent, Node child) {
List<Node> nodes = new ArrayList<>();
Node current = child;
while (current != null) {
nodes.add(current);
if (current == parent) {
return nodes;
}
current = current.getParent();
}
throw new IllegalArgumentException("Node " + parent + " is not a parent of " + child + ".");
}
public static <T> T findFirstNodeInstance(Node root, Class<T> clazz) {
if (clazz.isInstance(root)) {
return clazz.cast(root);
}
for (Node child : root.getChildren()) {
T node = findFirstNodeInstance(child, clazz);
if (node != null) {
return node;
}
}
return null;
}
public static <T> List<T> findAllNodeInstances(final Node root, final Class<T> clazz) {
final List<T> nodeList = new ArrayList<>();
root.accept(new NodeVisitor() {
public boolean visit(Node node) {
if (clazz.isInstance(node)) {
nodeList.add(clazz.cast(node));
}
return true;
}
});
return nodeList;
}
public static int countNodes(Node root) {
return countNodes(root, NodeCountFilter.NO_FILTER);
}
public static int countNodes(Node root, NodeCountFilter filter) {
NodeCounter counter = new NodeCounter(filter);
root.accept(counter);
return counter.count;
}
public interface NodeCountFilter {
NodeCountFilter NO_FILTER = new NodeCountFilter() {
public boolean isCounted(Node node) {
return true;
}
};
boolean isCounted(Node node);
}
public static String printCompactTreeToString(Node node) {
StringWriter out = new StringWriter();
printCompactTree(new PrintWriter(out), null, node, 1);
return out.toString();
}
public static void printCompactTree(OutputStream out, Node node) {
printCompactTree(new PrintWriter(out), null, node, 1);
}
private static void printCompactTree(PrintWriter p, Node parent, Node node, int level) {
if (node == null) {
return;
}
for (int i = 0; i < level; i++) {
p.print(" ");
}
if (parent == null) {
p.println(nodeName(node));
} else {
p.print(getNodeFieldName(parent, node, "unknownField"));
p.print(" = ");
p.println(nodeName(node));
}
for (Node child : node.getChildren()) {
printCompactTree(p, node, child, level + 1);
}
p.flush();
}
public static String printSourceAttributionTree(Node node) {
StringWriter out = new StringWriter();
printSourceAttributionTree(new PrintWriter(out), null, node, 1);
return out.toString();
}
public static void printSourceAttributionTree(OutputStream out, Node node) {
printSourceAttributionTree(new PrintWriter(out), null, node, 1);
}
public static void printSourceAttributionTree(PrintWriter out, Node node) {
printSourceAttributionTree(out, null, node, 1);
}
private static void printSourceAttributionTree(PrintWriter p, Node parent, Node node, int level) {
if (node == null) {
return;
}
if (parent == null) {
final SourceSection sourceSection = node.getSourceSection();
if (sourceSection != null) {
final String txt = sourceSection.getSource().getCharacters().toString();
p.println("Full source len=(" + txt.length() + ") ___" + txt + "___");
p.println("AST source attribution:");
}
}
final StringBuilder sb = new StringBuilder();
for (int i = 0; i < level; i++) {
sb.append("| ");
}
if (parent != null) {
sb.append(getNodeFieldName(parent, node, ""));
}
sb.append(" (" + node.getClass().getSimpleName() + ") ");
sb.append(printSyntaxTags(node));
sb.append(displaySourceAttribution(node));
p.println(sb.toString());
for (Node child : node.getChildren()) {
printSourceAttributionTree(p, node, child, level + 1);
}
p.flush();
}
private static String getNodeFieldName(Node parent, Node node, String defaultName) {
NodeClass nodeClass = parent.getNodeClass();
for (Object field : nodeClass.getNodeFieldArray()) {
if (nodeClass.isChildField(field)) {
if (nodeClass.getFieldObject(field, parent) == node) {
return nodeClass.getFieldName(field);
}
} else if (nodeClass.isChildrenField(field)) {
Object[] arrayNodes = (Object[]) nodeClass.getFieldObject(field, parent);
if (arrayNodes != null) {
int index = 0;
for (Object arrayNode : arrayNodes) {
if (arrayNode == node) {
return nodeClass.getFieldName(field) + "[" + index + "]";
}
index++;
}
}
} else if (nodeClass.nodeFieldsOrderedByKind()) {
break;
}
}
return defaultName;
}
public static String printSyntaxTags(final Object node) {
if ((node instanceof Node) && ((Node) node).getSourceSection() != null) {
return ((Node) node).getSourceSection().toString();
}
return "";
}
public static void printTree(OutputStream out, Node node) {
printTree(new PrintWriter(out), node);
}
public static String printTreeToString(Node node) {
StringWriter out = new StringWriter();
printTree(new PrintWriter(out), node);
return out.toString();
}
public static void printTree(PrintWriter p, Node node) {
printTree(p, node, 1);
p.println();
p.flush();
}
private static void printTree(PrintWriter p, Node node, int level) {
if (node == null) {
p.print("null");
return;
}
p.print(nodeName(node));
ArrayList<Object> childFields = new ArrayList<>();
String sep = "";
p.print("(");
NodeClass nodeClass = NodeClass.get(node);
for (Object field : nodeClass.getNodeFieldArray()) {
if (nodeClass.isChildField(field) || nodeClass.isChildrenField(field)) {
childFields.add(field);
} else {
p.print(sep);
sep = ", ";
p.print(nodeClass.getFieldName(field));
p.print(" = ");
p.print(nodeClass.getFieldValue(field, node));
}
}
p.print(")");
if (childFields.size() != 0) {
p.print(" {");
for (Object field : nodeClass.getNodeFieldArray()) {
printNewLine(p, level);
p.print(nodeClass.getFieldName(field));
Object value = nodeClass.getFieldValue(field, node);
if (value == null) {
p.print(" = null ");
} else if (nodeClass.isChildField(field)) {
p.print(" = ");
printTree(p, (Node) value, level + 1);
} else if (nodeClass.isChildrenField(field)) {
printChildren(p, level, value);
}
}
printNewLine(p, level - 1);
p.print("}");
}
}
private static void printChildren(PrintWriter p, int level, Object value) {
String sep;
Object[] children = (Object[]) value;
p.print(" = [");
sep = "";
for (Object child : children) {
p.print(sep);
sep = ", ";
printTree(p, (Node) child, level + 1);
}
p.print("]");
}
private static void printNewLine(PrintWriter p, int level) {
p.println();
for (int i = 0; i < level; i++) {
p.print(" ");
}
}
private static String nodeName(Node node) {
return className(node.getClass());
}
static String className(Class<?> clazz) {
String name = clazz.getName();
return name.substring(name.lastIndexOf('.') + 1);
}
private static String displaySourceAttribution(Node node) {
final SourceSection section = node.getSourceSection();
if (section == null) {
return "";
}
if (section.getSource() == null) {
return "source: <unknown>";
}
final String srcText = section.getCharacters().toString();
final StringBuilder sb = new StringBuilder();
sb.append("source:");
sb.append(" (" + section.getCharIndex() + "," + (section.getCharEndIndex() - 1) + ")");
sb.append(" line=" + section.getStartLine());
sb.append(" len=" + srcText.length());
sb.append(" text=\"" + srcText + "\"");
return sb.toString();
}
public static boolean verify(Node root) {
Iterable<Node> children = root.getChildren();
for (Node child : children) {
if (child != null) {
if (child.getParent() != root) {
throw new AssertionError(toStringWithClass(child) + ": actual parent=" + toStringWithClass(child.getParent()) + " expected parent=" + toStringWithClass(root));
}
verify(child);
}
}
return true;
}
private static String toStringWithClass(Object obj) {
return obj == null ? "null" : obj + "(" + obj.getClass().getName() + ")";
}
static void traceRewrite(Node oldNode, Node newNode, CharSequence reason) {
if (TruffleOptions.TraceRewritesFilterFromCost != null) {
if (filterByKind(oldNode, TruffleOptions.TraceRewritesFilterFromCost)) {
return;
}
}
if (TruffleOptions.TraceRewritesFilterToCost != null) {
if (filterByKind(newNode, TruffleOptions.TraceRewritesFilterToCost)) {
return;
}
}
String filter = TruffleOptions.TraceRewritesFilterClass;
Class<? extends Node> from = oldNode.getClass();
Class<? extends Node> to = newNode.getClass();
if (filter != null && (filterByContainsClassName(from, filter) || filterByContainsClassName(to, filter))) {
return;
}
final SourceSection reportedSourceSection = oldNode.getEncapsulatingSourceSection();
PrintStream out = System.out;
out.printf("[truffle] rewrite %-50s |From %-40s |To %-40s |Reason %s %s%n", oldNode.toString(), formatNodeInfo(oldNode), formatNodeInfo(newNode),
reason != null && reason.length() > 0 ? reason : "unknown", formatLocation(reportedSourceSection));
}
private static String formatLocation(SourceSection sourceSection) {
if (sourceSection == null) {
return "";
}
if (sourceSection.getSource() == null) {
return "at <Unknown>";
} else {
return "at " + String.format("%s:%d", sourceSection.getSource().getName(),
sourceSection.getStartLine());
}
}
private static String formatNodeInfo(Node node) {
String cost = "?";
switch (node.getCost()) {
case NONE:
cost = "G";
break;
case MONOMORPHIC:
cost = "M";
break;
case POLYMORPHIC:
cost = "P";
break;
case MEGAMORPHIC:
cost = "G";
break;
default:
cost = "?";
break;
}
return cost + " " + nodeName(node);
}
private static boolean filterByKind(Node node, NodeCost cost) {
return node.getCost() == cost;
}
private static boolean filterByContainsClassName(Class<? extends Node> from, String filter) {
Class<?> currentFrom = from;
while (currentFrom != null) {
if (currentFrom.getName().contains(filter)) {
return false;
}
currentFrom = currentFrom.getSuperclass();
}
return true;
}
private static final class NodeCounter implements NodeVisitor {
public int count;
private final NodeCountFilter filter;
NodeCounter(NodeCountFilter filter) {
this.filter = filter;
}
public boolean visit(Node node) {
if (filter.isCounted(node)) {
count++;
}
return true;
}
}
}
NodeUtil
NodeUtil(): void
deepCopyImpl(Node): Node
