Mercurial > hg > truffle

changeset 22352:7d9b7365b675

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Adding Map<String,Object> parameter to the attach(Eval*Listener) method to allow passing parameter values that the evaluated Source can reference.
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 04 Nov 2015 16:54:36 +0100
parents 906a5f6e07cc
children 56e71849d356
files truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/instrument/EvalInstrumentTest.java truffle/com.oracle.truffle.api.vm/src/com/oracle/truffle/api/vm/PolyglotEngine.java truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/LineBreakpointFactory.java truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/TagBreakpointFactory.java truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/impl/Accessor.java truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrumenter.java truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ProbeInstrument.java
diffstat 7 files changed, 101 insertions(+), 27 deletions(-) [+]
line wrap: on
line diff
--- a/truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/instrument/EvalInstrumentTest.java	Mon Nov 02 19:13:21 2015 +0100
+++ b/truffle/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/instrument/EvalInstrumentTest.java	Wed Nov 04 16:54:36 2015 +0100
@@ -99,7 +99,7 @@
         final Source source42 = InstrumentationTestingLanguage.createConstantSource42("testEvalInstrumentListener");
         final int[] evalResult = {0};
         final int[] evalCount = {0};
-        final Instrument instrument = instrumenter.attach(addNodeProbe[0], InstrumentationTestingLanguage.class, source42, new EvalInstrumentListener() {
+        final Instrument instrument = instrumenter.attach(addNodeProbe[0], source42, new EvalInstrumentListener() {
 
             public void onExecution(Node node, VirtualFrame vFrame, Object result) {
                 evalCount[0] = evalCount[0] + 1;
@@ -112,7 +112,7 @@
                 fail("Eval test evaluates without exception");
 
             }
-        }, "test EvalInstrument");
+        }, "test EvalInstrument", null);
 
         assertEquals(vm.eval(source13).get(), 13);
         assertEquals(evalCount[0], 1);
@@ -124,7 +124,7 @@
         assertEquals(evalResult[0], 42);
 
         // Add new eval instrument with no listener, no effect on third execution
-        instrumenter.attach(addNodeProbe[0], InstrumentationTestingLanguage.class, source42, null, "");
+        instrumenter.attach(addNodeProbe[0], source42, null, "", null);
         assertEquals(vm.eval(source13).get(), 13);
         assertEquals(evalCount[0], 3);
         assertEquals(evalResult[0], 42);
--- a/truffle/com.oracle.truffle.api.vm/src/com/oracle/truffle/api/vm/PolyglotEngine.java	Mon Nov 02 19:13:21 2015 +0100
+++ b/truffle/com.oracle.truffle.api.vm/src/com/oracle/truffle/api/vm/PolyglotEngine.java	Wed Nov 04 16:54:36 2015 +0100
@@ -869,7 +869,15 @@
                 return impl;
             }
         }
-        throw new IllegalStateException("Cannot find language " + languageClazz + " among " + langs);
+        return null;
+    }
+
+    TruffleLanguage<?> findLanguage(String mimeType) {
+        Language languageDescription = this.langs.get(mimeType);
+        if (languageDescription != null) {
+            return languageDescription.getImpl(true);
+        }
+        return null;
     }
 
     TruffleLanguage<?> findLanguage(Probe probe) {
@@ -970,9 +978,19 @@
         }
 
         @Override
-        protected TruffleLanguage<?> findLanguageImpl(Object obj, Class<? extends TruffleLanguage> languageClazz) {
+        protected TruffleLanguage<?> findLanguageImpl(Object obj, Class<? extends TruffleLanguage> languageClazz, String mimeType) {
             final PolyglotEngine vm = (PolyglotEngine) obj;
-            return vm.findLanguage(languageClazz);
+            TruffleLanguage<?> language = null;
+            if (languageClazz != null) {
+                language = vm.findLanguage(languageClazz);
+            }
+            if (language == null && mimeType != null) {
+                language = vm.findLanguage(mimeType);
+            }
+            if (language == null) {
+                throw new IllegalStateException("Cannot find language " + languageClazz + " with mimeType" + mimeType + " among " + vm.langs);
+            }
+            return language;
         }
 
         @Override
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/LineBreakpointFactory.java	Mon Nov 02 19:13:21 2015 +0100
+++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/LineBreakpointFactory.java	Wed Nov 04 16:54:36 2015 +0100
@@ -44,7 +44,6 @@
 import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.Truffle;
-import com.oracle.truffle.api.TruffleLanguage;
 import com.oracle.truffle.api.debug.Debugger.BreakpointCallback;
 import com.oracle.truffle.api.debug.Debugger.WarningLog;
 import com.oracle.truffle.api.frame.VirtualFrame;
@@ -372,7 +371,6 @@
             }
         }
 
-        @SuppressWarnings("rawtypes")
         private void attach(Probe newProbe) {
             if (getState() == DISPOSED) {
                 throw new IllegalStateException("Attempt to attach a disposed " + BREAKPOINT_NAME);
@@ -382,8 +380,7 @@
             if (conditionSource == null) {
                 newInstrument = instrumenter.attach(newProbe, new UnconditionalLineBreakInstrumentListener(), BREAKPOINT_NAME);
             } else {
-                final Class<? extends TruffleLanguage> languageClass = Debugger.ACCESSOR.findLanguage(newProbe);
-                newInstrument = instrumenter.attach(newProbe, languageClass, conditionSource, this, BREAKPOINT_NAME);
+                newInstrument = instrumenter.attach(newProbe, conditionSource, this, BREAKPOINT_NAME, null);
             }
             instruments.add(newInstrument);
             changeState(isEnabled ? ENABLED : DISABLED);
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/TagBreakpointFactory.java	Mon Nov 02 19:13:21 2015 +0100
+++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/TagBreakpointFactory.java	Wed Nov 04 16:54:36 2015 +0100
@@ -42,7 +42,6 @@
 import com.oracle.truffle.api.CompilerDirectives.CompilationFinal;
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.Truffle;
-import com.oracle.truffle.api.TruffleLanguage;
 import com.oracle.truffle.api.debug.Debugger.BreakpointCallback;
 import com.oracle.truffle.api.debug.Debugger.WarningLog;
 import com.oracle.truffle.api.frame.VirtualFrame;
@@ -333,7 +332,6 @@
             }
         }
 
-        @SuppressWarnings("rawtypes")
         private void attach(Probe newProbe) {
             if (getState() == DISPOSED) {
                 throw new IllegalStateException("Attempt to attach a disposed " + BREAKPOINT_NAME);
@@ -343,8 +341,7 @@
             if (conditionSource == null) {
                 newInstrument = instrumenter.attach(newProbe, new UnconditionalTagBreakInstrumentListener(), BREAKPOINT_NAME);
             } else {
-                final Class<? extends TruffleLanguage> languageClass = Debugger.ACCESSOR.findLanguage(newProbe);
-                instrumenter.attach(newProbe, languageClass, conditionSource, this, BREAKPOINT_NAME);
+                instrumenter.attach(newProbe, conditionSource, this, BREAKPOINT_NAME, null);
             }
             instruments.add(newInstrument);
             changeState(isEnabled ? ENABLED : DISABLED);
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/impl/Accessor.java	Mon Nov 02 19:13:21 2015 +0100
+++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/impl/Accessor.java	Wed Nov 04 16:54:36 2015 +0100
@@ -180,7 +180,7 @@
     protected boolean isInstrumentable(Object vm, Node node) {
         final RootNode rootNode = node.getRootNode();
         Class<? extends TruffleLanguage> languageClazz = findLanguage(rootNode);
-        TruffleLanguage language = findLanguageImpl(vm, languageClazz);
+        TruffleLanguage language = findLanguageImpl(vm, languageClazz, null);
         return isInstrumentable(node, language);
     }
 
@@ -195,7 +195,7 @@
     protected WrapperNode createWrapperNode(Object vm, Node node) {
         final RootNode rootNode = node.getRootNode();
         Class<? extends TruffleLanguage> languageClazz = findLanguage(rootNode);
-        TruffleLanguage language = findLanguageImpl(vm, languageClazz);
+        TruffleLanguage language = findLanguageImpl(vm, languageClazz, null);
         return createWrapperNode(node, language);
     }
 
@@ -231,7 +231,7 @@
     }
 
     @SuppressWarnings("rawtypes")
-    protected TruffleLanguage<?> findLanguageImpl(Object known, Class<? extends TruffleLanguage> languageClass) {
+    protected TruffleLanguage<?> findLanguageImpl(Object known, Class<? extends TruffleLanguage> languageClass, String mimeType) {
         Object vm;
         if (known == null) {
             vm = CURRENT_VM.get();
@@ -241,7 +241,7 @@
         } else {
             vm = known;
         }
-        return SPI.findLanguageImpl(vm, languageClass);
+        return SPI.findLanguageImpl(vm, languageClass, mimeType);
     }
 
     protected Instrumenter getInstrumenter(Object known) {
@@ -334,7 +334,7 @@
 
     @SuppressWarnings("rawtypes")
     protected CallTarget parse(Class<? extends TruffleLanguage> languageClass, Source code, Node context, String... argumentNames) throws IOException {
-        final TruffleLanguage<?> truffleLanguage = findLanguageImpl(null, languageClass);
+        final TruffleLanguage<?> truffleLanguage = findLanguageImpl(null, languageClass, code.getMimeType());
         return parse(truffleLanguage, code, context, argumentNames);
     }
 
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrumenter.java	Mon Nov 02 19:13:21 2015 +0100
+++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrumenter.java	Wed Nov 04 16:54:36 2015 +0100
@@ -46,6 +46,7 @@
 import com.oracle.truffle.api.nodes.RootNode;
 import com.oracle.truffle.api.source.Source;
 import com.oracle.truffle.api.source.SourceSection;
+import java.util.Map;
 
 /**
  * Client access to instrumentation services in a Truffle execution environment.
@@ -478,11 +479,71 @@
      * @param listener optional client callback for results/failure notification
      * @param instrumentInfo instrumentInfo optional documentation about the Instrument
      * @return a handle for access to the binding
+     * @deprecated
      */
+    @Deprecated
     @SuppressWarnings("rawtypes")
     public ProbeInstrument attach(Probe probe, Class<? extends TruffleLanguage> languageClass, Source source, EvalInstrumentListener listener, String instrumentInfo) {
+        return attach(probe, languageClass, source, listener, instrumentInfo, new String[0], new Object[0]);
+    }
+
+    /**
+     * <em>Attaches</em> a fragment of source text that is to be evaluated just before execution
+     * enters the location of a {@link Probe}, creating a <em>binding</em> called an
+     * {@link ProbeInstrument}. The outcome of the evaluation is reported to an optional
+     * {@link EvalInstrumentListener listener}, but the outcome does not affect the flow of guest
+     * language execution, even if the evaluation produces an exception.
+     * <p>
+     * The source text is assumed to be expressed in the language identified by its associated
+     * {@linkplain Source#getMimeType() MIME type}, if specified, otherwise by the language
+     * associated with the AST location associated with the {@link Probe}.
+     * <p>
+     * The source text is parsed in the lexical context of the AST location associated with the
+     * {@link Probe}.
+     * <p>
+     * The source text executes subject to full Truffle optimization.
+     *
+     * @param probe source of AST execution events, non-null
+     * @param source the source code to be evaluated, non-null and non-empty, preferably with
+     *            {@link Source#withMimeType(java.lang.String) specified mime type} that determines
+     *            the {@link TruffleLanguage} to use when processing the source
+     * @param listener optional client callback for results/failure notification
+     * @param instrumentInfo instrumentInfo optional documentation about the Instrument
+     * @param parameters keys are the parameter names to pass to
+     *            {@link TruffleLanguage#parse(com.oracle.truffle.api.source.Source, com.oracle.truffle.api.nodes.Node, java.lang.String...)
+     *            parse} method; values will be passed to
+     *            {@link CallTarget#call(java.lang.Object...)} returned from the <code>parse</code>
+     *            method; the value can be <code>null</code>
+     * @return a handle for access to the binding
+     */
+    public ProbeInstrument attach(Probe probe, Source source, EvalInstrumentListener listener, String instrumentInfo, Map<String, Object> parameters) {
+        final int size = parameters == null ? 0 : parameters.size();
+        String[] names = new String[size];
+        Object[] params = new Object[size];
+        if (parameters != null) {
+            int index = 0;
+            for (Map.Entry<String, Object> entry : parameters.entrySet()) {
+                names[index] = entry.getKey();
+                params[index] = entry.getValue();
+                index++;
+            }
+        }
+        return attach(probe, null, source, listener, instrumentInfo, names, params);
+    }
+
+    @SuppressWarnings("rawtypes")
+    private ProbeInstrument attach(Probe probe, Class<? extends TruffleLanguage> languageClass, Source source, EvalInstrumentListener listener, String instrumentInfo, String[] argumentNames,
+                    Object[] parameters) {
         assert probe.getInstrumenter() == this;
-        final EvalInstrument instrument = new EvalInstrument(languageClass, source, listener, instrumentInfo);
+        Class<? extends TruffleLanguage> foundLanguageClass = null;
+        if (languageClass == null) {
+            if (source.getMimeType() == null) {
+                foundLanguageClass = ACCESSOR.findLanguage(probe);
+            }
+        } else {
+            foundLanguageClass = languageClass;
+        }
+        final EvalInstrument instrument = new EvalInstrument(foundLanguageClass, source, listener, instrumentInfo, argumentNames, parameters);
         probe.attach(instrument);
         return instrument;
     }
--- a/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ProbeInstrument.java	Mon Nov 02 19:13:21 2015 +0100
+++ b/truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ProbeInstrument.java	Wed Nov 04 16:54:36 2015 +0100
@@ -54,10 +54,7 @@
  * @see Instrumenter
  */
 public abstract class ProbeInstrument extends Instrument {
-
-    private static final String[] NO_ARGS = new String[0];
-
-    protected Probe probe = null;
+    Probe probe = null;
 
     /**
      * <h4>Implementation Notes</h4>
@@ -345,13 +342,17 @@
         @SuppressWarnings("rawtypes") private final Class<? extends TruffleLanguage> languageClass;
         private final Source source;
         private final EvalInstrumentListener evalListener;
+        private final String[] names;
+        private final Object[] params;
 
         @SuppressWarnings("rawtypes")
-        EvalInstrument(Class<? extends TruffleLanguage> languageClass, Source source, EvalInstrumentListener evalListener, String instrumentInfo) {
+        EvalInstrument(Class<? extends TruffleLanguage> languageClass, Source source, EvalInstrumentListener evalListener, String instrumentInfo, String[] argumentNames, Object[] parameters) {
             super(instrumentInfo);
             this.languageClass = languageClass;
             this.source = source;
             this.evalListener = evalListener;
+            this.names = argumentNames;
+            this.params = parameters;
         }
 
         @Override
@@ -392,7 +393,7 @@
             public void enter(Node node, VirtualFrame vFrame) {
                 if (callNode == null) {
                     try {
-                        final CallTarget callTarget = Instrumenter.ACCESSOR.parse(languageClass, source, node, NO_ARGS);
+                        final CallTarget callTarget = Instrumenter.ACCESSOR.parse(languageClass, source, node, names);
                         if (callTarget != null) {
                             callNode = Truffle.getRuntime().createDirectCallNode(callTarget);
                             callNode.forceInlining();
@@ -407,7 +408,7 @@
                 }
                 if (callNode != null) {
                     try {
-                        final Object result = callNode.call(vFrame, NO_ARGS);
+                        final Object result = callNode.call(vFrame, params);
                         if (evalListener != null) {
                             evalListener.onExecution(node, vFrame, result);
                         }