gdb: add target_ops::supports_displaced_step
[deliverable/binutils-gdb.git] / sim / common / sim-io.c
index 7d40ccf4960505ee9b5122d6fab7fce25d7554da..989f9cfb35a757528135a135d5d1a269a99a01eb 100644 (file)
-/*  This file is part of the program psim.
+/* The common simulator framework for GDB, the GNU Debugger.
 
-    Copyright (C) 1994-1997, Andrew Cagney <cagney@highland.com.au>
+   Copyright 2002-2020 Free Software Foundation, Inc.
 
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
+   Contributed by Andrew Cagney and Red Hat.
 
-    This program 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 for more details.
-    You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-    */
+   This file is part of GDB.
 
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
 
-#ifndef _SIM_IO_C_
-#define _SIM_IO_C_
+   This program 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 for more details.
 
-#include "engine.h"
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+
+#include "sim-main.h"
+#include "sim-io.h"
+#include "targ-vals.h"
+
+#include <errno.h>
+#if HAVE_FCNTL_H
+#include <fcntl.h>
+#endif
+
+#if HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+
+#include <stdlib.h>
+
+/* Define the rate at which the simulator should poll the host
+   for a quit. */
+#ifndef POLL_QUIT_INTERVAL
+#define POLL_QUIT_INTERVAL 0x10
+#endif
+
+static int poll_quit_count = POLL_QUIT_INTERVAL;
 
 /* See the file include/callbacks.h for a description */
 
 
-INLINE_SIM_IO(int)
-sim_io_init(engine *system)
+int
+sim_io_init (SIM_DESC sd)
 {
-  return system->callback->init (system->callback);
+  return STATE_CALLBACK (sd)->init (STATE_CALLBACK (sd));
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_shutdown(engine *system)
+int
+sim_io_shutdown (SIM_DESC sd)
 {
-  return system->callback->shutdown (system->callback);
+  return STATE_CALLBACK (sd)->shutdown (STATE_CALLBACK (sd));
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_unlink(engine *system,
-             const char *f1)
+int
+sim_io_unlink (SIM_DESC sd,
+              const char *f1)
 {
-  return system->callback->unlink (system->callback, f1);
+  return STATE_CALLBACK (sd)->unlink (STATE_CALLBACK (sd), f1);
 }
 
 
-INLINE_SIM_IO(long)
-sim_io_time(engine *system,
-           long *t)
+long
+sim_io_time (SIM_DESC sd,
+            long *t)
 {
-  return system->callback->time (system->callback, t);
+  return STATE_CALLBACK (sd)->time (STATE_CALLBACK (sd), t);
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_system(engine *system, const char *s)
+int
+sim_io_system (SIM_DESC sd, const char *s)
 {
-  return system->callback->system (system->callback, s);
+  return STATE_CALLBACK (sd)->system (STATE_CALLBACK (sd), s);
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_rename(engine *system,
-             const char *f1,
-             const char *f2)
+int
+sim_io_rename (SIM_DESC sd,
+              const char *f1,
+              const char *f2)
 {
-  return system->callback->rename (system->callback, f1, f2);
+  return STATE_CALLBACK (sd)->rename (STATE_CALLBACK (sd), f1, f2);
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_write_stdout(engine *system,
-                   const char *buf,
-                   int len)
+int
+sim_io_write_stdout (SIM_DESC sd,
+                    const char *buf,
+                    int len)
 {
   switch (CURRENT_STDIO) {
   case DO_USE_STDIO:
-    return system->callback->write_stdout (system->callback, buf, len);
+    return STATE_CALLBACK (sd)->write_stdout (STATE_CALLBACK (sd), buf, len);
     break;
   case DONT_USE_STDIO:
-    return system->callback->write (system->callback, 1, buf, len);
+    return STATE_CALLBACK (sd)->write (STATE_CALLBACK (sd), 1, buf, len);
     break;
   default:
-    sim_io_error (system, "sim_io_write_stdout: unaccounted switch\n");
+    sim_io_error (sd, "sim_io_write_stdout: unaccounted switch\n");
     break;
   }
   return 0;
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_flush_stdout(engine *system)
+void
+sim_io_flush_stdout (SIM_DESC sd)
 {
   switch (CURRENT_STDIO) {
   case DO_USE_STDIO:
-    return system->callback->flush_stdout (system->callback);
+    STATE_CALLBACK (sd)->flush_stdout (STATE_CALLBACK (sd));
     break;
   case DONT_USE_STDIO:
     break;
   default:
-    sim_io_error (system, "sim_io_flush_stdout: unaccounted switch\n");
+    sim_io_error (sd, "sim_io_flush_stdout: unaccounted switch\n");
     break;
   }
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_write_stderr(engine *system,
-                   const char *buf,
-                   int len)
+int
+sim_io_write_stderr (SIM_DESC sd,
+                    const char *buf,
+                    int len)
 {
   switch (CURRENT_STDIO) {
   case DO_USE_STDIO:
-    return system->callback->write_stderr (system->callback, buf, len);
+    return STATE_CALLBACK (sd)->write_stderr (STATE_CALLBACK (sd), buf, len);
     break;
   case DONT_USE_STDIO:
-    return system->callback->write (system->callback, 2, buf, len);
+    return STATE_CALLBACK (sd)->write (STATE_CALLBACK (sd), 2, buf, len);
     break;
   default:
-    sim_io_error (system, "sim_io_write_stderr: unaccounted switch\n");
+    sim_io_error (sd, "sim_io_write_stderr: unaccounted switch\n");
     break;
   }
   return 0;
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_flush_stderr(engine *system)
+void
+sim_io_flush_stderr (SIM_DESC sd)
 {
   switch (CURRENT_STDIO) {
   case DO_USE_STDIO:
-    return system->callback->flush_stderr (system->callback);
+    STATE_CALLBACK (sd)->flush_stderr (STATE_CALLBACK (sd));
     break;
   case DONT_USE_STDIO:
     break;
   default:
-    sim_io_error (system, "sim_io_flush_stderr: unaccounted switch\n");
+    sim_io_error (sd, "sim_io_flush_stderr: unaccounted switch\n");
     break;
   }
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_write(engine *system,
-            int fd,
-            const char *buf,
-            int len)
+int
+sim_io_write (SIM_DESC sd,
+             int fd,
+             const char *buf,
+             int len)
 {
-  return system->callback->write (system->callback, fd, buf, len);
+  return STATE_CALLBACK (sd)->write (STATE_CALLBACK (sd), fd, buf, len);
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_read_stdin(engine *system,
-                 char *buf,
-                 int len)
+int
+sim_io_read_stdin (SIM_DESC sd,
+                  char *buf,
+                  int len)
 {
   switch (CURRENT_STDIO) {
   case DO_USE_STDIO:
-    return system->callback->read_stdin (system->callback, buf, len);
+    return STATE_CALLBACK (sd)->read_stdin (STATE_CALLBACK (sd), buf, len);
     break;
   case DONT_USE_STDIO:
-    return system->callback->read (system->callback, 0, buf, len);
+    return STATE_CALLBACK (sd)->read (STATE_CALLBACK (sd), 0, buf, len);
     break;
   default:
-    sim_io_error (system, "sim_io_read_stdin: unaccounted switch\n");
+    sim_io_error (sd, "sim_io_read_stdin: unaccounted switch\n");
     break;
   }
   return 0;
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_read(engine *system, int fd,
-           char *buf,
-           int len)
+int
+sim_io_read (SIM_DESC sd, int fd,
+            char *buf,
+            int len)
 {
-  return system->callback->read(system->callback, fd, buf, len);
+  return STATE_CALLBACK (sd)->read (STATE_CALLBACK (sd), fd, buf, len);
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_open(engine *system,
-           const char *name,
-           int flags)
+int
+sim_io_open (SIM_DESC sd,
+            const char *name,
+            int flags)
 {
-  return system->callback->open (system->callback, name, flags);
+  return STATE_CALLBACK (sd)->open (STATE_CALLBACK (sd), name, flags);
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_lseek(engine *system,
-            int fd,
-            long off,
-            int way)
+int
+sim_io_lseek (SIM_DESC sd,
+             int fd,
+             long off,
+             int way)
 {
-  return system->callback->lseek (system->callback, fd, off, way);
+  return STATE_CALLBACK (sd)->lseek (STATE_CALLBACK (sd), fd, off, way);
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_isatty(engine *system,
-             int fd)
+int
+sim_io_isatty (SIM_DESC sd,
+              int fd)
 {
-  return system->callback->isatty (system->callback, fd);
+  return STATE_CALLBACK (sd)->isatty (STATE_CALLBACK (sd), fd);
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_get_errno(engine *system)
+int
+sim_io_get_errno (SIM_DESC sd)
 {
-  return system->callback->get_errno (system->callback);
+  return STATE_CALLBACK (sd)->get_errno (STATE_CALLBACK (sd));
 }
 
 
-INLINE_SIM_IO(int)
-sim_io_close(engine *system,
-            int fd)
+int
+sim_io_close (SIM_DESC sd,
+             int fd)
 {
-  return system->callback->close (system->callback, fd);
+  return STATE_CALLBACK (sd)->close (STATE_CALLBACK (sd), fd);
 }
 
 
-INLINE_SIM_IO(void)
-sim_io_printf(engine *system,
-             const char *fmt,
-             ...)
+void
+sim_io_printf (SIM_DESC sd,
+              const char *fmt,
+              ...)
 {
   va_list ap;
-  va_start(ap, fmt);
-  system->callback->vprintf_filtered (system->callback, fmt, ap);
-  va_end(ap);
+  va_start (ap, fmt);
+  STATE_CALLBACK (sd)->vprintf_filtered (STATE_CALLBACK (sd), fmt, ap);
+  va_end (ap);
 }
 
 
-INLINE_SIM_IO(void)
-sim_io_vprintf(engine *system,
-              const char *fmt,
-              va_list ap)
+void
+sim_io_vprintf (SIM_DESC sd,
+               const char *fmt,
+               va_list ap)
 {
-  system->callback->vprintf_filtered (system->callback, fmt, ap);
+  STATE_CALLBACK (sd)->vprintf_filtered (STATE_CALLBACK (sd), fmt, ap);
 }
 
 
-INLINE_SIM_IO(void)
-sim_io_eprintf(engine *system,
-             const char *fmt,
-             ...)
+void
+sim_io_eprintf (SIM_DESC sd,
+              const char *fmt,
+              ...)
 {
   va_list ap;
-  va_start(ap, fmt);
-  system->callback->evprintf_filtered (system->callback, fmt, ap);
-  va_end(ap);
+  va_start (ap, fmt);
+  STATE_CALLBACK (sd)->evprintf_filtered (STATE_CALLBACK (sd), fmt, ap);
+  va_end (ap);
 }
 
 
-INLINE_SIM_IO(void)
-sim_io_evprintf(engine *system,
-               const char *fmt,
-               va_list ap)
+void
+sim_io_evprintf (SIM_DESC sd,
+                const char *fmt,
+                va_list ap)
 {
-  system->callback->evprintf_filtered (system->callback, fmt, ap);
+  STATE_CALLBACK (sd)->evprintf_filtered (STATE_CALLBACK (sd), fmt, ap);
 }
 
 
-INLINE_SIM_IO(void)
-sim_io_error(engine *system,
-            const char *fmt,
-            ...)
+void
+sim_io_error (SIM_DESC sd,
+             const char *fmt,
+             ...)
 {
-  char buf[1000];
-  va_list ap;
-  va_start(ap, fmt);
-  vsprintf(buf, fmt, ap);
-  va_end(ap);
+  if (sd == NULL || STATE_CALLBACK (sd) == NULL) {
+    va_list ap;
+    va_start (ap, fmt);
+    vfprintf (stderr, fmt, ap);
+    va_end (ap);
+    fprintf (stderr, "\n");
+    abort ();
+  }
+  else {
+    va_list ap;
+    va_start (ap, fmt);
+    STATE_CALLBACK (sd)->evprintf_filtered (STATE_CALLBACK (sd), fmt, ap);
+    va_end (ap);
+    STATE_CALLBACK (sd)->error (STATE_CALLBACK (sd), "");
+  }
+}
 
-  if (strlen(buf) >= sizeof(buf))
-    abort();
 
-  system->callback->error (system->callback, "%s", buf);
+void
+sim_io_poll_quit (SIM_DESC sd)
+{
+  if (STATE_CALLBACK (sd)->poll_quit != NULL && poll_quit_count-- < 0)
+    {
+      poll_quit_count = POLL_QUIT_INTERVAL;
+      if (STATE_CALLBACK (sd)->poll_quit (STATE_CALLBACK (sd)))
+       sim_stop (sd);
+    }
 }
 
 
+/* Based on gdb-4.17/sim/ppc/main.c:sim_io_read_stdin().
+
+   FIXME: Should not be calling fcntl() or grubbing around inside of
+   ->fdmap and ->errno.
+
+   FIXME: Some completly new mechanism for handling the general
+   problem of asynchronous IO is needed.
+
+   FIXME: This function does not supress the echoing (ECHO) of input.
+   Consequently polled input is always displayed.
 
+   FIXME: This function does not perform uncooked reads.
+   Consequently, data will not be read until an EOLN character has
+   been entered. A cntrl-d may force the early termination of a line */
+
+
+int
+sim_io_poll_read (SIM_DESC sd,
+                 int sim_io_fd,
+                 char *buf,
+                 int sizeof_buf)
+{
+#if defined(O_NDELAY) && defined(F_GETFL) && defined(F_SETFL)
+  int fd = STATE_CALLBACK (sd)->fdmap[sim_io_fd];
+  int flags;
+  int status;
+  int nr_read;
+  int result;
+  STATE_CALLBACK (sd)->last_errno = 0;
+  /* get the old status */
+  flags = fcntl (fd, F_GETFL, 0);
+  if (flags == -1)
+    {
+      perror ("sim_io_poll_read");
+      return 0;
+    }
+  /* temp, disable blocking IO */
+  status = fcntl (fd, F_SETFL, flags | O_NDELAY);
+  if (status == -1)
+    {
+      perror ("sim_io_read_stdin");
+      return 0;
+    }
+  /* try for input */
+  nr_read = read (fd, buf, sizeof_buf);
+  if (nr_read >= 0)
+    {
+      /* printf ("<nr-read=%d>\n", nr_read); */
+      result = nr_read;
+    }
+  else
+    { /* nr_read < 0 */
+      result = -1;
+      STATE_CALLBACK (sd)->last_errno = errno;
+    }
+  /* return to regular vewing */
+  status = fcntl (fd, F_SETFL, flags);
+  if (status == -1)
+    {
+      perror ("sim_io_read_stdin");
+      /* return 0; */
+    }
+  return result;
+#else
+  return sim_io_read (sd, sim_io_fd, buf, sizeof_buf);
 #endif
+}
+
+int
+sim_io_stat (SIM_DESC sd, const char *path, struct stat *buf)
+{
+  return STATE_CALLBACK (sd)->to_stat (STATE_CALLBACK (sd), path, buf);
+}
+
+int
+sim_io_fstat (SIM_DESC sd, int fd, struct stat *buf)
+{
+  return STATE_CALLBACK (sd)->to_fstat (STATE_CALLBACK (sd), fd, buf);
+}
This page took 0.041186 seconds and 4 git commands to generate.