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