1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2021 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 "cli/cli-cmds.h"
23 #include "cli/cli-script.h"
24 #include "cli/cli-setshow.h"
25 #include "cli/cli-decode.h"
31 #include "target-dcache.h"
32 #include "breakpoint.h"
34 #include "expression.h"
38 #include "gdbsupport/job-control.h"
40 #include "completer.h"
42 #include "gdbsupport/version.h"
45 #include "gdbsupport/event-loop.h"
46 #include "gdbthread.h"
47 #include "extension.h"
49 #include "observable.h"
51 #include "filenames.h"
53 #include "gdbsupport/buffer.h"
54 #include "gdbsupport/gdb_select.h"
55 #include "gdbsupport/scope-exit.h"
57 #include "gdbsupport/pathstuff.h"
58 #include "cli/cli-style.h"
60 /* readline include files. */
61 #include "readline/readline.h"
62 #include "readline/history.h"
64 /* readline defines this. */
67 #include <sys/types.h>
69 #include "event-top.h"
74 #include "tracepoint.h"
85 extern void initialize_all_files (void);
87 static bool history_filename_empty (void);
89 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
90 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
91 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
93 /* Default command line prompt. This is overridden in some configs. */
95 #ifndef DEFAULT_PROMPT
96 #define DEFAULT_PROMPT "(gdb) "
100 current_ui_gdb_stdout_ptr ()
102 return ¤t_ui
->m_gdb_stdout
;
106 current_ui_gdb_stdin_ptr ()
108 return ¤t_ui
->m_gdb_stdin
;
112 current_ui_gdb_stderr_ptr ()
114 return ¤t_ui
->m_gdb_stderr
;
118 current_ui_gdb_stdlog_ptr ()
120 return ¤t_ui
->m_gdb_stdlog
;
124 current_ui_current_uiout_ptr ()
126 return ¤t_ui
->m_current_uiout
;
129 int inhibit_gdbinit
= 0;
131 /* Flag for whether we want to confirm potentially dangerous
132 operations. Default is yes. */
137 show_confirm (struct ui_file
*file
, int from_tty
,
138 struct cmd_list_element
*c
, const char *value
)
140 fprintf_filtered (file
, _("Whether to confirm potentially "
141 "dangerous operations is %s.\n"),
145 /* Current working directory. */
147 char *current_directory
;
149 /* The last command line executed on the console. Used for command
150 repetitions when the user enters an empty line. */
152 static char *saved_command_line
;
154 /* If not NULL, the arguments that should be passed if
155 saved_command_line is repeated. */
157 static const char *repeat_arguments
;
159 /* The previous last command line executed on the console. Used for command
160 repetitions when a command wants to relaunch the previously launched
161 command. We need this as when a command is running, saved_command_line
162 already contains the line of the currently executing command. */
164 static char *previous_saved_command_line
;
166 /* If not NULL, the arguments that should be passed if the
167 previous_saved_command_line is repeated. */
169 static const char *previous_repeat_arguments
;
171 /* Nonzero if the current command is modified by "server ". This
172 affects things like recording into the command history, commands
173 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
174 whatever) can issue its own commands and also send along commands
175 from the user, and have the user not notice that the user interface
176 is issuing commands too. */
179 /* Timeout limit for response from target. */
181 /* The default value has been changed many times over the years. It
182 was originally 5 seconds. But that was thought to be a long time
183 to sit and wait, so it was changed to 2 seconds. That was thought
184 to be plenty unless the connection was going through some terminal
185 server or multiplexer or other form of hairy serial connection.
187 In mid-1996, remote_timeout was moved from remote.c to top.c and
188 it began being used in other remote-* targets. It appears that the
189 default was changed to 20 seconds at that time, perhaps because the
190 Renesas E7000 ICE didn't always respond in a timely manner.
192 But if 5 seconds is a long time to sit and wait for retransmissions,
193 20 seconds is far worse. This demonstrates the difficulty of using
194 a single variable for all protocol timeouts.
196 As remote.c is used much more than remote-e7000.c, it was changed
197 back to 2 seconds in 1999. */
199 int remote_timeout
= 2;
201 /* Sbrk location on entry to main. Used for statistics only. */
202 #ifdef HAVE_USEFUL_SBRK
206 /* Hooks for alternate command interfaces. */
208 /* This hook is called from within gdb's many mini-event loops which
209 could steal control from a real user interface's event loop. It
210 returns non-zero if the user is requesting a detach, zero
213 int (*deprecated_ui_loop_hook
) (int);
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
) (const char *, ...);
243 char *(*deprecated_readline_hook
) (const 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 when going to wait for the target. Usually allows the GUI
253 to run while waiting for target events. */
255 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
256 struct target_waitstatus
*status
,
259 /* Used by UI as a wrapper around command execution. May do various
260 things like enabling/disabling buttons, etc... */
262 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
263 const char *cmd
, int from_tty
);
265 /* Called when the current thread changes. Argument is thread id. */
267 void (*deprecated_context_hook
) (int id
);
269 /* The highest UI number ever assigned. */
270 static int highest_ui_num
;
274 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
276 num (++highest_ui_num
),
277 call_readline (nullptr),
278 input_handler (nullptr),
280 interp_info (nullptr),
282 secondary_prompt_depth (0),
283 stdin_stream (instream_
),
284 instream (instream_
),
285 outstream (outstream_
),
286 errstream (errstream_
),
287 input_fd (fileno (instream
)),
288 input_interactive_p (ISATTY (instream
)),
289 prompt_state (PROMPT_NEEDED
),
290 m_gdb_stdout (new stdio_file (outstream
)),
291 m_gdb_stdin (new stdio_file (instream
)),
292 m_gdb_stderr (new stderr_file (errstream
)),
293 m_gdb_stdlog (m_gdb_stderr
),
294 m_current_uiout (nullptr)
296 buffer_init (&line_buffer
);
304 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
312 struct ui
*ui
, *uiprev
;
316 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
320 gdb_assert (ui
!= NULL
);
332 /* Open file named NAME for read/write, making sure not to make it the
333 controlling terminal. */
336 open_terminal_stream (const char *name
)
340 fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
342 perror_with_name (_("opening terminal failed"));
344 return gdb_file_up (fdopen (fd
, "w+"));
347 /* Implementation of the "new-ui" command. */
350 new_ui_command (const char *args
, int from_tty
)
353 const char *interpreter_name
;
354 const char *tty_name
;
358 gdb_argv
argv (args
);
359 argc
= argv
.count ();
362 error (_("Usage: new-ui INTERPRETER TTY"));
364 interpreter_name
= argv
[0];
368 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
370 /* Open specified terminal. Note: we used to open it three times,
371 once for each of stdin/stdout/stderr, but that does not work
372 with Windows named pipes. */
373 gdb_file_up stream
= open_terminal_stream (tty_name
);
375 std::unique_ptr
<ui
> ui
376 (new struct ui (stream
.get (), stream
.get (), stream
.get ()));
380 current_ui
= ui
.get ();
382 set_top_level_interpreter (interpreter_name
);
384 interp_pre_command_loop (top_level_interpreter ());
386 /* Make sure the file is not closed. */
392 printf_unfiltered ("New UI allocated\n");
395 /* Handler for SIGHUP. */
398 /* NOTE 1999-04-29: This function will be static again, once we modify
399 gdb to use the event loop as the default command loop and we merge
400 event-top.c into this file, top.c. */
404 /* Stop asking user for confirmation --- we're exiting. This
405 prevents asking the user dumb questions. */
407 quit_command ((char *) 0, 0);
409 #endif /* defined SIGHUP */
411 /* Line number we are currently in, in a file which is being sourced. */
412 /* NOTE 1999-04-29: This variable will be static again, once we modify
413 gdb to use the event loop as the default command loop and we merge
414 event-top.c into this file, top.c. */
415 /* static */ int source_line_number
;
417 /* Name of the file we are sourcing. */
418 /* NOTE 1999-04-29: This variable will be static again, once we modify
419 gdb to use the event loop as the default command loop and we merge
420 event-top.c into this file, top.c. */
421 /* static */ std::string source_file_name
;
423 /* Read commands from STREAM. */
425 read_command_file (FILE *stream
)
427 struct ui
*ui
= current_ui
;
429 scoped_restore save_instream
430 = make_scoped_restore (&ui
->instream
, stream
);
432 /* Read commands from `instream' and execute them until end of file
433 or error reading instream. */
435 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
439 /* Get a command-line. This calls the readline package. */
440 command
= command_line_input (NULL
, NULL
);
443 command_handler (command
);
449 do_chdir_cleanup (void *old_dir
)
451 chdir ((const char *) old_dir
);
457 prepare_execute_command ()
459 /* With multiple threads running while the one we're examining is
460 stopped, the dcache can get stale without us being able to detect
461 it. For the duration of the command, though, use the dcache to
462 help things like backtrace. */
464 target_dcache_invalidate ();
466 return scoped_value_mark ();
469 /* Tell the user if the language has changed (except first time) after
470 executing a command. */
473 check_frame_language_change (void)
475 static int warned
= 0;
476 struct frame_info
*frame
;
478 /* First make sure that a new frame has been selected, in case the
479 command or the hooks changed the program state. */
480 frame
= deprecated_safe_get_selected_frame ();
481 if (current_language
!= expected_language
)
483 if (language_mode
== language_mode_auto
&& info_verbose
)
485 /* Print what changed. */
491 /* Warn the user if the working language does not match the language
492 of the current frame. Only warn the user if we are actually
493 running the program, i.e. there is a stack. */
494 /* FIXME: This should be cacheing the frame and only running when
495 the frame changes. */
497 if (has_stack_frames ())
501 flang
= get_frame_language (frame
);
503 && flang
!= language_unknown
504 && flang
!= current_language
->la_language
)
506 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
515 wait_sync_command_done (void)
517 /* Processing events may change the current UI. */
518 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
519 struct ui
*ui
= current_ui
;
521 /* We're about to wait until the target stops after having resumed
522 it so must force-commit resumptions, in case we're being called
523 in some context where a scoped_disable_commit_resumed object is
524 active. I.e., this function is a commit-resumed sync/flush
526 scoped_enable_commit_resumed
enable ("sync wait");
528 while (gdb_do_one_event () >= 0)
529 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
536 maybe_wait_sync_command_done (int was_sync
)
538 /* If the interpreter is in sync mode (we're running a user
539 command's list, running command hooks or similars), and we
540 just ran a synchronous command that started the target, wait
541 for that command to end. */
542 if (!current_ui
->async
544 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
545 wait_sync_command_done ();
551 set_repeat_arguments (const char *args
)
553 repeat_arguments
= args
;
556 /* Execute the line P as a command, in the current user context.
557 Pass FROM_TTY as second argument to the defining function. */
560 execute_command (const char *p
, int from_tty
)
562 struct cmd_list_element
*c
;
564 const char *cmd_start
= p
;
566 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
567 scoped_value_mark cleanup
= prepare_execute_command ();
569 /* This can happen when command_line_input hits end of file. */
572 cleanup_if_error
.release ();
576 target_log_command (p
);
578 while (*p
== ' ' || *p
== '\t')
584 std::string default_args
;
585 std::string default_args_and_arg
;
586 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
590 /* If trace-commands is set then this will print this command. */
591 print_command_trace ("%s", p
);
593 c
= lookup_cmd (&cmd
, cmdlist
, "", &default_args
, 0, 1);
596 scoped_restore save_repeat_args
597 = make_scoped_restore (&repeat_arguments
, nullptr);
598 const char *args_pointer
= p
;
600 if (!default_args
.empty ())
603 default_args_and_arg
= default_args
+ ' ' + p
;
605 default_args_and_arg
= default_args
;
606 arg
= default_args_and_arg
.c_str ();
610 /* Pass null arg rather than an empty one. */
611 arg
= *p
== '\0' ? nullptr : p
;
614 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
615 while the is_complete_command(cfunc) test is just plain
616 bogus. They should both be replaced by a test of the form
617 c->strip_trailing_white_space_p. */
618 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
619 can't be replaced with func. This is because it is the
620 cfunc, and not the func, that has the value that the
621 is_complete_command hack is testing for. */
622 /* Clear off trailing whitespace, except for set and complete
624 std::string without_whitespace
;
626 && c
->type
!= set_cmd
627 && !is_complete_command (c
))
629 const char *old_end
= arg
+ strlen (arg
) - 1;
631 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
635 without_whitespace
= std::string (arg
, p
+ 1);
636 arg
= without_whitespace
.c_str ();
640 /* If this command has been pre-hooked, run the hook first. */
641 execute_cmd_pre_hook (c
);
643 if (c
->deprecated_warn_user
)
644 deprecated_cmd_warning (line
, cmdlist
);
646 /* c->user_commands would be NULL in the case of a python command. */
647 if (c
->theclass
== class_user
&& c
->user_commands
)
648 execute_user_command (c
, arg
);
649 else if (c
->theclass
== class_user
650 && c
->is_prefix () && !c
->allow_unknown
)
651 /* If this is a user defined prefix that does not allow unknown
652 (in other words, C is a prefix command and not a command
653 that can be followed by its args), report the list of
656 std::string prefixname
= c
->prefixname ();
657 std::string prefixname_no_space
658 = prefixname
.substr (0, prefixname
.length () - 1);
660 ("\"%s\" must be followed by the name of a subcommand.\n",
661 prefixname_no_space
.c_str ());
662 help_list (*c
->subcommands
, prefixname
.c_str (), all_commands
,
665 else if (c
->type
== set_cmd
)
666 do_set_command (arg
, from_tty
, c
);
667 else if (c
->type
== show_cmd
)
668 do_show_command (arg
, from_tty
, c
);
669 else if (c
->is_command_class_help ())
670 error (_("That is not a command, just a help topic."));
671 else if (deprecated_call_command_hook
)
672 deprecated_call_command_hook (c
, arg
, from_tty
);
674 cmd_func (c
, arg
, from_tty
);
676 maybe_wait_sync_command_done (was_sync
);
678 /* If this command has been post-hooked, run the hook last. */
679 execute_cmd_post_hook (c
);
681 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
683 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
684 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
689 /* Only perform the frame-language-change check if the command
690 we just finished executing did not resume the inferior's execution.
691 If it did resume the inferior, we will do that check after
692 the inferior stopped. */
693 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
694 check_frame_language_change ();
696 cleanup_if_error
.release ();
702 execute_fn_to_ui_file (struct ui_file
*file
, std::function
<void(void)> fn
)
704 /* GDB_STDOUT should be better already restored during these
705 restoration callbacks. */
706 set_batch_flag_and_restore_page_info save_page_info
;
708 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
711 current_uiout
->redirect (file
);
712 ui_out_redirect_pop
redirect_popper (current_uiout
);
714 scoped_restore save_stdout
715 = make_scoped_restore (&gdb_stdout
, file
);
716 scoped_restore save_stderr
717 = make_scoped_restore (&gdb_stderr
, file
);
718 scoped_restore save_stdlog
719 = make_scoped_restore (&gdb_stdlog
, file
);
720 scoped_restore save_stdtarg
721 = make_scoped_restore (&gdb_stdtarg
, file
);
722 scoped_restore save_stdtargerr
723 = make_scoped_restore (&gdb_stdtargerr
, file
);
732 execute_fn_to_string (std::function
<void(void)> fn
, bool term_out
)
734 string_file
str_file (term_out
);
736 execute_fn_to_ui_file (&str_file
, fn
);
737 return std::move (str_file
.string ());
743 execute_command_to_ui_file (struct ui_file
*file
,
744 const char *p
, int from_tty
)
746 execute_fn_to_ui_file (file
, [=]() { execute_command (p
, from_tty
); });
752 execute_command_to_string (const char *p
, int from_tty
,
756 execute_fn_to_string ([=]() { execute_command (p
, from_tty
); }, term_out
);
759 /* When nonzero, cause dont_repeat to do nothing. This should only be
760 set via prevent_dont_repeat. */
762 static int suppress_dont_repeat
= 0;
769 struct ui
*ui
= current_ui
;
771 if (suppress_dont_repeat
|| server_command
)
774 /* If we aren't reading from standard input, we are saving the last
775 thing read from stdin in line and don't want to delete it. Null
776 lines won't repeat here in any case. */
777 if (ui
->instream
== ui
->stdin_stream
)
779 *saved_command_line
= 0;
780 repeat_arguments
= NULL
;
789 /* Do not repeat this command, as this command is a repeating command. */
792 /* We cannot free saved_command_line, as this line is being executed,
793 so swap it with previous_saved_command_line. */
794 std::swap (previous_saved_command_line
, saved_command_line
);
795 std::swap (previous_repeat_arguments
, repeat_arguments
);
797 const char *prev
= skip_spaces (get_saved_command_line ());
799 error (_("No previous command to relaunch"));
805 scoped_restore_tmpl
<int>
806 prevent_dont_repeat (void)
808 return make_scoped_restore (&suppress_dont_repeat
, 1);
814 get_saved_command_line ()
816 return saved_command_line
;
822 save_command_line (const char *cmd
)
824 xfree (previous_saved_command_line
);
825 previous_saved_command_line
= saved_command_line
;
826 previous_repeat_arguments
= repeat_arguments
;
827 saved_command_line
= xstrdup (cmd
);
828 repeat_arguments
= NULL
;
832 /* Read a line from the stream "instream" without command line editing.
834 It prints PROMPT once at the start.
835 Action is compatible with "readline", e.g. space for the result is
836 malloc'd and should be freed by the caller.
838 A NULL return means end of file. */
841 gdb_readline_no_editing (const char *prompt
)
843 struct buffer line_buffer
;
844 struct ui
*ui
= current_ui
;
845 /* Read from stdin if we are executing a user defined command. This
846 is the right thing for prompt_for_continue, at least. */
847 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
848 int fd
= fileno (stream
);
850 buffer_init (&line_buffer
);
854 /* Don't use a _filtered function here. It causes the assumed
855 character position to be off, since the newline we read from
856 the user is not accounted for. */
857 fputs_unfiltered (prompt
, gdb_stdout
);
858 gdb_flush (gdb_stdout
);
868 /* Wait until at least one byte of data is available. Control-C
869 can interrupt interruptible_select, but not fgetc. */
871 FD_SET (fd
, &readfds
);
872 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
876 /* If this was ctrl-c, the QUIT above handles it. */
879 perror_with_name (("select"));
886 if (line_buffer
.used_size
> 0)
887 /* The last line does not end with a newline. Return it, and
888 if we are called again fgetc will still return EOF and
889 we'll return NULL then. */
891 xfree (buffer_finish (&line_buffer
));
897 if (line_buffer
.used_size
> 0
898 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
899 line_buffer
.used_size
--;
903 buffer_grow_char (&line_buffer
, c
);
906 buffer_grow_char (&line_buffer
, '\0');
907 return buffer_finish (&line_buffer
);
910 /* Variables which control command line editing and history
911 substitution. These variables are given default values at the end
913 static bool command_editing_p
;
915 /* NOTE 1999-04-29: This variable will be static again, once we modify
916 gdb to use the event loop as the default command loop and we merge
917 event-top.c into this file, top.c. */
919 /* static */ bool history_expansion_p
;
921 /* Should we write out the command history on exit? In order to write out
922 the history both this flag must be true, and the history_filename
923 variable must be set to something sensible. */
924 static bool write_history_p
;
926 /* Implement 'show history save'. */
928 show_write_history_p (struct ui_file
*file
, int from_tty
,
929 struct cmd_list_element
*c
, const char *value
)
931 if (!write_history_p
|| !history_filename_empty ())
932 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
935 fprintf_filtered (file
, _("Saving of the history is disabled due to "
936 "the value of 'history filename'.\n"));
939 /* The variable associated with the "set/show history size"
940 command. The value -1 means unlimited, and -2 means undefined. */
941 static int history_size_setshow_var
= -2;
944 show_history_size (struct ui_file
*file
, int from_tty
,
945 struct cmd_list_element
*c
, const char *value
)
947 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
951 /* Variable associated with the "history remove-duplicates" option.
952 The value -1 means unlimited. */
953 static int history_remove_duplicates
= 0;
956 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
957 struct cmd_list_element
*c
, const char *value
)
959 fprintf_filtered (file
,
960 _("The number of history entries to look back at for "
961 "duplicates is %s.\n"),
965 /* The name of the file in which GDB history will be written. If this is
966 set to NULL, of the empty string then history will not be written. */
967 static char *history_filename
;
969 /* Return true if the history_filename is either NULL or the empty string,
970 indicating that we should not try to read, nor write out the history. */
972 history_filename_empty (void)
974 return (history_filename
== nullptr || *history_filename
== '\0');
977 /* Implement 'show history filename'. */
979 show_history_filename (struct ui_file
*file
, int from_tty
,
980 struct cmd_list_element
*c
, const char *value
)
982 if (!history_filename_empty ())
983 fprintf_filtered (file
, _("The filename in which to record "
984 "the command history is \"%ps\".\n"),
985 styled_string (file_name_style
.style (), value
));
987 fprintf_filtered (file
, _("There is no filename currently set for "
988 "recording the command history in.\n"));
991 /* This is like readline(), but it has some gdb-specific behavior.
992 gdb may want readline in both the synchronous and async modes during
993 a single gdb invocation. At the ordinary top-level prompt we might
994 be using the async readline. That means we can't use
995 rl_pre_input_hook, since it doesn't work properly in async mode.
996 However, for a secondary prompt (" >", such as occurs during a
997 `define'), gdb wants a synchronous response.
999 We used to call readline() directly, running it in synchronous
1000 mode. But mixing modes this way is not supported, and as of
1001 readline 5.x it no longer works; the arrow keys come unbound during
1002 the synchronous call. So we make a nested call into the event
1003 loop. That's what gdb_readline_wrapper is for. */
1005 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
1006 rely on gdb_readline_wrapper_result, which might still be NULL if
1007 the user types Control-D for EOF. */
1008 static int gdb_readline_wrapper_done
;
1010 /* The result of the current call to gdb_readline_wrapper, once a newline
1012 static char *gdb_readline_wrapper_result
;
1014 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
1015 to be called after the newline is processed (which will redisplay
1016 the prompt). But in gdb_readline_wrapper we will not get a new
1017 prompt until the next call, or until we return to the event loop.
1018 So we disable this hook around the newline and restore it before we
1020 static void (*saved_after_char_processing_hook
) (void);
1026 gdb_in_secondary_prompt_p (struct ui
*ui
)
1028 return ui
->secondary_prompt_depth
> 0;
1032 /* This function is called when readline has seen a complete line of
1036 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
1038 gdb_assert (!gdb_readline_wrapper_done
);
1039 gdb_readline_wrapper_result
= line
.release ();
1040 gdb_readline_wrapper_done
= 1;
1042 /* Prevent operate-and-get-next from acting too early. */
1043 saved_after_char_processing_hook
= after_char_processing_hook
;
1044 after_char_processing_hook
= NULL
;
1046 /* Prevent parts of the prompt from being redisplayed if annotations
1047 are enabled, and readline's state getting out of sync. We'll
1048 reinstall the callback handler, which puts the terminal in raw
1049 mode (or in readline lingo, in prepped state), when we're next
1050 ready to process user input, either in display_gdb_prompt, or if
1051 we're handling an asynchronous target event and running in the
1052 background, just before returning to the event loop to process
1053 further input (or more target events). */
1054 if (current_ui
->command_editing
)
1055 gdb_rl_callback_handler_remove ();
1058 class gdb_readline_wrapper_cleanup
1061 gdb_readline_wrapper_cleanup ()
1062 : m_handler_orig (current_ui
->input_handler
),
1063 m_already_prompted_orig (current_ui
->command_editing
1064 ? rl_already_prompted
: 0),
1065 m_target_is_async_orig (target_is_async_p ()),
1066 m_save_ui (¤t_ui
)
1068 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1069 current_ui
->secondary_prompt_depth
++;
1071 if (m_target_is_async_orig
)
1075 ~gdb_readline_wrapper_cleanup ()
1077 struct ui
*ui
= current_ui
;
1079 if (ui
->command_editing
)
1080 rl_already_prompted
= m_already_prompted_orig
;
1082 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1083 ui
->input_handler
= m_handler_orig
;
1085 /* Don't restore our input handler in readline yet. That would make
1086 readline prep the terminal (putting it in raw mode), while the
1087 line we just read may trigger execution of a command that expects
1088 the terminal in the default cooked/canonical mode, such as e.g.,
1089 running Python's interactive online help utility. See
1090 gdb_readline_wrapper_line for when we'll reinstall it. */
1092 gdb_readline_wrapper_result
= NULL
;
1093 gdb_readline_wrapper_done
= 0;
1094 ui
->secondary_prompt_depth
--;
1095 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1097 after_char_processing_hook
= saved_after_char_processing_hook
;
1098 saved_after_char_processing_hook
= NULL
;
1100 if (m_target_is_async_orig
)
1104 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1108 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1109 int m_already_prompted_orig
;
1111 /* Whether the target was async. */
1112 int m_target_is_async_orig
;
1114 /* Processing events may change the current UI. */
1115 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1119 gdb_readline_wrapper (const char *prompt
)
1121 struct ui
*ui
= current_ui
;
1123 gdb_readline_wrapper_cleanup cleanup
;
1125 /* Display our prompt and prevent double prompt display. Don't pass
1126 down a NULL prompt, since that has special meaning for
1127 display_gdb_prompt -- it indicates a request to print the primary
1128 prompt, while we want a secondary prompt here. */
1129 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1130 if (ui
->command_editing
)
1131 rl_already_prompted
= 1;
1133 if (after_char_processing_hook
)
1134 (*after_char_processing_hook
) ();
1135 gdb_assert (after_char_processing_hook
== NULL
);
1137 while (gdb_do_one_event () >= 0)
1138 if (gdb_readline_wrapper_done
)
1141 return gdb_readline_wrapper_result
;
1145 /* The current saved history number from operate-and-get-next.
1146 This is -1 if not valid. */
1147 static int operate_saved_history
= -1;
1149 /* This is put on the appropriate hook and helps operate-and-get-next
1152 gdb_rl_operate_and_get_next_completion (void)
1154 int delta
= where_history () - operate_saved_history
;
1156 /* The `key' argument to rl_get_previous_history is ignored. */
1157 rl_get_previous_history (delta
, 0);
1158 operate_saved_history
= -1;
1160 /* readline doesn't automatically update the display for us. */
1163 after_char_processing_hook
= NULL
;
1164 rl_pre_input_hook
= NULL
;
1167 /* This is a gdb-local readline command handler. It accepts the
1168 current command line (like RET does) and, if this command was taken
1169 from the history, arranges for the next command in the history to
1170 appear on the command line when the prompt returns.
1171 We ignore the arguments. */
1173 gdb_rl_operate_and_get_next (int count
, int key
)
1177 /* Use the async hook. */
1178 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1180 /* Find the current line, and find the next line to use. */
1181 where
= where_history();
1183 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1184 || (where
>= history_length
- 1))
1185 operate_saved_history
= where
;
1187 operate_saved_history
= where
+ 1;
1189 return rl_newline (1, key
);
1192 /* Number of user commands executed during this session. */
1194 static int command_count
= 0;
1196 /* Add the user command COMMAND to the input history list. */
1199 gdb_add_history (const char *command
)
1203 if (history_remove_duplicates
!= 0)
1206 int lookbehind_threshold
;
1208 /* The lookbehind threshold for finding a duplicate history entry is
1209 bounded by command_count because we can't meaningfully delete
1210 history entries that are already stored in the history file since
1211 the history file is appended to. */
1212 if (history_remove_duplicates
== -1
1213 || history_remove_duplicates
> command_count
)
1214 lookbehind_threshold
= command_count
;
1216 lookbehind_threshold
= history_remove_duplicates
;
1219 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1221 HIST_ENTRY
*temp
= previous_history ();
1226 if (strcmp (temp
->line
, command
) == 0)
1228 HIST_ENTRY
*prev
= remove_history (where_history ());
1230 free_history_entry (prev
);
1237 add_history (command
);
1240 /* Safely append new history entries to the history file in a corruption-free
1241 way using an intermediate local history file. */
1244 gdb_safe_append_history (void)
1246 int ret
, saved_errno
;
1248 std::string local_history_filename
1249 = string_printf ("%s-gdb%ld~", history_filename
, (long) getpid ());
1251 ret
= rename (history_filename
, local_history_filename
.c_str ());
1252 saved_errno
= errno
;
1253 if (ret
< 0 && saved_errno
!= ENOENT
)
1255 warning (_("Could not rename %ps to %ps: %s"),
1256 styled_string (file_name_style
.style (), history_filename
),
1257 styled_string (file_name_style
.style (),
1258 local_history_filename
.c_str ()),
1259 safe_strerror (saved_errno
));
1265 /* If the rename failed with ENOENT then either the global history
1266 file never existed in the first place or another GDB process is
1267 currently appending to it (and has thus temporarily renamed it).
1268 Since we can't distinguish between these two cases, we have to
1269 conservatively assume the first case and therefore must write out
1270 (not append) our known history to our local history file and try
1271 to move it back anyway. Otherwise a global history file would
1272 never get created! */
1273 gdb_assert (saved_errno
== ENOENT
);
1274 write_history (local_history_filename
.c_str ());
1278 append_history (command_count
, local_history_filename
.c_str ());
1279 if (history_is_stifled ())
1280 history_truncate_file (local_history_filename
.c_str (),
1281 history_max_entries
);
1284 ret
= rename (local_history_filename
.c_str (), history_filename
);
1285 saved_errno
= errno
;
1286 if (ret
< 0 && saved_errno
!= EEXIST
)
1287 warning (_("Could not rename %s to %s: %s"),
1288 local_history_filename
.c_str (), history_filename
,
1289 safe_strerror (saved_errno
));
1293 /* Read one line from the command input stream `instream' into a local
1294 static buffer. The buffer is made bigger as necessary. Returns
1295 the address of the start of the line.
1297 NULL is returned for end of file.
1299 This routine either uses fancy command line editing or simple input
1300 as the user has requested. */
1303 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1305 static struct buffer cmd_line_buffer
;
1306 static int cmd_line_buffer_initialized
;
1307 struct ui
*ui
= current_ui
;
1308 const char *prompt
= prompt_arg
;
1310 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1312 /* The annotation suffix must be non-NULL. */
1313 if (annotation_suffix
== NULL
)
1314 annotation_suffix
= "";
1316 if (from_tty
&& annotation_level
> 1)
1321 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1322 + strlen (annotation_suffix
) + 40);
1324 local_prompt
[0] = '\0';
1326 strcpy (local_prompt
, prompt
);
1327 strcat (local_prompt
, "\n\032\032");
1328 strcat (local_prompt
, annotation_suffix
);
1329 strcat (local_prompt
, "\n");
1331 prompt
= local_prompt
;
1334 if (!cmd_line_buffer_initialized
)
1336 buffer_init (&cmd_line_buffer
);
1337 cmd_line_buffer_initialized
= 1;
1340 /* Starting a new command line. */
1341 cmd_line_buffer
.used_size
= 0;
1345 signal (SIGTSTP
, handle_sigtstp
);
1350 gdb::unique_xmalloc_ptr
<char> rl
;
1352 /* Make sure that all output has been output. Some machines may
1353 let you get away with leaving out some of the gdb_flush, but
1356 gdb_flush (gdb_stdout
);
1357 gdb_flush (gdb_stderr
);
1359 if (!source_file_name
.empty ())
1360 ++source_line_number
;
1362 if (from_tty
&& annotation_level
> 1)
1364 puts_unfiltered ("\n\032\032pre-");
1365 puts_unfiltered (annotation_suffix
);
1366 puts_unfiltered ("\n");
1369 /* Don't use fancy stuff if not talking to stdin. */
1370 if (deprecated_readline_hook
1372 && input_interactive_p (current_ui
))
1374 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1376 else if (command_editing_p
1378 && input_interactive_p (current_ui
))
1380 rl
.reset (gdb_readline_wrapper (prompt
));
1384 rl
.reset (gdb_readline_no_editing (prompt
));
1387 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1388 0, annotation_suffix
);
1389 if (cmd
== (char *) EOF
)
1397 /* Got partial input. I.e., got a line that ends with a
1398 continuation character (backslash). Suppress printing the
1405 signal (SIGTSTP
, SIG_DFL
);
1413 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1415 /* From GNU coding standards, first line is meant to be easy for a
1416 program to parse, and is just canonical program name and version
1417 number, which starts after last space. */
1419 std::string v_str
= string_printf ("GNU gdb %s%s", PKGVERSION
, version
);
1420 fprintf_filtered (stream
, "%ps\n",
1421 styled_string (version_style
.style (), v_str
.c_str ()));
1423 /* Second line is a copyright notice. */
1425 fprintf_filtered (stream
,
1426 "Copyright (C) 2021 Free Software Foundation, Inc.\n");
1428 /* Following the copyright is a brief statement that the program is
1429 free software, that users are free to copy and change it on
1430 certain conditions, that it is covered by the GNU GPL, and that
1431 there is no warranty. */
1433 fprintf_filtered (stream
, "\
1434 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1435 \nThis is free software: you are free to change and redistribute it.\n\
1436 There is NO WARRANTY, to the extent permitted by law.");
1441 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1442 "\"show warranty\" for details.\n"));
1444 /* After the required info we print the configuration information. */
1446 fprintf_filtered (stream
, "This GDB was configured as \"");
1447 if (strcmp (host_name
, target_name
) != 0)
1449 fprintf_filtered (stream
, "--host=%s --target=%s",
1450 host_name
, target_name
);
1454 fprintf_filtered (stream
, "%s", host_name
);
1456 fprintf_filtered (stream
, "\".\n");
1458 fprintf_filtered (stream
, _("Type \"show configuration\" "
1459 "for configuration details.\n"));
1461 if (REPORT_BUGS_TO
[0])
1463 fprintf_filtered (stream
,
1464 _("For bug reporting instructions, please see:\n"));
1465 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1467 fprintf_filtered (stream
,
1468 _("Find the GDB manual and other documentation \
1469 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1470 fprintf_filtered (stream
, "\n\n");
1471 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1472 fprintf_filtered (stream
,
1473 _("Type \"apropos word\" to search for commands \
1474 related to \"word\"."));
1477 /* Print the details of GDB build-time configuration. */
1479 print_gdb_configuration (struct ui_file
*stream
)
1481 fprintf_filtered (stream
, _("\
1482 This GDB was configured as follows:\n\
1483 configure --host=%s --target=%s\n\
1484 "), host_name
, target_name
);
1486 fprintf_filtered (stream
, _("\
1487 --with-auto-load-dir=%s\n\
1488 --with-auto-load-safe-path=%s\n\
1489 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1492 fprintf_filtered (stream
, _("\
1496 fprintf_filtered (stream
, _("\
1502 fprintf_filtered (stream
, _("\
1503 --with-gdb-datadir=%s%s\n\
1504 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1507 fprintf_filtered (stream
, _("\
1508 --with-iconv-bin=%s%s\n\
1509 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1512 if (JIT_READER_DIR
[0])
1513 fprintf_filtered (stream
, _("\
1514 --with-jit-reader-dir=%s%s\n\
1515 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1517 #if HAVE_LIBUNWIND_IA64_H
1518 fprintf_filtered (stream
, _("\
1519 --with-libunwind-ia64\n\
1522 fprintf_filtered (stream
, _("\
1523 --without-libunwind-ia64\n\
1528 fprintf_filtered (stream
, _("\
1532 fprintf_filtered (stream
, _("\
1537 #if HAVE_LIBBABELTRACE
1538 fprintf_filtered (stream
, _("\
1539 --with-babeltrace\n\
1542 fprintf_filtered (stream
, _("\
1543 --without-babeltrace\n\
1548 fprintf_filtered (stream
, _("\
1552 fprintf_filtered (stream
, _("\
1553 --without-intel-pt\n\
1558 fprintf_filtered (stream
, _("\
1562 fprintf_filtered (stream
, _("\
1567 fprintf_filtered (stream
, _("\
1571 fprintf_filtered (stream
, _("\
1575 #ifdef WITH_PYTHON_PATH
1576 fprintf_filtered (stream
, _("\
1577 --with-python=%s%s\n\
1578 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1580 fprintf_filtered (stream
, _("\
1584 #ifdef WITH_PYTHON_LIBDIR
1585 fprintf_filtered (stream
, _("\
1586 --with-python-libdir=%s%s\n\
1587 "), WITH_PYTHON_LIBDIR
, PYTHON_LIBDIR_RELOCATABLE
? " (relocatable)" : "");
1589 fprintf_filtered (stream
, _("\
1590 --without-python-libdir\n\
1594 #if HAVE_LIBDEBUGINFOD
1595 fprintf_filtered (stream
, _("\
1596 --with-debuginfod\n\
1599 fprintf_filtered (stream
, _("\
1600 --without-debuginfod\n\
1605 fprintf_filtered (stream
, _("\
1609 fprintf_filtered (stream
, _("\
1614 #if HAVE_SOURCE_HIGHLIGHT
1615 fprintf_filtered (stream
, _("\
1616 --enable-source-highlight\n\
1619 fprintf_filtered (stream
, _("\
1620 --disable-source-highlight\n\
1625 fprintf_filtered (stream
, _("\
1626 --with-relocated-sources=%s\n\
1631 fprintf_filtered (stream
, _("\
1632 --with-separate-debug-dir=%s%s\n\
1633 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1635 if (TARGET_SYSTEM_ROOT
[0])
1636 fprintf_filtered (stream
, _("\
1637 --with-sysroot=%s%s\n\
1638 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1640 if (SYSTEM_GDBINIT
[0])
1641 fprintf_filtered (stream
, _("\
1642 --with-system-gdbinit=%s%s\n\
1643 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1645 if (SYSTEM_GDBINIT_DIR
[0])
1646 fprintf_filtered (stream
, _("\
1647 --with-system-gdbinit-dir=%s%s\n\
1648 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1650 /* We assume "relocatable" will be printed at least once, thus we always
1651 print this text. It's a reasonably safe assumption for now. */
1652 fprintf_filtered (stream
, _("\n\
1653 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1654 tree, and GDB will still find it.)\n\
1659 /* The current top level prompt, settable with "set prompt", and/or
1660 with the python `gdb.prompt_hook' hook. */
1661 static char *top_prompt
;
1663 /* Access method for the GDB prompt string. */
1671 /* Set method for the GDB prompt string. */
1674 set_prompt (const char *s
)
1676 char *p
= xstrdup (s
);
1683 /* Kills or detaches the given inferior, depending on how we originally
1684 gained control of it. */
1687 kill_or_detach (inferior
*inf
, int from_tty
)
1692 thread_info
*thread
= any_thread_of_inferior (inf
);
1695 switch_to_thread (thread
);
1697 /* Leave core files alone. */
1698 if (target_has_execution ())
1700 if (inf
->attach_flag
)
1701 target_detach (inf
, from_tty
);
1708 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1709 where to collect the output. */
1712 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1717 if (inf
->attach_flag
)
1718 fprintf_filtered (out
,
1719 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1720 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1722 fprintf_filtered (out
,
1723 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1724 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1727 /* If necessary, make the user confirm that we should quit. Return
1728 non-zero if we should quit, zero if we shouldn't. */
1733 /* Don't even ask if we're only debugging a core file inferior. */
1734 if (!have_live_inferiors ())
1737 /* Build the query string as a single string. */
1740 stb
.puts (_("A debugging session is active.\n\n"));
1742 for (inferior
*inf
: all_inferiors ())
1743 print_inferior_quit_action (inf
, &stb
);
1745 stb
.puts (_("\nQuit anyway? "));
1747 return query ("%s", stb
.c_str ());
1750 /* Prepare to exit GDB cleanly by undoing any changes made to the
1751 terminal so that we leave the terminal in the state we acquired it. */
1754 undo_terminal_modifications_before_exit (void)
1756 struct ui
*saved_top_level
= current_ui
;
1758 target_terminal::ours ();
1760 current_ui
= main_ui
;
1765 gdb_disable_readline ();
1767 current_ui
= saved_top_level
;
1771 /* Quit without asking for confirmation. */
1774 quit_force (int *exit_arg
, int from_tty
)
1778 undo_terminal_modifications_before_exit ();
1780 /* An optional expression may be used to cause gdb to terminate with the
1781 value of that expression. */
1783 exit_code
= *exit_arg
;
1784 else if (return_child_result
)
1785 exit_code
= return_child_result_value
;
1787 /* We want to handle any quit errors and exit regardless. */
1789 /* Get out of tfind mode, and kill or detach all inferiors. */
1792 disconnect_tracing ();
1793 for (inferior
*inf
: all_inferiors ())
1794 kill_or_detach (inf
, from_tty
);
1796 catch (const gdb_exception
&ex
)
1798 exception_print (gdb_stderr
, ex
);
1801 /* Give all pushed targets a chance to do minimal cleanup, and pop
1803 for (inferior
*inf
: all_inferiors ())
1805 switch_to_inferior_no_thread (inf
);
1810 catch (const gdb_exception
&ex
)
1812 exception_print (gdb_stderr
, ex
);
1816 /* Save the history information if it is appropriate to do so. */
1819 if (write_history_p
&& history_filename
)
1823 /* History is currently shared between all UIs. If there's
1824 any UI with a terminal, save history. */
1825 for (ui
*ui
: all_uis ())
1827 if (input_interactive_p (ui
))
1835 gdb_safe_append_history ();
1838 catch (const gdb_exception
&ex
)
1840 exception_print (gdb_stderr
, ex
);
1843 /* Destroy any values currently allocated now instead of leaving it
1844 to global destructors, because that may be too late. For
1845 example, the destructors of xmethod values call into the Python
1846 runtime, which is finalized via a final cleanup. */
1849 /* Do any final cleanups before exiting. */
1852 do_final_cleanups ();
1854 catch (const gdb_exception
&ex
)
1856 exception_print (gdb_stderr
, ex
);
1862 /* The value of the "interactive-mode" setting. */
1863 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1865 /* Implement the "show interactive-mode" option. */
1868 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1869 struct cmd_list_element
*c
,
1872 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1873 fprintf_filtered (file
, "Debugger's interactive mode "
1874 "is %s (currently %s).\n",
1875 value
, input_interactive_p (current_ui
) ? "on" : "off");
1877 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1880 /* Returns whether GDB is running on an interactive terminal. */
1883 input_interactive_p (struct ui
*ui
)
1888 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1889 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1891 return ui
->input_interactive_p
;
1895 dont_repeat_command (const char *ignored
, int from_tty
)
1897 /* Can't call dont_repeat here because we're not necessarily reading
1899 *saved_command_line
= 0;
1902 /* Functions to manipulate command line editing control variables. */
1904 /* Number of commands to print in each call to show_commands. */
1905 #define Hist_print 10
1907 show_commands (const char *args
, int from_tty
)
1909 /* Index for history commands. Relative to history_base. */
1912 /* Number of the history entry which we are planning to display next.
1913 Relative to history_base. */
1916 /* Print out some of the commands from the command history. */
1920 if (args
[0] == '+' && args
[1] == '\0')
1921 /* "info editing +" should print from the stored position. */
1924 /* "info editing <exp>" should print around command number <exp>. */
1925 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1927 /* "show commands" means print the last Hist_print commands. */
1930 num
= history_length
- Hist_print
;
1936 /* If there are at least Hist_print commands, we want to display the last
1937 Hist_print rather than, say, the last 6. */
1938 if (history_length
- num
< Hist_print
)
1940 num
= history_length
- Hist_print
;
1946 offset
< num
+ Hist_print
&& offset
< history_length
;
1949 printf_filtered ("%5d %s\n", history_base
+ offset
,
1950 (history_get (history_base
+ offset
))->line
);
1953 /* The next command we want to display is the next one that we haven't
1957 /* If the user repeats this command with return, it should do what
1958 "show commands +" does. This is unnecessary if arg is null,
1959 because "show commands +" is not useful after "show commands". */
1960 if (from_tty
&& args
)
1961 set_repeat_arguments ("+");
1964 /* Update the size of our command history file to HISTORY_SIZE.
1966 A HISTORY_SIZE of -1 stands for unlimited. */
1969 set_readline_history_size (int history_size
)
1971 gdb_assert (history_size
>= -1);
1973 if (history_size
== -1)
1974 unstifle_history ();
1976 stifle_history (history_size
);
1979 /* Called by do_setshow_command. */
1981 set_history_size_command (const char *args
,
1982 int from_tty
, struct cmd_list_element
*c
)
1984 set_readline_history_size (history_size_setshow_var
);
1987 bool info_verbose
= false; /* Default verbose msgs off. */
1989 /* Called by do_set_command. An elaborate joke. */
1991 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1993 const char *cmdname
= "verbose";
1994 struct cmd_list_element
*showcmd
;
1996 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, NULL
, 1);
1997 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1999 if (c
->doc
&& c
->doc_allocated
)
2000 xfree ((char *) c
->doc
);
2001 if (showcmd
->doc
&& showcmd
->doc_allocated
)
2002 xfree ((char *) showcmd
->doc
);
2005 c
->doc
= _("Set verbose printing of informational messages.");
2006 showcmd
->doc
= _("Show verbose printing of informational messages.");
2010 c
->doc
= _("Set verbosity.");
2011 showcmd
->doc
= _("Show verbosity.");
2013 c
->doc_allocated
= 0;
2014 showcmd
->doc_allocated
= 0;
2017 /* Init the history buffer. Note that we are called after the init file(s)
2018 have been read so that the user can change the history file via his
2019 .gdbinit file (for instance). The GDBHISTFILE environment variable
2020 overrides all of this. */
2027 tmpenv
= getenv ("GDBHISTSIZE");
2034 tmpenv
= skip_spaces (tmpenv
);
2036 var
= strtol (tmpenv
, &endptr
, 10);
2037 saved_errno
= errno
;
2038 endptr
= skip_spaces (endptr
);
2040 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
2041 empty string, a negative number or a huge positive number (larger than
2042 INT_MAX) then set the history size to unlimited. Otherwise set our
2043 history size to the number we have read. This behavior is consistent
2044 with how bash handles HISTSIZE. */
2045 if (*endptr
!= '\0')
2047 else if (*tmpenv
== '\0'
2050 /* On targets where INT_MAX == LONG_MAX, we have to look at
2051 errno after calling strtol to distinguish between a value that
2052 is exactly INT_MAX and an overflowing value that was clamped
2054 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2055 history_size_setshow_var
= -1;
2057 history_size_setshow_var
= var
;
2060 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2062 if (history_size_setshow_var
== -2)
2063 history_size_setshow_var
= 256;
2065 set_readline_history_size (history_size_setshow_var
);
2067 tmpenv
= getenv ("GDBHISTFILE");
2068 if (tmpenv
!= nullptr)
2069 history_filename
= xstrdup (tmpenv
);
2070 else if (history_filename
== nullptr)
2072 /* We include the current directory so that if the user changes
2073 directories the file written will be the same as the one
2076 /* No leading dots in file names are allowed on MSDOS. */
2077 const char *fname
= "_gdb_history";
2079 const char *fname
= ".gdb_history";
2082 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (fname
));
2083 history_filename
= temp
.release ();
2086 if (!history_filename_empty ())
2087 read_history (history_filename
);
2091 show_prompt (struct ui_file
*file
, int from_tty
,
2092 struct cmd_list_element
*c
, const char *value
)
2094 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2097 /* "set editing" command. */
2100 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2102 change_line_handler (set_editing_cmd_var
);
2103 /* Update the control variable so that MI's =cmd-param-changed event
2104 shows the correct value. */
2105 set_editing_cmd_var
= current_ui
->command_editing
;
2109 show_editing (struct ui_file
*file
, int from_tty
,
2110 struct cmd_list_element
*c
, const char *value
)
2112 fprintf_filtered (file
, _("Editing of command lines as "
2113 "they are typed is %s.\n"),
2114 current_ui
->command_editing
? _("on") : _("off"));
2118 show_annotation_level (struct ui_file
*file
, int from_tty
,
2119 struct cmd_list_element
*c
, const char *value
)
2121 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2125 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2126 struct cmd_list_element
*c
, const char *value
)
2128 fprintf_filtered (file
, _("Notification of completion for "
2129 "asynchronous execution commands is %s.\n"),
2133 /* New values of the "data-directory" parameter are staged here.
2134 Extension languages, for example Python's gdb.parameter API, will read
2135 the value directory from this variable, so we must ensure that this
2136 always contains the correct value. */
2137 static char *staged_gdb_datadir
;
2139 /* "set" command for the gdb_datadir configuration variable. */
2142 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2144 set_gdb_data_directory (staged_gdb_datadir
);
2146 /* SET_GDB_DATA_DIRECTORY will resolve relative paths in
2147 STAGED_GDB_DATADIR, so we now copy the value from GDB_DATADIR
2148 back into STAGED_GDB_DATADIR so the extension languages can read the
2150 free (staged_gdb_datadir
);
2151 staged_gdb_datadir
= strdup (gdb_datadir
.c_str ());
2153 gdb::observers::gdb_datadir_changed
.notify ();
2156 /* "show" command for the gdb_datadir configuration variable. */
2159 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2160 struct cmd_list_element
*c
, const char *value
)
2162 fprintf_filtered (file
, _("GDB's data directory is \"%ps\".\n"),
2163 styled_string (file_name_style
.style (),
2164 gdb_datadir
.c_str ()));
2167 /* Implement 'set history filename'. */
2170 set_history_filename (const char *args
,
2171 int from_tty
, struct cmd_list_element
*c
)
2173 /* We include the current directory so that if the user changes
2174 directories the file written will be the same as the one
2176 if (!history_filename_empty () && !IS_ABSOLUTE_PATH (history_filename
))
2178 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (history_filename
));
2180 xfree (history_filename
);
2181 history_filename
= temp
.release ();
2185 /* Whether we're in quiet startup mode. */
2187 static bool startup_quiet
;
2194 return startup_quiet
;
2197 /* Show whether GDB should start up in quiet mode. */
2200 show_startup_quiet (struct ui_file
*file
, int from_tty
,
2201 struct cmd_list_element
*c
, const char *value
)
2203 fprintf_filtered (file
, _("Whether to start up quietly is %s.\n"),
2208 init_gdb_version_vars (void)
2210 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2211 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2212 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2213 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2214 set_internalvar_integer (major_version_var
, vmajor
);
2215 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2221 struct cmd_list_element
*c
;
2223 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2224 the DEFAULT_PROMPT is. */
2225 set_prompt (DEFAULT_PROMPT
);
2227 /* Set the important stuff up for command editing. */
2228 command_editing_p
= 1;
2229 history_expansion_p
= 0;
2230 write_history_p
= 0;
2232 /* Setup important stuff for command line editing. */
2233 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2234 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2235 set_rl_completer_word_break_characters (default_word_break_characters ());
2236 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2237 rl_completion_display_matches_hook
= cli_display_match_list
;
2238 rl_readline_name
= "gdb";
2239 rl_terminal_name
= getenv ("TERM");
2241 /* The name for this defun comes from Bash, where it originated.
2242 15 is Control-o, the same binding this function has in Bash. */
2243 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2245 add_setshow_string_cmd ("prompt", class_support
,
2247 _("Set gdb's prompt."),
2248 _("Show gdb's prompt."),
2251 &setlist
, &showlist
);
2253 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2254 Don't repeat this command.\nPrimarily \
2255 used inside of user-defined commands that should not be repeated when\n\
2258 add_setshow_boolean_cmd ("editing", class_support
,
2259 &set_editing_cmd_var
, _("\
2260 Set editing of command lines as they are typed."), _("\
2261 Show editing of command lines as they are typed."), _("\
2262 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2263 Without an argument, command line editing is enabled. To edit, use\n\
2264 EMACS-like or VI-like commands like control-P or ESC."),
2267 &setlist
, &showlist
);
2269 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2270 Set saving of the history record on exit."), _("\
2271 Show saving of the history record on exit."), _("\
2272 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2273 Without an argument, saving is enabled."),
2275 show_write_history_p
,
2276 &sethistlist
, &showhistlist
);
2278 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2279 &history_size_setshow_var
, _("\
2280 Set the size of the command history."), _("\
2281 Show the size of the command history."), _("\
2282 This is the number of previous commands to keep a record of.\n\
2283 If set to \"unlimited\", the number of commands kept in the history\n\
2284 list is unlimited. This defaults to the value of the environment\n\
2285 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2286 set_history_size_command
,
2288 &sethistlist
, &showhistlist
);
2290 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2291 &history_remove_duplicates
, _("\
2292 Set how far back in history to look for and remove duplicate entries."), _("\
2293 Show how far back in history to look for and remove duplicate entries."), _("\
2294 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2295 and remove the first history entry that is a duplicate of the most recent\n\
2296 entry, each time a new history entry is added.\n\
2297 If set to \"unlimited\", this lookbehind is unbounded.\n\
2298 Only history entries added during this session are considered for removal.\n\
2299 If set to 0, removal of duplicate history entries is disabled.\n\
2300 By default this option is set to 0."),
2302 show_history_remove_duplicates
,
2303 &sethistlist
, &showhistlist
);
2305 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2306 Set the filename in which to record the command history."), _("\
2307 Show the filename in which to record the command history."), _("\
2308 (the list of previous commands of which a record is kept)."),
2309 set_history_filename
,
2310 show_history_filename
,
2311 &sethistlist
, &showhistlist
);
2313 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2314 Set whether to confirm potentially dangerous operations."), _("\
2315 Show whether to confirm potentially dangerous operations."), NULL
,
2318 &setlist
, &showlist
);
2320 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2321 Set annotation_level."), _("\
2322 Show annotation_level."), _("\
2323 0 == normal; 1 == fullname (for use when running under emacs)\n\
2324 2 == output annotated suitably for use by programs that control GDB."),
2326 show_annotation_level
,
2327 &setlist
, &showlist
);
2329 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2330 &exec_done_display_p
, _("\
2331 Set notification of completion for asynchronous execution commands."), _("\
2332 Show notification of completion for asynchronous execution commands."), _("\
2333 Use \"on\" to enable the notification, and \"off\" to disable it."),
2335 show_exec_done_display_p
,
2336 &setlist
, &showlist
);
2338 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2339 &staged_gdb_datadir
, _("Set GDB's data directory."),
2340 _("Show GDB's data directory."),
2342 When set, GDB uses the specified path to search for data files."),
2343 set_gdb_datadir
, show_gdb_datadir
,
2346 /* Prime the initial value for data-directory. */
2347 staged_gdb_datadir
= strdup (gdb_datadir
.c_str ());
2349 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2350 &interactive_mode
, _("\
2351 Set whether GDB's standard input is a terminal."), _("\
2352 Show whether GDB's standard input is a terminal."), _("\
2353 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2354 means that GDB should wait for the user to answer queries associated to\n\
2355 commands entered at the command prompt. If off, GDB assumes that standard\n\
2356 input is not a terminal, and uses the default answer to all queries.\n\
2357 If auto (the default), determine which mode to use based on the standard\n\
2360 show_interactive_mode
,
2361 &setlist
, &showlist
);
2363 add_setshow_boolean_cmd ("startup-quietly", class_support
,
2364 &startup_quiet
, _("\
2365 Set whether GDB should start up quietly."), _(" \
2366 Show whether GDB should start up quietly."), _("\
2367 This setting will not affect the current session. Instead this command\n\
2368 should be added to the .gdbearlyinit file in the users home directory to\n\
2369 affect future GDB sessions."),
2372 &setlist
, &showlist
);
2374 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2376 Usage: new-ui INTERPRETER TTY\n\
2377 The first argument is the name of the interpreter to run.\n\
2378 The second argument is the terminal the UI runs on."), &cmdlist
);
2379 set_cmd_completer (c
, interpreter_completer
);
2387 saved_command_line
= xstrdup ("");
2388 previous_saved_command_line
= xstrdup ("");
2390 /* Run the init function of each source file. */
2393 /* Make sure we return to the original directory upon exit, come
2394 what may, since the OS doesn't do that for us. */
2395 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2398 init_cmd_lists (); /* This needs to be done first. */
2402 /* Here is where we call all the _initialize_foo routines. */
2403 initialize_all_files ();
2405 /* This creates the current_program_space. Do this after all the
2406 _initialize_foo routines have had a chance to install their
2407 per-sspace data keys. Also do this before
2408 initialize_current_architecture is called, because it accesses
2409 exec_bfd of the current program space. */
2410 initialize_progspace ();
2411 initialize_inferiors ();
2412 initialize_current_architecture ();
2413 init_main (); /* But that omits this file! Do it now. */
2415 initialize_stdin_serial ();
2417 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2419 set_initial_gdb_ttystate ();
2421 gdb_init_signals ();
2423 /* We need a default language for parsing expressions, so simple
2424 things like "set width 0" won't fail if no language is explicitly
2425 set in a config file or implicitly set by reading an executable
2427 set_language (language_c
);
2428 expected_language
= current_language
; /* Don't warn about the change. */
2430 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2431 init_gdb_version_vars ();