Mercurial > hg > graal-compiler

comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrumentation.java @ 15279:0c6d8a08e31b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Truffle: Major cleanup and extension of the Truffle Instrumentation framework in com.oracle.truffle.api
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Sun, 20 Apr 2014 20:37:27 -0700
parents
children
comparison
equal deleted inserted replaced
14862:0e713dba33bb 15279:0c6d8a08e31b
1 /*
2 * Copyright (c) 2014, 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 java.util.*;
28
29 import com.oracle.truffle.api.*;
30 import com.oracle.truffle.api.source.*;
31
32 public interface Instrumentation {
33
34 /**
35 * Adds a new specification for how to instrument ASTs.
36 */
37 void addNodeProber(ASTNodeProber nodeProber);
38
39 /**
40 * Registers a tool interested in being notified about the insertion of a newly created
41 * {@link Probe} into a Truffle AST.
42 */
43 void addProbeListener(ProbeListener listener);
44
45 /**
46 * Return the (possibly newly created) {@link Probe} uniquely associated with a particular
47 * source code location. A newly created probe carries no tags.
48 *
49 * @param eventListener an optional listener for certain instrumentation-related events
50 * @return a probe uniquely associated with an extent of guest language source code.
51 */
52 Probe getProbe(SourceSection sourceSection, InstrumentEventListener eventListener);
53
54 /**
55 * Returns all existing probes with specific tag, or all probes if {@code tag = null}; empty
56 * collection if no probes found.
57 */
58 Collection<Probe> findProbesTaggedAs(PhylumTag tag);
59
60 /**
61 * Returns all existing probes with first character on a specified line; empty collection if no
62 * probes found.
63 */
64 Collection<Probe> findProbesByLine(SourceLineLocation lineLocation);
65
66 }