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