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"
53 /* readline include files. */
54 #include "readline/readline.h"
55 #include "readline/history.h"
57 /* readline defines this. */
60 #include <sys/types.h>
62 #include "event-top.h"
63 #include "gdb_string.h"
69 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
70 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
71 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
73 /* Default command line prompt. This is overriden in some configs. */
75 #ifndef DEFAULT_PROMPT
76 #define DEFAULT_PROMPT "(gdb) "
79 /* Initialization file name for gdb. This is overridden in some configs. */
83 # define PATH_MAX FILENAME_MAX
89 #ifndef GDBINIT_FILENAME
90 #define GDBINIT_FILENAME ".gdbinit"
92 char gdbinit[PATH_MAX + 1] = GDBINIT_FILENAME;
94 int inhibit_gdbinit = 0;
96 /* If nonzero, and GDB has been configured to be able to use windows,
97 attempt to open them upon startup. */
101 extern char lang_frame_mismatch_warn[]; /* language.c */
103 /* Flag for whether we want all the "from_tty" gubbish printed. */
105 int caution = 1; /* Default is yes, sigh. */
107 show_caution (struct ui_file *file, int from_tty,
108 struct cmd_list_element *c, const char *value)
110 fprintf_filtered (file, _("Whether to confirm potentially "
111 "dangerous operations is %s.\n"),
115 /* stdio stream that command input is being read from. Set to stdin
116 normally. Set by source_command to the file we are sourcing. Set
117 to NULL if we are executing a user-defined command or interacting
122 /* Flag to indicate whether a user defined command is currently running. */
126 /* Current working directory. */
128 char *current_directory;
130 /* The directory name is actually stored here (usually). */
131 char gdb_dirbuf[1024];
133 /* Function to call before reading a command, if nonzero.
134 The function receives two args: an input stream,
135 and a prompt string. */
137 void (*window_hook) (FILE *, char *);
142 /* Buffer used for reading command lines, and the size
143 allocated for it so far. */
145 char *saved_command_line;
146 int saved_command_line_size = 100;
148 /* Nonzero if the current command is modified by "server ". This
149 affects things like recording into the command history, commands
150 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
151 whatever) can issue its own commands and also send along commands
152 from the user, and have the user not notice that the user interface
153 is issuing commands too. */
156 /* Baud rate specified for talking to serial target systems. Default
157 is left as -1, so targets can choose their own defaults. */
158 /* FIXME: This means that "show remotebaud" and gr_files_info can
159 print -1 or (unsigned int)-1. This is a Bad User Interface. */
163 /* Timeout limit for response from target. */
165 /* The default value has been changed many times over the years. It
166 was originally 5 seconds. But that was thought to be a long time
167 to sit and wait, so it was changed to 2 seconds. That was thought
168 to be plenty unless the connection was going through some terminal
169 server or multiplexer or other form of hairy serial connection.
171 In mid-1996, remote_timeout was moved from remote.c to top.c and
172 it began being used in other remote-* targets. It appears that the
173 default was changed to 20 seconds at that time, perhaps because the
174 Renesas E7000 ICE didn't always respond in a timely manner.
176 But if 5 seconds is a long time to sit and wait for retransmissions,
177 20 seconds is far worse. This demonstrates the difficulty of using
178 a single variable for all protocol timeouts.
180 As remote.c is used much more than remote-e7000.c, it was changed
181 back to 2 seconds in 1999. */
183 int remote_timeout = 2;
185 /* Non-zero tells remote* modules to output debugging info. */
187 int remote_debug = 0;
189 /* Sbrk location on entry to main. Used for statistics only. */
194 /* Hooks for alternate command interfaces. */
196 /* Called after most modules have been initialized, but before taking
199 If the UI fails to initialize and it wants GDB to continue using
200 the default UI, then it should clear this hook before returning. */
202 void (*deprecated_init_ui_hook) (char *argv0);
204 /* This hook is called from within gdb's many mini-event loops which
205 could steal control from a real user interface's event loop. It
206 returns non-zero if the user is requesting a detach, zero
209 int (*deprecated_ui_loop_hook) (int);
211 /* Called instead of command_loop at top level. Can be invoked via
212 throw_exception(). */
214 void (*deprecated_command_loop_hook) (void);
217 /* Called from print_frame_info to list the line we stopped in. */
219 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
223 /* Replaces most of query. */
225 int (*deprecated_query_hook) (const char *, va_list);
227 /* Replaces most of warning. */
229 void (*deprecated_warning_hook) (const char *, va_list);
231 /* These three functions support getting lines of text from the user.
232 They are used in sequence. First deprecated_readline_begin_hook is
233 called with a text string that might be (for example) a message for
234 the user to type in a sequence of commands to be executed at a
235 breakpoint. If this function calls back to a GUI, it might take
236 this opportunity to pop up a text interaction window with this
237 message. Next, deprecated_readline_hook is called with a prompt
238 that is emitted prior to collecting the user input. It can be
239 called multiple times. Finally, deprecated_readline_end_hook is
240 called to notify the GUI that we are done with the interaction
241 window and it can close it. */
243 void (*deprecated_readline_begin_hook) (char *, ...);
244 char *(*deprecated_readline_hook) (char *);
245 void (*deprecated_readline_end_hook) (void);
247 /* Called as appropriate to notify the interface that we have attached
248 to or detached from an already running process. */
250 void (*deprecated_attach_hook) (void);
251 void (*deprecated_detach_hook) (void);
253 /* Called during long calculations to allow GUI to repair window
254 damage, and to check for stop buttons, etc... */
256 void (*deprecated_interactive_hook) (void);
258 /* Tell the GUI someone changed the register REGNO. -1 means
259 that the caller does not know which register changed or
260 that several registers have changed (see value_assign). */
261 void (*deprecated_register_changed_hook) (int regno);
263 /* Called when going to wait for the target. Usually allows the GUI
264 to run while waiting for target events. */
266 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
267 struct target_waitstatus *status,
270 /* Used by UI as a wrapper around command execution. May do various
271 things like enabling/disabling buttons, etc... */
273 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
274 char *cmd, int from_tty);
276 /* Called after a `set' command has finished. Is only run if the
277 `set' command succeeded. */
279 void (*deprecated_set_hook) (struct cmd_list_element * c);
281 /* Called when the current thread changes. Argument is thread id. */
283 void (*deprecated_context_hook) (int id);
285 /* Handler for SIGHUP. */
288 /* NOTE 1999-04-29: This function will be static again, once we modify
289 gdb to use the event loop as the default command loop and we merge
290 event-top.c into this file, top.c. */
294 caution = 0; /* Throw caution to the wind -- we're exiting.
295 This prevents asking the user dumb
297 quit_command ((char *) 0, 0);
299 #endif /* defined SIGHUP */
301 /* Line number we are currently in, in a file which is being sourced. */
302 /* NOTE 1999-04-29: This variable will be static again, once we modify
303 gdb to use the event loop as the default command loop and we merge
304 event-top.c into this file, top.c. */
305 /* static */ int source_line_number;
307 /* Name of the file we are sourcing. */
308 /* NOTE 1999-04-29: This variable will be static again, once we modify
309 gdb to use the event loop as the default command loop and we merge
310 event-top.c into this file, top.c. */
311 /* static */ const char *source_file_name;
313 /* Clean up on error during a "source" command (or execution of a
314 user-defined command). */
317 do_restore_instream_cleanup (void *stream)
319 /* Restore the previous input stream. */
323 /* Read commands from STREAM. */
325 read_command_file (FILE *stream)
327 struct cleanup *cleanups;
329 cleanups = make_cleanup (do_restore_instream_cleanup, instream);
332 do_cleanups (cleanups);
335 void (*pre_init_ui_hook) (void);
339 do_chdir_cleanup (void *old_dir)
347 prepare_execute_command (void)
350 struct cleanup *cleanup;
352 mark = value_mark ();
353 cleanup = make_cleanup_value_free_to_mark (mark);
355 /* With multiple threads running while the one we're examining is
356 stopped, the dcache can get stale without us being able to detect
357 it. For the duration of the command, though, use the dcache to
358 help things like backtrace. */
360 target_dcache_invalidate ();
365 /* 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_if_error, *cleanup;
372 struct cmd_list_element *c;
374 static int warned = 0;
377 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
378 cleanup = prepare_execute_command ();
380 /* Force cleanup of any alloca areas if using C alloca instead of
384 /* This can happen when command_line_input hits end of file. */
387 do_cleanups (cleanup);
391 target_log_command (p);
393 while (*p == ' ' || *p == '\t')
400 /* If trace-commands is set then this will print this command. */
401 print_command_trace (p);
403 c = lookup_cmd (&p, cmdlist, "", 0, 1);
405 /* Pass null arg rather than an empty one. */
408 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
409 while the is_complete_command(cfunc) test is just plain
410 bogus. They should both be replaced by a test of the form
411 c->strip_trailing_white_space_p. */
412 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
413 can't be replaced with func. This is because it is the
414 cfunc, and not the func, that has the value that the
415 is_complete_command hack is testing for. */
416 /* Clear off trailing whitespace, except for set and complete
419 && c->type != set_cmd
420 && !is_complete_command (c))
422 p = arg + strlen (arg) - 1;
423 while (p >= arg && (*p == ' ' || *p == '\t'))
428 /* If this command has been pre-hooked, run the hook first. */
429 execute_cmd_pre_hook (c);
431 if (c->flags & DEPRECATED_WARN_USER)
432 deprecated_cmd_warning (&line);
434 if (c->class == class_user)
435 execute_user_command (c, arg);
436 else if (c->type == set_cmd || c->type == show_cmd)
437 do_setshow_command (arg, from_tty & caution, c);
438 else if (!cmd_func_p (c))
439 error (_("That is not a command, just a help topic."));
440 else if (deprecated_call_command_hook)
441 deprecated_call_command_hook (c, arg, from_tty & caution);
443 cmd_func (c, arg, from_tty & caution);
445 /* If the interpreter is in sync mode (we're running a user
446 command's list, running command hooks or similars), and we
447 just ran a synchronous command that started the target, wait
448 for that command to end. */
449 if (!interpreter_async && sync_execution)
451 while (gdb_do_one_event () >= 0)
456 /* If this command has been post-hooked, run the hook last. */
457 execute_cmd_post_hook (c);
461 /* Tell the user if the language has changed (except first time).
462 First make sure that a new frame has been selected, in case this
463 command or the hooks changed the program state. */
464 deprecated_safe_get_selected_frame ();
465 if (current_language != expected_language)
467 if (language_mode == language_mode_auto && info_verbose)
469 language_info (1); /* Print what changed. */
474 /* Warn the user if the working language does not match the
475 language of the current frame. Only warn the user if we are
476 actually running the program, i.e. there is a stack. */
477 /* FIXME: This should be cacheing the frame and only running when
478 the frame changes. */
480 if (has_stack_frames ())
482 flang = get_frame_language ();
484 && flang != language_unknown
485 && flang != current_language->la_language)
487 printf_filtered ("%s\n", lang_frame_mismatch_warn);
492 do_cleanups (cleanup);
493 discard_cleanups (cleanup_if_error);
496 /* Run execute_command for P and FROM_TTY. Capture its output into the
497 returned string, do not display it to the screen. BATCH_FLAG will be
498 temporarily set to true. */
501 execute_command_to_string (char *p, int from_tty)
503 struct ui_file *str_file;
504 struct cleanup *cleanup;
507 /* GDB_STDOUT should be better already restored during these
508 restoration callbacks. */
509 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
511 make_cleanup_restore_integer (&interpreter_async);
512 interpreter_async = 0;
514 str_file = mem_fileopen ();
516 make_cleanup_ui_file_delete (str_file);
517 make_cleanup_restore_ui_file (&gdb_stdout);
518 make_cleanup_restore_ui_file (&gdb_stderr);
519 make_cleanup_restore_ui_file (&gdb_stdlog);
520 make_cleanup_restore_ui_file (&gdb_stdtarg);
521 make_cleanup_restore_ui_file (&gdb_stdtargerr);
523 if (ui_out_redirect (current_uiout, str_file) < 0)
524 warning (_("Current output protocol does not support redirection"));
526 make_cleanup_ui_out_redirect_pop (current_uiout);
528 gdb_stdout = str_file;
529 gdb_stderr = str_file;
530 gdb_stdlog = str_file;
531 gdb_stdtarg = str_file;
532 gdb_stdtargerr = str_file;
534 execute_command (p, from_tty);
536 retval = ui_file_xstrdup (str_file, NULL);
538 do_cleanups (cleanup);
543 /* Read commands from `instream' and execute them
544 until end of file or error reading instream. */
549 struct cleanup *old_chain;
551 int stdin_is_tty = ISATTY (stdin);
553 while (instream && !feof (instream))
555 if (window_hook && instream == stdin)
556 (*window_hook) (instream, get_prompt ());
559 if (instream == stdin && stdin_is_tty)
560 reinitialize_more_filter ();
561 old_chain = make_cleanup (null_cleanup, 0);
563 /* Get a command-line. This calls the readline package. */
564 command = command_line_input (instream == stdin ?
565 get_prompt () : (char *) NULL,
566 instream == stdin, "prompt");
569 do_cleanups (old_chain);
573 make_command_stats_cleanup (1);
575 execute_command (command, instream == stdin);
577 /* Do any commands attached to breakpoint we are stopped at. */
578 bpstat_do_actions ();
580 do_cleanups (old_chain);
584 /* When nonzero, cause dont_repeat to do nothing. This should only be
585 set via prevent_dont_repeat. */
587 static int suppress_dont_repeat = 0;
589 /* Commands call this if they do not want to be repeated by null lines. */
594 if (suppress_dont_repeat || server_command)
597 /* If we aren't reading from standard input, we are saving the last
598 thing read from stdin in line and don't want to delete it. Null
599 lines won't repeat here in any case. */
600 if (instream == stdin)
601 *saved_command_line = 0;
604 /* Prevent dont_repeat from working, and return a cleanup that
605 restores the previous state. */
608 prevent_dont_repeat (void)
610 struct cleanup *result = make_cleanup_restore_integer (&suppress_dont_repeat);
612 suppress_dont_repeat = 1;
617 /* Read a line from the stream "instream" without command line editing.
619 It prints PROMPT_ARG once at the start.
620 Action is compatible with "readline", e.g. space for the result is
621 malloc'd and should be freed by the caller.
623 A NULL return means end of file. */
625 gdb_readline (char *prompt_arg)
630 int result_size = 80;
634 /* Don't use a _filtered function here. It causes the assumed
635 character position to be off, since the newline we read from
636 the user is not accounted for. */
637 fputs_unfiltered (prompt_arg, gdb_stdout);
638 gdb_flush (gdb_stdout);
641 result = (char *) xmalloc (result_size);
645 /* Read from stdin if we are executing a user defined command.
646 This is the right thing for prompt_for_continue, at least. */
647 c = fgetc (instream ? instream : stdin);
652 /* The last line does not end with a newline. Return it, and
653 if we are called again fgetc will still return EOF and
654 we'll return NULL then. */
662 if (input_index > 0 && result[input_index - 1] == '\r')
667 result[input_index++] = c;
668 while (input_index >= result_size)
671 result = (char *) xrealloc (result, result_size);
675 result[input_index++] = '\0';
679 /* Variables which control command line editing and history
680 substitution. These variables are given default values at the end
682 static int command_editing_p;
684 /* NOTE 1999-04-29: This variable will be static again, once we modify
685 gdb to use the event loop as the default command loop and we merge
686 event-top.c into this file, top.c. */
688 /* static */ int history_expansion_p;
690 static int write_history_p;
692 show_write_history_p (struct ui_file *file, int from_tty,
693 struct cmd_list_element *c, const char *value)
695 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
699 static int history_size;
701 show_history_size (struct ui_file *file, int from_tty,
702 struct cmd_list_element *c, const char *value)
704 fprintf_filtered (file, _("The size of the command history is %s.\n"),
708 static char *history_filename;
710 show_history_filename (struct ui_file *file, int from_tty,
711 struct cmd_list_element *c, const char *value)
713 fprintf_filtered (file, _("The filename in which to record "
714 "the command history is \"%s\".\n"),
718 /* This is like readline(), but it has some gdb-specific behavior.
719 gdb may want readline in both the synchronous and async modes during
720 a single gdb invocation. At the ordinary top-level prompt we might
721 be using the async readline. That means we can't use
722 rl_pre_input_hook, since it doesn't work properly in async mode.
723 However, for a secondary prompt (" >", such as occurs during a
724 `define'), gdb wants a synchronous response.
726 We used to call readline() directly, running it in synchronous
727 mode. But mixing modes this way is not supported, and as of
728 readline 5.x it no longer works; the arrow keys come unbound during
729 the synchronous call. So we make a nested call into the event
730 loop. That's what gdb_readline_wrapper is for. */
732 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
733 rely on gdb_readline_wrapper_result, which might still be NULL if
734 the user types Control-D for EOF. */
735 static int gdb_readline_wrapper_done;
737 /* The result of the current call to gdb_readline_wrapper, once a newline
739 static char *gdb_readline_wrapper_result;
741 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
742 to be called after the newline is processed (which will redisplay
743 the prompt). But in gdb_readline_wrapper we will not get a new
744 prompt until the next call, or until we return to the event loop.
745 So we disable this hook around the newline and restore it before we
747 static void (*saved_after_char_processing_hook) (void);
749 /* This function is called when readline has seen a complete line of
753 gdb_readline_wrapper_line (char *line)
755 gdb_assert (!gdb_readline_wrapper_done);
756 gdb_readline_wrapper_result = line;
757 gdb_readline_wrapper_done = 1;
759 /* Prevent operate-and-get-next from acting too early. */
760 saved_after_char_processing_hook = after_char_processing_hook;
761 after_char_processing_hook = NULL;
763 /* Prevent parts of the prompt from being redisplayed if annotations
764 are enabled, and readline's state getting out of sync. */
765 if (async_command_editing_p)
766 rl_callback_handler_remove ();
769 struct gdb_readline_wrapper_cleanup
771 void (*handler_orig) (char *);
772 int already_prompted_orig;
776 gdb_readline_wrapper_cleanup (void *arg)
778 struct gdb_readline_wrapper_cleanup *cleanup = arg;
780 rl_already_prompted = cleanup->already_prompted_orig;
782 gdb_assert (input_handler == gdb_readline_wrapper_line);
783 input_handler = cleanup->handler_orig;
784 gdb_readline_wrapper_result = NULL;
785 gdb_readline_wrapper_done = 0;
787 after_char_processing_hook = saved_after_char_processing_hook;
788 saved_after_char_processing_hook = NULL;
794 gdb_readline_wrapper (char *prompt)
796 struct cleanup *back_to;
797 struct gdb_readline_wrapper_cleanup *cleanup;
800 cleanup = xmalloc (sizeof (*cleanup));
801 cleanup->handler_orig = input_handler;
802 input_handler = gdb_readline_wrapper_line;
804 cleanup->already_prompted_orig = rl_already_prompted;
806 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
808 /* Display our prompt and prevent double prompt display. */
809 display_gdb_prompt (prompt);
810 rl_already_prompted = 1;
812 if (after_char_processing_hook)
813 (*after_char_processing_hook) ();
814 gdb_assert (after_char_processing_hook == NULL);
816 while (gdb_do_one_event () >= 0)
817 if (gdb_readline_wrapper_done)
820 retval = gdb_readline_wrapper_result;
821 do_cleanups (back_to);
826 /* The current saved history number from operate-and-get-next.
827 This is -1 if not valid. */
828 static int operate_saved_history = -1;
830 /* This is put on the appropriate hook and helps operate-and-get-next
833 gdb_rl_operate_and_get_next_completion (void)
835 int delta = where_history () - operate_saved_history;
837 /* The `key' argument to rl_get_previous_history is ignored. */
838 rl_get_previous_history (delta, 0);
839 operate_saved_history = -1;
841 /* readline doesn't automatically update the display for us. */
844 after_char_processing_hook = NULL;
845 rl_pre_input_hook = NULL;
848 /* This is a gdb-local readline command handler. It accepts the
849 current command line (like RET does) and, if this command was taken
850 from the history, arranges for the next command in the history to
851 appear on the command line when the prompt returns.
852 We ignore the arguments. */
854 gdb_rl_operate_and_get_next (int count, int key)
858 /* Use the async hook. */
859 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
861 /* Find the current line, and find the next line to use. */
862 where = where_history();
864 /* FIXME: kettenis/20020817: max_input_history is renamed into
865 history_max_entries in readline-4.2. When we do a new readline
866 import, we should probably change it here too, even though
867 readline maintains backwards compatibility for now by still
868 defining max_input_history. */
869 if ((history_is_stifled () && (history_length >= max_input_history)) ||
870 (where >= history_length - 1))
871 operate_saved_history = where;
873 operate_saved_history = where + 1;
875 return rl_newline (1, key);
878 /* Read one line from the command input stream `instream'
879 into the local static buffer `linebuffer' (whose current length
881 The buffer is made bigger as necessary.
882 Returns the address of the start of the line.
884 NULL is returned for end of file.
886 *If* the instream == stdin & stdin is a terminal, the line read
887 is copied into the file line saver (global var char *line,
888 length linesize) so that it can be duplicated.
890 This routine either uses fancy command line editing or
891 simple input as the user has requested. */
894 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
896 static char *linebuffer = 0;
897 static unsigned linelength = 0;
901 char *local_prompt = prompt_arg;
905 /* The annotation suffix must be non-NULL. */
906 if (annotation_suffix == NULL)
907 annotation_suffix = "";
909 if (annotation_level > 1 && instream == stdin)
911 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
912 + strlen (annotation_suffix) + 40);
913 if (prompt_arg == NULL)
914 local_prompt[0] = '\0';
916 strcpy (local_prompt, prompt_arg);
917 strcat (local_prompt, "\n\032\032");
918 strcat (local_prompt, annotation_suffix);
919 strcat (local_prompt, "\n");
925 linebuffer = (char *) xmalloc (linelength);
930 /* Control-C quits instantly if typed while in this loop
931 since it should not wait until the user types a newline. */
935 signal (STOP_SIGNAL, handle_stop_sig);
940 /* Make sure that all output has been output. Some machines may
941 let you get away with leaving out some of the gdb_flush, but
944 gdb_flush (gdb_stdout);
945 gdb_flush (gdb_stderr);
947 if (source_file_name != NULL)
948 ++source_line_number;
950 if (annotation_level > 1 && instream == stdin)
952 puts_unfiltered ("\n\032\032pre-");
953 puts_unfiltered (annotation_suffix);
954 puts_unfiltered ("\n");
957 /* Don't use fancy stuff if not talking to stdin. */
958 if (deprecated_readline_hook && input_from_terminal_p ())
960 rl = (*deprecated_readline_hook) (local_prompt);
962 else if (command_editing_p && input_from_terminal_p ())
964 rl = gdb_readline_wrapper (local_prompt);
968 rl = gdb_readline (local_prompt);
971 if (annotation_level > 1 && instream == stdin)
973 puts_unfiltered ("\n\032\032post-");
974 puts_unfiltered (annotation_suffix);
975 puts_unfiltered ("\n");
978 if (!rl || rl == (char *) EOF)
983 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
985 linelength = strlen (rl) + 1 + (p - linebuffer);
986 nline = (char *) xrealloc (linebuffer, linelength);
987 p += nline - linebuffer;
991 /* Copy line. Don't copy null at end. (Leaves line alone
992 if this was just a newline). */
996 xfree (rl); /* Allocated in readline. */
998 if (p == linebuffer || *(p - 1) != '\\')
1001 p--; /* Put on top of '\'. */
1002 local_prompt = (char *) 0;
1007 signal (STOP_SIGNAL, SIG_DFL);
1014 #define SERVER_COMMAND_LENGTH 7
1016 (p - linebuffer > SERVER_COMMAND_LENGTH)
1017 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1020 /* Note that we don't set `line'. Between this and the check in
1021 dont_repeat, this insures that repeating will still do the
1024 return linebuffer + SERVER_COMMAND_LENGTH;
1027 /* Do history expansion if that is wished. */
1028 if (history_expansion_p && instream == stdin
1029 && ISATTY (instream))
1031 char *history_value;
1034 *p = '\0'; /* Insert null now. */
1035 expanded = history_expand (linebuffer, &history_value);
1038 /* Print the changes. */
1039 printf_unfiltered ("%s\n", history_value);
1041 /* If there was an error, call this function again. */
1044 xfree (history_value);
1045 return command_line_input (prompt_arg, repeat,
1048 if (strlen (history_value) > linelength)
1050 linelength = strlen (history_value) + 1;
1051 linebuffer = (char *) xrealloc (linebuffer, linelength);
1053 strcpy (linebuffer, history_value);
1054 p = linebuffer + strlen (linebuffer);
1056 xfree (history_value);
1059 /* If we just got an empty line, and that is supposed to repeat the
1060 previous command, return the value in the global buffer. */
1061 if (repeat && p == linebuffer)
1062 return saved_command_line;
1063 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1065 return saved_command_line;
1069 /* Add line to history if appropriate. */
1070 if (instream == stdin
1071 && ISATTY (stdin) && *linebuffer)
1072 add_history (linebuffer);
1074 /* Note: lines consisting solely of comments are added to the command
1075 history. This is useful when you type a command, and then
1076 realize you don't want to execute it quite yet. You can comment
1077 out the command and then later fetch it from the value history
1078 and remove the '#'. The kill ring is probably better, but some
1079 people are in the habit of commenting things out. */
1081 *p1 = '\0'; /* Found a comment. */
1083 /* Save into global buffer if appropriate. */
1086 if (linelength > saved_command_line_size)
1088 saved_command_line = xrealloc (saved_command_line, linelength);
1089 saved_command_line_size = linelength;
1091 strcpy (saved_command_line, linebuffer);
1092 return saved_command_line;
1098 /* Print the GDB banner. */
1100 print_gdb_version (struct ui_file *stream)
1102 /* From GNU coding standards, first line is meant to be easy for a
1103 program to parse, and is just canonical program name and version
1104 number, which starts after last space. */
1106 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1108 /* Second line is a copyright notice. */
1110 fprintf_filtered (stream,
1111 "Copyright (C) 2011 Free Software Foundation, Inc.\n");
1113 /* Following the copyright is a brief statement that the program is
1114 free software, that users are free to copy and change it on
1115 certain conditions, that it is covered by the GNU GPL, and that
1116 there is no warranty. */
1118 fprintf_filtered (stream, "\
1119 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1120 \nThis is free software: you are free to change and redistribute it.\n\
1121 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1122 and \"show warranty\" for details.\n");
1124 /* After the required info we print the configuration information. */
1126 fprintf_filtered (stream, "This GDB was configured as \"");
1127 if (strcmp (host_name, target_name) != 0)
1129 fprintf_filtered (stream, "--host=%s --target=%s",
1130 host_name, target_name);
1134 fprintf_filtered (stream, "%s", host_name);
1136 fprintf_filtered (stream, "\".");
1138 if (REPORT_BUGS_TO[0])
1140 fprintf_filtered (stream,
1141 _("\nFor bug reporting instructions, please see:\n"));
1142 fprintf_filtered (stream, "%s.", REPORT_BUGS_TO);
1147 /* The current top level prompt, settable with "set prompt", and/or
1148 with the python `gdb.prompt_hook' hook. */
1149 static char *top_prompt;
1151 /* Access method for the GDB prompt string. */
1159 /* Set method for the GDB prompt string. */
1162 set_prompt (const char *s)
1164 char *p = xstrdup (s);
1177 /* Callback for iterate_over_inferiors. Kills or detaches the given
1178 inferior, depending on how we originally gained control of it. */
1181 kill_or_detach (struct inferior *inf, void *args)
1183 struct qt_args *qt = args;
1184 struct thread_info *thread;
1189 thread = any_thread_of_process (inf->pid);
1192 switch_to_thread (thread->ptid);
1194 /* Leave core files alone. */
1195 if (target_has_execution)
1197 if (inf->attach_flag)
1198 target_detach (qt->args, qt->from_tty);
1207 /* Callback for iterate_over_inferiors. Prints info about what GDB
1208 will do to each inferior on a "quit". ARG points to a struct
1209 ui_out where output is to be collected. */
1212 print_inferior_quit_action (struct inferior *inf, void *arg)
1214 struct ui_file *stb = arg;
1219 if (inf->attach_flag)
1220 fprintf_filtered (stb,
1221 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1222 target_pid_to_str (pid_to_ptid (inf->pid)));
1224 fprintf_filtered (stb,
1225 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1226 target_pid_to_str (pid_to_ptid (inf->pid)));
1231 /* If necessary, make the user confirm that we should quit. Return
1232 non-zero if we should quit, zero if we shouldn't. */
1237 struct ui_file *stb;
1238 struct cleanup *old_chain;
1242 /* Don't even ask if we're only debugging a core file inferior. */
1243 if (!have_live_inferiors ())
1246 /* Build the query string as a single string. */
1247 stb = mem_fileopen ();
1248 old_chain = make_cleanup_ui_file_delete (stb);
1250 /* This is something of a hack. But there's no reliable way to see
1251 if a GUI is running. The `use_windows' variable doesn't cut
1253 if (deprecated_init_ui_hook)
1254 fprintf_filtered (stb, _("A debugging session is active.\n"
1255 "Do you still want to close the debugger?"));
1258 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1259 iterate_over_inferiors (print_inferior_quit_action, stb);
1260 fprintf_filtered (stb, _("\nQuit anyway? "));
1263 str = ui_file_xstrdup (stb, NULL);
1264 make_cleanup (xfree, str);
1266 qr = query ("%s", str);
1267 do_cleanups (old_chain);
1271 /* Helper routine for quit_force that requires error handling. */
1274 quit_target (void *arg)
1276 struct qt_args *qt = (struct qt_args *)arg;
1278 /* Kill or detach all inferiors. */
1279 iterate_over_inferiors (kill_or_detach, qt);
1281 /* Give all pushed targets a chance to do minimal cleanup, and pop
1283 pop_all_targets (1);
1285 /* Save the history information if it is appropriate to do so. */
1286 if (write_history_p && history_filename)
1287 write_history (history_filename);
1289 do_final_cleanups (ALL_CLEANUPS); /* Do any final cleanups before
1294 /* Quit without asking for confirmation. */
1297 quit_force (char *args, int from_tty)
1302 /* An optional expression may be used to cause gdb to terminate with the
1303 value of that expression. */
1306 struct value *val = parse_and_eval (args);
1308 exit_code = (int) value_as_long (val);
1310 else if (return_child_result)
1311 exit_code = return_child_result_value;
1314 qt.from_tty = from_tty;
1316 /* We want to handle any quit errors and exit regardless. */
1317 catch_errors (quit_target, &qt,
1318 "Quitting: ", RETURN_MASK_ALL);
1323 /* Returns whether GDB is running on a terminal and input is
1324 currently coming from that terminal. */
1327 input_from_terminal_p (void)
1332 if (gdb_has_a_terminal () && instream == stdin)
1335 /* If INSTREAM is unset, and we are not in a user command, we
1336 must be in Insight. That's like having a terminal, for our
1338 if (instream == NULL && !in_user_command)
1345 dont_repeat_command (char *ignored, int from_tty)
1347 /* Can't call dont_repeat here because we're not necessarily reading
1349 *saved_command_line = 0;
1352 /* Functions to manipulate command line editing control variables. */
1354 /* Number of commands to print in each call to show_commands. */
1355 #define Hist_print 10
1357 show_commands (char *args, int from_tty)
1359 /* Index for history commands. Relative to history_base. */
1362 /* Number of the history entry which we are planning to display next.
1363 Relative to history_base. */
1366 /* The first command in the history which doesn't exist (i.e. one more
1367 than the number of the last command). Relative to history_base. */
1370 /* Print out some of the commands from the command history. */
1371 /* First determine the length of the history list. */
1372 hist_len = history_size;
1373 for (offset = 0; offset < history_size; offset++)
1375 if (!history_get (history_base + offset))
1384 if (args[0] == '+' && args[1] == '\0')
1385 /* "info editing +" should print from the stored position. */
1388 /* "info editing <exp>" should print around command number <exp>. */
1389 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1391 /* "show commands" means print the last Hist_print commands. */
1394 num = hist_len - Hist_print;
1400 /* If there are at least Hist_print commands, we want to display the last
1401 Hist_print rather than, say, the last 6. */
1402 if (hist_len - num < Hist_print)
1404 num = hist_len - Hist_print;
1409 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1411 printf_filtered ("%5d %s\n", history_base + offset,
1412 (history_get (history_base + offset))->line);
1415 /* The next command we want to display is the next one that we haven't
1419 /* If the user repeats this command with return, it should do what
1420 "show commands +" does. This is unnecessary if arg is null,
1421 because "show commands +" is not useful after "show commands". */
1422 if (from_tty && args)
1429 /* Called by do_setshow_command. */
1431 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1433 if (history_size == INT_MAX)
1434 unstifle_history ();
1435 else if (history_size >= 0)
1436 stifle_history (history_size);
1439 history_size = INT_MAX;
1440 error (_("History size must be non-negative"));
1445 set_history (char *args, int from_tty)
1447 printf_unfiltered (_("\"set history\" must be followed "
1448 "by the name of a history subcommand.\n"));
1449 help_list (sethistlist, "set history ", -1, gdb_stdout);
1453 show_history (char *args, int from_tty)
1455 cmd_show_list (showhistlist, from_tty, "");
1458 int info_verbose = 0; /* Default verbose msgs off. */
1460 /* Called by do_setshow_command. An elaborate joke. */
1462 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1464 char *cmdname = "verbose";
1465 struct cmd_list_element *showcmd;
1467 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1468 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1472 c->doc = "Set verbose printing of informational messages.";
1473 showcmd->doc = "Show verbose printing of informational messages.";
1477 c->doc = "Set verbosity.";
1478 showcmd->doc = "Show verbosity.";
1482 /* Init the history buffer. Note that we are called after the init file(s)
1483 have been read so that the user can change the history file via his
1484 .gdbinit file (for instance). The GDBHISTFILE environment variable
1485 overrides all of this. */
1492 tmpenv = getenv ("HISTSIZE");
1494 history_size = atoi (tmpenv);
1495 else if (!history_size)
1498 stifle_history (history_size);
1500 tmpenv = getenv ("GDBHISTFILE");
1502 history_filename = xstrdup (tmpenv);
1503 else if (!history_filename)
1505 /* We include the current directory so that if the user changes
1506 directories the file written will be the same as the one
1509 /* No leading dots in file names are allowed on MSDOS. */
1510 history_filename = concat (current_directory, "/_gdb_history",
1513 history_filename = concat (current_directory, "/.gdb_history",
1517 read_history (history_filename);
1521 show_prompt (struct ui_file *file, int from_tty,
1522 struct cmd_list_element *c, const char *value)
1524 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1528 show_async_command_editing_p (struct ui_file *file, int from_tty,
1529 struct cmd_list_element *c, const char *value)
1531 fprintf_filtered (file, _("Editing of command lines as "
1532 "they are typed is %s.\n"),
1537 show_annotation_level (struct ui_file *file, int from_tty,
1538 struct cmd_list_element *c, const char *value)
1540 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1544 show_exec_done_display_p (struct ui_file *file, int from_tty,
1545 struct cmd_list_element *c, const char *value)
1547 fprintf_filtered (file, _("Notification of completion for "
1548 "asynchronous execution commands is %s.\n"),
1554 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1555 the DEFAULT_PROMPT is. */
1556 set_prompt (DEFAULT_PROMPT);
1558 /* Set things up for annotation_level > 1, if the user ever decides
1560 async_annotation_suffix = "prompt";
1562 /* Set the important stuff up for command editing. */
1563 command_editing_p = 1;
1564 history_expansion_p = 0;
1565 write_history_p = 0;
1567 /* Setup important stuff for command line editing. */
1568 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1569 rl_completion_entry_function = readline_line_completion_function;
1570 rl_completer_word_break_characters = default_word_break_characters ();
1571 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1572 rl_readline_name = "gdb";
1573 rl_terminal_name = getenv ("TERM");
1575 /* The name for this defun comes from Bash, where it originated.
1576 15 is Control-o, the same binding this function has in Bash. */
1577 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1579 add_setshow_string_cmd ("prompt", class_support,
1581 _("Set gdb's prompt"),
1582 _("Show gdb's prompt"),
1585 &setlist, &showlist);
1587 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1588 Don't repeat this command.\nPrimarily \
1589 used inside of user-defined commands that should not be repeated when\n\
1592 add_setshow_boolean_cmd ("editing", class_support,
1593 &async_command_editing_p, _("\
1594 Set editing of command lines as they are typed."), _("\
1595 Show editing of command lines as they are typed."), _("\
1596 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1597 Without an argument, command line editing is enabled. To edit, use\n\
1598 EMACS-like or VI-like commands like control-P or ESC."),
1599 set_async_editing_command,
1600 show_async_command_editing_p,
1601 &setlist, &showlist);
1603 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1604 Set saving of the history record on exit."), _("\
1605 Show saving of the history record on exit."), _("\
1606 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1607 Without an argument, saving is enabled."),
1609 show_write_history_p,
1610 &sethistlist, &showhistlist);
1612 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1613 Set the size of the command history,"), _("\
1614 Show the size of the command history,"), _("\
1615 ie. the number of previous commands to keep a record of."),
1616 set_history_size_command,
1618 &sethistlist, &showhistlist);
1620 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1621 Set the filename in which to record the command history"), _("\
1622 Show the filename in which to record the command history"), _("\
1623 (the list of previous commands of which a record is kept)."),
1625 show_history_filename,
1626 &sethistlist, &showhistlist);
1628 add_setshow_boolean_cmd ("confirm", class_support, &caution, _("\
1629 Set whether to confirm potentially dangerous operations."), _("\
1630 Show whether to confirm potentially dangerous operations."), NULL,
1633 &setlist, &showlist);
1635 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1636 Set annotation_level."), _("\
1637 Show annotation_level."), _("\
1638 0 == normal; 1 == fullname (for use when running under emacs)\n\
1639 2 == output annotated suitably for use by programs that control GDB."),
1641 show_annotation_level,
1642 &setlist, &showlist);
1644 add_setshow_boolean_cmd ("exec-done-display", class_support,
1645 &exec_done_display_p, _("\
1646 Set notification of completion for asynchronous execution commands."), _("\
1647 Show notification of completion for asynchronous execution commands."), _("\
1648 Use \"on\" to enable the notification, and \"off\" to disable it."),
1650 show_exec_done_display_p,
1651 &setlist, &showlist);
1653 add_setshow_filename_cmd ("data-directory", class_maintenance,
1654 &gdb_datadir, _("Set GDB's data directory."),
1655 _("Show GDB's data directory."),
1657 When set, GDB uses the specified path to search for data files."),
1664 gdb_init (char *argv0)
1666 if (pre_init_ui_hook)
1667 pre_init_ui_hook ();
1669 /* Run the init function of each source file. */
1672 /* Make sure we return to the original directory upon exit, come
1673 what may, since the OS doesn't do that for us. */
1674 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1677 init_cmd_lists (); /* This needs to be done first. */
1678 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1679 initialize_utils (); /* Make errors and warnings possible. */
1681 /* Here is where we call all the _initialize_foo routines. */
1682 initialize_all_files ();
1684 /* This creates the current_program_space. Do this after all the
1685 _initialize_foo routines have had a chance to install their
1686 per-sspace data keys. Also do this before
1687 initialize_current_architecture is called, because it accesses
1688 exec_bfd of the current program space. */
1689 initialize_progspace ();
1690 initialize_inferiors ();
1691 initialize_current_architecture ();
1693 init_main (); /* But that omits this file! Do it now. */
1695 initialize_stdin_serial ();
1697 async_init_signals ();
1699 /* We need a default language for parsing expressions, so simple
1700 things like "set width 0" won't fail if no language is explicitly
1701 set in a config file or implicitly set by reading an executable
1703 set_language (language_c);
1704 expected_language = current_language; /* Don't warn about the change. */
1706 /* Allow another UI to initialize. If the UI fails to initialize,
1707 and it wants GDB to revert to the CLI, it should clear
1708 deprecated_init_ui_hook. */
1709 if (deprecated_init_ui_hook)
1710 deprecated_init_ui_hook (argv0);
1713 /* Python initialization can require various commands to be
1714 installed. For example "info pretty-printer" needs the "info"
1715 prefix to be installed. Keep things simple and just do final
1716 python initialization here. */
1717 finish_python_initialization ();