# HG changeset patch
# User Michael Van De Vanter  <michael.van.de.vanter@oracle.com>
# Date 1389147971 28800
# Node ID b88852aea6f37630c0f591436d622fe218e1e44a
# Parent  35f637594acc9d742651acc68b94e4e126044ac9
Truffle: extend Instrumentation Framework for proxies/probes to include phylum marking, low level stepping mode, and bug fixes.

diff -r 35f637594acc -r b88852aea6f3 graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/instrument/InstrumentationProbeNode.java
--- a/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/instrument/InstrumentationProbeNode.java	Tue Jan 07 18:21:20 2014 -0800
+++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/instrument/InstrumentationProbeNode.java	Tue Jan 07 18:26:11 2014 -0800
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2014, 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
@@ -24,6 +24,8 @@
  */
 package com.oracle.truffle.api.nodes.instrument;
 
+import java.util.*;
+
 import com.oracle.truffle.api.*;
 import com.oracle.truffle.api.frame.*;
 import com.oracle.truffle.api.nodes.*;
@@ -50,6 +52,11 @@
         return next == null ? 0 : next.countProbes() + 1;
     }
 
+    protected boolean isStepping() {
+        final InstrumentationProbeNode parent = (InstrumentationProbeNode) getParent();
+        return parent.isStepping();
+    }
+
     /**
      * Add a probe to the end of this probe chain.
      */
@@ -69,6 +76,7 @@
                 this.next = null;
             } else {
                 this.next = adoptChild(oldProbeNode.next);
+                oldProbeNode.next = null;
             }
         } else {
             next.internalRemoveProbe(oldProbeNode);
@@ -186,6 +194,16 @@
      */
     public static class DefaultProbeNode extends InstrumentationProbeNode {
 
+        private final ExecutionContext executionContext;
+
+        protected DefaultProbeNode(ExecutionContext context) {
+            this.executionContext = context;
+        }
+
+        public ExecutionContext getContext() {
+            return executionContext;
+        }
+
         public void enter(Node astNode, VirtualFrame frame) {
         }
 
@@ -230,17 +248,28 @@
     /**
      * Holder of a chain of {@linkplain InstrumentationProbeNode probes}: manages the
      * {@link Assumption} that the chain has not changed since checked checked.
+     * <p>
+     * May be categorized by one or more {@linkplain NodePhylum node phyla}, signifying information
+     * useful for instrumentation about its AST location(s).
      */
-    public static final class ProbeChain extends DefaultProbeNode {
+    public static final class ProbeChain extends DefaultProbeNode implements PhylumMarked {
 
         @CompilerDirectives.CompilationFinal private Assumption probeUnchanged;
 
         /**
+         * When in stepping mode, ordinary line breakpoints are ignored, but every entry at a line
+         * will cause a halt.
+         */
+        @CompilerDirectives.CompilationFinal private boolean stepping;
+
+        /**
          * Source information about the node to which this probe chain is attached; it isn't
          * otherwise available. A probe chain is shared by every copy made during runtime, so there
          * is no parent pointer.
          */
-        @SuppressWarnings("unused") private final SourceSection sourceSection;
+        private final SourceSection probedSourceSection;
+
+        private final Set<NodePhylum> phyla = EnumSet.noneOf(NodePhylum.class);
 
         private final String description; // for debugging
 
@@ -249,9 +278,10 @@
          * probes can be added/removed, and all of which will be notified of
          * {@linkplain InstrumentationProbeEvents events} when the chain is notified.
          */
-        public ProbeChain(SourceSection sourceSection, String description) {
+        public ProbeChain(ExecutionContext context, SourceSection sourceSection, String description) {
+            super(context);
             this.probeUnchanged = Truffle.getRuntime().createAssumption();
-            this.sourceSection = sourceSection;
+            this.probedSourceSection = sourceSection;
             this.description = description;
             this.next = null;
         }
@@ -264,6 +294,51 @@
             return description;
         }
 
+        public SourceSection getProbedSourceSection() {
+            return probedSourceSection;
+        }
+
+        /**
+         * Mark this probe chain as being associated with an AST node in some category useful for
+         * debugging and other tools.
+         */
+        public void markAs(NodePhylum phylum) {
+            assert phylum != null;
+            phyla.add(phylum);
+        }
+
+        /**
+         * Is this probe chain as being associated with an AST node in some category useful for
+         * debugging and other tools.
+         */
+        public boolean isMarkedAs(NodePhylum phylum) {
+            assert phylum != null;
+            return phyla.contains(phylum);
+        }
+
+        /**
+         * In which categories is the AST (with which this probe is associated) marked?
+         */
+        public Set<NodePhylum> getPhylumMarks() {
+            return phyla;
+        }
+
+        /**
+         * Change <em>stepping mode</em> for statements.
+         */
+        public void setStepping(boolean stepping) {
+            if (this.stepping != stepping) {
+                this.stepping = stepping;
+                probeUnchanged.invalidate();
+                probeUnchanged = Truffle.getRuntime().createAssumption();
+            }
+        }
+
+        @Override
+        protected boolean isStepping() {
+            return stepping;
+        }
+
         @Override
         protected int countProbes() {
             // The head of the chain does not itself hold a probe
@@ -291,10 +366,13 @@
         }
 
         public void notifyEnter(Node astNode, VirtualFrame frame) {
-            if (next != null) {
+            if (stepping || next != null) {
                 if (!probeUnchanged.isValid()) {
                     CompilerDirectives.transferToInterpreter();
                 }
+                if (stepping) {
+                    getContext().getDebugManager().haltedAt(astNode, frame.materialize());
+                }
                 next.internalEnter(astNode, frame);
             }
         }
diff -r 35f637594acc -r b88852aea6f3 graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/instrument/InstrumentationProxyNode.java
--- a/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/instrument/InstrumentationProxyNode.java	Tue Jan 07 18:21:20 2014 -0800
+++ b/graal/com.oracle.truffle.api/src/com/oracle/truffle/api/nodes/instrument/InstrumentationProxyNode.java	Tue Jan 07 18:26:11 2014 -0800
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2013, 2014, 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
@@ -24,6 +24,7 @@
  */
 package com.oracle.truffle.api.nodes.instrument;
 
+import com.oracle.truffle.api.nodes.*;
 import com.oracle.truffle.api.nodes.instrument.InstrumentationProbeNode.ProbeChain;
 
 /**
@@ -36,7 +37,12 @@
  * probe chain} which passes along {@linkplain InstrumentationProbeEvents events} to any
  * {@linkplain InstrumentationProbeNode probes} that might have been attached.
  */
-public interface InstrumentationProxyNode extends InstrumentationNode {
+public interface InstrumentationProxyNode extends InstrumentationNode, PhylumMarked {
+
+    /**
+     * Gets the non-instrumentation node being proxied.
+     */
+    Node getChild();
 
     /**
      * Gets the chain of probes to which events at this node are delegated. Note that a chain of