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, 2011 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"
50 #include "python/python.h"
52 /* readline include files. */
53 #include "readline/readline.h"
54 #include "readline/history.h"
56 /* readline defines this. */
59 #include <sys/types.h>
61 #include "event-top.h"
62 #include "gdb_string.h"
68 /* Default command line prompt. This is overriden in some configs. */
70 #ifndef DEFAULT_PROMPT
71 #define DEFAULT_PROMPT "(gdb) "
74 /* Initialization file name for gdb. This is overridden in some configs. */
78 # define PATH_MAX FILENAME_MAX
84 #ifndef GDBINIT_FILENAME
85 #define GDBINIT_FILENAME ".gdbinit"
87 char gdbinit[PATH_MAX + 1] = GDBINIT_FILENAME;
89 int inhibit_gdbinit = 0;
91 /* If nonzero, and GDB has been configured to be able to use windows,
92 attempt to open them upon startup. */
96 extern char lang_frame_mismatch_warn[]; /* language.c */
98 /* Flag for whether we want all the "from_tty" gubbish printed. */
100 int caution = 1; /* Default is yes, sigh. */
102 show_caution (struct ui_file *file, int from_tty,
103 struct cmd_list_element *c, const char *value)
105 fprintf_filtered (file, _("Whether to confirm potentially "
106 "dangerous operations is %s.\n"),
110 /* stdio stream that command input is being read from. Set to stdin
111 normally. Set by source_command to the file we are sourcing. Set
112 to NULL if we are executing a user-defined command or interacting
117 /* Flag to indicate whether a user defined command is currently running. */
121 /* Current working directory. */
123 char *current_directory;
125 /* The directory name is actually stored here (usually). */
126 char gdb_dirbuf[1024];
128 /* Function to call before reading a command, if nonzero.
129 The function receives two args: an input stream,
130 and a prompt string. */
132 void (*window_hook) (FILE *, char *);
137 /* Buffer used for reading command lines, and the size
138 allocated for it so far. */
143 /* Nonzero if the current command is modified by "server ". This
144 affects things like recording into the command history, commands
145 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
146 whatever) can issue its own commands and also send along commands
147 from the user, and have the user not notice that the user interface
148 is issuing commands too. */
151 /* Baud rate specified for talking to serial target systems. Default
152 is left as -1, so targets can choose their own defaults. */
153 /* FIXME: This means that "show remotebaud" and gr_files_info can
154 print -1 or (unsigned int)-1. This is a Bad User Interface. */
158 /* Timeout limit for response from target. */
160 /* The default value has been changed many times over the years. It
161 was originally 5 seconds. But that was thought to be a long time
162 to sit and wait, so it was changed to 2 seconds. That was thought
163 to be plenty unless the connection was going through some terminal
164 server or multiplexer or other form of hairy serial connection.
166 In mid-1996, remote_timeout was moved from remote.c to top.c and
167 it began being used in other remote-* targets. It appears that the
168 default was changed to 20 seconds at that time, perhaps because the
169 Renesas E7000 ICE didn't always respond in a timely manner.
171 But if 5 seconds is a long time to sit and wait for retransmissions,
172 20 seconds is far worse. This demonstrates the difficulty of using
173 a single variable for all protocol timeouts.
175 As remote.c is used much more than remote-e7000.c, it was changed
176 back to 2 seconds in 1999. */
178 int remote_timeout = 2;
180 /* Non-zero tells remote* modules to output debugging info. */
182 int remote_debug = 0;
184 /* Sbrk location on entry to main. Used for statistics only. */
189 /* Hooks for alternate command interfaces. */
191 /* Called after most modules have been initialized, but before taking
194 If the UI fails to initialize and it wants GDB to continue using
195 the default UI, then it should clear this hook before returning. */
197 void (*deprecated_init_ui_hook) (char *argv0);
199 /* This hook is called from within gdb's many mini-event loops which
200 could steal control from a real user interface's event loop. It
201 returns non-zero if the user is requesting a detach, zero
204 int (*deprecated_ui_loop_hook) (int);
206 /* Called instead of command_loop at top level. Can be invoked via
207 throw_exception(). */
209 void (*deprecated_command_loop_hook) (void);
212 /* Called from print_frame_info to list the line we stopped in. */
214 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
218 /* Replaces most of query. */
220 int (*deprecated_query_hook) (const char *, va_list);
222 /* Replaces most of warning. */
224 void (*deprecated_warning_hook) (const char *, va_list);
226 /* These three functions support getting lines of text from the user.
227 They are used in sequence. First deprecated_readline_begin_hook is
228 called with a text string that might be (for example) a message for
229 the user to type in a sequence of commands to be executed at a
230 breakpoint. If this function calls back to a GUI, it might take
231 this opportunity to pop up a text interaction window with this
232 message. Next, deprecated_readline_hook is called with a prompt
233 that is emitted prior to collecting the user input. It can be
234 called multiple times. Finally, deprecated_readline_end_hook is
235 called to notify the GUI that we are done with the interaction
236 window and it can close it. */
238 void (*deprecated_readline_begin_hook) (char *, ...);
239 char *(*deprecated_readline_hook) (char *);
240 void (*deprecated_readline_end_hook) (void);
242 /* Called as appropriate to notify the interface that we have attached
243 to or detached from an already running process. */
245 void (*deprecated_attach_hook) (void);
246 void (*deprecated_detach_hook) (void);
248 /* Called during long calculations to allow GUI to repair window
249 damage, and to check for stop buttons, etc... */
251 void (*deprecated_interactive_hook) (void);
253 /* Tell the GUI someone changed the register REGNO. -1 means
254 that the caller does not know which register changed or
255 that several registers have changed (see value_assign). */
256 void (*deprecated_register_changed_hook) (int regno);
258 /* Called when going to wait for the target. Usually allows the GUI
259 to run while waiting for target events. */
261 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
262 struct target_waitstatus *status,
265 /* Used by UI as a wrapper around command execution. May do various
266 things like enabling/disabling buttons, etc... */
268 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
269 char *cmd, int from_tty);
271 /* Called after a `set' command has finished. Is only run if the
272 `set' command succeeded. */
274 void (*deprecated_set_hook) (struct cmd_list_element * c);
276 /* Called when the current thread changes. Argument is thread id. */
278 void (*deprecated_context_hook) (int id);
280 /* Handler for SIGHUP. */
283 /* NOTE 1999-04-29: This function will be static again, once we modify
284 gdb to use the event loop as the default command loop and we merge
285 event-top.c into this file, top.c. */
289 caution = 0; /* Throw caution to the wind -- we're exiting.
290 This prevents asking the user dumb
292 quit_command ((char *) 0, 0);
295 #endif /* defined SIGHUP */
297 /* Line number we are currently in in a file which is being sourced. */
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 */ int source_line_number;
303 /* Name of the file we are sourcing. */
304 /* NOTE 1999-04-29: This variable will be static again, once we modify
305 gdb to use the event loop as the default command loop and we merge
306 event-top.c into this file, top.c. */
307 /* static */ const char *source_file_name;
309 /* Clean up on error during a "source" command (or execution of a
310 user-defined command). */
313 do_restore_instream_cleanup (void *stream)
315 /* Restore the previous input stream. */
319 /* Read commands from STREAM. */
321 read_command_file (FILE *stream)
323 struct cleanup *cleanups;
325 cleanups = make_cleanup (do_restore_instream_cleanup, instream);
328 do_cleanups (cleanups);
331 void (*pre_init_ui_hook) (void);
335 do_chdir_cleanup (void *old_dir)
343 prepare_execute_command (void)
347 /* With multiple threads running while the one we're examining is
348 stopped, the dcache can get stale without us being able to detect
349 it. For the duration of the command, though, use the dcache to
350 help things like backtrace. */
352 target_dcache_invalidate ();
355 /* Execute the line P as a command, in the current user context.
356 Pass FROM_TTY as second argument to the defining function. */
359 execute_command (char *p, int from_tty)
361 struct cmd_list_element *c;
363 static int warned = 0;
366 prepare_execute_command ();
368 /* Force cleanup of any alloca areas if using C alloca instead of
372 /* This can happen when command_line_input hits end of file. */
376 target_log_command (p);
378 while (*p == ' ' || *p == '\t')
385 /* If trace-commands is set then this will print this command. */
386 print_command_trace (p);
388 c = lookup_cmd (&p, cmdlist, "", 0, 1);
390 /* Pass null arg rather than an empty one. */
393 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
394 while the is_complete_command(cfunc) test is just plain
395 bogus. They should both be replaced by a test of the form
396 c->strip_trailing_white_space_p. */
397 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
398 can't be replaced with func. This is because it is the
399 cfunc, and not the func, that has the value that the
400 is_complete_command hack is testing for. */
401 /* Clear off trailing whitespace, except for set and complete
404 && c->type != set_cmd
405 && !is_complete_command (c))
407 p = arg + strlen (arg) - 1;
408 while (p >= arg && (*p == ' ' || *p == '\t'))
413 /* If this command has been pre-hooked, run the hook first. */
414 execute_cmd_pre_hook (c);
416 if (c->flags & DEPRECATED_WARN_USER)
417 deprecated_cmd_warning (&line);
419 if (c->class == class_user)
420 execute_user_command (c, arg);
421 else if (c->type == set_cmd || c->type == show_cmd)
422 do_setshow_command (arg, from_tty & caution, c);
423 else if (!cmd_func_p (c))
424 error (_("That is not a command, just a help topic."));
425 else if (deprecated_call_command_hook)
426 deprecated_call_command_hook (c, arg, from_tty & caution);
428 cmd_func (c, arg, from_tty & caution);
430 /* If this command has been post-hooked, run the hook last. */
431 execute_cmd_post_hook (c);
435 /* Tell the user if the language has changed (except first time).
436 First make sure that a new frame has been selected, in case this
437 command or the hooks changed the program state. */
438 deprecated_safe_get_selected_frame ();
439 if (current_language != expected_language)
441 if (language_mode == language_mode_auto && info_verbose)
443 language_info (1); /* Print what changed. */
448 /* Warn the user if the working language does not match the
449 language of the current frame. Only warn the user if we are
450 actually running the program, i.e. there is a stack. */
451 /* FIXME: This should be cacheing the frame and only running when
452 the frame changes. */
454 if (has_stack_frames ())
456 flang = get_frame_language ();
458 && flang != language_unknown
459 && flang != current_language->la_language)
461 printf_filtered ("%s\n", lang_frame_mismatch_warn);
467 /* Run execute_command for P and FROM_TTY. Capture its output into the
468 returned string, do not display it to the screen. BATCH_FLAG will be
469 temporarily set to true. */
472 execute_command_to_string (char *p, int from_tty)
474 struct ui_file *str_file;
475 struct cleanup *cleanup;
478 /* GDB_STDOUT should be better already restored during these
479 restoration callbacks. */
480 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
482 str_file = mem_fileopen ();
484 make_cleanup_ui_file_delete (str_file);
485 make_cleanup_restore_ui_file (&gdb_stdout);
486 make_cleanup_restore_ui_file (&gdb_stderr);
487 make_cleanup_restore_ui_file (&gdb_stdlog);
488 make_cleanup_restore_ui_file (&gdb_stdtarg);
489 make_cleanup_restore_ui_file (&gdb_stdtargerr);
491 if (ui_out_redirect (uiout, str_file) < 0)
492 warning (_("Current output protocol does not support redirection"));
494 make_cleanup_ui_out_redirect_pop (uiout);
496 gdb_stdout = str_file;
497 gdb_stderr = str_file;
498 gdb_stdlog = str_file;
499 gdb_stdtarg = str_file;
500 gdb_stdtargerr = str_file;
502 execute_command (p, from_tty);
504 retval = ui_file_xstrdup (str_file, NULL);
506 do_cleanups (cleanup);
511 /* Read commands from `instream' and execute them
512 until end of file or error reading instream. */
517 struct cleanup *old_chain;
519 int stdin_is_tty = ISATTY (stdin);
521 while (instream && !feof (instream))
523 if (window_hook && instream == stdin)
524 (*window_hook) (instream, get_prompt ());
527 if (instream == stdin && stdin_is_tty)
528 reinitialize_more_filter ();
529 old_chain = make_cleanup (null_cleanup, 0);
531 /* Get a command-line. This calls the readline package. */
532 command = command_line_input (instream == stdin ?
533 get_prompt () : (char *) NULL,
534 instream == stdin, "prompt");
538 make_command_stats_cleanup (1);
540 execute_command (command, instream == stdin);
542 /* Do any commands attached to breakpoint we are stopped at. */
543 bpstat_do_actions ();
545 do_cleanups (old_chain);
549 /* Commands call this if they do not want to be repeated by null lines. */
557 /* If we aren't reading from standard input, we are saving the last
558 thing read from stdin in line and don't want to delete it. Null
559 lines won't repeat here in any case. */
560 if (instream == stdin)
564 /* Read a line from the stream "instream" without command line editing.
566 It prints PROMPT_ARG once at the start.
567 Action is compatible with "readline", e.g. space for the result is
568 malloc'd and should be freed by the caller.
570 A NULL return means end of file. */
572 gdb_readline (char *prompt_arg)
577 int result_size = 80;
581 /* Don't use a _filtered function here. It causes the assumed
582 character position to be off, since the newline we read from
583 the user is not accounted for. */
584 fputs_unfiltered (prompt_arg, gdb_stdout);
585 gdb_flush (gdb_stdout);
588 result = (char *) xmalloc (result_size);
592 /* Read from stdin if we are executing a user defined command.
593 This is the right thing for prompt_for_continue, at least. */
594 c = fgetc (instream ? instream : stdin);
599 /* The last line does not end with a newline. Return it, and
600 if we are called again fgetc will still return EOF and
601 we'll return NULL then. */
609 if (input_index > 0 && result[input_index - 1] == '\r')
614 result[input_index++] = c;
615 while (input_index >= result_size)
618 result = (char *) xrealloc (result, result_size);
622 result[input_index++] = '\0';
626 /* Variables which control command line editing and history
627 substitution. These variables are given default values at the end
629 static int command_editing_p;
631 /* NOTE 1999-04-29: This variable will be static again, once we modify
632 gdb to use the event loop as the default command loop and we merge
633 event-top.c into this file, top.c. */
635 /* static */ int history_expansion_p;
637 static int write_history_p;
639 show_write_history_p (struct ui_file *file, int from_tty,
640 struct cmd_list_element *c, const char *value)
642 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
646 static int history_size;
648 show_history_size (struct ui_file *file, int from_tty,
649 struct cmd_list_element *c, const char *value)
651 fprintf_filtered (file, _("The size of the command history is %s.\n"),
655 static char *history_filename;
657 show_history_filename (struct ui_file *file, int from_tty,
658 struct cmd_list_element *c, const char *value)
660 fprintf_filtered (file, _("The filename in which to record "
661 "the command history is \"%s\".\n"),
665 /* This is like readline(), but it has some gdb-specific behavior.
666 gdb may want readline in both the synchronous and async modes during
667 a single gdb invocation. At the ordinary top-level prompt we might
668 be using the async readline. That means we can't use
669 rl_pre_input_hook, since it doesn't work properly in async mode.
670 However, for a secondary prompt (" >", such as occurs during a
671 `define'), gdb wants a synchronous response.
673 We used to call readline() directly, running it in synchronous
674 mode. But mixing modes this way is not supported, and as of
675 readline 5.x it no longer works; the arrow keys come unbound during
676 the synchronous call. So we make a nested call into the event
677 loop. That's what gdb_readline_wrapper is for. */
679 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
680 rely on gdb_readline_wrapper_result, which might still be NULL if
681 the user types Control-D for EOF. */
682 static int gdb_readline_wrapper_done;
684 /* The result of the current call to gdb_readline_wrapper, once a newline
686 static char *gdb_readline_wrapper_result;
688 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
689 to be called after the newline is processed (which will redisplay
690 the prompt). But in gdb_readline_wrapper we will not get a new
691 prompt until the next call, or until we return to the event loop.
692 So we disable this hook around the newline and restore it before we
694 static void (*saved_after_char_processing_hook) (void);
696 /* This function is called when readline has seen a complete line of
700 gdb_readline_wrapper_line (char *line)
702 gdb_assert (!gdb_readline_wrapper_done);
703 gdb_readline_wrapper_result = line;
704 gdb_readline_wrapper_done = 1;
706 /* Prevent operate-and-get-next from acting too early. */
707 saved_after_char_processing_hook = after_char_processing_hook;
708 after_char_processing_hook = NULL;
710 /* Prevent parts of the prompt from being redisplayed if annotations
711 are enabled, and readline's state getting out of sync. */
712 if (async_command_editing_p)
713 rl_callback_handler_remove ();
716 struct gdb_readline_wrapper_cleanup
718 void (*handler_orig) (char *);
719 int already_prompted_orig;
723 gdb_readline_wrapper_cleanup (void *arg)
725 struct gdb_readline_wrapper_cleanup *cleanup = arg;
727 rl_already_prompted = cleanup->already_prompted_orig;
729 gdb_assert (input_handler == gdb_readline_wrapper_line);
730 input_handler = cleanup->handler_orig;
731 gdb_readline_wrapper_result = NULL;
732 gdb_readline_wrapper_done = 0;
734 after_char_processing_hook = saved_after_char_processing_hook;
735 saved_after_char_processing_hook = NULL;
741 gdb_readline_wrapper (char *prompt)
743 struct cleanup *back_to;
744 struct gdb_readline_wrapper_cleanup *cleanup;
747 cleanup = xmalloc (sizeof (*cleanup));
748 cleanup->handler_orig = input_handler;
749 input_handler = gdb_readline_wrapper_line;
751 cleanup->already_prompted_orig = rl_already_prompted;
753 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
755 /* Display our prompt and prevent double prompt display. */
756 display_gdb_prompt (prompt);
757 rl_already_prompted = 1;
759 if (after_char_processing_hook)
760 (*after_char_processing_hook) ();
761 gdb_assert (after_char_processing_hook == NULL);
763 /* gdb_do_one_event argument is unused. */
764 while (gdb_do_one_event (NULL) >= 0)
765 if (gdb_readline_wrapper_done)
768 retval = gdb_readline_wrapper_result;
769 do_cleanups (back_to);
774 /* The current saved history number from operate-and-get-next.
775 This is -1 if not valid. */
776 static int operate_saved_history = -1;
778 /* This is put on the appropriate hook and helps operate-and-get-next
781 gdb_rl_operate_and_get_next_completion (void)
783 int delta = where_history () - operate_saved_history;
785 /* The `key' argument to rl_get_previous_history is ignored. */
786 rl_get_previous_history (delta, 0);
787 operate_saved_history = -1;
789 /* readline doesn't automatically update the display for us. */
792 after_char_processing_hook = NULL;
793 rl_pre_input_hook = NULL;
796 /* This is a gdb-local readline command handler. It accepts the
797 current command line (like RET does) and, if this command was taken
798 from the history, arranges for the next command in the history to
799 appear on the command line when the prompt returns.
800 We ignore the arguments. */
802 gdb_rl_operate_and_get_next (int count, int key)
806 /* Use the async hook. */
807 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
809 /* Find the current line, and find the next line to use. */
810 where = where_history();
812 /* FIXME: kettenis/20020817: max_input_history is renamed into
813 history_max_entries in readline-4.2. When we do a new readline
814 import, we should probably change it here too, even though
815 readline maintains backwards compatibility for now by still
816 defining max_input_history. */
817 if ((history_is_stifled () && (history_length >= max_input_history)) ||
818 (where >= history_length - 1))
819 operate_saved_history = where;
821 operate_saved_history = where + 1;
823 return rl_newline (1, key);
826 /* Read one line from the command input stream `instream'
827 into the local static buffer `linebuffer' (whose current length
829 The buffer is made bigger as necessary.
830 Returns the address of the start of the line.
832 NULL is returned for end of file.
834 *If* the instream == stdin & stdin is a terminal, the line read
835 is copied into the file line saver (global var char *line,
836 length linesize) so that it can be duplicated.
838 This routine either uses fancy command line editing or
839 simple input as the user has requested. */
842 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
844 static char *linebuffer = 0;
845 static unsigned linelength = 0;
849 char *local_prompt = prompt_arg;
853 /* The annotation suffix must be non-NULL. */
854 if (annotation_suffix == NULL)
855 annotation_suffix = "";
857 if (annotation_level > 1 && instream == stdin)
859 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
860 + strlen (annotation_suffix) + 40);
861 if (prompt_arg == NULL)
862 local_prompt[0] = '\0';
864 strcpy (local_prompt, prompt_arg);
865 strcat (local_prompt, "\n\032\032");
866 strcat (local_prompt, annotation_suffix);
867 strcat (local_prompt, "\n");
873 linebuffer = (char *) xmalloc (linelength);
878 /* Control-C quits instantly if typed while in this loop
879 since it should not wait until the user types a newline. */
883 signal (STOP_SIGNAL, handle_stop_sig);
888 /* Make sure that all output has been output. Some machines may
889 let you get away with leaving out some of the gdb_flush, but
892 gdb_flush (gdb_stdout);
893 gdb_flush (gdb_stderr);
895 if (source_file_name != NULL)
896 ++source_line_number;
898 if (annotation_level > 1 && instream == stdin)
900 puts_unfiltered ("\n\032\032pre-");
901 puts_unfiltered (annotation_suffix);
902 puts_unfiltered ("\n");
905 /* Don't use fancy stuff if not talking to stdin. */
906 if (deprecated_readline_hook && input_from_terminal_p ())
908 rl = (*deprecated_readline_hook) (local_prompt);
910 else if (command_editing_p && input_from_terminal_p ())
912 rl = gdb_readline_wrapper (local_prompt);
916 rl = gdb_readline (local_prompt);
919 if (annotation_level > 1 && instream == stdin)
921 puts_unfiltered ("\n\032\032post-");
922 puts_unfiltered (annotation_suffix);
923 puts_unfiltered ("\n");
926 if (!rl || rl == (char *) EOF)
931 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
933 linelength = strlen (rl) + 1 + (p - linebuffer);
934 nline = (char *) xrealloc (linebuffer, linelength);
935 p += nline - linebuffer;
939 /* Copy line. Don't copy null at end. (Leaves line alone
940 if this was just a newline). */
944 xfree (rl); /* Allocated in readline. */
946 if (p == linebuffer || *(p - 1) != '\\')
949 p--; /* Put on top of '\'. */
950 local_prompt = (char *) 0;
955 signal (STOP_SIGNAL, SIG_DFL);
962 #define SERVER_COMMAND_LENGTH 7
964 (p - linebuffer > SERVER_COMMAND_LENGTH)
965 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
968 /* Note that we don't set `line'. Between this and the check in
969 dont_repeat, this insures that repeating will still do the
972 return linebuffer + SERVER_COMMAND_LENGTH;
975 /* Do history expansion if that is wished. */
976 if (history_expansion_p && instream == stdin
977 && ISATTY (instream))
982 *p = '\0'; /* Insert null now. */
983 expanded = history_expand (linebuffer, &history_value);
986 /* Print the changes. */
987 printf_unfiltered ("%s\n", history_value);
989 /* If there was an error, call this function again. */
992 xfree (history_value);
993 return command_line_input (prompt_arg, repeat,
996 if (strlen (history_value) > linelength)
998 linelength = strlen (history_value) + 1;
999 linebuffer = (char *) xrealloc (linebuffer, linelength);
1001 strcpy (linebuffer, history_value);
1002 p = linebuffer + strlen (linebuffer);
1004 xfree (history_value);
1007 /* If we just got an empty line, and that is supposed to repeat the
1008 previous command, return the value in the global buffer. */
1009 if (repeat && p == linebuffer)
1011 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1017 /* Add line to history if appropriate. */
1018 if (instream == stdin
1019 && ISATTY (stdin) && *linebuffer)
1020 add_history (linebuffer);
1022 /* Note: lines consisting solely of comments are added to the command
1023 history. This is useful when you type a command, and then
1024 realize you don't want to execute it quite yet. You can comment
1025 out the command and then later fetch it from the value history
1026 and remove the '#'. The kill ring is probably better, but some
1027 people are in the habit of commenting things out. */
1029 *p1 = '\0'; /* Found a comment. */
1031 /* Save into global buffer if appropriate. */
1034 if (linelength > linesize)
1036 line = xrealloc (line, linelength);
1037 linesize = linelength;
1039 strcpy (line, linebuffer);
1046 /* Print the GDB banner. */
1048 print_gdb_version (struct ui_file *stream)
1050 /* From GNU coding standards, first line is meant to be easy for a
1051 program to parse, and is just canonical program name and version
1052 number, which starts after last space. */
1054 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1056 /* Second line is a copyright notice. */
1058 fprintf_filtered (stream,
1059 "Copyright (C) 2011 Free Software Foundation, Inc.\n");
1061 /* Following the copyright is a brief statement that the program is
1062 free software, that users are free to copy and change it on
1063 certain conditions, that it is covered by the GNU GPL, and that
1064 there is no warranty. */
1066 fprintf_filtered (stream, "\
1067 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1068 \nThis is free software: you are free to change and redistribute it.\n\
1069 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1070 and \"show warranty\" for details.\n");
1072 /* After the required info we print the configuration information. */
1074 fprintf_filtered (stream, "This GDB was configured as \"");
1075 if (strcmp (host_name, target_name) != 0)
1077 fprintf_filtered (stream, "--host=%s --target=%s",
1078 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
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, "Debugger's interactive mode "
1283 "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;
1301 if (gdb_has_a_terminal () && instream == stdin)
1304 /* If INSTREAM is unset, and we are not in a user command, we
1305 must be in Insight. That's like having a terminal, for our
1307 if (instream == NULL && !in_user_command)
1314 dont_repeat_command (char *ignored, int from_tty)
1316 *line = 0; /* Can't call dont_repeat here because we're
1317 not necessarily reading from stdin. */
1320 /* Functions to manipulate command line editing control variables. */
1322 /* Number of commands to print in each call to show_commands. */
1323 #define Hist_print 10
1325 show_commands (char *args, int from_tty)
1327 /* Index for history commands. Relative to history_base. */
1330 /* Number of the history entry which we are planning to display next.
1331 Relative to history_base. */
1334 /* The first command in the history which doesn't exist (i.e. one more
1335 than the number of the last command). Relative to history_base. */
1338 /* Print out some of the commands from the command history. */
1339 /* First determine the length of the history list. */
1340 hist_len = history_size;
1341 for (offset = 0; offset < history_size; offset++)
1343 if (!history_get (history_base + offset))
1352 if (args[0] == '+' && args[1] == '\0')
1353 /* "info editing +" should print from the stored position. */
1356 /* "info editing <exp>" should print around command number <exp>. */
1357 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1359 /* "show commands" means print the last Hist_print commands. */
1362 num = hist_len - Hist_print;
1368 /* If there are at least Hist_print commands, we want to display the last
1369 Hist_print rather than, say, the last 6. */
1370 if (hist_len - num < Hist_print)
1372 num = hist_len - Hist_print;
1377 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1379 printf_filtered ("%5d %s\n", history_base + offset,
1380 (history_get (history_base + offset))->line);
1383 /* The next command we want to display is the next one that we haven't
1387 /* If the user repeats this command with return, it should do what
1388 "show commands +" does. This is unnecessary if arg is null,
1389 because "show commands +" is not useful after "show commands". */
1390 if (from_tty && args)
1397 /* Called by do_setshow_command. */
1399 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1401 if (history_size == INT_MAX)
1402 unstifle_history ();
1403 else if (history_size >= 0)
1404 stifle_history (history_size);
1407 history_size = INT_MAX;
1408 error (_("History size must be non-negative"));
1413 set_history (char *args, int from_tty)
1415 printf_unfiltered (_("\"set history\" must be followed "
1416 "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. */
1459 tmpenv = getenv ("HISTSIZE");
1461 history_size = atoi (tmpenv);
1462 else if (!history_size)
1465 stifle_history (history_size);
1467 tmpenv = getenv ("GDBHISTFILE");
1469 history_filename = xstrdup (tmpenv);
1470 else if (!history_filename)
1472 /* We include the current directory so that if the user changes
1473 directories the file written will be the same as the one
1476 /* No leading dots in file names are allowed on MSDOS. */
1477 history_filename = concat (current_directory, "/_gdb_history",
1480 history_filename = concat (current_directory, "/.gdb_history",
1484 read_history (history_filename);
1488 show_new_async_prompt (struct ui_file *file, int from_tty,
1489 struct cmd_list_element *c, const char *value)
1491 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1495 show_async_command_editing_p (struct ui_file *file, int from_tty,
1496 struct cmd_list_element *c, const char *value)
1498 fprintf_filtered (file, _("Editing of command lines as "
1499 "they are typed is %s.\n"),
1504 show_annotation_level (struct ui_file *file, int from_tty,
1505 struct cmd_list_element *c, const char *value)
1507 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1511 show_exec_done_display_p (struct ui_file *file, int from_tty,
1512 struct cmd_list_element *c, const char *value)
1514 fprintf_filtered (file, _("Notification of completion for "
1515 "asynchronous execution commands is %s.\n"),
1521 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1522 whatever the DEFAULT_PROMPT is. */
1523 the_prompts.top = 0;
1525 PROMPT (0) = xstrdup (DEFAULT_PROMPT);
1527 /* Set things up for annotation_level > 1, if the user ever decides
1529 async_annotation_suffix = "prompt";
1530 /* Set the variable associated with the setshow prompt command. */
1531 new_async_prompt = xstrdup (PROMPT (0));
1533 /* If gdb was started with --annotate=2, this is equivalent to the
1534 user entering the command 'set annotate 2' at the gdb prompt, so
1535 we need to do extra processing. */
1536 if (annotation_level > 1)
1537 set_async_annotation_level (NULL, 0, NULL);
1539 /* Set the important stuff up for command editing. */
1540 command_editing_p = 1;
1541 history_expansion_p = 0;
1542 write_history_p = 0;
1544 /* Setup important stuff for command line editing. */
1545 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1546 rl_completion_entry_function = readline_line_completion_function;
1547 rl_completer_word_break_characters = default_word_break_characters ();
1548 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1549 rl_readline_name = "gdb";
1550 rl_terminal_name = getenv ("TERM");
1552 /* The name for this defun comes from Bash, where it originated.
1553 15 is Control-o, the same binding this function has in Bash. */
1554 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1556 add_setshow_string_cmd ("prompt", class_support,
1558 _("Set gdb's prompt"),
1559 _("Show gdb's prompt"),
1560 NULL, set_async_prompt,
1561 show_new_async_prompt,
1562 &setlist, &showlist);
1564 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1565 Don't repeat this command.\nPrimarily \
1566 used inside of user-defined commands that should not be repeated when\n\
1569 add_setshow_boolean_cmd ("editing", class_support,
1570 &async_command_editing_p, _("\
1571 Set editing of command lines as they are typed."), _("\
1572 Show editing of command lines as they are typed."), _("\
1573 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1574 Without an argument, command line editing is enabled. To edit, use\n\
1575 EMACS-like or VI-like commands like control-P or ESC."),
1576 set_async_editing_command,
1577 show_async_command_editing_p,
1578 &setlist, &showlist);
1580 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1581 Set saving of the history record on exit."), _("\
1582 Show saving of the history record on exit."), _("\
1583 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1584 Without an argument, saving is enabled."),
1586 show_write_history_p,
1587 &sethistlist, &showhistlist);
1589 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1590 Set the size of the command history,"), _("\
1591 Show the size of the command history,"), _("\
1592 ie. the number of previous commands to keep a record of."),
1593 set_history_size_command,
1595 &sethistlist, &showhistlist);
1597 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1598 Set the filename in which to record the command history"), _("\
1599 Show the filename in which to record the command history"), _("\
1600 (the list of previous commands of which a record is kept)."),
1602 show_history_filename,
1603 &sethistlist, &showhistlist);
1605 add_setshow_boolean_cmd ("confirm", class_support, &caution, _("\
1606 Set whether to confirm potentially dangerous operations."), _("\
1607 Show whether to confirm potentially dangerous operations."), NULL,
1610 &setlist, &showlist);
1612 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1613 Set annotation_level."), _("\
1614 Show annotation_level."), _("\
1615 0 == normal; 1 == fullname (for use when running under emacs)\n\
1616 2 == output annotated suitably for use by programs that control GDB."),
1617 set_async_annotation_level,
1618 show_annotation_level,
1619 &setlist, &showlist);
1621 add_setshow_boolean_cmd ("exec-done-display", class_support,
1622 &exec_done_display_p, _("\
1623 Set notification of completion for asynchronous execution commands."), _("\
1624 Show notification of completion for asynchronous execution commands."), _("\
1625 Use \"on\" to enable the notification, and \"off\" to disable it."),
1627 show_exec_done_display_p,
1628 &setlist, &showlist);
1630 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
1631 &interactive_mode, _("\
1632 Set whether GDB should run in interactive mode or not"), _("\
1633 Show whether GDB runs in interactive mode"), _("\
1634 If on, run in interactive mode and wait for the user to answer\n\
1635 all queries. If off, run in non-interactive mode and automatically\n\
1636 assume the default answer to all queries. If auto (the default),\n\
1637 determine which mode to use based on the standard input settings"),
1639 show_interactive_mode,
1640 &setlist, &showlist);
1642 add_setshow_filename_cmd ("data-directory", class_maintenance,
1643 &gdb_datadir, _("Set GDB's data directory."),
1644 _("Show GDB's data directory."),
1646 When set, GDB uses the specified path to search for data files."),
1653 gdb_init (char *argv0)
1655 if (pre_init_ui_hook)
1656 pre_init_ui_hook ();
1658 /* Run the init function of each source file. */
1661 /* Make sure we return to the original directory upon exit, come
1662 what may, since the OS doesn't do that for us. */
1663 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1666 init_cmd_lists (); /* This needs to be done first. */
1667 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1668 initialize_utils (); /* Make errors and warnings possible. */
1670 /* Here is where we call all the _initialize_foo routines. */
1671 initialize_all_files ();
1673 /* This creates the current_program_space. Do this after all the
1674 _initialize_foo routines have had a chance to install their
1675 per-sspace data keys. Also do this before
1676 initialize_current_architecture is called, because it accesses
1677 exec_bfd of the current program space. */
1678 initialize_progspace ();
1679 initialize_inferiors ();
1680 initialize_current_architecture ();
1682 init_main (); /* But that omits this file! Do it now. */
1684 initialize_stdin_serial ();
1686 async_init_signals ();
1688 /* We need a default language for parsing expressions, so simple
1689 things like "set width 0" won't fail if no language is explicitly
1690 set in a config file or implicitly set by reading an executable
1692 set_language (language_c);
1693 expected_language = current_language; /* Don't warn about the change. */
1695 /* Allow another UI to initialize. If the UI fails to initialize,
1696 and it wants GDB to revert to the CLI, it should clear
1697 deprecated_init_ui_hook. */
1698 if (deprecated_init_ui_hook)
1699 deprecated_init_ui_hook (argv0);
1702 /* Python initialization can require various commands to be
1703 installed. For example "info pretty-printer" needs the "info"
1704 prefix to be installed. Keep things simple and just do final
1705 python initialization here. */
1706 finish_python_initialization ();