1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2012 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "call-cmds.h"
23 #include "cli/cli-cmds.h"
24 #include "cli/cli-script.h"
25 #include "cli/cli-setshow.h"
26 #include "cli/cli-decode.h"
29 #include "exceptions.h"
32 #include "breakpoint.h"
34 #include "expression.h"
37 #include "terminal.h" /* For job_control. */
39 #include "completer.h"
44 #include "gdb_assert.h"
46 #include "event-loop.h"
47 #include "gdbthread.h"
48 #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 to confirm potentially dangerous
103 operations. Default is yes. */
108 show_confirm (struct ui_file
*file
, int from_tty
,
109 struct cmd_list_element
*c
, const char *value
)
111 fprintf_filtered (file
, _("Whether to confirm potentially "
112 "dangerous operations is %s.\n"),
116 /* stdio stream that command input is being read from. Set to stdin
117 normally. Set by source_command to the file we are sourcing. Set
118 to NULL if we are executing a user-defined command or interacting
123 /* Flag to indicate whether a user defined command is currently running. */
127 /* Current working directory. */
129 char *current_directory
;
131 /* The directory name is actually stored here (usually). */
132 char gdb_dirbuf
[1024];
134 /* Function to call before reading a command, if nonzero.
135 The function receives two args: an input stream,
136 and a prompt string. */
138 void (*window_hook
) (FILE *, char *);
143 /* Buffer used for reading command lines, and the size
144 allocated for it so far. */
146 char *saved_command_line
;
147 int saved_command_line_size
= 100;
149 /* Nonzero if the current command is modified by "server ". This
150 affects things like recording into the command history, commands
151 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
152 whatever) can issue its own commands and also send along commands
153 from the user, and have the user not notice that the user interface
154 is issuing commands too. */
157 /* Baud rate specified for talking to serial target systems. Default
158 is left as -1, so targets can choose their own defaults. */
159 /* FIXME: This means that "show remotebaud" and gr_files_info can
160 print -1 or (unsigned int)-1. This is a Bad User Interface. */
164 /* Timeout limit for response from target. */
166 /* The default value has been changed many times over the years. It
167 was originally 5 seconds. But that was thought to be a long time
168 to sit and wait, so it was changed to 2 seconds. That was thought
169 to be plenty unless the connection was going through some terminal
170 server or multiplexer or other form of hairy serial connection.
172 In mid-1996, remote_timeout was moved from remote.c to top.c and
173 it began being used in other remote-* targets. It appears that the
174 default was changed to 20 seconds at that time, perhaps because the
175 Renesas E7000 ICE didn't always respond in a timely manner.
177 But if 5 seconds is a long time to sit and wait for retransmissions,
178 20 seconds is far worse. This demonstrates the difficulty of using
179 a single variable for all protocol timeouts.
181 As remote.c is used much more than remote-e7000.c, it was changed
182 back to 2 seconds in 1999. */
184 int remote_timeout
= 2;
186 /* Non-zero tells remote* modules to output debugging info. */
188 int remote_debug
= 0;
190 /* Sbrk location on entry to main. Used for statistics only. */
195 /* Hooks for alternate command interfaces. */
197 /* Called after most modules have been initialized, but before taking
200 If the UI fails to initialize and it wants GDB to continue using
201 the default UI, then it should clear this hook before returning. */
203 void (*deprecated_init_ui_hook
) (char *argv0
);
205 /* This hook is called from within gdb's many mini-event loops which
206 could steal control from a real user interface's event loop. It
207 returns non-zero if the user is requesting a detach, zero
210 int (*deprecated_ui_loop_hook
) (int);
212 /* Called instead of command_loop at top level. Can be invoked via
213 throw_exception(). */
215 void (*deprecated_command_loop_hook
) (void);
218 /* Called from print_frame_info to list the line we stopped in. */
220 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
224 /* Replaces most of query. */
226 int (*deprecated_query_hook
) (const char *, va_list);
228 /* Replaces most of warning. */
230 void (*deprecated_warning_hook
) (const char *, va_list);
232 /* These three functions support getting lines of text from the user.
233 They are used in sequence. First deprecated_readline_begin_hook is
234 called with a text string that might be (for example) a message for
235 the user to type in a sequence of commands to be executed at a
236 breakpoint. If this function calls back to a GUI, it might take
237 this opportunity to pop up a text interaction window with this
238 message. Next, deprecated_readline_hook is called with a prompt
239 that is emitted prior to collecting the user input. It can be
240 called multiple times. Finally, deprecated_readline_end_hook is
241 called to notify the GUI that we are done with the interaction
242 window and it can close it. */
244 void (*deprecated_readline_begin_hook
) (char *, ...);
245 char *(*deprecated_readline_hook
) (char *);
246 void (*deprecated_readline_end_hook
) (void);
248 /* Called as appropriate to notify the interface that we have attached
249 to or detached from an already running process. */
251 void (*deprecated_attach_hook
) (void);
252 void (*deprecated_detach_hook
) (void);
254 /* Called during long calculations to allow GUI to repair window
255 damage, and to check for stop buttons, etc... */
257 void (*deprecated_interactive_hook
) (void);
259 /* Tell the GUI someone changed the register REGNO. -1 means
260 that the caller does not know which register changed or
261 that several registers have changed (see value_assign). */
262 void (*deprecated_register_changed_hook
) (int regno
);
264 /* Called when going to wait for the target. Usually allows the GUI
265 to run while waiting for target events. */
267 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
268 struct target_waitstatus
*status
,
271 /* Used by UI as a wrapper around command execution. May do various
272 things like enabling/disabling buttons, etc... */
274 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
275 char *cmd
, int from_tty
);
277 /* Called after a `set' command has finished. Is only run if the
278 `set' command succeeded. */
280 void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
282 /* Called when the current thread changes. Argument is thread id. */
284 void (*deprecated_context_hook
) (int id
);
286 /* Handler for SIGHUP. */
289 /* NOTE 1999-04-29: This function will be static again, once we modify
290 gdb to use the event loop as the default command loop and we merge
291 event-top.c into this file, top.c. */
295 /* Stop asking user for confirmation --- we're exiting. This
296 prevents asking the user dumb questions. */
298 quit_command ((char *) 0, 0);
300 #endif /* defined SIGHUP */
302 /* Line number we are currently in, in a file which is being sourced. */
303 /* NOTE 1999-04-29: This variable will be static again, once we modify
304 gdb to use the event loop as the default command loop and we merge
305 event-top.c into this file, top.c. */
306 /* static */ int source_line_number
;
308 /* Name of the file we are sourcing. */
309 /* NOTE 1999-04-29: This variable will be static again, once we modify
310 gdb to use the event loop as the default command loop and we merge
311 event-top.c into this file, top.c. */
312 /* static */ const char *source_file_name
;
314 /* Clean up on error during a "source" command (or execution of a
315 user-defined command). */
318 do_restore_instream_cleanup (void *stream
)
320 /* Restore the previous input stream. */
324 /* Read commands from STREAM. */
326 read_command_file (FILE *stream
)
328 struct cleanup
*cleanups
;
330 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
333 do_cleanups (cleanups
);
336 void (*pre_init_ui_hook
) (void);
340 do_chdir_cleanup (void *old_dir
)
348 prepare_execute_command (void)
351 struct cleanup
*cleanup
;
353 mark
= value_mark ();
354 cleanup
= make_cleanup_value_free_to_mark (mark
);
356 /* With multiple threads running while the one we're examining is
357 stopped, the dcache can get stale without us being able to detect
358 it. For the duration of the command, though, use the dcache to
359 help things like backtrace. */
361 target_dcache_invalidate ();
366 /* Tell the user if the language has changed (except first time) after
367 executing a command. */
370 check_frame_language_change (void)
372 static int warned
= 0;
374 /* First make sure that a new frame has been selected, in case the
375 command or the hooks changed the program state. */
376 deprecated_safe_get_selected_frame ();
377 if (current_language
!= expected_language
)
379 if (language_mode
== language_mode_auto
&& info_verbose
)
381 language_info (1); /* Print what changed. */
386 /* Warn the user if the working language does not match the language
387 of the current frame. Only warn the user if we are actually
388 running the program, i.e. there is a stack. */
389 /* FIXME: This should be cacheing the frame and only running when
390 the frame changes. */
392 if (has_stack_frames ())
396 flang
= get_frame_language ();
398 && flang
!= language_unknown
399 && flang
!= current_language
->la_language
)
401 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
407 /* Execute the line P as a command, in the current user context.
408 Pass FROM_TTY as second argument to the defining function. */
411 execute_command (char *p
, int from_tty
)
413 struct cleanup
*cleanup_if_error
, *cleanup
;
414 struct cmd_list_element
*c
;
417 cleanup_if_error
= make_bpstat_clear_actions_cleanup ();
418 cleanup
= prepare_execute_command ();
420 /* Force cleanup of any alloca areas if using C alloca instead of
424 /* This can happen when command_line_input hits end of file. */
427 do_cleanups (cleanup
);
431 target_log_command (p
);
433 while (*p
== ' ' || *p
== '\t')
440 /* If trace-commands is set then this will print this command. */
441 print_command_trace (p
);
443 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
445 /* Pass null arg rather than an empty one. */
448 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
449 while the is_complete_command(cfunc) test is just plain
450 bogus. They should both be replaced by a test of the form
451 c->strip_trailing_white_space_p. */
452 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
453 can't be replaced with func. This is because it is the
454 cfunc, and not the func, that has the value that the
455 is_complete_command hack is testing for. */
456 /* Clear off trailing whitespace, except for set and complete
459 && c
->type
!= set_cmd
460 && !is_complete_command (c
))
462 p
= arg
+ strlen (arg
) - 1;
463 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
468 /* If this command has been pre-hooked, run the hook first. */
469 execute_cmd_pre_hook (c
);
471 if (c
->flags
& DEPRECATED_WARN_USER
)
472 deprecated_cmd_warning (&line
);
474 /* c->user_commands would be NULL in the case of a python command. */
475 if (c
->class == class_user
&& c
->user_commands
)
476 execute_user_command (c
, arg
);
477 else if (c
->type
== set_cmd
)
478 do_set_command (arg
, from_tty
, c
);
479 else if (c
->type
== show_cmd
)
480 do_show_command (arg
, from_tty
, c
);
481 else if (!cmd_func_p (c
))
482 error (_("That is not a command, just a help topic."));
483 else if (deprecated_call_command_hook
)
484 deprecated_call_command_hook (c
, arg
, from_tty
);
486 cmd_func (c
, arg
, from_tty
);
488 /* If the interpreter is in sync mode (we're running a user
489 command's list, running command hooks or similars), and we
490 just ran a synchronous command that started the target, wait
491 for that command to end. */
492 if (!interpreter_async
&& sync_execution
)
494 while (gdb_do_one_event () >= 0)
499 /* If this command has been post-hooked, run the hook last. */
500 execute_cmd_post_hook (c
);
504 check_frame_language_change ();
506 do_cleanups (cleanup
);
507 discard_cleanups (cleanup_if_error
);
510 /* Run execute_command for P and FROM_TTY. Capture its output into the
511 returned string, do not display it to the screen. BATCH_FLAG will be
512 temporarily set to true. */
515 execute_command_to_string (char *p
, int from_tty
)
517 struct ui_file
*str_file
;
518 struct cleanup
*cleanup
;
521 /* GDB_STDOUT should be better already restored during these
522 restoration callbacks. */
523 cleanup
= set_batch_flag_and_make_cleanup_restore_page_info ();
525 make_cleanup_restore_integer (&interpreter_async
);
526 interpreter_async
= 0;
528 str_file
= mem_fileopen ();
530 make_cleanup_ui_file_delete (str_file
);
531 make_cleanup_restore_ui_file (&gdb_stdout
);
532 make_cleanup_restore_ui_file (&gdb_stderr
);
533 make_cleanup_restore_ui_file (&gdb_stdlog
);
534 make_cleanup_restore_ui_file (&gdb_stdtarg
);
535 make_cleanup_restore_ui_file (&gdb_stdtargerr
);
537 if (ui_out_redirect (current_uiout
, str_file
) < 0)
538 warning (_("Current output protocol does not support redirection"));
540 make_cleanup_ui_out_redirect_pop (current_uiout
);
542 gdb_stdout
= str_file
;
543 gdb_stderr
= str_file
;
544 gdb_stdlog
= str_file
;
545 gdb_stdtarg
= str_file
;
546 gdb_stdtargerr
= str_file
;
548 execute_command (p
, from_tty
);
550 retval
= ui_file_xstrdup (str_file
, NULL
);
552 do_cleanups (cleanup
);
557 /* Read commands from `instream' and execute them
558 until end of file or error reading instream. */
563 struct cleanup
*old_chain
;
565 int stdin_is_tty
= ISATTY (stdin
);
567 while (instream
&& !feof (instream
))
569 if (window_hook
&& instream
== stdin
)
570 (*window_hook
) (instream
, get_prompt ());
573 if (instream
== stdin
&& stdin_is_tty
)
574 reinitialize_more_filter ();
575 old_chain
= make_cleanup (null_cleanup
, 0);
577 /* Get a command-line. This calls the readline package. */
578 command
= command_line_input (instream
== stdin
?
579 get_prompt () : (char *) NULL
,
580 instream
== stdin
, "prompt");
583 do_cleanups (old_chain
);
587 make_command_stats_cleanup (1);
589 execute_command (command
, instream
== stdin
);
591 /* Do any commands attached to breakpoint we are stopped at. */
592 bpstat_do_actions ();
594 do_cleanups (old_chain
);
598 /* When nonzero, cause dont_repeat to do nothing. This should only be
599 set via prevent_dont_repeat. */
601 static int suppress_dont_repeat
= 0;
603 /* Commands call this if they do not want to be repeated by null lines. */
608 if (suppress_dont_repeat
|| server_command
)
611 /* If we aren't reading from standard input, we are saving the last
612 thing read from stdin in line and don't want to delete it. Null
613 lines won't repeat here in any case. */
614 if (instream
== stdin
)
615 *saved_command_line
= 0;
618 /* Prevent dont_repeat from working, and return a cleanup that
619 restores the previous state. */
622 prevent_dont_repeat (void)
624 struct cleanup
*result
= make_cleanup_restore_integer (&suppress_dont_repeat
);
626 suppress_dont_repeat
= 1;
631 /* Read a line from the stream "instream" without command line editing.
633 It prints PROMPT_ARG once at the start.
634 Action is compatible with "readline", e.g. space for the result is
635 malloc'd and should be freed by the caller.
637 A NULL return means end of file. */
639 gdb_readline (char *prompt_arg
)
644 int result_size
= 80;
648 /* Don't use a _filtered function here. It causes the assumed
649 character position to be off, since the newline we read from
650 the user is not accounted for. */
651 fputs_unfiltered (prompt_arg
, gdb_stdout
);
652 gdb_flush (gdb_stdout
);
655 result
= (char *) xmalloc (result_size
);
659 /* Read from stdin if we are executing a user defined command.
660 This is the right thing for prompt_for_continue, at least. */
661 c
= fgetc (instream
? instream
: stdin
);
666 /* The last line does not end with a newline. Return it, and
667 if we are called again fgetc will still return EOF and
668 we'll return NULL then. */
676 if (input_index
> 0 && result
[input_index
- 1] == '\r')
681 result
[input_index
++] = c
;
682 while (input_index
>= result_size
)
685 result
= (char *) xrealloc (result
, result_size
);
689 result
[input_index
++] = '\0';
693 /* Variables which control command line editing and history
694 substitution. These variables are given default values at the end
696 static int command_editing_p
;
698 /* NOTE 1999-04-29: This variable will be static again, once we modify
699 gdb to use the event loop as the default command loop and we merge
700 event-top.c into this file, top.c. */
702 /* static */ int history_expansion_p
;
704 static int write_history_p
;
706 show_write_history_p (struct ui_file
*file
, int from_tty
,
707 struct cmd_list_element
*c
, const char *value
)
709 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
713 static unsigned int history_size
;
715 show_history_size (struct ui_file
*file
, int from_tty
,
716 struct cmd_list_element
*c
, const char *value
)
718 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
722 static char *history_filename
;
724 show_history_filename (struct ui_file
*file
, int from_tty
,
725 struct cmd_list_element
*c
, const char *value
)
727 fprintf_filtered (file
, _("The filename in which to record "
728 "the command history is \"%s\".\n"),
732 /* This is like readline(), but it has some gdb-specific behavior.
733 gdb may want readline in both the synchronous and async modes during
734 a single gdb invocation. At the ordinary top-level prompt we might
735 be using the async readline. That means we can't use
736 rl_pre_input_hook, since it doesn't work properly in async mode.
737 However, for a secondary prompt (" >", such as occurs during a
738 `define'), gdb wants a synchronous response.
740 We used to call readline() directly, running it in synchronous
741 mode. But mixing modes this way is not supported, and as of
742 readline 5.x it no longer works; the arrow keys come unbound during
743 the synchronous call. So we make a nested call into the event
744 loop. That's what gdb_readline_wrapper is for. */
746 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
747 rely on gdb_readline_wrapper_result, which might still be NULL if
748 the user types Control-D for EOF. */
749 static int gdb_readline_wrapper_done
;
751 /* The result of the current call to gdb_readline_wrapper, once a newline
753 static char *gdb_readline_wrapper_result
;
755 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
756 to be called after the newline is processed (which will redisplay
757 the prompt). But in gdb_readline_wrapper we will not get a new
758 prompt until the next call, or until we return to the event loop.
759 So we disable this hook around the newline and restore it before we
761 static void (*saved_after_char_processing_hook
) (void);
763 /* This function is called when readline has seen a complete line of
767 gdb_readline_wrapper_line (char *line
)
769 gdb_assert (!gdb_readline_wrapper_done
);
770 gdb_readline_wrapper_result
= line
;
771 gdb_readline_wrapper_done
= 1;
773 /* Prevent operate-and-get-next from acting too early. */
774 saved_after_char_processing_hook
= after_char_processing_hook
;
775 after_char_processing_hook
= NULL
;
777 /* Prevent parts of the prompt from being redisplayed if annotations
778 are enabled, and readline's state getting out of sync. */
779 if (async_command_editing_p
)
780 rl_callback_handler_remove ();
783 struct gdb_readline_wrapper_cleanup
785 void (*handler_orig
) (char *);
786 int already_prompted_orig
;
790 gdb_readline_wrapper_cleanup (void *arg
)
792 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
794 rl_already_prompted
= cleanup
->already_prompted_orig
;
796 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
797 input_handler
= cleanup
->handler_orig
;
798 gdb_readline_wrapper_result
= NULL
;
799 gdb_readline_wrapper_done
= 0;
801 after_char_processing_hook
= saved_after_char_processing_hook
;
802 saved_after_char_processing_hook
= NULL
;
808 gdb_readline_wrapper (char *prompt
)
810 struct cleanup
*back_to
;
811 struct gdb_readline_wrapper_cleanup
*cleanup
;
814 cleanup
= xmalloc (sizeof (*cleanup
));
815 cleanup
->handler_orig
= input_handler
;
816 input_handler
= gdb_readline_wrapper_line
;
818 cleanup
->already_prompted_orig
= rl_already_prompted
;
820 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
822 /* Display our prompt and prevent double prompt display. */
823 display_gdb_prompt (prompt
);
824 rl_already_prompted
= 1;
826 if (after_char_processing_hook
)
827 (*after_char_processing_hook
) ();
828 gdb_assert (after_char_processing_hook
== NULL
);
830 while (gdb_do_one_event () >= 0)
831 if (gdb_readline_wrapper_done
)
834 retval
= gdb_readline_wrapper_result
;
835 do_cleanups (back_to
);
840 /* The current saved history number from operate-and-get-next.
841 This is -1 if not valid. */
842 static int operate_saved_history
= -1;
844 /* This is put on the appropriate hook and helps operate-and-get-next
847 gdb_rl_operate_and_get_next_completion (void)
849 int delta
= where_history () - operate_saved_history
;
851 /* The `key' argument to rl_get_previous_history is ignored. */
852 rl_get_previous_history (delta
, 0);
853 operate_saved_history
= -1;
855 /* readline doesn't automatically update the display for us. */
858 after_char_processing_hook
= NULL
;
859 rl_pre_input_hook
= NULL
;
862 /* This is a gdb-local readline command handler. It accepts the
863 current command line (like RET does) and, if this command was taken
864 from the history, arranges for the next command in the history to
865 appear on the command line when the prompt returns.
866 We ignore the arguments. */
868 gdb_rl_operate_and_get_next (int count
, int key
)
872 /* Use the async hook. */
873 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
875 /* Find the current line, and find the next line to use. */
876 where
= where_history();
878 /* FIXME: kettenis/20020817: max_input_history is renamed into
879 history_max_entries in readline-4.2. When we do a new readline
880 import, we should probably change it here too, even though
881 readline maintains backwards compatibility for now by still
882 defining max_input_history. */
883 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
884 (where
>= history_length
- 1))
885 operate_saved_history
= where
;
887 operate_saved_history
= where
+ 1;
889 return rl_newline (1, key
);
892 /* Read one line from the command input stream `instream'
893 into the local static buffer `linebuffer' (whose current length
895 The buffer is made bigger as necessary.
896 Returns the address of the start of the line.
898 NULL is returned for end of file.
900 *If* the instream == stdin & stdin is a terminal, the line read
901 is copied into the file line saver (global var char *line,
902 length linesize) so that it can be duplicated.
904 This routine either uses fancy command line editing or
905 simple input as the user has requested. */
908 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
910 static char *linebuffer
= 0;
911 static unsigned linelength
= 0;
915 char *local_prompt
= prompt_arg
;
919 /* The annotation suffix must be non-NULL. */
920 if (annotation_suffix
== NULL
)
921 annotation_suffix
= "";
923 if (annotation_level
> 1 && instream
== stdin
)
925 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
926 + strlen (annotation_suffix
) + 40);
927 if (prompt_arg
== NULL
)
928 local_prompt
[0] = '\0';
930 strcpy (local_prompt
, prompt_arg
);
931 strcat (local_prompt
, "\n\032\032");
932 strcat (local_prompt
, annotation_suffix
);
933 strcat (local_prompt
, "\n");
939 linebuffer
= (char *) xmalloc (linelength
);
944 /* Control-C quits instantly if typed while in this loop
945 since it should not wait until the user types a newline. */
950 signal (STOP_SIGNAL
, handle_stop_sig
);
955 /* Make sure that all output has been output. Some machines may
956 let you get away with leaving out some of the gdb_flush, but
959 gdb_flush (gdb_stdout
);
960 gdb_flush (gdb_stderr
);
962 if (source_file_name
!= NULL
)
963 ++source_line_number
;
965 if (annotation_level
> 1 && instream
== stdin
)
967 puts_unfiltered ("\n\032\032pre-");
968 puts_unfiltered (annotation_suffix
);
969 puts_unfiltered ("\n");
972 /* Don't use fancy stuff if not talking to stdin. */
973 if (deprecated_readline_hook
&& input_from_terminal_p ())
975 rl
= (*deprecated_readline_hook
) (local_prompt
);
977 else if (command_editing_p
&& input_from_terminal_p ())
979 rl
= gdb_readline_wrapper (local_prompt
);
983 rl
= gdb_readline (local_prompt
);
986 if (annotation_level
> 1 && instream
== stdin
)
988 puts_unfiltered ("\n\032\032post-");
989 puts_unfiltered (annotation_suffix
);
990 puts_unfiltered ("\n");
993 if (!rl
|| rl
== (char *) EOF
)
998 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
1000 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
1001 nline
= (char *) xrealloc (linebuffer
, linelength
);
1002 p
+= nline
- linebuffer
;
1006 /* Copy line. Don't copy null at end. (Leaves line alone
1007 if this was just a newline). */
1011 xfree (rl
); /* Allocated in readline. */
1013 if (p
== linebuffer
|| *(p
- 1) != '\\')
1016 p
--; /* Put on top of '\'. */
1017 local_prompt
= (char *) 0;
1022 signal (STOP_SIGNAL
, SIG_DFL
);
1029 #define SERVER_COMMAND_LENGTH 7
1031 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1032 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1035 /* Note that we don't set `line'. Between this and the check in
1036 dont_repeat, this insures that repeating will still do the
1039 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1042 /* Do history expansion if that is wished. */
1043 if (history_expansion_p
&& instream
== stdin
1044 && ISATTY (instream
))
1046 char *history_value
;
1049 *p
= '\0'; /* Insert null now. */
1050 expanded
= history_expand (linebuffer
, &history_value
);
1053 /* Print the changes. */
1054 printf_unfiltered ("%s\n", history_value
);
1056 /* If there was an error, call this function again. */
1059 xfree (history_value
);
1060 return command_line_input (prompt_arg
, repeat
,
1063 if (strlen (history_value
) > linelength
)
1065 linelength
= strlen (history_value
) + 1;
1066 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1068 strcpy (linebuffer
, history_value
);
1069 p
= linebuffer
+ strlen (linebuffer
);
1071 xfree (history_value
);
1074 /* If we just got an empty line, and that is supposed to repeat the
1075 previous command, return the value in the global buffer. */
1076 if (repeat
&& p
== linebuffer
)
1077 return saved_command_line
;
1078 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1080 return saved_command_line
;
1084 /* Add line to history if appropriate. */
1085 if (instream
== stdin
1086 && ISATTY (stdin
) && *linebuffer
)
1087 add_history (linebuffer
);
1089 /* Note: lines consisting solely of comments are added to the command
1090 history. This is useful when you type a command, and then
1091 realize you don't want to execute it quite yet. You can comment
1092 out the command and then later fetch it from the value history
1093 and remove the '#'. The kill ring is probably better, but some
1094 people are in the habit of commenting things out. */
1096 *p1
= '\0'; /* Found a comment. */
1098 /* Save into global buffer if appropriate. */
1101 if (linelength
> saved_command_line_size
)
1103 saved_command_line
= xrealloc (saved_command_line
, linelength
);
1104 saved_command_line_size
= linelength
;
1106 strcpy (saved_command_line
, linebuffer
);
1107 return saved_command_line
;
1113 /* Print the GDB banner. */
1115 print_gdb_version (struct ui_file
*stream
)
1117 /* From GNU coding standards, first line is meant to be easy for a
1118 program to parse, and is just canonical program name and version
1119 number, which starts after last space. */
1121 fprintf_filtered (stream
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1123 /* Second line is a copyright notice. */
1125 fprintf_filtered (stream
,
1126 "Copyright (C) 2012 Free Software Foundation, Inc.\n");
1128 /* Following the copyright is a brief statement that the program is
1129 free software, that users are free to copy and change it on
1130 certain conditions, that it is covered by the GNU GPL, and that
1131 there is no warranty. */
1133 fprintf_filtered (stream
, "\
1134 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1135 \nThis is free software: you are free to change and redistribute it.\n\
1136 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1137 and \"show warranty\" for details.\n");
1139 /* After the required info we print the configuration information. */
1141 fprintf_filtered (stream
, "This GDB was configured as \"");
1142 if (strcmp (host_name
, target_name
) != 0)
1144 fprintf_filtered (stream
, "--host=%s --target=%s",
1145 host_name
, target_name
);
1149 fprintf_filtered (stream
, "%s", host_name
);
1151 fprintf_filtered (stream
, "\".");
1153 if (REPORT_BUGS_TO
[0])
1155 fprintf_filtered (stream
,
1156 _("\nFor bug reporting instructions, please see:\n"));
1157 fprintf_filtered (stream
, "%s.", REPORT_BUGS_TO
);
1162 /* The current top level prompt, settable with "set prompt", and/or
1163 with the python `gdb.prompt_hook' hook. */
1164 static char *top_prompt
;
1166 /* Access method for the GDB prompt string. */
1174 /* Set method for the GDB prompt string. */
1177 set_prompt (const char *s
)
1179 char *p
= xstrdup (s
);
1192 /* Callback for iterate_over_inferiors. Kills or detaches the given
1193 inferior, depending on how we originally gained control of it. */
1196 kill_or_detach (struct inferior
*inf
, void *args
)
1198 struct qt_args
*qt
= args
;
1199 struct thread_info
*thread
;
1204 thread
= any_thread_of_process (inf
->pid
);
1207 switch_to_thread (thread
->ptid
);
1209 /* Leave core files alone. */
1210 if (target_has_execution
)
1212 if (inf
->attach_flag
)
1213 target_detach (qt
->args
, qt
->from_tty
);
1222 /* Callback for iterate_over_inferiors. Prints info about what GDB
1223 will do to each inferior on a "quit". ARG points to a struct
1224 ui_out where output is to be collected. */
1227 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1229 struct ui_file
*stb
= arg
;
1234 if (inf
->attach_flag
)
1235 fprintf_filtered (stb
,
1236 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1237 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1239 fprintf_filtered (stb
,
1240 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1241 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1246 /* If necessary, make the user confirm that we should quit. Return
1247 non-zero if we should quit, zero if we shouldn't. */
1252 struct ui_file
*stb
;
1253 struct cleanup
*old_chain
;
1257 /* Don't even ask if we're only debugging a core file inferior. */
1258 if (!have_live_inferiors ())
1261 /* Build the query string as a single string. */
1262 stb
= mem_fileopen ();
1263 old_chain
= make_cleanup_ui_file_delete (stb
);
1265 /* This is something of a hack. But there's no reliable way to see
1266 if a GUI is running. The `use_windows' variable doesn't cut
1268 if (deprecated_init_ui_hook
)
1269 fprintf_filtered (stb
, _("A debugging session is active.\n"
1270 "Do you still want to close the debugger?"));
1273 fprintf_filtered (stb
, _("A debugging session is active.\n\n"));
1274 iterate_over_inferiors (print_inferior_quit_action
, stb
);
1275 fprintf_filtered (stb
, _("\nQuit anyway? "));
1278 str
= ui_file_xstrdup (stb
, NULL
);
1279 make_cleanup (xfree
, str
);
1281 qr
= query ("%s", str
);
1282 do_cleanups (old_chain
);
1286 /* Helper routine for quit_force that requires error handling. */
1289 quit_target (void *arg
)
1291 struct qt_args
*qt
= (struct qt_args
*)arg
;
1293 /* Kill or detach all inferiors. */
1294 iterate_over_inferiors (kill_or_detach
, qt
);
1296 /* Give all pushed targets a chance to do minimal cleanup, and pop
1298 pop_all_targets (1);
1300 /* Save the history information if it is appropriate to do so. */
1301 if (write_history_p
&& history_filename
)
1302 write_history (history_filename
);
1304 do_final_cleanups (all_cleanups ()); /* Do any final cleanups before
1309 /* Quit without asking for confirmation. */
1312 quit_force (char *args
, int from_tty
)
1317 /* An optional expression may be used to cause gdb to terminate with the
1318 value of that expression. */
1321 struct value
*val
= parse_and_eval (args
);
1323 exit_code
= (int) value_as_long (val
);
1325 else if (return_child_result
)
1326 exit_code
= return_child_result_value
;
1329 qt
.from_tty
= from_tty
;
1331 /* We want to handle any quit errors and exit regardless. */
1332 catch_errors (quit_target
, &qt
,
1333 "Quitting: ", RETURN_MASK_ALL
);
1338 /* Returns whether GDB is running on a terminal and input is
1339 currently coming from that terminal. */
1342 input_from_terminal_p (void)
1347 if (gdb_has_a_terminal () && instream
== stdin
)
1350 /* If INSTREAM is unset, and we are not in a user command, we
1351 must be in Insight. That's like having a terminal, for our
1353 if (instream
== NULL
&& !in_user_command
)
1360 dont_repeat_command (char *ignored
, int from_tty
)
1362 /* Can't call dont_repeat here because we're not necessarily reading
1364 *saved_command_line
= 0;
1367 /* Functions to manipulate command line editing control variables. */
1369 /* Number of commands to print in each call to show_commands. */
1370 #define Hist_print 10
1372 show_commands (char *args
, int from_tty
)
1374 /* Index for history commands. Relative to history_base. */
1377 /* Number of the history entry which we are planning to display next.
1378 Relative to history_base. */
1381 /* The first command in the history which doesn't exist (i.e. one more
1382 than the number of the last command). Relative to history_base. */
1383 unsigned int hist_len
;
1385 /* Print out some of the commands from the command history. */
1386 /* First determine the length of the history list. */
1387 hist_len
= history_size
;
1388 for (offset
= 0; offset
< history_size
; offset
++)
1390 if (!history_get (history_base
+ offset
))
1399 if (args
[0] == '+' && args
[1] == '\0')
1400 /* "info editing +" should print from the stored position. */
1403 /* "info editing <exp>" should print around command number <exp>. */
1404 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1406 /* "show commands" means print the last Hist_print commands. */
1409 num
= hist_len
- Hist_print
;
1415 /* If there are at least Hist_print commands, we want to display the last
1416 Hist_print rather than, say, the last 6. */
1417 if (hist_len
- num
< Hist_print
)
1419 num
= hist_len
- Hist_print
;
1424 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1426 printf_filtered ("%5d %s\n", history_base
+ offset
,
1427 (history_get (history_base
+ offset
))->line
);
1430 /* The next command we want to display is the next one that we haven't
1434 /* If the user repeats this command with return, it should do what
1435 "show commands +" does. This is unnecessary if arg is null,
1436 because "show commands +" is not useful after "show commands". */
1437 if (from_tty
&& args
)
1444 /* Called by do_setshow_command. */
1446 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1448 /* The type of parameter in stifle_history is int, so values from INT_MAX up
1449 mean 'unlimited'. */
1450 if (history_size
>= INT_MAX
)
1452 /* Ensure that 'show history size' prints 'unlimited'. */
1453 history_size
= UINT_MAX
;
1454 unstifle_history ();
1457 stifle_history (history_size
);
1461 set_history (char *args
, int from_tty
)
1463 printf_unfiltered (_("\"set history\" must be followed "
1464 "by the name of a history subcommand.\n"));
1465 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1469 show_history (char *args
, int from_tty
)
1471 cmd_show_list (showhistlist
, from_tty
, "");
1474 int info_verbose
= 0; /* Default verbose msgs off. */
1476 /* Called by do_setshow_command. An elaborate joke. */
1478 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1480 char *cmdname
= "verbose";
1481 struct cmd_list_element
*showcmd
;
1483 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1484 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1488 c
->doc
= "Set verbose printing of informational messages.";
1489 showcmd
->doc
= "Show verbose printing of informational messages.";
1493 c
->doc
= "Set verbosity.";
1494 showcmd
->doc
= "Show verbosity.";
1498 /* Init the history buffer. Note that we are called after the init file(s)
1499 have been read so that the user can change the history file via his
1500 .gdbinit file (for instance). The GDBHISTFILE environment variable
1501 overrides all of this. */
1508 tmpenv
= getenv ("HISTSIZE");
1510 history_size
= atoi (tmpenv
);
1511 else if (!history_size
)
1514 stifle_history (history_size
);
1516 tmpenv
= getenv ("GDBHISTFILE");
1518 history_filename
= xstrdup (tmpenv
);
1519 else if (!history_filename
)
1521 /* We include the current directory so that if the user changes
1522 directories the file written will be the same as the one
1525 /* No leading dots in file names are allowed on MSDOS. */
1526 history_filename
= concat (current_directory
, "/_gdb_history",
1529 history_filename
= concat (current_directory
, "/.gdb_history",
1533 read_history (history_filename
);
1537 show_prompt (struct ui_file
*file
, int from_tty
,
1538 struct cmd_list_element
*c
, const char *value
)
1540 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1544 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1545 struct cmd_list_element
*c
, const char *value
)
1547 fprintf_filtered (file
, _("Editing of command lines as "
1548 "they are typed is %s.\n"),
1553 show_annotation_level (struct ui_file
*file
, int from_tty
,
1554 struct cmd_list_element
*c
, const char *value
)
1556 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1560 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1561 struct cmd_list_element
*c
, const char *value
)
1563 fprintf_filtered (file
, _("Notification of completion for "
1564 "asynchronous execution commands is %s.\n"),
1568 /* "set" command for the gdb_datadir configuration variable. */
1571 set_gdb_datadir (char *args
, int from_tty
, struct cmd_list_element
*c
)
1573 observer_notify_gdb_datadir_changed ();
1579 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1580 the DEFAULT_PROMPT is. */
1581 set_prompt (DEFAULT_PROMPT
);
1583 /* Set things up for annotation_level > 1, if the user ever decides
1585 async_annotation_suffix
= "prompt";
1587 /* Set the important stuff up for command editing. */
1588 command_editing_p
= 1;
1589 history_expansion_p
= 0;
1590 write_history_p
= 0;
1592 /* Setup important stuff for command line editing. */
1593 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
1594 rl_completion_entry_function
= readline_line_completion_function
;
1595 rl_completer_word_break_characters
= default_word_break_characters ();
1596 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1597 rl_readline_name
= "gdb";
1598 rl_terminal_name
= getenv ("TERM");
1600 /* The name for this defun comes from Bash, where it originated.
1601 15 is Control-o, the same binding this function has in Bash. */
1602 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1604 add_setshow_string_cmd ("prompt", class_support
,
1606 _("Set gdb's prompt"),
1607 _("Show gdb's prompt"),
1610 &setlist
, &showlist
);
1612 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1613 Don't repeat this command.\nPrimarily \
1614 used inside of user-defined commands that should not be repeated when\n\
1617 add_setshow_boolean_cmd ("editing", class_support
,
1618 &async_command_editing_p
, _("\
1619 Set editing of command lines as they are typed."), _("\
1620 Show editing of command lines as they are typed."), _("\
1621 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1622 Without an argument, command line editing is enabled. To edit, use\n\
1623 EMACS-like or VI-like commands like control-P or ESC."),
1624 set_async_editing_command
,
1625 show_async_command_editing_p
,
1626 &setlist
, &showlist
);
1628 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1629 Set saving of the history record on exit."), _("\
1630 Show saving of the history record on exit."), _("\
1631 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1632 Without an argument, saving is enabled."),
1634 show_write_history_p
,
1635 &sethistlist
, &showhistlist
);
1637 add_setshow_uinteger_cmd ("size", no_class
, &history_size
, _("\
1638 Set the size of the command history,"), _("\
1639 Show the size of the command history,"), _("\
1640 ie. the number of previous commands to keep a record of."),
1641 set_history_size_command
,
1643 &sethistlist
, &showhistlist
);
1645 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1646 Set the filename in which to record the command history"), _("\
1647 Show the filename in which to record the command history"), _("\
1648 (the list of previous commands of which a record is kept)."),
1650 show_history_filename
,
1651 &sethistlist
, &showhistlist
);
1653 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
1654 Set whether to confirm potentially dangerous operations."), _("\
1655 Show whether to confirm potentially dangerous operations."), NULL
,
1658 &setlist
, &showlist
);
1660 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1661 Set annotation_level."), _("\
1662 Show annotation_level."), _("\
1663 0 == normal; 1 == fullname (for use when running under emacs)\n\
1664 2 == output annotated suitably for use by programs that control GDB."),
1666 show_annotation_level
,
1667 &setlist
, &showlist
);
1669 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1670 &exec_done_display_p
, _("\
1671 Set notification of completion for asynchronous execution commands."), _("\
1672 Show notification of completion for asynchronous execution commands."), _("\
1673 Use \"on\" to enable the notification, and \"off\" to disable it."),
1675 show_exec_done_display_p
,
1676 &setlist
, &showlist
);
1678 add_setshow_filename_cmd ("data-directory", class_maintenance
,
1679 &gdb_datadir
, _("Set GDB's data directory."),
1680 _("Show GDB's data directory."),
1682 When set, GDB uses the specified path to search for data files."),
1683 set_gdb_datadir
, NULL
,
1689 gdb_init (char *argv0
)
1691 if (pre_init_ui_hook
)
1692 pre_init_ui_hook ();
1694 /* Run the init function of each source file. */
1697 /* Make sure we return to the original directory upon exit, come
1698 what may, since the OS doesn't do that for us. */
1699 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1702 init_cmd_lists (); /* This needs to be done first. */
1703 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1704 initialize_utils (); /* Make errors and warnings possible. */
1706 /* Here is where we call all the _initialize_foo routines. */
1707 initialize_all_files ();
1709 /* This creates the current_program_space. Do this after all the
1710 _initialize_foo routines have had a chance to install their
1711 per-sspace data keys. Also do this before
1712 initialize_current_architecture is called, because it accesses
1713 exec_bfd of the current program space. */
1714 initialize_progspace ();
1715 initialize_inferiors ();
1716 initialize_current_architecture ();
1718 init_main (); /* But that omits this file! Do it now. */
1720 initialize_stdin_serial ();
1722 async_init_signals ();
1724 /* We need a default language for parsing expressions, so simple
1725 things like "set width 0" won't fail if no language is explicitly
1726 set in a config file or implicitly set by reading an executable
1728 set_language (language_c
);
1729 expected_language
= current_language
; /* Don't warn about the change. */
1731 /* Allow another UI to initialize. If the UI fails to initialize,
1732 and it wants GDB to revert to the CLI, it should clear
1733 deprecated_init_ui_hook. */
1734 if (deprecated_init_ui_hook
)
1735 deprecated_init_ui_hook (argv0
);
1738 /* Python initialization can require various commands to be
1739 installed. For example "info pretty-printer" needs the "info"
1740 prefix to be installed. Keep things simple and just do final
1741 python initialization here. */
1742 finish_python_initialization ();