/* Generic serial interface routines
- Copyright 1992, 1993, 1996, 1997, 1999, 2000 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,
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 serial_t last_serial_opened = NULL;
+static struct serial *last_serial_opened = NULL;
-/* Pointer to list of scb's. */
+/* Pointer to list of scb's. */
-static serial_t scb_base;
+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";
static const char *serial_logbase = logbase_ascii;
\f
-
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. */
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;
}
}
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;
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. */
-serial_t
+struct serial *
serial_open (const char *name)
{
- serial_t scb;
+ struct serial *scb;
struct serial_ops *ops;
const char *open_name = name;
return scb;
}
- if (strcmp (name, "ocd") == 0)
- ops = serial_interface_lookup ("ocd");
- else if (strcmp (name, "pc") == 0)
+ 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");
if (!ops)
return NULL;
- scb = (serial_t) xmalloc (sizeof (struct _serial_t));
+ scb = XMALLOC (struct serial);
scb->ops = ops;
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;
}
- scb->name = strsave (name);
+ scb->name = xstrdup (name);
scb->next = scb_base;
scb->refcnt = 1;
scb->debug_p = 0;
return scb;
}
-serial_t
-serial_fdopen (const int fd)
+/* Return the open serial device for FD, if found, or NULL if FD
+ is not already opened. */
+
+struct serial *
+serial_for_fd (int fd)
{
- serial_t scb;
- struct serial_ops *ops;
+ struct serial *scb;
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. */
- ops = serial_interface_lookup ("hardwire");
+static struct serial *
+serial_fdopen_ops (const int fd, 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");
+ if (!ops)
+ ops = serial_interface_lookup ("hardwire");
+ }
if (!ops)
return NULL;
- scb = (serial_t) xmalloc (sizeof (struct _serial_t));
+ 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;
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 (serial_t scb, int really_close)
+do_serial_close (struct serial *scb, int really_close)
{
- serial_t tmp_scb;
+ struct serial *tmp_scb;
last_serial_opened = NULL;
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;
}
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);
}
void
-serial_close (serial_t scb)
+serial_close (struct serial *scb)
{
do_serial_close (scb, 1);
}
void
-serial_un_fdopen (serial_t scb)
+serial_un_fdopen (struct serial *scb)
{
do_serial_close (scb, 0);
}
int
-serial_readchar (serial_t scb, int timeout)
+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. */
- if (0 && SERIAL_IS_ASYNC_P (scb) && timeout < 0)
- internal_error ("serial_readchar: blocking read in async mode");
+ code is finished. */
+ if (0 && serial_is_async_p (scb) && timeout < 0)
+ internal_error (__FILE__, __LINE__,
+ _("serial_readchar: blocking read in async mode"));
ch = scb->ops->readchar (scb, timeout);
if (serial_logfp != NULL)
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))
+ if (serial_debug_p (scb))
{
fprintf_unfiltered (gdb_stdlog, "[");
serial_logchar (gdb_stdlog, 'r', ch, timeout);
}
int
-serial_write (serial_t scb, const char *str, int len)
+serial_write (struct serial *scb, const char *str, int len)
{
if (serial_logfp != NULL)
{
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));
}
void
-serial_printf (serial_t desc, const char *format,...)
+serial_printf (struct serial *desc, const char *format,...)
{
va_list args;
char *buf;
va_start (args, format);
- xvasprintf (&buf, format, args);
- SERIAL_WRITE (desc, buf, strlen (buf));
+ buf = xstrvprintf (format, args);
+ serial_write (desc, buf, strlen (buf));
xfree (buf);
va_end (args);
}
int
-serial_drain_output (serial_t scb)
+serial_drain_output (struct serial *scb)
{
return scb->ops->drain_output (scb);
}
int
-serial_flush_output (serial_t scb)
+serial_flush_output (struct serial *scb)
{
return scb->ops->flush_output (scb);
}
int
-serial_flush_input (serial_t scb)
+serial_flush_input (struct serial *scb)
{
return scb->ops->flush_input (scb);
}
int
-serial_send_break (serial_t scb)
+serial_send_break (struct serial *scb)
{
if (serial_logfp != NULL)
serial_logchar (serial_logfp, 'w', SERIAL_BREAK, 0);
}
void
-serial_raw (serial_t scb)
+serial_raw (struct serial *scb)
{
scb->ops->go_raw (scb);
}
serial_ttystate
-serial_get_tty_state (serial_t scb)
+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 (serial_t scb, serial_ttystate ttystate)
+serial_set_tty_state (struct serial *scb, serial_ttystate ttystate)
{
return scb->ops->set_tty_state (scb, ttystate);
}
void
-serial_print_tty_state (serial_t scb,
+serial_print_tty_state (struct serial *scb,
serial_ttystate ttystate,
struct ui_file *stream)
{
}
int
-serial_noflush_set_tty_state (serial_t scb,
+serial_noflush_set_tty_state (struct serial *scb,
serial_ttystate new_ttystate,
serial_ttystate old_ttystate)
{
}
int
-serial_setbaudrate (serial_t scb, int rate)
+serial_setbaudrate (struct serial *scb, int rate)
{
return scb->ops->setbaudrate (scb, rate);
}
int
-serial_setstopbits (serial_t scb, int num)
+serial_setstopbits (struct serial *scb, int num)
{
return scb->ops->setstopbits (scb, num);
}
int
-serial_can_async_p (serial_t scb)
+serial_can_async_p (struct serial *scb)
{
return (scb->ops->async != NULL);
}
int
-serial_is_async_p (serial_t scb)
+serial_is_async_p (struct serial *scb)
{
return (scb->ops->async != NULL) && (scb->async_handler != NULL);
}
void
-serial_async (serial_t scb,
+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 (serial_t scb)
+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 ("serial: FD not valid");
+ internal_error (__FILE__, __LINE__,
+ _("serial: FD not valid"));
}
return scb->fd; /* sigh */
}
void
-serial_debug (serial_t scb, int debug_p)
+serial_debug (struct serial *scb, int debug_p)
{
scb->debug_p = debug_p;
}
int
-serial_debug_p (serial_t scb)
+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
- way to wait for I/O on two serial_t's simultaneously. Two solutions
- came to mind:
+/* 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
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
- */
+ -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 serial_t tty_desc; /* Controlling terminal */
+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);
+ serial_set_tty_state (tty_desc, ttystate);
xfree (ttystate);
- SERIAL_CLOSE (tty_desc);
+ serial_close (tty_desc);
}
static void
int c;
char cur_esc = 0;
serial_ttystate ttystate;
- serial_t port_desc; /* TTY port */
+ struct serial *port_desc; /* TTY port */
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");
- tty_desc = SERIAL_FDOPEN (0);
+ tty_desc = serial_fdopen (0);
port_desc = last_serial_opened;
- ttystate = SERIAL_GET_TTY_STATE (tty_desc);
+ ttystate = serial_get_tty_state (tty_desc);
- SERIAL_RAW (tty_desc);
- SERIAL_RAW (port_desc);
+ serial_raw (tty_desc);
+ serial_raw (port_desc);
make_cleanup (cleanup_tty, ttystate);
{
int mask;
- mask = SERIAL_WAIT_2 (tty_desc, port_desc, -1);
+ mask = serial_wait_2 (tty_desc, port_desc, -1);
if (mask & 2)
{ /* tty input */
while (1)
{
- c = SERIAL_READCHAR (tty_desc, 0);
+ c = serial_readchar (tty_desc, 0);
if (c == SERIAL_TIMEOUT)
break;
if (c < 0)
- perror_with_name ("connect");
+ perror_with_name (_("connect"));
cx = c;
- SERIAL_WRITE (port_desc, &cx, 1);
+ serial_write (port_desc, &cx, 1);
switch (cur_esc)
{
while (1)
{
- c = SERIAL_READCHAR (port_desc, 0);
+ c = serial_readchar (port_desc, 0);
if (c == SERIAL_TIMEOUT)
break;
if (c < 0)
- perror_with_name ("connect");
+ perror_with_name (_("connect"));
cx = c;
- SERIAL_WRITE (tty_desc, &cx, 1);
+ serial_write (tty_desc, &cx, 1);
}
}
}
}
#endif /* 0 */
+/* Serial set/show framework. */
+
+static struct cmd_list_element *serial_set_cmdlist;
+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");
+ help_list (serial_set_cmdlist, "set serial ", -1, gdb_stdout);
+}
+
+static void
+serial_show_cmd (char *args, int from_tty)
+{
+ cmd_show_list (serial_show_cmdlist, from_tty, "");
+}
+
+
void
_initialize_serial (void)
{
#if 0
- add_com ("connect", class_obscure, connect_command,
- "Connect the terminal directly up to the command monitor.\n\
-Use <CR>~. or <CR>~^D to break out.");
+ add_com ("connect", class_obscure, connect_command, _("\
+Connect the terminal directly up to the command monitor.\n\
+Use <CR>~. or <CR>~^D to break out."));
#endif /* 0 */
- add_show_from_set
- (add_set_cmd ("remotelogfile", no_class,
- var_filename, (char *) &serial_logfile,
- "Set filename for remote session recording.\n\
+ add_prefix_cmd ("serial", class_maintenance, serial_set_cmd, _("\
+Set default serial/parallel port configuration."),
+ &serial_set_cmdlist, "set serial ",
+ 0/*allow-unknown*/,
+ &setlist);
+
+ add_prefix_cmd ("serial", class_maintenance, serial_show_cmd, _("\
+Show default serial/parallel port configuration."),
+ &serial_show_cmdlist, "show serial ",
+ 0/*allow-unknown*/,
+ &showlist);
+
+ add_setshow_filename_cmd ("remotelogfile", no_class, &serial_logfile, _("\
+Set filename for remote session recording."), _("\
+Show filename for remote session recording."), _("\
This file is used to record the remote session for future playback\n\
-by gdbserver.",
- &setlist),
- &showlist);
-
- add_show_from_set
- (add_set_enum_cmd ("remotelogbase", no_class,
- logbase_enums, &serial_logbase,
- "Set numerical base for remote session logging",
- &setlist),
- &showlist);
-
- 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);
+by gdbserver."),
+ NULL,
+ NULL, /* FIXME: i18n: */
+ &setlist, &showlist);
+
+ 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);
}
projects / deliverable / binutils-gdb.git / blobdiff