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 language_info (1); /* Print what changed. */
490 /* Warn the user if the working language does not match the language
491 of the current frame. Only warn the user if we are actually
492 running the program, i.e. there is a stack. */
493 /* FIXME: This should be cacheing the frame and only running when
494 the frame changes. */
496 if (has_stack_frames ())
500 flang
= get_frame_language (frame
);
502 && flang
!= language_unknown
503 && flang
!= current_language
->la_language
)
505 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
514 wait_sync_command_done (void)
516 /* Processing events may change the current UI. */
517 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
518 struct ui
*ui
= current_ui
;
520 /* We're about to wait until the target stops after having resumed
521 it so must force-commit resumptions, in case we're being called
522 in some context where a scoped_disable_commit_resumed object is
523 active. I.e., this function is a commit-resumed sync/flush
525 scoped_enable_commit_resumed
enable ("sync wait");
527 while (gdb_do_one_event () >= 0)
528 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
535 maybe_wait_sync_command_done (int was_sync
)
537 /* If the interpreter is in sync mode (we're running a user
538 command's list, running command hooks or similars), and we
539 just ran a synchronous command that started the target, wait
540 for that command to end. */
541 if (!current_ui
->async
543 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
544 wait_sync_command_done ();
550 set_repeat_arguments (const char *args
)
552 repeat_arguments
= args
;
555 /* Execute the line P as a command, in the current user context.
556 Pass FROM_TTY as second argument to the defining function. */
559 execute_command (const char *p
, int from_tty
)
561 struct cmd_list_element
*c
;
563 const char *cmd_start
= p
;
565 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
566 scoped_value_mark cleanup
= prepare_execute_command ();
568 /* This can happen when command_line_input hits end of file. */
571 cleanup_if_error
.release ();
575 target_log_command (p
);
577 while (*p
== ' ' || *p
== '\t')
583 std::string default_args
;
584 std::string default_args_and_arg
;
585 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
589 /* If trace-commands is set then this will print this command. */
590 print_command_trace ("%s", p
);
592 c
= lookup_cmd (&cmd
, cmdlist
, "", &default_args
, 0, 1);
595 scoped_restore save_repeat_args
596 = make_scoped_restore (&repeat_arguments
, nullptr);
597 const char *args_pointer
= p
;
599 if (!default_args
.empty ())
602 default_args_and_arg
= default_args
+ ' ' + p
;
604 default_args_and_arg
= default_args
;
605 arg
= default_args_and_arg
.c_str ();
609 /* Pass null arg rather than an empty one. */
610 arg
= *p
== '\0' ? nullptr : p
;
613 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
614 while the is_complete_command(cfunc) test is just plain
615 bogus. They should both be replaced by a test of the form
616 c->strip_trailing_white_space_p. */
617 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
618 can't be replaced with func. This is because it is the
619 cfunc, and not the func, that has the value that the
620 is_complete_command hack is testing for. */
621 /* Clear off trailing whitespace, except for set and complete
623 std::string without_whitespace
;
625 && c
->type
!= set_cmd
626 && !is_complete_command (c
))
628 const char *old_end
= arg
+ strlen (arg
) - 1;
630 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
634 without_whitespace
= std::string (arg
, p
+ 1);
635 arg
= without_whitespace
.c_str ();
639 /* If this command has been pre-hooked, run the hook first. */
640 execute_cmd_pre_hook (c
);
642 if (c
->deprecated_warn_user
)
643 deprecated_cmd_warning (line
, cmdlist
);
645 /* c->user_commands would be NULL in the case of a python command. */
646 if (c
->theclass
== class_user
&& c
->user_commands
)
647 execute_user_command (c
, arg
);
648 else if (c
->theclass
== class_user
649 && c
->prefixlist
&& !c
->allow_unknown
)
650 /* If this is a user defined prefix that does not allow unknown
651 (in other words, C is a prefix command and not a command
652 that can be followed by its args), report the list of
656 ("\"%.*s\" must be followed by the name of a subcommand.\n",
657 (int) strlen (c
->prefixname
) - 1, c
->prefixname
);
658 help_list (*c
->prefixlist
, c
->prefixname
, all_commands
, gdb_stdout
);
660 else if (c
->type
== set_cmd
)
661 do_set_command (arg
, from_tty
, c
);
662 else if (c
->type
== show_cmd
)
663 do_show_command (arg
, from_tty
, c
);
664 else if (!cmd_func_p (c
))
665 error (_("That is not a command, just a help topic."));
666 else if (deprecated_call_command_hook
)
667 deprecated_call_command_hook (c
, arg
, from_tty
);
669 cmd_func (c
, arg
, from_tty
);
671 maybe_wait_sync_command_done (was_sync
);
673 /* If this command has been post-hooked, run the hook last. */
674 execute_cmd_post_hook (c
);
676 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
678 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
679 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
684 /* Only perform the frame-language-change check if the command
685 we just finished executing did not resume the inferior's execution.
686 If it did resume the inferior, we will do that check after
687 the inferior stopped. */
688 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
689 check_frame_language_change ();
691 cleanup_if_error
.release ();
694 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
695 do not display it to the screen. BATCH_FLAG will be
696 temporarily set to true. */
699 execute_command_to_ui_file (struct ui_file
*file
, const char *p
, int from_tty
)
701 /* GDB_STDOUT should be better already restored during these
702 restoration callbacks. */
703 set_batch_flag_and_restore_page_info save_page_info
;
705 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
708 current_uiout
->redirect (file
);
709 ui_out_redirect_pop
redirect_popper (current_uiout
);
711 scoped_restore save_stdout
712 = make_scoped_restore (&gdb_stdout
, file
);
713 scoped_restore save_stderr
714 = make_scoped_restore (&gdb_stderr
, file
);
715 scoped_restore save_stdlog
716 = make_scoped_restore (&gdb_stdlog
, file
);
717 scoped_restore save_stdtarg
718 = make_scoped_restore (&gdb_stdtarg
, file
);
719 scoped_restore save_stdtargerr
720 = make_scoped_restore (&gdb_stdtargerr
, file
);
722 execute_command (p
, from_tty
);
729 execute_command_to_string (const char *p
, int from_tty
,
732 string_file
str_file (term_out
);
734 execute_command_to_ui_file (&str_file
, p
, from_tty
);
735 return std::move (str_file
.string ());
739 /* When nonzero, cause dont_repeat to do nothing. This should only be
740 set via prevent_dont_repeat. */
742 static int suppress_dont_repeat
= 0;
749 struct ui
*ui
= current_ui
;
751 if (suppress_dont_repeat
|| server_command
)
754 /* If we aren't reading from standard input, we are saving the last
755 thing read from stdin in line and don't want to delete it. Null
756 lines won't repeat here in any case. */
757 if (ui
->instream
== ui
->stdin_stream
)
759 *saved_command_line
= 0;
760 repeat_arguments
= NULL
;
769 /* Do not repeat this command, as this command is a repeating command. */
772 /* We cannot free saved_command_line, as this line is being executed,
773 so swap it with previous_saved_command_line. */
774 std::swap (previous_saved_command_line
, saved_command_line
);
775 std::swap (previous_repeat_arguments
, repeat_arguments
);
777 const char *prev
= skip_spaces (get_saved_command_line ());
779 error (_("No previous command to relaunch"));
785 scoped_restore_tmpl
<int>
786 prevent_dont_repeat (void)
788 return make_scoped_restore (&suppress_dont_repeat
, 1);
794 get_saved_command_line ()
796 return saved_command_line
;
802 save_command_line (const char *cmd
)
804 xfree (previous_saved_command_line
);
805 previous_saved_command_line
= saved_command_line
;
806 previous_repeat_arguments
= repeat_arguments
;
807 saved_command_line
= xstrdup (cmd
);
808 repeat_arguments
= NULL
;
812 /* Read a line from the stream "instream" without command line editing.
814 It prints PROMPT once at the start.
815 Action is compatible with "readline", e.g. space for the result is
816 malloc'd and should be freed by the caller.
818 A NULL return means end of file. */
821 gdb_readline_no_editing (const char *prompt
)
823 struct buffer line_buffer
;
824 struct ui
*ui
= current_ui
;
825 /* Read from stdin if we are executing a user defined command. This
826 is the right thing for prompt_for_continue, at least. */
827 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
828 int fd
= fileno (stream
);
830 buffer_init (&line_buffer
);
834 /* Don't use a _filtered function here. It causes the assumed
835 character position to be off, since the newline we read from
836 the user is not accounted for. */
837 fputs_unfiltered (prompt
, gdb_stdout
);
838 gdb_flush (gdb_stdout
);
848 /* Wait until at least one byte of data is available. Control-C
849 can interrupt interruptible_select, but not fgetc. */
851 FD_SET (fd
, &readfds
);
852 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
856 /* If this was ctrl-c, the QUIT above handles it. */
859 perror_with_name (("select"));
866 if (line_buffer
.used_size
> 0)
867 /* The last line does not end with a newline. Return it, and
868 if we are called again fgetc will still return EOF and
869 we'll return NULL then. */
871 xfree (buffer_finish (&line_buffer
));
877 if (line_buffer
.used_size
> 0
878 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
879 line_buffer
.used_size
--;
883 buffer_grow_char (&line_buffer
, c
);
886 buffer_grow_char (&line_buffer
, '\0');
887 return buffer_finish (&line_buffer
);
890 /* Variables which control command line editing and history
891 substitution. These variables are given default values at the end
893 static bool command_editing_p
;
895 /* NOTE 1999-04-29: This variable will be static again, once we modify
896 gdb to use the event loop as the default command loop and we merge
897 event-top.c into this file, top.c. */
899 /* static */ bool history_expansion_p
;
901 /* Should we write out the command history on exit? In order to write out
902 the history both this flag must be true, and the history_filename
903 variable must be set to something sensible. */
904 static bool write_history_p
;
906 /* Implement 'show history save'. */
908 show_write_history_p (struct ui_file
*file
, int from_tty
,
909 struct cmd_list_element
*c
, const char *value
)
911 if (!write_history_p
|| !history_filename_empty ())
912 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
915 fprintf_filtered (file
, _("Saving of the history is disabled due to "
916 "the value of 'history filename'.\n"));
919 /* The variable associated with the "set/show history size"
920 command. The value -1 means unlimited, and -2 means undefined. */
921 static int history_size_setshow_var
= -2;
924 show_history_size (struct ui_file
*file
, int from_tty
,
925 struct cmd_list_element
*c
, const char *value
)
927 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
931 /* Variable associated with the "history remove-duplicates" option.
932 The value -1 means unlimited. */
933 static int history_remove_duplicates
= 0;
936 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
937 struct cmd_list_element
*c
, const char *value
)
939 fprintf_filtered (file
,
940 _("The number of history entries to look back at for "
941 "duplicates is %s.\n"),
945 /* The name of the file in which GDB history will be written. If this is
946 set to NULL, of the empty string then history will not be written. */
947 static char *history_filename
;
949 /* Return true if the history_filename is either NULL or the empty string,
950 indicating that we should not try to read, nor write out the history. */
952 history_filename_empty (void)
954 return (history_filename
== nullptr || *history_filename
== '\0');
957 /* Implement 'show history filename'. */
959 show_history_filename (struct ui_file
*file
, int from_tty
,
960 struct cmd_list_element
*c
, const char *value
)
962 if (!history_filename_empty ())
963 fprintf_filtered (file
, _("The filename in which to record "
964 "the command history is \"%ps\".\n"),
965 styled_string (file_name_style
.style (), value
));
967 fprintf_filtered (file
, _("There is no filename currently set for "
968 "recording the command history in.\n"));
971 /* This is like readline(), but it has some gdb-specific behavior.
972 gdb may want readline in both the synchronous and async modes during
973 a single gdb invocation. At the ordinary top-level prompt we might
974 be using the async readline. That means we can't use
975 rl_pre_input_hook, since it doesn't work properly in async mode.
976 However, for a secondary prompt (" >", such as occurs during a
977 `define'), gdb wants a synchronous response.
979 We used to call readline() directly, running it in synchronous
980 mode. But mixing modes this way is not supported, and as of
981 readline 5.x it no longer works; the arrow keys come unbound during
982 the synchronous call. So we make a nested call into the event
983 loop. That's what gdb_readline_wrapper is for. */
985 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
986 rely on gdb_readline_wrapper_result, which might still be NULL if
987 the user types Control-D for EOF. */
988 static int gdb_readline_wrapper_done
;
990 /* The result of the current call to gdb_readline_wrapper, once a newline
992 static char *gdb_readline_wrapper_result
;
994 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
995 to be called after the newline is processed (which will redisplay
996 the prompt). But in gdb_readline_wrapper we will not get a new
997 prompt until the next call, or until we return to the event loop.
998 So we disable this hook around the newline and restore it before we
1000 static void (*saved_after_char_processing_hook
) (void);
1006 gdb_in_secondary_prompt_p (struct ui
*ui
)
1008 return ui
->secondary_prompt_depth
> 0;
1012 /* This function is called when readline has seen a complete line of
1016 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
1018 gdb_assert (!gdb_readline_wrapper_done
);
1019 gdb_readline_wrapper_result
= line
.release ();
1020 gdb_readline_wrapper_done
= 1;
1022 /* Prevent operate-and-get-next from acting too early. */
1023 saved_after_char_processing_hook
= after_char_processing_hook
;
1024 after_char_processing_hook
= NULL
;
1026 /* Prevent parts of the prompt from being redisplayed if annotations
1027 are enabled, and readline's state getting out of sync. We'll
1028 reinstall the callback handler, which puts the terminal in raw
1029 mode (or in readline lingo, in prepped state), when we're next
1030 ready to process user input, either in display_gdb_prompt, or if
1031 we're handling an asynchronous target event and running in the
1032 background, just before returning to the event loop to process
1033 further input (or more target events). */
1034 if (current_ui
->command_editing
)
1035 gdb_rl_callback_handler_remove ();
1038 class gdb_readline_wrapper_cleanup
1041 gdb_readline_wrapper_cleanup ()
1042 : m_handler_orig (current_ui
->input_handler
),
1043 m_already_prompted_orig (current_ui
->command_editing
1044 ? rl_already_prompted
: 0),
1045 m_target_is_async_orig (target_is_async_p ()),
1046 m_save_ui (¤t_ui
)
1048 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1049 current_ui
->secondary_prompt_depth
++;
1051 if (m_target_is_async_orig
)
1055 ~gdb_readline_wrapper_cleanup ()
1057 struct ui
*ui
= current_ui
;
1059 if (ui
->command_editing
)
1060 rl_already_prompted
= m_already_prompted_orig
;
1062 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1063 ui
->input_handler
= m_handler_orig
;
1065 /* Don't restore our input handler in readline yet. That would make
1066 readline prep the terminal (putting it in raw mode), while the
1067 line we just read may trigger execution of a command that expects
1068 the terminal in the default cooked/canonical mode, such as e.g.,
1069 running Python's interactive online help utility. See
1070 gdb_readline_wrapper_line for when we'll reinstall it. */
1072 gdb_readline_wrapper_result
= NULL
;
1073 gdb_readline_wrapper_done
= 0;
1074 ui
->secondary_prompt_depth
--;
1075 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1077 after_char_processing_hook
= saved_after_char_processing_hook
;
1078 saved_after_char_processing_hook
= NULL
;
1080 if (m_target_is_async_orig
)
1084 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1088 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1089 int m_already_prompted_orig
;
1091 /* Whether the target was async. */
1092 int m_target_is_async_orig
;
1094 /* Processing events may change the current UI. */
1095 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1099 gdb_readline_wrapper (const char *prompt
)
1101 struct ui
*ui
= current_ui
;
1103 gdb_readline_wrapper_cleanup cleanup
;
1105 /* Display our prompt and prevent double prompt display. Don't pass
1106 down a NULL prompt, since that has special meaning for
1107 display_gdb_prompt -- it indicates a request to print the primary
1108 prompt, while we want a secondary prompt here. */
1109 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1110 if (ui
->command_editing
)
1111 rl_already_prompted
= 1;
1113 if (after_char_processing_hook
)
1114 (*after_char_processing_hook
) ();
1115 gdb_assert (after_char_processing_hook
== NULL
);
1117 while (gdb_do_one_event () >= 0)
1118 if (gdb_readline_wrapper_done
)
1121 return gdb_readline_wrapper_result
;
1125 /* The current saved history number from operate-and-get-next.
1126 This is -1 if not valid. */
1127 static int operate_saved_history
= -1;
1129 /* This is put on the appropriate hook and helps operate-and-get-next
1132 gdb_rl_operate_and_get_next_completion (void)
1134 int delta
= where_history () - operate_saved_history
;
1136 /* The `key' argument to rl_get_previous_history is ignored. */
1137 rl_get_previous_history (delta
, 0);
1138 operate_saved_history
= -1;
1140 /* readline doesn't automatically update the display for us. */
1143 after_char_processing_hook
= NULL
;
1144 rl_pre_input_hook
= NULL
;
1147 /* This is a gdb-local readline command handler. It accepts the
1148 current command line (like RET does) and, if this command was taken
1149 from the history, arranges for the next command in the history to
1150 appear on the command line when the prompt returns.
1151 We ignore the arguments. */
1153 gdb_rl_operate_and_get_next (int count
, int key
)
1157 /* Use the async hook. */
1158 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1160 /* Find the current line, and find the next line to use. */
1161 where
= where_history();
1163 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1164 || (where
>= history_length
- 1))
1165 operate_saved_history
= where
;
1167 operate_saved_history
= where
+ 1;
1169 return rl_newline (1, key
);
1172 /* Number of user commands executed during this session. */
1174 static int command_count
= 0;
1176 /* Add the user command COMMAND to the input history list. */
1179 gdb_add_history (const char *command
)
1183 if (history_remove_duplicates
!= 0)
1186 int lookbehind_threshold
;
1188 /* The lookbehind threshold for finding a duplicate history entry is
1189 bounded by command_count because we can't meaningfully delete
1190 history entries that are already stored in the history file since
1191 the history file is appended to. */
1192 if (history_remove_duplicates
== -1
1193 || history_remove_duplicates
> command_count
)
1194 lookbehind_threshold
= command_count
;
1196 lookbehind_threshold
= history_remove_duplicates
;
1199 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1201 HIST_ENTRY
*temp
= previous_history ();
1206 if (strcmp (temp
->line
, command
) == 0)
1208 HIST_ENTRY
*prev
= remove_history (where_history ());
1210 free_history_entry (prev
);
1217 add_history (command
);
1220 /* Safely append new history entries to the history file in a corruption-free
1221 way using an intermediate local history file. */
1224 gdb_safe_append_history (void)
1226 int ret
, saved_errno
;
1228 std::string local_history_filename
1229 = string_printf ("%s-gdb%ld~", history_filename
, (long) getpid ());
1231 ret
= rename (history_filename
, local_history_filename
.c_str ());
1232 saved_errno
= errno
;
1233 if (ret
< 0 && saved_errno
!= ENOENT
)
1235 warning (_("Could not rename %ps to %ps: %s"),
1236 styled_string (file_name_style
.style (), history_filename
),
1237 styled_string (file_name_style
.style (),
1238 local_history_filename
.c_str ()),
1239 safe_strerror (saved_errno
));
1245 /* If the rename failed with ENOENT then either the global history
1246 file never existed in the first place or another GDB process is
1247 currently appending to it (and has thus temporarily renamed it).
1248 Since we can't distinguish between these two cases, we have to
1249 conservatively assume the first case and therefore must write out
1250 (not append) our known history to our local history file and try
1251 to move it back anyway. Otherwise a global history file would
1252 never get created! */
1253 gdb_assert (saved_errno
== ENOENT
);
1254 write_history (local_history_filename
.c_str ());
1258 append_history (command_count
, local_history_filename
.c_str ());
1259 if (history_is_stifled ())
1260 history_truncate_file (local_history_filename
.c_str (),
1261 history_max_entries
);
1264 ret
= rename (local_history_filename
.c_str (), history_filename
);
1265 saved_errno
= errno
;
1266 if (ret
< 0 && saved_errno
!= EEXIST
)
1267 warning (_("Could not rename %s to %s: %s"),
1268 local_history_filename
.c_str (), history_filename
,
1269 safe_strerror (saved_errno
));
1273 /* Read one line from the command input stream `instream' into a local
1274 static buffer. The buffer is made bigger as necessary. Returns
1275 the address of the start of the line.
1277 NULL is returned for end of file.
1279 This routine either uses fancy command line editing or simple input
1280 as the user has requested. */
1283 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1285 static struct buffer cmd_line_buffer
;
1286 static int cmd_line_buffer_initialized
;
1287 struct ui
*ui
= current_ui
;
1288 const char *prompt
= prompt_arg
;
1290 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1292 /* The annotation suffix must be non-NULL. */
1293 if (annotation_suffix
== NULL
)
1294 annotation_suffix
= "";
1296 if (from_tty
&& annotation_level
> 1)
1301 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1302 + strlen (annotation_suffix
) + 40);
1304 local_prompt
[0] = '\0';
1306 strcpy (local_prompt
, prompt
);
1307 strcat (local_prompt
, "\n\032\032");
1308 strcat (local_prompt
, annotation_suffix
);
1309 strcat (local_prompt
, "\n");
1311 prompt
= local_prompt
;
1314 if (!cmd_line_buffer_initialized
)
1316 buffer_init (&cmd_line_buffer
);
1317 cmd_line_buffer_initialized
= 1;
1320 /* Starting a new command line. */
1321 cmd_line_buffer
.used_size
= 0;
1325 signal (SIGTSTP
, handle_sigtstp
);
1330 gdb::unique_xmalloc_ptr
<char> rl
;
1332 /* Make sure that all output has been output. Some machines may
1333 let you get away with leaving out some of the gdb_flush, but
1336 gdb_flush (gdb_stdout
);
1337 gdb_flush (gdb_stderr
);
1339 if (!source_file_name
.empty ())
1340 ++source_line_number
;
1342 if (from_tty
&& annotation_level
> 1)
1344 puts_unfiltered ("\n\032\032pre-");
1345 puts_unfiltered (annotation_suffix
);
1346 puts_unfiltered ("\n");
1349 /* Don't use fancy stuff if not talking to stdin. */
1350 if (deprecated_readline_hook
1352 && input_interactive_p (current_ui
))
1354 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1356 else if (command_editing_p
1358 && input_interactive_p (current_ui
))
1360 rl
.reset (gdb_readline_wrapper (prompt
));
1364 rl
.reset (gdb_readline_no_editing (prompt
));
1367 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1368 0, annotation_suffix
);
1369 if (cmd
== (char *) EOF
)
1377 /* Got partial input. I.e., got a line that ends with a
1378 continuation character (backslash). Suppress printing the
1385 signal (SIGTSTP
, SIG_DFL
);
1393 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1395 /* From GNU coding standards, first line is meant to be easy for a
1396 program to parse, and is just canonical program name and version
1397 number, which starts after last space. */
1399 std::string v_str
= string_printf ("GNU gdb %s%s", PKGVERSION
, version
);
1400 fprintf_filtered (stream
, "%ps\n",
1401 styled_string (version_style
.style (), v_str
.c_str ()));
1403 /* Second line is a copyright notice. */
1405 fprintf_filtered (stream
,
1406 "Copyright (C) 2021 Free Software Foundation, Inc.\n");
1408 /* Following the copyright is a brief statement that the program is
1409 free software, that users are free to copy and change it on
1410 certain conditions, that it is covered by the GNU GPL, and that
1411 there is no warranty. */
1413 fprintf_filtered (stream
, "\
1414 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1415 \nThis is free software: you are free to change and redistribute it.\n\
1416 There is NO WARRANTY, to the extent permitted by law.");
1421 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1422 "\"show warranty\" for details.\n"));
1424 /* After the required info we print the configuration information. */
1426 fprintf_filtered (stream
, "This GDB was configured as \"");
1427 if (strcmp (host_name
, target_name
) != 0)
1429 fprintf_filtered (stream
, "--host=%s --target=%s",
1430 host_name
, target_name
);
1434 fprintf_filtered (stream
, "%s", host_name
);
1436 fprintf_filtered (stream
, "\".\n");
1438 fprintf_filtered (stream
, _("Type \"show configuration\" "
1439 "for configuration details.\n"));
1441 if (REPORT_BUGS_TO
[0])
1443 fprintf_filtered (stream
,
1444 _("For bug reporting instructions, please see:\n"));
1445 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1447 fprintf_filtered (stream
,
1448 _("Find the GDB manual and other documentation \
1449 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1450 fprintf_filtered (stream
, "\n\n");
1451 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1452 fprintf_filtered (stream
,
1453 _("Type \"apropos word\" to search for commands \
1454 related to \"word\"."));
1457 /* Print the details of GDB build-time configuration. */
1459 print_gdb_configuration (struct ui_file
*stream
)
1461 fprintf_filtered (stream
, _("\
1462 This GDB was configured as follows:\n\
1463 configure --host=%s --target=%s\n\
1464 "), host_name
, target_name
);
1466 fprintf_filtered (stream
, _("\
1467 --with-auto-load-dir=%s\n\
1468 --with-auto-load-safe-path=%s\n\
1469 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1472 fprintf_filtered (stream
, _("\
1476 fprintf_filtered (stream
, _("\
1482 fprintf_filtered (stream
, _("\
1483 --with-gdb-datadir=%s%s\n\
1484 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1487 fprintf_filtered (stream
, _("\
1488 --with-iconv-bin=%s%s\n\
1489 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1492 if (JIT_READER_DIR
[0])
1493 fprintf_filtered (stream
, _("\
1494 --with-jit-reader-dir=%s%s\n\
1495 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1497 #if HAVE_LIBUNWIND_IA64_H
1498 fprintf_filtered (stream
, _("\
1499 --with-libunwind-ia64\n\
1502 fprintf_filtered (stream
, _("\
1503 --without-libunwind-ia64\n\
1508 fprintf_filtered (stream
, _("\
1512 fprintf_filtered (stream
, _("\
1517 #if HAVE_LIBBABELTRACE
1518 fprintf_filtered (stream
, _("\
1519 --with-babeltrace\n\
1522 fprintf_filtered (stream
, _("\
1523 --without-babeltrace\n\
1528 fprintf_filtered (stream
, _("\
1532 fprintf_filtered (stream
, _("\
1533 --without-intel-pt\n\
1538 fprintf_filtered (stream
, _("\
1542 fprintf_filtered (stream
, _("\
1547 fprintf_filtered (stream
, _("\
1551 fprintf_filtered (stream
, _("\
1555 #ifdef WITH_PYTHON_PATH
1556 fprintf_filtered (stream
, _("\
1557 --with-python=%s%s\n\
1558 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1560 fprintf_filtered (stream
, _("\
1564 #ifdef WITH_PYTHON_LIBDIR
1565 fprintf_filtered (stream
, _("\
1566 --with-python-libdir=%s%s\n\
1567 "), WITH_PYTHON_LIBDIR
, PYTHON_LIBDIR_RELOCATABLE
? " (relocatable)" : "");
1569 fprintf_filtered (stream
, _("\
1570 --without-python-libdir\n\
1574 #if HAVE_LIBDEBUGINFOD
1575 fprintf_filtered (stream
, _("\
1576 --with-debuginfod\n\
1579 fprintf_filtered (stream
, _("\
1580 --without-debuginfod\n\
1585 fprintf_filtered (stream
, _("\
1589 fprintf_filtered (stream
, _("\
1594 #if HAVE_SOURCE_HIGHLIGHT
1595 fprintf_filtered (stream
, _("\
1596 --enable-source-highlight\n\
1599 fprintf_filtered (stream
, _("\
1600 --disable-source-highlight\n\
1605 fprintf_filtered (stream
, _("\
1606 --with-relocated-sources=%s\n\
1611 fprintf_filtered (stream
, _("\
1612 --with-separate-debug-dir=%s%s\n\
1613 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1615 if (TARGET_SYSTEM_ROOT
[0])
1616 fprintf_filtered (stream
, _("\
1617 --with-sysroot=%s%s\n\
1618 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1620 if (SYSTEM_GDBINIT
[0])
1621 fprintf_filtered (stream
, _("\
1622 --with-system-gdbinit=%s%s\n\
1623 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1625 if (SYSTEM_GDBINIT_DIR
[0])
1626 fprintf_filtered (stream
, _("\
1627 --with-system-gdbinit-dir=%s%s\n\
1628 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1630 /* We assume "relocatable" will be printed at least once, thus we always
1631 print this text. It's a reasonably safe assumption for now. */
1632 fprintf_filtered (stream
, _("\n\
1633 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1634 tree, and GDB will still find it.)\n\
1639 /* The current top level prompt, settable with "set prompt", and/or
1640 with the python `gdb.prompt_hook' hook. */
1641 static char *top_prompt
;
1643 /* Access method for the GDB prompt string. */
1651 /* Set method for the GDB prompt string. */
1654 set_prompt (const char *s
)
1656 char *p
= xstrdup (s
);
1663 /* Kills or detaches the given inferior, depending on how we originally
1664 gained control of it. */
1667 kill_or_detach (inferior
*inf
, int from_tty
)
1672 thread_info
*thread
= any_thread_of_inferior (inf
);
1675 switch_to_thread (thread
);
1677 /* Leave core files alone. */
1678 if (target_has_execution ())
1680 if (inf
->attach_flag
)
1681 target_detach (inf
, from_tty
);
1688 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1689 where to collect the output. */
1692 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1697 if (inf
->attach_flag
)
1698 fprintf_filtered (out
,
1699 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1700 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1702 fprintf_filtered (out
,
1703 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1704 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1707 /* If necessary, make the user confirm that we should quit. Return
1708 non-zero if we should quit, zero if we shouldn't. */
1713 /* Don't even ask if we're only debugging a core file inferior. */
1714 if (!have_live_inferiors ())
1717 /* Build the query string as a single string. */
1720 stb
.puts (_("A debugging session is active.\n\n"));
1722 for (inferior
*inf
: all_inferiors ())
1723 print_inferior_quit_action (inf
, &stb
);
1725 stb
.puts (_("\nQuit anyway? "));
1727 return query ("%s", stb
.c_str ());
1730 /* Prepare to exit GDB cleanly by undoing any changes made to the
1731 terminal so that we leave the terminal in the state we acquired it. */
1734 undo_terminal_modifications_before_exit (void)
1736 struct ui
*saved_top_level
= current_ui
;
1738 target_terminal::ours ();
1740 current_ui
= main_ui
;
1745 gdb_disable_readline ();
1747 current_ui
= saved_top_level
;
1751 /* Quit without asking for confirmation. */
1754 quit_force (int *exit_arg
, int from_tty
)
1758 undo_terminal_modifications_before_exit ();
1760 /* An optional expression may be used to cause gdb to terminate with the
1761 value of that expression. */
1763 exit_code
= *exit_arg
;
1764 else if (return_child_result
)
1765 exit_code
= return_child_result_value
;
1767 /* We want to handle any quit errors and exit regardless. */
1769 /* Get out of tfind mode, and kill or detach all inferiors. */
1772 disconnect_tracing ();
1773 for (inferior
*inf
: all_inferiors ())
1774 kill_or_detach (inf
, from_tty
);
1776 catch (const gdb_exception
&ex
)
1778 exception_print (gdb_stderr
, ex
);
1781 /* Give all pushed targets a chance to do minimal cleanup, and pop
1783 for (inferior
*inf
: all_inferiors ())
1785 switch_to_inferior_no_thread (inf
);
1790 catch (const gdb_exception
&ex
)
1792 exception_print (gdb_stderr
, ex
);
1796 /* Save the history information if it is appropriate to do so. */
1799 if (write_history_p
&& history_filename
)
1803 /* History is currently shared between all UIs. If there's
1804 any UI with a terminal, save history. */
1805 for (ui
*ui
: all_uis ())
1807 if (input_interactive_p (ui
))
1815 gdb_safe_append_history ();
1818 catch (const gdb_exception
&ex
)
1820 exception_print (gdb_stderr
, ex
);
1823 /* Destroy any values currently allocated now instead of leaving it
1824 to global destructors, because that may be too late. For
1825 example, the destructors of xmethod values call into the Python
1826 runtime, which is finalized via a final cleanup. */
1829 /* Do any final cleanups before exiting. */
1832 do_final_cleanups ();
1834 catch (const gdb_exception
&ex
)
1836 exception_print (gdb_stderr
, ex
);
1842 /* The value of the "interactive-mode" setting. */
1843 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1845 /* Implement the "show interactive-mode" option. */
1848 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1849 struct cmd_list_element
*c
,
1852 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1853 fprintf_filtered (file
, "Debugger's interactive mode "
1854 "is %s (currently %s).\n",
1855 value
, input_interactive_p (current_ui
) ? "on" : "off");
1857 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1860 /* Returns whether GDB is running on an interactive terminal. */
1863 input_interactive_p (struct ui
*ui
)
1868 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1869 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1871 return ui
->input_interactive_p
;
1875 dont_repeat_command (const char *ignored
, int from_tty
)
1877 /* Can't call dont_repeat here because we're not necessarily reading
1879 *saved_command_line
= 0;
1882 /* Functions to manipulate command line editing control variables. */
1884 /* Number of commands to print in each call to show_commands. */
1885 #define Hist_print 10
1887 show_commands (const char *args
, int from_tty
)
1889 /* Index for history commands. Relative to history_base. */
1892 /* Number of the history entry which we are planning to display next.
1893 Relative to history_base. */
1896 /* Print out some of the commands from the command history. */
1900 if (args
[0] == '+' && args
[1] == '\0')
1901 /* "info editing +" should print from the stored position. */
1904 /* "info editing <exp>" should print around command number <exp>. */
1905 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1907 /* "show commands" means print the last Hist_print commands. */
1910 num
= history_length
- Hist_print
;
1916 /* If there are at least Hist_print commands, we want to display the last
1917 Hist_print rather than, say, the last 6. */
1918 if (history_length
- num
< Hist_print
)
1920 num
= history_length
- Hist_print
;
1926 offset
< num
+ Hist_print
&& offset
< history_length
;
1929 printf_filtered ("%5d %s\n", history_base
+ offset
,
1930 (history_get (history_base
+ offset
))->line
);
1933 /* The next command we want to display is the next one that we haven't
1937 /* If the user repeats this command with return, it should do what
1938 "show commands +" does. This is unnecessary if arg is null,
1939 because "show commands +" is not useful after "show commands". */
1940 if (from_tty
&& args
)
1941 set_repeat_arguments ("+");
1944 /* Update the size of our command history file to HISTORY_SIZE.
1946 A HISTORY_SIZE of -1 stands for unlimited. */
1949 set_readline_history_size (int history_size
)
1951 gdb_assert (history_size
>= -1);
1953 if (history_size
== -1)
1954 unstifle_history ();
1956 stifle_history (history_size
);
1959 /* Called by do_setshow_command. */
1961 set_history_size_command (const char *args
,
1962 int from_tty
, struct cmd_list_element
*c
)
1964 set_readline_history_size (history_size_setshow_var
);
1967 bool info_verbose
= false; /* Default verbose msgs off. */
1969 /* Called by do_set_command. An elaborate joke. */
1971 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1973 const char *cmdname
= "verbose";
1974 struct cmd_list_element
*showcmd
;
1976 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, NULL
, 1);
1977 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1979 if (c
->doc
&& c
->doc_allocated
)
1980 xfree ((char *) c
->doc
);
1981 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1982 xfree ((char *) showcmd
->doc
);
1985 c
->doc
= _("Set verbose printing of informational messages.");
1986 showcmd
->doc
= _("Show verbose printing of informational messages.");
1990 c
->doc
= _("Set verbosity.");
1991 showcmd
->doc
= _("Show verbosity.");
1993 c
->doc_allocated
= 0;
1994 showcmd
->doc_allocated
= 0;
1997 /* Init the history buffer. Note that we are called after the init file(s)
1998 have been read so that the user can change the history file via his
1999 .gdbinit file (for instance). The GDBHISTFILE environment variable
2000 overrides all of this. */
2007 tmpenv
= getenv ("GDBHISTSIZE");
2014 tmpenv
= skip_spaces (tmpenv
);
2016 var
= strtol (tmpenv
, &endptr
, 10);
2017 saved_errno
= errno
;
2018 endptr
= skip_spaces (endptr
);
2020 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
2021 empty string, a negative number or a huge positive number (larger than
2022 INT_MAX) then set the history size to unlimited. Otherwise set our
2023 history size to the number we have read. This behavior is consistent
2024 with how bash handles HISTSIZE. */
2025 if (*endptr
!= '\0')
2027 else if (*tmpenv
== '\0'
2030 /* On targets where INT_MAX == LONG_MAX, we have to look at
2031 errno after calling strtol to distinguish between a value that
2032 is exactly INT_MAX and an overflowing value that was clamped
2034 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2035 history_size_setshow_var
= -1;
2037 history_size_setshow_var
= var
;
2040 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2042 if (history_size_setshow_var
== -2)
2043 history_size_setshow_var
= 256;
2045 set_readline_history_size (history_size_setshow_var
);
2047 tmpenv
= getenv ("GDBHISTFILE");
2048 if (tmpenv
!= nullptr)
2049 history_filename
= xstrdup (tmpenv
);
2050 else if (history_filename
== nullptr)
2052 /* We include the current directory so that if the user changes
2053 directories the file written will be the same as the one
2056 /* No leading dots in file names are allowed on MSDOS. */
2057 const char *fname
= "_gdb_history";
2059 const char *fname
= ".gdb_history";
2062 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (fname
));
2063 history_filename
= temp
.release ();
2066 if (!history_filename_empty ())
2067 read_history (history_filename
);
2071 show_prompt (struct ui_file
*file
, int from_tty
,
2072 struct cmd_list_element
*c
, const char *value
)
2074 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2077 /* "set editing" command. */
2080 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2082 change_line_handler (set_editing_cmd_var
);
2083 /* Update the control variable so that MI's =cmd-param-changed event
2084 shows the correct value. */
2085 set_editing_cmd_var
= current_ui
->command_editing
;
2089 show_editing (struct ui_file
*file
, int from_tty
,
2090 struct cmd_list_element
*c
, const char *value
)
2092 fprintf_filtered (file
, _("Editing of command lines as "
2093 "they are typed is %s.\n"),
2094 current_ui
->command_editing
? _("on") : _("off"));
2098 show_annotation_level (struct ui_file
*file
, int from_tty
,
2099 struct cmd_list_element
*c
, const char *value
)
2101 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2105 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2106 struct cmd_list_element
*c
, const char *value
)
2108 fprintf_filtered (file
, _("Notification of completion for "
2109 "asynchronous execution commands is %s.\n"),
2113 /* New values of the "data-directory" parameter are staged here. */
2114 static char *staged_gdb_datadir
;
2116 /* "set" command for the gdb_datadir configuration variable. */
2119 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2121 set_gdb_data_directory (staged_gdb_datadir
);
2122 gdb::observers::gdb_datadir_changed
.notify ();
2125 /* "show" command for the gdb_datadir configuration variable. */
2128 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2129 struct cmd_list_element
*c
, const char *value
)
2131 fprintf_filtered (file
, _("GDB's data directory is \"%ps\".\n"),
2132 styled_string (file_name_style
.style (),
2133 gdb_datadir
.c_str ()));
2136 /* Implement 'set history filename'. */
2139 set_history_filename (const char *args
,
2140 int from_tty
, struct cmd_list_element
*c
)
2142 /* We include the current directory so that if the user changes
2143 directories the file written will be the same as the one
2145 if (!history_filename_empty () && !IS_ABSOLUTE_PATH (history_filename
))
2147 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (history_filename
));
2149 xfree (history_filename
);
2150 history_filename
= temp
.release ();
2155 init_gdb_version_vars (void)
2157 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2158 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2159 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2160 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2161 set_internalvar_integer (major_version_var
, vmajor
);
2162 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2168 struct cmd_list_element
*c
;
2170 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2171 the DEFAULT_PROMPT is. */
2172 set_prompt (DEFAULT_PROMPT
);
2174 /* Set the important stuff up for command editing. */
2175 command_editing_p
= 1;
2176 history_expansion_p
= 0;
2177 write_history_p
= 0;
2179 /* Setup important stuff for command line editing. */
2180 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2181 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2182 set_rl_completer_word_break_characters (default_word_break_characters ());
2183 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2184 rl_completion_display_matches_hook
= cli_display_match_list
;
2185 rl_readline_name
= "gdb";
2186 rl_terminal_name
= getenv ("TERM");
2188 /* The name for this defun comes from Bash, where it originated.
2189 15 is Control-o, the same binding this function has in Bash. */
2190 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2192 add_setshow_string_cmd ("prompt", class_support
,
2194 _("Set gdb's prompt."),
2195 _("Show gdb's prompt."),
2198 &setlist
, &showlist
);
2200 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2201 Don't repeat this command.\nPrimarily \
2202 used inside of user-defined commands that should not be repeated when\n\
2205 add_setshow_boolean_cmd ("editing", class_support
,
2206 &set_editing_cmd_var
, _("\
2207 Set editing of command lines as they are typed."), _("\
2208 Show editing of command lines as they are typed."), _("\
2209 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2210 Without an argument, command line editing is enabled. To edit, use\n\
2211 EMACS-like or VI-like commands like control-P or ESC."),
2214 &setlist
, &showlist
);
2216 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2217 Set saving of the history record on exit."), _("\
2218 Show saving of the history record on exit."), _("\
2219 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2220 Without an argument, saving is enabled."),
2222 show_write_history_p
,
2223 &sethistlist
, &showhistlist
);
2225 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2226 &history_size_setshow_var
, _("\
2227 Set the size of the command history."), _("\
2228 Show the size of the command history."), _("\
2229 This is the number of previous commands to keep a record of.\n\
2230 If set to \"unlimited\", the number of commands kept in the history\n\
2231 list is unlimited. This defaults to the value of the environment\n\
2232 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2233 set_history_size_command
,
2235 &sethistlist
, &showhistlist
);
2237 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2238 &history_remove_duplicates
, _("\
2239 Set how far back in history to look for and remove duplicate entries."), _("\
2240 Show how far back in history to look for and remove duplicate entries."), _("\
2241 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2242 and remove the first history entry that is a duplicate of the most recent\n\
2243 entry, each time a new history entry is added.\n\
2244 If set to \"unlimited\", this lookbehind is unbounded.\n\
2245 Only history entries added during this session are considered for removal.\n\
2246 If set to 0, removal of duplicate history entries is disabled.\n\
2247 By default this option is set to 0."),
2249 show_history_remove_duplicates
,
2250 &sethistlist
, &showhistlist
);
2252 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2253 Set the filename in which to record the command history."), _("\
2254 Show the filename in which to record the command history."), _("\
2255 (the list of previous commands of which a record is kept)."),
2256 set_history_filename
,
2257 show_history_filename
,
2258 &sethistlist
, &showhistlist
);
2260 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2261 Set whether to confirm potentially dangerous operations."), _("\
2262 Show whether to confirm potentially dangerous operations."), NULL
,
2265 &setlist
, &showlist
);
2267 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2268 Set annotation_level."), _("\
2269 Show annotation_level."), _("\
2270 0 == normal; 1 == fullname (for use when running under emacs)\n\
2271 2 == output annotated suitably for use by programs that control GDB."),
2273 show_annotation_level
,
2274 &setlist
, &showlist
);
2276 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2277 &exec_done_display_p
, _("\
2278 Set notification of completion for asynchronous execution commands."), _("\
2279 Show notification of completion for asynchronous execution commands."), _("\
2280 Use \"on\" to enable the notification, and \"off\" to disable it."),
2282 show_exec_done_display_p
,
2283 &setlist
, &showlist
);
2285 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2286 &staged_gdb_datadir
, _("Set GDB's data directory."),
2287 _("Show GDB's data directory."),
2289 When set, GDB uses the specified path to search for data files."),
2290 set_gdb_datadir
, show_gdb_datadir
,
2294 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2295 &interactive_mode
, _("\
2296 Set whether GDB's standard input is a terminal."), _("\
2297 Show whether GDB's standard input is a terminal."), _("\
2298 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2299 means that GDB should wait for the user to answer queries associated to\n\
2300 commands entered at the command prompt. If off, GDB assumes that standard\n\
2301 input is not a terminal, and uses the default answer to all queries.\n\
2302 If auto (the default), determine which mode to use based on the standard\n\
2305 show_interactive_mode
,
2306 &setlist
, &showlist
);
2308 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2310 Usage: new-ui INTERPRETER TTY\n\
2311 The first argument is the name of the interpreter to run.\n\
2312 The second argument is the terminal the UI runs on."), &cmdlist
);
2313 set_cmd_completer (c
, interpreter_completer
);
2317 gdb_init (char *argv0
)
2319 saved_command_line
= xstrdup ("");
2320 previous_saved_command_line
= xstrdup ("");
2322 /* Run the init function of each source file. */
2325 /* Make sure we return to the original directory upon exit, come
2326 what may, since the OS doesn't do that for us. */
2327 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2330 init_cmd_lists (); /* This needs to be done first. */
2334 /* Here is where we call all the _initialize_foo routines. */
2335 initialize_all_files ();
2337 /* This creates the current_program_space. Do this after all the
2338 _initialize_foo routines have had a chance to install their
2339 per-sspace data keys. Also do this before
2340 initialize_current_architecture is called, because it accesses
2341 exec_bfd of the current program space. */
2342 initialize_progspace ();
2343 initialize_inferiors ();
2344 initialize_current_architecture ();
2345 init_main (); /* But that omits this file! Do it now. */
2347 initialize_stdin_serial ();
2349 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2351 set_initial_gdb_ttystate ();
2353 async_init_signals ();
2355 /* We need a default language for parsing expressions, so simple
2356 things like "set width 0" won't fail if no language is explicitly
2357 set in a config file or implicitly set by reading an executable
2359 set_language (language_c
);
2360 expected_language
= current_language
; /* Don't warn about the change. */
2362 /* Python initialization, for example, can require various commands to be
2363 installed. For example "info pretty-printer" needs the "info"
2364 prefix to be installed. Keep things simple and just do final
2365 script initialization here. */
2366 finish_ext_lang_initialization ();
2368 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2369 init_gdb_version_vars ();