gdb/serial.c - gdb

Global variables defined

Data types defined

Functions defined

Macros defined

Source code

  1. /* Generic serial interface routines

  3.    Copyright (C) 1992-2015 Free Software Foundation, Inc.

  5.    This file is part of GDB.

  7.    This program is free software; you can redistribute it and/or modify
  8.    it under the terms of the GNU General Public License as published by
  9.    the Free Software Foundation; either version 3 of the License, or
  10.    (at your option) any later version.

  12.    This program is distributed in the hope that it will be useful,
  13.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15.    GNU General Public License for more details.

  17.    You should have received a copy of the GNU General Public License
  18.    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

  20. #include "defs.h"
  21. #include <ctype.h>
  22. #include "serial.h"
  23. #include "gdbcmd.h"
  24. #include "cli/cli-utils.h"

  26. extern void _initialize_serial (void);

  28. /* Is serial being debugged?  */

  30. ‌static unsigned int global_serial_debug_p;

  32. ‌typedef const struct serial_ops *serial_ops_p;
  33. ‌DEF_VEC_P (serial_ops_p);

  35. /* Serial I/O handlers.  */

  37. VEC (serial_ops_p) *serial_ops_list = NULL;

  39. /* Pointer to list of scb's.  */

  41. ‌static struct serial *scb_base;

  43. /* Non-NULL gives filename which contains a recording of the remote session,
  44.    suitable for playback by gdbserver.  */

  46. ‌static char *serial_logfile = NULL;
  47. ‌static struct ui_file *serial_logfp = NULL;

  49. static const struct serial_ops *serial_interface_lookup (const char *);
  50. static void serial_logchar (struct ui_file *stream,
  51.                             int ch_type, int ch, int timeout);
  52. ‌static const char logbase_hex[] = "hex";
  53. ‌static const char logbase_octal[] = "octal";
  54. ‌static const char logbase_ascii[] = "ascii";
  55. ‌static const char *const logbase_enums[] =
  56. {logbase_hex, logbase_octal, logbase_ascii, NULL};
  57. ‌static const char *serial_logbase = logbase_ascii;


  60. ‌static int serial_current_type = 0;

  62. /* Log char CH of type CHTYPE, with TIMEOUT.  */

  64. /* Define bogus char to represent a BREAK.  Should be careful to choose a value
  65.    that can't be confused with a normal char, or an error code.  */
  66. ‌#define SERIAL_BREAK 1235

  68. static void
  69. ‌serial_logchar (struct ui_file *stream, int ch_type, int ch, int timeout)
  70. {
  71.   if (ch_type != serial_current_type)
  72.     {
  73.       fprintf_unfiltered (stream, "\n%c ", ch_type);
  74.       serial_current_type = ch_type;
  75.     }

  77.   if (serial_logbase != logbase_ascii)
  78.     fputc_unfiltered (' ', stream);

  80.   switch (ch)
  81.     {
  82.     case SERIAL_TIMEOUT:
  83.       fprintf_unfiltered (stream, "<Timeout: %d seconds>", timeout);
  84.       return;
  85.     case SERIAL_ERROR:
  86.       fprintf_unfiltered (stream, "<Error: %s>", safe_strerror (errno));
  87.       return;
  88.     case SERIAL_EOF:
  89.       fputs_unfiltered ("<Eof>", stream);
  90.       return;
  91.     case SERIAL_BREAK:
  92.       fputs_unfiltered ("<Break>", stream);
  93.       return;
  94.     default:
  95.       if (serial_logbase == logbase_hex)
  96.         fprintf_unfiltered (stream, "%02x", ch & 0xff);
  97.       else if (serial_logbase == logbase_octal)
  98.         fprintf_unfiltered (stream, "%03o", ch & 0xff);
  99.       else
  100.         switch (ch)
  101.           {
  102.           case '\\':
  103.             fputs_unfiltered ("\\\\", stream);
  104.             break;
  105.           case '\b':
  106.             fputs_unfiltered ("\\b", stream);
  107.             break;
  108.           case '\f':
  109.             fputs_unfiltered ("\\f", stream);
  110.             break;
  111.           case '\n':
  112.             fputs_unfiltered ("\\n", stream);
  113.             break;
  114.           case '\r':
  115.             fputs_unfiltered ("\\r", stream);
  116.             break;
  117.           case '\t':
  118.             fputs_unfiltered ("\\t", stream);
  119.             break;
  120.           case '\v':
  121.             fputs_unfiltered ("\\v", stream);
  122.             break;
  123.           default:
  124.             fprintf_unfiltered (stream,
  125.                                 isprint (ch) ? "%c" : "\\x%02x", ch & 0xFF);
  126.             break;
  127.           }
  128.     }
  129. }

  131. void
  132. ‌serial_log_command (struct target_ops *self, const char *cmd)
  133. {
  134.   if (!serial_logfp)
  135.     return;

  137.   serial_current_type = 'c';

  139.   fputs_unfiltered ("\nc ", serial_logfp);
  140.   fputs_unfiltered (cmd, serial_logfp);

  142.   /* Make sure that the log file is as up-to-date as possible,
  143.      in case we are getting ready to dump core or something.  */
  144.   gdb_flush (serial_logfp);
  145. }


  148. static const struct serial_ops *
  149. ‌serial_interface_lookup (const char *name)
  150. {
  151.   const struct serial_ops *ops;
  152.   int i;

  154.   for (i = 0; VEC_iterate (serial_ops_p, serial_ops_list, i, ops); ++i)
  155.     if (strcmp (name, ops->name) == 0)
  156.       return ops;

  158.   return NULL;
  159. }

  161. void
  162. ‌serial_add_interface (const struct serial_ops *optable)
  163. {
  164.   VEC_safe_push (serial_ops_p, serial_ops_list, optable);
  165. }

  167. /* Return the open serial device for FD, if found, or NULL if FD is
  168.    not already opened.  */

  170. struct serial *
  171. ‌serial_for_fd (int fd)
  172. {
  173.   struct serial *scb;

  175.   for (scb = scb_base; scb; scb = scb->next)
  176.     if (scb->fd == fd)
  177.       return scb;

  179.   return NULL;
  180. }

  182. /* Open up a device or a network socket, depending upon the syntax of NAME.  */

  184. struct serial *
  185. ‌serial_open (const char *name)
  186. {
  187.   struct serial *scb;
  188.   const struct serial_ops *ops;
  189.   const char *open_name = name;

  191.   if (strcmp (name, "pc") == 0)
  192.     ops = serial_interface_lookup ("pc");
  193.   else if (strncmp (name, "lpt", 3) == 0)
  194.     ops = serial_interface_lookup ("parallel");
  195.   else if (strncmp (name, "|", 1) == 0)
  196.     {
  197.       ops = serial_interface_lookup ("pipe");
  198.       /* Discard ``|'' and any space before the command itself.  */
  199.       ++open_name;
  200.       open_name = skip_spaces_const (open_name);
  201.     }
  202.   /* Check for a colon, suggesting an IP address/port pair.
  203.      Do this *after* checking for all the interesting prefixes.  We
  204.      don't want to constrain the syntax of what can follow them.  */
  205.   else if (strchr (name, ':'))
  206.     ops = serial_interface_lookup ("tcp");
  207.   else
  208.     ops = serial_interface_lookup ("hardwire");

  210.   if (!ops)
  211.     return NULL;

  213.   scb = XNEW (struct serial);

  215.   scb->ops = ops;

  217.   scb->bufcnt = 0;
  218.   scb->bufp = scb->buf;
  219.   scb->error_fd = -1;
  220.   scb->refcnt = 1;

  222.   /* `...->open (...)' would get expanded by the open(2) syscall macro.  */
  223.   if ((*scb->ops->open) (scb, open_name))
  224.     {
  225.       xfree (scb);
  226.       return NULL;
  227.     }

  229.   scb->name = xstrdup (name);
  230.   scb->next = scb_base;
  231.   scb->debug_p = 0;
  232.   scb->async_state = 0;
  233.   scb->async_handler = NULL;
  234.   scb->async_context = NULL;
  235.   scb_base = scb;

  237.   if (serial_logfile != NULL)
  238.     {
  239.       serial_logfp = gdb_fopen (serial_logfile, "w");
  240.       if (serial_logfp == NULL)
  241.         perror_with_name (serial_logfile);
  242.     }

  244.   return scb;
  245. }

  247. /* Open a new serial stream using a file handle, using serial
  248.    interface ops OPS.  */

  250. static struct serial *
  251. ‌serial_fdopen_ops (const int fd, const struct serial_ops *ops)
  252. {
  253.   struct serial *scb;

  255.   if (!ops)
  256.     {
  257.       ops = serial_interface_lookup ("terminal");
  258.       if (!ops)
  259.          ops = serial_interface_lookup ("hardwire");
  260.     }

  262.   if (!ops)
  263.     return NULL;

  265.   scb = XCNEW (struct serial);

  267.   scb->ops = ops;

  269.   scb->bufcnt = 0;
  270.   scb->bufp = scb->buf;
  271.   scb->error_fd = -1;
  272.   scb->refcnt = 1;

  274.   scb->name = NULL;
  275.   scb->next = scb_base;
  276.   scb->debug_p = 0;
  277.   scb->async_state = 0;
  278.   scb->async_handler = NULL;
  279.   scb->async_context = NULL;
  280.   scb_base = scb;

  282.   if ((ops->fdopen) != NULL)
  283.     (*ops->fdopen) (scb, fd);
  284.   else
  285.     scb->fd = fd;

  287.   return scb;
  288. }

  290. struct serial *
  291. ‌serial_fdopen (const int fd)
  292. {
  293.   return serial_fdopen_ops (fd, NULL);
  294. }

  296. static void
  297. ‌do_serial_close (struct serial *scb, int really_close)
  298. {
  299.   struct serial *tmp_scb;

  301.   if (serial_logfp)
  302.     {
  303.       fputs_unfiltered ("\nEnd of log\n", serial_logfp);
  304.       serial_current_type = 0;

  306.       /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr?  */
  307.       ui_file_delete (serial_logfp);
  308.       serial_logfp = NULL;
  309.     }

  311.   /* ensure that the FD has been taken out of async mode.  */
  312.   if (scb->async_handler != NULL)
  313.     serial_async (scb, NULL, NULL);

  315.   if (really_close)
  316.     scb->ops->close (scb);

  318.   if (scb->name)
  319.     xfree (scb->name);

  321.   /* For serial_is_open.  */
  322.   scb->bufp = NULL;

  324.   if (scb_base == scb)
  325.     scb_base = scb_base->next;
  326.   else
  327.     for (tmp_scb = scb_base; tmp_scb; tmp_scb = tmp_scb->next)
  328.       {
  329.         if (tmp_scb->next != scb)
  330.           continue;

  332.         tmp_scb->next = tmp_scb->next->next;
  333.         break;
  334.       }

  336.   serial_unref (scb);
  337. }

  339. void
  340. ‌serial_close (struct serial *scb)
  341. {
  342.   do_serial_close (scb, 1);
  343. }

  345. void
  346. ‌serial_un_fdopen (struct serial *scb)
  347. {
  348.   do_serial_close (scb, 0);
  349. }

  351. int
  352. ‌serial_is_open (struct serial *scb)
  353. {
  354.   return scb->bufp != NULL;
  355. }

  357. void
  358. ‌serial_ref (struct serial *scb)
  359. {
  360.   scb->refcnt++;
  361. }

  363. void
  364. ‌serial_unref (struct serial *scb)
  365. {
  366.   --scb->refcnt;
  367.   if (scb->refcnt == 0)
  368.     xfree (scb);
  369. }

  371. int
  372. ‌serial_readchar (struct serial *scb, int timeout)
  373. {
  374.   int ch;

  376.   /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
  377.      code is finished.  */
  378.   if (0 && serial_is_async_p (scb) && timeout < 0)
  379.     internal_error (__FILE__, __LINE__,
  380.                     _("serial_readchar: blocking read in async mode"));

  382.   ch = scb->ops->readchar (scb, timeout);
  383.   if (serial_logfp != NULL)
  384.     {
  385.       serial_logchar (serial_logfp, 'r', ch, timeout);

  387.       /* Make sure that the log file is as up-to-date as possible,
  388.          in case we are getting ready to dump core or something.  */
  389.       gdb_flush (serial_logfp);
  390.     }
  391.   if (serial_debug_p (scb))
  392.     {
  393.       fprintf_unfiltered (gdb_stdlog, "[");
  394.       serial_logchar (gdb_stdlog, 'r', ch, timeout);
  395.       fprintf_unfiltered (gdb_stdlog, "]");
  396.       gdb_flush (gdb_stdlog);
  397.     }

  399.   return (ch);
  400. }

  402. int
  403. ‌serial_write (struct serial *scb, const void *buf, size_t count)
  404. {
  405.   if (serial_logfp != NULL)
  406.     {
  407.       const char *str = buf;
  408.       size_t c;

  410.       for (c = 0; c < count; c++)
  411.         serial_logchar (serial_logfp, 'w', str[c] & 0xff, 0);

  413.       /* Make sure that the log file is as up-to-date as possible,
  414.          in case we are getting ready to dump core or something.  */
  415.       gdb_flush (serial_logfp);
  416.     }
  417.   if (serial_debug_p (scb))
  418.     {
  419.       const char *str = buf;
  420.       size_t c;

  422.       for (c = 0; c < count; c++)
  423.         {
  424.           fprintf_unfiltered (gdb_stdlog, "[");
  425.           serial_logchar (gdb_stdlog, 'w', str[c] & 0xff, 0);
  426.           fprintf_unfiltered (gdb_stdlog, "]");
  427.         }
  428.       gdb_flush (gdb_stdlog);
  429.     }

  431.   return (scb->ops->write (scb, buf, count));
  432. }

  434. void
  435. ‌serial_printf (struct serial *desc, const char *format,...)
  436. {
  437.   va_list args;
  438.   char *buf;
  439.   va_start (args, format);

  441.   buf = xstrvprintf (format, args);
  442.   serial_write (desc, buf, strlen (buf));

  444.   xfree (buf);
  445.   va_end (args);
  446. }

  448. int
  449. ‌serial_drain_output (struct serial *scb)
  450. {
  451.   return scb->ops->drain_output (scb);
  452. }

  454. int
  455. ‌serial_flush_output (struct serial *scb)
  456. {
  457.   return scb->ops->flush_output (scb);
  458. }

  460. int
  461. ‌serial_flush_input (struct serial *scb)
  462. {
  463.   return scb->ops->flush_input (scb);
  464. }

  466. int
  467. ‌serial_send_break (struct serial *scb)
  468. {
  469.   if (serial_logfp != NULL)
  470.     serial_logchar (serial_logfp, 'w', SERIAL_BREAK, 0);

  472.   return (scb->ops->send_break (scb));
  473. }

  475. void
  476. ‌serial_raw (struct serial *scb)
  477. {
  478.   scb->ops->go_raw (scb);
  479. }

  481. serial_ttystate
  482. ‌serial_get_tty_state (struct serial *scb)
  483. {
  484.   return scb->ops->get_tty_state (scb);
  485. }

  487. serial_ttystate
  488. ‌serial_copy_tty_state (struct serial *scb, serial_ttystate ttystate)
  489. {
  490.   return scb->ops->copy_tty_state (scb, ttystate);
  491. }

  493. int
  494. ‌serial_set_tty_state (struct serial *scb, serial_ttystate ttystate)
  495. {
  496.   return scb->ops->set_tty_state (scb, ttystate);
  497. }

  499. void
  500. ‌serial_print_tty_state (struct serial *scb,
  501.                         serial_ttystate ttystate,
  502.                         struct ui_file *stream)
  503. {
  504.   scb->ops->print_tty_state (scb, ttystate, stream);
  505. }

  507. int
  508. ‌serial_noflush_set_tty_state (struct serial *scb,
  509.                               serial_ttystate new_ttystate,
  510.                               serial_ttystate old_ttystate)
  511. {
  512.   return scb->ops->noflush_set_tty_state (scb, new_ttystate, old_ttystate);
  513. }

  515. int
  516. ‌serial_setbaudrate (struct serial *scb, int rate)
  517. {
  518.   return scb->ops->setbaudrate (scb, rate);
  519. }

  521. int
  522. ‌serial_setstopbits (struct serial *scb, int num)
  523. {
  524.   return scb->ops->setstopbits (scb, num);
  525. }

  527. int
  528. ‌serial_can_async_p (struct serial *scb)
  529. {
  530.   return (scb->ops->async != NULL);
  531. }

  533. int
  534. ‌serial_is_async_p (struct serial *scb)
  535. {
  536.   return (scb->ops->async != NULL) && (scb->async_handler != NULL);
  537. }

  539. void
  540. ‌serial_async (struct serial *scb,
  541.               serial_event_ftype *handler,
  542.               void *context)
  543. {
  544.   int changed = ((scb->async_handler == NULL) != (handler == NULL));

  546.   scb->async_handler = handler;
  547.   scb->async_context = context;
  548.   /* Only change mode if there is a need.  */
  549.   if (changed)
  550.     scb->ops->async (scb, handler != NULL);
  551. }

  553. void
  554. ‌serial_debug (struct serial *scb, int debug_p)
  555. {
  556.   scb->debug_p = debug_p;
  557. }

  559. int
  560. ‌serial_debug_p (struct serial *scb)
  561. {
  562.   return scb->debug_p || global_serial_debug_p;
  563. }

  565. #ifdef USE_WIN32API
  566. void
  567. ‌serial_wait_handle (struct serial *scb, HANDLE *read, HANDLE *except)
  568. {
  569.   if (scb->ops->wait_handle)
  570.     scb->ops->wait_handle (scb, read, except);
  571.   else
  572.     {
  573.       *read = (HANDLE) _get_osfhandle (scb->fd);
  574.       *except = NULL;
  575.     }
  576. }

  578. void
  579. ‌serial_done_wait_handle (struct serial *scb)
  580. {
  581.   if (scb->ops->done_wait_handle)
  582.     scb->ops->done_wait_handle (scb);
  583. }
  584. #endif

  586. int
  587. ‌serial_pipe (struct serial *scbs[2])
  588. {
  589.   const struct serial_ops *ops;
  590.   int fildes[2];

  592.   ops = serial_interface_lookup ("pipe");
  593.   if (!ops)
  594.     {
  595.       errno = ENOSYS;
  596.       return -1;
  597.     }

  599.   if (gdb_pipe (fildes) == -1)
  600.     return -1;

  602.   scbs[0] = serial_fdopen_ops (fildes[0], ops);
  603.   scbs[1] = serial_fdopen_ops (fildes[1], ops);
  604.   return 0;
  605. }

  607. /* Serial set/show framework.  */

  609. ‌static struct cmd_list_element *serial_set_cmdlist;
  610. ‌static struct cmd_list_element *serial_show_cmdlist;

  612. static void
  613. ‌serial_set_cmd (char *args, int from_tty)
  614. {
  615.   printf_unfiltered ("\"set serial\" must be followed "
  616.                      "by the name of a command.\n");
  617.   help_list (serial_set_cmdlist, "set serial ", all_commands, gdb_stdout);
  618. }

  620. static void
  621. ‌serial_show_cmd (char *args, int from_tty)
  622. {
  623.   cmd_show_list (serial_show_cmdlist, from_tty, "");
  624. }

  626. /* Baud rate specified for talking to serial target systems.  Default
  627.    is left as -1, so targets can choose their own defaults.  */
  628. /* FIXME: This means that "show serial baud" and gr_files_info can
  629.    print -1 or (unsigned int)-1.  This is a Bad User Interface.  */

  631. ‌int baud_rate = -1;

  633. static void
  634. ‌serial_baud_show_cmd (struct ui_file *file, int from_tty,
  635.                       struct cmd_list_element *c, const char *value)
  636. {
  637.   fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
  638.                     value);
  639. }

  641. void
  642. ‌_initialize_serial (void)
  643. {
  644. #if 0
  645.   add_com ("connect", class_obscure, connect_command, _("\
  646. Connect the terminal directly up to the command monitor.\n\
  647. Use <CR>~. or <CR>~^D to break out."));
  648. #endif /* 0 */

  650.   add_prefix_cmd ("serial", class_maintenance, serial_set_cmd, _("\
  651. Set default serial/parallel port configuration."),
  652.                   &serial_set_cmdlist, "set serial ",
  653.                   0/*allow-unknown*/,
  654.                   &setlist);

  656.   add_prefix_cmd ("serial", class_maintenance, serial_show_cmd, _("\
  657. Show default serial/parallel port configuration."),
  658.                   &serial_show_cmdlist, "show serial ",
  659.                   0/*allow-unknown*/,
  660.                   &showlist);

  662.   /* If target is open when baud changes, it doesn't take effect until
  663.      the next open (I think, not sure).  */
  664.   add_setshow_zinteger_cmd ("baud", no_class, &baud_rate, _("\
  665. Set baud rate for remote serial I/O."), _("\
  666. Show baud rate for remote serial I/O."), _("\
  667. This value is used to set the speed of the serial port when debugging\n\
  668. using remote targets."),
  669.                             NULL,
  670.                             serial_baud_show_cmd,
  671.                             &serial_set_cmdlist, &serial_show_cmdlist);

  673.   add_setshow_filename_cmd ("remotelogfile", no_class, &serial_logfile, _("\
  674. Set filename for remote session recording."), _("\
  675. Show filename for remote session recording."), _("\
  676. This file is used to record the remote session for future playback\n\
  677. by gdbserver."),
  678.                             NULL,
  679.                             NULL, /* FIXME: i18n: */
  680.                             &setlist, &showlist);

  682.   add_setshow_enum_cmd ("remotelogbase", no_class, logbase_enums,
  683.                         &serial_logbase, _("\
  684. Set numerical base for remote session logging"), _("\
  685. Show numerical base for remote session logging"), NULL,
  686.                         NULL,
  687.                         NULL, /* FIXME: i18n: */
  688.                         &setlist, &showlist);

  690.   add_setshow_zuinteger_cmd ("serial", class_maintenance,
  691.                              &global_serial_debug_p, _("\
  692. Set serial debugging."), _("\
  693. Show serial debugging."), _("\
  694. When non-zero, serial port debugging is enabled."),
  695.                              NULL,
  696.                              NULL, /* FIXME: i18n: */
  697.                              &setdebuglist, &showdebuglist);
  698. }