comparison graal/com.oracle.truffle.api/src/com/oracle/truffle/api/instrument/Instrumentable.java @ 16880:7661cc464239

Truffle/Instrumentation: Added Instrumentable interface and LineLocationToSourceSections map SL: Updated implementation to use new Instrumentable interface
author David Piorkowski <david.piorkowski@oracle.com>
date Thu, 21 Aug 2014 13:28:22 -0700
parents
children 997899955e72 a1427e40deaf
comparison
equal deleted inserted replaced
16867:7af9301efe6b 16880:7661cc464239
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 com.oracle.truffle.api.*;
28
29 public interface Instrumentable {
30
31 /**
32 * Optionally applies <em>instrumentation</em> at a Truffle AST node, depending on guest
33 * language characteristics and use-case policy. Ideally, the parent node of the guest language
34 * implements this interface.
35 * <ul>
36 * <li>if no instrumentation is to be applied, returns the AST node unmodified;</li>
37 * <li>if an AST node is to be instrumented, then creates a new Wrapper that <em>decorates</em>
38 * the AST node. Additionally, this creates a probe on the wrapper that is to be used for
39 * attaching instruments. This {@link Probe} is notified of all {@link ExecutionEvents} at the
40 * wrapped AST node.</li>
41 * </ul>
42 *
43 * @param context The {@link ExecutionContext} of the guest language used to create probes on
44 * the wrapper.
45 * @return The probe that was created.
46 */
47 public Probe probe(ExecutionContext context);
48 }