1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5 2008, 2009, 2010 Free Software Foundation, Inc.
7 This file is part of GDB.
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.
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.
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/>. */
24 #include "call-cmds.h"
25 #include "cli/cli-cmds.h"
26 #include "cli/cli-script.h"
27 #include "cli/cli-setshow.h"
28 #include "cli/cli-decode.h"
31 #include "exceptions.h"
34 #include "breakpoint.h"
36 #include "expression.h"
39 #include "terminal.h" /* For job_control. */
41 #include "completer.h"
46 #include "gdb_assert.h"
48 #include "event-loop.h"
49 #include "gdbthread.h"
51 /* readline include files */
52 #include "readline/readline.h"
53 #include "readline/history.h"
55 /* readline defines this. */
58 #include <sys/types.h>
60 #include "event-top.h"
61 #include "gdb_string.h"
67 /* Default command line prompt. This is overriden in some configs. */
69 #ifndef DEFAULT_PROMPT
70 #define DEFAULT_PROMPT "(gdb) "
73 /* Initialization file name for gdb. This is overridden in some configs. */
77 # define PATH_MAX FILENAME_MAX
83 #ifndef GDBINIT_FILENAME
84 #define GDBINIT_FILENAME ".gdbinit"
86 char gdbinit
[PATH_MAX
+ 1] = GDBINIT_FILENAME
;
88 int inhibit_gdbinit
= 0;
90 /* If nonzero, and GDB has been configured to be able to use windows,
91 attempt to open them upon startup. */
95 extern char lang_frame_mismatch_warn
[]; /* language.c */
97 /* Flag for whether we want all the "from_tty" gubbish printed. */
99 int caution
= 1; /* Default is yes, sigh. */
101 show_caution (struct ui_file
*file
, int from_tty
,
102 struct cmd_list_element
*c
, const char *value
)
104 fprintf_filtered (file
, _("\
105 Whether to confirm potentially dangerous operations is %s.\n"),
109 /* stdio stream that command input is being read from. Set to stdin normally.
110 Set by source_command to the file we are sourcing. Set to NULL if we are
111 executing a user-defined command or interacting via a GUI. */
115 /* Flag to indicate whether a user defined command is currently running. */
119 /* Current working directory. */
121 char *current_directory
;
123 /* The directory name is actually stored here (usually). */
124 char gdb_dirbuf
[1024];
126 /* Function to call before reading a command, if nonzero.
127 The function receives two args: an input stream,
128 and a prompt string. */
130 void (*window_hook
) (FILE *, char *);
135 /* Buffer used for reading command lines, and the size
136 allocated for it so far. */
141 /* Nonzero if the current command is modified by "server ". This
142 affects things like recording into the command history, commands
143 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
144 whatever) can issue its own commands and also send along commands
145 from the user, and have the user not notice that the user interface
146 is issuing commands too. */
149 /* Baud rate specified for talking to serial target systems. Default
150 is left as -1, so targets can choose their own defaults. */
151 /* FIXME: This means that "show remotebaud" and gr_files_info can print -1
152 or (unsigned int)-1. This is a Bad User Interface. */
156 /* Timeout limit for response from target. */
158 /* The default value has been changed many times over the years. It
159 was originally 5 seconds. But that was thought to be a long time
160 to sit and wait, so it was changed to 2 seconds. That was thought
161 to be plenty unless the connection was going through some terminal
162 server or multiplexer or other form of hairy serial connection.
164 In mid-1996, remote_timeout was moved from remote.c to top.c and
165 it began being used in other remote-* targets. It appears that the
166 default was changed to 20 seconds at that time, perhaps because the
167 Renesas E7000 ICE didn't always respond in a timely manner.
169 But if 5 seconds is a long time to sit and wait for retransmissions,
170 20 seconds is far worse. This demonstrates the difficulty of using
171 a single variable for all protocol timeouts.
173 As remote.c is used much more than remote-e7000.c, it was changed
174 back to 2 seconds in 1999. */
176 int remote_timeout
= 2;
178 /* Non-zero tells remote* modules to output debugging info. */
180 int remote_debug
= 0;
182 /* Sbrk location on entry to main. Used for statistics only. */
187 /* Hooks for alternate command interfaces. */
189 /* Called after most modules have been initialized, but before taking users
192 If the UI fails to initialize and it wants GDB to continue
193 using the default UI, then it should clear this hook before returning. */
195 void (*deprecated_init_ui_hook
) (char *argv0
);
197 /* This hook is called from within gdb's many mini-event loops which could
198 steal control from a real user interface's event loop. It returns
199 non-zero if the user is requesting a detach, zero otherwise. */
201 int (*deprecated_ui_loop_hook
) (int);
203 /* Called instead of command_loop at top level. Can be invoked via
204 throw_exception(). */
206 void (*deprecated_command_loop_hook
) (void);
209 /* Called from print_frame_info to list the line we stopped in. */
211 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
, int line
,
212 int stopline
, int noerror
);
213 /* Replaces most of query. */
215 int (*deprecated_query_hook
) (const char *, va_list);
217 /* Replaces most of warning. */
219 void (*deprecated_warning_hook
) (const char *, va_list);
221 /* These three functions support getting lines of text from the user.
222 They are used in sequence. First deprecated_readline_begin_hook is
223 called with a text string that might be (for example) a message for
224 the user to type in a sequence of commands to be executed at a
225 breakpoint. If this function calls back to a GUI, it might take
226 this opportunity to pop up a text interaction window with this
227 message. Next, deprecated_readline_hook is called with a prompt
228 that is emitted prior to collecting the user input. It can be
229 called multiple times. Finally, deprecated_readline_end_hook is
230 called to notify the GUI that we are done with the interaction
231 window and it can close it. */
233 void (*deprecated_readline_begin_hook
) (char *, ...);
234 char *(*deprecated_readline_hook
) (char *);
235 void (*deprecated_readline_end_hook
) (void);
237 /* Called as appropriate to notify the interface that we have attached
238 to or detached from an already running process. */
240 void (*deprecated_attach_hook
) (void);
241 void (*deprecated_detach_hook
) (void);
243 /* Called during long calculations to allow GUI to repair window damage, and to
244 check for stop buttons, etc... */
246 void (*deprecated_interactive_hook
) (void);
248 /* Tell the GUI someone changed the register REGNO. -1 means
249 that the caller does not know which register changed or
250 that several registers have changed (see value_assign). */
251 void (*deprecated_register_changed_hook
) (int regno
);
253 /* Called when going to wait for the target. Usually allows the GUI to run
254 while waiting for target events. */
256 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
257 struct target_waitstatus
*status
,
260 /* Used by UI as a wrapper around command execution. May do various things
261 like enabling/disabling buttons, etc... */
263 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
, char *cmd
,
266 /* Called after a `set' command has finished. Is only run if the
267 `set' command succeeded. */
269 void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
271 /* Called when the current thread changes. Argument is thread id. */
273 void (*deprecated_context_hook
) (int id
);
275 /* Handler for SIGHUP. */
278 /* NOTE 1999-04-29: This function will be static again, once we modify
279 gdb to use the event loop as the default command loop and we merge
280 event-top.c into this file, top.c */
284 caution
= 0; /* Throw caution to the wind -- we're exiting.
285 This prevents asking the user dumb questions. */
286 quit_command ((char *) 0, 0);
289 #endif /* defined SIGHUP */
291 /* Line number we are currently in in a file which is being sourced. */
292 /* NOTE 1999-04-29: This variable will be static again, once we modify
293 gdb to use the event loop as the default command loop and we merge
294 event-top.c into this file, top.c */
295 /* static */ int source_line_number
;
297 /* Name of the file we are sourcing. */
298 /* NOTE 1999-04-29: This variable will be static again, once we modify
299 gdb to use the event loop as the default command loop and we merge
300 event-top.c into this file, top.c */
301 /* static */ const char *source_file_name
;
303 /* Clean up on error during a "source" command (or execution of a
304 user-defined command). */
307 do_restore_instream_cleanup (void *stream
)
309 /* Restore the previous input stream. */
313 /* Read commands from STREAM. */
315 read_command_file (FILE *stream
)
317 struct cleanup
*cleanups
;
319 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
322 do_cleanups (cleanups
);
325 void (*pre_init_ui_hook
) (void);
329 do_chdir_cleanup (void *old_dir
)
337 prepare_execute_command (void)
341 /* With multiple threads running while the one we're examining is stopped,
342 the dcache can get stale without us being able to detect it.
343 For the duration of the command, though, use the dcache to help
344 things like backtrace. */
346 target_dcache_invalidate ();
349 /* Execute the line P as a command, in the current user context.
350 Pass FROM_TTY as second argument to the defining function. */
353 execute_command (char *p
, int from_tty
)
355 struct cmd_list_element
*c
;
357 static int warned
= 0;
359 long time_at_cmd_start
= 0;
361 long space_at_cmd_start
= 0;
363 extern int display_space
;
365 if (target_can_async_p ())
367 time_at_cmd_start
= get_run_time ();
372 char *lim
= (char *) sbrk (0);
374 space_at_cmd_start
= lim
- lim_at_start
;
379 prepare_execute_command ();
381 /* Force cleanup of any alloca areas if using C alloca instead of
385 /* This can happen when command_line_input hits end of file. */
389 target_log_command (p
);
391 while (*p
== ' ' || *p
== '\t')
398 /* If trace-commands is set then this will print this command. */
399 print_command_trace (p
);
401 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
403 /* Pass null arg rather than an empty one. */
406 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
407 while the is_complete_command(cfunc) test is just plain
408 bogus. They should both be replaced by a test of the form
409 c->strip_trailing_white_space_p. */
410 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
411 can't be replaced with func. This is because it is the
412 cfunc, and not the func, that has the value that the
413 is_complete_command hack is testing for. */
414 /* Clear off trailing whitespace, except for set and complete
417 && c
->type
!= set_cmd
418 && !is_complete_command (c
))
420 p
= arg
+ strlen (arg
) - 1;
421 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
426 /* If this command has been pre-hooked, run the hook first. */
427 execute_cmd_pre_hook (c
);
429 if (c
->flags
& DEPRECATED_WARN_USER
)
430 deprecated_cmd_warning (&line
);
432 if (c
->class == class_user
)
433 execute_user_command (c
, arg
);
434 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
435 do_setshow_command (arg
, from_tty
& caution
, c
);
436 else if (!cmd_func_p (c
))
437 error (_("That is not a command, just a help topic."));
438 else if (deprecated_call_command_hook
)
439 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
441 cmd_func (c
, arg
, from_tty
& caution
);
443 /* If this command has been post-hooked, run the hook last. */
444 execute_cmd_post_hook (c
);
448 /* Tell the user if the language has changed (except first time).
449 First make sure that a new frame has been selected, in case this
450 command or the hooks changed the program state. */
451 deprecated_safe_get_selected_frame ();
452 if (current_language
!= expected_language
)
454 if (language_mode
== language_mode_auto
&& info_verbose
)
456 language_info (1); /* Print what changed. */
461 /* Warn the user if the working language does not match the
462 language of the current frame. Only warn the user if we are
463 actually running the program, i.e. there is a stack. */
464 /* FIXME: This should be cacheing the frame and only running when
465 the frame changes. */
467 if (has_stack_frames ())
469 flang
= get_frame_language ();
471 && flang
!= language_unknown
472 && flang
!= current_language
->la_language
)
474 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
480 /* Read commands from `instream' and execute them
481 until end of file or error reading instream. */
486 struct cleanup
*old_chain
;
488 int stdin_is_tty
= ISATTY (stdin
);
489 long time_at_cmd_start
;
491 long space_at_cmd_start
= 0;
493 extern int display_time
;
494 extern int display_space
;
496 while (instream
&& !feof (instream
))
498 if (window_hook
&& instream
== stdin
)
499 (*window_hook
) (instream
, get_prompt ());
502 if (instream
== stdin
&& stdin_is_tty
)
503 reinitialize_more_filter ();
504 old_chain
= make_cleanup (null_cleanup
, 0);
506 /* Get a command-line. This calls the readline package. */
507 command
= command_line_input (instream
== stdin
?
508 get_prompt () : (char *) NULL
,
509 instream
== stdin
, "prompt");
513 time_at_cmd_start
= get_run_time ();
518 char *lim
= (char *) sbrk (0);
520 space_at_cmd_start
= lim
- lim_at_start
;
524 execute_command (command
, instream
== stdin
);
526 /* Do any commands attached to breakpoint we are stopped at. */
527 bpstat_do_actions ();
529 do_cleanups (old_chain
);
533 long cmd_time
= get_run_time () - time_at_cmd_start
;
535 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
536 cmd_time
/ 1000000, cmd_time
% 1000000);
542 char *lim
= (char *) sbrk (0);
544 long space_now
= lim
- lim_at_start
;
545 long space_diff
= space_now
- space_at_cmd_start
;
547 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
549 (space_diff
>= 0 ? "+" : ""),
556 /* Commands call this if they do not want to be repeated by null lines. */
564 /* If we aren't reading from standard input, we are saving the last
565 thing read from stdin in line and don't want to delete it. Null lines
566 won't repeat here in any case. */
567 if (instream
== stdin
)
571 /* Read a line from the stream "instream" without command line editing.
573 It prints PROMPT_ARG once at the start.
574 Action is compatible with "readline", e.g. space for the result is
575 malloc'd and should be freed by the caller.
577 A NULL return means end of file. */
579 gdb_readline (char *prompt_arg
)
584 int result_size
= 80;
588 /* Don't use a _filtered function here. It causes the assumed
589 character position to be off, since the newline we read from
590 the user is not accounted for. */
591 fputs_unfiltered (prompt_arg
, gdb_stdout
);
592 gdb_flush (gdb_stdout
);
595 result
= (char *) xmalloc (result_size
);
599 /* Read from stdin if we are executing a user defined command.
600 This is the right thing for prompt_for_continue, at least. */
601 c
= fgetc (instream
? instream
: stdin
);
606 /* The last line does not end with a newline. Return it, and
607 if we are called again fgetc will still return EOF and
608 we'll return NULL then. */
616 if (input_index
> 0 && result
[input_index
- 1] == '\r')
621 result
[input_index
++] = c
;
622 while (input_index
>= result_size
)
625 result
= (char *) xrealloc (result
, result_size
);
629 result
[input_index
++] = '\0';
633 /* Variables which control command line editing and history
634 substitution. These variables are given default values at the end
636 static int command_editing_p
;
638 /* NOTE 1999-04-29: This variable will be static again, once we modify
639 gdb to use the event loop as the default command loop and we merge
640 event-top.c into this file, top.c */
642 /* static */ int history_expansion_p
;
644 static int write_history_p
;
646 show_write_history_p (struct ui_file
*file
, int from_tty
,
647 struct cmd_list_element
*c
, const char *value
)
649 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
653 static int history_size
;
655 show_history_size (struct ui_file
*file
, int from_tty
,
656 struct cmd_list_element
*c
, const char *value
)
658 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
662 static char *history_filename
;
664 show_history_filename (struct ui_file
*file
, int from_tty
,
665 struct cmd_list_element
*c
, const char *value
)
667 fprintf_filtered (file
, _("\
668 The filename in which to record the command history is \"%s\".\n"),
672 /* This is like readline(), but it has some gdb-specific behavior.
673 gdb may want readline in both the synchronous and async modes during
674 a single gdb invocation. At the ordinary top-level prompt we might
675 be using the async readline. That means we can't use
676 rl_pre_input_hook, since it doesn't work properly in async mode.
677 However, for a secondary prompt (" >", such as occurs during a
678 `define'), gdb wants a synchronous response.
680 We used to call readline() directly, running it in synchronous
681 mode. But mixing modes this way is not supported, and as of
682 readline 5.x it no longer works; the arrow keys come unbound during
683 the synchronous call. So we make a nested call into the event
684 loop. That's what gdb_readline_wrapper is for. */
686 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
687 rely on gdb_readline_wrapper_result, which might still be NULL if
688 the user types Control-D for EOF. */
689 static int gdb_readline_wrapper_done
;
691 /* The result of the current call to gdb_readline_wrapper, once a newline
693 static char *gdb_readline_wrapper_result
;
695 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
696 to be called after the newline is processed (which will redisplay
697 the prompt). But in gdb_readline_wrapper we will not get a new
698 prompt until the next call, or until we return to the event loop.
699 So we disable this hook around the newline and restore it before we
701 static void (*saved_after_char_processing_hook
) (void);
703 /* This function is called when readline has seen a complete line of
707 gdb_readline_wrapper_line (char *line
)
709 gdb_assert (!gdb_readline_wrapper_done
);
710 gdb_readline_wrapper_result
= line
;
711 gdb_readline_wrapper_done
= 1;
713 /* Prevent operate-and-get-next from acting too early. */
714 saved_after_char_processing_hook
= after_char_processing_hook
;
715 after_char_processing_hook
= NULL
;
717 /* Prevent parts of the prompt from being redisplayed if annotations
718 are enabled, and readline's state getting out of sync. */
719 if (async_command_editing_p
)
720 rl_callback_handler_remove ();
723 struct gdb_readline_wrapper_cleanup
725 void (*handler_orig
) (char *);
726 int already_prompted_orig
;
730 gdb_readline_wrapper_cleanup (void *arg
)
732 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
734 rl_already_prompted
= cleanup
->already_prompted_orig
;
736 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
737 input_handler
= cleanup
->handler_orig
;
738 gdb_readline_wrapper_result
= NULL
;
739 gdb_readline_wrapper_done
= 0;
741 after_char_processing_hook
= saved_after_char_processing_hook
;
742 saved_after_char_processing_hook
= NULL
;
748 gdb_readline_wrapper (char *prompt
)
750 struct cleanup
*back_to
;
751 struct gdb_readline_wrapper_cleanup
*cleanup
;
754 cleanup
= xmalloc (sizeof (*cleanup
));
755 cleanup
->handler_orig
= input_handler
;
756 input_handler
= gdb_readline_wrapper_line
;
758 cleanup
->already_prompted_orig
= rl_already_prompted
;
760 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
762 /* Display our prompt and prevent double prompt display. */
763 display_gdb_prompt (prompt
);
764 rl_already_prompted
= 1;
766 if (after_char_processing_hook
)
767 (*after_char_processing_hook
) ();
768 gdb_assert (after_char_processing_hook
== NULL
);
770 /* gdb_do_one_event argument is unused. */
771 while (gdb_do_one_event (NULL
) >= 0)
772 if (gdb_readline_wrapper_done
)
775 retval
= gdb_readline_wrapper_result
;
776 do_cleanups (back_to
);
781 /* The current saved history number from operate-and-get-next.
782 This is -1 if not valid. */
783 static int operate_saved_history
= -1;
785 /* This is put on the appropriate hook and helps operate-and-get-next
788 gdb_rl_operate_and_get_next_completion (void)
790 int delta
= where_history () - operate_saved_history
;
792 /* The `key' argument to rl_get_previous_history is ignored. */
793 rl_get_previous_history (delta
, 0);
794 operate_saved_history
= -1;
796 /* readline doesn't automatically update the display for us. */
799 after_char_processing_hook
= NULL
;
800 rl_pre_input_hook
= NULL
;
803 /* This is a gdb-local readline command handler. It accepts the
804 current command line (like RET does) and, if this command was taken
805 from the history, arranges for the next command in the history to
806 appear on the command line when the prompt returns.
807 We ignore the arguments. */
809 gdb_rl_operate_and_get_next (int count
, int key
)
813 /* Use the async hook. */
814 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
816 /* Find the current line, and find the next line to use. */
817 where
= where_history();
819 /* FIXME: kettenis/20020817: max_input_history is renamed into
820 history_max_entries in readline-4.2. When we do a new readline
821 import, we should probably change it here too, even though
822 readline maintains backwards compatibility for now by still
823 defining max_input_history. */
824 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
825 (where
>= history_length
- 1))
826 operate_saved_history
= where
;
828 operate_saved_history
= where
+ 1;
830 return rl_newline (1, key
);
833 /* Read one line from the command input stream `instream'
834 into the local static buffer `linebuffer' (whose current length
836 The buffer is made bigger as necessary.
837 Returns the address of the start of the line.
839 NULL is returned for end of file.
841 *If* the instream == stdin & stdin is a terminal, the line read
842 is copied into the file line saver (global var char *line,
843 length linesize) so that it can be duplicated.
845 This routine either uses fancy command line editing or
846 simple input as the user has requested. */
849 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
851 static char *linebuffer
= 0;
852 static unsigned linelength
= 0;
856 char *local_prompt
= prompt_arg
;
860 /* The annotation suffix must be non-NULL. */
861 if (annotation_suffix
== NULL
)
862 annotation_suffix
= "";
864 if (annotation_level
> 1 && instream
== stdin
)
866 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
867 + strlen (annotation_suffix
) + 40);
868 if (prompt_arg
== NULL
)
869 local_prompt
[0] = '\0';
871 strcpy (local_prompt
, prompt_arg
);
872 strcat (local_prompt
, "\n\032\032");
873 strcat (local_prompt
, annotation_suffix
);
874 strcat (local_prompt
, "\n");
880 linebuffer
= (char *) xmalloc (linelength
);
885 /* Control-C quits instantly if typed while in this loop
886 since it should not wait until the user types a newline. */
890 signal (STOP_SIGNAL
, handle_stop_sig
);
895 /* Make sure that all output has been output. Some machines may let
896 you get away with leaving out some of the gdb_flush, but not all. */
898 gdb_flush (gdb_stdout
);
899 gdb_flush (gdb_stderr
);
901 if (source_file_name
!= NULL
)
902 ++source_line_number
;
904 if (annotation_level
> 1 && instream
== stdin
)
906 puts_unfiltered ("\n\032\032pre-");
907 puts_unfiltered (annotation_suffix
);
908 puts_unfiltered ("\n");
911 /* Don't use fancy stuff if not talking to stdin. */
912 if (deprecated_readline_hook
&& input_from_terminal_p ())
914 rl
= (*deprecated_readline_hook
) (local_prompt
);
916 else if (command_editing_p
&& input_from_terminal_p ())
918 rl
= gdb_readline_wrapper (local_prompt
);
922 rl
= gdb_readline (local_prompt
);
925 if (annotation_level
> 1 && instream
== stdin
)
927 puts_unfiltered ("\n\032\032post-");
928 puts_unfiltered (annotation_suffix
);
929 puts_unfiltered ("\n");
932 if (!rl
|| rl
== (char *) EOF
)
937 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
939 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
940 nline
= (char *) xrealloc (linebuffer
, linelength
);
941 p
+= nline
- linebuffer
;
945 /* Copy line. Don't copy null at end. (Leaves line alone
946 if this was just a newline) */
950 xfree (rl
); /* Allocated in readline. */
952 if (p
== linebuffer
|| *(p
- 1) != '\\')
955 p
--; /* Put on top of '\'. */
956 local_prompt
= (char *) 0;
961 signal (STOP_SIGNAL
, SIG_DFL
);
968 #define SERVER_COMMAND_LENGTH 7
970 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
971 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
974 /* Note that we don't set `line'. Between this and the check in
975 dont_repeat, this insures that repeating will still do the
978 return linebuffer
+ SERVER_COMMAND_LENGTH
;
981 /* Do history expansion if that is wished. */
982 if (history_expansion_p
&& instream
== stdin
983 && ISATTY (instream
))
988 *p
= '\0'; /* Insert null now. */
989 expanded
= history_expand (linebuffer
, &history_value
);
992 /* Print the changes. */
993 printf_unfiltered ("%s\n", history_value
);
995 /* If there was an error, call this function again. */
998 xfree (history_value
);
999 return command_line_input (prompt_arg
, repeat
, annotation_suffix
);
1001 if (strlen (history_value
) > linelength
)
1003 linelength
= strlen (history_value
) + 1;
1004 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1006 strcpy (linebuffer
, history_value
);
1007 p
= linebuffer
+ strlen (linebuffer
);
1009 xfree (history_value
);
1012 /* If we just got an empty line, and that is supposed
1013 to repeat the previous command, return the value in the
1015 if (repeat
&& p
== linebuffer
)
1017 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1023 /* Add line to history if appropriate. */
1024 if (instream
== stdin
1025 && ISATTY (stdin
) && *linebuffer
)
1026 add_history (linebuffer
);
1028 /* Note: lines consisting solely of comments are added to the command
1029 history. This is useful when you type a command, and then
1030 realize you don't want to execute it quite yet. You can comment
1031 out the command and then later fetch it from the value history
1032 and remove the '#'. The kill ring is probably better, but some
1033 people are in the habit of commenting things out. */
1035 *p1
= '\0'; /* Found a comment. */
1037 /* Save into global buffer if appropriate. */
1040 if (linelength
> linesize
)
1042 line
= xrealloc (line
, linelength
);
1043 linesize
= linelength
;
1045 strcpy (line
, linebuffer
);
1052 /* Print the GDB banner. */
1054 print_gdb_version (struct ui_file
*stream
)
1056 /* From GNU coding standards, first line is meant to be easy for a
1057 program to parse, and is just canonical program name and version
1058 number, which starts after last space. */
1060 fprintf_filtered (stream
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1062 /* Second line is a copyright notice. */
1064 fprintf_filtered (stream
, "Copyright (C) 2010 Free Software Foundation, Inc.\n");
1066 /* Following the copyright is a brief statement that the program is
1067 free software, that users are free to copy and change it on
1068 certain conditions, that it is covered by the GNU GPL, and that
1069 there is no warranty. */
1071 fprintf_filtered (stream
, "\
1072 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1073 This is free software: you are free to change and redistribute it.\n\
1074 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1075 and \"show warranty\" for details.\n");
1077 /* After the required info we print the configuration information. */
1079 fprintf_filtered (stream
, "This GDB was configured as \"");
1080 if (strcmp (host_name
, target_name
) != 0)
1082 fprintf_filtered (stream
, "--host=%s --target=%s", host_name
, target_name
);
1086 fprintf_filtered (stream
, "%s", host_name
);
1088 fprintf_filtered (stream
, "\".");
1090 if (REPORT_BUGS_TO
[0])
1092 fprintf_filtered (stream
,
1093 _("\nFor bug reporting instructions, please see:\n"));
1094 fprintf_filtered (stream
, "%s.", REPORT_BUGS_TO
);
1098 /* get_prompt: access method for the GDB prompt string. */
1107 set_prompt (char *s
)
1109 /* ??rehrauer: I don't know why this fails, since it looks as though
1110 assignments to prompt are wrapped in calls to xstrdup...
1114 PROMPT (0) = xstrdup (s
);
1124 /* Callback for iterate_over_inferiors. Kills or detaches the given
1125 inferior, depending on how we originally gained control of it. */
1128 kill_or_detach (struct inferior
*inf
, void *args
)
1130 struct qt_args
*qt
= args
;
1131 struct thread_info
*thread
;
1136 thread
= any_thread_of_process (inf
->pid
);
1139 switch_to_thread (thread
->ptid
);
1141 /* Leave core files alone. */
1142 if (target_has_execution
)
1144 if (inf
->attach_flag
)
1145 target_detach (qt
->args
, qt
->from_tty
);
1154 /* Callback for iterate_over_inferiors. Prints info about what GDB
1155 will do to each inferior on a "quit". ARG points to a struct
1156 ui_out where output is to be collected. */
1159 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1161 struct ui_file
*stb
= arg
;
1166 if (inf
->attach_flag
)
1167 fprintf_filtered (stb
,
1168 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1169 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1171 fprintf_filtered (stb
,
1172 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1173 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1178 /* If necessary, make the user confirm that we should quit. Return
1179 non-zero if we should quit, zero if we shouldn't. */
1184 struct ui_file
*stb
;
1185 struct cleanup
*old_chain
;
1189 /* Don't even ask if we're only debugging a core file inferior. */
1190 if (!have_live_inferiors ())
1193 /* Build the query string as a single string. */
1194 stb
= mem_fileopen ();
1195 old_chain
= make_cleanup_ui_file_delete (stb
);
1197 /* This is something of a hack. But there's no reliable way to see
1198 if a GUI is running. The `use_windows' variable doesn't cut
1200 if (deprecated_init_ui_hook
)
1201 fprintf_filtered (stb
, _("A debugging session is active.\n"
1202 "Do you still want to close the debugger?"));
1205 fprintf_filtered (stb
, _("A debugging session is active.\n\n"));
1206 iterate_over_inferiors (print_inferior_quit_action
, stb
);
1207 fprintf_filtered (stb
, _("\nQuit anyway? "));
1210 str
= ui_file_xstrdup (stb
, NULL
);
1211 make_cleanup (xfree
, str
);
1213 qr
= query ("%s", str
);
1214 do_cleanups (old_chain
);
1218 /* Helper routine for quit_force that requires error handling. */
1221 quit_target (void *arg
)
1223 struct qt_args
*qt
= (struct qt_args
*)arg
;
1225 /* Kill or detach all inferiors. */
1226 iterate_over_inferiors (kill_or_detach
, qt
);
1228 /* Give all pushed targets a chance to do minimal cleanup, and pop
1230 pop_all_targets (1);
1232 /* Save the history information if it is appropriate to do so. */
1233 if (write_history_p
&& history_filename
)
1234 write_history (history_filename
);
1236 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before exiting */
1241 /* Quit without asking for confirmation. */
1244 quit_force (char *args
, int from_tty
)
1249 /* An optional expression may be used to cause gdb to terminate with the
1250 value of that expression. */
1253 struct value
*val
= parse_and_eval (args
);
1255 exit_code
= (int) value_as_long (val
);
1257 else if (return_child_result
)
1258 exit_code
= return_child_result_value
;
1261 qt
.from_tty
= from_tty
;
1263 /* We want to handle any quit errors and exit regardless. */
1264 catch_errors (quit_target
, &qt
,
1265 "Quitting: ", RETURN_MASK_ALL
);
1270 /* If OFF, the debugger will run in non-interactive mode, which means
1271 that it will automatically select the default answer to all the
1272 queries made to the user. If ON, gdb will wait for the user to
1273 answer all queries. If AUTO, gdb will determine whether to run
1274 in interactive mode or not depending on whether stdin is a terminal
1276 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1278 /* Implement the "show interactive-mode" option. */
1281 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1282 struct cmd_list_element
*c
,
1285 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1286 fprintf_filtered (file
, "\
1287 Debugger's interactive mode is %s (currently %s).\n",
1288 value
, input_from_terminal_p () ? "on" : "off");
1290 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1293 /* Returns whether GDB is running on a terminal and input is
1294 currently coming from that terminal. */
1297 input_from_terminal_p (void)
1299 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1300 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1302 if (gdb_has_a_terminal () && instream
== stdin
)
1305 /* If INSTREAM is unset, and we are not in a user command, we
1306 must be in Insight. That's like having a terminal, for our
1308 if (instream
== NULL
&& !in_user_command
)
1315 dont_repeat_command (char *ignored
, int from_tty
)
1317 *line
= 0; /* Can't call dont_repeat here because we're not
1318 necessarily reading from stdin. */
1321 /* Functions to manipulate command line editing control variables. */
1323 /* Number of commands to print in each call to show_commands. */
1324 #define Hist_print 10
1326 show_commands (char *args
, int from_tty
)
1328 /* Index for history commands. Relative to history_base. */
1331 /* Number of the history entry which we are planning to display next.
1332 Relative to history_base. */
1335 /* The first command in the history which doesn't exist (i.e. one more
1336 than the number of the last command). Relative to history_base. */
1339 /* Print out some of the commands from the command history. */
1340 /* First determine the length of the history list. */
1341 hist_len
= history_size
;
1342 for (offset
= 0; offset
< history_size
; offset
++)
1344 if (!history_get (history_base
+ offset
))
1353 if (args
[0] == '+' && args
[1] == '\0')
1354 /* "info editing +" should print from the stored position. */
1357 /* "info editing <exp>" should print around command number <exp>. */
1358 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1360 /* "show commands" means print the last Hist_print commands. */
1363 num
= hist_len
- Hist_print
;
1369 /* If there are at least Hist_print commands, we want to display the last
1370 Hist_print rather than, say, the last 6. */
1371 if (hist_len
- num
< Hist_print
)
1373 num
= hist_len
- Hist_print
;
1378 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1380 printf_filtered ("%5d %s\n", history_base
+ offset
,
1381 (history_get (history_base
+ offset
))->line
);
1384 /* The next command we want to display is the next one that we haven't
1388 /* If the user repeats this command with return, it should do what
1389 "show commands +" does. This is unnecessary if arg is null,
1390 because "show commands +" is not useful after "show commands". */
1391 if (from_tty
&& args
)
1398 /* Called by do_setshow_command. */
1400 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1402 if (history_size
== INT_MAX
)
1403 unstifle_history ();
1404 else if (history_size
>= 0)
1405 stifle_history (history_size
);
1408 history_size
= INT_MAX
;
1409 error (_("History size must be non-negative"));
1414 set_history (char *args
, int from_tty
)
1416 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1417 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1421 show_history (char *args
, int from_tty
)
1423 cmd_show_list (showhistlist
, from_tty
, "");
1426 int info_verbose
= 0; /* Default verbose msgs off */
1428 /* Called by do_setshow_command. An elaborate joke. */
1430 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1432 char *cmdname
= "verbose";
1433 struct cmd_list_element
*showcmd
;
1435 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1439 c
->doc
= "Set verbose printing of informational messages.";
1440 showcmd
->doc
= "Show verbose printing of informational messages.";
1444 c
->doc
= "Set verbosity.";
1445 showcmd
->doc
= "Show verbosity.";
1449 /* Init the history buffer. Note that we are called after the init file(s)
1450 * have been read so that the user can change the history file via his
1451 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1452 * overrides all of this.
1460 tmpenv
= getenv ("HISTSIZE");
1462 history_size
= atoi (tmpenv
);
1463 else if (!history_size
)
1466 stifle_history (history_size
);
1468 tmpenv
= getenv ("GDBHISTFILE");
1470 history_filename
= xstrdup (tmpenv
);
1471 else if (!history_filename
)
1473 /* We include the current directory so that if the user changes
1474 directories the file written will be the same as the one
1477 /* No leading dots in file names are allowed on MSDOS. */
1478 history_filename
= concat (current_directory
, "/_gdb_history",
1481 history_filename
= concat (current_directory
, "/.gdb_history",
1485 read_history (history_filename
);
1489 show_new_async_prompt (struct ui_file
*file
, int from_tty
,
1490 struct cmd_list_element
*c
, const char *value
)
1492 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1496 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1497 struct cmd_list_element
*c
, const char *value
)
1499 fprintf_filtered (file
, _("\
1500 Editing of command lines as they are typed is %s.\n"),
1505 show_annotation_level (struct ui_file
*file
, int from_tty
,
1506 struct cmd_list_element
*c
, const char *value
)
1508 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1512 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1513 struct cmd_list_element
*c
, const char *value
)
1515 fprintf_filtered (file
, _("\
1516 Notification of completion for asynchronous execution commands is %s.\n"),
1522 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1523 whatever the DEFAULT_PROMPT is. */
1524 the_prompts
.top
= 0;
1526 PROMPT (0) = xstrdup (DEFAULT_PROMPT
);
1528 /* Set things up for annotation_level > 1, if the user ever decides
1530 async_annotation_suffix
= "prompt";
1531 /* Set the variable associated with the setshow prompt command. */
1532 new_async_prompt
= xstrdup (PROMPT (0));
1534 /* If gdb was started with --annotate=2, this is equivalent to the
1535 user entering the command 'set annotate 2' at the gdb prompt, so
1536 we need to do extra processing. */
1537 if (annotation_level
> 1)
1538 set_async_annotation_level (NULL
, 0, NULL
);
1540 /* Set the important stuff up for command editing. */
1541 command_editing_p
= 1;
1542 history_expansion_p
= 0;
1543 write_history_p
= 0;
1545 /* Setup important stuff for command line editing. */
1546 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
1547 rl_completion_entry_function
= readline_line_completion_function
;
1548 rl_completer_word_break_characters
= default_word_break_characters ();
1549 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1550 rl_readline_name
= "gdb";
1551 rl_terminal_name
= getenv ("TERM");
1553 /* The name for this defun comes from Bash, where it originated.
1554 15 is Control-o, the same binding this function has in Bash. */
1555 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1557 add_setshow_string_cmd ("prompt", class_support
,
1558 &new_async_prompt
, _("\
1559 Set gdb's prompt"), _("\
1560 Show gdb's prompt"), NULL
,
1562 show_new_async_prompt
,
1563 &setlist
, &showlist
);
1565 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1566 Don't repeat this command.\n\
1567 Primarily used inside of user-defined commands that should not be repeated when\n\
1570 add_setshow_boolean_cmd ("editing", class_support
,
1571 &async_command_editing_p
, _("\
1572 Set editing of command lines as they are typed."), _("\
1573 Show editing of command lines as they are typed."), _("\
1574 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1575 Without an argument, command line editing is enabled. To edit, use\n\
1576 EMACS-like or VI-like commands like control-P or ESC."),
1577 set_async_editing_command
,
1578 show_async_command_editing_p
,
1579 &setlist
, &showlist
);
1581 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1582 Set saving of the history record on exit."), _("\
1583 Show saving of the history record on exit."), _("\
1584 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1585 Without an argument, saving is enabled."),
1587 show_write_history_p
,
1588 &sethistlist
, &showhistlist
);
1590 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1591 Set the size of the command history,"), _("\
1592 Show the size of the command history,"), _("\
1593 ie. the number of previous commands to keep a record of."),
1594 set_history_size_command
,
1596 &sethistlist
, &showhistlist
);
1598 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1599 Set the filename in which to record the command history"), _("\
1600 Show the filename in which to record the command history"), _("\
1601 (the list of previous commands of which a record is kept)."),
1603 show_history_filename
,
1604 &sethistlist
, &showhistlist
);
1606 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1607 Set whether to confirm potentially dangerous operations."), _("\
1608 Show whether to confirm potentially dangerous operations."), NULL
,
1611 &setlist
, &showlist
);
1613 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1614 Set annotation_level."), _("\
1615 Show annotation_level."), _("\
1616 0 == normal; 1 == fullname (for use when running under emacs)\n\
1617 2 == output annotated suitably for use by programs that control GDB."),
1618 set_async_annotation_level
,
1619 show_annotation_level
,
1620 &setlist
, &showlist
);
1622 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1623 &exec_done_display_p
, _("\
1624 Set notification of completion for asynchronous execution commands."), _("\
1625 Show notification of completion for asynchronous execution commands."), _("\
1626 Use \"on\" to enable the notification, and \"off\" to disable it."),
1628 show_exec_done_display_p
,
1629 &setlist
, &showlist
);
1631 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
1632 &interactive_mode
, _("\
1633 Set whether GDB should run in interactive mode or not"), _("\
1634 Show whether GDB runs in interactive mode"), _("\
1635 If on, run in interactive mode and wait for the user to answer\n\
1636 all queries. If off, run in non-interactive mode and automatically\n\
1637 assume the default answer to all queries. If auto (the default),\n\
1638 determine which mode to use based on the standard input settings"),
1640 show_interactive_mode
,
1641 &setlist
, &showlist
);
1643 add_setshow_filename_cmd ("data-directory", class_maintenance
,
1644 &gdb_datadir
, _("Set GDB's data directory."),
1645 _("Show GDB's data directory."),
1647 When set, GDB uses the specified path to search for data files."),
1654 gdb_init (char *argv0
)
1656 if (pre_init_ui_hook
)
1657 pre_init_ui_hook ();
1659 /* Run the init function of each source file */
1662 /* Make sure we return to the original directory upon exit, come
1663 what may, since the OS doesn't do that for us. */
1664 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1667 init_cmd_lists (); /* This needs to be done first */
1668 initialize_targets (); /* Setup target_terminal macros for utils.c */
1669 initialize_utils (); /* Make errors and warnings possible */
1670 initialize_all_files ();
1671 /* This creates the current_program_space. Do this after all the
1672 _initialize_foo routines have had a chance to install their
1673 per-sspace data keys. Also do this before
1674 initialize_current_architecture is called, because it accesses
1675 exec_bfd of the current program space. */
1676 initialize_progspace ();
1677 initialize_inferiors ();
1678 initialize_current_architecture ();
1680 init_main (); /* But that omits this file! Do it now */
1682 initialize_stdin_serial ();
1684 async_init_signals ();
1686 /* We need a default language for parsing expressions, so simple things like
1687 "set width 0" won't fail if no language is explicitly set in a config file
1688 or implicitly set by reading an executable during startup. */
1689 set_language (language_c
);
1690 expected_language
= current_language
; /* don't warn about the change. */
1692 /* Allow another UI to initialize. If the UI fails to initialize,
1693 and it wants GDB to revert to the CLI, it should clear
1694 deprecated_init_ui_hook. */
1695 if (deprecated_init_ui_hook
)
1696 deprecated_init_ui_hook (argv0
);