Automatic date update in version.in
[platform/upstream/binutils.git] / gdb / serial.c
index 8809abd..791f12f 100644 (file)
@@ -1,8 +1,6 @@
 /* Generic serial interface routines
 
-   Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
-   2002, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
-   Free Software Foundation, Inc.
+   Copyright (C) 1992-2014 Free Software Foundation, Inc.
 
    This file is part of GDB.
 
 #include "defs.h"
 #include <ctype.h>
 #include "serial.h"
-#include "gdb_string.h"
 #include "gdbcmd.h"
+#include "cli/cli-utils.h"
 
 extern void _initialize_serial (void);
 
 /* Is serial being debugged?  */
 
-static int global_serial_debug_p;
+static unsigned int global_serial_debug_p;
 
-/* Linked list of serial I/O handlers.  */
+typedef const struct serial_ops *serial_ops_p;
+DEF_VEC_P (serial_ops_p);
 
-static struct serial_ops *serial_ops_list = NULL;
+/* Serial I/O handlers.  */
 
-/* This is the last serial stream opened.  Used by connect command.  */
-
-static struct serial *last_serial_opened = NULL;
+VEC (serial_ops_p) *serial_ops_list = NULL;
 
 /* Pointer to list of scb's.  */
 
@@ -49,13 +46,13 @@ static struct serial *scb_base;
 static char *serial_logfile = NULL;
 static struct ui_file *serial_logfp = NULL;
 
-static struct serial_ops *serial_interface_lookup (const char *);
+static const struct serial_ops *serial_interface_lookup (const char *);
 static void serial_logchar (struct ui_file *stream,
                            int ch_type, int ch, int timeout);
 static const char logbase_hex[] = "hex";
 static const char logbase_octal[] = "octal";
 static const char logbase_ascii[] = "ascii";
-static const char *logbase_enums[] =
+static const char *const logbase_enums[] =
 {logbase_hex, logbase_octal, logbase_ascii, NULL};
 static const char *serial_logbase = logbase_ascii;
 \f
@@ -132,7 +129,7 @@ serial_logchar (struct ui_file *stream, int ch_type, int ch, int timeout)
 }
 
 void
-serial_log_command (const char *cmd)
+serial_log_command (struct target_ops *self, const char *cmd)
 {
   if (!serial_logfp)
     return;
@@ -148,12 +145,13 @@ serial_log_command (const char *cmd)
 }
 
 \f
-static struct serial_ops *
+static const struct serial_ops *
 serial_interface_lookup (const char *name)
 {
-  struct serial_ops *ops;
+  const struct serial_ops *ops;
+  int i;
 
-  for (ops = serial_ops_list; ops; ops = ops->next)
+  for (i = 0; VEC_iterate (serial_ops_p, serial_ops_list, i, ops); ++i)
     if (strcmp (name, ops->name) == 0)
       return ops;
 
@@ -161,10 +159,24 @@ serial_interface_lookup (const char *name)
 }
 
 void
-serial_add_interface (struct serial_ops *optable)
+serial_add_interface (const struct serial_ops *optable)
+{
+  VEC_safe_push (serial_ops_p, serial_ops_list, optable);
+}
+
+/* Return the open serial device for FD, if found, or NULL if FD is
+   not already opened.  */
+
+struct serial *
+serial_for_fd (int fd)
 {
-  optable->next = serial_ops_list;
-  serial_ops_list = optable;
+  struct serial *scb;
+
+  for (scb = scb_base; scb; scb = scb->next)
+    if (scb->fd == fd)
+      return scb;
+
+  return NULL;
 }
 
 /* Open up a device or a network socket, depending upon the syntax of NAME.  */
@@ -173,16 +185,9 @@ struct serial *
 serial_open (const char *name)
 {
   struct serial *scb;
-  struct serial_ops *ops;
+  const struct serial_ops *ops;
   const char *open_name = name;
 
-  for (scb = scb_base; scb; scb = scb->next)
-    if (scb->name && strcmp (scb->name, name) == 0)
-      {
-       scb->refcnt++;
-       return scb;
-      }
-
   if (strcmp (name, "pc") == 0)
     ops = serial_interface_lookup ("pc");
   else if (strncmp (name, "lpt", 3) == 0)
@@ -192,8 +197,7 @@ serial_open (const char *name)
       ops = serial_interface_lookup ("pipe");
       /* Discard ``|'' and any space before the command itself.  */
       ++open_name;
-      while (isspace (*open_name))
-       ++open_name;
+      open_name = skip_spaces_const (open_name);
     }
   /* Check for a colon, suggesting an IP address/port pair.
      Do this *after* checking for all the interesting prefixes.  We
@@ -206,15 +210,16 @@ serial_open (const char *name)
   if (!ops)
     return NULL;
 
-  scb = XMALLOC (struct serial);
+  scb = XNEW (struct serial);
 
   scb->ops = ops;
 
   scb->bufcnt = 0;
   scb->bufp = scb->buf;
   scb->error_fd = -1;
+  scb->refcnt = 1;
 
-  /* `...->open (...)' would get expanded by an the open(2) syscall macro.  */
+  /* `...->open (...)' would get expanded by the open(2) syscall macro.  */
   if ((*scb->ops->open) (scb, open_name))
     {
       xfree (scb);
@@ -223,15 +228,12 @@ serial_open (const char *name)
 
   scb->name = xstrdup (name);
   scb->next = scb_base;
-  scb->refcnt = 1;
   scb->debug_p = 0;
   scb->async_state = 0;
   scb->async_handler = NULL;
   scb->async_context = NULL;
   scb_base = scb;
 
-  last_serial_opened = scb;
-
   if (serial_logfile != NULL)
     {
       serial_logfp = gdb_fopen (serial_logfile, "w");
@@ -242,36 +244,14 @@ serial_open (const char *name)
   return scb;
 }
 
-/* Return the open serial device for FD, if found, or NULL if FD
-   is not already opened.  */
-
-struct serial *
-serial_for_fd (int fd)
-{
-  struct serial *scb;
-
-  for (scb = scb_base; scb; scb = scb->next)
-    if (scb->fd == fd)
-      return scb;
-
-  return NULL;
-}
-
 /* Open a new serial stream using a file handle, using serial
    interface ops OPS.  */
 
 static struct serial *
-serial_fdopen_ops (const int fd, struct serial_ops *ops)
+serial_fdopen_ops (const int fd, const struct serial_ops *ops)
 {
   struct serial *scb;
 
-  scb = serial_for_fd (fd);
-  if (scb)
-    {
-      scb->refcnt++;
-      return scb;
-    }
-
   if (!ops)
     {
       ops = serial_interface_lookup ("terminal");
@@ -282,17 +262,17 @@ serial_fdopen_ops (const int fd, struct serial_ops *ops)
   if (!ops)
     return NULL;
 
-  scb = XCALLOC (1, struct serial);
+  scb = XCNEW (struct serial);
 
   scb->ops = ops;
 
   scb->bufcnt = 0;
   scb->bufp = scb->buf;
   scb->error_fd = -1;
+  scb->refcnt = 1;
 
   scb->name = NULL;
   scb->next = scb_base;
-  scb->refcnt = 1;
   scb->debug_p = 0;
   scb->async_state = 0;
   scb->async_handler = NULL;
@@ -304,8 +284,6 @@ serial_fdopen_ops (const int fd, struct serial_ops *ops)
   else
     scb->fd = fd;
 
-  last_serial_opened = scb;
-
   return scb;
 }
 
@@ -320,8 +298,6 @@ do_serial_close (struct serial *scb, int really_close)
 {
   struct serial *tmp_scb;
 
-  last_serial_opened = NULL;
-
   if (serial_logfp)
     {
       fputs_unfiltered ("\nEnd of log\n", serial_logfp);
@@ -332,16 +308,6 @@ do_serial_close (struct serial *scb, int really_close)
       serial_logfp = NULL;
     }
 
-/* This is bogus.  It's not our fault if you pass us a bad scb...!  Rob, you
-   should fix your code instead.  */
-
-  if (!scb)
-    return;
-
-  scb->refcnt--;
-  if (scb->refcnt > 0)
-    return;
-
   /* ensure that the FD has been taken out of async mode.  */
   if (scb->async_handler != NULL)
     serial_async (scb, NULL, NULL);
@@ -352,6 +318,9 @@ do_serial_close (struct serial *scb, int really_close)
   if (scb->name)
     xfree (scb->name);
 
+  /* For serial_is_open.  */
+  scb->bufp = NULL;
+
   if (scb_base == scb)
     scb_base = scb_base->next;
   else
@@ -364,7 +333,7 @@ do_serial_close (struct serial *scb, int really_close)
        break;
       }
 
-  xfree (scb);
+  serial_unref (scb);
 }
 
 void
@@ -380,6 +349,26 @@ serial_un_fdopen (struct serial *scb)
 }
 
 int
+serial_is_open (struct serial *scb)
+{
+  return scb->bufp != NULL;
+}
+
+void
+serial_ref (struct serial *scb)
+{
+  scb->refcnt++;
+}
+
+void
+serial_unref (struct serial *scb)
+{
+  --scb->refcnt;
+  if (scb->refcnt == 0)
+    xfree (scb);
+}
+
+int
 serial_readchar (struct serial *scb, int timeout)
 {
   int ch;
@@ -411,14 +400,15 @@ serial_readchar (struct serial *scb, int timeout)
 }
 
 int
-serial_write (struct serial *scb, const char *str, int len)
+serial_write (struct serial *scb, const void *buf, size_t count)
 {
   if (serial_logfp != NULL)
     {
-      int count;
+      const char *str = buf;
+      size_t c;
 
-      for (count = 0; count < len; count++)
-       serial_logchar (serial_logfp, 'w', str[count] & 0xff, 0);
+      for (c = 0; c < count; c++)
+       serial_logchar (serial_logfp, 'w', str[c] & 0xff, 0);
 
       /* Make sure that the log file is as up-to-date as possible,
          in case we are getting ready to dump core or something.  */
@@ -426,18 +416,19 @@ serial_write (struct serial *scb, const char *str, int len)
     }
   if (serial_debug_p (scb))
     {
-      int count;
+      const char *str = buf;
+      size_t c;
 
-      for (count = 0; count < len; count++)
+      for (c = 0; c < count; c++)
        {
          fprintf_unfiltered (gdb_stdlog, "[");
-         serial_logchar (gdb_stdlog, 'w', str[count] & 0xff, 0);
+         serial_logchar (gdb_stdlog, 'w', str[c] & 0xff, 0);
          fprintf_unfiltered (gdb_stdlog, "]");
        }
       gdb_flush (gdb_stdlog);
     }
 
-  return (scb->ops->write (scb, str, len));
+  return (scb->ops->write (scb, buf, count));
 }
 
 void
@@ -493,6 +484,12 @@ serial_get_tty_state (struct serial *scb)
   return scb->ops->get_tty_state (scb);
 }
 
+serial_ttystate
+serial_copy_tty_state (struct serial *scb, serial_ttystate ttystate)
+{
+  return scb->ops->copy_tty_state (scb, ttystate);
+}
+
 int
 serial_set_tty_state (struct serial *scb, serial_ttystate ttystate)
 {
@@ -553,19 +550,6 @@ serial_async (struct serial *scb,
     scb->ops->async (scb, handler != NULL);
 }
 
-int
-deprecated_serial_fd (struct serial *scb)
-{
-  /* FIXME: should this output a warning that deprecated code is being
-     called?  */
-  if (scb->fd < 0)
-    {
-      internal_error (__FILE__, __LINE__,
-                     _("serial: FD not valid"));
-    }
-  return scb->fd; /* sigh */
-}
-
 void
 serial_debug (struct serial *scb, int debug_p)
 {
@@ -602,7 +586,7 @@ serial_done_wait_handle (struct serial *scb)
 int
 serial_pipe (struct serial *scbs[2])
 {
-  struct serial_ops *ops;
+  const struct serial_ops *ops;
   int fildes[2];
 
   ops = serial_interface_lookup ("pipe");
@@ -620,129 +604,6 @@ serial_pipe (struct serial *scbs[2])
   return 0;
 }
 
-#if 0
-/* The connect command is #if 0 because I hadn't thought of an elegant
-   way to wait for I/O on two `struct serial *'s simultaneously.  Two
-   solutions came to mind:
-
-   1) Fork, and have have one fork handle the to user direction,
-   and have the other hand the to target direction.  This
-   obviously won't cut it for MSDOS.
-
-   2) Use something like select.  This assumes that stdin and
-   the target side can both be waited on via the same
-   mechanism.  This may not be true for DOS, if GDB is
-   talking to the target via a TCP socket.
-   -grossman, 8 Jun 93 */
-
-/* Connect the user directly to the remote system.  This command acts just like
-   the 'cu' or 'tip' command.  Use <CR>~. or <CR>~^D to break out.  */
-
-static struct serial *tty_desc;        /* Controlling terminal */
-
-static void
-cleanup_tty (serial_ttystate ttystate)
-{
-  printf_unfiltered ("\r\n[Exiting connect mode]\r\n");
-  serial_set_tty_state (tty_desc, ttystate);
-  xfree (ttystate);
-  serial_close (tty_desc);
-}
-
-static void
-connect_command (char *args, int fromtty)
-{
-  int c;
-  char cur_esc = 0;
-  serial_ttystate ttystate;
-  struct serial *port_desc;            /* TTY port */
-
-  dont_repeat ();
-
-  if (args)
-    fprintf_unfiltered (gdb_stderr,
-                       "This command takes no args.  "
-                       "They have been ignored.\n");
-
-  printf_unfiltered ("[Entering connect mode.  Use ~. or ~^D to escape]\n");
-
-  tty_desc = serial_fdopen (0);
-  port_desc = last_serial_opened;
-
-  ttystate = serial_get_tty_state (tty_desc);
-
-  serial_raw (tty_desc);
-  serial_raw (port_desc);
-
-  make_cleanup (cleanup_tty, ttystate);
-
-  while (1)
-    {
-      int mask;
-
-      mask = serial_wait_2 (tty_desc, port_desc, -1);
-
-      if (mask & 2)
-       {                       /* tty input */
-         char cx;
-
-         while (1)
-           {
-             c = serial_readchar (tty_desc, 0);
-
-             if (c == SERIAL_TIMEOUT)
-               break;
-
-             if (c < 0)
-               perror_with_name (_("connect"));
-
-             cx = c;
-             serial_write (port_desc, &cx, 1);
-
-             switch (cur_esc)
-               {
-               case 0:
-                 if (c == '\r')
-                   cur_esc = c;
-                 break;
-               case '\r':
-                 if (c == '~')
-                   cur_esc = c;
-                 else
-                   cur_esc = 0;
-                 break;
-               case '~':
-                 if (c == '.' || c == '\004')
-                   return;
-                 else
-                   cur_esc = 0;
-               }
-           }
-       }
-
-      if (mask & 1)
-       {                       /* Port input */
-         char cx;
-
-         while (1)
-           {
-             c = serial_readchar (port_desc, 0);
-
-             if (c == SERIAL_TIMEOUT)
-               break;
-
-             if (c < 0)
-               perror_with_name (_("connect"));
-
-             cx = c;
-
-             serial_write (tty_desc, &cx, 1);
-           }
-       }
-    }
-}
-#endif /* 0 */
-
 /* Serial set/show framework.  */
 
 static struct cmd_list_element *serial_set_cmdlist;
@@ -753,7 +614,7 @@ serial_set_cmd (char *args, int from_tty)
 {
   printf_unfiltered ("\"set serial\" must be followed "
                     "by the name of a command.\n");
-  help_list (serial_set_cmdlist, "set serial ", -1, gdb_stdout);
+  help_list (serial_set_cmdlist, "set serial ", all_commands, gdb_stdout);
 }
 
 static void
@@ -762,6 +623,20 @@ serial_show_cmd (char *args, int from_tty)
   cmd_show_list (serial_show_cmdlist, from_tty, "");
 }
 
+/* Baud rate specified for talking to serial target systems.  Default
+   is left as -1, so targets can choose their own defaults.  */
+/* FIXME: This means that "show serial baud" and gr_files_info can
+   print -1 or (unsigned int)-1.  This is a Bad User Interface.  */
+
+int baud_rate = -1;
+
+static void
+serial_baud_show_cmd (struct ui_file *file, int from_tty,
+                     struct cmd_list_element *c, const char *value)
+{
+  fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
+                   value);
+}
 
 void
 _initialize_serial (void)
@@ -784,6 +659,17 @@ Show default serial/parallel port configuration."),
                  0/*allow-unknown*/,
                  &showlist);
 
+  /* If target is open when baud changes, it doesn't take effect until
+     the next open (I think, not sure).  */
+  add_setshow_zinteger_cmd ("baud", no_class, &baud_rate, _("\
+Set baud rate for remote serial I/O."), _("\
+Show baud rate for remote serial I/O."), _("\
+This value is used to set the speed of the serial port when debugging\n\
+using remote targets."),
+                           NULL,
+                           serial_baud_show_cmd,
+                           &serial_set_cmdlist, &serial_show_cmdlist);
+
   add_setshow_filename_cmd ("remotelogfile", no_class, &serial_logfile, _("\
 Set filename for remote session recording."), _("\
 Show filename for remote session recording."), _("\
@@ -801,12 +687,12 @@ Show numerical base for remote session logging"), NULL,
                        NULL, /* FIXME: i18n: */
                        &setlist, &showlist);
 
-  add_setshow_zinteger_cmd ("serial", class_maintenance,
-                           &global_serial_debug_p, _("\
+  add_setshow_zuinteger_cmd ("serial", class_maintenance,
+                            &global_serial_debug_p, _("\
 Set serial debugging."), _("\
 Show serial debugging."), _("\
 When non-zero, serial port debugging is enabled."),
-                           NULL,
-                           NULL, /* FIXME: i18n: */
-                           &setdebuglist, &showdebuglist);
+                            NULL,
+                            NULL, /* FIXME: i18n: */
+                            &setdebuglist, &showdebuglist);
 }