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