gdb/ser-base.c

   1 /* Generic serial interface functions.
   2
   3    Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2003,
   4    2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
   5    Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #include "defs.h"
  23 #include "serial.h"
  24 #include "ser-base.h"
  25 #include "event-loop.h"
  26
  27 #include "gdb_select.h"
  28 #include "gdb_string.h"
  29 #include <sys/time.h>
  30 #ifdef USE_WIN32API
  31 #include <winsock2.h>
  32 #endif
  33
  34
  35 static timer_handler_func push_event;
  36 static handler_func fd_event;
  37
  38 /* Event handling for ASYNC serial code.
  39
  40    At any time the SERIAL device either: has an empty FIFO and is
  41    waiting on a FD event; or has a non-empty FIFO/error condition and
  42    is constantly scheduling timer events.
  43
  44    ASYNC only stops pestering its client when it is de-async'ed or it
  45    is told to go away. */
  46
  47 /* Value of scb->async_state: */
  48 enum {
  49   /* >= 0 (TIMER_SCHEDULED) */
  50   /* The ID of the currently scheduled timer event. This state is
  51      rarely encountered.  Timer events are one-off so as soon as the
  52      event is delivered the state is shanged to NOTHING_SCHEDULED. */
  53   FD_SCHEDULED = -1,
  54   /* The fd_event() handler is scheduled.  It is called when ever the
  55      file descriptor becomes ready. */
  56   NOTHING_SCHEDULED = -2
  57   /* Either no task is scheduled (just going into ASYNC mode) or a
  58      timer event has just gone off and the current state has been
  59      forced into nothing scheduled. */
  60 };
  61
  62 /* Identify and schedule the next ASYNC task based on scb->async_state
  63    and scb->buf* (the input FIFO).  A state machine is used to avoid
  64    the need to make redundant calls into the event-loop - the next
  65    scheduled task is only changed when needed. */
  66
  67 static void
  68 reschedule (struct serial *scb)
  69 {
  70   if (serial_is_async_p (scb))
  71     {
  72       int next_state;
  73
  74       switch (scb->async_state)
  75         {
  76         case FD_SCHEDULED:
  77           if (scb->bufcnt == 0)
  78             next_state = FD_SCHEDULED;
  79           else
  80             {
  81               delete_file_handler (scb->fd);
  82               next_state = create_timer (0, push_event, scb);
  83             }
  84           break;
  85         case NOTHING_SCHEDULED:
  86           if (scb->bufcnt == 0)
  87             {
  88               add_file_handler (scb->fd, fd_event, scb);
  89               next_state = FD_SCHEDULED;
  90             }
  91           else
  92             {
  93               next_state = create_timer (0, push_event, scb);
  94             }
  95           break;
  96         default: /* TIMER SCHEDULED */
  97           if (scb->bufcnt == 0)
  98             {
  99               delete_timer (scb->async_state);
 100               add_file_handler (scb->fd, fd_event, scb);
 101               next_state = FD_SCHEDULED;
 102             }
 103           else
 104             next_state = scb->async_state;
 105           break;
 106         }
 107       if (serial_debug_p (scb))
 108         {
 109           switch (next_state)
 110             {
 111             case FD_SCHEDULED:
 112               if (scb->async_state != FD_SCHEDULED)
 113                 fprintf_unfiltered (gdb_stdlog, "[fd%d->fd-scheduled]\n",
 114                                     scb->fd);
 115               break;
 116             default: /* TIMER SCHEDULED */
 117               if (scb->async_state == FD_SCHEDULED)
 118                 fprintf_unfiltered (gdb_stdlog, "[fd%d->timer-scheduled]\n",
 119                                     scb->fd);
 120               break;
 121             }
 122         }
 123       scb->async_state = next_state;
 124     }
 125 }
 126
 127 /* FD_EVENT: This is scheduled when the input FIFO is empty (and there
 128    is no pending error).  As soon as data arrives, it is read into the
 129    input FIFO and the client notified.  The client should then drain
 130    the FIFO using readchar().  If the FIFO isn't immediatly emptied,
 131    push_event() is used to nag the client until it is. */
 132
 133 static void
 134 fd_event (int error, void *context)
 135 {
 136   struct serial *scb = context;
 137   if (error != 0)
 138     {
 139       scb->bufcnt = SERIAL_ERROR;
 140     }
 141   else if (scb->bufcnt == 0)
 142     {
 143       /* Prime the input FIFO.  The readchar() function is used to
 144          pull characters out of the buffer.  See also
 145          generic_readchar(). */
 146       int nr;
 147       nr = scb->ops->read_prim (scb, BUFSIZ);
 148       if (nr == 0)
 149         {
 150           scb->bufcnt = SERIAL_EOF;
 151         }
 152       else if (nr > 0)
 153         {
 154           scb->bufcnt = nr;
 155           scb->bufp = scb->buf;
 156         }
 157       else
 158         {
 159           scb->bufcnt = SERIAL_ERROR;
 160         }
 161     }
 162   scb->async_handler (scb, scb->async_context);
 163   reschedule (scb);
 164 }
 165
 166 /* PUSH_EVENT: The input FIFO is non-empty (or there is a pending
 167    error).  Nag the client until all the data has been read.  In the
 168    case of errors, the client will need to close or de-async the
 169    device before naging stops. */
 170
 171 static void
 172 push_event (void *context)
 173 {
 174   struct serial *scb = context;
 175
 176   scb->async_state = NOTHING_SCHEDULED; /* Timers are one-off */
 177   scb->async_handler (scb, scb->async_context);
 178   /* re-schedule */
 179   reschedule (scb);
 180 }
 181
 182 /* Wait for input on scb, with timeout seconds.  Returns 0 on success,
 183    otherwise SERIAL_TIMEOUT or SERIAL_ERROR. */
 184
 185 static int
 186 ser_base_wait_for (struct serial *scb, int timeout)
 187 {
 188   while (1)
 189     {
 190       int numfds;
 191       struct timeval tv;
 192       fd_set readfds, exceptfds;
 193
 194       /* NOTE: Some OS's can scramble the READFDS when the select()
 195          call fails (ex the kernel with Red Hat 5.2).  Initialize all
 196          arguments before each call. */
 197
 198       tv.tv_sec = timeout;
 199       tv.tv_usec = 0;
 200
 201       FD_ZERO (&readfds);
 202       FD_ZERO (&exceptfds);
 203       FD_SET (scb->fd, &readfds);
 204       FD_SET (scb->fd, &exceptfds);
 205
 206       if (timeout >= 0)
 207         numfds = gdb_select (scb->fd + 1, &readfds, 0, &exceptfds, &tv);
 208       else
 209         numfds = gdb_select (scb->fd + 1, &readfds, 0, &exceptfds, 0);
 210
 211       if (numfds <= 0)
 212         {
 213           if (numfds == 0)
 214             return SERIAL_TIMEOUT;
 215           else if (errno == EINTR)
 216             continue;
 217           else
 218             return SERIAL_ERROR;        /* Got an error from select or poll */
 219         }
 220
 221       return 0;
 222     }
 223 }
 224
 225 /* Read a character with user-specified timeout.  TIMEOUT is number of seconds
 226    to wait, or -1 to wait forever.  Use timeout of 0 to effect a poll.  Returns
 227    char if successful.  Returns -2 if timeout expired, EOF if line dropped
 228    dead, or -3 for any other error (see errno in that case). */
 229
 230 static int
 231 do_ser_base_readchar (struct serial *scb, int timeout)
 232 {
 233   int status;
 234   int delta;
 235
 236   /* We have to be able to keep the GUI alive here, so we break the
 237      original timeout into steps of 1 second, running the "keep the
 238      GUI alive" hook each time through the loop.
 239
 240      Also, timeout = 0 means to poll, so we just set the delta to 0,
 241      so we will only go through the loop once.  */
 242
 243   delta = (timeout == 0 ? 0 : 1);
 244   while (1)
 245     {
 246       /* N.B. The UI may destroy our world (for instance by calling
 247          remote_stop,) in which case we want to get out of here as
 248          quickly as possible.  It is not safe to touch scb, since
 249          someone else might have freed it.  The
 250          deprecated_ui_loop_hook signals that we should exit by
 251          returning 1.  */
 252
 253       if (deprecated_ui_loop_hook)
 254         {
 255           if (deprecated_ui_loop_hook (0))
 256             return SERIAL_TIMEOUT;
 257         }
 258
 259       status = ser_base_wait_for (scb, delta);
 260       if (timeout > 0)
 261         timeout -= delta;
 262
 263       /* If we got a character or an error back from wait_for, then we can
 264          break from the loop before the timeout is completed. */
 265       if (status != SERIAL_TIMEOUT)
 266         break;
 267
 268       /* If we have exhausted the original timeout, then generate
 269          a SERIAL_TIMEOUT, and pass it out of the loop. */
 270       else if (timeout == 0)
 271         {
 272           status = SERIAL_TIMEOUT;
 273           break;
 274         }
 275     }
 276
 277   if (status < 0)
 278     return status;
 279
 280   status = scb->ops->read_prim (scb, BUFSIZ);
 281
 282   if (status <= 0)
 283     {
 284       if (status == 0)
 285         return SERIAL_EOF;
 286       else
 287         /* Got an error from read.  */
 288         return SERIAL_ERROR;
 289     }
 290
 291   scb->bufcnt = status;
 292   scb->bufcnt--;
 293   scb->bufp = scb->buf;
 294   return *scb->bufp++;
 295 }
 296
 297 /* Perform operations common to both old and new readchar. */
 298
 299 /* Return the next character from the input FIFO.  If the FIFO is
 300    empty, call the SERIAL specific routine to try and read in more
 301    characters.
 302
 303    Initially data from the input FIFO is returned (fd_event()
 304    pre-reads the input into that FIFO.  Once that has been emptied,
 305    further data is obtained by polling the input FD using the device
 306    specific readchar() function.  Note: reschedule() is called after
 307    every read.  This is because there is no guarentee that the lower
 308    level fd_event() poll_event() code (which also calls reschedule())
 309    will be called. */
 310
 311 int
 312 generic_readchar (struct serial *scb, int timeout,
 313                   int (do_readchar) (struct serial *scb, int timeout))
 314 {
 315   int ch;
 316   if (scb->bufcnt > 0)
 317     {
 318       ch = *scb->bufp;
 319       scb->bufcnt--;
 320       scb->bufp++;
 321     }
 322   else if (scb->bufcnt < 0)
 323     {
 324       /* Some errors/eof are are sticky. */
 325       ch = scb->bufcnt;
 326     }
 327   else
 328     {
 329       ch = do_readchar (scb, timeout);
 330       if (ch < 0)
 331         {
 332           switch ((enum serial_rc) ch)
 333             {
 334             case SERIAL_EOF:
 335             case SERIAL_ERROR:
 336               /* Make the error/eof stick. */
 337               scb->bufcnt = ch;
 338               break;
 339             case SERIAL_TIMEOUT:
 340               scb->bufcnt = 0;
 341               break;
 342             }
 343         }
 344     }
 345   /* Read any error output we might have.  */
 346   if (scb->error_fd != -1)
 347     {
 348       ssize_t s;
 349       char buf[81];
 350
 351       for (;;)
 352         {
 353           char *current;
 354           char *newline;
 355           int to_read = 80;
 356
 357           int num_bytes = -1;
 358           if (scb->ops->avail)
 359             num_bytes = (scb->ops->avail)(scb, scb->error_fd);
 360           if (num_bytes != -1)
 361             to_read = (num_bytes < to_read) ? num_bytes : to_read;
 362
 363           if (to_read == 0)
 364             break;
 365
 366           s = read (scb->error_fd, &buf, to_read);
 367           if (s == -1)
 368             break;
 369           if (s == 0)
 370             {
 371               /* EOF */
 372               close (scb->error_fd);
 373               scb->error_fd = -1;
 374               break;
 375             }
 376
 377           /* In theory, embedded newlines are not a problem.
 378              But for MI, we want each output line to have just
 379              one newline for legibility.  So output things
 380              in newline chunks.  */
 381           buf[s] = '\0';
 382           current = buf;
 383           while ((newline = strstr (current, "\n")) != NULL)
 384             {
 385               *newline = '\0';
 386               fputs_unfiltered (current, gdb_stderr);
 387               fputs_unfiltered ("\n", gdb_stderr);
 388               current = newline + 1;
 389             }
 390           fputs_unfiltered (current, gdb_stderr);
 391         }
 392     }
 393
 394   reschedule (scb);
 395   return ch;
 396 }
 397
 398 int
 399 ser_base_readchar (struct serial *scb, int timeout)
 400 {
 401   return generic_readchar (scb, timeout, do_ser_base_readchar);
 402 }
 403
 404 int
 405 ser_base_write (struct serial *scb, const char *str, int len)
 406 {
 407   int cc;
 408
 409   while (len > 0)
 410     {
 411       cc = scb->ops->write_prim (scb, str, len);
 412
 413       if (cc < 0)
 414         return 1;
 415       len -= cc;
 416       str += cc;
 417     }
 418   return 0;
 419 }
 420
 421 int
 422 ser_base_flush_output (struct serial *scb)
 423 {
 424   return 0;
 425 }
 426
 427 int
 428 ser_base_flush_input (struct serial *scb)
 429 {
 430   if (scb->bufcnt >= 0)
 431     {
 432       scb->bufcnt = 0;
 433       scb->bufp = scb->buf;
 434       return 0;
 435     }
 436   else
 437     return SERIAL_ERROR;
 438 }
 439
 440 int
 441 ser_base_send_break (struct serial *scb)
 442 {
 443   return 0;
 444 }
 445
 446 int
 447 ser_base_drain_output (struct serial *scb)
 448 {
 449   return 0;
 450 }
 451
 452 void
 453 ser_base_raw (struct serial *scb)
 454 {
 455   return;                       /* Always in raw mode */
 456 }
 457
 458 serial_ttystate
 459 ser_base_get_tty_state (struct serial *scb)
 460 {
 461   /* allocate a dummy */
 462   return (serial_ttystate) XMALLOC (int);
 463 }
 464
 465 int
 466 ser_base_set_tty_state (struct serial *scb, serial_ttystate ttystate)
 467 {
 468   return 0;
 469 }
 470
 471 int
 472 ser_base_noflush_set_tty_state (struct serial *scb,
 473                                 serial_ttystate new_ttystate,
 474                                 serial_ttystate old_ttystate)
 475 {
 476   return 0;
 477 }
 478
 479 void
 480 ser_base_print_tty_state (struct serial *scb,
 481                           serial_ttystate ttystate,
 482                           struct ui_file *stream)
 483 {
 484   /* Nothing to print.  */
 485   return;
 486 }
 487
 488 int
 489 ser_base_setbaudrate (struct serial *scb, int rate)
 490 {
 491   return 0;                     /* Never fails! */
 492 }
 493
 494 int
 495 ser_base_setstopbits (struct serial *scb, int num)
 496 {
 497   return 0;                     /* Never fails! */
 498 }
 499
 500 /* Put the SERIAL device into/out-of ASYNC mode.  */
 501
 502 void
 503 ser_base_async (struct serial *scb,
 504                 int async_p)
 505 {
 506   if (async_p)
 507     {
 508       /* Force a re-schedule. */
 509       scb->async_state = NOTHING_SCHEDULED;
 510       if (serial_debug_p (scb))
 511         fprintf_unfiltered (gdb_stdlog, "[fd%d->asynchronous]\n",
 512                             scb->fd);
 513       reschedule (scb);
 514     }
 515   else
 516     {
 517       if (serial_debug_p (scb))
 518         fprintf_unfiltered (gdb_stdlog, "[fd%d->synchronous]\n",
 519                             scb->fd);
 520       /* De-schedule whatever tasks are currently scheduled. */
 521       switch (scb->async_state)
 522         {
 523         case FD_SCHEDULED:
 524           delete_file_handler (scb->fd);
 525           break;
 526         case NOTHING_SCHEDULED:
 527           break;
 528         default: /* TIMER SCHEDULED */
 529           delete_timer (scb->async_state);
 530           break;
 531         }
 532     }
 533 }