include/remote-sim.h

   1 /* This file defines the interface between the simulator and gdb.
   2    Copyright (C) 1993, 1994, 1996, 1997 Free Software Foundation, Inc.
   3
   4 This file is part of GDB.
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  19
  20 #if !defined (REMOTE_SIM_H)
  21 #define REMOTE_SIM_H 1
  22
  23 /* This file is used when building stand-alone simulators, so isolate this
  24    file from gdb.  */
  25
  26 /* Pick up CORE_ADDR_TYPE if defined (from gdb), otherwise use same value as
  27    gdb does (unsigned int - from defs.h).  */
  28
  29 #ifndef CORE_ADDR_TYPE
  30 typedef unsigned int SIM_ADDR;
  31 #else
  32 typedef CORE_ADDR_TYPE SIM_ADDR;
  33 #endif
  34
  35
  36 /* Semi-opaque type used as result of sim_open and passed back to all
  37    other routines.  "desc" is short for "descriptor".
  38    It is up to each simulator to define `sim_state'.  */
  39
  40 typedef struct sim_state *SIM_DESC;
  41
  42
  43 /* Values for `kind' arg to sim_open.  */
  44
  45 typedef enum {
  46   SIM_OPEN_STANDALONE, /* simulator used standalone (run.c) */
  47   SIM_OPEN_DEBUG       /* simulator used by debugger (gdb) */
  48 } SIM_OPEN_KIND;
  49
  50
  51 /* Return codes from various functions.  */
  52
  53 typedef enum {
  54   SIM_RC_FAIL = 0,
  55   SIM_RC_OK = 1,
  56   SIM_RC_UNKNOWN_BREAKPOINT = 2,
  57   SIM_RC_INSUFFICIENT_RESOURCES = 3,
  58   SIM_RC_DUPLICATE_BREAKPOINT = 4
  59 } SIM_RC;
  60
  61
  62 /* The bfd struct, as an opaque type.  */
  63
  64 struct _bfd;
  65
  66
  67 /* Main simulator entry points.  */
  68
  69
  70 /* Create a fully initialized simulator instance.
  71
  72    (This function is called when the simulator is selected from the
  73    gdb command line.)
  74
  75    KIND specifies how the simulator shall be used.  Currently there
  76    are only two kinds: stand-alone and debug.
  77
  78    CALLBACK specifies a standard host callback (defined in callback.h).
  79
  80    ABFD, when non NULL, designates a target program.  The program is
  81    not loaded.
  82
  83    ARGV is a standard ARGV pointer such as that passed from the
  84    command line.  The syntax of the argument list is is assumed to be
  85    ``SIM-PROG { SIM-OPTION } [ TARGET-PROGRAM { TARGET-OPTION } ]''.
  86    The trailing TARGET-PROGRAM and args are only valid for a
  87    stand-alone simulator.
  88
  89    On success, the result is a non NULL descriptor that shall be
  90    passed to the other sim_foo functions.  While the simulator
  91    configuration can be parameterized by (in decreasing precedence)
  92    ARGV's SIM-OPTION, ARGV's TARGET-PROGRAM and the ABFD argument, the
  93    successful creation of the simulator shall not dependent on the
  94    presence of any of these arguments/options.
  95
  96    Hardware simulator: The created simulator shall be sufficiently
  97    initialized to handle, with out restrictions any client requests
  98    (including memory reads/writes, register fetch/stores and a
  99    resume).
 100
 101    Process simulator: that process is not created until a call to
 102    sim_create_inferior.  FIXME: What should the state of the simulator
 103    be? */
 104
 105 SIM_DESC sim_open PARAMS ((SIM_OPEN_KIND kind, struct host_callback_struct *callback, struct _bfd *abfd, char **argv));
 106
 107
 108 /* Destory a simulator instance.
 109
 110    QUITTING is non-zero if we cannot hang on errors.
 111
 112    This may involve freeing target memory and closing any open files
 113    and mmap'd areas.  You cannot assume sim_kill has already been
 114    called. */
 115
 116 void sim_close PARAMS ((SIM_DESC sd, int quitting));
 117
 118
 119 /* Load program PROG into the simulators memory.
 120
 121    If ABFD is non-NULL, the bfd for the file has already been opened.
 122    The result is a return code indicating success.
 123
 124    Hardware simulator: A call to this function should not effect the
 125    state of the processor registers.  Multiple calls to this function
 126    are permitted and have an accumulative effect.
 127
 128    Process simulator: Calls to this function may be ignored.
 129
 130    FIXME: Some hardware targets, before a loaded program can be
 131    executed, require the manipulation of VM registers and tables.
 132    Such manipulation should probably (?) occure in
 133    sim_create_inferior. */
 134
 135 SIM_RC sim_load PARAMS ((SIM_DESC sd, char *prog, struct _bfd *abfd, int from_tty));
 136
 137
 138 /* Prepare to run the simulated program.
 139
 140    ABFD, if not NULL, provides initial processor state information.
 141    ARGV and ENV, if non NULL, are NULL terminated lists of pointers.
 142
 143    Hardware simulator: This function shall initialize the processor
 144    registers to a known value.  The program counter and possibly stack
 145    pointer shall be set using information obtained from ABFD (or
 146    hardware reset defaults).  ARGV and ENV, dependant on the target
 147    ABI, may be written to memory.
 148
 149    Process simulator: After a call to this function, a new process
 150    instance shall exist. The TEXT, DATA, BSS and stack regions shall
 151    all be initialized, ARGV and ENV shall be written to process
 152    address space (according to the applicable ABI) and the program
 153    counter and stack pointer set accordingly. */
 154
 155 SIM_RC sim_create_inferior PARAMS ((SIM_DESC sd, struct _bfd *abfd, char **argv, char **env));
 156
 157
 158 /* Read LENGTH bytes of the simulated program's memory and store in
 159    BUF.  Result is number of bytes read, or zero if error.  */
 160
 161 int sim_read PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length));
 162
 163
 164 /* Store LENGTH bytes from BUF in the simulated program's memory.
 165    Result is number of bytes write, or zero if error.  */
 166
 167 int sim_write PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length));
 168
 169
 170 /* Fetch register REGNO and store the raw (target endian) value in
 171    BUF.  */
 172
 173 void sim_fetch_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf));
 174
 175
 176 /* Store register REGNO from the raw (target endian) value in BUF.  */
 177
 178 void sim_store_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf));
 179
 180
 181 /* Print whatever statistics the simulator has collected.
 182
 183    VERBOSE is currently unused and must always be zero.  */
 184
 185 void sim_info PARAMS ((SIM_DESC sd, int verbose));
 186
 187
 188 /* Run (or resume) the simulated program.  */
 189
 190 void sim_resume PARAMS ((SIM_DESC sd, int step, int siggnal));
 191
 192
 193 /* Asynchronous request to stop the simulation.
 194    A nonzero return indicates that the simulator is able to handle
 195    the request */
 196
 197 int sim_stop PARAMS ((SIM_DESC sd));
 198
 199
 200 /* Fetch the REASON why the program stopped.
 201
 202    SIM_EXITED: The program has terminated. SIGRC indicates the target
 203    dependant exit status.
 204
 205    SIM_STOPPED: The program has stopped.  SIGRC indicates the reason:
 206    program interrupted by user via a sim_stop request (SIGINT); a
 207    breakpoint instruction (SIGTRAP); a completed step (SIGTRAP); an
 208    internal error condition (SIGABRT).
 209
 210    SIM_SIGNALLED: The simulator encountered target code that requires
 211    the signal SIGRC to be delivered to the simulated program.
 212
 213    SIM_RUNNING, SIM_POLLING: The return of one of these values
 214    indicates a problem internal to the simulator. */
 215
 216 enum sim_stop { sim_running, sim_polling, sim_exited, sim_stopped, sim_signalled };
 217
 218 void sim_stop_reason PARAMS ((SIM_DESC sd, enum sim_stop *reason, int *sigrc));
 219
 220
 221 /* Passthru for other commands that the simulator might support.
 222    Simulators should be prepared to deal with any combination of NULL
 223    or empty CMD. */
 224
 225 void sim_do_command PARAMS ((SIM_DESC sd, char *cmd));
 226
 227 /* Call these functions to set and clear breakpoints at ADDR. */
 228
 229 SIM_RC sim_set_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr));
 230 SIM_RC sim_clear_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr));
 231 SIM_RC sim_clear_all_breakpoints PARAMS ((SIM_DESC sd));
 232
 233 /* These functions are used to enable and disable breakpoints. */
 234
 235 SIM_RC sim_enable_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr));
 236 SIM_RC sim_disable_breakpoint PARAMS ((SIM_DESC sd, SIM_ADDR addr));
 237 SIM_RC sim_enable_all_breakpoints PARAMS ((SIM_DESC sd));
 238 SIM_RC sim_disable_all_breakpoints PARAMS ((SIM_DESC sd));
 239 \f
 240
 241 /* Provide simulator with a default (global) host_callback_struct.
 242    THIS PROCEDURE IS DEPRECIATED.
 243    GDB and NRUN do not use this interface.
 244    This procedure does not take a SIM_DESC argument as it is
 245    used before sim_open. */
 246
 247 void sim_set_callbacks PARAMS ((struct host_callback_struct *));
 248
 249
 250 /* Set the size of the simulator memory array.
 251    THIS PROCEDURE IS DEPRECIATED.
 252    GDB and NRUN do not use this interface.
 253    This procedure does not take a SIM_DESC argument as it is
 254    used before sim_open. */
 255
 256 void sim_size PARAMS ((int i));
 257
 258
 259 /* Run a simulation with tracing enabled.
 260    THIS PROCEDURE IS DEPRECIATED.
 261    GDB and NRUN do not use this interface.
 262    This procedure does not take a SIM_DESC argument as it is
 263    used before sim_open. */
 264
 265 int sim_trace PARAMS ((SIM_DESC sd));
 266
 267
 268 /* Configure the size of the profile buffer.
 269    THIS PROCEDURE IS DEPRECIATED.
 270    GDB and NRUN do not use this interface.
 271    This procedure does not take a SIM_DESC argument as it is
 272    used before sim_open. */
 273
 274 void sim_set_profile_size PARAMS ((int n));
 275
 276
 277 /* Kill the running program.
 278    THIS PROCEDURE IS DEPRECIATED.
 279    GDB and NRUN do not use this interface.
 280    This procedure will be replaced as part of the introduction of
 281    multi-cpu simulators. */
 282
 283 void sim_kill PARAMS ((SIM_DESC sd));
 284
 285 #endif /* !defined (REMOTE_SIM_H) */