* remote-sim.c (simulator_command): Add comment about dealing with
[binutils-gdb.git] / gdb / remote-sim.c
index 813f2128149676bffa0b66fa721175d4cf15370b..339b39cc1a276a93e885066b039656421646592e 100644 (file)
@@ -1,5 +1,5 @@
 /* Generic remote debugging interface for simulators.
-   Copyright 1993, 1994 Free Software Foundation, Inc.
+   Copyright 1993, 1994, 1996, 1997 Free Software Foundation, Inc.
    Contributed by Cygnus Support.
    Steve Chamberlain (sac@cygnus.com).
 
@@ -32,13 +32,71 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
 #include "terminal.h"
 #include "target.h"
 #include "gdbcore.h"
+#include "callback.h"
 #include "remote-sim.h"
 #include "remote-utils.h"
 
+/* Prototypes */
+
+static void dump_mem PARAMS ((char *buf, int len));
+
+static void init_callbacks PARAMS ((void));
+
+static void end_callbacks PARAMS ((void));
+
+static int gdb_os_write_stdout PARAMS ((host_callback *, const char *, int));
+
+static void gdb_os_flush_stdout PARAMS ((host_callback *));
+
+static int gdb_os_write_stderr PARAMS ((host_callback *, const char *, int));
+
+static void gdb_os_flush_stderr PARAMS ((host_callback *));
+
+/* printf_filtered is depreciated */
+static void gdb_os_printf_filtered PARAMS ((host_callback *, const char *, ...));
+
+static void gdb_os_vprintf_filtered PARAMS ((host_callback *, const char *, void *));
+
+static void gdb_os_evprintf_filtered PARAMS ((host_callback *, const char *, void *));
+
+static void gdb_os_error PARAMS ((host_callback *, const char *, ...));
+
+static void gdbsim_fetch_register PARAMS ((int regno));
+
+static void gdbsim_store_register PARAMS ((int regno));
+
+static void gdbsim_kill PARAMS ((void));
+
+static void gdbsim_load PARAMS ((char *prog, int fromtty));
+
+static void gdbsim_create_inferior PARAMS ((char *exec_file, char *args, char **env));
+
+static void gdbsim_open PARAMS ((char *args, int from_tty));
+
+static void gdbsim_close PARAMS ((int quitting));
+
+static void gdbsim_detach PARAMS ((char *args, int from_tty));
+
+static void gdbsim_resume PARAMS ((int pid, int step, enum target_signal siggnal));
+
+static int gdbsim_wait PARAMS ((int pid, struct target_waitstatus *status));
+
+static void gdbsim_prepare_to_store PARAMS ((void));
+
+static int gdbsim_xfer_inferior_memory PARAMS ((CORE_ADDR memaddr,
+                                               char *myaddr, int len,
+                                               int write,
+                                               struct target_ops *target));
+
+static void gdbsim_files_info PARAMS ((struct target_ops *target));
+
+static void gdbsim_mourn_inferior PARAMS ((void));
+
+static void simulator_command PARAMS ((char *args, int from_tty));
+
 /* Naming convention:
 
    sim_* are the interface to the simulator (see remote-sim.h).
-
    gdbsim_* are stuff which is internal to gdb.  */
 
 /* Forward data declarations */
@@ -46,6 +104,12 @@ extern struct target_ops gdbsim_ops;
 
 static int program_loaded = 0;
 
+/* We must keep track of whether the simulator has been opened or not because
+   GDB can call a target's close routine twice, but sim_close doesn't allow
+   this.  We also need to record the result of sim_open so we can pass it
+   back to the other sim_foo routines.  */
+static SIM_DESC gdbsim_desc = 0;
+
 static void
 dump_mem (buf, len)
      char *buf;
@@ -71,6 +135,200 @@ dump_mem (buf, len)
     }
 }
 
+static host_callback gdb_callback;
+static int callbacks_initialized = 0;
+
+/* Initialize gdb_callback.  */
+
+static void
+init_callbacks ()
+{
+  if (! callbacks_initialized)
+    {
+      gdb_callback = default_callback;
+      gdb_callback.init (&gdb_callback);
+      gdb_callback.write_stdout = gdb_os_write_stdout;
+      gdb_callback.flush_stdout = gdb_os_flush_stdout;
+      gdb_callback.write_stderr = gdb_os_write_stderr;
+      gdb_callback.flush_stderr = gdb_os_flush_stderr;
+      gdb_callback.printf_filtered = gdb_os_printf_filtered;
+      gdb_callback.vprintf_filtered = gdb_os_vprintf_filtered;
+      gdb_callback.evprintf_filtered = gdb_os_evprintf_filtered;
+      gdb_callback.error = gdb_os_error;
+      sim_set_callbacks (gdbsim_desc, &gdb_callback);
+      callbacks_initialized = 1;
+    }
+}
+
+/* Release callbacks (free resources used by them).  */
+
+static void
+end_callbacks ()
+{
+  if (callbacks_initialized)
+    {
+      gdb_callback.shutdown (&gdb_callback);
+      callbacks_initialized = 0;
+    }
+}
+
+/* GDB version of os_write_stdout callback.  */
+
+static int 
+gdb_os_write_stdout (p, buf, len)
+     host_callback *p;
+     const char *buf;
+     int len;
+{
+  int i;
+  char b[2];
+
+  for (i = 0; i < len; i++) 
+    {
+      b[0] = buf[i];
+      b[1] = 0;
+      if (target_output_hook)
+       target_output_hook (b);
+      else
+       fputs_filtered (b, gdb_stdout);
+    }
+  return len;
+}
+
+/* GDB version of os_flush_stdout callback.  */
+
+static void
+gdb_os_flush_stdout (p)
+     host_callback *p;
+{
+  gdb_flush (gdb_stdout);
+}
+
+/* GDB version of os_write_stderr callback.  */
+
+static int 
+gdb_os_write_stderr (p, buf, len)
+     host_callback *p;
+     const char *buf;
+     int len;
+{
+  int i;
+  char b[2];
+
+  for (i = 0; i < len; i++) 
+    {
+      b[0] = buf[i];
+      b[1] = 0;
+      if (target_output_hook)
+       target_output_hook (b);
+      else
+       fputs_filtered (b, gdb_stderr);
+    }
+  return len;
+}
+
+/* GDB version of os_flush_stderr callback.  */
+
+static void
+gdb_os_flush_stderr (p)
+     host_callback *p;
+{
+  gdb_flush (gdb_stderr);
+}
+
+/* GDB version of printf_filtered callback.  */
+
+/* VARARGS */
+static void
+#ifdef ANSI_PROTOTYPES
+gdb_os_printf_filtered (host_callback *p, const char *format, ...)
+#else
+gdb_os_printf_filtered (p, va_alist)
+     host_callback *p;
+     va_dcl
+#endif
+{
+  va_list args;
+#ifdef ANSI_PROTOTYPES
+  va_start (args, format);
+#else
+  char *format;
+
+  va_start (args);
+  format = va_arg (args, char *);
+#endif
+
+  vfprintf_filtered (gdb_stdout, format, args);
+
+  va_end (args);
+}
+
+/* GDB version of error vprintf_filtered.  */
+
+/* VARARGS */
+static void
+#ifdef ANSI_PROTOTYPES
+gdb_os_vprintf_filtered (host_callback *p, const char *format, void *ap)
+#else
+gdb_os_vprintf_filtered (p, format, ap)
+     host_callback *p;
+     char *format;
+     void *ap;
+#endif
+{
+  vfprintf_filtered (gdb_stdout, format, (va_list)ap);
+}
+
+/* GDB version of error evprintf_filtered.  */
+
+/* VARARGS */
+static void
+#ifdef ANSI_PROTOTYPES
+gdb_os_evprintf_filtered (host_callback *p, const char *format, void *ap)
+#else
+gdb_os_evprintf_filtered (p, format, ap)
+     host_callback *p;
+     char *format;
+     void *ap;
+#endif
+{
+  vfprintf_filtered (gdb_stderr, format, (va_list)ap);
+}
+
+/* GDB version of error callback.  */
+
+/* VARARGS */
+static void
+#ifdef ANSI_PROTOTYPES
+gdb_os_error (host_callback *p, const char *format, ...)
+#else
+gdb_os_error (p, va_alist)
+     host_callback *p;
+     va_dcl
+#endif
+{
+  if (error_hook)
+    (*error_hook) ();
+  else 
+    {
+      va_list args;
+#ifdef ANSI_PROTOTYPES
+      va_start (args, format);
+#else
+      char *format;
+
+      va_start (args);
+      format = va_arg (args, char *);
+#endif
+
+      error_begin ();
+      vfprintf_filtered (gdb_stderr, format, args);
+      fprintf_filtered (gdb_stderr, "\n");
+      va_end (args);
+      return_to_top_level (RETURN_ERROR);
+    }
+}
+
 static void
 gdbsim_fetch_register (regno)
 int regno;
@@ -84,7 +342,7 @@ int regno;
     {
       char buf[MAX_REGISTER_RAW_SIZE];
 
-      sim_fetch_register (regno, buf);
+      sim_fetch_register (gdbsim_desc, regno, buf);
       supply_register (regno, buf);
       if (sr_get_debug ())
        {
@@ -95,6 +353,7 @@ int regno;
     }
 }
 
+
 static void
 gdbsim_store_register (regno)
 int regno;
@@ -109,7 +368,7 @@ int regno;
       /* FIXME: Until read_register() returns LONGEST, we have this.  */
       char tmp[MAX_REGISTER_RAW_SIZE];
       read_register_gen (regno, tmp);
-      sim_store_register (regno, tmp);
+      sim_store_register (gdbsim_desc, regno, tmp);
       if (sr_get_debug ())
        {
          printf_filtered ("gdbsim_store_register: %d", regno);
@@ -128,7 +387,7 @@ gdbsim_kill ()
   if (sr_get_debug ())
     printf_filtered ("gdbsim_kill\n");
 
-  sim_kill (); /* close fd's, remove mappings */
+  sim_kill (gdbsim_desc);      /* close fd's, remove mappings, etc. */
   inferior_pid = 0;
 }
 
@@ -149,14 +408,14 @@ gdbsim_load (prog, fromtty)
   /* This must be done before calling gr_load_image.  */
   program_loaded = 1;
 
-  if (sim_load (prog, fromtty) != 0)
-    gr_load_image (prog, fromtty);
+  if (sim_load (gdbsim_desc, prog, fromtty) != 0)
+    generic_load (prog, fromtty);
 }
 
 
 /* Start an inferior process and set inferior_pid to its pid.
    EXEC_FILE is the file to run.
-   ALLARGS is a string containing the arguments to the program.
+   ARGS is a string containing the arguments to the program.
    ENV is the environment vector to pass.  Errors reported with error().
    On VxWorks and various standalone systems, we ignore exec_file.  */
 /* This is called not only when we first attach, but also when the
@@ -184,11 +443,11 @@ gdbsim_create_inferior (exec_file, args, env)
 
   entry_pt = (CORE_ADDR) bfd_get_start_address (exec_bfd);
 
-  gdbsim_kill (NULL, NULL);     
+  gdbsim_kill ();       
   remove_breakpoints ();
   init_wait_for_inferior ();
 
-  len = 5 + strlen (exec_file) + 1 + strlen (args) + 1 + /*slop*/ 10;
+  len = strlen (exec_file) + 1 + strlen (args) + 1 + /*slop*/ 10;
   arg_buf = (char *) alloca (len);
   arg_buf[0] = '\0';
   strcat (arg_buf, exec_file);
@@ -196,7 +455,7 @@ gdbsim_create_inferior (exec_file, args, env)
   strcat (arg_buf, args);
   argv = buildargv (arg_buf);
   make_cleanup (freeargv, (char *) argv);
-  sim_create_inferior (entry_pt, argv, env);
+  sim_create_inferior (gdbsim_desc, entry_pt, argv, env);
 
   inferior_pid = 42;
   insert_breakpoints ();       /* Needed to get correct instruction in cache */
@@ -213,14 +472,43 @@ gdbsim_open (args, from_tty)
      char *args;
      int from_tty;
 {
+  int len;
+  char *arg_buf;
+  char **argv;
+
   if (sr_get_debug ())
     printf_filtered ("gdbsim_open: args \"%s\"\n", args ? args : "(null)");
 
-  sim_open (args);
+  /* Remove current simulator if one exists.  Only do this if the simulator
+     has been opened because sim_close requires it.
+     This is important because the call to push_target below will cause
+     sim_close to be called if the simulator is already open, but push_target
+     is called after sim_open!  We can't move the call to push_target before
+     the call to sim_open because sim_open may invoke `error'.  */
+  if (gdbsim_desc != NULL)
+    unpush_target (&gdbsim_ops);
+
+  init_callbacks ();
+
+  len = 7 + 1 + (args ? strlen (args) : 0) + 1 + /*slop*/ 10;
+  arg_buf = (char *) alloca (len);
+  strcpy (arg_buf, "gdbsim");
+  if (args)
+    {
+      strcat (arg_buf, " ");
+      strcat (arg_buf, args);
+    }
+  argv = buildargv (arg_buf);
+  if (argv == NULL)
+    error ("Insufficient memory available to allocate simulator arg list.");
+  make_cleanup (freeargv, (char *) argv);
+
+  /* FIXME: sim_open may call `error' if it fails, but perhaps it should
+     just return an error indicator and let us call `error'.  */
+  gdbsim_desc = sim_open (argv);
 
   push_target (&gdbsim_ops);
   target_fetch_registers (-1);
-
   printf_filtered ("Connected to the simulator.\n");
 }
 
@@ -242,7 +530,13 @@ gdbsim_close (quitting)
 
   program_loaded = 0;
 
-  sim_close (quitting);
+  if (gdbsim_desc != NULL)
+    {
+      sim_close (gdbsim_desc, quitting);
+      gdbsim_desc = NULL;
+    }
+
+  end_callbacks ();
 }
 
 /* Takes a program previously attached to and detaches it.
@@ -276,10 +570,13 @@ gdbsim_resume (pid, step, siggnal)
      int pid, step;
      enum target_signal siggnal;
 {
+  if (inferior_pid != 42)
+    error ("The program is not being run.");
+
   if (sr_get_debug ())
     printf_filtered ("gdbsim_resume: step %d, signal %d\n", step, siggnal);
 
-  sim_resume (step, target_signal_to_host (siggnal));
+  sim_resume (gdbsim_desc, step, target_signal_to_host (siggnal));
 }
 
 /* Wait for inferior process to do something.  Return pid of child,
@@ -297,7 +594,7 @@ gdbsim_wait (pid, status)
   if (sr_get_debug ())
     printf_filtered ("gdbsim_wait\n");
 
-  sim_stop_reason (&reason, &sigrc);
+  sim_stop_reason (gdbsim_desc, &reason, &sigrc);
   switch (reason)
     {
     case sim_exited:
@@ -354,11 +651,11 @@ gdbsim_xfer_inferior_memory (memaddr, myaddr, len, write, target)
 
   if (write)
     {
-      len = sim_write (memaddr, myaddr, len);
+      len = sim_write (gdbsim_desc, memaddr, myaddr, len);
     }
   else 
     {
-      len = sim_read (memaddr, myaddr, len);
+      len = sim_read (gdbsim_desc, memaddr, myaddr, len);
       if (sr_get_debug () && len > 0)
        dump_mem(myaddr, len);
     } 
@@ -381,7 +678,7 @@ gdbsim_files_info (target)
     {
       printf_filtered ("\tAttached to %s running program %s\n",
                       target_shortname, file);
-      sim_info (0);
+      sim_info (gdbsim_desc, 0);
     }
 }
 
@@ -397,16 +694,24 @@ gdbsim_mourn_inferior ()
   generic_mourn_inferior ();
 }
 
-/* Put a command string, in args, out to MONITOR.  Output from MONITOR
-   is placed on the users terminal until the prompt is seen. FIXME: We
-   read the characters ourseleves here cause of a nasty echo.  */
+/* Pass the command argument through to the simulator verbatim.  The
+   simulator must do any command interpretation work.  */
 
 static void
 simulator_command (args, from_tty)
      char *args;
      int from_tty;
 {
-  sim_do_command (args);
+  /* The user may give a command before the simulator is opened, so
+     ensure that the callbacks have been set up.  */
+  init_callbacks ();
+
+  /* Note that if the simulator hasn't been opened, gdbsim_desc == NULL
+     which is correct (??? assuming of course one wishes to continue to
+     allow commands to be sent to unopened simulators, which isn't entirely
+     unreasonable).  Simulators should be prepared to deal with any
+     combination of NULL or empty args. */
+  sim_do_command (gdbsim_desc, args);
 }
 
 /* Define the target subroutine names */