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