1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2024 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"
43 #include "gdbsupport/version.h"
46 #include "gdbsupport/event-loop.h"
47 #include "gdbthread.h"
48 #include "extension.h"
50 #include "observable.h"
52 #include "filenames.h"
54 #include "gdbsupport/gdb_select.h"
55 #include "gdbsupport/scope-exit.h"
57 #include "gdbsupport/pathstuff.h"
58 #include "cli/cli-style.h"
61 /* readline include files. */
62 #include "readline/readline.h"
63 #include "readline/history.h"
65 /* readline defines this. */
68 #include <sys/types.h>
70 #include "event-top.h"
75 #include "tracepoint.h"
80 # include "tui/tui-io.h"
87 extern void initialize_all_files (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 gdb_printf (file
, _("Whether to confirm potentially "
141 "dangerous operations is %s.\n"),
145 /* The last command line executed on the console. Used for command
146 repetitions when the user enters an empty line. */
148 static char *saved_command_line
;
150 /* If not NULL, the arguments that should be passed if
151 saved_command_line is repeated. */
153 static const char *repeat_arguments
;
155 /* The previous last command line executed on the console. Used for command
156 repetitions when a command wants to relaunch the previously launched
157 command. We need this as when a command is running, saved_command_line
158 already contains the line of the currently executing command. */
160 static char *previous_saved_command_line
;
162 /* If not NULL, the arguments that should be passed if the
163 previous_saved_command_line is repeated. */
165 static const char *previous_repeat_arguments
;
167 /* Nonzero if the current command is modified by "server ". This
168 affects things like recording into the command history, commands
169 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
170 whatever) can issue its own commands and also send along commands
171 from the user, and have the user not notice that the user interface
172 is issuing commands too. */
175 /* Timeout limit for response from target. */
177 /* The default value has been changed many times over the years. It
178 was originally 5 seconds. But that was thought to be a long time
179 to sit and wait, so it was changed to 2 seconds. That was thought
180 to be plenty unless the connection was going through some terminal
181 server or multiplexer or other form of hairy serial connection.
183 In mid-1996, remote_timeout was moved from remote.c to top.c and
184 it began being used in other remote-* targets. It appears that the
185 default was changed to 20 seconds at that time, perhaps because the
186 Renesas E7000 ICE didn't always respond in a timely manner.
188 But if 5 seconds is a long time to sit and wait for retransmissions,
189 20 seconds is far worse. This demonstrates the difficulty of using
190 a single variable for all protocol timeouts.
192 As remote.c is used much more than remote-e7000.c, it was changed
193 back to 2 seconds in 1999. */
195 int remote_timeout
= 2;
197 /* Sbrk location on entry to main. Used for statistics only. */
198 #ifdef HAVE_USEFUL_SBRK
202 /* Hooks for alternate command interfaces. */
204 /* This hook is called from within gdb's many mini-event loops which
205 could steal control from a real user interface's event loop. It
206 returns non-zero if the user is requesting a detach, zero
209 int (*deprecated_ui_loop_hook
) (int);
212 /* Called from print_frame_info to list the line we stopped in. */
214 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
218 /* Replaces most of query. */
220 int (*deprecated_query_hook
) (const char *, va_list);
222 /* These three functions support getting lines of text from the user.
223 They are used in sequence. First deprecated_readline_begin_hook is
224 called with a text string that might be (for example) a message for
225 the user to type in a sequence of commands to be executed at a
226 breakpoint. If this function calls back to a GUI, it might take
227 this opportunity to pop up a text interaction window with this
228 message. Next, deprecated_readline_hook is called with a prompt
229 that is emitted prior to collecting the user input. It can be
230 called multiple times. Finally, deprecated_readline_end_hook is
231 called to notify the GUI that we are done with the interaction
232 window and it can close it. */
234 void (*deprecated_readline_begin_hook
) (const char *, ...);
235 char *(*deprecated_readline_hook
) (const char *);
236 void (*deprecated_readline_end_hook
) (void);
238 /* Called as appropriate to notify the interface that we have attached
239 to or detached from an already running process. */
241 void (*deprecated_attach_hook
) (void);
242 void (*deprecated_detach_hook
) (void);
244 /* Used by UI as a wrapper around command execution. May do various
245 things like enabling/disabling buttons, etc... */
247 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
248 const char *cmd
, int from_tty
);
250 /* Called when the current thread changes. Argument is thread id. */
252 void (*deprecated_context_hook
) (int id
);
257 unbuffer_stream (FILE *stream
)
259 /* Unbuffer the input stream so that in gdb_readline_no_editing_callback,
260 the calls to fgetc fetch only one char at the time from STREAM.
262 This is important because gdb_readline_no_editing_callback will read
263 from STREAM up to the first '\n' character, after this GDB returns to
264 the event loop and relies on a select on STREAM indicating that more
267 If STREAM is buffered then the fgetc calls may have moved all the
268 pending input from the kernel into a local buffer, after which the
269 select will not indicate that more input is pending, and input after
270 the first '\n' will not be processed immediately.
272 Please ensure that any changes in this area run the MI tests with the
273 FORCE_SEPARATE_MI_TTY=1 flag being passed. */
276 /* With MS-Windows runtime, making stdin unbuffered when it's
277 connected to the terminal causes it to misbehave. */
278 if (!ISATTY (stream
))
279 setbuf (stream
, nullptr);
281 /* On GNU/Linux the issues described above can impact GDB even when
282 dealing with input from a terminal. For now we unbuffer the input
283 stream for everyone except MS-Windows. */
284 setbuf (stream
, nullptr);
288 /* Handler for SIGHUP. */
291 /* NOTE 1999-04-29: This function will be static again, once we modify
292 gdb to use the event loop as the default command loop and we merge
293 event-top.c into this file, top.c. */
297 /* Stop asking user for confirmation --- we're exiting. This
298 prevents asking the user dumb questions. */
300 quit_command ((char *) 0, 0);
302 #endif /* defined SIGHUP */
304 /* Line number we are currently in, in a file which is being sourced. */
305 /* NOTE 1999-04-29: This variable will be static again, once we modify
306 gdb to use the event loop as the default command loop and we merge
307 event-top.c into this file, top.c. */
308 /* static */ int source_line_number
;
310 /* Name of the file we are sourcing. */
311 /* NOTE 1999-04-29: This variable will be static again, once we modify
312 gdb to use the event loop as the default command loop and we merge
313 event-top.c into this file, top.c. */
314 /* static */ std::string source_file_name
;
316 /* Read commands from STREAM. */
318 read_command_file (FILE *stream
)
320 struct ui
*ui
= current_ui
;
322 unbuffer_stream (stream
);
324 scoped_restore save_instream
325 = make_scoped_restore (&ui
->instream
, stream
);
327 /* Read commands from `instream' and execute them until end of file
328 or error reading instream. */
330 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
332 /* Get a command-line. This calls the readline package. */
333 std::string command_buffer
;
335 = command_line_input (command_buffer
, nullptr, nullptr);
336 if (command
== nullptr)
338 command_handler (command
);
344 do_chdir_cleanup (void *old_dir
)
346 chdir ((const char *) old_dir
);
352 prepare_execute_command ()
354 /* With multiple threads running while the one we're examining is
355 stopped, the dcache can get stale without us being able to detect
356 it. For the duration of the command, though, use the dcache to
357 help things like backtrace. */
359 target_dcache_invalidate (current_program_space
->aspace
);
361 return scoped_value_mark ();
364 /* Tell the user if the language has changed (except first time) after
365 executing a command. */
368 check_frame_language_change (void)
370 static int warned
= 0;
371 frame_info_ptr frame
;
373 /* First make sure that a new frame has been selected, in case the
374 command or the hooks changed the program state. */
375 frame
= deprecated_safe_get_selected_frame ();
376 if (current_language
!= expected_language
)
378 if (language_mode
== language_mode_auto
&& info_verbose
)
380 /* Print what changed. */
386 /* Warn the user if the working language does not match the language
387 of the current frame. Only warn the user if we are actually
388 running the program, i.e. there is a stack. */
389 /* FIXME: This should be cacheing the frame and only running when
390 the frame changes. */
392 if (has_stack_frames ())
396 flang
= get_frame_language (frame
);
398 && flang
!= language_unknown
399 && flang
!= current_language
->la_language
)
401 gdb_printf ("%s\n", _(lang_frame_mismatch_warn
));
410 wait_sync_command_done (void)
412 /* Processing events may change the current UI. */
413 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
414 struct ui
*ui
= current_ui
;
416 /* We're about to wait until the target stops after having resumed
417 it so must force-commit resumptions, in case we're being called
418 in some context where a scoped_disable_commit_resumed object is
419 active. I.e., this function is a commit-resumed sync/flush
421 scoped_enable_commit_resumed
enable ("sync wait");
423 while (gdb_do_one_event () >= 0)
424 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
431 maybe_wait_sync_command_done (int was_sync
)
433 /* If the interpreter is in sync mode (we're running a user
434 command's list, running command hooks or similars), and we
435 just ran a synchronous command that started the target, wait
436 for that command to end. */
437 if (!current_ui
->async
439 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
440 wait_sync_command_done ();
446 set_repeat_arguments (const char *args
)
448 repeat_arguments
= args
;
451 /* Execute the line P as a command, in the current user context.
452 Pass FROM_TTY as second argument to the defining function. */
455 execute_command (const char *p
, int from_tty
)
457 struct cmd_list_element
*c
;
459 const char *cmd_start
= p
;
461 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
462 scoped_value_mark cleanup
= prepare_execute_command ();
464 /* This can happen when command_line_input hits end of file. */
467 cleanup_if_error
.release ();
471 std::string cmd_copy
= p
;
473 target_log_command (p
);
475 while (*p
== ' ' || *p
== '\t')
481 std::string default_args
;
482 std::string default_args_and_arg
;
483 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
487 /* If trace-commands is set then this will print this command. */
488 print_command_trace ("%s", p
);
490 c
= lookup_cmd (&cmd
, cmdlist
, "", &default_args
, 0, 1);
493 scoped_restore save_repeat_args
494 = make_scoped_restore (&repeat_arguments
, nullptr);
495 const char *args_pointer
= p
;
497 if (!default_args
.empty ())
500 default_args_and_arg
= default_args
+ ' ' + p
;
502 default_args_and_arg
= default_args
;
503 arg
= default_args_and_arg
.c_str ();
507 /* Pass null arg rather than an empty one. */
508 arg
= *p
== '\0' ? nullptr : p
;
511 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
512 while the is_complete_command(cfunc) test is just plain
513 bogus. They should both be replaced by a test of the form
514 c->strip_trailing_white_space_p. */
515 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
516 can't be replaced with func. This is because it is the
517 cfunc, and not the func, that has the value that the
518 is_complete_command hack is testing for. */
519 /* Clear off trailing whitespace, except for set and complete
521 std::string without_whitespace
;
523 && c
->type
!= set_cmd
524 && !is_complete_command (c
))
526 const char *old_end
= arg
+ strlen (arg
) - 1;
528 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
532 without_whitespace
= std::string (arg
, p
+ 1);
533 arg
= without_whitespace
.c_str ();
537 /* If this command has been pre-hooked, run the hook first. */
538 execute_cmd_pre_hook (c
);
540 if (c
->deprecated_warn_user
)
541 deprecated_cmd_warning (line
, cmdlist
);
543 /* c->user_commands would be NULL in the case of a python command. */
544 if (c
->theclass
== class_user
&& c
->user_commands
)
545 execute_user_command (c
, arg
);
546 else if (c
->theclass
== class_user
547 && c
->is_prefix () && !c
->allow_unknown
)
548 /* If this is a user defined prefix that does not allow unknown
549 (in other words, C is a prefix command and not a command
550 that can be followed by its args), report the list of
553 std::string prefixname
= c
->prefixname ();
554 std::string prefixname_no_space
555 = prefixname
.substr (0, prefixname
.length () - 1);
557 ("\"%s\" must be followed by the name of a subcommand.\n",
558 prefixname_no_space
.c_str ());
559 help_list (*c
->subcommands
, prefixname
.c_str (), all_commands
,
562 else if (c
->type
== set_cmd
)
563 do_set_command (arg
, from_tty
, c
);
564 else if (c
->type
== show_cmd
)
565 do_show_command (arg
, from_tty
, c
);
566 else if (c
->is_command_class_help ())
567 error (_("That is not a command, just a help topic."));
568 else if (deprecated_call_command_hook
)
569 deprecated_call_command_hook (c
, arg
, from_tty
);
571 cmd_func (c
, arg
, from_tty
);
573 maybe_wait_sync_command_done (was_sync
);
575 /* If this command has been post-hooked, run the hook last.
576 We need to lookup the command again since during its execution,
577 a command may redefine itself. In this case, C pointer
578 becomes invalid so we need to look it up again. */
579 const char *cmd2
= cmd_copy
.c_str ();
580 c
= lookup_cmd (&cmd2
, cmdlist
, "", nullptr, 1, 1);
582 execute_cmd_post_hook (c
);
584 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
586 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
587 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
592 /* Only perform the frame-language-change check if the command
593 we just finished executing did not resume the inferior's execution.
594 If it did resume the inferior, we will do that check after
595 the inferior stopped. */
596 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
597 check_frame_language_change ();
599 cleanup_if_error
.release ();
605 execute_fn_to_ui_file (struct ui_file
*file
, std::function
<void(void)> fn
)
607 /* GDB_STDOUT should be better already restored during these
608 restoration callbacks. */
609 set_batch_flag_and_restore_page_info save_page_info
;
611 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
614 ui_out_redirect_pop
redirect_popper (current_uiout
, file
);
616 scoped_restore save_stdout
617 = make_scoped_restore (&gdb_stdout
, file
);
618 scoped_restore save_stderr
619 = make_scoped_restore (&gdb_stderr
, file
);
620 scoped_restore save_stdlog
621 = make_scoped_restore (&gdb_stdlog
, file
);
622 scoped_restore save_stdtarg
623 = make_scoped_restore (&gdb_stdtarg
, file
);
624 scoped_restore save_stdtargerr
625 = make_scoped_restore (&gdb_stdtargerr
, file
);
634 execute_fn_to_string (std::string
&res
, std::function
<void(void)> fn
,
637 string_file
str_file (term_out
);
641 execute_fn_to_ui_file (&str_file
, fn
);
646 res
= str_file
.release ();
651 res
= str_file
.release ();
657 execute_command_to_ui_file (struct ui_file
*file
,
658 const char *p
, int from_tty
)
660 execute_fn_to_ui_file (file
, [=]() { execute_command (p
, from_tty
); });
666 execute_command_to_string (std::string
&res
, const char *p
, int from_tty
,
669 execute_fn_to_string (res
, [=]() { execute_command (p
, from_tty
); },
676 execute_command_to_string (const char *p
, int from_tty
,
680 execute_fn_to_string (dummy
, [=]() { execute_command (p
, from_tty
); },
684 /* When nonzero, cause dont_repeat to do nothing. This should only be
685 set via prevent_dont_repeat. */
687 static int suppress_dont_repeat
= 0;
694 struct ui
*ui
= current_ui
;
696 if (suppress_dont_repeat
|| server_command
)
699 /* If we aren't reading from standard input, we are saving the last
700 thing read from stdin in line and don't want to delete it. Null
701 lines won't repeat here in any case. */
702 if (ui
->instream
== ui
->stdin_stream
)
704 *saved_command_line
= 0;
705 repeat_arguments
= NULL
;
714 /* Do not repeat this command, as this command is a repeating command. */
717 /* We cannot free saved_command_line, as this line is being executed,
718 so swap it with previous_saved_command_line. */
719 std::swap (previous_saved_command_line
, saved_command_line
);
720 std::swap (previous_repeat_arguments
, repeat_arguments
);
722 const char *prev
= skip_spaces (get_saved_command_line ());
724 error (_("No previous command to relaunch"));
730 scoped_restore_tmpl
<int>
731 prevent_dont_repeat (void)
733 return make_scoped_restore (&suppress_dont_repeat
, 1);
739 get_saved_command_line ()
741 return saved_command_line
;
747 save_command_line (const char *cmd
)
749 xfree (previous_saved_command_line
);
750 previous_saved_command_line
= saved_command_line
;
751 previous_repeat_arguments
= repeat_arguments
;
752 saved_command_line
= xstrdup (cmd
);
753 repeat_arguments
= NULL
;
757 /* Read a line from the stream "instream" without command line editing.
759 It prints PROMPT once at the start.
760 Action is compatible with "readline", e.g. space for the result is
761 malloc'd and should be freed by the caller.
763 A NULL return means end of file. */
765 static gdb::unique_xmalloc_ptr
<char>
766 gdb_readline_no_editing (const char *prompt
)
768 std::string line_buffer
;
769 struct ui
*ui
= current_ui
;
770 /* Read from stdin if we are executing a user defined command. This
771 is the right thing for prompt_for_continue, at least. */
772 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
773 int fd
= fileno (stream
);
777 /* Don't use a _filtered function here. It causes the assumed
778 character position to be off, since the newline we read from
779 the user is not accounted for. */
780 printf_unfiltered ("%s", prompt
);
781 gdb_flush (gdb_stdout
);
791 /* Wait until at least one byte of data is available. Control-C
792 can interrupt interruptible_select, but not fgetc. */
794 FD_SET (fd
, &readfds
);
795 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
799 /* If this was ctrl-c, the QUIT above handles it. */
802 perror_with_name (("select"));
809 if (!line_buffer
.empty ())
810 /* The last line does not end with a newline. Return it, and
811 if we are called again fgetc will still return EOF and
812 we'll return NULL then. */
819 if (!line_buffer
.empty () && line_buffer
.back () == '\r')
820 line_buffer
.pop_back ();
827 return make_unique_xstrdup (line_buffer
.c_str ());
830 /* Variables which control command line editing and history
831 substitution. These variables are given default values at the end
833 static bool command_editing_p
;
835 /* NOTE 1999-04-29: This variable will be static again, once we modify
836 gdb to use the event loop as the default command loop and we merge
837 event-top.c into this file, top.c. */
839 /* static */ bool history_expansion_p
;
841 /* Should we write out the command history on exit? In order to write out
842 the history both this flag must be true, and the history_filename
843 variable must be set to something sensible. */
844 static bool write_history_p
;
846 /* The name of the file in which GDB history will be written. If this is
847 set to NULL, of the empty string then history will not be written. */
848 static std::string history_filename
;
850 /* Implement 'show history save'. */
852 show_write_history_p (struct ui_file
*file
, int from_tty
,
853 struct cmd_list_element
*c
, const char *value
)
855 if (!write_history_p
|| !history_filename
.empty ())
856 gdb_printf (file
, _("Saving of the history record on exit is %s.\n"),
859 gdb_printf (file
, _("Saving of the history is disabled due to "
860 "the value of 'history filename'.\n"));
863 /* The variable associated with the "set/show history size"
864 command. The value -1 means unlimited, and -2 means undefined. */
865 static int history_size_setshow_var
= -2;
868 show_history_size (struct ui_file
*file
, int from_tty
,
869 struct cmd_list_element
*c
, const char *value
)
871 gdb_printf (file
, _("The size of the command history is %s.\n"),
875 /* Variable associated with the "history remove-duplicates" option.
876 The value -1 means unlimited. */
877 static int history_remove_duplicates
= 0;
880 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
881 struct cmd_list_element
*c
, const char *value
)
884 _("The number of history entries to look back at for "
885 "duplicates is %s.\n"),
889 /* Implement 'show history filename'. */
891 show_history_filename (struct ui_file
*file
, int from_tty
,
892 struct cmd_list_element
*c
, const char *value
)
894 if (!history_filename
.empty ())
895 gdb_printf (file
, _("The filename in which to record "
896 "the command history is \"%ps\".\n"),
897 styled_string (file_name_style
.style (), value
));
899 gdb_printf (file
, _("There is no filename currently set for "
900 "recording the command history in.\n"));
903 /* This is like readline(), but it has some gdb-specific behavior.
904 gdb may want readline in both the synchronous and async modes during
905 a single gdb invocation. At the ordinary top-level prompt we might
906 be using the async readline. That means we can't use
907 rl_pre_input_hook, since it doesn't work properly in async mode.
908 However, for a secondary prompt (" >", such as occurs during a
909 `define'), gdb wants a synchronous response.
911 We used to call readline() directly, running it in synchronous
912 mode. But mixing modes this way is not supported, and as of
913 readline 5.x it no longer works; the arrow keys come unbound during
914 the synchronous call. So we make a nested call into the event
915 loop. That's what gdb_readline_wrapper is for. */
917 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
918 rely on gdb_readline_wrapper_result, which might still be NULL if
919 the user types Control-D for EOF. */
920 static int gdb_readline_wrapper_done
;
922 /* The result of the current call to gdb_readline_wrapper, once a newline
924 static char *gdb_readline_wrapper_result
;
926 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
927 to be called after the newline is processed (which will redisplay
928 the prompt). But in gdb_readline_wrapper we will not get a new
929 prompt until the next call, or until we return to the event loop.
930 So we disable this hook around the newline and restore it before we
932 static void (*saved_after_char_processing_hook
) (void);
938 gdb_in_secondary_prompt_p (struct ui
*ui
)
940 return ui
->secondary_prompt_depth
> 0;
944 /* This function is called when readline has seen a complete line of
948 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
950 gdb_assert (!gdb_readline_wrapper_done
);
951 gdb_readline_wrapper_result
= line
.release ();
952 gdb_readline_wrapper_done
= 1;
954 /* Prevent operate-and-get-next from acting too early. */
955 saved_after_char_processing_hook
= after_char_processing_hook
;
956 after_char_processing_hook
= NULL
;
960 tui_inject_newline_into_command_window ();
963 /* Prevent parts of the prompt from being redisplayed if annotations
964 are enabled, and readline's state getting out of sync. We'll
965 reinstall the callback handler, which puts the terminal in raw
966 mode (or in readline lingo, in prepped state), when we're next
967 ready to process user input, either in display_gdb_prompt, or if
968 we're handling an asynchronous target event and running in the
969 background, just before returning to the event loop to process
970 further input (or more target events). */
971 if (current_ui
->command_editing
)
972 gdb_rl_callback_handler_remove ();
975 class gdb_readline_wrapper_cleanup
978 gdb_readline_wrapper_cleanup ()
979 : m_handler_orig (current_ui
->input_handler
),
980 m_already_prompted_orig (current_ui
->command_editing
981 ? rl_already_prompted
: 0),
982 m_target_is_async_orig (target_is_async_p ()),
983 m_save_ui (¤t_ui
)
985 current_ui
->input_handler
= gdb_readline_wrapper_line
;
986 current_ui
->secondary_prompt_depth
++;
988 if (m_target_is_async_orig
)
989 target_async (false);
992 ~gdb_readline_wrapper_cleanup ()
994 struct ui
*ui
= current_ui
;
996 if (ui
->command_editing
)
997 rl_already_prompted
= m_already_prompted_orig
;
999 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1000 ui
->input_handler
= m_handler_orig
;
1002 /* Don't restore our input handler in readline yet. That would make
1003 readline prep the terminal (putting it in raw mode), while the
1004 line we just read may trigger execution of a command that expects
1005 the terminal in the default cooked/canonical mode, such as e.g.,
1006 running Python's interactive online help utility. See
1007 gdb_readline_wrapper_line for when we'll reinstall it. */
1009 gdb_readline_wrapper_result
= NULL
;
1010 gdb_readline_wrapper_done
= 0;
1011 ui
->secondary_prompt_depth
--;
1012 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1014 after_char_processing_hook
= saved_after_char_processing_hook
;
1015 saved_after_char_processing_hook
= NULL
;
1017 if (m_target_is_async_orig
)
1018 target_async (true);
1021 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1025 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1026 int m_already_prompted_orig
;
1028 /* Whether the target was async. */
1029 int m_target_is_async_orig
;
1031 /* Processing events may change the current UI. */
1032 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1036 gdb_readline_wrapper (const char *prompt
)
1038 struct ui
*ui
= current_ui
;
1040 gdb_readline_wrapper_cleanup cleanup
;
1042 /* Display our prompt and prevent double prompt display. Don't pass
1043 down a NULL prompt, since that has special meaning for
1044 display_gdb_prompt -- it indicates a request to print the primary
1045 prompt, while we want a secondary prompt here. */
1046 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1047 if (ui
->command_editing
)
1048 rl_already_prompted
= 1;
1050 if (after_char_processing_hook
)
1051 (*after_char_processing_hook
) ();
1052 gdb_assert (after_char_processing_hook
== NULL
);
1054 while (gdb_do_one_event () >= 0)
1055 if (gdb_readline_wrapper_done
)
1058 return gdb_readline_wrapper_result
;
1062 /* The current saved history number from operate-and-get-next.
1063 This is -1 if not valid. */
1064 static int operate_saved_history
= -1;
1066 /* This is put on the appropriate hook and helps operate-and-get-next
1069 gdb_rl_operate_and_get_next_completion (void)
1071 int delta
= where_history () - operate_saved_history
;
1073 /* The `key' argument to rl_get_previous_history is ignored. */
1074 rl_get_previous_history (delta
, 0);
1075 operate_saved_history
= -1;
1077 /* readline doesn't automatically update the display for us. */
1080 after_char_processing_hook
= NULL
;
1081 rl_pre_input_hook
= NULL
;
1084 /* This is a gdb-local readline command handler. It accepts the
1085 current command line (like RET does) and, if this command was taken
1086 from the history, arranges for the next command in the history to
1087 appear on the command line when the prompt returns.
1088 We ignore the arguments. */
1090 gdb_rl_operate_and_get_next (int count
, int key
)
1094 /* Use the async hook. */
1095 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1097 /* Find the current line, and find the next line to use. */
1098 where
= where_history();
1100 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1101 || (where
>= history_length
- 1))
1102 operate_saved_history
= where
;
1104 operate_saved_history
= where
+ 1;
1106 return rl_newline (1, key
);
1109 /* Number of user commands executed during this session. */
1111 static int command_count
= 0;
1113 /* Add the user command COMMAND to the input history list. */
1116 gdb_add_history (const char *command
)
1120 if (history_remove_duplicates
!= 0)
1123 int lookbehind_threshold
;
1125 /* The lookbehind threshold for finding a duplicate history entry is
1126 bounded by command_count because we can't meaningfully delete
1127 history entries that are already stored in the history file since
1128 the history file is appended to. */
1129 if (history_remove_duplicates
== -1
1130 || history_remove_duplicates
> command_count
)
1131 lookbehind_threshold
= command_count
;
1133 lookbehind_threshold
= history_remove_duplicates
;
1136 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1138 HIST_ENTRY
*temp
= previous_history ();
1143 if (strcmp (temp
->line
, command
) == 0)
1145 HIST_ENTRY
*prev
= remove_history (where_history ());
1147 free_history_entry (prev
);
1154 add_history (command
);
1157 /* Safely append new history entries to the history file in a corruption-free
1158 way using an intermediate local history file. */
1161 gdb_safe_append_history (void)
1163 int ret
, saved_errno
;
1165 std::string local_history_filename
1166 = string_printf ("%s-gdb%ld~", history_filename
.c_str (), (long) getpid ());
1168 ret
= rename (history_filename
.c_str (), local_history_filename
.c_str ());
1169 saved_errno
= errno
;
1170 if (ret
< 0 && saved_errno
!= ENOENT
)
1172 warning (_("Could not rename %ps to %ps: %s"),
1173 styled_string (file_name_style
.style (),
1174 history_filename
.c_str ()),
1175 styled_string (file_name_style
.style (),
1176 local_history_filename
.c_str ()),
1177 safe_strerror (saved_errno
));
1183 /* If the rename failed with ENOENT then either the global history
1184 file never existed in the first place or another GDB process is
1185 currently appending to it (and has thus temporarily renamed it).
1186 Since we can't distinguish between these two cases, we have to
1187 conservatively assume the first case and therefore must write out
1188 (not append) our known history to our local history file and try
1189 to move it back anyway. Otherwise a global history file would
1190 never get created! */
1191 gdb_assert (saved_errno
== ENOENT
);
1192 write_history (local_history_filename
.c_str ());
1196 append_history (command_count
, local_history_filename
.c_str ());
1197 if (history_is_stifled ())
1198 history_truncate_file (local_history_filename
.c_str (),
1199 history_max_entries
);
1202 ret
= rename (local_history_filename
.c_str (), history_filename
.c_str ());
1203 saved_errno
= errno
;
1204 if (ret
< 0 && saved_errno
!= EEXIST
)
1205 warning (_("Could not rename %s to %s: %s"),
1206 local_history_filename
.c_str (), history_filename
.c_str (),
1207 safe_strerror (saved_errno
));
1211 /* Read one line from the command input stream `instream'.
1213 CMD_LINE_BUFFER is a buffer that the function may use to store the result, if
1214 it needs to be dynamically-allocated. Otherwise, it is unused.string
1216 Return nullptr for end of file.
1218 This routine either uses fancy command line editing or simple input
1219 as the user has requested. */
1222 command_line_input (std::string
&cmd_line_buffer
, const char *prompt_arg
,
1223 const char *annotation_suffix
)
1225 struct ui
*ui
= current_ui
;
1226 const char *prompt
= prompt_arg
;
1228 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1230 /* The annotation suffix must be non-NULL. */
1231 if (annotation_suffix
== NULL
)
1232 annotation_suffix
= "";
1234 if (from_tty
&& annotation_level
> 1)
1239 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1240 + strlen (annotation_suffix
) + 40);
1242 local_prompt
[0] = '\0';
1244 strcpy (local_prompt
, prompt
);
1245 strcat (local_prompt
, "\n\032\032");
1246 strcat (local_prompt
, annotation_suffix
);
1247 strcat (local_prompt
, "\n");
1249 prompt
= local_prompt
;
1254 signal (SIGTSTP
, handle_sigtstp
);
1259 gdb::unique_xmalloc_ptr
<char> rl
;
1261 /* Make sure that all output has been output. Some machines may
1262 let you get away with leaving out some of the gdb_flush, but
1264 gdb_flush (gdb_stdout
);
1265 gdb_flush (gdb_stderr
);
1267 if (!source_file_name
.empty ())
1268 ++source_line_number
;
1270 if (from_tty
&& annotation_level
> 1)
1271 printf_unfiltered ("\n\032\032pre-%s\n", annotation_suffix
);
1273 /* Don't use fancy stuff if not talking to stdin. */
1274 if (deprecated_readline_hook
1276 && current_ui
->input_interactive_p ())
1278 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1280 else if (command_editing_p
1282 && current_ui
->input_interactive_p ())
1284 rl
.reset (gdb_readline_wrapper (prompt
));
1288 rl
= gdb_readline_no_editing (prompt
);
1291 cmd
= handle_line_of_input (cmd_line_buffer
, rl
.get (),
1292 0, annotation_suffix
);
1293 if (cmd
== (char *) EOF
)
1301 /* Got partial input. I.e., got a line that ends with a
1302 continuation character (backslash). Suppress printing the
1309 signal (SIGTSTP
, SIG_DFL
);
1317 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1319 /* From GNU coding standards, first line is meant to be easy for a
1320 program to parse, and is just canonical program name and version
1321 number, which starts after last space. */
1323 std::string v_str
= string_printf ("GNU gdb %s%s", PKGVERSION
, version
);
1324 gdb_printf (stream
, "%ps\n",
1325 styled_string (version_style
.style (), v_str
.c_str ()));
1327 /* Second line is a copyright notice. */
1330 "Copyright (C) 2024 Free Software Foundation, Inc.\n");
1332 /* Following the copyright is a brief statement that the program is
1333 free software, that users are free to copy and change it on
1334 certain conditions, that it is covered by the GNU GPL, and that
1335 there is no warranty. */
1337 gdb_printf (stream
, "\
1338 License GPLv3+: GNU GPL version 3 or later <%ps>\
1339 \nThis is free software: you are free to change and redistribute it.\n\
1340 There is NO WARRANTY, to the extent permitted by law.",
1341 styled_string (file_name_style
.style (),
1342 "http://gnu.org/licenses/gpl.html"));
1347 gdb_printf (stream
, ("\nType \"show copying\" and "
1348 "\"show warranty\" for details.\n"));
1350 /* After the required info we print the configuration information. */
1352 gdb_printf (stream
, "This GDB was configured as \"");
1353 if (strcmp (host_name
, target_name
) != 0)
1355 gdb_printf (stream
, "--host=%s --target=%s",
1356 host_name
, target_name
);
1360 gdb_printf (stream
, "%s", host_name
);
1362 gdb_printf (stream
, "\".\n");
1364 gdb_printf (stream
, _("Type \"show configuration\" "
1365 "for configuration details.\n"));
1367 if (REPORT_BUGS_TO
[0])
1370 _("For bug reporting instructions, please see:\n"));
1371 gdb_printf (stream
, "%ps.\n",
1372 styled_string (file_name_style
.style (),
1376 _("Find the GDB manual and other documentation \
1377 resources online at:\n <%ps>."),
1378 styled_string (file_name_style
.style (),
1379 "http://www.gnu.org/software/gdb/documentation/"));
1380 gdb_printf (stream
, "\n\n");
1381 gdb_printf (stream
, _("For help, type \"help\".\n"));
1383 _("Type \"apropos word\" to search for commands \
1384 related to \"word\"."));
1387 /* Print the details of GDB build-time configuration. */
1389 print_gdb_configuration (struct ui_file
*stream
)
1391 gdb_printf (stream
, _("\
1392 This GDB was configured as follows:\n\
1393 configure --host=%s --target=%s\n\
1394 "), host_name
, target_name
);
1396 gdb_printf (stream
, _("\
1397 --with-auto-load-dir=%s\n\
1398 --with-auto-load-safe-path=%s\n\
1399 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1402 gdb_printf (stream
, _("\
1406 gdb_printf (stream
, _("\
1412 gdb_printf (stream
, _("\
1413 --with-gdb-datadir=%s%s\n\
1414 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1417 gdb_printf (stream
, _("\
1418 --with-iconv-bin=%s%s\n\
1419 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1422 if (JIT_READER_DIR
[0])
1423 gdb_printf (stream
, _("\
1424 --with-jit-reader-dir=%s%s\n\
1425 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1427 #if HAVE_LIBUNWIND_IA64_H
1428 gdb_printf (stream
, _("\
1429 --with-libunwind-ia64\n\
1432 gdb_printf (stream
, _("\
1433 --without-libunwind-ia64\n\
1438 gdb_printf (stream
, _("\
1442 gdb_printf (stream
, _("\
1447 #if HAVE_LIBBABELTRACE
1448 gdb_printf (stream
, _("\
1449 --with-babeltrace\n\
1452 gdb_printf (stream
, _("\
1453 --without-babeltrace\n\
1458 gdb_printf (stream
, _("\
1462 gdb_printf (stream
, _("\
1463 --without-intel-pt\n\
1468 gdb_printf (stream
, _("\
1472 gdb_printf (stream
, _("\
1476 #ifdef WITH_PYTHON_PATH
1477 gdb_printf (stream
, _("\
1478 --with-python=%s%s\n\
1479 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1481 gdb_printf (stream
, _("\
1485 #ifdef WITH_PYTHON_LIBDIR
1486 gdb_printf (stream
, _("\
1487 --with-python-libdir=%s%s\n\
1488 "), WITH_PYTHON_LIBDIR
, PYTHON_LIBDIR_RELOCATABLE
? " (relocatable)" : "");
1490 gdb_printf (stream
, _("\
1491 --without-python-libdir\n\
1495 #if HAVE_LIBDEBUGINFOD
1496 gdb_printf (stream
, _("\
1497 --with-debuginfod\n\
1500 gdb_printf (stream
, _("\
1501 --without-debuginfod\n\
1506 gdb_printf (stream
, _("\
1510 gdb_printf (stream
, _("\
1516 gdb_printf (stream
, _("\
1520 gdb_printf (stream
, _("\
1526 gdb_printf (stream
, _("\
1527 --with-amd-dbgapi\n\
1530 gdb_printf (stream
, _("\
1531 --without-amd-dbgapi\n\
1535 #if HAVE_SOURCE_HIGHLIGHT
1536 gdb_printf (stream
, _("\
1537 --enable-source-highlight\n\
1540 gdb_printf (stream
, _("\
1541 --disable-source-highlight\n\
1546 gdb_printf (stream
, _("\
1547 --enable-threading\n\
1550 gdb_printf (stream
, _("\
1551 --disable-threading\n\
1556 gdb_printf (stream
, _("\
1560 gdb_printf (stream
, _("\
1565 #ifdef HAVE_READLINE_READLINE_H
1566 gdb_printf (stream
, _("\
1567 --with-system-readline\n\
1570 gdb_printf (stream
, _("\
1571 --without-system-readline\n\
1576 gdb_printf (stream
, _("\
1577 --with-relocated-sources=%s\n\
1582 gdb_printf (stream
, _("\
1583 --with-separate-debug-dir=%s%s\n\
1584 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1586 #ifdef ADDITIONAL_DEBUG_DIRS
1587 gdb_printf (stream
, _ ("\
1588 --with-additional-debug-dirs=%s\n\
1589 "), ADDITIONAL_DEBUG_DIRS
);
1592 if (TARGET_SYSTEM_ROOT
[0])
1593 gdb_printf (stream
, _("\
1594 --with-sysroot=%s%s\n\
1595 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1597 if (SYSTEM_GDBINIT
[0])
1598 gdb_printf (stream
, _("\
1599 --with-system-gdbinit=%s%s\n\
1600 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1602 if (SYSTEM_GDBINIT_DIR
[0])
1603 gdb_printf (stream
, _("\
1604 --with-system-gdbinit-dir=%s%s\n\
1605 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1607 /* We assume "relocatable" will be printed at least once, thus we always
1608 print this text. It's a reasonably safe assumption for now. */
1609 gdb_printf (stream
, _("\n\
1610 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1611 tree, and GDB will still find it.)\n\
1616 /* The current top level prompt, settable with "set prompt", and/or
1617 with the python `gdb.prompt_hook' hook. */
1618 static std::string top_prompt
;
1620 /* Access method for the GDB prompt string. */
1628 /* Set method for the GDB prompt string. */
1631 set_prompt (const char *s
)
1637 /* Kills or detaches the given inferior, depending on how we originally
1638 gained control of it. */
1641 kill_or_detach (inferior
*inf
, int from_tty
)
1646 thread_info
*thread
= any_thread_of_inferior (inf
);
1649 switch_to_thread (thread
);
1651 /* Leave core files alone. */
1652 if (target_has_execution ())
1654 if (inf
->attach_flag
)
1655 target_detach (inf
, from_tty
);
1662 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1663 where to collect the output. */
1666 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1671 if (inf
->attach_flag
)
1673 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1674 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1677 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1678 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1681 /* If necessary, make the user confirm that we should quit. Return
1682 non-zero if we should quit, zero if we shouldn't. */
1687 /* Don't even ask if we're only debugging a core file inferior. */
1688 if (!have_live_inferiors ())
1691 /* Build the query string as a single string. */
1694 stb
.puts (_("A debugging session is active.\n\n"));
1696 for (inferior
*inf
: all_inferiors ())
1697 print_inferior_quit_action (inf
, &stb
);
1699 stb
.puts (_("\nQuit anyway? "));
1701 return query ("%s", stb
.c_str ());
1704 /* Prepare to exit GDB cleanly by undoing any changes made to the
1705 terminal so that we leave the terminal in the state we acquired it. */
1708 undo_terminal_modifications_before_exit (void)
1710 struct ui
*saved_top_level
= current_ui
;
1712 target_terminal::ours ();
1714 current_ui
= main_ui
;
1719 gdb_disable_readline ();
1721 current_ui
= saved_top_level
;
1725 /* Quit without asking for confirmation. */
1728 quit_force (int *exit_arg
, int from_tty
)
1732 /* Clear the quit flag and sync_quit_force_run so that a
1733 gdb_exception_forced_quit isn't inadvertently triggered by a QUIT
1734 check while running the various cleanup/exit code below. Note
1735 that the call to 'check_quit_flag' clears the quit flag as a side
1738 sync_quit_force_run
= false;
1740 /* An optional expression may be used to cause gdb to terminate with the
1741 value of that expression. */
1743 exit_code
= *exit_arg
;
1744 else if (return_child_result
)
1745 exit_code
= return_child_result_value
;
1747 gdb::observers::gdb_exiting
.notify (exit_code
);
1749 undo_terminal_modifications_before_exit ();
1751 /* We want to handle any quit errors and exit regardless. */
1753 /* Get out of tfind mode, and kill or detach all inferiors. */
1756 disconnect_tracing ();
1757 for (inferior
*inf
: all_inferiors ())
1758 kill_or_detach (inf
, from_tty
);
1760 catch (const gdb_exception
&ex
)
1762 exception_print (gdb_stderr
, ex
);
1765 /* Give all pushed targets a chance to do minimal cleanup, and pop
1767 for (inferior
*inf
: all_inferiors ())
1771 inf
->pop_all_targets ();
1773 catch (const gdb_exception
&ex
)
1775 exception_print (gdb_stderr
, ex
);
1779 /* Save the history information if it is appropriate to do so. */
1782 if (write_history_p
&& !history_filename
.empty ())
1786 /* History is currently shared between all UIs. If there's
1787 any UI with a terminal, save history. */
1788 for (ui
*ui
: all_uis ())
1790 if (ui
->input_interactive_p ())
1798 gdb_safe_append_history ();
1801 catch (const gdb_exception
&ex
)
1803 exception_print (gdb_stderr
, ex
);
1806 /* Destroy any values currently allocated now instead of leaving it
1807 to global destructors, because that may be too late. For
1808 example, the destructors of xmethod values call into the Python
1809 runtime, which is finalized via a final cleanup. */
1812 /* Do any final cleanups before exiting. */
1815 do_final_cleanups ();
1817 catch (const gdb_exception
&ex
)
1819 exception_print (gdb_stderr
, ex
);
1827 auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1829 /* Implement the "show interactive-mode" option. */
1832 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1833 struct cmd_list_element
*c
,
1836 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1837 gdb_printf (file
, "Debugger's interactive mode "
1838 "is %s (currently %s).\n",
1839 value
, current_ui
->input_interactive_p () ? "on" : "off");
1841 gdb_printf (file
, "Debugger's interactive mode is %s.\n", value
);
1845 dont_repeat_command (const char *ignored
, int from_tty
)
1847 /* Can't call dont_repeat here because we're not necessarily reading
1849 *saved_command_line
= 0;
1852 /* Functions to manipulate command line editing control variables. */
1854 /* Number of commands to print in each call to show_commands. */
1855 #define Hist_print 10
1857 show_commands (const char *args
, int from_tty
)
1859 /* Index for history commands. Relative to history_base. */
1862 /* Number of the history entry which we are planning to display next.
1863 Relative to history_base. */
1866 /* Print out some of the commands from the command history. */
1870 if (args
[0] == '+' && args
[1] == '\0')
1871 /* "info editing +" should print from the stored position. */
1874 /* "info editing <exp>" should print around command number <exp>. */
1875 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1877 /* "show commands" means print the last Hist_print commands. */
1880 num
= history_length
- Hist_print
;
1886 /* If there are at least Hist_print commands, we want to display the last
1887 Hist_print rather than, say, the last 6. */
1888 if (history_length
- num
< Hist_print
)
1890 num
= history_length
- Hist_print
;
1896 offset
< num
+ Hist_print
&& offset
< history_length
;
1899 gdb_printf ("%5d %s\n", history_base
+ offset
,
1900 (history_get (history_base
+ offset
))->line
);
1903 /* The next command we want to display is the next one that we haven't
1907 /* If the user repeats this command with return, it should do what
1908 "show commands +" does. This is unnecessary if arg is null,
1909 because "show commands +" is not useful after "show commands". */
1910 if (from_tty
&& args
)
1911 set_repeat_arguments ("+");
1914 /* Update the size of our command history file to HISTORY_SIZE.
1916 A HISTORY_SIZE of -1 stands for unlimited. */
1919 set_readline_history_size (int history_size
)
1921 gdb_assert (history_size
>= -1);
1923 if (history_size
== -1)
1924 unstifle_history ();
1926 stifle_history (history_size
);
1929 /* Called by do_setshow_command. */
1931 set_history_size_command (const char *args
,
1932 int from_tty
, struct cmd_list_element
*c
)
1934 set_readline_history_size (history_size_setshow_var
);
1937 bool info_verbose
= false; /* Default verbose msgs off. */
1939 /* Called by do_set_command. An elaborate joke. */
1941 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1943 const char *cmdname
= "verbose";
1944 struct cmd_list_element
*showcmd
;
1946 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, NULL
, 1);
1947 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1949 if (c
->doc
&& c
->doc_allocated
)
1950 xfree ((char *) c
->doc
);
1951 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1952 xfree ((char *) showcmd
->doc
);
1955 c
->doc
= _("Set verbose printing of informational messages.");
1956 showcmd
->doc
= _("Show verbose printing of informational messages.");
1960 c
->doc
= _("Set verbosity.");
1961 showcmd
->doc
= _("Show verbosity.");
1963 c
->doc_allocated
= 0;
1964 showcmd
->doc_allocated
= 0;
1967 /* Init the history buffer. Note that we are called after the init file(s)
1968 have been read so that the user can change the history file via his
1969 .gdbinit file (for instance). The GDBHISTFILE environment variable
1970 overrides all of this. */
1977 tmpenv
= getenv ("GDBHISTSIZE");
1984 tmpenv
= skip_spaces (tmpenv
);
1986 var
= strtol (tmpenv
, &endptr
, 10);
1987 saved_errno
= errno
;
1988 endptr
= skip_spaces (endptr
);
1990 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1991 empty string, a negative number or a huge positive number (larger than
1992 INT_MAX) then set the history size to unlimited. Otherwise set our
1993 history size to the number we have read. This behavior is consistent
1994 with how bash handles HISTSIZE. */
1995 if (*endptr
!= '\0')
1997 else if (*tmpenv
== '\0'
2000 /* On targets where INT_MAX == LONG_MAX, we have to look at
2001 errno after calling strtol to distinguish between a value that
2002 is exactly INT_MAX and an overflowing value that was clamped
2004 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2005 history_size_setshow_var
= -1;
2007 history_size_setshow_var
= var
;
2010 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2012 if (history_size_setshow_var
== -2)
2013 history_size_setshow_var
= 256;
2015 set_readline_history_size (history_size_setshow_var
);
2017 if (!history_filename
.empty ())
2018 read_history (history_filename
.c_str ());
2022 show_prompt (struct ui_file
*file
, int from_tty
,
2023 struct cmd_list_element
*c
, const char *value
)
2025 gdb_printf (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2028 /* "set editing" command. */
2031 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2033 change_line_handler (set_editing_cmd_var
);
2034 /* Update the control variable so that MI's =cmd-param-changed event
2035 shows the correct value. */
2036 set_editing_cmd_var
= current_ui
->command_editing
;
2040 show_editing (struct ui_file
*file
, int from_tty
,
2041 struct cmd_list_element
*c
, const char *value
)
2043 gdb_printf (file
, _("Editing of command lines as "
2044 "they are typed is %s.\n"),
2045 current_ui
->command_editing
? _("on") : _("off"));
2049 show_annotation_level (struct ui_file
*file
, int from_tty
,
2050 struct cmd_list_element
*c
, const char *value
)
2052 gdb_printf (file
, _("Annotation_level is %s.\n"), value
);
2056 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2057 struct cmd_list_element
*c
, const char *value
)
2059 gdb_printf (file
, _("Notification of completion for "
2060 "asynchronous execution commands is %s.\n"),
2064 /* New values of the "data-directory" parameter are staged here.
2065 Extension languages, for example Python's gdb.parameter API, will read
2066 the value directory from this variable, so we must ensure that this
2067 always contains the correct value. */
2068 static std::string staged_gdb_datadir
;
2070 /* "set" command for the gdb_datadir configuration variable. */
2073 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2075 set_gdb_data_directory (staged_gdb_datadir
.c_str ());
2077 /* SET_GDB_DATA_DIRECTORY will resolve relative paths in
2078 STAGED_GDB_DATADIR, so we now copy the value from GDB_DATADIR
2079 back into STAGED_GDB_DATADIR so the extension languages can read the
2081 staged_gdb_datadir
= gdb_datadir
;
2083 gdb::observers::gdb_datadir_changed
.notify ();
2086 /* "show" command for the gdb_datadir configuration variable. */
2089 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2090 struct cmd_list_element
*c
, const char *value
)
2092 gdb_printf (file
, _("GDB's data directory is \"%ps\".\n"),
2093 styled_string (file_name_style
.style (),
2094 gdb_datadir
.c_str ()));
2097 /* Implement 'set history filename'. */
2100 set_history_filename (const char *args
,
2101 int from_tty
, struct cmd_list_element
*c
)
2103 /* We include the current directory so that if the user changes
2104 directories the file written will be the same as the one
2106 if (!history_filename
.empty ()
2107 && !IS_ABSOLUTE_PATH (history_filename
.c_str ()))
2108 history_filename
= gdb_abspath (history_filename
.c_str ());
2111 /* Whether we're in quiet startup mode. */
2113 static bool startup_quiet
;
2120 return startup_quiet
;
2123 /* Show whether GDB should start up in quiet mode. */
2126 show_startup_quiet (struct ui_file
*file
, int from_tty
,
2127 struct cmd_list_element
*c
, const char *value
)
2129 gdb_printf (file
, _("Whether to start up quietly is %s.\n"),
2136 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2137 the DEFAULT_PROMPT is. */
2138 set_prompt (DEFAULT_PROMPT
);
2140 /* Set the important stuff up for command editing. */
2141 command_editing_p
= 1;
2142 history_expansion_p
= 0;
2143 write_history_p
= 0;
2145 /* Setup important stuff for command line editing. */
2146 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2147 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2148 set_rl_completer_word_break_characters (default_word_break_characters ());
2149 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2150 rl_completion_display_matches_hook
= cli_display_match_list
;
2151 rl_readline_name
= "gdb";
2152 rl_terminal_name
= getenv ("TERM");
2153 rl_deprep_term_function
= gdb_rl_deprep_term_function
;
2155 /* The name for this defun comes from Bash, where it originated.
2156 15 is Control-o, the same binding this function has in Bash. */
2157 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2159 add_setshow_string_cmd ("prompt", class_support
,
2161 _("Set gdb's prompt."),
2162 _("Show gdb's prompt."),
2165 &setlist
, &showlist
);
2167 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2168 Don't repeat this command.\nPrimarily \
2169 used inside of user-defined commands that should not be repeated when\n\
2172 add_setshow_boolean_cmd ("editing", class_support
,
2173 &set_editing_cmd_var
, _("\
2174 Set editing of command lines as they are typed."), _("\
2175 Show editing of command lines as they are typed."), _("\
2176 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2177 Without an argument, command line editing is enabled. To edit, use\n\
2178 EMACS-like or VI-like commands like control-P or ESC."),
2181 &setlist
, &showlist
);
2183 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2184 Set saving of the history record on exit."), _("\
2185 Show saving of the history record on exit."), _("\
2186 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2187 Without an argument, saving is enabled."),
2189 show_write_history_p
,
2190 &sethistlist
, &showhistlist
);
2192 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2193 &history_size_setshow_var
, _("\
2194 Set the size of the command history."), _("\
2195 Show the size of the command history."), _("\
2196 This is the number of previous commands to keep a record of.\n\
2197 If set to \"unlimited\", the number of commands kept in the history\n\
2198 list is unlimited. This defaults to the value of the environment\n\
2199 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2200 set_history_size_command
,
2202 &sethistlist
, &showhistlist
);
2204 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2205 &history_remove_duplicates
, _("\
2206 Set how far back in history to look for and remove duplicate entries."), _("\
2207 Show how far back in history to look for and remove duplicate entries."), _("\
2208 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2209 and remove the first history entry that is a duplicate of the most recent\n\
2210 entry, each time a new history entry is added.\n\
2211 If set to \"unlimited\", this lookbehind is unbounded.\n\
2212 Only history entries added during this session are considered for removal.\n\
2213 If set to 0, removal of duplicate history entries is disabled.\n\
2214 By default this option is set to 0."),
2216 show_history_remove_duplicates
,
2217 &sethistlist
, &showhistlist
);
2219 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2220 Set the filename in which to record the command history."), _("\
2221 Show the filename in which to record the command history."), _("\
2222 (the list of previous commands of which a record is kept)."),
2223 set_history_filename
,
2224 show_history_filename
,
2225 &sethistlist
, &showhistlist
);
2227 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2228 Set whether to confirm potentially dangerous operations."), _("\
2229 Show whether to confirm potentially dangerous operations."), NULL
,
2232 &setlist
, &showlist
);
2234 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2235 Set annotation_level."), _("\
2236 Show annotation_level."), _("\
2237 0 == normal; 1 == fullname (for use when running under emacs)\n\
2238 2 == output annotated suitably for use by programs that control GDB."),
2240 show_annotation_level
,
2241 &setlist
, &showlist
);
2243 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2244 &exec_done_display_p
, _("\
2245 Set notification of completion for asynchronous execution commands."), _("\
2246 Show notification of completion for asynchronous execution commands."), _("\
2247 Use \"on\" to enable the notification, and \"off\" to disable it."),
2249 show_exec_done_display_p
,
2250 &setlist
, &showlist
);
2252 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2253 &staged_gdb_datadir
, _("Set GDB's data directory."),
2254 _("Show GDB's data directory."),
2256 When set, GDB uses the specified path to search for data files."),
2257 set_gdb_datadir
, show_gdb_datadir
,
2260 /* Prime the initial value for data-directory. */
2261 staged_gdb_datadir
= gdb_datadir
;
2263 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2264 &interactive_mode
, _("\
2265 Set whether GDB's standard input is a terminal."), _("\
2266 Show whether GDB's standard input is a terminal."), _("\
2267 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2268 means that GDB should wait for the user to answer queries associated to\n\
2269 commands entered at the command prompt. If off, GDB assumes that standard\n\
2270 input is not a terminal, and uses the default answer to all queries.\n\
2271 If auto (the default), determine which mode to use based on the standard\n\
2274 show_interactive_mode
,
2275 &setlist
, &showlist
);
2277 add_setshow_boolean_cmd ("startup-quietly", class_support
,
2278 &startup_quiet
, _("\
2279 Set whether GDB should start up quietly."), _(" \
2280 Show whether GDB should start up quietly."), _("\
2281 This setting will not affect the current session. Instead this command\n\
2282 should be added to the .gdbearlyinit file in the users home directory to\n\
2283 affect future GDB sessions."),
2286 &setlist
, &showlist
);
2288 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2289 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2290 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2291 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2292 set_internalvar_integer (major_version_var
, vmajor
);
2293 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2301 saved_command_line
= xstrdup ("");
2302 previous_saved_command_line
= xstrdup ("");
2304 /* Run the init function of each source file. */
2307 /* Make sure we return to the original directory upon exit, come
2308 what may, since the OS doesn't do that for us. */
2309 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2314 /* Here is where we call all the _initialize_foo routines. */
2315 initialize_all_files ();
2317 /* This creates the current_program_space. Do this after all the
2318 _initialize_foo routines have had a chance to install their
2319 per-sspace data keys. Also do this before
2320 initialize_current_architecture is called, because it accesses
2321 exec_bfd of the current program space. */
2322 initialize_progspace ();
2323 initialize_inferiors ();
2324 initialize_current_architecture ();
2325 init_main (); /* But that omits this file! Do it now. */
2327 initialize_stdin_serial ();
2329 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2331 set_initial_gdb_ttystate ();
2333 gdb_init_signals ();
2335 /* We need a default language for parsing expressions, so simple
2336 things like "set width 0" won't fail if no language is explicitly
2337 set in a config file or implicitly set by reading an executable
2339 set_language (language_c
);
2340 expected_language
= current_language
; /* Don't warn about the change. */
2343 void _initialize_top ();
2347 /* Determine a default value for the history filename. */
2348 const char *tmpenv
= getenv ("GDBHISTFILE");
2349 if (tmpenv
!= nullptr)
2350 history_filename
= tmpenv
;
2353 /* We include the current directory so that if the user changes
2354 directories the file written will be the same as the one
2357 /* No leading dots in file names are allowed on MSDOS. */
2358 const char *fname
= "_gdb_history";
2360 const char *fname
= ".gdb_history";
2363 history_filename
= gdb_abspath (fname
);