1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2012 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "call-cmds.h"
23 #include "cli/cli-cmds.h"
24 #include "cli/cli-script.h"
25 #include "cli/cli-setshow.h"
26 #include "cli/cli-decode.h"
29 #include "exceptions.h"
32 #include "breakpoint.h"
34 #include "expression.h"
37 #include "terminal.h" /* For job_control. */
39 #include "completer.h"
44 #include "gdb_assert.h"
46 #include "event-loop.h"
47 #include "gdbthread.h"
48 #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 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
69 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
70 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
72 /* Default command line prompt. This is overriden in some configs. */
74 #ifndef DEFAULT_PROMPT
75 #define DEFAULT_PROMPT "(gdb) "
78 /* Initialization file name for gdb. This is overridden in some configs. */
82 # define PATH_MAX FILENAME_MAX
88 #ifndef GDBINIT_FILENAME
89 #define GDBINIT_FILENAME ".gdbinit"
91 char gdbinit[PATH_MAX + 1] = GDBINIT_FILENAME;
93 int inhibit_gdbinit = 0;
95 /* If nonzero, and GDB has been configured to be able to use windows,
96 attempt to open them upon startup. */
100 extern char lang_frame_mismatch_warn[]; /* language.c */
102 /* Flag for whether we want to confirm potentially dangerous
103 operations. Default is yes. */
108 show_confirm (struct ui_file *file, int from_tty,
109 struct cmd_list_element *c, const char *value)
111 fprintf_filtered (file, _("Whether to confirm potentially "
112 "dangerous operations is %s.\n"),
116 /* stdio stream that command input is being read from. Set to stdin
117 normally. Set by source_command to the file we are sourcing. Set
118 to NULL if we are executing a user-defined command or interacting
123 /* Flag to indicate whether a user defined command is currently running. */
127 /* Current working directory. */
129 char *current_directory;
131 /* The directory name is actually stored here (usually). */
132 char gdb_dirbuf[1024];
134 /* Function to call before reading a command, if nonzero.
135 The function receives two args: an input stream,
136 and a prompt string. */
138 void (*window_hook) (FILE *, char *);
143 /* Buffer used for reading command lines, and the size
144 allocated for it so far. */
146 char *saved_command_line;
147 int saved_command_line_size = 100;
149 /* Nonzero if the current command is modified by "server ". This
150 affects things like recording into the command history, commands
151 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
152 whatever) can issue its own commands and also send along commands
153 from the user, and have the user not notice that the user interface
154 is issuing commands too. */
157 /* Baud rate specified for talking to serial target systems. Default
158 is left as -1, so targets can choose their own defaults. */
159 /* FIXME: This means that "show remotebaud" and gr_files_info can
160 print -1 or (unsigned int)-1. This is a Bad User Interface. */
164 /* Timeout limit for response from target. */
166 /* The default value has been changed many times over the years. It
167 was originally 5 seconds. But that was thought to be a long time
168 to sit and wait, so it was changed to 2 seconds. That was thought
169 to be plenty unless the connection was going through some terminal
170 server or multiplexer or other form of hairy serial connection.
172 In mid-1996, remote_timeout was moved from remote.c to top.c and
173 it began being used in other remote-* targets. It appears that the
174 default was changed to 20 seconds at that time, perhaps because the
175 Renesas E7000 ICE didn't always respond in a timely manner.
177 But if 5 seconds is a long time to sit and wait for retransmissions,
178 20 seconds is far worse. This demonstrates the difficulty of using
179 a single variable for all protocol timeouts.
181 As remote.c is used much more than remote-e7000.c, it was changed
182 back to 2 seconds in 1999. */
184 int remote_timeout = 2;
186 /* Non-zero tells remote* modules to output debugging info. */
188 int remote_debug = 0;
190 /* Sbrk location on entry to main. Used for statistics only. */
195 /* Hooks for alternate command interfaces. */
197 /* Called after most modules have been initialized, but before taking
200 If the UI fails to initialize and it wants GDB to continue using
201 the default UI, then it should clear this hook before returning. */
203 void (*deprecated_init_ui_hook) (char *argv0);
205 /* This hook is called from within gdb's many mini-event loops which
206 could steal control from a real user interface's event loop. It
207 returns non-zero if the user is requesting a detach, zero
210 int (*deprecated_ui_loop_hook) (int);
212 /* Called instead of command_loop at top level. Can be invoked via
213 throw_exception(). */
215 void (*deprecated_command_loop_hook) (void);
218 /* Called from print_frame_info to list the line we stopped in. */
220 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
224 /* Replaces most of query. */
226 int (*deprecated_query_hook) (const char *, va_list);
228 /* Replaces most of warning. */
230 void (*deprecated_warning_hook) (const char *, va_list);
232 /* These three functions support getting lines of text from the user.
233 They are used in sequence. First deprecated_readline_begin_hook is
234 called with a text string that might be (for example) a message for
235 the user to type in a sequence of commands to be executed at a
236 breakpoint. If this function calls back to a GUI, it might take
237 this opportunity to pop up a text interaction window with this
238 message. Next, deprecated_readline_hook is called with a prompt
239 that is emitted prior to collecting the user input. It can be
240 called multiple times. Finally, deprecated_readline_end_hook is
241 called to notify the GUI that we are done with the interaction
242 window and it can close it. */
244 void (*deprecated_readline_begin_hook) (char *, ...);
245 char *(*deprecated_readline_hook) (char *);
246 void (*deprecated_readline_end_hook) (void);
248 /* Called as appropriate to notify the interface that we have attached
249 to or detached from an already running process. */
251 void (*deprecated_attach_hook) (void);
252 void (*deprecated_detach_hook) (void);
254 /* Called during long calculations to allow GUI to repair window
255 damage, and to check for stop buttons, etc... */
257 void (*deprecated_interactive_hook) (void);
259 /* Tell the GUI someone changed the register REGNO. -1 means
260 that the caller does not know which register changed or
261 that several registers have changed (see value_assign). */
262 void (*deprecated_register_changed_hook) (int regno);
264 /* Called when going to wait for the target. Usually allows the GUI
265 to run while waiting for target events. */
267 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
268 struct target_waitstatus *status,
271 /* Used by UI as a wrapper around command execution. May do various
272 things like enabling/disabling buttons, etc... */
274 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
275 char *cmd, int from_tty);
277 /* Called after a `set' command has finished. Is only run if the
278 `set' command succeeded. */
280 void (*deprecated_set_hook) (struct cmd_list_element * c);
282 /* Called when the current thread changes. Argument is thread id. */
284 void (*deprecated_context_hook) (int id);
286 /* Handler for SIGHUP. */
289 /* NOTE 1999-04-29: This function will be static again, once we modify
290 gdb to use the event loop as the default command loop and we merge
291 event-top.c into this file, top.c. */
295 /* Stop asking user for confirmation --- we're exiting. This
296 prevents asking the user dumb questions. */
298 quit_command ((char *) 0, 0);
300 #endif /* defined SIGHUP */
302 /* Line number we are currently in, in a file which is being sourced. */
303 /* NOTE 1999-04-29: This variable will be static again, once we modify
304 gdb to use the event loop as the default command loop and we merge
305 event-top.c into this file, top.c. */
306 /* static */ int source_line_number;
308 /* Name of the file we are sourcing. */
309 /* NOTE 1999-04-29: This variable will be static again, once we modify
310 gdb to use the event loop as the default command loop and we merge
311 event-top.c into this file, top.c. */
312 /* static */ const char *source_file_name;
314 /* Clean up on error during a "source" command (or execution of a
315 user-defined command). */
318 do_restore_instream_cleanup (void *stream)
320 /* Restore the previous input stream. */
324 /* Read commands from STREAM. */
326 read_command_file (FILE *stream)
328 struct cleanup *cleanups;
330 cleanups = make_cleanup (do_restore_instream_cleanup, instream);
333 do_cleanups (cleanups);
336 void (*pre_init_ui_hook) (void);
340 do_chdir_cleanup (void *old_dir)
348 prepare_execute_command (void)
351 struct cleanup *cleanup;
353 mark = value_mark ();
354 cleanup = make_cleanup_value_free_to_mark (mark);
356 /* With multiple threads running while the one we're examining is
357 stopped, the dcache can get stale without us being able to detect
358 it. For the duration of the command, though, use the dcache to
359 help things like backtrace. */
361 target_dcache_invalidate ();
366 /* Tell the user if the language has changed (except first time) after
367 executing a command. */
370 check_frame_language_change (void)
372 static int warned = 0;
374 /* First make sure that a new frame has been selected, in case the
375 command or the hooks changed the program state. */
376 deprecated_safe_get_selected_frame ();
377 if (current_language != expected_language)
379 if (language_mode == language_mode_auto && info_verbose)
381 language_info (1); /* Print what changed. */
386 /* Warn the user if the working language does not match the language
387 of the current frame. Only warn the user if we are actually
388 running the program, i.e. there is a stack. */
389 /* FIXME: This should be cacheing the frame and only running when
390 the frame changes. */
392 if (has_stack_frames ())
396 flang = get_frame_language ();
398 && flang != language_unknown
399 && flang != current_language->la_language)
401 printf_filtered ("%s\n", lang_frame_mismatch_warn);
407 /* Execute the line P as a command, in the current user context.
408 Pass FROM_TTY as second argument to the defining function. */
411 execute_command (char *p, int from_tty)
413 struct cleanup *cleanup_if_error, *cleanup;
414 struct cmd_list_element *c;
417 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
418 cleanup = prepare_execute_command ();
420 /* Force cleanup of any alloca areas if using C alloca instead of
424 /* This can happen when command_line_input hits end of file. */
427 do_cleanups (cleanup);
431 target_log_command (p);
433 while (*p == ' ' || *p == '\t')
440 /* If trace-commands is set then this will print this command. */
441 print_command_trace (p);
443 c = lookup_cmd (&p, cmdlist, "", 0, 1);
445 /* Pass null arg rather than an empty one. */
448 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
449 while the is_complete_command(cfunc) test is just plain
450 bogus. They should both be replaced by a test of the form
451 c->strip_trailing_white_space_p. */
452 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
453 can't be replaced with func. This is because it is the
454 cfunc, and not the func, that has the value that the
455 is_complete_command hack is testing for. */
456 /* Clear off trailing whitespace, except for set and complete
459 && c->type != set_cmd
460 && !is_complete_command (c))
462 p = arg + strlen (arg) - 1;
463 while (p >= arg && (*p == ' ' || *p == '\t'))
468 /* If this command has been pre-hooked, run the hook first. */
469 execute_cmd_pre_hook (c);
471 if (c->flags & DEPRECATED_WARN_USER)
472 deprecated_cmd_warning (&line);
474 /* c->user_commands would be NULL in the case of a python command. */
475 if (c->class == class_user && c->user_commands)
476 execute_user_command (c, arg);
477 else if (c->type == set_cmd || c->type == show_cmd)
478 do_setshow_command (arg, from_tty, c);
479 else if (!cmd_func_p (c))
480 error (_("That is not a command, just a help topic."));
481 else if (deprecated_call_command_hook)
482 deprecated_call_command_hook (c, arg, from_tty);
484 cmd_func (c, arg, from_tty);
486 /* If the interpreter is in sync mode (we're running a user
487 command's list, running command hooks or similars), and we
488 just ran a synchronous command that started the target, wait
489 for that command to end. */
490 if (!interpreter_async && sync_execution)
492 while (gdb_do_one_event () >= 0)
497 /* If this command has been post-hooked, run the hook last. */
498 execute_cmd_post_hook (c);
502 check_frame_language_change ();
504 do_cleanups (cleanup);
505 discard_cleanups (cleanup_if_error);
508 /* Run execute_command for P and FROM_TTY. Capture its output into the
509 returned string, do not display it to the screen. BATCH_FLAG will be
510 temporarily set to true. */
513 execute_command_to_string (char *p, int from_tty)
515 struct ui_file *str_file;
516 struct cleanup *cleanup;
519 /* GDB_STDOUT should be better already restored during these
520 restoration callbacks. */
521 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
523 make_cleanup_restore_integer (&interpreter_async);
524 interpreter_async = 0;
526 str_file = mem_fileopen ();
528 make_cleanup_ui_file_delete (str_file);
529 make_cleanup_restore_ui_file (&gdb_stdout);
530 make_cleanup_restore_ui_file (&gdb_stderr);
531 make_cleanup_restore_ui_file (&gdb_stdlog);
532 make_cleanup_restore_ui_file (&gdb_stdtarg);
533 make_cleanup_restore_ui_file (&gdb_stdtargerr);
535 if (ui_out_redirect (current_uiout, str_file) < 0)
536 warning (_("Current output protocol does not support redirection"));
538 make_cleanup_ui_out_redirect_pop (current_uiout);
540 gdb_stdout = str_file;
541 gdb_stderr = str_file;
542 gdb_stdlog = str_file;
543 gdb_stdtarg = str_file;
544 gdb_stdtargerr = str_file;
546 execute_command (p, from_tty);
548 retval = ui_file_xstrdup (str_file, NULL);
550 do_cleanups (cleanup);
555 /* Read commands from `instream' and execute them
556 until end of file or error reading instream. */
561 struct cleanup *old_chain;
563 int stdin_is_tty = ISATTY (stdin);
565 while (instream && !feof (instream))
567 if (window_hook && instream == stdin)
568 (*window_hook) (instream, get_prompt ());
571 if (instream == stdin && stdin_is_tty)
572 reinitialize_more_filter ();
573 old_chain = make_cleanup (null_cleanup, 0);
575 /* Get a command-line. This calls the readline package. */
576 command = command_line_input (instream == stdin ?
577 get_prompt () : (char *) NULL,
578 instream == stdin, "prompt");
581 do_cleanups (old_chain);
585 make_command_stats_cleanup (1);
587 execute_command (command, instream == stdin);
589 /* Do any commands attached to breakpoint we are stopped at. */
590 bpstat_do_actions ();
592 do_cleanups (old_chain);
596 /* When nonzero, cause dont_repeat to do nothing. This should only be
597 set via prevent_dont_repeat. */
599 static int suppress_dont_repeat = 0;
601 /* Commands call this if they do not want to be repeated by null lines. */
606 if (suppress_dont_repeat || server_command)
609 /* If we aren't reading from standard input, we are saving the last
610 thing read from stdin in line and don't want to delete it. Null
611 lines won't repeat here in any case. */
612 if (instream == stdin)
613 *saved_command_line = 0;
616 /* Prevent dont_repeat from working, and return a cleanup that
617 restores the previous state. */
620 prevent_dont_repeat (void)
622 struct cleanup *result = make_cleanup_restore_integer (&suppress_dont_repeat);
624 suppress_dont_repeat = 1;
629 /* Read a line from the stream "instream" without command line editing.
631 It prints PROMPT_ARG once at the start.
632 Action is compatible with "readline", e.g. space for the result is
633 malloc'd and should be freed by the caller.
635 A NULL return means end of file. */
637 gdb_readline (char *prompt_arg)
642 int result_size = 80;
646 /* Don't use a _filtered function here. It causes the assumed
647 character position to be off, since the newline we read from
648 the user is not accounted for. */
649 fputs_unfiltered (prompt_arg, gdb_stdout);
650 gdb_flush (gdb_stdout);
653 result = (char *) xmalloc (result_size);
657 /* Read from stdin if we are executing a user defined command.
658 This is the right thing for prompt_for_continue, at least. */
659 c = fgetc (instream ? instream : stdin);
664 /* The last line does not end with a newline. Return it, and
665 if we are called again fgetc will still return EOF and
666 we'll return NULL then. */
674 if (input_index > 0 && result[input_index - 1] == '\r')
679 result[input_index++] = c;
680 while (input_index >= result_size)
683 result = (char *) xrealloc (result, result_size);
687 result[input_index++] = '\0';
691 /* Variables which control command line editing and history
692 substitution. These variables are given default values at the end
694 static int command_editing_p;
696 /* NOTE 1999-04-29: This variable will be static again, once we modify
697 gdb to use the event loop as the default command loop and we merge
698 event-top.c into this file, top.c. */
700 /* static */ int history_expansion_p;
702 static int write_history_p;
704 show_write_history_p (struct ui_file *file, int from_tty,
705 struct cmd_list_element *c, const char *value)
707 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
711 static int history_size;
713 show_history_size (struct ui_file *file, int from_tty,
714 struct cmd_list_element *c, const char *value)
716 fprintf_filtered (file, _("The size of the command history is %s.\n"),
720 static char *history_filename;
722 show_history_filename (struct ui_file *file, int from_tty,
723 struct cmd_list_element *c, const char *value)
725 fprintf_filtered (file, _("The filename in which to record "
726 "the command history is \"%s\".\n"),
730 /* This is like readline(), but it has some gdb-specific behavior.
731 gdb may want readline in both the synchronous and async modes during
732 a single gdb invocation. At the ordinary top-level prompt we might
733 be using the async readline. That means we can't use
734 rl_pre_input_hook, since it doesn't work properly in async mode.
735 However, for a secondary prompt (" >", such as occurs during a
736 `define'), gdb wants a synchronous response.
738 We used to call readline() directly, running it in synchronous
739 mode. But mixing modes this way is not supported, and as of
740 readline 5.x it no longer works; the arrow keys come unbound during
741 the synchronous call. So we make a nested call into the event
742 loop. That's what gdb_readline_wrapper is for. */
744 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
745 rely on gdb_readline_wrapper_result, which might still be NULL if
746 the user types Control-D for EOF. */
747 static int gdb_readline_wrapper_done;
749 /* The result of the current call to gdb_readline_wrapper, once a newline
751 static char *gdb_readline_wrapper_result;
753 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
754 to be called after the newline is processed (which will redisplay
755 the prompt). But in gdb_readline_wrapper we will not get a new
756 prompt until the next call, or until we return to the event loop.
757 So we disable this hook around the newline and restore it before we
759 static void (*saved_after_char_processing_hook) (void);
761 /* This function is called when readline has seen a complete line of
765 gdb_readline_wrapper_line (char *line)
767 gdb_assert (!gdb_readline_wrapper_done);
768 gdb_readline_wrapper_result = line;
769 gdb_readline_wrapper_done = 1;
771 /* Prevent operate-and-get-next from acting too early. */
772 saved_after_char_processing_hook = after_char_processing_hook;
773 after_char_processing_hook = NULL;
775 /* Prevent parts of the prompt from being redisplayed if annotations
776 are enabled, and readline's state getting out of sync. */
777 if (async_command_editing_p)
778 rl_callback_handler_remove ();
781 struct gdb_readline_wrapper_cleanup
783 void (*handler_orig) (char *);
784 int already_prompted_orig;
788 gdb_readline_wrapper_cleanup (void *arg)
790 struct gdb_readline_wrapper_cleanup *cleanup = arg;
792 rl_already_prompted = cleanup->already_prompted_orig;
794 gdb_assert (input_handler == gdb_readline_wrapper_line);
795 input_handler = cleanup->handler_orig;
796 gdb_readline_wrapper_result = NULL;
797 gdb_readline_wrapper_done = 0;
799 after_char_processing_hook = saved_after_char_processing_hook;
800 saved_after_char_processing_hook = NULL;
806 gdb_readline_wrapper (char *prompt)
808 struct cleanup *back_to;
809 struct gdb_readline_wrapper_cleanup *cleanup;
812 cleanup = xmalloc (sizeof (*cleanup));
813 cleanup->handler_orig = input_handler;
814 input_handler = gdb_readline_wrapper_line;
816 cleanup->already_prompted_orig = rl_already_prompted;
818 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
820 /* Display our prompt and prevent double prompt display. */
821 display_gdb_prompt (prompt);
822 rl_already_prompted = 1;
824 if (after_char_processing_hook)
825 (*after_char_processing_hook) ();
826 gdb_assert (after_char_processing_hook == NULL);
828 while (gdb_do_one_event () >= 0)
829 if (gdb_readline_wrapper_done)
832 retval = gdb_readline_wrapper_result;
833 do_cleanups (back_to);
838 /* The current saved history number from operate-and-get-next.
839 This is -1 if not valid. */
840 static int operate_saved_history = -1;
842 /* This is put on the appropriate hook and helps operate-and-get-next
845 gdb_rl_operate_and_get_next_completion (void)
847 int delta = where_history () - operate_saved_history;
849 /* The `key' argument to rl_get_previous_history is ignored. */
850 rl_get_previous_history (delta, 0);
851 operate_saved_history = -1;
853 /* readline doesn't automatically update the display for us. */
856 after_char_processing_hook = NULL;
857 rl_pre_input_hook = NULL;
860 /* This is a gdb-local readline command handler. It accepts the
861 current command line (like RET does) and, if this command was taken
862 from the history, arranges for the next command in the history to
863 appear on the command line when the prompt returns.
864 We ignore the arguments. */
866 gdb_rl_operate_and_get_next (int count, int key)
870 /* Use the async hook. */
871 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
873 /* Find the current line, and find the next line to use. */
874 where = where_history();
876 /* FIXME: kettenis/20020817: max_input_history is renamed into
877 history_max_entries in readline-4.2. When we do a new readline
878 import, we should probably change it here too, even though
879 readline maintains backwards compatibility for now by still
880 defining max_input_history. */
881 if ((history_is_stifled () && (history_length >= max_input_history)) ||
882 (where >= history_length - 1))
883 operate_saved_history = where;
885 operate_saved_history = where + 1;
887 return rl_newline (1, key);
890 /* Read one line from the command input stream `instream'
891 into the local static buffer `linebuffer' (whose current length
893 The buffer is made bigger as necessary.
894 Returns the address of the start of the line.
896 NULL is returned for end of file.
898 *If* the instream == stdin & stdin is a terminal, the line read
899 is copied into the file line saver (global var char *line,
900 length linesize) so that it can be duplicated.
902 This routine either uses fancy command line editing or
903 simple input as the user has requested. */
906 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
908 static char *linebuffer = 0;
909 static unsigned linelength = 0;
913 char *local_prompt = prompt_arg;
917 /* The annotation suffix must be non-NULL. */
918 if (annotation_suffix == NULL)
919 annotation_suffix = "";
921 if (annotation_level > 1 && instream == stdin)
923 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
924 + strlen (annotation_suffix) + 40);
925 if (prompt_arg == NULL)
926 local_prompt[0] = '\0';
928 strcpy (local_prompt, prompt_arg);
929 strcat (local_prompt, "\n\032\032");
930 strcat (local_prompt, annotation_suffix);
931 strcat (local_prompt, "\n");
937 linebuffer = (char *) xmalloc (linelength);
942 /* Control-C quits instantly if typed while in this loop
943 since it should not wait until the user types a newline. */
947 signal (STOP_SIGNAL, handle_stop_sig);
952 /* Make sure that all output has been output. Some machines may
953 let you get away with leaving out some of the gdb_flush, but
956 gdb_flush (gdb_stdout);
957 gdb_flush (gdb_stderr);
959 if (source_file_name != NULL)
960 ++source_line_number;
962 if (annotation_level > 1 && instream == stdin)
964 puts_unfiltered ("\n\032\032pre-");
965 puts_unfiltered (annotation_suffix);
966 puts_unfiltered ("\n");
969 /* Don't use fancy stuff if not talking to stdin. */
970 if (deprecated_readline_hook && input_from_terminal_p ())
972 rl = (*deprecated_readline_hook) (local_prompt);
974 else if (command_editing_p && input_from_terminal_p ())
976 rl = gdb_readline_wrapper (local_prompt);
980 rl = gdb_readline (local_prompt);
983 if (annotation_level > 1 && instream == stdin)
985 puts_unfiltered ("\n\032\032post-");
986 puts_unfiltered (annotation_suffix);
987 puts_unfiltered ("\n");
990 if (!rl || rl == (char *) EOF)
995 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
997 linelength = strlen (rl) + 1 + (p - linebuffer);
998 nline = (char *) xrealloc (linebuffer, linelength);
999 p += nline - linebuffer;
1003 /* Copy line. Don't copy null at end. (Leaves line alone
1004 if this was just a newline). */
1008 xfree (rl); /* Allocated in readline. */
1010 if (p == linebuffer || *(p - 1) != '\\')
1013 p--; /* Put on top of '\'. */
1014 local_prompt = (char *) 0;
1019 signal (STOP_SIGNAL, SIG_DFL);
1026 #define SERVER_COMMAND_LENGTH 7
1028 (p - linebuffer > SERVER_COMMAND_LENGTH)
1029 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1032 /* Note that we don't set `line'. Between this and the check in
1033 dont_repeat, this insures that repeating will still do the
1036 return linebuffer + SERVER_COMMAND_LENGTH;
1039 /* Do history expansion if that is wished. */
1040 if (history_expansion_p && instream == stdin
1041 && ISATTY (instream))
1043 char *history_value;
1046 *p = '\0'; /* Insert null now. */
1047 expanded = history_expand (linebuffer, &history_value);
1050 /* Print the changes. */
1051 printf_unfiltered ("%s\n", history_value);
1053 /* If there was an error, call this function again. */
1056 xfree (history_value);
1057 return command_line_input (prompt_arg, repeat,
1060 if (strlen (history_value) > linelength)
1062 linelength = strlen (history_value) + 1;
1063 linebuffer = (char *) xrealloc (linebuffer, linelength);
1065 strcpy (linebuffer, history_value);
1066 p = linebuffer + strlen (linebuffer);
1068 xfree (history_value);
1071 /* If we just got an empty line, and that is supposed to repeat the
1072 previous command, return the value in the global buffer. */
1073 if (repeat && p == linebuffer)
1074 return saved_command_line;
1075 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1077 return saved_command_line;
1081 /* Add line to history if appropriate. */
1082 if (instream == stdin
1083 && ISATTY (stdin) && *linebuffer)
1084 add_history (linebuffer);
1086 /* Note: lines consisting solely of comments are added to the command
1087 history. This is useful when you type a command, and then
1088 realize you don't want to execute it quite yet. You can comment
1089 out the command and then later fetch it from the value history
1090 and remove the '#'. The kill ring is probably better, but some
1091 people are in the habit of commenting things out. */
1093 *p1 = '\0'; /* Found a comment. */
1095 /* Save into global buffer if appropriate. */
1098 if (linelength > saved_command_line_size)
1100 saved_command_line = xrealloc (saved_command_line, linelength);
1101 saved_command_line_size = linelength;
1103 strcpy (saved_command_line, linebuffer);
1104 return saved_command_line;
1110 /* Print the GDB banner. */
1112 print_gdb_version (struct ui_file *stream)
1114 /* From GNU coding standards, first line is meant to be easy for a
1115 program to parse, and is just canonical program name and version
1116 number, which starts after last space. */
1118 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1120 /* Second line is a copyright notice. */
1122 fprintf_filtered (stream,
1123 "Copyright (C) 2012 Free Software Foundation, Inc.\n");
1125 /* Following the copyright is a brief statement that the program is
1126 free software, that users are free to copy and change it on
1127 certain conditions, that it is covered by the GNU GPL, and that
1128 there is no warranty. */
1130 fprintf_filtered (stream, "\
1131 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1132 \nThis is free software: you are free to change and redistribute it.\n\
1133 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1134 and \"show warranty\" for details.\n");
1136 /* After the required info we print the configuration information. */
1138 fprintf_filtered (stream, "This GDB was configured as \"");
1139 if (strcmp (host_name, target_name) != 0)
1141 fprintf_filtered (stream, "--host=%s --target=%s",
1142 host_name, target_name);
1146 fprintf_filtered (stream, "%s", host_name);
1148 fprintf_filtered (stream, "\".");
1150 if (REPORT_BUGS_TO[0])
1152 fprintf_filtered (stream,
1153 _("\nFor bug reporting instructions, please see:\n"));
1154 fprintf_filtered (stream, "%s.", REPORT_BUGS_TO);
1159 /* The current top level prompt, settable with "set prompt", and/or
1160 with the python `gdb.prompt_hook' hook. */
1161 static char *top_prompt;
1163 /* Access method for the GDB prompt string. */
1171 /* Set method for the GDB prompt string. */
1174 set_prompt (const char *s)
1176 char *p = xstrdup (s);
1189 /* Callback for iterate_over_inferiors. Kills or detaches the given
1190 inferior, depending on how we originally gained control of it. */
1193 kill_or_detach (struct inferior *inf, void *args)
1195 struct qt_args *qt = args;
1196 struct thread_info *thread;
1201 thread = any_thread_of_process (inf->pid);
1204 switch_to_thread (thread->ptid);
1206 /* Leave core files alone. */
1207 if (target_has_execution)
1209 if (inf->attach_flag)
1210 target_detach (qt->args, qt->from_tty);
1219 /* Callback for iterate_over_inferiors. Prints info about what GDB
1220 will do to each inferior on a "quit". ARG points to a struct
1221 ui_out where output is to be collected. */
1224 print_inferior_quit_action (struct inferior *inf, void *arg)
1226 struct ui_file *stb = arg;
1231 if (inf->attach_flag)
1232 fprintf_filtered (stb,
1233 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1234 target_pid_to_str (pid_to_ptid (inf->pid)));
1236 fprintf_filtered (stb,
1237 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1238 target_pid_to_str (pid_to_ptid (inf->pid)));
1243 /* If necessary, make the user confirm that we should quit. Return
1244 non-zero if we should quit, zero if we shouldn't. */
1249 struct ui_file *stb;
1250 struct cleanup *old_chain;
1254 /* Don't even ask if we're only debugging a core file inferior. */
1255 if (!have_live_inferiors ())
1258 /* Build the query string as a single string. */
1259 stb = mem_fileopen ();
1260 old_chain = make_cleanup_ui_file_delete (stb);
1262 /* This is something of a hack. But there's no reliable way to see
1263 if a GUI is running. The `use_windows' variable doesn't cut
1265 if (deprecated_init_ui_hook)
1266 fprintf_filtered (stb, _("A debugging session is active.\n"
1267 "Do you still want to close the debugger?"));
1270 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1271 iterate_over_inferiors (print_inferior_quit_action, stb);
1272 fprintf_filtered (stb, _("\nQuit anyway? "));
1275 str = ui_file_xstrdup (stb, NULL);
1276 make_cleanup (xfree, str);
1278 qr = query ("%s", str);
1279 do_cleanups (old_chain);
1283 /* Helper routine for quit_force that requires error handling. */
1286 quit_target (void *arg)
1288 struct qt_args *qt = (struct qt_args *)arg;
1290 /* Kill or detach all inferiors. */
1291 iterate_over_inferiors (kill_or_detach, qt);
1293 /* Give all pushed targets a chance to do minimal cleanup, and pop
1295 pop_all_targets (1);
1297 /* Save the history information if it is appropriate to do so. */
1298 if (write_history_p && history_filename)
1299 write_history (history_filename);
1301 do_final_cleanups (all_cleanups ()); /* Do any final cleanups before
1306 /* Quit without asking for confirmation. */
1309 quit_force (char *args, int from_tty)
1314 /* An optional expression may be used to cause gdb to terminate with the
1315 value of that expression. */
1318 struct value *val = parse_and_eval (args);
1320 exit_code = (int) value_as_long (val);
1322 else if (return_child_result)
1323 exit_code = return_child_result_value;
1326 qt.from_tty = from_tty;
1328 /* We want to handle any quit errors and exit regardless. */
1329 catch_errors (quit_target, &qt,
1330 "Quitting: ", RETURN_MASK_ALL);
1335 /* Returns whether GDB is running on a terminal and input is
1336 currently coming from that terminal. */
1339 input_from_terminal_p (void)
1344 if (gdb_has_a_terminal () && instream == stdin)
1347 /* If INSTREAM is unset, and we are not in a user command, we
1348 must be in Insight. That's like having a terminal, for our
1350 if (instream == NULL && !in_user_command)
1357 dont_repeat_command (char *ignored, int from_tty)
1359 /* Can't call dont_repeat here because we're not necessarily reading
1361 *saved_command_line = 0;
1364 /* Functions to manipulate command line editing control variables. */
1366 /* Number of commands to print in each call to show_commands. */
1367 #define Hist_print 10
1369 show_commands (char *args, int from_tty)
1371 /* Index for history commands. Relative to history_base. */
1374 /* Number of the history entry which we are planning to display next.
1375 Relative to history_base. */
1378 /* The first command in the history which doesn't exist (i.e. one more
1379 than the number of the last command). Relative to history_base. */
1382 /* Print out some of the commands from the command history. */
1383 /* First determine the length of the history list. */
1384 hist_len = history_size;
1385 for (offset = 0; offset < history_size; offset++)
1387 if (!history_get (history_base + offset))
1396 if (args[0] == '+' && args[1] == '\0')
1397 /* "info editing +" should print from the stored position. */
1400 /* "info editing <exp>" should print around command number <exp>. */
1401 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1403 /* "show commands" means print the last Hist_print commands. */
1406 num = hist_len - Hist_print;
1412 /* If there are at least Hist_print commands, we want to display the last
1413 Hist_print rather than, say, the last 6. */
1414 if (hist_len - num < Hist_print)
1416 num = hist_len - Hist_print;
1421 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1423 printf_filtered ("%5d %s\n", history_base + offset,
1424 (history_get (history_base + offset))->line);
1427 /* The next command we want to display is the next one that we haven't
1431 /* If the user repeats this command with return, it should do what
1432 "show commands +" does. This is unnecessary if arg is null,
1433 because "show commands +" is not useful after "show commands". */
1434 if (from_tty && args)
1441 /* Called by do_setshow_command. */
1443 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1445 if (history_size == INT_MAX)
1446 unstifle_history ();
1447 else if (history_size >= 0)
1448 stifle_history (history_size);
1451 history_size = INT_MAX;
1452 error (_("History size must be non-negative"));
1457 set_history (char *args, int from_tty)
1459 printf_unfiltered (_("\"set history\" must be followed "
1460 "by the name of a history subcommand.\n"));
1461 help_list (sethistlist, "set history ", -1, gdb_stdout);
1465 show_history (char *args, int from_tty)
1467 cmd_show_list (showhistlist, from_tty, "");
1470 int info_verbose = 0; /* Default verbose msgs off. */
1472 /* Called by do_setshow_command. An elaborate joke. */
1474 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1476 char *cmdname = "verbose";
1477 struct cmd_list_element *showcmd;
1479 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1480 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1484 c->doc = "Set verbose printing of informational messages.";
1485 showcmd->doc = "Show verbose printing of informational messages.";
1489 c->doc = "Set verbosity.";
1490 showcmd->doc = "Show verbosity.";
1494 /* Init the history buffer. Note that we are called after the init file(s)
1495 have been read so that the user can change the history file via his
1496 .gdbinit file (for instance). The GDBHISTFILE environment variable
1497 overrides all of this. */
1504 tmpenv = getenv ("HISTSIZE");
1506 history_size = atoi (tmpenv);
1507 else if (!history_size)
1510 stifle_history (history_size);
1512 tmpenv = getenv ("GDBHISTFILE");
1514 history_filename = xstrdup (tmpenv);
1515 else if (!history_filename)
1517 /* We include the current directory so that if the user changes
1518 directories the file written will be the same as the one
1521 /* No leading dots in file names are allowed on MSDOS. */
1522 history_filename = concat (current_directory, "/_gdb_history",
1525 history_filename = concat (current_directory, "/.gdb_history",
1529 read_history (history_filename);
1533 show_prompt (struct ui_file *file, int from_tty,
1534 struct cmd_list_element *c, const char *value)
1536 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1540 show_async_command_editing_p (struct ui_file *file, int from_tty,
1541 struct cmd_list_element *c, const char *value)
1543 fprintf_filtered (file, _("Editing of command lines as "
1544 "they are typed is %s.\n"),
1549 show_annotation_level (struct ui_file *file, int from_tty,
1550 struct cmd_list_element *c, const char *value)
1552 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1556 show_exec_done_display_p (struct ui_file *file, int from_tty,
1557 struct cmd_list_element *c, const char *value)
1559 fprintf_filtered (file, _("Notification of completion for "
1560 "asynchronous execution commands is %s.\n"),
1564 /* "set" command for the gdb_datadir configuration variable. */
1567 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1569 observer_notify_gdb_datadir_changed ();
1575 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1576 the DEFAULT_PROMPT is. */
1577 set_prompt (DEFAULT_PROMPT);
1579 /* Set things up for annotation_level > 1, if the user ever decides
1581 async_annotation_suffix = "prompt";
1583 /* Set the important stuff up for command editing. */
1584 command_editing_p = 1;
1585 history_expansion_p = 0;
1586 write_history_p = 0;
1588 /* Setup important stuff for command line editing. */
1589 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1590 rl_completion_entry_function = readline_line_completion_function;
1591 rl_completer_word_break_characters = default_word_break_characters ();
1592 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1593 rl_readline_name = "gdb";
1594 rl_terminal_name = getenv ("TERM");
1596 /* The name for this defun comes from Bash, where it originated.
1597 15 is Control-o, the same binding this function has in Bash. */
1598 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1600 add_setshow_string_cmd ("prompt", class_support,
1602 _("Set gdb's prompt"),
1603 _("Show gdb's prompt"),
1606 &setlist, &showlist);
1608 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1609 Don't repeat this command.\nPrimarily \
1610 used inside of user-defined commands that should not be repeated when\n\
1613 add_setshow_boolean_cmd ("editing", class_support,
1614 &async_command_editing_p, _("\
1615 Set editing of command lines as they are typed."), _("\
1616 Show editing of command lines as they are typed."), _("\
1617 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1618 Without an argument, command line editing is enabled. To edit, use\n\
1619 EMACS-like or VI-like commands like control-P or ESC."),
1620 set_async_editing_command,
1621 show_async_command_editing_p,
1622 &setlist, &showlist);
1624 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1625 Set saving of the history record on exit."), _("\
1626 Show saving of the history record on exit."), _("\
1627 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1628 Without an argument, saving is enabled."),
1630 show_write_history_p,
1631 &sethistlist, &showhistlist);
1633 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1634 Set the size of the command history,"), _("\
1635 Show the size of the command history,"), _("\
1636 ie. the number of previous commands to keep a record of."),
1637 set_history_size_command,
1639 &sethistlist, &showhistlist);
1641 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1642 Set the filename in which to record the command history"), _("\
1643 Show the filename in which to record the command history"), _("\
1644 (the list of previous commands of which a record is kept)."),
1646 show_history_filename,
1647 &sethistlist, &showhistlist);
1649 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
1650 Set whether to confirm potentially dangerous operations."), _("\
1651 Show whether to confirm potentially dangerous operations."), NULL,
1654 &setlist, &showlist);
1656 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1657 Set annotation_level."), _("\
1658 Show annotation_level."), _("\
1659 0 == normal; 1 == fullname (for use when running under emacs)\n\
1660 2 == output annotated suitably for use by programs that control GDB."),
1662 show_annotation_level,
1663 &setlist, &showlist);
1665 add_setshow_boolean_cmd ("exec-done-display", class_support,
1666 &exec_done_display_p, _("\
1667 Set notification of completion for asynchronous execution commands."), _("\
1668 Show notification of completion for asynchronous execution commands."), _("\
1669 Use \"on\" to enable the notification, and \"off\" to disable it."),
1671 show_exec_done_display_p,
1672 &setlist, &showlist);
1674 add_setshow_filename_cmd ("data-directory", class_maintenance,
1675 &gdb_datadir, _("Set GDB's data directory."),
1676 _("Show GDB's data directory."),
1678 When set, GDB uses the specified path to search for data files."),
1679 set_gdb_datadir, NULL,
1685 gdb_init (char *argv0)
1687 if (pre_init_ui_hook)
1688 pre_init_ui_hook ();
1690 /* Run the init function of each source file. */
1693 /* Make sure we return to the original directory upon exit, come
1694 what may, since the OS doesn't do that for us. */
1695 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1698 init_cmd_lists (); /* This needs to be done first. */
1699 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1700 initialize_utils (); /* Make errors and warnings possible. */
1702 /* Here is where we call all the _initialize_foo routines. */
1703 initialize_all_files ();
1705 /* This creates the current_program_space. Do this after all the
1706 _initialize_foo routines have had a chance to install their
1707 per-sspace data keys. Also do this before
1708 initialize_current_architecture is called, because it accesses
1709 exec_bfd of the current program space. */
1710 initialize_progspace ();
1711 initialize_inferiors ();
1712 initialize_current_architecture ();
1714 init_main (); /* But that omits this file! Do it now. */
1716 initialize_stdin_serial ();
1718 async_init_signals ();
1720 /* We need a default language for parsing expressions, so simple
1721 things like "set width 0" won't fail if no language is explicitly
1722 set in a config file or implicitly set by reading an executable
1724 set_language (language_c);
1725 expected_language = current_language; /* Don't warn about the change. */
1727 /* Allow another UI to initialize. If the UI fails to initialize,
1728 and it wants GDB to revert to the CLI, it should clear
1729 deprecated_init_ui_hook. */
1730 if (deprecated_init_ui_hook)
1731 deprecated_init_ui_hook (argv0);
1734 /* Python initialization can require various commands to be
1735 installed. For example "info pretty-printer" needs the "info"
1736 prefix to be installed. Keep things simple and just do final
1737 python initialization here. */
1738 finish_python_initialization ();