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)
348 /* Execute the line P as a command, in the current user context.
349 Pass FROM_TTY as second argument to the defining function. */
352 execute_command (char *p, int from_tty)
354 struct cmd_list_element *c;
356 static int warned = 0;
358 long time_at_cmd_start = 0;
360 long space_at_cmd_start = 0;
362 extern int display_time;
363 extern int display_space;
365 if (target_can_async_p ())
367 time_at_cmd_start = get_run_time ();
372 char *lim = (char *) sbrk (0);
373 space_at_cmd_start = lim - lim_at_start;
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. */
388 target_log_command (p);
390 while (*p == ' ' || *p == '\t')
397 /* If trace-commands is set then this will print this command. */
398 print_command_trace (p);
400 c = lookup_cmd (&p, cmdlist, "", 0, 1);
402 /* Pass null arg rather than an empty one. */
405 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
406 while the is_complete_command(cfunc) test is just plain
407 bogus. They should both be replaced by a test of the form
408 c->strip_trailing_white_space_p. */
409 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
410 can't be replaced with func. This is because it is the
411 cfunc, and not the func, that has the value that the
412 is_complete_command hack is testing for. */
413 /* Clear off trailing whitespace, except for set and complete
416 && c->type != set_cmd
417 && !is_complete_command (c))
419 p = arg + strlen (arg) - 1;
420 while (p >= arg && (*p == ' ' || *p == '\t'))
425 /* If this command has been pre-hooked, run the hook first. */
426 execute_cmd_pre_hook (c);
428 if (c->flags & DEPRECATED_WARN_USER)
429 deprecated_cmd_warning (&line);
431 if (c->class == class_user)
432 execute_user_command (c, arg);
433 else if (c->type == set_cmd || c->type == show_cmd)
434 do_setshow_command (arg, from_tty & caution, c);
435 else if (!cmd_func_p (c))
436 error (_("That is not a command, just a help topic."));
437 else if (deprecated_call_command_hook)
438 deprecated_call_command_hook (c, arg, from_tty & caution);
440 cmd_func (c, arg, from_tty & caution);
442 /* If this command has been post-hooked, run the hook last. */
443 execute_cmd_post_hook (c);
447 /* Tell the user if the language has changed (except first time). */
448 if (current_language != expected_language)
450 if (language_mode == language_mode_auto)
452 language_info (1); /* Print what changed. */
457 /* Warn the user if the working language does not match the
458 language of the current frame. Only warn the user if we are
459 actually running the program, i.e. there is a stack. */
460 /* FIXME: This should be cacheing the frame and only running when
461 the frame changes. */
463 if (has_stack_frames ())
465 flang = get_frame_language ();
467 && flang != language_unknown
468 && flang != current_language->la_language)
470 printf_filtered ("%s\n", lang_frame_mismatch_warn);
476 /* Read commands from `instream' and execute them
477 until end of file or error reading instream. */
482 struct cleanup *old_chain;
484 int stdin_is_tty = ISATTY (stdin);
485 long time_at_cmd_start;
487 long space_at_cmd_start = 0;
489 extern int display_time;
490 extern int display_space;
492 while (instream && !feof (instream))
494 if (window_hook && instream == stdin)
495 (*window_hook) (instream, get_prompt ());
498 if (instream == stdin && stdin_is_tty)
499 reinitialize_more_filter ();
500 old_chain = make_cleanup (null_cleanup, 0);
502 /* Get a command-line. This calls the readline package. */
503 command = command_line_input (instream == stdin ?
504 get_prompt () : (char *) NULL,
505 instream == stdin, "prompt");
509 time_at_cmd_start = get_run_time ();
514 char *lim = (char *) sbrk (0);
515 space_at_cmd_start = lim - lim_at_start;
519 execute_command (command, instream == stdin);
521 /* Do any commands attached to breakpoint we are stopped at. */
522 bpstat_do_actions ();
524 do_cleanups (old_chain);
528 long cmd_time = get_run_time () - time_at_cmd_start;
530 printf_unfiltered (_("Command execution time: %ld.%06ld\n"),
531 cmd_time / 1000000, cmd_time % 1000000);
537 char *lim = (char *) sbrk (0);
538 long space_now = lim - lim_at_start;
539 long space_diff = space_now - space_at_cmd_start;
541 printf_unfiltered (_("Space used: %ld (%s%ld for this command)\n"),
543 (space_diff >= 0 ? "+" : ""),
550 /* Commands call this if they do not want to be repeated by null lines. */
558 /* If we aren't reading from standard input, we are saving the last
559 thing read from stdin in line and don't want to delete it. Null lines
560 won't repeat here in any case. */
561 if (instream == stdin)
565 /* Read a line from the stream "instream" without command line editing.
567 It prints PROMPT_ARG once at the start.
568 Action is compatible with "readline", e.g. space for the result is
569 malloc'd and should be freed by the caller.
571 A NULL return means end of file. */
573 gdb_readline (char *prompt_arg)
578 int result_size = 80;
582 /* Don't use a _filtered function here. It causes the assumed
583 character position to be off, since the newline we read from
584 the user is not accounted for. */
585 fputs_unfiltered (prompt_arg, gdb_stdout);
586 gdb_flush (gdb_stdout);
589 result = (char *) xmalloc (result_size);
593 /* Read from stdin if we are executing a user defined command.
594 This is the right thing for prompt_for_continue, at least. */
595 c = fgetc (instream ? instream : stdin);
600 /* The last line does not end with a newline. Return it, and
601 if we are called again fgetc will still return EOF and
602 we'll return NULL then. */
610 if (input_index > 0 && result[input_index - 1] == '\r')
615 result[input_index++] = c;
616 while (input_index >= result_size)
619 result = (char *) xrealloc (result, result_size);
623 result[input_index++] = '\0';
627 /* Variables which control command line editing and history
628 substitution. These variables are given default values at the end
630 static int command_editing_p;
632 /* NOTE 1999-04-29: This variable will be static again, once we modify
633 gdb to use the event loop as the default command loop and we merge
634 event-top.c into this file, top.c */
636 /* static */ int history_expansion_p;
638 static int write_history_p;
640 show_write_history_p (struct ui_file *file, int from_tty,
641 struct cmd_list_element *c, const char *value)
643 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
647 static int history_size;
649 show_history_size (struct ui_file *file, int from_tty,
650 struct cmd_list_element *c, const char *value)
652 fprintf_filtered (file, _("The size of the command history is %s.\n"),
656 static char *history_filename;
658 show_history_filename (struct ui_file *file, int from_tty,
659 struct cmd_list_element *c, const char *value)
661 fprintf_filtered (file, _("\
662 The filename in which to record the command history is \"%s\".\n"),
666 /* This is like readline(), but it has some gdb-specific behavior.
667 gdb may want readline in both the synchronous and async modes during
668 a single gdb invocation. At the ordinary top-level prompt we might
669 be using the async readline. That means we can't use
670 rl_pre_input_hook, since it doesn't work properly in async mode.
671 However, for a secondary prompt (" >", such as occurs during a
672 `define'), gdb wants a synchronous response.
674 We used to call readline() directly, running it in synchronous
675 mode. But mixing modes this way is not supported, and as of
676 readline 5.x it no longer works; the arrow keys come unbound during
677 the synchronous call. So we make a nested call into the event
678 loop. That's what gdb_readline_wrapper is for. */
680 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
681 rely on gdb_readline_wrapper_result, which might still be NULL if
682 the user types Control-D for EOF. */
683 static int gdb_readline_wrapper_done;
685 /* The result of the current call to gdb_readline_wrapper, once a newline
687 static char *gdb_readline_wrapper_result;
689 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
690 to be called after the newline is processed (which will redisplay
691 the prompt). But in gdb_readline_wrapper we will not get a new
692 prompt until the next call, or until we return to the event loop.
693 So we disable this hook around the newline and restore it before we
695 static void (*saved_after_char_processing_hook) (void);
697 /* This function is called when readline has seen a complete line of
701 gdb_readline_wrapper_line (char *line)
703 gdb_assert (!gdb_readline_wrapper_done);
704 gdb_readline_wrapper_result = line;
705 gdb_readline_wrapper_done = 1;
707 /* Prevent operate-and-get-next from acting too early. */
708 saved_after_char_processing_hook = after_char_processing_hook;
709 after_char_processing_hook = NULL;
711 /* Prevent parts of the prompt from being redisplayed if annotations
712 are enabled, and readline's state getting out of sync. */
713 if (async_command_editing_p)
714 rl_callback_handler_remove ();
717 struct gdb_readline_wrapper_cleanup
719 void (*handler_orig) (char *);
720 int already_prompted_orig;
724 gdb_readline_wrapper_cleanup (void *arg)
726 struct gdb_readline_wrapper_cleanup *cleanup = arg;
728 rl_already_prompted = cleanup->already_prompted_orig;
730 gdb_assert (input_handler == gdb_readline_wrapper_line);
731 input_handler = cleanup->handler_orig;
732 gdb_readline_wrapper_result = NULL;
733 gdb_readline_wrapper_done = 0;
735 after_char_processing_hook = saved_after_char_processing_hook;
736 saved_after_char_processing_hook = NULL;
742 gdb_readline_wrapper (char *prompt)
744 struct cleanup *back_to;
745 struct gdb_readline_wrapper_cleanup *cleanup;
748 cleanup = xmalloc (sizeof (*cleanup));
749 cleanup->handler_orig = input_handler;
750 input_handler = gdb_readline_wrapper_line;
752 cleanup->already_prompted_orig = rl_already_prompted;
754 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
756 /* Display our prompt and prevent double prompt display. */
757 display_gdb_prompt (prompt);
758 rl_already_prompted = 1;
760 if (after_char_processing_hook)
761 (*after_char_processing_hook) ();
762 gdb_assert (after_char_processing_hook == NULL);
764 /* gdb_do_one_event argument is unused. */
765 while (gdb_do_one_event (NULL) >= 0)
766 if (gdb_readline_wrapper_done)
769 retval = gdb_readline_wrapper_result;
770 do_cleanups (back_to);
779 #if STOP_SIGNAL == SIGTSTP
780 signal (SIGTSTP, SIG_DFL);
786 sigprocmask (SIG_SETMASK, &zero, 0);
788 #elif HAVE_SIGSETMASK
791 kill (getpid (), SIGTSTP);
792 signal (SIGTSTP, stop_sig);
794 signal (STOP_SIGNAL, stop_sig);
796 printf_unfiltered ("%s", get_prompt ());
797 gdb_flush (gdb_stdout);
799 /* Forget about any previous command -- null line now will do nothing. */
802 #endif /* STOP_SIGNAL */
804 /* Initialize signal handlers. */
806 float_handler (int signo)
808 /* This message is based on ANSI C, section 4.7. Note that integer
809 divide by zero causes this, so "float" is a misnomer. */
810 signal (SIGFPE, float_handler);
811 error (_("Erroneous arithmetic operation."));
815 do_nothing (int signo)
817 /* Under System V the default disposition of a signal is reinstated after
818 the signal is caught and delivered to an application process. On such
819 systems one must restore the replacement signal handler if one wishes
820 to continue handling the signal in one's program. On BSD systems this
821 is not needed but it is harmless, and it simplifies the code to just do
822 it unconditionally. */
823 signal (signo, do_nothing);
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;
836 /* The `key' argument to rl_get_previous_history is ignored. */
837 rl_get_previous_history (delta, 0);
838 operate_saved_history = -1;
840 /* readline doesn't automatically update the display for us. */
843 after_char_processing_hook = NULL;
844 rl_pre_input_hook = NULL;
847 /* This is a gdb-local readline command handler. It accepts the
848 current command line (like RET does) and, if this command was taken
849 from the history, arranges for the next command in the history to
850 appear on the command line when the prompt returns.
851 We ignore the arguments. */
853 gdb_rl_operate_and_get_next (int count, int key)
857 /* Use the async hook. */
858 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
860 /* Find the current line, and find the next line to use. */
861 where = where_history();
863 /* FIXME: kettenis/20020817: max_input_history is renamed into
864 history_max_entries in readline-4.2. When we do a new readline
865 import, we should probably change it here too, even though
866 readline maintains backwards compatibility for now by still
867 defining max_input_history. */
868 if ((history_is_stifled () && (history_length >= max_input_history)) ||
869 (where >= history_length - 1))
870 operate_saved_history = where;
872 operate_saved_history = where + 1;
874 return rl_newline (1, key);
877 /* Read one line from the command input stream `instream'
878 into the local static buffer `linebuffer' (whose current length
880 The buffer is made bigger as necessary.
881 Returns the address of the start of the line.
883 NULL is returned for end of file.
885 *If* the instream == stdin & stdin is a terminal, the line read
886 is copied into the file line saver (global var char *line,
887 length linesize) so that it can be duplicated.
889 This routine either uses fancy command line editing or
890 simple input as the user has requested. */
893 command_line_input (char *prompt_arg, int repeat, char *annotation_suffix)
895 static char *linebuffer = 0;
896 static unsigned linelength = 0;
900 char *local_prompt = prompt_arg;
904 /* The annotation suffix must be non-NULL. */
905 if (annotation_suffix == NULL)
906 annotation_suffix = "";
908 if (annotation_level > 1 && instream == stdin)
910 local_prompt = alloca ((prompt_arg == NULL ? 0 : strlen (prompt_arg))
911 + strlen (annotation_suffix) + 40);
912 if (prompt_arg == NULL)
913 local_prompt[0] = '\0';
915 strcpy (local_prompt, prompt_arg);
916 strcat (local_prompt, "\n\032\032");
917 strcat (local_prompt, annotation_suffix);
918 strcat (local_prompt, "\n");
924 linebuffer = (char *) xmalloc (linelength);
929 /* Control-C quits instantly if typed while in this loop
930 since it should not wait until the user types a newline. */
934 signal (STOP_SIGNAL, handle_stop_sig);
939 /* Make sure that all output has been output. Some machines may let
940 you get away with leaving out some of the gdb_flush, but not all. */
942 gdb_flush (gdb_stdout);
943 gdb_flush (gdb_stderr);
945 if (source_file_name != NULL)
946 ++source_line_number;
948 if (annotation_level > 1 && instream == stdin)
950 puts_unfiltered ("\n\032\032pre-");
951 puts_unfiltered (annotation_suffix);
952 puts_unfiltered ("\n");
955 /* Don't use fancy stuff if not talking to stdin. */
956 if (deprecated_readline_hook && input_from_terminal_p ())
958 rl = (*deprecated_readline_hook) (local_prompt);
960 else if (command_editing_p && input_from_terminal_p ())
962 rl = gdb_readline_wrapper (local_prompt);
966 rl = gdb_readline (local_prompt);
969 if (annotation_level > 1 && instream == stdin)
971 puts_unfiltered ("\n\032\032post-");
972 puts_unfiltered (annotation_suffix);
973 puts_unfiltered ("\n");
976 if (!rl || rl == (char *) EOF)
981 if (strlen (rl) + 1 + (p - linebuffer) > linelength)
983 linelength = strlen (rl) + 1 + (p - linebuffer);
984 nline = (char *) xrealloc (linebuffer, linelength);
985 p += nline - linebuffer;
989 /* Copy line. Don't copy null at end. (Leaves line alone
990 if this was just a newline) */
994 xfree (rl); /* Allocated in readline. */
996 if (p == linebuffer || *(p - 1) != '\\')
999 p--; /* Put on top of '\'. */
1000 local_prompt = (char *) 0;
1005 signal (STOP_SIGNAL, SIG_DFL);
1012 #define SERVER_COMMAND_LENGTH 7
1014 (p - linebuffer > SERVER_COMMAND_LENGTH)
1015 && strncmp (linebuffer, "server ", SERVER_COMMAND_LENGTH) == 0;
1018 /* Note that we don't set `line'. Between this and the check in
1019 dont_repeat, this insures that repeating will still do the
1022 return linebuffer + SERVER_COMMAND_LENGTH;
1025 /* Do history expansion if that is wished. */
1026 if (history_expansion_p && instream == stdin
1027 && ISATTY (instream))
1029 char *history_value;
1032 *p = '\0'; /* Insert null now. */
1033 expanded = history_expand (linebuffer, &history_value);
1036 /* Print the changes. */
1037 printf_unfiltered ("%s\n", history_value);
1039 /* If there was an error, call this function again. */
1042 xfree (history_value);
1043 return command_line_input (prompt_arg, repeat, annotation_suffix);
1045 if (strlen (history_value) > linelength)
1047 linelength = strlen (history_value) + 1;
1048 linebuffer = (char *) xrealloc (linebuffer, linelength);
1050 strcpy (linebuffer, history_value);
1051 p = linebuffer + strlen (linebuffer);
1053 xfree (history_value);
1056 /* If we just got an empty line, and that is supposed
1057 to repeat the previous command, return the value in the
1059 if (repeat && p == linebuffer)
1061 for (p1 = linebuffer; *p1 == ' ' || *p1 == '\t'; p1++);
1067 /* Add line to history if appropriate. */
1068 if (instream == stdin
1069 && ISATTY (stdin) && *linebuffer)
1070 add_history (linebuffer);
1072 /* Note: lines consisting solely of comments are added to the command
1073 history. This is useful when you type a command, and then
1074 realize you don't want to execute it quite yet. You can comment
1075 out the command and then later fetch it from the value history
1076 and remove the '#'. The kill ring is probably better, but some
1077 people are in the habit of commenting things out. */
1079 *p1 = '\0'; /* Found a comment. */
1081 /* Save into global buffer if appropriate. */
1084 if (linelength > linesize)
1086 line = xrealloc (line, linelength);
1087 linesize = linelength;
1089 strcpy (line, linebuffer);
1096 /* Print the GDB banner. */
1098 print_gdb_version (struct ui_file *stream)
1100 /* From GNU coding standards, first line is meant to be easy for a
1101 program to parse, and is just canonical program name and version
1102 number, which starts after last space. */
1104 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1106 /* Second line is a copyright notice. */
1108 fprintf_filtered (stream, "Copyright (C) 2009 Free Software Foundation, Inc.\n");
1110 /* Following the copyright is a brief statement that the program is
1111 free software, that users are free to copy and change it on
1112 certain conditions, that it is covered by the GNU GPL, and that
1113 there is no warranty. */
1115 fprintf_filtered (stream, "\
1116 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\
1117 This is free software: you are free to change and redistribute it.\n\
1118 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1119 and \"show warranty\" for details.\n");
1121 /* After the required info we print the configuration information. */
1123 fprintf_filtered (stream, "This GDB was configured as \"");
1124 if (strcmp (host_name, target_name) != 0)
1126 fprintf_filtered (stream, "--host=%s --target=%s", host_name, target_name);
1130 fprintf_filtered (stream, "%s", host_name);
1132 fprintf_filtered (stream, "\".");
1134 if (REPORT_BUGS_TO[0])
1136 fprintf_filtered (stream,
1137 _("\nFor bug reporting instructions, please see:\n"));
1138 fprintf_filtered (stream, "%s.", REPORT_BUGS_TO);
1142 /* get_prompt: access method for the GDB prompt string. */
1151 set_prompt (char *s)
1153 /* ??rehrauer: I don't know why this fails, since it looks as though
1154 assignments to prompt are wrapped in calls to xstrdup...
1158 PROMPT (0) = xstrdup (s);
1168 /* Callback for iterate_over_inferiors. Kills or detaches the given
1169 inferior, depending on how we originally gained control of it. */
1172 kill_or_detach (struct inferior *inf, void *args)
1174 struct qt_args *qt = args;
1175 struct thread_info *thread;
1177 thread = any_thread_of_process (inf->pid);
1180 switch_to_thread (thread->ptid);
1182 /* Leave core files alone. */
1183 if (target_has_execution)
1185 if (inf->attach_flag)
1186 target_detach (qt->args, qt->from_tty);
1195 /* Callback for iterate_over_inferiors. Prints info about what GDB
1196 will do to each inferior on a "quit". ARG points to a struct
1197 ui_out where output is to be collected. */
1200 print_inferior_quit_action (struct inferior *inf, void *arg)
1202 struct ui_file *stb = arg;
1204 if (inf->attach_flag)
1205 fprintf_filtered (stb,
1206 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1207 target_pid_to_str (pid_to_ptid (inf->pid)));
1209 fprintf_filtered (stb,
1210 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1211 target_pid_to_str (pid_to_ptid (inf->pid)));
1216 /* If necessary, make the user confirm that we should quit. Return
1217 non-zero if we should quit, zero if we shouldn't. */
1222 struct ui_file *stb;
1223 struct cleanup *old_chain;
1227 /* Don't even ask if we're only debugging a core file inferior. */
1228 if (!have_live_inferiors ())
1231 /* Build the query string as a single string. */
1232 stb = mem_fileopen ();
1233 old_chain = make_cleanup_ui_file_delete (stb);
1235 /* This is something of a hack. But there's no reliable way to see
1236 if a GUI is running. The `use_windows' variable doesn't cut
1238 if (deprecated_init_ui_hook)
1239 fprintf_filtered (stb, _("A debugging session is active.\n"
1240 "Do you still want to close the debugger?"));
1243 fprintf_filtered (stb, _("A debugging session is active.\n\n"));
1244 iterate_over_inferiors (print_inferior_quit_action, stb);
1245 fprintf_filtered (stb, _("\nQuit anyway? "));
1248 str = ui_file_xstrdup (stb, NULL);
1249 make_cleanup (xfree, str);
1251 qr = query ("%s", str);
1252 do_cleanups (old_chain);
1256 /* Helper routine for quit_force that requires error handling. */
1259 quit_target (void *arg)
1261 struct qt_args *qt = (struct qt_args *)arg;
1263 /* Kill or detach all inferiors. */
1264 iterate_over_inferiors (kill_or_detach, qt);
1266 /* Give all pushed targets a chance to do minimal cleanup, and pop
1268 pop_all_targets (1);
1270 /* Save the history information if it is appropriate to do so. */
1271 if (write_history_p && history_filename)
1272 write_history (history_filename);
1274 do_final_cleanups (ALL_CLEANUPS); /* Do any final cleanups before exiting */
1279 /* Quit without asking for confirmation. */
1282 quit_force (char *args, int from_tty)
1287 /* An optional expression may be used to cause gdb to terminate with the
1288 value of that expression. */
1291 struct value *val = parse_and_eval (args);
1293 exit_code = (int) value_as_long (val);
1295 else if (return_child_result)
1296 exit_code = return_child_result_value;
1299 qt.from_tty = from_tty;
1301 /* We want to handle any quit errors and exit regardless. */
1302 catch_errors (quit_target, &qt,
1303 "Quitting: ", RETURN_MASK_ALL);
1308 /* Returns whether GDB is running on a terminal and input is
1309 currently coming from that terminal. */
1312 input_from_terminal_p (void)
1314 if (gdb_has_a_terminal () && instream == stdin)
1317 /* If INSTREAM is unset, and we are not in a user command, we
1318 must be in Insight. That's like having a terminal, for our
1320 if (instream == NULL && !in_user_command)
1327 dont_repeat_command (char *ignored, int from_tty)
1329 *line = 0; /* Can't call dont_repeat here because we're not
1330 necessarily reading from stdin. */
1333 /* Functions to manipulate command line editing control variables. */
1335 /* Number of commands to print in each call to show_commands. */
1336 #define Hist_print 10
1338 show_commands (char *args, int from_tty)
1340 /* Index for history commands. Relative to history_base. */
1343 /* Number of the history entry which we are planning to display next.
1344 Relative to history_base. */
1347 /* The first command in the history which doesn't exist (i.e. one more
1348 than the number of the last command). Relative to history_base. */
1351 /* Print out some of the commands from the command history. */
1352 /* First determine the length of the history list. */
1353 hist_len = history_size;
1354 for (offset = 0; offset < history_size; offset++)
1356 if (!history_get (history_base + offset))
1365 if (args[0] == '+' && args[1] == '\0')
1366 /* "info editing +" should print from the stored position. */
1369 /* "info editing <exp>" should print around command number <exp>. */
1370 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1372 /* "show commands" means print the last Hist_print commands. */
1375 num = hist_len - Hist_print;
1381 /* If there are at least Hist_print commands, we want to display the last
1382 Hist_print rather than, say, the last 6. */
1383 if (hist_len - num < Hist_print)
1385 num = hist_len - Hist_print;
1390 for (offset = num; offset < num + Hist_print && offset < hist_len; offset++)
1392 printf_filtered ("%5d %s\n", history_base + offset,
1393 (history_get (history_base + offset))->line);
1396 /* The next command we want to display is the next one that we haven't
1400 /* If the user repeats this command with return, it should do what
1401 "show commands +" does. This is unnecessary if arg is null,
1402 because "show commands +" is not useful after "show commands". */
1403 if (from_tty && args)
1410 /* Called by do_setshow_command. */
1412 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1414 if (history_size == INT_MAX)
1415 unstifle_history ();
1416 else if (history_size >= 0)
1417 stifle_history (history_size);
1420 history_size = INT_MAX;
1421 error (_("History size must be non-negative"));
1426 set_history (char *args, int from_tty)
1428 printf_unfiltered (_("\"set history\" must be followed by the name of a history subcommand.\n"));
1429 help_list (sethistlist, "set history ", -1, gdb_stdout);
1433 show_history (char *args, int from_tty)
1435 cmd_show_list (showhistlist, from_tty, "");
1438 int info_verbose = 0; /* Default verbose msgs off */
1440 /* Called by do_setshow_command. An elaborate joke. */
1442 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1444 char *cmdname = "verbose";
1445 struct cmd_list_element *showcmd;
1447 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1451 c->doc = "Set verbose printing of informational messages.";
1452 showcmd->doc = "Show verbose printing of informational messages.";
1456 c->doc = "Set verbosity.";
1457 showcmd->doc = "Show verbosity.";
1461 /* Init the history buffer. Note that we are called after the init file(s)
1462 * have been read so that the user can change the history file via his
1463 * .gdbinit file (for instance). The GDBHISTFILE environment variable
1464 * overrides all of this.
1472 tmpenv = getenv ("HISTSIZE");
1474 history_size = atoi (tmpenv);
1475 else if (!history_size)
1478 stifle_history (history_size);
1480 tmpenv = getenv ("GDBHISTFILE");
1482 history_filename = xstrdup (tmpenv);
1483 else if (!history_filename)
1485 /* We include the current directory so that if the user changes
1486 directories the file written will be the same as the one
1489 /* No leading dots in file names are allowed on MSDOS. */
1490 history_filename = concat (current_directory, "/_gdb_history",
1493 history_filename = concat (current_directory, "/.gdb_history",
1497 read_history (history_filename);
1501 show_new_async_prompt (struct ui_file *file, int from_tty,
1502 struct cmd_list_element *c, const char *value)
1504 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1508 show_async_command_editing_p (struct ui_file *file, int from_tty,
1509 struct cmd_list_element *c, const char *value)
1511 fprintf_filtered (file, _("\
1512 Editing of command lines as they are typed is %s.\n"),
1517 show_annotation_level (struct ui_file *file, int from_tty,
1518 struct cmd_list_element *c, const char *value)
1520 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1524 show_exec_done_display_p (struct ui_file *file, int from_tty,
1525 struct cmd_list_element *c, const char *value)
1527 fprintf_filtered (file, _("\
1528 Notification of completion for asynchronous execution commands is %s.\n"),
1534 struct cmd_list_element *c;
1536 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1537 whatever the DEFAULT_PROMPT is. */
1538 the_prompts.top = 0;
1540 PROMPT (0) = xstrdup (DEFAULT_PROMPT);
1542 /* Set things up for annotation_level > 1, if the user ever decides
1544 async_annotation_suffix = "prompt";
1545 /* Set the variable associated with the setshow prompt command. */
1546 new_async_prompt = xstrdup (PROMPT (0));
1548 /* If gdb was started with --annotate=2, this is equivalent to the
1549 user entering the command 'set annotate 2' at the gdb prompt, so
1550 we need to do extra processing. */
1551 if (annotation_level > 1)
1552 set_async_annotation_level (NULL, 0, NULL);
1554 /* Set the important stuff up for command editing. */
1555 command_editing_p = 1;
1556 history_expansion_p = 0;
1557 write_history_p = 0;
1559 /* Setup important stuff for command line editing. */
1560 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1561 rl_completion_entry_function = readline_line_completion_function;
1562 rl_completer_word_break_characters = default_word_break_characters ();
1563 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1564 rl_readline_name = "gdb";
1565 rl_terminal_name = getenv ("TERM");
1567 /* The name for this defun comes from Bash, where it originated.
1568 15 is Control-o, the same binding this function has in Bash. */
1569 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1571 add_setshow_string_cmd ("prompt", class_support,
1572 &new_async_prompt, _("\
1573 Set gdb's prompt"), _("\
1574 Show gdb's prompt"), NULL,
1576 show_new_async_prompt,
1577 &setlist, &showlist);
1579 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1580 Don't repeat this command.\n\
1581 Primarily used inside of user-defined commands that should not be repeated when\n\
1584 add_setshow_boolean_cmd ("editing", class_support,
1585 &async_command_editing_p, _("\
1586 Set editing of command lines as they are typed."), _("\
1587 Show editing of command lines as they are typed."), _("\
1588 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1589 Without an argument, command line editing is enabled. To edit, use\n\
1590 EMACS-like or VI-like commands like control-P or ESC."),
1591 set_async_editing_command,
1592 show_async_command_editing_p,
1593 &setlist, &showlist);
1595 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
1596 Set saving of the history record on exit."), _("\
1597 Show saving of the history record on exit."), _("\
1598 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1599 Without an argument, saving is enabled."),
1601 show_write_history_p,
1602 &sethistlist, &showhistlist);
1604 add_setshow_integer_cmd ("size", no_class, &history_size, _("\
1605 Set the size of the command history,"), _("\
1606 Show the size of the command history,"), _("\
1607 ie. the number of previous commands to keep a record of."),
1608 set_history_size_command,
1610 &sethistlist, &showhistlist);
1612 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
1613 Set the filename in which to record the command history"), _("\
1614 Show the filename in which to record the command history"), _("\
1615 (the list of previous commands of which a record is kept)."),
1617 show_history_filename,
1618 &sethistlist, &showhistlist);
1620 add_setshow_boolean_cmd ("confirm", class_support, &caution, _("\
1621 Set whether to confirm potentially dangerous operations."), _("\
1622 Show whether to confirm potentially dangerous operations."), NULL,
1625 &setlist, &showlist);
1627 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
1628 Set annotation_level."), _("\
1629 Show annotation_level."), _("\
1630 0 == normal; 1 == fullname (for use when running under emacs)\n\
1631 2 == output annotated suitably for use by programs that control GDB."),
1632 set_async_annotation_level,
1633 show_annotation_level,
1634 &setlist, &showlist);
1636 add_setshow_boolean_cmd ("exec-done-display", class_support,
1637 &exec_done_display_p, _("\
1638 Set notification of completion for asynchronous execution commands."), _("\
1639 Show notification of completion for asynchronous execution commands."), _("\
1640 Use \"on\" to enable the notification, and \"off\" to disable it."),
1642 show_exec_done_display_p,
1643 &setlist, &showlist);
1645 add_setshow_filename_cmd ("data-directory", class_maintenance,
1646 &gdb_datadir, _("Set GDB's data directory."),
1647 _("Show GDB's data directory."),
1649 When set, GDB uses the specified path to search for data files."),
1656 gdb_init (char *argv0)
1658 if (pre_init_ui_hook)
1659 pre_init_ui_hook ();
1661 /* Run the init function of each source file */
1664 /* Make sure we return to the original directory upon exit, come
1665 what may, since the OS doesn't do that for us. */
1666 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
1669 init_cmd_lists (); /* This needs to be done first */
1670 initialize_targets (); /* Setup target_terminal macros for utils.c */
1671 initialize_utils (); /* Make errors and warnings possible */
1672 initialize_all_files ();
1673 initialize_current_architecture ();
1675 init_main (); /* But that omits this file! Do it now */
1677 initialize_stdin_serial ();
1679 async_init_signals ();
1681 /* We need a default language for parsing expressions, so simple things like
1682 "set width 0" won't fail if no language is explicitly set in a config file
1683 or implicitly set by reading an executable during startup. */
1684 set_language (language_c);
1685 expected_language = current_language; /* don't warn about the change. */
1687 /* Allow another UI to initialize. If the UI fails to initialize,
1688 and it wants GDB to revert to the CLI, it should clear
1689 deprecated_init_ui_hook. */
1690 if (deprecated_init_ui_hook)
1691 deprecated_init_ui_hook (argv0);