1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2022 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "cli/cli-cmds.h"
23 #include "cli/cli-script.h"
24 #include "cli/cli-setshow.h"
25 #include "cli/cli-decode.h"
31 #include "target-dcache.h"
32 #include "breakpoint.h"
34 #include "expression.h"
38 #include "gdbsupport/job-control.h"
40 #include "completer.h"
42 #include "gdbsupport/version.h"
45 #include "gdbsupport/event-loop.h"
46 #include "gdbthread.h"
47 #include "extension.h"
49 #include "observable.h"
51 #include "filenames.h"
53 #include "gdbsupport/buffer.h"
54 #include "gdbsupport/gdb_select.h"
55 #include "gdbsupport/scope-exit.h"
57 #include "gdbsupport/pathstuff.h"
58 #include "cli/cli-style.h"
60 /* readline include files. */
61 #include "readline/readline.h"
62 #include "readline/history.h"
64 /* readline defines this. */
67 #include <sys/types.h>
69 #include "event-top.h"
74 #include "tracepoint.h"
85 extern void initialize_all_files (void);
87 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
88 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
89 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
91 /* Default command line prompt. This is overridden in some configs. */
93 #ifndef DEFAULT_PROMPT
94 #define DEFAULT_PROMPT "(gdb) "
98 current_ui_gdb_stdout_ptr ()
100 return ¤t_ui
->m_gdb_stdout
;
104 current_ui_gdb_stdin_ptr ()
106 return ¤t_ui
->m_gdb_stdin
;
110 current_ui_gdb_stderr_ptr ()
112 return ¤t_ui
->m_gdb_stderr
;
116 current_ui_gdb_stdlog_ptr ()
118 return ¤t_ui
->m_gdb_stdlog
;
122 current_ui_current_uiout_ptr ()
124 return ¤t_ui
->m_current_uiout
;
127 int inhibit_gdbinit
= 0;
129 /* Flag for whether we want to confirm potentially dangerous
130 operations. Default is yes. */
135 show_confirm (struct ui_file
*file
, int from_tty
,
136 struct cmd_list_element
*c
, const char *value
)
138 fprintf_filtered (file
, _("Whether to confirm potentially "
139 "dangerous operations is %s.\n"),
143 /* Current working directory. */
145 char *current_directory
;
147 /* The last command line executed on the console. Used for command
148 repetitions when the user enters an empty line. */
150 static char *saved_command_line
;
152 /* If not NULL, the arguments that should be passed if
153 saved_command_line is repeated. */
155 static const char *repeat_arguments
;
157 /* The previous last command line executed on the console. Used for command
158 repetitions when a command wants to relaunch the previously launched
159 command. We need this as when a command is running, saved_command_line
160 already contains the line of the currently executing command. */
162 static char *previous_saved_command_line
;
164 /* If not NULL, the arguments that should be passed if the
165 previous_saved_command_line is repeated. */
167 static const char *previous_repeat_arguments
;
169 /* Nonzero if the current command is modified by "server ". This
170 affects things like recording into the command history, commands
171 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
172 whatever) can issue its own commands and also send along commands
173 from the user, and have the user not notice that the user interface
174 is issuing commands too. */
177 /* Timeout limit for response from target. */
179 /* The default value has been changed many times over the years. It
180 was originally 5 seconds. But that was thought to be a long time
181 to sit and wait, so it was changed to 2 seconds. That was thought
182 to be plenty unless the connection was going through some terminal
183 server or multiplexer or other form of hairy serial connection.
185 In mid-1996, remote_timeout was moved from remote.c to top.c and
186 it began being used in other remote-* targets. It appears that the
187 default was changed to 20 seconds at that time, perhaps because the
188 Renesas E7000 ICE didn't always respond in a timely manner.
190 But if 5 seconds is a long time to sit and wait for retransmissions,
191 20 seconds is far worse. This demonstrates the difficulty of using
192 a single variable for all protocol timeouts.
194 As remote.c is used much more than remote-e7000.c, it was changed
195 back to 2 seconds in 1999. */
197 int remote_timeout
= 2;
199 /* Sbrk location on entry to main. Used for statistics only. */
200 #ifdef HAVE_USEFUL_SBRK
204 /* Hooks for alternate command interfaces. */
206 /* This hook is called from within gdb's many mini-event loops which
207 could steal control from a real user interface's event loop. It
208 returns non-zero if the user is requesting a detach, zero
211 int (*deprecated_ui_loop_hook
) (int);
214 /* Called from print_frame_info to list the line we stopped in. */
216 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
220 /* Replaces most of query. */
222 int (*deprecated_query_hook
) (const char *, va_list);
224 /* Replaces most of warning. */
226 void (*deprecated_warning_hook
) (const char *, va_list);
228 /* These three functions support getting lines of text from the user.
229 They are used in sequence. First deprecated_readline_begin_hook is
230 called with a text string that might be (for example) a message for
231 the user to type in a sequence of commands to be executed at a
232 breakpoint. If this function calls back to a GUI, it might take
233 this opportunity to pop up a text interaction window with this
234 message. Next, deprecated_readline_hook is called with a prompt
235 that is emitted prior to collecting the user input. It can be
236 called multiple times. Finally, deprecated_readline_end_hook is
237 called to notify the GUI that we are done with the interaction
238 window and it can close it. */
240 void (*deprecated_readline_begin_hook
) (const char *, ...);
241 char *(*deprecated_readline_hook
) (const char *);
242 void (*deprecated_readline_end_hook
) (void);
244 /* Called as appropriate to notify the interface that we have attached
245 to or detached from an already running process. */
247 void (*deprecated_attach_hook
) (void);
248 void (*deprecated_detach_hook
) (void);
250 /* Used by UI as a wrapper around command execution. May do various
251 things like enabling/disabling buttons, etc... */
253 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
254 const char *cmd
, int from_tty
);
256 /* Called when the current thread changes. Argument is thread id. */
258 void (*deprecated_context_hook
) (int id
);
260 /* The highest UI number ever assigned. */
261 static int highest_ui_num
;
265 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
267 num (++highest_ui_num
),
268 call_readline (nullptr),
269 input_handler (nullptr),
271 interp_info (nullptr),
273 secondary_prompt_depth (0),
274 stdin_stream (instream_
),
275 instream (instream_
),
276 outstream (outstream_
),
277 errstream (errstream_
),
278 input_fd (fileno (instream
)),
279 input_interactive_p (ISATTY (instream
)),
280 prompt_state (PROMPT_NEEDED
),
281 m_gdb_stdout (new stdio_file (outstream
)),
282 m_gdb_stdin (new stdio_file (instream
)),
283 m_gdb_stderr (new stderr_file (errstream
)),
284 m_gdb_stdlog (m_gdb_stderr
),
285 m_current_uiout (nullptr)
287 buffer_init (&line_buffer
);
295 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
303 struct ui
*ui
, *uiprev
;
307 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
311 gdb_assert (ui
!= NULL
);
323 /* Open file named NAME for read/write, making sure not to make it the
324 controlling terminal. */
327 open_terminal_stream (const char *name
)
329 scoped_fd fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
331 perror_with_name (_("opening terminal failed"));
333 return fd
.to_file ("w+");
336 /* Implementation of the "new-ui" command. */
339 new_ui_command (const char *args
, int from_tty
)
342 const char *interpreter_name
;
343 const char *tty_name
;
347 gdb_argv
argv (args
);
348 argc
= argv
.count ();
351 error (_("Usage: new-ui INTERPRETER TTY"));
353 interpreter_name
= argv
[0];
357 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
359 /* Open specified terminal. Note: we used to open it three times,
360 once for each of stdin/stdout/stderr, but that does not work
361 with Windows named pipes. */
362 gdb_file_up stream
= open_terminal_stream (tty_name
);
364 std::unique_ptr
<ui
> ui
365 (new struct ui (stream
.get (), stream
.get (), stream
.get ()));
369 current_ui
= ui
.get ();
371 set_top_level_interpreter (interpreter_name
);
373 interp_pre_command_loop (top_level_interpreter ());
375 /* Make sure the file is not closed. */
381 printf_filtered ("New UI allocated\n");
384 /* Handler for SIGHUP. */
387 /* NOTE 1999-04-29: This function will be static again, once we modify
388 gdb to use the event loop as the default command loop and we merge
389 event-top.c into this file, top.c. */
393 /* Stop asking user for confirmation --- we're exiting. This
394 prevents asking the user dumb questions. */
396 quit_command ((char *) 0, 0);
398 #endif /* defined SIGHUP */
400 /* Line number we are currently in, in a file which is being sourced. */
401 /* NOTE 1999-04-29: This variable will be static again, once we modify
402 gdb to use the event loop as the default command loop and we merge
403 event-top.c into this file, top.c. */
404 /* static */ int source_line_number
;
406 /* Name of the file we are sourcing. */
407 /* NOTE 1999-04-29: This variable will be static again, once we modify
408 gdb to use the event loop as the default command loop and we merge
409 event-top.c into this file, top.c. */
410 /* static */ std::string source_file_name
;
412 /* Read commands from STREAM. */
414 read_command_file (FILE *stream
)
416 struct ui
*ui
= current_ui
;
418 scoped_restore save_instream
419 = make_scoped_restore (&ui
->instream
, stream
);
421 /* Read commands from `instream' and execute them until end of file
422 or error reading instream. */
424 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
428 /* Get a command-line. This calls the readline package. */
429 command
= command_line_input (NULL
, NULL
);
432 command_handler (command
);
438 do_chdir_cleanup (void *old_dir
)
440 chdir ((const char *) old_dir
);
446 prepare_execute_command ()
448 /* With multiple threads running while the one we're examining is
449 stopped, the dcache can get stale without us being able to detect
450 it. For the duration of the command, though, use the dcache to
451 help things like backtrace. */
453 target_dcache_invalidate ();
455 return scoped_value_mark ();
458 /* Tell the user if the language has changed (except first time) after
459 executing a command. */
462 check_frame_language_change (void)
464 static int warned
= 0;
465 struct frame_info
*frame
;
467 /* First make sure that a new frame has been selected, in case the
468 command or the hooks changed the program state. */
469 frame
= deprecated_safe_get_selected_frame ();
470 if (current_language
!= expected_language
)
472 if (language_mode
== language_mode_auto
&& info_verbose
)
474 /* Print what changed. */
480 /* Warn the user if the working language does not match the language
481 of the current frame. Only warn the user if we are actually
482 running the program, i.e. there is a stack. */
483 /* FIXME: This should be cacheing the frame and only running when
484 the frame changes. */
486 if (has_stack_frames ())
490 flang
= get_frame_language (frame
);
492 && flang
!= language_unknown
493 && flang
!= current_language
->la_language
)
495 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
504 wait_sync_command_done (void)
506 /* Processing events may change the current UI. */
507 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
508 struct ui
*ui
= current_ui
;
510 /* We're about to wait until the target stops after having resumed
511 it so must force-commit resumptions, in case we're being called
512 in some context where a scoped_disable_commit_resumed object is
513 active. I.e., this function is a commit-resumed sync/flush
515 scoped_enable_commit_resumed
enable ("sync wait");
517 while (gdb_do_one_event () >= 0)
518 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
525 maybe_wait_sync_command_done (int was_sync
)
527 /* If the interpreter is in sync mode (we're running a user
528 command's list, running command hooks or similars), and we
529 just ran a synchronous command that started the target, wait
530 for that command to end. */
531 if (!current_ui
->async
533 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
534 wait_sync_command_done ();
540 set_repeat_arguments (const char *args
)
542 repeat_arguments
= args
;
545 /* Execute the line P as a command, in the current user context.
546 Pass FROM_TTY as second argument to the defining function. */
549 execute_command (const char *p
, int from_tty
)
551 struct cmd_list_element
*c
;
553 const char *cmd_start
= p
;
555 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
556 scoped_value_mark cleanup
= prepare_execute_command ();
558 /* This can happen when command_line_input hits end of file. */
561 cleanup_if_error
.release ();
565 target_log_command (p
);
567 while (*p
== ' ' || *p
== '\t')
573 std::string default_args
;
574 std::string default_args_and_arg
;
575 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
579 /* If trace-commands is set then this will print this command. */
580 print_command_trace ("%s", p
);
582 c
= lookup_cmd (&cmd
, cmdlist
, "", &default_args
, 0, 1);
585 scoped_restore save_repeat_args
586 = make_scoped_restore (&repeat_arguments
, nullptr);
587 const char *args_pointer
= p
;
589 if (!default_args
.empty ())
592 default_args_and_arg
= default_args
+ ' ' + p
;
594 default_args_and_arg
= default_args
;
595 arg
= default_args_and_arg
.c_str ();
599 /* Pass null arg rather than an empty one. */
600 arg
= *p
== '\0' ? nullptr : p
;
603 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
604 while the is_complete_command(cfunc) test is just plain
605 bogus. They should both be replaced by a test of the form
606 c->strip_trailing_white_space_p. */
607 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
608 can't be replaced with func. This is because it is the
609 cfunc, and not the func, that has the value that the
610 is_complete_command hack is testing for. */
611 /* Clear off trailing whitespace, except for set and complete
613 std::string without_whitespace
;
615 && c
->type
!= set_cmd
616 && !is_complete_command (c
))
618 const char *old_end
= arg
+ strlen (arg
) - 1;
620 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
624 without_whitespace
= std::string (arg
, p
+ 1);
625 arg
= without_whitespace
.c_str ();
629 /* If this command has been pre-hooked, run the hook first. */
630 execute_cmd_pre_hook (c
);
632 if (c
->deprecated_warn_user
)
633 deprecated_cmd_warning (line
, cmdlist
);
635 /* c->user_commands would be NULL in the case of a python command. */
636 if (c
->theclass
== class_user
&& c
->user_commands
)
637 execute_user_command (c
, arg
);
638 else if (c
->theclass
== class_user
639 && c
->is_prefix () && !c
->allow_unknown
)
640 /* If this is a user defined prefix that does not allow unknown
641 (in other words, C is a prefix command and not a command
642 that can be followed by its args), report the list of
645 std::string prefixname
= c
->prefixname ();
646 std::string prefixname_no_space
647 = prefixname
.substr (0, prefixname
.length () - 1);
649 ("\"%s\" must be followed by the name of a subcommand.\n",
650 prefixname_no_space
.c_str ());
651 help_list (*c
->subcommands
, prefixname
.c_str (), all_commands
,
654 else if (c
->type
== set_cmd
)
655 do_set_command (arg
, from_tty
, c
);
656 else if (c
->type
== show_cmd
)
657 do_show_command (arg
, from_tty
, c
);
658 else if (c
->is_command_class_help ())
659 error (_("That is not a command, just a help topic."));
660 else if (deprecated_call_command_hook
)
661 deprecated_call_command_hook (c
, arg
, from_tty
);
663 cmd_func (c
, arg
, from_tty
);
665 maybe_wait_sync_command_done (was_sync
);
667 /* If this command has been post-hooked, run the hook last. */
668 execute_cmd_post_hook (c
);
670 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
672 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
673 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
678 /* Only perform the frame-language-change check if the command
679 we just finished executing did not resume the inferior's execution.
680 If it did resume the inferior, we will do that check after
681 the inferior stopped. */
682 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
683 check_frame_language_change ();
685 cleanup_if_error
.release ();
691 execute_fn_to_ui_file (struct ui_file
*file
, std::function
<void(void)> fn
)
693 /* GDB_STDOUT should be better already restored during these
694 restoration callbacks. */
695 set_batch_flag_and_restore_page_info save_page_info
;
697 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
700 current_uiout
->redirect (file
);
701 ui_out_redirect_pop
redirect_popper (current_uiout
);
703 scoped_restore save_stdout
704 = make_scoped_restore (&gdb_stdout
, file
);
705 scoped_restore save_stderr
706 = make_scoped_restore (&gdb_stderr
, file
);
707 scoped_restore save_stdlog
708 = make_scoped_restore (&gdb_stdlog
, file
);
709 scoped_restore save_stdtarg
710 = make_scoped_restore (&gdb_stdtarg
, file
);
711 scoped_restore save_stdtargerr
712 = make_scoped_restore (&gdb_stdtargerr
, file
);
721 execute_fn_to_string (std::string
&res
, std::function
<void(void)> fn
,
724 string_file
str_file (term_out
);
728 execute_fn_to_ui_file (&str_file
, fn
);
733 res
= std::move (str_file
.string ());
738 res
= std::move (str_file
.string ());
744 execute_command_to_ui_file (struct ui_file
*file
,
745 const char *p
, int from_tty
)
747 execute_fn_to_ui_file (file
, [=]() { execute_command (p
, from_tty
); });
753 execute_command_to_string (std::string
&res
, const char *p
, int from_tty
,
756 execute_fn_to_string (res
, [=]() { execute_command (p
, from_tty
); },
763 execute_command_to_string (const char *p
, int from_tty
,
767 execute_fn_to_string (dummy
, [=]() { execute_command (p
, from_tty
); },
771 /* When nonzero, cause dont_repeat to do nothing. This should only be
772 set via prevent_dont_repeat. */
774 static int suppress_dont_repeat
= 0;
781 struct ui
*ui
= current_ui
;
783 if (suppress_dont_repeat
|| server_command
)
786 /* If we aren't reading from standard input, we are saving the last
787 thing read from stdin in line and don't want to delete it. Null
788 lines won't repeat here in any case. */
789 if (ui
->instream
== ui
->stdin_stream
)
791 *saved_command_line
= 0;
792 repeat_arguments
= NULL
;
801 /* Do not repeat this command, as this command is a repeating command. */
804 /* We cannot free saved_command_line, as this line is being executed,
805 so swap it with previous_saved_command_line. */
806 std::swap (previous_saved_command_line
, saved_command_line
);
807 std::swap (previous_repeat_arguments
, repeat_arguments
);
809 const char *prev
= skip_spaces (get_saved_command_line ());
811 error (_("No previous command to relaunch"));
817 scoped_restore_tmpl
<int>
818 prevent_dont_repeat (void)
820 return make_scoped_restore (&suppress_dont_repeat
, 1);
826 get_saved_command_line ()
828 return saved_command_line
;
834 save_command_line (const char *cmd
)
836 xfree (previous_saved_command_line
);
837 previous_saved_command_line
= saved_command_line
;
838 previous_repeat_arguments
= repeat_arguments
;
839 saved_command_line
= xstrdup (cmd
);
840 repeat_arguments
= NULL
;
844 /* Read a line from the stream "instream" without command line editing.
846 It prints PROMPT once at the start.
847 Action is compatible with "readline", e.g. space for the result is
848 malloc'd and should be freed by the caller.
850 A NULL return means end of file. */
853 gdb_readline_no_editing (const char *prompt
)
855 struct buffer line_buffer
;
856 struct ui
*ui
= current_ui
;
857 /* Read from stdin if we are executing a user defined command. This
858 is the right thing for prompt_for_continue, at least. */
859 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
860 int fd
= fileno (stream
);
862 buffer_init (&line_buffer
);
866 /* Don't use a _filtered function here. It causes the assumed
867 character position to be off, since the newline we read from
868 the user is not accounted for. */
869 printf_unfiltered ("%s", prompt
);
870 gdb_flush (gdb_stdout
);
880 /* Wait until at least one byte of data is available. Control-C
881 can interrupt interruptible_select, but not fgetc. */
883 FD_SET (fd
, &readfds
);
884 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
888 /* If this was ctrl-c, the QUIT above handles it. */
891 perror_with_name (("select"));
898 if (line_buffer
.used_size
> 0)
899 /* The last line does not end with a newline. Return it, and
900 if we are called again fgetc will still return EOF and
901 we'll return NULL then. */
903 xfree (buffer_finish (&line_buffer
));
909 if (line_buffer
.used_size
> 0
910 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
911 line_buffer
.used_size
--;
915 buffer_grow_char (&line_buffer
, c
);
918 buffer_grow_char (&line_buffer
, '\0');
919 return buffer_finish (&line_buffer
);
922 /* Variables which control command line editing and history
923 substitution. These variables are given default values at the end
925 static bool command_editing_p
;
927 /* NOTE 1999-04-29: This variable will be static again, once we modify
928 gdb to use the event loop as the default command loop and we merge
929 event-top.c into this file, top.c. */
931 /* static */ bool history_expansion_p
;
933 /* Should we write out the command history on exit? In order to write out
934 the history both this flag must be true, and the history_filename
935 variable must be set to something sensible. */
936 static bool write_history_p
;
938 /* The name of the file in which GDB history will be written. If this is
939 set to NULL, of the empty string then history will not be written. */
940 static std::string history_filename
;
942 /* Implement 'show history save'. */
944 show_write_history_p (struct ui_file
*file
, int from_tty
,
945 struct cmd_list_element
*c
, const char *value
)
947 if (!write_history_p
|| !history_filename
.empty ())
948 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
951 fprintf_filtered (file
, _("Saving of the history is disabled due to "
952 "the value of 'history filename'.\n"));
955 /* The variable associated with the "set/show history size"
956 command. The value -1 means unlimited, and -2 means undefined. */
957 static int history_size_setshow_var
= -2;
960 show_history_size (struct ui_file
*file
, int from_tty
,
961 struct cmd_list_element
*c
, const char *value
)
963 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
967 /* Variable associated with the "history remove-duplicates" option.
968 The value -1 means unlimited. */
969 static int history_remove_duplicates
= 0;
972 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
973 struct cmd_list_element
*c
, const char *value
)
975 fprintf_filtered (file
,
976 _("The number of history entries to look back at for "
977 "duplicates is %s.\n"),
981 /* Implement 'show history filename'. */
983 show_history_filename (struct ui_file
*file
, int from_tty
,
984 struct cmd_list_element
*c
, const char *value
)
986 if (!history_filename
.empty ())
987 fprintf_filtered (file
, _("The filename in which to record "
988 "the command history is \"%ps\".\n"),
989 styled_string (file_name_style
.style (), value
));
991 fprintf_filtered (file
, _("There is no filename currently set for "
992 "recording the command history in.\n"));
995 /* This is like readline(), but it has some gdb-specific behavior.
996 gdb may want readline in both the synchronous and async modes during
997 a single gdb invocation. At the ordinary top-level prompt we might
998 be using the async readline. That means we can't use
999 rl_pre_input_hook, since it doesn't work properly in async mode.
1000 However, for a secondary prompt (" >", such as occurs during a
1001 `define'), gdb wants a synchronous response.
1003 We used to call readline() directly, running it in synchronous
1004 mode. But mixing modes this way is not supported, and as of
1005 readline 5.x it no longer works; the arrow keys come unbound during
1006 the synchronous call. So we make a nested call into the event
1007 loop. That's what gdb_readline_wrapper is for. */
1009 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
1010 rely on gdb_readline_wrapper_result, which might still be NULL if
1011 the user types Control-D for EOF. */
1012 static int gdb_readline_wrapper_done
;
1014 /* The result of the current call to gdb_readline_wrapper, once a newline
1016 static char *gdb_readline_wrapper_result
;
1018 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
1019 to be called after the newline is processed (which will redisplay
1020 the prompt). But in gdb_readline_wrapper we will not get a new
1021 prompt until the next call, or until we return to the event loop.
1022 So we disable this hook around the newline and restore it before we
1024 static void (*saved_after_char_processing_hook
) (void);
1030 gdb_in_secondary_prompt_p (struct ui
*ui
)
1032 return ui
->secondary_prompt_depth
> 0;
1036 /* This function is called when readline has seen a complete line of
1040 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
1042 gdb_assert (!gdb_readline_wrapper_done
);
1043 gdb_readline_wrapper_result
= line
.release ();
1044 gdb_readline_wrapper_done
= 1;
1046 /* Prevent operate-and-get-next from acting too early. */
1047 saved_after_char_processing_hook
= after_char_processing_hook
;
1048 after_char_processing_hook
= NULL
;
1050 /* Prevent parts of the prompt from being redisplayed if annotations
1051 are enabled, and readline's state getting out of sync. We'll
1052 reinstall the callback handler, which puts the terminal in raw
1053 mode (or in readline lingo, in prepped state), when we're next
1054 ready to process user input, either in display_gdb_prompt, or if
1055 we're handling an asynchronous target event and running in the
1056 background, just before returning to the event loop to process
1057 further input (or more target events). */
1058 if (current_ui
->command_editing
)
1059 gdb_rl_callback_handler_remove ();
1062 class gdb_readline_wrapper_cleanup
1065 gdb_readline_wrapper_cleanup ()
1066 : m_handler_orig (current_ui
->input_handler
),
1067 m_already_prompted_orig (current_ui
->command_editing
1068 ? rl_already_prompted
: 0),
1069 m_target_is_async_orig (target_is_async_p ()),
1070 m_save_ui (¤t_ui
)
1072 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1073 current_ui
->secondary_prompt_depth
++;
1075 if (m_target_is_async_orig
)
1079 ~gdb_readline_wrapper_cleanup ()
1081 struct ui
*ui
= current_ui
;
1083 if (ui
->command_editing
)
1084 rl_already_prompted
= m_already_prompted_orig
;
1086 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1087 ui
->input_handler
= m_handler_orig
;
1089 /* Don't restore our input handler in readline yet. That would make
1090 readline prep the terminal (putting it in raw mode), while the
1091 line we just read may trigger execution of a command that expects
1092 the terminal in the default cooked/canonical mode, such as e.g.,
1093 running Python's interactive online help utility. See
1094 gdb_readline_wrapper_line for when we'll reinstall it. */
1096 gdb_readline_wrapper_result
= NULL
;
1097 gdb_readline_wrapper_done
= 0;
1098 ui
->secondary_prompt_depth
--;
1099 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1101 after_char_processing_hook
= saved_after_char_processing_hook
;
1102 saved_after_char_processing_hook
= NULL
;
1104 if (m_target_is_async_orig
)
1108 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1112 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1113 int m_already_prompted_orig
;
1115 /* Whether the target was async. */
1116 int m_target_is_async_orig
;
1118 /* Processing events may change the current UI. */
1119 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1123 gdb_readline_wrapper (const char *prompt
)
1125 struct ui
*ui
= current_ui
;
1127 gdb_readline_wrapper_cleanup cleanup
;
1129 /* Display our prompt and prevent double prompt display. Don't pass
1130 down a NULL prompt, since that has special meaning for
1131 display_gdb_prompt -- it indicates a request to print the primary
1132 prompt, while we want a secondary prompt here. */
1133 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1134 if (ui
->command_editing
)
1135 rl_already_prompted
= 1;
1137 if (after_char_processing_hook
)
1138 (*after_char_processing_hook
) ();
1139 gdb_assert (after_char_processing_hook
== NULL
);
1141 while (gdb_do_one_event () >= 0)
1142 if (gdb_readline_wrapper_done
)
1145 return gdb_readline_wrapper_result
;
1149 /* The current saved history number from operate-and-get-next.
1150 This is -1 if not valid. */
1151 static int operate_saved_history
= -1;
1153 /* This is put on the appropriate hook and helps operate-and-get-next
1156 gdb_rl_operate_and_get_next_completion (void)
1158 int delta
= where_history () - operate_saved_history
;
1160 /* The `key' argument to rl_get_previous_history is ignored. */
1161 rl_get_previous_history (delta
, 0);
1162 operate_saved_history
= -1;
1164 /* readline doesn't automatically update the display for us. */
1167 after_char_processing_hook
= NULL
;
1168 rl_pre_input_hook
= NULL
;
1171 /* This is a gdb-local readline command handler. It accepts the
1172 current command line (like RET does) and, if this command was taken
1173 from the history, arranges for the next command in the history to
1174 appear on the command line when the prompt returns.
1175 We ignore the arguments. */
1177 gdb_rl_operate_and_get_next (int count
, int key
)
1181 /* Use the async hook. */
1182 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1184 /* Find the current line, and find the next line to use. */
1185 where
= where_history();
1187 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1188 || (where
>= history_length
- 1))
1189 operate_saved_history
= where
;
1191 operate_saved_history
= where
+ 1;
1193 return rl_newline (1, key
);
1196 /* Number of user commands executed during this session. */
1198 static int command_count
= 0;
1200 /* Add the user command COMMAND to the input history list. */
1203 gdb_add_history (const char *command
)
1207 if (history_remove_duplicates
!= 0)
1210 int lookbehind_threshold
;
1212 /* The lookbehind threshold for finding a duplicate history entry is
1213 bounded by command_count because we can't meaningfully delete
1214 history entries that are already stored in the history file since
1215 the history file is appended to. */
1216 if (history_remove_duplicates
== -1
1217 || history_remove_duplicates
> command_count
)
1218 lookbehind_threshold
= command_count
;
1220 lookbehind_threshold
= history_remove_duplicates
;
1223 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1225 HIST_ENTRY
*temp
= previous_history ();
1230 if (strcmp (temp
->line
, command
) == 0)
1232 HIST_ENTRY
*prev
= remove_history (where_history ());
1234 free_history_entry (prev
);
1241 add_history (command
);
1244 /* Safely append new history entries to the history file in a corruption-free
1245 way using an intermediate local history file. */
1248 gdb_safe_append_history (void)
1250 int ret
, saved_errno
;
1252 std::string local_history_filename
1253 = string_printf ("%s-gdb%ld~", history_filename
.c_str (), (long) getpid ());
1255 ret
= rename (history_filename
.c_str (), local_history_filename
.c_str ());
1256 saved_errno
= errno
;
1257 if (ret
< 0 && saved_errno
!= ENOENT
)
1259 warning (_("Could not rename %ps to %ps: %s"),
1260 styled_string (file_name_style
.style (),
1261 history_filename
.c_str ()),
1262 styled_string (file_name_style
.style (),
1263 local_history_filename
.c_str ()),
1264 safe_strerror (saved_errno
));
1270 /* If the rename failed with ENOENT then either the global history
1271 file never existed in the first place or another GDB process is
1272 currently appending to it (and has thus temporarily renamed it).
1273 Since we can't distinguish between these two cases, we have to
1274 conservatively assume the first case and therefore must write out
1275 (not append) our known history to our local history file and try
1276 to move it back anyway. Otherwise a global history file would
1277 never get created! */
1278 gdb_assert (saved_errno
== ENOENT
);
1279 write_history (local_history_filename
.c_str ());
1283 append_history (command_count
, local_history_filename
.c_str ());
1284 if (history_is_stifled ())
1285 history_truncate_file (local_history_filename
.c_str (),
1286 history_max_entries
);
1289 ret
= rename (local_history_filename
.c_str (), history_filename
.c_str ());
1290 saved_errno
= errno
;
1291 if (ret
< 0 && saved_errno
!= EEXIST
)
1292 warning (_("Could not rename %s to %s: %s"),
1293 local_history_filename
.c_str (), history_filename
.c_str (),
1294 safe_strerror (saved_errno
));
1298 /* Read one line from the command input stream `instream' into a local
1299 static buffer. The buffer is made bigger as necessary. Returns
1300 the address of the start of the line.
1302 NULL is returned for end of file.
1304 This routine either uses fancy command line editing or simple input
1305 as the user has requested. */
1308 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1310 static struct buffer cmd_line_buffer
;
1311 static int cmd_line_buffer_initialized
;
1312 struct ui
*ui
= current_ui
;
1313 const char *prompt
= prompt_arg
;
1315 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1317 /* The annotation suffix must be non-NULL. */
1318 if (annotation_suffix
== NULL
)
1319 annotation_suffix
= "";
1321 if (from_tty
&& annotation_level
> 1)
1326 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1327 + strlen (annotation_suffix
) + 40);
1329 local_prompt
[0] = '\0';
1331 strcpy (local_prompt
, prompt
);
1332 strcat (local_prompt
, "\n\032\032");
1333 strcat (local_prompt
, annotation_suffix
);
1334 strcat (local_prompt
, "\n");
1336 prompt
= local_prompt
;
1339 if (!cmd_line_buffer_initialized
)
1341 buffer_init (&cmd_line_buffer
);
1342 cmd_line_buffer_initialized
= 1;
1345 /* Starting a new command line. */
1346 cmd_line_buffer
.used_size
= 0;
1350 signal (SIGTSTP
, handle_sigtstp
);
1355 gdb::unique_xmalloc_ptr
<char> rl
;
1357 /* Make sure that all output has been output. Some machines may
1358 let you get away with leaving out some of the gdb_flush, but
1360 gdb_stdout
->wrap_here (0);
1361 gdb_flush (gdb_stdout
);
1362 gdb_flush (gdb_stderr
);
1364 if (!source_file_name
.empty ())
1365 ++source_line_number
;
1367 if (from_tty
&& annotation_level
> 1)
1368 printf_unfiltered ("\n\032\032pre-%s\n", annotation_suffix
);
1370 /* Don't use fancy stuff if not talking to stdin. */
1371 if (deprecated_readline_hook
1373 && input_interactive_p (current_ui
))
1375 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1377 else if (command_editing_p
1379 && input_interactive_p (current_ui
))
1381 rl
.reset (gdb_readline_wrapper (prompt
));
1385 rl
.reset (gdb_readline_no_editing (prompt
));
1388 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1389 0, annotation_suffix
);
1390 if (cmd
== (char *) EOF
)
1398 /* Got partial input. I.e., got a line that ends with a
1399 continuation character (backslash). Suppress printing the
1406 signal (SIGTSTP
, SIG_DFL
);
1414 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1416 /* From GNU coding standards, first line is meant to be easy for a
1417 program to parse, and is just canonical program name and version
1418 number, which starts after last space. */
1420 std::string v_str
= string_printf ("GNU gdb %s%s", PKGVERSION
, version
);
1421 fprintf_filtered (stream
, "%ps\n",
1422 styled_string (version_style
.style (), v_str
.c_str ()));
1424 /* Second line is a copyright notice. */
1426 fprintf_filtered (stream
,
1427 "Copyright (C) 2022 Free Software Foundation, Inc.\n");
1429 /* Following the copyright is a brief statement that the program is
1430 free software, that users are free to copy and change it on
1431 certain conditions, that it is covered by the GNU GPL, and that
1432 there is no warranty. */
1434 fprintf_filtered (stream
, "\
1435 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1436 \nThis is free software: you are free to change and redistribute it.\n\
1437 There is NO WARRANTY, to the extent permitted by law.");
1442 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1443 "\"show warranty\" for details.\n"));
1445 /* After the required info we print the configuration information. */
1447 fprintf_filtered (stream
, "This GDB was configured as \"");
1448 if (strcmp (host_name
, target_name
) != 0)
1450 fprintf_filtered (stream
, "--host=%s --target=%s",
1451 host_name
, target_name
);
1455 fprintf_filtered (stream
, "%s", host_name
);
1457 fprintf_filtered (stream
, "\".\n");
1459 fprintf_filtered (stream
, _("Type \"show configuration\" "
1460 "for configuration details.\n"));
1462 if (REPORT_BUGS_TO
[0])
1464 fprintf_filtered (stream
,
1465 _("For bug reporting instructions, please see:\n"));
1466 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1468 fprintf_filtered (stream
,
1469 _("Find the GDB manual and other documentation \
1470 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1471 fprintf_filtered (stream
, "\n\n");
1472 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1473 fprintf_filtered (stream
,
1474 _("Type \"apropos word\" to search for commands \
1475 related to \"word\"."));
1478 /* Print the details of GDB build-time configuration. */
1480 print_gdb_configuration (struct ui_file
*stream
)
1482 fprintf_filtered (stream
, _("\
1483 This GDB was configured as follows:\n\
1484 configure --host=%s --target=%s\n\
1485 "), host_name
, target_name
);
1487 fprintf_filtered (stream
, _("\
1488 --with-auto-load-dir=%s\n\
1489 --with-auto-load-safe-path=%s\n\
1490 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1493 fprintf_filtered (stream
, _("\
1497 fprintf_filtered (stream
, _("\
1503 fprintf_filtered (stream
, _("\
1504 --with-gdb-datadir=%s%s\n\
1505 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1508 fprintf_filtered (stream
, _("\
1509 --with-iconv-bin=%s%s\n\
1510 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1513 if (JIT_READER_DIR
[0])
1514 fprintf_filtered (stream
, _("\
1515 --with-jit-reader-dir=%s%s\n\
1516 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1518 #if HAVE_LIBUNWIND_IA64_H
1519 fprintf_filtered (stream
, _("\
1520 --with-libunwind-ia64\n\
1523 fprintf_filtered (stream
, _("\
1524 --without-libunwind-ia64\n\
1529 fprintf_filtered (stream
, _("\
1533 fprintf_filtered (stream
, _("\
1538 #if HAVE_LIBBABELTRACE
1539 fprintf_filtered (stream
, _("\
1540 --with-babeltrace\n\
1543 fprintf_filtered (stream
, _("\
1544 --without-babeltrace\n\
1549 fprintf_filtered (stream
, _("\
1553 fprintf_filtered (stream
, _("\
1554 --without-intel-pt\n\
1559 fprintf_filtered (stream
, _("\
1563 fprintf_filtered (stream
, _("\
1568 fprintf_filtered (stream
, _("\
1572 fprintf_filtered (stream
, _("\
1576 #ifdef WITH_PYTHON_PATH
1577 fprintf_filtered (stream
, _("\
1578 --with-python=%s%s\n\
1579 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1581 fprintf_filtered (stream
, _("\
1585 #ifdef WITH_PYTHON_LIBDIR
1586 fprintf_filtered (stream
, _("\
1587 --with-python-libdir=%s%s\n\
1588 "), WITH_PYTHON_LIBDIR
, PYTHON_LIBDIR_RELOCATABLE
? " (relocatable)" : "");
1590 fprintf_filtered (stream
, _("\
1591 --without-python-libdir\n\
1595 #if HAVE_LIBDEBUGINFOD
1596 fprintf_filtered (stream
, _("\
1597 --with-debuginfod\n\
1600 fprintf_filtered (stream
, _("\
1601 --without-debuginfod\n\
1606 fprintf_filtered (stream
, _("\
1610 fprintf_filtered (stream
, _("\
1615 #if HAVE_SOURCE_HIGHLIGHT
1616 fprintf_filtered (stream
, _("\
1617 --enable-source-highlight\n\
1620 fprintf_filtered (stream
, _("\
1621 --disable-source-highlight\n\
1626 fprintf_filtered (stream
, _("\
1627 --with-relocated-sources=%s\n\
1632 fprintf_filtered (stream
, _("\
1633 --with-separate-debug-dir=%s%s\n\
1634 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1636 if (TARGET_SYSTEM_ROOT
[0])
1637 fprintf_filtered (stream
, _("\
1638 --with-sysroot=%s%s\n\
1639 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1641 if (SYSTEM_GDBINIT
[0])
1642 fprintf_filtered (stream
, _("\
1643 --with-system-gdbinit=%s%s\n\
1644 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1646 if (SYSTEM_GDBINIT_DIR
[0])
1647 fprintf_filtered (stream
, _("\
1648 --with-system-gdbinit-dir=%s%s\n\
1649 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1651 /* We assume "relocatable" will be printed at least once, thus we always
1652 print this text. It's a reasonably safe assumption for now. */
1653 fprintf_filtered (stream
, _("\n\
1654 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1655 tree, and GDB will still find it.)\n\
1660 /* The current top level prompt, settable with "set prompt", and/or
1661 with the python `gdb.prompt_hook' hook. */
1662 static std::string top_prompt
;
1664 /* Access method for the GDB prompt string. */
1672 /* Set method for the GDB prompt string. */
1675 set_prompt (const char *s
)
1681 /* Kills or detaches the given inferior, depending on how we originally
1682 gained control of it. */
1685 kill_or_detach (inferior
*inf
, int from_tty
)
1690 thread_info
*thread
= any_thread_of_inferior (inf
);
1693 switch_to_thread (thread
);
1695 /* Leave core files alone. */
1696 if (target_has_execution ())
1698 if (inf
->attach_flag
)
1699 target_detach (inf
, from_tty
);
1706 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1707 where to collect the output. */
1710 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1715 if (inf
->attach_flag
)
1716 fprintf_filtered (out
,
1717 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1718 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1720 fprintf_filtered (out
,
1721 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1722 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1725 /* If necessary, make the user confirm that we should quit. Return
1726 non-zero if we should quit, zero if we shouldn't. */
1731 /* Don't even ask if we're only debugging a core file inferior. */
1732 if (!have_live_inferiors ())
1735 /* Build the query string as a single string. */
1738 stb
.puts (_("A debugging session is active.\n\n"));
1740 for (inferior
*inf
: all_inferiors ())
1741 print_inferior_quit_action (inf
, &stb
);
1743 stb
.puts (_("\nQuit anyway? "));
1745 return query ("%s", stb
.c_str ());
1748 /* Prepare to exit GDB cleanly by undoing any changes made to the
1749 terminal so that we leave the terminal in the state we acquired it. */
1752 undo_terminal_modifications_before_exit (void)
1754 struct ui
*saved_top_level
= current_ui
;
1756 target_terminal::ours ();
1758 current_ui
= main_ui
;
1763 gdb_disable_readline ();
1765 current_ui
= saved_top_level
;
1769 /* Quit without asking for confirmation. */
1772 quit_force (int *exit_arg
, int from_tty
)
1776 /* An optional expression may be used to cause gdb to terminate with the
1777 value of that expression. */
1779 exit_code
= *exit_arg
;
1780 else if (return_child_result
)
1781 exit_code
= return_child_result_value
;
1783 gdb::observers::gdb_exiting
.notify (exit_code
);
1785 undo_terminal_modifications_before_exit ();
1787 /* We want to handle any quit errors and exit regardless. */
1789 /* Get out of tfind mode, and kill or detach all inferiors. */
1792 disconnect_tracing ();
1793 for (inferior
*inf
: all_inferiors ())
1794 kill_or_detach (inf
, from_tty
);
1796 catch (const gdb_exception
&ex
)
1798 exception_print (gdb_stderr
, ex
);
1801 /* Give all pushed targets a chance to do minimal cleanup, and pop
1803 for (inferior
*inf
: all_inferiors ())
1805 switch_to_inferior_no_thread (inf
);
1810 catch (const gdb_exception
&ex
)
1812 exception_print (gdb_stderr
, ex
);
1816 /* Save the history information if it is appropriate to do so. */
1819 if (write_history_p
&& !history_filename
.empty ())
1823 /* History is currently shared between all UIs. If there's
1824 any UI with a terminal, save history. */
1825 for (ui
*ui
: all_uis ())
1827 if (input_interactive_p (ui
))
1835 gdb_safe_append_history ();
1838 catch (const gdb_exception
&ex
)
1840 exception_print (gdb_stderr
, ex
);
1843 /* Destroy any values currently allocated now instead of leaving it
1844 to global destructors, because that may be too late. For
1845 example, the destructors of xmethod values call into the Python
1846 runtime, which is finalized via a final cleanup. */
1849 /* Do any final cleanups before exiting. */
1852 do_final_cleanups ();
1854 catch (const gdb_exception
&ex
)
1856 exception_print (gdb_stderr
, ex
);
1862 /* The value of the "interactive-mode" setting. */
1863 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1865 /* Implement the "show interactive-mode" option. */
1868 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1869 struct cmd_list_element
*c
,
1872 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1873 fprintf_filtered (file
, "Debugger's interactive mode "
1874 "is %s (currently %s).\n",
1875 value
, input_interactive_p (current_ui
) ? "on" : "off");
1877 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1880 /* Returns whether GDB is running on an interactive terminal. */
1883 input_interactive_p (struct ui
*ui
)
1888 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1889 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1891 return ui
->input_interactive_p
;
1895 dont_repeat_command (const char *ignored
, int from_tty
)
1897 /* Can't call dont_repeat here because we're not necessarily reading
1899 *saved_command_line
= 0;
1902 /* Functions to manipulate command line editing control variables. */
1904 /* Number of commands to print in each call to show_commands. */
1905 #define Hist_print 10
1907 show_commands (const char *args
, int from_tty
)
1909 /* Index for history commands. Relative to history_base. */
1912 /* Number of the history entry which we are planning to display next.
1913 Relative to history_base. */
1916 /* Print out some of the commands from the command history. */
1920 if (args
[0] == '+' && args
[1] == '\0')
1921 /* "info editing +" should print from the stored position. */
1924 /* "info editing <exp>" should print around command number <exp>. */
1925 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1927 /* "show commands" means print the last Hist_print commands. */
1930 num
= history_length
- Hist_print
;
1936 /* If there are at least Hist_print commands, we want to display the last
1937 Hist_print rather than, say, the last 6. */
1938 if (history_length
- num
< Hist_print
)
1940 num
= history_length
- Hist_print
;
1946 offset
< num
+ Hist_print
&& offset
< history_length
;
1949 printf_filtered ("%5d %s\n", history_base
+ offset
,
1950 (history_get (history_base
+ offset
))->line
);
1953 /* The next command we want to display is the next one that we haven't
1957 /* If the user repeats this command with return, it should do what
1958 "show commands +" does. This is unnecessary if arg is null,
1959 because "show commands +" is not useful after "show commands". */
1960 if (from_tty
&& args
)
1961 set_repeat_arguments ("+");
1964 /* Update the size of our command history file to HISTORY_SIZE.
1966 A HISTORY_SIZE of -1 stands for unlimited. */
1969 set_readline_history_size (int history_size
)
1971 gdb_assert (history_size
>= -1);
1973 if (history_size
== -1)
1974 unstifle_history ();
1976 stifle_history (history_size
);
1979 /* Called by do_setshow_command. */
1981 set_history_size_command (const char *args
,
1982 int from_tty
, struct cmd_list_element
*c
)
1984 set_readline_history_size (history_size_setshow_var
);
1987 bool info_verbose
= false; /* Default verbose msgs off. */
1989 /* Called by do_set_command. An elaborate joke. */
1991 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1993 const char *cmdname
= "verbose";
1994 struct cmd_list_element
*showcmd
;
1996 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, NULL
, 1);
1997 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1999 if (c
->doc
&& c
->doc_allocated
)
2000 xfree ((char *) c
->doc
);
2001 if (showcmd
->doc
&& showcmd
->doc_allocated
)
2002 xfree ((char *) showcmd
->doc
);
2005 c
->doc
= _("Set verbose printing of informational messages.");
2006 showcmd
->doc
= _("Show verbose printing of informational messages.");
2010 c
->doc
= _("Set verbosity.");
2011 showcmd
->doc
= _("Show verbosity.");
2013 c
->doc_allocated
= 0;
2014 showcmd
->doc_allocated
= 0;
2017 /* Init the history buffer. Note that we are called after the init file(s)
2018 have been read so that the user can change the history file via his
2019 .gdbinit file (for instance). The GDBHISTFILE environment variable
2020 overrides all of this. */
2027 tmpenv
= getenv ("GDBHISTSIZE");
2034 tmpenv
= skip_spaces (tmpenv
);
2036 var
= strtol (tmpenv
, &endptr
, 10);
2037 saved_errno
= errno
;
2038 endptr
= skip_spaces (endptr
);
2040 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
2041 empty string, a negative number or a huge positive number (larger than
2042 INT_MAX) then set the history size to unlimited. Otherwise set our
2043 history size to the number we have read. This behavior is consistent
2044 with how bash handles HISTSIZE. */
2045 if (*endptr
!= '\0')
2047 else if (*tmpenv
== '\0'
2050 /* On targets where INT_MAX == LONG_MAX, we have to look at
2051 errno after calling strtol to distinguish between a value that
2052 is exactly INT_MAX and an overflowing value that was clamped
2054 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2055 history_size_setshow_var
= -1;
2057 history_size_setshow_var
= var
;
2060 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2062 if (history_size_setshow_var
== -2)
2063 history_size_setshow_var
= 256;
2065 set_readline_history_size (history_size_setshow_var
);
2067 if (!history_filename
.empty ())
2068 read_history (history_filename
.c_str ());
2072 show_prompt (struct ui_file
*file
, int from_tty
,
2073 struct cmd_list_element
*c
, const char *value
)
2075 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2078 /* "set editing" command. */
2081 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2083 change_line_handler (set_editing_cmd_var
);
2084 /* Update the control variable so that MI's =cmd-param-changed event
2085 shows the correct value. */
2086 set_editing_cmd_var
= current_ui
->command_editing
;
2090 show_editing (struct ui_file
*file
, int from_tty
,
2091 struct cmd_list_element
*c
, const char *value
)
2093 fprintf_filtered (file
, _("Editing of command lines as "
2094 "they are typed is %s.\n"),
2095 current_ui
->command_editing
? _("on") : _("off"));
2099 show_annotation_level (struct ui_file
*file
, int from_tty
,
2100 struct cmd_list_element
*c
, const char *value
)
2102 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2106 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2107 struct cmd_list_element
*c
, const char *value
)
2109 fprintf_filtered (file
, _("Notification of completion for "
2110 "asynchronous execution commands is %s.\n"),
2114 /* New values of the "data-directory" parameter are staged here.
2115 Extension languages, for example Python's gdb.parameter API, will read
2116 the value directory from this variable, so we must ensure that this
2117 always contains the correct value. */
2118 static std::string staged_gdb_datadir
;
2120 /* "set" command for the gdb_datadir configuration variable. */
2123 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2125 set_gdb_data_directory (staged_gdb_datadir
.c_str ());
2127 /* SET_GDB_DATA_DIRECTORY will resolve relative paths in
2128 STAGED_GDB_DATADIR, so we now copy the value from GDB_DATADIR
2129 back into STAGED_GDB_DATADIR so the extension languages can read the
2131 staged_gdb_datadir
= gdb_datadir
;
2133 gdb::observers::gdb_datadir_changed
.notify ();
2136 /* "show" command for the gdb_datadir configuration variable. */
2139 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2140 struct cmd_list_element
*c
, const char *value
)
2142 fprintf_filtered (file
, _("GDB's data directory is \"%ps\".\n"),
2143 styled_string (file_name_style
.style (),
2144 gdb_datadir
.c_str ()));
2147 /* Implement 'set history filename'. */
2150 set_history_filename (const char *args
,
2151 int from_tty
, struct cmd_list_element
*c
)
2153 /* We include the current directory so that if the user changes
2154 directories the file written will be the same as the one
2156 if (!history_filename
.empty ()
2157 && !IS_ABSOLUTE_PATH (history_filename
.c_str ()))
2159 gdb::unique_xmalloc_ptr
<char> temp
2160 (gdb_abspath (history_filename
.c_str ()));
2162 history_filename
= temp
.get ();
2166 /* Whether we're in quiet startup mode. */
2168 static bool startup_quiet
;
2175 return startup_quiet
;
2178 /* Show whether GDB should start up in quiet mode. */
2181 show_startup_quiet (struct ui_file
*file
, int from_tty
,
2182 struct cmd_list_element
*c
, const char *value
)
2184 fprintf_filtered (file
, _("Whether to start up quietly is %s.\n"),
2189 init_gdb_version_vars (void)
2191 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2192 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2193 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2194 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2195 set_internalvar_integer (major_version_var
, vmajor
);
2196 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2202 struct cmd_list_element
*c
;
2204 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2205 the DEFAULT_PROMPT is. */
2206 set_prompt (DEFAULT_PROMPT
);
2208 /* Set the important stuff up for command editing. */
2209 command_editing_p
= 1;
2210 history_expansion_p
= 0;
2211 write_history_p
= 0;
2213 /* Setup important stuff for command line editing. */
2214 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2215 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2216 set_rl_completer_word_break_characters (default_word_break_characters ());
2217 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2218 rl_completion_display_matches_hook
= cli_display_match_list
;
2219 rl_readline_name
= "gdb";
2220 rl_terminal_name
= getenv ("TERM");
2222 /* The name for this defun comes from Bash, where it originated.
2223 15 is Control-o, the same binding this function has in Bash. */
2224 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2226 add_setshow_string_cmd ("prompt", class_support
,
2228 _("Set gdb's prompt."),
2229 _("Show gdb's prompt."),
2232 &setlist
, &showlist
);
2234 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2235 Don't repeat this command.\nPrimarily \
2236 used inside of user-defined commands that should not be repeated when\n\
2239 add_setshow_boolean_cmd ("editing", class_support
,
2240 &set_editing_cmd_var
, _("\
2241 Set editing of command lines as they are typed."), _("\
2242 Show editing of command lines as they are typed."), _("\
2243 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2244 Without an argument, command line editing is enabled. To edit, use\n\
2245 EMACS-like or VI-like commands like control-P or ESC."),
2248 &setlist
, &showlist
);
2250 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2251 Set saving of the history record on exit."), _("\
2252 Show saving of the history record on exit."), _("\
2253 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2254 Without an argument, saving is enabled."),
2256 show_write_history_p
,
2257 &sethistlist
, &showhistlist
);
2259 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2260 &history_size_setshow_var
, _("\
2261 Set the size of the command history."), _("\
2262 Show the size of the command history."), _("\
2263 This is the number of previous commands to keep a record of.\n\
2264 If set to \"unlimited\", the number of commands kept in the history\n\
2265 list is unlimited. This defaults to the value of the environment\n\
2266 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2267 set_history_size_command
,
2269 &sethistlist
, &showhistlist
);
2271 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2272 &history_remove_duplicates
, _("\
2273 Set how far back in history to look for and remove duplicate entries."), _("\
2274 Show how far back in history to look for and remove duplicate entries."), _("\
2275 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2276 and remove the first history entry that is a duplicate of the most recent\n\
2277 entry, each time a new history entry is added.\n\
2278 If set to \"unlimited\", this lookbehind is unbounded.\n\
2279 Only history entries added during this session are considered for removal.\n\
2280 If set to 0, removal of duplicate history entries is disabled.\n\
2281 By default this option is set to 0."),
2283 show_history_remove_duplicates
,
2284 &sethistlist
, &showhistlist
);
2286 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2287 Set the filename in which to record the command history."), _("\
2288 Show the filename in which to record the command history."), _("\
2289 (the list of previous commands of which a record is kept)."),
2290 set_history_filename
,
2291 show_history_filename
,
2292 &sethistlist
, &showhistlist
);
2294 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2295 Set whether to confirm potentially dangerous operations."), _("\
2296 Show whether to confirm potentially dangerous operations."), NULL
,
2299 &setlist
, &showlist
);
2301 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2302 Set annotation_level."), _("\
2303 Show annotation_level."), _("\
2304 0 == normal; 1 == fullname (for use when running under emacs)\n\
2305 2 == output annotated suitably for use by programs that control GDB."),
2307 show_annotation_level
,
2308 &setlist
, &showlist
);
2310 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2311 &exec_done_display_p
, _("\
2312 Set notification of completion for asynchronous execution commands."), _("\
2313 Show notification of completion for asynchronous execution commands."), _("\
2314 Use \"on\" to enable the notification, and \"off\" to disable it."),
2316 show_exec_done_display_p
,
2317 &setlist
, &showlist
);
2319 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2320 &staged_gdb_datadir
, _("Set GDB's data directory."),
2321 _("Show GDB's data directory."),
2323 When set, GDB uses the specified path to search for data files."),
2324 set_gdb_datadir
, show_gdb_datadir
,
2327 /* Prime the initial value for data-directory. */
2328 staged_gdb_datadir
= gdb_datadir
;
2330 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2331 &interactive_mode
, _("\
2332 Set whether GDB's standard input is a terminal."), _("\
2333 Show whether GDB's standard input is a terminal."), _("\
2334 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2335 means that GDB should wait for the user to answer queries associated to\n\
2336 commands entered at the command prompt. If off, GDB assumes that standard\n\
2337 input is not a terminal, and uses the default answer to all queries.\n\
2338 If auto (the default), determine which mode to use based on the standard\n\
2341 show_interactive_mode
,
2342 &setlist
, &showlist
);
2344 add_setshow_boolean_cmd ("startup-quietly", class_support
,
2345 &startup_quiet
, _("\
2346 Set whether GDB should start up quietly."), _(" \
2347 Show whether GDB should start up quietly."), _("\
2348 This setting will not affect the current session. Instead this command\n\
2349 should be added to the .gdbearlyinit file in the users home directory to\n\
2350 affect future GDB sessions."),
2353 &setlist
, &showlist
);
2355 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2357 Usage: new-ui INTERPRETER TTY\n\
2358 The first argument is the name of the interpreter to run.\n\
2359 The second argument is the terminal the UI runs on."), &cmdlist
);
2360 set_cmd_completer (c
, interpreter_completer
);
2368 saved_command_line
= xstrdup ("");
2369 previous_saved_command_line
= xstrdup ("");
2371 /* Run the init function of each source file. */
2374 /* Make sure we return to the original directory upon exit, come
2375 what may, since the OS doesn't do that for us. */
2376 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2379 init_cmd_lists (); /* This needs to be done first. */
2383 /* Here is where we call all the _initialize_foo routines. */
2384 initialize_all_files ();
2386 /* This creates the current_program_space. Do this after all the
2387 _initialize_foo routines have had a chance to install their
2388 per-sspace data keys. Also do this before
2389 initialize_current_architecture is called, because it accesses
2390 exec_bfd of the current program space. */
2391 initialize_progspace ();
2392 initialize_inferiors ();
2393 initialize_current_architecture ();
2394 init_main (); /* But that omits this file! Do it now. */
2396 initialize_stdin_serial ();
2398 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2400 set_initial_gdb_ttystate ();
2402 gdb_init_signals ();
2404 /* We need a default language for parsing expressions, so simple
2405 things like "set width 0" won't fail if no language is explicitly
2406 set in a config file or implicitly set by reading an executable
2408 set_language (language_c
);
2409 expected_language
= current_language
; /* Don't warn about the change. */
2411 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2412 init_gdb_version_vars ();
2415 void _initialize_top ();
2419 /* Determine a default value for the history filename. */
2420 const char *tmpenv
= getenv ("GDBHISTFILE");
2421 if (tmpenv
!= nullptr)
2422 history_filename
= tmpenv
;
2425 /* We include the current directory so that if the user changes
2426 directories the file written will be the same as the one
2429 /* No leading dots in file names are allowed on MSDOS. */
2430 const char *fname
= "_gdb_history";
2432 const char *fname
= ".gdb_history";
2435 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (fname
));
2436 history_filename
= temp
.get ();