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 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"
51 /* readline include files */
52 #include "readline/readline.h"
53 #include "readline/history.h"
55 /* readline defines this. */
58 #include <sys/types.h>
60 #include "event-top.h"
61 #include "gdb_string.h"
67 /* Default command line prompt. This is overriden in some configs. */
69 #ifndef DEFAULT_PROMPT
70 #define DEFAULT_PROMPT "(gdb) "
73 /* Initialization file name for gdb. This is overridden in some configs. */
77 # define PATH_MAX FILENAME_MAX
83 #ifndef GDBINIT_FILENAME
84 #define GDBINIT_FILENAME ".gdbinit"
86 char gdbinit[PATH_MAX + 1] = GDBINIT_FILENAME;
88 int inhibit_gdbinit = 0;
90 /* If nonzero, and GDB has been configured to be able to use windows,
91 attempt to open them upon startup. */
95 extern char lang_frame_mismatch_warn[]; /* language.c */
97 /* Flag for whether we want all the "from_tty" gubbish printed. */
99 int caution = 1; /* Default is yes, sigh. */
101 show_caution (struct ui_file *file, int from_tty,
102 struct cmd_list_element *c, const char *value)
104 fprintf_filtered (file, _("\
105 Whether to confirm potentially dangerous operations is %s.\n"),
109 /* stdio stream that command input is being read from. Set to stdin normally.
110 Set by source_command to the file we are sourcing. Set to NULL if we are
111 executing a user-defined command or interacting via a GUI. */
115 /* Flag to indicate whether a user defined command is currently running. */
119 /* Current working directory. */
121 char *current_directory;
123 /* The directory name is actually stored here (usually). */
124 char gdb_dirbuf[1024];
126 /* Function to call before reading a command, if nonzero.
127 The function receives two args: an input stream,
128 and a prompt string. */
130 void (*window_hook) (FILE *, char *);
135 /* Buffer used for reading command lines, and the size
136 allocated for it so far. */
141 /* Nonzero if the current command is modified by "server ". This
142 affects things like recording into the command history, commands
143 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
144 whatever) can issue its own commands and also send along commands
145 from the user, and have the user not notice that the user interface
146 is issuing commands too. */
149 /* Baud rate specified for talking to serial target systems. Default
150 is left as -1, so targets can choose their own defaults. */
151 /* FIXME: This means that "show remotebaud" and gr_files_info can print -1
152 or (unsigned int)-1. This is a Bad User Interface. */
156 /* Timeout limit for response from target. */
158 /* The default value has been changed many times over the years. It
159 was originally 5 seconds. But that was thought to be a long time
160 to sit and wait, so it was changed to 2 seconds. That was thought
161 to be plenty unless the connection was going through some terminal
162 server or multiplexer or other form of hairy serial connection.
164 In mid-1996, remote_timeout was moved from remote.c to top.c and
165 it began being used in other remote-* targets. It appears that the
166 default was changed to 20 seconds at that time, perhaps because the
167 Renesas E7000 ICE didn't always respond in a timely manner.
169 But if 5 seconds is a long time to sit and wait for retransmissions,
170 20 seconds is far worse. This demonstrates the difficulty of using
171 a single variable for all protocol timeouts.
173 As remote.c is used much more than remote-e7000.c, it was changed
174 back to 2 seconds in 1999. */
176 int remote_timeout = 2;
178 /* Non-zero tells remote* modules to output debugging info. */
180 int remote_debug = 0;
182 /* Sbrk location on entry to main. Used for statistics only. */
187 /* Signal to catch ^Z typed while reading a command: SIGTSTP or SIGCONT. */
191 #define STOP_SIGNAL SIGTSTP
192 static void stop_sig (int);
196 /* Hooks for alternate command interfaces. */
198 /* Called after most modules have been initialized, but before taking users
201 If the UI fails to initialize and it wants GDB to continue
202 using the default UI, then it should clear this hook before returning. */
204 void (*deprecated_init_ui_hook) (char *argv0);
206 /* This hook is called from within gdb's many mini-event loops which could
207 steal control from a real user interface's event loop. It returns
208 non-zero if the user is requesting a detach, zero otherwise. */
210 int (*deprecated_ui_loop_hook) (int);
212 /* Called instead of command_loop at top level. Can be invoked via
213 throw_exception(). */
215 void (*deprecated_command_loop_hook) (void);
218 /* Called from print_frame_info to list the line we stopped in. */
220 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s, int line,
221 int stopline, int noerror);
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 damage, and to
253 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 /* Tell the GUI someone changed LEN bytes of memory at ADDR */
263 void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
265 /* Called when going to wait for the target. Usually allows the GUI to run
266 while waiting for target events. */
268 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
269 struct target_waitstatus *status,
272 /* Used by UI as a wrapper around command execution. May do various things
273 like enabling/disabling buttons, etc... */
275 void (*deprecated_call_command_hook) (struct cmd_list_element * c, char *cmd,
278 /* Called after a `set' command has finished. Is only run if the
279 `set' command succeeded. */
281 void (*deprecated_set_hook) (struct cmd_list_element * c);
283 /* Called when the current thread changes. Argument is thread id. */
285 void (*deprecated_context_hook) (int id);
287 /* Handler for SIGHUP. */
290 /* NOTE 1999-04-29: This function will be static again, once we modify
291 gdb to use the event loop as the default command loop and we merge
292 event-top.c into this file, top.c */
296 caution = 0; /* Throw caution to the wind -- we're exiting.
297 This prevents asking the user dumb questions. */
298 quit_command ((char *) 0, 0);
301 #endif /* defined SIGHUP */
303 /* Line number we are currently in in a file which is being sourced. */
304 /* NOTE 1999-04-29: This variable will be static again, once we modify
305 gdb to use the event loop as the default command loop and we merge
306 event-top.c into this file, top.c */
307 /* static */ int source_line_number;
309 /* Name of the file we are sourcing. */
310 /* NOTE 1999-04-29: This variable will be static again, once we modify
311 gdb to use the event loop as the default command loop and we merge
312 event-top.c into this file, top.c */
313 /* static */ char *source_file_name;
315 /* Clean up on error during a "source" command (or execution of a
316 user-defined command). */
319 do_restore_instream_cleanup (void *stream)
321 /* Restore the previous input stream. */
325 /* Read commands from STREAM. */
327 read_command_file (FILE *stream)
329 struct cleanup *cleanups;
331 cleanups = make_cleanup (do_restore_instream_cleanup, instream);
334 do_cleanups (cleanups);
337 void (*pre_init_ui_hook) (void);
341 do_chdir_cleanup (void *old_dir)
349 prepare_execute_command (void)
353 /* With multiple threads running while the one we're examining is stopped,
354 the dcache can get stale without us being able to detect it.
355 For the duration of the command, though, use the dcache to help
356 things like backtrace. */
358 target_dcache_invalidate ();
361 /* Execute the line P as a command, in the current user context.
362 Pass FROM_TTY as second argument to the defining function. */
365 execute_command (char *p, int from_tty)
367 struct cmd_list_element *c;
369 static int warned = 0;
371 long time_at_cmd_start = 0;
373 long space_at_cmd_start = 0;
375 extern int display_time;
376 extern int display_space;
378 if (target_can_async_p ())
380 time_at_cmd_start = get_run_time ();
385 char *lim = (char *) sbrk (0);
386 space_at_cmd_start = lim - lim_at_start;
391 prepare_execute_command ();
393 /* Force cleanup of any alloca areas if using C alloca instead of
397 /* This can happen when command_line_input hits end of file. */
401 target_log_command (p);
403 while (*p == ' ' || *p == '\t')
410 /* If trace-commands is set then this will print this command. */
411 print_command_trace (p);
413 c = lookup_cmd (&p, cmdlist, "", 0, 1);
415 /* Pass null arg rather than an empty one. */
418 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
419 while the is_complete_command(cfunc) test is just plain
420 bogus. They should both be replaced by a test of the form
421 c->strip_trailing_white_space_p. */
422 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
423 can't be replaced with func. This is because it is the
424 cfunc, and not the func, that has the value that the
425 is_complete_command hack is testing for. */
426 /* Clear off trailing whitespace, except for set and complete
429 && c->type != set_cmd
430 && !is_complete_command (c))
432 p = arg + strlen (arg) - 1;
433 while (p >= arg && (*p == ' ' || *p == '\t'))
438 /* If this command has been pre-hooked, run the hook first. */
439 execute_cmd_pre_hook (c);
441 if (c->flags & DEPRECATED_WARN_USER)
442 deprecated_cmd_warning (&line);
444 if (c->class == class_user)
445 execute_user_command (c, arg);
446 else if (c->type == set_cmd || c->type == show_cmd)
447 do_setshow_command (arg, from_tty & caution, c);
448 else if (!cmd_func_p (c))
449 error (_("That is not a command, just a help topic."));
450 else if (deprecated_call_command_hook)
451 deprecated_call_command_hook (c, arg, from_tty & caution);
453 cmd_func (c, arg, from_tty & caution);
455 /* If this command has been post-hooked, run the hook last. */
456 execute_cmd_post_hook (c);
460 /* Tell the user if the language has changed (except first time). */
461 if (current_language != expected_language)
463 if (language_mode == language_mode_auto)
465 language_info (1); /* Print what changed. */
470 /* Warn the user if the working language does not match the
471 language of the current frame. Only warn the user if we are
472 actually running the program, i.e. there is a stack. */
473 /* FIXME: This should be cacheing the frame and only running when
474 the frame changes. */
476 if (has_stack_frames ())
478 flang = get_frame_language ();
480 && flang != language_unknown
481 && flang != current_language->la_language)
483 printf_filtered ("%s\n", lang_frame_mismatch_warn);
489 /* Read commands from `instream' and execute them
490 until end of file or error reading instream. */
495 struct cleanup *old_chain;
497 int stdin_is_tty = ISATTY (stdin);
498 long time_at_cmd_start;
500 long space_at_cmd_start = 0;
502 extern int display_time;
503 extern int display_space;
505 while (instream && !feof (instream))
507 if (window_hook && instream == stdin)
508 (*window_hook) (instream, get_prompt ());
511 if (instream == stdin && stdin_is_tty)
512 reinitialize_more_filter ();
513 old_chain = make_cleanup (null_cleanup, 0);
515 /* Get a command-line. This calls the readline package. */
516 command = command_line_input (instream == stdin ?
517 get_prompt () : (char *) NULL,
518 instream == stdin, "prompt");
522 time_at_cmd_start = get_run_time ();
527 char *lim = (char *) sbrk (0);
528 space_at_cmd_start = lim - lim_at_start;
532 execute_command (command, instream == stdin);
534 /* Do any commands attached to breakpoint we are stopped at. */
535 bpstat_do_actions ();
537 do_cleanups (old_chain);
541 long cmd_time = get_run_time () - time_at_cmd_start;
543 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
544 cmd_time / 1000000, cmd_time % 1000000);
550 char *lim = (char *) sbrk (0);
551 long space_now = lim - lim_at_start;
552 long space_diff = space_now - space_at_cmd_start;
554 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
556 (space_diff >= 0 ? "+" : ""),
563 /* Commands call this if they do not want to be repeated by null lines. */
571 /* If we aren't reading from standard input, we are saving the last
572 thing read from stdin in line and don't want to delete it. Null lines
573 won't repeat here in any case. */
574 if (instream == stdin)
578 /* Read a line from the stream "instream" without command line editing.
580 It prints PROMPT_ARG once at the start.
581 Action is compatible with "readline", e.g. space for the result is
582 malloc'd and should be freed by the caller.
584 A NULL return means end of file. */
586 gdb_readline (char *prompt_arg)
591 int result_size = 80;
595 /* Don't use a _filtered function here. It causes the assumed
596 character position to be off, since the newline we read from
597 the user is not accounted for. */
598 fputs_unfiltered (prompt_arg, gdb_stdout);
599 gdb_flush (gdb_stdout);
602 result = (char *) xmalloc (result_size);
606 /* Read from stdin if we are executing a user defined command.
607 This is the right thing for prompt_for_continue, at least. */
608 c = fgetc (instream ? instream : stdin);
613 /* The last line does not end with a newline. Return it, and
614 if we are called again fgetc will still return EOF and
615 we'll return NULL then. */
623 if (input_index > 0 && result[input_index - 1] == '\r')
628 result[input_index++] = c;
629 while (input_index >= result_size)
632 result = (char *) xrealloc (result, result_size);
636 result[input_index++] = '\0';
640 /* Variables which control command line editing and history
641 substitution. These variables are given default values at the end
643 static int command_editing_p;
645 /* NOTE 1999-04-29: This variable will be static again, once we modify
646 gdb to use the event loop as the default command loop and we merge
647 event-top.c into this file, top.c */
649 /* static */ int history_expansion_p;
651 static int write_history_p;
653 show_write_history_p (struct ui_file *file, int from_tty,
654 struct cmd_list_element *c, const char *value)
656 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
660 static int history_size;
662 show_history_size (struct ui_file *file, int from_tty,
663 struct cmd_list_element *c, const char *value)
665 fprintf_filtered (file, _("The size of the command history is %s.\n"),
669 static char *history_filename;
671 show_history_filename (struct ui_file *file, int from_tty,
672 struct cmd_list_element *c, const char *value)
674 fprintf_filtered (file, _("\
675 The filename in which to record the command history is \"%s\".\n"),
679 /* This is like readline(), but it has some gdb-specific behavior.
680 gdb may want readline in both the synchronous and async modes during
681 a single gdb invocation. At the ordinary top-level prompt we might
682 be using the async readline. That means we can't use
683 rl_pre_input_hook, since it doesn't work properly in async mode.
684 However, for a secondary prompt (" >", such as occurs during a
685 `define'), gdb wants a synchronous response.
687 We used to call readline() directly, running it in synchronous
688 mode. But mixing modes this way is not supported, and as of
689 readline 5.x it no longer works; the arrow keys come unbound during
690 the synchronous call. So we make a nested call into the event
691 loop. That's what gdb_readline_wrapper is for. */
693 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
694 rely on gdb_readline_wrapper_result, which might still be NULL if
695 the user types Control-D for EOF. */
696 static int gdb_readline_wrapper_done;
698 /* The result of the current call to gdb_readline_wrapper, once a newline
700 static char *gdb_readline_wrapper_result;
702 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
703 to be called after the newline is processed (which will redisplay
704 the prompt). But in gdb_readline_wrapper we will not get a new
705 prompt until the next call, or until we return to the event loop.
706 So we disable this hook around the newline and restore it before we
708 static void (*saved_after_char_processing_hook) (void);
710 /* This function is called when readline has seen a complete line of
714 gdb_readline_wrapper_line (char *line)
716 gdb_assert (!gdb_readline_wrapper_done);
717 gdb_readline_wrapper_result = line;
718 gdb_readline_wrapper_done = 1;
720 /* Prevent operate-and-get-next from acting too early. */
721 saved_after_char_processing_hook = after_char_processing_hook;
722 after_char_processing_hook = NULL;
724 /* Prevent parts of the prompt from being redisplayed if annotations
725 are enabled, and readline's state getting out of sync. */
726 if (async_command_editing_p)
727 rl_callback_handler_remove ();
730 struct gdb_readline_wrapper_cleanup
732 void (*handler_orig) (char *);
733 int already_prompted_orig;
737 gdb_readline_wrapper_cleanup (void *arg)
739 struct gdb_readline_wrapper_cleanup *cleanup = arg;
741 rl_already_prompted = cleanup->already_prompted_orig;
743 gdb_assert (input_handler == gdb_readline_wrapper_line);
744 input_handler = cleanup->handler_orig;
745 gdb_readline_wrapper_result = NULL;
746 gdb_readline_wrapper_done = 0;
748 after_char_processing_hook = saved_after_char_processing_hook;
749 saved_after_char_processing_hook = NULL;
755 gdb_readline_wrapper (char *prompt)
757 struct cleanup *back_to;
758 struct gdb_readline_wrapper_cleanup *cleanup;
761 cleanup = xmalloc (sizeof (*cleanup));
762 cleanup->handler_orig = input_handler;
763 input_handler = gdb_readline_wrapper_line;
765 cleanup->already_prompted_orig = rl_already_prompted;
767 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
769 /* Display our prompt and prevent double prompt display. */
770 display_gdb_prompt (prompt);
771 rl_already_prompted = 1;
773 if (after_char_processing_hook)
774 (*after_char_processing_hook) ();
775 gdb_assert (after_char_processing_hook == NULL);
777 /* gdb_do_one_event argument is unused. */
778 while (gdb_do_one_event (NULL) >= 0)
779 if (gdb_readline_wrapper_done)
782 retval = gdb_readline_wrapper_result;
783 do_cleanups (back_to);
792 #if STOP_SIGNAL == SIGTSTP
793 signal (SIGTSTP, SIG_DFL);
799 sigprocmask (SIG_SETMASK, &zero, 0);
801 #elif HAVE_SIGSETMASK
804 kill (getpid (), SIGTSTP);
805 signal (SIGTSTP, stop_sig);
807 signal (STOP_SIGNAL, stop_sig);
809 printf_unfiltered ("%s", get_prompt ());
810 gdb_flush (gdb_stdout);
812 /* Forget about any previous command -- null line now will do nothing. */
815 #endif /* STOP_SIGNAL */
817 /* Initialize signal handlers. */
819 float_handler (int signo)
821 /* This message is based on ANSI C, section 4.7. Note that integer
822 divide by zero causes this, so "float" is a misnomer. */
823 signal (SIGFPE, float_handler);
824 error (_("Erroneous arithmetic operation."));
828 do_nothing (int signo)
830 /* Under System V the default disposition of a signal is reinstated after
831 the signal is caught and delivered to an application process. On such
832 systems one must restore the replacement signal handler if one wishes
833 to continue handling the signal in one's program. On BSD systems this
834 is not needed but it is harmless, and it simplifies the code to just do
835 it unconditionally. */
836 signal (signo, do_nothing);
839 /* The current saved history number from operate-and-get-next.
840 This is -1 if not valid. */
841 static int operate_saved_history = -1;
843 /* This is put on the appropriate hook and helps operate-and-get-next
846 gdb_rl_operate_and_get_next_completion (void)
848 int delta = where_history () - operate_saved_history;
849 /* The `key' argument to rl_get_previous_history is ignored. */
850 rl_get_previous_history (delta, 0);
851 operate_saved_history = -1;
853 /* readline doesn't automatically update the display for us. */
856 after_char_processing_hook = NULL;
857 rl_pre_input_hook = NULL;
860 /* This is a gdb-local readline command handler. It accepts the
861 current command line (like RET does) and, if this command was taken
862 from the history, arranges for the next command in the history to
863 appear on the command line when the prompt returns.
864 We ignore the arguments. */
866 gdb_rl_operate_and_get_next (int count, int key)
870 /* Use the async hook. */
871 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
873 /* Find the current line, and find the next line to use. */
874 where = where_history();
876 /* FIXME: kettenis/20020817: max_input_history is renamed into
877 history_max_entries in readline-4.2. When we do a new readline
878 import, we should probably change it here too, even though
879 readline maintains backwards compatibility for now by still
880 defining max_input_history. */
881 if ((history_is_stifled () && (history_length >= max_input_history)) ||
882 (where >= history_length - 1))
883 operate_saved_history = where;
885 operate_saved_history = where + 1;
887 return rl_newline (1, key);
890 /* Read one line from the command input stream `instream'
891 into the local static buffer `linebuffer' (whose current length
893 The buffer is made bigger as necessary.
894 Returns the address of the start of the line.
896 NULL is returned for end of file.
898 *If* the instream == stdin & stdin is a terminal, the line read
899 is copied into the file line saver (global var char *line,
900 length linesize) so that it can be duplicated.
902 This routine either uses fancy command line editing or
903 simple input as the user has requested. */
906 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
908 static char *linebuffer = 0;
909 static unsigned linelength = 0;
913 char *local_prompt = prompt_arg;
917 /* The annotation suffix must be non-NULL. */
918 if (annotation_suffix == NULL)
919 annotation_suffix = "";
921 if (annotation_level > 1 && instream == stdin)
923 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
924 + strlen (annotation_suffix) + 40);
925 if (prompt_arg == NULL)
926 local_prompt[0] = '\0';
928 strcpy (local_prompt, prompt_arg);
929 strcat (local_prompt, "\n\032\032");
930 strcat (local_prompt, annotation_suffix);
931 strcat (local_prompt, "\n");
937 linebuffer = (char *) xmalloc (linelength);
942 /* Control-C quits instantly if typed while in this loop
943 since it should not wait until the user types a newline. */
947 signal (STOP_SIGNAL, handle_stop_sig);
952 /* Make sure that all output has been output. Some machines may let
953 you get away with leaving out some of the gdb_flush, but not all. */
955 gdb_flush (gdb_stdout);
956 gdb_flush (gdb_stderr);
958 if (source_file_name != NULL)
959 ++source_line_number;
961 if (annotation_level > 1 && instream == stdin)
963 puts_unfiltered ("\n\032\032pre-");
964 puts_unfiltered (annotation_suffix);
965 puts_unfiltered ("\n");
968 /* Don't use fancy stuff if not talking to stdin. */
969 if (deprecated_readline_hook && input_from_terminal_p ())
971 rl = (*deprecated_readline_hook) (local_prompt);
973 else if (command_editing_p && input_from_terminal_p ())
975 rl = gdb_readline_wrapper (local_prompt);
979 rl = gdb_readline (local_prompt);
982 if (annotation_level > 1 && instream == stdin)
984 puts_unfiltered ("\n\032\032post-");
985 puts_unfiltered (annotation_suffix);
986 puts_unfiltered ("\n");
989 if (!rl || rl == (char *) EOF)
994 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
996 linelength = strlen (rl) + 1 + (p - linebuffer);
997 nline = (char *) xrealloc (linebuffer, linelength);
998 p += nline - linebuffer;
1002 /* Copy line. Don't copy null at end. (Leaves line alone
1003 if this was just a newline) */
1007 xfree (rl); /* Allocated in readline. */
1009 if (p == linebuffer || *(p - 1) != '\\')
1012 p--; /* Put on top of '\'. */
1013 local_prompt = (char *) 0;
1018 signal (STOP_SIGNAL, SIG_DFL);
1025 #define SERVER_COMMAND_LENGTH 7
1027 (p - linebuffer > SERVER_COMMAND_LENGTH)
1028 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1031 /* Note that we don't set `line'. Between this and the check in
1032 dont_repeat, this insures that repeating will still do the
1035 return linebuffer + SERVER_COMMAND_LENGTH;
1038 /* Do history expansion if that is wished. */
1039 if (history_expansion_p && instream == stdin
1040 && ISATTY (instream))
1042 char *history_value;
1045 *p = '\0'; /* Insert null now. */
1046 expanded = history_expand (linebuffer, &history_value);
1049 /* Print the changes. */
1050 printf_unfiltered ("%s\n", history_value);
1052 /* If there was an error, call this function again. */
1055 xfree (history_value);
1056 return command_line_input (prompt_arg, repeat, annotation_suffix);
1058 if (strlen (history_value) > linelength)
1060 linelength = strlen (history_value) + 1;
1061 linebuffer = (char *) xrealloc (linebuffer, linelength);
1063 strcpy (linebuffer, history_value);
1064 p = linebuffer + strlen (linebuffer);
1066 xfree (history_value);
1069 /* If we just got an empty line, and that is supposed
1070 to repeat the previous command, return the value in the
1072 if (repeat && p == linebuffer)
1074 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1080 /* Add line to history if appropriate. */
1081 if (instream == stdin
1082 && ISATTY (stdin) && *linebuffer)
1083 add_history (linebuffer);
1085 /* Note: lines consisting solely of comments are added to the command
1086 history. This is useful when you type a command, and then
1087 realize you don't want to execute it quite yet. You can comment
1088 out the command and then later fetch it from the value history
1089 and remove the '#'. The kill ring is probably better, but some
1090 people are in the habit of commenting things out. */
1092 *p1 = '\0'; /* Found a comment. */
1094 /* Save into global buffer if appropriate. */
1097 if (linelength > linesize)
1099 line = xrealloc (line, linelength);
1100 linesize = linelength;
1102 strcpy (line, linebuffer);
1109 /* Print the GDB banner. */
1111 print_gdb_version (struct ui_file *stream)
1113 /* From GNU coding standards, first line is meant to be easy for a
1114 program to parse, and is just canonical program name and version
1115 number, which starts after last space. */
1117 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1119 /* Second line is a copyright notice. */
1121 fprintf_filtered (stream, "Copyright (C) 2009 Free Software Foundation, Inc.\n");
1123 /* Following the copyright is a brief statement that the program is
1124 free software, that users are free to copy and change it on
1125 certain conditions, that it is covered by the GNU GPL, and that
1126 there is no warranty. */
1128 fprintf_filtered (stream, "\
1129 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1130 This is free software: you are free to change and redistribute it.\n\
1131 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1132 and \"show warranty\" for details.\n");
1134 /* After the required info we print the configuration information. */
1136 fprintf_filtered (stream, "This GDB was configured as \"");
1137 if (strcmp (host_name, target_name) != 0)
1139 fprintf_filtered (stream, "--host=%s --target=%s", host_name, target_name);
1143 fprintf_filtered (stream, "%s", host_name);
1145 fprintf_filtered (stream, "\".");
1147 if (REPORT_BUGS_TO[0])
1149 fprintf_filtered (stream,
1150 _("\nFor bug reporting instructions, please see:\n"));
1151 fprintf_filtered (stream, "%s.", REPORT_BUGS_TO);
1155 /* get_prompt: access method for the GDB prompt string. */
1164 set_prompt (char *s)
1166 /* ??rehrauer: I don't know why this fails, since it looks as though
1167 assignments to prompt are wrapped in calls to xstrdup...
1171 PROMPT (0) = xstrdup (s);
1181 /* Callback for iterate_over_inferiors. Kills or detaches the given
1182 inferior, depending on how we originally gained control of it. */
1185 kill_or_detach (struct inferior *inf, void *args)
1187 struct qt_args *qt = args;
1188 struct thread_info *thread;
1190 thread = any_thread_of_process (inf->pid);
1193 switch_to_thread (thread->ptid);
1195 /* Leave core files alone. */
1196 if (target_has_execution)
1198 if (inf->attach_flag)
1199 target_detach (qt->args, qt->from_tty);
1208 /* Callback for iterate_over_inferiors. Prints info about what GDB
1209 will do to each inferior on a "quit". ARG points to a struct
1210 ui_out where output is to be collected. */
1213 print_inferior_quit_action (struct inferior *inf, void *arg)
1215 struct ui_file *stb = arg;
1217 if (inf->attach_flag)
1218 fprintf_filtered (stb,
1219 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1220 target_pid_to_str (pid_to_ptid (inf->pid)));
1222 fprintf_filtered (stb,
1223 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1224 target_pid_to_str (pid_to_ptid (inf->pid)));
1229 /* If necessary, make the user confirm that we should quit. Return
1230 non-zero if we should quit, zero if we shouldn't. */
1235 struct ui_file *stb;
1236 struct cleanup *old_chain;
1240 /* Don't even ask if we're only debugging a core file inferior. */
1241 if (!have_live_inferiors ())
1244 /* Build the query string as a single string. */
1245 stb = mem_fileopen ();
1246 old_chain = make_cleanup_ui_file_delete (stb);
1248 /* This is something of a hack. But there's no reliable way to see
1249 if a GUI is running. The `use_windows' variable doesn't cut
1251 if (deprecated_init_ui_hook)
1252 fprintf_filtered (stb, _("A debugging session is active.\n"
1253 "Do you still want to close the debugger?"));
1256 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1257 iterate_over_inferiors (print_inferior_quit_action, stb);
1258 fprintf_filtered (stb, _("\nQuit anyway? "));
1261 str = ui_file_xstrdup (stb, NULL);
1262 make_cleanup (xfree, str);
1264 qr = query ("%s", str);
1265 do_cleanups (old_chain);
1269 /* Helper routine for quit_force that requires error handling. */
1272 quit_target (void *arg)
1274 struct qt_args *qt = (struct qt_args *)arg;
1276 /* Kill or detach all inferiors. */
1277 iterate_over_inferiors (kill_or_detach, qt);
1279 /* Give all pushed targets a chance to do minimal cleanup, and pop
1281 pop_all_targets (1);
1283 /* Save the history information if it is appropriate to do so. */
1284 if (write_history_p && history_filename)
1285 write_history (history_filename);
1287 do_final_cleanups (ALL_CLEANUPS); /* Do any final cleanups before exiting */
1292 /* Quit without asking for confirmation. */
1295 quit_force (char *args, int from_tty)
1300 /* An optional expression may be used to cause gdb to terminate with the
1301 value of that expression. */
1304 struct value *val = parse_and_eval (args);
1306 exit_code = (int) value_as_long (val);
1308 else if (return_child_result)
1309 exit_code = return_child_result_value;
1312 qt.from_tty = from_tty;
1314 /* We want to handle any quit errors and exit regardless. */
1315 catch_errors (quit_target, &qt,
1316 "Quitting: ", RETURN_MASK_ALL);
1321 /* If OFF, the debugger will run in non-interactive mode, which means
1322 that it will automatically select the default answer to all the
1323 queries made to the user. If ON, gdb will wait for the user to
1324 answer all queries. If AUTO, gdb will determine whether to run
1325 in interactive mode or not depending on whether stdin is a terminal
1327 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1329 /* Implement the "show interactive-mode" option. */
1332 show_interactive_mode (struct ui_file *file, int from_tty,
1333 struct cmd_list_element *c,
1336 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1337 fprintf_filtered (file, "\
1338 Debugger's interactive mode is %s (currently %s).\n",
1339 value, input_from_terminal_p () ? "on" : "off");
1341 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1344 /* Returns whether GDB is running on a terminal and input is
1345 currently coming from that terminal. */
1348 input_from_terminal_p (void)
1350 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1351 return interactive_mode == AUTO_BOOLEAN_TRUE;
1353 if (gdb_has_a_terminal () && instream == stdin)
1356 /* If INSTREAM is unset, and we are not in a user command, we
1357 must be in Insight. That's like having a terminal, for our
1359 if (instream == NULL && !in_user_command)
1366 dont_repeat_command (char *ignored, int from_tty)
1368 *line = 0; /* Can't call dont_repeat here because we're not
1369 necessarily reading from stdin. */
1372 /* Functions to manipulate command line editing control variables. */
1374 /* Number of commands to print in each call to show_commands. */
1375 #define Hist_print 10
1377 show_commands (char *args, int from_tty)
1379 /* Index for history commands. Relative to history_base. */
1382 /* Number of the history entry which we are planning to display next.
1383 Relative to history_base. */
1386 /* The first command in the history which doesn't exist (i.e. one more
1387 than the number of the last command). Relative to history_base. */
1390 /* Print out some of the commands from the command history. */
1391 /* First determine the length of the history list. */
1392 hist_len = history_size;
1393 for (offset = 0; offset < history_size; offset++)
1395 if (!history_get (history_base + offset))
1404 if (args[0] == '+' && args[1] == '\0')
1405 /* "info editing +" should print from the stored position. */
1408 /* "info editing <exp>" should print around command number <exp>. */
1409 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1411 /* "show commands" means print the last Hist_print commands. */
1414 num = hist_len - Hist_print;
1420 /* If there are at least Hist_print commands, we want to display the last
1421 Hist_print rather than, say, the last 6. */
1422 if (hist_len - num < Hist_print)
1424 num = hist_len - Hist_print;
1429 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1431 printf_filtered ("%5d %s\n", history_base + offset,
1432 (history_get (history_base + offset))->line);
1435 /* The next command we want to display is the next one that we haven't
1439 /* If the user repeats this command with return, it should do what
1440 "show commands +" does. This is unnecessary if arg is null,
1441 because "show commands +" is not useful after "show commands". */
1442 if (from_tty && args)
1449 /* Called by do_setshow_command. */
1451 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1453 if (history_size == INT_MAX)
1454 unstifle_history ();
1455 else if (history_size >= 0)
1456 stifle_history (history_size);
1459 history_size = INT_MAX;
1460 error (_("History size must be non-negative"));
1465 set_history (char *args, int from_tty)
1467 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1468 help_list (sethistlist, "set history ", -1, gdb_stdout);
1472 show_history (char *args, int from_tty)
1474 cmd_show_list (showhistlist, from_tty, "");
1477 int info_verbose = 0; /* Default verbose msgs off */
1479 /* Called by do_setshow_command. An elaborate joke. */
1481 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1483 char *cmdname = "verbose";
1484 struct cmd_list_element *showcmd;
1486 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1490 c->doc = "Set verbose printing of informational messages.";
1491 showcmd->doc = "Show verbose printing of informational messages.";
1495 c->doc = "Set verbosity.";
1496 showcmd->doc = "Show verbosity.";
1500 /* Init the history buffer. Note that we are called after the init file(s)
1501 * have been read so that the user can change the history file via his
1502 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1503 * overrides all of this.
1511 tmpenv = getenv ("HISTSIZE");
1513 history_size = atoi (tmpenv);
1514 else if (!history_size)
1517 stifle_history (history_size);
1519 tmpenv = getenv ("GDBHISTFILE");
1521 history_filename = xstrdup (tmpenv);
1522 else if (!history_filename)
1524 /* We include the current directory so that if the user changes
1525 directories the file written will be the same as the one
1528 /* No leading dots in file names are allowed on MSDOS. */
1529 history_filename = concat (current_directory, "/_gdb_history",
1532 history_filename = concat (current_directory, "/.gdb_history",
1536 read_history (history_filename);
1540 show_new_async_prompt (struct ui_file *file, int from_tty,
1541 struct cmd_list_element *c, const char *value)
1543 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1547 show_async_command_editing_p (struct ui_file *file, int from_tty,
1548 struct cmd_list_element *c, const char *value)
1550 fprintf_filtered (file, _("\
1551 Editing of command lines as they are typed is %s.\n"),
1556 show_annotation_level (struct ui_file *file, int from_tty,
1557 struct cmd_list_element *c, const char *value)
1559 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1563 show_exec_done_display_p (struct ui_file *file, int from_tty,
1564 struct cmd_list_element *c, const char *value)
1566 fprintf_filtered (file, _("\
1567 Notification of completion for asynchronous execution commands is %s.\n"),
1573 struct cmd_list_element *c;
1575 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1576 whatever the DEFAULT_PROMPT is. */
1577 the_prompts.top = 0;
1579 PROMPT (0) = xstrdup (DEFAULT_PROMPT);
1581 /* Set things up for annotation_level > 1, if the user ever decides
1583 async_annotation_suffix = "prompt";
1584 /* Set the variable associated with the setshow prompt command. */
1585 new_async_prompt = xstrdup (PROMPT (0));
1587 /* If gdb was started with --annotate=2, this is equivalent to the
1588 user entering the command 'set annotate 2' at the gdb prompt, so
1589 we need to do extra processing. */
1590 if (annotation_level > 1)
1591 set_async_annotation_level (NULL, 0, NULL);
1593 /* Set the important stuff up for command editing. */
1594 command_editing_p = 1;
1595 history_expansion_p = 0;
1596 write_history_p = 0;
1598 /* Setup important stuff for command line editing. */
1599 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1600 rl_completion_entry_function = readline_line_completion_function;
1601 rl_completer_word_break_characters = default_word_break_characters ();
1602 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1603 rl_readline_name = "gdb";
1604 rl_terminal_name = getenv ("TERM");
1606 /* The name for this defun comes from Bash, where it originated.
1607 15 is Control-o, the same binding this function has in Bash. */
1608 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1610 add_setshow_string_cmd ("prompt", class_support,
1611 &new_async_prompt, _("\
1612 Set gdb's prompt"), _("\
1613 Show gdb's prompt"), NULL,
1615 show_new_async_prompt,
1616 &setlist, &showlist);
1618 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1619 Don't repeat this command.\n\
1620 Primarily used inside of user-defined commands that should not be repeated when\n\
1623 add_setshow_boolean_cmd ("editing", class_support,
1624 &async_command_editing_p, _("\
1625 Set editing of command lines as they are typed."), _("\
1626 Show editing of command lines as they are typed."), _("\
1627 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1628 Without an argument, command line editing is enabled. To edit, use\n\
1629 EMACS-like or VI-like commands like control-P or ESC."),
1630 set_async_editing_command,
1631 show_async_command_editing_p,
1632 &setlist, &showlist);
1634 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1635 Set saving of the history record on exit."), _("\
1636 Show saving of the history record on exit."), _("\
1637 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1638 Without an argument, saving is enabled."),
1640 show_write_history_p,
1641 &sethistlist, &showhistlist);
1643 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1644 Set the size of the command history,"), _("\
1645 Show the size of the command history,"), _("\
1646 ie. the number of previous commands to keep a record of."),
1647 set_history_size_command,
1649 &sethistlist, &showhistlist);
1651 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1652 Set the filename in which to record the command history"), _("\
1653 Show the filename in which to record the command history"), _("\
1654 (the list of previous commands of which a record is kept)."),
1656 show_history_filename,
1657 &sethistlist, &showhistlist);
1659 add_setshow_boolean_cmd ("confirm", class_support, &caution, _("\
1660 Set whether to confirm potentially dangerous operations."), _("\
1661 Show whether to confirm potentially dangerous operations."), NULL,
1664 &setlist, &showlist);
1666 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1667 Set annotation_level."), _("\
1668 Show annotation_level."), _("\
1669 0 == normal; 1 == fullname (for use when running under emacs)\n\
1670 2 == output annotated suitably for use by programs that control GDB."),
1671 set_async_annotation_level,
1672 show_annotation_level,
1673 &setlist, &showlist);
1675 add_setshow_boolean_cmd ("exec-done-display", class_support,
1676 &exec_done_display_p, _("\
1677 Set notification of completion for asynchronous execution commands."), _("\
1678 Show notification of completion for asynchronous execution commands."), _("\
1679 Use \"on\" to enable the notification, and \"off\" to disable it."),
1681 show_exec_done_display_p,
1682 &setlist, &showlist);
1684 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
1685 &interactive_mode, _("\
1686 Set whether GDB should run in interactive mode or not"), _("\
1687 Show whether GDB runs in interactive mode"), _("\
1688 If on, run in interactive mode and wait for the user to answer\n\
1689 all queries. If off, run in non-interactive mode and automatically\n\
1690 assume the default answer to all queries. If auto (the default),\n\
1691 determine which mode to use based on the standard input settings"),
1693 show_interactive_mode,
1694 &setlist, &showlist);
1696 add_setshow_filename_cmd ("data-directory", class_maintenance,
1697 &gdb_datadir, _("Set GDB's data directory."),
1698 _("Show GDB's data directory."),
1700 When set, GDB uses the specified path to search for data files."),
1707 gdb_init (char *argv0)
1709 if (pre_init_ui_hook)
1710 pre_init_ui_hook ();
1712 /* Run the init function of each source file */
1715 /* Make sure we return to the original directory upon exit, come
1716 what may, since the OS doesn't do that for us. */
1717 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1720 init_cmd_lists (); /* This needs to be done first */
1721 initialize_targets (); /* Setup target_terminal macros for utils.c */
1722 initialize_utils (); /* Make errors and warnings possible */
1723 initialize_all_files ();
1724 initialize_current_architecture ();
1726 init_main (); /* But that omits this file! Do it now */
1728 initialize_stdin_serial ();
1730 async_init_signals ();
1732 /* We need a default language for parsing expressions, so simple things like
1733 "set width 0" won't fail if no language is explicitly set in a config file
1734 or implicitly set by reading an executable during startup. */
1735 set_language (language_c);
1736 expected_language = current_language; /* don't warn about the change. */
1738 /* Allow another UI to initialize. If the UI fails to initialize,
1739 and it wants GDB to revert to the CLI, it should clear
1740 deprecated_init_ui_hook. */
1741 if (deprecated_init_ui_hook)
1742 deprecated_init_ui_hook (argv0);