1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2022 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "cli/cli-cmds.h"
23 #include "cli/cli-script.h"
24 #include "cli/cli-setshow.h"
25 #include "cli/cli-decode.h"
31 #include "target-dcache.h"
32 #include "breakpoint.h"
34 #include "expression.h"
38 #include "gdbsupport/job-control.h"
40 #include "completer.h"
42 #include "gdbsupport/version.h"
45 #include "gdbsupport/event-loop.h"
46 #include "gdbthread.h"
47 #include "extension.h"
49 #include "observable.h"
51 #include "filenames.h"
53 #include "gdbsupport/buffer.h"
54 #include "gdbsupport/gdb_select.h"
55 #include "gdbsupport/scope-exit.h"
57 #include "gdbsupport/pathstuff.h"
58 #include "cli/cli-style.h"
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"
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 /* Current working directory. */
146 char *current_directory
;
148 /* The last command line executed on the console. Used for command
149 repetitions when the user enters an empty line. */
151 static char *saved_command_line
;
153 /* If not NULL, the arguments that should be passed if
154 saved_command_line is repeated. */
156 static const char *repeat_arguments
;
158 /* The previous last command line executed on the console. Used for command
159 repetitions when a command wants to relaunch the previously launched
160 command. We need this as when a command is running, saved_command_line
161 already contains the line of the currently executing command. */
163 static char *previous_saved_command_line
;
165 /* If not NULL, the arguments that should be passed if the
166 previous_saved_command_line is repeated. */
168 static const char *previous_repeat_arguments
;
170 /* Nonzero if the current command is modified by "server ". This
171 affects things like recording into the command history, commands
172 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
173 whatever) can issue its own commands and also send along commands
174 from the user, and have the user not notice that the user interface
175 is issuing commands too. */
178 /* Timeout limit for response from target. */
180 /* The default value has been changed many times over the years. It
181 was originally 5 seconds. But that was thought to be a long time
182 to sit and wait, so it was changed to 2 seconds. That was thought
183 to be plenty unless the connection was going through some terminal
184 server or multiplexer or other form of hairy serial connection.
186 In mid-1996, remote_timeout was moved from remote.c to top.c and
187 it began being used in other remote-* targets. It appears that the
188 default was changed to 20 seconds at that time, perhaps because the
189 Renesas E7000 ICE didn't always respond in a timely manner.
191 But if 5 seconds is a long time to sit and wait for retransmissions,
192 20 seconds is far worse. This demonstrates the difficulty of using
193 a single variable for all protocol timeouts.
195 As remote.c is used much more than remote-e7000.c, it was changed
196 back to 2 seconds in 1999. */
198 int remote_timeout
= 2;
200 /* Sbrk location on entry to main. Used for statistics only. */
201 #ifdef HAVE_USEFUL_SBRK
205 /* Hooks for alternate command interfaces. */
207 /* This hook is called from within gdb's many mini-event loops which
208 could steal control from a real user interface's event loop. It
209 returns non-zero if the user is requesting a detach, zero
212 int (*deprecated_ui_loop_hook
) (int);
215 /* Called from print_frame_info to list the line we stopped in. */
217 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
221 /* Replaces most of query. */
223 int (*deprecated_query_hook
) (const char *, va_list);
225 /* Replaces most of warning. */
227 void (*deprecated_warning_hook
) (const char *, va_list);
229 /* These three functions support getting lines of text from the user.
230 They are used in sequence. First deprecated_readline_begin_hook is
231 called with a text string that might be (for example) a message for
232 the user to type in a sequence of commands to be executed at a
233 breakpoint. If this function calls back to a GUI, it might take
234 this opportunity to pop up a text interaction window with this
235 message. Next, deprecated_readline_hook is called with a prompt
236 that is emitted prior to collecting the user input. It can be
237 called multiple times. Finally, deprecated_readline_end_hook is
238 called to notify the GUI that we are done with the interaction
239 window and it can close it. */
241 void (*deprecated_readline_begin_hook
) (const char *, ...);
242 char *(*deprecated_readline_hook
) (const char *);
243 void (*deprecated_readline_end_hook
) (void);
245 /* Called as appropriate to notify the interface that we have attached
246 to or detached from an already running process. */
248 void (*deprecated_attach_hook
) (void);
249 void (*deprecated_detach_hook
) (void);
251 /* Used by UI as a wrapper around command execution. May do various
252 things like enabling/disabling buttons, etc... */
254 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
255 const char *cmd
, int from_tty
);
257 /* Called when the current thread changes. Argument is thread id. */
259 void (*deprecated_context_hook
) (int id
);
261 /* The highest UI number ever assigned. */
262 static int highest_ui_num
;
266 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
268 num (++highest_ui_num
),
269 call_readline (nullptr),
270 input_handler (nullptr),
272 interp_info (nullptr),
274 secondary_prompt_depth (0),
275 stdin_stream (instream_
),
276 instream (instream_
),
277 outstream (outstream_
),
278 errstream (errstream_
),
279 input_fd (fileno (instream
)),
280 input_interactive_p (ISATTY (instream
)),
281 prompt_state (PROMPT_NEEDED
),
282 m_gdb_stdout (new pager_file (new stdio_file (outstream
))),
283 m_gdb_stdin (new stdio_file (instream
)),
284 m_gdb_stderr (new stderr_file (errstream
)),
285 m_gdb_stdlog (m_gdb_stderr
),
286 m_current_uiout (nullptr)
288 buffer_init (&line_buffer
);
296 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
304 struct ui
*ui
, *uiprev
;
308 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
312 gdb_assert (ui
!= NULL
);
324 /* Open file named NAME for read/write, making sure not to make it the
325 controlling terminal. */
328 open_terminal_stream (const char *name
)
330 scoped_fd fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
332 perror_with_name (_("opening terminal failed"));
334 return fd
.to_file ("w+");
337 /* Implementation of the "new-ui" command. */
340 new_ui_command (const char *args
, int from_tty
)
343 const char *interpreter_name
;
344 const char *tty_name
;
348 gdb_argv
argv (args
);
349 argc
= argv
.count ();
352 error (_("Usage: new-ui INTERPRETER TTY"));
354 interpreter_name
= argv
[0];
358 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
360 /* Open specified terminal. Note: we used to open it three times,
361 once for each of stdin/stdout/stderr, but that does not work
362 with Windows named pipes. */
363 gdb_file_up stream
= open_terminal_stream (tty_name
);
365 std::unique_ptr
<ui
> ui
366 (new struct ui (stream
.get (), stream
.get (), stream
.get ()));
370 current_ui
= ui
.get ();
372 set_top_level_interpreter (interpreter_name
);
374 interp_pre_command_loop (top_level_interpreter ());
376 /* Make sure the file is not closed. */
382 gdb_printf ("New UI allocated\n");
385 /* Handler for SIGHUP. */
388 /* NOTE 1999-04-29: This function will be static again, once we modify
389 gdb to use the event loop as the default command loop and we merge
390 event-top.c into this file, top.c. */
394 /* Stop asking user for confirmation --- we're exiting. This
395 prevents asking the user dumb questions. */
397 quit_command ((char *) 0, 0);
399 #endif /* defined SIGHUP */
401 /* Line number we are currently in, in a file which is being sourced. */
402 /* NOTE 1999-04-29: This variable will be static again, once we modify
403 gdb to use the event loop as the default command loop and we merge
404 event-top.c into this file, top.c. */
405 /* static */ int source_line_number
;
407 /* Name of the file we are sourcing. */
408 /* NOTE 1999-04-29: This variable will be static again, once we modify
409 gdb to use the event loop as the default command loop and we merge
410 event-top.c into this file, top.c. */
411 /* static */ std::string source_file_name
;
413 /* Read commands from STREAM. */
415 read_command_file (FILE *stream
)
417 struct ui
*ui
= current_ui
;
419 scoped_restore save_instream
420 = make_scoped_restore (&ui
->instream
, stream
);
422 /* Read commands from `instream' and execute them until end of file
423 or error reading instream. */
425 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
429 /* Get a command-line. This calls the readline package. */
430 command
= command_line_input (NULL
, NULL
);
433 command_handler (command
);
439 do_chdir_cleanup (void *old_dir
)
441 chdir ((const char *) old_dir
);
447 prepare_execute_command ()
449 /* With multiple threads running while the one we're examining is
450 stopped, the dcache can get stale without us being able to detect
451 it. For the duration of the command, though, use the dcache to
452 help things like backtrace. */
454 target_dcache_invalidate ();
456 return scoped_value_mark ();
459 /* Tell the user if the language has changed (except first time) after
460 executing a command. */
463 check_frame_language_change (void)
465 static int warned
= 0;
466 struct frame_info
*frame
;
468 /* First make sure that a new frame has been selected, in case the
469 command or the hooks changed the program state. */
470 frame
= deprecated_safe_get_selected_frame ();
471 if (current_language
!= expected_language
)
473 if (language_mode
== language_mode_auto
&& info_verbose
)
475 /* Print what changed. */
481 /* Warn the user if the working language does not match the language
482 of the current frame. Only warn the user if we are actually
483 running the program, i.e. there is a stack. */
484 /* FIXME: This should be cacheing the frame and only running when
485 the frame changes. */
487 if (has_stack_frames ())
491 flang
= get_frame_language (frame
);
493 && flang
!= language_unknown
494 && flang
!= current_language
->la_language
)
496 gdb_printf ("%s\n", _(lang_frame_mismatch_warn
));
505 wait_sync_command_done (void)
507 /* Processing events may change the current UI. */
508 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
509 struct ui
*ui
= current_ui
;
511 /* We're about to wait until the target stops after having resumed
512 it so must force-commit resumptions, in case we're being called
513 in some context where a scoped_disable_commit_resumed object is
514 active. I.e., this function is a commit-resumed sync/flush
516 scoped_enable_commit_resumed
enable ("sync wait");
518 while (gdb_do_one_event () >= 0)
519 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
526 maybe_wait_sync_command_done (int was_sync
)
528 /* If the interpreter is in sync mode (we're running a user
529 command's list, running command hooks or similars), and we
530 just ran a synchronous command that started the target, wait
531 for that command to end. */
532 if (!current_ui
->async
534 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
535 wait_sync_command_done ();
541 set_repeat_arguments (const char *args
)
543 repeat_arguments
= args
;
546 /* Execute the line P as a command, in the current user context.
547 Pass FROM_TTY as second argument to the defining function. */
550 execute_command (const char *p
, int from_tty
)
552 struct cmd_list_element
*c
;
554 const char *cmd_start
= p
;
556 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
557 scoped_value_mark cleanup
= prepare_execute_command ();
559 /* This can happen when command_line_input hits end of file. */
562 cleanup_if_error
.release ();
566 target_log_command (p
);
568 while (*p
== ' ' || *p
== '\t')
574 std::string default_args
;
575 std::string default_args_and_arg
;
576 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
580 /* If trace-commands is set then this will print this command. */
581 print_command_trace ("%s", p
);
583 c
= lookup_cmd (&cmd
, cmdlist
, "", &default_args
, 0, 1);
586 scoped_restore save_repeat_args
587 = make_scoped_restore (&repeat_arguments
, nullptr);
588 const char *args_pointer
= p
;
590 if (!default_args
.empty ())
593 default_args_and_arg
= default_args
+ ' ' + p
;
595 default_args_and_arg
= default_args
;
596 arg
= default_args_and_arg
.c_str ();
600 /* Pass null arg rather than an empty one. */
601 arg
= *p
== '\0' ? nullptr : p
;
604 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
605 while the is_complete_command(cfunc) test is just plain
606 bogus. They should both be replaced by a test of the form
607 c->strip_trailing_white_space_p. */
608 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
609 can't be replaced with func. This is because it is the
610 cfunc, and not the func, that has the value that the
611 is_complete_command hack is testing for. */
612 /* Clear off trailing whitespace, except for set and complete
614 std::string without_whitespace
;
616 && c
->type
!= set_cmd
617 && !is_complete_command (c
))
619 const char *old_end
= arg
+ strlen (arg
) - 1;
621 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
625 without_whitespace
= std::string (arg
, p
+ 1);
626 arg
= without_whitespace
.c_str ();
630 /* If this command has been pre-hooked, run the hook first. */
631 execute_cmd_pre_hook (c
);
633 if (c
->deprecated_warn_user
)
634 deprecated_cmd_warning (line
, cmdlist
);
636 /* c->user_commands would be NULL in the case of a python command. */
637 if (c
->theclass
== class_user
&& c
->user_commands
)
638 execute_user_command (c
, arg
);
639 else if (c
->theclass
== class_user
640 && c
->is_prefix () && !c
->allow_unknown
)
641 /* If this is a user defined prefix that does not allow unknown
642 (in other words, C is a prefix command and not a command
643 that can be followed by its args), report the list of
646 std::string prefixname
= c
->prefixname ();
647 std::string prefixname_no_space
648 = prefixname
.substr (0, prefixname
.length () - 1);
650 ("\"%s\" must be followed by the name of a subcommand.\n",
651 prefixname_no_space
.c_str ());
652 help_list (*c
->subcommands
, prefixname
.c_str (), all_commands
,
655 else if (c
->type
== set_cmd
)
656 do_set_command (arg
, from_tty
, c
);
657 else if (c
->type
== show_cmd
)
658 do_show_command (arg
, from_tty
, c
);
659 else if (c
->is_command_class_help ())
660 error (_("That is not a command, just a help topic."));
661 else if (deprecated_call_command_hook
)
662 deprecated_call_command_hook (c
, arg
, from_tty
);
664 cmd_func (c
, arg
, from_tty
);
666 maybe_wait_sync_command_done (was_sync
);
668 /* If this command has been post-hooked, run the hook last. */
669 execute_cmd_post_hook (c
);
671 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
673 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
674 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
679 /* Only perform the frame-language-change check if the command
680 we just finished executing did not resume the inferior's execution.
681 If it did resume the inferior, we will do that check after
682 the inferior stopped. */
683 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
684 check_frame_language_change ();
686 cleanup_if_error
.release ();
692 execute_fn_to_ui_file (struct ui_file
*file
, std::function
<void(void)> fn
)
694 /* GDB_STDOUT should be better already restored during these
695 restoration callbacks. */
696 set_batch_flag_and_restore_page_info save_page_info
;
698 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
701 current_uiout
->redirect (file
);
702 ui_out_redirect_pop
redirect_popper (current_uiout
);
704 scoped_restore save_stdout
705 = make_scoped_restore (&gdb_stdout
, file
);
706 scoped_restore save_stderr
707 = make_scoped_restore (&gdb_stderr
, file
);
708 scoped_restore save_stdlog
709 = make_scoped_restore (&gdb_stdlog
, file
);
710 scoped_restore save_stdtarg
711 = make_scoped_restore (&gdb_stdtarg
, file
);
712 scoped_restore save_stdtargerr
713 = make_scoped_restore (&gdb_stdtargerr
, file
);
722 execute_fn_to_string (std::string
&res
, std::function
<void(void)> fn
,
725 string_file
str_file (term_out
);
729 execute_fn_to_ui_file (&str_file
, fn
);
734 res
= std::move (str_file
.string ());
739 res
= std::move (str_file
.string ());
745 execute_command_to_ui_file (struct ui_file
*file
,
746 const char *p
, int from_tty
)
748 execute_fn_to_ui_file (file
, [=]() { execute_command (p
, from_tty
); });
754 execute_command_to_string (std::string
&res
, const char *p
, int from_tty
,
757 execute_fn_to_string (res
, [=]() { execute_command (p
, from_tty
); },
764 execute_command_to_string (const char *p
, int from_tty
,
768 execute_fn_to_string (dummy
, [=]() { execute_command (p
, from_tty
); },
772 /* When nonzero, cause dont_repeat to do nothing. This should only be
773 set via prevent_dont_repeat. */
775 static int suppress_dont_repeat
= 0;
782 struct ui
*ui
= current_ui
;
784 if (suppress_dont_repeat
|| server_command
)
787 /* If we aren't reading from standard input, we are saving the last
788 thing read from stdin in line and don't want to delete it. Null
789 lines won't repeat here in any case. */
790 if (ui
->instream
== ui
->stdin_stream
)
792 *saved_command_line
= 0;
793 repeat_arguments
= NULL
;
802 /* Do not repeat this command, as this command is a repeating command. */
805 /* We cannot free saved_command_line, as this line is being executed,
806 so swap it with previous_saved_command_line. */
807 std::swap (previous_saved_command_line
, saved_command_line
);
808 std::swap (previous_repeat_arguments
, repeat_arguments
);
810 const char *prev
= skip_spaces (get_saved_command_line ());
812 error (_("No previous command to relaunch"));
818 scoped_restore_tmpl
<int>
819 prevent_dont_repeat (void)
821 return make_scoped_restore (&suppress_dont_repeat
, 1);
827 get_saved_command_line ()
829 return saved_command_line
;
835 save_command_line (const char *cmd
)
837 xfree (previous_saved_command_line
);
838 previous_saved_command_line
= saved_command_line
;
839 previous_repeat_arguments
= repeat_arguments
;
840 saved_command_line
= xstrdup (cmd
);
841 repeat_arguments
= NULL
;
845 /* Read a line from the stream "instream" without command line editing.
847 It prints PROMPT once at the start.
848 Action is compatible with "readline", e.g. space for the result is
849 malloc'd and should be freed by the caller.
851 A NULL return means end of file. */
854 gdb_readline_no_editing (const char *prompt
)
856 struct buffer line_buffer
;
857 struct ui
*ui
= current_ui
;
858 /* Read from stdin if we are executing a user defined command. This
859 is the right thing for prompt_for_continue, at least. */
860 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
861 int fd
= fileno (stream
);
863 buffer_init (&line_buffer
);
867 /* Don't use a _filtered function here. It causes the assumed
868 character position to be off, since the newline we read from
869 the user is not accounted for. */
870 printf_unfiltered ("%s", prompt
);
871 gdb_flush (gdb_stdout
);
881 /* Wait until at least one byte of data is available. Control-C
882 can interrupt interruptible_select, but not fgetc. */
884 FD_SET (fd
, &readfds
);
885 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
889 /* If this was ctrl-c, the QUIT above handles it. */
892 perror_with_name (("select"));
899 if (line_buffer
.used_size
> 0)
900 /* The last line does not end with a newline. Return it, and
901 if we are called again fgetc will still return EOF and
902 we'll return NULL then. */
904 xfree (buffer_finish (&line_buffer
));
910 if (line_buffer
.used_size
> 0
911 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
912 line_buffer
.used_size
--;
916 buffer_grow_char (&line_buffer
, c
);
919 buffer_grow_char (&line_buffer
, '\0');
920 return buffer_finish (&line_buffer
);
923 /* Variables which control command line editing and history
924 substitution. These variables are given default values at the end
926 static bool command_editing_p
;
928 /* NOTE 1999-04-29: This variable will be static again, once we modify
929 gdb to use the event loop as the default command loop and we merge
930 event-top.c into this file, top.c. */
932 /* static */ bool history_expansion_p
;
934 /* Should we write out the command history on exit? In order to write out
935 the history both this flag must be true, and the history_filename
936 variable must be set to something sensible. */
937 static bool write_history_p
;
939 /* The name of the file in which GDB history will be written. If this is
940 set to NULL, of the empty string then history will not be written. */
941 static std::string history_filename
;
943 /* Implement 'show history save'. */
945 show_write_history_p (struct ui_file
*file
, int from_tty
,
946 struct cmd_list_element
*c
, const char *value
)
948 if (!write_history_p
|| !history_filename
.empty ())
949 gdb_printf (file
, _("Saving of the history record on exit is %s.\n"),
952 gdb_printf (file
, _("Saving of the history is disabled due to "
953 "the value of 'history filename'.\n"));
956 /* The variable associated with the "set/show history size"
957 command. The value -1 means unlimited, and -2 means undefined. */
958 static int history_size_setshow_var
= -2;
961 show_history_size (struct ui_file
*file
, int from_tty
,
962 struct cmd_list_element
*c
, const char *value
)
964 gdb_printf (file
, _("The size of the command history is %s.\n"),
968 /* Variable associated with the "history remove-duplicates" option.
969 The value -1 means unlimited. */
970 static int history_remove_duplicates
= 0;
973 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
974 struct cmd_list_element
*c
, const char *value
)
977 _("The number of history entries to look back at for "
978 "duplicates is %s.\n"),
982 /* Implement 'show history filename'. */
984 show_history_filename (struct ui_file
*file
, int from_tty
,
985 struct cmd_list_element
*c
, const char *value
)
987 if (!history_filename
.empty ())
988 gdb_printf (file
, _("The filename in which to record "
989 "the command history is \"%ps\".\n"),
990 styled_string (file_name_style
.style (), value
));
992 gdb_printf (file
, _("There is no filename currently set for "
993 "recording the command history in.\n"));
996 /* This is like readline(), but it has some gdb-specific behavior.
997 gdb may want readline in both the synchronous and async modes during
998 a single gdb invocation. At the ordinary top-level prompt we might
999 be using the async readline. That means we can't use
1000 rl_pre_input_hook, since it doesn't work properly in async mode.
1001 However, for a secondary prompt (" >", such as occurs during a
1002 `define'), gdb wants a synchronous response.
1004 We used to call readline() directly, running it in synchronous
1005 mode. But mixing modes this way is not supported, and as of
1006 readline 5.x it no longer works; the arrow keys come unbound during
1007 the synchronous call. So we make a nested call into the event
1008 loop. That's what gdb_readline_wrapper is for. */
1010 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
1011 rely on gdb_readline_wrapper_result, which might still be NULL if
1012 the user types Control-D for EOF. */
1013 static int gdb_readline_wrapper_done
;
1015 /* The result of the current call to gdb_readline_wrapper, once a newline
1017 static char *gdb_readline_wrapper_result
;
1019 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
1020 to be called after the newline is processed (which will redisplay
1021 the prompt). But in gdb_readline_wrapper we will not get a new
1022 prompt until the next call, or until we return to the event loop.
1023 So we disable this hook around the newline and restore it before we
1025 static void (*saved_after_char_processing_hook
) (void);
1031 gdb_in_secondary_prompt_p (struct ui
*ui
)
1033 return ui
->secondary_prompt_depth
> 0;
1037 /* This function is called when readline has seen a complete line of
1041 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
1043 gdb_assert (!gdb_readline_wrapper_done
);
1044 gdb_readline_wrapper_result
= line
.release ();
1045 gdb_readline_wrapper_done
= 1;
1047 /* Prevent operate-and-get-next from acting too early. */
1048 saved_after_char_processing_hook
= after_char_processing_hook
;
1049 after_char_processing_hook
= NULL
;
1051 /* Prevent parts of the prompt from being redisplayed if annotations
1052 are enabled, and readline's state getting out of sync. We'll
1053 reinstall the callback handler, which puts the terminal in raw
1054 mode (or in readline lingo, in prepped state), when we're next
1055 ready to process user input, either in display_gdb_prompt, or if
1056 we're handling an asynchronous target event and running in the
1057 background, just before returning to the event loop to process
1058 further input (or more target events). */
1059 if (current_ui
->command_editing
)
1060 gdb_rl_callback_handler_remove ();
1063 class gdb_readline_wrapper_cleanup
1066 gdb_readline_wrapper_cleanup ()
1067 : m_handler_orig (current_ui
->input_handler
),
1068 m_already_prompted_orig (current_ui
->command_editing
1069 ? rl_already_prompted
: 0),
1070 m_target_is_async_orig (target_is_async_p ()),
1071 m_save_ui (¤t_ui
)
1073 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1074 current_ui
->secondary_prompt_depth
++;
1076 if (m_target_is_async_orig
)
1080 ~gdb_readline_wrapper_cleanup ()
1082 struct ui
*ui
= current_ui
;
1084 if (ui
->command_editing
)
1085 rl_already_prompted
= m_already_prompted_orig
;
1087 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1088 ui
->input_handler
= m_handler_orig
;
1090 /* Don't restore our input handler in readline yet. That would make
1091 readline prep the terminal (putting it in raw mode), while the
1092 line we just read may trigger execution of a command that expects
1093 the terminal in the default cooked/canonical mode, such as e.g.,
1094 running Python's interactive online help utility. See
1095 gdb_readline_wrapper_line for when we'll reinstall it. */
1097 gdb_readline_wrapper_result
= NULL
;
1098 gdb_readline_wrapper_done
= 0;
1099 ui
->secondary_prompt_depth
--;
1100 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1102 after_char_processing_hook
= saved_after_char_processing_hook
;
1103 saved_after_char_processing_hook
= NULL
;
1105 if (m_target_is_async_orig
)
1109 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1113 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1114 int m_already_prompted_orig
;
1116 /* Whether the target was async. */
1117 int m_target_is_async_orig
;
1119 /* Processing events may change the current UI. */
1120 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1124 gdb_readline_wrapper (const char *prompt
)
1126 struct ui
*ui
= current_ui
;
1128 gdb_readline_wrapper_cleanup cleanup
;
1130 /* Display our prompt and prevent double prompt display. Don't pass
1131 down a NULL prompt, since that has special meaning for
1132 display_gdb_prompt -- it indicates a request to print the primary
1133 prompt, while we want a secondary prompt here. */
1134 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1135 if (ui
->command_editing
)
1136 rl_already_prompted
= 1;
1138 if (after_char_processing_hook
)
1139 (*after_char_processing_hook
) ();
1140 gdb_assert (after_char_processing_hook
== NULL
);
1142 while (gdb_do_one_event () >= 0)
1143 if (gdb_readline_wrapper_done
)
1146 return gdb_readline_wrapper_result
;
1150 /* The current saved history number from operate-and-get-next.
1151 This is -1 if not valid. */
1152 static int operate_saved_history
= -1;
1154 /* This is put on the appropriate hook and helps operate-and-get-next
1157 gdb_rl_operate_and_get_next_completion (void)
1159 int delta
= where_history () - operate_saved_history
;
1161 /* The `key' argument to rl_get_previous_history is ignored. */
1162 rl_get_previous_history (delta
, 0);
1163 operate_saved_history
= -1;
1165 /* readline doesn't automatically update the display for us. */
1168 after_char_processing_hook
= NULL
;
1169 rl_pre_input_hook
= NULL
;
1172 /* This is a gdb-local readline command handler. It accepts the
1173 current command line (like RET does) and, if this command was taken
1174 from the history, arranges for the next command in the history to
1175 appear on the command line when the prompt returns.
1176 We ignore the arguments. */
1178 gdb_rl_operate_and_get_next (int count
, int key
)
1182 /* Use the async hook. */
1183 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1185 /* Find the current line, and find the next line to use. */
1186 where
= where_history();
1188 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1189 || (where
>= history_length
- 1))
1190 operate_saved_history
= where
;
1192 operate_saved_history
= where
+ 1;
1194 return rl_newline (1, key
);
1197 /* Number of user commands executed during this session. */
1199 static int command_count
= 0;
1201 /* Add the user command COMMAND to the input history list. */
1204 gdb_add_history (const char *command
)
1208 if (history_remove_duplicates
!= 0)
1211 int lookbehind_threshold
;
1213 /* The lookbehind threshold for finding a duplicate history entry is
1214 bounded by command_count because we can't meaningfully delete
1215 history entries that are already stored in the history file since
1216 the history file is appended to. */
1217 if (history_remove_duplicates
== -1
1218 || history_remove_duplicates
> command_count
)
1219 lookbehind_threshold
= command_count
;
1221 lookbehind_threshold
= history_remove_duplicates
;
1224 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1226 HIST_ENTRY
*temp
= previous_history ();
1231 if (strcmp (temp
->line
, command
) == 0)
1233 HIST_ENTRY
*prev
= remove_history (where_history ());
1235 free_history_entry (prev
);
1242 add_history (command
);
1245 /* Safely append new history entries to the history file in a corruption-free
1246 way using an intermediate local history file. */
1249 gdb_safe_append_history (void)
1251 int ret
, saved_errno
;
1253 std::string local_history_filename
1254 = string_printf ("%s-gdb%ld~", history_filename
.c_str (), (long) getpid ());
1256 ret
= rename (history_filename
.c_str (), local_history_filename
.c_str ());
1257 saved_errno
= errno
;
1258 if (ret
< 0 && saved_errno
!= ENOENT
)
1260 warning (_("Could not rename %ps to %ps: %s"),
1261 styled_string (file_name_style
.style (),
1262 history_filename
.c_str ()),
1263 styled_string (file_name_style
.style (),
1264 local_history_filename
.c_str ()),
1265 safe_strerror (saved_errno
));
1271 /* If the rename failed with ENOENT then either the global history
1272 file never existed in the first place or another GDB process is
1273 currently appending to it (and has thus temporarily renamed it).
1274 Since we can't distinguish between these two cases, we have to
1275 conservatively assume the first case and therefore must write out
1276 (not append) our known history to our local history file and try
1277 to move it back anyway. Otherwise a global history file would
1278 never get created! */
1279 gdb_assert (saved_errno
== ENOENT
);
1280 write_history (local_history_filename
.c_str ());
1284 append_history (command_count
, local_history_filename
.c_str ());
1285 if (history_is_stifled ())
1286 history_truncate_file (local_history_filename
.c_str (),
1287 history_max_entries
);
1290 ret
= rename (local_history_filename
.c_str (), history_filename
.c_str ());
1291 saved_errno
= errno
;
1292 if (ret
< 0 && saved_errno
!= EEXIST
)
1293 warning (_("Could not rename %s to %s: %s"),
1294 local_history_filename
.c_str (), history_filename
.c_str (),
1295 safe_strerror (saved_errno
));
1299 /* Read one line from the command input stream `instream' into a local
1300 static buffer. The buffer is made bigger as necessary. Returns
1301 the address of the start of the line.
1303 NULL is returned for end of file.
1305 This routine either uses fancy command line editing or simple input
1306 as the user has requested. */
1309 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1311 static struct buffer cmd_line_buffer
;
1312 static int cmd_line_buffer_initialized
;
1313 struct ui
*ui
= current_ui
;
1314 const char *prompt
= prompt_arg
;
1316 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1318 /* The annotation suffix must be non-NULL. */
1319 if (annotation_suffix
== NULL
)
1320 annotation_suffix
= "";
1322 if (from_tty
&& annotation_level
> 1)
1327 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1328 + strlen (annotation_suffix
) + 40);
1330 local_prompt
[0] = '\0';
1332 strcpy (local_prompt
, prompt
);
1333 strcat (local_prompt
, "\n\032\032");
1334 strcat (local_prompt
, annotation_suffix
);
1335 strcat (local_prompt
, "\n");
1337 prompt
= local_prompt
;
1340 if (!cmd_line_buffer_initialized
)
1342 buffer_init (&cmd_line_buffer
);
1343 cmd_line_buffer_initialized
= 1;
1346 /* Starting a new command line. */
1347 cmd_line_buffer
.used_size
= 0;
1351 signal (SIGTSTP
, handle_sigtstp
);
1356 gdb::unique_xmalloc_ptr
<char> rl
;
1358 /* Make sure that all output has been output. Some machines may
1359 let you get away with leaving out some of the gdb_flush, but
1361 gdb_stdout
->wrap_here (0);
1362 gdb_flush (gdb_stdout
);
1363 gdb_flush (gdb_stderr
);
1365 if (!source_file_name
.empty ())
1366 ++source_line_number
;
1368 if (from_tty
&& annotation_level
> 1)
1369 printf_unfiltered ("\n\032\032pre-%s\n", annotation_suffix
);
1371 /* Don't use fancy stuff if not talking to stdin. */
1372 if (deprecated_readline_hook
1374 && input_interactive_p (current_ui
))
1376 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1378 else if (command_editing_p
1380 && input_interactive_p (current_ui
))
1382 rl
.reset (gdb_readline_wrapper (prompt
));
1386 rl
.reset (gdb_readline_no_editing (prompt
));
1389 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1390 0, annotation_suffix
);
1391 if (cmd
== (char *) EOF
)
1399 /* Got partial input. I.e., got a line that ends with a
1400 continuation character (backslash). Suppress printing the
1407 signal (SIGTSTP
, SIG_DFL
);
1415 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1417 /* From GNU coding standards, first line is meant to be easy for a
1418 program to parse, and is just canonical program name and version
1419 number, which starts after last space. */
1421 std::string v_str
= string_printf ("GNU gdb %s%s", PKGVERSION
, version
);
1422 gdb_printf (stream
, "%ps\n",
1423 styled_string (version_style
.style (), v_str
.c_str ()));
1425 /* Second line is a copyright notice. */
1428 "Copyright (C) 2022 Free Software Foundation, Inc.\n");
1430 /* Following the copyright is a brief statement that the program is
1431 free software, that users are free to copy and change it on
1432 certain conditions, that it is covered by the GNU GPL, and that
1433 there is no warranty. */
1435 gdb_printf (stream
, "\
1436 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1437 \nThis is free software: you are free to change and redistribute it.\n\
1438 There is NO WARRANTY, to the extent permitted by law.");
1443 gdb_printf (stream
, ("\nType \"show copying\" and "
1444 "\"show warranty\" for details.\n"));
1446 /* After the required info we print the configuration information. */
1448 gdb_printf (stream
, "This GDB was configured as \"");
1449 if (strcmp (host_name
, target_name
) != 0)
1451 gdb_printf (stream
, "--host=%s --target=%s",
1452 host_name
, target_name
);
1456 gdb_printf (stream
, "%s", host_name
);
1458 gdb_printf (stream
, "\".\n");
1460 gdb_printf (stream
, _("Type \"show configuration\" "
1461 "for configuration details.\n"));
1463 if (REPORT_BUGS_TO
[0])
1466 _("For bug reporting instructions, please see:\n"));
1467 gdb_printf (stream
, "%s.\n", REPORT_BUGS_TO
);
1470 _("Find the GDB manual and other documentation \
1471 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1472 gdb_printf (stream
, "\n\n");
1473 gdb_printf (stream
, _("For help, type \"help\".\n"));
1475 _("Type \"apropos word\" to search for commands \
1476 related to \"word\"."));
1479 /* Print the details of GDB build-time configuration. */
1481 print_gdb_configuration (struct ui_file
*stream
)
1483 gdb_printf (stream
, _("\
1484 This GDB was configured as follows:\n\
1485 configure --host=%s --target=%s\n\
1486 "), host_name
, target_name
);
1488 gdb_printf (stream
, _("\
1489 --with-auto-load-dir=%s\n\
1490 --with-auto-load-safe-path=%s\n\
1491 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1494 gdb_printf (stream
, _("\
1498 gdb_printf (stream
, _("\
1504 gdb_printf (stream
, _("\
1505 --with-gdb-datadir=%s%s\n\
1506 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1509 gdb_printf (stream
, _("\
1510 --with-iconv-bin=%s%s\n\
1511 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1514 if (JIT_READER_DIR
[0])
1515 gdb_printf (stream
, _("\
1516 --with-jit-reader-dir=%s%s\n\
1517 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1519 #if HAVE_LIBUNWIND_IA64_H
1520 gdb_printf (stream
, _("\
1521 --with-libunwind-ia64\n\
1524 gdb_printf (stream
, _("\
1525 --without-libunwind-ia64\n\
1530 gdb_printf (stream
, _("\
1534 gdb_printf (stream
, _("\
1539 #if HAVE_LIBBABELTRACE
1540 gdb_printf (stream
, _("\
1541 --with-babeltrace\n\
1544 gdb_printf (stream
, _("\
1545 --without-babeltrace\n\
1550 gdb_printf (stream
, _("\
1554 gdb_printf (stream
, _("\
1555 --without-intel-pt\n\
1560 gdb_printf (stream
, _("\
1564 gdb_printf (stream
, _("\
1569 gdb_printf (stream
, _("\
1573 gdb_printf (stream
, _("\
1577 #ifdef WITH_PYTHON_PATH
1578 gdb_printf (stream
, _("\
1579 --with-python=%s%s\n\
1580 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1582 gdb_printf (stream
, _("\
1586 #ifdef WITH_PYTHON_LIBDIR
1587 gdb_printf (stream
, _("\
1588 --with-python-libdir=%s%s\n\
1589 "), WITH_PYTHON_LIBDIR
, PYTHON_LIBDIR_RELOCATABLE
? " (relocatable)" : "");
1591 gdb_printf (stream
, _("\
1592 --without-python-libdir\n\
1596 #if HAVE_LIBDEBUGINFOD
1597 gdb_printf (stream
, _("\
1598 --with-debuginfod\n\
1601 gdb_printf (stream
, _("\
1602 --without-debuginfod\n\
1607 gdb_printf (stream
, _("\
1611 gdb_printf (stream
, _("\
1616 #if HAVE_SOURCE_HIGHLIGHT
1617 gdb_printf (stream
, _("\
1618 --enable-source-highlight\n\
1621 gdb_printf (stream
, _("\
1622 --disable-source-highlight\n\
1627 gdb_printf (stream
, _("\
1628 --with-relocated-sources=%s\n\
1633 gdb_printf (stream
, _("\
1634 --with-separate-debug-dir=%s%s\n\
1635 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1637 if (TARGET_SYSTEM_ROOT
[0])
1638 gdb_printf (stream
, _("\
1639 --with-sysroot=%s%s\n\
1640 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1642 if (SYSTEM_GDBINIT
[0])
1643 gdb_printf (stream
, _("\
1644 --with-system-gdbinit=%s%s\n\
1645 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1647 if (SYSTEM_GDBINIT_DIR
[0])
1648 gdb_printf (stream
, _("\
1649 --with-system-gdbinit-dir=%s%s\n\
1650 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1652 /* We assume "relocatable" will be printed at least once, thus we always
1653 print this text. It's a reasonably safe assumption for now. */
1654 gdb_printf (stream
, _("\n\
1655 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1656 tree, and GDB will still find it.)\n\
1661 /* The current top level prompt, settable with "set prompt", and/or
1662 with the python `gdb.prompt_hook' hook. */
1663 static std::string top_prompt
;
1665 /* Access method for the GDB prompt string. */
1673 /* Set method for the GDB prompt string. */
1676 set_prompt (const char *s
)
1682 /* Kills or detaches the given inferior, depending on how we originally
1683 gained control of it. */
1686 kill_or_detach (inferior
*inf
, int from_tty
)
1691 thread_info
*thread
= any_thread_of_inferior (inf
);
1694 switch_to_thread (thread
);
1696 /* Leave core files alone. */
1697 if (target_has_execution ())
1699 if (inf
->attach_flag
)
1700 target_detach (inf
, from_tty
);
1707 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1708 where to collect the output. */
1711 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1716 if (inf
->attach_flag
)
1718 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1719 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1722 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1723 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1726 /* If necessary, make the user confirm that we should quit. Return
1727 non-zero if we should quit, zero if we shouldn't. */
1732 /* Don't even ask if we're only debugging a core file inferior. */
1733 if (!have_live_inferiors ())
1736 /* Build the query string as a single string. */
1739 stb
.puts (_("A debugging session is active.\n\n"));
1741 for (inferior
*inf
: all_inferiors ())
1742 print_inferior_quit_action (inf
, &stb
);
1744 stb
.puts (_("\nQuit anyway? "));
1746 return query ("%s", stb
.c_str ());
1749 /* Prepare to exit GDB cleanly by undoing any changes made to the
1750 terminal so that we leave the terminal in the state we acquired it. */
1753 undo_terminal_modifications_before_exit (void)
1755 struct ui
*saved_top_level
= current_ui
;
1757 target_terminal::ours ();
1759 current_ui
= main_ui
;
1764 gdb_disable_readline ();
1766 current_ui
= saved_top_level
;
1770 /* Quit without asking for confirmation. */
1773 quit_force (int *exit_arg
, int from_tty
)
1777 /* An optional expression may be used to cause gdb to terminate with the
1778 value of that expression. */
1780 exit_code
= *exit_arg
;
1781 else if (return_child_result
)
1782 exit_code
= return_child_result_value
;
1784 gdb::observers::gdb_exiting
.notify (exit_code
);
1786 undo_terminal_modifications_before_exit ();
1788 /* We want to handle any quit errors and exit regardless. */
1790 /* Get out of tfind mode, and kill or detach all inferiors. */
1793 disconnect_tracing ();
1794 for (inferior
*inf
: all_inferiors ())
1795 kill_or_detach (inf
, from_tty
);
1797 catch (const gdb_exception
&ex
)
1799 exception_print (gdb_stderr
, ex
);
1802 /* Give all pushed targets a chance to do minimal cleanup, and pop
1804 for (inferior
*inf
: all_inferiors ())
1806 switch_to_inferior_no_thread (inf
);
1811 catch (const gdb_exception
&ex
)
1813 exception_print (gdb_stderr
, ex
);
1817 /* Save the history information if it is appropriate to do so. */
1820 if (write_history_p
&& !history_filename
.empty ())
1824 /* History is currently shared between all UIs. If there's
1825 any UI with a terminal, save history. */
1826 for (ui
*ui
: all_uis ())
1828 if (input_interactive_p (ui
))
1836 gdb_safe_append_history ();
1839 catch (const gdb_exception
&ex
)
1841 exception_print (gdb_stderr
, ex
);
1844 /* Destroy any values currently allocated now instead of leaving it
1845 to global destructors, because that may be too late. For
1846 example, the destructors of xmethod values call into the Python
1847 runtime, which is finalized via a final cleanup. */
1850 /* Do any final cleanups before exiting. */
1853 do_final_cleanups ();
1855 catch (const gdb_exception
&ex
)
1857 exception_print (gdb_stderr
, ex
);
1863 /* The value of the "interactive-mode" setting. */
1864 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1866 /* Implement the "show interactive-mode" option. */
1869 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1870 struct cmd_list_element
*c
,
1873 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1874 gdb_printf (file
, "Debugger's interactive mode "
1875 "is %s (currently %s).\n",
1876 value
, input_interactive_p (current_ui
) ? "on" : "off");
1878 gdb_printf (file
, "Debugger's interactive mode is %s.\n", value
);
1881 /* Returns whether GDB is running on an interactive terminal. */
1884 input_interactive_p (struct ui
*ui
)
1889 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1890 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1892 return ui
->input_interactive_p
;
1896 dont_repeat_command (const char *ignored
, int from_tty
)
1898 /* Can't call dont_repeat here because we're not necessarily reading
1900 *saved_command_line
= 0;
1903 /* Functions to manipulate command line editing control variables. */
1905 /* Number of commands to print in each call to show_commands. */
1906 #define Hist_print 10
1908 show_commands (const char *args
, int from_tty
)
1910 /* Index for history commands. Relative to history_base. */
1913 /* Number of the history entry which we are planning to display next.
1914 Relative to history_base. */
1917 /* Print out some of the commands from the command history. */
1921 if (args
[0] == '+' && args
[1] == '\0')
1922 /* "info editing +" should print from the stored position. */
1925 /* "info editing <exp>" should print around command number <exp>. */
1926 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1928 /* "show commands" means print the last Hist_print commands. */
1931 num
= history_length
- Hist_print
;
1937 /* If there are at least Hist_print commands, we want to display the last
1938 Hist_print rather than, say, the last 6. */
1939 if (history_length
- num
< Hist_print
)
1941 num
= history_length
- Hist_print
;
1947 offset
< num
+ Hist_print
&& offset
< history_length
;
1950 gdb_printf ("%5d %s\n", history_base
+ offset
,
1951 (history_get (history_base
+ offset
))->line
);
1954 /* The next command we want to display is the next one that we haven't
1958 /* If the user repeats this command with return, it should do what
1959 "show commands +" does. This is unnecessary if arg is null,
1960 because "show commands +" is not useful after "show commands". */
1961 if (from_tty
&& args
)
1962 set_repeat_arguments ("+");
1965 /* Update the size of our command history file to HISTORY_SIZE.
1967 A HISTORY_SIZE of -1 stands for unlimited. */
1970 set_readline_history_size (int history_size
)
1972 gdb_assert (history_size
>= -1);
1974 if (history_size
== -1)
1975 unstifle_history ();
1977 stifle_history (history_size
);
1980 /* Called by do_setshow_command. */
1982 set_history_size_command (const char *args
,
1983 int from_tty
, struct cmd_list_element
*c
)
1985 set_readline_history_size (history_size_setshow_var
);
1988 bool info_verbose
= false; /* Default verbose msgs off. */
1990 /* Called by do_set_command. An elaborate joke. */
1992 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1994 const char *cmdname
= "verbose";
1995 struct cmd_list_element
*showcmd
;
1997 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, NULL
, 1);
1998 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
2000 if (c
->doc
&& c
->doc_allocated
)
2001 xfree ((char *) c
->doc
);
2002 if (showcmd
->doc
&& showcmd
->doc_allocated
)
2003 xfree ((char *) showcmd
->doc
);
2006 c
->doc
= _("Set verbose printing of informational messages.");
2007 showcmd
->doc
= _("Show verbose printing of informational messages.");
2011 c
->doc
= _("Set verbosity.");
2012 showcmd
->doc
= _("Show verbosity.");
2014 c
->doc_allocated
= 0;
2015 showcmd
->doc_allocated
= 0;
2018 /* Init the history buffer. Note that we are called after the init file(s)
2019 have been read so that the user can change the history file via his
2020 .gdbinit file (for instance). The GDBHISTFILE environment variable
2021 overrides all of this. */
2028 tmpenv
= getenv ("GDBHISTSIZE");
2035 tmpenv
= skip_spaces (tmpenv
);
2037 var
= strtol (tmpenv
, &endptr
, 10);
2038 saved_errno
= errno
;
2039 endptr
= skip_spaces (endptr
);
2041 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
2042 empty string, a negative number or a huge positive number (larger than
2043 INT_MAX) then set the history size to unlimited. Otherwise set our
2044 history size to the number we have read. This behavior is consistent
2045 with how bash handles HISTSIZE. */
2046 if (*endptr
!= '\0')
2048 else if (*tmpenv
== '\0'
2051 /* On targets where INT_MAX == LONG_MAX, we have to look at
2052 errno after calling strtol to distinguish between a value that
2053 is exactly INT_MAX and an overflowing value that was clamped
2055 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2056 history_size_setshow_var
= -1;
2058 history_size_setshow_var
= var
;
2061 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2063 if (history_size_setshow_var
== -2)
2064 history_size_setshow_var
= 256;
2066 set_readline_history_size (history_size_setshow_var
);
2068 if (!history_filename
.empty ())
2069 read_history (history_filename
.c_str ());
2073 show_prompt (struct ui_file
*file
, int from_tty
,
2074 struct cmd_list_element
*c
, const char *value
)
2076 gdb_printf (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2079 /* "set editing" command. */
2082 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2084 change_line_handler (set_editing_cmd_var
);
2085 /* Update the control variable so that MI's =cmd-param-changed event
2086 shows the correct value. */
2087 set_editing_cmd_var
= current_ui
->command_editing
;
2091 show_editing (struct ui_file
*file
, int from_tty
,
2092 struct cmd_list_element
*c
, const char *value
)
2094 gdb_printf (file
, _("Editing of command lines as "
2095 "they are typed is %s.\n"),
2096 current_ui
->command_editing
? _("on") : _("off"));
2100 show_annotation_level (struct ui_file
*file
, int from_tty
,
2101 struct cmd_list_element
*c
, const char *value
)
2103 gdb_printf (file
, _("Annotation_level is %s.\n"), value
);
2107 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2108 struct cmd_list_element
*c
, const char *value
)
2110 gdb_printf (file
, _("Notification of completion for "
2111 "asynchronous execution commands is %s.\n"),
2115 /* New values of the "data-directory" parameter are staged here.
2116 Extension languages, for example Python's gdb.parameter API, will read
2117 the value directory from this variable, so we must ensure that this
2118 always contains the correct value. */
2119 static std::string staged_gdb_datadir
;
2121 /* "set" command for the gdb_datadir configuration variable. */
2124 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2126 set_gdb_data_directory (staged_gdb_datadir
.c_str ());
2128 /* SET_GDB_DATA_DIRECTORY will resolve relative paths in
2129 STAGED_GDB_DATADIR, so we now copy the value from GDB_DATADIR
2130 back into STAGED_GDB_DATADIR so the extension languages can read the
2132 staged_gdb_datadir
= gdb_datadir
;
2134 gdb::observers::gdb_datadir_changed
.notify ();
2137 /* "show" command for the gdb_datadir configuration variable. */
2140 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2141 struct cmd_list_element
*c
, const char *value
)
2143 gdb_printf (file
, _("GDB's data directory is \"%ps\".\n"),
2144 styled_string (file_name_style
.style (),
2145 gdb_datadir
.c_str ()));
2148 /* Implement 'set history filename'. */
2151 set_history_filename (const char *args
,
2152 int from_tty
, struct cmd_list_element
*c
)
2154 /* We include the current directory so that if the user changes
2155 directories the file written will be the same as the one
2157 if (!history_filename
.empty ()
2158 && !IS_ABSOLUTE_PATH (history_filename
.c_str ()))
2160 gdb::unique_xmalloc_ptr
<char> temp
2161 (gdb_abspath (history_filename
.c_str ()));
2163 history_filename
= temp
.get ();
2167 /* Whether we're in quiet startup mode. */
2169 static bool startup_quiet
;
2176 return startup_quiet
;
2179 /* Show whether GDB should start up in quiet mode. */
2182 show_startup_quiet (struct ui_file
*file
, int from_tty
,
2183 struct cmd_list_element
*c
, const char *value
)
2185 gdb_printf (file
, _("Whether to start up quietly is %s.\n"),
2190 init_gdb_version_vars (void)
2192 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2193 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2194 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2195 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2196 set_internalvar_integer (major_version_var
, vmajor
);
2197 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2203 struct cmd_list_element
*c
;
2205 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2206 the DEFAULT_PROMPT is. */
2207 set_prompt (DEFAULT_PROMPT
);
2209 /* Set the important stuff up for command editing. */
2210 command_editing_p
= 1;
2211 history_expansion_p
= 0;
2212 write_history_p
= 0;
2214 /* Setup important stuff for command line editing. */
2215 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2216 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2217 set_rl_completer_word_break_characters (default_word_break_characters ());
2218 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2219 rl_completion_display_matches_hook
= cli_display_match_list
;
2220 rl_readline_name
= "gdb";
2221 rl_terminal_name
= getenv ("TERM");
2223 /* The name for this defun comes from Bash, where it originated.
2224 15 is Control-o, the same binding this function has in Bash. */
2225 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2227 add_setshow_string_cmd ("prompt", class_support
,
2229 _("Set gdb's prompt."),
2230 _("Show gdb's prompt."),
2233 &setlist
, &showlist
);
2235 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2236 Don't repeat this command.\nPrimarily \
2237 used inside of user-defined commands that should not be repeated when\n\
2240 add_setshow_boolean_cmd ("editing", class_support
,
2241 &set_editing_cmd_var
, _("\
2242 Set editing of command lines as they are typed."), _("\
2243 Show editing of command lines as they are typed."), _("\
2244 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2245 Without an argument, command line editing is enabled. To edit, use\n\
2246 EMACS-like or VI-like commands like control-P or ESC."),
2249 &setlist
, &showlist
);
2251 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2252 Set saving of the history record on exit."), _("\
2253 Show saving of the history record on exit."), _("\
2254 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2255 Without an argument, saving is enabled."),
2257 show_write_history_p
,
2258 &sethistlist
, &showhistlist
);
2260 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2261 &history_size_setshow_var
, _("\
2262 Set the size of the command history."), _("\
2263 Show the size of the command history."), _("\
2264 This is the number of previous commands to keep a record of.\n\
2265 If set to \"unlimited\", the number of commands kept in the history\n\
2266 list is unlimited. This defaults to the value of the environment\n\
2267 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2268 set_history_size_command
,
2270 &sethistlist
, &showhistlist
);
2272 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2273 &history_remove_duplicates
, _("\
2274 Set how far back in history to look for and remove duplicate entries."), _("\
2275 Show how far back in history to look for and remove duplicate entries."), _("\
2276 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2277 and remove the first history entry that is a duplicate of the most recent\n\
2278 entry, each time a new history entry is added.\n\
2279 If set to \"unlimited\", this lookbehind is unbounded.\n\
2280 Only history entries added during this session are considered for removal.\n\
2281 If set to 0, removal of duplicate history entries is disabled.\n\
2282 By default this option is set to 0."),
2284 show_history_remove_duplicates
,
2285 &sethistlist
, &showhistlist
);
2287 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2288 Set the filename in which to record the command history."), _("\
2289 Show the filename in which to record the command history."), _("\
2290 (the list of previous commands of which a record is kept)."),
2291 set_history_filename
,
2292 show_history_filename
,
2293 &sethistlist
, &showhistlist
);
2295 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2296 Set whether to confirm potentially dangerous operations."), _("\
2297 Show whether to confirm potentially dangerous operations."), NULL
,
2300 &setlist
, &showlist
);
2302 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2303 Set annotation_level."), _("\
2304 Show annotation_level."), _("\
2305 0 == normal; 1 == fullname (for use when running under emacs)\n\
2306 2 == output annotated suitably for use by programs that control GDB."),
2308 show_annotation_level
,
2309 &setlist
, &showlist
);
2311 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2312 &exec_done_display_p
, _("\
2313 Set notification of completion for asynchronous execution commands."), _("\
2314 Show notification of completion for asynchronous execution commands."), _("\
2315 Use \"on\" to enable the notification, and \"off\" to disable it."),
2317 show_exec_done_display_p
,
2318 &setlist
, &showlist
);
2320 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2321 &staged_gdb_datadir
, _("Set GDB's data directory."),
2322 _("Show GDB's data directory."),
2324 When set, GDB uses the specified path to search for data files."),
2325 set_gdb_datadir
, show_gdb_datadir
,
2328 /* Prime the initial value for data-directory. */
2329 staged_gdb_datadir
= gdb_datadir
;
2331 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2332 &interactive_mode
, _("\
2333 Set whether GDB's standard input is a terminal."), _("\
2334 Show whether GDB's standard input is a terminal."), _("\
2335 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2336 means that GDB should wait for the user to answer queries associated to\n\
2337 commands entered at the command prompt. If off, GDB assumes that standard\n\
2338 input is not a terminal, and uses the default answer to all queries.\n\
2339 If auto (the default), determine which mode to use based on the standard\n\
2342 show_interactive_mode
,
2343 &setlist
, &showlist
);
2345 add_setshow_boolean_cmd ("startup-quietly", class_support
,
2346 &startup_quiet
, _("\
2347 Set whether GDB should start up quietly."), _(" \
2348 Show whether GDB should start up quietly."), _("\
2349 This setting will not affect the current session. Instead this command\n\
2350 should be added to the .gdbearlyinit file in the users home directory to\n\
2351 affect future GDB sessions."),
2354 &setlist
, &showlist
);
2356 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2358 Usage: new-ui INTERPRETER TTY\n\
2359 The first argument is the name of the interpreter to run.\n\
2360 The second argument is the terminal the UI runs on."), &cmdlist
);
2361 set_cmd_completer (c
, interpreter_completer
);
2369 saved_command_line
= xstrdup ("");
2370 previous_saved_command_line
= xstrdup ("");
2372 /* Run the init function of each source file. */
2375 /* Make sure we return to the original directory upon exit, come
2376 what may, since the OS doesn't do that for us. */
2377 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2380 init_cmd_lists (); /* This needs to be done first. */
2384 /* Here is where we call all the _initialize_foo routines. */
2385 initialize_all_files ();
2387 /* This creates the current_program_space. Do this after all the
2388 _initialize_foo routines have had a chance to install their
2389 per-sspace data keys. Also do this before
2390 initialize_current_architecture is called, because it accesses
2391 exec_bfd of the current program space. */
2392 initialize_progspace ();
2393 initialize_inferiors ();
2394 initialize_current_architecture ();
2395 init_main (); /* But that omits this file! Do it now. */
2397 initialize_stdin_serial ();
2399 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2401 set_initial_gdb_ttystate ();
2403 gdb_init_signals ();
2405 /* We need a default language for parsing expressions, so simple
2406 things like "set width 0" won't fail if no language is explicitly
2407 set in a config file or implicitly set by reading an executable
2409 set_language (language_c
);
2410 expected_language
= current_language
; /* Don't warn about the change. */
2412 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2413 init_gdb_version_vars ();
2416 void _initialize_top ();
2420 /* Determine a default value for the history filename. */
2421 const char *tmpenv
= getenv ("GDBHISTFILE");
2422 if (tmpenv
!= nullptr)
2423 history_filename
= tmpenv
;
2426 /* We include the current directory so that if the user changes
2427 directories the file written will be the same as the one
2430 /* No leading dots in file names are allowed on MSDOS. */
2431 const char *fname
= "_gdb_history";
2433 const char *fname
= ".gdb_history";
2436 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (fname
));
2437 history_filename
= temp
.get ();