gdb/serial.c

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