1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "call-cmds.h"
25 #include "cli/cli-cmds.h"
26 #include "cli/cli-script.h"
27 #include "cli/cli-setshow.h"
28 #include "cli/cli-decode.h"
31 #include "exceptions.h"
34 #include "breakpoint.h"
36 #include "expression.h"
39 #include "terminal.h" /* For job_control. */
41 #include "completer.h"
46 #include "gdb_assert.h"
48 #include "event-loop.h"
49 #include "gdbthread.h"
50 #include "python/python.h"
52 /* readline include files. */
53 #include "readline/readline.h"
54 #include "readline/history.h"
56 /* readline defines this. */
59 #include <sys/types.h>
61 #include "event-top.h"
62 #include "gdb_string.h"
68 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
69 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
70 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
72 /* Default command line prompt. This is overriden in some configs. */
74 #ifndef DEFAULT_PROMPT
75 #define DEFAULT_PROMPT "(gdb) "
78 /* Initialization file name for gdb. This is overridden in some configs. */
82 # define PATH_MAX FILENAME_MAX
88 #ifndef GDBINIT_FILENAME
89 #define GDBINIT_FILENAME ".gdbinit"
91 char gdbinit
[PATH_MAX
+ 1] = GDBINIT_FILENAME
;
93 int inhibit_gdbinit
= 0;
95 /* If nonzero, and GDB has been configured to be able to use windows,
96 attempt to open them upon startup. */
100 extern char lang_frame_mismatch_warn
[]; /* language.c */
102 /* Flag for whether we want all the "from_tty" gubbish printed. */
104 int caution
= 1; /* Default is yes, sigh. */
106 show_caution (struct ui_file
*file
, int from_tty
,
107 struct cmd_list_element
*c
, const char *value
)
109 fprintf_filtered (file
, _("Whether to confirm potentially "
110 "dangerous operations is %s.\n"),
114 /* stdio stream that command input is being read from. Set to stdin
115 normally. Set by source_command to the file we are sourcing. Set
116 to NULL if we are executing a user-defined command or interacting
121 /* Flag to indicate whether a user defined command is currently running. */
125 /* Current working directory. */
127 char *current_directory
;
129 /* The directory name is actually stored here (usually). */
130 char gdb_dirbuf
[1024];
132 /* Function to call before reading a command, if nonzero.
133 The function receives two args: an input stream,
134 and a prompt string. */
136 void (*window_hook
) (FILE *, char *);
141 /* Buffer used for reading command lines, and the size
142 allocated for it so far. */
144 char *saved_command_line
;
145 int saved_command_line_size
= 100;
147 /* Nonzero if the current command is modified by "server ". This
148 affects things like recording into the command history, commands
149 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
150 whatever) can issue its own commands and also send along commands
151 from the user, and have the user not notice that the user interface
152 is issuing commands too. */
155 /* Baud rate specified for talking to serial target systems. Default
156 is left as -1, so targets can choose their own defaults. */
157 /* FIXME: This means that "show remotebaud" and gr_files_info can
158 print -1 or (unsigned int)-1. This is a Bad User Interface. */
162 /* Timeout limit for response from target. */
164 /* The default value has been changed many times over the years. It
165 was originally 5 seconds. But that was thought to be a long time
166 to sit and wait, so it was changed to 2 seconds. That was thought
167 to be plenty unless the connection was going through some terminal
168 server or multiplexer or other form of hairy serial connection.
170 In mid-1996, remote_timeout was moved from remote.c to top.c and
171 it began being used in other remote-* targets. It appears that the
172 default was changed to 20 seconds at that time, perhaps because the
173 Renesas E7000 ICE didn't always respond in a timely manner.
175 But if 5 seconds is a long time to sit and wait for retransmissions,
176 20 seconds is far worse. This demonstrates the difficulty of using
177 a single variable for all protocol timeouts.
179 As remote.c is used much more than remote-e7000.c, it was changed
180 back to 2 seconds in 1999. */
182 int remote_timeout
= 2;
184 /* Non-zero tells remote* modules to output debugging info. */
186 int remote_debug
= 0;
188 /* Sbrk location on entry to main. Used for statistics only. */
193 /* Hooks for alternate command interfaces. */
195 /* Called after most modules have been initialized, but before taking
198 If the UI fails to initialize and it wants GDB to continue using
199 the default UI, then it should clear this hook before returning. */
201 void (*deprecated_init_ui_hook
) (char *argv0
);
203 /* This hook is called from within gdb's many mini-event loops which
204 could steal control from a real user interface's event loop. It
205 returns non-zero if the user is requesting a detach, zero
208 int (*deprecated_ui_loop_hook
) (int);
210 /* Called instead of command_loop at top level. Can be invoked via
211 throw_exception(). */
213 void (*deprecated_command_loop_hook
) (void);
216 /* Called from print_frame_info to list the line we stopped in. */
218 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
222 /* Replaces most of query. */
224 int (*deprecated_query_hook
) (const char *, va_list);
226 /* Replaces most of warning. */
228 void (*deprecated_warning_hook
) (const char *, va_list);
230 /* These three functions support getting lines of text from the user.
231 They are used in sequence. First deprecated_readline_begin_hook is
232 called with a text string that might be (for example) a message for
233 the user to type in a sequence of commands to be executed at a
234 breakpoint. If this function calls back to a GUI, it might take
235 this opportunity to pop up a text interaction window with this
236 message. Next, deprecated_readline_hook is called with a prompt
237 that is emitted prior to collecting the user input. It can be
238 called multiple times. Finally, deprecated_readline_end_hook is
239 called to notify the GUI that we are done with the interaction
240 window and it can close it. */
242 void (*deprecated_readline_begin_hook
) (char *, ...);
243 char *(*deprecated_readline_hook
) (char *);
244 void (*deprecated_readline_end_hook
) (void);
246 /* Called as appropriate to notify the interface that we have attached
247 to or detached from an already running process. */
249 void (*deprecated_attach_hook
) (void);
250 void (*deprecated_detach_hook
) (void);
252 /* Called during long calculations to allow GUI to repair window
253 damage, and to check for stop buttons, etc... */
255 void (*deprecated_interactive_hook
) (void);
257 /* Tell the GUI someone changed the register REGNO. -1 means
258 that the caller does not know which register changed or
259 that several registers have changed (see value_assign). */
260 void (*deprecated_register_changed_hook
) (int regno
);
262 /* Called when going to wait for the target. Usually allows the GUI
263 to run while waiting for target events. */
265 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
266 struct target_waitstatus
*status
,
269 /* Used by UI as a wrapper around command execution. May do various
270 things like enabling/disabling buttons, etc... */
272 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
273 char *cmd
, int from_tty
);
275 /* Called after a `set' command has finished. Is only run if the
276 `set' command succeeded. */
278 void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
280 /* Called when the current thread changes. Argument is thread id. */
282 void (*deprecated_context_hook
) (int id
);
284 /* Handler for SIGHUP. */
287 /* NOTE 1999-04-29: This function will be static again, once we modify
288 gdb to use the event loop as the default command loop and we merge
289 event-top.c into this file, top.c. */
293 caution
= 0; /* Throw caution to the wind -- we're exiting.
294 This prevents asking the user dumb
296 quit_command ((char *) 0, 0);
299 #endif /* defined SIGHUP */
301 /* Line number we are currently in, in a file which is being sourced. */
302 /* NOTE 1999-04-29: This variable will be static again, once we modify
303 gdb to use the event loop as the default command loop and we merge
304 event-top.c into this file, top.c. */
305 /* static */ int source_line_number
;
307 /* Name of the file we are sourcing. */
308 /* NOTE 1999-04-29: This variable will be static again, once we modify
309 gdb to use the event loop as the default command loop and we merge
310 event-top.c into this file, top.c. */
311 /* static */ const char *source_file_name
;
313 /* Clean up on error during a "source" command (or execution of a
314 user-defined command). */
317 do_restore_instream_cleanup (void *stream
)
319 /* Restore the previous input stream. */
323 /* Read commands from STREAM. */
325 read_command_file (FILE *stream
)
327 struct cleanup
*cleanups
;
329 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
332 do_cleanups (cleanups
);
335 void (*pre_init_ui_hook
) (void);
339 do_chdir_cleanup (void *old_dir
)
347 prepare_execute_command (void)
350 struct cleanup
*cleanup
;
352 mark
= value_mark ();
353 cleanup
= make_cleanup_value_free_to_mark (mark
);
355 /* With multiple threads running while the one we're examining is
356 stopped, the dcache can get stale without us being able to detect
357 it. For the duration of the command, though, use the dcache to
358 help things like backtrace. */
360 target_dcache_invalidate ();
365 /* Execute the line P as a command, in the current user context.
366 Pass FROM_TTY as second argument to the defining function. */
369 execute_command (char *p
, int from_tty
)
371 struct cleanup
*cleanup_if_error
, *cleanup
;
372 struct cmd_list_element
*c
;
374 static int warned
= 0;
377 cleanup_if_error
= make_bpstat_clear_actions_cleanup ();
378 cleanup
= prepare_execute_command ();
380 /* Force cleanup of any alloca areas if using C alloca instead of
384 /* This can happen when command_line_input hits end of file. */
387 do_cleanups (cleanup
);
391 target_log_command (p
);
393 while (*p
== ' ' || *p
== '\t')
400 /* If trace-commands is set then this will print this command. */
401 print_command_trace (p
);
403 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
405 /* Pass null arg rather than an empty one. */
408 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
409 while the is_complete_command(cfunc) test is just plain
410 bogus. They should both be replaced by a test of the form
411 c->strip_trailing_white_space_p. */
412 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
413 can't be replaced with func. This is because it is the
414 cfunc, and not the func, that has the value that the
415 is_complete_command hack is testing for. */
416 /* Clear off trailing whitespace, except for set and complete
419 && c
->type
!= set_cmd
420 && !is_complete_command (c
))
422 p
= arg
+ strlen (arg
) - 1;
423 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
428 /* If this command has been pre-hooked, run the hook first. */
429 execute_cmd_pre_hook (c
);
431 if (c
->flags
& DEPRECATED_WARN_USER
)
432 deprecated_cmd_warning (&line
);
434 if (c
->class == class_user
)
435 execute_user_command (c
, arg
);
436 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
437 do_setshow_command (arg
, from_tty
& caution
, c
);
438 else if (!cmd_func_p (c
))
439 error (_("That is not a command, just a help topic."));
440 else if (deprecated_call_command_hook
)
441 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
443 cmd_func (c
, arg
, from_tty
& caution
);
445 /* If this command has been post-hooked, run the hook last. */
446 execute_cmd_post_hook (c
);
450 /* Tell the user if the language has changed (except first time).
451 First make sure that a new frame has been selected, in case this
452 command or the hooks changed the program state. */
453 deprecated_safe_get_selected_frame ();
454 if (current_language
!= expected_language
)
456 if (language_mode
== language_mode_auto
&& info_verbose
)
458 language_info (1); /* Print what changed. */
463 /* Warn the user if the working language does not match the
464 language of the current frame. Only warn the user if we are
465 actually running the program, i.e. there is a stack. */
466 /* FIXME: This should be cacheing the frame and only running when
467 the frame changes. */
469 if (has_stack_frames ())
471 flang
= get_frame_language ();
473 && flang
!= language_unknown
474 && flang
!= current_language
->la_language
)
476 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
481 do_cleanups (cleanup
);
482 discard_cleanups (cleanup_if_error
);
485 /* Run execute_command for P and FROM_TTY. Capture its output into the
486 returned string, do not display it to the screen. BATCH_FLAG will be
487 temporarily set to true. */
490 execute_command_to_string (char *p
, int from_tty
)
492 struct ui_file
*str_file
;
493 struct cleanup
*cleanup
;
496 /* GDB_STDOUT should be better already restored during these
497 restoration callbacks. */
498 cleanup
= set_batch_flag_and_make_cleanup_restore_page_info ();
500 str_file
= mem_fileopen ();
502 make_cleanup_ui_file_delete (str_file
);
503 make_cleanup_restore_ui_file (&gdb_stdout
);
504 make_cleanup_restore_ui_file (&gdb_stderr
);
505 make_cleanup_restore_ui_file (&gdb_stdlog
);
506 make_cleanup_restore_ui_file (&gdb_stdtarg
);
507 make_cleanup_restore_ui_file (&gdb_stdtargerr
);
509 if (ui_out_redirect (current_uiout
, str_file
) < 0)
510 warning (_("Current output protocol does not support redirection"));
512 make_cleanup_ui_out_redirect_pop (current_uiout
);
514 gdb_stdout
= str_file
;
515 gdb_stderr
= str_file
;
516 gdb_stdlog
= str_file
;
517 gdb_stdtarg
= str_file
;
518 gdb_stdtargerr
= str_file
;
520 execute_command (p
, from_tty
);
522 retval
= ui_file_xstrdup (str_file
, NULL
);
524 do_cleanups (cleanup
);
529 /* Read commands from `instream' and execute them
530 until end of file or error reading instream. */
535 struct cleanup
*old_chain
;
537 int stdin_is_tty
= ISATTY (stdin
);
539 while (instream
&& !feof (instream
))
541 if (window_hook
&& instream
== stdin
)
542 (*window_hook
) (instream
, get_prompt (0));
545 if (instream
== stdin
&& stdin_is_tty
)
546 reinitialize_more_filter ();
547 old_chain
= make_cleanup (null_cleanup
, 0);
549 /* Get a command-line. This calls the readline package. */
550 command
= command_line_input (instream
== stdin
?
551 get_prompt (0) : (char *) NULL
,
552 instream
== stdin
, "prompt");
555 do_cleanups (old_chain
);
559 make_command_stats_cleanup (1);
561 execute_command (command
, instream
== stdin
);
563 /* Do any commands attached to breakpoint we are stopped at. */
564 bpstat_do_actions ();
566 do_cleanups (old_chain
);
570 /* When nonzero, cause dont_repeat to do nothing. This should only be
571 set via prevent_dont_repeat. */
573 static int suppress_dont_repeat
= 0;
575 /* Commands call this if they do not want to be repeated by null lines. */
580 if (suppress_dont_repeat
|| server_command
)
583 /* If we aren't reading from standard input, we are saving the last
584 thing read from stdin in line and don't want to delete it. Null
585 lines won't repeat here in any case. */
586 if (instream
== stdin
)
587 *saved_command_line
= 0;
590 /* Prevent dont_repeat from working, and return a cleanup that
591 restores the previous state. */
594 prevent_dont_repeat (void)
596 struct cleanup
*result
= make_cleanup_restore_integer (&suppress_dont_repeat
);
598 suppress_dont_repeat
= 1;
603 /* Read a line from the stream "instream" without command line editing.
605 It prints PROMPT_ARG once at the start.
606 Action is compatible with "readline", e.g. space for the result is
607 malloc'd and should be freed by the caller.
609 A NULL return means end of file. */
611 gdb_readline (char *prompt_arg
)
616 int result_size
= 80;
620 /* Don't use a _filtered function here. It causes the assumed
621 character position to be off, since the newline we read from
622 the user is not accounted for. */
623 fputs_unfiltered (prompt_arg
, gdb_stdout
);
624 gdb_flush (gdb_stdout
);
627 result
= (char *) xmalloc (result_size
);
631 /* Read from stdin if we are executing a user defined command.
632 This is the right thing for prompt_for_continue, at least. */
633 c
= fgetc (instream
? instream
: stdin
);
638 /* The last line does not end with a newline. Return it, and
639 if we are called again fgetc will still return EOF and
640 we'll return NULL then. */
648 if (input_index
> 0 && result
[input_index
- 1] == '\r')
653 result
[input_index
++] = c
;
654 while (input_index
>= result_size
)
657 result
= (char *) xrealloc (result
, result_size
);
661 result
[input_index
++] = '\0';
665 /* Variables which control command line editing and history
666 substitution. These variables are given default values at the end
668 static int command_editing_p
;
670 /* NOTE 1999-04-29: This variable will be static again, once we modify
671 gdb to use the event loop as the default command loop and we merge
672 event-top.c into this file, top.c. */
674 /* static */ int history_expansion_p
;
676 static int write_history_p
;
678 show_write_history_p (struct ui_file
*file
, int from_tty
,
679 struct cmd_list_element
*c
, const char *value
)
681 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
685 static int history_size
;
687 show_history_size (struct ui_file
*file
, int from_tty
,
688 struct cmd_list_element
*c
, const char *value
)
690 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
694 static char *history_filename
;
696 show_history_filename (struct ui_file
*file
, int from_tty
,
697 struct cmd_list_element
*c
, const char *value
)
699 fprintf_filtered (file
, _("The filename in which to record "
700 "the command history is \"%s\".\n"),
704 /* This is like readline(), but it has some gdb-specific behavior.
705 gdb may want readline in both the synchronous and async modes during
706 a single gdb invocation. At the ordinary top-level prompt we might
707 be using the async readline. That means we can't use
708 rl_pre_input_hook, since it doesn't work properly in async mode.
709 However, for a secondary prompt (" >", such as occurs during a
710 `define'), gdb wants a synchronous response.
712 We used to call readline() directly, running it in synchronous
713 mode. But mixing modes this way is not supported, and as of
714 readline 5.x it no longer works; the arrow keys come unbound during
715 the synchronous call. So we make a nested call into the event
716 loop. That's what gdb_readline_wrapper is for. */
718 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
719 rely on gdb_readline_wrapper_result, which might still be NULL if
720 the user types Control-D for EOF. */
721 static int gdb_readline_wrapper_done
;
723 /* The result of the current call to gdb_readline_wrapper, once a newline
725 static char *gdb_readline_wrapper_result
;
727 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
728 to be called after the newline is processed (which will redisplay
729 the prompt). But in gdb_readline_wrapper we will not get a new
730 prompt until the next call, or until we return to the event loop.
731 So we disable this hook around the newline and restore it before we
733 static void (*saved_after_char_processing_hook
) (void);
735 /* This function is called when readline has seen a complete line of
739 gdb_readline_wrapper_line (char *line
)
741 gdb_assert (!gdb_readline_wrapper_done
);
742 gdb_readline_wrapper_result
= line
;
743 gdb_readline_wrapper_done
= 1;
745 /* Prevent operate-and-get-next from acting too early. */
746 saved_after_char_processing_hook
= after_char_processing_hook
;
747 after_char_processing_hook
= NULL
;
749 /* Prevent parts of the prompt from being redisplayed if annotations
750 are enabled, and readline's state getting out of sync. */
751 if (async_command_editing_p
)
752 rl_callback_handler_remove ();
755 struct gdb_readline_wrapper_cleanup
757 void (*handler_orig
) (char *);
758 int already_prompted_orig
;
762 gdb_readline_wrapper_cleanup (void *arg
)
764 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
766 rl_already_prompted
= cleanup
->already_prompted_orig
;
768 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
769 input_handler
= cleanup
->handler_orig
;
770 gdb_readline_wrapper_result
= NULL
;
771 gdb_readline_wrapper_done
= 0;
773 after_char_processing_hook
= saved_after_char_processing_hook
;
774 saved_after_char_processing_hook
= NULL
;
780 gdb_readline_wrapper (char *prompt
)
782 struct cleanup
*back_to
;
783 struct gdb_readline_wrapper_cleanup
*cleanup
;
786 cleanup
= xmalloc (sizeof (*cleanup
));
787 cleanup
->handler_orig
= input_handler
;
788 input_handler
= gdb_readline_wrapper_line
;
790 cleanup
->already_prompted_orig
= rl_already_prompted
;
792 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
794 /* Display our prompt and prevent double prompt display. */
795 display_gdb_prompt (prompt
);
796 rl_already_prompted
= 1;
798 if (after_char_processing_hook
)
799 (*after_char_processing_hook
) ();
800 gdb_assert (after_char_processing_hook
== NULL
);
802 while (gdb_do_one_event () >= 0)
803 if (gdb_readline_wrapper_done
)
806 retval
= gdb_readline_wrapper_result
;
807 do_cleanups (back_to
);
812 /* The current saved history number from operate-and-get-next.
813 This is -1 if not valid. */
814 static int operate_saved_history
= -1;
816 /* This is put on the appropriate hook and helps operate-and-get-next
819 gdb_rl_operate_and_get_next_completion (void)
821 int delta
= where_history () - operate_saved_history
;
823 /* The `key' argument to rl_get_previous_history is ignored. */
824 rl_get_previous_history (delta
, 0);
825 operate_saved_history
= -1;
827 /* readline doesn't automatically update the display for us. */
830 after_char_processing_hook
= NULL
;
831 rl_pre_input_hook
= NULL
;
834 /* This is a gdb-local readline command handler. It accepts the
835 current command line (like RET does) and, if this command was taken
836 from the history, arranges for the next command in the history to
837 appear on the command line when the prompt returns.
838 We ignore the arguments. */
840 gdb_rl_operate_and_get_next (int count
, int key
)
844 /* Use the async hook. */
845 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
847 /* Find the current line, and find the next line to use. */
848 where
= where_history();
850 /* FIXME: kettenis/20020817: max_input_history is renamed into
851 history_max_entries in readline-4.2. When we do a new readline
852 import, we should probably change it here too, even though
853 readline maintains backwards compatibility for now by still
854 defining max_input_history. */
855 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
856 (where
>= history_length
- 1))
857 operate_saved_history
= where
;
859 operate_saved_history
= where
+ 1;
861 return rl_newline (1, key
);
864 /* Read one line from the command input stream `instream'
865 into the local static buffer `linebuffer' (whose current length
867 The buffer is made bigger as necessary.
868 Returns the address of the start of the line.
870 NULL is returned for end of file.
872 *If* the instream == stdin & stdin is a terminal, the line read
873 is copied into the file line saver (global var char *line,
874 length linesize) so that it can be duplicated.
876 This routine either uses fancy command line editing or
877 simple input as the user has requested. */
880 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
882 static char *linebuffer
= 0;
883 static unsigned linelength
= 0;
887 char *local_prompt
= prompt_arg
;
891 /* The annotation suffix must be non-NULL. */
892 if (annotation_suffix
== NULL
)
893 annotation_suffix
= "";
895 if (annotation_level
> 1 && instream
== stdin
)
897 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
898 + strlen (annotation_suffix
) + 40);
899 if (prompt_arg
== NULL
)
900 local_prompt
[0] = '\0';
902 strcpy (local_prompt
, prompt_arg
);
903 strcat (local_prompt
, "\n\032\032");
904 strcat (local_prompt
, annotation_suffix
);
905 strcat (local_prompt
, "\n");
911 linebuffer
= (char *) xmalloc (linelength
);
916 /* Control-C quits instantly if typed while in this loop
917 since it should not wait until the user types a newline. */
921 signal (STOP_SIGNAL
, handle_stop_sig
);
926 /* Make sure that all output has been output. Some machines may
927 let you get away with leaving out some of the gdb_flush, but
930 gdb_flush (gdb_stdout
);
931 gdb_flush (gdb_stderr
);
933 if (source_file_name
!= NULL
)
934 ++source_line_number
;
936 if (annotation_level
> 1 && instream
== stdin
)
938 puts_unfiltered ("\n\032\032pre-");
939 puts_unfiltered (annotation_suffix
);
940 puts_unfiltered ("\n");
943 /* Don't use fancy stuff if not talking to stdin. */
944 if (deprecated_readline_hook
&& input_from_terminal_p ())
946 rl
= (*deprecated_readline_hook
) (local_prompt
);
948 else if (command_editing_p
&& input_from_terminal_p ())
950 rl
= gdb_readline_wrapper (local_prompt
);
954 rl
= gdb_readline (local_prompt
);
957 if (annotation_level
> 1 && instream
== stdin
)
959 puts_unfiltered ("\n\032\032post-");
960 puts_unfiltered (annotation_suffix
);
961 puts_unfiltered ("\n");
964 if (!rl
|| rl
== (char *) EOF
)
969 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
971 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
972 nline
= (char *) xrealloc (linebuffer
, linelength
);
973 p
+= nline
- linebuffer
;
977 /* Copy line. Don't copy null at end. (Leaves line alone
978 if this was just a newline). */
982 xfree (rl
); /* Allocated in readline. */
984 if (p
== linebuffer
|| *(p
- 1) != '\\')
987 p
--; /* Put on top of '\'. */
988 local_prompt
= (char *) 0;
993 signal (STOP_SIGNAL
, SIG_DFL
);
1000 #define SERVER_COMMAND_LENGTH 7
1002 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1003 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1006 /* Note that we don't set `line'. Between this and the check in
1007 dont_repeat, this insures that repeating will still do the
1010 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1013 /* Do history expansion if that is wished. */
1014 if (history_expansion_p
&& instream
== stdin
1015 && ISATTY (instream
))
1017 char *history_value
;
1020 *p
= '\0'; /* Insert null now. */
1021 expanded
= history_expand (linebuffer
, &history_value
);
1024 /* Print the changes. */
1025 printf_unfiltered ("%s\n", history_value
);
1027 /* If there was an error, call this function again. */
1030 xfree (history_value
);
1031 return command_line_input (prompt_arg
, repeat
,
1034 if (strlen (history_value
) > linelength
)
1036 linelength
= strlen (history_value
) + 1;
1037 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1039 strcpy (linebuffer
, history_value
);
1040 p
= linebuffer
+ strlen (linebuffer
);
1042 xfree (history_value
);
1045 /* If we just got an empty line, and that is supposed to repeat the
1046 previous command, return the value in the global buffer. */
1047 if (repeat
&& p
== linebuffer
)
1048 return saved_command_line
;
1049 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1051 return saved_command_line
;
1055 /* Add line to history if appropriate. */
1056 if (instream
== stdin
1057 && ISATTY (stdin
) && *linebuffer
)
1058 add_history (linebuffer
);
1060 /* Note: lines consisting solely of comments are added to the command
1061 history. This is useful when you type a command, and then
1062 realize you don't want to execute it quite yet. You can comment
1063 out the command and then later fetch it from the value history
1064 and remove the '#'. The kill ring is probably better, but some
1065 people are in the habit of commenting things out. */
1067 *p1
= '\0'; /* Found a comment. */
1069 /* Save into global buffer if appropriate. */
1072 if (linelength
> saved_command_line_size
)
1074 saved_command_line
= xrealloc (saved_command_line
, linelength
);
1075 saved_command_line_size
= linelength
;
1077 strcpy (saved_command_line
, linebuffer
);
1078 return saved_command_line
;
1084 /* Print the GDB banner. */
1086 print_gdb_version (struct ui_file
*stream
)
1088 /* From GNU coding standards, first line is meant to be easy for a
1089 program to parse, and is just canonical program name and version
1090 number, which starts after last space. */
1092 fprintf_filtered (stream
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1094 /* Second line is a copyright notice. */
1096 fprintf_filtered (stream
,
1097 "Copyright (C) 2011 Free Software Foundation, Inc.\n");
1099 /* Following the copyright is a brief statement that the program is
1100 free software, that users are free to copy and change it on
1101 certain conditions, that it is covered by the GNU GPL, and that
1102 there is no warranty. */
1104 fprintf_filtered (stream
, "\
1105 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1106 \nThis is free software: you are free to change and redistribute it.\n\
1107 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1108 and \"show warranty\" for details.\n");
1110 /* After the required info we print the configuration information. */
1112 fprintf_filtered (stream
, "This GDB was configured as \"");
1113 if (strcmp (host_name
, target_name
) != 0)
1115 fprintf_filtered (stream
, "--host=%s --target=%s",
1116 host_name
, target_name
);
1120 fprintf_filtered (stream
, "%s", host_name
);
1122 fprintf_filtered (stream
, "\".");
1124 if (REPORT_BUGS_TO
[0])
1126 fprintf_filtered (stream
,
1127 _("\nFor bug reporting instructions, please see:\n"));
1128 fprintf_filtered (stream
, "%s.", REPORT_BUGS_TO
);
1133 /* get_prefix: access method for the GDB prefix string. */
1136 get_prefix (int level
)
1138 return PREFIX (level
);
1141 /* set_prefix: set method for the GDB prefix string. */
1144 set_prefix (const char *s
, int level
)
1146 /* If S is NULL, just free the PREFIX at level LEVEL and set to
1150 xfree (PREFIX (level
));
1151 PREFIX (level
) = NULL
;
1155 char *p
= xstrdup (s
);
1157 xfree (PREFIX (level
));
1162 /* get_suffix: access method for the GDB suffix string. */
1165 get_suffix (int level
)
1167 return SUFFIX (level
);
1170 /* set_suffix: set method for the GDB suffix string. */
1173 set_suffix (const char *s
, int level
)
1175 /* If S is NULL, just free the SUFFIX at level LEVEL and set to
1179 xfree (SUFFIX (level
));
1180 SUFFIX (level
) = NULL
;
1184 char *p
= xstrdup (s
);
1186 xfree (SUFFIX (level
));
1191 /* get_prompt: access method for the GDB prompt string. */
1194 get_prompt (int level
)
1196 return PROMPT (level
);
1200 set_prompt (const char *s
, int level
)
1202 /* If S is NULL, just free the PROMPT at level LEVEL and set to
1206 xfree (PROMPT (level
));
1207 PROMPT (level
) = NULL
;
1211 char *p
= xstrdup (s
);
1218 /* Also, free and set new_async_prompt so prompt changes sync up
1219 with set/show prompt. */
1220 xfree (new_async_prompt
);
1221 new_async_prompt
= xstrdup (PROMPT (0));
1233 /* Callback for iterate_over_inferiors. Kills or detaches the given
1234 inferior, depending on how we originally gained control of it. */
1237 kill_or_detach (struct inferior
*inf
, void *args
)
1239 struct qt_args
*qt
= args
;
1240 struct thread_info
*thread
;
1245 thread
= any_thread_of_process (inf
->pid
);
1248 switch_to_thread (thread
->ptid
);
1250 /* Leave core files alone. */
1251 if (target_has_execution
)
1253 if (inf
->attach_flag
)
1254 target_detach (qt
->args
, qt
->from_tty
);
1263 /* Callback for iterate_over_inferiors. Prints info about what GDB
1264 will do to each inferior on a "quit". ARG points to a struct
1265 ui_out where output is to be collected. */
1268 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1270 struct ui_file
*stb
= arg
;
1275 if (inf
->attach_flag
)
1276 fprintf_filtered (stb
,
1277 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1278 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1280 fprintf_filtered (stb
,
1281 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1282 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1287 /* If necessary, make the user confirm that we should quit. Return
1288 non-zero if we should quit, zero if we shouldn't. */
1293 struct ui_file
*stb
;
1294 struct cleanup
*old_chain
;
1298 /* Don't even ask if we're only debugging a core file inferior. */
1299 if (!have_live_inferiors ())
1302 /* Build the query string as a single string. */
1303 stb
= mem_fileopen ();
1304 old_chain
= make_cleanup_ui_file_delete (stb
);
1306 /* This is something of a hack. But there's no reliable way to see
1307 if a GUI is running. The `use_windows' variable doesn't cut
1309 if (deprecated_init_ui_hook
)
1310 fprintf_filtered (stb
, _("A debugging session is active.\n"
1311 "Do you still want to close the debugger?"));
1314 fprintf_filtered (stb
, _("A debugging session is active.\n\n"));
1315 iterate_over_inferiors (print_inferior_quit_action
, stb
);
1316 fprintf_filtered (stb
, _("\nQuit anyway? "));
1319 str
= ui_file_xstrdup (stb
, NULL
);
1320 make_cleanup (xfree
, str
);
1322 qr
= query ("%s", str
);
1323 do_cleanups (old_chain
);
1327 /* Helper routine for quit_force that requires error handling. */
1330 quit_target (void *arg
)
1332 struct qt_args
*qt
= (struct qt_args
*)arg
;
1334 /* Kill or detach all inferiors. */
1335 iterate_over_inferiors (kill_or_detach
, qt
);
1337 /* Give all pushed targets a chance to do minimal cleanup, and pop
1339 pop_all_targets (1);
1341 /* Save the history information if it is appropriate to do so. */
1342 if (write_history_p
&& history_filename
)
1343 write_history (history_filename
);
1345 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before
1350 /* Quit without asking for confirmation. */
1353 quit_force (char *args
, int from_tty
)
1358 /* An optional expression may be used to cause gdb to terminate with the
1359 value of that expression. */
1362 struct value
*val
= parse_and_eval (args
);
1364 exit_code
= (int) value_as_long (val
);
1366 else if (return_child_result
)
1367 exit_code
= return_child_result_value
;
1370 qt
.from_tty
= from_tty
;
1372 /* We want to handle any quit errors and exit regardless. */
1373 catch_errors (quit_target
, &qt
,
1374 "Quitting: ", RETURN_MASK_ALL
);
1379 /* Returns whether GDB is running on a terminal and input is
1380 currently coming from that terminal. */
1383 input_from_terminal_p (void)
1388 if (gdb_has_a_terminal () && instream
== stdin
)
1391 /* If INSTREAM is unset, and we are not in a user command, we
1392 must be in Insight. That's like having a terminal, for our
1394 if (instream
== NULL
&& !in_user_command
)
1401 dont_repeat_command (char *ignored
, int from_tty
)
1403 /* Can't call dont_repeat here because we're not necessarily reading
1405 *saved_command_line
= 0;
1408 /* Functions to manipulate command line editing control variables. */
1410 /* Number of commands to print in each call to show_commands. */
1411 #define Hist_print 10
1413 show_commands (char *args
, int from_tty
)
1415 /* Index for history commands. Relative to history_base. */
1418 /* Number of the history entry which we are planning to display next.
1419 Relative to history_base. */
1422 /* The first command in the history which doesn't exist (i.e. one more
1423 than the number of the last command). Relative to history_base. */
1426 /* Print out some of the commands from the command history. */
1427 /* First determine the length of the history list. */
1428 hist_len
= history_size
;
1429 for (offset
= 0; offset
< history_size
; offset
++)
1431 if (!history_get (history_base
+ offset
))
1440 if (args
[0] == '+' && args
[1] == '\0')
1441 /* "info editing +" should print from the stored position. */
1444 /* "info editing <exp>" should print around command number <exp>. */
1445 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1447 /* "show commands" means print the last Hist_print commands. */
1450 num
= hist_len
- Hist_print
;
1456 /* If there are at least Hist_print commands, we want to display the last
1457 Hist_print rather than, say, the last 6. */
1458 if (hist_len
- num
< Hist_print
)
1460 num
= hist_len
- Hist_print
;
1465 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1467 printf_filtered ("%5d %s\n", history_base
+ offset
,
1468 (history_get (history_base
+ offset
))->line
);
1471 /* The next command we want to display is the next one that we haven't
1475 /* If the user repeats this command with return, it should do what
1476 "show commands +" does. This is unnecessary if arg is null,
1477 because "show commands +" is not useful after "show commands". */
1478 if (from_tty
&& args
)
1485 /* Called by do_setshow_command. */
1487 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1489 if (history_size
== INT_MAX
)
1490 unstifle_history ();
1491 else if (history_size
>= 0)
1492 stifle_history (history_size
);
1495 history_size
= INT_MAX
;
1496 error (_("History size must be non-negative"));
1501 set_history (char *args
, int from_tty
)
1503 printf_unfiltered (_("\"set history\" must be followed "
1504 "by the name of a history subcommand.\n"));
1505 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1509 show_history (char *args
, int from_tty
)
1511 cmd_show_list (showhistlist
, from_tty
, "");
1514 int info_verbose
= 0; /* Default verbose msgs off. */
1516 /* Called by do_setshow_command. An elaborate joke. */
1518 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1520 char *cmdname
= "verbose";
1521 struct cmd_list_element
*showcmd
;
1523 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1524 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1528 c
->doc
= "Set verbose printing of informational messages.";
1529 showcmd
->doc
= "Show verbose printing of informational messages.";
1533 c
->doc
= "Set verbosity.";
1534 showcmd
->doc
= "Show verbosity.";
1538 /* Init the history buffer. Note that we are called after the init file(s)
1539 have been read so that the user can change the history file via his
1540 .gdbinit file (for instance). The GDBHISTFILE environment variable
1541 overrides all of this. */
1548 tmpenv
= getenv ("HISTSIZE");
1550 history_size
= atoi (tmpenv
);
1551 else if (!history_size
)
1554 stifle_history (history_size
);
1556 tmpenv
= getenv ("GDBHISTFILE");
1558 history_filename
= xstrdup (tmpenv
);
1559 else if (!history_filename
)
1561 /* We include the current directory so that if the user changes
1562 directories the file written will be the same as the one
1565 /* No leading dots in file names are allowed on MSDOS. */
1566 history_filename
= concat (current_directory
, "/_gdb_history",
1569 history_filename
= concat (current_directory
, "/.gdb_history",
1573 read_history (history_filename
);
1577 show_new_async_prompt (struct ui_file
*file
, int from_tty
,
1578 struct cmd_list_element
*c
, const char *value
)
1580 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1584 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1585 struct cmd_list_element
*c
, const char *value
)
1587 fprintf_filtered (file
, _("Editing of command lines as "
1588 "they are typed is %s.\n"),
1593 show_annotation_level (struct ui_file
*file
, int from_tty
,
1594 struct cmd_list_element
*c
, const char *value
)
1596 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1600 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1601 struct cmd_list_element
*c
, const char *value
)
1603 fprintf_filtered (file
, _("Notification of completion for "
1604 "asynchronous execution commands is %s.\n"),
1610 /* initialize the prompt stack to a simple "(gdb) " prompt or to
1611 whatever the DEFAULT_PROMPT is. */
1612 the_prompts
.top
= 0;
1614 set_prompt (DEFAULT_PROMPT
, 0);
1616 /* Set things up for annotation_level > 1, if the user ever decides
1618 async_annotation_suffix
= "prompt";
1620 /* If gdb was started with --annotate=2, this is equivalent to the
1621 user entering the command 'set annotate 2' at the gdb prompt, so
1622 we need to do extra processing. */
1623 if (annotation_level
> 1)
1624 set_async_annotation_level (NULL
, 0, NULL
);
1626 /* Set the important stuff up for command editing. */
1627 command_editing_p
= 1;
1628 history_expansion_p
= 0;
1629 write_history_p
= 0;
1631 /* Setup important stuff for command line editing. */
1632 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
1633 rl_completion_entry_function
= readline_line_completion_function
;
1634 rl_completer_word_break_characters
= default_word_break_characters ();
1635 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1636 rl_readline_name
= "gdb";
1637 rl_terminal_name
= getenv ("TERM");
1639 /* The name for this defun comes from Bash, where it originated.
1640 15 is Control-o, the same binding this function has in Bash. */
1641 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1643 add_setshow_string_cmd ("prompt", class_support
,
1645 _("Set gdb's prompt"),
1646 _("Show gdb's prompt"),
1647 NULL
, set_async_prompt
,
1648 show_new_async_prompt
,
1649 &setlist
, &showlist
);
1651 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1652 Don't repeat this command.\nPrimarily \
1653 used inside of user-defined commands that should not be repeated when\n\
1656 add_setshow_boolean_cmd ("editing", class_support
,
1657 &async_command_editing_p
, _("\
1658 Set editing of command lines as they are typed."), _("\
1659 Show editing of command lines as they are typed."), _("\
1660 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1661 Without an argument, command line editing is enabled. To edit, use\n\
1662 EMACS-like or VI-like commands like control-P or ESC."),
1663 set_async_editing_command
,
1664 show_async_command_editing_p
,
1665 &setlist
, &showlist
);
1667 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1668 Set saving of the history record on exit."), _("\
1669 Show saving of the history record on exit."), _("\
1670 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1671 Without an argument, saving is enabled."),
1673 show_write_history_p
,
1674 &sethistlist
, &showhistlist
);
1676 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1677 Set the size of the command history,"), _("\
1678 Show the size of the command history,"), _("\
1679 ie. the number of previous commands to keep a record of."),
1680 set_history_size_command
,
1682 &sethistlist
, &showhistlist
);
1684 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1685 Set the filename in which to record the command history"), _("\
1686 Show the filename in which to record the command history"), _("\
1687 (the list of previous commands of which a record is kept)."),
1689 show_history_filename
,
1690 &sethistlist
, &showhistlist
);
1692 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1693 Set whether to confirm potentially dangerous operations."), _("\
1694 Show whether to confirm potentially dangerous operations."), NULL
,
1697 &setlist
, &showlist
);
1699 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1700 Set annotation_level."), _("\
1701 Show annotation_level."), _("\
1702 0 == normal; 1 == fullname (for use when running under emacs)\n\
1703 2 == output annotated suitably for use by programs that control GDB."),
1704 set_async_annotation_level
,
1705 show_annotation_level
,
1706 &setlist
, &showlist
);
1708 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1709 &exec_done_display_p
, _("\
1710 Set notification of completion for asynchronous execution commands."), _("\
1711 Show notification of completion for asynchronous execution commands."), _("\
1712 Use \"on\" to enable the notification, and \"off\" to disable it."),
1714 show_exec_done_display_p
,
1715 &setlist
, &showlist
);
1717 add_setshow_filename_cmd ("data-directory", class_maintenance
,
1718 &gdb_datadir
, _("Set GDB's data directory."),
1719 _("Show GDB's data directory."),
1721 When set, GDB uses the specified path to search for data files."),
1728 gdb_init (char *argv0
)
1730 if (pre_init_ui_hook
)
1731 pre_init_ui_hook ();
1733 /* Run the init function of each source file. */
1736 /* Make sure we return to the original directory upon exit, come
1737 what may, since the OS doesn't do that for us. */
1738 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1741 init_cmd_lists (); /* This needs to be done first. */
1742 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1743 initialize_utils (); /* Make errors and warnings possible. */
1745 /* Here is where we call all the _initialize_foo routines. */
1746 initialize_all_files ();
1748 /* This creates the current_program_space. Do this after all the
1749 _initialize_foo routines have had a chance to install their
1750 per-sspace data keys. Also do this before
1751 initialize_current_architecture is called, because it accesses
1752 exec_bfd of the current program space. */
1753 initialize_progspace ();
1754 initialize_inferiors ();
1755 initialize_current_architecture ();
1757 init_main (); /* But that omits this file! Do it now. */
1759 initialize_stdin_serial ();
1761 async_init_signals ();
1763 /* We need a default language for parsing expressions, so simple
1764 things like "set width 0" won't fail if no language is explicitly
1765 set in a config file or implicitly set by reading an executable
1767 set_language (language_c
);
1768 expected_language
= current_language
; /* Don't warn about the change. */
1770 /* Allow another UI to initialize. If the UI fails to initialize,
1771 and it wants GDB to revert to the CLI, it should clear
1772 deprecated_init_ui_hook. */
1773 if (deprecated_init_ui_hook
)
1774 deprecated_init_ui_hook (argv0
);
1777 /* Python initialization can require various commands to be
1778 installed. For example "info pretty-printer" needs the "info"
1779 prefix to be installed. Keep things simple and just do final
1780 python initialization here. */
1781 finish_python_initialization ();