gdb/serial.c

   1 /* Generic serial interface routines
   2
   3    Copyright (C) 1992-2017 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #include "defs.h"
  21 #include <ctype.h>
  22 #include "serial.h"
  23 #include "gdbcmd.h"
  24 #include "cli/cli-utils.h"
  25
  26 extern void _initialize_serial (void);
  27
  28 /* Is serial being debugged?  */
  29
  30 static unsigned int global_serial_debug_p;
  31
  32 typedef const struct serial_ops *serial_ops_p;
  33 DEF_VEC_P (serial_ops_p);
  34
  35 /* Serial I/O handlers.  */
  36
  37 VEC (serial_ops_p) *serial_ops_list = NULL;
  38
  39 /* Pointer to list of scb's.  */
  40
  41 static struct serial *scb_base;
  42
  43 /* Non-NULL gives filename which contains a recording of the remote session,
  44    suitable for playback by gdbserver.  */
  45
  46 static char *serial_logfile = NULL;
  47 static struct ui_file *serial_logfp = NULL;
  48
  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;
  58 \f
  59
  60 static int serial_current_type = 0;
  61
  62 /* Log char CH of type CHTYPE, with TIMEOUT.  */
  63
  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
  67
  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     }
  76
  77   if (serial_logbase != logbase_ascii)
  78     fputc_unfiltered (' ', stream);
  79
  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 }
 130
 131 void
 132 serial_log_command (struct target_ops *self, const char *cmd)
 133 {
 134   if (!serial_logfp)
 135     return;
 136
 137   serial_current_type = 'c';
 138
 139   fputs_unfiltered ("\nc ", serial_logfp);
 140   fputs_unfiltered (cmd, serial_logfp);
 141
 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 }
 146
 147 \f
 148 static const struct serial_ops *
 149 serial_interface_lookup (const char *name)
 150 {
 151   const struct serial_ops *ops;
 152   int i;
 153
 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;
 157
 158   return NULL;
 159 }
 160
 161 void
 162 serial_add_interface (const struct serial_ops *optable)
 163 {
 164   VEC_safe_push (serial_ops_p, serial_ops_list, optable);
 165 }
 166
 167 /* Return the open serial device for FD, if found, or NULL if FD is
 168    not already opened.  */
 169
 170 struct serial *
 171 serial_for_fd (int fd)
 172 {
 173   struct serial *scb;
 174
 175   for (scb = scb_base; scb; scb = scb->next)
 176     if (scb->fd == fd)
 177       return scb;
 178
 179   return NULL;
 180 }
 181
 182 /* Create a new serial for OPS.  */
 183
 184 static struct serial *
 185 new_serial (const struct serial_ops *ops)
 186 {
 187   struct serial *scb;
 188
 189   scb = XCNEW (struct serial);
 190
 191   scb->ops = ops;
 192
 193   scb->bufp = scb->buf;
 194   scb->error_fd = -1;
 195   scb->refcnt = 1;
 196
 197   return scb;
 198 }
 199
 200 static struct serial *serial_open_ops_1 (const struct serial_ops *ops,
 201                                          const char *open_name);
 202
 203 /* Open up a device or a network socket, depending upon the syntax of NAME.  */
 204
 205 struct serial *
 206 serial_open (const char *name)
 207 {
 208   struct serial *scb;
 209   const struct serial_ops *ops;
 210   const char *open_name = name;
 211
 212   if (startswith (name, "|"))
 213     {
 214       ops = serial_interface_lookup ("pipe");
 215       /* Discard ``|'' and any space before the command itself.  */
 216       ++open_name;
 217       open_name = skip_spaces_const (open_name);
 218     }
 219   /* Check for a colon, suggesting an IP address/port pair.
 220      Do this *after* checking for all the interesting prefixes.  We
 221      don't want to constrain the syntax of what can follow them.  */
 222   else if (strchr (name, ':'))
 223     ops = serial_interface_lookup ("tcp");
 224   else
 225     ops = serial_interface_lookup ("hardwire");
 226
 227   if (!ops)
 228     return NULL;
 229
 230   return serial_open_ops_1 (ops, open_name);
 231 }
 232
 233 /* Open up a serial for OPS, passing OPEN_NAME to the open method.  */
 234
 235 static struct serial *
 236 serial_open_ops_1 (const struct serial_ops *ops, const char *open_name)
 237 {
 238   struct serial *scb;
 239
 240   scb = new_serial (ops);
 241
 242   /* `...->open (...)' would get expanded by the open(2) syscall macro.  */
 243   if ((*scb->ops->open) (scb, open_name))
 244     {
 245       xfree (scb);
 246       return NULL;
 247     }
 248
 249   scb->next = scb_base;
 250   scb_base = scb;
 251
 252   if (serial_logfile != NULL)
 253     {
 254       stdio_file_up file (new stdio_file ());
 255
 256       if (!file->open (serial_logfile, "w"))
 257         perror_with_name (serial_logfile);
 258
 259       serial_logfp = file.release ();
 260     }
 261
 262   return scb;
 263 }
 264
 265 /* See serial.h.  */
 266
 267 struct serial *
 268 serial_open_ops (const struct serial_ops *ops)
 269 {
 270   return serial_open_ops_1 (ops, NULL);
 271 }
 272
 273 /* Open a new serial stream using a file handle, using serial
 274    interface ops OPS.  */
 275
 276 static struct serial *
 277 serial_fdopen_ops (const int fd, const struct serial_ops *ops)
 278 {
 279   struct serial *scb;
 280
 281   if (!ops)
 282     {
 283       ops = serial_interface_lookup ("terminal");
 284       if (!ops)
 285         ops = serial_interface_lookup ("hardwire");
 286     }
 287
 288   if (!ops)
 289     return NULL;
 290
 291   scb = new_serial (ops);
 292
 293   scb->next = scb_base;
 294   scb_base = scb;
 295
 296   if ((ops->fdopen) != NULL)
 297     (*ops->fdopen) (scb, fd);
 298   else
 299     scb->fd = fd;
 300
 301   return scb;
 302 }
 303
 304 struct serial *
 305 serial_fdopen (const int fd)
 306 {
 307   return serial_fdopen_ops (fd, NULL);
 308 }
 309
 310 static void
 311 do_serial_close (struct serial *scb, int really_close)
 312 {
 313   struct serial *tmp_scb;
 314
 315   if (serial_logfp)
 316     {
 317       fputs_unfiltered ("\nEnd of log\n", serial_logfp);
 318       serial_current_type = 0;
 319
 320       /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr?  */
 321       delete serial_logfp;
 322       serial_logfp = NULL;
 323     }
 324
 325   /* ensure that the FD has been taken out of async mode.  */
 326   if (scb->async_handler != NULL)
 327     serial_async (scb, NULL, NULL);
 328
 329   if (really_close)
 330     scb->ops->close (scb);
 331
 332   /* For serial_is_open.  */
 333   scb->bufp = NULL;
 334
 335   if (scb_base == scb)
 336     scb_base = scb_base->next;
 337   else
 338     for (tmp_scb = scb_base; tmp_scb; tmp_scb = tmp_scb->next)
 339       {
 340         if (tmp_scb->next != scb)
 341           continue;
 342
 343         tmp_scb->next = tmp_scb->next->next;
 344         break;
 345       }
 346
 347   serial_unref (scb);
 348 }
 349
 350 void
 351 serial_close (struct serial *scb)
 352 {
 353   do_serial_close (scb, 1);
 354 }
 355
 356 void
 357 serial_un_fdopen (struct serial *scb)
 358 {
 359   do_serial_close (scb, 0);
 360 }
 361
 362 int
 363 serial_is_open (struct serial *scb)
 364 {
 365   return scb->bufp != NULL;
 366 }
 367
 368 void
 369 serial_ref (struct serial *scb)
 370 {
 371   scb->refcnt++;
 372 }
 373
 374 void
 375 serial_unref (struct serial *scb)
 376 {
 377   --scb->refcnt;
 378   if (scb->refcnt == 0)
 379     xfree (scb);
 380 }
 381
 382 int
 383 serial_readchar (struct serial *scb, int timeout)
 384 {
 385   int ch;
 386
 387   /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
 388      code is finished.  */
 389   if (0 && serial_is_async_p (scb) && timeout < 0)
 390     internal_error (__FILE__, __LINE__,
 391                     _("serial_readchar: blocking read in async mode"));
 392
 393   ch = scb->ops->readchar (scb, timeout);
 394   if (serial_logfp != NULL)
 395     {
 396       serial_logchar (serial_logfp, 'r', ch, timeout);
 397
 398       /* Make sure that the log file is as up-to-date as possible,
 399          in case we are getting ready to dump core or something.  */
 400       gdb_flush (serial_logfp);
 401     }
 402   if (serial_debug_p (scb))
 403     {
 404       fprintf_unfiltered (gdb_stdlog, "[");
 405       serial_logchar (gdb_stdlog, 'r', ch, timeout);
 406       fprintf_unfiltered (gdb_stdlog, "]");
 407       gdb_flush (gdb_stdlog);
 408     }
 409
 410   return (ch);
 411 }
 412
 413 int
 414 serial_write (struct serial *scb, const void *buf, size_t count)
 415 {
 416   if (serial_logfp != NULL)
 417     {
 418       const char *str = (const char *) buf;
 419       size_t c;
 420
 421       for (c = 0; c < count; c++)
 422         serial_logchar (serial_logfp, 'w', str[c] & 0xff, 0);
 423
 424       /* Make sure that the log file is as up-to-date as possible,
 425          in case we are getting ready to dump core or something.  */
 426       gdb_flush (serial_logfp);
 427     }
 428   if (serial_debug_p (scb))
 429     {
 430       const char *str = (const char *) buf;
 431       size_t c;
 432
 433       for (c = 0; c < count; c++)
 434         {
 435           fprintf_unfiltered (gdb_stdlog, "[");
 436           serial_logchar (gdb_stdlog, 'w', str[c] & 0xff, 0);
 437           fprintf_unfiltered (gdb_stdlog, "]");
 438         }
 439       gdb_flush (gdb_stdlog);
 440     }
 441
 442   return (scb->ops->write (scb, buf, count));
 443 }
 444
 445 void
 446 serial_printf (struct serial *desc, const char *format,...)
 447 {
 448   va_list args;
 449   char *buf;
 450   va_start (args, format);
 451
 452   buf = xstrvprintf (format, args);
 453   serial_write (desc, buf, strlen (buf));
 454
 455   xfree (buf);
 456   va_end (args);
 457 }
 458
 459 int
 460 serial_drain_output (struct serial *scb)
 461 {
 462   return scb->ops->drain_output (scb);
 463 }
 464
 465 int
 466 serial_flush_output (struct serial *scb)
 467 {
 468   return scb->ops->flush_output (scb);
 469 }
 470
 471 int
 472 serial_flush_input (struct serial *scb)
 473 {
 474   return scb->ops->flush_input (scb);
 475 }
 476
 477 int
 478 serial_send_break (struct serial *scb)
 479 {
 480   if (serial_logfp != NULL)
 481     serial_logchar (serial_logfp, 'w', SERIAL_BREAK, 0);
 482
 483   return (scb->ops->send_break (scb));
 484 }
 485
 486 void
 487 serial_raw (struct serial *scb)
 488 {
 489   scb->ops->go_raw (scb);
 490 }
 491
 492 serial_ttystate
 493 serial_get_tty_state (struct serial *scb)
 494 {
 495   return scb->ops->get_tty_state (scb);
 496 }
 497
 498 serial_ttystate
 499 serial_copy_tty_state (struct serial *scb, serial_ttystate ttystate)
 500 {
 501   return scb->ops->copy_tty_state (scb, ttystate);
 502 }
 503
 504 int
 505 serial_set_tty_state (struct serial *scb, serial_ttystate ttystate)
 506 {
 507   return scb->ops->set_tty_state (scb, ttystate);
 508 }
 509
 510 void
 511 serial_print_tty_state (struct serial *scb,
 512                         serial_ttystate ttystate,
 513                         struct ui_file *stream)
 514 {
 515   scb->ops->print_tty_state (scb, ttystate, stream);
 516 }
 517
 518 int
 519 serial_noflush_set_tty_state (struct serial *scb,
 520                               serial_ttystate new_ttystate,
 521                               serial_ttystate old_ttystate)
 522 {
 523   return scb->ops->noflush_set_tty_state (scb, new_ttystate, old_ttystate);
 524 }
 525
 526 int
 527 serial_setbaudrate (struct serial *scb, int rate)
 528 {
 529   return scb->ops->setbaudrate (scb, rate);
 530 }
 531
 532 int
 533 serial_setstopbits (struct serial *scb, int num)
 534 {
 535   return scb->ops->setstopbits (scb, num);
 536 }
 537
 538 /* See serial.h.  */
 539
 540 int
 541 serial_setparity (struct serial *scb, int parity)
 542 {
 543   return scb->ops->setparity (scb, parity);
 544 }
 545
 546 int
 547 serial_can_async_p (struct serial *scb)
 548 {
 549   return (scb->ops->async != NULL);
 550 }
 551
 552 int
 553 serial_is_async_p (struct serial *scb)
 554 {
 555   return (scb->ops->async != NULL) && (scb->async_handler != NULL);
 556 }
 557
 558 void
 559 serial_async (struct serial *scb,
 560               serial_event_ftype *handler,
 561               void *context)
 562 {
 563   int changed = ((scb->async_handler == NULL) != (handler == NULL));
 564
 565   scb->async_handler = handler;
 566   scb->async_context = context;
 567   /* Only change mode if there is a need.  */
 568   if (changed)
 569     scb->ops->async (scb, handler != NULL);
 570 }
 571
 572 void
 573 serial_debug (struct serial *scb, int debug_p)
 574 {
 575   scb->debug_p = debug_p;
 576 }
 577
 578 int
 579 serial_debug_p (struct serial *scb)
 580 {
 581   return scb->debug_p || global_serial_debug_p;
 582 }
 583
 584 #ifdef USE_WIN32API
 585 void
 586 serial_wait_handle (struct serial *scb, HANDLE *read, HANDLE *except)
 587 {
 588   if (scb->ops->wait_handle)
 589     scb->ops->wait_handle (scb, read, except);
 590   else
 591     {
 592       *read = (HANDLE) _get_osfhandle (scb->fd);
 593       *except = NULL;
 594     }
 595 }
 596
 597 void
 598 serial_done_wait_handle (struct serial *scb)
 599 {
 600   if (scb->ops->done_wait_handle)
 601     scb->ops->done_wait_handle (scb);
 602 }
 603 #endif
 604
 605 int
 606 serial_pipe (struct serial *scbs[2])
 607 {
 608   const struct serial_ops *ops;
 609   int fildes[2];
 610
 611   ops = serial_interface_lookup ("pipe");
 612   if (!ops)
 613     {
 614       errno = ENOSYS;
 615       return -1;
 616     }
 617
 618   if (gdb_pipe (fildes) == -1)
 619     return -1;
 620
 621   scbs[0] = serial_fdopen_ops (fildes[0], ops);
 622   scbs[1] = serial_fdopen_ops (fildes[1], ops);
 623   return 0;
 624 }
 625
 626 /* Serial set/show framework.  */
 627
 628 static struct cmd_list_element *serial_set_cmdlist;
 629 static struct cmd_list_element *serial_show_cmdlist;
 630
 631 static void
 632 serial_set_cmd (char *args, int from_tty)
 633 {
 634   printf_unfiltered ("\"set serial\" must be followed "
 635                      "by the name of a command.\n");
 636   help_list (serial_set_cmdlist, "set serial ", all_commands, gdb_stdout);
 637 }
 638
 639 static void
 640 serial_show_cmd (char *args, int from_tty)
 641 {
 642   cmd_show_list (serial_show_cmdlist, from_tty, "");
 643 }
 644
 645 /* Baud rate specified for talking to serial target systems.  Default
 646    is left as -1, so targets can choose their own defaults.  */
 647 /* FIXME: This means that "show serial baud" and gr_files_info can
 648    print -1 or (unsigned int)-1.  This is a Bad User Interface.  */
 649
 650 int baud_rate = -1;
 651
 652 static void
 653 serial_baud_show_cmd (struct ui_file *file, int from_tty,
 654                       struct cmd_list_element *c, const char *value)
 655 {
 656   fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
 657                     value);
 658 }
 659
 660 /* Parity for serial port.  */
 661
 662 int serial_parity = GDBPARITY_NONE;
 663
 664 static const char parity_none[] = "none";
 665 static const char parity_odd[] = "odd";
 666 static const char parity_even[] = "even";
 667 static const char *const parity_enums[] =
 668   {parity_none, parity_odd, parity_even,  NULL};
 669 static const char *parity = parity_none;
 670
 671 /* Set serial_parity value.  */
 672
 673 static void
 674 set_parity (char *ignore_args, int from_tty, struct cmd_list_element *c)
 675 {
 676   if (parity == parity_odd)
 677     serial_parity = GDBPARITY_ODD;
 678   else if (parity == parity_even)
 679     serial_parity = GDBPARITY_EVEN;
 680   else
 681     serial_parity = GDBPARITY_NONE;
 682 }
 683
 684 void
 685 _initialize_serial (void)
 686 {
 687 #if 0
 688   add_com ("connect", class_obscure, connect_command, _("\
 689 Connect the terminal directly up to the command monitor.\n\
 690 Use <CR>~. or <CR>~^D to break out."));
 691 #endif /* 0 */
 692
 693   add_prefix_cmd ("serial", class_maintenance, serial_set_cmd, _("\
 694 Set default serial/parallel port configuration."),
 695                   &serial_set_cmdlist, "set serial ",
 696                   0/*allow-unknown*/,
 697                   &setlist);
 698
 699   add_prefix_cmd ("serial", class_maintenance, serial_show_cmd, _("\
 700 Show default serial/parallel port configuration."),
 701                   &serial_show_cmdlist, "show serial ",
 702                   0/*allow-unknown*/,
 703                   &showlist);
 704
 705   /* If target is open when baud changes, it doesn't take effect until
 706      the next open (I think, not sure).  */
 707   add_setshow_zinteger_cmd ("baud", no_class, &baud_rate, _("\
 708 Set baud rate for remote serial I/O."), _("\
 709 Show baud rate for remote serial I/O."), _("\
 710 This value is used to set the speed of the serial port when debugging\n\
 711 using remote targets."),
 712                             NULL,
 713                             serial_baud_show_cmd,
 714                             &serial_set_cmdlist, &serial_show_cmdlist);
 715
 716   add_setshow_enum_cmd ("parity", no_class, parity_enums,
 717                         &parity, _("\
 718 Set parity for remote serial I/O"), _("\
 719 Show parity for remote serial I/O"), NULL,
 720                         set_parity,
 721                         NULL, /* FIXME: i18n: */
 722                         &serial_set_cmdlist, &serial_show_cmdlist);
 723
 724   add_setshow_filename_cmd ("remotelogfile", no_class, &serial_logfile, _("\
 725 Set filename for remote session recording."), _("\
 726 Show filename for remote session recording."), _("\
 727 This file is used to record the remote session for future playback\n\
 728 by gdbserver."),
 729                             NULL,
 730                             NULL, /* FIXME: i18n: */
 731                             &setlist, &showlist);
 732
 733   add_setshow_enum_cmd ("remotelogbase", no_class, logbase_enums,
 734                         &serial_logbase, _("\
 735 Set numerical base for remote session logging"), _("\
 736 Show numerical base for remote session logging"), NULL,
 737                         NULL,
 738                         NULL, /* FIXME: i18n: */
 739                         &setlist, &showlist);
 740
 741   add_setshow_zuinteger_cmd ("serial", class_maintenance,
 742                              &global_serial_debug_p, _("\
 743 Set serial debugging."), _("\
 744 Show serial debugging."), _("\
 745 When non-zero, serial port debugging is enabled."),
 746                              NULL,
 747                              NULL, /* FIXME: i18n: */
 748                              &setdebuglist, &showdebuglist);
 749 }