1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2022 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 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
88 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
89 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
91 /* Default command line prompt. This is overridden in some configs. */
93 #ifndef DEFAULT_PROMPT
94 #define DEFAULT_PROMPT "(gdb) "
98 current_ui_gdb_stdout_ptr ()
100 return ¤t_ui
->m_gdb_stdout
;
104 current_ui_gdb_stdin_ptr ()
106 return ¤t_ui
->m_gdb_stdin
;
110 current_ui_gdb_stderr_ptr ()
112 return ¤t_ui
->m_gdb_stderr
;
116 current_ui_gdb_stdlog_ptr ()
118 return ¤t_ui
->m_gdb_stdlog
;
122 current_ui_current_uiout_ptr ()
124 return ¤t_ui
->m_current_uiout
;
127 int inhibit_gdbinit
= 0;
129 /* Flag for whether we want to confirm potentially dangerous
130 operations. Default is yes. */
135 show_confirm (struct ui_file
*file
, int from_tty
,
136 struct cmd_list_element
*c
, const char *value
)
138 fprintf_filtered (file
, _("Whether to confirm potentially "
139 "dangerous operations is %s.\n"),
143 /* Current working directory. */
145 char *current_directory
;
147 /* The last command line executed on the console. Used for command
148 repetitions when the user enters an empty line. */
150 static char *saved_command_line
;
152 /* If not NULL, the arguments that should be passed if
153 saved_command_line is repeated. */
155 static const char *repeat_arguments
;
157 /* The previous last command line executed on the console. Used for command
158 repetitions when a command wants to relaunch the previously launched
159 command. We need this as when a command is running, saved_command_line
160 already contains the line of the currently executing command. */
162 static char *previous_saved_command_line
;
164 /* If not NULL, the arguments that should be passed if the
165 previous_saved_command_line is repeated. */
167 static const char *previous_repeat_arguments
;
169 /* Nonzero if the current command is modified by "server ". This
170 affects things like recording into the command history, commands
171 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
172 whatever) can issue its own commands and also send along commands
173 from the user, and have the user not notice that the user interface
174 is issuing commands too. */
177 /* Timeout limit for response from target. */
179 /* The default value has been changed many times over the years. It
180 was originally 5 seconds. But that was thought to be a long time
181 to sit and wait, so it was changed to 2 seconds. That was thought
182 to be plenty unless the connection was going through some terminal
183 server or multiplexer or other form of hairy serial connection.
185 In mid-1996, remote_timeout was moved from remote.c to top.c and
186 it began being used in other remote-* targets. It appears that the
187 default was changed to 20 seconds at that time, perhaps because the
188 Renesas E7000 ICE didn't always respond in a timely manner.
190 But if 5 seconds is a long time to sit and wait for retransmissions,
191 20 seconds is far worse. This demonstrates the difficulty of using
192 a single variable for all protocol timeouts.
194 As remote.c is used much more than remote-e7000.c, it was changed
195 back to 2 seconds in 1999. */
197 int remote_timeout
= 2;
199 /* Sbrk location on entry to main. Used for statistics only. */
200 #ifdef HAVE_USEFUL_SBRK
204 /* Hooks for alternate command interfaces. */
206 /* This hook is called from within gdb's many mini-event loops which
207 could steal control from a real user interface's event loop. It
208 returns non-zero if the user is requesting a detach, zero
211 int (*deprecated_ui_loop_hook
) (int);
214 /* Called from print_frame_info to list the line we stopped in. */
216 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
220 /* Replaces most of query. */
222 int (*deprecated_query_hook
) (const char *, va_list);
224 /* Replaces most of warning. */
226 void (*deprecated_warning_hook
) (const char *, va_list);
228 /* These three functions support getting lines of text from the user.
229 They are used in sequence. First deprecated_readline_begin_hook is
230 called with a text string that might be (for example) a message for
231 the user to type in a sequence of commands to be executed at a
232 breakpoint. If this function calls back to a GUI, it might take
233 this opportunity to pop up a text interaction window with this
234 message. Next, deprecated_readline_hook is called with a prompt
235 that is emitted prior to collecting the user input. It can be
236 called multiple times. Finally, deprecated_readline_end_hook is
237 called to notify the GUI that we are done with the interaction
238 window and it can close it. */
240 void (*deprecated_readline_begin_hook
) (const char *, ...);
241 char *(*deprecated_readline_hook
) (const char *);
242 void (*deprecated_readline_end_hook
) (void);
244 /* Called as appropriate to notify the interface that we have attached
245 to or detached from an already running process. */
247 void (*deprecated_attach_hook
) (void);
248 void (*deprecated_detach_hook
) (void);
250 /* Called when going to wait for the target. Usually allows the GUI
251 to run while waiting for target events. */
253 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
254 struct target_waitstatus
*status
,
257 /* Used by UI as a wrapper around command execution. May do various
258 things like enabling/disabling buttons, etc... */
260 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
261 const char *cmd
, int from_tty
);
263 /* Called when the current thread changes. Argument is thread id. */
265 void (*deprecated_context_hook
) (int id
);
267 /* The highest UI number ever assigned. */
268 static int highest_ui_num
;
272 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
274 num (++highest_ui_num
),
275 call_readline (nullptr),
276 input_handler (nullptr),
278 interp_info (nullptr),
280 secondary_prompt_depth (0),
281 stdin_stream (instream_
),
282 instream (instream_
),
283 outstream (outstream_
),
284 errstream (errstream_
),
285 input_fd (fileno (instream
)),
286 input_interactive_p (ISATTY (instream
)),
287 prompt_state (PROMPT_NEEDED
),
288 m_gdb_stdout (new stdio_file (outstream
)),
289 m_gdb_stdin (new stdio_file (instream
)),
290 m_gdb_stderr (new stderr_file (errstream
)),
291 m_gdb_stdlog (m_gdb_stderr
),
292 m_current_uiout (nullptr)
294 buffer_init (&line_buffer
);
302 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
310 struct ui
*ui
, *uiprev
;
314 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
318 gdb_assert (ui
!= NULL
);
330 /* Open file named NAME for read/write, making sure not to make it the
331 controlling terminal. */
334 open_terminal_stream (const char *name
)
336 scoped_fd fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
338 perror_with_name (_("opening terminal failed"));
340 return fd
.to_file ("w+");
343 /* Implementation of the "new-ui" command. */
346 new_ui_command (const char *args
, int from_tty
)
349 const char *interpreter_name
;
350 const char *tty_name
;
354 gdb_argv
argv (args
);
355 argc
= argv
.count ();
358 error (_("Usage: new-ui INTERPRETER TTY"));
360 interpreter_name
= argv
[0];
364 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
366 /* Open specified terminal. Note: we used to open it three times,
367 once for each of stdin/stdout/stderr, but that does not work
368 with Windows named pipes. */
369 gdb_file_up stream
= open_terminal_stream (tty_name
);
371 std::unique_ptr
<ui
> ui
372 (new struct ui (stream
.get (), stream
.get (), stream
.get ()));
376 current_ui
= ui
.get ();
378 set_top_level_interpreter (interpreter_name
);
380 interp_pre_command_loop (top_level_interpreter ());
382 /* Make sure the file is not closed. */
388 printf_filtered ("New UI allocated\n");
391 /* Handler for SIGHUP. */
394 /* NOTE 1999-04-29: This function will be static again, once we modify
395 gdb to use the event loop as the default command loop and we merge
396 event-top.c into this file, top.c. */
400 /* Stop asking user for confirmation --- we're exiting. This
401 prevents asking the user dumb questions. */
403 quit_command ((char *) 0, 0);
405 #endif /* defined SIGHUP */
407 /* Line number we are currently in, in a file which is being sourced. */
408 /* NOTE 1999-04-29: This variable will be static again, once we modify
409 gdb to use the event loop as the default command loop and we merge
410 event-top.c into this file, top.c. */
411 /* static */ int source_line_number
;
413 /* Name of the file we are sourcing. */
414 /* NOTE 1999-04-29: This variable will be static again, once we modify
415 gdb to use the event loop as the default command loop and we merge
416 event-top.c into this file, top.c. */
417 /* static */ std::string source_file_name
;
419 /* Read commands from STREAM. */
421 read_command_file (FILE *stream
)
423 struct ui
*ui
= current_ui
;
425 scoped_restore save_instream
426 = make_scoped_restore (&ui
->instream
, stream
);
428 /* Read commands from `instream' and execute them until end of file
429 or error reading instream. */
431 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
435 /* Get a command-line. This calls the readline package. */
436 command
= command_line_input (NULL
, NULL
);
439 command_handler (command
);
445 do_chdir_cleanup (void *old_dir
)
447 chdir ((const char *) old_dir
);
453 prepare_execute_command ()
455 /* With multiple threads running while the one we're examining is
456 stopped, the dcache can get stale without us being able to detect
457 it. For the duration of the command, though, use the dcache to
458 help things like backtrace. */
460 target_dcache_invalidate ();
462 return scoped_value_mark ();
465 /* Tell the user if the language has changed (except first time) after
466 executing a command. */
469 check_frame_language_change (void)
471 static int warned
= 0;
472 struct frame_info
*frame
;
474 /* First make sure that a new frame has been selected, in case the
475 command or the hooks changed the program state. */
476 frame
= deprecated_safe_get_selected_frame ();
477 if (current_language
!= expected_language
)
479 if (language_mode
== language_mode_auto
&& info_verbose
)
481 /* Print what changed. */
487 /* Warn the user if the working language does not match the language
488 of the current frame. Only warn the user if we are actually
489 running the program, i.e. there is a stack. */
490 /* FIXME: This should be cacheing the frame and only running when
491 the frame changes. */
493 if (has_stack_frames ())
497 flang
= get_frame_language (frame
);
499 && flang
!= language_unknown
500 && flang
!= current_language
->la_language
)
502 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
511 wait_sync_command_done (void)
513 /* Processing events may change the current UI. */
514 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
515 struct ui
*ui
= current_ui
;
517 /* We're about to wait until the target stops after having resumed
518 it so must force-commit resumptions, in case we're being called
519 in some context where a scoped_disable_commit_resumed object is
520 active. I.e., this function is a commit-resumed sync/flush
522 scoped_enable_commit_resumed
enable ("sync wait");
524 while (gdb_do_one_event () >= 0)
525 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
532 maybe_wait_sync_command_done (int was_sync
)
534 /* If the interpreter is in sync mode (we're running a user
535 command's list, running command hooks or similars), and we
536 just ran a synchronous command that started the target, wait
537 for that command to end. */
538 if (!current_ui
->async
540 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
541 wait_sync_command_done ();
547 set_repeat_arguments (const char *args
)
549 repeat_arguments
= args
;
552 /* Execute the line P as a command, in the current user context.
553 Pass FROM_TTY as second argument to the defining function. */
556 execute_command (const char *p
, int from_tty
)
558 struct cmd_list_element
*c
;
560 const char *cmd_start
= p
;
562 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
563 scoped_value_mark cleanup
= prepare_execute_command ();
565 /* This can happen when command_line_input hits end of file. */
568 cleanup_if_error
.release ();
572 target_log_command (p
);
574 while (*p
== ' ' || *p
== '\t')
580 std::string default_args
;
581 std::string default_args_and_arg
;
582 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
586 /* If trace-commands is set then this will print this command. */
587 print_command_trace ("%s", p
);
589 c
= lookup_cmd (&cmd
, cmdlist
, "", &default_args
, 0, 1);
592 scoped_restore save_repeat_args
593 = make_scoped_restore (&repeat_arguments
, nullptr);
594 const char *args_pointer
= p
;
596 if (!default_args
.empty ())
599 default_args_and_arg
= default_args
+ ' ' + p
;
601 default_args_and_arg
= default_args
;
602 arg
= default_args_and_arg
.c_str ();
606 /* Pass null arg rather than an empty one. */
607 arg
= *p
== '\0' ? nullptr : p
;
610 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
611 while the is_complete_command(cfunc) test is just plain
612 bogus. They should both be replaced by a test of the form
613 c->strip_trailing_white_space_p. */
614 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
615 can't be replaced with func. This is because it is the
616 cfunc, and not the func, that has the value that the
617 is_complete_command hack is testing for. */
618 /* Clear off trailing whitespace, except for set and complete
620 std::string without_whitespace
;
622 && c
->type
!= set_cmd
623 && !is_complete_command (c
))
625 const char *old_end
= arg
+ strlen (arg
) - 1;
627 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
631 without_whitespace
= std::string (arg
, p
+ 1);
632 arg
= without_whitespace
.c_str ();
636 /* If this command has been pre-hooked, run the hook first. */
637 execute_cmd_pre_hook (c
);
639 if (c
->deprecated_warn_user
)
640 deprecated_cmd_warning (line
, cmdlist
);
642 /* c->user_commands would be NULL in the case of a python command. */
643 if (c
->theclass
== class_user
&& c
->user_commands
)
644 execute_user_command (c
, arg
);
645 else if (c
->theclass
== class_user
646 && c
->is_prefix () && !c
->allow_unknown
)
647 /* If this is a user defined prefix that does not allow unknown
648 (in other words, C is a prefix command and not a command
649 that can be followed by its args), report the list of
652 std::string prefixname
= c
->prefixname ();
653 std::string prefixname_no_space
654 = prefixname
.substr (0, prefixname
.length () - 1);
656 ("\"%s\" must be followed by the name of a subcommand.\n",
657 prefixname_no_space
.c_str ());
658 help_list (*c
->subcommands
, prefixname
.c_str (), all_commands
,
661 else if (c
->type
== set_cmd
)
662 do_set_command (arg
, from_tty
, c
);
663 else if (c
->type
== show_cmd
)
664 do_show_command (arg
, from_tty
, c
);
665 else if (c
->is_command_class_help ())
666 error (_("That is not a command, just a help topic."));
667 else if (deprecated_call_command_hook
)
668 deprecated_call_command_hook (c
, arg
, from_tty
);
670 cmd_func (c
, arg
, from_tty
);
672 maybe_wait_sync_command_done (was_sync
);
674 /* If this command has been post-hooked, run the hook last. */
675 execute_cmd_post_hook (c
);
677 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
679 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
680 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
685 /* Only perform the frame-language-change check if the command
686 we just finished executing did not resume the inferior's execution.
687 If it did resume the inferior, we will do that check after
688 the inferior stopped. */
689 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
690 check_frame_language_change ();
692 cleanup_if_error
.release ();
698 execute_fn_to_ui_file (struct ui_file
*file
, std::function
<void(void)> fn
)
700 /* GDB_STDOUT should be better already restored during these
701 restoration callbacks. */
702 set_batch_flag_and_restore_page_info save_page_info
;
704 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
707 current_uiout
->redirect (file
);
708 ui_out_redirect_pop
redirect_popper (current_uiout
);
710 scoped_restore save_stdout
711 = make_scoped_restore (&gdb_stdout
, file
);
712 scoped_restore save_stderr
713 = make_scoped_restore (&gdb_stderr
, file
);
714 scoped_restore save_stdlog
715 = make_scoped_restore (&gdb_stdlog
, file
);
716 scoped_restore save_stdtarg
717 = make_scoped_restore (&gdb_stdtarg
, file
);
718 scoped_restore save_stdtargerr
719 = make_scoped_restore (&gdb_stdtargerr
, file
);
728 execute_fn_to_string (std::string
&res
, std::function
<void(void)> fn
,
731 string_file
str_file (term_out
);
735 execute_fn_to_ui_file (&str_file
, fn
);
740 res
= std::move (str_file
.string ());
745 res
= std::move (str_file
.string ());
751 execute_command_to_ui_file (struct ui_file
*file
,
752 const char *p
, int from_tty
)
754 execute_fn_to_ui_file (file
, [=]() { execute_command (p
, from_tty
); });
760 execute_command_to_string (std::string
&res
, const char *p
, int from_tty
,
763 execute_fn_to_string (res
, [=]() { execute_command (p
, from_tty
); },
770 execute_command_to_string (const char *p
, int from_tty
,
774 execute_fn_to_string (dummy
, [=]() { execute_command (p
, from_tty
); },
778 /* When nonzero, cause dont_repeat to do nothing. This should only be
779 set via prevent_dont_repeat. */
781 static int suppress_dont_repeat
= 0;
788 struct ui
*ui
= current_ui
;
790 if (suppress_dont_repeat
|| server_command
)
793 /* If we aren't reading from standard input, we are saving the last
794 thing read from stdin in line and don't want to delete it. Null
795 lines won't repeat here in any case. */
796 if (ui
->instream
== ui
->stdin_stream
)
798 *saved_command_line
= 0;
799 repeat_arguments
= NULL
;
808 /* Do not repeat this command, as this command is a repeating command. */
811 /* We cannot free saved_command_line, as this line is being executed,
812 so swap it with previous_saved_command_line. */
813 std::swap (previous_saved_command_line
, saved_command_line
);
814 std::swap (previous_repeat_arguments
, repeat_arguments
);
816 const char *prev
= skip_spaces (get_saved_command_line ());
818 error (_("No previous command to relaunch"));
824 scoped_restore_tmpl
<int>
825 prevent_dont_repeat (void)
827 return make_scoped_restore (&suppress_dont_repeat
, 1);
833 get_saved_command_line ()
835 return saved_command_line
;
841 save_command_line (const char *cmd
)
843 xfree (previous_saved_command_line
);
844 previous_saved_command_line
= saved_command_line
;
845 previous_repeat_arguments
= repeat_arguments
;
846 saved_command_line
= xstrdup (cmd
);
847 repeat_arguments
= NULL
;
851 /* Read a line from the stream "instream" without command line editing.
853 It prints PROMPT once at the start.
854 Action is compatible with "readline", e.g. space for the result is
855 malloc'd and should be freed by the caller.
857 A NULL return means end of file. */
860 gdb_readline_no_editing (const char *prompt
)
862 struct buffer line_buffer
;
863 struct ui
*ui
= current_ui
;
864 /* Read from stdin if we are executing a user defined command. This
865 is the right thing for prompt_for_continue, at least. */
866 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
867 int fd
= fileno (stream
);
869 buffer_init (&line_buffer
);
873 /* Don't use a _filtered function here. It causes the assumed
874 character position to be off, since the newline we read from
875 the user is not accounted for. */
876 puts_unfiltered (prompt
);
877 gdb_flush (gdb_stdout
);
887 /* Wait until at least one byte of data is available. Control-C
888 can interrupt interruptible_select, but not fgetc. */
890 FD_SET (fd
, &readfds
);
891 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
895 /* If this was ctrl-c, the QUIT above handles it. */
898 perror_with_name (("select"));
905 if (line_buffer
.used_size
> 0)
906 /* The last line does not end with a newline. Return it, and
907 if we are called again fgetc will still return EOF and
908 we'll return NULL then. */
910 xfree (buffer_finish (&line_buffer
));
916 if (line_buffer
.used_size
> 0
917 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
918 line_buffer
.used_size
--;
922 buffer_grow_char (&line_buffer
, c
);
925 buffer_grow_char (&line_buffer
, '\0');
926 return buffer_finish (&line_buffer
);
929 /* Variables which control command line editing and history
930 substitution. These variables are given default values at the end
932 static bool command_editing_p
;
934 /* NOTE 1999-04-29: This variable will be static again, once we modify
935 gdb to use the event loop as the default command loop and we merge
936 event-top.c into this file, top.c. */
938 /* static */ bool history_expansion_p
;
940 /* Should we write out the command history on exit? In order to write out
941 the history both this flag must be true, and the history_filename
942 variable must be set to something sensible. */
943 static bool write_history_p
;
945 /* The name of the file in which GDB history will be written. If this is
946 set to NULL, of the empty string then history will not be written. */
947 static std::string history_filename
;
949 /* Implement 'show history save'. */
951 show_write_history_p (struct ui_file
*file
, int from_tty
,
952 struct cmd_list_element
*c
, const char *value
)
954 if (!write_history_p
|| !history_filename
.empty ())
955 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
958 fprintf_filtered (file
, _("Saving of the history is disabled due to "
959 "the value of 'history filename'.\n"));
962 /* The variable associated with the "set/show history size"
963 command. The value -1 means unlimited, and -2 means undefined. */
964 static int history_size_setshow_var
= -2;
967 show_history_size (struct ui_file
*file
, int from_tty
,
968 struct cmd_list_element
*c
, const char *value
)
970 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
974 /* Variable associated with the "history remove-duplicates" option.
975 The value -1 means unlimited. */
976 static int history_remove_duplicates
= 0;
979 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
980 struct cmd_list_element
*c
, const char *value
)
982 fprintf_filtered (file
,
983 _("The number of history entries to look back at for "
984 "duplicates is %s.\n"),
988 /* Implement 'show history filename'. */
990 show_history_filename (struct ui_file
*file
, int from_tty
,
991 struct cmd_list_element
*c
, const char *value
)
993 if (!history_filename
.empty ())
994 fprintf_filtered (file
, _("The filename in which to record "
995 "the command history is \"%ps\".\n"),
996 styled_string (file_name_style
.style (), value
));
998 fprintf_filtered (file
, _("There is no filename currently set for "
999 "recording the command history in.\n"));
1002 /* This is like readline(), but it has some gdb-specific behavior.
1003 gdb may want readline in both the synchronous and async modes during
1004 a single gdb invocation. At the ordinary top-level prompt we might
1005 be using the async readline. That means we can't use
1006 rl_pre_input_hook, since it doesn't work properly in async mode.
1007 However, for a secondary prompt (" >", such as occurs during a
1008 `define'), gdb wants a synchronous response.
1010 We used to call readline() directly, running it in synchronous
1011 mode. But mixing modes this way is not supported, and as of
1012 readline 5.x it no longer works; the arrow keys come unbound during
1013 the synchronous call. So we make a nested call into the event
1014 loop. That's what gdb_readline_wrapper is for. */
1016 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
1017 rely on gdb_readline_wrapper_result, which might still be NULL if
1018 the user types Control-D for EOF. */
1019 static int gdb_readline_wrapper_done
;
1021 /* The result of the current call to gdb_readline_wrapper, once a newline
1023 static char *gdb_readline_wrapper_result
;
1025 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
1026 to be called after the newline is processed (which will redisplay
1027 the prompt). But in gdb_readline_wrapper we will not get a new
1028 prompt until the next call, or until we return to the event loop.
1029 So we disable this hook around the newline and restore it before we
1031 static void (*saved_after_char_processing_hook
) (void);
1037 gdb_in_secondary_prompt_p (struct ui
*ui
)
1039 return ui
->secondary_prompt_depth
> 0;
1043 /* This function is called when readline has seen a complete line of
1047 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
1049 gdb_assert (!gdb_readline_wrapper_done
);
1050 gdb_readline_wrapper_result
= line
.release ();
1051 gdb_readline_wrapper_done
= 1;
1053 /* Prevent operate-and-get-next from acting too early. */
1054 saved_after_char_processing_hook
= after_char_processing_hook
;
1055 after_char_processing_hook
= NULL
;
1057 /* Prevent parts of the prompt from being redisplayed if annotations
1058 are enabled, and readline's state getting out of sync. We'll
1059 reinstall the callback handler, which puts the terminal in raw
1060 mode (or in readline lingo, in prepped state), when we're next
1061 ready to process user input, either in display_gdb_prompt, or if
1062 we're handling an asynchronous target event and running in the
1063 background, just before returning to the event loop to process
1064 further input (or more target events). */
1065 if (current_ui
->command_editing
)
1066 gdb_rl_callback_handler_remove ();
1069 class gdb_readline_wrapper_cleanup
1072 gdb_readline_wrapper_cleanup ()
1073 : m_handler_orig (current_ui
->input_handler
),
1074 m_already_prompted_orig (current_ui
->command_editing
1075 ? rl_already_prompted
: 0),
1076 m_target_is_async_orig (target_is_async_p ()),
1077 m_save_ui (¤t_ui
)
1079 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1080 current_ui
->secondary_prompt_depth
++;
1082 if (m_target_is_async_orig
)
1086 ~gdb_readline_wrapper_cleanup ()
1088 struct ui
*ui
= current_ui
;
1090 if (ui
->command_editing
)
1091 rl_already_prompted
= m_already_prompted_orig
;
1093 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1094 ui
->input_handler
= m_handler_orig
;
1096 /* Don't restore our input handler in readline yet. That would make
1097 readline prep the terminal (putting it in raw mode), while the
1098 line we just read may trigger execution of a command that expects
1099 the terminal in the default cooked/canonical mode, such as e.g.,
1100 running Python's interactive online help utility. See
1101 gdb_readline_wrapper_line for when we'll reinstall it. */
1103 gdb_readline_wrapper_result
= NULL
;
1104 gdb_readline_wrapper_done
= 0;
1105 ui
->secondary_prompt_depth
--;
1106 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1108 after_char_processing_hook
= saved_after_char_processing_hook
;
1109 saved_after_char_processing_hook
= NULL
;
1111 if (m_target_is_async_orig
)
1115 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1119 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1120 int m_already_prompted_orig
;
1122 /* Whether the target was async. */
1123 int m_target_is_async_orig
;
1125 /* Processing events may change the current UI. */
1126 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1130 gdb_readline_wrapper (const char *prompt
)
1132 struct ui
*ui
= current_ui
;
1134 gdb_readline_wrapper_cleanup cleanup
;
1136 /* Display our prompt and prevent double prompt display. Don't pass
1137 down a NULL prompt, since that has special meaning for
1138 display_gdb_prompt -- it indicates a request to print the primary
1139 prompt, while we want a secondary prompt here. */
1140 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1141 if (ui
->command_editing
)
1142 rl_already_prompted
= 1;
1144 if (after_char_processing_hook
)
1145 (*after_char_processing_hook
) ();
1146 gdb_assert (after_char_processing_hook
== NULL
);
1148 while (gdb_do_one_event () >= 0)
1149 if (gdb_readline_wrapper_done
)
1152 return gdb_readline_wrapper_result
;
1156 /* The current saved history number from operate-and-get-next.
1157 This is -1 if not valid. */
1158 static int operate_saved_history
= -1;
1160 /* This is put on the appropriate hook and helps operate-and-get-next
1163 gdb_rl_operate_and_get_next_completion (void)
1165 int delta
= where_history () - operate_saved_history
;
1167 /* The `key' argument to rl_get_previous_history is ignored. */
1168 rl_get_previous_history (delta
, 0);
1169 operate_saved_history
= -1;
1171 /* readline doesn't automatically update the display for us. */
1174 after_char_processing_hook
= NULL
;
1175 rl_pre_input_hook
= NULL
;
1178 /* This is a gdb-local readline command handler. It accepts the
1179 current command line (like RET does) and, if this command was taken
1180 from the history, arranges for the next command in the history to
1181 appear on the command line when the prompt returns.
1182 We ignore the arguments. */
1184 gdb_rl_operate_and_get_next (int count
, int key
)
1188 /* Use the async hook. */
1189 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1191 /* Find the current line, and find the next line to use. */
1192 where
= where_history();
1194 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1195 || (where
>= history_length
- 1))
1196 operate_saved_history
= where
;
1198 operate_saved_history
= where
+ 1;
1200 return rl_newline (1, key
);
1203 /* Number of user commands executed during this session. */
1205 static int command_count
= 0;
1207 /* Add the user command COMMAND to the input history list. */
1210 gdb_add_history (const char *command
)
1214 if (history_remove_duplicates
!= 0)
1217 int lookbehind_threshold
;
1219 /* The lookbehind threshold for finding a duplicate history entry is
1220 bounded by command_count because we can't meaningfully delete
1221 history entries that are already stored in the history file since
1222 the history file is appended to. */
1223 if (history_remove_duplicates
== -1
1224 || history_remove_duplicates
> command_count
)
1225 lookbehind_threshold
= command_count
;
1227 lookbehind_threshold
= history_remove_duplicates
;
1230 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1232 HIST_ENTRY
*temp
= previous_history ();
1237 if (strcmp (temp
->line
, command
) == 0)
1239 HIST_ENTRY
*prev
= remove_history (where_history ());
1241 free_history_entry (prev
);
1248 add_history (command
);
1251 /* Safely append new history entries to the history file in a corruption-free
1252 way using an intermediate local history file. */
1255 gdb_safe_append_history (void)
1257 int ret
, saved_errno
;
1259 std::string local_history_filename
1260 = string_printf ("%s-gdb%ld~", history_filename
.c_str (), (long) getpid ());
1262 ret
= rename (history_filename
.c_str (), local_history_filename
.c_str ());
1263 saved_errno
= errno
;
1264 if (ret
< 0 && saved_errno
!= ENOENT
)
1266 warning (_("Could not rename %ps to %ps: %s"),
1267 styled_string (file_name_style
.style (),
1268 history_filename
.c_str ()),
1269 styled_string (file_name_style
.style (),
1270 local_history_filename
.c_str ()),
1271 safe_strerror (saved_errno
));
1277 /* If the rename failed with ENOENT then either the global history
1278 file never existed in the first place or another GDB process is
1279 currently appending to it (and has thus temporarily renamed it).
1280 Since we can't distinguish between these two cases, we have to
1281 conservatively assume the first case and therefore must write out
1282 (not append) our known history to our local history file and try
1283 to move it back anyway. Otherwise a global history file would
1284 never get created! */
1285 gdb_assert (saved_errno
== ENOENT
);
1286 write_history (local_history_filename
.c_str ());
1290 append_history (command_count
, local_history_filename
.c_str ());
1291 if (history_is_stifled ())
1292 history_truncate_file (local_history_filename
.c_str (),
1293 history_max_entries
);
1296 ret
= rename (local_history_filename
.c_str (), history_filename
.c_str ());
1297 saved_errno
= errno
;
1298 if (ret
< 0 && saved_errno
!= EEXIST
)
1299 warning (_("Could not rename %s to %s: %s"),
1300 local_history_filename
.c_str (), history_filename
.c_str (),
1301 safe_strerror (saved_errno
));
1305 /* Read one line from the command input stream `instream' into a local
1306 static buffer. The buffer is made bigger as necessary. Returns
1307 the address of the start of the line.
1309 NULL is returned for end of file.
1311 This routine either uses fancy command line editing or simple input
1312 as the user has requested. */
1315 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1317 static struct buffer cmd_line_buffer
;
1318 static int cmd_line_buffer_initialized
;
1319 struct ui
*ui
= current_ui
;
1320 const char *prompt
= prompt_arg
;
1322 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1324 /* The annotation suffix must be non-NULL. */
1325 if (annotation_suffix
== NULL
)
1326 annotation_suffix
= "";
1328 if (from_tty
&& annotation_level
> 1)
1333 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1334 + strlen (annotation_suffix
) + 40);
1336 local_prompt
[0] = '\0';
1338 strcpy (local_prompt
, prompt
);
1339 strcat (local_prompt
, "\n\032\032");
1340 strcat (local_prompt
, annotation_suffix
);
1341 strcat (local_prompt
, "\n");
1343 prompt
= local_prompt
;
1346 if (!cmd_line_buffer_initialized
)
1348 buffer_init (&cmd_line_buffer
);
1349 cmd_line_buffer_initialized
= 1;
1352 /* Starting a new command line. */
1353 cmd_line_buffer
.used_size
= 0;
1357 signal (SIGTSTP
, handle_sigtstp
);
1362 gdb::unique_xmalloc_ptr
<char> rl
;
1364 /* Make sure that all output has been output. Some machines may
1365 let you get away with leaving out some of the gdb_flush, but
1367 gdb_stdout
->wrap_here (0);
1368 gdb_flush (gdb_stdout
);
1369 gdb_flush (gdb_stderr
);
1371 if (!source_file_name
.empty ())
1372 ++source_line_number
;
1374 if (from_tty
&& annotation_level
> 1)
1376 puts_unfiltered ("\n\032\032pre-");
1377 puts_unfiltered (annotation_suffix
);
1378 puts_unfiltered ("\n");
1381 /* Don't use fancy stuff if not talking to stdin. */
1382 if (deprecated_readline_hook
1384 && input_interactive_p (current_ui
))
1386 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1388 else if (command_editing_p
1390 && input_interactive_p (current_ui
))
1392 rl
.reset (gdb_readline_wrapper (prompt
));
1396 rl
.reset (gdb_readline_no_editing (prompt
));
1399 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1400 0, annotation_suffix
);
1401 if (cmd
== (char *) EOF
)
1409 /* Got partial input. I.e., got a line that ends with a
1410 continuation character (backslash). Suppress printing the
1417 signal (SIGTSTP
, SIG_DFL
);
1425 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1427 /* From GNU coding standards, first line is meant to be easy for a
1428 program to parse, and is just canonical program name and version
1429 number, which starts after last space. */
1431 std::string v_str
= string_printf ("GNU gdb %s%s", PKGVERSION
, version
);
1432 fprintf_filtered (stream
, "%ps\n",
1433 styled_string (version_style
.style (), v_str
.c_str ()));
1435 /* Second line is a copyright notice. */
1437 fprintf_filtered (stream
,
1438 "Copyright (C) 2022 Free Software Foundation, Inc.\n");
1440 /* Following the copyright is a brief statement that the program is
1441 free software, that users are free to copy and change it on
1442 certain conditions, that it is covered by the GNU GPL, and that
1443 there is no warranty. */
1445 fprintf_filtered (stream
, "\
1446 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1447 \nThis is free software: you are free to change and redistribute it.\n\
1448 There is NO WARRANTY, to the extent permitted by law.");
1453 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1454 "\"show warranty\" for details.\n"));
1456 /* After the required info we print the configuration information. */
1458 fprintf_filtered (stream
, "This GDB was configured as \"");
1459 if (strcmp (host_name
, target_name
) != 0)
1461 fprintf_filtered (stream
, "--host=%s --target=%s",
1462 host_name
, target_name
);
1466 fprintf_filtered (stream
, "%s", host_name
);
1468 fprintf_filtered (stream
, "\".\n");
1470 fprintf_filtered (stream
, _("Type \"show configuration\" "
1471 "for configuration details.\n"));
1473 if (REPORT_BUGS_TO
[0])
1475 fprintf_filtered (stream
,
1476 _("For bug reporting instructions, please see:\n"));
1477 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1479 fprintf_filtered (stream
,
1480 _("Find the GDB manual and other documentation \
1481 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1482 fprintf_filtered (stream
, "\n\n");
1483 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1484 fprintf_filtered (stream
,
1485 _("Type \"apropos word\" to search for commands \
1486 related to \"word\"."));
1489 /* Print the details of GDB build-time configuration. */
1491 print_gdb_configuration (struct ui_file
*stream
)
1493 fprintf_filtered (stream
, _("\
1494 This GDB was configured as follows:\n\
1495 configure --host=%s --target=%s\n\
1496 "), host_name
, target_name
);
1498 fprintf_filtered (stream
, _("\
1499 --with-auto-load-dir=%s\n\
1500 --with-auto-load-safe-path=%s\n\
1501 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1504 fprintf_filtered (stream
, _("\
1508 fprintf_filtered (stream
, _("\
1514 fprintf_filtered (stream
, _("\
1515 --with-gdb-datadir=%s%s\n\
1516 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1519 fprintf_filtered (stream
, _("\
1520 --with-iconv-bin=%s%s\n\
1521 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1524 if (JIT_READER_DIR
[0])
1525 fprintf_filtered (stream
, _("\
1526 --with-jit-reader-dir=%s%s\n\
1527 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1529 #if HAVE_LIBUNWIND_IA64_H
1530 fprintf_filtered (stream
, _("\
1531 --with-libunwind-ia64\n\
1534 fprintf_filtered (stream
, _("\
1535 --without-libunwind-ia64\n\
1540 fprintf_filtered (stream
, _("\
1544 fprintf_filtered (stream
, _("\
1549 #if HAVE_LIBBABELTRACE
1550 fprintf_filtered (stream
, _("\
1551 --with-babeltrace\n\
1554 fprintf_filtered (stream
, _("\
1555 --without-babeltrace\n\
1560 fprintf_filtered (stream
, _("\
1564 fprintf_filtered (stream
, _("\
1565 --without-intel-pt\n\
1570 fprintf_filtered (stream
, _("\
1574 fprintf_filtered (stream
, _("\
1579 fprintf_filtered (stream
, _("\
1583 fprintf_filtered (stream
, _("\
1587 #ifdef WITH_PYTHON_PATH
1588 fprintf_filtered (stream
, _("\
1589 --with-python=%s%s\n\
1590 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1592 fprintf_filtered (stream
, _("\
1596 #ifdef WITH_PYTHON_LIBDIR
1597 fprintf_filtered (stream
, _("\
1598 --with-python-libdir=%s%s\n\
1599 "), WITH_PYTHON_LIBDIR
, PYTHON_LIBDIR_RELOCATABLE
? " (relocatable)" : "");
1601 fprintf_filtered (stream
, _("\
1602 --without-python-libdir\n\
1606 #if HAVE_LIBDEBUGINFOD
1607 fprintf_filtered (stream
, _("\
1608 --with-debuginfod\n\
1611 fprintf_filtered (stream
, _("\
1612 --without-debuginfod\n\
1617 fprintf_filtered (stream
, _("\
1621 fprintf_filtered (stream
, _("\
1626 #if HAVE_SOURCE_HIGHLIGHT
1627 fprintf_filtered (stream
, _("\
1628 --enable-source-highlight\n\
1631 fprintf_filtered (stream
, _("\
1632 --disable-source-highlight\n\
1637 fprintf_filtered (stream
, _("\
1638 --with-relocated-sources=%s\n\
1643 fprintf_filtered (stream
, _("\
1644 --with-separate-debug-dir=%s%s\n\
1645 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1647 if (TARGET_SYSTEM_ROOT
[0])
1648 fprintf_filtered (stream
, _("\
1649 --with-sysroot=%s%s\n\
1650 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1652 if (SYSTEM_GDBINIT
[0])
1653 fprintf_filtered (stream
, _("\
1654 --with-system-gdbinit=%s%s\n\
1655 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1657 if (SYSTEM_GDBINIT_DIR
[0])
1658 fprintf_filtered (stream
, _("\
1659 --with-system-gdbinit-dir=%s%s\n\
1660 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1662 /* We assume "relocatable" will be printed at least once, thus we always
1663 print this text. It's a reasonably safe assumption for now. */
1664 fprintf_filtered (stream
, _("\n\
1665 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1666 tree, and GDB will still find it.)\n\
1671 /* The current top level prompt, settable with "set prompt", and/or
1672 with the python `gdb.prompt_hook' hook. */
1673 static std::string top_prompt
;
1675 /* Access method for the GDB prompt string. */
1683 /* Set method for the GDB prompt string. */
1686 set_prompt (const char *s
)
1692 /* Kills or detaches the given inferior, depending on how we originally
1693 gained control of it. */
1696 kill_or_detach (inferior
*inf
, int from_tty
)
1701 thread_info
*thread
= any_thread_of_inferior (inf
);
1704 switch_to_thread (thread
);
1706 /* Leave core files alone. */
1707 if (target_has_execution ())
1709 if (inf
->attach_flag
)
1710 target_detach (inf
, from_tty
);
1717 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1718 where to collect the output. */
1721 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1726 if (inf
->attach_flag
)
1727 fprintf_filtered (out
,
1728 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1729 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1731 fprintf_filtered (out
,
1732 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1733 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1736 /* If necessary, make the user confirm that we should quit. Return
1737 non-zero if we should quit, zero if we shouldn't. */
1742 /* Don't even ask if we're only debugging a core file inferior. */
1743 if (!have_live_inferiors ())
1746 /* Build the query string as a single string. */
1749 stb
.puts (_("A debugging session is active.\n\n"));
1751 for (inferior
*inf
: all_inferiors ())
1752 print_inferior_quit_action (inf
, &stb
);
1754 stb
.puts (_("\nQuit anyway? "));
1756 return query ("%s", stb
.c_str ());
1759 /* Prepare to exit GDB cleanly by undoing any changes made to the
1760 terminal so that we leave the terminal in the state we acquired it. */
1763 undo_terminal_modifications_before_exit (void)
1765 struct ui
*saved_top_level
= current_ui
;
1767 target_terminal::ours ();
1769 current_ui
= main_ui
;
1774 gdb_disable_readline ();
1776 current_ui
= saved_top_level
;
1780 /* Quit without asking for confirmation. */
1783 quit_force (int *exit_arg
, int from_tty
)
1787 /* An optional expression may be used to cause gdb to terminate with the
1788 value of that expression. */
1790 exit_code
= *exit_arg
;
1791 else if (return_child_result
)
1792 exit_code
= return_child_result_value
;
1794 gdb::observers::gdb_exiting
.notify (exit_code
);
1796 undo_terminal_modifications_before_exit ();
1798 /* We want to handle any quit errors and exit regardless. */
1800 /* Get out of tfind mode, and kill or detach all inferiors. */
1803 disconnect_tracing ();
1804 for (inferior
*inf
: all_inferiors ())
1805 kill_or_detach (inf
, from_tty
);
1807 catch (const gdb_exception
&ex
)
1809 exception_print (gdb_stderr
, ex
);
1812 /* Give all pushed targets a chance to do minimal cleanup, and pop
1814 for (inferior
*inf
: all_inferiors ())
1816 switch_to_inferior_no_thread (inf
);
1821 catch (const gdb_exception
&ex
)
1823 exception_print (gdb_stderr
, ex
);
1827 /* Save the history information if it is appropriate to do so. */
1830 if (write_history_p
&& !history_filename
.empty ())
1834 /* History is currently shared between all UIs. If there's
1835 any UI with a terminal, save history. */
1836 for (ui
*ui
: all_uis ())
1838 if (input_interactive_p (ui
))
1846 gdb_safe_append_history ();
1849 catch (const gdb_exception
&ex
)
1851 exception_print (gdb_stderr
, ex
);
1854 /* Destroy any values currently allocated now instead of leaving it
1855 to global destructors, because that may be too late. For
1856 example, the destructors of xmethod values call into the Python
1857 runtime, which is finalized via a final cleanup. */
1860 /* Do any final cleanups before exiting. */
1863 do_final_cleanups ();
1865 catch (const gdb_exception
&ex
)
1867 exception_print (gdb_stderr
, ex
);
1873 /* The value of the "interactive-mode" setting. */
1874 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1876 /* Implement the "show interactive-mode" option. */
1879 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1880 struct cmd_list_element
*c
,
1883 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1884 fprintf_filtered (file
, "Debugger's interactive mode "
1885 "is %s (currently %s).\n",
1886 value
, input_interactive_p (current_ui
) ? "on" : "off");
1888 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1891 /* Returns whether GDB is running on an interactive terminal. */
1894 input_interactive_p (struct ui
*ui
)
1899 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1900 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1902 return ui
->input_interactive_p
;
1906 dont_repeat_command (const char *ignored
, int from_tty
)
1908 /* Can't call dont_repeat here because we're not necessarily reading
1910 *saved_command_line
= 0;
1913 /* Functions to manipulate command line editing control variables. */
1915 /* Number of commands to print in each call to show_commands. */
1916 #define Hist_print 10
1918 show_commands (const char *args
, int from_tty
)
1920 /* Index for history commands. Relative to history_base. */
1923 /* Number of the history entry which we are planning to display next.
1924 Relative to history_base. */
1927 /* Print out some of the commands from the command history. */
1931 if (args
[0] == '+' && args
[1] == '\0')
1932 /* "info editing +" should print from the stored position. */
1935 /* "info editing <exp>" should print around command number <exp>. */
1936 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1938 /* "show commands" means print the last Hist_print commands. */
1941 num
= history_length
- Hist_print
;
1947 /* If there are at least Hist_print commands, we want to display the last
1948 Hist_print rather than, say, the last 6. */
1949 if (history_length
- num
< Hist_print
)
1951 num
= history_length
- Hist_print
;
1957 offset
< num
+ Hist_print
&& offset
< history_length
;
1960 printf_filtered ("%5d %s\n", history_base
+ offset
,
1961 (history_get (history_base
+ offset
))->line
);
1964 /* The next command we want to display is the next one that we haven't
1968 /* If the user repeats this command with return, it should do what
1969 "show commands +" does. This is unnecessary if arg is null,
1970 because "show commands +" is not useful after "show commands". */
1971 if (from_tty
&& args
)
1972 set_repeat_arguments ("+");
1975 /* Update the size of our command history file to HISTORY_SIZE.
1977 A HISTORY_SIZE of -1 stands for unlimited. */
1980 set_readline_history_size (int history_size
)
1982 gdb_assert (history_size
>= -1);
1984 if (history_size
== -1)
1985 unstifle_history ();
1987 stifle_history (history_size
);
1990 /* Called by do_setshow_command. */
1992 set_history_size_command (const char *args
,
1993 int from_tty
, struct cmd_list_element
*c
)
1995 set_readline_history_size (history_size_setshow_var
);
1998 bool info_verbose
= false; /* Default verbose msgs off. */
2000 /* Called by do_set_command. An elaborate joke. */
2002 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2004 const char *cmdname
= "verbose";
2005 struct cmd_list_element
*showcmd
;
2007 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, NULL
, 1);
2008 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
2010 if (c
->doc
&& c
->doc_allocated
)
2011 xfree ((char *) c
->doc
);
2012 if (showcmd
->doc
&& showcmd
->doc_allocated
)
2013 xfree ((char *) showcmd
->doc
);
2016 c
->doc
= _("Set verbose printing of informational messages.");
2017 showcmd
->doc
= _("Show verbose printing of informational messages.");
2021 c
->doc
= _("Set verbosity.");
2022 showcmd
->doc
= _("Show verbosity.");
2024 c
->doc_allocated
= 0;
2025 showcmd
->doc_allocated
= 0;
2028 /* Init the history buffer. Note that we are called after the init file(s)
2029 have been read so that the user can change the history file via his
2030 .gdbinit file (for instance). The GDBHISTFILE environment variable
2031 overrides all of this. */
2038 tmpenv
= getenv ("GDBHISTSIZE");
2045 tmpenv
= skip_spaces (tmpenv
);
2047 var
= strtol (tmpenv
, &endptr
, 10);
2048 saved_errno
= errno
;
2049 endptr
= skip_spaces (endptr
);
2051 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
2052 empty string, a negative number or a huge positive number (larger than
2053 INT_MAX) then set the history size to unlimited. Otherwise set our
2054 history size to the number we have read. This behavior is consistent
2055 with how bash handles HISTSIZE. */
2056 if (*endptr
!= '\0')
2058 else if (*tmpenv
== '\0'
2061 /* On targets where INT_MAX == LONG_MAX, we have to look at
2062 errno after calling strtol to distinguish between a value that
2063 is exactly INT_MAX and an overflowing value that was clamped
2065 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2066 history_size_setshow_var
= -1;
2068 history_size_setshow_var
= var
;
2071 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2073 if (history_size_setshow_var
== -2)
2074 history_size_setshow_var
= 256;
2076 set_readline_history_size (history_size_setshow_var
);
2078 if (!history_filename
.empty ())
2079 read_history (history_filename
.c_str ());
2083 show_prompt (struct ui_file
*file
, int from_tty
,
2084 struct cmd_list_element
*c
, const char *value
)
2086 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2089 /* "set editing" command. */
2092 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2094 change_line_handler (set_editing_cmd_var
);
2095 /* Update the control variable so that MI's =cmd-param-changed event
2096 shows the correct value. */
2097 set_editing_cmd_var
= current_ui
->command_editing
;
2101 show_editing (struct ui_file
*file
, int from_tty
,
2102 struct cmd_list_element
*c
, const char *value
)
2104 fprintf_filtered (file
, _("Editing of command lines as "
2105 "they are typed is %s.\n"),
2106 current_ui
->command_editing
? _("on") : _("off"));
2110 show_annotation_level (struct ui_file
*file
, int from_tty
,
2111 struct cmd_list_element
*c
, const char *value
)
2113 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2117 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2118 struct cmd_list_element
*c
, const char *value
)
2120 fprintf_filtered (file
, _("Notification of completion for "
2121 "asynchronous execution commands is %s.\n"),
2125 /* New values of the "data-directory" parameter are staged here.
2126 Extension languages, for example Python's gdb.parameter API, will read
2127 the value directory from this variable, so we must ensure that this
2128 always contains the correct value. */
2129 static std::string staged_gdb_datadir
;
2131 /* "set" command for the gdb_datadir configuration variable. */
2134 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2136 set_gdb_data_directory (staged_gdb_datadir
.c_str ());
2138 /* SET_GDB_DATA_DIRECTORY will resolve relative paths in
2139 STAGED_GDB_DATADIR, so we now copy the value from GDB_DATADIR
2140 back into STAGED_GDB_DATADIR so the extension languages can read the
2142 staged_gdb_datadir
= gdb_datadir
;
2144 gdb::observers::gdb_datadir_changed
.notify ();
2147 /* "show" command for the gdb_datadir configuration variable. */
2150 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2151 struct cmd_list_element
*c
, const char *value
)
2153 fprintf_filtered (file
, _("GDB's data directory is \"%ps\".\n"),
2154 styled_string (file_name_style
.style (),
2155 gdb_datadir
.c_str ()));
2158 /* Implement 'set history filename'. */
2161 set_history_filename (const char *args
,
2162 int from_tty
, struct cmd_list_element
*c
)
2164 /* We include the current directory so that if the user changes
2165 directories the file written will be the same as the one
2167 if (!history_filename
.empty ()
2168 && !IS_ABSOLUTE_PATH (history_filename
.c_str ()))
2170 gdb::unique_xmalloc_ptr
<char> temp
2171 (gdb_abspath (history_filename
.c_str ()));
2173 history_filename
= temp
.get ();
2177 /* Whether we're in quiet startup mode. */
2179 static bool startup_quiet
;
2186 return startup_quiet
;
2189 /* Show whether GDB should start up in quiet mode. */
2192 show_startup_quiet (struct ui_file
*file
, int from_tty
,
2193 struct cmd_list_element
*c
, const char *value
)
2195 fprintf_filtered (file
, _("Whether to start up quietly is %s.\n"),
2200 init_gdb_version_vars (void)
2202 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2203 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2204 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2205 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2206 set_internalvar_integer (major_version_var
, vmajor
);
2207 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2213 struct cmd_list_element
*c
;
2215 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2216 the DEFAULT_PROMPT is. */
2217 set_prompt (DEFAULT_PROMPT
);
2219 /* Set the important stuff up for command editing. */
2220 command_editing_p
= 1;
2221 history_expansion_p
= 0;
2222 write_history_p
= 0;
2224 /* Setup important stuff for command line editing. */
2225 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2226 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2227 set_rl_completer_word_break_characters (default_word_break_characters ());
2228 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2229 rl_completion_display_matches_hook
= cli_display_match_list
;
2230 rl_readline_name
= "gdb";
2231 rl_terminal_name
= getenv ("TERM");
2233 /* The name for this defun comes from Bash, where it originated.
2234 15 is Control-o, the same binding this function has in Bash. */
2235 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2237 add_setshow_string_cmd ("prompt", class_support
,
2239 _("Set gdb's prompt."),
2240 _("Show gdb's prompt."),
2243 &setlist
, &showlist
);
2245 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2246 Don't repeat this command.\nPrimarily \
2247 used inside of user-defined commands that should not be repeated when\n\
2250 add_setshow_boolean_cmd ("editing", class_support
,
2251 &set_editing_cmd_var
, _("\
2252 Set editing of command lines as they are typed."), _("\
2253 Show editing of command lines as they are typed."), _("\
2254 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2255 Without an argument, command line editing is enabled. To edit, use\n\
2256 EMACS-like or VI-like commands like control-P or ESC."),
2259 &setlist
, &showlist
);
2261 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2262 Set saving of the history record on exit."), _("\
2263 Show saving of the history record on exit."), _("\
2264 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2265 Without an argument, saving is enabled."),
2267 show_write_history_p
,
2268 &sethistlist
, &showhistlist
);
2270 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2271 &history_size_setshow_var
, _("\
2272 Set the size of the command history."), _("\
2273 Show the size of the command history."), _("\
2274 This is the number of previous commands to keep a record of.\n\
2275 If set to \"unlimited\", the number of commands kept in the history\n\
2276 list is unlimited. This defaults to the value of the environment\n\
2277 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2278 set_history_size_command
,
2280 &sethistlist
, &showhistlist
);
2282 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2283 &history_remove_duplicates
, _("\
2284 Set how far back in history to look for and remove duplicate entries."), _("\
2285 Show how far back in history to look for and remove duplicate entries."), _("\
2286 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2287 and remove the first history entry that is a duplicate of the most recent\n\
2288 entry, each time a new history entry is added.\n\
2289 If set to \"unlimited\", this lookbehind is unbounded.\n\
2290 Only history entries added during this session are considered for removal.\n\
2291 If set to 0, removal of duplicate history entries is disabled.\n\
2292 By default this option is set to 0."),
2294 show_history_remove_duplicates
,
2295 &sethistlist
, &showhistlist
);
2297 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2298 Set the filename in which to record the command history."), _("\
2299 Show the filename in which to record the command history."), _("\
2300 (the list of previous commands of which a record is kept)."),
2301 set_history_filename
,
2302 show_history_filename
,
2303 &sethistlist
, &showhistlist
);
2305 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2306 Set whether to confirm potentially dangerous operations."), _("\
2307 Show whether to confirm potentially dangerous operations."), NULL
,
2310 &setlist
, &showlist
);
2312 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2313 Set annotation_level."), _("\
2314 Show annotation_level."), _("\
2315 0 == normal; 1 == fullname (for use when running under emacs)\n\
2316 2 == output annotated suitably for use by programs that control GDB."),
2318 show_annotation_level
,
2319 &setlist
, &showlist
);
2321 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2322 &exec_done_display_p
, _("\
2323 Set notification of completion for asynchronous execution commands."), _("\
2324 Show notification of completion for asynchronous execution commands."), _("\
2325 Use \"on\" to enable the notification, and \"off\" to disable it."),
2327 show_exec_done_display_p
,
2328 &setlist
, &showlist
);
2330 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2331 &staged_gdb_datadir
, _("Set GDB's data directory."),
2332 _("Show GDB's data directory."),
2334 When set, GDB uses the specified path to search for data files."),
2335 set_gdb_datadir
, show_gdb_datadir
,
2338 /* Prime the initial value for data-directory. */
2339 staged_gdb_datadir
= gdb_datadir
;
2341 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2342 &interactive_mode
, _("\
2343 Set whether GDB's standard input is a terminal."), _("\
2344 Show whether GDB's standard input is a terminal."), _("\
2345 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2346 means that GDB should wait for the user to answer queries associated to\n\
2347 commands entered at the command prompt. If off, GDB assumes that standard\n\
2348 input is not a terminal, and uses the default answer to all queries.\n\
2349 If auto (the default), determine which mode to use based on the standard\n\
2352 show_interactive_mode
,
2353 &setlist
, &showlist
);
2355 add_setshow_boolean_cmd ("startup-quietly", class_support
,
2356 &startup_quiet
, _("\
2357 Set whether GDB should start up quietly."), _(" \
2358 Show whether GDB should start up quietly."), _("\
2359 This setting will not affect the current session. Instead this command\n\
2360 should be added to the .gdbearlyinit file in the users home directory to\n\
2361 affect future GDB sessions."),
2364 &setlist
, &showlist
);
2366 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2368 Usage: new-ui INTERPRETER TTY\n\
2369 The first argument is the name of the interpreter to run.\n\
2370 The second argument is the terminal the UI runs on."), &cmdlist
);
2371 set_cmd_completer (c
, interpreter_completer
);
2379 saved_command_line
= xstrdup ("");
2380 previous_saved_command_line
= xstrdup ("");
2382 /* Run the init function of each source file. */
2385 /* Make sure we return to the original directory upon exit, come
2386 what may, since the OS doesn't do that for us. */
2387 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2390 init_cmd_lists (); /* This needs to be done first. */
2394 /* Here is where we call all the _initialize_foo routines. */
2395 initialize_all_files ();
2397 /* This creates the current_program_space. Do this after all the
2398 _initialize_foo routines have had a chance to install their
2399 per-sspace data keys. Also do this before
2400 initialize_current_architecture is called, because it accesses
2401 exec_bfd of the current program space. */
2402 initialize_progspace ();
2403 initialize_inferiors ();
2404 initialize_current_architecture ();
2405 init_main (); /* But that omits this file! Do it now. */
2407 initialize_stdin_serial ();
2409 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2411 set_initial_gdb_ttystate ();
2413 gdb_init_signals ();
2415 /* We need a default language for parsing expressions, so simple
2416 things like "set width 0" won't fail if no language is explicitly
2417 set in a config file or implicitly set by reading an executable
2419 set_language (language_c
);
2420 expected_language
= current_language
; /* Don't warn about the change. */
2422 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2423 init_gdb_version_vars ();
2426 void _initialize_top ();
2430 /* Determine a default value for the history filename. */
2431 const char *tmpenv
= getenv ("GDBHISTFILE");
2432 if (tmpenv
!= nullptr)
2433 history_filename
= tmpenv
;
2436 /* We include the current directory so that if the user changes
2437 directories the file written will be the same as the one
2440 /* No leading dots in file names are allowed on MSDOS. */
2441 const char *fname
= "_gdb_history";
2443 const char *fname
= ".gdb_history";
2446 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (fname
));
2447 history_filename
= temp
.get ();