1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "call-cmds.h"
25 #include "cli/cli-cmds.h"
26 #include "cli/cli-script.h"
27 #include "cli/cli-setshow.h"
28 #include "cli/cli-decode.h"
31 #include "exceptions.h"
34 #include "breakpoint.h"
36 #include "expression.h"
39 #include "terminal.h" /* For job_control. */
41 #include "completer.h"
46 #include "gdb_assert.h"
48 #include "event-loop.h"
49 #include "gdbthread.h"
50 #include "python/python.h"
52 /* readline include files. */
53 #include "readline/readline.h"
54 #include "readline/history.h"
56 /* readline defines this. */
59 #include <sys/types.h>
61 #include "event-top.h"
62 #include "gdb_string.h"
68 #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 all the "from_tty" gubbish printed. */
104 int caution = 1; /* Default is yes, sigh. */
106 show_caution (struct ui_file *file, int from_tty,
107 struct cmd_list_element *c, const char *value)
109 fprintf_filtered (file, _("Whether to confirm potentially "
110 "dangerous operations is %s.\n"),
114 /* stdio stream that command input is being read from. Set to stdin
115 normally. Set by source_command to the file we are sourcing. Set
116 to NULL if we are executing a user-defined command or interacting
121 /* Flag to indicate whether a user defined command is currently running. */
125 /* Current working directory. */
127 char *current_directory;
129 /* The directory name is actually stored here (usually). */
130 char gdb_dirbuf[1024];
132 /* Function to call before reading a command, if nonzero.
133 The function receives two args: an input stream,
134 and a prompt string. */
136 void (*window_hook) (FILE *, char *);
141 /* Buffer used for reading command lines, and the size
142 allocated for it so far. */
144 char *saved_command_line;
145 int saved_command_line_size = 100;
147 /* Nonzero if the current command is modified by "server ". This
148 affects things like recording into the command history, commands
149 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
150 whatever) can issue its own commands and also send along commands
151 from the user, and have the user not notice that the user interface
152 is issuing commands too. */
155 /* Baud rate specified for talking to serial target systems. Default
156 is left as -1, so targets can choose their own defaults. */
157 /* FIXME: This means that "show remotebaud" and gr_files_info can
158 print -1 or (unsigned int)-1. This is a Bad User Interface. */
162 /* Timeout limit for response from target. */
164 /* The default value has been changed many times over the years. It
165 was originally 5 seconds. But that was thought to be a long time
166 to sit and wait, so it was changed to 2 seconds. That was thought
167 to be plenty unless the connection was going through some terminal
168 server or multiplexer or other form of hairy serial connection.
170 In mid-1996, remote_timeout was moved from remote.c to top.c and
171 it began being used in other remote-* targets. It appears that the
172 default was changed to 20 seconds at that time, perhaps because the
173 Renesas E7000 ICE didn't always respond in a timely manner.
175 But if 5 seconds is a long time to sit and wait for retransmissions,
176 20 seconds is far worse. This demonstrates the difficulty of using
177 a single variable for all protocol timeouts.
179 As remote.c is used much more than remote-e7000.c, it was changed
180 back to 2 seconds in 1999. */
182 int remote_timeout = 2;
184 /* Non-zero tells remote* modules to output debugging info. */
186 int remote_debug = 0;
188 /* Sbrk location on entry to main. Used for statistics only. */
193 /* Hooks for alternate command interfaces. */
195 /* Called after most modules have been initialized, but before taking
198 If the UI fails to initialize and it wants GDB to continue using
199 the default UI, then it should clear this hook before returning. */
201 void (*deprecated_init_ui_hook) (char *argv0);
203 /* This hook is called from within gdb's many mini-event loops which
204 could steal control from a real user interface's event loop. It
205 returns non-zero if the user is requesting a detach, zero
208 int (*deprecated_ui_loop_hook) (int);
210 /* Called instead of command_loop at top level. Can be invoked via
211 throw_exception(). */
213 void (*deprecated_command_loop_hook) (void);
216 /* Called from print_frame_info to list the line we stopped in. */
218 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
222 /* Replaces most of query. */
224 int (*deprecated_query_hook) (const char *, va_list);
226 /* Replaces most of warning. */
228 void (*deprecated_warning_hook) (const char *, va_list);
230 /* These three functions support getting lines of text from the user.
231 They are used in sequence. First deprecated_readline_begin_hook is
232 called with a text string that might be (for example) a message for
233 the user to type in a sequence of commands to be executed at a
234 breakpoint. If this function calls back to a GUI, it might take
235 this opportunity to pop up a text interaction window with this
236 message. Next, deprecated_readline_hook is called with a prompt
237 that is emitted prior to collecting the user input. It can be
238 called multiple times. Finally, deprecated_readline_end_hook is
239 called to notify the GUI that we are done with the interaction
240 window and it can close it. */
242 void (*deprecated_readline_begin_hook) (char *, ...);
243 char *(*deprecated_readline_hook) (char *);
244 void (*deprecated_readline_end_hook) (void);
246 /* Called as appropriate to notify the interface that we have attached
247 to or detached from an already running process. */
249 void (*deprecated_attach_hook) (void);
250 void (*deprecated_detach_hook) (void);
252 /* Called during long calculations to allow GUI to repair window
253 damage, and to check for stop buttons, etc... */
255 void (*deprecated_interactive_hook) (void);
257 /* Tell the GUI someone changed the register REGNO. -1 means
258 that the caller does not know which register changed or
259 that several registers have changed (see value_assign). */
260 void (*deprecated_register_changed_hook) (int regno);
262 /* Called when going to wait for the target. Usually allows the GUI
263 to run while waiting for target events. */
265 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
266 struct target_waitstatus *status,
269 /* Used by UI as a wrapper around command execution. May do various
270 things like enabling/disabling buttons, etc... */
272 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
273 char *cmd, int from_tty);
275 /* Called after a `set' command has finished. Is only run if the
276 `set' command succeeded. */
278 void (*deprecated_set_hook) (struct cmd_list_element * c);
280 /* Called when the current thread changes. Argument is thread id. */
282 void (*deprecated_context_hook) (int id);
284 /* Handler for SIGHUP. */
287 /* NOTE 1999-04-29: This function will be static again, once we modify
288 gdb to use the event loop as the default command loop and we merge
289 event-top.c into this file, top.c. */
293 caution = 0; /* Throw caution to the wind -- we're exiting.
294 This prevents asking the user dumb
296 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 /* Execute the line P as a command, in the current user context.
366 Pass FROM_TTY as second argument to the defining function. */
369 execute_command (char *p, int from_tty)
371 struct cleanup *cleanup;
372 struct cmd_list_element *c;
374 static int warned = 0;
377 cleanup = prepare_execute_command ();
379 /* Force cleanup of any alloca areas if using C alloca instead of
383 /* This can happen when command_line_input hits end of file. */
386 do_cleanups (cleanup);
390 target_log_command (p);
392 while (*p == ' ' || *p == '\t')
399 /* If trace-commands is set then this will print this command. */
400 print_command_trace (p);
402 c = lookup_cmd (&p, cmdlist, "", 0, 1);
404 /* Pass null arg rather than an empty one. */
407 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
408 while the is_complete_command(cfunc) test is just plain
409 bogus. They should both be replaced by a test of the form
410 c->strip_trailing_white_space_p. */
411 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
412 can't be replaced with func. This is because it is the
413 cfunc, and not the func, that has the value that the
414 is_complete_command hack is testing for. */
415 /* Clear off trailing whitespace, except for set and complete
418 && c->type != set_cmd
419 && !is_complete_command (c))
421 p = arg + strlen (arg) - 1;
422 while (p >= arg && (*p == ' ' || *p == '\t'))
427 /* If this command has been pre-hooked, run the hook first. */
428 execute_cmd_pre_hook (c);
430 if (c->flags & DEPRECATED_WARN_USER)
431 deprecated_cmd_warning (&line);
433 if (c->class == class_user)
434 execute_user_command (c, arg);
435 else if (c->type == set_cmd || c->type == show_cmd)
436 do_setshow_command (arg, from_tty & caution, c);
437 else if (!cmd_func_p (c))
438 error (_("That is not a command, just a help topic."));
439 else if (deprecated_call_command_hook)
440 deprecated_call_command_hook (c, arg, from_tty & caution);
442 cmd_func (c, arg, from_tty & caution);
444 /* If this command has been post-hooked, run the hook last. */
445 execute_cmd_post_hook (c);
449 /* Tell the user if the language has changed (except first time).
450 First make sure that a new frame has been selected, in case this
451 command or the hooks changed the program state. */
452 deprecated_safe_get_selected_frame ();
453 if (current_language != expected_language)
455 if (language_mode == language_mode_auto && info_verbose)
457 language_info (1); /* Print what changed. */
462 /* Warn the user if the working language does not match the
463 language of the current frame. Only warn the user if we are
464 actually running the program, i.e. there is a stack. */
465 /* FIXME: This should be cacheing the frame and only running when
466 the frame changes. */
468 if (has_stack_frames ())
470 flang = get_frame_language ();
472 && flang != language_unknown
473 && flang != current_language->la_language)
475 printf_filtered ("%s\n", lang_frame_mismatch_warn);
480 do_cleanups (cleanup);
483 /* Run execute_command for P and FROM_TTY. Capture its output into the
484 returned string, do not display it to the screen. BATCH_FLAG will be
485 temporarily set to true. */
488 execute_command_to_string (char *p, int from_tty)
490 struct ui_file *str_file;
491 struct cleanup *cleanup;
494 /* GDB_STDOUT should be better already restored during these
495 restoration callbacks. */
496 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
498 str_file = mem_fileopen ();
500 make_cleanup_ui_file_delete (str_file);
501 make_cleanup_restore_ui_file (&gdb_stdout);
502 make_cleanup_restore_ui_file (&gdb_stderr);
503 make_cleanup_restore_ui_file (&gdb_stdlog);
504 make_cleanup_restore_ui_file (&gdb_stdtarg);
505 make_cleanup_restore_ui_file (&gdb_stdtargerr);
507 if (ui_out_redirect (current_uiout, str_file) < 0)
508 warning (_("Current output protocol does not support redirection"));
510 make_cleanup_ui_out_redirect_pop (current_uiout);
512 gdb_stdout = str_file;
513 gdb_stderr = str_file;
514 gdb_stdlog = str_file;
515 gdb_stdtarg = str_file;
516 gdb_stdtargerr = str_file;
518 execute_command (p, from_tty);
520 retval = ui_file_xstrdup (str_file, NULL);
522 do_cleanups (cleanup);
527 /* Read commands from `instream' and execute them
528 until end of file or error reading instream. */
533 struct cleanup *old_chain;
535 int stdin_is_tty = ISATTY (stdin);
537 while (instream && !feof (instream))
539 if (window_hook && instream == stdin)
540 (*window_hook) (instream, get_prompt (0));
543 if (instream == stdin && stdin_is_tty)
544 reinitialize_more_filter ();
545 old_chain = make_cleanup (null_cleanup, 0);
547 /* Get a command-line. This calls the readline package. */
548 command = command_line_input (instream == stdin ?
549 get_prompt (0) : (char *) NULL,
550 instream == stdin, "prompt");
553 do_cleanups (old_chain);
557 make_command_stats_cleanup (1);
559 execute_command (command, instream == stdin);
561 /* Do any commands attached to breakpoint we are stopped at. */
562 bpstat_do_actions ();
564 do_cleanups (old_chain);
568 /* When nonzero, cause dont_repeat to do nothing. This should only be
569 set via prevent_dont_repeat. */
571 static int suppress_dont_repeat = 0;
573 /* Commands call this if they do not want to be repeated by null lines. */
578 if (suppress_dont_repeat || server_command)
581 /* If we aren't reading from standard input, we are saving the last
582 thing read from stdin in line and don't want to delete it. Null
583 lines won't repeat here in any case. */
584 if (instream == stdin)
585 *saved_command_line = 0;
588 /* Prevent dont_repeat from working, and return a cleanup that
589 restores the previous state. */
592 prevent_dont_repeat (void)
594 struct cleanup *result = make_cleanup_restore_integer (&suppress_dont_repeat);
596 suppress_dont_repeat = 1;
601 /* Read a line from the stream "instream" without command line editing.
603 It prints PROMPT_ARG once at the start.
604 Action is compatible with "readline", e.g. space for the result is
605 malloc'd and should be freed by the caller.
607 A NULL return means end of file. */
609 gdb_readline (char *prompt_arg)
614 int result_size = 80;
618 /* Don't use a _filtered function here. It causes the assumed
619 character position to be off, since the newline we read from
620 the user is not accounted for. */
621 fputs_unfiltered (prompt_arg, gdb_stdout);
622 gdb_flush (gdb_stdout);
625 result = (char *) xmalloc (result_size);
629 /* Read from stdin if we are executing a user defined command.
630 This is the right thing for prompt_for_continue, at least. */
631 c = fgetc (instream ? instream : stdin);
636 /* The last line does not end with a newline. Return it, and
637 if we are called again fgetc will still return EOF and
638 we'll return NULL then. */
646 if (input_index > 0 && result[input_index - 1] == '\r')
651 result[input_index++] = c;
652 while (input_index >= result_size)
655 result = (char *) xrealloc (result, result_size);
659 result[input_index++] = '\0';
663 /* Variables which control command line editing and history
664 substitution. These variables are given default values at the end
666 static int command_editing_p;
668 /* NOTE 1999-04-29: This variable will be static again, once we modify
669 gdb to use the event loop as the default command loop and we merge
670 event-top.c into this file, top.c. */
672 /* static */ int history_expansion_p;
674 static int write_history_p;
676 show_write_history_p (struct ui_file *file, int from_tty,
677 struct cmd_list_element *c, const char *value)
679 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
683 static int history_size;
685 show_history_size (struct ui_file *file, int from_tty,
686 struct cmd_list_element *c, const char *value)
688 fprintf_filtered (file, _("The size of the command history is %s.\n"),
692 static char *history_filename;
694 show_history_filename (struct ui_file *file, int from_tty,
695 struct cmd_list_element *c, const char *value)
697 fprintf_filtered (file, _("The filename in which to record "
698 "the command history is \"%s\".\n"),
702 /* This is like readline(), but it has some gdb-specific behavior.
703 gdb may want readline in both the synchronous and async modes during
704 a single gdb invocation. At the ordinary top-level prompt we might
705 be using the async readline. That means we can't use
706 rl_pre_input_hook, since it doesn't work properly in async mode.
707 However, for a secondary prompt (" >", such as occurs during a
708 `define'), gdb wants a synchronous response.
710 We used to call readline() directly, running it in synchronous
711 mode. But mixing modes this way is not supported, and as of
712 readline 5.x it no longer works; the arrow keys come unbound during
713 the synchronous call. So we make a nested call into the event
714 loop. That's what gdb_readline_wrapper is for. */
716 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
717 rely on gdb_readline_wrapper_result, which might still be NULL if
718 the user types Control-D for EOF. */
719 static int gdb_readline_wrapper_done;
721 /* The result of the current call to gdb_readline_wrapper, once a newline
723 static char *gdb_readline_wrapper_result;
725 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
726 to be called after the newline is processed (which will redisplay
727 the prompt). But in gdb_readline_wrapper we will not get a new
728 prompt until the next call, or until we return to the event loop.
729 So we disable this hook around the newline and restore it before we
731 static void (*saved_after_char_processing_hook) (void);
733 /* This function is called when readline has seen a complete line of
737 gdb_readline_wrapper_line (char *line)
739 gdb_assert (!gdb_readline_wrapper_done);
740 gdb_readline_wrapper_result = line;
741 gdb_readline_wrapper_done = 1;
743 /* Prevent operate-and-get-next from acting too early. */
744 saved_after_char_processing_hook = after_char_processing_hook;
745 after_char_processing_hook = NULL;
747 /* Prevent parts of the prompt from being redisplayed if annotations
748 are enabled, and readline's state getting out of sync. */
749 if (async_command_editing_p)
750 rl_callback_handler_remove ();
753 struct gdb_readline_wrapper_cleanup
755 void (*handler_orig) (char *);
756 int already_prompted_orig;
760 gdb_readline_wrapper_cleanup (void *arg)
762 struct gdb_readline_wrapper_cleanup *cleanup = arg;
764 rl_already_prompted = cleanup->already_prompted_orig;
766 gdb_assert (input_handler == gdb_readline_wrapper_line);
767 input_handler = cleanup->handler_orig;
768 gdb_readline_wrapper_result = NULL;
769 gdb_readline_wrapper_done = 0;
771 after_char_processing_hook = saved_after_char_processing_hook;
772 saved_after_char_processing_hook = NULL;
778 gdb_readline_wrapper (char *prompt)
780 struct cleanup *back_to;
781 struct gdb_readline_wrapper_cleanup *cleanup;
784 cleanup = xmalloc (sizeof (*cleanup));
785 cleanup->handler_orig = input_handler;
786 input_handler = gdb_readline_wrapper_line;
788 cleanup->already_prompted_orig = rl_already_prompted;
790 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
792 /* Display our prompt and prevent double prompt display. */
793 display_gdb_prompt (prompt);
794 rl_already_prompted = 1;
796 if (after_char_processing_hook)
797 (*after_char_processing_hook) ();
798 gdb_assert (after_char_processing_hook == NULL);
800 while (gdb_do_one_event () >= 0)
801 if (gdb_readline_wrapper_done)
804 retval = gdb_readline_wrapper_result;
805 do_cleanups (back_to);
810 /* The current saved history number from operate-and-get-next.
811 This is -1 if not valid. */
812 static int operate_saved_history = -1;
814 /* This is put on the appropriate hook and helps operate-and-get-next
817 gdb_rl_operate_and_get_next_completion (void)
819 int delta = where_history () - operate_saved_history;
821 /* The `key' argument to rl_get_previous_history is ignored. */
822 rl_get_previous_history (delta, 0);
823 operate_saved_history = -1;
825 /* readline doesn't automatically update the display for us. */
828 after_char_processing_hook = NULL;
829 rl_pre_input_hook = NULL;
832 /* This is a gdb-local readline command handler. It accepts the
833 current command line (like RET does) and, if this command was taken
834 from the history, arranges for the next command in the history to
835 appear on the command line when the prompt returns.
836 We ignore the arguments. */
838 gdb_rl_operate_and_get_next (int count, int key)
842 /* Use the async hook. */
843 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
845 /* Find the current line, and find the next line to use. */
846 where = where_history();
848 /* FIXME: kettenis/20020817: max_input_history is renamed into
849 history_max_entries in readline-4.2. When we do a new readline
850 import, we should probably change it here too, even though
851 readline maintains backwards compatibility for now by still
852 defining max_input_history. */
853 if ((history_is_stifled () && (history_length >= max_input_history)) ||
854 (where >= history_length - 1))
855 operate_saved_history = where;
857 operate_saved_history = where + 1;
859 return rl_newline (1, key);
862 /* Read one line from the command input stream `instream'
863 into the local static buffer `linebuffer' (whose current length
865 The buffer is made bigger as necessary.
866 Returns the address of the start of the line.
868 NULL is returned for end of file.
870 *If* the instream == stdin & stdin is a terminal, the line read
871 is copied into the file line saver (global var char *line,
872 length linesize) so that it can be duplicated.
874 This routine either uses fancy command line editing or
875 simple input as the user has requested. */
878 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
880 static char *linebuffer = 0;
881 static unsigned linelength = 0;
885 char *local_prompt = prompt_arg;
889 /* The annotation suffix must be non-NULL. */
890 if (annotation_suffix == NULL)
891 annotation_suffix = "";
893 if (annotation_level > 1 && instream == stdin)
895 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
896 + strlen (annotation_suffix) + 40);
897 if (prompt_arg == NULL)
898 local_prompt[0] = '\0';
900 strcpy (local_prompt, prompt_arg);
901 strcat (local_prompt, "\n\032\032");
902 strcat (local_prompt, annotation_suffix);
903 strcat (local_prompt, "\n");
909 linebuffer = (char *) xmalloc (linelength);
914 /* Control-C quits instantly if typed while in this loop
915 since it should not wait until the user types a newline. */
919 signal (STOP_SIGNAL, handle_stop_sig);
924 /* Make sure that all output has been output. Some machines may
925 let you get away with leaving out some of the gdb_flush, but
928 gdb_flush (gdb_stdout);
929 gdb_flush (gdb_stderr);
931 if (source_file_name != NULL)
932 ++source_line_number;
934 if (annotation_level > 1 && instream == stdin)
936 puts_unfiltered ("\n\032\032pre-");
937 puts_unfiltered (annotation_suffix);
938 puts_unfiltered ("\n");
941 /* Don't use fancy stuff if not talking to stdin. */
942 if (deprecated_readline_hook && input_from_terminal_p ())
944 rl = (*deprecated_readline_hook) (local_prompt);
946 else if (command_editing_p && input_from_terminal_p ())
948 rl = gdb_readline_wrapper (local_prompt);
952 rl = gdb_readline (local_prompt);
955 if (annotation_level > 1 && instream == stdin)
957 puts_unfiltered ("\n\032\032post-");
958 puts_unfiltered (annotation_suffix);
959 puts_unfiltered ("\n");
962 if (!rl || rl == (char *) EOF)
967 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
969 linelength = strlen (rl) + 1 + (p - linebuffer);
970 nline = (char *) xrealloc (linebuffer, linelength);
971 p += nline - linebuffer;
975 /* Copy line. Don't copy null at end. (Leaves line alone
976 if this was just a newline). */
980 xfree (rl); /* Allocated in readline. */
982 if (p == linebuffer || *(p - 1) != '\\')
985 p--; /* Put on top of '\'. */
986 local_prompt = (char *) 0;
991 signal (STOP_SIGNAL, SIG_DFL);
998 #define SERVER_COMMAND_LENGTH 7
1000 (p - linebuffer > SERVER_COMMAND_LENGTH)
1001 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1004 /* Note that we don't set `line'. Between this and the check in
1005 dont_repeat, this insures that repeating will still do the
1008 return linebuffer + SERVER_COMMAND_LENGTH;
1011 /* Do history expansion if that is wished. */
1012 if (history_expansion_p && instream == stdin
1013 && ISATTY (instream))
1015 char *history_value;
1018 *p = '\0'; /* Insert null now. */
1019 expanded = history_expand (linebuffer, &history_value);
1022 /* Print the changes. */
1023 printf_unfiltered ("%s\n", history_value);
1025 /* If there was an error, call this function again. */
1028 xfree (history_value);
1029 return command_line_input (prompt_arg, repeat,
1032 if (strlen (history_value) > linelength)
1034 linelength = strlen (history_value) + 1;
1035 linebuffer = (char *) xrealloc (linebuffer, linelength);
1037 strcpy (linebuffer, history_value);
1038 p = linebuffer + strlen (linebuffer);
1040 xfree (history_value);
1043 /* If we just got an empty line, and that is supposed to repeat the
1044 previous command, return the value in the global buffer. */
1045 if (repeat && p == linebuffer)
1046 return saved_command_line;
1047 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1049 return saved_command_line;
1053 /* Add line to history if appropriate. */
1054 if (instream == stdin
1055 && ISATTY (stdin) && *linebuffer)
1056 add_history (linebuffer);
1058 /* Note: lines consisting solely of comments are added to the command
1059 history. This is useful when you type a command, and then
1060 realize you don't want to execute it quite yet. You can comment
1061 out the command and then later fetch it from the value history
1062 and remove the '#'. The kill ring is probably better, but some
1063 people are in the habit of commenting things out. */
1065 *p1 = '\0'; /* Found a comment. */
1067 /* Save into global buffer if appropriate. */
1070 if (linelength > saved_command_line_size)
1072 saved_command_line = xrealloc (saved_command_line, linelength);
1073 saved_command_line_size = linelength;
1075 strcpy (saved_command_line, linebuffer);
1076 return saved_command_line;
1082 /* Print the GDB banner. */
1084 print_gdb_version (struct ui_file *stream)
1086 /* From GNU coding standards, first line is meant to be easy for a
1087 program to parse, and is just canonical program name and version
1088 number, which starts after last space. */
1090 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1092 /* Second line is a copyright notice. */
1094 fprintf_filtered (stream,
1095 "Copyright (C) 2011 Free Software Foundation, Inc.\n");
1097 /* Following the copyright is a brief statement that the program is
1098 free software, that users are free to copy and change it on
1099 certain conditions, that it is covered by the GNU GPL, and that
1100 there is no warranty. */
1102 fprintf_filtered (stream, "\
1103 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1104 \nThis is free software: you are free to change and redistribute it.\n\
1105 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1106 and \"show warranty\" for details.\n");
1108 /* After the required info we print the configuration information. */
1110 fprintf_filtered (stream, "This GDB was configured as \"");
1111 if (strcmp (host_name, target_name) != 0)
1113 fprintf_filtered (stream, "--host=%s --target=%s",
1114 host_name, target_name);
1118 fprintf_filtered (stream, "%s", host_name);
1120 fprintf_filtered (stream, "\".");
1122 if (REPORT_BUGS_TO[0])
1124 fprintf_filtered (stream,
1125 _("\nFor bug reporting instructions, please see:\n"));
1126 fprintf_filtered (stream, "%s.", REPORT_BUGS_TO);
1131 /* get_prefix: access method for the GDB prefix string. */
1134 get_prefix (int level)
1136 return PREFIX (level);
1139 /* set_prefix: set method for the GDB prefix string. */
1142 set_prefix (const char *s, int level)
1144 /* If S is NULL, just free the PREFIX at level LEVEL and set to
1148 xfree (PREFIX (level));
1149 PREFIX (level) = NULL;
1153 char *p = xstrdup (s);
1155 xfree (PREFIX (level));
1160 /* get_suffix: access method for the GDB suffix string. */
1163 get_suffix (int level)
1165 return SUFFIX (level);
1168 /* set_suffix: set method for the GDB suffix string. */
1171 set_suffix (const char *s, int level)
1173 /* If S is NULL, just free the SUFFIX at level LEVEL and set to
1177 xfree (SUFFIX (level));
1178 SUFFIX (level) = NULL;
1182 char *p = xstrdup (s);
1184 xfree (SUFFIX (level));
1189 /* get_prompt: access method for the GDB prompt string. */
1192 get_prompt (int level)
1194 return PROMPT (level);
1198 set_prompt (const char *s, int level)
1200 /* If S is NULL, just free the PROMPT at level LEVEL and set to
1204 xfree (PROMPT (level));
1205 PROMPT (level) = NULL;
1209 char *p = xstrdup (s);
1216 /* Also, free and set new_async_prompt so prompt changes sync up
1217 with set/show prompt. */
1218 xfree (new_async_prompt);
1219 new_async_prompt = xstrdup (PROMPT (0));
1231 /* Callback for iterate_over_inferiors. Kills or detaches the given
1232 inferior, depending on how we originally gained control of it. */
1235 kill_or_detach (struct inferior *inf, void *args)
1237 struct qt_args *qt = args;
1238 struct thread_info *thread;
1243 thread = any_thread_of_process (inf->pid);
1246 switch_to_thread (thread->ptid);
1248 /* Leave core files alone. */
1249 if (target_has_execution)
1251 if (inf->attach_flag)
1252 target_detach (qt->args, qt->from_tty);
1261 /* Callback for iterate_over_inferiors. Prints info about what GDB
1262 will do to each inferior on a "quit". ARG points to a struct
1263 ui_out where output is to be collected. */
1266 print_inferior_quit_action (struct inferior *inf, void *arg)
1268 struct ui_file *stb = arg;
1273 if (inf->attach_flag)
1274 fprintf_filtered (stb,
1275 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1276 target_pid_to_str (pid_to_ptid (inf->pid)));
1278 fprintf_filtered (stb,
1279 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1280 target_pid_to_str (pid_to_ptid (inf->pid)));
1285 /* If necessary, make the user confirm that we should quit. Return
1286 non-zero if we should quit, zero if we shouldn't. */
1291 struct ui_file *stb;
1292 struct cleanup *old_chain;
1296 /* Don't even ask if we're only debugging a core file inferior. */
1297 if (!have_live_inferiors ())
1300 /* Build the query string as a single string. */
1301 stb = mem_fileopen ();
1302 old_chain = make_cleanup_ui_file_delete (stb);
1304 /* This is something of a hack. But there's no reliable way to see
1305 if a GUI is running. The `use_windows' variable doesn't cut
1307 if (deprecated_init_ui_hook)
1308 fprintf_filtered (stb, _("A debugging session is active.\n"
1309 "Do you still want to close the debugger?"));
1312 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1313 iterate_over_inferiors (print_inferior_quit_action, stb);
1314 fprintf_filtered (stb, _("\nQuit anyway? "));
1317 str = ui_file_xstrdup (stb, NULL);
1318 make_cleanup (xfree, str);
1320 qr = query ("%s", str);
1321 do_cleanups (old_chain);
1325 /* Helper routine for quit_force that requires error handling. */
1328 quit_target (void *arg)
1330 struct qt_args *qt = (struct qt_args *)arg;
1332 /* Kill or detach all inferiors. */
1333 iterate_over_inferiors (kill_or_detach, qt);
1335 /* Give all pushed targets a chance to do minimal cleanup, and pop
1337 pop_all_targets (1);
1339 /* Save the history information if it is appropriate to do so. */
1340 if (write_history_p && history_filename)
1341 write_history (history_filename);
1343 do_final_cleanups (ALL_CLEANUPS); /* Do any final cleanups before
1348 /* Quit without asking for confirmation. */
1351 quit_force (char *args, int from_tty)
1356 /* An optional expression may be used to cause gdb to terminate with the
1357 value of that expression. */
1360 struct value *val = parse_and_eval (args);
1362 exit_code = (int) value_as_long (val);
1364 else if (return_child_result)
1365 exit_code = return_child_result_value;
1368 qt.from_tty = from_tty;
1370 /* We want to handle any quit errors and exit regardless. */
1371 catch_errors (quit_target, &qt,
1372 "Quitting: ", RETURN_MASK_ALL);
1377 /* Returns whether GDB is running on a terminal and input is
1378 currently coming from that terminal. */
1381 input_from_terminal_p (void)
1386 if (gdb_has_a_terminal () && instream == stdin)
1389 /* If INSTREAM is unset, and we are not in a user command, we
1390 must be in Insight. That's like having a terminal, for our
1392 if (instream == NULL && !in_user_command)
1399 dont_repeat_command (char *ignored, int from_tty)
1401 /* Can't call dont_repeat here because we're not necessarily reading
1403 *saved_command_line = 0;
1406 /* Functions to manipulate command line editing control variables. */
1408 /* Number of commands to print in each call to show_commands. */
1409 #define Hist_print 10
1411 show_commands (char *args, int from_tty)
1413 /* Index for history commands. Relative to history_base. */
1416 /* Number of the history entry which we are planning to display next.
1417 Relative to history_base. */
1420 /* The first command in the history which doesn't exist (i.e. one more
1421 than the number of the last command). Relative to history_base. */
1424 /* Print out some of the commands from the command history. */
1425 /* First determine the length of the history list. */
1426 hist_len = history_size;
1427 for (offset = 0; offset < history_size; offset++)
1429 if (!history_get (history_base + offset))
1438 if (args[0] == '+' && args[1] == '\0')
1439 /* "info editing +" should print from the stored position. */
1442 /* "info editing <exp>" should print around command number <exp>. */
1443 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1445 /* "show commands" means print the last Hist_print commands. */
1448 num = hist_len - Hist_print;
1454 /* If there are at least Hist_print commands, we want to display the last
1455 Hist_print rather than, say, the last 6. */
1456 if (hist_len - num < Hist_print)
1458 num = hist_len - Hist_print;
1463 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1465 printf_filtered ("%5d %s\n", history_base + offset,
1466 (history_get (history_base + offset))->line);
1469 /* The next command we want to display is the next one that we haven't
1473 /* If the user repeats this command with return, it should do what
1474 "show commands +" does. This is unnecessary if arg is null,
1475 because "show commands +" is not useful after "show commands". */
1476 if (from_tty && args)
1483 /* Called by do_setshow_command. */
1485 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1487 if (history_size == INT_MAX)
1488 unstifle_history ();
1489 else if (history_size >= 0)
1490 stifle_history (history_size);
1493 history_size = INT_MAX;
1494 error (_("History size must be non-negative"));
1499 set_history (char *args, int from_tty)
1501 printf_unfiltered (_("\"set history\" must be followed "
1502 "by the name of a history subcommand.\n"));
1503 help_list (sethistlist, "set history ", -1, gdb_stdout);
1507 show_history (char *args, int from_tty)
1509 cmd_show_list (showhistlist, from_tty, "");
1512 int info_verbose = 0; /* Default verbose msgs off. */
1514 /* Called by do_setshow_command. An elaborate joke. */
1516 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1518 char *cmdname = "verbose";
1519 struct cmd_list_element *showcmd;
1521 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1522 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1526 c->doc = "Set verbose printing of informational messages.";
1527 showcmd->doc = "Show verbose printing of informational messages.";
1531 c->doc = "Set verbosity.";
1532 showcmd->doc = "Show verbosity.";
1536 /* Init the history buffer. Note that we are called after the init file(s)
1537 have been read so that the user can change the history file via his
1538 .gdbinit file (for instance). The GDBHISTFILE environment variable
1539 overrides all of this. */
1546 tmpenv = getenv ("HISTSIZE");
1548 history_size = atoi (tmpenv);
1549 else if (!history_size)
1552 stifle_history (history_size);
1554 tmpenv = getenv ("GDBHISTFILE");
1556 history_filename = xstrdup (tmpenv);
1557 else if (!history_filename)
1559 /* We include the current directory so that if the user changes
1560 directories the file written will be the same as the one
1563 /* No leading dots in file names are allowed on MSDOS. */
1564 history_filename = concat (current_directory, "/_gdb_history",
1567 history_filename = concat (current_directory, "/.gdb_history",
1571 read_history (history_filename);
1575 show_new_async_prompt (struct ui_file *file, int from_tty,
1576 struct cmd_list_element *c, const char *value)
1578 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1582 show_async_command_editing_p (struct ui_file *file, int from_tty,
1583 struct cmd_list_element *c, const char *value)
1585 fprintf_filtered (file, _("Editing of command lines as "
1586 "they are typed is %s.\n"),
1591 show_annotation_level (struct ui_file *file, int from_tty,
1592 struct cmd_list_element *c, const char *value)
1594 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1598 show_exec_done_display_p (struct ui_file *file, int from_tty,
1599 struct cmd_list_element *c, const char *value)
1601 fprintf_filtered (file, _("Notification of completion for "
1602 "asynchronous execution commands is %s.\n"),
1608 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1609 whatever the DEFAULT_PROMPT is. */
1610 the_prompts.top = 0;
1612 set_prompt (DEFAULT_PROMPT, 0);
1614 /* Set things up for annotation_level > 1, if the user ever decides
1616 async_annotation_suffix = "prompt";
1618 /* If gdb was started with --annotate=2, this is equivalent to the
1619 user entering the command 'set annotate 2' at the gdb prompt, so
1620 we need to do extra processing. */
1621 if (annotation_level > 1)
1622 set_async_annotation_level (NULL, 0, NULL);
1624 /* Set the important stuff up for command editing. */
1625 command_editing_p = 1;
1626 history_expansion_p = 0;
1627 write_history_p = 0;
1629 /* Setup important stuff for command line editing. */
1630 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1631 rl_completion_entry_function = readline_line_completion_function;
1632 rl_completer_word_break_characters = default_word_break_characters ();
1633 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1634 rl_readline_name = "gdb";
1635 rl_terminal_name = getenv ("TERM");
1637 /* The name for this defun comes from Bash, where it originated.
1638 15 is Control-o, the same binding this function has in Bash. */
1639 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1641 add_setshow_string_cmd ("prompt", class_support,
1643 _("Set gdb's prompt"),
1644 _("Show gdb's prompt"),
1645 NULL, set_async_prompt,
1646 show_new_async_prompt,
1647 &setlist, &showlist);
1649 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1650 Don't repeat this command.\nPrimarily \
1651 used inside of user-defined commands that should not be repeated when\n\
1654 add_setshow_boolean_cmd ("editing", class_support,
1655 &async_command_editing_p, _("\
1656 Set editing of command lines as they are typed."), _("\
1657 Show editing of command lines as they are typed."), _("\
1658 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1659 Without an argument, command line editing is enabled. To edit, use\n\
1660 EMACS-like or VI-like commands like control-P or ESC."),
1661 set_async_editing_command,
1662 show_async_command_editing_p,
1663 &setlist, &showlist);
1665 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1666 Set saving of the history record on exit."), _("\
1667 Show saving of the history record on exit."), _("\
1668 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1669 Without an argument, saving is enabled."),
1671 show_write_history_p,
1672 &sethistlist, &showhistlist);
1674 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1675 Set the size of the command history,"), _("\
1676 Show the size of the command history,"), _("\
1677 ie. the number of previous commands to keep a record of."),
1678 set_history_size_command,
1680 &sethistlist, &showhistlist);
1682 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1683 Set the filename in which to record the command history"), _("\
1684 Show the filename in which to record the command history"), _("\
1685 (the list of previous commands of which a record is kept)."),
1687 show_history_filename,
1688 &sethistlist, &showhistlist);
1690 add_setshow_boolean_cmd ("confirm", class_support, &caution, _("\
1691 Set whether to confirm potentially dangerous operations."), _("\
1692 Show whether to confirm potentially dangerous operations."), NULL,
1695 &setlist, &showlist);
1697 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1698 Set annotation_level."), _("\
1699 Show annotation_level."), _("\
1700 0 == normal; 1 == fullname (for use when running under emacs)\n\
1701 2 == output annotated suitably for use by programs that control GDB."),
1702 set_async_annotation_level,
1703 show_annotation_level,
1704 &setlist, &showlist);
1706 add_setshow_boolean_cmd ("exec-done-display", class_support,
1707 &exec_done_display_p, _("\
1708 Set notification of completion for asynchronous execution commands."), _("\
1709 Show notification of completion for asynchronous execution commands."), _("\
1710 Use \"on\" to enable the notification, and \"off\" to disable it."),
1712 show_exec_done_display_p,
1713 &setlist, &showlist);
1715 add_setshow_filename_cmd ("data-directory", class_maintenance,
1716 &gdb_datadir, _("Set GDB's data directory."),
1717 _("Show GDB's data directory."),
1719 When set, GDB uses the specified path to search for data files."),
1726 gdb_init (char *argv0)
1728 if (pre_init_ui_hook)
1729 pre_init_ui_hook ();
1731 /* Run the init function of each source file. */
1734 /* Make sure we return to the original directory upon exit, come
1735 what may, since the OS doesn't do that for us. */
1736 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1739 init_cmd_lists (); /* This needs to be done first. */
1740 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1741 initialize_utils (); /* Make errors and warnings possible. */
1743 /* Here is where we call all the _initialize_foo routines. */
1744 initialize_all_files ();
1746 /* This creates the current_program_space. Do this after all the
1747 _initialize_foo routines have had a chance to install their
1748 per-sspace data keys. Also do this before
1749 initialize_current_architecture is called, because it accesses
1750 exec_bfd of the current program space. */
1751 initialize_progspace ();
1752 initialize_inferiors ();
1753 initialize_current_architecture ();
1755 init_main (); /* But that omits this file! Do it now. */
1757 initialize_stdin_serial ();
1759 async_init_signals ();
1761 /* We need a default language for parsing expressions, so simple
1762 things like "set width 0" won't fail if no language is explicitly
1763 set in a config file or implicitly set by reading an executable
1765 set_language (language_c);
1766 expected_language = current_language; /* Don't warn about the change. */
1768 /* Allow another UI to initialize. If the UI fails to initialize,
1769 and it wants GDB to revert to the CLI, it should clear
1770 deprecated_init_ui_hook. */
1771 if (deprecated_init_ui_hook)
1772 deprecated_init_ui_hook (argv0);
1775 /* Python initialization can require various commands to be
1776 installed. For example "info pretty-printer" needs the "info"
1777 prefix to be installed. Keep things simple and just do final
1778 python initialization here. */
1779 finish_python_initialization ();