1 /*
2  * Copyright (c) 2002, 2021, 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.
8  *
9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  *
23  */
24 
25 package sun.jvm.hotspot.debugger.windbg;
26 
27 import java.util.List;
28 import sun.jvm.hotspot.debugger.*;
29 import sun.jvm.hotspot.debugger.cdbg.*;
30 
31 /** An extension of the JVMDebugger interface with a few additions to
32     support 32-bit vs. 64-bit debugging as well as features required
33     by the architecture-specific subpackages. */
34 
35 public interface WindbgDebugger extends JVMDebugger {
addressValueToString(long address)36   public String       addressValueToString(long address) throws DebuggerException;
readJBoolean(long address)37   public boolean      readJBoolean(long address) throws DebuggerException;
readJByte(long address)38   public byte         readJByte(long address) throws DebuggerException;
readJChar(long address)39   public char         readJChar(long address) throws DebuggerException;
readJDouble(long address)40   public double       readJDouble(long address) throws DebuggerException;
readJFloat(long address)41   public float        readJFloat(long address) throws DebuggerException;
readJInt(long address)42   public int          readJInt(long address) throws DebuggerException;
readJLong(long address)43   public long         readJLong(long address) throws DebuggerException;
readJShort(long address)44   public short        readJShort(long address) throws DebuggerException;
readCInteger(long address, long numBytes, boolean isUnsigned)45   public long         readCInteger(long address, long numBytes, boolean isUnsigned)
46     throws DebuggerException;
readAddress(long address)47   public WindbgAddress readAddress(long address) throws DebuggerException;
readCompOopAddress(long address)48   public WindbgAddress readCompOopAddress(long address) throws DebuggerException;
readCompKlassAddress(long address)49   public WindbgAddress readCompKlassAddress(long address) throws DebuggerException;
readOopHandle(long address)50   public WindbgOopHandle readOopHandle(long address) throws DebuggerException;
readCompOopHandle(long address)51   public WindbgOopHandle readCompOopHandle(long address) throws DebuggerException;
52 
53   // The returned array of register contents is guaranteed to be in
54   // the same order as in the DbxDebugger for Solaris/x86 or amd64; that is,
55   // the indices match those in debugger/x86/X86ThreadContext.java or
56   // debugger/amd64/AMD64ThreadContext.java.
getThreadIntegerRegisterSet(long threadId)57   public long[]       getThreadIntegerRegisterSet(long threadId) throws DebuggerException;
58 
getThreadIdFromSysId(long sysId)59   public long         getThreadIdFromSysId(long sysId) throws DebuggerException;
60   // Support for the CDebugger interface. Retrieves the thread list of
61   // the target process as a List of ThreadProxy objects.
getThreadList()62   public List<ThreadProxy> getThreadList() throws DebuggerException;
63 
64   // Support for the CDebugger interface. Retrieves a List of the
65   // loadobjects in the target process.
getLoadObjectList()66   public List<LoadObject> getLoadObjectList() throws DebuggerException;
67 
68   // NOTE: this interface implicitly contains the following methods:
69   // From the Debugger interface via JVMDebugger
70   //   public void attach(int processID) throws DebuggerException;
71   //   public void attach(String executableName, String coreFileName) throws DebuggerException;
72   //   public boolean detach();
73   //   public Address parseAddress(String addressString) throws NumberFormatException;
74   //   public long getAddressValue(Address addr) throws DebuggerException;
75   //   public String getOS();
76   //   public String getCPU();
77   // From the SymbolLookup interface via Debugger and JVMDebugger
78   //   public Address lookup(String objectName, String symbol);
79   //   public OopHandle lookupOop(String objectName, String symbol);
80   // From the JVMDebugger interface
81   //   public void configureJavaPrimitiveTypeSizes(long jbooleanSize,
82   //                                               long jbyteSize,
83   //                                               long jcharSize,
84   //                                               long jdoubleSize,
85   //                                               long jfloatSize,
86   //                                               long jintSize,
87   //                                               long jlongSize,
88   //                                               long jshortSize);
89   // From the ThreadAccess interface via Debugger and JVMDebugger
90   //   public ThreadProxy getThreadForIdentifierAddress(Address addr);
91 
getAddressSize()92   public int getAddressSize();
93 }
94