gdb/serial.c

   1 /* Generic serial interface routines
   2
   3    Copyright (C) 1992-2002, 2004-2012 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 "gdb_string.h"
  24 #include "gdbcmd.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 /* Linked list of serial I/O handlers.  */
  33
  34 static struct serial_ops *serial_ops_list = NULL;
  35
  36 /* Pointer to list of scb's.  */
  37
  38 static struct serial *scb_base;
  39
  40 /* Non-NULL gives filename which contains a recording of the remote session,
  41    suitable for playback by gdbserver.  */
  42
  43 static char *serial_logfile = NULL;
  44 static struct ui_file *serial_logfp = NULL;
  45
  46 static struct serial_ops *serial_interface_lookup (const char *);
  47 static void serial_logchar (struct ui_file *stream,
  48                             int ch_type, int ch, int timeout);
  49 static const char logbase_hex[] = "hex";
  50 static const char logbase_octal[] = "octal";
  51 static const char logbase_ascii[] = "ascii";
  52 static const char *const logbase_enums[] =
  53 {logbase_hex, logbase_octal, logbase_ascii, NULL};
  54 static const char *serial_logbase = logbase_ascii;
  55 \f
  56
  57 static int serial_current_type = 0;
  58
  59 /* Log char CH of type CHTYPE, with TIMEOUT.  */
  60
  61 /* Define bogus char to represent a BREAK.  Should be careful to choose a value
  62    that can't be confused with a normal char, or an error code.  */
  63 #define SERIAL_BREAK 1235
  64
  65 static void
  66 serial_logchar (struct ui_file *stream, int ch_type, int ch, int timeout)
  67 {
  68   if (ch_type != serial_current_type)
  69     {
  70       fprintf_unfiltered (stream, "\n%c ", ch_type);
  71       serial_current_type = ch_type;
  72     }
  73
  74   if (serial_logbase != logbase_ascii)
  75     fputc_unfiltered (' ', stream);
  76
  77   switch (ch)
  78     {
  79     case SERIAL_TIMEOUT:
  80       fprintf_unfiltered (stream, "<Timeout: %d seconds>", timeout);
  81       return;
  82     case SERIAL_ERROR:
  83       fprintf_unfiltered (stream, "<Error: %s>", safe_strerror (errno));
  84       return;
  85     case SERIAL_EOF:
  86       fputs_unfiltered ("<Eof>", stream);
  87       return;
  88     case SERIAL_BREAK:
  89       fputs_unfiltered ("<Break>", stream);
  90       return;
  91     default:
  92       if (serial_logbase == logbase_hex)
  93         fprintf_unfiltered (stream, "%02x", ch & 0xff);
  94       else if (serial_logbase == logbase_octal)
  95         fprintf_unfiltered (stream, "%03o", ch & 0xff);
  96       else
  97         switch (ch)
  98           {
  99           case '\\':
 100             fputs_unfiltered ("\\\\", stream);
 101             break;
 102           case '\b':
 103             fputs_unfiltered ("\\b", stream);
 104             break;
 105           case '\f':
 106             fputs_unfiltered ("\\f", stream);
 107             break;
 108           case '\n':
 109             fputs_unfiltered ("\\n", stream);
 110             break;
 111           case '\r':
 112             fputs_unfiltered ("\\r", stream);
 113             break;
 114           case '\t':
 115             fputs_unfiltered ("\\t", stream);
 116             break;
 117           case '\v':
 118             fputs_unfiltered ("\\v", stream);
 119             break;
 120           default:
 121             fprintf_unfiltered (stream,
 122                                 isprint (ch) ? "%c" : "\\x%02x", ch & 0xFF);
 123             break;
 124           }
 125     }
 126 }
 127
 128 void
 129 serial_log_command (const char *cmd)
 130 {
 131   if (!serial_logfp)
 132     return;
 133
 134   serial_current_type = 'c';
 135
 136   fputs_unfiltered ("\nc ", serial_logfp);
 137   fputs_unfiltered (cmd, serial_logfp);
 138
 139   /* Make sure that the log file is as up-to-date as possible,
 140      in case we are getting ready to dump core or something.  */
 141   gdb_flush (serial_logfp);
 142 }
 143
 144 \f
 145 static struct serial_ops *
 146 serial_interface_lookup (const char *name)
 147 {
 148   struct serial_ops *ops;
 149
 150   for (ops = serial_ops_list; ops; ops = ops->next)
 151     if (strcmp (name, ops->name) == 0)
 152       return ops;
 153
 154   return NULL;
 155 }
 156
 157 void
 158 serial_add_interface (struct serial_ops *optable)
 159 {
 160   optable->next = serial_ops_list;
 161   serial_ops_list = optable;
 162 }
 163
 164 /* Return the open serial device for FD, if found, or NULL if FD is
 165    not already opened.  */
 166
 167 struct serial *
 168 serial_for_fd (int fd)
 169 {
 170   struct serial *scb;
 171
 172   for (scb = scb_base; scb; scb = scb->next)
 173     if (scb->fd == fd)
 174       return scb;
 175
 176   return NULL;
 177 }
 178
 179 /* Open up a device or a network socket, depending upon the syntax of NAME.  */
 180
 181 struct serial *
 182 serial_open (const char *name)
 183 {
 184   struct serial *scb;
 185   struct serial_ops *ops;
 186   const char *open_name = name;
 187
 188   if (strcmp (name, "pc") == 0)
 189     ops = serial_interface_lookup ("pc");
 190   else if (strncmp (name, "lpt", 3) == 0)
 191     ops = serial_interface_lookup ("parallel");
 192   else if (strncmp (name, "|", 1) == 0)
 193     {
 194       ops = serial_interface_lookup ("pipe");
 195       /* Discard ``|'' and any space before the command itself.  */
 196       ++open_name;
 197       while (isspace (*open_name))
 198         ++open_name;
 199     }
 200   /* Check for a colon, suggesting an IP address/port pair.
 201      Do this *after* checking for all the interesting prefixes.  We
 202      don't want to constrain the syntax of what can follow them.  */
 203   else if (strchr (name, ':'))
 204     ops = serial_interface_lookup ("tcp");
 205   else
 206     ops = serial_interface_lookup ("hardwire");
 207
 208   if (!ops)
 209     return NULL;
 210
 211   scb = XMALLOC (struct serial);
 212
 213   scb->ops = ops;
 214
 215   scb->bufcnt = 0;
 216   scb->bufp = scb->buf;
 217   scb->error_fd = -1;
 218   scb->refcnt = 1;
 219
 220   /* `...->open (...)' would get expanded by the open(2) syscall macro.  */
 221   if ((*scb->ops->open) (scb, open_name))
 222     {
 223       xfree (scb);
 224       return NULL;
 225     }
 226
 227   scb->name = xstrdup (name);
 228   scb->next = scb_base;
 229   scb->debug_p = 0;
 230   scb->async_state = 0;
 231   scb->async_handler = NULL;
 232   scb->async_context = NULL;
 233   scb_base = scb;
 234
 235   if (serial_logfile != NULL)
 236     {
 237       serial_logfp = gdb_fopen (serial_logfile, "w");
 238       if (serial_logfp == NULL)
 239         perror_with_name (serial_logfile);
 240     }
 241
 242   return scb;
 243 }
 244
 245 /* Open a new serial stream using a file handle, using serial
 246    interface ops OPS.  */
 247
 248 static struct serial *
 249 serial_fdopen_ops (const int fd, struct serial_ops *ops)
 250 {
 251   struct serial *scb;
 252
 253   if (!ops)
 254     {
 255       ops = serial_interface_lookup ("terminal");
 256       if (!ops)
 257         ops = serial_interface_lookup ("hardwire");
 258     }
 259
 260   if (!ops)
 261     return NULL;
 262
 263   scb = XCALLOC (1, struct serial);
 264
 265   scb->ops = ops;
 266
 267   scb->bufcnt = 0;
 268   scb->bufp = scb->buf;
 269   scb->error_fd = -1;
 270   scb->refcnt = 1;
 271
 272   scb->name = NULL;
 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   if (scb->name)
 317     xfree (scb->name);
 318
 319   /* For serial_is_open.  */
 320   scb->bufp = NULL;
 321
 322   if (scb_base == scb)
 323     scb_base = scb_base->next;
 324   else
 325     for (tmp_scb = scb_base; tmp_scb; tmp_scb = tmp_scb->next)
 326       {
 327         if (tmp_scb->next != scb)
 328           continue;
 329
 330         tmp_scb->next = tmp_scb->next->next;
 331         break;
 332       }
 333
 334   serial_unref (scb);
 335 }
 336
 337 void
 338 serial_close (struct serial *scb)
 339 {
 340   do_serial_close (scb, 1);
 341 }
 342
 343 void
 344 serial_un_fdopen (struct serial *scb)
 345 {
 346   do_serial_close (scb, 0);
 347 }
 348
 349 int
 350 serial_is_open (struct serial *scb)
 351 {
 352   return scb->bufp != NULL;
 353 }
 354
 355 void
 356 serial_ref (struct serial *scb)
 357 {
 358   scb->refcnt++;
 359 }
 360
 361 void
 362 serial_unref (struct serial *scb)
 363 {
 364   --scb->refcnt;
 365   if (scb->refcnt == 0)
 366     xfree (scb);
 367 }
 368
 369 int
 370 serial_readchar (struct serial *scb, int timeout)
 371 {
 372   int ch;
 373
 374   /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
 375      code is finished.  */
 376   if (0 && serial_is_async_p (scb) && timeout < 0)
 377     internal_error (__FILE__, __LINE__,
 378                     _("serial_readchar: blocking read in async mode"));
 379
 380   ch = scb->ops->readchar (scb, timeout);
 381   if (serial_logfp != NULL)
 382     {
 383       serial_logchar (serial_logfp, 'r', ch, timeout);
 384
 385       /* Make sure that the log file is as up-to-date as possible,
 386          in case we are getting ready to dump core or something.  */
 387       gdb_flush (serial_logfp);
 388     }
 389   if (serial_debug_p (scb))
 390     {
 391       fprintf_unfiltered (gdb_stdlog, "[");
 392       serial_logchar (gdb_stdlog, 'r', ch, timeout);
 393       fprintf_unfiltered (gdb_stdlog, "]");
 394       gdb_flush (gdb_stdlog);
 395     }
 396
 397   return (ch);
 398 }
 399
 400 int
 401 serial_write (struct serial *scb, const char *str, int len)
 402 {
 403   if (serial_logfp != NULL)
 404     {
 405       int count;
 406
 407       for (count = 0; count < len; count++)
 408         serial_logchar (serial_logfp, 'w', str[count] & 0xff, 0);
 409
 410       /* Make sure that the log file is as up-to-date as possible,
 411          in case we are getting ready to dump core or something.  */
 412       gdb_flush (serial_logfp);
 413     }
 414   if (serial_debug_p (scb))
 415     {
 416       int count;
 417
 418       for (count = 0; count < len; count++)
 419         {
 420           fprintf_unfiltered (gdb_stdlog, "[");
 421           serial_logchar (gdb_stdlog, 'w', str[count] & 0xff, 0);
 422           fprintf_unfiltered (gdb_stdlog, "]");
 423         }
 424       gdb_flush (gdb_stdlog);
 425     }
 426
 427   return (scb->ops->write (scb, str, len));
 428 }
 429
 430 void
 431 serial_printf (struct serial *desc, const char *format,...)
 432 {
 433   va_list args;
 434   char *buf;
 435   va_start (args, format);
 436
 437   buf = xstrvprintf (format, args);
 438   serial_write (desc, buf, strlen (buf));
 439
 440   xfree (buf);
 441   va_end (args);
 442 }
 443
 444 int
 445 serial_drain_output (struct serial *scb)
 446 {
 447   return scb->ops->drain_output (scb);
 448 }
 449
 450 int
 451 serial_flush_output (struct serial *scb)
 452 {
 453   return scb->ops->flush_output (scb);
 454 }
 455
 456 int
 457 serial_flush_input (struct serial *scb)
 458 {
 459   return scb->ops->flush_input (scb);
 460 }
 461
 462 int
 463 serial_send_break (struct serial *scb)
 464 {
 465   if (serial_logfp != NULL)
 466     serial_logchar (serial_logfp, 'w', SERIAL_BREAK, 0);
 467
 468   return (scb->ops->send_break (scb));
 469 }
 470
 471 void
 472 serial_raw (struct serial *scb)
 473 {
 474   scb->ops->go_raw (scb);
 475 }
 476
 477 serial_ttystate
 478 serial_get_tty_state (struct serial *scb)
 479 {
 480   return scb->ops->get_tty_state (scb);
 481 }
 482
 483 serial_ttystate
 484 serial_copy_tty_state (struct serial *scb, serial_ttystate ttystate)
 485 {
 486   return scb->ops->copy_tty_state (scb, ttystate);
 487 }
 488
 489 int
 490 serial_set_tty_state (struct serial *scb, serial_ttystate ttystate)
 491 {
 492   return scb->ops->set_tty_state (scb, ttystate);
 493 }
 494
 495 void
 496 serial_print_tty_state (struct serial *scb,
 497                         serial_ttystate ttystate,
 498                         struct ui_file *stream)
 499 {
 500   scb->ops->print_tty_state (scb, ttystate, stream);
 501 }
 502
 503 int
 504 serial_noflush_set_tty_state (struct serial *scb,
 505                               serial_ttystate new_ttystate,
 506                               serial_ttystate old_ttystate)
 507 {
 508   return scb->ops->noflush_set_tty_state (scb, new_ttystate, old_ttystate);
 509 }
 510
 511 int
 512 serial_setbaudrate (struct serial *scb, int rate)
 513 {
 514   return scb->ops->setbaudrate (scb, rate);
 515 }
 516
 517 int
 518 serial_setstopbits (struct serial *scb, int num)
 519 {
 520   return scb->ops->setstopbits (scb, num);
 521 }
 522
 523 int
 524 serial_can_async_p (struct serial *scb)
 525 {
 526   return (scb->ops->async != NULL);
 527 }
 528
 529 int
 530 serial_is_async_p (struct serial *scb)
 531 {
 532   return (scb->ops->async != NULL) && (scb->async_handler != NULL);
 533 }
 534
 535 void
 536 serial_async (struct serial *scb,
 537               serial_event_ftype *handler,
 538               void *context)
 539 {
 540   int changed = ((scb->async_handler == NULL) != (handler == NULL));
 541
 542   scb->async_handler = handler;
 543   scb->async_context = context;
 544   /* Only change mode if there is a need.  */
 545   if (changed)
 546     scb->ops->async (scb, handler != NULL);
 547 }
 548
 549 int
 550 deprecated_serial_fd (struct serial *scb)
 551 {
 552   /* FIXME: should this output a warning that deprecated code is being
 553      called?  */
 554   if (scb->fd < 0)
 555     {
 556       internal_error (__FILE__, __LINE__,
 557                       _("serial: FD not valid"));
 558     }
 559   return scb->fd; /* sigh */
 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   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 (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 ", -1, gdb_stdout);
 627 }
 628
 629 static void
 630 serial_show_cmd (char *args, int from_tty)
 631 {
 632   cmd_show_list (serial_show_cmdlist, from_tty, "");
 633 }
 634
 635
 636 void
 637 _initialize_serial (void)
 638 {
 639 #if 0
 640   add_com ("connect", class_obscure, connect_command, _("\
 641 Connect the terminal directly up to the command monitor.\n\
 642 Use <CR>~. or <CR>~^D to break out."));
 643 #endif /* 0 */
 644
 645   add_prefix_cmd ("serial", class_maintenance, serial_set_cmd, _("\
 646 Set default serial/parallel port configuration."),
 647                   &serial_set_cmdlist, "set serial ",
 648                   0/*allow-unknown*/,
 649                   &setlist);
 650
 651   add_prefix_cmd ("serial", class_maintenance, serial_show_cmd, _("\
 652 Show default serial/parallel port configuration."),
 653                   &serial_show_cmdlist, "show serial ",
 654                   0/*allow-unknown*/,
 655                   &showlist);
 656
 657   add_setshow_filename_cmd ("remotelogfile", no_class, &serial_logfile, _("\
 658 Set filename for remote session recording."), _("\
 659 Show filename for remote session recording."), _("\
 660 This file is used to record the remote session for future playback\n\
 661 by gdbserver."),
 662                             NULL,
 663                             NULL, /* FIXME: i18n: */
 664                             &setlist, &showlist);
 665
 666   add_setshow_enum_cmd ("remotelogbase", no_class, logbase_enums,
 667                         &serial_logbase, _("\
 668 Set numerical base for remote session logging"), _("\
 669 Show numerical base for remote session logging"), NULL,
 670                         NULL,
 671                         NULL, /* FIXME: i18n: */
 672                         &setlist, &showlist);
 673
 674   add_setshow_zuinteger_cmd ("serial", class_maintenance,
 675                              &global_serial_debug_p, _("\
 676 Set serial debugging."), _("\
 677 Show serial debugging."), _("\
 678 When non-zero, serial port debugging is enabled."),
 679                              NULL,
 680                              NULL, /* FIXME: i18n: */
 681                              &setdebuglist, &showdebuglist);
 682 }