| /* Generic serial interface routines |
| Copyright 1992, 1993, 1996, 1997 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 |
| (at your option) any later version. |
| |
| 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. */ |
| |
| #include "defs.h" |
| #include <ctype.h> |
| #include "serial.h" |
| #include "gdb_string.h" |
| #include "gdbcmd.h" |
| |
| extern void _initialize_serial PARAMS ((void)); |
| |
| /* 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. */ |
| |
| static serial_t last_serial_opened = NULL; |
| |
| /* Pointer to list of scb's. */ |
| |
| static serial_t scb_base; |
| |
| /* Non-NULL gives filename which contains a recording of the remote session, |
| suitable for playback by gdbserver. */ |
| |
| static char *serial_logfile = NULL; |
| static GDB_FILE *serial_logfp = NULL; |
| |
| static struct serial_ops *serial_interface_lookup PARAMS ((char *)); |
| static void serial_logchar PARAMS ((int, int, int)); |
| static char logbase_hex[] = "hex"; |
| static char logbase_octal[] = "octal"; |
| static char logbase_ascii[] = "ascii"; |
| static char *logbase_enums[] = {logbase_hex, logbase_octal, logbase_ascii, NULL}; |
| static char *serial_logbase = logbase_ascii; |
| |
| |
| static int serial_current_type = 0; |
| |
| /* 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. */ |
| #define SERIAL_BREAK 1235 |
| |
| static void |
| serial_logchar (ch_type, ch, timeout) |
| int ch_type; |
| int ch; |
| int timeout; |
| { |
| if (ch_type != serial_current_type) |
| { |
| fprintf_unfiltered (serial_logfp, "\n%c ", ch_type); |
| serial_current_type = ch_type; |
| } |
| |
| if (serial_logbase != logbase_ascii) |
| fputc_unfiltered (' ', serial_logfp); |
| |
| switch (ch) |
| { |
| case SERIAL_TIMEOUT: |
| fprintf_unfiltered (serial_logfp, "<Timeout: %d seconds>", timeout); |
| return; |
| case SERIAL_ERROR: |
| fprintf_unfiltered (serial_logfp, "<Error: %s>", safe_strerror (errno)); |
| return; |
| case SERIAL_EOF: |
| fputs_unfiltered ("<Eof>", serial_logfp); |
| return; |
| case SERIAL_BREAK: |
| fputs_unfiltered ("<Break>", serial_logfp); |
| return; |
| default: |
| if (serial_logbase == logbase_hex) |
| fprintf_unfiltered (serial_logfp, "%02x", ch & 0xff); |
| else if (serial_logbase == logbase_octal) |
| fprintf_unfiltered (serial_logfp, "%03o", ch & 0xff); |
| else |
| switch (ch) |
| { |
| case '\\': fputs_unfiltered ("\\\\", serial_logfp); break; |
| case '\b': fputs_unfiltered ("\\b", serial_logfp); break; |
| case '\f': fputs_unfiltered ("\\f", serial_logfp); break; |
| case '\n': fputs_unfiltered ("\\n", serial_logfp); break; |
| case '\r': fputs_unfiltered ("\\r", serial_logfp); break; |
| case '\t': fputs_unfiltered ("\\t", serial_logfp); break; |
| case '\v': fputs_unfiltered ("\\v", serial_logfp); break; |
| default: fprintf_unfiltered (serial_logfp, isprint (ch) ? "%c" : "\\x%02x", ch & 0xFF); break; |
| } |
| } |
| } |
| |
| void |
| serial_log_command (cmd) |
| const char *cmd; |
| { |
| if (!serial_logfp) |
| return; |
| |
| serial_current_type = 'c'; |
| |
| fputs_unfiltered ("\nc ", serial_logfp); |
| 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. */ |
| gdb_flush (serial_logfp); |
| } |
| |
| int |
| serial_write (scb, str, len) |
| serial_t scb; |
| const char *str; |
| int len; |
| { |
| if (serial_logfp != NULL) |
| { |
| int count; |
| |
| for (count = 0; count < len; count++) |
| serial_logchar ('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. */ |
| gdb_flush (serial_logfp); |
| } |
| |
| return (scb -> ops -> write (scb, str, len)); |
| } |
| |
| int |
| serial_readchar (scb, timeout) |
| serial_t scb; |
| int timeout; |
| { |
| int ch; |
| |
| ch = scb -> ops -> readchar (scb, timeout); |
| if (serial_logfp != NULL) |
| { |
| serial_logchar ('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. */ |
| gdb_flush (serial_logfp); |
| } |
| |
| return (ch); |
| } |
| |
| int |
| serial_send_break (scb) |
| serial_t scb; |
| { |
| if (serial_logfp != NULL) |
| serial_logchar ('w', SERIAL_BREAK, 0); |
| |
| return (scb -> ops -> send_break (scb)); |
| } |
| |
| static struct serial_ops * |
| serial_interface_lookup (name) |
| char *name; |
| { |
| struct serial_ops *ops; |
| |
| for (ops = serial_ops_list; ops; ops = ops->next) |
| if (strcmp (name, ops->name) == 0) |
| return ops; |
| |
| return NULL; |
| } |
| |
| void |
| serial_add_interface(optable) |
| struct serial_ops *optable; |
| { |
| optable->next = serial_ops_list; |
| serial_ops_list = optable; |
| } |
| |
| /* Open up a device or a network socket, depending upon the syntax of NAME. */ |
| |
| serial_t |
| serial_open (name) |
| const char *name; |
| { |
| serial_t scb; |
| struct serial_ops *ops; |
| |
| for (scb = scb_base; scb; scb = scb->next) |
| if (scb->name && strcmp (scb->name, name) == 0) |
| { |
| scb->refcnt++; |
| return scb; |
| } |
| |
| if (strcmp (name, "ocd") == 0) |
| ops = serial_interface_lookup ("ocd"); |
| else 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 |
| ops = serial_interface_lookup ("hardwire"); |
| |
| if (!ops) |
| return NULL; |
| |
| scb = (serial_t)xmalloc (sizeof (struct _serial_t)); |
| |
| scb->ops = ops; |
| |
| scb->bufcnt = 0; |
| scb->bufp = scb->buf; |
| |
| if (scb->ops->open(scb, name)) |
| { |
| free (scb); |
| return NULL; |
| } |
| |
| scb->name = strsave (name); |
| scb->next = scb_base; |
| scb->refcnt = 1; |
| scb_base = scb; |
| |
| last_serial_opened = scb; |
| |
| if (serial_logfile != NULL) |
| { |
| serial_logfp = gdb_fopen (serial_logfile, "w"); |
| if (serial_logfp == NULL) |
| perror_with_name (serial_logfile); |
| } |
| |
| return scb; |
| } |
| |
| serial_t |
| serial_fdopen (fd) |
| const int fd; |
| { |
| serial_t scb; |
| struct serial_ops *ops; |
| |
| for (scb = scb_base; scb; scb = scb->next) |
| if (scb->fd == fd) |
| { |
| scb->refcnt++; |
| return scb; |
| } |
| |
| ops = serial_interface_lookup ("hardwire"); |
| |
| if (!ops) |
| return NULL; |
| |
| scb = (serial_t)xmalloc (sizeof (struct _serial_t)); |
| |
| scb->ops = ops; |
| |
| scb->bufcnt = 0; |
| scb->bufp = scb->buf; |
| |
| scb->fd = fd; |
| |
| scb->name = NULL; |
| scb->next = scb_base; |
| scb->refcnt = 1; |
| scb_base = scb; |
| |
| last_serial_opened = scb; |
| |
| return scb; |
| } |
| |
| void |
| serial_close (scb, really_close) |
| serial_t scb; |
| int really_close; |
| { |
| serial_t tmp_scb; |
| |
| last_serial_opened = NULL; |
| |
| if (serial_logfp) |
| { |
| fputs_unfiltered ("\nEnd of log\n", serial_logfp); |
| serial_current_type = 0; |
| |
| /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr? */ |
| gdb_fclose (&serial_logfp); |
| 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; |
| |
| if (really_close) |
| scb->ops->close (scb); |
| |
| if (scb->name) |
| free (scb->name); |
| |
| if (scb_base == scb) |
| scb_base = scb_base->next; |
| else |
| for (tmp_scb = scb_base; tmp_scb; tmp_scb = tmp_scb->next) |
| { |
| if (tmp_scb->next != scb) |
| continue; |
| |
| tmp_scb->next = tmp_scb->next->next; |
| break; |
| } |
| |
| free(scb); |
| } |
| |
| #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: |
| |
| 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 serial_t tty_desc; /* Controlling terminal */ |
| |
| static void |
| cleanup_tty(ttystate) |
| serial_ttystate ttystate; |
| { |
| printf_unfiltered ("\r\n[Exiting connect mode]\r\n"); |
| SERIAL_SET_TTY_STATE (tty_desc, ttystate); |
| free (ttystate); |
| SERIAL_CLOSE (tty_desc); |
| } |
| |
| static void |
| connect_command (args, fromtty) |
| char *args; |
| int fromtty; |
| { |
| int c; |
| char cur_esc = 0; |
| serial_ttystate ttystate; |
| serial_t 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 */ |
| |
| /* VARARGS */ |
| void |
| #ifdef ANSI_PROTOTYPES |
| serial_printf (serial_t desc, const char *format, ...) |
| #else |
| serial_printf (va_alist) |
| va_dcl |
| #endif |
| { |
| va_list args; |
| char *buf; |
| #ifdef ANSI_PROTOTYPES |
| va_start (args, format); |
| #else |
| serial_t desc; |
| char *format; |
| |
| va_start (args); |
| desc = va_arg (args, serial_t); |
| format = va_arg (args, char *); |
| #endif |
| |
| vasprintf (&buf, format, args); |
| SERIAL_WRITE (desc, buf, strlen (buf)); |
| |
| free (buf); |
| va_end (args); |
| } |
| |
| void |
| _initialize_serial () |
| { |
| #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."); |
| #endif /* 0 */ |
| |
| add_show_from_set |
| (add_set_cmd ("remotelogfile", no_class, |
| var_filename, (char *) &serial_logfile, |
| "Set filename for remote session recording.\n\ |
| 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, (char *) &serial_logbase, |
| "Set numerical base for remote session logging", |
| &setlist), |
| &showlist); |
| } |