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. */
140 char *saved_command_line;
141 int saved_command_line_size = 100;
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)
346 struct cleanup *cleanup;
348 mark = value_mark ();
349 cleanup = make_cleanup_value_free_to_mark (mark);
351 /* With multiple threads running while the one we're examining is
352 stopped, the dcache can get stale without us being able to detect
353 it. For the duration of the command, though, use the dcache to
354 help things like backtrace. */
356 target_dcache_invalidate ();
361 /* Execute the line P as a command, in the current user context.
362 Pass FROM_TTY as second argument to the defining function. */
365 execute_command (char *p, int from_tty)
367 struct cleanup *cleanup;
368 struct cmd_list_element *c;
370 static int warned = 0;
373 cleanup = prepare_execute_command ();
375 /* Force cleanup of any alloca areas if using C alloca instead of
379 /* This can happen when command_line_input hits end of file. */
382 do_cleanups (cleanup);
386 target_log_command (p);
388 while (*p == ' ' || *p == '\t')
395 /* If trace-commands is set then this will print this command. */
396 print_command_trace (p);
398 c = lookup_cmd (&p, cmdlist, "", 0, 1);
400 /* Pass null arg rather than an empty one. */
403 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
404 while the is_complete_command(cfunc) test is just plain
405 bogus. They should both be replaced by a test of the form
406 c->strip_trailing_white_space_p. */
407 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
408 can't be replaced with func. This is because it is the
409 cfunc, and not the func, that has the value that the
410 is_complete_command hack is testing for. */
411 /* Clear off trailing whitespace, except for set and complete
414 && c->type != set_cmd
415 && !is_complete_command (c))
417 p = arg + strlen (arg) - 1;
418 while (p >= arg && (*p == ' ' || *p == '\t'))
423 /* If this command has been pre-hooked, run the hook first. */
424 execute_cmd_pre_hook (c);
426 if (c->flags & DEPRECATED_WARN_USER)
427 deprecated_cmd_warning (&line);
429 if (c->class == class_user)
430 execute_user_command (c, arg);
431 else if (c->type == set_cmd || c->type == show_cmd)
432 do_setshow_command (arg, from_tty & caution, c);
433 else if (!cmd_func_p (c))
434 error (_("That is not a command, just a help topic."));
435 else if (deprecated_call_command_hook)
436 deprecated_call_command_hook (c, arg, from_tty & caution);
438 cmd_func (c, arg, from_tty & caution);
440 /* If this command has been post-hooked, run the hook last. */
441 execute_cmd_post_hook (c);
445 /* Tell the user if the language has changed (except first time).
446 First make sure that a new frame has been selected, in case this
447 command or the hooks changed the program state. */
448 deprecated_safe_get_selected_frame ();
449 if (current_language != expected_language)
451 if (language_mode == language_mode_auto && info_verbose)
453 language_info (1); /* Print what changed. */
458 /* Warn the user if the working language does not match the
459 language of the current frame. Only warn the user if we are
460 actually running the program, i.e. there is a stack. */
461 /* FIXME: This should be cacheing the frame and only running when
462 the frame changes. */
464 if (has_stack_frames ())
466 flang = get_frame_language ();
468 && flang != language_unknown
469 && flang != current_language->la_language)
471 printf_filtered ("%s\n", lang_frame_mismatch_warn);
476 do_cleanups (cleanup);
479 /* Run execute_command for P and FROM_TTY. Capture its output into the
480 returned string, do not display it to the screen. BATCH_FLAG will be
481 temporarily set to true. */
484 execute_command_to_string (char *p, int from_tty)
486 struct ui_file *str_file;
487 struct cleanup *cleanup;
490 /* GDB_STDOUT should be better already restored during these
491 restoration callbacks. */
492 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
494 str_file = mem_fileopen ();
496 make_cleanup_ui_file_delete (str_file);
497 make_cleanup_restore_ui_file (&gdb_stdout);
498 make_cleanup_restore_ui_file (&gdb_stderr);
499 make_cleanup_restore_ui_file (&gdb_stdlog);
500 make_cleanup_restore_ui_file (&gdb_stdtarg);
501 make_cleanup_restore_ui_file (&gdb_stdtargerr);
503 if (ui_out_redirect (uiout, str_file) < 0)
504 warning (_("Current output protocol does not support redirection"));
506 make_cleanup_ui_out_redirect_pop (uiout);
508 gdb_stdout = str_file;
509 gdb_stderr = str_file;
510 gdb_stdlog = str_file;
511 gdb_stdtarg = str_file;
512 gdb_stdtargerr = str_file;
514 execute_command (p, from_tty);
516 retval = ui_file_xstrdup (str_file, NULL);
518 do_cleanups (cleanup);
523 /* Read commands from `instream' and execute them
524 until end of file or error reading instream. */
529 struct cleanup *old_chain;
531 int stdin_is_tty = ISATTY (stdin);
533 while (instream && !feof (instream))
535 if (window_hook && instream == stdin)
536 (*window_hook) (instream, get_prompt ());
539 if (instream == stdin && stdin_is_tty)
540 reinitialize_more_filter ();
541 old_chain = make_cleanup (null_cleanup, 0);
543 /* Get a command-line. This calls the readline package. */
544 command = command_line_input (instream == stdin ?
545 get_prompt () : (char *) NULL,
546 instream == stdin, "prompt");
549 do_cleanups (old_chain);
553 make_command_stats_cleanup (1);
555 execute_command (command, instream == stdin);
557 /* Do any commands attached to breakpoint we are stopped at. */
558 bpstat_do_actions ();
560 do_cleanups (old_chain);
564 /* When nonzero, cause dont_repeat to do nothing. This should only be
565 set via prevent_dont_repeat. */
567 static int suppress_dont_repeat = 0;
569 /* Commands call this if they do not want to be repeated by null lines. */
574 if (suppress_dont_repeat || server_command)
577 /* If we aren't reading from standard input, we are saving the last
578 thing read from stdin in line and don't want to delete it. Null
579 lines won't repeat here in any case. */
580 if (instream == stdin)
581 *saved_command_line = 0;
584 /* Prevent dont_repeat from working, and return a cleanup that
585 restores the previous state. */
588 prevent_dont_repeat (void)
590 struct cleanup *result = make_cleanup_restore_integer (&suppress_dont_repeat);
592 suppress_dont_repeat = 1;
597 /* Read a line from the stream "instream" without command line editing.
599 It prints PROMPT_ARG once at the start.
600 Action is compatible with "readline", e.g. space for the result is
601 malloc'd and should be freed by the caller.
603 A NULL return means end of file. */
605 gdb_readline (char *prompt_arg)
610 int result_size = 80;
614 /* Don't use a _filtered function here. It causes the assumed
615 character position to be off, since the newline we read from
616 the user is not accounted for. */
617 fputs_unfiltered (prompt_arg, gdb_stdout);
618 gdb_flush (gdb_stdout);
621 result = (char *) xmalloc (result_size);
625 /* Read from stdin if we are executing a user defined command.
626 This is the right thing for prompt_for_continue, at least. */
627 c = fgetc (instream ? instream : stdin);
632 /* The last line does not end with a newline. Return it, and
633 if we are called again fgetc will still return EOF and
634 we'll return NULL then. */
642 if (input_index > 0 && result[input_index - 1] == '\r')
647 result[input_index++] = c;
648 while (input_index >= result_size)
651 result = (char *) xrealloc (result, result_size);
655 result[input_index++] = '\0';
659 /* Variables which control command line editing and history
660 substitution. These variables are given default values at the end
662 static int command_editing_p;
664 /* NOTE 1999-04-29: This variable will be static again, once we modify
665 gdb to use the event loop as the default command loop and we merge
666 event-top.c into this file, top.c. */
668 /* static */ int history_expansion_p;
670 static int write_history_p;
672 show_write_history_p (struct ui_file *file, int from_tty,
673 struct cmd_list_element *c, const char *value)
675 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
679 static int history_size;
681 show_history_size (struct ui_file *file, int from_tty,
682 struct cmd_list_element *c, const char *value)
684 fprintf_filtered (file, _("The size of the command history is %s.\n"),
688 static char *history_filename;
690 show_history_filename (struct ui_file *file, int from_tty,
691 struct cmd_list_element *c, const char *value)
693 fprintf_filtered (file, _("The filename in which to record "
694 "the command history is \"%s\".\n"),
698 /* This is like readline(), but it has some gdb-specific behavior.
699 gdb may want readline in both the synchronous and async modes during
700 a single gdb invocation. At the ordinary top-level prompt we might
701 be using the async readline. That means we can't use
702 rl_pre_input_hook, since it doesn't work properly in async mode.
703 However, for a secondary prompt (" >", such as occurs during a
704 `define'), gdb wants a synchronous response.
706 We used to call readline() directly, running it in synchronous
707 mode. But mixing modes this way is not supported, and as of
708 readline 5.x it no longer works; the arrow keys come unbound during
709 the synchronous call. So we make a nested call into the event
710 loop. That's what gdb_readline_wrapper is for. */
712 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
713 rely on gdb_readline_wrapper_result, which might still be NULL if
714 the user types Control-D for EOF. */
715 static int gdb_readline_wrapper_done;
717 /* The result of the current call to gdb_readline_wrapper, once a newline
719 static char *gdb_readline_wrapper_result;
721 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
722 to be called after the newline is processed (which will redisplay
723 the prompt). But in gdb_readline_wrapper we will not get a new
724 prompt until the next call, or until we return to the event loop.
725 So we disable this hook around the newline and restore it before we
727 static void (*saved_after_char_processing_hook) (void);
729 /* This function is called when readline has seen a complete line of
733 gdb_readline_wrapper_line (char *line)
735 gdb_assert (!gdb_readline_wrapper_done);
736 gdb_readline_wrapper_result = line;
737 gdb_readline_wrapper_done = 1;
739 /* Prevent operate-and-get-next from acting too early. */
740 saved_after_char_processing_hook = after_char_processing_hook;
741 after_char_processing_hook = NULL;
743 /* Prevent parts of the prompt from being redisplayed if annotations
744 are enabled, and readline's state getting out of sync. */
745 if (async_command_editing_p)
746 rl_callback_handler_remove ();
749 struct gdb_readline_wrapper_cleanup
751 void (*handler_orig) (char *);
752 int already_prompted_orig;
756 gdb_readline_wrapper_cleanup (void *arg)
758 struct gdb_readline_wrapper_cleanup *cleanup = arg;
760 rl_already_prompted = cleanup->already_prompted_orig;
762 gdb_assert (input_handler == gdb_readline_wrapper_line);
763 input_handler = cleanup->handler_orig;
764 gdb_readline_wrapper_result = NULL;
765 gdb_readline_wrapper_done = 0;
767 after_char_processing_hook = saved_after_char_processing_hook;
768 saved_after_char_processing_hook = NULL;
774 gdb_readline_wrapper (char *prompt)
776 struct cleanup *back_to;
777 struct gdb_readline_wrapper_cleanup *cleanup;
780 cleanup = xmalloc (sizeof (*cleanup));
781 cleanup->handler_orig = input_handler;
782 input_handler = gdb_readline_wrapper_line;
784 cleanup->already_prompted_orig = rl_already_prompted;
786 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
788 /* Display our prompt and prevent double prompt display. */
789 display_gdb_prompt (prompt);
790 rl_already_prompted = 1;
792 if (after_char_processing_hook)
793 (*after_char_processing_hook) ();
794 gdb_assert (after_char_processing_hook == NULL);
796 /* gdb_do_one_event argument is unused. */
797 while (gdb_do_one_event (NULL) >= 0)
798 if (gdb_readline_wrapper_done)
801 retval = gdb_readline_wrapper_result;
802 do_cleanups (back_to);
807 /* The current saved history number from operate-and-get-next.
808 This is -1 if not valid. */
809 static int operate_saved_history = -1;
811 /* This is put on the appropriate hook and helps operate-and-get-next
814 gdb_rl_operate_and_get_next_completion (void)
816 int delta = where_history () - operate_saved_history;
818 /* The `key' argument to rl_get_previous_history is ignored. */
819 rl_get_previous_history (delta, 0);
820 operate_saved_history = -1;
822 /* readline doesn't automatically update the display for us. */
825 after_char_processing_hook = NULL;
826 rl_pre_input_hook = NULL;
829 /* This is a gdb-local readline command handler. It accepts the
830 current command line (like RET does) and, if this command was taken
831 from the history, arranges for the next command in the history to
832 appear on the command line when the prompt returns.
833 We ignore the arguments. */
835 gdb_rl_operate_and_get_next (int count, int key)
839 /* Use the async hook. */
840 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
842 /* Find the current line, and find the next line to use. */
843 where = where_history();
845 /* FIXME: kettenis/20020817: max_input_history is renamed into
846 history_max_entries in readline-4.2. When we do a new readline
847 import, we should probably change it here too, even though
848 readline maintains backwards compatibility for now by still
849 defining max_input_history. */
850 if ((history_is_stifled () && (history_length >= max_input_history)) ||
851 (where >= history_length - 1))
852 operate_saved_history = where;
854 operate_saved_history = where + 1;
856 return rl_newline (1, key);
859 /* Read one line from the command input stream `instream'
860 into the local static buffer `linebuffer' (whose current length
862 The buffer is made bigger as necessary.
863 Returns the address of the start of the line.
865 NULL is returned for end of file.
867 *If* the instream == stdin & stdin is a terminal, the line read
868 is copied into the file line saver (global var char *line,
869 length linesize) so that it can be duplicated.
871 This routine either uses fancy command line editing or
872 simple input as the user has requested. */
875 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
877 static char *linebuffer = 0;
878 static unsigned linelength = 0;
882 char *local_prompt = prompt_arg;
886 /* The annotation suffix must be non-NULL. */
887 if (annotation_suffix == NULL)
888 annotation_suffix = "";
890 if (annotation_level > 1 && instream == stdin)
892 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
893 + strlen (annotation_suffix) + 40);
894 if (prompt_arg == NULL)
895 local_prompt[0] = '\0';
897 strcpy (local_prompt, prompt_arg);
898 strcat (local_prompt, "\n\032\032");
899 strcat (local_prompt, annotation_suffix);
900 strcat (local_prompt, "\n");
906 linebuffer = (char *) xmalloc (linelength);
911 /* Control-C quits instantly if typed while in this loop
912 since it should not wait until the user types a newline. */
916 signal (STOP_SIGNAL, handle_stop_sig);
921 /* Make sure that all output has been output. Some machines may
922 let you get away with leaving out some of the gdb_flush, but
925 gdb_flush (gdb_stdout);
926 gdb_flush (gdb_stderr);
928 if (source_file_name != NULL)
929 ++source_line_number;
931 if (annotation_level > 1 && instream == stdin)
933 puts_unfiltered ("\n\032\032pre-");
934 puts_unfiltered (annotation_suffix);
935 puts_unfiltered ("\n");
938 /* Don't use fancy stuff if not talking to stdin. */
939 if (deprecated_readline_hook && input_from_terminal_p ())
941 rl = (*deprecated_readline_hook) (local_prompt);
943 else if (command_editing_p && input_from_terminal_p ())
945 rl = gdb_readline_wrapper (local_prompt);
949 rl = gdb_readline (local_prompt);
952 if (annotation_level > 1 && instream == stdin)
954 puts_unfiltered ("\n\032\032post-");
955 puts_unfiltered (annotation_suffix);
956 puts_unfiltered ("\n");
959 if (!rl || rl == (char *) EOF)
964 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
966 linelength = strlen (rl) + 1 + (p - linebuffer);
967 nline = (char *) xrealloc (linebuffer, linelength);
968 p += nline - linebuffer;
972 /* Copy line. Don't copy null at end. (Leaves line alone
973 if this was just a newline). */
977 xfree (rl); /* Allocated in readline. */
979 if (p == linebuffer || *(p - 1) != '\\')
982 p--; /* Put on top of '\'. */
983 local_prompt = (char *) 0;
988 signal (STOP_SIGNAL, SIG_DFL);
995 #define SERVER_COMMAND_LENGTH 7
997 (p - linebuffer > SERVER_COMMAND_LENGTH)
998 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1001 /* Note that we don't set `line'. Between this and the check in
1002 dont_repeat, this insures that repeating will still do the
1005 return linebuffer + SERVER_COMMAND_LENGTH;
1008 /* Do history expansion if that is wished. */
1009 if (history_expansion_p && instream == stdin
1010 && ISATTY (instream))
1012 char *history_value;
1015 *p = '\0'; /* Insert null now. */
1016 expanded = history_expand (linebuffer, &history_value);
1019 /* Print the changes. */
1020 printf_unfiltered ("%s\n", history_value);
1022 /* If there was an error, call this function again. */
1025 xfree (history_value);
1026 return command_line_input (prompt_arg, repeat,
1029 if (strlen (history_value) > linelength)
1031 linelength = strlen (history_value) + 1;
1032 linebuffer = (char *) xrealloc (linebuffer, linelength);
1034 strcpy (linebuffer, history_value);
1035 p = linebuffer + strlen (linebuffer);
1037 xfree (history_value);
1040 /* If we just got an empty line, and that is supposed to repeat the
1041 previous command, return the value in the global buffer. */
1042 if (repeat && p == linebuffer)
1043 return saved_command_line;
1044 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1046 return saved_command_line;
1050 /* Add line to history if appropriate. */
1051 if (instream == stdin
1052 && ISATTY (stdin) && *linebuffer)
1053 add_history (linebuffer);
1055 /* Note: lines consisting solely of comments are added to the command
1056 history. This is useful when you type a command, and then
1057 realize you don't want to execute it quite yet. You can comment
1058 out the command and then later fetch it from the value history
1059 and remove the '#'. The kill ring is probably better, but some
1060 people are in the habit of commenting things out. */
1062 *p1 = '\0'; /* Found a comment. */
1064 /* Save into global buffer if appropriate. */
1067 if (linelength > saved_command_line_size)
1069 saved_command_line = xrealloc (saved_command_line, linelength);
1070 saved_command_line_size = linelength;
1072 strcpy (saved_command_line, linebuffer);
1073 return saved_command_line;
1079 /* Print the GDB banner. */
1081 print_gdb_version (struct ui_file *stream)
1083 /* From GNU coding standards, first line is meant to be easy for a
1084 program to parse, and is just canonical program name and version
1085 number, which starts after last space. */
1087 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1089 /* Second line is a copyright notice. */
1091 fprintf_filtered (stream,
1092 "Copyright (C) 2011 Free Software Foundation, Inc.\n");
1094 /* Following the copyright is a brief statement that the program is
1095 free software, that users are free to copy and change it on
1096 certain conditions, that it is covered by the GNU GPL, and that
1097 there is no warranty. */
1099 fprintf_filtered (stream, "\
1100 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1101 \nThis is free software: you are free to change and redistribute it.\n\
1102 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1103 and \"show warranty\" for details.\n");
1105 /* After the required info we print the configuration information. */
1107 fprintf_filtered (stream, "This GDB was configured as \"");
1108 if (strcmp (host_name, target_name) != 0)
1110 fprintf_filtered (stream, "--host=%s --target=%s",
1111 host_name, target_name);
1115 fprintf_filtered (stream, "%s", host_name);
1117 fprintf_filtered (stream, "\".");
1119 if (REPORT_BUGS_TO[0])
1121 fprintf_filtered (stream,
1122 _("\nFor bug reporting instructions, please see:\n"));
1123 fprintf_filtered (stream, "%s.", REPORT_BUGS_TO);
1127 /* get_prompt: access method for the GDB prompt string. */
1136 set_prompt (char *s)
1138 /* ??rehrauer: I don't know why this fails, since it looks as though
1139 assignments to prompt are wrapped in calls to xstrdup...
1143 PROMPT (0) = xstrdup (s);
1153 /* Callback for iterate_over_inferiors. Kills or detaches the given
1154 inferior, depending on how we originally gained control of it. */
1157 kill_or_detach (struct inferior *inf, void *args)
1159 struct qt_args *qt = args;
1160 struct thread_info *thread;
1165 thread = any_thread_of_process (inf->pid);
1168 switch_to_thread (thread->ptid);
1170 /* Leave core files alone. */
1171 if (target_has_execution)
1173 if (inf->attach_flag)
1174 target_detach (qt->args, qt->from_tty);
1183 /* Callback for iterate_over_inferiors. Prints info about what GDB
1184 will do to each inferior on a "quit". ARG points to a struct
1185 ui_out where output is to be collected. */
1188 print_inferior_quit_action (struct inferior *inf, void *arg)
1190 struct ui_file *stb = arg;
1195 if (inf->attach_flag)
1196 fprintf_filtered (stb,
1197 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1198 target_pid_to_str (pid_to_ptid (inf->pid)));
1200 fprintf_filtered (stb,
1201 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1202 target_pid_to_str (pid_to_ptid (inf->pid)));
1207 /* If necessary, make the user confirm that we should quit. Return
1208 non-zero if we should quit, zero if we shouldn't. */
1213 struct ui_file *stb;
1214 struct cleanup *old_chain;
1218 /* Don't even ask if we're only debugging a core file inferior. */
1219 if (!have_live_inferiors ())
1222 /* Build the query string as a single string. */
1223 stb = mem_fileopen ();
1224 old_chain = make_cleanup_ui_file_delete (stb);
1226 /* This is something of a hack. But there's no reliable way to see
1227 if a GUI is running. The `use_windows' variable doesn't cut
1229 if (deprecated_init_ui_hook)
1230 fprintf_filtered (stb, _("A debugging session is active.\n"
1231 "Do you still want to close the debugger?"));
1234 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1235 iterate_over_inferiors (print_inferior_quit_action, stb);
1236 fprintf_filtered (stb, _("\nQuit anyway? "));
1239 str = ui_file_xstrdup (stb, NULL);
1240 make_cleanup (xfree, str);
1242 qr = query ("%s", str);
1243 do_cleanups (old_chain);
1247 /* Helper routine for quit_force that requires error handling. */
1250 quit_target (void *arg)
1252 struct qt_args *qt = (struct qt_args *)arg;
1254 /* Kill or detach all inferiors. */
1255 iterate_over_inferiors (kill_or_detach, qt);
1257 /* Give all pushed targets a chance to do minimal cleanup, and pop
1259 pop_all_targets (1);
1261 /* Save the history information if it is appropriate to do so. */
1262 if (write_history_p && history_filename)
1263 write_history (history_filename);
1265 do_final_cleanups (ALL_CLEANUPS); /* Do any final cleanups before
1270 /* Quit without asking for confirmation. */
1273 quit_force (char *args, int from_tty)
1278 /* An optional expression may be used to cause gdb to terminate with the
1279 value of that expression. */
1282 struct value *val = parse_and_eval (args);
1284 exit_code = (int) value_as_long (val);
1286 else if (return_child_result)
1287 exit_code = return_child_result_value;
1290 qt.from_tty = from_tty;
1292 /* We want to handle any quit errors and exit regardless. */
1293 catch_errors (quit_target, &qt,
1294 "Quitting: ", RETURN_MASK_ALL);
1299 /* Returns whether GDB is running on a terminal and input is
1300 currently coming from that terminal. */
1303 input_from_terminal_p (void)
1308 if (gdb_has_a_terminal () && instream == stdin)
1311 /* If INSTREAM is unset, and we are not in a user command, we
1312 must be in Insight. That's like having a terminal, for our
1314 if (instream == NULL && !in_user_command)
1321 dont_repeat_command (char *ignored, int from_tty)
1323 /* Can't call dont_repeat here because we're not necessarily reading
1325 *saved_command_line = 0;
1328 /* Functions to manipulate command line editing control variables. */
1330 /* Number of commands to print in each call to show_commands. */
1331 #define Hist_print 10
1333 show_commands (char *args, int from_tty)
1335 /* Index for history commands. Relative to history_base. */
1338 /* Number of the history entry which we are planning to display next.
1339 Relative to history_base. */
1342 /* The first command in the history which doesn't exist (i.e. one more
1343 than the number of the last command). Relative to history_base. */
1346 /* Print out some of the commands from the command history. */
1347 /* First determine the length of the history list. */
1348 hist_len = history_size;
1349 for (offset = 0; offset < history_size; offset++)
1351 if (!history_get (history_base + offset))
1360 if (args[0] == '+' && args[1] == '\0')
1361 /* "info editing +" should print from the stored position. */
1364 /* "info editing <exp>" should print around command number <exp>. */
1365 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1367 /* "show commands" means print the last Hist_print commands. */
1370 num = hist_len - Hist_print;
1376 /* If there are at least Hist_print commands, we want to display the last
1377 Hist_print rather than, say, the last 6. */
1378 if (hist_len - num < Hist_print)
1380 num = hist_len - Hist_print;
1385 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1387 printf_filtered ("%5d %s\n", history_base + offset,
1388 (history_get (history_base + offset))->line);
1391 /* The next command we want to display is the next one that we haven't
1395 /* If the user repeats this command with return, it should do what
1396 "show commands +" does. This is unnecessary if arg is null,
1397 because "show commands +" is not useful after "show commands". */
1398 if (from_tty && args)
1405 /* Called by do_setshow_command. */
1407 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1409 if (history_size == INT_MAX)
1410 unstifle_history ();
1411 else if (history_size >= 0)
1412 stifle_history (history_size);
1415 history_size = INT_MAX;
1416 error (_("History size must be non-negative"));
1421 set_history (char *args, int from_tty)
1423 printf_unfiltered (_("\"set history\" must be followed "
1424 "by the name of a history subcommand.\n"));
1425 help_list (sethistlist, "set history ", -1, gdb_stdout);
1429 show_history (char *args, int from_tty)
1431 cmd_show_list (showhistlist, from_tty, "");
1434 int info_verbose = 0; /* Default verbose msgs off. */
1436 /* Called by do_setshow_command. An elaborate joke. */
1438 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1440 char *cmdname = "verbose";
1441 struct cmd_list_element *showcmd;
1443 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1444 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1448 c->doc = "Set verbose printing of informational messages.";
1449 showcmd->doc = "Show verbose printing of informational messages.";
1453 c->doc = "Set verbosity.";
1454 showcmd->doc = "Show verbosity.";
1458 /* Init the history buffer. Note that we are called after the init file(s)
1459 have been read so that the user can change the history file via his
1460 .gdbinit file (for instance). The GDBHISTFILE environment variable
1461 overrides all of this. */
1468 tmpenv = getenv ("HISTSIZE");
1470 history_size = atoi (tmpenv);
1471 else if (!history_size)
1474 stifle_history (history_size);
1476 tmpenv = getenv ("GDBHISTFILE");
1478 history_filename = xstrdup (tmpenv);
1479 else if (!history_filename)
1481 /* We include the current directory so that if the user changes
1482 directories the file written will be the same as the one
1485 /* No leading dots in file names are allowed on MSDOS. */
1486 history_filename = concat (current_directory, "/_gdb_history",
1489 history_filename = concat (current_directory, "/.gdb_history",
1493 read_history (history_filename);
1497 show_new_async_prompt (struct ui_file *file, int from_tty,
1498 struct cmd_list_element *c, const char *value)
1500 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1504 show_async_command_editing_p (struct ui_file *file, int from_tty,
1505 struct cmd_list_element *c, const char *value)
1507 fprintf_filtered (file, _("Editing of command lines as "
1508 "they are typed is %s.\n"),
1513 show_annotation_level (struct ui_file *file, int from_tty,
1514 struct cmd_list_element *c, const char *value)
1516 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1520 show_exec_done_display_p (struct ui_file *file, int from_tty,
1521 struct cmd_list_element *c, const char *value)
1523 fprintf_filtered (file, _("Notification of completion for "
1524 "asynchronous execution commands is %s.\n"),
1530 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1531 whatever the DEFAULT_PROMPT is. */
1532 the_prompts.top = 0;
1534 PROMPT (0) = xstrdup (DEFAULT_PROMPT);
1536 /* Set things up for annotation_level > 1, if the user ever decides
1538 async_annotation_suffix = "prompt";
1539 /* Set the variable associated with the setshow prompt command. */
1540 new_async_prompt = xstrdup (PROMPT (0));
1542 /* If gdb was started with --annotate=2, this is equivalent to the
1543 user entering the command 'set annotate 2' at the gdb prompt, so
1544 we need to do extra processing. */
1545 if (annotation_level > 1)
1546 set_async_annotation_level (NULL, 0, NULL);
1548 /* Set the important stuff up for command editing. */
1549 command_editing_p = 1;
1550 history_expansion_p = 0;
1551 write_history_p = 0;
1553 /* Setup important stuff for command line editing. */
1554 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1555 rl_completion_entry_function = readline_line_completion_function;
1556 rl_completer_word_break_characters = default_word_break_characters ();
1557 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1558 rl_readline_name = "gdb";
1559 rl_terminal_name = getenv ("TERM");
1561 /* The name for this defun comes from Bash, where it originated.
1562 15 is Control-o, the same binding this function has in Bash. */
1563 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1565 add_setshow_string_cmd ("prompt", class_support,
1567 _("Set gdb's prompt"),
1568 _("Show gdb's prompt"),
1569 NULL, set_async_prompt,
1570 show_new_async_prompt,
1571 &setlist, &showlist);
1573 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1574 Don't repeat this command.\nPrimarily \
1575 used inside of user-defined commands that should not be repeated when\n\
1578 add_setshow_boolean_cmd ("editing", class_support,
1579 &async_command_editing_p, _("\
1580 Set editing of command lines as they are typed."), _("\
1581 Show editing of command lines as they are typed."), _("\
1582 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1583 Without an argument, command line editing is enabled. To edit, use\n\
1584 EMACS-like or VI-like commands like control-P or ESC."),
1585 set_async_editing_command,
1586 show_async_command_editing_p,
1587 &setlist, &showlist);
1589 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1590 Set saving of the history record on exit."), _("\
1591 Show saving of the history record on exit."), _("\
1592 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1593 Without an argument, saving is enabled."),
1595 show_write_history_p,
1596 &sethistlist, &showhistlist);
1598 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1599 Set the size of the command history,"), _("\
1600 Show the size of the command history,"), _("\
1601 ie. the number of previous commands to keep a record of."),
1602 set_history_size_command,
1604 &sethistlist, &showhistlist);
1606 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1607 Set the filename in which to record the command history"), _("\
1608 Show the filename in which to record the command history"), _("\
1609 (the list of previous commands of which a record is kept)."),
1611 show_history_filename,
1612 &sethistlist, &showhistlist);
1614 add_setshow_boolean_cmd ("confirm", class_support, &caution, _("\
1615 Set whether to confirm potentially dangerous operations."), _("\
1616 Show whether to confirm potentially dangerous operations."), NULL,
1619 &setlist, &showlist);
1621 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1622 Set annotation_level."), _("\
1623 Show annotation_level."), _("\
1624 0 == normal; 1 == fullname (for use when running under emacs)\n\
1625 2 == output annotated suitably for use by programs that control GDB."),
1626 set_async_annotation_level,
1627 show_annotation_level,
1628 &setlist, &showlist);
1630 add_setshow_boolean_cmd ("exec-done-display", class_support,
1631 &exec_done_display_p, _("\
1632 Set notification of completion for asynchronous execution commands."), _("\
1633 Show notification of completion for asynchronous execution commands."), _("\
1634 Use \"on\" to enable the notification, and \"off\" to disable it."),
1636 show_exec_done_display_p,
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. */
1667 /* Here is where we call all the _initialize_foo routines. */
1668 initialize_all_files ();
1670 /* This creates the current_program_space. Do this after all the
1671 _initialize_foo routines have had a chance to install their
1672 per-sspace data keys. Also do this before
1673 initialize_current_architecture is called, because it accesses
1674 exec_bfd of the current program space. */
1675 initialize_progspace ();
1676 initialize_inferiors ();
1677 initialize_current_architecture ();
1679 init_main (); /* But that omits this file! Do it now. */
1681 initialize_stdin_serial ();
1683 async_init_signals ();
1685 /* We need a default language for parsing expressions, so simple
1686 things like "set width 0" won't fail if no language is explicitly
1687 set in a config file or implicitly set by reading an executable
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);
1699 /* Python initialization can require various commands to be
1700 installed. For example "info pretty-printer" needs the "info"
1701 prefix to be installed. Keep things simple and just do final
1702 python initialization here. */
1703 finish_python_initialization ();