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);
373 space_at_cmd_start = lim - lim_at_start;
378 prepare_execute_command ();
380 /* Force cleanup of any alloca areas if using C alloca instead of
384 /* This can happen when command_line_input hits end of file. */
388 target_log_command (p);
390 while (*p == ' ' || *p == '\t')
397 /* If trace-commands is set then this will print this command. */
398 print_command_trace (p);
400 c = lookup_cmd (&p, cmdlist, "", 0, 1);
402 /* Pass null arg rather than an empty one. */
405 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
406 while the is_complete_command(cfunc) test is just plain
407 bogus. They should both be replaced by a test of the form
408 c->strip_trailing_white_space_p. */
409 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
410 can't be replaced with func. This is because it is the
411 cfunc, and not the func, that has the value that the
412 is_complete_command hack is testing for. */
413 /* Clear off trailing whitespace, except for set and complete
416 && c->type != set_cmd
417 && !is_complete_command (c))
419 p = arg + strlen (arg) - 1;
420 while (p >= arg && (*p == ' ' || *p == '\t'))
425 /* If this command has been pre-hooked, run the hook first. */
426 execute_cmd_pre_hook (c);
428 if (c->flags & DEPRECATED_WARN_USER)
429 deprecated_cmd_warning (&line);
431 if (c->class == class_user)
432 execute_user_command (c, arg);
433 else if (c->type == set_cmd || c->type == show_cmd)
434 do_setshow_command (arg, from_tty & caution, c);
435 else if (!cmd_func_p (c))
436 error (_("That is not a command, just a help topic."));
437 else if (deprecated_call_command_hook)
438 deprecated_call_command_hook (c, arg, from_tty & caution);
440 cmd_func (c, arg, from_tty & caution);
442 /* If this command has been post-hooked, run the hook last. */
443 execute_cmd_post_hook (c);
447 /* Tell the user if the language has changed (except first time).
448 First make sure that a new frame has been selected, in case this
449 command or the hooks changed the program state. */
450 deprecated_safe_get_selected_frame ();
451 if (current_language != expected_language)
453 if (language_mode == language_mode_auto && info_verbose)
455 language_info (1); /* Print what changed. */
460 /* Warn the user if the working language does not match the
461 language of the current frame. Only warn the user if we are
462 actually running the program, i.e. there is a stack. */
463 /* FIXME: This should be cacheing the frame and only running when
464 the frame changes. */
466 if (has_stack_frames ())
468 flang = get_frame_language ();
470 && flang != language_unknown
471 && flang != current_language->la_language)
473 printf_filtered ("%s\n", lang_frame_mismatch_warn);
479 /* Read commands from `instream' and execute them
480 until end of file or error reading instream. */
485 struct cleanup *old_chain;
487 int stdin_is_tty = ISATTY (stdin);
488 long time_at_cmd_start;
490 long space_at_cmd_start = 0;
492 extern int display_time;
493 extern int display_space;
495 while (instream && !feof (instream))
497 if (window_hook && instream == stdin)
498 (*window_hook) (instream, get_prompt ());
501 if (instream == stdin && stdin_is_tty)
502 reinitialize_more_filter ();
503 old_chain = make_cleanup (null_cleanup, 0);
505 /* Get a command-line. This calls the readline package. */
506 command = command_line_input (instream == stdin ?
507 get_prompt () : (char *) NULL,
508 instream == stdin, "prompt");
512 time_at_cmd_start = get_run_time ();
517 char *lim = (char *) sbrk (0);
518 space_at_cmd_start = lim - lim_at_start;
522 execute_command (command, instream == stdin);
524 /* Do any commands attached to breakpoint we are stopped at. */
525 bpstat_do_actions ();
527 do_cleanups (old_chain);
531 long cmd_time = get_run_time () - time_at_cmd_start;
533 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
534 cmd_time / 1000000, cmd_time % 1000000);
540 char *lim = (char *) sbrk (0);
541 long space_now = lim - lim_at_start;
542 long space_diff = space_now - space_at_cmd_start;
544 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
546 (space_diff >= 0 ? "+" : ""),
553 /* Commands call this if they do not want to be repeated by null lines. */
561 /* If we aren't reading from standard input, we are saving the last
562 thing read from stdin in line and don't want to delete it. Null lines
563 won't repeat here in any case. */
564 if (instream == stdin)
568 /* Read a line from the stream "instream" without command line editing.
570 It prints PROMPT_ARG once at the start.
571 Action is compatible with "readline", e.g. space for the result is
572 malloc'd and should be freed by the caller.
574 A NULL return means end of file. */
576 gdb_readline (char *prompt_arg)
581 int result_size = 80;
585 /* Don't use a _filtered function here. It causes the assumed
586 character position to be off, since the newline we read from
587 the user is not accounted for. */
588 fputs_unfiltered (prompt_arg, gdb_stdout);
589 gdb_flush (gdb_stdout);
592 result = (char *) xmalloc (result_size);
596 /* Read from stdin if we are executing a user defined command.
597 This is the right thing for prompt_for_continue, at least. */
598 c = fgetc (instream ? instream : stdin);
603 /* The last line does not end with a newline. Return it, and
604 if we are called again fgetc will still return EOF and
605 we'll return NULL then. */
613 if (input_index > 0 && result[input_index - 1] == '\r')
618 result[input_index++] = c;
619 while (input_index >= result_size)
622 result = (char *) xrealloc (result, result_size);
626 result[input_index++] = '\0';
630 /* Variables which control command line editing and history
631 substitution. These variables are given default values at the end
633 static int command_editing_p;
635 /* NOTE 1999-04-29: This variable will be static again, once we modify
636 gdb to use the event loop as the default command loop and we merge
637 event-top.c into this file, top.c */
639 /* static */ int history_expansion_p;
641 static int write_history_p;
643 show_write_history_p (struct ui_file *file, int from_tty,
644 struct cmd_list_element *c, const char *value)
646 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
650 static int history_size;
652 show_history_size (struct ui_file *file, int from_tty,
653 struct cmd_list_element *c, const char *value)
655 fprintf_filtered (file, _("The size of the command history is %s.\n"),
659 static char *history_filename;
661 show_history_filename (struct ui_file *file, int from_tty,
662 struct cmd_list_element *c, const char *value)
664 fprintf_filtered (file, _("\
665 The filename in which to record the command history is \"%s\".\n"),
669 /* This is like readline(), but it has some gdb-specific behavior.
670 gdb may want readline in both the synchronous and async modes during
671 a single gdb invocation. At the ordinary top-level prompt we might
672 be using the async readline. That means we can't use
673 rl_pre_input_hook, since it doesn't work properly in async mode.
674 However, for a secondary prompt (" >", such as occurs during a
675 `define'), gdb wants a synchronous response.
677 We used to call readline() directly, running it in synchronous
678 mode. But mixing modes this way is not supported, and as of
679 readline 5.x it no longer works; the arrow keys come unbound during
680 the synchronous call. So we make a nested call into the event
681 loop. That's what gdb_readline_wrapper is for. */
683 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
684 rely on gdb_readline_wrapper_result, which might still be NULL if
685 the user types Control-D for EOF. */
686 static int gdb_readline_wrapper_done;
688 /* The result of the current call to gdb_readline_wrapper, once a newline
690 static char *gdb_readline_wrapper_result;
692 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
693 to be called after the newline is processed (which will redisplay
694 the prompt). But in gdb_readline_wrapper we will not get a new
695 prompt until the next call, or until we return to the event loop.
696 So we disable this hook around the newline and restore it before we
698 static void (*saved_after_char_processing_hook) (void);
700 /* This function is called when readline has seen a complete line of
704 gdb_readline_wrapper_line (char *line)
706 gdb_assert (!gdb_readline_wrapper_done);
707 gdb_readline_wrapper_result = line;
708 gdb_readline_wrapper_done = 1;
710 /* Prevent operate-and-get-next from acting too early. */
711 saved_after_char_processing_hook = after_char_processing_hook;
712 after_char_processing_hook = NULL;
714 /* Prevent parts of the prompt from being redisplayed if annotations
715 are enabled, and readline's state getting out of sync. */
716 if (async_command_editing_p)
717 rl_callback_handler_remove ();
720 struct gdb_readline_wrapper_cleanup
722 void (*handler_orig) (char *);
723 int already_prompted_orig;
727 gdb_readline_wrapper_cleanup (void *arg)
729 struct gdb_readline_wrapper_cleanup *cleanup = arg;
731 rl_already_prompted = cleanup->already_prompted_orig;
733 gdb_assert (input_handler == gdb_readline_wrapper_line);
734 input_handler = cleanup->handler_orig;
735 gdb_readline_wrapper_result = NULL;
736 gdb_readline_wrapper_done = 0;
738 after_char_processing_hook = saved_after_char_processing_hook;
739 saved_after_char_processing_hook = NULL;
745 gdb_readline_wrapper (char *prompt)
747 struct cleanup *back_to;
748 struct gdb_readline_wrapper_cleanup *cleanup;
751 cleanup = xmalloc (sizeof (*cleanup));
752 cleanup->handler_orig = input_handler;
753 input_handler = gdb_readline_wrapper_line;
755 cleanup->already_prompted_orig = rl_already_prompted;
757 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
759 /* Display our prompt and prevent double prompt display. */
760 display_gdb_prompt (prompt);
761 rl_already_prompted = 1;
763 if (after_char_processing_hook)
764 (*after_char_processing_hook) ();
765 gdb_assert (after_char_processing_hook == NULL);
767 /* gdb_do_one_event argument is unused. */
768 while (gdb_do_one_event (NULL) >= 0)
769 if (gdb_readline_wrapper_done)
772 retval = gdb_readline_wrapper_result;
773 do_cleanups (back_to);
778 /* The current saved history number from operate-and-get-next.
779 This is -1 if not valid. */
780 static int operate_saved_history = -1;
782 /* This is put on the appropriate hook and helps operate-and-get-next
785 gdb_rl_operate_and_get_next_completion (void)
787 int delta = where_history () - operate_saved_history;
788 /* The `key' argument to rl_get_previous_history is ignored. */
789 rl_get_previous_history (delta, 0);
790 operate_saved_history = -1;
792 /* readline doesn't automatically update the display for us. */
795 after_char_processing_hook = NULL;
796 rl_pre_input_hook = NULL;
799 /* This is a gdb-local readline command handler. It accepts the
800 current command line (like RET does) and, if this command was taken
801 from the history, arranges for the next command in the history to
802 appear on the command line when the prompt returns.
803 We ignore the arguments. */
805 gdb_rl_operate_and_get_next (int count, int key)
809 /* Use the async hook. */
810 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
812 /* Find the current line, and find the next line to use. */
813 where = where_history();
815 /* FIXME: kettenis/20020817: max_input_history is renamed into
816 history_max_entries in readline-4.2. When we do a new readline
817 import, we should probably change it here too, even though
818 readline maintains backwards compatibility for now by still
819 defining max_input_history. */
820 if ((history_is_stifled () && (history_length >= max_input_history)) ||
821 (where >= history_length - 1))
822 operate_saved_history = where;
824 operate_saved_history = where + 1;
826 return rl_newline (1, key);
829 /* Read one line from the command input stream `instream'
830 into the local static buffer `linebuffer' (whose current length
832 The buffer is made bigger as necessary.
833 Returns the address of the start of the line.
835 NULL is returned for end of file.
837 *If* the instream == stdin & stdin is a terminal, the line read
838 is copied into the file line saver (global var char *line,
839 length linesize) so that it can be duplicated.
841 This routine either uses fancy command line editing or
842 simple input as the user has requested. */
845 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
847 static char *linebuffer = 0;
848 static unsigned linelength = 0;
852 char *local_prompt = prompt_arg;
856 /* The annotation suffix must be non-NULL. */
857 if (annotation_suffix == NULL)
858 annotation_suffix = "";
860 if (annotation_level > 1 && instream == stdin)
862 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
863 + strlen (annotation_suffix) + 40);
864 if (prompt_arg == NULL)
865 local_prompt[0] = '\0';
867 strcpy (local_prompt, prompt_arg);
868 strcat (local_prompt, "\n\032\032");
869 strcat (local_prompt, annotation_suffix);
870 strcat (local_prompt, "\n");
876 linebuffer = (char *) xmalloc (linelength);
881 /* Control-C quits instantly if typed while in this loop
882 since it should not wait until the user types a newline. */
886 signal (STOP_SIGNAL, handle_stop_sig);
891 /* Make sure that all output has been output. Some machines may let
892 you get away with leaving out some of the gdb_flush, but not all. */
894 gdb_flush (gdb_stdout);
895 gdb_flush (gdb_stderr);
897 if (source_file_name != NULL)
898 ++source_line_number;
900 if (annotation_level > 1 && instream == stdin)
902 puts_unfiltered ("\n\032\032pre-");
903 puts_unfiltered (annotation_suffix);
904 puts_unfiltered ("\n");
907 /* Don't use fancy stuff if not talking to stdin. */
908 if (deprecated_readline_hook && input_from_terminal_p ())
910 rl = (*deprecated_readline_hook) (local_prompt);
912 else if (command_editing_p && input_from_terminal_p ())
914 rl = gdb_readline_wrapper (local_prompt);
918 rl = gdb_readline (local_prompt);
921 if (annotation_level > 1 && instream == stdin)
923 puts_unfiltered ("\n\032\032post-");
924 puts_unfiltered (annotation_suffix);
925 puts_unfiltered ("\n");
928 if (!rl || rl == (char *) EOF)
933 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
935 linelength = strlen (rl) + 1 + (p - linebuffer);
936 nline = (char *) xrealloc (linebuffer, linelength);
937 p += nline - linebuffer;
941 /* Copy line. Don't copy null at end. (Leaves line alone
942 if this was just a newline) */
946 xfree (rl); /* Allocated in readline. */
948 if (p == linebuffer || *(p - 1) != '\\')
951 p--; /* Put on top of '\'. */
952 local_prompt = (char *) 0;
957 signal (STOP_SIGNAL, SIG_DFL);
964 #define SERVER_COMMAND_LENGTH 7
966 (p - linebuffer > SERVER_COMMAND_LENGTH)
967 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
970 /* Note that we don't set `line'. Between this and the check in
971 dont_repeat, this insures that repeating will still do the
974 return linebuffer + SERVER_COMMAND_LENGTH;
977 /* Do history expansion if that is wished. */
978 if (history_expansion_p && instream == stdin
979 && ISATTY (instream))
984 *p = '\0'; /* Insert null now. */
985 expanded = history_expand (linebuffer, &history_value);
988 /* Print the changes. */
989 printf_unfiltered ("%s\n", history_value);
991 /* If there was an error, call this function again. */
994 xfree (history_value);
995 return command_line_input (prompt_arg, repeat, annotation_suffix);
997 if (strlen (history_value) > linelength)
999 linelength = strlen (history_value) + 1;
1000 linebuffer = (char *) xrealloc (linebuffer, linelength);
1002 strcpy (linebuffer, history_value);
1003 p = linebuffer + strlen (linebuffer);
1005 xfree (history_value);
1008 /* If we just got an empty line, and that is supposed
1009 to repeat the previous command, return the value in the
1011 if (repeat && p == linebuffer)
1013 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1019 /* Add line to history if appropriate. */
1020 if (instream == stdin
1021 && ISATTY (stdin) && *linebuffer)
1022 add_history (linebuffer);
1024 /* Note: lines consisting solely of comments are added to the command
1025 history. This is useful when you type a command, and then
1026 realize you don't want to execute it quite yet. You can comment
1027 out the command and then later fetch it from the value history
1028 and remove the '#'. The kill ring is probably better, but some
1029 people are in the habit of commenting things out. */
1031 *p1 = '\0'; /* Found a comment. */
1033 /* Save into global buffer if appropriate. */
1036 if (linelength > linesize)
1038 line = xrealloc (line, linelength);
1039 linesize = linelength;
1041 strcpy (line, linebuffer);
1048 /* Print the GDB banner. */
1050 print_gdb_version (struct ui_file *stream)
1052 /* From GNU coding standards, first line is meant to be easy for a
1053 program to parse, and is just canonical program name and version
1054 number, which starts after last space. */
1056 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1058 /* Second line is a copyright notice. */
1060 fprintf_filtered (stream, "Copyright (C) 2010 Free Software Foundation, Inc.\n");
1062 /* Following the copyright is a brief statement that the program is
1063 free software, that users are free to copy and change it on
1064 certain conditions, that it is covered by the GNU GPL, and that
1065 there is no warranty. */
1067 fprintf_filtered (stream, "\
1068 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1069 This is free software: you are free to change and redistribute it.\n\
1070 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1071 and \"show warranty\" for details.\n");
1073 /* After the required info we print the configuration information. */
1075 fprintf_filtered (stream, "This GDB was configured as \"");
1076 if (strcmp (host_name, target_name) != 0)
1078 fprintf_filtered (stream, "--host=%s --target=%s", host_name, target_name);
1082 fprintf_filtered (stream, "%s", host_name);
1084 fprintf_filtered (stream, "\".");
1086 if (REPORT_BUGS_TO[0])
1088 fprintf_filtered (stream,
1089 _("\nFor bug reporting instructions, please see:\n"));
1090 fprintf_filtered (stream, "%s.", REPORT_BUGS_TO);
1094 /* get_prompt: access method for the GDB prompt string. */
1103 set_prompt (char *s)
1105 /* ??rehrauer: I don't know why this fails, since it looks as though
1106 assignments to prompt are wrapped in calls to xstrdup...
1110 PROMPT (0) = xstrdup (s);
1120 /* Callback for iterate_over_inferiors. Kills or detaches the given
1121 inferior, depending on how we originally gained control of it. */
1124 kill_or_detach (struct inferior *inf, void *args)
1126 struct qt_args *qt = args;
1127 struct thread_info *thread;
1132 thread = any_thread_of_process (inf->pid);
1135 switch_to_thread (thread->ptid);
1137 /* Leave core files alone. */
1138 if (target_has_execution)
1140 if (inf->attach_flag)
1141 target_detach (qt->args, qt->from_tty);
1150 /* Callback for iterate_over_inferiors. Prints info about what GDB
1151 will do to each inferior on a "quit". ARG points to a struct
1152 ui_out where output is to be collected. */
1155 print_inferior_quit_action (struct inferior *inf, void *arg)
1157 struct ui_file *stb = arg;
1162 if (inf->attach_flag)
1163 fprintf_filtered (stb,
1164 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1165 target_pid_to_str (pid_to_ptid (inf->pid)));
1167 fprintf_filtered (stb,
1168 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1169 target_pid_to_str (pid_to_ptid (inf->pid)));
1174 /* If necessary, make the user confirm that we should quit. Return
1175 non-zero if we should quit, zero if we shouldn't. */
1180 struct ui_file *stb;
1181 struct cleanup *old_chain;
1185 /* Don't even ask if we're only debugging a core file inferior. */
1186 if (!have_live_inferiors ())
1189 /* Build the query string as a single string. */
1190 stb = mem_fileopen ();
1191 old_chain = make_cleanup_ui_file_delete (stb);
1193 /* This is something of a hack. But there's no reliable way to see
1194 if a GUI is running. The `use_windows' variable doesn't cut
1196 if (deprecated_init_ui_hook)
1197 fprintf_filtered (stb, _("A debugging session is active.\n"
1198 "Do you still want to close the debugger?"));
1201 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1202 iterate_over_inferiors (print_inferior_quit_action, stb);
1203 fprintf_filtered (stb, _("\nQuit anyway? "));
1206 str = ui_file_xstrdup (stb, NULL);
1207 make_cleanup (xfree, str);
1209 qr = query ("%s", str);
1210 do_cleanups (old_chain);
1214 /* Helper routine for quit_force that requires error handling. */
1217 quit_target (void *arg)
1219 struct qt_args *qt = (struct qt_args *)arg;
1221 /* Kill or detach all inferiors. */
1222 iterate_over_inferiors (kill_or_detach, qt);
1224 /* Give all pushed targets a chance to do minimal cleanup, and pop
1226 pop_all_targets (1);
1228 /* Save the history information if it is appropriate to do so. */
1229 if (write_history_p && history_filename)
1230 write_history (history_filename);
1232 do_final_cleanups (ALL_CLEANUPS); /* Do any final cleanups before exiting */
1237 /* Quit without asking for confirmation. */
1240 quit_force (char *args, int from_tty)
1245 /* An optional expression may be used to cause gdb to terminate with the
1246 value of that expression. */
1249 struct value *val = parse_and_eval (args);
1251 exit_code = (int) value_as_long (val);
1253 else if (return_child_result)
1254 exit_code = return_child_result_value;
1257 qt.from_tty = from_tty;
1259 /* We want to handle any quit errors and exit regardless. */
1260 catch_errors (quit_target, &qt,
1261 "Quitting: ", RETURN_MASK_ALL);
1266 /* If OFF, the debugger will run in non-interactive mode, which means
1267 that it will automatically select the default answer to all the
1268 queries made to the user. If ON, gdb will wait for the user to
1269 answer all queries. If AUTO, gdb will determine whether to run
1270 in interactive mode or not depending on whether stdin is a terminal
1272 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1274 /* Implement the "show interactive-mode" option. */
1277 show_interactive_mode (struct ui_file *file, int from_tty,
1278 struct cmd_list_element *c,
1281 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1282 fprintf_filtered (file, "\
1283 Debugger's interactive mode is %s (currently %s).\n",
1284 value, input_from_terminal_p () ? "on" : "off");
1286 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1289 /* Returns whether GDB is running on a terminal and input is
1290 currently coming from that terminal. */
1293 input_from_terminal_p (void)
1295 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1296 return interactive_mode == AUTO_BOOLEAN_TRUE;
1298 if (gdb_has_a_terminal () && instream == stdin)
1301 /* If INSTREAM is unset, and we are not in a user command, we
1302 must be in Insight. That's like having a terminal, for our
1304 if (instream == NULL && !in_user_command)
1311 dont_repeat_command (char *ignored, int from_tty)
1313 *line = 0; /* Can't call dont_repeat here because we're not
1314 necessarily reading from stdin. */
1317 /* Functions to manipulate command line editing control variables. */
1319 /* Number of commands to print in each call to show_commands. */
1320 #define Hist_print 10
1322 show_commands (char *args, int from_tty)
1324 /* Index for history commands. Relative to history_base. */
1327 /* Number of the history entry which we are planning to display next.
1328 Relative to history_base. */
1331 /* The first command in the history which doesn't exist (i.e. one more
1332 than the number of the last command). Relative to history_base. */
1335 /* Print out some of the commands from the command history. */
1336 /* First determine the length of the history list. */
1337 hist_len = history_size;
1338 for (offset = 0; offset < history_size; offset++)
1340 if (!history_get (history_base + offset))
1349 if (args[0] == '+' && args[1] == '\0')
1350 /* "info editing +" should print from the stored position. */
1353 /* "info editing <exp>" should print around command number <exp>. */
1354 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1356 /* "show commands" means print the last Hist_print commands. */
1359 num = hist_len - Hist_print;
1365 /* If there are at least Hist_print commands, we want to display the last
1366 Hist_print rather than, say, the last 6. */
1367 if (hist_len - num < Hist_print)
1369 num = hist_len - Hist_print;
1374 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1376 printf_filtered ("%5d %s\n", history_base + offset,
1377 (history_get (history_base + offset))->line);
1380 /* The next command we want to display is the next one that we haven't
1384 /* If the user repeats this command with return, it should do what
1385 "show commands +" does. This is unnecessary if arg is null,
1386 because "show commands +" is not useful after "show commands". */
1387 if (from_tty && args)
1394 /* Called by do_setshow_command. */
1396 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1398 if (history_size == INT_MAX)
1399 unstifle_history ();
1400 else if (history_size >= 0)
1401 stifle_history (history_size);
1404 history_size = INT_MAX;
1405 error (_("History size must be non-negative"));
1410 set_history (char *args, int from_tty)
1412 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1413 help_list (sethistlist, "set history ", -1, gdb_stdout);
1417 show_history (char *args, int from_tty)
1419 cmd_show_list (showhistlist, from_tty, "");
1422 int info_verbose = 0; /* Default verbose msgs off */
1424 /* Called by do_setshow_command. An elaborate joke. */
1426 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1428 char *cmdname = "verbose";
1429 struct cmd_list_element *showcmd;
1431 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1435 c->doc = "Set verbose printing of informational messages.";
1436 showcmd->doc = "Show verbose printing of informational messages.";
1440 c->doc = "Set verbosity.";
1441 showcmd->doc = "Show verbosity.";
1445 /* Init the history buffer. Note that we are called after the init file(s)
1446 * have been read so that the user can change the history file via his
1447 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1448 * overrides all of this.
1456 tmpenv = getenv ("HISTSIZE");
1458 history_size = atoi (tmpenv);
1459 else if (!history_size)
1462 stifle_history (history_size);
1464 tmpenv = getenv ("GDBHISTFILE");
1466 history_filename = xstrdup (tmpenv);
1467 else if (!history_filename)
1469 /* We include the current directory so that if the user changes
1470 directories the file written will be the same as the one
1473 /* No leading dots in file names are allowed on MSDOS. */
1474 history_filename = concat (current_directory, "/_gdb_history",
1477 history_filename = concat (current_directory, "/.gdb_history",
1481 read_history (history_filename);
1485 show_new_async_prompt (struct ui_file *file, int from_tty,
1486 struct cmd_list_element *c, const char *value)
1488 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1492 show_async_command_editing_p (struct ui_file *file, int from_tty,
1493 struct cmd_list_element *c, const char *value)
1495 fprintf_filtered (file, _("\
1496 Editing of command lines as they are typed is %s.\n"),
1501 show_annotation_level (struct ui_file *file, int from_tty,
1502 struct cmd_list_element *c, const char *value)
1504 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1508 show_exec_done_display_p (struct ui_file *file, int from_tty,
1509 struct cmd_list_element *c, const char *value)
1511 fprintf_filtered (file, _("\
1512 Notification of completion for asynchronous execution commands is %s.\n"),
1518 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1519 whatever the DEFAULT_PROMPT is. */
1520 the_prompts.top = 0;
1522 PROMPT (0) = xstrdup (DEFAULT_PROMPT);
1524 /* Set things up for annotation_level > 1, if the user ever decides
1526 async_annotation_suffix = "prompt";
1527 /* Set the variable associated with the setshow prompt command. */
1528 new_async_prompt = xstrdup (PROMPT (0));
1530 /* If gdb was started with --annotate=2, this is equivalent to the
1531 user entering the command 'set annotate 2' at the gdb prompt, so
1532 we need to do extra processing. */
1533 if (annotation_level > 1)
1534 set_async_annotation_level (NULL, 0, NULL);
1536 /* Set the important stuff up for command editing. */
1537 command_editing_p = 1;
1538 history_expansion_p = 0;
1539 write_history_p = 0;
1541 /* Setup important stuff for command line editing. */
1542 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1543 rl_completion_entry_function = readline_line_completion_function;
1544 rl_completer_word_break_characters = default_word_break_characters ();
1545 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1546 rl_readline_name = "gdb";
1547 rl_terminal_name = getenv ("TERM");
1549 /* The name for this defun comes from Bash, where it originated.
1550 15 is Control-o, the same binding this function has in Bash. */
1551 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1553 add_setshow_string_cmd ("prompt", class_support,
1554 &new_async_prompt, _("\
1555 Set gdb's prompt"), _("\
1556 Show gdb's prompt"), NULL,
1558 show_new_async_prompt,
1559 &setlist, &showlist);
1561 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1562 Don't repeat this command.\n\
1563 Primarily used inside of user-defined commands that should not be repeated when\n\
1566 add_setshow_boolean_cmd ("editing", class_support,
1567 &async_command_editing_p, _("\
1568 Set editing of command lines as they are typed."), _("\
1569 Show editing of command lines as they are typed."), _("\
1570 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1571 Without an argument, command line editing is enabled. To edit, use\n\
1572 EMACS-like or VI-like commands like control-P or ESC."),
1573 set_async_editing_command,
1574 show_async_command_editing_p,
1575 &setlist, &showlist);
1577 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1578 Set saving of the history record on exit."), _("\
1579 Show saving of the history record on exit."), _("\
1580 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1581 Without an argument, saving is enabled."),
1583 show_write_history_p,
1584 &sethistlist, &showhistlist);
1586 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1587 Set the size of the command history,"), _("\
1588 Show the size of the command history,"), _("\
1589 ie. the number of previous commands to keep a record of."),
1590 set_history_size_command,
1592 &sethistlist, &showhistlist);
1594 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1595 Set the filename in which to record the command history"), _("\
1596 Show the filename in which to record the command history"), _("\
1597 (the list of previous commands of which a record is kept)."),
1599 show_history_filename,
1600 &sethistlist, &showhistlist);
1602 add_setshow_boolean_cmd ("confirm", class_support, &caution, _("\
1603 Set whether to confirm potentially dangerous operations."), _("\
1604 Show whether to confirm potentially dangerous operations."), NULL,
1607 &setlist, &showlist);
1609 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1610 Set annotation_level."), _("\
1611 Show annotation_level."), _("\
1612 0 == normal; 1 == fullname (for use when running under emacs)\n\
1613 2 == output annotated suitably for use by programs that control GDB."),
1614 set_async_annotation_level,
1615 show_annotation_level,
1616 &setlist, &showlist);
1618 add_setshow_boolean_cmd ("exec-done-display", class_support,
1619 &exec_done_display_p, _("\
1620 Set notification of completion for asynchronous execution commands."), _("\
1621 Show notification of completion for asynchronous execution commands."), _("\
1622 Use \"on\" to enable the notification, and \"off\" to disable it."),
1624 show_exec_done_display_p,
1625 &setlist, &showlist);
1627 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
1628 &interactive_mode, _("\
1629 Set whether GDB should run in interactive mode or not"), _("\
1630 Show whether GDB runs in interactive mode"), _("\
1631 If on, run in interactive mode and wait for the user to answer\n\
1632 all queries. If off, run in non-interactive mode and automatically\n\
1633 assume the default answer to all queries. If auto (the default),\n\
1634 determine which mode to use based on the standard input settings"),
1636 show_interactive_mode,
1637 &setlist, &showlist);
1639 add_setshow_filename_cmd ("data-directory", class_maintenance,
1640 &gdb_datadir, _("Set GDB's data directory."),
1641 _("Show GDB's data directory."),
1643 When set, GDB uses the specified path to search for data files."),
1650 gdb_init (char *argv0)
1652 if (pre_init_ui_hook)
1653 pre_init_ui_hook ();
1655 /* Run the init function of each source file */
1658 /* Make sure we return to the original directory upon exit, come
1659 what may, since the OS doesn't do that for us. */
1660 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1663 init_cmd_lists (); /* This needs to be done first */
1664 initialize_targets (); /* Setup target_terminal macros for utils.c */
1665 initialize_utils (); /* Make errors and warnings possible */
1666 initialize_all_files ();
1667 /* This creates the current_program_space. Do this after all the
1668 _initialize_foo routines have had a chance to install their
1669 per-sspace data keys. Also do this before
1670 initialize_current_architecture is called, because it accesses
1671 exec_bfd of the current program space. */
1672 initialize_progspace ();
1673 initialize_inferiors ();
1674 initialize_current_architecture ();
1676 init_main (); /* But that omits this file! Do it now */
1678 initialize_stdin_serial ();
1680 async_init_signals ();
1682 /* We need a default language for parsing expressions, so simple things like
1683 "set width 0" won't fail if no language is explicitly set in a config file
1684 or implicitly set by reading an executable during startup. */
1685 set_language (language_c);
1686 expected_language = current_language; /* don't warn about the change. */
1688 /* Allow another UI to initialize. If the UI fails to initialize,
1689 and it wants GDB to revert to the CLI, it should clear
1690 deprecated_init_ui_hook. */
1691 if (deprecated_init_ui_hook)
1692 deprecated_init_ui_hook (argv0);