Further fix the documentation in struct quick_symbol_functions
[deliverable/binutils-gdb.git] / gdb / serial.c
index a2562d3289d778b93bc9c7719500cf6916c7529c..7c8fbc2c76d92924b771dc3a3281e58147c51f71 100644 (file)
@@ -1,13 +1,14 @@
 /* Generic serial interface routines
 
-   Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
-   2001, 2002 Free Software Foundation, Inc.
+   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.
 
    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 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
@@ -16,9 +17,7 @@
    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.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #include "defs.h"
 #include <ctype.h>
 
 extern void _initialize_serial (void);
 
-/* Is serial being debugged? */
+/* Is serial being debugged?  */
 
 static int global_serial_debug_p;
 
-/* Linked list of serial I/O handlers */
+/* Linked list of serial I/O handlers */
 
 static struct serial_ops *serial_ops_list = NULL;
 
-/* This is the last serial stream opened.  Used by connect command. */
+/* This is the last serial stream opened.  Used by connect command.  */
 
 static struct serial *last_serial_opened = NULL;
 
-/* Pointer to list of scb's. */
+/* Pointer to list of scb's.  */
 
 static struct serial *scb_base;
 
 /* Non-NULL gives filename which contains a recording of the remote session,
-   suitable for playback by gdbserver. */
+   suitable for playback by gdbserver.  */
 
 static char *serial_logfile = NULL;
 static struct ui_file *serial_logfp = NULL;
 
-static struct serial_ops *serial_interface_lookup (char *);
-static void serial_logchar (struct ui_file *stream, int ch_type, int ch, int timeout);
+static 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";
@@ -62,7 +62,7 @@ static const char *serial_logbase = logbase_ascii;
 
 static int serial_current_type = 0;
 
-/* Log char CH of type CHTYPE, with TIMEOUT */
+/* Log char CH of type CHTYPE, with TIMEOUT */
 
 /* Define bogus char to represent a BREAK.  Should be careful to choose a value
    that can't be confused with a normal char, or an error code.  */
@@ -124,7 +124,8 @@ serial_logchar (struct ui_file *stream, int ch_type, int ch, int timeout)
            fputs_unfiltered ("\\v", stream);
            break;
          default:
-           fprintf_unfiltered (stream, isprint (ch) ? "%c" : "\\x%02x", ch & 0xFF);
+           fprintf_unfiltered (stream,
+                               isprint (ch) ? "%c" : "\\x%02x", ch & 0xFF);
            break;
          }
     }
@@ -142,13 +143,13 @@ serial_log_command (const char *cmd)
   fputs_unfiltered (cmd, serial_logfp);
 
   /* Make sure that the log file is as up-to-date as possible,
-     in case we are getting ready to dump core or something. */
+     in case we are getting ready to dump core or something.  */
   gdb_flush (serial_logfp);
 }
 
 \f
 static struct serial_ops *
-serial_interface_lookup (char *name)
+serial_interface_lookup (const char *name)
 {
   struct serial_ops *ops;
 
@@ -166,7 +167,7 @@ serial_add_interface (struct serial_ops *optable)
   serial_ops_list = optable;
 }
 
-/* Open up a device or a network socket, depending upon the syntax of NAME. */
+/* Open up a device or a network socket, depending upon the syntax of NAME.  */
 
 struct serial *
 serial_open (const char *name)
@@ -184,15 +185,21 @@ serial_open (const char *name)
 
   if (strcmp (name, "pc") == 0)
     ops = serial_interface_lookup ("pc");
-  else if (strchr (name, ':'))
-    ops = serial_interface_lookup ("tcp");
   else if (strncmp (name, "lpt", 3) == 0)
     ops = serial_interface_lookup ("parallel");
   else if (strncmp (name, "|", 1) == 0)
     {
       ops = serial_interface_lookup ("pipe");
-      open_name = name + 1; /* discard ``|'' */
+      /* Discard ``|'' and any space before the command itself.  */
+      ++open_name;
+      while (isspace (*open_name))
+       ++open_name;
     }
+  /* Check for a colon, suggesting an IP address/port pair.
+     Do this *after* checking for all the interesting prefixes.  We
+     don't want to constrain the syntax of what can follow them.  */
+  else if (strchr (name, ':'))
+    ops = serial_interface_lookup ("tcp");
   else
     ops = serial_interface_lookup ("hardwire");
 
@@ -205,8 +212,10 @@ serial_open (const char *name)
 
   scb->bufcnt = 0;
   scb->bufp = scb->buf;
+  scb->error_fd = -1;
 
-  if (scb->ops->open (scb, open_name))
+  /* `...->open (...)' would get expanded by the open(2) syscall macro.  */
+  if ((*scb->ops->open) (scb, open_name))
     {
       xfree (scb);
       return NULL;
@@ -233,32 +242,53 @@ 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_fdopen (const int fd)
+serial_for_fd (int fd)
 {
   struct serial *scb;
-  struct serial_ops *ops;
 
   for (scb = scb_base; scb; scb = scb->next)
     if (scb->fd == fd)
-      {
-       scb->refcnt++;
-       return scb;
-      }
+      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)
+{
+  struct serial *scb;
 
-  ops = serial_interface_lookup ("hardwire");
+  scb = serial_for_fd (fd);
+  if (scb)
+    {
+      scb->refcnt++;
+      return scb;
+    }
+
+  if (!ops)
+    {
+      ops = serial_interface_lookup ("terminal");
+      if (!ops)
+       ops = serial_interface_lookup ("hardwire");
+    }
 
   if (!ops)
     return NULL;
 
-  scb = XMALLOC (struct serial);
+  scb = XCALLOC (1, struct serial);
 
   scb->ops = ops;
 
   scb->bufcnt = 0;
   scb->bufp = scb->buf;
-
-  scb->fd = fd;
+  scb->error_fd = -1;
 
   scb->name = NULL;
   scb->next = scb_base;
@@ -269,11 +299,22 @@ serial_fdopen (const int fd)
   scb->async_context = NULL;
   scb_base = scb;
 
+  if ((ops->fdopen) != NULL)
+    (*ops->fdopen) (scb, fd);
+  else
+    scb->fd = fd;
+
   last_serial_opened = scb;
 
   return scb;
 }
 
+struct serial *
+serial_fdopen (const int fd)
+{
+  return serial_fdopen_ops (fd, NULL);
+}
+
 static void
 do_serial_close (struct serial *scb, int really_close)
 {
@@ -286,7 +327,7 @@ do_serial_close (struct serial *scb, int really_close)
       fputs_unfiltered ("\nEnd of log\n", serial_logfp);
       serial_current_type = 0;
 
-      /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr? */
+      /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr?  */
       ui_file_delete (serial_logfp);
       serial_logfp = NULL;
     }
@@ -301,7 +342,7 @@ do_serial_close (struct serial *scb, int really_close)
   if (scb->refcnt > 0)
     return;
 
-  /* ensure that the FD has been taken out of async mode */
+  /* ensure that the FD has been taken out of async mode */
   if (scb->async_handler != NULL)
     serial_async (scb, NULL, NULL);
 
@@ -344,7 +385,7 @@ serial_readchar (struct serial *scb, int timeout)
   int ch;
 
   /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
-     code is finished. */
+     code is finished.  */
   if (0 && serial_is_async_p (scb) && timeout < 0)
     internal_error (__FILE__, __LINE__,
                    _("serial_readchar: blocking read in async mode"));
@@ -355,7 +396,7 @@ serial_readchar (struct serial *scb, int timeout)
       serial_logchar (serial_logfp, 'r', ch, timeout);
 
       /* Make sure that the log file is as up-to-date as possible,
-         in case we are getting ready to dump core or something. */
+         in case we are getting ready to dump core or something.  */
       gdb_flush (serial_logfp);
     }
   if (serial_debug_p (scb))
@@ -380,9 +421,21 @@ serial_write (struct serial *scb, const char *str, int len)
        serial_logchar (serial_logfp, 'w', str[count] & 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. */
+         in case we are getting ready to dump core or something.  */
       gdb_flush (serial_logfp);
     }
+  if (serial_debug_p (scb))
+    {
+      int count;
+
+      for (count = 0; count < len; count++)
+       {
+         fprintf_unfiltered (gdb_stdlog, "[");
+         serial_logchar (gdb_stdlog, 'w', str[count] & 0xff, 0);
+         fprintf_unfiltered (gdb_stdlog, "]");
+       }
+      gdb_flush (gdb_stdlog);
+    }
 
   return (scb->ops->write (scb, str, len));
 }
@@ -440,6 +493,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)
 {
@@ -491,19 +550,20 @@ serial_async (struct serial *scb,
              serial_event_ftype *handler,
              void *context)
 {
-  /* Only change mode if there is a need. */
-  if ((scb->async_handler == NULL)
-      != (handler == NULL))
-    scb->ops->async (scb, handler != NULL);
+  int changed = ((scb->async_handler == NULL) != (handler == NULL));
+
   scb->async_handler = handler;
   scb->async_context = context;
+  /* Only change mode if there is a need.  */
+  if (changed)
+    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? */
+     called?  */
   if (scb->fd < 0)
     {
       internal_error (__FILE__, __LINE__,
@@ -524,6 +584,47 @@ serial_debug_p (struct serial *scb)
   return scb->debug_p || global_serial_debug_p;
 }
 
+#ifdef USE_WIN32API
+void
+serial_wait_handle (struct serial *scb, HANDLE *read, HANDLE *except)
+{
+  if (scb->ops->wait_handle)
+    scb->ops->wait_handle (scb, read, except);
+  else
+    {
+      *read = (HANDLE) _get_osfhandle (scb->fd);
+      *except = NULL;
+    }
+}
+
+void
+serial_done_wait_handle (struct serial *scb)
+{
+  if (scb->ops->done_wait_handle)
+    scb->ops->done_wait_handle (scb);
+}
+#endif
+
+int
+serial_pipe (struct serial *scbs[2])
+{
+  struct serial_ops *ops;
+  int fildes[2];
+
+  ops = serial_interface_lookup ("pipe");
+  if (!ops)
+    {
+      errno = ENOSYS;
+      return -1;
+    }
+
+  if (gdb_pipe (fildes) == -1)
+    return -1;
+
+  scbs[0] = serial_fdopen_ops (fildes[0], ops);
+  scbs[1] = serial_fdopen_ops (fildes[1], ops);
+  return 0;
+}
 
 #if 0
 /* The connect command is #if 0 because I hadn't thought of an elegant
@@ -565,7 +666,9 @@ connect_command (char *args, int fromtty)
   dont_repeat ();
 
   if (args)
-    fprintf_unfiltered (gdb_stderr, "This command takes no args.  They have been ignored.\n");
+    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");
 
@@ -654,7 +757,8 @@ static struct cmd_list_element *serial_show_cmdlist;
 static void
 serial_set_cmd (char *args, int from_tty)
 {
-  printf_unfiltered ("\"set serial\" must be followed by the name of a command.\n");
+  printf_unfiltered ("\"set serial\" must be followed "
+                    "by the name of a command.\n");
   help_list (serial_set_cmdlist, "set serial ", -1, gdb_stdout);
 }
 
@@ -695,19 +799,20 @@ by gdbserver."),
                            NULL, /* FIXME: i18n: */
                            &setlist, &showlist);
 
-  deprecated_add_show_from_set
-    (add_set_enum_cmd ("remotelogbase", no_class,
-                      logbase_enums, &serial_logbase,
-                      "Set numerical base for remote session logging",
-                      &setlist),
-     &showlist);
-
-  deprecated_add_show_from_set
-    (add_set_cmd ("serial",
-                 class_maintenance,
-                 var_zinteger,
-                 (char *)&global_serial_debug_p,
-                 "Set serial debugging.\n\
-When non-zero, serial port debugging is enabled.", &setdebuglist),
-     &showdebuglist);
+  add_setshow_enum_cmd ("remotelogbase", no_class, logbase_enums,
+                       &serial_logbase, _("\
+Set numerical base for remote session logging"), _("\
+Show numerical base for remote session logging"), NULL,
+                       NULL,
+                       NULL, /* FIXME: i18n: */
+                       &setlist, &showlist);
+
+  add_setshow_zinteger_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);
 }
This page took 0.035786 seconds and 4 git commands to generate.