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 *);
142 /* Buffer used for reading command lines, and the size
143 allocated for it so far. */
145 char *saved_command_line;
146 int saved_command_line_size = 100;
148 /* Nonzero if the current command is modified by "server ". This
149 affects things like recording into the command history, commands
150 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
151 whatever) can issue its own commands and also send along commands
152 from the user, and have the user not notice that the user interface
153 is issuing commands too. */
156 /* Baud rate specified for talking to serial target systems. Default
157 is left as -1, so targets can choose their own defaults. */
158 /* FIXME: This means that "show remotebaud" and gr_files_info can
159 print -1 or (unsigned int)-1. This is a Bad User Interface. */
163 /* Timeout limit for response from target. */
165 /* The default value has been changed many times over the years. It
166 was originally 5 seconds. But that was thought to be a long time
167 to sit and wait, so it was changed to 2 seconds. That was thought
168 to be plenty unless the connection was going through some terminal
169 server or multiplexer or other form of hairy serial connection.
171 In mid-1996, remote_timeout was moved from remote.c to top.c and
172 it began being used in other remote-* targets. It appears that the
173 default was changed to 20 seconds at that time, perhaps because the
174 Renesas E7000 ICE didn't always respond in a timely manner.
176 But if 5 seconds is a long time to sit and wait for retransmissions,
177 20 seconds is far worse. This demonstrates the difficulty of using
178 a single variable for all protocol timeouts.
180 As remote.c is used much more than remote-e7000.c, it was changed
181 back to 2 seconds in 1999. */
183 int remote_timeout = 2;
185 /* Non-zero tells remote* modules to output debugging info. */
187 int remote_debug = 0;
189 /* Sbrk location on entry to main. Used for statistics only. */
194 /* Hooks for alternate command interfaces. */
196 /* Called after most modules have been initialized, but before taking
199 If the UI fails to initialize and it wants GDB to continue using
200 the default UI, then it should clear this hook before returning. */
202 void (*deprecated_init_ui_hook) (char *argv0);
204 /* This hook is called from within gdb's many mini-event loops which
205 could steal control from a real user interface's event loop. It
206 returns non-zero if the user is requesting a detach, zero
209 int (*deprecated_ui_loop_hook) (int);
211 /* Called instead of command_loop at top level. Can be invoked via
212 throw_exception(). */
214 void (*deprecated_command_loop_hook) (void);
217 /* Called from print_frame_info to list the line we stopped in. */
219 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
223 /* Replaces most of query. */
225 int (*deprecated_query_hook) (const char *, va_list);
227 /* Replaces most of warning. */
229 void (*deprecated_warning_hook) (const char *, va_list);
231 /* These three functions support getting lines of text from the user.
232 They are used in sequence. First deprecated_readline_begin_hook is
233 called with a text string that might be (for example) a message for
234 the user to type in a sequence of commands to be executed at a
235 breakpoint. If this function calls back to a GUI, it might take
236 this opportunity to pop up a text interaction window with this
237 message. Next, deprecated_readline_hook is called with a prompt
238 that is emitted prior to collecting the user input. It can be
239 called multiple times. Finally, deprecated_readline_end_hook is
240 called to notify the GUI that we are done with the interaction
241 window and it can close it. */
243 void (*deprecated_readline_begin_hook) (char *, ...);
244 char *(*deprecated_readline_hook) (char *);
245 void (*deprecated_readline_end_hook) (void);
247 /* Called as appropriate to notify the interface that we have attached
248 to or detached from an already running process. */
250 void (*deprecated_attach_hook) (void);
251 void (*deprecated_detach_hook) (void);
253 /* Called during long calculations to allow GUI to repair window
254 damage, and to check for stop buttons, etc... */
256 void (*deprecated_interactive_hook) (void);
258 /* Tell the GUI someone changed the register REGNO. -1 means
259 that the caller does not know which register changed or
260 that several registers have changed (see value_assign). */
261 void (*deprecated_register_changed_hook) (int regno);
263 /* Called when going to wait for the target. Usually allows the GUI
264 to run while waiting for target events. */
266 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
267 struct target_waitstatus *status,
270 /* Used by UI as a wrapper around command execution. May do various
271 things like enabling/disabling buttons, etc... */
273 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
274 char *cmd, int from_tty);
276 /* Called after a `set' command has finished. Is only run if the
277 `set' command succeeded. */
279 void (*deprecated_set_hook) (struct cmd_list_element * c);
281 /* Called when the current thread changes. Argument is thread id. */
283 void (*deprecated_context_hook) (int id);
285 /* Handler for SIGHUP. */
288 /* NOTE 1999-04-29: This function will be static again, once we modify
289 gdb to use the event loop as the default command loop and we merge
290 event-top.c into this file, top.c. */
294 /* Stop asking user for confirmation --- we're exiting. This
295 prevents asking the user dumb questions. */
297 quit_command ((char *) 0, 0);
299 #endif /* defined SIGHUP */
301 /* Line number we are currently in, in a file which is being sourced. */
302 /* NOTE 1999-04-29: This variable will be static again, once we modify
303 gdb to use the event loop as the default command loop and we merge
304 event-top.c into this file, top.c. */
305 /* static */ int source_line_number;
307 /* Name of the file we are sourcing. */
308 /* NOTE 1999-04-29: This variable will be static again, once we modify
309 gdb to use the event loop as the default command loop and we merge
310 event-top.c into this file, top.c. */
311 /* static */ const char *source_file_name;
313 /* Clean up on error during a "source" command (or execution of a
314 user-defined command). */
317 do_restore_instream_cleanup (void *stream)
319 /* Restore the previous input stream. */
323 /* Read commands from STREAM. */
325 read_command_file (FILE *stream)
327 struct cleanup *cleanups;
329 cleanups = make_cleanup (do_restore_instream_cleanup, instream);
332 do_cleanups (cleanups);
335 void (*pre_init_ui_hook) (void);
339 do_chdir_cleanup (void *old_dir)
347 prepare_execute_command (void)
350 struct cleanup *cleanup;
352 mark = value_mark ();
353 cleanup = make_cleanup_value_free_to_mark (mark);
355 /* With multiple threads running while the one we're examining is
356 stopped, the dcache can get stale without us being able to detect
357 it. For the duration of the command, though, use the dcache to
358 help things like backtrace. */
360 target_dcache_invalidate ();
365 /* Tell the user if the language has changed (except first time) after
366 executing a command. */
369 check_frame_language_change (void)
371 static int warned = 0;
373 /* First make sure that a new frame has been selected, in case the
374 command or the hooks changed the program state. */
375 deprecated_safe_get_selected_frame ();
376 if (current_language != expected_language)
378 if (language_mode == language_mode_auto && info_verbose)
380 language_info (1); /* Print what changed. */
385 /* Warn the user if the working language does not match the language
386 of the current frame. Only warn the user if we are actually
387 running the program, i.e. there is a stack. */
388 /* FIXME: This should be cacheing the frame and only running when
389 the frame changes. */
391 if (has_stack_frames ())
395 flang = get_frame_language ();
397 && flang != language_unknown
398 && flang != current_language->la_language)
400 printf_filtered ("%s\n", lang_frame_mismatch_warn);
406 /* Execute the line P as a command, in the current user context.
407 Pass FROM_TTY as second argument to the defining function. */
410 execute_command (char *p, int from_tty)
412 struct cleanup *cleanup_if_error, *cleanup;
413 struct cmd_list_element *c;
416 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
417 cleanup = prepare_execute_command ();
419 /* Force cleanup of any alloca areas if using C alloca instead of
423 /* This can happen when command_line_input hits end of file. */
426 do_cleanups (cleanup);
430 target_log_command (p);
432 while (*p == ' ' || *p == '\t')
439 /* If trace-commands is set then this will print this command. */
440 print_command_trace (p);
442 c = lookup_cmd (&p, cmdlist, "", 0, 1);
444 /* Pass null arg rather than an empty one. */
447 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
448 while the is_complete_command(cfunc) test is just plain
449 bogus. They should both be replaced by a test of the form
450 c->strip_trailing_white_space_p. */
451 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
452 can't be replaced with func. This is because it is the
453 cfunc, and not the func, that has the value that the
454 is_complete_command hack is testing for. */
455 /* Clear off trailing whitespace, except for set and complete
458 && c->type != set_cmd
459 && !is_complete_command (c))
461 p = arg + strlen (arg) - 1;
462 while (p >= arg && (*p == ' ' || *p == '\t'))
467 /* If this command has been pre-hooked, run the hook first. */
468 execute_cmd_pre_hook (c);
470 if (c->flags & DEPRECATED_WARN_USER)
471 deprecated_cmd_warning (&line);
473 /* c->user_commands would be NULL in the case of a python command. */
474 if (c->class == class_user && c->user_commands)
475 execute_user_command (c, arg);
476 else if (c->type == set_cmd)
477 do_set_command (arg, from_tty, c);
478 else if (c->type == show_cmd)
479 do_show_command (arg, from_tty, c);
480 else if (!cmd_func_p (c))
481 error (_("That is not a command, just a help topic."));
482 else if (deprecated_call_command_hook)
483 deprecated_call_command_hook (c, arg, from_tty);
485 cmd_func (c, arg, from_tty);
487 /* If the interpreter is in sync mode (we're running a user
488 command's list, running command hooks or similars), and we
489 just ran a synchronous command that started the target, wait
490 for that command to end. */
491 if (!interpreter_async && sync_execution)
493 while (gdb_do_one_event () >= 0)
498 /* If this command has been post-hooked, run the hook last. */
499 execute_cmd_post_hook (c);
503 check_frame_language_change ();
505 do_cleanups (cleanup);
506 discard_cleanups (cleanup_if_error);
509 /* Run execute_command for P and FROM_TTY. Capture its output into the
510 returned string, do not display it to the screen. BATCH_FLAG will be
511 temporarily set to true. */
514 execute_command_to_string (char *p, int from_tty)
516 struct ui_file *str_file;
517 struct cleanup *cleanup;
520 /* GDB_STDOUT should be better already restored during these
521 restoration callbacks. */
522 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
524 make_cleanup_restore_integer (&interpreter_async);
525 interpreter_async = 0;
527 str_file = mem_fileopen ();
529 make_cleanup_ui_file_delete (str_file);
530 make_cleanup_restore_ui_file (&gdb_stdout);
531 make_cleanup_restore_ui_file (&gdb_stderr);
532 make_cleanup_restore_ui_file (&gdb_stdlog);
533 make_cleanup_restore_ui_file (&gdb_stdtarg);
534 make_cleanup_restore_ui_file (&gdb_stdtargerr);
536 if (ui_out_redirect (current_uiout, str_file) < 0)
537 warning (_("Current output protocol does not support redirection"));
539 make_cleanup_ui_out_redirect_pop (current_uiout);
541 gdb_stdout = str_file;
542 gdb_stderr = str_file;
543 gdb_stdlog = str_file;
544 gdb_stdtarg = str_file;
545 gdb_stdtargerr = str_file;
547 execute_command (p, from_tty);
549 retval = ui_file_xstrdup (str_file, NULL);
551 do_cleanups (cleanup);
556 /* Read commands from `instream' and execute them
557 until end of file or error reading instream. */
562 struct cleanup *old_chain;
564 int stdin_is_tty = ISATTY (stdin);
566 while (instream && !feof (instream))
568 if (window_hook && instream == stdin)
569 (*window_hook) (instream, get_prompt ());
572 if (instream == stdin && stdin_is_tty)
573 reinitialize_more_filter ();
574 old_chain = make_cleanup (null_cleanup, 0);
576 /* Get a command-line. This calls the readline package. */
577 command = command_line_input (instream == stdin ?
578 get_prompt () : (char *) NULL,
579 instream == stdin, "prompt");
582 do_cleanups (old_chain);
586 make_command_stats_cleanup (1);
588 execute_command (command, instream == stdin);
590 /* Do any commands attached to breakpoint we are stopped at. */
591 bpstat_do_actions ();
593 do_cleanups (old_chain);
597 /* When nonzero, cause dont_repeat to do nothing. This should only be
598 set via prevent_dont_repeat. */
600 static int suppress_dont_repeat = 0;
602 /* Commands call this if they do not want to be repeated by null lines. */
607 if (suppress_dont_repeat || server_command)
610 /* If we aren't reading from standard input, we are saving the last
611 thing read from stdin in line and don't want to delete it. Null
612 lines won't repeat here in any case. */
613 if (instream == stdin)
614 *saved_command_line = 0;
617 /* Prevent dont_repeat from working, and return a cleanup that
618 restores the previous state. */
621 prevent_dont_repeat (void)
623 struct cleanup *result = make_cleanup_restore_integer (&suppress_dont_repeat);
625 suppress_dont_repeat = 1;
630 /* Read a line from the stream "instream" without command line editing.
632 It prints PROMPT_ARG once at the start.
633 Action is compatible with "readline", e.g. space for the result is
634 malloc'd and should be freed by the caller.
636 A NULL return means end of file. */
638 gdb_readline (char *prompt_arg)
643 int result_size = 80;
647 /* Don't use a _filtered function here. It causes the assumed
648 character position to be off, since the newline we read from
649 the user is not accounted for. */
650 fputs_unfiltered (prompt_arg, gdb_stdout);
651 gdb_flush (gdb_stdout);
654 result = (char *) xmalloc (result_size);
658 /* Read from stdin if we are executing a user defined command.
659 This is the right thing for prompt_for_continue, at least. */
660 c = fgetc (instream ? instream : stdin);
665 /* The last line does not end with a newline. Return it, and
666 if we are called again fgetc will still return EOF and
667 we'll return NULL then. */
675 if (input_index > 0 && result[input_index - 1] == '\r')
680 result[input_index++] = c;
681 while (input_index >= result_size)
684 result = (char *) xrealloc (result, result_size);
688 result[input_index++] = '\0';
692 /* Variables which control command line editing and history
693 substitution. These variables are given default values at the end
695 static int command_editing_p;
697 /* NOTE 1999-04-29: This variable will be static again, once we modify
698 gdb to use the event loop as the default command loop and we merge
699 event-top.c into this file, top.c. */
701 /* static */ int history_expansion_p;
703 static int write_history_p;
705 show_write_history_p (struct ui_file *file, int from_tty,
706 struct cmd_list_element *c, const char *value)
708 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
712 static unsigned int history_size;
714 show_history_size (struct ui_file *file, int from_tty,
715 struct cmd_list_element *c, const char *value)
717 fprintf_filtered (file, _("The size of the command history is %s.\n"),
721 static char *history_filename;
723 show_history_filename (struct ui_file *file, int from_tty,
724 struct cmd_list_element *c, const char *value)
726 fprintf_filtered (file, _("The filename in which to record "
727 "the command history is \"%s\".\n"),
731 /* This is like readline(), but it has some gdb-specific behavior.
732 gdb may want readline in both the synchronous and async modes during
733 a single gdb invocation. At the ordinary top-level prompt we might
734 be using the async readline. That means we can't use
735 rl_pre_input_hook, since it doesn't work properly in async mode.
736 However, for a secondary prompt (" >", such as occurs during a
737 `define'), gdb wants a synchronous response.
739 We used to call readline() directly, running it in synchronous
740 mode. But mixing modes this way is not supported, and as of
741 readline 5.x it no longer works; the arrow keys come unbound during
742 the synchronous call. So we make a nested call into the event
743 loop. That's what gdb_readline_wrapper is for. */
745 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
746 rely on gdb_readline_wrapper_result, which might still be NULL if
747 the user types Control-D for EOF. */
748 static int gdb_readline_wrapper_done;
750 /* The result of the current call to gdb_readline_wrapper, once a newline
752 static char *gdb_readline_wrapper_result;
754 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
755 to be called after the newline is processed (which will redisplay
756 the prompt). But in gdb_readline_wrapper we will not get a new
757 prompt until the next call, or until we return to the event loop.
758 So we disable this hook around the newline and restore it before we
760 static void (*saved_after_char_processing_hook) (void);
762 /* This function is called when readline has seen a complete line of
766 gdb_readline_wrapper_line (char *line)
768 gdb_assert (!gdb_readline_wrapper_done);
769 gdb_readline_wrapper_result = line;
770 gdb_readline_wrapper_done = 1;
772 /* Prevent operate-and-get-next from acting too early. */
773 saved_after_char_processing_hook = after_char_processing_hook;
774 after_char_processing_hook = NULL;
776 /* Prevent parts of the prompt from being redisplayed if annotations
777 are enabled, and readline's state getting out of sync. */
778 if (async_command_editing_p)
779 rl_callback_handler_remove ();
782 struct gdb_readline_wrapper_cleanup
784 void (*handler_orig) (char *);
785 int already_prompted_orig;
789 gdb_readline_wrapper_cleanup (void *arg)
791 struct gdb_readline_wrapper_cleanup *cleanup = arg;
793 rl_already_prompted = cleanup->already_prompted_orig;
795 gdb_assert (input_handler == gdb_readline_wrapper_line);
796 input_handler = cleanup->handler_orig;
797 gdb_readline_wrapper_result = NULL;
798 gdb_readline_wrapper_done = 0;
800 after_char_processing_hook = saved_after_char_processing_hook;
801 saved_after_char_processing_hook = NULL;
807 gdb_readline_wrapper (char *prompt)
809 struct cleanup *back_to;
810 struct gdb_readline_wrapper_cleanup *cleanup;
813 cleanup = xmalloc (sizeof (*cleanup));
814 cleanup->handler_orig = input_handler;
815 input_handler = gdb_readline_wrapper_line;
817 cleanup->already_prompted_orig = rl_already_prompted;
819 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
821 /* Display our prompt and prevent double prompt display. */
822 display_gdb_prompt (prompt);
823 rl_already_prompted = 1;
825 if (after_char_processing_hook)
826 (*after_char_processing_hook) ();
827 gdb_assert (after_char_processing_hook == NULL);
829 while (gdb_do_one_event () >= 0)
830 if (gdb_readline_wrapper_done)
833 retval = gdb_readline_wrapper_result;
834 do_cleanups (back_to);
839 /* The current saved history number from operate-and-get-next.
840 This is -1 if not valid. */
841 static int operate_saved_history = -1;
843 /* This is put on the appropriate hook and helps operate-and-get-next
846 gdb_rl_operate_and_get_next_completion (void)
848 int delta = where_history () - operate_saved_history;
850 /* The `key' argument to rl_get_previous_history is ignored. */
851 rl_get_previous_history (delta, 0);
852 operate_saved_history = -1;
854 /* readline doesn't automatically update the display for us. */
857 after_char_processing_hook = NULL;
858 rl_pre_input_hook = NULL;
861 /* This is a gdb-local readline command handler. It accepts the
862 current command line (like RET does) and, if this command was taken
863 from the history, arranges for the next command in the history to
864 appear on the command line when the prompt returns.
865 We ignore the arguments. */
867 gdb_rl_operate_and_get_next (int count, int key)
871 /* Use the async hook. */
872 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
874 /* Find the current line, and find the next line to use. */
875 where = where_history();
877 /* FIXME: kettenis/20020817: max_input_history is renamed into
878 history_max_entries in readline-4.2. When we do a new readline
879 import, we should probably change it here too, even though
880 readline maintains backwards compatibility for now by still
881 defining max_input_history. */
882 if ((history_is_stifled () && (history_length >= max_input_history)) ||
883 (where >= history_length - 1))
884 operate_saved_history = where;
886 operate_saved_history = where + 1;
888 return rl_newline (1, key);
891 /* Read one line from the command input stream `instream'
892 into the local static buffer `linebuffer' (whose current length
894 The buffer is made bigger as necessary.
895 Returns the address of the start of the line.
897 NULL is returned for end of file.
899 *If* the instream == stdin & stdin is a terminal, the line read
900 is copied into the file line saver (global var char *line,
901 length linesize) so that it can be duplicated.
903 This routine either uses fancy command line editing or
904 simple input as the user has requested. */
907 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
909 static char *linebuffer = 0;
910 static unsigned linelength = 0;
914 char *local_prompt = prompt_arg;
918 /* The annotation suffix must be non-NULL. */
919 if (annotation_suffix == NULL)
920 annotation_suffix = "";
922 if (annotation_level > 1 && instream == stdin)
924 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
925 + strlen (annotation_suffix) + 40);
926 if (prompt_arg == NULL)
927 local_prompt[0] = '\0';
929 strcpy (local_prompt, prompt_arg);
930 strcat (local_prompt, "\n\032\032");
931 strcat (local_prompt, annotation_suffix);
932 strcat (local_prompt, "\n");
938 linebuffer = (char *) xmalloc (linelength);
943 /* Control-C quits instantly if typed while in this loop
944 since it should not wait until the user types a newline. */
949 signal (STOP_SIGNAL, handle_stop_sig);
954 /* Make sure that all output has been output. Some machines may
955 let you get away with leaving out some of the gdb_flush, but
958 gdb_flush (gdb_stdout);
959 gdb_flush (gdb_stderr);
961 if (source_file_name != NULL)
962 ++source_line_number;
964 if (annotation_level > 1 && instream == stdin)
966 puts_unfiltered ("\n\032\032pre-");
967 puts_unfiltered (annotation_suffix);
968 puts_unfiltered ("\n");
971 /* Don't use fancy stuff if not talking to stdin. */
972 if (deprecated_readline_hook && input_from_terminal_p ())
974 rl = (*deprecated_readline_hook) (local_prompt);
976 else if (command_editing_p && input_from_terminal_p ())
978 rl = gdb_readline_wrapper (local_prompt);
982 rl = gdb_readline (local_prompt);
985 if (annotation_level > 1 && instream == stdin)
987 puts_unfiltered ("\n\032\032post-");
988 puts_unfiltered (annotation_suffix);
989 puts_unfiltered ("\n");
992 if (!rl || rl == (char *) EOF)
997 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
999 linelength = strlen (rl) + 1 + (p - linebuffer);
1000 nline = (char *) xrealloc (linebuffer, linelength);
1001 p += nline - linebuffer;
1005 /* Copy line. Don't copy null at end. (Leaves line alone
1006 if this was just a newline). */
1010 xfree (rl); /* Allocated in readline. */
1012 if (p == linebuffer || *(p - 1) != '\\')
1015 p--; /* Put on top of '\'. */
1016 local_prompt = (char *) 0;
1021 signal (STOP_SIGNAL, SIG_DFL);
1028 #define SERVER_COMMAND_LENGTH 7
1030 (p - linebuffer > SERVER_COMMAND_LENGTH)
1031 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1034 /* Note that we don't set `line'. Between this and the check in
1035 dont_repeat, this insures that repeating will still do the
1038 return linebuffer + SERVER_COMMAND_LENGTH;
1041 /* Do history expansion if that is wished. */
1042 if (history_expansion_p && instream == stdin
1043 && ISATTY (instream))
1045 char *history_value;
1048 *p = '\0'; /* Insert null now. */
1049 expanded = history_expand (linebuffer, &history_value);
1052 /* Print the changes. */
1053 printf_unfiltered ("%s\n", history_value);
1055 /* If there was an error, call this function again. */
1058 xfree (history_value);
1059 return command_line_input (prompt_arg, repeat,
1062 if (strlen (history_value) > linelength)
1064 linelength = strlen (history_value) + 1;
1065 linebuffer = (char *) xrealloc (linebuffer, linelength);
1067 strcpy (linebuffer, history_value);
1068 p = linebuffer + strlen (linebuffer);
1070 xfree (history_value);
1073 /* If we just got an empty line, and that is supposed to repeat the
1074 previous command, return the value in the global buffer. */
1075 if (repeat && p == linebuffer)
1076 return saved_command_line;
1077 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1079 return saved_command_line;
1083 /* Add line to history if appropriate. */
1084 if (instream == stdin
1085 && ISATTY (stdin) && *linebuffer)
1086 add_history (linebuffer);
1088 /* Note: lines consisting solely of comments are added to the command
1089 history. This is useful when you type a command, and then
1090 realize you don't want to execute it quite yet. You can comment
1091 out the command and then later fetch it from the value history
1092 and remove the '#'. The kill ring is probably better, but some
1093 people are in the habit of commenting things out. */
1095 *p1 = '\0'; /* Found a comment. */
1097 /* Save into global buffer if appropriate. */
1100 if (linelength > saved_command_line_size)
1102 saved_command_line = xrealloc (saved_command_line, linelength);
1103 saved_command_line_size = linelength;
1105 strcpy (saved_command_line, linebuffer);
1106 return saved_command_line;
1112 /* Print the GDB banner. */
1114 print_gdb_version (struct ui_file *stream)
1116 /* From GNU coding standards, first line is meant to be easy for a
1117 program to parse, and is just canonical program name and version
1118 number, which starts after last space. */
1120 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1122 /* Second line is a copyright notice. */
1124 fprintf_filtered (stream,
1125 "Copyright (C) 2012 Free Software Foundation, Inc.\n");
1127 /* Following the copyright is a brief statement that the program is
1128 free software, that users are free to copy and change it on
1129 certain conditions, that it is covered by the GNU GPL, and that
1130 there is no warranty. */
1132 fprintf_filtered (stream, "\
1133 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1134 \nThis is free software: you are free to change and redistribute it.\n\
1135 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1136 and \"show warranty\" for details.\n");
1138 /* After the required info we print the configuration information. */
1140 fprintf_filtered (stream, "This GDB was configured as \"");
1141 if (strcmp (host_name, target_name) != 0)
1143 fprintf_filtered (stream, "--host=%s --target=%s",
1144 host_name, target_name);
1148 fprintf_filtered (stream, "%s", host_name);
1150 fprintf_filtered (stream, "\".");
1152 if (REPORT_BUGS_TO[0])
1154 fprintf_filtered (stream,
1155 _("\nFor bug reporting instructions, please see:\n"));
1156 fprintf_filtered (stream, "%s.", REPORT_BUGS_TO);
1161 /* The current top level prompt, settable with "set prompt", and/or
1162 with the python `gdb.prompt_hook' hook. */
1163 static char *top_prompt;
1165 /* Access method for the GDB prompt string. */
1173 /* Set method for the GDB prompt string. */
1176 set_prompt (const char *s)
1178 char *p = xstrdup (s);
1191 /* Callback for iterate_over_inferiors. Kills or detaches the given
1192 inferior, depending on how we originally gained control of it. */
1195 kill_or_detach (struct inferior *inf, void *args)
1197 struct qt_args *qt = args;
1198 struct thread_info *thread;
1203 thread = any_thread_of_process (inf->pid);
1206 switch_to_thread (thread->ptid);
1208 /* Leave core files alone. */
1209 if (target_has_execution)
1211 if (inf->attach_flag)
1212 target_detach (qt->args, qt->from_tty);
1221 /* Callback for iterate_over_inferiors. Prints info about what GDB
1222 will do to each inferior on a "quit". ARG points to a struct
1223 ui_out where output is to be collected. */
1226 print_inferior_quit_action (struct inferior *inf, void *arg)
1228 struct ui_file *stb = arg;
1233 if (inf->attach_flag)
1234 fprintf_filtered (stb,
1235 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1236 target_pid_to_str (pid_to_ptid (inf->pid)));
1238 fprintf_filtered (stb,
1239 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1240 target_pid_to_str (pid_to_ptid (inf->pid)));
1245 /* If necessary, make the user confirm that we should quit. Return
1246 non-zero if we should quit, zero if we shouldn't. */
1251 struct ui_file *stb;
1252 struct cleanup *old_chain;
1256 /* Don't even ask if we're only debugging a core file inferior. */
1257 if (!have_live_inferiors ())
1260 /* Build the query string as a single string. */
1261 stb = mem_fileopen ();
1262 old_chain = make_cleanup_ui_file_delete (stb);
1264 /* This is something of a hack. But there's no reliable way to see
1265 if a GUI is running. The `use_windows' variable doesn't cut
1267 if (deprecated_init_ui_hook)
1268 fprintf_filtered (stb, _("A debugging session is active.\n"
1269 "Do you still want to close the debugger?"));
1272 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1273 iterate_over_inferiors (print_inferior_quit_action, stb);
1274 fprintf_filtered (stb, _("\nQuit anyway? "));
1277 str = ui_file_xstrdup (stb, NULL);
1278 make_cleanup (xfree, str);
1280 qr = query ("%s", str);
1281 do_cleanups (old_chain);
1285 /* Helper routine for quit_force that requires error handling. */
1288 quit_target (void *arg)
1290 struct qt_args *qt = (struct qt_args *)arg;
1292 /* Kill or detach all inferiors. */
1293 iterate_over_inferiors (kill_or_detach, qt);
1295 /* Give all pushed targets a chance to do minimal cleanup, and pop
1297 pop_all_targets (1);
1299 /* Save the history information if it is appropriate to do so. */
1300 if (write_history_p && history_filename)
1301 write_history (history_filename);
1303 do_final_cleanups (all_cleanups ()); /* Do any final cleanups before
1308 /* Quit without asking for confirmation. */
1311 quit_force (char *args, int from_tty)
1316 /* An optional expression may be used to cause gdb to terminate with the
1317 value of that expression. */
1320 struct value *val = parse_and_eval (args);
1322 exit_code = (int) value_as_long (val);
1324 else if (return_child_result)
1325 exit_code = return_child_result_value;
1328 qt.from_tty = from_tty;
1330 /* We want to handle any quit errors and exit regardless. */
1331 catch_errors (quit_target, &qt,
1332 "Quitting: ", RETURN_MASK_ALL);
1337 /* Returns whether GDB is running on a terminal and input is
1338 currently coming from that terminal. */
1341 input_from_terminal_p (void)
1346 if (gdb_has_a_terminal () && instream == stdin)
1349 /* If INSTREAM is unset, and we are not in a user command, we
1350 must be in Insight. That's like having a terminal, for our
1352 if (instream == NULL && !in_user_command)
1359 dont_repeat_command (char *ignored, int from_tty)
1361 /* Can't call dont_repeat here because we're not necessarily reading
1363 *saved_command_line = 0;
1366 /* Functions to manipulate command line editing control variables. */
1368 /* Number of commands to print in each call to show_commands. */
1369 #define Hist_print 10
1371 show_commands (char *args, int from_tty)
1373 /* Index for history commands. Relative to history_base. */
1376 /* Number of the history entry which we are planning to display next.
1377 Relative to history_base. */
1380 /* The first command in the history which doesn't exist (i.e. one more
1381 than the number of the last command). Relative to history_base. */
1382 unsigned int hist_len;
1384 /* Print out some of the commands from the command history. */
1385 /* First determine the length of the history list. */
1386 hist_len = history_size;
1387 for (offset = 0; offset < history_size; offset++)
1389 if (!history_get (history_base + offset))
1398 if (args[0] == '+' && args[1] == '\0')
1399 /* "info editing +" should print from the stored position. */
1402 /* "info editing <exp>" should print around command number <exp>. */
1403 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1405 /* "show commands" means print the last Hist_print commands. */
1408 num = hist_len - Hist_print;
1414 /* If there are at least Hist_print commands, we want to display the last
1415 Hist_print rather than, say, the last 6. */
1416 if (hist_len - num < Hist_print)
1418 num = hist_len - Hist_print;
1423 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1425 printf_filtered ("%5d %s\n", history_base + offset,
1426 (history_get (history_base + offset))->line);
1429 /* The next command we want to display is the next one that we haven't
1433 /* If the user repeats this command with return, it should do what
1434 "show commands +" does. This is unnecessary if arg is null,
1435 because "show commands +" is not useful after "show commands". */
1436 if (from_tty && args)
1443 /* Called by do_setshow_command. */
1445 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1447 /* The type of parameter in stifle_history is int, so values from INT_MAX up
1448 mean 'unlimited'. */
1449 if (history_size >= INT_MAX)
1451 /* Ensure that 'show history size' prints 'unlimited'. */
1452 history_size = UINT_MAX;
1453 unstifle_history ();
1456 stifle_history (history_size);
1460 set_history (char *args, int from_tty)
1462 printf_unfiltered (_("\"set history\" must be followed "
1463 "by the name of a history subcommand.\n"));
1464 help_list (sethistlist, "set history ", -1, gdb_stdout);
1468 show_history (char *args, int from_tty)
1470 cmd_show_list (showhistlist, from_tty, "");
1473 int info_verbose = 0; /* Default verbose msgs off. */
1475 /* Called by do_setshow_command. An elaborate joke. */
1477 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1479 char *cmdname = "verbose";
1480 struct cmd_list_element *showcmd;
1482 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1483 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1487 c->doc = "Set verbose printing of informational messages.";
1488 showcmd->doc = "Show verbose printing of informational messages.";
1492 c->doc = "Set verbosity.";
1493 showcmd->doc = "Show verbosity.";
1497 /* Init the history buffer. Note that we are called after the init file(s)
1498 have been read so that the user can change the history file via his
1499 .gdbinit file (for instance). The GDBHISTFILE environment variable
1500 overrides all of this. */
1507 tmpenv = getenv ("HISTSIZE");
1509 history_size = atoi (tmpenv);
1510 else if (!history_size)
1513 stifle_history (history_size);
1515 tmpenv = getenv ("GDBHISTFILE");
1517 history_filename = xstrdup (tmpenv);
1518 else if (!history_filename)
1520 /* We include the current directory so that if the user changes
1521 directories the file written will be the same as the one
1524 /* No leading dots in file names are allowed on MSDOS. */
1525 history_filename = concat (current_directory, "/_gdb_history",
1528 history_filename = concat (current_directory, "/.gdb_history",
1532 read_history (history_filename);
1536 show_prompt (struct ui_file *file, int from_tty,
1537 struct cmd_list_element *c, const char *value)
1539 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1543 show_async_command_editing_p (struct ui_file *file, int from_tty,
1544 struct cmd_list_element *c, const char *value)
1546 fprintf_filtered (file, _("Editing of command lines as "
1547 "they are typed is %s.\n"),
1552 show_annotation_level (struct ui_file *file, int from_tty,
1553 struct cmd_list_element *c, const char *value)
1555 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1559 show_exec_done_display_p (struct ui_file *file, int from_tty,
1560 struct cmd_list_element *c, const char *value)
1562 fprintf_filtered (file, _("Notification of completion for "
1563 "asynchronous execution commands is %s.\n"),
1567 /* "set" command for the gdb_datadir configuration variable. */
1570 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1572 observer_notify_gdb_datadir_changed ();
1578 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1579 the DEFAULT_PROMPT is. */
1580 set_prompt (DEFAULT_PROMPT);
1582 /* Set things up for annotation_level > 1, if the user ever decides
1584 async_annotation_suffix = "prompt";
1586 /* Set the important stuff up for command editing. */
1587 command_editing_p = 1;
1588 history_expansion_p = 0;
1589 write_history_p = 0;
1591 /* Setup important stuff for command line editing. */
1592 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1593 rl_completion_entry_function = readline_line_completion_function;
1594 rl_completer_word_break_characters = default_word_break_characters ();
1595 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1596 rl_readline_name = "gdb";
1597 rl_terminal_name = getenv ("TERM");
1599 /* The name for this defun comes from Bash, where it originated.
1600 15 is Control-o, the same binding this function has in Bash. */
1601 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1603 add_setshow_string_cmd ("prompt", class_support,
1605 _("Set gdb's prompt"),
1606 _("Show gdb's prompt"),
1609 &setlist, &showlist);
1611 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1612 Don't repeat this command.\nPrimarily \
1613 used inside of user-defined commands that should not be repeated when\n\
1616 add_setshow_boolean_cmd ("editing", class_support,
1617 &async_command_editing_p, _("\
1618 Set editing of command lines as they are typed."), _("\
1619 Show editing of command lines as they are typed."), _("\
1620 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1621 Without an argument, command line editing is enabled. To edit, use\n\
1622 EMACS-like or VI-like commands like control-P or ESC."),
1623 set_async_editing_command,
1624 show_async_command_editing_p,
1625 &setlist, &showlist);
1627 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1628 Set saving of the history record on exit."), _("\
1629 Show saving of the history record on exit."), _("\
1630 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1631 Without an argument, saving is enabled."),
1633 show_write_history_p,
1634 &sethistlist, &showhistlist);
1636 add_setshow_uinteger_cmd ("size", no_class, &history_size, _("\
1637 Set the size of the command history,"), _("\
1638 Show the size of the command history,"), _("\
1639 ie. the number of previous commands to keep a record of."),
1640 set_history_size_command,
1642 &sethistlist, &showhistlist);
1644 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1645 Set the filename in which to record the command history"), _("\
1646 Show the filename in which to record the command history"), _("\
1647 (the list of previous commands of which a record is kept)."),
1649 show_history_filename,
1650 &sethistlist, &showhistlist);
1652 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
1653 Set whether to confirm potentially dangerous operations."), _("\
1654 Show whether to confirm potentially dangerous operations."), NULL,
1657 &setlist, &showlist);
1659 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1660 Set annotation_level."), _("\
1661 Show annotation_level."), _("\
1662 0 == normal; 1 == fullname (for use when running under emacs)\n\
1663 2 == output annotated suitably for use by programs that control GDB."),
1665 show_annotation_level,
1666 &setlist, &showlist);
1668 add_setshow_boolean_cmd ("exec-done-display", class_support,
1669 &exec_done_display_p, _("\
1670 Set notification of completion for asynchronous execution commands."), _("\
1671 Show notification of completion for asynchronous execution commands."), _("\
1672 Use \"on\" to enable the notification, and \"off\" to disable it."),
1674 show_exec_done_display_p,
1675 &setlist, &showlist);
1677 add_setshow_filename_cmd ("data-directory", class_maintenance,
1678 &gdb_datadir, _("Set GDB's data directory."),
1679 _("Show GDB's data directory."),
1681 When set, GDB uses the specified path to search for data files."),
1682 set_gdb_datadir, NULL,
1688 gdb_init (char *argv0)
1690 if (pre_init_ui_hook)
1691 pre_init_ui_hook ();
1693 /* Run the init function of each source file. */
1696 /* Make sure we return to the original directory upon exit, come
1697 what may, since the OS doesn't do that for us. */
1698 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1701 init_cmd_lists (); /* This needs to be done first. */
1702 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1703 initialize_utils (); /* Make errors and warnings possible. */
1705 /* Here is where we call all the _initialize_foo routines. */
1706 initialize_all_files ();
1708 /* This creates the current_program_space. Do this after all the
1709 _initialize_foo routines have had a chance to install their
1710 per-sspace data keys. Also do this before
1711 initialize_current_architecture is called, because it accesses
1712 exec_bfd of the current program space. */
1713 initialize_progspace ();
1714 initialize_inferiors ();
1715 initialize_current_architecture ();
1717 init_main (); /* But that omits this file! Do it now. */
1719 initialize_stdin_serial ();
1721 async_init_signals ();
1723 /* We need a default language for parsing expressions, so simple
1724 things like "set width 0" won't fail if no language is explicitly
1725 set in a config file or implicitly set by reading an executable
1727 set_language (language_c);
1728 expected_language = current_language; /* Don't warn about the change. */
1730 /* Allow another UI to initialize. If the UI fails to initialize,
1731 and it wants GDB to revert to the CLI, it should clear
1732 deprecated_init_ui_hook. */
1733 if (deprecated_init_ui_hook)
1734 deprecated_init_ui_hook (argv0);
1737 /* Python initialization can require various commands to be
1738 installed. For example "info pretty-printer" needs the "info"
1739 prefix to be installed. Keep things simple and just do final
1740 python initialization here. */
1741 finish_python_initialization ();