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/>. */
21 #include "cli/cli-cmds.h"
22 #include "cli/cli-script.h"
23 #include "cli/cli-setshow.h"
24 #include "cli/cli-decode.h"
30 #include "target-dcache.h"
31 #include "breakpoint.h"
33 #include "expression.h"
37 #include "gdbsupport/job-control.h"
39 #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/gdb_select.h"
54 #include "gdbsupport/scope-exit.h"
56 #include "gdbsupport/pathstuff.h"
57 #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"
79 # include "tui/tui-io.h"
86 extern void initialize_all_files (void);
88 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
89 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
90 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
92 /* Default command line prompt. This is overridden in some configs. */
94 #ifndef DEFAULT_PROMPT
95 #define DEFAULT_PROMPT "(gdb) "
99 current_ui_gdb_stdout_ptr ()
101 return ¤t_ui
->m_gdb_stdout
;
105 current_ui_gdb_stdin_ptr ()
107 return ¤t_ui
->m_gdb_stdin
;
111 current_ui_gdb_stderr_ptr ()
113 return ¤t_ui
->m_gdb_stderr
;
117 current_ui_gdb_stdlog_ptr ()
119 return ¤t_ui
->m_gdb_stdlog
;
123 current_ui_current_uiout_ptr ()
125 return ¤t_ui
->m_current_uiout
;
128 int inhibit_gdbinit
= 0;
130 /* Flag for whether we want to confirm potentially dangerous
131 operations. Default is yes. */
136 show_confirm (struct ui_file
*file
, int from_tty
,
137 struct cmd_list_element
*c
, const char *value
)
139 gdb_printf (file
, _("Whether to confirm potentially "
140 "dangerous operations is %s.\n"),
144 /* The last command line executed on the console. Used for command
145 repetitions when the user enters an empty line. */
147 static char *saved_command_line
;
149 /* If not NULL, the arguments that should be passed if
150 saved_command_line is repeated. */
152 static const char *repeat_arguments
;
154 /* The previous last command line executed on the console. Used for command
155 repetitions when a command wants to relaunch the previously launched
156 command. We need this as when a command is running, saved_command_line
157 already contains the line of the currently executing command. */
159 static char *previous_saved_command_line
;
161 /* If not NULL, the arguments that should be passed if the
162 previous_saved_command_line is repeated. */
164 static const char *previous_repeat_arguments
;
166 /* Nonzero if the current command is modified by "server ". This
167 affects things like recording into the command history, commands
168 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
169 whatever) can issue its own commands and also send along commands
170 from the user, and have the user not notice that the user interface
171 is issuing commands too. */
174 /* Timeout limit for response from target. */
176 /* The default value has been changed many times over the years. It
177 was originally 5 seconds. But that was thought to be a long time
178 to sit and wait, so it was changed to 2 seconds. That was thought
179 to be plenty unless the connection was going through some terminal
180 server or multiplexer or other form of hairy serial connection.
182 In mid-1996, remote_timeout was moved from remote.c to top.c and
183 it began being used in other remote-* targets. It appears that the
184 default was changed to 20 seconds at that time, perhaps because the
185 Renesas E7000 ICE didn't always respond in a timely manner.
187 But if 5 seconds is a long time to sit and wait for retransmissions,
188 20 seconds is far worse. This demonstrates the difficulty of using
189 a single variable for all protocol timeouts.
191 As remote.c is used much more than remote-e7000.c, it was changed
192 back to 2 seconds in 1999. */
194 int remote_timeout
= 2;
196 /* Sbrk location on entry to main. Used for statistics only. */
197 #ifdef HAVE_USEFUL_SBRK
201 /* Hooks for alternate command interfaces. */
203 /* This hook is called from within gdb's many mini-event loops which
204 could steal control from a real user interface's event loop. It
205 returns non-zero if the user is requesting a detach, zero
208 int (*deprecated_ui_loop_hook
) (int);
211 /* Called from print_frame_info to list the line we stopped in. */
213 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
217 /* Replaces most of query. */
219 int (*deprecated_query_hook
) (const char *, va_list);
221 /* These three functions support getting lines of text from the user.
222 They are used in sequence. First deprecated_readline_begin_hook is
223 called with a text string that might be (for example) a message for
224 the user to type in a sequence of commands to be executed at a
225 breakpoint. If this function calls back to a GUI, it might take
226 this opportunity to pop up a text interaction window with this
227 message. Next, deprecated_readline_hook is called with a prompt
228 that is emitted prior to collecting the user input. It can be
229 called multiple times. Finally, deprecated_readline_end_hook is
230 called to notify the GUI that we are done with the interaction
231 window and it can close it. */
233 void (*deprecated_readline_begin_hook
) (const char *, ...);
234 char *(*deprecated_readline_hook
) (const char *);
235 void (*deprecated_readline_end_hook
) (void);
237 /* Called as appropriate to notify the interface that we have attached
238 to or detached from an already running process. */
240 void (*deprecated_attach_hook
) (void);
241 void (*deprecated_detach_hook
) (void);
243 /* Used by UI as a wrapper around command execution. May do various
244 things like enabling/disabling buttons, etc... */
246 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
247 const char *cmd
, int from_tty
);
249 /* Called when the current thread changes. Argument is thread id. */
251 void (*deprecated_context_hook
) (int id
);
256 unbuffer_stream (FILE *stream
)
258 /* Unbuffer the input stream so that in gdb_readline_no_editing_callback,
259 the calls to fgetc fetch only one char at the time from STREAM.
261 This is important because gdb_readline_no_editing_callback will read
262 from STREAM up to the first '\n' character, after this GDB returns to
263 the event loop and relies on a select on STREAM indicating that more
266 If STREAM is buffered then the fgetc calls may have moved all the
267 pending input from the kernel into a local buffer, after which the
268 select will not indicate that more input is pending, and input after
269 the first '\n' will not be processed immediately.
271 Please ensure that any changes in this area run the MI tests with the
272 FORCE_SEPARATE_MI_TTY=1 flag being passed. */
275 /* With MS-Windows runtime, making stdin unbuffered when it's
276 connected to the terminal causes it to misbehave. */
277 if (!ISATTY (stream
))
278 setbuf (stream
, nullptr);
280 /* On GNU/Linux the issues described above can impact GDB even when
281 dealing with input from a terminal. For now we unbuffer the input
282 stream for everyone except MS-Windows. */
283 setbuf (stream
, nullptr);
287 /* Handler for SIGHUP. */
290 /* NOTE 1999-04-29: This function will be static again, once we modify
291 gdb to use the event loop as the default command loop and we merge
292 event-top.c into this file, top.c. */
296 /* Stop asking user for confirmation --- we're exiting. This
297 prevents asking the user dumb questions. */
299 quit_command ((char *) 0, 0);
301 #endif /* defined SIGHUP */
303 /* Line number we are currently in, in a file which is being sourced. */
304 /* NOTE 1999-04-29: This variable will be static again, once we modify
305 gdb to use the event loop as the default command loop and we merge
306 event-top.c into this file, top.c. */
307 /* static */ int source_line_number
;
309 /* Name of the file we are sourcing. */
310 /* NOTE 1999-04-29: This variable will be static again, once we modify
311 gdb to use the event loop as the default command loop and we merge
312 event-top.c into this file, top.c. */
313 /* static */ std::string source_file_name
;
315 /* Read commands from STREAM. */
317 read_command_file (FILE *stream
)
319 struct ui
*ui
= current_ui
;
321 unbuffer_stream (stream
);
323 scoped_restore save_instream
324 = make_scoped_restore (&ui
->instream
, stream
);
326 /* Read commands from `instream' and execute them until end of file
327 or error reading instream. */
329 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
331 /* Get a command-line. This calls the readline package. */
332 std::string command_buffer
;
334 = command_line_input (command_buffer
, nullptr, nullptr);
335 if (command
== nullptr)
337 command_handler (command
);
343 do_chdir_cleanup (void *old_dir
)
345 chdir ((const char *) old_dir
);
351 prepare_execute_command ()
353 /* With multiple threads running while the one we're examining is
354 stopped, the dcache can get stale without us being able to detect
355 it. For the duration of the command, though, use the dcache to
356 help things like backtrace. */
358 target_dcache_invalidate (current_program_space
->aspace
);
360 return scoped_value_mark ();
363 /* Tell the user if the language has changed (except first time) after
364 executing a command. */
367 check_frame_language_change (void)
369 static int warned
= 0;
370 frame_info_ptr frame
;
372 /* First make sure that a new frame has been selected, in case the
373 command or the hooks changed the program state. */
374 frame
= deprecated_safe_get_selected_frame ();
375 if (current_language
!= expected_language
)
377 if (language_mode
== language_mode_auto
&& info_verbose
)
379 /* Print what changed. */
385 /* Warn the user if the working language does not match the language
386 of the current frame. Only warn the user if we are actually
387 running the program, i.e. there is a stack. */
388 /* FIXME: This should be cacheing the frame and only running when
389 the frame changes. */
391 if (has_stack_frames ())
395 flang
= get_frame_language (frame
);
397 && flang
!= language_unknown
398 && flang
!= current_language
->la_language
)
400 gdb_printf ("%s\n", _(lang_frame_mismatch_warn
));
409 wait_sync_command_done (void)
411 /* Processing events may change the current UI. */
412 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
413 struct ui
*ui
= current_ui
;
415 /* We're about to wait until the target stops after having resumed
416 it so must force-commit resumptions, in case we're being called
417 in some context where a scoped_disable_commit_resumed object is
418 active. I.e., this function is a commit-resumed sync/flush
420 scoped_enable_commit_resumed
enable ("sync wait");
422 while (gdb_do_one_event () >= 0)
423 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
430 maybe_wait_sync_command_done (int was_sync
)
432 /* If the interpreter is in sync mode (we're running a user
433 command's list, running command hooks or similars), and we
434 just ran a synchronous command that started the target, wait
435 for that command to end. */
436 if (!current_ui
->async
438 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
439 wait_sync_command_done ();
445 set_repeat_arguments (const char *args
)
447 repeat_arguments
= args
;
450 /* Execute the line P as a command, in the current user context.
451 Pass FROM_TTY as second argument to the defining function. */
454 execute_command (const char *p
, int from_tty
)
456 struct cmd_list_element
*c
;
458 const char *cmd_start
= p
;
460 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
461 scoped_value_mark cleanup
= prepare_execute_command ();
463 /* This can happen when command_line_input hits end of file. */
466 cleanup_if_error
.release ();
470 std::string cmd_copy
= p
;
472 target_log_command (p
);
474 while (*p
== ' ' || *p
== '\t')
480 std::string default_args
;
481 std::string default_args_and_arg
;
482 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
486 /* If trace-commands is set then this will print this command. */
487 print_command_trace ("%s", p
);
489 c
= lookup_cmd (&cmd
, cmdlist
, "", &default_args
, 0, 1);
492 scoped_restore save_repeat_args
493 = make_scoped_restore (&repeat_arguments
, nullptr);
494 const char *args_pointer
= p
;
496 if (!default_args
.empty ())
499 default_args_and_arg
= default_args
+ ' ' + p
;
501 default_args_and_arg
= default_args
;
502 arg
= default_args_and_arg
.c_str ();
506 /* Pass null arg rather than an empty one. */
507 arg
= *p
== '\0' ? nullptr : p
;
510 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
511 while the is_complete_command(cfunc) test is just plain
512 bogus. They should both be replaced by a test of the form
513 c->strip_trailing_white_space_p. */
514 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
515 can't be replaced with func. This is because it is the
516 cfunc, and not the func, that has the value that the
517 is_complete_command hack is testing for. */
518 /* Clear off trailing whitespace, except for set and complete
520 std::string without_whitespace
;
522 && c
->type
!= set_cmd
523 && !is_complete_command (c
))
525 const char *old_end
= arg
+ strlen (arg
) - 1;
527 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
531 without_whitespace
= std::string (arg
, p
+ 1);
532 arg
= without_whitespace
.c_str ();
536 /* If this command has been pre-hooked, run the hook first. */
537 execute_cmd_pre_hook (c
);
539 if (c
->deprecated_warn_user
)
540 deprecated_cmd_warning (line
, cmdlist
);
542 /* c->user_commands would be NULL in the case of a python command. */
543 if (c
->theclass
== class_user
&& c
->user_commands
)
544 execute_user_command (c
, arg
);
545 else if (c
->theclass
== class_user
546 && c
->is_prefix () && !c
->allow_unknown
)
547 /* If this is a user defined prefix that does not allow unknown
548 (in other words, C is a prefix command and not a command
549 that can be followed by its args), report the list of
552 std::string prefixname
= c
->prefixname ();
553 std::string prefixname_no_space
554 = prefixname
.substr (0, prefixname
.length () - 1);
556 ("\"%s\" must be followed by the name of a subcommand.\n",
557 prefixname_no_space
.c_str ());
558 help_list (*c
->subcommands
, prefixname
.c_str (), all_commands
,
561 else if (c
->type
== set_cmd
)
562 do_set_command (arg
, from_tty
, c
);
563 else if (c
->type
== show_cmd
)
564 do_show_command (arg
, from_tty
, c
);
565 else if (c
->is_command_class_help ())
566 error (_("That is not a command, just a help topic."));
567 else if (deprecated_call_command_hook
)
568 deprecated_call_command_hook (c
, arg
, from_tty
);
570 cmd_func (c
, arg
, from_tty
);
572 maybe_wait_sync_command_done (was_sync
);
574 /* If this command has been post-hooked, run the hook last.
575 We need to lookup the command again since during its execution,
576 a command may redefine itself. In this case, C pointer
577 becomes invalid so we need to look it up again. */
578 const char *cmd2
= cmd_copy
.c_str ();
579 c
= lookup_cmd (&cmd2
, cmdlist
, "", nullptr, 1, 1);
581 execute_cmd_post_hook (c
);
583 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
585 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
586 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
591 /* Only perform the frame-language-change check if the command
592 we just finished executing did not resume the inferior's execution.
593 If it did resume the inferior, we will do that check after
594 the inferior stopped. */
595 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
596 check_frame_language_change ();
598 cleanup_if_error
.release ();
604 execute_fn_to_ui_file (struct ui_file
*file
, std::function
<void(void)> fn
)
606 /* GDB_STDOUT should be better already restored during these
607 restoration callbacks. */
608 set_batch_flag_and_restore_page_info save_page_info
;
610 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
613 ui_out_redirect_pop
redirect_popper (current_uiout
, file
);
615 scoped_restore save_stdout
616 = make_scoped_restore (&gdb_stdout
, file
);
617 scoped_restore save_stderr
618 = make_scoped_restore (&gdb_stderr
, file
);
619 scoped_restore save_stdlog
620 = make_scoped_restore (&gdb_stdlog
, file
);
621 scoped_restore save_stdtarg
622 = make_scoped_restore (&gdb_stdtarg
, file
);
623 scoped_restore save_stdtargerr
624 = make_scoped_restore (&gdb_stdtargerr
, file
);
633 execute_fn_to_string (std::string
&res
, std::function
<void(void)> fn
,
636 string_file
str_file (term_out
);
640 execute_fn_to_ui_file (&str_file
, fn
);
645 res
= str_file
.release ();
650 res
= str_file
.release ();
656 execute_command_to_ui_file (struct ui_file
*file
,
657 const char *p
, int from_tty
)
659 execute_fn_to_ui_file (file
, [=]() { execute_command (p
, from_tty
); });
665 execute_command_to_string (std::string
&res
, const char *p
, int from_tty
,
668 execute_fn_to_string (res
, [=]() { execute_command (p
, from_tty
); },
675 execute_command_to_string (const char *p
, int from_tty
,
679 execute_fn_to_string (dummy
, [=]() { execute_command (p
, from_tty
); },
683 /* When nonzero, cause dont_repeat to do nothing. This should only be
684 set via prevent_dont_repeat. */
686 static int suppress_dont_repeat
= 0;
693 struct ui
*ui
= current_ui
;
695 if (suppress_dont_repeat
|| server_command
)
698 /* If we aren't reading from standard input, we are saving the last
699 thing read from stdin in line and don't want to delete it. Null
700 lines won't repeat here in any case. */
701 if (ui
->instream
== ui
->stdin_stream
)
703 *saved_command_line
= 0;
704 repeat_arguments
= NULL
;
713 /* Do not repeat this command, as this command is a repeating command. */
716 /* We cannot free saved_command_line, as this line is being executed,
717 so swap it with previous_saved_command_line. */
718 std::swap (previous_saved_command_line
, saved_command_line
);
719 std::swap (previous_repeat_arguments
, repeat_arguments
);
721 const char *prev
= skip_spaces (get_saved_command_line ());
723 error (_("No previous command to relaunch"));
729 scoped_restore_tmpl
<int>
730 prevent_dont_repeat (void)
732 return make_scoped_restore (&suppress_dont_repeat
, 1);
738 get_saved_command_line ()
740 return saved_command_line
;
746 save_command_line (const char *cmd
)
748 xfree (previous_saved_command_line
);
749 previous_saved_command_line
= saved_command_line
;
750 previous_repeat_arguments
= repeat_arguments
;
751 saved_command_line
= xstrdup (cmd
);
752 repeat_arguments
= NULL
;
756 /* Read a line from the stream "instream" without command line editing.
758 It prints PROMPT once at the start.
759 Action is compatible with "readline", e.g. space for the result is
760 malloc'd and should be freed by the caller.
762 A NULL return means end of file. */
764 static gdb::unique_xmalloc_ptr
<char>
765 gdb_readline_no_editing (const char *prompt
)
767 std::string line_buffer
;
768 struct ui
*ui
= current_ui
;
769 /* Read from stdin if we are executing a user defined command. This
770 is the right thing for prompt_for_continue, at least. */
771 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
772 int fd
= fileno (stream
);
776 /* Don't use a _filtered function here. It causes the assumed
777 character position to be off, since the newline we read from
778 the user is not accounted for. */
779 printf_unfiltered ("%s", prompt
);
780 gdb_flush (gdb_stdout
);
790 /* Wait until at least one byte of data is available. Control-C
791 can interrupt interruptible_select, but not fgetc. */
793 FD_SET (fd
, &readfds
);
794 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
798 /* If this was ctrl-c, the QUIT above handles it. */
801 perror_with_name (("select"));
808 if (!line_buffer
.empty ())
809 /* The last line does not end with a newline. Return it, and
810 if we are called again fgetc will still return EOF and
811 we'll return NULL then. */
818 if (!line_buffer
.empty () && line_buffer
.back () == '\r')
819 line_buffer
.pop_back ();
826 return make_unique_xstrdup (line_buffer
.c_str ());
829 /* Variables which control command line editing and history
830 substitution. These variables are given default values at the end
832 static bool command_editing_p
;
834 /* NOTE 1999-04-29: This variable will be static again, once we modify
835 gdb to use the event loop as the default command loop and we merge
836 event-top.c into this file, top.c. */
838 /* static */ bool history_expansion_p
;
840 /* Should we write out the command history on exit? In order to write out
841 the history both this flag must be true, and the history_filename
842 variable must be set to something sensible. */
843 static bool write_history_p
;
845 /* The name of the file in which GDB history will be written. If this is
846 set to NULL, of the empty string then history will not be written. */
847 static std::string history_filename
;
849 /* Implement 'show history save'. */
851 show_write_history_p (struct ui_file
*file
, int from_tty
,
852 struct cmd_list_element
*c
, const char *value
)
854 if (!write_history_p
|| !history_filename
.empty ())
855 gdb_printf (file
, _("Saving of the history record on exit is %s.\n"),
858 gdb_printf (file
, _("Saving of the history is disabled due to "
859 "the value of 'history filename'.\n"));
862 /* The variable associated with the "set/show history size"
863 command. The value -1 means unlimited, and -2 means undefined. */
864 static int history_size_setshow_var
= -2;
867 show_history_size (struct ui_file
*file
, int from_tty
,
868 struct cmd_list_element
*c
, const char *value
)
870 gdb_printf (file
, _("The size of the command history is %s.\n"),
874 /* Variable associated with the "history remove-duplicates" option.
875 The value -1 means unlimited. */
876 static int history_remove_duplicates
= 0;
879 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
880 struct cmd_list_element
*c
, const char *value
)
883 _("The number of history entries to look back at for "
884 "duplicates is %s.\n"),
888 /* Implement 'show history filename'. */
890 show_history_filename (struct ui_file
*file
, int from_tty
,
891 struct cmd_list_element
*c
, const char *value
)
893 if (!history_filename
.empty ())
894 gdb_printf (file
, _("The filename in which to record "
895 "the command history is \"%ps\".\n"),
896 styled_string (file_name_style
.style (), value
));
898 gdb_printf (file
, _("There is no filename currently set for "
899 "recording the command history in.\n"));
902 /* This is like readline(), but it has some gdb-specific behavior.
903 gdb may want readline in both the synchronous and async modes during
904 a single gdb invocation. At the ordinary top-level prompt we might
905 be using the async readline. That means we can't use
906 rl_pre_input_hook, since it doesn't work properly in async mode.
907 However, for a secondary prompt (" >", such as occurs during a
908 `define'), gdb wants a synchronous response.
910 We used to call readline() directly, running it in synchronous
911 mode. But mixing modes this way is not supported, and as of
912 readline 5.x it no longer works; the arrow keys come unbound during
913 the synchronous call. So we make a nested call into the event
914 loop. That's what gdb_readline_wrapper is for. */
916 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
917 rely on gdb_readline_wrapper_result, which might still be NULL if
918 the user types Control-D for EOF. */
919 static int gdb_readline_wrapper_done
;
921 /* The result of the current call to gdb_readline_wrapper, once a newline
923 static char *gdb_readline_wrapper_result
;
925 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
926 to be called after the newline is processed (which will redisplay
927 the prompt). But in gdb_readline_wrapper we will not get a new
928 prompt until the next call, or until we return to the event loop.
929 So we disable this hook around the newline and restore it before we
931 static void (*saved_after_char_processing_hook
) (void);
937 gdb_in_secondary_prompt_p (struct ui
*ui
)
939 return ui
->secondary_prompt_depth
> 0;
943 /* This function is called when readline has seen a complete line of
947 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
949 gdb_assert (!gdb_readline_wrapper_done
);
950 gdb_readline_wrapper_result
= line
.release ();
951 gdb_readline_wrapper_done
= 1;
953 /* Prevent operate-and-get-next from acting too early. */
954 saved_after_char_processing_hook
= after_char_processing_hook
;
955 after_char_processing_hook
= NULL
;
959 tui_inject_newline_into_command_window ();
962 /* Prevent parts of the prompt from being redisplayed if annotations
963 are enabled, and readline's state getting out of sync. We'll
964 reinstall the callback handler, which puts the terminal in raw
965 mode (or in readline lingo, in prepped state), when we're next
966 ready to process user input, either in display_gdb_prompt, or if
967 we're handling an asynchronous target event and running in the
968 background, just before returning to the event loop to process
969 further input (or more target events). */
970 if (current_ui
->command_editing
)
971 gdb_rl_callback_handler_remove ();
974 class gdb_readline_wrapper_cleanup
977 gdb_readline_wrapper_cleanup ()
978 : m_handler_orig (current_ui
->input_handler
),
979 m_already_prompted_orig (current_ui
->command_editing
980 ? rl_already_prompted
: 0),
981 m_target_is_async_orig (target_is_async_p ()),
982 m_save_ui (¤t_ui
)
984 current_ui
->input_handler
= gdb_readline_wrapper_line
;
985 current_ui
->secondary_prompt_depth
++;
987 if (m_target_is_async_orig
)
988 target_async (false);
991 ~gdb_readline_wrapper_cleanup ()
993 struct ui
*ui
= current_ui
;
995 if (ui
->command_editing
)
996 rl_already_prompted
= m_already_prompted_orig
;
998 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
999 ui
->input_handler
= m_handler_orig
;
1001 /* Don't restore our input handler in readline yet. That would make
1002 readline prep the terminal (putting it in raw mode), while the
1003 line we just read may trigger execution of a command that expects
1004 the terminal in the default cooked/canonical mode, such as e.g.,
1005 running Python's interactive online help utility. See
1006 gdb_readline_wrapper_line for when we'll reinstall it. */
1008 gdb_readline_wrapper_result
= NULL
;
1009 gdb_readline_wrapper_done
= 0;
1010 ui
->secondary_prompt_depth
--;
1011 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1013 after_char_processing_hook
= saved_after_char_processing_hook
;
1014 saved_after_char_processing_hook
= NULL
;
1016 if (m_target_is_async_orig
)
1017 target_async (true);
1020 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1024 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1025 int m_already_prompted_orig
;
1027 /* Whether the target was async. */
1028 int m_target_is_async_orig
;
1030 /* Processing events may change the current UI. */
1031 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1035 gdb_readline_wrapper (const char *prompt
)
1037 struct ui
*ui
= current_ui
;
1039 gdb_readline_wrapper_cleanup cleanup
;
1041 /* Display our prompt and prevent double prompt display. Don't pass
1042 down a NULL prompt, since that has special meaning for
1043 display_gdb_prompt -- it indicates a request to print the primary
1044 prompt, while we want a secondary prompt here. */
1045 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1046 if (ui
->command_editing
)
1047 rl_already_prompted
= 1;
1049 if (after_char_processing_hook
)
1050 (*after_char_processing_hook
) ();
1051 gdb_assert (after_char_processing_hook
== NULL
);
1053 while (gdb_do_one_event () >= 0)
1054 if (gdb_readline_wrapper_done
)
1057 return gdb_readline_wrapper_result
;
1061 /* The current saved history number from operate-and-get-next.
1062 This is -1 if not valid. */
1063 static int operate_saved_history
= -1;
1065 /* This is put on the appropriate hook and helps operate-and-get-next
1068 gdb_rl_operate_and_get_next_completion (void)
1070 int delta
= where_history () - operate_saved_history
;
1072 /* The `key' argument to rl_get_previous_history is ignored. */
1073 rl_get_previous_history (delta
, 0);
1074 operate_saved_history
= -1;
1076 /* readline doesn't automatically update the display for us. */
1079 after_char_processing_hook
= NULL
;
1080 rl_pre_input_hook
= NULL
;
1083 /* This is a gdb-local readline command handler. It accepts the
1084 current command line (like RET does) and, if this command was taken
1085 from the history, arranges for the next command in the history to
1086 appear on the command line when the prompt returns.
1087 We ignore the arguments. */
1089 gdb_rl_operate_and_get_next (int count
, int key
)
1093 /* Use the async hook. */
1094 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1096 /* Find the current line, and find the next line to use. */
1097 where
= where_history();
1099 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1100 || (where
>= history_length
- 1))
1101 operate_saved_history
= where
;
1103 operate_saved_history
= where
+ 1;
1105 return rl_newline (1, key
);
1108 /* Number of user commands executed during this session. */
1110 static int command_count
= 0;
1112 /* Add the user command COMMAND to the input history list. */
1115 gdb_add_history (const char *command
)
1119 if (history_remove_duplicates
!= 0)
1122 int lookbehind_threshold
;
1124 /* The lookbehind threshold for finding a duplicate history entry is
1125 bounded by command_count because we can't meaningfully delete
1126 history entries that are already stored in the history file since
1127 the history file is appended to. */
1128 if (history_remove_duplicates
== -1
1129 || history_remove_duplicates
> command_count
)
1130 lookbehind_threshold
= command_count
;
1132 lookbehind_threshold
= history_remove_duplicates
;
1135 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1137 HIST_ENTRY
*temp
= previous_history ();
1142 if (strcmp (temp
->line
, command
) == 0)
1144 HIST_ENTRY
*prev
= remove_history (where_history ());
1146 free_history_entry (prev
);
1153 add_history (command
);
1156 /* Safely append new history entries to the history file in a corruption-free
1157 way using an intermediate local history file. */
1160 gdb_safe_append_history (void)
1162 int ret
, saved_errno
;
1164 std::string local_history_filename
1165 = string_printf ("%s-gdb%ld~", history_filename
.c_str (), (long) getpid ());
1167 ret
= rename (history_filename
.c_str (), local_history_filename
.c_str ());
1168 saved_errno
= errno
;
1169 if (ret
< 0 && saved_errno
!= ENOENT
)
1171 warning (_("Could not rename %ps to %ps: %s"),
1172 styled_string (file_name_style
.style (),
1173 history_filename
.c_str ()),
1174 styled_string (file_name_style
.style (),
1175 local_history_filename
.c_str ()),
1176 safe_strerror (saved_errno
));
1182 /* If the rename failed with ENOENT then either the global history
1183 file never existed in the first place or another GDB process is
1184 currently appending to it (and has thus temporarily renamed it).
1185 Since we can't distinguish between these two cases, we have to
1186 conservatively assume the first case and therefore must write out
1187 (not append) our known history to our local history file and try
1188 to move it back anyway. Otherwise a global history file would
1189 never get created! */
1190 gdb_assert (saved_errno
== ENOENT
);
1191 write_history (local_history_filename
.c_str ());
1195 append_history (command_count
, local_history_filename
.c_str ());
1196 if (history_is_stifled ())
1197 history_truncate_file (local_history_filename
.c_str (),
1198 history_max_entries
);
1201 ret
= rename (local_history_filename
.c_str (), history_filename
.c_str ());
1202 saved_errno
= errno
;
1203 if (ret
< 0 && saved_errno
!= EEXIST
)
1204 warning (_("Could not rename %s to %s: %s"),
1205 local_history_filename
.c_str (), history_filename
.c_str (),
1206 safe_strerror (saved_errno
));
1210 /* Read one line from the command input stream `instream'.
1212 CMD_LINE_BUFFER is a buffer that the function may use to store the result, if
1213 it needs to be dynamically-allocated. Otherwise, it is unused.string
1215 Return nullptr for end of file.
1217 This routine either uses fancy command line editing or simple input
1218 as the user has requested. */
1221 command_line_input (std::string
&cmd_line_buffer
, const char *prompt_arg
,
1222 const char *annotation_suffix
)
1224 struct ui
*ui
= current_ui
;
1225 const char *prompt
= prompt_arg
;
1227 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1229 /* The annotation suffix must be non-NULL. */
1230 if (annotation_suffix
== NULL
)
1231 annotation_suffix
= "";
1233 if (from_tty
&& annotation_level
> 1)
1238 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1239 + strlen (annotation_suffix
) + 40);
1241 local_prompt
[0] = '\0';
1243 strcpy (local_prompt
, prompt
);
1244 strcat (local_prompt
, "\n\032\032");
1245 strcat (local_prompt
, annotation_suffix
);
1246 strcat (local_prompt
, "\n");
1248 prompt
= local_prompt
;
1253 signal (SIGTSTP
, handle_sigtstp
);
1258 gdb::unique_xmalloc_ptr
<char> rl
;
1260 /* Make sure that all output has been output. Some machines may
1261 let you get away with leaving out some of the gdb_flush, but
1263 gdb_flush (gdb_stdout
);
1264 gdb_flush (gdb_stderr
);
1266 if (!source_file_name
.empty ())
1267 ++source_line_number
;
1269 if (from_tty
&& annotation_level
> 1)
1270 printf_unfiltered ("\n\032\032pre-%s\n", annotation_suffix
);
1272 /* Don't use fancy stuff if not talking to stdin. */
1273 if (deprecated_readline_hook
1275 && current_ui
->input_interactive_p ())
1277 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1279 else if (command_editing_p
1281 && current_ui
->input_interactive_p ())
1283 rl
.reset (gdb_readline_wrapper (prompt
));
1287 rl
= gdb_readline_no_editing (prompt
);
1290 cmd
= handle_line_of_input (cmd_line_buffer
, rl
.get (),
1291 0, annotation_suffix
);
1292 if (cmd
== (char *) EOF
)
1300 /* Got partial input. I.e., got a line that ends with a
1301 continuation character (backslash). Suppress printing the
1308 signal (SIGTSTP
, SIG_DFL
);
1316 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1318 /* From GNU coding standards, first line is meant to be easy for a
1319 program to parse, and is just canonical program name and version
1320 number, which starts after last space. */
1322 std::string v_str
= string_printf ("GNU gdb %s%s", PKGVERSION
, version
);
1323 gdb_printf (stream
, "%ps\n",
1324 styled_string (version_style
.style (), v_str
.c_str ()));
1326 /* Second line is a copyright notice. */
1329 "Copyright (C) 2024 Free Software Foundation, Inc.\n");
1331 /* Following the copyright is a brief statement that the program is
1332 free software, that users are free to copy and change it on
1333 certain conditions, that it is covered by the GNU GPL, and that
1334 there is no warranty. */
1336 gdb_printf (stream
, "\
1337 License GPLv3+: GNU GPL version 3 or later <%ps>\
1338 \nThis is free software: you are free to change and redistribute it.\n\
1339 There is NO WARRANTY, to the extent permitted by law.",
1340 styled_string (file_name_style
.style (),
1341 "http://gnu.org/licenses/gpl.html"));
1346 gdb_printf (stream
, ("\nType \"show copying\" and "
1347 "\"show warranty\" for details.\n"));
1349 /* After the required info we print the configuration information. */
1351 gdb_printf (stream
, "This GDB was configured as \"");
1352 if (strcmp (host_name
, target_name
) != 0)
1354 gdb_printf (stream
, "--host=%s --target=%s",
1355 host_name
, target_name
);
1359 gdb_printf (stream
, "%s", host_name
);
1361 gdb_printf (stream
, "\".\n");
1363 gdb_printf (stream
, _("Type \"show configuration\" "
1364 "for configuration details.\n"));
1366 if (REPORT_BUGS_TO
[0])
1369 _("For bug reporting instructions, please see:\n"));
1370 gdb_printf (stream
, "%ps.\n",
1371 styled_string (file_name_style
.style (),
1375 _("Find the GDB manual and other documentation \
1376 resources online at:\n <%ps>."),
1377 styled_string (file_name_style
.style (),
1378 "http://www.gnu.org/software/gdb/documentation/"));
1379 gdb_printf (stream
, "\n\n");
1380 gdb_printf (stream
, _("For help, type \"help\".\n"));
1382 _("Type \"apropos word\" to search for commands \
1383 related to \"word\"."));
1386 /* Print the details of GDB build-time configuration. */
1388 print_gdb_configuration (struct ui_file
*stream
)
1390 gdb_printf (stream
, _("\
1391 This GDB was configured as follows:\n\
1392 configure --host=%s --target=%s\n\
1393 "), host_name
, target_name
);
1395 gdb_printf (stream
, _("\
1396 --with-auto-load-dir=%s\n\
1397 --with-auto-load-safe-path=%s\n\
1398 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1401 gdb_printf (stream
, _("\
1405 gdb_printf (stream
, _("\
1411 gdb_printf (stream
, _("\
1412 --with-gdb-datadir=%s%s\n\
1413 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1416 gdb_printf (stream
, _("\
1417 --with-iconv-bin=%s%s\n\
1418 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1421 if (JIT_READER_DIR
[0])
1422 gdb_printf (stream
, _("\
1423 --with-jit-reader-dir=%s%s\n\
1424 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1426 #if HAVE_LIBUNWIND_IA64_H
1427 gdb_printf (stream
, _("\
1428 --with-libunwind-ia64\n\
1431 gdb_printf (stream
, _("\
1432 --without-libunwind-ia64\n\
1437 gdb_printf (stream
, _("\
1441 gdb_printf (stream
, _("\
1446 #if HAVE_LIBBABELTRACE
1447 gdb_printf (stream
, _("\
1448 --with-babeltrace\n\
1451 gdb_printf (stream
, _("\
1452 --without-babeltrace\n\
1457 gdb_printf (stream
, _("\
1461 gdb_printf (stream
, _("\
1462 --without-intel-pt\n\
1467 gdb_printf (stream
, _("\
1471 gdb_printf (stream
, _("\
1475 #ifdef WITH_PYTHON_PATH
1476 gdb_printf (stream
, _("\
1477 --with-python=%s%s\n\
1478 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1480 gdb_printf (stream
, _("\
1484 #ifdef WITH_PYTHON_LIBDIR
1485 gdb_printf (stream
, _("\
1486 --with-python-libdir=%s%s\n\
1487 "), WITH_PYTHON_LIBDIR
, PYTHON_LIBDIR_RELOCATABLE
? " (relocatable)" : "");
1489 gdb_printf (stream
, _("\
1490 --without-python-libdir\n\
1494 #if HAVE_LIBDEBUGINFOD
1495 gdb_printf (stream
, _("\
1496 --with-debuginfod\n\
1499 gdb_printf (stream
, _("\
1500 --without-debuginfod\n\
1505 gdb_printf (stream
, _("\
1509 gdb_printf (stream
, _("\
1515 gdb_printf (stream
, _("\
1519 gdb_printf (stream
, _("\
1525 gdb_printf (stream
, _("\
1526 --with-amd-dbgapi\n\
1529 gdb_printf (stream
, _("\
1530 --without-amd-dbgapi\n\
1534 #if HAVE_SOURCE_HIGHLIGHT
1535 gdb_printf (stream
, _("\
1536 --enable-source-highlight\n\
1539 gdb_printf (stream
, _("\
1540 --disable-source-highlight\n\
1545 gdb_printf (stream
, _("\
1546 --enable-threading\n\
1549 gdb_printf (stream
, _("\
1550 --disable-threading\n\
1555 gdb_printf (stream
, _("\
1559 gdb_printf (stream
, _("\
1564 #ifdef HAVE_READLINE_READLINE_H
1565 gdb_printf (stream
, _("\
1566 --with-system-readline\n\
1569 gdb_printf (stream
, _("\
1570 --without-system-readline\n\
1575 gdb_printf (stream
, _("\
1576 --with-relocated-sources=%s\n\
1581 gdb_printf (stream
, _("\
1582 --with-separate-debug-dir=%s%s\n\
1583 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1585 #ifdef ADDITIONAL_DEBUG_DIRS
1586 gdb_printf (stream
, _ ("\
1587 --with-additional-debug-dirs=%s\n\
1588 "), ADDITIONAL_DEBUG_DIRS
);
1591 if (TARGET_SYSTEM_ROOT
[0])
1592 gdb_printf (stream
, _("\
1593 --with-sysroot=%s%s\n\
1594 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1596 if (SYSTEM_GDBINIT
[0])
1597 gdb_printf (stream
, _("\
1598 --with-system-gdbinit=%s%s\n\
1599 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1601 if (SYSTEM_GDBINIT_DIR
[0])
1602 gdb_printf (stream
, _("\
1603 --with-system-gdbinit-dir=%s%s\n\
1604 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1606 /* We assume "relocatable" will be printed at least once, thus we always
1607 print this text. It's a reasonably safe assumption for now. */
1608 gdb_printf (stream
, _("\n\
1609 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1610 tree, and GDB will still find it.)\n\
1615 /* The current top level prompt, settable with "set prompt", and/or
1616 with the python `gdb.prompt_hook' hook. */
1617 static std::string top_prompt
;
1619 /* Access method for the GDB prompt string. */
1627 /* Set method for the GDB prompt string. */
1630 set_prompt (const char *s
)
1636 /* Kills or detaches the given inferior, depending on how we originally
1637 gained control of it. */
1640 kill_or_detach (inferior
*inf
, int from_tty
)
1645 thread_info
*thread
= any_thread_of_inferior (inf
);
1648 switch_to_thread (thread
);
1650 /* Leave core files alone. */
1651 if (target_has_execution ())
1653 if (inf
->attach_flag
)
1654 target_detach (inf
, from_tty
);
1661 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1662 where to collect the output. */
1665 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1670 if (inf
->attach_flag
)
1672 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1673 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1676 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1677 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1680 /* If necessary, make the user confirm that we should quit. Return
1681 non-zero if we should quit, zero if we shouldn't. */
1686 /* Don't even ask if we're only debugging a core file inferior. */
1687 if (!have_live_inferiors ())
1690 /* Build the query string as a single string. */
1693 stb
.puts (_("A debugging session is active.\n\n"));
1695 for (inferior
*inf
: all_inferiors ())
1696 print_inferior_quit_action (inf
, &stb
);
1698 stb
.puts (_("\nQuit anyway? "));
1700 return query ("%s", stb
.c_str ());
1703 /* Prepare to exit GDB cleanly by undoing any changes made to the
1704 terminal so that we leave the terminal in the state we acquired it. */
1707 undo_terminal_modifications_before_exit (void)
1709 struct ui
*saved_top_level
= current_ui
;
1711 target_terminal::ours ();
1713 current_ui
= main_ui
;
1718 gdb_disable_readline ();
1720 current_ui
= saved_top_level
;
1724 /* Quit without asking for confirmation. */
1727 quit_force (int *exit_arg
, int from_tty
)
1731 /* Clear the quit flag and sync_quit_force_run so that a
1732 gdb_exception_forced_quit isn't inadvertently triggered by a QUIT
1733 check while running the various cleanup/exit code below. Note
1734 that the call to 'check_quit_flag' clears the quit flag as a side
1737 sync_quit_force_run
= false;
1739 /* An optional expression may be used to cause gdb to terminate with the
1740 value of that expression. */
1742 exit_code
= *exit_arg
;
1743 else if (return_child_result
)
1744 exit_code
= return_child_result_value
;
1746 gdb::observers::gdb_exiting
.notify (exit_code
);
1748 undo_terminal_modifications_before_exit ();
1750 /* We want to handle any quit errors and exit regardless. */
1752 /* Get out of tfind mode, and kill or detach all inferiors. */
1755 disconnect_tracing ();
1756 for (inferior
*inf
: all_inferiors ())
1757 kill_or_detach (inf
, from_tty
);
1759 catch (const gdb_exception
&ex
)
1761 exception_print (gdb_stderr
, ex
);
1764 /* Give all pushed targets a chance to do minimal cleanup, and pop
1766 for (inferior
*inf
: all_inferiors ())
1770 inf
->pop_all_targets ();
1772 catch (const gdb_exception
&ex
)
1774 exception_print (gdb_stderr
, ex
);
1778 /* Save the history information if it is appropriate to do so. */
1781 if (write_history_p
&& !history_filename
.empty ())
1785 /* History is currently shared between all UIs. If there's
1786 any UI with a terminal, save history. */
1787 for (ui
*ui
: all_uis ())
1789 if (ui
->input_interactive_p ())
1797 gdb_safe_append_history ();
1800 catch (const gdb_exception
&ex
)
1802 exception_print (gdb_stderr
, ex
);
1805 /* Do any final cleanups before exiting. */
1808 do_final_cleanups ();
1810 catch (const gdb_exception
&ex
)
1812 exception_print (gdb_stderr
, ex
);
1815 ext_lang_shutdown ();
1822 auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1824 /* Implement the "show interactive-mode" option. */
1827 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1828 struct cmd_list_element
*c
,
1831 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1832 gdb_printf (file
, "Debugger's interactive mode "
1833 "is %s (currently %s).\n",
1834 value
, current_ui
->input_interactive_p () ? "on" : "off");
1836 gdb_printf (file
, "Debugger's interactive mode is %s.\n", value
);
1840 dont_repeat_command (const char *ignored
, int from_tty
)
1842 /* Can't call dont_repeat here because we're not necessarily reading
1844 *saved_command_line
= 0;
1847 /* Functions to manipulate command line editing control variables. */
1849 /* Number of commands to print in each call to show_commands. */
1850 #define Hist_print 10
1852 show_commands (const char *args
, int from_tty
)
1854 /* Index for history commands. Relative to history_base. */
1857 /* Number of the history entry which we are planning to display next.
1858 Relative to history_base. */
1861 /* Print out some of the commands from the command history. */
1865 if (args
[0] == '+' && args
[1] == '\0')
1866 /* "info editing +" should print from the stored position. */
1869 /* "info editing <exp>" should print around command number <exp>. */
1870 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1872 /* "show commands" means print the last Hist_print commands. */
1875 num
= history_length
- Hist_print
;
1881 /* If there are at least Hist_print commands, we want to display the last
1882 Hist_print rather than, say, the last 6. */
1883 if (history_length
- num
< Hist_print
)
1885 num
= history_length
- Hist_print
;
1891 offset
< num
+ Hist_print
&& offset
< history_length
;
1894 gdb_printf ("%5d %s\n", history_base
+ offset
,
1895 (history_get (history_base
+ offset
))->line
);
1898 /* The next command we want to display is the next one that we haven't
1902 /* If the user repeats this command with return, it should do what
1903 "show commands +" does. This is unnecessary if arg is null,
1904 because "show commands +" is not useful after "show commands". */
1905 if (from_tty
&& args
)
1906 set_repeat_arguments ("+");
1909 /* Update the size of our command history file to HISTORY_SIZE.
1911 A HISTORY_SIZE of -1 stands for unlimited. */
1914 set_readline_history_size (int history_size
)
1916 gdb_assert (history_size
>= -1);
1918 if (history_size
== -1)
1919 unstifle_history ();
1921 stifle_history (history_size
);
1924 /* Called by do_setshow_command. */
1926 set_history_size_command (const char *args
,
1927 int from_tty
, struct cmd_list_element
*c
)
1929 set_readline_history_size (history_size_setshow_var
);
1932 bool info_verbose
= false; /* Default verbose msgs off. */
1934 /* Called by do_set_command. An elaborate joke. */
1936 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1938 const char *cmdname
= "verbose";
1939 struct cmd_list_element
*showcmd
;
1941 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, NULL
, 1);
1942 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1944 if (c
->doc
&& c
->doc_allocated
)
1945 xfree ((char *) c
->doc
);
1946 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1947 xfree ((char *) showcmd
->doc
);
1950 c
->doc
= _("Set verbose printing of informational messages.");
1951 showcmd
->doc
= _("Show verbose printing of informational messages.");
1955 c
->doc
= _("Set verbosity.");
1956 showcmd
->doc
= _("Show verbosity.");
1958 c
->doc_allocated
= 0;
1959 showcmd
->doc_allocated
= 0;
1962 /* Init the history buffer. Note that we are called after the init file(s)
1963 have been read so that the user can change the history file via his
1964 .gdbinit file (for instance). The GDBHISTFILE environment variable
1965 overrides all of this. */
1972 tmpenv
= getenv ("GDBHISTSIZE");
1979 tmpenv
= skip_spaces (tmpenv
);
1981 var
= strtol (tmpenv
, &endptr
, 10);
1982 saved_errno
= errno
;
1983 endptr
= skip_spaces (endptr
);
1985 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1986 empty string, a negative number or a huge positive number (larger than
1987 INT_MAX) then set the history size to unlimited. Otherwise set our
1988 history size to the number we have read. This behavior is consistent
1989 with how bash handles HISTSIZE. */
1990 if (*endptr
!= '\0')
1992 else if (*tmpenv
== '\0'
1995 /* On targets where INT_MAX == LONG_MAX, we have to look at
1996 errno after calling strtol to distinguish between a value that
1997 is exactly INT_MAX and an overflowing value that was clamped
1999 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2000 history_size_setshow_var
= -1;
2002 history_size_setshow_var
= var
;
2005 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2007 if (history_size_setshow_var
== -2)
2008 history_size_setshow_var
= 256;
2010 set_readline_history_size (history_size_setshow_var
);
2012 if (!history_filename
.empty ())
2013 read_history (history_filename
.c_str ());
2017 show_prompt (struct ui_file
*file
, int from_tty
,
2018 struct cmd_list_element
*c
, const char *value
)
2020 gdb_printf (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2023 /* "set editing" command. */
2026 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2028 change_line_handler (set_editing_cmd_var
);
2029 /* Update the control variable so that MI's =cmd-param-changed event
2030 shows the correct value. */
2031 set_editing_cmd_var
= current_ui
->command_editing
;
2035 show_editing (struct ui_file
*file
, int from_tty
,
2036 struct cmd_list_element
*c
, const char *value
)
2038 gdb_printf (file
, _("Editing of command lines as "
2039 "they are typed is %s.\n"),
2040 current_ui
->command_editing
? _("on") : _("off"));
2044 show_annotation_level (struct ui_file
*file
, int from_tty
,
2045 struct cmd_list_element
*c
, const char *value
)
2047 gdb_printf (file
, _("Annotation_level is %s.\n"), value
);
2051 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2052 struct cmd_list_element
*c
, const char *value
)
2054 gdb_printf (file
, _("Notification of completion for "
2055 "asynchronous execution commands is %s.\n"),
2059 /* New values of the "data-directory" parameter are staged here.
2060 Extension languages, for example Python's gdb.parameter API, will read
2061 the value directory from this variable, so we must ensure that this
2062 always contains the correct value. */
2063 static std::string staged_gdb_datadir
;
2065 /* "set" command for the gdb_datadir configuration variable. */
2068 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2070 set_gdb_data_directory (staged_gdb_datadir
.c_str ());
2072 /* SET_GDB_DATA_DIRECTORY will resolve relative paths in
2073 STAGED_GDB_DATADIR, so we now copy the value from GDB_DATADIR
2074 back into STAGED_GDB_DATADIR so the extension languages can read the
2076 staged_gdb_datadir
= gdb_datadir
;
2078 gdb::observers::gdb_datadir_changed
.notify ();
2081 /* "show" command for the gdb_datadir configuration variable. */
2084 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2085 struct cmd_list_element
*c
, const char *value
)
2087 gdb_printf (file
, _("GDB's data directory is \"%ps\".\n"),
2088 styled_string (file_name_style
.style (),
2089 gdb_datadir
.c_str ()));
2092 /* Implement 'set history filename'. */
2095 set_history_filename (const char *args
,
2096 int from_tty
, struct cmd_list_element
*c
)
2098 /* We include the current directory so that if the user changes
2099 directories the file written will be the same as the one
2101 if (!history_filename
.empty ()
2102 && !IS_ABSOLUTE_PATH (history_filename
.c_str ()))
2103 history_filename
= gdb_abspath (history_filename
.c_str ());
2106 /* Whether we're in quiet startup mode. */
2108 static bool startup_quiet
;
2115 return startup_quiet
;
2118 /* Show whether GDB should start up in quiet mode. */
2121 show_startup_quiet (struct ui_file
*file
, int from_tty
,
2122 struct cmd_list_element
*c
, const char *value
)
2124 gdb_printf (file
, _("Whether to start up quietly is %s.\n"),
2131 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2132 the DEFAULT_PROMPT is. */
2133 set_prompt (DEFAULT_PROMPT
);
2135 /* Set the important stuff up for command editing. */
2136 command_editing_p
= 1;
2137 history_expansion_p
= 0;
2138 write_history_p
= 0;
2140 /* Setup important stuff for command line editing. */
2141 rl_completion_display_matches_hook
= cli_display_match_list
;
2142 rl_readline_name
= "gdb";
2143 rl_terminal_name
= getenv ("TERM");
2144 rl_deprep_term_function
= gdb_rl_deprep_term_function
;
2146 /* The name for this defun comes from Bash, where it originated.
2147 15 is Control-o, the same binding this function has in Bash. */
2148 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2150 add_setshow_string_cmd ("prompt", class_support
,
2152 _("Set gdb's prompt."),
2153 _("Show gdb's prompt."),
2156 &setlist
, &showlist
);
2158 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2159 Don't repeat this command.\nPrimarily \
2160 used inside of user-defined commands that should not be repeated when\n\
2163 add_setshow_boolean_cmd ("editing", class_support
,
2164 &set_editing_cmd_var
, _("\
2165 Set editing of command lines as they are typed."), _("\
2166 Show editing of command lines as they are typed."), _("\
2167 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2168 Without an argument, command line editing is enabled. To edit, use\n\
2169 EMACS-like or VI-like commands like control-P or ESC."),
2172 &setlist
, &showlist
);
2174 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2175 Set saving of the history record on exit."), _("\
2176 Show saving of the history record on exit."), _("\
2177 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2178 Without an argument, saving is enabled."),
2180 show_write_history_p
,
2181 &sethistlist
, &showhistlist
);
2183 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2184 &history_size_setshow_var
, _("\
2185 Set the size of the command history."), _("\
2186 Show the size of the command history."), _("\
2187 This is the number of previous commands to keep a record of.\n\
2188 If set to \"unlimited\", the number of commands kept in the history\n\
2189 list is unlimited. This defaults to the value of the environment\n\
2190 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2191 set_history_size_command
,
2193 &sethistlist
, &showhistlist
);
2195 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2196 &history_remove_duplicates
, _("\
2197 Set how far back in history to look for and remove duplicate entries."), _("\
2198 Show how far back in history to look for and remove duplicate entries."), _("\
2199 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2200 and remove the first history entry that is a duplicate of the most recent\n\
2201 entry, each time a new history entry is added.\n\
2202 If set to \"unlimited\", this lookbehind is unbounded.\n\
2203 Only history entries added during this session are considered for removal.\n\
2204 If set to 0, removal of duplicate history entries is disabled.\n\
2205 By default this option is set to 0."),
2207 show_history_remove_duplicates
,
2208 &sethistlist
, &showhistlist
);
2210 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2211 Set the filename in which to record the command history."), _("\
2212 Show the filename in which to record the command history."), _("\
2213 (the list of previous commands of which a record is kept)."),
2214 set_history_filename
,
2215 show_history_filename
,
2216 &sethistlist
, &showhistlist
);
2218 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2219 Set whether to confirm potentially dangerous operations."), _("\
2220 Show whether to confirm potentially dangerous operations."), NULL
,
2223 &setlist
, &showlist
);
2225 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2226 Set annotation_level."), _("\
2227 Show annotation_level."), _("\
2228 0 == normal; 1 == fullname (for use when running under emacs)\n\
2229 2 == output annotated suitably for use by programs that control GDB."),
2231 show_annotation_level
,
2232 &setlist
, &showlist
);
2234 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2235 &exec_done_display_p
, _("\
2236 Set notification of completion for asynchronous execution commands."), _("\
2237 Show notification of completion for asynchronous execution commands."), _("\
2238 Use \"on\" to enable the notification, and \"off\" to disable it."),
2240 show_exec_done_display_p
,
2241 &setlist
, &showlist
);
2243 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2244 &staged_gdb_datadir
, _("Set GDB's data directory."),
2245 _("Show GDB's data directory."),
2247 When set, GDB uses the specified path to search for data files."),
2248 set_gdb_datadir
, show_gdb_datadir
,
2251 /* Prime the initial value for data-directory. */
2252 staged_gdb_datadir
= gdb_datadir
;
2254 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2255 &interactive_mode
, _("\
2256 Set whether GDB's standard input is a terminal."), _("\
2257 Show whether GDB's standard input is a terminal."), _("\
2258 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2259 means that GDB should wait for the user to answer queries associated to\n\
2260 commands entered at the command prompt. If off, GDB assumes that standard\n\
2261 input is not a terminal, and uses the default answer to all queries.\n\
2262 If auto (the default), determine which mode to use based on the standard\n\
2265 show_interactive_mode
,
2266 &setlist
, &showlist
);
2268 add_setshow_boolean_cmd ("startup-quietly", class_support
,
2269 &startup_quiet
, _("\
2270 Set whether GDB should start up quietly."), _("\
2271 Show whether GDB should start up quietly."), _("\
2272 This setting will not affect the current session. Instead this command\n\
2273 should be added to the .gdbearlyinit file in the users home directory to\n\
2274 affect future GDB sessions."),
2277 &setlist
, &showlist
);
2279 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2280 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2281 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2282 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2283 set_internalvar_integer (major_version_var
, vmajor
);
2284 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2292 saved_command_line
= xstrdup ("");
2293 previous_saved_command_line
= xstrdup ("");
2295 /* Run the init function of each source file. */
2298 /* Make sure we return to the original directory upon exit, come
2299 what may, since the OS doesn't do that for us. */
2300 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2305 /* Here is where we call all the _initialize_foo routines. */
2306 initialize_all_files ();
2308 /* This creates the current_program_space. Do this after all the
2309 _initialize_foo routines have had a chance to install their
2310 per-sspace data keys. Also do this before
2311 initialize_current_architecture is called, because it accesses
2312 exec_bfd of the current program space. */
2313 initialize_progspace ();
2314 initialize_inferiors ();
2315 initialize_current_architecture ();
2316 init_main (); /* But that omits this file! Do it now. */
2318 initialize_stdin_serial ();
2320 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2322 set_initial_gdb_ttystate ();
2324 gdb_init_signals ();
2326 /* We need a default language for parsing expressions, so simple
2327 things like "set width 0" won't fail if no language is explicitly
2328 set in a config file or implicitly set by reading an executable
2330 set_language (language_c
);
2331 expected_language
= current_language
; /* Don't warn about the change. */
2334 void _initialize_top ();
2338 /* Determine a default value for the history filename. */
2339 const char *tmpenv
= getenv ("GDBHISTFILE");
2340 if (tmpenv
!= nullptr)
2341 history_filename
= tmpenv
;
2344 /* We include the current directory so that if the user changes
2345 directories the file written will be the same as the one
2348 /* No leading dots in file names are allowed on MSDOS. */
2349 const char *fname
= "_gdb_history";
2351 const char *fname
= ".gdb_history";
2354 history_filename
= gdb_abspath (fname
);