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 /* Semi-opaque type used as result of sim_open and passed back to all
  36    other routines.  "desc" is short for "descriptor".
  37    It is up to each simulator to define `sim_state'.  */
  38
  39 typedef struct sim_state *SIM_DESC;
  40
  41 /* Values for `kind' arg to sim_open.  */
  42 typedef enum {
  43   SIM_OPEN_STANDALONE, /* simulator used standalone (run.c) */
  44   SIM_OPEN_DEBUG       /* simulator used by debugger (gdb) */
  45 } SIM_OPEN_KIND;
  46
  47 /* Return codes from various functions.  */
  48 typedef enum {
  49   SIM_RC_FAIL = 0,
  50   SIM_RC_OK = 1
  51 } SIM_RC;
  52
  53 /* The bfd struct, as an opaque type.  */
  54 struct _bfd;
  55
  56 /* Main simulator entry points.  */
  57
  58 /* Initialize the simulator.  This function is called when the simulator
  59    is selected from the gdb command line.
  60    KIND specifies how the simulator will be used.  Currently there are only
  61    two kinds: standalone and debug.
  62    ARGV is passed from the command line and can be used to select whatever
  63    run time options the simulator provides.  It is the standard NULL
  64    terminated array of pointers, with argv[0] being the program name.
  65    The result is a descriptor that must be passed back to the other sim_foo
  66    functions.  */
  67
  68 SIM_DESC sim_open PARAMS ((SIM_OPEN_KIND kind, char **argv));
  69
  70 /* Terminate usage of the simulator.  This may involve freeing target memory
  71    and closing any open files and mmap'd areas.  You cannot assume sim_kill
  72    has already been called.
  73    QUITTING is non-zero if we cannot hang on errors.  */
  74
  75 void sim_close PARAMS ((SIM_DESC sd, int quitting));
  76
  77 /* Load program PROG into the simulator.
  78    If ABFD is non-NULL, the bfd for the file has already been opened.
  79    The result is a return code indicating success.  */
  80
  81 SIM_RC sim_load PARAMS ((SIM_DESC sd, char *prog, struct _bfd *abfd, int from_tty));
  82
  83 /* Prepare to run the simulated program.
  84    ARGV and ENV are NULL terminated lists of pointers.  */
  85
  86 SIM_RC sim_create_inferior PARAMS ((SIM_DESC sd, char **argv, char **env));
  87
  88 /* Kill the running program.
  89    This may involve closing any open files and deleting any mmap'd areas.  */
  90
  91 void sim_kill PARAMS ((SIM_DESC sd));
  92
  93 /* Read LENGTH bytes of the simulated program's memory and store in BUF.
  94    Result is number of bytes read, or zero if error.  */
  95
  96 int sim_read PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length));
  97
  98 /* Store LENGTH bytes from BUF in the simulated program's memory.
  99    Result is number of bytes write, or zero if error.  */
 100
 101 int sim_write PARAMS ((SIM_DESC sd, SIM_ADDR mem, unsigned char *buf, int length));
 102
 103 /* Fetch register REGNO and store the raw value in BUF.  */
 104
 105 void sim_fetch_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf));
 106
 107 /* Store register REGNO from BUF (in raw format).  */
 108
 109 void sim_store_register PARAMS ((SIM_DESC sd, int regno, unsigned char *buf));
 110
 111 /* Print whatever statistics the simulator has collected.
 112    VERBOSE is currently unused and must always be zero.  */
 113
 114 void sim_info PARAMS ((SIM_DESC sd, int verbose));
 115
 116 /* Fetch why the program stopped.
 117    SIGRC will contain either the argument to exit() or the signal number.  */
 118
 119 enum sim_stop { sim_exited, sim_stopped, sim_signalled };
 120
 121 void sim_stop_reason PARAMS ((SIM_DESC sd, enum sim_stop *reason, int *sigrc));
 122
 123 /* Run (or resume) the program.  */
 124
 125 void sim_resume PARAMS ((SIM_DESC sd, int step, int siggnal));
 126
 127 /* Passthru for other commands that the simulator might support.
 128    If SD is NULL, the command is to be interpreted as refering to
 129    the global state, however the simulator defines that.  */
 130
 131 void sim_do_command PARAMS ((SIM_DESC sd, char *cmd));
 132
 133 /* Provide simulator with a standard host_callback_struct.
 134    If SD is NULL, the command is to be interpreted as refering to
 135    the global state, however the simulator defines that.  */
 136
 137 void sim_set_callbacks PARAMS ((SIM_DESC sd, struct host_callback_struct *));
 138
 139
 140 /* NOTE: sim_size() and sim_trace() are going away */
 141
 142 void sim_size PARAMS ((int i));
 143
 144 int sim_trace PARAMS ((SIM_DESC sd));
 145
 146
 147 #endif /* !defined (REMOTE_SIM_H) */