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 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 /* Non-zero tells remote* modules to output debugging info. */
203 int remote_debug
= 0;
205 /* Sbrk location on entry to main. Used for statistics only. */
206 #ifdef HAVE_USEFUL_SBRK
210 /* Hooks for alternate command interfaces. */
212 /* This hook is called from within gdb's many mini-event loops which
213 could steal control from a real user interface's event loop. It
214 returns non-zero if the user is requesting a detach, zero
217 int (*deprecated_ui_loop_hook
) (int);
220 /* Called from print_frame_info to list the line we stopped in. */
222 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
226 /* Replaces most of query. */
228 int (*deprecated_query_hook
) (const char *, va_list);
230 /* Replaces most of warning. */
232 void (*deprecated_warning_hook
) (const char *, va_list);
234 /* These three functions support getting lines of text from the user.
235 They are used in sequence. First deprecated_readline_begin_hook is
236 called with a text string that might be (for example) a message for
237 the user to type in a sequence of commands to be executed at a
238 breakpoint. If this function calls back to a GUI, it might take
239 this opportunity to pop up a text interaction window with this
240 message. Next, deprecated_readline_hook is called with a prompt
241 that is emitted prior to collecting the user input. It can be
242 called multiple times. Finally, deprecated_readline_end_hook is
243 called to notify the GUI that we are done with the interaction
244 window and it can close it. */
246 void (*deprecated_readline_begin_hook
) (const char *, ...);
247 char *(*deprecated_readline_hook
) (const char *);
248 void (*deprecated_readline_end_hook
) (void);
250 /* Called as appropriate to notify the interface that we have attached
251 to or detached from an already running process. */
253 void (*deprecated_attach_hook
) (void);
254 void (*deprecated_detach_hook
) (void);
256 /* Called when going to wait for the target. Usually allows the GUI
257 to run while waiting for target events. */
259 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
260 struct target_waitstatus
*status
,
263 /* Used by UI as a wrapper around command execution. May do various
264 things like enabling/disabling buttons, etc... */
266 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
267 const char *cmd
, int from_tty
);
269 /* Called when the current thread changes. Argument is thread id. */
271 void (*deprecated_context_hook
) (int id
);
273 /* The highest UI number ever assigned. */
274 static int highest_ui_num
;
278 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
280 num (++highest_ui_num
),
281 call_readline (nullptr),
282 input_handler (nullptr),
284 interp_info (nullptr),
286 secondary_prompt_depth (0),
287 stdin_stream (instream_
),
288 instream (instream_
),
289 outstream (outstream_
),
290 errstream (errstream_
),
291 input_fd (fileno (instream
)),
292 input_interactive_p (ISATTY (instream
)),
293 prompt_state (PROMPT_NEEDED
),
294 m_gdb_stdout (new stdio_file (outstream
)),
295 m_gdb_stdin (new stdio_file (instream
)),
296 m_gdb_stderr (new stderr_file (errstream
)),
297 m_gdb_stdlog (m_gdb_stderr
),
298 m_current_uiout (nullptr)
300 buffer_init (&line_buffer
);
308 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
316 struct ui
*ui
, *uiprev
;
320 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
324 gdb_assert (ui
!= NULL
);
336 /* Open file named NAME for read/write, making sure not to make it the
337 controlling terminal. */
340 open_terminal_stream (const char *name
)
344 fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
346 perror_with_name (_("opening terminal failed"));
348 return gdb_file_up (fdopen (fd
, "w+"));
351 /* Implementation of the "new-ui" command. */
354 new_ui_command (const char *args
, int from_tty
)
357 const char *interpreter_name
;
358 const char *tty_name
;
362 gdb_argv
argv (args
);
363 argc
= argv
.count ();
366 error (_("Usage: new-ui INTERPRETER TTY"));
368 interpreter_name
= argv
[0];
372 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
374 /* Open specified terminal. Note: we used to open it three times,
375 once for each of stdin/stdout/stderr, but that does not work
376 with Windows named pipes. */
377 gdb_file_up stream
= open_terminal_stream (tty_name
);
379 std::unique_ptr
<ui
> ui
380 (new struct ui (stream
.get (), stream
.get (), stream
.get ()));
384 current_ui
= ui
.get ();
386 set_top_level_interpreter (interpreter_name
);
388 interp_pre_command_loop (top_level_interpreter ());
390 /* Make sure the file is not closed. */
396 printf_unfiltered ("New UI allocated\n");
399 /* Handler for SIGHUP. */
402 /* NOTE 1999-04-29: This function will be static again, once we modify
403 gdb to use the event loop as the default command loop and we merge
404 event-top.c into this file, top.c. */
408 /* Stop asking user for confirmation --- we're exiting. This
409 prevents asking the user dumb questions. */
411 quit_command ((char *) 0, 0);
413 #endif /* defined SIGHUP */
415 /* Line number we are currently in, in a file which is being sourced. */
416 /* NOTE 1999-04-29: This variable will be static again, once we modify
417 gdb to use the event loop as the default command loop and we merge
418 event-top.c into this file, top.c. */
419 /* static */ int source_line_number
;
421 /* Name of the file we are sourcing. */
422 /* NOTE 1999-04-29: This variable will be static again, once we modify
423 gdb to use the event loop as the default command loop and we merge
424 event-top.c into this file, top.c. */
425 /* static */ std::string source_file_name
;
427 /* Read commands from STREAM. */
429 read_command_file (FILE *stream
)
431 struct ui
*ui
= current_ui
;
433 scoped_restore save_instream
434 = make_scoped_restore (&ui
->instream
, stream
);
436 /* Read commands from `instream' and execute them until end of file
437 or error reading instream. */
439 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
443 /* Get a command-line. This calls the readline package. */
444 command
= command_line_input (NULL
, NULL
);
447 command_handler (command
);
453 do_chdir_cleanup (void *old_dir
)
455 chdir ((const char *) old_dir
);
461 prepare_execute_command ()
463 /* With multiple threads running while the one we're examining is
464 stopped, the dcache can get stale without us being able to detect
465 it. For the duration of the command, though, use the dcache to
466 help things like backtrace. */
468 target_dcache_invalidate ();
470 return scoped_value_mark ();
473 /* Tell the user if the language has changed (except first time) after
474 executing a command. */
477 check_frame_language_change (void)
479 static int warned
= 0;
480 struct frame_info
*frame
;
482 /* First make sure that a new frame has been selected, in case the
483 command or the hooks changed the program state. */
484 frame
= deprecated_safe_get_selected_frame ();
485 if (current_language
!= expected_language
)
487 if (language_mode
== language_mode_auto
&& info_verbose
)
489 language_info (1); /* Print what changed. */
494 /* Warn the user if the working language does not match the language
495 of the current frame. Only warn the user if we are actually
496 running the program, i.e. there is a stack. */
497 /* FIXME: This should be cacheing the frame and only running when
498 the frame changes. */
500 if (has_stack_frames ())
504 flang
= get_frame_language (frame
);
506 && flang
!= language_unknown
507 && flang
!= current_language
->la_language
)
509 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
518 wait_sync_command_done (void)
520 /* Processing events may change the current UI. */
521 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
522 struct ui
*ui
= current_ui
;
524 while (gdb_do_one_event () >= 0)
525 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
532 maybe_wait_sync_command_done (int was_sync
)
534 /* If the interpreter is in sync mode (we're running a user
535 command's list, running command hooks or similars), and we
536 just ran a synchronous command that started the target, wait
537 for that command to end. */
538 if (!current_ui
->async
540 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
541 wait_sync_command_done ();
547 set_repeat_arguments (const char *args
)
549 repeat_arguments
= args
;
552 /* Execute the line P as a command, in the current user context.
553 Pass FROM_TTY as second argument to the defining function. */
556 execute_command (const char *p
, int from_tty
)
558 struct cmd_list_element
*c
;
560 const char *cmd_start
= p
;
562 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
563 scoped_value_mark cleanup
= prepare_execute_command ();
565 /* This can happen when command_line_input hits end of file. */
568 cleanup_if_error
.release ();
572 target_log_command (p
);
574 while (*p
== ' ' || *p
== '\t')
580 std::string default_args
;
581 std::string default_args_and_arg
;
582 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
586 /* If trace-commands is set then this will print this command. */
587 print_command_trace ("%s", p
);
589 c
= lookup_cmd (&cmd
, cmdlist
, "", &default_args
, 0, 1);
592 scoped_restore save_repeat_args
593 = make_scoped_restore (&repeat_arguments
, nullptr);
594 const char *args_pointer
= p
;
596 if (!default_args
.empty ())
599 default_args_and_arg
= default_args
+ ' ' + p
;
601 default_args_and_arg
= default_args
;
602 arg
= default_args_and_arg
.c_str ();
606 /* Pass null arg rather than an empty one. */
607 arg
= *p
== '\0' ? nullptr : p
;
610 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
611 while the is_complete_command(cfunc) test is just plain
612 bogus. They should both be replaced by a test of the form
613 c->strip_trailing_white_space_p. */
614 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
615 can't be replaced with func. This is because it is the
616 cfunc, and not the func, that has the value that the
617 is_complete_command hack is testing for. */
618 /* Clear off trailing whitespace, except for set and complete
620 std::string without_whitespace
;
622 && c
->type
!= set_cmd
623 && !is_complete_command (c
))
625 const char *old_end
= arg
+ strlen (arg
) - 1;
627 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
631 without_whitespace
= std::string (arg
, p
+ 1);
632 arg
= without_whitespace
.c_str ();
636 /* If this command has been pre-hooked, run the hook first. */
637 execute_cmd_pre_hook (c
);
639 if (c
->deprecated_warn_user
)
640 deprecated_cmd_warning (line
, cmdlist
);
642 /* c->user_commands would be NULL in the case of a python command. */
643 if (c
->theclass
== class_user
&& c
->user_commands
)
644 execute_user_command (c
, arg
);
645 else if (c
->theclass
== class_user
646 && c
->prefixlist
&& !c
->allow_unknown
)
647 /* If this is a user defined prefix that does not allow unknown
648 (in other words, C is a prefix command and not a command
649 that can be followed by its args), report the list of
653 ("\"%.*s\" must be followed by the name of a subcommand.\n",
654 (int) strlen (c
->prefixname
) - 1, c
->prefixname
);
655 help_list (*c
->prefixlist
, c
->prefixname
, all_commands
, gdb_stdout
);
657 else if (c
->type
== set_cmd
)
658 do_set_command (arg
, from_tty
, c
);
659 else if (c
->type
== show_cmd
)
660 do_show_command (arg
, from_tty
, c
);
661 else if (!cmd_func_p (c
))
662 error (_("That is not a command, just a help topic."));
663 else if (deprecated_call_command_hook
)
664 deprecated_call_command_hook (c
, arg
, from_tty
);
666 cmd_func (c
, arg
, from_tty
);
668 maybe_wait_sync_command_done (was_sync
);
670 /* If this command has been post-hooked, run the hook last. */
671 execute_cmd_post_hook (c
);
673 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
675 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
676 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
681 /* Only perform the frame-language-change check if the command
682 we just finished executing did not resume the inferior's execution.
683 If it did resume the inferior, we will do that check after
684 the inferior stopped. */
685 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
686 check_frame_language_change ();
688 cleanup_if_error
.release ();
691 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
692 do not display it to the screen. BATCH_FLAG will be
693 temporarily set to true. */
696 execute_command_to_ui_file (struct ui_file
*file
, const char *p
, int from_tty
)
698 /* GDB_STDOUT should be better already restored during these
699 restoration callbacks. */
700 set_batch_flag_and_restore_page_info save_page_info
;
702 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
705 current_uiout
->redirect (file
);
706 ui_out_redirect_pop
redirect_popper (current_uiout
);
708 scoped_restore save_stdout
709 = make_scoped_restore (&gdb_stdout
, file
);
710 scoped_restore save_stderr
711 = make_scoped_restore (&gdb_stderr
, file
);
712 scoped_restore save_stdlog
713 = make_scoped_restore (&gdb_stdlog
, file
);
714 scoped_restore save_stdtarg
715 = make_scoped_restore (&gdb_stdtarg
, file
);
716 scoped_restore save_stdtargerr
717 = make_scoped_restore (&gdb_stdtargerr
, file
);
719 execute_command (p
, from_tty
);
723 /* Run execute_command for P and FROM_TTY. Capture its output into the
724 returned string, do not display it to the screen. BATCH_FLAG will be
725 temporarily set to true. */
728 execute_command_to_string (const char *p
, int from_tty
,
731 string_file
str_file (term_out
);
733 execute_command_to_ui_file (&str_file
, p
, from_tty
);
734 return std::move (str_file
.string ());
738 /* When nonzero, cause dont_repeat to do nothing. This should only be
739 set via prevent_dont_repeat. */
741 static int suppress_dont_repeat
= 0;
748 struct ui
*ui
= current_ui
;
750 if (suppress_dont_repeat
|| server_command
)
753 /* If we aren't reading from standard input, we are saving the last
754 thing read from stdin in line and don't want to delete it. Null
755 lines won't repeat here in any case. */
756 if (ui
->instream
== ui
->stdin_stream
)
758 *saved_command_line
= 0;
759 repeat_arguments
= NULL
;
768 /* Do not repeat this command, as this command is a repeating command. */
771 /* We cannot free saved_command_line, as this line is being executed,
772 so swap it with previous_saved_command_line. */
773 std::swap (previous_saved_command_line
, saved_command_line
);
774 std::swap (previous_repeat_arguments
, repeat_arguments
);
776 const char *prev
= skip_spaces (get_saved_command_line ());
778 error (_("No previous command to relaunch"));
784 scoped_restore_tmpl
<int>
785 prevent_dont_repeat (void)
787 return make_scoped_restore (&suppress_dont_repeat
, 1);
793 get_saved_command_line ()
795 return saved_command_line
;
801 save_command_line (const char *cmd
)
803 xfree (previous_saved_command_line
);
804 previous_saved_command_line
= saved_command_line
;
805 previous_repeat_arguments
= repeat_arguments
;
806 saved_command_line
= xstrdup (cmd
);
807 repeat_arguments
= NULL
;
811 /* Read a line from the stream "instream" without command line editing.
813 It prints PROMPT once at the start.
814 Action is compatible with "readline", e.g. space for the result is
815 malloc'd and should be freed by the caller.
817 A NULL return means end of file. */
820 gdb_readline_no_editing (const char *prompt
)
822 struct buffer line_buffer
;
823 struct ui
*ui
= current_ui
;
824 /* Read from stdin if we are executing a user defined command. This
825 is the right thing for prompt_for_continue, at least. */
826 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
827 int fd
= fileno (stream
);
829 buffer_init (&line_buffer
);
833 /* Don't use a _filtered function here. It causes the assumed
834 character position to be off, since the newline we read from
835 the user is not accounted for. */
836 fputs_unfiltered (prompt
, gdb_stdout
);
837 gdb_flush (gdb_stdout
);
847 /* Wait until at least one byte of data is available. Control-C
848 can interrupt interruptible_select, but not fgetc. */
850 FD_SET (fd
, &readfds
);
851 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
855 /* If this was ctrl-c, the QUIT above handles it. */
858 perror_with_name (("select"));
865 if (line_buffer
.used_size
> 0)
866 /* The last line does not end with a newline. Return it, and
867 if we are called again fgetc will still return EOF and
868 we'll return NULL then. */
870 xfree (buffer_finish (&line_buffer
));
876 if (line_buffer
.used_size
> 0
877 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
878 line_buffer
.used_size
--;
882 buffer_grow_char (&line_buffer
, c
);
885 buffer_grow_char (&line_buffer
, '\0');
886 return buffer_finish (&line_buffer
);
889 /* Variables which control command line editing and history
890 substitution. These variables are given default values at the end
892 static bool command_editing_p
;
894 /* NOTE 1999-04-29: This variable will be static again, once we modify
895 gdb to use the event loop as the default command loop and we merge
896 event-top.c into this file, top.c. */
898 /* static */ bool history_expansion_p
;
900 /* Should we write out the command history on exit? In order to write out
901 the history both this flag must be true, and the history_filename
902 variable must be set to something sensible. */
903 static bool write_history_p
;
905 /* Implement 'show history save'. */
907 show_write_history_p (struct ui_file
*file
, int from_tty
,
908 struct cmd_list_element
*c
, const char *value
)
910 if (!write_history_p
|| !history_filename_empty ())
911 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
914 fprintf_filtered (file
, _("Saving of the history is disabled due to "
915 "the value of 'history filename'.\n"));
918 /* The variable associated with the "set/show history size"
919 command. The value -1 means unlimited, and -2 means undefined. */
920 static int history_size_setshow_var
= -2;
923 show_history_size (struct ui_file
*file
, int from_tty
,
924 struct cmd_list_element
*c
, const char *value
)
926 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
930 /* Variable associated with the "history remove-duplicates" option.
931 The value -1 means unlimited. */
932 static int history_remove_duplicates
= 0;
935 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
936 struct cmd_list_element
*c
, const char *value
)
938 fprintf_filtered (file
,
939 _("The number of history entries to look back at for "
940 "duplicates is %s.\n"),
944 /* The name of the file in which GDB history will be written. If this is
945 set to NULL, of the empty string then history will not be written. */
946 static char *history_filename
;
948 /* Return true if the history_filename is either NULL or the empty string,
949 indicating that we should not try to read, nor write out the history. */
951 history_filename_empty (void)
953 return (history_filename
== nullptr || *history_filename
== '\0');
956 /* Implement 'show history filename'. */
958 show_history_filename (struct ui_file
*file
, int from_tty
,
959 struct cmd_list_element
*c
, const char *value
)
961 if (!history_filename_empty ())
962 fprintf_filtered (file
, _("The filename in which to record "
963 "the command history is \"%ps\".\n"),
964 styled_string (file_name_style
.style (), value
));
966 fprintf_filtered (file
, _("There is no filename currently set for "
967 "recording the command history in.\n"));
970 /* This is like readline(), but it has some gdb-specific behavior.
971 gdb may want readline in both the synchronous and async modes during
972 a single gdb invocation. At the ordinary top-level prompt we might
973 be using the async readline. That means we can't use
974 rl_pre_input_hook, since it doesn't work properly in async mode.
975 However, for a secondary prompt (" >", such as occurs during a
976 `define'), gdb wants a synchronous response.
978 We used to call readline() directly, running it in synchronous
979 mode. But mixing modes this way is not supported, and as of
980 readline 5.x it no longer works; the arrow keys come unbound during
981 the synchronous call. So we make a nested call into the event
982 loop. That's what gdb_readline_wrapper is for. */
984 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
985 rely on gdb_readline_wrapper_result, which might still be NULL if
986 the user types Control-D for EOF. */
987 static int gdb_readline_wrapper_done
;
989 /* The result of the current call to gdb_readline_wrapper, once a newline
991 static char *gdb_readline_wrapper_result
;
993 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
994 to be called after the newline is processed (which will redisplay
995 the prompt). But in gdb_readline_wrapper we will not get a new
996 prompt until the next call, or until we return to the event loop.
997 So we disable this hook around the newline and restore it before we
999 static void (*saved_after_char_processing_hook
) (void);
1005 gdb_in_secondary_prompt_p (struct ui
*ui
)
1007 return ui
->secondary_prompt_depth
> 0;
1011 /* This function is called when readline has seen a complete line of
1015 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
1017 gdb_assert (!gdb_readline_wrapper_done
);
1018 gdb_readline_wrapper_result
= line
.release ();
1019 gdb_readline_wrapper_done
= 1;
1021 /* Prevent operate-and-get-next from acting too early. */
1022 saved_after_char_processing_hook
= after_char_processing_hook
;
1023 after_char_processing_hook
= NULL
;
1025 /* Prevent parts of the prompt from being redisplayed if annotations
1026 are enabled, and readline's state getting out of sync. We'll
1027 reinstall the callback handler, which puts the terminal in raw
1028 mode (or in readline lingo, in prepped state), when we're next
1029 ready to process user input, either in display_gdb_prompt, or if
1030 we're handling an asynchronous target event and running in the
1031 background, just before returning to the event loop to process
1032 further input (or more target events). */
1033 if (current_ui
->command_editing
)
1034 gdb_rl_callback_handler_remove ();
1037 class gdb_readline_wrapper_cleanup
1040 gdb_readline_wrapper_cleanup ()
1041 : m_handler_orig (current_ui
->input_handler
),
1042 m_already_prompted_orig (current_ui
->command_editing
1043 ? rl_already_prompted
: 0),
1044 m_target_is_async_orig (target_is_async_p ()),
1045 m_save_ui (¤t_ui
)
1047 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1048 current_ui
->secondary_prompt_depth
++;
1050 if (m_target_is_async_orig
)
1054 ~gdb_readline_wrapper_cleanup ()
1056 struct ui
*ui
= current_ui
;
1058 if (ui
->command_editing
)
1059 rl_already_prompted
= m_already_prompted_orig
;
1061 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1062 ui
->input_handler
= m_handler_orig
;
1064 /* Don't restore our input handler in readline yet. That would make
1065 readline prep the terminal (putting it in raw mode), while the
1066 line we just read may trigger execution of a command that expects
1067 the terminal in the default cooked/canonical mode, such as e.g.,
1068 running Python's interactive online help utility. See
1069 gdb_readline_wrapper_line for when we'll reinstall it. */
1071 gdb_readline_wrapper_result
= NULL
;
1072 gdb_readline_wrapper_done
= 0;
1073 ui
->secondary_prompt_depth
--;
1074 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1076 after_char_processing_hook
= saved_after_char_processing_hook
;
1077 saved_after_char_processing_hook
= NULL
;
1079 if (m_target_is_async_orig
)
1083 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1087 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1088 int m_already_prompted_orig
;
1090 /* Whether the target was async. */
1091 int m_target_is_async_orig
;
1093 /* Processing events may change the current UI. */
1094 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1098 gdb_readline_wrapper (const char *prompt
)
1100 struct ui
*ui
= current_ui
;
1102 gdb_readline_wrapper_cleanup cleanup
;
1104 /* Display our prompt and prevent double prompt display. Don't pass
1105 down a NULL prompt, since that has special meaning for
1106 display_gdb_prompt -- it indicates a request to print the primary
1107 prompt, while we want a secondary prompt here. */
1108 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1109 if (ui
->command_editing
)
1110 rl_already_prompted
= 1;
1112 if (after_char_processing_hook
)
1113 (*after_char_processing_hook
) ();
1114 gdb_assert (after_char_processing_hook
== NULL
);
1116 while (gdb_do_one_event () >= 0)
1117 if (gdb_readline_wrapper_done
)
1120 return gdb_readline_wrapper_result
;
1124 /* The current saved history number from operate-and-get-next.
1125 This is -1 if not valid. */
1126 static int operate_saved_history
= -1;
1128 /* This is put on the appropriate hook and helps operate-and-get-next
1131 gdb_rl_operate_and_get_next_completion (void)
1133 int delta
= where_history () - operate_saved_history
;
1135 /* The `key' argument to rl_get_previous_history is ignored. */
1136 rl_get_previous_history (delta
, 0);
1137 operate_saved_history
= -1;
1139 /* readline doesn't automatically update the display for us. */
1142 after_char_processing_hook
= NULL
;
1143 rl_pre_input_hook
= NULL
;
1146 /* This is a gdb-local readline command handler. It accepts the
1147 current command line (like RET does) and, if this command was taken
1148 from the history, arranges for the next command in the history to
1149 appear on the command line when the prompt returns.
1150 We ignore the arguments. */
1152 gdb_rl_operate_and_get_next (int count
, int key
)
1156 /* Use the async hook. */
1157 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1159 /* Find the current line, and find the next line to use. */
1160 where
= where_history();
1162 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1163 || (where
>= history_length
- 1))
1164 operate_saved_history
= where
;
1166 operate_saved_history
= where
+ 1;
1168 return rl_newline (1, key
);
1171 /* Number of user commands executed during this session. */
1173 static int command_count
= 0;
1175 /* Add the user command COMMAND to the input history list. */
1178 gdb_add_history (const char *command
)
1182 if (history_remove_duplicates
!= 0)
1185 int lookbehind_threshold
;
1187 /* The lookbehind threshold for finding a duplicate history entry is
1188 bounded by command_count because we can't meaningfully delete
1189 history entries that are already stored in the history file since
1190 the history file is appended to. */
1191 if (history_remove_duplicates
== -1
1192 || history_remove_duplicates
> command_count
)
1193 lookbehind_threshold
= command_count
;
1195 lookbehind_threshold
= history_remove_duplicates
;
1198 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1200 HIST_ENTRY
*temp
= previous_history ();
1205 if (strcmp (temp
->line
, command
) == 0)
1207 HIST_ENTRY
*prev
= remove_history (where_history ());
1209 free_history_entry (prev
);
1216 add_history (command
);
1219 /* Safely append new history entries to the history file in a corruption-free
1220 way using an intermediate local history file. */
1223 gdb_safe_append_history (void)
1225 int ret
, saved_errno
;
1227 std::string local_history_filename
1228 = string_printf ("%s-gdb%ld~", history_filename
, (long) getpid ());
1230 ret
= rename (history_filename
, local_history_filename
.c_str ());
1231 saved_errno
= errno
;
1232 if (ret
< 0 && saved_errno
!= ENOENT
)
1234 warning (_("Could not rename %ps to %ps: %s"),
1235 styled_string (file_name_style
.style (), history_filename
),
1236 styled_string (file_name_style
.style (),
1237 local_history_filename
.c_str ()),
1238 safe_strerror (saved_errno
));
1244 /* If the rename failed with ENOENT then either the global history
1245 file never existed in the first place or another GDB process is
1246 currently appending to it (and has thus temporarily renamed it).
1247 Since we can't distinguish between these two cases, we have to
1248 conservatively assume the first case and therefore must write out
1249 (not append) our known history to our local history file and try
1250 to move it back anyway. Otherwise a global history file would
1251 never get created! */
1252 gdb_assert (saved_errno
== ENOENT
);
1253 write_history (local_history_filename
.c_str ());
1257 append_history (command_count
, local_history_filename
.c_str ());
1258 if (history_is_stifled ())
1259 history_truncate_file (local_history_filename
.c_str (),
1260 history_max_entries
);
1263 ret
= rename (local_history_filename
.c_str (), history_filename
);
1264 saved_errno
= errno
;
1265 if (ret
< 0 && saved_errno
!= EEXIST
)
1266 warning (_("Could not rename %s to %s: %s"),
1267 local_history_filename
.c_str (), history_filename
,
1268 safe_strerror (saved_errno
));
1272 /* Read one line from the command input stream `instream' into a local
1273 static buffer. The buffer is made bigger as necessary. Returns
1274 the address of the start of the line.
1276 NULL is returned for end of file.
1278 This routine either uses fancy command line editing or simple input
1279 as the user has requested. */
1282 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1284 static struct buffer cmd_line_buffer
;
1285 static int cmd_line_buffer_initialized
;
1286 struct ui
*ui
= current_ui
;
1287 const char *prompt
= prompt_arg
;
1289 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1291 /* The annotation suffix must be non-NULL. */
1292 if (annotation_suffix
== NULL
)
1293 annotation_suffix
= "";
1295 if (from_tty
&& annotation_level
> 1)
1300 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1301 + strlen (annotation_suffix
) + 40);
1303 local_prompt
[0] = '\0';
1305 strcpy (local_prompt
, prompt
);
1306 strcat (local_prompt
, "\n\032\032");
1307 strcat (local_prompt
, annotation_suffix
);
1308 strcat (local_prompt
, "\n");
1310 prompt
= local_prompt
;
1313 if (!cmd_line_buffer_initialized
)
1315 buffer_init (&cmd_line_buffer
);
1316 cmd_line_buffer_initialized
= 1;
1319 /* Starting a new command line. */
1320 cmd_line_buffer
.used_size
= 0;
1324 signal (SIGTSTP
, handle_sigtstp
);
1329 gdb::unique_xmalloc_ptr
<char> rl
;
1331 /* Make sure that all output has been output. Some machines may
1332 let you get away with leaving out some of the gdb_flush, but
1335 gdb_flush (gdb_stdout
);
1336 gdb_flush (gdb_stderr
);
1338 if (!source_file_name
.empty ())
1339 ++source_line_number
;
1341 if (from_tty
&& annotation_level
> 1)
1343 puts_unfiltered ("\n\032\032pre-");
1344 puts_unfiltered (annotation_suffix
);
1345 puts_unfiltered ("\n");
1348 /* Don't use fancy stuff if not talking to stdin. */
1349 if (deprecated_readline_hook
1351 && input_interactive_p (current_ui
))
1353 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1355 else if (command_editing_p
1357 && input_interactive_p (current_ui
))
1359 rl
.reset (gdb_readline_wrapper (prompt
));
1363 rl
.reset (gdb_readline_no_editing (prompt
));
1366 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1367 0, annotation_suffix
);
1368 if (cmd
== (char *) EOF
)
1376 /* Got partial input. I.e., got a line that ends with a
1377 continuation character (backslash). Suppress printing the
1384 signal (SIGTSTP
, SIG_DFL
);
1392 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1394 /* From GNU coding standards, first line is meant to be easy for a
1395 program to parse, and is just canonical program name and version
1396 number, which starts after last space. */
1398 ui_file_style style
;
1401 ui_file_style nstyle
= { ui_file_style::MAGENTA
, ui_file_style::NONE
,
1402 ui_file_style::BOLD
};
1405 fprintf_styled (stream
, style
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1407 /* Second line is a copyright notice. */
1409 fprintf_filtered (stream
,
1410 "Copyright (C) 2021 Free Software Foundation, Inc.\n");
1412 /* Following the copyright is a brief statement that the program is
1413 free software, that users are free to copy and change it on
1414 certain conditions, that it is covered by the GNU GPL, and that
1415 there is no warranty. */
1417 fprintf_filtered (stream
, "\
1418 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1419 \nThis is free software: you are free to change and redistribute it.\n\
1420 There is NO WARRANTY, to the extent permitted by law.");
1425 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1426 "\"show warranty\" for details.\n"));
1428 /* After the required info we print the configuration information. */
1430 fprintf_filtered (stream
, "This GDB was configured as \"");
1431 if (strcmp (host_name
, target_name
) != 0)
1433 fprintf_filtered (stream
, "--host=%s --target=%s",
1434 host_name
, target_name
);
1438 fprintf_filtered (stream
, "%s", host_name
);
1440 fprintf_filtered (stream
, "\".\n");
1442 fprintf_filtered (stream
, _("Type \"show configuration\" "
1443 "for configuration details.\n"));
1445 if (REPORT_BUGS_TO
[0])
1447 fprintf_filtered (stream
,
1448 _("For bug reporting instructions, please see:\n"));
1449 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1451 fprintf_filtered (stream
,
1452 _("Find the GDB manual and other documentation \
1453 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1454 fprintf_filtered (stream
, "\n\n");
1455 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1456 fprintf_filtered (stream
,
1457 _("Type \"apropos word\" to search for commands \
1458 related to \"word\"."));
1461 /* Print the details of GDB build-time configuration. */
1463 print_gdb_configuration (struct ui_file
*stream
)
1465 fprintf_filtered (stream
, _("\
1466 This GDB was configured as follows:\n\
1467 configure --host=%s --target=%s\n\
1468 "), host_name
, target_name
);
1470 fprintf_filtered (stream
, _("\
1471 --with-auto-load-dir=%s\n\
1472 --with-auto-load-safe-path=%s\n\
1473 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1476 fprintf_filtered (stream
, _("\
1480 fprintf_filtered (stream
, _("\
1486 fprintf_filtered (stream
, _("\
1487 --with-gdb-datadir=%s%s\n\
1488 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1491 fprintf_filtered (stream
, _("\
1492 --with-iconv-bin=%s%s\n\
1493 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1496 if (JIT_READER_DIR
[0])
1497 fprintf_filtered (stream
, _("\
1498 --with-jit-reader-dir=%s%s\n\
1499 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1501 #if HAVE_LIBUNWIND_IA64_H
1502 fprintf_filtered (stream
, _("\
1503 --with-libunwind-ia64\n\
1506 fprintf_filtered (stream
, _("\
1507 --without-libunwind-ia64\n\
1512 fprintf_filtered (stream
, _("\
1516 fprintf_filtered (stream
, _("\
1521 #if HAVE_LIBBABELTRACE
1522 fprintf_filtered (stream
, _("\
1523 --with-babeltrace\n\
1526 fprintf_filtered (stream
, _("\
1527 --without-babeltrace\n\
1532 fprintf_filtered (stream
, _("\
1536 fprintf_filtered (stream
, _("\
1537 --without-intel-pt\n\
1542 fprintf_filtered (stream
, _("\
1546 fprintf_filtered (stream
, _("\
1551 fprintf_filtered (stream
, _("\
1555 fprintf_filtered (stream
, _("\
1559 #ifdef WITH_PYTHON_PATH
1560 fprintf_filtered (stream
, _("\
1561 --with-python=%s%s\n\
1562 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1564 fprintf_filtered (stream
, _("\
1568 #ifdef WITH_PYTHON_LIBDIR
1569 fprintf_filtered (stream
, _("\
1570 --with-python-libdir=%s%s\n\
1571 "), WITH_PYTHON_LIBDIR
, PYTHON_LIBDIR_RELOCATABLE
? " (relocatable)" : "");
1573 fprintf_filtered (stream
, _("\
1574 --without-python-libdir\n\
1578 #if HAVE_LIBDEBUGINFOD
1579 fprintf_filtered (stream
, _("\
1580 --with-debuginfod\n\
1583 fprintf_filtered (stream
, _("\
1584 --without-debuginfod\n\
1589 fprintf_filtered (stream
, _("\
1593 fprintf_filtered (stream
, _("\
1598 #if HAVE_SOURCE_HIGHLIGHT
1599 fprintf_filtered (stream
, _("\
1600 --enable-source-highlight\n\
1603 fprintf_filtered (stream
, _("\
1604 --disable-source-highlight\n\
1609 fprintf_filtered (stream
, _("\
1610 --with-relocated-sources=%s\n\
1615 fprintf_filtered (stream
, _("\
1616 --with-separate-debug-dir=%s%s\n\
1617 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1619 if (TARGET_SYSTEM_ROOT
[0])
1620 fprintf_filtered (stream
, _("\
1621 --with-sysroot=%s%s\n\
1622 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1624 if (SYSTEM_GDBINIT
[0])
1625 fprintf_filtered (stream
, _("\
1626 --with-system-gdbinit=%s%s\n\
1627 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1629 if (SYSTEM_GDBINIT_DIR
[0])
1630 fprintf_filtered (stream
, _("\
1631 --with-system-gdbinit-dir=%s%s\n\
1632 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1634 /* We assume "relocatable" will be printed at least once, thus we always
1635 print this text. It's a reasonably safe assumption for now. */
1636 fprintf_filtered (stream
, _("\n\
1637 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1638 tree, and GDB will still find it.)\n\
1643 /* The current top level prompt, settable with "set prompt", and/or
1644 with the python `gdb.prompt_hook' hook. */
1645 static char *top_prompt
;
1647 /* Access method for the GDB prompt string. */
1655 /* Set method for the GDB prompt string. */
1658 set_prompt (const char *s
)
1660 char *p
= xstrdup (s
);
1667 /* Kills or detaches the given inferior, depending on how we originally
1668 gained control of it. */
1671 kill_or_detach (inferior
*inf
, int from_tty
)
1676 thread_info
*thread
= any_thread_of_inferior (inf
);
1679 switch_to_thread (thread
);
1681 /* Leave core files alone. */
1682 if (target_has_execution ())
1684 if (inf
->attach_flag
)
1685 target_detach (inf
, from_tty
);
1692 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1693 where to collect the output. */
1696 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1701 if (inf
->attach_flag
)
1702 fprintf_filtered (out
,
1703 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1704 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1706 fprintf_filtered (out
,
1707 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1708 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1711 /* If necessary, make the user confirm that we should quit. Return
1712 non-zero if we should quit, zero if we shouldn't. */
1717 /* Don't even ask if we're only debugging a core file inferior. */
1718 if (!have_live_inferiors ())
1721 /* Build the query string as a single string. */
1724 stb
.puts (_("A debugging session is active.\n\n"));
1726 for (inferior
*inf
: all_inferiors ())
1727 print_inferior_quit_action (inf
, &stb
);
1729 stb
.puts (_("\nQuit anyway? "));
1731 return query ("%s", stb
.c_str ());
1734 /* Prepare to exit GDB cleanly by undoing any changes made to the
1735 terminal so that we leave the terminal in the state we acquired it. */
1738 undo_terminal_modifications_before_exit (void)
1740 struct ui
*saved_top_level
= current_ui
;
1742 target_terminal::ours ();
1744 current_ui
= main_ui
;
1749 gdb_disable_readline ();
1751 current_ui
= saved_top_level
;
1755 /* Quit without asking for confirmation. */
1758 quit_force (int *exit_arg
, int from_tty
)
1762 undo_terminal_modifications_before_exit ();
1764 /* An optional expression may be used to cause gdb to terminate with the
1765 value of that expression. */
1767 exit_code
= *exit_arg
;
1768 else if (return_child_result
)
1769 exit_code
= return_child_result_value
;
1771 /* We want to handle any quit errors and exit regardless. */
1773 /* Get out of tfind mode, and kill or detach all inferiors. */
1776 disconnect_tracing ();
1777 for (inferior
*inf
: all_inferiors ())
1778 kill_or_detach (inf
, from_tty
);
1780 catch (const gdb_exception
&ex
)
1782 exception_print (gdb_stderr
, ex
);
1785 /* Give all pushed targets a chance to do minimal cleanup, and pop
1787 for (inferior
*inf
: all_inferiors ())
1789 switch_to_inferior_no_thread (inf
);
1794 catch (const gdb_exception
&ex
)
1796 exception_print (gdb_stderr
, ex
);
1800 /* Save the history information if it is appropriate to do so. */
1803 if (write_history_p
&& history_filename
)
1807 /* History is currently shared between all UIs. If there's
1808 any UI with a terminal, save history. */
1809 for (ui
*ui
: all_uis ())
1811 if (input_interactive_p (ui
))
1819 gdb_safe_append_history ();
1822 catch (const gdb_exception
&ex
)
1824 exception_print (gdb_stderr
, ex
);
1827 /* Destroy any values currently allocated now instead of leaving it
1828 to global destructors, because that may be too late. For
1829 example, the destructors of xmethod values call into the Python
1830 runtime, which is finalized via a final cleanup. */
1833 /* Do any final cleanups before exiting. */
1836 do_final_cleanups ();
1838 catch (const gdb_exception
&ex
)
1840 exception_print (gdb_stderr
, ex
);
1846 /* The value of the "interactive-mode" setting. */
1847 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1849 /* Implement the "show interactive-mode" option. */
1852 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1853 struct cmd_list_element
*c
,
1856 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1857 fprintf_filtered (file
, "Debugger's interactive mode "
1858 "is %s (currently %s).\n",
1859 value
, input_interactive_p (current_ui
) ? "on" : "off");
1861 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1864 /* Returns whether GDB is running on an interactive terminal. */
1867 input_interactive_p (struct ui
*ui
)
1872 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1873 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1875 return ui
->input_interactive_p
;
1879 dont_repeat_command (const char *ignored
, int from_tty
)
1881 /* Can't call dont_repeat here because we're not necessarily reading
1883 *saved_command_line
= 0;
1886 /* Functions to manipulate command line editing control variables. */
1888 /* Number of commands to print in each call to show_commands. */
1889 #define Hist_print 10
1891 show_commands (const char *args
, int from_tty
)
1893 /* Index for history commands. Relative to history_base. */
1896 /* Number of the history entry which we are planning to display next.
1897 Relative to history_base. */
1900 /* Print out some of the commands from the command history. */
1904 if (args
[0] == '+' && args
[1] == '\0')
1905 /* "info editing +" should print from the stored position. */
1908 /* "info editing <exp>" should print around command number <exp>. */
1909 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1911 /* "show commands" means print the last Hist_print commands. */
1914 num
= history_length
- Hist_print
;
1920 /* If there are at least Hist_print commands, we want to display the last
1921 Hist_print rather than, say, the last 6. */
1922 if (history_length
- num
< Hist_print
)
1924 num
= history_length
- Hist_print
;
1930 offset
< num
+ Hist_print
&& offset
< history_length
;
1933 printf_filtered ("%5d %s\n", history_base
+ offset
,
1934 (history_get (history_base
+ offset
))->line
);
1937 /* The next command we want to display is the next one that we haven't
1941 /* If the user repeats this command with return, it should do what
1942 "show commands +" does. This is unnecessary if arg is null,
1943 because "show commands +" is not useful after "show commands". */
1944 if (from_tty
&& args
)
1945 set_repeat_arguments ("+");
1948 /* Update the size of our command history file to HISTORY_SIZE.
1950 A HISTORY_SIZE of -1 stands for unlimited. */
1953 set_readline_history_size (int history_size
)
1955 gdb_assert (history_size
>= -1);
1957 if (history_size
== -1)
1958 unstifle_history ();
1960 stifle_history (history_size
);
1963 /* Called by do_setshow_command. */
1965 set_history_size_command (const char *args
,
1966 int from_tty
, struct cmd_list_element
*c
)
1968 set_readline_history_size (history_size_setshow_var
);
1971 bool info_verbose
= false; /* Default verbose msgs off. */
1973 /* Called by do_set_command. An elaborate joke. */
1975 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1977 const char *cmdname
= "verbose";
1978 struct cmd_list_element
*showcmd
;
1980 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, NULL
, 1);
1981 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1983 if (c
->doc
&& c
->doc_allocated
)
1984 xfree ((char *) c
->doc
);
1985 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1986 xfree ((char *) showcmd
->doc
);
1989 c
->doc
= _("Set verbose printing of informational messages.");
1990 showcmd
->doc
= _("Show verbose printing of informational messages.");
1994 c
->doc
= _("Set verbosity.");
1995 showcmd
->doc
= _("Show verbosity.");
1997 c
->doc_allocated
= 0;
1998 showcmd
->doc_allocated
= 0;
2001 /* Init the history buffer. Note that we are called after the init file(s)
2002 have been read so that the user can change the history file via his
2003 .gdbinit file (for instance). The GDBHISTFILE environment variable
2004 overrides all of this. */
2011 tmpenv
= getenv ("GDBHISTSIZE");
2018 tmpenv
= skip_spaces (tmpenv
);
2020 var
= strtol (tmpenv
, &endptr
, 10);
2021 saved_errno
= errno
;
2022 endptr
= skip_spaces (endptr
);
2024 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
2025 empty string, a negative number or a huge positive number (larger than
2026 INT_MAX) then set the history size to unlimited. Otherwise set our
2027 history size to the number we have read. This behavior is consistent
2028 with how bash handles HISTSIZE. */
2029 if (*endptr
!= '\0')
2031 else if (*tmpenv
== '\0'
2034 /* On targets where INT_MAX == LONG_MAX, we have to look at
2035 errno after calling strtol to distinguish between a value that
2036 is exactly INT_MAX and an overflowing value that was clamped
2038 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2039 history_size_setshow_var
= -1;
2041 history_size_setshow_var
= var
;
2044 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2046 if (history_size_setshow_var
== -2)
2047 history_size_setshow_var
= 256;
2049 set_readline_history_size (history_size_setshow_var
);
2051 tmpenv
= getenv ("GDBHISTFILE");
2052 if (tmpenv
!= nullptr)
2053 history_filename
= xstrdup (tmpenv
);
2054 else if (history_filename
== nullptr)
2056 /* We include the current directory so that if the user changes
2057 directories the file written will be the same as the one
2060 /* No leading dots in file names are allowed on MSDOS. */
2061 const char *fname
= "_gdb_history";
2063 const char *fname
= ".gdb_history";
2066 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (fname
));
2067 history_filename
= temp
.release ();
2070 if (!history_filename_empty ())
2071 read_history (history_filename
);
2075 show_prompt (struct ui_file
*file
, int from_tty
,
2076 struct cmd_list_element
*c
, const char *value
)
2078 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2081 /* "set editing" command. */
2084 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2086 change_line_handler (set_editing_cmd_var
);
2087 /* Update the control variable so that MI's =cmd-param-changed event
2088 shows the correct value. */
2089 set_editing_cmd_var
= current_ui
->command_editing
;
2093 show_editing (struct ui_file
*file
, int from_tty
,
2094 struct cmd_list_element
*c
, const char *value
)
2096 fprintf_filtered (file
, _("Editing of command lines as "
2097 "they are typed is %s.\n"),
2098 current_ui
->command_editing
? _("on") : _("off"));
2102 show_annotation_level (struct ui_file
*file
, int from_tty
,
2103 struct cmd_list_element
*c
, const char *value
)
2105 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2109 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2110 struct cmd_list_element
*c
, const char *value
)
2112 fprintf_filtered (file
, _("Notification of completion for "
2113 "asynchronous execution commands is %s.\n"),
2117 /* New values of the "data-directory" parameter are staged here. */
2118 static char *staged_gdb_datadir
;
2120 /* "set" command for the gdb_datadir configuration variable. */
2123 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2125 set_gdb_data_directory (staged_gdb_datadir
);
2126 gdb::observers::gdb_datadir_changed
.notify ();
2129 /* "show" command for the gdb_datadir configuration variable. */
2132 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2133 struct cmd_list_element
*c
, const char *value
)
2135 fprintf_filtered (file
, _("GDB's data directory is \"%ps\".\n"),
2136 styled_string (file_name_style
.style (),
2137 gdb_datadir
.c_str ()));
2140 /* Implement 'set history filename'. */
2143 set_history_filename (const char *args
,
2144 int from_tty
, struct cmd_list_element
*c
)
2146 /* We include the current directory so that if the user changes
2147 directories the file written will be the same as the one
2149 if (!history_filename_empty () && !IS_ABSOLUTE_PATH (history_filename
))
2151 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (history_filename
));
2153 xfree (history_filename
);
2154 history_filename
= temp
.release ();
2159 init_gdb_version_vars (void)
2161 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2162 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2163 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2164 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2165 set_internalvar_integer (major_version_var
, vmajor
);
2166 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2172 struct cmd_list_element
*c
;
2174 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2175 the DEFAULT_PROMPT is. */
2176 set_prompt (DEFAULT_PROMPT
);
2178 /* Set the important stuff up for command editing. */
2179 command_editing_p
= 1;
2180 history_expansion_p
= 0;
2181 write_history_p
= 0;
2183 /* Setup important stuff for command line editing. */
2184 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2185 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2186 set_rl_completer_word_break_characters (default_word_break_characters ());
2187 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2188 rl_completion_display_matches_hook
= cli_display_match_list
;
2189 rl_readline_name
= "gdb";
2190 rl_terminal_name
= getenv ("TERM");
2192 /* The name for this defun comes from Bash, where it originated.
2193 15 is Control-o, the same binding this function has in Bash. */
2194 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2196 add_setshow_string_cmd ("prompt", class_support
,
2198 _("Set gdb's prompt."),
2199 _("Show gdb's prompt."),
2202 &setlist
, &showlist
);
2204 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2205 Don't repeat this command.\nPrimarily \
2206 used inside of user-defined commands that should not be repeated when\n\
2209 add_setshow_boolean_cmd ("editing", class_support
,
2210 &set_editing_cmd_var
, _("\
2211 Set editing of command lines as they are typed."), _("\
2212 Show editing of command lines as they are typed."), _("\
2213 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2214 Without an argument, command line editing is enabled. To edit, use\n\
2215 EMACS-like or VI-like commands like control-P or ESC."),
2218 &setlist
, &showlist
);
2220 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2221 Set saving of the history record on exit."), _("\
2222 Show saving of the history record on exit."), _("\
2223 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2224 Without an argument, saving is enabled."),
2226 show_write_history_p
,
2227 &sethistlist
, &showhistlist
);
2229 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2230 &history_size_setshow_var
, _("\
2231 Set the size of the command history."), _("\
2232 Show the size of the command history."), _("\
2233 This is the number of previous commands to keep a record of.\n\
2234 If set to \"unlimited\", the number of commands kept in the history\n\
2235 list is unlimited. This defaults to the value of the environment\n\
2236 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2237 set_history_size_command
,
2239 &sethistlist
, &showhistlist
);
2241 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2242 &history_remove_duplicates
, _("\
2243 Set how far back in history to look for and remove duplicate entries."), _("\
2244 Show how far back in history to look for and remove duplicate entries."), _("\
2245 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2246 and remove the first history entry that is a duplicate of the most recent\n\
2247 entry, each time a new history entry is added.\n\
2248 If set to \"unlimited\", this lookbehind is unbounded.\n\
2249 Only history entries added during this session are considered for removal.\n\
2250 If set to 0, removal of duplicate history entries is disabled.\n\
2251 By default this option is set to 0."),
2253 show_history_remove_duplicates
,
2254 &sethistlist
, &showhistlist
);
2256 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2257 Set the filename in which to record the command history."), _("\
2258 Show the filename in which to record the command history."), _("\
2259 (the list of previous commands of which a record is kept)."),
2260 set_history_filename
,
2261 show_history_filename
,
2262 &sethistlist
, &showhistlist
);
2264 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2265 Set whether to confirm potentially dangerous operations."), _("\
2266 Show whether to confirm potentially dangerous operations."), NULL
,
2269 &setlist
, &showlist
);
2271 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2272 Set annotation_level."), _("\
2273 Show annotation_level."), _("\
2274 0 == normal; 1 == fullname (for use when running under emacs)\n\
2275 2 == output annotated suitably for use by programs that control GDB."),
2277 show_annotation_level
,
2278 &setlist
, &showlist
);
2280 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2281 &exec_done_display_p
, _("\
2282 Set notification of completion for asynchronous execution commands."), _("\
2283 Show notification of completion for asynchronous execution commands."), _("\
2284 Use \"on\" to enable the notification, and \"off\" to disable it."),
2286 show_exec_done_display_p
,
2287 &setlist
, &showlist
);
2289 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2290 &staged_gdb_datadir
, _("Set GDB's data directory."),
2291 _("Show GDB's data directory."),
2293 When set, GDB uses the specified path to search for data files."),
2294 set_gdb_datadir
, show_gdb_datadir
,
2298 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2299 &interactive_mode
, _("\
2300 Set whether GDB's standard input is a terminal."), _("\
2301 Show whether GDB's standard input is a terminal."), _("\
2302 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2303 means that GDB should wait for the user to answer queries associated to\n\
2304 commands entered at the command prompt. If off, GDB assumes that standard\n\
2305 input is not a terminal, and uses the default answer to all queries.\n\
2306 If auto (the default), determine which mode to use based on the standard\n\
2309 show_interactive_mode
,
2310 &setlist
, &showlist
);
2312 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2314 Usage: new-ui INTERPRETER TTY\n\
2315 The first argument is the name of the interpreter to run.\n\
2316 The second argument is the terminal the UI runs on."), &cmdlist
);
2317 set_cmd_completer (c
, interpreter_completer
);
2321 gdb_init (char *argv0
)
2323 saved_command_line
= xstrdup ("");
2324 previous_saved_command_line
= xstrdup ("");
2326 /* Run the init function of each source file. */
2329 /* Make sure we return to the original directory upon exit, come
2330 what may, since the OS doesn't do that for us. */
2331 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2334 init_cmd_lists (); /* This needs to be done first. */
2338 /* Here is where we call all the _initialize_foo routines. */
2339 initialize_all_files ();
2341 /* This creates the current_program_space. Do this after all the
2342 _initialize_foo routines have had a chance to install their
2343 per-sspace data keys. Also do this before
2344 initialize_current_architecture is called, because it accesses
2345 exec_bfd of the current program space. */
2346 initialize_progspace ();
2347 initialize_inferiors ();
2348 initialize_current_architecture ();
2349 init_main (); /* But that omits this file! Do it now. */
2351 initialize_stdin_serial ();
2353 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2355 set_initial_gdb_ttystate ();
2357 async_init_signals ();
2359 /* We need a default language for parsing expressions, so simple
2360 things like "set width 0" won't fail if no language is explicitly
2361 set in a config file or implicitly set by reading an executable
2363 set_language (language_c
);
2364 expected_language
= current_language
; /* Don't warn about the change. */
2366 /* Python initialization, for example, can require various commands to be
2367 installed. For example "info pretty-printer" needs the "info"
2368 prefix to be installed. Keep things simple and just do final
2369 script initialization here. */
2370 finish_ext_lang_initialization ();
2372 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2373 init_gdb_version_vars ();