1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2021 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 static bool history_filename_empty (void);
89 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
90 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
91 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
93 /* Default command line prompt. This is overridden in some configs. */
95 #ifndef DEFAULT_PROMPT
96 #define DEFAULT_PROMPT "(gdb) "
100 current_ui_gdb_stdout_ptr ()
102 return ¤t_ui
->m_gdb_stdout
;
106 current_ui_gdb_stdin_ptr ()
108 return ¤t_ui
->m_gdb_stdin
;
112 current_ui_gdb_stderr_ptr ()
114 return ¤t_ui
->m_gdb_stderr
;
118 current_ui_gdb_stdlog_ptr ()
120 return ¤t_ui
->m_gdb_stdlog
;
124 current_ui_current_uiout_ptr ()
126 return ¤t_ui
->m_current_uiout
;
129 int inhibit_gdbinit
= 0;
131 /* Flag for whether we want to confirm potentially dangerous
132 operations. Default is yes. */
137 show_confirm (struct ui_file
*file
, int from_tty
,
138 struct cmd_list_element
*c
, const char *value
)
140 fprintf_filtered (file
, _("Whether to confirm potentially "
141 "dangerous operations is %s.\n"),
145 /* Current working directory. */
147 char *current_directory
;
149 /* The last command line executed on the console. Used for command
150 repetitions when the user enters an empty line. */
152 static char *saved_command_line
;
154 /* If not NULL, the arguments that should be passed if
155 saved_command_line is repeated. */
157 static const char *repeat_arguments
;
159 /* The previous last command line executed on the console. Used for command
160 repetitions when a command wants to relaunch the previously launched
161 command. We need this as when a command is running, saved_command_line
162 already contains the line of the currently executing command. */
164 static char *previous_saved_command_line
;
166 /* If not NULL, the arguments that should be passed if the
167 previous_saved_command_line is repeated. */
169 static const char *previous_repeat_arguments
;
171 /* Nonzero if the current command is modified by "server ". This
172 affects things like recording into the command history, commands
173 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
174 whatever) can issue its own commands and also send along commands
175 from the user, and have the user not notice that the user interface
176 is issuing commands too. */
179 /* Timeout limit for response from target. */
181 /* The default value has been changed many times over the years. It
182 was originally 5 seconds. But that was thought to be a long time
183 to sit and wait, so it was changed to 2 seconds. That was thought
184 to be plenty unless the connection was going through some terminal
185 server or multiplexer or other form of hairy serial connection.
187 In mid-1996, remote_timeout was moved from remote.c to top.c and
188 it began being used in other remote-* targets. It appears that the
189 default was changed to 20 seconds at that time, perhaps because the
190 Renesas E7000 ICE didn't always respond in a timely manner.
192 But if 5 seconds is a long time to sit and wait for retransmissions,
193 20 seconds is far worse. This demonstrates the difficulty of using
194 a single variable for all protocol timeouts.
196 As remote.c is used much more than remote-e7000.c, it was changed
197 back to 2 seconds in 1999. */
199 int remote_timeout
= 2;
201 /* Sbrk location on entry to main. Used for statistics only. */
202 #ifdef HAVE_USEFUL_SBRK
206 /* Hooks for alternate command interfaces. */
208 /* This hook is called from within gdb's many mini-event loops which
209 could steal control from a real user interface's event loop. It
210 returns non-zero if the user is requesting a detach, zero
213 int (*deprecated_ui_loop_hook
) (int);
216 /* Called from print_frame_info to list the line we stopped in. */
218 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
222 /* Replaces most of query. */
224 int (*deprecated_query_hook
) (const char *, va_list);
226 /* Replaces most of warning. */
228 void (*deprecated_warning_hook
) (const char *, va_list);
230 /* These three functions support getting lines of text from the user.
231 They are used in sequence. First deprecated_readline_begin_hook is
232 called with a text string that might be (for example) a message for
233 the user to type in a sequence of commands to be executed at a
234 breakpoint. If this function calls back to a GUI, it might take
235 this opportunity to pop up a text interaction window with this
236 message. Next, deprecated_readline_hook is called with a prompt
237 that is emitted prior to collecting the user input. It can be
238 called multiple times. Finally, deprecated_readline_end_hook is
239 called to notify the GUI that we are done with the interaction
240 window and it can close it. */
242 void (*deprecated_readline_begin_hook
) (const char *, ...);
243 char *(*deprecated_readline_hook
) (const char *);
244 void (*deprecated_readline_end_hook
) (void);
246 /* Called as appropriate to notify the interface that we have attached
247 to or detached from an already running process. */
249 void (*deprecated_attach_hook
) (void);
250 void (*deprecated_detach_hook
) (void);
252 /* Called when going to wait for the target. Usually allows the GUI
253 to run while waiting for target events. */
255 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
256 struct target_waitstatus
*status
,
259 /* Used by UI as a wrapper around command execution. May do various
260 things like enabling/disabling buttons, etc... */
262 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
263 const char *cmd
, int from_tty
);
265 /* Called when the current thread changes. Argument is thread id. */
267 void (*deprecated_context_hook
) (int id
);
269 /* The highest UI number ever assigned. */
270 static int highest_ui_num
;
274 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
276 num (++highest_ui_num
),
277 call_readline (nullptr),
278 input_handler (nullptr),
280 interp_info (nullptr),
282 secondary_prompt_depth (0),
283 stdin_stream (instream_
),
284 instream (instream_
),
285 outstream (outstream_
),
286 errstream (errstream_
),
287 input_fd (fileno (instream
)),
288 input_interactive_p (ISATTY (instream
)),
289 prompt_state (PROMPT_NEEDED
),
290 m_gdb_stdout (new stdio_file (outstream
)),
291 m_gdb_stdin (new stdio_file (instream
)),
292 m_gdb_stderr (new stderr_file (errstream
)),
293 m_gdb_stdlog (m_gdb_stderr
),
294 m_current_uiout (nullptr)
296 buffer_init (&line_buffer
);
304 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
312 struct ui
*ui
, *uiprev
;
316 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
320 gdb_assert (ui
!= NULL
);
332 /* Open file named NAME for read/write, making sure not to make it the
333 controlling terminal. */
336 open_terminal_stream (const char *name
)
340 fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
342 perror_with_name (_("opening terminal failed"));
344 return gdb_file_up (fdopen (fd
, "w+"));
347 /* Implementation of the "new-ui" command. */
350 new_ui_command (const char *args
, int from_tty
)
353 const char *interpreter_name
;
354 const char *tty_name
;
358 gdb_argv
argv (args
);
359 argc
= argv
.count ();
362 error (_("Usage: new-ui INTERPRETER TTY"));
364 interpreter_name
= argv
[0];
368 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
370 /* Open specified terminal. Note: we used to open it three times,
371 once for each of stdin/stdout/stderr, but that does not work
372 with Windows named pipes. */
373 gdb_file_up stream
= open_terminal_stream (tty_name
);
375 std::unique_ptr
<ui
> ui
376 (new struct ui (stream
.get (), stream
.get (), stream
.get ()));
380 current_ui
= ui
.get ();
382 set_top_level_interpreter (interpreter_name
);
384 interp_pre_command_loop (top_level_interpreter ());
386 /* Make sure the file is not closed. */
392 printf_unfiltered ("New UI allocated\n");
395 /* Handler for SIGHUP. */
398 /* NOTE 1999-04-29: This function will be static again, once we modify
399 gdb to use the event loop as the default command loop and we merge
400 event-top.c into this file, top.c. */
404 /* Stop asking user for confirmation --- we're exiting. This
405 prevents asking the user dumb questions. */
407 quit_command ((char *) 0, 0);
409 #endif /* defined SIGHUP */
411 /* Line number we are currently in, in a file which is being sourced. */
412 /* NOTE 1999-04-29: This variable will be static again, once we modify
413 gdb to use the event loop as the default command loop and we merge
414 event-top.c into this file, top.c. */
415 /* static */ int source_line_number
;
417 /* Name of the file we are sourcing. */
418 /* NOTE 1999-04-29: This variable will be static again, once we modify
419 gdb to use the event loop as the default command loop and we merge
420 event-top.c into this file, top.c. */
421 /* static */ std::string source_file_name
;
423 /* Read commands from STREAM. */
425 read_command_file (FILE *stream
)
427 struct ui
*ui
= current_ui
;
429 scoped_restore save_instream
430 = make_scoped_restore (&ui
->instream
, stream
);
432 /* Read commands from `instream' and execute them until end of file
433 or error reading instream. */
435 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
439 /* Get a command-line. This calls the readline package. */
440 command
= command_line_input (NULL
, NULL
);
443 command_handler (command
);
449 do_chdir_cleanup (void *old_dir
)
451 chdir ((const char *) old_dir
);
457 prepare_execute_command ()
459 /* With multiple threads running while the one we're examining is
460 stopped, the dcache can get stale without us being able to detect
461 it. For the duration of the command, though, use the dcache to
462 help things like backtrace. */
464 target_dcache_invalidate ();
466 return scoped_value_mark ();
469 /* Tell the user if the language has changed (except first time) after
470 executing a command. */
473 check_frame_language_change (void)
475 static int warned
= 0;
476 struct frame_info
*frame
;
478 /* First make sure that a new frame has been selected, in case the
479 command or the hooks changed the program state. */
480 frame
= deprecated_safe_get_selected_frame ();
481 if (current_language
!= expected_language
)
483 if (language_mode
== language_mode_auto
&& info_verbose
)
485 /* Print what changed. */
491 /* Warn the user if the working language does not match the language
492 of the current frame. Only warn the user if we are actually
493 running the program, i.e. there is a stack. */
494 /* FIXME: This should be cacheing the frame and only running when
495 the frame changes. */
497 if (has_stack_frames ())
501 flang
= get_frame_language (frame
);
503 && flang
!= language_unknown
504 && flang
!= current_language
->la_language
)
506 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
515 wait_sync_command_done (void)
517 /* Processing events may change the current UI. */
518 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
519 struct ui
*ui
= current_ui
;
521 /* We're about to wait until the target stops after having resumed
522 it so must force-commit resumptions, in case we're being called
523 in some context where a scoped_disable_commit_resumed object is
524 active. I.e., this function is a commit-resumed sync/flush
526 scoped_enable_commit_resumed
enable ("sync wait");
528 while (gdb_do_one_event () >= 0)
529 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
536 maybe_wait_sync_command_done (int was_sync
)
538 /* If the interpreter is in sync mode (we're running a user
539 command's list, running command hooks or similars), and we
540 just ran a synchronous command that started the target, wait
541 for that command to end. */
542 if (!current_ui
->async
544 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
545 wait_sync_command_done ();
551 set_repeat_arguments (const char *args
)
553 repeat_arguments
= args
;
556 /* Execute the line P as a command, in the current user context.
557 Pass FROM_TTY as second argument to the defining function. */
560 execute_command (const char *p
, int from_tty
)
562 struct cmd_list_element
*c
;
564 const char *cmd_start
= p
;
566 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
567 scoped_value_mark cleanup
= prepare_execute_command ();
569 /* This can happen when command_line_input hits end of file. */
572 cleanup_if_error
.release ();
576 target_log_command (p
);
578 while (*p
== ' ' || *p
== '\t')
584 std::string default_args
;
585 std::string default_args_and_arg
;
586 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
590 /* If trace-commands is set then this will print this command. */
591 print_command_trace ("%s", p
);
593 c
= lookup_cmd (&cmd
, cmdlist
, "", &default_args
, 0, 1);
596 scoped_restore save_repeat_args
597 = make_scoped_restore (&repeat_arguments
, nullptr);
598 const char *args_pointer
= p
;
600 if (!default_args
.empty ())
603 default_args_and_arg
= default_args
+ ' ' + p
;
605 default_args_and_arg
= default_args
;
606 arg
= default_args_and_arg
.c_str ();
610 /* Pass null arg rather than an empty one. */
611 arg
= *p
== '\0' ? nullptr : p
;
614 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
615 while the is_complete_command(cfunc) test is just plain
616 bogus. They should both be replaced by a test of the form
617 c->strip_trailing_white_space_p. */
618 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
619 can't be replaced with func. This is because it is the
620 cfunc, and not the func, that has the value that the
621 is_complete_command hack is testing for. */
622 /* Clear off trailing whitespace, except for set and complete
624 std::string without_whitespace
;
626 && c
->type
!= set_cmd
627 && !is_complete_command (c
))
629 const char *old_end
= arg
+ strlen (arg
) - 1;
631 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
635 without_whitespace
= std::string (arg
, p
+ 1);
636 arg
= without_whitespace
.c_str ();
640 /* If this command has been pre-hooked, run the hook first. */
641 execute_cmd_pre_hook (c
);
643 if (c
->deprecated_warn_user
)
644 deprecated_cmd_warning (line
, cmdlist
);
646 /* c->user_commands would be NULL in the case of a python command. */
647 if (c
->theclass
== class_user
&& c
->user_commands
)
648 execute_user_command (c
, arg
);
649 else if (c
->theclass
== class_user
650 && c
->prefixlist
&& !c
->allow_unknown
)
651 /* If this is a user defined prefix that does not allow unknown
652 (in other words, C is a prefix command and not a command
653 that can be followed by its args), report the list of
657 ("\"%.*s\" must be followed by the name of a subcommand.\n",
658 (int) strlen (c
->prefixname
) - 1, c
->prefixname
);
659 help_list (*c
->prefixlist
, c
->prefixname
, all_commands
, gdb_stdout
);
661 else if (c
->type
== set_cmd
)
662 do_set_command (arg
, from_tty
, c
);
663 else if (c
->type
== show_cmd
)
664 do_show_command (arg
, from_tty
, c
);
665 else if (!cmd_func_p (c
))
666 error (_("That is not a command, just a help topic."));
667 else if (deprecated_call_command_hook
)
668 deprecated_call_command_hook (c
, arg
, from_tty
);
670 cmd_func (c
, arg
, from_tty
);
672 maybe_wait_sync_command_done (was_sync
);
674 /* If this command has been post-hooked, run the hook last. */
675 execute_cmd_post_hook (c
);
677 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
679 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
680 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
685 /* Only perform the frame-language-change check if the command
686 we just finished executing did not resume the inferior's execution.
687 If it did resume the inferior, we will do that check after
688 the inferior stopped. */
689 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
690 check_frame_language_change ();
692 cleanup_if_error
.release ();
695 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
696 do not display it to the screen. BATCH_FLAG will be
697 temporarily set to true. */
700 execute_command_to_ui_file (struct ui_file
*file
, const char *p
, int from_tty
)
702 /* GDB_STDOUT should be better already restored during these
703 restoration callbacks. */
704 set_batch_flag_and_restore_page_info save_page_info
;
706 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
709 current_uiout
->redirect (file
);
710 ui_out_redirect_pop
redirect_popper (current_uiout
);
712 scoped_restore save_stdout
713 = make_scoped_restore (&gdb_stdout
, file
);
714 scoped_restore save_stderr
715 = make_scoped_restore (&gdb_stderr
, file
);
716 scoped_restore save_stdlog
717 = make_scoped_restore (&gdb_stdlog
, file
);
718 scoped_restore save_stdtarg
719 = make_scoped_restore (&gdb_stdtarg
, file
);
720 scoped_restore save_stdtargerr
721 = make_scoped_restore (&gdb_stdtargerr
, file
);
723 execute_command (p
, from_tty
);
730 execute_command_to_string (const char *p
, int from_tty
,
733 string_file
str_file (term_out
);
735 execute_command_to_ui_file (&str_file
, p
, from_tty
);
736 return std::move (str_file
.string ());
740 /* When nonzero, cause dont_repeat to do nothing. This should only be
741 set via prevent_dont_repeat. */
743 static int suppress_dont_repeat
= 0;
750 struct ui
*ui
= current_ui
;
752 if (suppress_dont_repeat
|| server_command
)
755 /* If we aren't reading from standard input, we are saving the last
756 thing read from stdin in line and don't want to delete it. Null
757 lines won't repeat here in any case. */
758 if (ui
->instream
== ui
->stdin_stream
)
760 *saved_command_line
= 0;
761 repeat_arguments
= NULL
;
770 /* Do not repeat this command, as this command is a repeating command. */
773 /* We cannot free saved_command_line, as this line is being executed,
774 so swap it with previous_saved_command_line. */
775 std::swap (previous_saved_command_line
, saved_command_line
);
776 std::swap (previous_repeat_arguments
, repeat_arguments
);
778 const char *prev
= skip_spaces (get_saved_command_line ());
780 error (_("No previous command to relaunch"));
786 scoped_restore_tmpl
<int>
787 prevent_dont_repeat (void)
789 return make_scoped_restore (&suppress_dont_repeat
, 1);
795 get_saved_command_line ()
797 return saved_command_line
;
803 save_command_line (const char *cmd
)
805 xfree (previous_saved_command_line
);
806 previous_saved_command_line
= saved_command_line
;
807 previous_repeat_arguments
= repeat_arguments
;
808 saved_command_line
= xstrdup (cmd
);
809 repeat_arguments
= NULL
;
813 /* Read a line from the stream "instream" without command line editing.
815 It prints PROMPT once at the start.
816 Action is compatible with "readline", e.g. space for the result is
817 malloc'd and should be freed by the caller.
819 A NULL return means end of file. */
822 gdb_readline_no_editing (const char *prompt
)
824 struct buffer line_buffer
;
825 struct ui
*ui
= current_ui
;
826 /* Read from stdin if we are executing a user defined command. This
827 is the right thing for prompt_for_continue, at least. */
828 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
829 int fd
= fileno (stream
);
831 buffer_init (&line_buffer
);
835 /* Don't use a _filtered function here. It causes the assumed
836 character position to be off, since the newline we read from
837 the user is not accounted for. */
838 fputs_unfiltered (prompt
, gdb_stdout
);
839 gdb_flush (gdb_stdout
);
849 /* Wait until at least one byte of data is available. Control-C
850 can interrupt interruptible_select, but not fgetc. */
852 FD_SET (fd
, &readfds
);
853 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
857 /* If this was ctrl-c, the QUIT above handles it. */
860 perror_with_name (("select"));
867 if (line_buffer
.used_size
> 0)
868 /* The last line does not end with a newline. Return it, and
869 if we are called again fgetc will still return EOF and
870 we'll return NULL then. */
872 xfree (buffer_finish (&line_buffer
));
878 if (line_buffer
.used_size
> 0
879 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
880 line_buffer
.used_size
--;
884 buffer_grow_char (&line_buffer
, c
);
887 buffer_grow_char (&line_buffer
, '\0');
888 return buffer_finish (&line_buffer
);
891 /* Variables which control command line editing and history
892 substitution. These variables are given default values at the end
894 static bool command_editing_p
;
896 /* NOTE 1999-04-29: This variable will be static again, once we modify
897 gdb to use the event loop as the default command loop and we merge
898 event-top.c into this file, top.c. */
900 /* static */ bool history_expansion_p
;
902 /* Should we write out the command history on exit? In order to write out
903 the history both this flag must be true, and the history_filename
904 variable must be set to something sensible. */
905 static bool write_history_p
;
907 /* Implement 'show history save'. */
909 show_write_history_p (struct ui_file
*file
, int from_tty
,
910 struct cmd_list_element
*c
, const char *value
)
912 if (!write_history_p
|| !history_filename_empty ())
913 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
916 fprintf_filtered (file
, _("Saving of the history is disabled due to "
917 "the value of 'history filename'.\n"));
920 /* The variable associated with the "set/show history size"
921 command. The value -1 means unlimited, and -2 means undefined. */
922 static int history_size_setshow_var
= -2;
925 show_history_size (struct ui_file
*file
, int from_tty
,
926 struct cmd_list_element
*c
, const char *value
)
928 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
932 /* Variable associated with the "history remove-duplicates" option.
933 The value -1 means unlimited. */
934 static int history_remove_duplicates
= 0;
937 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
938 struct cmd_list_element
*c
, const char *value
)
940 fprintf_filtered (file
,
941 _("The number of history entries to look back at for "
942 "duplicates is %s.\n"),
946 /* The name of the file in which GDB history will be written. If this is
947 set to NULL, of the empty string then history will not be written. */
948 static char *history_filename
;
950 /* Return true if the history_filename is either NULL or the empty string,
951 indicating that we should not try to read, nor write out the history. */
953 history_filename_empty (void)
955 return (history_filename
== nullptr || *history_filename
== '\0');
958 /* Implement 'show history filename'. */
960 show_history_filename (struct ui_file
*file
, int from_tty
,
961 struct cmd_list_element
*c
, const char *value
)
963 if (!history_filename_empty ())
964 fprintf_filtered (file
, _("The filename in which to record "
965 "the command history is \"%ps\".\n"),
966 styled_string (file_name_style
.style (), value
));
968 fprintf_filtered (file
, _("There is no filename currently set for "
969 "recording the command history in.\n"));
972 /* This is like readline(), but it has some gdb-specific behavior.
973 gdb may want readline in both the synchronous and async modes during
974 a single gdb invocation. At the ordinary top-level prompt we might
975 be using the async readline. That means we can't use
976 rl_pre_input_hook, since it doesn't work properly in async mode.
977 However, for a secondary prompt (" >", such as occurs during a
978 `define'), gdb wants a synchronous response.
980 We used to call readline() directly, running it in synchronous
981 mode. But mixing modes this way is not supported, and as of
982 readline 5.x it no longer works; the arrow keys come unbound during
983 the synchronous call. So we make a nested call into the event
984 loop. That's what gdb_readline_wrapper is for. */
986 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
987 rely on gdb_readline_wrapper_result, which might still be NULL if
988 the user types Control-D for EOF. */
989 static int gdb_readline_wrapper_done
;
991 /* The result of the current call to gdb_readline_wrapper, once a newline
993 static char *gdb_readline_wrapper_result
;
995 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
996 to be called after the newline is processed (which will redisplay
997 the prompt). But in gdb_readline_wrapper we will not get a new
998 prompt until the next call, or until we return to the event loop.
999 So we disable this hook around the newline and restore it before we
1001 static void (*saved_after_char_processing_hook
) (void);
1007 gdb_in_secondary_prompt_p (struct ui
*ui
)
1009 return ui
->secondary_prompt_depth
> 0;
1013 /* This function is called when readline has seen a complete line of
1017 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
1019 gdb_assert (!gdb_readline_wrapper_done
);
1020 gdb_readline_wrapper_result
= line
.release ();
1021 gdb_readline_wrapper_done
= 1;
1023 /* Prevent operate-and-get-next from acting too early. */
1024 saved_after_char_processing_hook
= after_char_processing_hook
;
1025 after_char_processing_hook
= NULL
;
1027 /* Prevent parts of the prompt from being redisplayed if annotations
1028 are enabled, and readline's state getting out of sync. We'll
1029 reinstall the callback handler, which puts the terminal in raw
1030 mode (or in readline lingo, in prepped state), when we're next
1031 ready to process user input, either in display_gdb_prompt, or if
1032 we're handling an asynchronous target event and running in the
1033 background, just before returning to the event loop to process
1034 further input (or more target events). */
1035 if (current_ui
->command_editing
)
1036 gdb_rl_callback_handler_remove ();
1039 class gdb_readline_wrapper_cleanup
1042 gdb_readline_wrapper_cleanup ()
1043 : m_handler_orig (current_ui
->input_handler
),
1044 m_already_prompted_orig (current_ui
->command_editing
1045 ? rl_already_prompted
: 0),
1046 m_target_is_async_orig (target_is_async_p ()),
1047 m_save_ui (¤t_ui
)
1049 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1050 current_ui
->secondary_prompt_depth
++;
1052 if (m_target_is_async_orig
)
1056 ~gdb_readline_wrapper_cleanup ()
1058 struct ui
*ui
= current_ui
;
1060 if (ui
->command_editing
)
1061 rl_already_prompted
= m_already_prompted_orig
;
1063 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1064 ui
->input_handler
= m_handler_orig
;
1066 /* Don't restore our input handler in readline yet. That would make
1067 readline prep the terminal (putting it in raw mode), while the
1068 line we just read may trigger execution of a command that expects
1069 the terminal in the default cooked/canonical mode, such as e.g.,
1070 running Python's interactive online help utility. See
1071 gdb_readline_wrapper_line for when we'll reinstall it. */
1073 gdb_readline_wrapper_result
= NULL
;
1074 gdb_readline_wrapper_done
= 0;
1075 ui
->secondary_prompt_depth
--;
1076 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1078 after_char_processing_hook
= saved_after_char_processing_hook
;
1079 saved_after_char_processing_hook
= NULL
;
1081 if (m_target_is_async_orig
)
1085 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1089 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1090 int m_already_prompted_orig
;
1092 /* Whether the target was async. */
1093 int m_target_is_async_orig
;
1095 /* Processing events may change the current UI. */
1096 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1100 gdb_readline_wrapper (const char *prompt
)
1102 struct ui
*ui
= current_ui
;
1104 gdb_readline_wrapper_cleanup cleanup
;
1106 /* Display our prompt and prevent double prompt display. Don't pass
1107 down a NULL prompt, since that has special meaning for
1108 display_gdb_prompt -- it indicates a request to print the primary
1109 prompt, while we want a secondary prompt here. */
1110 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1111 if (ui
->command_editing
)
1112 rl_already_prompted
= 1;
1114 if (after_char_processing_hook
)
1115 (*after_char_processing_hook
) ();
1116 gdb_assert (after_char_processing_hook
== NULL
);
1118 while (gdb_do_one_event () >= 0)
1119 if (gdb_readline_wrapper_done
)
1122 return gdb_readline_wrapper_result
;
1126 /* The current saved history number from operate-and-get-next.
1127 This is -1 if not valid. */
1128 static int operate_saved_history
= -1;
1130 /* This is put on the appropriate hook and helps operate-and-get-next
1133 gdb_rl_operate_and_get_next_completion (void)
1135 int delta
= where_history () - operate_saved_history
;
1137 /* The `key' argument to rl_get_previous_history is ignored. */
1138 rl_get_previous_history (delta
, 0);
1139 operate_saved_history
= -1;
1141 /* readline doesn't automatically update the display for us. */
1144 after_char_processing_hook
= NULL
;
1145 rl_pre_input_hook
= NULL
;
1148 /* This is a gdb-local readline command handler. It accepts the
1149 current command line (like RET does) and, if this command was taken
1150 from the history, arranges for the next command in the history to
1151 appear on the command line when the prompt returns.
1152 We ignore the arguments. */
1154 gdb_rl_operate_and_get_next (int count
, int key
)
1158 /* Use the async hook. */
1159 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1161 /* Find the current line, and find the next line to use. */
1162 where
= where_history();
1164 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1165 || (where
>= history_length
- 1))
1166 operate_saved_history
= where
;
1168 operate_saved_history
= where
+ 1;
1170 return rl_newline (1, key
);
1173 /* Number of user commands executed during this session. */
1175 static int command_count
= 0;
1177 /* Add the user command COMMAND to the input history list. */
1180 gdb_add_history (const char *command
)
1184 if (history_remove_duplicates
!= 0)
1187 int lookbehind_threshold
;
1189 /* The lookbehind threshold for finding a duplicate history entry is
1190 bounded by command_count because we can't meaningfully delete
1191 history entries that are already stored in the history file since
1192 the history file is appended to. */
1193 if (history_remove_duplicates
== -1
1194 || history_remove_duplicates
> command_count
)
1195 lookbehind_threshold
= command_count
;
1197 lookbehind_threshold
= history_remove_duplicates
;
1200 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1202 HIST_ENTRY
*temp
= previous_history ();
1207 if (strcmp (temp
->line
, command
) == 0)
1209 HIST_ENTRY
*prev
= remove_history (where_history ());
1211 free_history_entry (prev
);
1218 add_history (command
);
1221 /* Safely append new history entries to the history file in a corruption-free
1222 way using an intermediate local history file. */
1225 gdb_safe_append_history (void)
1227 int ret
, saved_errno
;
1229 std::string local_history_filename
1230 = string_printf ("%s-gdb%ld~", history_filename
, (long) getpid ());
1232 ret
= rename (history_filename
, local_history_filename
.c_str ());
1233 saved_errno
= errno
;
1234 if (ret
< 0 && saved_errno
!= ENOENT
)
1236 warning (_("Could not rename %ps to %ps: %s"),
1237 styled_string (file_name_style
.style (), history_filename
),
1238 styled_string (file_name_style
.style (),
1239 local_history_filename
.c_str ()),
1240 safe_strerror (saved_errno
));
1246 /* If the rename failed with ENOENT then either the global history
1247 file never existed in the first place or another GDB process is
1248 currently appending to it (and has thus temporarily renamed it).
1249 Since we can't distinguish between these two cases, we have to
1250 conservatively assume the first case and therefore must write out
1251 (not append) our known history to our local history file and try
1252 to move it back anyway. Otherwise a global history file would
1253 never get created! */
1254 gdb_assert (saved_errno
== ENOENT
);
1255 write_history (local_history_filename
.c_str ());
1259 append_history (command_count
, local_history_filename
.c_str ());
1260 if (history_is_stifled ())
1261 history_truncate_file (local_history_filename
.c_str (),
1262 history_max_entries
);
1265 ret
= rename (local_history_filename
.c_str (), history_filename
);
1266 saved_errno
= errno
;
1267 if (ret
< 0 && saved_errno
!= EEXIST
)
1268 warning (_("Could not rename %s to %s: %s"),
1269 local_history_filename
.c_str (), history_filename
,
1270 safe_strerror (saved_errno
));
1274 /* Read one line from the command input stream `instream' into a local
1275 static buffer. The buffer is made bigger as necessary. Returns
1276 the address of the start of the line.
1278 NULL is returned for end of file.
1280 This routine either uses fancy command line editing or simple input
1281 as the user has requested. */
1284 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1286 static struct buffer cmd_line_buffer
;
1287 static int cmd_line_buffer_initialized
;
1288 struct ui
*ui
= current_ui
;
1289 const char *prompt
= prompt_arg
;
1291 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1293 /* The annotation suffix must be non-NULL. */
1294 if (annotation_suffix
== NULL
)
1295 annotation_suffix
= "";
1297 if (from_tty
&& annotation_level
> 1)
1302 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1303 + strlen (annotation_suffix
) + 40);
1305 local_prompt
[0] = '\0';
1307 strcpy (local_prompt
, prompt
);
1308 strcat (local_prompt
, "\n\032\032");
1309 strcat (local_prompt
, annotation_suffix
);
1310 strcat (local_prompt
, "\n");
1312 prompt
= local_prompt
;
1315 if (!cmd_line_buffer_initialized
)
1317 buffer_init (&cmd_line_buffer
);
1318 cmd_line_buffer_initialized
= 1;
1321 /* Starting a new command line. */
1322 cmd_line_buffer
.used_size
= 0;
1326 signal (SIGTSTP
, handle_sigtstp
);
1331 gdb::unique_xmalloc_ptr
<char> rl
;
1333 /* Make sure that all output has been output. Some machines may
1334 let you get away with leaving out some of the gdb_flush, but
1337 gdb_flush (gdb_stdout
);
1338 gdb_flush (gdb_stderr
);
1340 if (!source_file_name
.empty ())
1341 ++source_line_number
;
1343 if (from_tty
&& annotation_level
> 1)
1345 puts_unfiltered ("\n\032\032pre-");
1346 puts_unfiltered (annotation_suffix
);
1347 puts_unfiltered ("\n");
1350 /* Don't use fancy stuff if not talking to stdin. */
1351 if (deprecated_readline_hook
1353 && input_interactive_p (current_ui
))
1355 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1357 else if (command_editing_p
1359 && input_interactive_p (current_ui
))
1361 rl
.reset (gdb_readline_wrapper (prompt
));
1365 rl
.reset (gdb_readline_no_editing (prompt
));
1368 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1369 0, annotation_suffix
);
1370 if (cmd
== (char *) EOF
)
1378 /* Got partial input. I.e., got a line that ends with a
1379 continuation character (backslash). Suppress printing the
1386 signal (SIGTSTP
, SIG_DFL
);
1394 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1396 /* From GNU coding standards, first line is meant to be easy for a
1397 program to parse, and is just canonical program name and version
1398 number, which starts after last space. */
1400 std::string v_str
= string_printf ("GNU gdb %s%s", PKGVERSION
, version
);
1401 fprintf_filtered (stream
, "%ps\n",
1402 styled_string (version_style
.style (), v_str
.c_str ()));
1404 /* Second line is a copyright notice. */
1406 fprintf_filtered (stream
,
1407 "Copyright (C) 2021 Free Software Foundation, Inc.\n");
1409 /* Following the copyright is a brief statement that the program is
1410 free software, that users are free to copy and change it on
1411 certain conditions, that it is covered by the GNU GPL, and that
1412 there is no warranty. */
1414 fprintf_filtered (stream
, "\
1415 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1416 \nThis is free software: you are free to change and redistribute it.\n\
1417 There is NO WARRANTY, to the extent permitted by law.");
1422 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1423 "\"show warranty\" for details.\n"));
1425 /* After the required info we print the configuration information. */
1427 fprintf_filtered (stream
, "This GDB was configured as \"");
1428 if (strcmp (host_name
, target_name
) != 0)
1430 fprintf_filtered (stream
, "--host=%s --target=%s",
1431 host_name
, target_name
);
1435 fprintf_filtered (stream
, "%s", host_name
);
1437 fprintf_filtered (stream
, "\".\n");
1439 fprintf_filtered (stream
, _("Type \"show configuration\" "
1440 "for configuration details.\n"));
1442 if (REPORT_BUGS_TO
[0])
1444 fprintf_filtered (stream
,
1445 _("For bug reporting instructions, please see:\n"));
1446 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1448 fprintf_filtered (stream
,
1449 _("Find the GDB manual and other documentation \
1450 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1451 fprintf_filtered (stream
, "\n\n");
1452 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1453 fprintf_filtered (stream
,
1454 _("Type \"apropos word\" to search for commands \
1455 related to \"word\"."));
1458 /* Print the details of GDB build-time configuration. */
1460 print_gdb_configuration (struct ui_file
*stream
)
1462 fprintf_filtered (stream
, _("\
1463 This GDB was configured as follows:\n\
1464 configure --host=%s --target=%s\n\
1465 "), host_name
, target_name
);
1467 fprintf_filtered (stream
, _("\
1468 --with-auto-load-dir=%s\n\
1469 --with-auto-load-safe-path=%s\n\
1470 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1473 fprintf_filtered (stream
, _("\
1477 fprintf_filtered (stream
, _("\
1483 fprintf_filtered (stream
, _("\
1484 --with-gdb-datadir=%s%s\n\
1485 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1488 fprintf_filtered (stream
, _("\
1489 --with-iconv-bin=%s%s\n\
1490 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1493 if (JIT_READER_DIR
[0])
1494 fprintf_filtered (stream
, _("\
1495 --with-jit-reader-dir=%s%s\n\
1496 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1498 #if HAVE_LIBUNWIND_IA64_H
1499 fprintf_filtered (stream
, _("\
1500 --with-libunwind-ia64\n\
1503 fprintf_filtered (stream
, _("\
1504 --without-libunwind-ia64\n\
1509 fprintf_filtered (stream
, _("\
1513 fprintf_filtered (stream
, _("\
1518 #if HAVE_LIBBABELTRACE
1519 fprintf_filtered (stream
, _("\
1520 --with-babeltrace\n\
1523 fprintf_filtered (stream
, _("\
1524 --without-babeltrace\n\
1529 fprintf_filtered (stream
, _("\
1533 fprintf_filtered (stream
, _("\
1534 --without-intel-pt\n\
1539 fprintf_filtered (stream
, _("\
1543 fprintf_filtered (stream
, _("\
1548 fprintf_filtered (stream
, _("\
1552 fprintf_filtered (stream
, _("\
1556 #ifdef WITH_PYTHON_PATH
1557 fprintf_filtered (stream
, _("\
1558 --with-python=%s%s\n\
1559 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1561 fprintf_filtered (stream
, _("\
1565 #ifdef WITH_PYTHON_LIBDIR
1566 fprintf_filtered (stream
, _("\
1567 --with-python-libdir=%s%s\n\
1568 "), WITH_PYTHON_LIBDIR
, PYTHON_LIBDIR_RELOCATABLE
? " (relocatable)" : "");
1570 fprintf_filtered (stream
, _("\
1571 --without-python-libdir\n\
1575 #if HAVE_LIBDEBUGINFOD
1576 fprintf_filtered (stream
, _("\
1577 --with-debuginfod\n\
1580 fprintf_filtered (stream
, _("\
1581 --without-debuginfod\n\
1586 fprintf_filtered (stream
, _("\
1590 fprintf_filtered (stream
, _("\
1595 #if HAVE_SOURCE_HIGHLIGHT
1596 fprintf_filtered (stream
, _("\
1597 --enable-source-highlight\n\
1600 fprintf_filtered (stream
, _("\
1601 --disable-source-highlight\n\
1606 fprintf_filtered (stream
, _("\
1607 --with-relocated-sources=%s\n\
1612 fprintf_filtered (stream
, _("\
1613 --with-separate-debug-dir=%s%s\n\
1614 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1616 if (TARGET_SYSTEM_ROOT
[0])
1617 fprintf_filtered (stream
, _("\
1618 --with-sysroot=%s%s\n\
1619 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1621 if (SYSTEM_GDBINIT
[0])
1622 fprintf_filtered (stream
, _("\
1623 --with-system-gdbinit=%s%s\n\
1624 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1626 if (SYSTEM_GDBINIT_DIR
[0])
1627 fprintf_filtered (stream
, _("\
1628 --with-system-gdbinit-dir=%s%s\n\
1629 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1631 /* We assume "relocatable" will be printed at least once, thus we always
1632 print this text. It's a reasonably safe assumption for now. */
1633 fprintf_filtered (stream
, _("\n\
1634 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1635 tree, and GDB will still find it.)\n\
1640 /* The current top level prompt, settable with "set prompt", and/or
1641 with the python `gdb.prompt_hook' hook. */
1642 static char *top_prompt
;
1644 /* Access method for the GDB prompt string. */
1652 /* Set method for the GDB prompt string. */
1655 set_prompt (const char *s
)
1657 char *p
= xstrdup (s
);
1664 /* Kills or detaches the given inferior, depending on how we originally
1665 gained control of it. */
1668 kill_or_detach (inferior
*inf
, int from_tty
)
1673 thread_info
*thread
= any_thread_of_inferior (inf
);
1676 switch_to_thread (thread
);
1678 /* Leave core files alone. */
1679 if (target_has_execution ())
1681 if (inf
->attach_flag
)
1682 target_detach (inf
, from_tty
);
1689 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1690 where to collect the output. */
1693 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1698 if (inf
->attach_flag
)
1699 fprintf_filtered (out
,
1700 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1701 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1703 fprintf_filtered (out
,
1704 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1705 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1708 /* If necessary, make the user confirm that we should quit. Return
1709 non-zero if we should quit, zero if we shouldn't. */
1714 /* Don't even ask if we're only debugging a core file inferior. */
1715 if (!have_live_inferiors ())
1718 /* Build the query string as a single string. */
1721 stb
.puts (_("A debugging session is active.\n\n"));
1723 for (inferior
*inf
: all_inferiors ())
1724 print_inferior_quit_action (inf
, &stb
);
1726 stb
.puts (_("\nQuit anyway? "));
1728 return query ("%s", stb
.c_str ());
1731 /* Prepare to exit GDB cleanly by undoing any changes made to the
1732 terminal so that we leave the terminal in the state we acquired it. */
1735 undo_terminal_modifications_before_exit (void)
1737 struct ui
*saved_top_level
= current_ui
;
1739 target_terminal::ours ();
1741 current_ui
= main_ui
;
1746 gdb_disable_readline ();
1748 current_ui
= saved_top_level
;
1752 /* Quit without asking for confirmation. */
1755 quit_force (int *exit_arg
, int from_tty
)
1759 undo_terminal_modifications_before_exit ();
1761 /* An optional expression may be used to cause gdb to terminate with the
1762 value of that expression. */
1764 exit_code
= *exit_arg
;
1765 else if (return_child_result
)
1766 exit_code
= return_child_result_value
;
1768 /* We want to handle any quit errors and exit regardless. */
1770 /* Get out of tfind mode, and kill or detach all inferiors. */
1773 disconnect_tracing ();
1774 for (inferior
*inf
: all_inferiors ())
1775 kill_or_detach (inf
, from_tty
);
1777 catch (const gdb_exception
&ex
)
1779 exception_print (gdb_stderr
, ex
);
1782 /* Give all pushed targets a chance to do minimal cleanup, and pop
1784 for (inferior
*inf
: all_inferiors ())
1786 switch_to_inferior_no_thread (inf
);
1791 catch (const gdb_exception
&ex
)
1793 exception_print (gdb_stderr
, ex
);
1797 /* Save the history information if it is appropriate to do so. */
1800 if (write_history_p
&& history_filename
)
1804 /* History is currently shared between all UIs. If there's
1805 any UI with a terminal, save history. */
1806 for (ui
*ui
: all_uis ())
1808 if (input_interactive_p (ui
))
1816 gdb_safe_append_history ();
1819 catch (const gdb_exception
&ex
)
1821 exception_print (gdb_stderr
, ex
);
1824 /* Destroy any values currently allocated now instead of leaving it
1825 to global destructors, because that may be too late. For
1826 example, the destructors of xmethod values call into the Python
1827 runtime, which is finalized via a final cleanup. */
1830 /* Do any final cleanups before exiting. */
1833 do_final_cleanups ();
1835 catch (const gdb_exception
&ex
)
1837 exception_print (gdb_stderr
, ex
);
1843 /* The value of the "interactive-mode" setting. */
1844 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1846 /* Implement the "show interactive-mode" option. */
1849 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1850 struct cmd_list_element
*c
,
1853 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1854 fprintf_filtered (file
, "Debugger's interactive mode "
1855 "is %s (currently %s).\n",
1856 value
, input_interactive_p (current_ui
) ? "on" : "off");
1858 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1861 /* Returns whether GDB is running on an interactive terminal. */
1864 input_interactive_p (struct ui
*ui
)
1869 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1870 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1872 return ui
->input_interactive_p
;
1876 dont_repeat_command (const char *ignored
, int from_tty
)
1878 /* Can't call dont_repeat here because we're not necessarily reading
1880 *saved_command_line
= 0;
1883 /* Functions to manipulate command line editing control variables. */
1885 /* Number of commands to print in each call to show_commands. */
1886 #define Hist_print 10
1888 show_commands (const char *args
, int from_tty
)
1890 /* Index for history commands. Relative to history_base. */
1893 /* Number of the history entry which we are planning to display next.
1894 Relative to history_base. */
1897 /* Print out some of the commands from the command history. */
1901 if (args
[0] == '+' && args
[1] == '\0')
1902 /* "info editing +" should print from the stored position. */
1905 /* "info editing <exp>" should print around command number <exp>. */
1906 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1908 /* "show commands" means print the last Hist_print commands. */
1911 num
= history_length
- Hist_print
;
1917 /* If there are at least Hist_print commands, we want to display the last
1918 Hist_print rather than, say, the last 6. */
1919 if (history_length
- num
< Hist_print
)
1921 num
= history_length
- Hist_print
;
1927 offset
< num
+ Hist_print
&& offset
< history_length
;
1930 printf_filtered ("%5d %s\n", history_base
+ offset
,
1931 (history_get (history_base
+ offset
))->line
);
1934 /* The next command we want to display is the next one that we haven't
1938 /* If the user repeats this command with return, it should do what
1939 "show commands +" does. This is unnecessary if arg is null,
1940 because "show commands +" is not useful after "show commands". */
1941 if (from_tty
&& args
)
1942 set_repeat_arguments ("+");
1945 /* Update the size of our command history file to HISTORY_SIZE.
1947 A HISTORY_SIZE of -1 stands for unlimited. */
1950 set_readline_history_size (int history_size
)
1952 gdb_assert (history_size
>= -1);
1954 if (history_size
== -1)
1955 unstifle_history ();
1957 stifle_history (history_size
);
1960 /* Called by do_setshow_command. */
1962 set_history_size_command (const char *args
,
1963 int from_tty
, struct cmd_list_element
*c
)
1965 set_readline_history_size (history_size_setshow_var
);
1968 bool info_verbose
= false; /* Default verbose msgs off. */
1970 /* Called by do_set_command. An elaborate joke. */
1972 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1974 const char *cmdname
= "verbose";
1975 struct cmd_list_element
*showcmd
;
1977 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, NULL
, 1);
1978 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1980 if (c
->doc
&& c
->doc_allocated
)
1981 xfree ((char *) c
->doc
);
1982 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1983 xfree ((char *) showcmd
->doc
);
1986 c
->doc
= _("Set verbose printing of informational messages.");
1987 showcmd
->doc
= _("Show verbose printing of informational messages.");
1991 c
->doc
= _("Set verbosity.");
1992 showcmd
->doc
= _("Show verbosity.");
1994 c
->doc_allocated
= 0;
1995 showcmd
->doc_allocated
= 0;
1998 /* Init the history buffer. Note that we are called after the init file(s)
1999 have been read so that the user can change the history file via his
2000 .gdbinit file (for instance). The GDBHISTFILE environment variable
2001 overrides all of this. */
2008 tmpenv
= getenv ("GDBHISTSIZE");
2015 tmpenv
= skip_spaces (tmpenv
);
2017 var
= strtol (tmpenv
, &endptr
, 10);
2018 saved_errno
= errno
;
2019 endptr
= skip_spaces (endptr
);
2021 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
2022 empty string, a negative number or a huge positive number (larger than
2023 INT_MAX) then set the history size to unlimited. Otherwise set our
2024 history size to the number we have read. This behavior is consistent
2025 with how bash handles HISTSIZE. */
2026 if (*endptr
!= '\0')
2028 else if (*tmpenv
== '\0'
2031 /* On targets where INT_MAX == LONG_MAX, we have to look at
2032 errno after calling strtol to distinguish between a value that
2033 is exactly INT_MAX and an overflowing value that was clamped
2035 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2036 history_size_setshow_var
= -1;
2038 history_size_setshow_var
= var
;
2041 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2043 if (history_size_setshow_var
== -2)
2044 history_size_setshow_var
= 256;
2046 set_readline_history_size (history_size_setshow_var
);
2048 tmpenv
= getenv ("GDBHISTFILE");
2049 if (tmpenv
!= nullptr)
2050 history_filename
= xstrdup (tmpenv
);
2051 else if (history_filename
== nullptr)
2053 /* We include the current directory so that if the user changes
2054 directories the file written will be the same as the one
2057 /* No leading dots in file names are allowed on MSDOS. */
2058 const char *fname
= "_gdb_history";
2060 const char *fname
= ".gdb_history";
2063 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (fname
));
2064 history_filename
= temp
.release ();
2067 if (!history_filename_empty ())
2068 read_history (history_filename
);
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 static char *staged_gdb_datadir
;
2117 /* "set" command for the gdb_datadir configuration variable. */
2120 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2122 set_gdb_data_directory (staged_gdb_datadir
);
2123 gdb::observers::gdb_datadir_changed
.notify ();
2126 /* "show" command for the gdb_datadir configuration variable. */
2129 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2130 struct cmd_list_element
*c
, const char *value
)
2132 fprintf_filtered (file
, _("GDB's data directory is \"%ps\".\n"),
2133 styled_string (file_name_style
.style (),
2134 gdb_datadir
.c_str ()));
2137 /* Implement 'set history filename'. */
2140 set_history_filename (const char *args
,
2141 int from_tty
, struct cmd_list_element
*c
)
2143 /* We include the current directory so that if the user changes
2144 directories the file written will be the same as the one
2146 if (!history_filename_empty () && !IS_ABSOLUTE_PATH (history_filename
))
2148 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (history_filename
));
2150 xfree (history_filename
);
2151 history_filename
= temp
.release ();
2156 init_gdb_version_vars (void)
2158 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2159 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2160 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2161 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2162 set_internalvar_integer (major_version_var
, vmajor
);
2163 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2169 struct cmd_list_element
*c
;
2171 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2172 the DEFAULT_PROMPT is. */
2173 set_prompt (DEFAULT_PROMPT
);
2175 /* Set the important stuff up for command editing. */
2176 command_editing_p
= 1;
2177 history_expansion_p
= 0;
2178 write_history_p
= 0;
2180 /* Setup important stuff for command line editing. */
2181 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2182 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2183 set_rl_completer_word_break_characters (default_word_break_characters ());
2184 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2185 rl_completion_display_matches_hook
= cli_display_match_list
;
2186 rl_readline_name
= "gdb";
2187 rl_terminal_name
= getenv ("TERM");
2189 /* The name for this defun comes from Bash, where it originated.
2190 15 is Control-o, the same binding this function has in Bash. */
2191 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2193 add_setshow_string_cmd ("prompt", class_support
,
2195 _("Set gdb's prompt."),
2196 _("Show gdb's prompt."),
2199 &setlist
, &showlist
);
2201 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2202 Don't repeat this command.\nPrimarily \
2203 used inside of user-defined commands that should not be repeated when\n\
2206 add_setshow_boolean_cmd ("editing", class_support
,
2207 &set_editing_cmd_var
, _("\
2208 Set editing of command lines as they are typed."), _("\
2209 Show editing of command lines as they are typed."), _("\
2210 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2211 Without an argument, command line editing is enabled. To edit, use\n\
2212 EMACS-like or VI-like commands like control-P or ESC."),
2215 &setlist
, &showlist
);
2217 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2218 Set saving of the history record on exit."), _("\
2219 Show saving of the history record on exit."), _("\
2220 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2221 Without an argument, saving is enabled."),
2223 show_write_history_p
,
2224 &sethistlist
, &showhistlist
);
2226 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2227 &history_size_setshow_var
, _("\
2228 Set the size of the command history."), _("\
2229 Show the size of the command history."), _("\
2230 This is the number of previous commands to keep a record of.\n\
2231 If set to \"unlimited\", the number of commands kept in the history\n\
2232 list is unlimited. This defaults to the value of the environment\n\
2233 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2234 set_history_size_command
,
2236 &sethistlist
, &showhistlist
);
2238 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2239 &history_remove_duplicates
, _("\
2240 Set how far back in history to look for and remove duplicate entries."), _("\
2241 Show how far back in history to look for and remove duplicate entries."), _("\
2242 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2243 and remove the first history entry that is a duplicate of the most recent\n\
2244 entry, each time a new history entry is added.\n\
2245 If set to \"unlimited\", this lookbehind is unbounded.\n\
2246 Only history entries added during this session are considered for removal.\n\
2247 If set to 0, removal of duplicate history entries is disabled.\n\
2248 By default this option is set to 0."),
2250 show_history_remove_duplicates
,
2251 &sethistlist
, &showhistlist
);
2253 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2254 Set the filename in which to record the command history."), _("\
2255 Show the filename in which to record the command history."), _("\
2256 (the list of previous commands of which a record is kept)."),
2257 set_history_filename
,
2258 show_history_filename
,
2259 &sethistlist
, &showhistlist
);
2261 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2262 Set whether to confirm potentially dangerous operations."), _("\
2263 Show whether to confirm potentially dangerous operations."), NULL
,
2266 &setlist
, &showlist
);
2268 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2269 Set annotation_level."), _("\
2270 Show annotation_level."), _("\
2271 0 == normal; 1 == fullname (for use when running under emacs)\n\
2272 2 == output annotated suitably for use by programs that control GDB."),
2274 show_annotation_level
,
2275 &setlist
, &showlist
);
2277 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2278 &exec_done_display_p
, _("\
2279 Set notification of completion for asynchronous execution commands."), _("\
2280 Show notification of completion for asynchronous execution commands."), _("\
2281 Use \"on\" to enable the notification, and \"off\" to disable it."),
2283 show_exec_done_display_p
,
2284 &setlist
, &showlist
);
2286 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2287 &staged_gdb_datadir
, _("Set GDB's data directory."),
2288 _("Show GDB's data directory."),
2290 When set, GDB uses the specified path to search for data files."),
2291 set_gdb_datadir
, show_gdb_datadir
,
2295 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2296 &interactive_mode
, _("\
2297 Set whether GDB's standard input is a terminal."), _("\
2298 Show whether GDB's standard input is a terminal."), _("\
2299 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2300 means that GDB should wait for the user to answer queries associated to\n\
2301 commands entered at the command prompt. If off, GDB assumes that standard\n\
2302 input is not a terminal, and uses the default answer to all queries.\n\
2303 If auto (the default), determine which mode to use based on the standard\n\
2306 show_interactive_mode
,
2307 &setlist
, &showlist
);
2309 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2311 Usage: new-ui INTERPRETER TTY\n\
2312 The first argument is the name of the interpreter to run.\n\
2313 The second argument is the terminal the UI runs on."), &cmdlist
);
2314 set_cmd_completer (c
, interpreter_completer
);
2318 gdb_init (char *argv0
)
2320 saved_command_line
= xstrdup ("");
2321 previous_saved_command_line
= xstrdup ("");
2323 /* Run the init function of each source file. */
2326 /* Make sure we return to the original directory upon exit, come
2327 what may, since the OS doesn't do that for us. */
2328 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2331 init_cmd_lists (); /* This needs to be done first. */
2335 /* Here is where we call all the _initialize_foo routines. */
2336 initialize_all_files ();
2338 /* This creates the current_program_space. Do this after all the
2339 _initialize_foo routines have had a chance to install their
2340 per-sspace data keys. Also do this before
2341 initialize_current_architecture is called, because it accesses
2342 exec_bfd of the current program space. */
2343 initialize_progspace ();
2344 initialize_inferiors ();
2345 initialize_current_architecture ();
2346 init_main (); /* But that omits this file! Do it now. */
2348 initialize_stdin_serial ();
2350 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2352 set_initial_gdb_ttystate ();
2354 async_init_signals ();
2356 /* We need a default language for parsing expressions, so simple
2357 things like "set width 0" won't fail if no language is explicitly
2358 set in a config file or implicitly set by reading an executable
2360 set_language (language_c
);
2361 expected_language
= current_language
; /* Don't warn about the change. */
2363 /* Python initialization, for example, can require various commands to be
2364 installed. For example "info pretty-printer" needs the "info"
2365 prefix to be installed. Keep things simple and just do final
2366 script initialization here. */
2367 finish_ext_lang_initialization ();
2369 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2370 init_gdb_version_vars ();