Mercurial > hg > graal-jvmci-8

comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/ProbeListener.java @ 18985:867058575979

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Truffle: Improved support for "probing" AST nodes: - Node.isSafelyReplacaeableBy(Node) checks in advance if Node.replace(Node) would be unsafe (crash the VM). - Hoist Probe() from language imlementations into Node; now completely language agnostic. - Language implementations support probing by implementing Node.isInstrumentable() and Node.createWrapperNode() - Node.Probe() throws ProbeException (without side effects) if the probe fails. -- ProbeException contains an instance of ProbeFailure that diagnoses the failure in detail - Additional measures to prevent instrumentation from being applied to internal InstrumentationNodes. - Promote ProbeListener to top level interface and add a default implementation
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Tue, 27 Jan 2015 20:24:54 -0800
parents
children
comparison
equal deleted inserted replaced
18984:0f462015296f 18985:867058575979
1 /*
2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25 package com.oracle.truffle.api.instrument;
26
27 import com.oracle.truffle.api.nodes.*;
28 import com.oracle.truffle.api.source.*;
29
30 /**
31 * An observer of events related to {@link Probe}s: creating and tagging.
32 */
33 public interface ProbeListener {
34
35 /**
36 * Notifies that all registered {@link ASTProber}s are about to be applied to a newly
37 * constructed AST.
38 *
39 * @param source source code from which the AST was constructed
40 */
41 void startASTProbing(Source source);
42
43 /**
44 * Notifies that a {@link Probe} has been newly attached to an AST via {@link Node#probe()}.
45 * <p>
46 * There can be no more than one {@link Probe} at a node; this notification will only be
47 * delivered the first time {@linkplain Node#probe() probe()} is called at a particular AST
48 * node. There will also be no notification when the AST to which the Probe is attached is
49 * cloned.
50 */
51 void newProbeInserted(Probe probe);
52
53 /**
54 * Notifies that a {@link SyntaxTag} has been newly added to the set of tags associated with a
55 * {@link Probe} via {@link Probe#tagAs(SyntaxTag, Object)}.
56 * <p>
57 * The {@linkplain SyntaxTag tags} at a {@link Probe} are a <em>set</em>; this notification will
58 * only be delivered the first time a particular {@linkplain SyntaxTag tag} is added at a
59 * {@link Probe}.
60 * <p>
61 * An optional value supplied with {@linkplain Probe#tagAs(SyntaxTag, Object) tagAs(SyntaxTag,
62 * Object)} is reported to all listeners, but not stored. As a consequence, the optional value
63 * will have no effect at all if the tag had already been added.
64 *
65 * @param probe where a tag has been added
66 * @param tag the tag that has been newly added (subsequent additions of the tag are
67 * unreported).
68 * @param tagValue an optional value associated with the tag for the purposes of reporting.
69 */
70 void probeTaggedAs(Probe probe, SyntaxTag tag, Object tagValue);
71
72 /**
73 * Notifies that the application of all registered {@link ASTProber}s to a newly constructed AST
74 * has completed.
75 *
76 * @param source source code from which the AST was constructed
77 */
78 void endASTProbing(Source source);
79
80 }