1 /*
   2  * Copyright 2002-2008 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  *
  23  */
  24 
  25 package sun.jvm.hotspot.debugger.remote;
  26 
  27 import java.rmi.*;
  28 
  29 import sun.jvm.hotspot.debugger.*;
  30 
  31 /** <P> This interface describes the methods which are used in a
  32     remote debugging scenario. It is only necessary because RMI
  33     requires that all such methods throw RemoteException, which is a
  34     checked (i.e., not a Runtime) exception. Since we already have a
  35     suitable runtime exception (DebuggerException) present in the
  36     signatures for all of the debugger-related methods, we would like
  37     to repurpose this to wrap RemoteExceptions. This is done by
  38     wrapping the actual remote debugger object
  39     </P>
  40 
  41     <P> NOTE that this interface currently assumes that the debugger
  42     on the remote machine has already been attached to the target
  43     process or has opened the desired core file. This implies that the
  44     machine hosting the user interface can not effect
  45     attaching/detaching. Currently this restriction has been enforced
  46     to make the user interface less confusing, but there will also be
  47     security concerns with allowing clients to attach to arbitrary
  48     remote processes. </P>
  49 */
  50 
  51 public interface RemoteDebugger extends Remote {
  52   public String    getOS() throws RemoteException;
  53   public String    getCPU() throws RemoteException;
  54   public MachineDescription getMachineDescription() throws RemoteException;
  55   public long      lookupInProcess(String objectName, String symbol) throws RemoteException;
  56   public ReadResult readBytesFromProcess(long address, long numBytes) throws RemoteException;
  57   public boolean   hasConsole() throws RemoteException;
  58   public String    getConsolePrompt() throws RemoteException;
  59   public String    consoleExecuteCommand(String cmd) throws RemoteException;
  60   public long      getJBooleanSize() throws RemoteException;
  61   public long      getJByteSize() throws RemoteException;
  62   public long      getJCharSize() throws RemoteException;
  63   public long      getJDoubleSize() throws RemoteException;
  64   public long      getJFloatSize() throws RemoteException;
  65   public long      getJIntSize() throws RemoteException;
  66   public long      getJLongSize() throws RemoteException;
  67   public long      getJShortSize() throws RemoteException;
  68   public long      getHeapBase() throws RemoteException;
  69   public long      getHeapOopSize() throws RemoteException;
  70   public long      getLogMinObjAlignmentInBytes() throws RemoteException;
  71   public boolean   areThreadsEqual(long addrOrId1, boolean isAddress1,
  72                                    long addrOrId2, boolean isAddress2) throws RemoteException;
  73   public int       getThreadHashCode(long addrOrId, boolean isAddress) throws RemoteException;
  74   public long[]    getThreadIntegerRegisterSet(long addrOrId, boolean isAddress) throws RemoteException;
  75 }