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