1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2023 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 /* The last command line executed on the console. Used for command
145 repetitions when the user enters an empty line. */
147 static char *saved_command_line;
149 /* If not NULL, the arguments that should be passed if
150 saved_command_line is repeated. */
152 static const char *repeat_arguments;
154 /* The previous last command line executed on the console. Used for command
155 repetitions when a command wants to relaunch the previously launched
156 command. We need this as when a command is running, saved_command_line
157 already contains the line of the currently executing command. */
159 static char *previous_saved_command_line;
161 /* If not NULL, the arguments that should be passed if the
162 previous_saved_command_line is repeated. */
164 static const char *previous_repeat_arguments;
166 /* Nonzero if the current command is modified by "server ". This
167 affects things like recording into the command history, commands
168 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
169 whatever) can issue its own commands and also send along commands
170 from the user, and have the user not notice that the user interface
171 is issuing commands too. */
174 /* Timeout limit for response from target. */
176 /* The default value has been changed many times over the years. It
177 was originally 5 seconds. But that was thought to be a long time
178 to sit and wait, so it was changed to 2 seconds. That was thought
179 to be plenty unless the connection was going through some terminal
180 server or multiplexer or other form of hairy serial connection.
182 In mid-1996, remote_timeout was moved from remote.c to top.c and
183 it began being used in other remote-* targets. It appears that the
184 default was changed to 20 seconds at that time, perhaps because the
185 Renesas E7000 ICE didn't always respond in a timely manner.
187 But if 5 seconds is a long time to sit and wait for retransmissions,
188 20 seconds is far worse. This demonstrates the difficulty of using
189 a single variable for all protocol timeouts.
191 As remote.c is used much more than remote-e7000.c, it was changed
192 back to 2 seconds in 1999. */
194 int remote_timeout = 2;
196 /* Sbrk location on entry to main. Used for statistics only. */
197 #ifdef HAVE_USEFUL_SBRK
201 /* Hooks for alternate command interfaces. */
203 /* This hook is called from within gdb's many mini-event loops which
204 could steal control from a real user interface's event loop. It
205 returns non-zero if the user is requesting a detach, zero
208 int (*deprecated_ui_loop_hook) (int);
211 /* Called from print_frame_info to list the line we stopped in. */
213 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
217 /* Replaces most of query. */
219 int (*deprecated_query_hook) (const char *, va_list);
221 /* Replaces most of warning. */
223 void (*deprecated_warning_hook) (const char *, va_list);
225 /* These three functions support getting lines of text from the user.
226 They are used in sequence. First deprecated_readline_begin_hook is
227 called with a text string that might be (for example) a message for
228 the user to type in a sequence of commands to be executed at a
229 breakpoint. If this function calls back to a GUI, it might take
230 this opportunity to pop up a text interaction window with this
231 message. Next, deprecated_readline_hook is called with a prompt
232 that is emitted prior to collecting the user input. It can be
233 called multiple times. Finally, deprecated_readline_end_hook is
234 called to notify the GUI that we are done with the interaction
235 window and it can close it. */
237 void (*deprecated_readline_begin_hook) (const char *, ...);
238 char *(*deprecated_readline_hook) (const char *);
239 void (*deprecated_readline_end_hook) (void);
241 /* Called as appropriate to notify the interface that we have attached
242 to or detached from an already running process. */
244 void (*deprecated_attach_hook) (void);
245 void (*deprecated_detach_hook) (void);
247 /* Used by UI as a wrapper around command execution. May do various
248 things like enabling/disabling buttons, etc... */
250 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
251 const char *cmd, int from_tty);
253 /* Called when the current thread changes. Argument is thread id. */
255 void (*deprecated_context_hook) (int id);
257 /* The highest UI number ever assigned. */
258 static int highest_ui_num;
260 /* Unbuffer STREAM. This is a wrapper around setbuf(STREAM, nullptr)
261 which applies some special rules for MS-Windows hosts. */
264 unbuffer_stream (FILE *stream)
266 /* Unbuffer the input stream so that in gdb_readline_no_editing_callback,
267 the calls to fgetc fetch only one char at the time from STREAM.
269 This is important because gdb_readline_no_editing_callback will read
270 from STREAM up to the first '\n' character, after this GDB returns to
271 the event loop and relies on a select on STREAM indicating that more
274 If STREAM is buffered then the fgetc calls may have moved all the
275 pending input from the kernel into a local buffer, after which the
276 select will not indicate that more input is pending, and input after
277 the first '\n' will not be processed immediately.
279 Please ensure that any changes in this area run the MI tests with the
280 FORCE_SEPARATE_MI_TTY=1 flag being passed. */
283 /* With MS-Windows runtime, making stdin unbuffered when it's
284 connected to the terminal causes it to misbehave. */
285 if (!ISATTY (stream))
286 setbuf (stream, nullptr);
288 /* On GNU/Linux the issues described above can impact GDB even when
289 dealing with input from a terminal. For now we unbuffer the input
290 stream for everyone except MS-Windows. */
291 setbuf (stream, nullptr);
297 ui::ui (FILE *instream_, FILE *outstream_, FILE *errstream_)
298 : num (++highest_ui_num),
299 stdin_stream (instream_),
300 instream (instream_),
301 outstream (outstream_),
302 errstream (errstream_),
303 input_fd (fileno (instream)),
304 m_input_interactive_p (ISATTY (instream)),
305 m_gdb_stdout (new pager_file (new stdio_file (outstream))),
306 m_gdb_stdin (new stdio_file (instream)),
307 m_gdb_stderr (new stderr_file (errstream)),
308 m_gdb_stdlog (new timestamped_file (m_gdb_stderr))
310 unbuffer_stream (instream_);
318 for (last = ui_list; last->next != NULL; last = last->next)
326 struct ui *ui, *uiprev;
330 for (ui = ui_list; ui != NULL; uiprev = ui, ui = ui->next)
334 gdb_assert (ui != NULL);
346 /* Open file named NAME for read/write, making sure not to make it the
347 controlling terminal. */
350 open_terminal_stream (const char *name)
352 scoped_fd fd = gdb_open_cloexec (name, O_RDWR | O_NOCTTY, 0);
354 perror_with_name (_("opening terminal failed"));
356 return fd.to_file ("w+");
359 /* Implementation of the "new-ui" command. */
362 new_ui_command (const char *args, int from_tty)
365 const char *interpreter_name;
366 const char *tty_name;
370 gdb_argv argv (args);
371 argc = argv.count ();
374 error (_("Usage: new-ui INTERPRETER TTY"));
376 interpreter_name = argv[0];
380 scoped_restore save_ui = make_scoped_restore (¤t_ui);
382 /* Open specified terminal. Note: we used to open it three times,
383 once for each of stdin/stdout/stderr, but that does not work
384 with Windows named pipes. */
385 gdb_file_up stream = open_terminal_stream (tty_name);
387 std::unique_ptr<ui> ui
388 (new struct ui (stream.get (), stream.get (), stream.get ()));
392 current_ui = ui.get ();
394 set_top_level_interpreter (interpreter_name);
396 interp_pre_command_loop (top_level_interpreter ());
398 /* Make sure the file is not closed. */
404 gdb_printf ("New UI allocated\n");
407 /* Handler for SIGHUP. */
410 /* NOTE 1999-04-29: This function will be static again, once we modify
411 gdb to use the event loop as the default command loop and we merge
412 event-top.c into this file, top.c. */
416 /* Stop asking user for confirmation --- we're exiting. This
417 prevents asking the user dumb questions. */
419 quit_command ((char *) 0, 0);
421 #endif /* defined SIGHUP */
423 /* Line number we are currently in, in a file which is being sourced. */
424 /* NOTE 1999-04-29: This variable will be static again, once we modify
425 gdb to use the event loop as the default command loop and we merge
426 event-top.c into this file, top.c. */
427 /* static */ int source_line_number;
429 /* Name of the file we are sourcing. */
430 /* NOTE 1999-04-29: This variable will be static again, once we modify
431 gdb to use the event loop as the default command loop and we merge
432 event-top.c into this file, top.c. */
433 /* static */ std::string source_file_name;
435 /* Read commands from STREAM. */
437 read_command_file (FILE *stream)
439 struct ui *ui = current_ui;
441 unbuffer_stream (stream);
443 scoped_restore save_instream
444 = make_scoped_restore (&ui->instream, stream);
446 /* Read commands from `instream' and execute them until end of file
447 or error reading instream. */
449 while (ui->instream != NULL && !feof (ui->instream))
451 /* Get a command-line. This calls the readline package. */
452 std::string command_buffer;
454 = command_line_input (command_buffer, nullptr, nullptr);
455 if (command == nullptr)
457 command_handler (command);
463 do_chdir_cleanup (void *old_dir)
465 chdir ((const char *) old_dir);
471 prepare_execute_command ()
473 /* With multiple threads running while the one we're examining is
474 stopped, the dcache can get stale without us being able to detect
475 it. For the duration of the command, though, use the dcache to
476 help things like backtrace. */
478 target_dcache_invalidate ();
480 return scoped_value_mark ();
483 /* Tell the user if the language has changed (except first time) after
484 executing a command. */
487 check_frame_language_change (void)
489 static int warned = 0;
490 frame_info_ptr frame;
492 /* First make sure that a new frame has been selected, in case the
493 command or the hooks changed the program state. */
494 frame = deprecated_safe_get_selected_frame ();
495 if (current_language != expected_language)
497 if (language_mode == language_mode_auto && info_verbose)
499 /* Print what changed. */
505 /* Warn the user if the working language does not match the language
506 of the current frame. Only warn the user if we are actually
507 running the program, i.e. there is a stack. */
508 /* FIXME: This should be cacheing the frame and only running when
509 the frame changes. */
511 if (has_stack_frames ())
515 flang = get_frame_language (frame);
517 && flang != language_unknown
518 && flang != current_language->la_language)
520 gdb_printf ("%s\n", _(lang_frame_mismatch_warn));
529 wait_sync_command_done (void)
531 /* Processing events may change the current UI. */
532 scoped_restore save_ui = make_scoped_restore (¤t_ui);
533 struct ui *ui = current_ui;
535 /* We're about to wait until the target stops after having resumed
536 it so must force-commit resumptions, in case we're being called
537 in some context where a scoped_disable_commit_resumed object is
538 active. I.e., this function is a commit-resumed sync/flush
540 scoped_enable_commit_resumed enable ("sync wait");
542 while (gdb_do_one_event () >= 0)
543 if (ui->prompt_state != PROMPT_BLOCKED)
550 maybe_wait_sync_command_done (int was_sync)
552 /* If the interpreter is in sync mode (we're running a user
553 command's list, running command hooks or similars), and we
554 just ran a synchronous command that started the target, wait
555 for that command to end. */
556 if (!current_ui->async
558 && current_ui->prompt_state == PROMPT_BLOCKED)
559 wait_sync_command_done ();
565 set_repeat_arguments (const char *args)
567 repeat_arguments = args;
570 /* Execute the line P as a command, in the current user context.
571 Pass FROM_TTY as second argument to the defining function. */
574 execute_command (const char *p, int from_tty)
576 struct cmd_list_element *c;
578 const char *cmd_start = p;
580 auto cleanup_if_error = make_scope_exit (bpstat_clear_actions);
581 scoped_value_mark cleanup = prepare_execute_command ();
583 /* This can happen when command_line_input hits end of file. */
586 cleanup_if_error.release ();
590 std::string cmd_copy = p;
592 target_log_command (p);
594 while (*p == ' ' || *p == '\t')
600 std::string default_args;
601 std::string default_args_and_arg;
602 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
606 /* If trace-commands is set then this will print this command. */
607 print_command_trace ("%s", p);
609 c = lookup_cmd (&cmd, cmdlist, "", &default_args, 0, 1);
612 scoped_restore save_repeat_args
613 = make_scoped_restore (&repeat_arguments, nullptr);
614 const char *args_pointer = p;
616 if (!default_args.empty ())
619 default_args_and_arg = default_args + ' ' + p;
621 default_args_and_arg = default_args;
622 arg = default_args_and_arg.c_str ();
626 /* Pass null arg rather than an empty one. */
627 arg = *p == '\0' ? nullptr : p;
630 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
631 while the is_complete_command(cfunc) test is just plain
632 bogus. They should both be replaced by a test of the form
633 c->strip_trailing_white_space_p. */
634 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
635 can't be replaced with func. This is because it is the
636 cfunc, and not the func, that has the value that the
637 is_complete_command hack is testing for. */
638 /* Clear off trailing whitespace, except for set and complete
640 std::string without_whitespace;
642 && c->type != set_cmd
643 && !is_complete_command (c))
645 const char *old_end = arg + strlen (arg) - 1;
647 while (p >= arg && (*p == ' ' || *p == '\t'))
651 without_whitespace = std::string (arg, p + 1);
652 arg = without_whitespace.c_str ();
656 /* If this command has been pre-hooked, run the hook first. */
657 execute_cmd_pre_hook (c);
659 if (c->deprecated_warn_user)
660 deprecated_cmd_warning (line, cmdlist);
662 /* c->user_commands would be NULL in the case of a python command. */
663 if (c->theclass == class_user && c->user_commands)
664 execute_user_command (c, arg);
665 else if (c->theclass == class_user
666 && c->is_prefix () && !c->allow_unknown)
667 /* If this is a user defined prefix that does not allow unknown
668 (in other words, C is a prefix command and not a command
669 that can be followed by its args), report the list of
672 std::string prefixname = c->prefixname ();
673 std::string prefixname_no_space
674 = prefixname.substr (0, prefixname.length () - 1);
676 ("\"%s\" must be followed by the name of a subcommand.\n",
677 prefixname_no_space.c_str ());
678 help_list (*c->subcommands, prefixname.c_str (), all_commands,
681 else if (c->type == set_cmd)
682 do_set_command (arg, from_tty, c);
683 else if (c->type == show_cmd)
684 do_show_command (arg, from_tty, c);
685 else if (c->is_command_class_help ())
686 error (_("That is not a command, just a help topic."));
687 else if (deprecated_call_command_hook)
688 deprecated_call_command_hook (c, arg, from_tty);
690 cmd_func (c, arg, from_tty);
692 maybe_wait_sync_command_done (was_sync);
694 /* If this command has been post-hooked, run the hook last.
695 We need to lookup the command again since during its execution,
696 a command may redefine itself. In this case, C pointer
697 becomes invalid so we need to look it up again. */
698 const char *cmd2 = cmd_copy.c_str ();
699 c = lookup_cmd (&cmd2, cmdlist, "", nullptr, 1, 1);
701 execute_cmd_post_hook (c);
703 if (repeat_arguments != NULL && cmd_start == saved_command_line)
705 gdb_assert (strlen (args_pointer) >= strlen (repeat_arguments));
706 strcpy (saved_command_line + (args_pointer - cmd_start),
711 /* Only perform the frame-language-change check if the command
712 we just finished executing did not resume the inferior's execution.
713 If it did resume the inferior, we will do that check after
714 the inferior stopped. */
715 if (has_stack_frames () && inferior_thread ()->state != THREAD_RUNNING)
716 check_frame_language_change ();
718 cleanup_if_error.release ();
724 execute_fn_to_ui_file (struct ui_file *file, std::function<void(void)> fn)
726 /* GDB_STDOUT should be better already restored during these
727 restoration callbacks. */
728 set_batch_flag_and_restore_page_info save_page_info;
730 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
733 ui_out_redirect_pop redirect_popper (current_uiout, file);
735 scoped_restore save_stdout
736 = make_scoped_restore (&gdb_stdout, file);
737 scoped_restore save_stderr
738 = make_scoped_restore (&gdb_stderr, file);
739 scoped_restore save_stdlog
740 = make_scoped_restore (&gdb_stdlog, file);
741 scoped_restore save_stdtarg
742 = make_scoped_restore (&gdb_stdtarg, file);
743 scoped_restore save_stdtargerr
744 = make_scoped_restore (&gdb_stdtargerr, file);
753 execute_fn_to_string (std::string &res, std::function<void(void)> fn,
756 string_file str_file (term_out);
760 execute_fn_to_ui_file (&str_file, fn);
765 res = std::move (str_file.string ());
770 res = std::move (str_file.string ());
776 execute_command_to_ui_file (struct ui_file *file,
777 const char *p, int from_tty)
779 execute_fn_to_ui_file (file, [=]() { execute_command (p, from_tty); });
785 execute_command_to_string (std::string &res, const char *p, int from_tty,
788 execute_fn_to_string (res, [=]() { execute_command (p, from_tty); },
795 execute_command_to_string (const char *p, int from_tty,
799 execute_fn_to_string (dummy, [=]() { execute_command (p, from_tty); },
803 /* When nonzero, cause dont_repeat to do nothing. This should only be
804 set via prevent_dont_repeat. */
806 static int suppress_dont_repeat = 0;
813 struct ui *ui = current_ui;
815 if (suppress_dont_repeat || server_command)
818 /* If we aren't reading from standard input, we are saving the last
819 thing read from stdin in line and don't want to delete it. Null
820 lines won't repeat here in any case. */
821 if (ui->instream == ui->stdin_stream)
823 *saved_command_line = 0;
824 repeat_arguments = NULL;
833 /* Do not repeat this command, as this command is a repeating command. */
836 /* We cannot free saved_command_line, as this line is being executed,
837 so swap it with previous_saved_command_line. */
838 std::swap (previous_saved_command_line, saved_command_line);
839 std::swap (previous_repeat_arguments, repeat_arguments);
841 const char *prev = skip_spaces (get_saved_command_line ());
843 error (_("No previous command to relaunch"));
849 scoped_restore_tmpl<int>
850 prevent_dont_repeat (void)
852 return make_scoped_restore (&suppress_dont_repeat, 1);
858 get_saved_command_line ()
860 return saved_command_line;
866 save_command_line (const char *cmd)
868 xfree (previous_saved_command_line);
869 previous_saved_command_line = saved_command_line;
870 previous_repeat_arguments = repeat_arguments;
871 saved_command_line = xstrdup (cmd);
872 repeat_arguments = NULL;
876 /* Read a line from the stream "instream" without command line editing.
878 It prints PROMPT once at the start.
879 Action is compatible with "readline", e.g. space for the result is
880 malloc'd and should be freed by the caller.
882 A NULL return means end of file. */
885 gdb_readline_no_editing (const char *prompt)
887 struct buffer line_buffer;
888 struct ui *ui = current_ui;
889 /* Read from stdin if we are executing a user defined command. This
890 is the right thing for prompt_for_continue, at least. */
891 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
892 int fd = fileno (stream);
894 buffer_init (&line_buffer);
898 /* Don't use a _filtered function here. It causes the assumed
899 character position to be off, since the newline we read from
900 the user is not accounted for. */
901 printf_unfiltered ("%s", prompt);
902 gdb_flush (gdb_stdout);
912 /* Wait until at least one byte of data is available. Control-C
913 can interrupt interruptible_select, but not fgetc. */
915 FD_SET (fd, &readfds);
916 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
920 /* If this was ctrl-c, the QUIT above handles it. */
923 perror_with_name (("select"));
930 if (line_buffer.used_size > 0)
931 /* The last line does not end with a newline. Return it, and
932 if we are called again fgetc will still return EOF and
933 we'll return NULL then. */
935 xfree (buffer_finish (&line_buffer));
941 if (line_buffer.used_size > 0
942 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
943 line_buffer.used_size--;
947 buffer_grow_char (&line_buffer, c);
950 buffer_grow_char (&line_buffer, '\0');
951 return buffer_finish (&line_buffer);
954 /* Variables which control command line editing and history
955 substitution. These variables are given default values at the end
957 static bool command_editing_p;
959 /* NOTE 1999-04-29: This variable will be static again, once we modify
960 gdb to use the event loop as the default command loop and we merge
961 event-top.c into this file, top.c. */
963 /* static */ bool history_expansion_p;
965 /* Should we write out the command history on exit? In order to write out
966 the history both this flag must be true, and the history_filename
967 variable must be set to something sensible. */
968 static bool write_history_p;
970 /* The name of the file in which GDB history will be written. If this is
971 set to NULL, of the empty string then history will not be written. */
972 static std::string history_filename;
974 /* Implement 'show history save'. */
976 show_write_history_p (struct ui_file *file, int from_tty,
977 struct cmd_list_element *c, const char *value)
979 if (!write_history_p || !history_filename.empty ())
980 gdb_printf (file, _("Saving of the history record on exit is %s.\n"),
983 gdb_printf (file, _("Saving of the history is disabled due to "
984 "the value of 'history filename'.\n"));
987 /* The variable associated with the "set/show history size"
988 command. The value -1 means unlimited, and -2 means undefined. */
989 static int history_size_setshow_var = -2;
992 show_history_size (struct ui_file *file, int from_tty,
993 struct cmd_list_element *c, const char *value)
995 gdb_printf (file, _("The size of the command history is %s.\n"),
999 /* Variable associated with the "history remove-duplicates" option.
1000 The value -1 means unlimited. */
1001 static int history_remove_duplicates = 0;
1004 show_history_remove_duplicates (struct ui_file *file, int from_tty,
1005 struct cmd_list_element *c, const char *value)
1008 _("The number of history entries to look back at for "
1009 "duplicates is %s.\n"),
1013 /* Implement 'show history filename'. */
1015 show_history_filename (struct ui_file *file, int from_tty,
1016 struct cmd_list_element *c, const char *value)
1018 if (!history_filename.empty ())
1019 gdb_printf (file, _("The filename in which to record "
1020 "the command history is \"%ps\".\n"),
1021 styled_string (file_name_style.style (), value));
1023 gdb_printf (file, _("There is no filename currently set for "
1024 "recording the command history in.\n"));
1027 /* This is like readline(), but it has some gdb-specific behavior.
1028 gdb may want readline in both the synchronous and async modes during
1029 a single gdb invocation. At the ordinary top-level prompt we might
1030 be using the async readline. That means we can't use
1031 rl_pre_input_hook, since it doesn't work properly in async mode.
1032 However, for a secondary prompt (" >", such as occurs during a
1033 `define'), gdb wants a synchronous response.
1035 We used to call readline() directly, running it in synchronous
1036 mode. But mixing modes this way is not supported, and as of
1037 readline 5.x it no longer works; the arrow keys come unbound during
1038 the synchronous call. So we make a nested call into the event
1039 loop. That's what gdb_readline_wrapper is for. */
1041 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
1042 rely on gdb_readline_wrapper_result, which might still be NULL if
1043 the user types Control-D for EOF. */
1044 static int gdb_readline_wrapper_done;
1046 /* The result of the current call to gdb_readline_wrapper, once a newline
1048 static char *gdb_readline_wrapper_result;
1050 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
1051 to be called after the newline is processed (which will redisplay
1052 the prompt). But in gdb_readline_wrapper we will not get a new
1053 prompt until the next call, or until we return to the event loop.
1054 So we disable this hook around the newline and restore it before we
1056 static void (*saved_after_char_processing_hook) (void);
1062 gdb_in_secondary_prompt_p (struct ui *ui)
1064 return ui->secondary_prompt_depth > 0;
1068 /* This function is called when readline has seen a complete line of
1072 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr<char> &&line)
1074 gdb_assert (!gdb_readline_wrapper_done);
1075 gdb_readline_wrapper_result = line.release ();
1076 gdb_readline_wrapper_done = 1;
1078 /* Prevent operate-and-get-next from acting too early. */
1079 saved_after_char_processing_hook = after_char_processing_hook;
1080 after_char_processing_hook = NULL;
1082 /* Prevent parts of the prompt from being redisplayed if annotations
1083 are enabled, and readline's state getting out of sync. We'll
1084 reinstall the callback handler, which puts the terminal in raw
1085 mode (or in readline lingo, in prepped state), when we're next
1086 ready to process user input, either in display_gdb_prompt, or if
1087 we're handling an asynchronous target event and running in the
1088 background, just before returning to the event loop to process
1089 further input (or more target events). */
1090 if (current_ui->command_editing)
1091 gdb_rl_callback_handler_remove ();
1094 class gdb_readline_wrapper_cleanup
1097 gdb_readline_wrapper_cleanup ()
1098 : m_handler_orig (current_ui->input_handler),
1099 m_already_prompted_orig (current_ui->command_editing
1100 ? rl_already_prompted : 0),
1101 m_target_is_async_orig (target_is_async_p ()),
1102 m_save_ui (¤t_ui)
1104 current_ui->input_handler = gdb_readline_wrapper_line;
1105 current_ui->secondary_prompt_depth++;
1107 if (m_target_is_async_orig)
1108 target_async (false);
1111 ~gdb_readline_wrapper_cleanup ()
1113 struct ui *ui = current_ui;
1115 if (ui->command_editing)
1116 rl_already_prompted = m_already_prompted_orig;
1118 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
1119 ui->input_handler = m_handler_orig;
1121 /* Don't restore our input handler in readline yet. That would make
1122 readline prep the terminal (putting it in raw mode), while the
1123 line we just read may trigger execution of a command that expects
1124 the terminal in the default cooked/canonical mode, such as e.g.,
1125 running Python's interactive online help utility. See
1126 gdb_readline_wrapper_line for when we'll reinstall it. */
1128 gdb_readline_wrapper_result = NULL;
1129 gdb_readline_wrapper_done = 0;
1130 ui->secondary_prompt_depth--;
1131 gdb_assert (ui->secondary_prompt_depth >= 0);
1133 after_char_processing_hook = saved_after_char_processing_hook;
1134 saved_after_char_processing_hook = NULL;
1136 if (m_target_is_async_orig)
1137 target_async (true);
1140 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup);
1144 void (*m_handler_orig) (gdb::unique_xmalloc_ptr<char> &&);
1145 int m_already_prompted_orig;
1147 /* Whether the target was async. */
1148 int m_target_is_async_orig;
1150 /* Processing events may change the current UI. */
1151 scoped_restore_tmpl<struct ui *> m_save_ui;
1155 gdb_readline_wrapper (const char *prompt)
1157 struct ui *ui = current_ui;
1159 gdb_readline_wrapper_cleanup cleanup;
1161 /* Display our prompt and prevent double prompt display. Don't pass
1162 down a NULL prompt, since that has special meaning for
1163 display_gdb_prompt -- it indicates a request to print the primary
1164 prompt, while we want a secondary prompt here. */
1165 display_gdb_prompt (prompt != NULL ? prompt : "");
1166 if (ui->command_editing)
1167 rl_already_prompted = 1;
1169 if (after_char_processing_hook)
1170 (*after_char_processing_hook) ();
1171 gdb_assert (after_char_processing_hook == NULL);
1173 while (gdb_do_one_event () >= 0)
1174 if (gdb_readline_wrapper_done)
1177 return gdb_readline_wrapper_result;
1181 /* The current saved history number from operate-and-get-next.
1182 This is -1 if not valid. */
1183 static int operate_saved_history = -1;
1185 /* This is put on the appropriate hook and helps operate-and-get-next
1188 gdb_rl_operate_and_get_next_completion (void)
1190 int delta = where_history () - operate_saved_history;
1192 /* The `key' argument to rl_get_previous_history is ignored. */
1193 rl_get_previous_history (delta, 0);
1194 operate_saved_history = -1;
1196 /* readline doesn't automatically update the display for us. */
1199 after_char_processing_hook = NULL;
1200 rl_pre_input_hook = NULL;
1203 /* This is a gdb-local readline command handler. It accepts the
1204 current command line (like RET does) and, if this command was taken
1205 from the history, arranges for the next command in the history to
1206 appear on the command line when the prompt returns.
1207 We ignore the arguments. */
1209 gdb_rl_operate_and_get_next (int count, int key)
1213 /* Use the async hook. */
1214 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1216 /* Find the current line, and find the next line to use. */
1217 where = where_history();
1219 if ((history_is_stifled () && (history_length >= history_max_entries))
1220 || (where >= history_length - 1))
1221 operate_saved_history = where;
1223 operate_saved_history = where + 1;
1225 return rl_newline (1, key);
1228 /* Number of user commands executed during this session. */
1230 static int command_count = 0;
1232 /* Add the user command COMMAND to the input history list. */
1235 gdb_add_history (const char *command)
1239 if (history_remove_duplicates != 0)
1242 int lookbehind_threshold;
1244 /* The lookbehind threshold for finding a duplicate history entry is
1245 bounded by command_count because we can't meaningfully delete
1246 history entries that are already stored in the history file since
1247 the history file is appended to. */
1248 if (history_remove_duplicates == -1
1249 || history_remove_duplicates > command_count)
1250 lookbehind_threshold = command_count;
1252 lookbehind_threshold = history_remove_duplicates;
1255 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1257 HIST_ENTRY *temp = previous_history ();
1262 if (strcmp (temp->line, command) == 0)
1264 HIST_ENTRY *prev = remove_history (where_history ());
1266 free_history_entry (prev);
1273 add_history (command);
1276 /* Safely append new history entries to the history file in a corruption-free
1277 way using an intermediate local history file. */
1280 gdb_safe_append_history (void)
1282 int ret, saved_errno;
1284 std::string local_history_filename
1285 = string_printf ("%s-gdb%ld~", history_filename.c_str (), (long) getpid ());
1287 ret = rename (history_filename.c_str (), local_history_filename.c_str ());
1288 saved_errno = errno;
1289 if (ret < 0 && saved_errno != ENOENT)
1291 warning (_("Could not rename %ps to %ps: %s"),
1292 styled_string (file_name_style.style (),
1293 history_filename.c_str ()),
1294 styled_string (file_name_style.style (),
1295 local_history_filename.c_str ()),
1296 safe_strerror (saved_errno));
1302 /* If the rename failed with ENOENT then either the global history
1303 file never existed in the first place or another GDB process is
1304 currently appending to it (and has thus temporarily renamed it).
1305 Since we can't distinguish between these two cases, we have to
1306 conservatively assume the first case and therefore must write out
1307 (not append) our known history to our local history file and try
1308 to move it back anyway. Otherwise a global history file would
1309 never get created! */
1310 gdb_assert (saved_errno == ENOENT);
1311 write_history (local_history_filename.c_str ());
1315 append_history (command_count, local_history_filename.c_str ());
1316 if (history_is_stifled ())
1317 history_truncate_file (local_history_filename.c_str (),
1318 history_max_entries);
1321 ret = rename (local_history_filename.c_str (), history_filename.c_str ());
1322 saved_errno = errno;
1323 if (ret < 0 && saved_errno != EEXIST)
1324 warning (_("Could not rename %s to %s: %s"),
1325 local_history_filename.c_str (), history_filename.c_str (),
1326 safe_strerror (saved_errno));
1330 /* Read one line from the command input stream `instream'.
1332 CMD_LINE_BUFFER is a buffer that the function may use to store the result, if
1333 it needs to be dynamically-allocated. Otherwise, it is unused.string
1335 Return nullptr for end of file.
1337 This routine either uses fancy command line editing or simple input
1338 as the user has requested. */
1341 command_line_input (std::string &cmd_line_buffer, const char *prompt_arg,
1342 const char *annotation_suffix)
1344 struct ui *ui = current_ui;
1345 const char *prompt = prompt_arg;
1347 int from_tty = ui->instream == ui->stdin_stream;
1349 /* The annotation suffix must be non-NULL. */
1350 if (annotation_suffix == NULL)
1351 annotation_suffix = "";
1353 if (from_tty && annotation_level > 1)
1358 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1359 + strlen (annotation_suffix) + 40);
1361 local_prompt[0] = '\0';
1363 strcpy (local_prompt, prompt);
1364 strcat (local_prompt, "\n\032\032");
1365 strcat (local_prompt, annotation_suffix);
1366 strcat (local_prompt, "\n");
1368 prompt = local_prompt;
1373 signal (SIGTSTP, handle_sigtstp);
1378 gdb::unique_xmalloc_ptr<char> rl;
1380 /* Make sure that all output has been output. Some machines may
1381 let you get away with leaving out some of the gdb_flush, but
1383 gdb_flush (gdb_stdout);
1384 gdb_flush (gdb_stderr);
1386 if (!source_file_name.empty ())
1387 ++source_line_number;
1389 if (from_tty && annotation_level > 1)
1390 printf_unfiltered ("\n\032\032pre-%s\n", annotation_suffix);
1392 /* Don't use fancy stuff if not talking to stdin. */
1393 if (deprecated_readline_hook
1395 && current_ui->input_interactive_p ())
1397 rl.reset ((*deprecated_readline_hook) (prompt));
1399 else if (command_editing_p
1401 && current_ui->input_interactive_p ())
1403 rl.reset (gdb_readline_wrapper (prompt));
1407 rl.reset (gdb_readline_no_editing (prompt));
1410 cmd = handle_line_of_input (cmd_line_buffer, rl.get (),
1411 0, annotation_suffix);
1412 if (cmd == (char *) EOF)
1420 /* Got partial input. I.e., got a line that ends with a
1421 continuation character (backslash). Suppress printing the
1428 signal (SIGTSTP, SIG_DFL);
1436 print_gdb_version (struct ui_file *stream, bool interactive)
1438 /* From GNU coding standards, first line is meant to be easy for a
1439 program to parse, and is just canonical program name and version
1440 number, which starts after last space. */
1442 std::string v_str = string_printf ("GNU gdb %s%s", PKGVERSION, version);
1443 gdb_printf (stream, "%ps\n",
1444 styled_string (version_style.style (), v_str.c_str ()));
1446 /* Second line is a copyright notice. */
1449 "Copyright (C) 2023 Free Software Foundation, Inc.\n");
1451 /* Following the copyright is a brief statement that the program is
1452 free software, that users are free to copy and change it on
1453 certain conditions, that it is covered by the GNU GPL, and that
1454 there is no warranty. */
1456 gdb_printf (stream, "\
1457 License GPLv3+: GNU GPL version 3 or later <%ps>\
1458 \nThis is free software: you are free to change and redistribute it.\n\
1459 There is NO WARRANTY, to the extent permitted by law.",
1460 styled_string (file_name_style.style (),
1461 "http://gnu.org/licenses/gpl.html"));
1466 gdb_printf (stream, ("\nType \"show copying\" and "
1467 "\"show warranty\" for details.\n"));
1469 /* After the required info we print the configuration information. */
1471 gdb_printf (stream, "This GDB was configured as \"");
1472 if (strcmp (host_name, target_name) != 0)
1474 gdb_printf (stream, "--host=%s --target=%s",
1475 host_name, target_name);
1479 gdb_printf (stream, "%s", host_name);
1481 gdb_printf (stream, "\".\n");
1483 gdb_printf (stream, _("Type \"show configuration\" "
1484 "for configuration details.\n"));
1486 if (REPORT_BUGS_TO[0])
1489 _("For bug reporting instructions, please see:\n"));
1490 gdb_printf (stream, "%ps.\n",
1491 styled_string (file_name_style.style (),
1495 _("Find the GDB manual and other documentation \
1496 resources online at:\n <%ps>."),
1497 styled_string (file_name_style.style (),
1498 "http://www.gnu.org/software/gdb/documentation/"));
1499 gdb_printf (stream, "\n\n");
1500 gdb_printf (stream, _("For help, type \"help\".\n"));
1502 _("Type \"apropos word\" to search for commands \
1503 related to \"word\"."));
1506 /* Print the details of GDB build-time configuration. */
1508 print_gdb_configuration (struct ui_file *stream)
1510 gdb_printf (stream, _("\
1511 This GDB was configured as follows:\n\
1512 configure --host=%s --target=%s\n\
1513 "), host_name, target_name);
1515 gdb_printf (stream, _("\
1516 --with-auto-load-dir=%s\n\
1517 --with-auto-load-safe-path=%s\n\
1518 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1521 gdb_printf (stream, _("\
1525 gdb_printf (stream, _("\
1531 gdb_printf (stream, _("\
1532 --with-gdb-datadir=%s%s\n\
1533 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1536 gdb_printf (stream, _("\
1537 --with-iconv-bin=%s%s\n\
1538 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1541 if (JIT_READER_DIR[0])
1542 gdb_printf (stream, _("\
1543 --with-jit-reader-dir=%s%s\n\
1544 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1546 #if HAVE_LIBUNWIND_IA64_H
1547 gdb_printf (stream, _("\
1548 --with-libunwind-ia64\n\
1551 gdb_printf (stream, _("\
1552 --without-libunwind-ia64\n\
1557 gdb_printf (stream, _("\
1561 gdb_printf (stream, _("\
1566 #if HAVE_LIBBABELTRACE
1567 gdb_printf (stream, _("\
1568 --with-babeltrace\n\
1571 gdb_printf (stream, _("\
1572 --without-babeltrace\n\
1577 gdb_printf (stream, _("\
1581 gdb_printf (stream, _("\
1582 --without-intel-pt\n\
1587 gdb_printf (stream, _("\
1591 gdb_printf (stream, _("\
1596 gdb_printf (stream, _("\
1600 gdb_printf (stream, _("\
1604 #ifdef WITH_PYTHON_PATH
1605 gdb_printf (stream, _("\
1606 --with-python=%s%s\n\
1607 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1609 gdb_printf (stream, _("\
1613 #ifdef WITH_PYTHON_LIBDIR
1614 gdb_printf (stream, _("\
1615 --with-python-libdir=%s%s\n\
1616 "), WITH_PYTHON_LIBDIR, PYTHON_LIBDIR_RELOCATABLE ? " (relocatable)" : "");
1618 gdb_printf (stream, _("\
1619 --without-python-libdir\n\
1623 #if HAVE_LIBDEBUGINFOD
1624 gdb_printf (stream, _("\
1625 --with-debuginfod\n\
1628 gdb_printf (stream, _("\
1629 --without-debuginfod\n\
1634 gdb_printf (stream, _("\
1638 gdb_printf (stream, _("\
1643 #if HAVE_SOURCE_HIGHLIGHT
1644 gdb_printf (stream, _("\
1645 --enable-source-highlight\n\
1648 gdb_printf (stream, _("\
1649 --disable-source-highlight\n\
1654 gdb_printf (stream, _("\
1655 --enable-threading\n\
1658 gdb_printf (stream, _("\
1659 --disable-threading\n\
1664 gdb_printf (stream, _("\
1665 --with-relocated-sources=%s\n\
1670 gdb_printf (stream, _("\
1671 --with-separate-debug-dir=%s%s\n\
1672 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1674 if (TARGET_SYSTEM_ROOT[0])
1675 gdb_printf (stream, _("\
1676 --with-sysroot=%s%s\n\
1677 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1679 if (SYSTEM_GDBINIT[0])
1680 gdb_printf (stream, _("\
1681 --with-system-gdbinit=%s%s\n\
1682 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1684 if (SYSTEM_GDBINIT_DIR[0])
1685 gdb_printf (stream, _("\
1686 --with-system-gdbinit-dir=%s%s\n\
1687 "), SYSTEM_GDBINIT_DIR, SYSTEM_GDBINIT_DIR_RELOCATABLE ? " (relocatable)" : "");
1689 /* We assume "relocatable" will be printed at least once, thus we always
1690 print this text. It's a reasonably safe assumption for now. */
1691 gdb_printf (stream, _("\n\
1692 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1693 tree, and GDB will still find it.)\n\
1698 /* The current top level prompt, settable with "set prompt", and/or
1699 with the python `gdb.prompt_hook' hook. */
1700 static std::string top_prompt;
1702 /* Access method for the GDB prompt string. */
1710 /* Set method for the GDB prompt string. */
1713 set_prompt (const char *s)
1719 /* Kills or detaches the given inferior, depending on how we originally
1720 gained control of it. */
1723 kill_or_detach (inferior *inf, int from_tty)
1728 thread_info *thread = any_thread_of_inferior (inf);
1731 switch_to_thread (thread);
1733 /* Leave core files alone. */
1734 if (target_has_execution ())
1736 if (inf->attach_flag)
1737 target_detach (inf, from_tty);
1744 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1745 where to collect the output. */
1748 print_inferior_quit_action (inferior *inf, ui_file *out)
1753 if (inf->attach_flag)
1755 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1756 target_pid_to_str (ptid_t (inf->pid)).c_str ());
1759 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1760 target_pid_to_str (ptid_t (inf->pid)).c_str ());
1763 /* If necessary, make the user confirm that we should quit. Return
1764 non-zero if we should quit, zero if we shouldn't. */
1769 /* Don't even ask if we're only debugging a core file inferior. */
1770 if (!have_live_inferiors ())
1773 /* Build the query string as a single string. */
1776 stb.puts (_("A debugging session is active.\n\n"));
1778 for (inferior *inf : all_inferiors ())
1779 print_inferior_quit_action (inf, &stb);
1781 stb.puts (_("\nQuit anyway? "));
1783 return query ("%s", stb.c_str ());
1786 /* Prepare to exit GDB cleanly by undoing any changes made to the
1787 terminal so that we leave the terminal in the state we acquired it. */
1790 undo_terminal_modifications_before_exit (void)
1792 struct ui *saved_top_level = current_ui;
1794 target_terminal::ours ();
1796 current_ui = main_ui;
1801 gdb_disable_readline ();
1803 current_ui = saved_top_level;
1807 /* Quit without asking for confirmation. */
1810 quit_force (int *exit_arg, int from_tty)
1814 /* An optional expression may be used to cause gdb to terminate with the
1815 value of that expression. */
1817 exit_code = *exit_arg;
1818 else if (return_child_result)
1819 exit_code = return_child_result_value;
1821 gdb::observers::gdb_exiting.notify (exit_code);
1823 undo_terminal_modifications_before_exit ();
1825 /* We want to handle any quit errors and exit regardless. */
1827 /* Get out of tfind mode, and kill or detach all inferiors. */
1830 disconnect_tracing ();
1831 for (inferior *inf : all_inferiors ())
1832 kill_or_detach (inf, from_tty);
1834 catch (const gdb_exception &ex)
1836 exception_print (gdb_stderr, ex);
1839 /* Give all pushed targets a chance to do minimal cleanup, and pop
1841 for (inferior *inf : all_inferiors ())
1845 inf->pop_all_targets ();
1847 catch (const gdb_exception &ex)
1849 exception_print (gdb_stderr, ex);
1853 /* Save the history information if it is appropriate to do so. */
1856 if (write_history_p && !history_filename.empty ())
1860 /* History is currently shared between all UIs. If there's
1861 any UI with a terminal, save history. */
1862 for (ui *ui : all_uis ())
1864 if (ui->input_interactive_p ())
1872 gdb_safe_append_history ();
1875 catch (const gdb_exception &ex)
1877 exception_print (gdb_stderr, ex);
1880 /* Destroy any values currently allocated now instead of leaving it
1881 to global destructors, because that may be too late. For
1882 example, the destructors of xmethod values call into the Python
1883 runtime, which is finalized via a final cleanup. */
1886 /* Do any final cleanups before exiting. */
1889 do_final_cleanups ();
1891 catch (const gdb_exception &ex)
1893 exception_print (gdb_stderr, ex);
1899 /* The value of the "interactive-mode" setting. */
1900 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1902 /* Implement the "show interactive-mode" option. */
1905 show_interactive_mode (struct ui_file *file, int from_tty,
1906 struct cmd_list_element *c,
1909 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1910 gdb_printf (file, "Debugger's interactive mode "
1911 "is %s (currently %s).\n",
1912 value, current_ui->input_interactive_p () ? "on" : "off");
1914 gdb_printf (file, "Debugger's interactive mode is %s.\n", value);
1917 /* Returns whether GDB is running on an interactive terminal. */
1920 ui::input_interactive_p () const
1925 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1926 return interactive_mode == AUTO_BOOLEAN_TRUE;
1928 return m_input_interactive_p;
1932 dont_repeat_command (const char *ignored, int from_tty)
1934 /* Can't call dont_repeat here because we're not necessarily reading
1936 *saved_command_line = 0;
1939 /* Functions to manipulate command line editing control variables. */
1941 /* Number of commands to print in each call to show_commands. */
1942 #define Hist_print 10
1944 show_commands (const char *args, int from_tty)
1946 /* Index for history commands. Relative to history_base. */
1949 /* Number of the history entry which we are planning to display next.
1950 Relative to history_base. */
1953 /* Print out some of the commands from the command history. */
1957 if (args[0] == '+' && args[1] == '\0')
1958 /* "info editing +" should print from the stored position. */
1961 /* "info editing <exp>" should print around command number <exp>. */
1962 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1964 /* "show commands" means print the last Hist_print commands. */
1967 num = history_length - Hist_print;
1973 /* If there are at least Hist_print commands, we want to display the last
1974 Hist_print rather than, say, the last 6. */
1975 if (history_length - num < Hist_print)
1977 num = history_length - Hist_print;
1983 offset < num + Hist_print && offset < history_length;
1986 gdb_printf ("%5d %s\n", history_base + offset,
1987 (history_get (history_base + offset))->line);
1990 /* The next command we want to display is the next one that we haven't
1994 /* If the user repeats this command with return, it should do what
1995 "show commands +" does. This is unnecessary if arg is null,
1996 because "show commands +" is not useful after "show commands". */
1997 if (from_tty && args)
1998 set_repeat_arguments ("+");
2001 /* Update the size of our command history file to HISTORY_SIZE.
2003 A HISTORY_SIZE of -1 stands for unlimited. */
2006 set_readline_history_size (int history_size)
2008 gdb_assert (history_size >= -1);
2010 if (history_size == -1)
2011 unstifle_history ();
2013 stifle_history (history_size);
2016 /* Called by do_setshow_command. */
2018 set_history_size_command (const char *args,
2019 int from_tty, struct cmd_list_element *c)
2021 set_readline_history_size (history_size_setshow_var);
2024 bool info_verbose = false; /* Default verbose msgs off. */
2026 /* Called by do_set_command. An elaborate joke. */
2028 set_verbose (const char *args, int from_tty, struct cmd_list_element *c)
2030 const char *cmdname = "verbose";
2031 struct cmd_list_element *showcmd;
2033 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, NULL, 1);
2034 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
2036 if (c->doc && c->doc_allocated)
2037 xfree ((char *) c->doc);
2038 if (showcmd->doc && showcmd->doc_allocated)
2039 xfree ((char *) showcmd->doc);
2042 c->doc = _("Set verbose printing of informational messages.");
2043 showcmd->doc = _("Show verbose printing of informational messages.");
2047 c->doc = _("Set verbosity.");
2048 showcmd->doc = _("Show verbosity.");
2050 c->doc_allocated = 0;
2051 showcmd->doc_allocated = 0;
2054 /* Init the history buffer. Note that we are called after the init file(s)
2055 have been read so that the user can change the history file via his
2056 .gdbinit file (for instance). The GDBHISTFILE environment variable
2057 overrides all of this. */
2064 tmpenv = getenv ("GDBHISTSIZE");
2071 tmpenv = skip_spaces (tmpenv);
2073 var = strtol (tmpenv, &endptr, 10);
2074 saved_errno = errno;
2075 endptr = skip_spaces (endptr);
2077 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
2078 empty string, a negative number or a huge positive number (larger than
2079 INT_MAX) then set the history size to unlimited. Otherwise set our
2080 history size to the number we have read. This behavior is consistent
2081 with how bash handles HISTSIZE. */
2082 if (*endptr != '\0')
2084 else if (*tmpenv == '\0'
2087 /* On targets where INT_MAX == LONG_MAX, we have to look at
2088 errno after calling strtol to distinguish between a value that
2089 is exactly INT_MAX and an overflowing value that was clamped
2091 || (var == INT_MAX && saved_errno == ERANGE))
2092 history_size_setshow_var = -1;
2094 history_size_setshow_var = var;
2097 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2099 if (history_size_setshow_var == -2)
2100 history_size_setshow_var = 256;
2102 set_readline_history_size (history_size_setshow_var);
2104 if (!history_filename.empty ())
2105 read_history (history_filename.c_str ());
2109 show_prompt (struct ui_file *file, int from_tty,
2110 struct cmd_list_element *c, const char *value)
2112 gdb_printf (file, _("Gdb's prompt is \"%s\".\n"), value);
2115 /* "set editing" command. */
2118 set_editing (const char *args, int from_tty, struct cmd_list_element *c)
2120 change_line_handler (set_editing_cmd_var);
2121 /* Update the control variable so that MI's =cmd-param-changed event
2122 shows the correct value. */
2123 set_editing_cmd_var = current_ui->command_editing;
2127 show_editing (struct ui_file *file, int from_tty,
2128 struct cmd_list_element *c, const char *value)
2130 gdb_printf (file, _("Editing of command lines as "
2131 "they are typed is %s.\n"),
2132 current_ui->command_editing ? _("on") : _("off"));
2136 show_annotation_level (struct ui_file *file, int from_tty,
2137 struct cmd_list_element *c, const char *value)
2139 gdb_printf (file, _("Annotation_level is %s.\n"), value);
2143 show_exec_done_display_p (struct ui_file *file, int from_tty,
2144 struct cmd_list_element *c, const char *value)
2146 gdb_printf (file, _("Notification of completion for "
2147 "asynchronous execution commands is %s.\n"),
2151 /* New values of the "data-directory" parameter are staged here.
2152 Extension languages, for example Python's gdb.parameter API, will read
2153 the value directory from this variable, so we must ensure that this
2154 always contains the correct value. */
2155 static std::string staged_gdb_datadir;
2157 /* "set" command for the gdb_datadir configuration variable. */
2160 set_gdb_datadir (const char *args, int from_tty, struct cmd_list_element *c)
2162 set_gdb_data_directory (staged_gdb_datadir.c_str ());
2164 /* SET_GDB_DATA_DIRECTORY will resolve relative paths in
2165 STAGED_GDB_DATADIR, so we now copy the value from GDB_DATADIR
2166 back into STAGED_GDB_DATADIR so the extension languages can read the
2168 staged_gdb_datadir = gdb_datadir;
2170 gdb::observers::gdb_datadir_changed.notify ();
2173 /* "show" command for the gdb_datadir configuration variable. */
2176 show_gdb_datadir (struct ui_file *file, int from_tty,
2177 struct cmd_list_element *c, const char *value)
2179 gdb_printf (file, _("GDB's data directory is \"%ps\".\n"),
2180 styled_string (file_name_style.style (),
2181 gdb_datadir.c_str ()));
2184 /* Implement 'set history filename'. */
2187 set_history_filename (const char *args,
2188 int from_tty, struct cmd_list_element *c)
2190 /* We include the current directory so that if the user changes
2191 directories the file written will be the same as the one
2193 if (!history_filename.empty ()
2194 && !IS_ABSOLUTE_PATH (history_filename.c_str ()))
2195 history_filename = gdb_abspath (history_filename.c_str ());
2198 /* Whether we're in quiet startup mode. */
2200 static bool startup_quiet;
2207 return startup_quiet;
2210 /* Show whether GDB should start up in quiet mode. */
2213 show_startup_quiet (struct ui_file *file, int from_tty,
2214 struct cmd_list_element *c, const char *value)
2216 gdb_printf (file, _("Whether to start up quietly is %s.\n"),
2223 struct cmd_list_element *c;
2225 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2226 the DEFAULT_PROMPT is. */
2227 set_prompt (DEFAULT_PROMPT);
2229 /* Set the important stuff up for command editing. */
2230 command_editing_p = 1;
2231 history_expansion_p = 0;
2232 write_history_p = 0;
2234 /* Setup important stuff for command line editing. */
2235 rl_completion_word_break_hook = gdb_completion_word_break_characters;
2236 rl_attempted_completion_function = gdb_rl_attempted_completion_function;
2237 set_rl_completer_word_break_characters (default_word_break_characters ());
2238 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
2239 rl_completion_display_matches_hook = cli_display_match_list;
2240 rl_readline_name = "gdb";
2241 rl_terminal_name = getenv ("TERM");
2242 rl_deprep_term_function = gdb_rl_deprep_term_function;
2244 /* The name for this defun comes from Bash, where it originated.
2245 15 is Control-o, the same binding this function has in Bash. */
2246 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2248 add_setshow_string_cmd ("prompt", class_support,
2250 _("Set gdb's prompt."),
2251 _("Show gdb's prompt."),
2254 &setlist, &showlist);
2256 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2257 Don't repeat this command.\nPrimarily \
2258 used inside of user-defined commands that should not be repeated when\n\
2261 add_setshow_boolean_cmd ("editing", class_support,
2262 &set_editing_cmd_var, _("\
2263 Set editing of command lines as they are typed."), _("\
2264 Show editing of command lines as they are typed."), _("\
2265 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2266 Without an argument, command line editing is enabled. To edit, use\n\
2267 EMACS-like or VI-like commands like control-P or ESC."),
2270 &setlist, &showlist);
2272 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2273 Set saving of the history record on exit."), _("\
2274 Show saving of the history record on exit."), _("\
2275 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2276 Without an argument, saving is enabled."),
2278 show_write_history_p,
2279 &sethistlist, &showhistlist);
2281 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2282 &history_size_setshow_var, _("\
2283 Set the size of the command history."), _("\
2284 Show the size of the command history."), _("\
2285 This is the number of previous commands to keep a record of.\n\
2286 If set to \"unlimited\", the number of commands kept in the history\n\
2287 list is unlimited. This defaults to the value of the environment\n\
2288 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2289 set_history_size_command,
2291 &sethistlist, &showhistlist);
2293 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2294 &history_remove_duplicates, _("\
2295 Set how far back in history to look for and remove duplicate entries."), _("\
2296 Show how far back in history to look for and remove duplicate entries."), _("\
2297 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2298 and remove the first history entry that is a duplicate of the most recent\n\
2299 entry, each time a new history entry is added.\n\
2300 If set to \"unlimited\", this lookbehind is unbounded.\n\
2301 Only history entries added during this session are considered for removal.\n\
2302 If set to 0, removal of duplicate history entries is disabled.\n\
2303 By default this option is set to 0."),
2305 show_history_remove_duplicates,
2306 &sethistlist, &showhistlist);
2308 add_setshow_optional_filename_cmd ("filename", no_class, &history_filename, _("\
2309 Set the filename in which to record the command history."), _("\
2310 Show the filename in which to record the command history."), _("\
2311 (the list of previous commands of which a record is kept)."),
2312 set_history_filename,
2313 show_history_filename,
2314 &sethistlist, &showhistlist);
2316 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2317 Set whether to confirm potentially dangerous operations."), _("\
2318 Show whether to confirm potentially dangerous operations."), NULL,
2321 &setlist, &showlist);
2323 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2324 Set annotation_level."), _("\
2325 Show annotation_level."), _("\
2326 0 == normal; 1 == fullname (for use when running under emacs)\n\
2327 2 == output annotated suitably for use by programs that control GDB."),
2329 show_annotation_level,
2330 &setlist, &showlist);
2332 add_setshow_boolean_cmd ("exec-done-display", class_support,
2333 &exec_done_display_p, _("\
2334 Set notification of completion for asynchronous execution commands."), _("\
2335 Show notification of completion for asynchronous execution commands."), _("\
2336 Use \"on\" to enable the notification, and \"off\" to disable it."),
2338 show_exec_done_display_p,
2339 &setlist, &showlist);
2341 add_setshow_filename_cmd ("data-directory", class_maintenance,
2342 &staged_gdb_datadir, _("Set GDB's data directory."),
2343 _("Show GDB's data directory."),
2345 When set, GDB uses the specified path to search for data files."),
2346 set_gdb_datadir, show_gdb_datadir,
2349 /* Prime the initial value for data-directory. */
2350 staged_gdb_datadir = gdb_datadir;
2352 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2353 &interactive_mode, _("\
2354 Set whether GDB's standard input is a terminal."), _("\
2355 Show whether GDB's standard input is a terminal."), _("\
2356 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2357 means that GDB should wait for the user to answer queries associated to\n\
2358 commands entered at the command prompt. If off, GDB assumes that standard\n\
2359 input is not a terminal, and uses the default answer to all queries.\n\
2360 If auto (the default), determine which mode to use based on the standard\n\
2363 show_interactive_mode,
2364 &setlist, &showlist);
2366 add_setshow_boolean_cmd ("startup-quietly", class_support,
2367 &startup_quiet, _("\
2368 Set whether GDB should start up quietly."), _(" \
2369 Show whether GDB should start up quietly."), _("\
2370 This setting will not affect the current session. Instead this command\n\
2371 should be added to the .gdbearlyinit file in the users home directory to\n\
2372 affect future GDB sessions."),
2375 &setlist, &showlist);
2377 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2379 Usage: new-ui INTERPRETER TTY\n\
2380 The first argument is the name of the interpreter to run.\n\
2381 The second argument is the terminal the UI runs on."), &cmdlist);
2382 set_cmd_completer (c, interpreter_completer);
2384 struct internalvar *major_version_var = create_internalvar ("_gdb_major");
2385 struct internalvar *minor_version_var = create_internalvar ("_gdb_minor");
2386 int vmajor = 0, vminor = 0, vrevision = 0;
2387 sscanf (version, "%d.%d.%d", &vmajor, &vminor, &vrevision);
2388 set_internalvar_integer (major_version_var, vmajor);
2389 set_internalvar_integer (minor_version_var, vminor + (vrevision > 0));
2397 saved_command_line = xstrdup ("");
2398 previous_saved_command_line = xstrdup ("");
2400 /* Run the init function of each source file. */
2403 /* Make sure we return to the original directory upon exit, come
2404 what may, since the OS doesn't do that for us. */
2405 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2410 /* Here is where we call all the _initialize_foo routines. */
2411 initialize_all_files ();
2413 /* This creates the current_program_space. Do this after all the
2414 _initialize_foo routines have had a chance to install their
2415 per-sspace data keys. Also do this before
2416 initialize_current_architecture is called, because it accesses
2417 exec_bfd of the current program space. */
2418 initialize_progspace ();
2419 initialize_inferiors ();
2420 initialize_current_architecture ();
2421 init_main (); /* But that omits this file! Do it now. */
2423 initialize_stdin_serial ();
2425 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2427 set_initial_gdb_ttystate ();
2429 gdb_init_signals ();
2431 /* We need a default language for parsing expressions, so simple
2432 things like "set width 0" won't fail if no language is explicitly
2433 set in a config file or implicitly set by reading an executable
2435 set_language (language_c);
2436 expected_language = current_language; /* Don't warn about the change. */
2439 void _initialize_top ();
2443 /* Determine a default value for the history filename. */
2444 const char *tmpenv = getenv ("GDBHISTFILE");
2445 if (tmpenv != nullptr)
2446 history_filename = tmpenv;
2449 /* We include the current directory so that if the user changes
2450 directories the file written will be the same as the one
2453 /* No leading dots in file names are allowed on MSDOS. */
2454 const char *fname = "_gdb_history";
2456 const char *fname = ".gdb_history";
2459 history_filename = gdb_abspath (fname);