gdb/event-top.c

   1 /* Top level stuff for GDB, the GNU debugger.
   2
   3    Copyright (C) 1999-2013 Free Software Foundation, Inc.
   4
   5    Written by Elena Zannoni <ezannoni@cygnus.com> of Cygnus Solutions.
   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 "top.h"
  24 #include "inferior.h"
  25 #include "target.h"
  26 #include "terminal.h"           /* for job_control */
  27 #include "event-loop.h"
  28 #include "event-top.h"
  29 #include "interps.h"
  30 #include <signal.h>
  31 #include "exceptions.h"
  32 #include "cli/cli-script.h"     /* for reset_command_nest_depth */
  33 #include "main.h"
  34 #include "gdbthread.h"
  35 #include "observer.h"
  36 #include "continuations.h"
  37 #include "gdbcmd.h"             /* for dont_repeat() */
  38 #include "annotate.h"
  39 #include "maint.h"
  40
  41 /* readline include files.  */
  42 #include "readline/readline.h"
  43 #include "readline/history.h"
  44
  45 /* readline defines this.  */
  46 #undef savestring
  47
  48 static void rl_callback_read_char_wrapper (gdb_client_data client_data);
  49 static void command_line_handler (char *rl);
  50 static void change_line_handler (void);
  51 static void command_handler (char *command);
  52 static char *top_level_prompt (void);
  53
  54 /* Signal handlers.  */
  55 #ifdef SIGQUIT
  56 static void handle_sigquit (int sig);
  57 #endif
  58 #ifdef SIGHUP
  59 static void handle_sighup (int sig);
  60 #endif
  61 static void handle_sigfpe (int sig);
  62
  63 /* Functions to be invoked by the event loop in response to
  64    signals.  */
  65 #if defined (SIGQUIT) || defined (SIGHUP)
  66 static void async_do_nothing (gdb_client_data);
  67 #endif
  68 #ifdef SIGHUP
  69 static void async_disconnect (gdb_client_data);
  70 #endif
  71 static void async_float_handler (gdb_client_data);
  72 #ifdef STOP_SIGNAL
  73 static void async_stop_sig (gdb_client_data);
  74 #endif
  75
  76 /* Readline offers an alternate interface, via callback
  77    functions.  These are all included in the file callback.c in the
  78    readline distribution.  This file provides (mainly) a function, which
  79    the event loop uses as callback (i.e. event handler) whenever an event
  80    is detected on the standard input file descriptor.
  81    readline_callback_read_char is called (by the GDB event loop) whenever
  82    there is a new character ready on the input stream.  This function
  83    incrementally builds a buffer internal to readline where it
  84    accumulates the line read up to the point of invocation.  In the
  85    special case in which the character read is newline, the function
  86    invokes a GDB supplied callback routine, which does the processing of
  87    a full command line.  This latter routine is the asynchronous analog
  88    of the old command_line_input in gdb.  Instead of invoking (and waiting
  89    for) readline to read the command line and pass it back to
  90    command_loop for processing, the new command_line_handler function has
  91    the command line already available as its parameter.  INPUT_HANDLER is
  92    to be set to the function that readline will invoke when a complete
  93    line of input is ready.  CALL_READLINE is to be set to the function
  94    that readline offers as callback to the event_loop.  */
  95
  96 void (*input_handler) (char *);
  97 void (*call_readline) (gdb_client_data);
  98
  99 /* Important variables for the event loop.  */
 100
 101 /* This is used to determine if GDB is using the readline library or
 102    its own simplified form of readline.  It is used by the asynchronous
 103    form of the set editing command.
 104    ezannoni: as of 1999-04-29 I expect that this
 105    variable will not be used after gdb is changed to use the event
 106    loop as default engine, and event-top.c is merged into top.c.  */
 107 int async_command_editing_p;
 108
 109 /* This is the annotation suffix that will be used when the
 110    annotation_level is 2.  */
 111 char *async_annotation_suffix;
 112
 113 /* This is used to display the notification of the completion of an
 114    asynchronous execution command.  */
 115 int exec_done_display_p = 0;
 116
 117 /* This is the file descriptor for the input stream that GDB uses to
 118    read commands from.  */
 119 int input_fd;
 120
 121 /* Signal handling variables.  */
 122 /* Each of these is a pointer to a function that the event loop will
 123    invoke if the corresponding signal has received.  The real signal
 124    handlers mark these functions as ready to be executed and the event
 125    loop, in a later iteration, calls them.  See the function
 126    invoke_async_signal_handler.  */
 127 static struct async_signal_handler *sigint_token;
 128 #ifdef SIGHUP
 129 static struct async_signal_handler *sighup_token;
 130 #endif
 131 #ifdef SIGQUIT
 132 static struct async_signal_handler *sigquit_token;
 133 #endif
 134 static struct async_signal_handler *sigfpe_token;
 135 #ifdef STOP_SIGNAL
 136 static struct async_signal_handler *sigtstp_token;
 137 #endif
 138
 139 /* Structure to save a partially entered command.  This is used when
 140    the user types '\' at the end of a command line.  This is necessary
 141    because each line of input is handled by a different call to
 142    command_line_handler, and normally there is no state retained
 143    between different calls.  */
 144 static int more_to_come = 0;
 145
 146 struct readline_input_state
 147   {
 148     char *linebuffer;
 149     char *linebuffer_ptr;
 150   }
 151 readline_input_state;
 152
 153 /* This hook is called by rl_callback_read_char_wrapper after each
 154    character is processed.  */
 155 void (*after_char_processing_hook) (void);
 156 \f
 157
 158 /* Wrapper function for calling into the readline library.  The event
 159    loop expects the callback function to have a paramter, while
 160    readline expects none.  */
 161 static void
 162 rl_callback_read_char_wrapper (gdb_client_data client_data)
 163 {
 164   rl_callback_read_char ();
 165   if (after_char_processing_hook)
 166     (*after_char_processing_hook) ();
 167 }
 168
 169 /* Initialize all the necessary variables, start the event loop,
 170    register readline, and stdin, start the loop.  The DATA is the
 171    interpreter data cookie, ignored for now.  */
 172
 173 void
 174 cli_command_loop (void *data)
 175 {
 176   display_gdb_prompt (0);
 177
 178   /* Now it's time to start the event loop.  */
 179   start_event_loop ();
 180 }
 181
 182 /* Change the function to be invoked every time there is a character
 183    ready on stdin.  This is used when the user sets the editing off,
 184    therefore bypassing readline, and letting gdb handle the input
 185    itself, via gdb_readline2.  Also it is used in the opposite case in
 186    which the user sets editing on again, by restoring readline
 187    handling of the input.  */
 188 static void
 189 change_line_handler (void)
 190 {
 191   /* NOTE: this operates on input_fd, not instream.  If we are reading
 192      commands from a file, instream will point to the file.  However in
 193      async mode, we always read commands from a file with editing
 194      off.  This means that the 'set editing on/off' will have effect
 195      only on the interactive session.  */
 196
 197   if (async_command_editing_p)
 198     {
 199       /* Turn on editing by using readline.  */
 200       call_readline = rl_callback_read_char_wrapper;
 201       input_handler = command_line_handler;
 202     }
 203   else
 204     {
 205       /* Turn off editing by using gdb_readline2.  */
 206       rl_callback_handler_remove ();
 207       call_readline = gdb_readline2;
 208
 209       /* Set up the command handler as well, in case we are called as
 210          first thing from .gdbinit.  */
 211       input_handler = command_line_handler;
 212     }
 213 }
 214
 215 /* Displays the prompt.  If the argument NEW_PROMPT is NULL, the
 216    prompt that is displayed is the current top level prompt.
 217    Otherwise, it displays whatever NEW_PROMPT is as a local/secondary
 218    prompt.
 219
 220    This is used after each gdb command has completed, and in the
 221    following cases:
 222
 223    1. When the user enters a command line which is ended by '\'
 224    indicating that the command will continue on the next line.  In
 225    that case the prompt that is displayed is the empty string.
 226
 227    2. When the user is entering 'commands' for a breakpoint, or
 228    actions for a tracepoint.  In this case the prompt will be '>'
 229
 230    3. On prompting for pagination.  */
 231
 232 void
 233 display_gdb_prompt (char *new_prompt)
 234 {
 235   char *actual_gdb_prompt = NULL;
 236   struct cleanup *old_chain;
 237
 238   annotate_display_prompt ();
 239
 240   /* Reset the nesting depth used when trace-commands is set.  */
 241   reset_command_nest_depth ();
 242
 243   /* Each interpreter has its own rules on displaying the command
 244      prompt.  */
 245   if (!current_interp_display_prompt_p ())
 246     return;
 247
 248   old_chain = make_cleanup (free_current_contents, &actual_gdb_prompt);
 249
 250   /* Do not call the python hook on an explicit prompt change as
 251      passed to this function, as this forms a secondary/local prompt,
 252      IE, displayed but not set.  */
 253   if (! new_prompt)
 254     {
 255       if (sync_execution)
 256         {
 257           /* This is to trick readline into not trying to display the
 258              prompt.  Even though we display the prompt using this
 259              function, readline still tries to do its own display if
 260              we don't call rl_callback_handler_install and
 261              rl_callback_handler_remove (which readline detects
 262              because a global variable is not set).  If readline did
 263              that, it could mess up gdb signal handlers for SIGINT.
 264              Readline assumes that between calls to rl_set_signals and
 265              rl_clear_signals gdb doesn't do anything with the signal
 266              handlers.  Well, that's not the case, because when the
 267              target executes we change the SIGINT signal handler.  If
 268              we allowed readline to display the prompt, the signal
 269              handler change would happen exactly between the calls to
 270              the above two functions.  Calling
 271              rl_callback_handler_remove(), does the job.  */
 272
 273           rl_callback_handler_remove ();
 274           do_cleanups (old_chain);
 275           return;
 276         }
 277       else
 278         {
 279           /* Display the top level prompt.  */
 280           actual_gdb_prompt = top_level_prompt ();
 281         }
 282     }
 283   else
 284     actual_gdb_prompt = xstrdup (new_prompt);
 285
 286   if (async_command_editing_p)
 287     {
 288       rl_callback_handler_remove ();
 289       rl_callback_handler_install (actual_gdb_prompt, input_handler);
 290     }
 291   /* new_prompt at this point can be the top of the stack or the one
 292      passed in.  It can't be NULL.  */
 293   else
 294     {
 295       /* Don't use a _filtered function here.  It causes the assumed
 296          character position to be off, since the newline we read from
 297          the user is not accounted for.  */
 298       fputs_unfiltered (actual_gdb_prompt, gdb_stdout);
 299       gdb_flush (gdb_stdout);
 300     }
 301
 302   do_cleanups (old_chain);
 303 }
 304
 305 /* Return the top level prompt, as specified by "set prompt", possibly
 306    overriden by the python gdb.prompt_hook hook, and then composed
 307    with the prompt prefix and suffix (annotations).  The caller is
 308    responsible for freeing the returned string.  */
 309
 310 static char *
 311 top_level_prompt (void)
 312 {
 313   char *prefix;
 314   char *prompt = NULL;
 315   char *suffix;
 316   char *composed_prompt;
 317   size_t prompt_length;
 318
 319   /* Give observers a chance of changing the prompt.  E.g., the python
 320      `gdb.prompt_hook' is installed as an observer.  */
 321   observer_notify_before_prompt (get_prompt ());
 322
 323   prompt = xstrdup (get_prompt ());
 324
 325   if (annotation_level >= 2)
 326     {
 327       /* Prefix needs to have new line at end.  */
 328       prefix = (char *) alloca (strlen (async_annotation_suffix) + 10);
 329       strcpy (prefix, "\n\032\032pre-");
 330       strcat (prefix, async_annotation_suffix);
 331       strcat (prefix, "\n");
 332
 333       /* Suffix needs to have a new line at end and \032 \032 at
 334          beginning.  */
 335       suffix = (char *) alloca (strlen (async_annotation_suffix) + 6);
 336       strcpy (suffix, "\n\032\032");
 337       strcat (suffix, async_annotation_suffix);
 338       strcat (suffix, "\n");
 339     }
 340   else
 341     {
 342       prefix = "";
 343       suffix = "";
 344     }
 345
 346   prompt_length = strlen (prefix) + strlen (prompt) + strlen (suffix);
 347   composed_prompt = xmalloc (prompt_length + 1);
 348
 349   strcpy (composed_prompt, prefix);
 350   strcat (composed_prompt, prompt);
 351   strcat (composed_prompt, suffix);
 352
 353   xfree (prompt);
 354
 355   return composed_prompt;
 356 }
 357
 358 /* When there is an event ready on the stdin file desriptor, instead
 359    of calling readline directly throught the callback function, or
 360    instead of calling gdb_readline2, give gdb a chance to detect
 361    errors and do something.  */
 362 void
 363 stdin_event_handler (int error, gdb_client_data client_data)
 364 {
 365   if (error)
 366     {
 367       printf_unfiltered (_("error detected on stdin\n"));
 368       delete_file_handler (input_fd);
 369       discard_all_continuations ();
 370       discard_all_intermediate_continuations ();
 371       /* If stdin died, we may as well kill gdb.  */
 372       quit_command ((char *) 0, stdin == instream);
 373     }
 374   else
 375     (*call_readline) (client_data);
 376 }
 377
 378 /* Re-enable stdin after the end of an execution command in
 379    synchronous mode, or after an error from the target, and we aborted
 380    the exec operation.  */
 381
 382 void
 383 async_enable_stdin (void)
 384 {
 385   if (sync_execution)
 386     {
 387       /* See NOTE in async_disable_stdin().  */
 388       /* FIXME: cagney/1999-09-27: Call this before clearing
 389          sync_execution.  Current target_terminal_ours() implementations
 390          check for sync_execution before switching the terminal.  */
 391       target_terminal_ours ();
 392       sync_execution = 0;
 393     }
 394 }
 395
 396 /* Disable reads from stdin (the console) marking the command as
 397    synchronous.  */
 398
 399 void
 400 async_disable_stdin (void)
 401 {
 402   sync_execution = 1;
 403 }
 404 \f
 405
 406 /* Handles a gdb command.  This function is called by
 407    command_line_handler, which has processed one or more input lines
 408    into COMMAND.  */
 409 /* NOTE: 1999-04-30 This is the asynchronous version of the command_loop
 410    function.  The command_loop function will be obsolete when we
 411    switch to use the event loop at every execution of gdb.  */
 412 static void
 413 command_handler (char *command)
 414 {
 415   int stdin_is_tty = ISATTY (stdin);
 416   struct cleanup *stat_chain;
 417
 418   clear_quit_flag ();
 419   if (instream == stdin && stdin_is_tty)
 420     reinitialize_more_filter ();
 421
 422   /* If readline returned a NULL command, it means that the connection
 423      with the terminal is gone.  This happens at the end of a
 424      testsuite run, after Expect has hung up but GDB is still alive.
 425      In such a case, we just quit gdb killing the inferior program
 426      too.  */
 427   if (command == 0)
 428     {
 429       printf_unfiltered ("quit\n");
 430       execute_command ("quit", stdin == instream);
 431     }
 432
 433   stat_chain = make_command_stats_cleanup (1);
 434
 435   execute_command (command, instream == stdin);
 436
 437   /* Do any commands attached to breakpoint we stopped at.  */
 438   bpstat_do_actions ();
 439
 440   do_cleanups (stat_chain);
 441 }
 442
 443 /* Handle a complete line of input.  This is called by the callback
 444    mechanism within the readline library.  Deal with incomplete
 445    commands as well, by saving the partial input in a global
 446    buffer.  */
 447
 448 /* NOTE: 1999-04-30 This is the asynchronous version of the
 449    command_line_input function; command_line_input will become
 450    obsolete once we use the event loop as the default mechanism in
 451    GDB.  */
 452 static void
 453 command_line_handler (char *rl)
 454 {
 455   static char *linebuffer = 0;
 456   static unsigned linelength = 0;
 457   char *p;
 458   char *p1;
 459   char *nline;
 460   int repeat = (instream == stdin);
 461
 462   if (annotation_level > 1 && instream == stdin)
 463     {
 464       printf_unfiltered (("\n\032\032post-"));
 465       puts_unfiltered (async_annotation_suffix);
 466       printf_unfiltered (("\n"));
 467     }
 468
 469   if (linebuffer == 0)
 470     {
 471       linelength = 80;
 472       linebuffer = (char *) xmalloc (linelength);
 473     }
 474
 475   p = linebuffer;
 476
 477   if (more_to_come)
 478     {
 479       strcpy (linebuffer, readline_input_state.linebuffer);
 480       p = readline_input_state.linebuffer_ptr;
 481       xfree (readline_input_state.linebuffer);
 482       more_to_come = 0;
 483     }
 484
 485 #ifdef STOP_SIGNAL
 486   if (job_control)
 487     signal (STOP_SIGNAL, handle_stop_sig);
 488 #endif
 489
 490   /* Make sure that all output has been output.  Some machines may let
 491      you get away with leaving out some of the gdb_flush, but not
 492      all.  */
 493   wrap_here ("");
 494   gdb_flush (gdb_stdout);
 495   gdb_flush (gdb_stderr);
 496
 497   if (source_file_name != NULL)
 498     ++source_line_number;
 499
 500   /* If we are in this case, then command_handler will call quit
 501      and exit from gdb.  */
 502   if (!rl || rl == (char *) EOF)
 503     {
 504       command_handler (0);
 505       return;                   /* Lint.  */
 506     }
 507   if (strlen (rl) + 1 + (p - linebuffer) > linelength)
 508     {
 509       linelength = strlen (rl) + 1 + (p - linebuffer);
 510       nline = (char *) xrealloc (linebuffer, linelength);
 511       p += nline - linebuffer;
 512       linebuffer = nline;
 513     }
 514   p1 = rl;
 515   /* Copy line.  Don't copy null at end.  (Leaves line alone
 516      if this was just a newline).  */
 517   while (*p1)
 518     *p++ = *p1++;
 519
 520   xfree (rl);                   /* Allocated in readline.  */
 521
 522   if (p > linebuffer && *(p - 1) == '\\')
 523     {
 524       *p = '\0';
 525       p--;                      /* Put on top of '\'.  */
 526
 527       readline_input_state.linebuffer = xstrdup (linebuffer);
 528       readline_input_state.linebuffer_ptr = p;
 529
 530       /* We will not invoke a execute_command if there is more
 531          input expected to complete the command.  So, we need to
 532          print an empty prompt here.  */
 533       more_to_come = 1;
 534       display_gdb_prompt ("");
 535       return;
 536     }
 537
 538 #ifdef STOP_SIGNAL
 539   if (job_control)
 540     signal (STOP_SIGNAL, SIG_DFL);
 541 #endif
 542
 543 #define SERVER_COMMAND_LENGTH 7
 544   server_command =
 545     (p - linebuffer > SERVER_COMMAND_LENGTH)
 546     && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
 547   if (server_command)
 548     {
 549       /* Note that we don't set `line'.  Between this and the check in
 550          dont_repeat, this insures that repeating will still do the
 551          right thing.  */
 552       *p = '\0';
 553       command_handler (linebuffer + SERVER_COMMAND_LENGTH);
 554       display_gdb_prompt (0);
 555       return;
 556     }
 557
 558   /* Do history expansion if that is wished.  */
 559   if (history_expansion_p && instream == stdin
 560       && ISATTY (instream))
 561     {
 562       char *history_value;
 563       int expanded;
 564
 565       *p = '\0';                /* Insert null now.  */
 566       expanded = history_expand (linebuffer, &history_value);
 567       if (expanded)
 568         {
 569           /* Print the changes.  */
 570           printf_unfiltered ("%s\n", history_value);
 571
 572           /* If there was an error, call this function again.  */
 573           if (expanded < 0)
 574             {
 575               xfree (history_value);
 576               return;
 577             }
 578           if (strlen (history_value) > linelength)
 579             {
 580               linelength = strlen (history_value) + 1;
 581               linebuffer = (char *) xrealloc (linebuffer, linelength);
 582             }
 583           strcpy (linebuffer, history_value);
 584           p = linebuffer + strlen (linebuffer);
 585         }
 586       xfree (history_value);
 587     }
 588
 589   /* If we just got an empty line, and that is supposed to repeat the
 590      previous command, return the value in the global buffer.  */
 591   if (repeat && p == linebuffer && *p != '\\')
 592     {
 593       command_handler (saved_command_line);
 594       display_gdb_prompt (0);
 595       return;
 596     }
 597
 598   for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
 599   if (repeat && !*p1)
 600     {
 601       command_handler (saved_command_line);
 602       display_gdb_prompt (0);
 603       return;
 604     }
 605
 606   *p = 0;
 607
 608   /* Add line to history if appropriate.  */
 609   if (instream == stdin
 610       && ISATTY (stdin) && *linebuffer)
 611     add_history (linebuffer);
 612
 613   /* Note: lines consisting solely of comments are added to the command
 614      history.  This is useful when you type a command, and then
 615      realize you don't want to execute it quite yet.  You can comment
 616      out the command and then later fetch it from the value history
 617      and remove the '#'.  The kill ring is probably better, but some
 618      people are in the habit of commenting things out.  */
 619   if (*p1 == '#')
 620     *p1 = '\0';                 /* Found a comment.  */
 621
 622   /* Save into global buffer if appropriate.  */
 623   if (repeat)
 624     {
 625       if (linelength > saved_command_line_size)
 626         {
 627           saved_command_line = xrealloc (saved_command_line, linelength);
 628           saved_command_line_size = linelength;
 629         }
 630       strcpy (saved_command_line, linebuffer);
 631       if (!more_to_come)
 632         {
 633           command_handler (saved_command_line);
 634           display_gdb_prompt (0);
 635         }
 636       return;
 637     }
 638
 639   command_handler (linebuffer);
 640   display_gdb_prompt (0);
 641   return;
 642 }
 643
 644 /* Does reading of input from terminal w/o the editing features
 645    provided by the readline library.  */
 646
 647 /* NOTE: 1999-04-30 Asynchronous version of gdb_readline; gdb_readline
 648    will become obsolete when the event loop is made the default
 649    execution for gdb.  */
 650 void
 651 gdb_readline2 (gdb_client_data client_data)
 652 {
 653   int c;
 654   char *result;
 655   int input_index = 0;
 656   int result_size = 80;
 657   static int done_once = 0;
 658
 659   /* Unbuffer the input stream, so that, later on, the calls to fgetc
 660      fetch only one char at the time from the stream.  The fgetc's will
 661      get up to the first newline, but there may be more chars in the
 662      stream after '\n'.  If we buffer the input and fgetc drains the
 663      stream, getting stuff beyond the newline as well, a select, done
 664      afterwards will not trigger.  */
 665   if (!done_once && !ISATTY (instream))
 666     {
 667       setbuf (instream, NULL);
 668       done_once = 1;
 669     }
 670
 671   result = (char *) xmalloc (result_size);
 672
 673   /* We still need the while loop here, even though it would seem
 674      obvious to invoke gdb_readline2 at every character entered.  If
 675      not using the readline library, the terminal is in cooked mode,
 676      which sends the characters all at once.  Poll will notice that the
 677      input fd has changed state only after enter is pressed.  At this
 678      point we still need to fetch all the chars entered.  */
 679
 680   while (1)
 681     {
 682       /* Read from stdin if we are executing a user defined command.
 683          This is the right thing for prompt_for_continue, at least.  */
 684       c = fgetc (instream ? instream : stdin);
 685
 686       if (c == EOF)
 687         {
 688           if (input_index > 0)
 689             /* The last line does not end with a newline.  Return it,
 690                and if we are called again fgetc will still return EOF
 691                and we'll return NULL then.  */
 692             break;
 693           xfree (result);
 694           (*input_handler) (0);
 695           return;
 696         }
 697
 698       if (c == '\n')
 699         {
 700           if (input_index > 0 && result[input_index - 1] == '\r')
 701             input_index--;
 702           break;
 703         }
 704
 705       result[input_index++] = c;
 706       while (input_index >= result_size)
 707         {
 708           result_size *= 2;
 709           result = (char *) xrealloc (result, result_size);
 710         }
 711     }
 712
 713   result[input_index++] = '\0';
 714   (*input_handler) (result);
 715 }
 716 \f
 717
 718 /* Initialization of signal handlers and tokens.  There is a function
 719    handle_sig* for each of the signals GDB cares about.  Specifically:
 720    SIGINT, SIGFPE, SIGQUIT, SIGTSTP, SIGHUP, SIGWINCH.  These
 721    functions are the actual signal handlers associated to the signals
 722    via calls to signal().  The only job for these functions is to
 723    enqueue the appropriate event/procedure with the event loop.  Such
 724    procedures are the old signal handlers.  The event loop will take
 725    care of invoking the queued procedures to perform the usual tasks
 726    associated with the reception of the signal.  */
 727 /* NOTE: 1999-04-30 This is the asynchronous version of init_signals.
 728    init_signals will become obsolete as we move to have to event loop
 729    as the default for gdb.  */
 730 void
 731 async_init_signals (void)
 732 {
 733   signal (SIGINT, handle_sigint);
 734   sigint_token =
 735     create_async_signal_handler (async_request_quit, NULL);
 736   signal (SIGTERM, handle_sigterm);
 737
 738   /* If SIGTRAP was set to SIG_IGN, then the SIG_IGN will get passed
 739      to the inferior and breakpoints will be ignored.  */
 740 #ifdef SIGTRAP
 741   signal (SIGTRAP, SIG_DFL);
 742 #endif
 743
 744 #ifdef SIGQUIT
 745   /* If we initialize SIGQUIT to SIG_IGN, then the SIG_IGN will get
 746      passed to the inferior, which we don't want.  It would be
 747      possible to do a "signal (SIGQUIT, SIG_DFL)" after we fork, but
 748      on BSD4.3 systems using vfork, that can affect the
 749      GDB process as well as the inferior (the signal handling tables
 750      might be in memory, shared between the two).  Since we establish
 751      a handler for SIGQUIT, when we call exec it will set the signal
 752      to SIG_DFL for us.  */
 753   signal (SIGQUIT, handle_sigquit);
 754   sigquit_token =
 755     create_async_signal_handler (async_do_nothing, NULL);
 756 #endif
 757 #ifdef SIGHUP
 758   if (signal (SIGHUP, handle_sighup) != SIG_IGN)
 759     sighup_token =
 760       create_async_signal_handler (async_disconnect, NULL);
 761   else
 762     sighup_token =
 763       create_async_signal_handler (async_do_nothing, NULL);
 764 #endif
 765   signal (SIGFPE, handle_sigfpe);
 766   sigfpe_token =
 767     create_async_signal_handler (async_float_handler, NULL);
 768
 769 #ifdef STOP_SIGNAL
 770   sigtstp_token =
 771     create_async_signal_handler (async_stop_sig, NULL);
 772 #endif
 773
 774 }
 775
 776 /* Tell the event loop what to do if SIGINT is received.
 777    See event-signal.c.  */
 778 void
 779 handle_sigint (int sig)
 780 {
 781   signal (sig, handle_sigint);
 782
 783   /* We could be running in a loop reading in symfiles or something so
 784      it may be quite a while before we get back to the event loop.  So
 785      set quit_flag to 1 here.  Then if QUIT is called before we get to
 786      the event loop, we will unwind as expected.  */
 787
 788   set_quit_flag ();
 789
 790   /* If immediate_quit is set, we go ahead and process the SIGINT right
 791      away, even if we usually would defer this to the event loop.  The
 792      assumption here is that it is safe to process ^C immediately if
 793      immediate_quit is set.  If we didn't, SIGINT would be really
 794      processed only the next time through the event loop.  To get to
 795      that point, though, the command that we want to interrupt needs to
 796      finish first, which is unacceptable.  If immediate quit is not set,
 797      we process SIGINT the next time through the loop, which is fine.  */
 798   gdb_call_async_signal_handler (sigint_token, immediate_quit);
 799 }
 800
 801 /* Quit GDB if SIGTERM is received.
 802    GDB would quit anyway, but this way it will clean up properly.  */
 803 void
 804 handle_sigterm (int sig)
 805 {
 806   signal (sig, handle_sigterm);
 807   quit_force ((char *) 0, stdin == instream);
 808 }
 809
 810 /* Do the quit.  All the checks have been done by the caller.  */
 811 void
 812 async_request_quit (gdb_client_data arg)
 813 {
 814   /* If the quit_flag has gotten reset back to 0 by the time we get
 815      back here, that means that an exception was thrown to unwind the
 816      current command before we got back to the event loop.  So there
 817      is no reason to call quit again here.  */
 818
 819   if (check_quit_flag ())
 820     quit ();
 821 }
 822
 823 #ifdef SIGQUIT
 824 /* Tell the event loop what to do if SIGQUIT is received.
 825    See event-signal.c.  */
 826 static void
 827 handle_sigquit (int sig)
 828 {
 829   mark_async_signal_handler (sigquit_token);
 830   signal (sig, handle_sigquit);
 831 }
 832 #endif
 833
 834 #if defined (SIGQUIT) || defined (SIGHUP)
 835 /* Called by the event loop in response to a SIGQUIT or an
 836    ignored SIGHUP.  */
 837 static void
 838 async_do_nothing (gdb_client_data arg)
 839 {
 840   /* Empty function body.  */
 841 }
 842 #endif
 843
 844 #ifdef SIGHUP
 845 /* Tell the event loop what to do if SIGHUP is received.
 846    See event-signal.c.  */
 847 static void
 848 handle_sighup (int sig)
 849 {
 850   mark_async_signal_handler (sighup_token);
 851   signal (sig, handle_sighup);
 852 }
 853
 854 /* Called by the event loop to process a SIGHUP.  */
 855 static void
 856 async_disconnect (gdb_client_data arg)
 857 {
 858   volatile struct gdb_exception exception;
 859
 860   TRY_CATCH (exception, RETURN_MASK_ALL)
 861     {
 862       quit_cover ();
 863     }
 864
 865   if (exception.reason < 0)
 866     {
 867       fputs_filtered ("Could not kill the program being debugged",
 868                       gdb_stderr);
 869       exception_print (gdb_stderr, exception);
 870     }
 871
 872   TRY_CATCH (exception, RETURN_MASK_ALL)
 873     {
 874       pop_all_targets ();
 875     }
 876
 877   signal (SIGHUP, SIG_DFL);     /*FIXME: ???????????  */
 878   raise (SIGHUP);
 879 }
 880 #endif
 881
 882 #ifdef STOP_SIGNAL
 883 void
 884 handle_stop_sig (int sig)
 885 {
 886   mark_async_signal_handler (sigtstp_token);
 887   signal (sig, handle_stop_sig);
 888 }
 889
 890 static void
 891 async_stop_sig (gdb_client_data arg)
 892 {
 893   char *prompt = get_prompt ();
 894
 895 #if STOP_SIGNAL == SIGTSTP
 896   signal (SIGTSTP, SIG_DFL);
 897 #if HAVE_SIGPROCMASK
 898   {
 899     sigset_t zero;
 900
 901     sigemptyset (&zero);
 902     sigprocmask (SIG_SETMASK, &zero, 0);
 903   }
 904 #elif HAVE_SIGSETMASK
 905   sigsetmask (0);
 906 #endif
 907   raise (SIGTSTP);
 908   signal (SIGTSTP, handle_stop_sig);
 909 #else
 910   signal (STOP_SIGNAL, handle_stop_sig);
 911 #endif
 912   printf_unfiltered ("%s", prompt);
 913   gdb_flush (gdb_stdout);
 914
 915   /* Forget about any previous command -- null line now will do
 916      nothing.  */
 917   dont_repeat ();
 918 }
 919 #endif /* STOP_SIGNAL */
 920
 921 /* Tell the event loop what to do if SIGFPE is received.
 922    See event-signal.c.  */
 923 static void
 924 handle_sigfpe (int sig)
 925 {
 926   mark_async_signal_handler (sigfpe_token);
 927   signal (sig, handle_sigfpe);
 928 }
 929
 930 /* Event loop will call this functin to process a SIGFPE.  */
 931 static void
 932 async_float_handler (gdb_client_data arg)
 933 {
 934   /* This message is based on ANSI C, section 4.7.  Note that integer
 935      divide by zero causes this, so "float" is a misnomer.  */
 936   error (_("Erroneous arithmetic operation."));
 937 }
 938 \f
 939
 940 /* Called by do_setshow_command.  */
 941 void
 942 set_async_editing_command (char *args, int from_tty,
 943                            struct cmd_list_element *c)
 944 {
 945   change_line_handler ();
 946 }
 947
 948 /* Set things up for readline to be invoked via the alternate
 949    interface, i.e. via a callback function (rl_callback_read_char),
 950    and hook up instream to the event loop.  */
 951 void
 952 gdb_setup_readline (void)
 953 {
 954   /* This function is a noop for the sync case.  The assumption is
 955      that the sync setup is ALL done in gdb_init, and we would only
 956      mess it up here.  The sync stuff should really go away over
 957      time.  */
 958   if (!batch_silent)
 959     gdb_stdout = stdio_fileopen (stdout);
 960   gdb_stderr = stderr_fileopen ();
 961   gdb_stdlog = gdb_stderr;  /* for moment */
 962   gdb_stdtarg = gdb_stderr; /* for moment */
 963   gdb_stdtargerr = gdb_stderr; /* for moment */
 964
 965   /* If the input stream is connected to a terminal, turn on
 966      editing.  */
 967   if (ISATTY (instream))
 968     {
 969       /* Tell gdb that we will be using the readline library.  This
 970          could be overwritten by a command in .gdbinit like 'set
 971          editing on' or 'off'.  */
 972       async_command_editing_p = 1;
 973
 974       /* When a character is detected on instream by select or poll,
 975          readline will be invoked via this callback function.  */
 976       call_readline = rl_callback_read_char_wrapper;
 977     }
 978   else
 979     {
 980       async_command_editing_p = 0;
 981       call_readline = gdb_readline2;
 982     }
 983
 984   /* When readline has read an end-of-line character, it passes the
 985      complete line to gdb for processing; command_line_handler is the
 986      function that does this.  */
 987   input_handler = command_line_handler;
 988
 989   /* Tell readline to use the same input stream that gdb uses.  */
 990   rl_instream = instream;
 991
 992   /* Get a file descriptor for the input stream, so that we can
 993      register it with the event loop.  */
 994   input_fd = fileno (instream);
 995
 996   /* Now we need to create the event sources for the input file
 997      descriptor.  */
 998   /* At this point in time, this is the only event source that we
 999      register with the even loop.  Another source is going to be the
1000      target program (inferior), but that must be registered only when
1001      it actually exists (I.e. after we say 'run' or after we connect
1002      to a remote target.  */
1003   add_file_handler (input_fd, stdin_event_handler, 0);
1004 }
1005
1006 /* Disable command input through the standard CLI channels.  Used in
1007    the suspend proc for interpreters that use the standard gdb readline
1008    interface, like the cli & the mi.  */
1009 void
1010 gdb_disable_readline (void)
1011 {
1012   /* FIXME - It is too heavyweight to delete and remake these every
1013      time you run an interpreter that needs readline.  It is probably
1014      better to have the interpreters cache these, which in turn means
1015      that this needs to be moved into interpreter specific code.  */
1016
1017 #if 0
1018   ui_file_delete (gdb_stdout);
1019   ui_file_delete (gdb_stderr);
1020   gdb_stdlog = NULL;
1021   gdb_stdtarg = NULL;
1022   gdb_stdtargerr = NULL;
1023 #endif
1024
1025   rl_callback_handler_remove ();
1026   delete_file_handler (input_fd);
1027 }