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"
51 /* readline include files. */
52 #include "readline/readline.h"
53 #include "readline/history.h"
55 /* readline defines this. */
58 #include <sys/types.h>
60 #include "event-top.h"
61 #include "gdb_string.h"
67 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
68 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
69 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
71 /* Default command line prompt. This is overriden in some configs. */
73 #ifndef DEFAULT_PROMPT
74 #define DEFAULT_PROMPT "(gdb) "
77 /* Initialization file name for gdb. This is overridden in some configs. */
81 # define PATH_MAX FILENAME_MAX
87 #ifndef GDBINIT_FILENAME
88 #define GDBINIT_FILENAME ".gdbinit"
90 char gdbinit[PATH_MAX + 1] = GDBINIT_FILENAME;
92 int inhibit_gdbinit = 0;
94 /* If nonzero, and GDB has been configured to be able to use windows,
95 attempt to open them upon startup. */
99 extern char lang_frame_mismatch_warn[]; /* language.c */
101 /* Flag for whether we want all the "from_tty" gubbish printed. */
103 int caution = 1; /* Default is yes, sigh. */
105 show_caution (struct ui_file *file, int from_tty,
106 struct cmd_list_element *c, const char *value)
108 fprintf_filtered (file, _("Whether to confirm potentially "
109 "dangerous operations is %s.\n"),
113 /* stdio stream that command input is being read from. Set to stdin
114 normally. Set by source_command to the file we are sourcing. Set
115 to NULL if we are executing a user-defined command or interacting
120 /* Flag to indicate whether a user defined command is currently running. */
124 /* Current working directory. */
126 char *current_directory;
128 /* The directory name is actually stored here (usually). */
129 char gdb_dirbuf[1024];
131 /* Function to call before reading a command, if nonzero.
132 The function receives two args: an input stream,
133 and a prompt string. */
135 void (*window_hook) (FILE *, char *);
140 /* Buffer used for reading command lines, and the size
141 allocated for it so far. */
143 char *saved_command_line;
144 int saved_command_line_size = 100;
146 /* Nonzero if the current command is modified by "server ". This
147 affects things like recording into the command history, commands
148 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
149 whatever) can issue its own commands and also send along commands
150 from the user, and have the user not notice that the user interface
151 is issuing commands too. */
154 /* Baud rate specified for talking to serial target systems. Default
155 is left as -1, so targets can choose their own defaults. */
156 /* FIXME: This means that "show remotebaud" and gr_files_info can
157 print -1 or (unsigned int)-1. This is a Bad User Interface. */
161 /* Timeout limit for response from target. */
163 /* The default value has been changed many times over the years. It
164 was originally 5 seconds. But that was thought to be a long time
165 to sit and wait, so it was changed to 2 seconds. That was thought
166 to be plenty unless the connection was going through some terminal
167 server or multiplexer or other form of hairy serial connection.
169 In mid-1996, remote_timeout was moved from remote.c to top.c and
170 it began being used in other remote-* targets. It appears that the
171 default was changed to 20 seconds at that time, perhaps because the
172 Renesas E7000 ICE didn't always respond in a timely manner.
174 But if 5 seconds is a long time to sit and wait for retransmissions,
175 20 seconds is far worse. This demonstrates the difficulty of using
176 a single variable for all protocol timeouts.
178 As remote.c is used much more than remote-e7000.c, it was changed
179 back to 2 seconds in 1999. */
181 int remote_timeout = 2;
183 /* Non-zero tells remote* modules to output debugging info. */
185 int remote_debug = 0;
187 /* Sbrk location on entry to main. Used for statistics only. */
192 /* Hooks for alternate command interfaces. */
194 /* Called after most modules have been initialized, but before taking
197 If the UI fails to initialize and it wants GDB to continue using
198 the default UI, then it should clear this hook before returning. */
200 void (*deprecated_init_ui_hook) (char *argv0);
202 /* This hook is called from within gdb's many mini-event loops which
203 could steal control from a real user interface's event loop. It
204 returns non-zero if the user is requesting a detach, zero
207 int (*deprecated_ui_loop_hook) (int);
209 /* Called instead of command_loop at top level. Can be invoked via
210 throw_exception(). */
212 void (*deprecated_command_loop_hook) (void);
215 /* Called from print_frame_info to list the line we stopped in. */
217 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
221 /* Replaces most of query. */
223 int (*deprecated_query_hook) (const char *, va_list);
225 /* Replaces most of warning. */
227 void (*deprecated_warning_hook) (const char *, va_list);
229 /* These three functions support getting lines of text from the user.
230 They are used in sequence. First deprecated_readline_begin_hook is
231 called with a text string that might be (for example) a message for
232 the user to type in a sequence of commands to be executed at a
233 breakpoint. If this function calls back to a GUI, it might take
234 this opportunity to pop up a text interaction window with this
235 message. Next, deprecated_readline_hook is called with a prompt
236 that is emitted prior to collecting the user input. It can be
237 called multiple times. Finally, deprecated_readline_end_hook is
238 called to notify the GUI that we are done with the interaction
239 window and it can close it. */
241 void (*deprecated_readline_begin_hook) (char *, ...);
242 char *(*deprecated_readline_hook) (char *);
243 void (*deprecated_readline_end_hook) (void);
245 /* Called as appropriate to notify the interface that we have attached
246 to or detached from an already running process. */
248 void (*deprecated_attach_hook) (void);
249 void (*deprecated_detach_hook) (void);
251 /* Called during long calculations to allow GUI to repair window
252 damage, and to check for stop buttons, etc... */
254 void (*deprecated_interactive_hook) (void);
256 /* Tell the GUI someone changed the register REGNO. -1 means
257 that the caller does not know which register changed or
258 that several registers have changed (see value_assign). */
259 void (*deprecated_register_changed_hook) (int regno);
261 /* Called when going to wait for the target. Usually allows the GUI
262 to run while waiting for target events. */
264 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
265 struct target_waitstatus *status,
268 /* Used by UI as a wrapper around command execution. May do various
269 things like enabling/disabling buttons, etc... */
271 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
272 char *cmd, int from_tty);
274 /* Called after a `set' command has finished. Is only run if the
275 `set' command succeeded. */
277 void (*deprecated_set_hook) (struct cmd_list_element * c);
279 /* Called when the current thread changes. Argument is thread id. */
281 void (*deprecated_context_hook) (int id);
283 /* Handler for SIGHUP. */
286 /* NOTE 1999-04-29: This function will be static again, once we modify
287 gdb to use the event loop as the default command loop and we merge
288 event-top.c into this file, top.c. */
292 caution = 0; /* Throw caution to the wind -- we're exiting.
293 This prevents asking the user dumb
295 quit_command ((char *) 0, 0);
297 #endif /* defined SIGHUP */
299 /* Line number we are currently in, in a file which is being sourced. */
300 /* NOTE 1999-04-29: This variable will be static again, once we modify
301 gdb to use the event loop as the default command loop and we merge
302 event-top.c into this file, top.c. */
303 /* static */ int source_line_number;
305 /* Name of the file we are sourcing. */
306 /* NOTE 1999-04-29: This variable will be static again, once we modify
307 gdb to use the event loop as the default command loop and we merge
308 event-top.c into this file, top.c. */
309 /* static */ const char *source_file_name;
311 /* Clean up on error during a "source" command (or execution of a
312 user-defined command). */
315 do_restore_instream_cleanup (void *stream)
317 /* Restore the previous input stream. */
321 /* Read commands from STREAM. */
323 read_command_file (FILE *stream)
325 struct cleanup *cleanups;
327 cleanups = make_cleanup (do_restore_instream_cleanup, instream);
330 do_cleanups (cleanups);
333 void (*pre_init_ui_hook) (void);
337 do_chdir_cleanup (void *old_dir)
345 prepare_execute_command (void)
348 struct cleanup *cleanup;
350 mark = value_mark ();
351 cleanup = make_cleanup_value_free_to_mark (mark);
353 /* With multiple threads running while the one we're examining is
354 stopped, the dcache can get stale without us being able to detect
355 it. For the duration of the command, though, use the dcache to
356 help things like backtrace. */
358 target_dcache_invalidate ();
363 /* Execute the line P as a command, in the current user context.
364 Pass FROM_TTY as second argument to the defining function. */
367 execute_command (char *p, int from_tty)
369 struct cleanup *cleanup_if_error, *cleanup;
370 struct cmd_list_element *c;
372 static int warned = 0;
375 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
376 cleanup = prepare_execute_command ();
378 /* Force cleanup of any alloca areas if using C alloca instead of
382 /* This can happen when command_line_input hits end of file. */
385 do_cleanups (cleanup);
389 target_log_command (p);
391 while (*p == ' ' || *p == '\t')
398 /* If trace-commands is set then this will print this command. */
399 print_command_trace (p);
401 c = lookup_cmd (&p, cmdlist, "", 0, 1);
403 /* Pass null arg rather than an empty one. */
406 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
407 while the is_complete_command(cfunc) test is just plain
408 bogus. They should both be replaced by a test of the form
409 c->strip_trailing_white_space_p. */
410 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
411 can't be replaced with func. This is because it is the
412 cfunc, and not the func, that has the value that the
413 is_complete_command hack is testing for. */
414 /* Clear off trailing whitespace, except for set and complete
417 && c->type != set_cmd
418 && !is_complete_command (c))
420 p = arg + strlen (arg) - 1;
421 while (p >= arg && (*p == ' ' || *p == '\t'))
426 /* If this command has been pre-hooked, run the hook first. */
427 execute_cmd_pre_hook (c);
429 if (c->flags & DEPRECATED_WARN_USER)
430 deprecated_cmd_warning (&line);
432 if (c->class == class_user)
433 execute_user_command (c, arg);
434 else if (c->type == set_cmd || c->type == show_cmd)
435 do_setshow_command (arg, from_tty & caution, c);
436 else if (!cmd_func_p (c))
437 error (_("That is not a command, just a help topic."));
438 else if (deprecated_call_command_hook)
439 deprecated_call_command_hook (c, arg, from_tty & caution);
441 cmd_func (c, arg, from_tty & caution);
443 /* If the interpreter is in sync mode (we're running a user
444 command's list, running command hooks or similars), and we
445 just ran a synchronous command that started the target, wait
446 for that command to end. */
447 if (!interpreter_async && sync_execution)
449 while (gdb_do_one_event () >= 0)
454 /* If this command has been post-hooked, run the hook last. */
455 execute_cmd_post_hook (c);
459 /* Tell the user if the language has changed (except first time).
460 First make sure that a new frame has been selected, in case this
461 command or the hooks changed the program state. */
462 deprecated_safe_get_selected_frame ();
463 if (current_language != expected_language)
465 if (language_mode == language_mode_auto && info_verbose)
467 language_info (1); /* Print what changed. */
472 /* Warn the user if the working language does not match the
473 language of the current frame. Only warn the user if we are
474 actually running the program, i.e. there is a stack. */
475 /* FIXME: This should be cacheing the frame and only running when
476 the frame changes. */
478 if (has_stack_frames ())
480 flang = get_frame_language ();
482 && flang != language_unknown
483 && flang != current_language->la_language)
485 printf_filtered ("%s\n", lang_frame_mismatch_warn);
490 do_cleanups (cleanup);
491 discard_cleanups (cleanup_if_error);
494 /* Run execute_command for P and FROM_TTY. Capture its output into the
495 returned string, do not display it to the screen. BATCH_FLAG will be
496 temporarily set to true. */
499 execute_command_to_string (char *p, int from_tty)
501 struct ui_file *str_file;
502 struct cleanup *cleanup;
505 /* GDB_STDOUT should be better already restored during these
506 restoration callbacks. */
507 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
509 make_cleanup_restore_integer (&interpreter_async);
510 interpreter_async = 0;
512 str_file = mem_fileopen ();
514 make_cleanup_ui_file_delete (str_file);
515 make_cleanup_restore_ui_file (&gdb_stdout);
516 make_cleanup_restore_ui_file (&gdb_stderr);
517 make_cleanup_restore_ui_file (&gdb_stdlog);
518 make_cleanup_restore_ui_file (&gdb_stdtarg);
519 make_cleanup_restore_ui_file (&gdb_stdtargerr);
521 if (ui_out_redirect (current_uiout, str_file) < 0)
522 warning (_("Current output protocol does not support redirection"));
524 make_cleanup_ui_out_redirect_pop (current_uiout);
526 gdb_stdout = str_file;
527 gdb_stderr = str_file;
528 gdb_stdlog = str_file;
529 gdb_stdtarg = str_file;
530 gdb_stdtargerr = str_file;
532 execute_command (p, from_tty);
534 retval = ui_file_xstrdup (str_file, NULL);
536 do_cleanups (cleanup);
541 /* Read commands from `instream' and execute them
542 until end of file or error reading instream. */
547 struct cleanup *old_chain;
549 int stdin_is_tty = ISATTY (stdin);
551 while (instream && !feof (instream))
553 if (window_hook && instream == stdin)
554 (*window_hook) (instream, get_prompt ());
557 if (instream == stdin && stdin_is_tty)
558 reinitialize_more_filter ();
559 old_chain = make_cleanup (null_cleanup, 0);
561 /* Get a command-line. This calls the readline package. */
562 command = command_line_input (instream == stdin ?
563 get_prompt () : (char *) NULL,
564 instream == stdin, "prompt");
567 do_cleanups (old_chain);
571 make_command_stats_cleanup (1);
573 execute_command (command, instream == stdin);
575 /* Do any commands attached to breakpoint we are stopped at. */
576 bpstat_do_actions ();
578 do_cleanups (old_chain);
582 /* When nonzero, cause dont_repeat to do nothing. This should only be
583 set via prevent_dont_repeat. */
585 static int suppress_dont_repeat = 0;
587 /* Commands call this if they do not want to be repeated by null lines. */
592 if (suppress_dont_repeat || server_command)
595 /* If we aren't reading from standard input, we are saving the last
596 thing read from stdin in line and don't want to delete it. Null
597 lines won't repeat here in any case. */
598 if (instream == stdin)
599 *saved_command_line = 0;
602 /* Prevent dont_repeat from working, and return a cleanup that
603 restores the previous state. */
606 prevent_dont_repeat (void)
608 struct cleanup *result = make_cleanup_restore_integer (&suppress_dont_repeat);
610 suppress_dont_repeat = 1;
615 /* Read a line from the stream "instream" without command line editing.
617 It prints PROMPT_ARG once at the start.
618 Action is compatible with "readline", e.g. space for the result is
619 malloc'd and should be freed by the caller.
621 A NULL return means end of file. */
623 gdb_readline (char *prompt_arg)
628 int result_size = 80;
632 /* Don't use a _filtered function here. It causes the assumed
633 character position to be off, since the newline we read from
634 the user is not accounted for. */
635 fputs_unfiltered (prompt_arg, gdb_stdout);
636 gdb_flush (gdb_stdout);
639 result = (char *) xmalloc (result_size);
643 /* Read from stdin if we are executing a user defined command.
644 This is the right thing for prompt_for_continue, at least. */
645 c = fgetc (instream ? instream : stdin);
650 /* The last line does not end with a newline. Return it, and
651 if we are called again fgetc will still return EOF and
652 we'll return NULL then. */
660 if (input_index > 0 && result[input_index - 1] == '\r')
665 result[input_index++] = c;
666 while (input_index >= result_size)
669 result = (char *) xrealloc (result, result_size);
673 result[input_index++] = '\0';
677 /* Variables which control command line editing and history
678 substitution. These variables are given default values at the end
680 static int command_editing_p;
682 /* NOTE 1999-04-29: This variable will be static again, once we modify
683 gdb to use the event loop as the default command loop and we merge
684 event-top.c into this file, top.c. */
686 /* static */ int history_expansion_p;
688 static int write_history_p;
690 show_write_history_p (struct ui_file *file, int from_tty,
691 struct cmd_list_element *c, const char *value)
693 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
697 static int history_size;
699 show_history_size (struct ui_file *file, int from_tty,
700 struct cmd_list_element *c, const char *value)
702 fprintf_filtered (file, _("The size of the command history is %s.\n"),
706 static char *history_filename;
708 show_history_filename (struct ui_file *file, int from_tty,
709 struct cmd_list_element *c, const char *value)
711 fprintf_filtered (file, _("The filename in which to record "
712 "the command history is \"%s\".\n"),
716 /* This is like readline(), but it has some gdb-specific behavior.
717 gdb may want readline in both the synchronous and async modes during
718 a single gdb invocation. At the ordinary top-level prompt we might
719 be using the async readline. That means we can't use
720 rl_pre_input_hook, since it doesn't work properly in async mode.
721 However, for a secondary prompt (" >", such as occurs during a
722 `define'), gdb wants a synchronous response.
724 We used to call readline() directly, running it in synchronous
725 mode. But mixing modes this way is not supported, and as of
726 readline 5.x it no longer works; the arrow keys come unbound during
727 the synchronous call. So we make a nested call into the event
728 loop. That's what gdb_readline_wrapper is for. */
730 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
731 rely on gdb_readline_wrapper_result, which might still be NULL if
732 the user types Control-D for EOF. */
733 static int gdb_readline_wrapper_done;
735 /* The result of the current call to gdb_readline_wrapper, once a newline
737 static char *gdb_readline_wrapper_result;
739 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
740 to be called after the newline is processed (which will redisplay
741 the prompt). But in gdb_readline_wrapper we will not get a new
742 prompt until the next call, or until we return to the event loop.
743 So we disable this hook around the newline and restore it before we
745 static void (*saved_after_char_processing_hook) (void);
747 /* This function is called when readline has seen a complete line of
751 gdb_readline_wrapper_line (char *line)
753 gdb_assert (!gdb_readline_wrapper_done);
754 gdb_readline_wrapper_result = line;
755 gdb_readline_wrapper_done = 1;
757 /* Prevent operate-and-get-next from acting too early. */
758 saved_after_char_processing_hook = after_char_processing_hook;
759 after_char_processing_hook = NULL;
761 /* Prevent parts of the prompt from being redisplayed if annotations
762 are enabled, and readline's state getting out of sync. */
763 if (async_command_editing_p)
764 rl_callback_handler_remove ();
767 struct gdb_readline_wrapper_cleanup
769 void (*handler_orig) (char *);
770 int already_prompted_orig;
774 gdb_readline_wrapper_cleanup (void *arg)
776 struct gdb_readline_wrapper_cleanup *cleanup = arg;
778 rl_already_prompted = cleanup->already_prompted_orig;
780 gdb_assert (input_handler == gdb_readline_wrapper_line);
781 input_handler = cleanup->handler_orig;
782 gdb_readline_wrapper_result = NULL;
783 gdb_readline_wrapper_done = 0;
785 after_char_processing_hook = saved_after_char_processing_hook;
786 saved_after_char_processing_hook = NULL;
792 gdb_readline_wrapper (char *prompt)
794 struct cleanup *back_to;
795 struct gdb_readline_wrapper_cleanup *cleanup;
798 cleanup = xmalloc (sizeof (*cleanup));
799 cleanup->handler_orig = input_handler;
800 input_handler = gdb_readline_wrapper_line;
802 cleanup->already_prompted_orig = rl_already_prompted;
804 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
806 /* Display our prompt and prevent double prompt display. */
807 display_gdb_prompt (prompt);
808 rl_already_prompted = 1;
810 if (after_char_processing_hook)
811 (*after_char_processing_hook) ();
812 gdb_assert (after_char_processing_hook == NULL);
814 while (gdb_do_one_event () >= 0)
815 if (gdb_readline_wrapper_done)
818 retval = gdb_readline_wrapper_result;
819 do_cleanups (back_to);
824 /* The current saved history number from operate-and-get-next.
825 This is -1 if not valid. */
826 static int operate_saved_history = -1;
828 /* This is put on the appropriate hook and helps operate-and-get-next
831 gdb_rl_operate_and_get_next_completion (void)
833 int delta = where_history () - operate_saved_history;
835 /* The `key' argument to rl_get_previous_history is ignored. */
836 rl_get_previous_history (delta, 0);
837 operate_saved_history = -1;
839 /* readline doesn't automatically update the display for us. */
842 after_char_processing_hook = NULL;
843 rl_pre_input_hook = NULL;
846 /* This is a gdb-local readline command handler. It accepts the
847 current command line (like RET does) and, if this command was taken
848 from the history, arranges for the next command in the history to
849 appear on the command line when the prompt returns.
850 We ignore the arguments. */
852 gdb_rl_operate_and_get_next (int count, int key)
856 /* Use the async hook. */
857 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
859 /* Find the current line, and find the next line to use. */
860 where = where_history();
862 /* FIXME: kettenis/20020817: max_input_history is renamed into
863 history_max_entries in readline-4.2. When we do a new readline
864 import, we should probably change it here too, even though
865 readline maintains backwards compatibility for now by still
866 defining max_input_history. */
867 if ((history_is_stifled () && (history_length >= max_input_history)) ||
868 (where >= history_length - 1))
869 operate_saved_history = where;
871 operate_saved_history = where + 1;
873 return rl_newline (1, key);
876 /* Read one line from the command input stream `instream'
877 into the local static buffer `linebuffer' (whose current length
879 The buffer is made bigger as necessary.
880 Returns the address of the start of the line.
882 NULL is returned for end of file.
884 *If* the instream == stdin & stdin is a terminal, the line read
885 is copied into the file line saver (global var char *line,
886 length linesize) so that it can be duplicated.
888 This routine either uses fancy command line editing or
889 simple input as the user has requested. */
892 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
894 static char *linebuffer = 0;
895 static unsigned linelength = 0;
899 char *local_prompt = prompt_arg;
903 /* The annotation suffix must be non-NULL. */
904 if (annotation_suffix == NULL)
905 annotation_suffix = "";
907 if (annotation_level > 1 && instream == stdin)
909 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
910 + strlen (annotation_suffix) + 40);
911 if (prompt_arg == NULL)
912 local_prompt[0] = '\0';
914 strcpy (local_prompt, prompt_arg);
915 strcat (local_prompt, "\n\032\032");
916 strcat (local_prompt, annotation_suffix);
917 strcat (local_prompt, "\n");
923 linebuffer = (char *) xmalloc (linelength);
928 /* Control-C quits instantly if typed while in this loop
929 since it should not wait until the user types a newline. */
933 signal (STOP_SIGNAL, handle_stop_sig);
938 /* Make sure that all output has been output. Some machines may
939 let you get away with leaving out some of the gdb_flush, but
942 gdb_flush (gdb_stdout);
943 gdb_flush (gdb_stderr);
945 if (source_file_name != NULL)
946 ++source_line_number;
948 if (annotation_level > 1 && instream == stdin)
950 puts_unfiltered ("\n\032\032pre-");
951 puts_unfiltered (annotation_suffix);
952 puts_unfiltered ("\n");
955 /* Don't use fancy stuff if not talking to stdin. */
956 if (deprecated_readline_hook && input_from_terminal_p ())
958 rl = (*deprecated_readline_hook) (local_prompt);
960 else if (command_editing_p && input_from_terminal_p ())
962 rl = gdb_readline_wrapper (local_prompt);
966 rl = gdb_readline (local_prompt);
969 if (annotation_level > 1 && instream == stdin)
971 puts_unfiltered ("\n\032\032post-");
972 puts_unfiltered (annotation_suffix);
973 puts_unfiltered ("\n");
976 if (!rl || rl == (char *) EOF)
981 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
983 linelength = strlen (rl) + 1 + (p - linebuffer);
984 nline = (char *) xrealloc (linebuffer, linelength);
985 p += nline - linebuffer;
989 /* Copy line. Don't copy null at end. (Leaves line alone
990 if this was just a newline). */
994 xfree (rl); /* Allocated in readline. */
996 if (p == linebuffer || *(p - 1) != '\\')
999 p--; /* Put on top of '\'. */
1000 local_prompt = (char *) 0;
1005 signal (STOP_SIGNAL, SIG_DFL);
1012 #define SERVER_COMMAND_LENGTH 7
1014 (p - linebuffer > SERVER_COMMAND_LENGTH)
1015 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1018 /* Note that we don't set `line'. Between this and the check in
1019 dont_repeat, this insures that repeating will still do the
1022 return linebuffer + SERVER_COMMAND_LENGTH;
1025 /* Do history expansion if that is wished. */
1026 if (history_expansion_p && instream == stdin
1027 && ISATTY (instream))
1029 char *history_value;
1032 *p = '\0'; /* Insert null now. */
1033 expanded = history_expand (linebuffer, &history_value);
1036 /* Print the changes. */
1037 printf_unfiltered ("%s\n", history_value);
1039 /* If there was an error, call this function again. */
1042 xfree (history_value);
1043 return command_line_input (prompt_arg, repeat,
1046 if (strlen (history_value) > linelength)
1048 linelength = strlen (history_value) + 1;
1049 linebuffer = (char *) xrealloc (linebuffer, linelength);
1051 strcpy (linebuffer, history_value);
1052 p = linebuffer + strlen (linebuffer);
1054 xfree (history_value);
1057 /* If we just got an empty line, and that is supposed to repeat the
1058 previous command, return the value in the global buffer. */
1059 if (repeat && p == linebuffer)
1060 return saved_command_line;
1061 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1063 return saved_command_line;
1067 /* Add line to history if appropriate. */
1068 if (instream == stdin
1069 && ISATTY (stdin) && *linebuffer)
1070 add_history (linebuffer);
1072 /* Note: lines consisting solely of comments are added to the command
1073 history. This is useful when you type a command, and then
1074 realize you don't want to execute it quite yet. You can comment
1075 out the command and then later fetch it from the value history
1076 and remove the '#'. The kill ring is probably better, but some
1077 people are in the habit of commenting things out. */
1079 *p1 = '\0'; /* Found a comment. */
1081 /* Save into global buffer if appropriate. */
1084 if (linelength > saved_command_line_size)
1086 saved_command_line = xrealloc (saved_command_line, linelength);
1087 saved_command_line_size = linelength;
1089 strcpy (saved_command_line, linebuffer);
1090 return saved_command_line;
1096 /* Print the GDB banner. */
1098 print_gdb_version (struct ui_file *stream)
1100 /* From GNU coding standards, first line is meant to be easy for a
1101 program to parse, and is just canonical program name and version
1102 number, which starts after last space. */
1104 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1106 /* Second line is a copyright notice. */
1108 fprintf_filtered (stream,
1109 "Copyright (C) 2012 Free Software Foundation, Inc.\n");
1111 /* Following the copyright is a brief statement that the program is
1112 free software, that users are free to copy and change it on
1113 certain conditions, that it is covered by the GNU GPL, and that
1114 there is no warranty. */
1116 fprintf_filtered (stream, "\
1117 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1118 \nThis is free software: you are free to change and redistribute it.\n\
1119 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1120 and \"show warranty\" for details.\n");
1122 /* After the required info we print the configuration information. */
1124 fprintf_filtered (stream, "This GDB was configured as \"");
1125 if (strcmp (host_name, target_name) != 0)
1127 fprintf_filtered (stream, "--host=%s --target=%s",
1128 host_name, target_name);
1132 fprintf_filtered (stream, "%s", host_name);
1134 fprintf_filtered (stream, "\".");
1136 if (REPORT_BUGS_TO[0])
1138 fprintf_filtered (stream,
1139 _("\nFor bug reporting instructions, please see:\n"));
1140 fprintf_filtered (stream, "%s.", REPORT_BUGS_TO);
1145 /* The current top level prompt, settable with "set prompt", and/or
1146 with the python `gdb.prompt_hook' hook. */
1147 static char *top_prompt;
1149 /* Access method for the GDB prompt string. */
1157 /* Set method for the GDB prompt string. */
1160 set_prompt (const char *s)
1162 char *p = xstrdup (s);
1175 /* Callback for iterate_over_inferiors. Kills or detaches the given
1176 inferior, depending on how we originally gained control of it. */
1179 kill_or_detach (struct inferior *inf, void *args)
1181 struct qt_args *qt = args;
1182 struct thread_info *thread;
1184 if (inf->pid == FAKE_PROCESS_ID)
1187 thread = any_thread_of_process (inf->pid);
1190 switch_to_thread (thread->ptid);
1192 /* Leave core files alone. */
1193 if (target_has_execution)
1195 if (inf->attach_flag)
1196 target_detach (qt->args, qt->from_tty);
1205 /* Callback for iterate_over_inferiors. Prints info about what GDB
1206 will do to each inferior on a "quit". ARG points to a struct
1207 ui_out where output is to be collected. */
1210 print_inferior_quit_action (struct inferior *inf, void *arg)
1212 struct ui_file *stb = arg;
1214 if (inf->pid == FAKE_PROCESS_ID)
1217 if (inf->attach_flag)
1218 fprintf_filtered (stb,
1219 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1220 target_pid_to_str (pid_to_ptid (inf->pid)));
1222 fprintf_filtered (stb,
1223 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1224 target_pid_to_str (pid_to_ptid (inf->pid)));
1229 /* If necessary, make the user confirm that we should quit. Return
1230 non-zero if we should quit, zero if we shouldn't. */
1235 struct ui_file *stb;
1236 struct cleanup *old_chain;
1240 /* Don't even ask if we're only debugging a core file inferior. */
1241 if (!have_live_inferiors ())
1244 /* Build the query string as a single string. */
1245 stb = mem_fileopen ();
1246 old_chain = make_cleanup_ui_file_delete (stb);
1248 /* This is something of a hack. But there's no reliable way to see
1249 if a GUI is running. The `use_windows' variable doesn't cut
1251 if (deprecated_init_ui_hook)
1252 fprintf_filtered (stb, _("A debugging session is active.\n"
1253 "Do you still want to close the debugger?"));
1256 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1257 iterate_over_inferiors (print_inferior_quit_action, stb);
1258 fprintf_filtered (stb, _("\nQuit anyway? "));
1261 str = ui_file_xstrdup (stb, NULL);
1262 make_cleanup (xfree, str);
1264 qr = query ("%s", str);
1265 do_cleanups (old_chain);
1269 /* Helper routine for quit_force that requires error handling. */
1272 quit_target (void *arg)
1274 struct qt_args *qt = (struct qt_args *)arg;
1276 /* Kill or detach all inferiors. */
1277 iterate_over_inferiors (kill_or_detach, qt);
1279 /* Give all pushed targets a chance to do minimal cleanup, and pop
1281 pop_all_targets (1);
1283 /* Save the history information if it is appropriate to do so. */
1284 if (write_history_p && history_filename)
1285 write_history (history_filename);
1287 do_final_cleanups (ALL_CLEANUPS); /* Do any final cleanups before
1292 /* Quit without asking for confirmation. */
1295 quit_force (char *args, int from_tty)
1300 /* An optional expression may be used to cause gdb to terminate with the
1301 value of that expression. */
1304 struct value *val = parse_and_eval (args);
1306 exit_code = (int) value_as_long (val);
1308 else if (return_child_result)
1309 exit_code = return_child_result_value;
1312 qt.from_tty = from_tty;
1314 /* We want to handle any quit errors and exit regardless. */
1315 catch_errors (quit_target, &qt,
1316 "Quitting: ", RETURN_MASK_ALL);
1321 /* Returns whether GDB is running on a terminal and input is
1322 currently coming from that terminal. */
1325 input_from_terminal_p (void)
1330 if (gdb_has_a_terminal () && instream == stdin)
1333 /* If INSTREAM is unset, and we are not in a user command, we
1334 must be in Insight. That's like having a terminal, for our
1336 if (instream == NULL && !in_user_command)
1343 dont_repeat_command (char *ignored, int from_tty)
1345 /* Can't call dont_repeat here because we're not necessarily reading
1347 *saved_command_line = 0;
1350 /* Functions to manipulate command line editing control variables. */
1352 /* Number of commands to print in each call to show_commands. */
1353 #define Hist_print 10
1355 show_commands (char *args, int from_tty)
1357 /* Index for history commands. Relative to history_base. */
1360 /* Number of the history entry which we are planning to display next.
1361 Relative to history_base. */
1364 /* The first command in the history which doesn't exist (i.e. one more
1365 than the number of the last command). Relative to history_base. */
1368 /* Print out some of the commands from the command history. */
1369 /* First determine the length of the history list. */
1370 hist_len = history_size;
1371 for (offset = 0; offset < history_size; offset++)
1373 if (!history_get (history_base + offset))
1382 if (args[0] == '+' && args[1] == '\0')
1383 /* "info editing +" should print from the stored position. */
1386 /* "info editing <exp>" should print around command number <exp>. */
1387 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1389 /* "show commands" means print the last Hist_print commands. */
1392 num = hist_len - Hist_print;
1398 /* If there are at least Hist_print commands, we want to display the last
1399 Hist_print rather than, say, the last 6. */
1400 if (hist_len - num < Hist_print)
1402 num = hist_len - Hist_print;
1407 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1409 printf_filtered ("%5d %s\n", history_base + offset,
1410 (history_get (history_base + offset))->line);
1413 /* The next command we want to display is the next one that we haven't
1417 /* If the user repeats this command with return, it should do what
1418 "show commands +" does. This is unnecessary if arg is null,
1419 because "show commands +" is not useful after "show commands". */
1420 if (from_tty && args)
1427 /* Called by do_setshow_command. */
1429 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1431 if (history_size == INT_MAX)
1432 unstifle_history ();
1433 else if (history_size >= 0)
1434 stifle_history (history_size);
1437 history_size = INT_MAX;
1438 error (_("History size must be non-negative"));
1443 set_history (char *args, int from_tty)
1445 printf_unfiltered (_("\"set history\" must be followed "
1446 "by the name of a history subcommand.\n"));
1447 help_list (sethistlist, "set history ", -1, gdb_stdout);
1451 show_history (char *args, int from_tty)
1453 cmd_show_list (showhistlist, from_tty, "");
1456 int info_verbose = 0; /* Default verbose msgs off. */
1458 /* Called by do_setshow_command. An elaborate joke. */
1460 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1462 char *cmdname = "verbose";
1463 struct cmd_list_element *showcmd;
1465 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1466 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1470 c->doc = "Set verbose printing of informational messages.";
1471 showcmd->doc = "Show verbose printing of informational messages.";
1475 c->doc = "Set verbosity.";
1476 showcmd->doc = "Show verbosity.";
1480 /* Init the history buffer. Note that we are called after the init file(s)
1481 have been read so that the user can change the history file via his
1482 .gdbinit file (for instance). The GDBHISTFILE environment variable
1483 overrides all of this. */
1490 tmpenv = getenv ("HISTSIZE");
1492 history_size = atoi (tmpenv);
1493 else if (!history_size)
1496 stifle_history (history_size);
1498 tmpenv = getenv ("GDBHISTFILE");
1500 history_filename = xstrdup (tmpenv);
1501 else if (!history_filename)
1503 /* We include the current directory so that if the user changes
1504 directories the file written will be the same as the one
1507 /* No leading dots in file names are allowed on MSDOS. */
1508 history_filename = concat (current_directory, "/_gdb_history",
1511 history_filename = concat (current_directory, "/.gdb_history",
1515 read_history (history_filename);
1519 show_prompt (struct ui_file *file, int from_tty,
1520 struct cmd_list_element *c, const char *value)
1522 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1526 show_async_command_editing_p (struct ui_file *file, int from_tty,
1527 struct cmd_list_element *c, const char *value)
1529 fprintf_filtered (file, _("Editing of command lines as "
1530 "they are typed is %s.\n"),
1535 show_annotation_level (struct ui_file *file, int from_tty,
1536 struct cmd_list_element *c, const char *value)
1538 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1542 show_exec_done_display_p (struct ui_file *file, int from_tty,
1543 struct cmd_list_element *c, const char *value)
1545 fprintf_filtered (file, _("Notification of completion for "
1546 "asynchronous execution commands is %s.\n"),
1552 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1553 the DEFAULT_PROMPT is. */
1554 set_prompt (DEFAULT_PROMPT);
1556 /* Set things up for annotation_level > 1, if the user ever decides
1558 async_annotation_suffix = "prompt";
1560 /* Set the important stuff up for command editing. */
1561 command_editing_p = 1;
1562 history_expansion_p = 0;
1563 write_history_p = 0;
1565 /* Setup important stuff for command line editing. */
1566 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1567 rl_completion_entry_function = readline_line_completion_function;
1568 rl_completer_word_break_characters = default_word_break_characters ();
1569 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1570 rl_readline_name = "gdb";
1571 rl_terminal_name = getenv ("TERM");
1573 /* The name for this defun comes from Bash, where it originated.
1574 15 is Control-o, the same binding this function has in Bash. */
1575 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1577 add_setshow_string_cmd ("prompt", class_support,
1579 _("Set gdb's prompt"),
1580 _("Show gdb's prompt"),
1583 &setlist, &showlist);
1585 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1586 Don't repeat this command.\nPrimarily \
1587 used inside of user-defined commands that should not be repeated when\n\
1590 add_setshow_boolean_cmd ("editing", class_support,
1591 &async_command_editing_p, _("\
1592 Set editing of command lines as they are typed."), _("\
1593 Show editing of command lines as they are typed."), _("\
1594 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1595 Without an argument, command line editing is enabled. To edit, use\n\
1596 EMACS-like or VI-like commands like control-P or ESC."),
1597 set_async_editing_command,
1598 show_async_command_editing_p,
1599 &setlist, &showlist);
1601 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1602 Set saving of the history record on exit."), _("\
1603 Show saving of the history record on exit."), _("\
1604 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1605 Without an argument, saving is enabled."),
1607 show_write_history_p,
1608 &sethistlist, &showhistlist);
1610 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1611 Set the size of the command history,"), _("\
1612 Show the size of the command history,"), _("\
1613 ie. the number of previous commands to keep a record of."),
1614 set_history_size_command,
1616 &sethistlist, &showhistlist);
1618 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1619 Set the filename in which to record the command history"), _("\
1620 Show the filename in which to record the command history"), _("\
1621 (the list of previous commands of which a record is kept)."),
1623 show_history_filename,
1624 &sethistlist, &showhistlist);
1626 add_setshow_boolean_cmd ("confirm", class_support, &caution, _("\
1627 Set whether to confirm potentially dangerous operations."), _("\
1628 Show whether to confirm potentially dangerous operations."), NULL,
1631 &setlist, &showlist);
1633 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1634 Set annotation_level."), _("\
1635 Show annotation_level."), _("\
1636 0 == normal; 1 == fullname (for use when running under emacs)\n\
1637 2 == output annotated suitably for use by programs that control GDB."),
1639 show_annotation_level,
1640 &setlist, &showlist);
1642 add_setshow_boolean_cmd ("exec-done-display", class_support,
1643 &exec_done_display_p, _("\
1644 Set notification of completion for asynchronous execution commands."), _("\
1645 Show notification of completion for asynchronous execution commands."), _("\
1646 Use \"on\" to enable the notification, and \"off\" to disable it."),
1648 show_exec_done_display_p,
1649 &setlist, &showlist);
1651 add_setshow_filename_cmd ("data-directory", class_maintenance,
1652 &gdb_datadir, _("Set GDB's data directory."),
1653 _("Show GDB's data directory."),
1655 When set, GDB uses the specified path to search for data files."),
1662 gdb_init (char *argv0)
1664 if (pre_init_ui_hook)
1665 pre_init_ui_hook ();
1667 /* Run the init function of each source file. */
1670 /* Make sure we return to the original directory upon exit, come
1671 what may, since the OS doesn't do that for us. */
1672 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1675 init_cmd_lists (); /* This needs to be done first. */
1676 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1677 initialize_utils (); /* Make errors and warnings possible. */
1679 /* Here is where we call all the _initialize_foo routines. */
1680 initialize_all_files ();
1682 /* This creates the current_program_space. Do this after all the
1683 _initialize_foo routines have had a chance to install their
1684 per-sspace data keys. Also do this before
1685 initialize_current_architecture is called, because it accesses
1686 exec_bfd of the current program space. */
1687 initialize_progspace ();
1688 initialize_inferiors ();
1689 initialize_current_architecture ();
1691 init_main (); /* But that omits this file! Do it now. */
1693 initialize_stdin_serial ();
1695 async_init_signals ();
1697 /* We need a default language for parsing expressions, so simple
1698 things like "set width 0" won't fail if no language is explicitly
1699 set in a config file or implicitly set by reading an executable
1701 set_language (language_c);
1702 expected_language = current_language; /* Don't warn about the change. */
1704 /* Allow another UI to initialize. If the UI fails to initialize,
1705 and it wants GDB to revert to the CLI, it should clear
1706 deprecated_init_ui_hook. */
1707 if (deprecated_init_ui_hook)
1708 deprecated_init_ui_hook (argv0);
1711 /* Python initialization can require various commands to be
1712 installed. For example "info pretty-printer" needs the "info"
1713 prefix to be installed. Keep things simple and just do final
1714 python initialization here. */
1715 finish_python_initialization ();