/*

 * Copyright (c) 2002, 2008, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 *

 */

package sun.jvm.hotspot.debugger.linux;

import java.util.List;

import sun.jvm.hotspot.debugger.*;

import sun.jvm.hotspot.debugger.cdbg.*;

/** An extension of the JVMDebugger interface with a few additions to

    support 32-bit vs. 64-bit debugging as well as features required

    by the architecture-specific subpackages. */

public interface LinuxDebugger extends JVMDebugger {

  public String       addressValueToString(long address) throws DebuggerException;

  public boolean      readJBoolean(long address) throws DebuggerException;

  public byte         readJByte(long address) throws DebuggerException;

  public char         readJChar(long address) throws DebuggerException;

  public double       readJDouble(long address) throws DebuggerException;

  public float        readJFloat(long address) throws DebuggerException;

  public int          readJInt(long address) throws DebuggerException;

  public long         readJLong(long address) throws DebuggerException;

  public short        readJShort(long address) throws DebuggerException;

  public long         readCInteger(long address, long numBytes, boolean isUnsigned)

    throws DebuggerException;

  public LinuxAddress readAddress(long address) throws DebuggerException;

  public LinuxAddress readCompOopAddress(long address) throws DebuggerException;

  public LinuxAddress readCompKlassAddress(long address) throws DebuggerException;

  public LinuxOopHandle readOopHandle(long address) throws DebuggerException;

  public LinuxOopHandle readCompOopHandle(long address) throws DebuggerException;

  public long[]       getThreadIntegerRegisterSet(int lwp_id) throws DebuggerException;

  public long         getAddressValue(Address addr) throws DebuggerException;

  public Address      newAddress(long value) throws DebuggerException;

  // For LinuxCDebugger

  public List         getThreadList();

  public List         getLoadObjectList();

  public ClosestSymbol lookup(long address);

  // NOTE: this interface implicitly contains the following methods:

  // From the Debugger interface via JVMDebugger

  //   public void attach(int processID) throws DebuggerException;

  //   public void attach(String executableName, String coreFileName) throws DebuggerException;

  //   public boolean detach();

  //   public Address parseAddress(String addressString) throws NumberFormatException;

  //   public String getOS();

  //   public String getCPU();

  // From the SymbolLookup interface via Debugger and JVMDebugger

  //   public Address lookup(String objectName, String symbol);

  //   public OopHandle lookupOop(String objectName, String symbol);

  // From the JVMDebugger interface

  //   public void configureJavaPrimitiveTypeSizes(long jbooleanSize,

  //                                               long jbyteSize,

  //                                               long jcharSize,

  //                                               long jdoubleSize,

  //                                               long jfloatSize,

  //                                               long jintSize,

  //                                               long jlongSize,

  //                                               long jshortSize);

  // From the ThreadAccess interface via Debugger and JVMDebugger

  //   public ThreadProxy getThreadForIdentifierAddress(Address addr);

}