1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "call-cmds.h"
25 #include "cli/cli-cmds.h"
26 #include "cli/cli-script.h"
27 #include "cli/cli-setshow.h"
28 #include "cli/cli-decode.h"
31 #include "exceptions.h"
34 #include "breakpoint.h"
36 #include "expression.h"
39 #include "terminal.h" /* For job_control. */
41 #include "completer.h"
46 #include "gdb_assert.h"
48 #include "event-loop.h"
49 #include "gdbthread.h"
50 #include "python/python.h"
52 /* readline include files. */
53 #include "readline/readline.h"
54 #include "readline/history.h"
56 /* readline defines this. */
59 #include <sys/types.h>
61 #include "event-top.h"
62 #include "gdb_string.h"
68 /* Default command line prompt. This is overriden in some configs. */
70 #ifndef DEFAULT_PROMPT
71 #define DEFAULT_PROMPT "(gdb) "
74 /* Initialization file name for gdb. This is overridden in some configs. */
78 # define PATH_MAX FILENAME_MAX
84 #ifndef GDBINIT_FILENAME
85 #define GDBINIT_FILENAME ".gdbinit"
87 char gdbinit
[PATH_MAX
+ 1] = GDBINIT_FILENAME
;
89 int inhibit_gdbinit
= 0;
91 /* If nonzero, and GDB has been configured to be able to use windows,
92 attempt to open them upon startup. */
96 extern char lang_frame_mismatch_warn
[]; /* language.c */
98 /* Flag for whether we want all the "from_tty" gubbish printed. */
100 int caution
= 1; /* Default is yes, sigh. */
102 show_caution (struct ui_file
*file
, int from_tty
,
103 struct cmd_list_element
*c
, const char *value
)
105 fprintf_filtered (file
, _("Whether to confirm potentially "
106 "dangerous operations is %s.\n"),
110 /* stdio stream that command input is being read from. Set to stdin
111 normally. Set by source_command to the file we are sourcing. Set
112 to NULL if we are executing a user-defined command or interacting
117 /* Flag to indicate whether a user defined command is currently running. */
121 /* Current working directory. */
123 char *current_directory
;
125 /* The directory name is actually stored here (usually). */
126 char gdb_dirbuf
[1024];
128 /* Function to call before reading a command, if nonzero.
129 The function receives two args: an input stream,
130 and a prompt string. */
132 void (*window_hook
) (FILE *, char *);
137 /* Buffer used for reading command lines, and the size
138 allocated for it so far. */
140 char *saved_command_line
;
141 int saved_command_line_size
= 100;
143 /* Nonzero if the current command is modified by "server ". This
144 affects things like recording into the command history, commands
145 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
146 whatever) can issue its own commands and also send along commands
147 from the user, and have the user not notice that the user interface
148 is issuing commands too. */
151 /* Baud rate specified for talking to serial target systems. Default
152 is left as -1, so targets can choose their own defaults. */
153 /* FIXME: This means that "show remotebaud" and gr_files_info can
154 print -1 or (unsigned int)-1. This is a Bad User Interface. */
158 /* Timeout limit for response from target. */
160 /* The default value has been changed many times over the years. It
161 was originally 5 seconds. But that was thought to be a long time
162 to sit and wait, so it was changed to 2 seconds. That was thought
163 to be plenty unless the connection was going through some terminal
164 server or multiplexer or other form of hairy serial connection.
166 In mid-1996, remote_timeout was moved from remote.c to top.c and
167 it began being used in other remote-* targets. It appears that the
168 default was changed to 20 seconds at that time, perhaps because the
169 Renesas E7000 ICE didn't always respond in a timely manner.
171 But if 5 seconds is a long time to sit and wait for retransmissions,
172 20 seconds is far worse. This demonstrates the difficulty of using
173 a single variable for all protocol timeouts.
175 As remote.c is used much more than remote-e7000.c, it was changed
176 back to 2 seconds in 1999. */
178 int remote_timeout
= 2;
180 /* Non-zero tells remote* modules to output debugging info. */
182 int remote_debug
= 0;
184 /* Sbrk location on entry to main. Used for statistics only. */
189 /* Hooks for alternate command interfaces. */
191 /* Called after most modules have been initialized, but before taking
194 If the UI fails to initialize and it wants GDB to continue using
195 the default UI, then it should clear this hook before returning. */
197 void (*deprecated_init_ui_hook
) (char *argv0
);
199 /* This hook is called from within gdb's many mini-event loops which
200 could steal control from a real user interface's event loop. It
201 returns non-zero if the user is requesting a detach, zero
204 int (*deprecated_ui_loop_hook
) (int);
206 /* Called instead of command_loop at top level. Can be invoked via
207 throw_exception(). */
209 void (*deprecated_command_loop_hook
) (void);
212 /* Called from print_frame_info to list the line we stopped in. */
214 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
218 /* Replaces most of query. */
220 int (*deprecated_query_hook
) (const char *, va_list);
222 /* Replaces most of warning. */
224 void (*deprecated_warning_hook
) (const char *, va_list);
226 /* These three functions support getting lines of text from the user.
227 They are used in sequence. First deprecated_readline_begin_hook is
228 called with a text string that might be (for example) a message for
229 the user to type in a sequence of commands to be executed at a
230 breakpoint. If this function calls back to a GUI, it might take
231 this opportunity to pop up a text interaction window with this
232 message. Next, deprecated_readline_hook is called with a prompt
233 that is emitted prior to collecting the user input. It can be
234 called multiple times. Finally, deprecated_readline_end_hook is
235 called to notify the GUI that we are done with the interaction
236 window and it can close it. */
238 void (*deprecated_readline_begin_hook
) (char *, ...);
239 char *(*deprecated_readline_hook
) (char *);
240 void (*deprecated_readline_end_hook
) (void);
242 /* Called as appropriate to notify the interface that we have attached
243 to or detached from an already running process. */
245 void (*deprecated_attach_hook
) (void);
246 void (*deprecated_detach_hook
) (void);
248 /* Called during long calculations to allow GUI to repair window
249 damage, and to check for stop buttons, etc... */
251 void (*deprecated_interactive_hook
) (void);
253 /* Tell the GUI someone changed the register REGNO. -1 means
254 that the caller does not know which register changed or
255 that several registers have changed (see value_assign). */
256 void (*deprecated_register_changed_hook
) (int regno
);
258 /* Called when going to wait for the target. Usually allows the GUI
259 to run while waiting for target events. */
261 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
262 struct target_waitstatus
*status
,
265 /* Used by UI as a wrapper around command execution. May do various
266 things like enabling/disabling buttons, etc... */
268 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
269 char *cmd
, int from_tty
);
271 /* Called after a `set' command has finished. Is only run if the
272 `set' command succeeded. */
274 void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
276 /* Called when the current thread changes. Argument is thread id. */
278 void (*deprecated_context_hook
) (int id
);
280 /* Handler for SIGHUP. */
283 /* NOTE 1999-04-29: This function will be static again, once we modify
284 gdb to use the event loop as the default command loop and we merge
285 event-top.c into this file, top.c. */
289 caution
= 0; /* Throw caution to the wind -- we're exiting.
290 This prevents asking the user dumb
292 quit_command ((char *) 0, 0);
295 #endif /* defined SIGHUP */
297 /* Line number we are currently in, in a file which is being sourced. */
298 /* NOTE 1999-04-29: This variable will be static again, once we modify
299 gdb to use the event loop as the default command loop and we merge
300 event-top.c into this file, top.c. */
301 /* static */ int source_line_number
;
303 /* Name of the file we are sourcing. */
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 */ const char *source_file_name
;
309 /* Clean up on error during a "source" command (or execution of a
310 user-defined command). */
313 do_restore_instream_cleanup (void *stream
)
315 /* Restore the previous input stream. */
319 /* Read commands from STREAM. */
321 read_command_file (FILE *stream
)
323 struct cleanup
*cleanups
;
325 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
328 do_cleanups (cleanups
);
331 void (*pre_init_ui_hook
) (void);
335 do_chdir_cleanup (void *old_dir
)
343 prepare_execute_command (void)
346 struct cleanup
*cleanup
;
348 mark
= value_mark ();
349 cleanup
= make_cleanup_value_free_to_mark (mark
);
351 /* With multiple threads running while the one we're examining is
352 stopped, the dcache can get stale without us being able to detect
353 it. For the duration of the command, though, use the dcache to
354 help things like backtrace. */
356 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 cleanup
*cleanup
;
368 struct cmd_list_element
*c
;
370 static int warned
= 0;
373 cleanup
= prepare_execute_command ();
375 /* Force cleanup of any alloca areas if using C alloca instead of
379 /* This can happen when command_line_input hits end of file. */
383 target_log_command (p
);
385 while (*p
== ' ' || *p
== '\t')
392 /* If trace-commands is set then this will print this command. */
393 print_command_trace (p
);
395 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
397 /* Pass null arg rather than an empty one. */
400 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
401 while the is_complete_command(cfunc) test is just plain
402 bogus. They should both be replaced by a test of the form
403 c->strip_trailing_white_space_p. */
404 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
405 can't be replaced with func. This is because it is the
406 cfunc, and not the func, that has the value that the
407 is_complete_command hack is testing for. */
408 /* Clear off trailing whitespace, except for set and complete
411 && c
->type
!= set_cmd
412 && !is_complete_command (c
))
414 p
= arg
+ strlen (arg
) - 1;
415 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
420 /* If this command has been pre-hooked, run the hook first. */
421 execute_cmd_pre_hook (c
);
423 if (c
->flags
& DEPRECATED_WARN_USER
)
424 deprecated_cmd_warning (&line
);
426 if (c
->class == class_user
)
427 execute_user_command (c
, arg
);
428 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
429 do_setshow_command (arg
, from_tty
& caution
, c
);
430 else if (!cmd_func_p (c
))
431 error (_("That is not a command, just a help topic."));
432 else if (deprecated_call_command_hook
)
433 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
435 cmd_func (c
, arg
, from_tty
& caution
);
437 /* If this command has been post-hooked, run the hook last. */
438 execute_cmd_post_hook (c
);
442 /* Tell the user if the language has changed (except first time).
443 First make sure that a new frame has been selected, in case this
444 command or the hooks changed the program state. */
445 deprecated_safe_get_selected_frame ();
446 if (current_language
!= expected_language
)
448 if (language_mode
== language_mode_auto
&& info_verbose
)
450 language_info (1); /* Print what changed. */
455 /* Warn the user if the working language does not match the
456 language of the current frame. Only warn the user if we are
457 actually running the program, i.e. there is a stack. */
458 /* FIXME: This should be cacheing the frame and only running when
459 the frame changes. */
461 if (has_stack_frames ())
463 flang
= get_frame_language ();
465 && flang
!= language_unknown
466 && flang
!= current_language
->la_language
)
468 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
473 do_cleanups (cleanup
);
476 /* Run execute_command for P and FROM_TTY. Capture its output into the
477 returned string, do not display it to the screen. BATCH_FLAG will be
478 temporarily set to true. */
481 execute_command_to_string (char *p
, int from_tty
)
483 struct ui_file
*str_file
;
484 struct cleanup
*cleanup
;
487 /* GDB_STDOUT should be better already restored during these
488 restoration callbacks. */
489 cleanup
= set_batch_flag_and_make_cleanup_restore_page_info ();
491 str_file
= mem_fileopen ();
493 make_cleanup_ui_file_delete (str_file
);
494 make_cleanup_restore_ui_file (&gdb_stdout
);
495 make_cleanup_restore_ui_file (&gdb_stderr
);
496 make_cleanup_restore_ui_file (&gdb_stdlog
);
497 make_cleanup_restore_ui_file (&gdb_stdtarg
);
498 make_cleanup_restore_ui_file (&gdb_stdtargerr
);
500 if (ui_out_redirect (uiout
, str_file
) < 0)
501 warning (_("Current output protocol does not support redirection"));
503 make_cleanup_ui_out_redirect_pop (uiout
);
505 gdb_stdout
= str_file
;
506 gdb_stderr
= str_file
;
507 gdb_stdlog
= str_file
;
508 gdb_stdtarg
= str_file
;
509 gdb_stdtargerr
= str_file
;
511 execute_command (p
, from_tty
);
513 retval
= ui_file_xstrdup (str_file
, NULL
);
515 do_cleanups (cleanup
);
520 /* Read commands from `instream' and execute them
521 until end of file or error reading instream. */
526 struct cleanup
*old_chain
;
528 int stdin_is_tty
= ISATTY (stdin
);
530 while (instream
&& !feof (instream
))
532 if (window_hook
&& instream
== stdin
)
533 (*window_hook
) (instream
, get_prompt ());
536 if (instream
== stdin
&& stdin_is_tty
)
537 reinitialize_more_filter ();
538 old_chain
= make_cleanup (null_cleanup
, 0);
540 /* Get a command-line. This calls the readline package. */
541 command
= command_line_input (instream
== stdin
?
542 get_prompt () : (char *) NULL
,
543 instream
== stdin
, "prompt");
547 make_command_stats_cleanup (1);
549 execute_command (command
, instream
== stdin
);
551 /* Do any commands attached to breakpoint we are stopped at. */
552 bpstat_do_actions ();
554 do_cleanups (old_chain
);
558 /* When nonzero, cause dont_repeat to do nothing. This should only be
559 set via prevent_dont_repeat. */
561 static int suppress_dont_repeat
= 0;
563 /* Commands call this if they do not want to be repeated by null lines. */
568 if (suppress_dont_repeat
|| server_command
)
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
573 lines won't repeat here in any case. */
574 if (instream
== stdin
)
575 *saved_command_line
= 0;
578 /* Prevent dont_repeat from working, and return a cleanup that
579 restores the previous state. */
582 prevent_dont_repeat (void)
584 struct cleanup
*result
= make_cleanup_restore_integer (&suppress_dont_repeat
);
586 suppress_dont_repeat
= 1;
591 /* Read a line from the stream "instream" without command line editing.
593 It prints PROMPT_ARG once at the start.
594 Action is compatible with "readline", e.g. space for the result is
595 malloc'd and should be freed by the caller.
597 A NULL return means end of file. */
599 gdb_readline (char *prompt_arg
)
604 int result_size
= 80;
608 /* Don't use a _filtered function here. It causes the assumed
609 character position to be off, since the newline we read from
610 the user is not accounted for. */
611 fputs_unfiltered (prompt_arg
, gdb_stdout
);
612 gdb_flush (gdb_stdout
);
615 result
= (char *) xmalloc (result_size
);
619 /* Read from stdin if we are executing a user defined command.
620 This is the right thing for prompt_for_continue, at least. */
621 c
= fgetc (instream
? instream
: stdin
);
626 /* The last line does not end with a newline. Return it, and
627 if we are called again fgetc will still return EOF and
628 we'll return NULL then. */
636 if (input_index
> 0 && result
[input_index
- 1] == '\r')
641 result
[input_index
++] = c
;
642 while (input_index
>= result_size
)
645 result
= (char *) xrealloc (result
, result_size
);
649 result
[input_index
++] = '\0';
653 /* Variables which control command line editing and history
654 substitution. These variables are given default values at the end
656 static int command_editing_p
;
658 /* NOTE 1999-04-29: This variable will be static again, once we modify
659 gdb to use the event loop as the default command loop and we merge
660 event-top.c into this file, top.c. */
662 /* static */ int history_expansion_p
;
664 static int write_history_p
;
666 show_write_history_p (struct ui_file
*file
, int from_tty
,
667 struct cmd_list_element
*c
, const char *value
)
669 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
673 static int history_size
;
675 show_history_size (struct ui_file
*file
, int from_tty
,
676 struct cmd_list_element
*c
, const char *value
)
678 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
682 static char *history_filename
;
684 show_history_filename (struct ui_file
*file
, int from_tty
,
685 struct cmd_list_element
*c
, const char *value
)
687 fprintf_filtered (file
, _("The filename in which to record "
688 "the command history is \"%s\".\n"),
692 /* This is like readline(), but it has some gdb-specific behavior.
693 gdb may want readline in both the synchronous and async modes during
694 a single gdb invocation. At the ordinary top-level prompt we might
695 be using the async readline. That means we can't use
696 rl_pre_input_hook, since it doesn't work properly in async mode.
697 However, for a secondary prompt (" >", such as occurs during a
698 `define'), gdb wants a synchronous response.
700 We used to call readline() directly, running it in synchronous
701 mode. But mixing modes this way is not supported, and as of
702 readline 5.x it no longer works; the arrow keys come unbound during
703 the synchronous call. So we make a nested call into the event
704 loop. That's what gdb_readline_wrapper is for. */
706 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
707 rely on gdb_readline_wrapper_result, which might still be NULL if
708 the user types Control-D for EOF. */
709 static int gdb_readline_wrapper_done
;
711 /* The result of the current call to gdb_readline_wrapper, once a newline
713 static char *gdb_readline_wrapper_result
;
715 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
716 to be called after the newline is processed (which will redisplay
717 the prompt). But in gdb_readline_wrapper we will not get a new
718 prompt until the next call, or until we return to the event loop.
719 So we disable this hook around the newline and restore it before we
721 static void (*saved_after_char_processing_hook
) (void);
723 /* This function is called when readline has seen a complete line of
727 gdb_readline_wrapper_line (char *line
)
729 gdb_assert (!gdb_readline_wrapper_done
);
730 gdb_readline_wrapper_result
= line
;
731 gdb_readline_wrapper_done
= 1;
733 /* Prevent operate-and-get-next from acting too early. */
734 saved_after_char_processing_hook
= after_char_processing_hook
;
735 after_char_processing_hook
= NULL
;
737 /* Prevent parts of the prompt from being redisplayed if annotations
738 are enabled, and readline's state getting out of sync. */
739 if (async_command_editing_p
)
740 rl_callback_handler_remove ();
743 struct gdb_readline_wrapper_cleanup
745 void (*handler_orig
) (char *);
746 int already_prompted_orig
;
750 gdb_readline_wrapper_cleanup (void *arg
)
752 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
754 rl_already_prompted
= cleanup
->already_prompted_orig
;
756 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
757 input_handler
= cleanup
->handler_orig
;
758 gdb_readline_wrapper_result
= NULL
;
759 gdb_readline_wrapper_done
= 0;
761 after_char_processing_hook
= saved_after_char_processing_hook
;
762 saved_after_char_processing_hook
= NULL
;
768 gdb_readline_wrapper (char *prompt
)
770 struct cleanup
*back_to
;
771 struct gdb_readline_wrapper_cleanup
*cleanup
;
774 cleanup
= xmalloc (sizeof (*cleanup
));
775 cleanup
->handler_orig
= input_handler
;
776 input_handler
= gdb_readline_wrapper_line
;
778 cleanup
->already_prompted_orig
= rl_already_prompted
;
780 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
782 /* Display our prompt and prevent double prompt display. */
783 display_gdb_prompt (prompt
);
784 rl_already_prompted
= 1;
786 if (after_char_processing_hook
)
787 (*after_char_processing_hook
) ();
788 gdb_assert (after_char_processing_hook
== NULL
);
790 /* gdb_do_one_event argument is unused. */
791 while (gdb_do_one_event (NULL
) >= 0)
792 if (gdb_readline_wrapper_done
)
795 retval
= gdb_readline_wrapper_result
;
796 do_cleanups (back_to
);
801 /* The current saved history number from operate-and-get-next.
802 This is -1 if not valid. */
803 static int operate_saved_history
= -1;
805 /* This is put on the appropriate hook and helps operate-and-get-next
808 gdb_rl_operate_and_get_next_completion (void)
810 int delta
= where_history () - operate_saved_history
;
812 /* The `key' argument to rl_get_previous_history is ignored. */
813 rl_get_previous_history (delta
, 0);
814 operate_saved_history
= -1;
816 /* readline doesn't automatically update the display for us. */
819 after_char_processing_hook
= NULL
;
820 rl_pre_input_hook
= NULL
;
823 /* This is a gdb-local readline command handler. It accepts the
824 current command line (like RET does) and, if this command was taken
825 from the history, arranges for the next command in the history to
826 appear on the command line when the prompt returns.
827 We ignore the arguments. */
829 gdb_rl_operate_and_get_next (int count
, int key
)
833 /* Use the async hook. */
834 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
836 /* Find the current line, and find the next line to use. */
837 where
= where_history();
839 /* FIXME: kettenis/20020817: max_input_history is renamed into
840 history_max_entries in readline-4.2. When we do a new readline
841 import, we should probably change it here too, even though
842 readline maintains backwards compatibility for now by still
843 defining max_input_history. */
844 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
845 (where
>= history_length
- 1))
846 operate_saved_history
= where
;
848 operate_saved_history
= where
+ 1;
850 return rl_newline (1, key
);
853 /* Read one line from the command input stream `instream'
854 into the local static buffer `linebuffer' (whose current length
856 The buffer is made bigger as necessary.
857 Returns the address of the start of the line.
859 NULL is returned for end of file.
861 *If* the instream == stdin & stdin is a terminal, the line read
862 is copied into the file line saver (global var char *line,
863 length linesize) so that it can be duplicated.
865 This routine either uses fancy command line editing or
866 simple input as the user has requested. */
869 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
871 static char *linebuffer
= 0;
872 static unsigned linelength
= 0;
876 char *local_prompt
= prompt_arg
;
880 /* The annotation suffix must be non-NULL. */
881 if (annotation_suffix
== NULL
)
882 annotation_suffix
= "";
884 if (annotation_level
> 1 && instream
== stdin
)
886 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
887 + strlen (annotation_suffix
) + 40);
888 if (prompt_arg
== NULL
)
889 local_prompt
[0] = '\0';
891 strcpy (local_prompt
, prompt_arg
);
892 strcat (local_prompt
, "\n\032\032");
893 strcat (local_prompt
, annotation_suffix
);
894 strcat (local_prompt
, "\n");
900 linebuffer
= (char *) xmalloc (linelength
);
905 /* Control-C quits instantly if typed while in this loop
906 since it should not wait until the user types a newline. */
910 signal (STOP_SIGNAL
, handle_stop_sig
);
915 /* Make sure that all output has been output. Some machines may
916 let you get away with leaving out some of the gdb_flush, but
919 gdb_flush (gdb_stdout
);
920 gdb_flush (gdb_stderr
);
922 if (source_file_name
!= NULL
)
923 ++source_line_number
;
925 if (annotation_level
> 1 && instream
== stdin
)
927 puts_unfiltered ("\n\032\032pre-");
928 puts_unfiltered (annotation_suffix
);
929 puts_unfiltered ("\n");
932 /* Don't use fancy stuff if not talking to stdin. */
933 if (deprecated_readline_hook
&& input_from_terminal_p ())
935 rl
= (*deprecated_readline_hook
) (local_prompt
);
937 else if (command_editing_p
&& input_from_terminal_p ())
939 rl
= gdb_readline_wrapper (local_prompt
);
943 rl
= gdb_readline (local_prompt
);
946 if (annotation_level
> 1 && instream
== stdin
)
948 puts_unfiltered ("\n\032\032post-");
949 puts_unfiltered (annotation_suffix
);
950 puts_unfiltered ("\n");
953 if (!rl
|| rl
== (char *) EOF
)
958 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
960 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
961 nline
= (char *) xrealloc (linebuffer
, linelength
);
962 p
+= nline
- linebuffer
;
966 /* Copy line. Don't copy null at end. (Leaves line alone
967 if this was just a newline). */
971 xfree (rl
); /* Allocated in readline. */
973 if (p
== linebuffer
|| *(p
- 1) != '\\')
976 p
--; /* Put on top of '\'. */
977 local_prompt
= (char *) 0;
982 signal (STOP_SIGNAL
, SIG_DFL
);
989 #define SERVER_COMMAND_LENGTH 7
991 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
992 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
995 /* Note that we don't set `line'. Between this and the check in
996 dont_repeat, this insures that repeating will still do the
999 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1002 /* Do history expansion if that is wished. */
1003 if (history_expansion_p
&& instream
== stdin
1004 && ISATTY (instream
))
1006 char *history_value
;
1009 *p
= '\0'; /* Insert null now. */
1010 expanded
= history_expand (linebuffer
, &history_value
);
1013 /* Print the changes. */
1014 printf_unfiltered ("%s\n", history_value
);
1016 /* If there was an error, call this function again. */
1019 xfree (history_value
);
1020 return command_line_input (prompt_arg
, repeat
,
1023 if (strlen (history_value
) > linelength
)
1025 linelength
= strlen (history_value
) + 1;
1026 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1028 strcpy (linebuffer
, history_value
);
1029 p
= linebuffer
+ strlen (linebuffer
);
1031 xfree (history_value
);
1034 /* If we just got an empty line, and that is supposed to repeat the
1035 previous command, return the value in the global buffer. */
1036 if (repeat
&& p
== linebuffer
)
1037 return saved_command_line
;
1038 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1040 return saved_command_line
;
1044 /* Add line to history if appropriate. */
1045 if (instream
== stdin
1046 && ISATTY (stdin
) && *linebuffer
)
1047 add_history (linebuffer
);
1049 /* Note: lines consisting solely of comments are added to the command
1050 history. This is useful when you type a command, and then
1051 realize you don't want to execute it quite yet. You can comment
1052 out the command and then later fetch it from the value history
1053 and remove the '#'. The kill ring is probably better, but some
1054 people are in the habit of commenting things out. */
1056 *p1
= '\0'; /* Found a comment. */
1058 /* Save into global buffer if appropriate. */
1061 if (linelength
> saved_command_line_size
)
1063 saved_command_line
= xrealloc (saved_command_line
, linelength
);
1064 saved_command_line_size
= linelength
;
1066 strcpy (saved_command_line
, linebuffer
);
1067 return saved_command_line
;
1073 /* Print the GDB banner. */
1075 print_gdb_version (struct ui_file
*stream
)
1077 /* From GNU coding standards, first line is meant to be easy for a
1078 program to parse, and is just canonical program name and version
1079 number, which starts after last space. */
1081 fprintf_filtered (stream
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1083 /* Second line is a copyright notice. */
1085 fprintf_filtered (stream
,
1086 "Copyright (C) 2011 Free Software Foundation, Inc.\n");
1088 /* Following the copyright is a brief statement that the program is
1089 free software, that users are free to copy and change it on
1090 certain conditions, that it is covered by the GNU GPL, and that
1091 there is no warranty. */
1093 fprintf_filtered (stream
, "\
1094 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1095 \nThis is free software: you are free to change and redistribute it.\n\
1096 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1097 and \"show warranty\" for details.\n");
1099 /* After the required info we print the configuration information. */
1101 fprintf_filtered (stream
, "This GDB was configured as \"");
1102 if (strcmp (host_name
, target_name
) != 0)
1104 fprintf_filtered (stream
, "--host=%s --target=%s",
1105 host_name
, target_name
);
1109 fprintf_filtered (stream
, "%s", host_name
);
1111 fprintf_filtered (stream
, "\".");
1113 if (REPORT_BUGS_TO
[0])
1115 fprintf_filtered (stream
,
1116 _("\nFor bug reporting instructions, please see:\n"));
1117 fprintf_filtered (stream
, "%s.", REPORT_BUGS_TO
);
1121 /* get_prompt: access method for the GDB prompt string. */
1130 set_prompt (char *s
)
1132 /* ??rehrauer: I don't know why this fails, since it looks as though
1133 assignments to prompt are wrapped in calls to xstrdup...
1137 PROMPT (0) = xstrdup (s
);
1147 /* Callback for iterate_over_inferiors. Kills or detaches the given
1148 inferior, depending on how we originally gained control of it. */
1151 kill_or_detach (struct inferior
*inf
, void *args
)
1153 struct qt_args
*qt
= args
;
1154 struct thread_info
*thread
;
1159 thread
= any_thread_of_process (inf
->pid
);
1162 switch_to_thread (thread
->ptid
);
1164 /* Leave core files alone. */
1165 if (target_has_execution
)
1167 if (inf
->attach_flag
)
1168 target_detach (qt
->args
, qt
->from_tty
);
1177 /* Callback for iterate_over_inferiors. Prints info about what GDB
1178 will do to each inferior on a "quit". ARG points to a struct
1179 ui_out where output is to be collected. */
1182 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1184 struct ui_file
*stb
= arg
;
1189 if (inf
->attach_flag
)
1190 fprintf_filtered (stb
,
1191 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1192 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1194 fprintf_filtered (stb
,
1195 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1196 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1201 /* If necessary, make the user confirm that we should quit. Return
1202 non-zero if we should quit, zero if we shouldn't. */
1207 struct ui_file
*stb
;
1208 struct cleanup
*old_chain
;
1212 /* Don't even ask if we're only debugging a core file inferior. */
1213 if (!have_live_inferiors ())
1216 /* Build the query string as a single string. */
1217 stb
= mem_fileopen ();
1218 old_chain
= make_cleanup_ui_file_delete (stb
);
1220 /* This is something of a hack. But there's no reliable way to see
1221 if a GUI is running. The `use_windows' variable doesn't cut
1223 if (deprecated_init_ui_hook
)
1224 fprintf_filtered (stb
, _("A debugging session is active.\n"
1225 "Do you still want to close the debugger?"));
1228 fprintf_filtered (stb
, _("A debugging session is active.\n\n"));
1229 iterate_over_inferiors (print_inferior_quit_action
, stb
);
1230 fprintf_filtered (stb
, _("\nQuit anyway? "));
1233 str
= ui_file_xstrdup (stb
, NULL
);
1234 make_cleanup (xfree
, str
);
1236 qr
= query ("%s", str
);
1237 do_cleanups (old_chain
);
1241 /* Helper routine for quit_force that requires error handling. */
1244 quit_target (void *arg
)
1246 struct qt_args
*qt
= (struct qt_args
*)arg
;
1248 /* Kill or detach all inferiors. */
1249 iterate_over_inferiors (kill_or_detach
, qt
);
1251 /* Give all pushed targets a chance to do minimal cleanup, and pop
1253 pop_all_targets (1);
1255 /* Save the history information if it is appropriate to do so. */
1256 if (write_history_p
&& history_filename
)
1257 write_history (history_filename
);
1259 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before
1264 /* Quit without asking for confirmation. */
1267 quit_force (char *args
, int from_tty
)
1272 /* An optional expression may be used to cause gdb to terminate with the
1273 value of that expression. */
1276 struct value
*val
= parse_and_eval (args
);
1278 exit_code
= (int) value_as_long (val
);
1280 else if (return_child_result
)
1281 exit_code
= return_child_result_value
;
1284 qt
.from_tty
= from_tty
;
1286 /* We want to handle any quit errors and exit regardless. */
1287 catch_errors (quit_target
, &qt
,
1288 "Quitting: ", RETURN_MASK_ALL
);
1293 /* Returns whether GDB is running on a terminal and input is
1294 currently coming from that terminal. */
1297 input_from_terminal_p (void)
1302 if (gdb_has_a_terminal () && instream
== stdin
)
1305 /* If INSTREAM is unset, and we are not in a user command, we
1306 must be in Insight. That's like having a terminal, for our
1308 if (instream
== NULL
&& !in_user_command
)
1315 dont_repeat_command (char *ignored
, int from_tty
)
1317 /* Can't call dont_repeat here because we're not necessarily reading
1319 *saved_command_line
= 0;
1322 /* Functions to manipulate command line editing control variables. */
1324 /* Number of commands to print in each call to show_commands. */
1325 #define Hist_print 10
1327 show_commands (char *args
, int from_tty
)
1329 /* Index for history commands. Relative to history_base. */
1332 /* Number of the history entry which we are planning to display next.
1333 Relative to history_base. */
1336 /* The first command in the history which doesn't exist (i.e. one more
1337 than the number of the last command). Relative to history_base. */
1340 /* Print out some of the commands from the command history. */
1341 /* First determine the length of the history list. */
1342 hist_len
= history_size
;
1343 for (offset
= 0; offset
< history_size
; offset
++)
1345 if (!history_get (history_base
+ offset
))
1354 if (args
[0] == '+' && args
[1] == '\0')
1355 /* "info editing +" should print from the stored position. */
1358 /* "info editing <exp>" should print around command number <exp>. */
1359 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1361 /* "show commands" means print the last Hist_print commands. */
1364 num
= hist_len
- Hist_print
;
1370 /* If there are at least Hist_print commands, we want to display the last
1371 Hist_print rather than, say, the last 6. */
1372 if (hist_len
- num
< Hist_print
)
1374 num
= hist_len
- Hist_print
;
1379 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1381 printf_filtered ("%5d %s\n", history_base
+ offset
,
1382 (history_get (history_base
+ offset
))->line
);
1385 /* The next command we want to display is the next one that we haven't
1389 /* If the user repeats this command with return, it should do what
1390 "show commands +" does. This is unnecessary if arg is null,
1391 because "show commands +" is not useful after "show commands". */
1392 if (from_tty
&& args
)
1399 /* Called by do_setshow_command. */
1401 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1403 if (history_size
== INT_MAX
)
1404 unstifle_history ();
1405 else if (history_size
>= 0)
1406 stifle_history (history_size
);
1409 history_size
= INT_MAX
;
1410 error (_("History size must be non-negative"));
1415 set_history (char *args
, int from_tty
)
1417 printf_unfiltered (_("\"set history\" must be followed "
1418 "by the name of a history subcommand.\n"));
1419 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1423 show_history (char *args
, int from_tty
)
1425 cmd_show_list (showhistlist
, from_tty
, "");
1428 int info_verbose
= 0; /* Default verbose msgs off. */
1430 /* Called by do_setshow_command. An elaborate joke. */
1432 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1434 char *cmdname
= "verbose";
1435 struct cmd_list_element
*showcmd
;
1437 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1438 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1442 c
->doc
= "Set verbose printing of informational messages.";
1443 showcmd
->doc
= "Show verbose printing of informational messages.";
1447 c
->doc
= "Set verbosity.";
1448 showcmd
->doc
= "Show verbosity.";
1452 /* Init the history buffer. Note that we are called after the init file(s)
1453 have been read so that the user can change the history file via his
1454 .gdbinit file (for instance). The GDBHISTFILE environment variable
1455 overrides all of this. */
1462 tmpenv
= getenv ("HISTSIZE");
1464 history_size
= atoi (tmpenv
);
1465 else if (!history_size
)
1468 stifle_history (history_size
);
1470 tmpenv
= getenv ("GDBHISTFILE");
1472 history_filename
= xstrdup (tmpenv
);
1473 else if (!history_filename
)
1475 /* We include the current directory so that if the user changes
1476 directories the file written will be the same as the one
1479 /* No leading dots in file names are allowed on MSDOS. */
1480 history_filename
= concat (current_directory
, "/_gdb_history",
1483 history_filename
= concat (current_directory
, "/.gdb_history",
1487 read_history (history_filename
);
1491 show_new_async_prompt (struct ui_file
*file
, int from_tty
,
1492 struct cmd_list_element
*c
, const char *value
)
1494 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1498 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1499 struct cmd_list_element
*c
, const char *value
)
1501 fprintf_filtered (file
, _("Editing of command lines as "
1502 "they are typed is %s.\n"),
1507 show_annotation_level (struct ui_file
*file
, int from_tty
,
1508 struct cmd_list_element
*c
, const char *value
)
1510 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1514 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1515 struct cmd_list_element
*c
, const char *value
)
1517 fprintf_filtered (file
, _("Notification of completion for "
1518 "asynchronous execution commands is %s.\n"),
1524 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1525 whatever the DEFAULT_PROMPT is. */
1526 the_prompts
.top
= 0;
1528 PROMPT (0) = xstrdup (DEFAULT_PROMPT
);
1530 /* Set things up for annotation_level > 1, if the user ever decides
1532 async_annotation_suffix
= "prompt";
1533 /* Set the variable associated with the setshow prompt command. */
1534 new_async_prompt
= xstrdup (PROMPT (0));
1536 /* If gdb was started with --annotate=2, this is equivalent to the
1537 user entering the command 'set annotate 2' at the gdb prompt, so
1538 we need to do extra processing. */
1539 if (annotation_level
> 1)
1540 set_async_annotation_level (NULL
, 0, NULL
);
1542 /* Set the important stuff up for command editing. */
1543 command_editing_p
= 1;
1544 history_expansion_p
= 0;
1545 write_history_p
= 0;
1547 /* Setup important stuff for command line editing. */
1548 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
1549 rl_completion_entry_function
= readline_line_completion_function
;
1550 rl_completer_word_break_characters
= default_word_break_characters ();
1551 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1552 rl_readline_name
= "gdb";
1553 rl_terminal_name
= getenv ("TERM");
1555 /* The name for this defun comes from Bash, where it originated.
1556 15 is Control-o, the same binding this function has in Bash. */
1557 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1559 add_setshow_string_cmd ("prompt", class_support
,
1561 _("Set gdb's prompt"),
1562 _("Show gdb's prompt"),
1563 NULL
, set_async_prompt
,
1564 show_new_async_prompt
,
1565 &setlist
, &showlist
);
1567 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1568 Don't repeat this command.\nPrimarily \
1569 used inside of user-defined commands that should not be repeated when\n\
1572 add_setshow_boolean_cmd ("editing", class_support
,
1573 &async_command_editing_p
, _("\
1574 Set editing of command lines as they are typed."), _("\
1575 Show editing of command lines as they are typed."), _("\
1576 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1577 Without an argument, command line editing is enabled. To edit, use\n\
1578 EMACS-like or VI-like commands like control-P or ESC."),
1579 set_async_editing_command
,
1580 show_async_command_editing_p
,
1581 &setlist
, &showlist
);
1583 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1584 Set saving of the history record on exit."), _("\
1585 Show saving of the history record on exit."), _("\
1586 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1587 Without an argument, saving is enabled."),
1589 show_write_history_p
,
1590 &sethistlist
, &showhistlist
);
1592 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1593 Set the size of the command history,"), _("\
1594 Show the size of the command history,"), _("\
1595 ie. the number of previous commands to keep a record of."),
1596 set_history_size_command
,
1598 &sethistlist
, &showhistlist
);
1600 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1601 Set the filename in which to record the command history"), _("\
1602 Show the filename in which to record the command history"), _("\
1603 (the list of previous commands of which a record is kept)."),
1605 show_history_filename
,
1606 &sethistlist
, &showhistlist
);
1608 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1609 Set whether to confirm potentially dangerous operations."), _("\
1610 Show whether to confirm potentially dangerous operations."), NULL
,
1613 &setlist
, &showlist
);
1615 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1616 Set annotation_level."), _("\
1617 Show annotation_level."), _("\
1618 0 == normal; 1 == fullname (for use when running under emacs)\n\
1619 2 == output annotated suitably for use by programs that control GDB."),
1620 set_async_annotation_level
,
1621 show_annotation_level
,
1622 &setlist
, &showlist
);
1624 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1625 &exec_done_display_p
, _("\
1626 Set notification of completion for asynchronous execution commands."), _("\
1627 Show notification of completion for asynchronous execution commands."), _("\
1628 Use \"on\" to enable the notification, and \"off\" to disable it."),
1630 show_exec_done_display_p
,
1631 &setlist
, &showlist
);
1633 add_setshow_filename_cmd ("data-directory", class_maintenance
,
1634 &gdb_datadir
, _("Set GDB's data directory."),
1635 _("Show GDB's data directory."),
1637 When set, GDB uses the specified path to search for data files."),
1644 gdb_init (char *argv0
)
1646 if (pre_init_ui_hook
)
1647 pre_init_ui_hook ();
1649 /* Run the init function of each source file. */
1652 /* Make sure we return to the original directory upon exit, come
1653 what may, since the OS doesn't do that for us. */
1654 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1657 init_cmd_lists (); /* This needs to be done first. */
1658 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1659 initialize_utils (); /* Make errors and warnings possible. */
1661 /* Here is where we call all the _initialize_foo routines. */
1662 initialize_all_files ();
1664 /* This creates the current_program_space. Do this after all the
1665 _initialize_foo routines have had a chance to install their
1666 per-sspace data keys. Also do this before
1667 initialize_current_architecture is called, because it accesses
1668 exec_bfd of the current program space. */
1669 initialize_progspace ();
1670 initialize_inferiors ();
1671 initialize_current_architecture ();
1673 init_main (); /* But that omits this file! Do it now. */
1675 initialize_stdin_serial ();
1677 async_init_signals ();
1679 /* We need a default language for parsing expressions, so simple
1680 things like "set width 0" won't fail if no language is explicitly
1681 set in a config file or implicitly set by reading an executable
1683 set_language (language_c
);
1684 expected_language
= current_language
; /* Don't warn about the change. */
1686 /* Allow another UI to initialize. If the UI fails to initialize,
1687 and it wants GDB to revert to the CLI, it should clear
1688 deprecated_init_ui_hook. */
1689 if (deprecated_init_ui_hook
)
1690 deprecated_init_ui_hook (argv0
);
1693 /* Python initialization can require various commands to be
1694 installed. For example "info pretty-printer" needs the "info"
1695 prefix to be installed. Keep things simple and just do final
1696 python initialization here. */
1697 finish_python_initialization ();