gdb/event-top.c

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