gdb/serial.c

   1 /* Generic serial interface routines
   2
   3    Copyright (C) 1992-2016 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 /* Open up a device or a network socket, depending upon the syntax of NAME.  */
 183
 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;
 190
 191   if (strcmp (name, "pc") == 0)
 192     ops = serial_interface_lookup ("pc");
 193   else if (startswith (name, "lpt"))
 194     ops = serial_interface_lookup ("parallel");
 195   else if (startswith (name, "|"))
 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");
 209
 210   if (!ops)
 211     return NULL;
 212
 213   scb = XNEW (struct serial);
 214
 215   scb->ops = ops;
 216
 217   scb->bufcnt = 0;
 218   scb->bufp = scb->buf;
 219   scb->error_fd = -1;
 220   scb->refcnt = 1;
 221
 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     }
 228
 229   scb->next = scb_base;
 230   scb->debug_p = 0;
 231   scb->async_state = 0;
 232   scb->async_handler = NULL;
 233   scb->async_context = NULL;
 234   scb_base = scb;
 235
 236   if (serial_logfile != NULL)
 237     {
 238       serial_logfp = gdb_fopen (serial_logfile, "w");
 239       if (serial_logfp == NULL)
 240         perror_with_name (serial_logfile);
 241     }
 242
 243   return scb;
 244 }
 245
 246 /* Open a new serial stream using a file handle, using serial
 247    interface ops OPS.  */
 248
 249 static struct serial *
 250 serial_fdopen_ops (const int fd, const struct serial_ops *ops)
 251 {
 252   struct serial *scb;
 253
 254   if (!ops)
 255     {
 256       ops = serial_interface_lookup ("terminal");
 257       if (!ops)
 258         ops = serial_interface_lookup ("hardwire");
 259     }
 260
 261   if (!ops)
 262     return NULL;
 263
 264   scb = XCNEW (struct serial);
 265
 266   scb->ops = ops;
 267
 268   scb->bufcnt = 0;
 269   scb->bufp = scb->buf;
 270   scb->error_fd = -1;
 271   scb->refcnt = 1;
 272
 273   scb->next = scb_base;
 274   scb->debug_p = 0;
 275   scb->async_state = 0;
 276   scb->async_handler = NULL;
 277   scb->async_context = NULL;
 278   scb_base = scb;
 279
 280   if ((ops->fdopen) != NULL)
 281     (*ops->fdopen) (scb, fd);
 282   else
 283     scb->fd = fd;
 284
 285   return scb;
 286 }
 287
 288 struct serial *
 289 serial_fdopen (const int fd)
 290 {
 291   return serial_fdopen_ops (fd, NULL);
 292 }
 293
 294 static void
 295 do_serial_close (struct serial *scb, int really_close)
 296 {
 297   struct serial *tmp_scb;
 298
 299   if (serial_logfp)
 300     {
 301       fputs_unfiltered ("\nEnd of log\n", serial_logfp);
 302       serial_current_type = 0;
 303
 304       /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr?  */
 305       ui_file_delete (serial_logfp);
 306       serial_logfp = NULL;
 307     }
 308
 309   /* ensure that the FD has been taken out of async mode.  */
 310   if (scb->async_handler != NULL)
 311     serial_async (scb, NULL, NULL);
 312
 313   if (really_close)
 314     scb->ops->close (scb);
 315
 316   /* For serial_is_open.  */
 317   scb->bufp = NULL;
 318
 319   if (scb_base == scb)
 320     scb_base = scb_base->next;
 321   else
 322     for (tmp_scb = scb_base; tmp_scb; tmp_scb = tmp_scb->next)
 323       {
 324         if (tmp_scb->next != scb)
 325           continue;
 326
 327         tmp_scb->next = tmp_scb->next->next;
 328         break;
 329       }
 330
 331   serial_unref (scb);
 332 }
 333
 334 void
 335 serial_close (struct serial *scb)
 336 {
 337   do_serial_close (scb, 1);
 338 }
 339
 340 void
 341 serial_un_fdopen (struct serial *scb)
 342 {
 343   do_serial_close (scb, 0);
 344 }
 345
 346 int
 347 serial_is_open (struct serial *scb)
 348 {
 349   return scb->bufp != NULL;
 350 }
 351
 352 void
 353 serial_ref (struct serial *scb)
 354 {
 355   scb->refcnt++;
 356 }
 357
 358 void
 359 serial_unref (struct serial *scb)
 360 {
 361   --scb->refcnt;
 362   if (scb->refcnt == 0)
 363     xfree (scb);
 364 }
 365
 366 int
 367 serial_readchar (struct serial *scb, int timeout)
 368 {
 369   int ch;
 370
 371   /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
 372      code is finished.  */
 373   if (0 && serial_is_async_p (scb) && timeout < 0)
 374     internal_error (__FILE__, __LINE__,
 375                     _("serial_readchar: blocking read in async mode"));
 376
 377   ch = scb->ops->readchar (scb, timeout);
 378   if (serial_logfp != NULL)
 379     {
 380       serial_logchar (serial_logfp, 'r', ch, timeout);
 381
 382       /* Make sure that the log file is as up-to-date as possible,
 383          in case we are getting ready to dump core or something.  */
 384       gdb_flush (serial_logfp);
 385     }
 386   if (serial_debug_p (scb))
 387     {
 388       fprintf_unfiltered (gdb_stdlog, "[");
 389       serial_logchar (gdb_stdlog, 'r', ch, timeout);
 390       fprintf_unfiltered (gdb_stdlog, "]");
 391       gdb_flush (gdb_stdlog);
 392     }
 393
 394   return (ch);
 395 }
 396
 397 int
 398 serial_write (struct serial *scb, const void *buf, size_t count)
 399 {
 400   if (serial_logfp != NULL)
 401     {
 402       const char *str = (const char *) buf;
 403       size_t c;
 404
 405       for (c = 0; c < count; c++)
 406         serial_logchar (serial_logfp, 'w', str[c] & 0xff, 0);
 407
 408       /* Make sure that the log file is as up-to-date as possible,
 409          in case we are getting ready to dump core or something.  */
 410       gdb_flush (serial_logfp);
 411     }
 412   if (serial_debug_p (scb))
 413     {
 414       const char *str = (const char *) buf;
 415       size_t c;
 416
 417       for (c = 0; c < count; c++)
 418         {
 419           fprintf_unfiltered (gdb_stdlog, "[");
 420           serial_logchar (gdb_stdlog, 'w', str[c] & 0xff, 0);
 421           fprintf_unfiltered (gdb_stdlog, "]");
 422         }
 423       gdb_flush (gdb_stdlog);
 424     }
 425
 426   return (scb->ops->write (scb, buf, count));
 427 }
 428
 429 void
 430 serial_printf (struct serial *desc, const char *format,...)
 431 {
 432   va_list args;
 433   char *buf;
 434   va_start (args, format);
 435
 436   buf = xstrvprintf (format, args);
 437   serial_write (desc, buf, strlen (buf));
 438
 439   xfree (buf);
 440   va_end (args);
 441 }
 442
 443 int
 444 serial_drain_output (struct serial *scb)
 445 {
 446   return scb->ops->drain_output (scb);
 447 }
 448
 449 int
 450 serial_flush_output (struct serial *scb)
 451 {
 452   return scb->ops->flush_output (scb);
 453 }
 454
 455 int
 456 serial_flush_input (struct serial *scb)
 457 {
 458   return scb->ops->flush_input (scb);
 459 }
 460
 461 int
 462 serial_send_break (struct serial *scb)
 463 {
 464   if (serial_logfp != NULL)
 465     serial_logchar (serial_logfp, 'w', SERIAL_BREAK, 0);
 466
 467   return (scb->ops->send_break (scb));
 468 }
 469
 470 void
 471 serial_raw (struct serial *scb)
 472 {
 473   scb->ops->go_raw (scb);
 474 }
 475
 476 serial_ttystate
 477 serial_get_tty_state (struct serial *scb)
 478 {
 479   return scb->ops->get_tty_state (scb);
 480 }
 481
 482 serial_ttystate
 483 serial_copy_tty_state (struct serial *scb, serial_ttystate ttystate)
 484 {
 485   return scb->ops->copy_tty_state (scb, ttystate);
 486 }
 487
 488 int
 489 serial_set_tty_state (struct serial *scb, serial_ttystate ttystate)
 490 {
 491   return scb->ops->set_tty_state (scb, ttystate);
 492 }
 493
 494 void
 495 serial_print_tty_state (struct serial *scb,
 496                         serial_ttystate ttystate,
 497                         struct ui_file *stream)
 498 {
 499   scb->ops->print_tty_state (scb, ttystate, stream);
 500 }
 501
 502 int
 503 serial_noflush_set_tty_state (struct serial *scb,
 504                               serial_ttystate new_ttystate,
 505                               serial_ttystate old_ttystate)
 506 {
 507   return scb->ops->noflush_set_tty_state (scb, new_ttystate, old_ttystate);
 508 }
 509
 510 int
 511 serial_setbaudrate (struct serial *scb, int rate)
 512 {
 513   return scb->ops->setbaudrate (scb, rate);
 514 }
 515
 516 int
 517 serial_setstopbits (struct serial *scb, int num)
 518 {
 519   return scb->ops->setstopbits (scb, num);
 520 }
 521
 522 /* See serial.h.  */
 523
 524 int
 525 serial_setparity (struct serial *scb, int parity)
 526 {
 527   return scb->ops->setparity (scb, parity);
 528 }
 529
 530 int
 531 serial_can_async_p (struct serial *scb)
 532 {
 533   return (scb->ops->async != NULL);
 534 }
 535
 536 int
 537 serial_is_async_p (struct serial *scb)
 538 {
 539   return (scb->ops->async != NULL) && (scb->async_handler != NULL);
 540 }
 541
 542 void
 543 serial_async (struct serial *scb,
 544               serial_event_ftype *handler,
 545               void *context)
 546 {
 547   int changed = ((scb->async_handler == NULL) != (handler == NULL));
 548
 549   scb->async_handler = handler;
 550   scb->async_context = context;
 551   /* Only change mode if there is a need.  */
 552   if (changed)
 553     scb->ops->async (scb, handler != NULL);
 554 }
 555
 556 void
 557 serial_debug (struct serial *scb, int debug_p)
 558 {
 559   scb->debug_p = debug_p;
 560 }
 561
 562 int
 563 serial_debug_p (struct serial *scb)
 564 {
 565   return scb->debug_p || global_serial_debug_p;
 566 }
 567
 568 #ifdef USE_WIN32API
 569 void
 570 serial_wait_handle (struct serial *scb, HANDLE *read, HANDLE *except)
 571 {
 572   if (scb->ops->wait_handle)
 573     scb->ops->wait_handle (scb, read, except);
 574   else
 575     {
 576       *read = (HANDLE) _get_osfhandle (scb->fd);
 577       *except = NULL;
 578     }
 579 }
 580
 581 void
 582 serial_done_wait_handle (struct serial *scb)
 583 {
 584   if (scb->ops->done_wait_handle)
 585     scb->ops->done_wait_handle (scb);
 586 }
 587 #endif
 588
 589 int
 590 serial_pipe (struct serial *scbs[2])
 591 {
 592   const struct serial_ops *ops;
 593   int fildes[2];
 594
 595   ops = serial_interface_lookup ("pipe");
 596   if (!ops)
 597     {
 598       errno = ENOSYS;
 599       return -1;
 600     }
 601
 602   if (gdb_pipe (fildes) == -1)
 603     return -1;
 604
 605   scbs[0] = serial_fdopen_ops (fildes[0], ops);
 606   scbs[1] = serial_fdopen_ops (fildes[1], ops);
 607   return 0;
 608 }
 609
 610 /* Serial set/show framework.  */
 611
 612 static struct cmd_list_element *serial_set_cmdlist;
 613 static struct cmd_list_element *serial_show_cmdlist;
 614
 615 static void
 616 serial_set_cmd (char *args, int from_tty)
 617 {
 618   printf_unfiltered ("\"set serial\" must be followed "
 619                      "by the name of a command.\n");
 620   help_list (serial_set_cmdlist, "set serial ", all_commands, gdb_stdout);
 621 }
 622
 623 static void
 624 serial_show_cmd (char *args, int from_tty)
 625 {
 626   cmd_show_list (serial_show_cmdlist, from_tty, "");
 627 }
 628
 629 /* Baud rate specified for talking to serial target systems.  Default
 630    is left as -1, so targets can choose their own defaults.  */
 631 /* FIXME: This means that "show serial baud" and gr_files_info can
 632    print -1 or (unsigned int)-1.  This is a Bad User Interface.  */
 633
 634 int baud_rate = -1;
 635
 636 static void
 637 serial_baud_show_cmd (struct ui_file *file, int from_tty,
 638                       struct cmd_list_element *c, const char *value)
 639 {
 640   fprintf_filtered (file, _("Baud rate for remote serial I/O is %s.\n"),
 641                     value);
 642 }
 643
 644 /* Parity for serial port.  */
 645
 646 int serial_parity = GDBPARITY_NONE;
 647
 648 static const char parity_none[] = "none";
 649 static const char parity_odd[] = "odd";
 650 static const char parity_even[] = "even";
 651 static const char *const parity_enums[] =
 652   {parity_none, parity_odd, parity_even,  NULL};
 653 static const char *parity = parity_none;
 654
 655 /* Set serial_parity value.  */
 656
 657 static void
 658 set_parity (char *ignore_args, int from_tty, struct cmd_list_element *c)
 659 {
 660   if (parity == parity_odd)
 661     serial_parity = GDBPARITY_ODD;
 662   else if (parity == parity_even)
 663     serial_parity = GDBPARITY_EVEN;
 664   else
 665     serial_parity = GDBPARITY_NONE;
 666 }
 667
 668 void
 669 _initialize_serial (void)
 670 {
 671 #if 0
 672   add_com ("connect", class_obscure, connect_command, _("\
 673 Connect the terminal directly up to the command monitor.\n\
 674 Use <CR>~. or <CR>~^D to break out."));
 675 #endif /* 0 */
 676
 677   add_prefix_cmd ("serial", class_maintenance, serial_set_cmd, _("\
 678 Set default serial/parallel port configuration."),
 679                   &serial_set_cmdlist, "set serial ",
 680                   0/*allow-unknown*/,
 681                   &setlist);
 682
 683   add_prefix_cmd ("serial", class_maintenance, serial_show_cmd, _("\
 684 Show default serial/parallel port configuration."),
 685                   &serial_show_cmdlist, "show serial ",
 686                   0/*allow-unknown*/,
 687                   &showlist);
 688
 689   /* If target is open when baud changes, it doesn't take effect until
 690      the next open (I think, not sure).  */
 691   add_setshow_zinteger_cmd ("baud", no_class, &baud_rate, _("\
 692 Set baud rate for remote serial I/O."), _("\
 693 Show baud rate for remote serial I/O."), _("\
 694 This value is used to set the speed of the serial port when debugging\n\
 695 using remote targets."),
 696                             NULL,
 697                             serial_baud_show_cmd,
 698                             &serial_set_cmdlist, &serial_show_cmdlist);
 699
 700   add_setshow_enum_cmd ("parity", no_class, parity_enums,
 701                         &parity, _("\
 702 Set parity for remote serial I/O"), _("\
 703 Show parity for remote serial I/O"), NULL,
 704                         set_parity,
 705                         NULL, /* FIXME: i18n: */
 706                         &serial_set_cmdlist, &serial_show_cmdlist);
 707
 708   add_setshow_filename_cmd ("remotelogfile", no_class, &serial_logfile, _("\
 709 Set filename for remote session recording."), _("\
 710 Show filename for remote session recording."), _("\
 711 This file is used to record the remote session for future playback\n\
 712 by gdbserver."),
 713                             NULL,
 714                             NULL, /* FIXME: i18n: */
 715                             &setlist, &showlist);
 716
 717   add_setshow_enum_cmd ("remotelogbase", no_class, logbase_enums,
 718                         &serial_logbase, _("\
 719 Set numerical base for remote session logging"), _("\
 720 Show numerical base for remote session logging"), NULL,
 721                         NULL,
 722                         NULL, /* FIXME: i18n: */
 723                         &setlist, &showlist);
 724
 725   add_setshow_zuinteger_cmd ("serial", class_maintenance,
 726                              &global_serial_debug_p, _("\
 727 Set serial debugging."), _("\
 728 Show serial debugging."), _("\
 729 When non-zero, serial port debugging is enabled."),
 730                              NULL,
 731                              NULL, /* FIXME: i18n: */
 732                              &setdebuglist, &showdebuglist);
 733 }