Mercurial > hg > truffle

annotate truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/debug/package-info.java @ 22008:02e4cf046653

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Providing a bit more meaningful documentation to our recent debugging improvements
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 22 Jul 2015 14:25:03 +0200
parents
children 7a5b874b8d12
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22008
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
1 /*
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
4 *
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
10 *
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
15 * accompanied this code).
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
16 *
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
20 *
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
23 * questions.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
24 */
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
25
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
26 /**
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
27 * Control over {@link com.oracle.truffle.api.debug.Debugger debugging} of your {@link com.oracle.truffle.api.vm.TruffleVM}. Each {@link com.oracle.truffle.api.vm.TruffleVM}
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
28 * is inherently capable to run in debugging mode - there is just one thing
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
29 * to do - the {@link com.oracle.truffle.api.vm.TruffleVM.Builder creator of the virtual machine}
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
30 * needs to turn debugging on when constructing its Truffle virtual machine:
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
31 * <pre>
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
32 * vm = {@link com.oracle.truffle.api.vm.TruffleVM#newVM()}.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
33 * {@link com.oracle.truffle.api.vm.TruffleVM.Builder#onEvent(com.oracle.truffle.api.vm.EventConsumer) onEvent}(<b>new</b> {@link com.oracle.truffle.api.vm.EventConsumer EventConsumer}{@code <}{@link com.oracle.truffle.api.debug.ExecutionEvent}{@code >}() {
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
34 * <b>public void</b> handle({@link com.oracle.truffle.api.debug.ExecutionEvent} ev) {
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
35 * <em>// configure the virtual machine as {@link com.oracle.truffle.api.vm.TruffleVM#eval(java.net.URI) new execution} is starting</em>
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
36 * }
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
37 * }).
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
38 * {@link com.oracle.truffle.api.vm.TruffleVM.Builder#onEvent(com.oracle.truffle.api.vm.EventConsumer) onEvent}(<b>new</b> {@link com.oracle.truffle.api.vm.EventConsumer EventConsumer}{@code <}{@link com.oracle.truffle.api.debug.SuspendedEvent}{@code >}() {
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
39 * <b>public void</b> handle({@link com.oracle.truffle.api.debug.SuspendedEvent} ev) {
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
40 * <em>// execution is suspended on a breakpoint or on a step - decide what next</em>
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
41 * }
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
42 * }).{@link com.oracle.truffle.api.vm.TruffleVM.Builder#build() build()};
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
43 * </pre>
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
44 * The debugging is controlled by events emitted by the Truffle virtual machine
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
45 * at important moments. The {@link com.oracle.truffle.api.debug.ExecutionEvent}
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
46 * is sent when a call to {@link com.oracle.truffle.api.vm.TruffleVM#eval(java.net.URI) eval(...)}
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
47 * is made and allows one to configure {@link com.oracle.truffle.api.debug.Breakpoint breakpoints} and/or decide whether the
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
48 * program should {@link com.oracle.truffle.api.debug.ExecutionEvent#prepareStepInto() step-into} or
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
49 * {@link com.oracle.truffle.api.debug.ExecutionEvent#prepareContinue() just run}. Once the execution is suspended a
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
50 * {@link com.oracle.truffle.api.debug.SuspendedEvent} is generated which
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
51 * allows one to inspect the stack and choose the further execution mode
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
52 * ({@link com.oracle.truffle.api.debug.SuspendedEvent#prepareStepInto(int) step-into}, {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareStepOver(int) step-over}, {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareStepOut() step-out}, {@link com.oracle.truffle.api.debug.SuspendedEvent#prepareContinue() continue}).
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
53 * <p>
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
54 * The events methods are only available when the event is being delivered and
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
55 * shouldn't be used anytime later. Both events however provide access to
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
56 * {@link com.oracle.truffle.api.debug.Debugger} which can be kept and used
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
57 * during whole existence of the {@link com.oracle.truffle.api.vm.TruffleVM}.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
58 * {@link com.oracle.truffle.api.debug.Debugger} is the central class that
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
59 * keeps information about {@link com.oracle.truffle.api.debug.Debugger#getBreakpoints() registered breakpoints}
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
60 * and allows one create new {@link com.oracle.truffle.api.debug.Breakpoint ones}.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
61 *
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
62 * <h4>Turning on Stepping Mode</h4>
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
63 *
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
64 * In case you want your execution to pause on first statement, register for
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
65 * {@link com.oracle.truffle.api.debug.ExecutionEvent} and once delivered
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
66 * call {@link com.oracle.truffle.api.debug.ExecutionEvent#prepareStepInto()}.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
67 *
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
68 * <h4>Register a {@link com.oracle.truffle.api.debug.Breakpoint}</h4>
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
69 *
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
70 * Wait for execution to be started - which generates an
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
71 * {@link com.oracle.truffle.api.debug.ExecutionEvent}. Use its
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
72 * {@link com.oracle.truffle.api.debug.Debugger ev.getDebugger}()
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
73 * methods to submit breakpoints.
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
74 */
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
75 package com.oracle.truffle.api.debug;
02e4cf046653 Providing a bit more meaningful documentation to our recent debugging improvements
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents:
diff changeset
76