annotate agent/src/share/classes/sun/jvm/hotspot/debugger/cdbg/CDebugger.java @ 1552:c18cbe5936b8

6941466: Oracle rebranding changes for Hotspot repositories Summary: Change all the Sun copyrights to Oracle copyright Reviewed-by: ohair
author trims
date Thu, 27 May 2010 19:08:38 -0700
parents a61af66fc99e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
1552
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
2 * Copyright (c) 2001, 2003, Oracle and/or its affiliates. All rights reserved.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
1552
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 0
diff changeset
21 * questions.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24
a61af66fc99e Initial load
duke
parents:
diff changeset
25 package sun.jvm.hotspot.debugger.cdbg;
a61af66fc99e Initial load
duke
parents:
diff changeset
26
a61af66fc99e Initial load
duke
parents:
diff changeset
27 import java.util.*;
a61af66fc99e Initial load
duke
parents:
diff changeset
28 import sun.jvm.hotspot.debugger.*;
a61af66fc99e Initial load
duke
parents:
diff changeset
29
a61af66fc99e Initial load
duke
parents:
diff changeset
30 /** Interface describing how to debug C and C++ programs. Being kept
a61af66fc99e Initial load
duke
parents:
diff changeset
31 very minimal and incomplete for now; can be extended later. */
a61af66fc99e Initial load
duke
parents:
diff changeset
32
a61af66fc99e Initial load
duke
parents:
diff changeset
33 public interface CDebugger {
a61af66fc99e Initial load
duke
parents:
diff changeset
34 /** Fetch the thread list for the target process as a List of
a61af66fc99e Initial load
duke
parents:
diff changeset
35 ThreadProxy objects. Do not mutate this list. Throws
a61af66fc99e Initial load
duke
parents:
diff changeset
36 DebuggerException if the target process is not suspended (via
a61af66fc99e Initial load
duke
parents:
diff changeset
37 ProcessControl) or if the fetch failed for some other reason. */
a61af66fc99e Initial load
duke
parents:
diff changeset
38 public List/*<ThreadProxy>*/ getThreadList() throws DebuggerException;
a61af66fc99e Initial load
duke
parents:
diff changeset
39
a61af66fc99e Initial load
duke
parents:
diff changeset
40 /** Return a list of LoadObjects in the target process. Do not
a61af66fc99e Initial load
duke
parents:
diff changeset
41 mutate this list. Throws DebuggerException if the target process
a61af66fc99e Initial load
duke
parents:
diff changeset
42 is not suspended (via ProcessControl) or if the fetch failed for
a61af66fc99e Initial load
duke
parents:
diff changeset
43 some other reason. */
a61af66fc99e Initial load
duke
parents:
diff changeset
44 public List/*<LoadObject>*/ getLoadObjectList() throws DebuggerException;
a61af66fc99e Initial load
duke
parents:
diff changeset
45
a61af66fc99e Initial load
duke
parents:
diff changeset
46 /** Fetch the loadobject containing the current program counter.
a61af66fc99e Initial load
duke
parents:
diff changeset
47 Returns null if the PC was outside the ranges of all loadobjects
a61af66fc99e Initial load
duke
parents:
diff changeset
48 in the target process. Throws DebuggerException if the target
a61af66fc99e Initial load
duke
parents:
diff changeset
49 process is not suspended (via ProcessControl) or if the fetch
a61af66fc99e Initial load
duke
parents:
diff changeset
50 failed for some other reason. */
a61af66fc99e Initial load
duke
parents:
diff changeset
51 public LoadObject loadObjectContainingPC(Address pc) throws DebuggerException;
a61af66fc99e Initial load
duke
parents:
diff changeset
52
a61af66fc99e Initial load
duke
parents:
diff changeset
53 /** Create a CFrame object for the top frame of the given thread,
a61af66fc99e Initial load
duke
parents:
diff changeset
54 specified as a ThreadProxy. Returns null if there are no frames
a61af66fc99e Initial load
duke
parents:
diff changeset
55 on the stack or the frame can not be created for some other
a61af66fc99e Initial load
duke
parents:
diff changeset
56 reason. Throws DebuggerException if the target process is not
a61af66fc99e Initial load
duke
parents:
diff changeset
57 suspended (via ProcessControl). */
a61af66fc99e Initial load
duke
parents:
diff changeset
58 public CFrame topFrameForThread(ThreadProxy t)
a61af66fc99e Initial load
duke
parents:
diff changeset
59 throws DebuggerException, IllegalThreadStateException;
a61af66fc99e Initial load
duke
parents:
diff changeset
60
a61af66fc99e Initial load
duke
parents:
diff changeset
61 /** Get the file name component for the given full path to a DLL.
a61af66fc99e Initial load
duke
parents:
diff changeset
62 (The path separator characters and behavior of File.getName()
a61af66fc99e Initial load
duke
parents:
diff changeset
63 are platform-specific.) */
a61af66fc99e Initial load
duke
parents:
diff changeset
64 public String getNameOfFile(String fileName) throws DebuggerException;
a61af66fc99e Initial load
duke
parents:
diff changeset
65
a61af66fc99e Initial load
duke
parents:
diff changeset
66 /** Fetch a ProcessControl object for the target process, enabling
a61af66fc99e Initial load
duke
parents:
diff changeset
67 suspension, resumption and event handling. This method may
a61af66fc99e Initial load
duke
parents:
diff changeset
68 return null for many reasons, including that the underlying
a61af66fc99e Initial load
duke
parents:
diff changeset
69 implementation does not support process interaction, or that the
a61af66fc99e Initial load
duke
parents:
diff changeset
70 target process is dead (i.e., a core file). */
a61af66fc99e Initial load
duke
parents:
diff changeset
71 public ProcessControl getProcessControl() throws DebuggerException;
a61af66fc99e Initial load
duke
parents:
diff changeset
72
a61af66fc99e Initial load
duke
parents:
diff changeset
73 /** is demangling of C++ symbols supported by this CDebugger? */
a61af66fc99e Initial load
duke
parents:
diff changeset
74 public boolean canDemangle();
a61af66fc99e Initial load
duke
parents:
diff changeset
75
a61af66fc99e Initial load
duke
parents:
diff changeset
76 /** Demangle C++ symbols into readable strings, if possible.
a61af66fc99e Initial load
duke
parents:
diff changeset
77 otherwise returns the input symbol back. */
a61af66fc99e Initial load
duke
parents:
diff changeset
78 public String demangle(String sym) throws UnsupportedOperationException;
a61af66fc99e Initial load
duke
parents:
diff changeset
79 }