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