1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2020 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
);
451 void (*pre_init_ui_hook
) (void);
455 do_chdir_cleanup (void *old_dir
)
457 chdir ((const char *) old_dir
);
463 prepare_execute_command ()
465 /* With multiple threads running while the one we're examining is
466 stopped, the dcache can get stale without us being able to detect
467 it. For the duration of the command, though, use the dcache to
468 help things like backtrace. */
470 target_dcache_invalidate ();
472 return scoped_value_mark ();
475 /* Tell the user if the language has changed (except first time) after
476 executing a command. */
479 check_frame_language_change (void)
481 static int warned
= 0;
482 struct frame_info
*frame
;
484 /* First make sure that a new frame has been selected, in case the
485 command or the hooks changed the program state. */
486 frame
= deprecated_safe_get_selected_frame ();
487 if (current_language
!= expected_language
)
489 if (language_mode
== language_mode_auto
&& info_verbose
)
491 language_info (1); /* Print what changed. */
496 /* Warn the user if the working language does not match the language
497 of the current frame. Only warn the user if we are actually
498 running the program, i.e. there is a stack. */
499 /* FIXME: This should be cacheing the frame and only running when
500 the frame changes. */
502 if (has_stack_frames ())
506 flang
= get_frame_language (frame
);
508 && flang
!= language_unknown
509 && flang
!= current_language
->la_language
)
511 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
520 wait_sync_command_done (void)
522 /* Processing events may change the current UI. */
523 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
524 struct ui
*ui
= current_ui
;
526 while (gdb_do_one_event () >= 0)
527 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
534 maybe_wait_sync_command_done (int was_sync
)
536 /* If the interpreter is in sync mode (we're running a user
537 command's list, running command hooks or similars), and we
538 just ran a synchronous command that started the target, wait
539 for that command to end. */
540 if (!current_ui
->async
542 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
543 wait_sync_command_done ();
549 set_repeat_arguments (const char *args
)
551 repeat_arguments
= args
;
554 /* Execute the line P as a command, in the current user context.
555 Pass FROM_TTY as second argument to the defining function. */
558 execute_command (const char *p
, int from_tty
)
560 struct cmd_list_element
*c
;
562 const char *cmd_start
= p
;
564 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
565 scoped_value_mark cleanup
= prepare_execute_command ();
567 /* This can happen when command_line_input hits end of file. */
570 cleanup_if_error
.release ();
574 target_log_command (p
);
576 while (*p
== ' ' || *p
== '\t')
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
, "", 0, 1);
592 scoped_restore save_repeat_args
593 = make_scoped_restore (&repeat_arguments
, nullptr);
594 const char *args_pointer
= p
;
596 /* Pass null arg rather than an empty one. */
599 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
600 while the is_complete_command(cfunc) test is just plain
601 bogus. They should both be replaced by a test of the form
602 c->strip_trailing_white_space_p. */
603 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
604 can't be replaced with func. This is because it is the
605 cfunc, and not the func, that has the value that the
606 is_complete_command hack is testing for. */
607 /* Clear off trailing whitespace, except for set and complete
609 std::string without_whitespace
;
611 && c
->type
!= set_cmd
612 && !is_complete_command (c
))
614 const char *old_end
= arg
+ strlen (arg
) - 1;
616 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
620 without_whitespace
= std::string (arg
, p
+ 1);
621 arg
= without_whitespace
.c_str ();
625 /* If this command has been pre-hooked, run the hook first. */
626 execute_cmd_pre_hook (c
);
628 if (c
->deprecated_warn_user
)
629 deprecated_cmd_warning (line
);
631 /* c->user_commands would be NULL in the case of a python command. */
632 if (c
->theclass
== class_user
&& c
->user_commands
)
633 execute_user_command (c
, arg
);
634 else if (c
->theclass
== class_user
635 && c
->prefixlist
&& !c
->allow_unknown
)
636 /* If this is a user defined prefix that does not allow unknown
637 (in other words, C is a prefix command and not a command
638 that can be followed by its args), report the list of
642 ("\"%.*s\" must be followed by the name of a subcommand.\n",
643 (int) strlen (c
->prefixname
) - 1, c
->prefixname
);
644 help_list (*c
->prefixlist
, c
->prefixname
, all_commands
, gdb_stdout
);
646 else if (c
->type
== set_cmd
)
647 do_set_command (arg
, from_tty
, c
);
648 else if (c
->type
== show_cmd
)
649 do_show_command (arg
, from_tty
, c
);
650 else if (!cmd_func_p (c
))
651 error (_("That is not a command, just a help topic."));
652 else if (deprecated_call_command_hook
)
653 deprecated_call_command_hook (c
, arg
, from_tty
);
655 cmd_func (c
, arg
, from_tty
);
657 maybe_wait_sync_command_done (was_sync
);
659 /* If this command has been post-hooked, run the hook last. */
660 execute_cmd_post_hook (c
);
662 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
664 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
665 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
670 /* Only perform the frame-language-change check if the command
671 we just finished executing did not resume the inferior's execution.
672 If it did resume the inferior, we will do that check after
673 the inferior stopped. */
674 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
675 check_frame_language_change ();
677 cleanup_if_error
.release ();
680 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
681 do not display it to the screen. BATCH_FLAG will be
682 temporarily set to true. */
685 execute_command_to_ui_file (struct ui_file
*file
, const char *p
, int from_tty
)
687 /* GDB_STDOUT should be better already restored during these
688 restoration callbacks. */
689 set_batch_flag_and_restore_page_info save_page_info
;
691 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
694 current_uiout
->redirect (file
);
695 ui_out_redirect_pop
redirect_popper (current_uiout
);
697 scoped_restore save_stdout
698 = make_scoped_restore (&gdb_stdout
, file
);
699 scoped_restore save_stderr
700 = make_scoped_restore (&gdb_stderr
, file
);
701 scoped_restore save_stdlog
702 = make_scoped_restore (&gdb_stdlog
, file
);
703 scoped_restore save_stdtarg
704 = make_scoped_restore (&gdb_stdtarg
, file
);
705 scoped_restore save_stdtargerr
706 = make_scoped_restore (&gdb_stdtargerr
, file
);
708 execute_command (p
, from_tty
);
712 /* Run execute_command for P and FROM_TTY. Capture its output into the
713 returned string, do not display it to the screen. BATCH_FLAG will be
714 temporarily set to true. */
717 execute_command_to_string (const char *p
, int from_tty
,
720 string_file
str_file (term_out
);
722 execute_command_to_ui_file (&str_file
, p
, from_tty
);
723 return std::move (str_file
.string ());
727 /* When nonzero, cause dont_repeat to do nothing. This should only be
728 set via prevent_dont_repeat. */
730 static int suppress_dont_repeat
= 0;
737 struct ui
*ui
= current_ui
;
739 if (suppress_dont_repeat
|| server_command
)
742 /* If we aren't reading from standard input, we are saving the last
743 thing read from stdin in line and don't want to delete it. Null
744 lines won't repeat here in any case. */
745 if (ui
->instream
== ui
->stdin_stream
)
747 *saved_command_line
= 0;
748 repeat_arguments
= NULL
;
757 /* Do not repeat this command, as this command is a repeating command. */
760 /* We cannot free saved_command_line, as this line is being executed,
761 so swap it with previous_saved_command_line. */
762 std::swap (previous_saved_command_line
, saved_command_line
);
763 std::swap (previous_repeat_arguments
, repeat_arguments
);
765 const char *prev
= skip_spaces (get_saved_command_line ());
767 error (_("No previous command to relaunch"));
773 scoped_restore_tmpl
<int>
774 prevent_dont_repeat (void)
776 return make_scoped_restore (&suppress_dont_repeat
, 1);
782 get_saved_command_line ()
784 return saved_command_line
;
790 save_command_line (const char *cmd
)
792 xfree (previous_saved_command_line
);
793 previous_saved_command_line
= saved_command_line
;
794 previous_repeat_arguments
= repeat_arguments
;
795 saved_command_line
= xstrdup (cmd
);
796 repeat_arguments
= NULL
;
800 /* Read a line from the stream "instream" without command line editing.
802 It prints PROMPT once at the start.
803 Action is compatible with "readline", e.g. space for the result is
804 malloc'd and should be freed by the caller.
806 A NULL return means end of file. */
809 gdb_readline_no_editing (const char *prompt
)
811 struct buffer line_buffer
;
812 struct ui
*ui
= current_ui
;
813 /* Read from stdin if we are executing a user defined command. This
814 is the right thing for prompt_for_continue, at least. */
815 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
816 int fd
= fileno (stream
);
818 buffer_init (&line_buffer
);
822 /* Don't use a _filtered function here. It causes the assumed
823 character position to be off, since the newline we read from
824 the user is not accounted for. */
825 fputs_unfiltered (prompt
, gdb_stdout
);
826 gdb_flush (gdb_stdout
);
836 /* Wait until at least one byte of data is available. Control-C
837 can interrupt interruptible_select, but not fgetc. */
839 FD_SET (fd
, &readfds
);
840 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
844 /* If this was ctrl-c, the QUIT above handles it. */
847 perror_with_name (("select"));
854 if (line_buffer
.used_size
> 0)
855 /* The last line does not end with a newline. Return it, and
856 if we are called again fgetc will still return EOF and
857 we'll return NULL then. */
859 xfree (buffer_finish (&line_buffer
));
865 if (line_buffer
.used_size
> 0
866 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
867 line_buffer
.used_size
--;
871 buffer_grow_char (&line_buffer
, c
);
874 buffer_grow_char (&line_buffer
, '\0');
875 return buffer_finish (&line_buffer
);
878 /* Variables which control command line editing and history
879 substitution. These variables are given default values at the end
881 static bool command_editing_p
;
883 /* NOTE 1999-04-29: This variable will be static again, once we modify
884 gdb to use the event loop as the default command loop and we merge
885 event-top.c into this file, top.c. */
887 /* static */ bool history_expansion_p
;
889 /* Should we write out the command history on exit? In order to write out
890 the history both this flag must be true, and the history_filename
891 variable must be set to something sensible. */
892 static bool write_history_p
;
894 /* Implement 'show history save'. */
896 show_write_history_p (struct ui_file
*file
, int from_tty
,
897 struct cmd_list_element
*c
, const char *value
)
899 if (!write_history_p
|| !history_filename_empty ())
900 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
903 fprintf_filtered (file
, _("Saving of the history is disabled due to "
904 "the value of 'history filename'.\n"));
907 /* The variable associated with the "set/show history size"
908 command. The value -1 means unlimited, and -2 means undefined. */
909 static int history_size_setshow_var
= -2;
912 show_history_size (struct ui_file
*file
, int from_tty
,
913 struct cmd_list_element
*c
, const char *value
)
915 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
919 /* Variable associated with the "history remove-duplicates" option.
920 The value -1 means unlimited. */
921 static int history_remove_duplicates
= 0;
924 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
925 struct cmd_list_element
*c
, const char *value
)
927 fprintf_filtered (file
,
928 _("The number of history entries to look back at for "
929 "duplicates is %s.\n"),
933 /* The name of the file in which GDB history will be written. If this is
934 set to NULL, of the empty string then history will not be written. */
935 static char *history_filename
;
937 /* Return true if the history_filename is either NULL or the empty string,
938 indicating that we should not try to read, nor write out the history. */
940 history_filename_empty (void)
942 return (history_filename
== nullptr || *history_filename
== '\0');
945 /* Implement 'show history filename'. */
947 show_history_filename (struct ui_file
*file
, int from_tty
,
948 struct cmd_list_element
*c
, const char *value
)
950 if (!history_filename_empty ())
951 fprintf_filtered (file
, _("The filename in which to record "
952 "the command history is \"%ps\".\n"),
953 styled_string (file_name_style
.style (), value
));
955 fprintf_filtered (file
, _("There is no filename currently set for "
956 "recording the command history in.\n"));
959 /* This is like readline(), but it has some gdb-specific behavior.
960 gdb may want readline in both the synchronous and async modes during
961 a single gdb invocation. At the ordinary top-level prompt we might
962 be using the async readline. That means we can't use
963 rl_pre_input_hook, since it doesn't work properly in async mode.
964 However, for a secondary prompt (" >", such as occurs during a
965 `define'), gdb wants a synchronous response.
967 We used to call readline() directly, running it in synchronous
968 mode. But mixing modes this way is not supported, and as of
969 readline 5.x it no longer works; the arrow keys come unbound during
970 the synchronous call. So we make a nested call into the event
971 loop. That's what gdb_readline_wrapper is for. */
973 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
974 rely on gdb_readline_wrapper_result, which might still be NULL if
975 the user types Control-D for EOF. */
976 static int gdb_readline_wrapper_done
;
978 /* The result of the current call to gdb_readline_wrapper, once a newline
980 static char *gdb_readline_wrapper_result
;
982 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
983 to be called after the newline is processed (which will redisplay
984 the prompt). But in gdb_readline_wrapper we will not get a new
985 prompt until the next call, or until we return to the event loop.
986 So we disable this hook around the newline and restore it before we
988 static void (*saved_after_char_processing_hook
) (void);
994 gdb_in_secondary_prompt_p (struct ui
*ui
)
996 return ui
->secondary_prompt_depth
> 0;
1000 /* This function is called when readline has seen a complete line of
1004 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
1006 gdb_assert (!gdb_readline_wrapper_done
);
1007 gdb_readline_wrapper_result
= line
.release ();
1008 gdb_readline_wrapper_done
= 1;
1010 /* Prevent operate-and-get-next from acting too early. */
1011 saved_after_char_processing_hook
= after_char_processing_hook
;
1012 after_char_processing_hook
= NULL
;
1014 /* Prevent parts of the prompt from being redisplayed if annotations
1015 are enabled, and readline's state getting out of sync. We'll
1016 reinstall the callback handler, which puts the terminal in raw
1017 mode (or in readline lingo, in prepped state), when we're next
1018 ready to process user input, either in display_gdb_prompt, or if
1019 we're handling an asynchronous target event and running in the
1020 background, just before returning to the event loop to process
1021 further input (or more target events). */
1022 if (current_ui
->command_editing
)
1023 gdb_rl_callback_handler_remove ();
1026 class gdb_readline_wrapper_cleanup
1029 gdb_readline_wrapper_cleanup ()
1030 : m_handler_orig (current_ui
->input_handler
),
1031 m_already_prompted_orig (current_ui
->command_editing
1032 ? rl_already_prompted
: 0),
1033 m_target_is_async_orig (target_is_async_p ()),
1034 m_save_ui (¤t_ui
)
1036 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1037 current_ui
->secondary_prompt_depth
++;
1039 if (m_target_is_async_orig
)
1043 ~gdb_readline_wrapper_cleanup ()
1045 struct ui
*ui
= current_ui
;
1047 if (ui
->command_editing
)
1048 rl_already_prompted
= m_already_prompted_orig
;
1050 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1051 ui
->input_handler
= m_handler_orig
;
1053 /* Don't restore our input handler in readline yet. That would make
1054 readline prep the terminal (putting it in raw mode), while the
1055 line we just read may trigger execution of a command that expects
1056 the terminal in the default cooked/canonical mode, such as e.g.,
1057 running Python's interactive online help utility. See
1058 gdb_readline_wrapper_line for when we'll reinstall it. */
1060 gdb_readline_wrapper_result
= NULL
;
1061 gdb_readline_wrapper_done
= 0;
1062 ui
->secondary_prompt_depth
--;
1063 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1065 after_char_processing_hook
= saved_after_char_processing_hook
;
1066 saved_after_char_processing_hook
= NULL
;
1068 if (m_target_is_async_orig
)
1072 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1076 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1077 int m_already_prompted_orig
;
1079 /* Whether the target was async. */
1080 int m_target_is_async_orig
;
1082 /* Processing events may change the current UI. */
1083 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1087 gdb_readline_wrapper (const char *prompt
)
1089 struct ui
*ui
= current_ui
;
1091 gdb_readline_wrapper_cleanup cleanup
;
1093 /* Display our prompt and prevent double prompt display. Don't pass
1094 down a NULL prompt, since that has special meaning for
1095 display_gdb_prompt -- it indicates a request to print the primary
1096 prompt, while we want a secondary prompt here. */
1097 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1098 if (ui
->command_editing
)
1099 rl_already_prompted
= 1;
1101 if (after_char_processing_hook
)
1102 (*after_char_processing_hook
) ();
1103 gdb_assert (after_char_processing_hook
== NULL
);
1105 while (gdb_do_one_event () >= 0)
1106 if (gdb_readline_wrapper_done
)
1109 return gdb_readline_wrapper_result
;
1113 /* The current saved history number from operate-and-get-next.
1114 This is -1 if not valid. */
1115 static int operate_saved_history
= -1;
1117 /* This is put on the appropriate hook and helps operate-and-get-next
1120 gdb_rl_operate_and_get_next_completion (void)
1122 int delta
= where_history () - operate_saved_history
;
1124 /* The `key' argument to rl_get_previous_history is ignored. */
1125 rl_get_previous_history (delta
, 0);
1126 operate_saved_history
= -1;
1128 /* readline doesn't automatically update the display for us. */
1131 after_char_processing_hook
= NULL
;
1132 rl_pre_input_hook
= NULL
;
1135 /* This is a gdb-local readline command handler. It accepts the
1136 current command line (like RET does) and, if this command was taken
1137 from the history, arranges for the next command in the history to
1138 appear on the command line when the prompt returns.
1139 We ignore the arguments. */
1141 gdb_rl_operate_and_get_next (int count
, int key
)
1145 /* Use the async hook. */
1146 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1148 /* Find the current line, and find the next line to use. */
1149 where
= where_history();
1151 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1152 || (where
>= history_length
- 1))
1153 operate_saved_history
= where
;
1155 operate_saved_history
= where
+ 1;
1157 return rl_newline (1, key
);
1160 /* Number of user commands executed during this session. */
1162 static int command_count
= 0;
1164 /* Add the user command COMMAND to the input history list. */
1167 gdb_add_history (const char *command
)
1171 if (history_remove_duplicates
!= 0)
1174 int lookbehind_threshold
;
1176 /* The lookbehind threshold for finding a duplicate history entry is
1177 bounded by command_count because we can't meaningfully delete
1178 history entries that are already stored in the history file since
1179 the history file is appended to. */
1180 if (history_remove_duplicates
== -1
1181 || history_remove_duplicates
> command_count
)
1182 lookbehind_threshold
= command_count
;
1184 lookbehind_threshold
= history_remove_duplicates
;
1187 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1189 HIST_ENTRY
*temp
= previous_history ();
1194 if (strcmp (temp
->line
, command
) == 0)
1196 HIST_ENTRY
*prev
= remove_history (where_history ());
1198 free_history_entry (prev
);
1205 add_history (command
);
1208 /* Safely append new history entries to the history file in a corruption-free
1209 way using an intermediate local history file. */
1212 gdb_safe_append_history (void)
1214 int ret
, saved_errno
;
1216 std::string local_history_filename
1217 = string_printf ("%s-gdb%ld~", history_filename
, (long) getpid ());
1219 ret
= rename (history_filename
, local_history_filename
.c_str ());
1220 saved_errno
= errno
;
1221 if (ret
< 0 && saved_errno
!= ENOENT
)
1223 warning (_("Could not rename %ps to %ps: %s"),
1224 styled_string (file_name_style
.style (), history_filename
),
1225 styled_string (file_name_style
.style (),
1226 local_history_filename
.c_str ()),
1227 safe_strerror (saved_errno
));
1233 /* If the rename failed with ENOENT then either the global history
1234 file never existed in the first place or another GDB process is
1235 currently appending to it (and has thus temporarily renamed it).
1236 Since we can't distinguish between these two cases, we have to
1237 conservatively assume the first case and therefore must write out
1238 (not append) our known history to our local history file and try
1239 to move it back anyway. Otherwise a global history file would
1240 never get created! */
1241 gdb_assert (saved_errno
== ENOENT
);
1242 write_history (local_history_filename
.c_str ());
1246 append_history (command_count
, local_history_filename
.c_str ());
1247 if (history_is_stifled ())
1248 history_truncate_file (local_history_filename
.c_str (),
1249 history_max_entries
);
1252 ret
= rename (local_history_filename
.c_str (), history_filename
);
1253 saved_errno
= errno
;
1254 if (ret
< 0 && saved_errno
!= EEXIST
)
1255 warning (_("Could not rename %s to %s: %s"),
1256 local_history_filename
.c_str (), history_filename
,
1257 safe_strerror (saved_errno
));
1261 /* Read one line from the command input stream `instream' into a local
1262 static buffer. The buffer is made bigger as necessary. Returns
1263 the address of the start of the line.
1265 NULL is returned for end of file.
1267 This routine either uses fancy command line editing or simple input
1268 as the user has requested. */
1271 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1273 static struct buffer cmd_line_buffer
;
1274 static int cmd_line_buffer_initialized
;
1275 struct ui
*ui
= current_ui
;
1276 const char *prompt
= prompt_arg
;
1278 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1280 /* The annotation suffix must be non-NULL. */
1281 if (annotation_suffix
== NULL
)
1282 annotation_suffix
= "";
1284 if (from_tty
&& annotation_level
> 1)
1289 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1290 + strlen (annotation_suffix
) + 40);
1292 local_prompt
[0] = '\0';
1294 strcpy (local_prompt
, prompt
);
1295 strcat (local_prompt
, "\n\032\032");
1296 strcat (local_prompt
, annotation_suffix
);
1297 strcat (local_prompt
, "\n");
1299 prompt
= local_prompt
;
1302 if (!cmd_line_buffer_initialized
)
1304 buffer_init (&cmd_line_buffer
);
1305 cmd_line_buffer_initialized
= 1;
1308 /* Starting a new command line. */
1309 cmd_line_buffer
.used_size
= 0;
1313 signal (SIGTSTP
, handle_sigtstp
);
1318 gdb::unique_xmalloc_ptr
<char> rl
;
1320 /* Make sure that all output has been output. Some machines may
1321 let you get away with leaving out some of the gdb_flush, but
1324 gdb_flush (gdb_stdout
);
1325 gdb_flush (gdb_stderr
);
1327 if (!source_file_name
.empty ())
1328 ++source_line_number
;
1330 if (from_tty
&& annotation_level
> 1)
1332 puts_unfiltered ("\n\032\032pre-");
1333 puts_unfiltered (annotation_suffix
);
1334 puts_unfiltered ("\n");
1337 /* Don't use fancy stuff if not talking to stdin. */
1338 if (deprecated_readline_hook
1340 && input_interactive_p (current_ui
))
1342 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1344 else if (command_editing_p
1346 && input_interactive_p (current_ui
))
1348 rl
.reset (gdb_readline_wrapper (prompt
));
1352 rl
.reset (gdb_readline_no_editing (prompt
));
1355 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1356 0, annotation_suffix
);
1357 if (cmd
== (char *) EOF
)
1365 /* Got partial input. I.e., got a line that ends with a
1366 continuation character (backslash). Suppress printing the
1373 signal (SIGTSTP
, SIG_DFL
);
1381 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1383 /* From GNU coding standards, first line is meant to be easy for a
1384 program to parse, and is just canonical program name and version
1385 number, which starts after last space. */
1387 ui_file_style style
;
1390 ui_file_style nstyle
= { ui_file_style::MAGENTA
, ui_file_style::NONE
,
1391 ui_file_style::BOLD
};
1394 fprintf_styled (stream
, style
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1396 /* Second line is a copyright notice. */
1398 fprintf_filtered (stream
,
1399 "Copyright (C) 2020 Free Software Foundation, Inc.\n");
1401 /* Following the copyright is a brief statement that the program is
1402 free software, that users are free to copy and change it on
1403 certain conditions, that it is covered by the GNU GPL, and that
1404 there is no warranty. */
1406 fprintf_filtered (stream
, "\
1407 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1408 \nThis is free software: you are free to change and redistribute it.\n\
1409 There is NO WARRANTY, to the extent permitted by law.");
1414 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1415 "\"show warranty\" for details.\n"));
1417 /* After the required info we print the configuration information. */
1419 fprintf_filtered (stream
, "This GDB was configured as \"");
1420 if (strcmp (host_name
, target_name
) != 0)
1422 fprintf_filtered (stream
, "--host=%s --target=%s",
1423 host_name
, target_name
);
1427 fprintf_filtered (stream
, "%s", host_name
);
1429 fprintf_filtered (stream
, "\".\n");
1431 fprintf_filtered (stream
, _("Type \"show configuration\" "
1432 "for configuration details.\n"));
1434 if (REPORT_BUGS_TO
[0])
1436 fprintf_filtered (stream
,
1437 _("For bug reporting instructions, please see:\n"));
1438 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1440 fprintf_filtered (stream
,
1441 _("Find the GDB manual and other documentation \
1442 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1443 fprintf_filtered (stream
, "\n\n");
1444 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1445 fprintf_filtered (stream
,
1446 _("Type \"apropos word\" to search for commands \
1447 related to \"word\"."));
1450 /* Print the details of GDB build-time configuration. */
1452 print_gdb_configuration (struct ui_file
*stream
)
1454 fprintf_filtered (stream
, _("\
1455 This GDB was configured as follows:\n\
1456 configure --host=%s --target=%s\n\
1457 "), host_name
, target_name
);
1459 fprintf_filtered (stream
, _("\
1460 --with-auto-load-dir=%s\n\
1461 --with-auto-load-safe-path=%s\n\
1462 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1465 fprintf_filtered (stream
, _("\
1469 fprintf_filtered (stream
, _("\
1475 fprintf_filtered (stream
, _("\
1476 --with-gdb-datadir=%s%s\n\
1477 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1480 fprintf_filtered (stream
, _("\
1481 --with-iconv-bin=%s%s\n\
1482 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1485 if (JIT_READER_DIR
[0])
1486 fprintf_filtered (stream
, _("\
1487 --with-jit-reader-dir=%s%s\n\
1488 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1490 #if HAVE_LIBUNWIND_IA64_H
1491 fprintf_filtered (stream
, _("\
1492 --with-libunwind-ia64\n\
1495 fprintf_filtered (stream
, _("\
1496 --without-libunwind-ia64\n\
1501 fprintf_filtered (stream
, _("\
1505 fprintf_filtered (stream
, _("\
1510 #if HAVE_LIBBABELTRACE
1511 fprintf_filtered (stream
, _("\
1512 --with-babeltrace\n\
1515 fprintf_filtered (stream
, _("\
1516 --without-babeltrace\n\
1521 fprintf_filtered (stream
, _("\
1525 fprintf_filtered (stream
, _("\
1526 --without-intel-pt\n\
1531 fprintf_filtered (stream
, _("\
1535 fprintf_filtered (stream
, _("\
1540 fprintf_filtered (stream
, _("\
1544 fprintf_filtered (stream
, _("\
1548 #ifdef WITH_PYTHON_PATH
1549 fprintf_filtered (stream
, _("\
1550 --with-python=%s%s\n\
1551 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1553 fprintf_filtered (stream
, _("\
1558 #if HAVE_LIBDEBUGINFOD
1559 fprintf_filtered (stream
, _("\
1560 --with-debuginfod\n\
1563 fprintf_filtered (stream
, _("\
1564 --without-debuginfod\n\
1569 fprintf_filtered (stream
, _("\
1573 fprintf_filtered (stream
, _("\
1578 #if HAVE_SOURCE_HIGHLIGHT
1579 fprintf_filtered (stream
, _("\
1580 --enable-source-highlight\n\
1583 fprintf_filtered (stream
, _("\
1584 --disable-source-highlight\n\
1589 fprintf_filtered (stream
, _("\
1590 --with-relocated-sources=%s\n\
1595 fprintf_filtered (stream
, _("\
1596 --with-separate-debug-dir=%s%s\n\
1597 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1599 if (TARGET_SYSTEM_ROOT
[0])
1600 fprintf_filtered (stream
, _("\
1601 --with-sysroot=%s%s\n\
1602 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1604 if (SYSTEM_GDBINIT
[0])
1605 fprintf_filtered (stream
, _("\
1606 --with-system-gdbinit=%s%s\n\
1607 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1609 if (SYSTEM_GDBINIT_DIR
[0])
1610 fprintf_filtered (stream
, _("\
1611 --with-system-gdbinit-dir=%s%s\n\
1612 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1614 /* We assume "relocatable" will be printed at least once, thus we always
1615 print this text. It's a reasonably safe assumption for now. */
1616 fprintf_filtered (stream
, _("\n\
1617 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1618 tree, and GDB will still find it.)\n\
1623 /* The current top level prompt, settable with "set prompt", and/or
1624 with the python `gdb.prompt_hook' hook. */
1625 static char *top_prompt
;
1627 /* Access method for the GDB prompt string. */
1635 /* Set method for the GDB prompt string. */
1638 set_prompt (const char *s
)
1640 char *p
= xstrdup (s
);
1647 /* Kills or detaches the given inferior, depending on how we originally
1648 gained control of it. */
1651 kill_or_detach (inferior
*inf
, int from_tty
)
1656 thread_info
*thread
= any_thread_of_inferior (inf
);
1659 switch_to_thread (thread
);
1661 /* Leave core files alone. */
1662 if (target_has_execution
)
1664 if (inf
->attach_flag
)
1665 target_detach (inf
, from_tty
);
1672 /* Prints info about what GDB will do to inferior INF on a "quit". OUT is
1673 where to collect the output. */
1676 print_inferior_quit_action (inferior
*inf
, ui_file
*out
)
1681 if (inf
->attach_flag
)
1682 fprintf_filtered (out
,
1683 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1684 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1686 fprintf_filtered (out
,
1687 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1688 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1691 /* If necessary, make the user confirm that we should quit. Return
1692 non-zero if we should quit, zero if we shouldn't. */
1697 /* Don't even ask if we're only debugging a core file inferior. */
1698 if (!have_live_inferiors ())
1701 /* Build the query string as a single string. */
1704 stb
.puts (_("A debugging session is active.\n\n"));
1706 for (inferior
*inf
: all_inferiors ())
1707 print_inferior_quit_action (inf
, &stb
);
1709 stb
.puts (_("\nQuit anyway? "));
1711 return query ("%s", stb
.c_str ());
1714 /* Prepare to exit GDB cleanly by undoing any changes made to the
1715 terminal so that we leave the terminal in the state we acquired it. */
1718 undo_terminal_modifications_before_exit (void)
1720 struct ui
*saved_top_level
= current_ui
;
1722 target_terminal::ours ();
1724 current_ui
= main_ui
;
1729 gdb_disable_readline ();
1731 current_ui
= saved_top_level
;
1735 /* Quit without asking for confirmation. */
1738 quit_force (int *exit_arg
, int from_tty
)
1742 undo_terminal_modifications_before_exit ();
1744 /* An optional expression may be used to cause gdb to terminate with the
1745 value of that expression. */
1747 exit_code
= *exit_arg
;
1748 else if (return_child_result
)
1749 exit_code
= return_child_result_value
;
1751 /* We want to handle any quit errors and exit regardless. */
1753 /* Get out of tfind mode, and kill or detach all inferiors. */
1756 disconnect_tracing ();
1757 for (inferior
*inf
: all_inferiors ())
1758 kill_or_detach (inf
, from_tty
);
1760 catch (const gdb_exception
&ex
)
1762 exception_print (gdb_stderr
, ex
);
1765 /* Give all pushed targets a chance to do minimal cleanup, and pop
1767 for (inferior
*inf
: all_inferiors ())
1769 switch_to_inferior_no_thread (inf
);
1774 catch (const gdb_exception
&ex
)
1776 exception_print (gdb_stderr
, ex
);
1780 /* Save the history information if it is appropriate to do so. */
1783 if (write_history_p
&& history_filename
)
1788 /* History is currently shared between all UIs. If there's
1789 any UI with a terminal, save history. */
1792 if (input_interactive_p (ui
))
1800 gdb_safe_append_history ();
1803 catch (const gdb_exception
&ex
)
1805 exception_print (gdb_stderr
, ex
);
1808 /* Destroy any values currently allocated now instead of leaving it
1809 to global destructors, because that may be too late. For
1810 example, the destructors of xmethod values call into the Python
1811 runtime, which is finalized via a final cleanup. */
1814 /* Do any final cleanups before exiting. */
1817 do_final_cleanups ();
1819 catch (const gdb_exception
&ex
)
1821 exception_print (gdb_stderr
, ex
);
1827 /* The value of the "interactive-mode" setting. */
1828 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1830 /* Implement the "show interactive-mode" option. */
1833 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1834 struct cmd_list_element
*c
,
1837 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1838 fprintf_filtered (file
, "Debugger's interactive mode "
1839 "is %s (currently %s).\n",
1840 value
, input_interactive_p (current_ui
) ? "on" : "off");
1842 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1845 /* Returns whether GDB is running on an interactive terminal. */
1848 input_interactive_p (struct ui
*ui
)
1853 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1854 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1856 return ui
->input_interactive_p
;
1860 dont_repeat_command (const char *ignored
, int from_tty
)
1862 /* Can't call dont_repeat here because we're not necessarily reading
1864 *saved_command_line
= 0;
1867 /* Functions to manipulate command line editing control variables. */
1869 /* Number of commands to print in each call to show_commands. */
1870 #define Hist_print 10
1872 show_commands (const char *args
, int from_tty
)
1874 /* Index for history commands. Relative to history_base. */
1877 /* Number of the history entry which we are planning to display next.
1878 Relative to history_base. */
1881 /* Print out some of the commands from the command history. */
1885 if (args
[0] == '+' && args
[1] == '\0')
1886 /* "info editing +" should print from the stored position. */
1889 /* "info editing <exp>" should print around command number <exp>. */
1890 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1892 /* "show commands" means print the last Hist_print commands. */
1895 num
= history_length
- Hist_print
;
1901 /* If there are at least Hist_print commands, we want to display the last
1902 Hist_print rather than, say, the last 6. */
1903 if (history_length
- num
< Hist_print
)
1905 num
= history_length
- Hist_print
;
1911 offset
< num
+ Hist_print
&& offset
< history_length
;
1914 printf_filtered ("%5d %s\n", history_base
+ offset
,
1915 (history_get (history_base
+ offset
))->line
);
1918 /* The next command we want to display is the next one that we haven't
1922 /* If the user repeats this command with return, it should do what
1923 "show commands +" does. This is unnecessary if arg is null,
1924 because "show commands +" is not useful after "show commands". */
1925 if (from_tty
&& args
)
1926 set_repeat_arguments ("+");
1929 /* Update the size of our command history file to HISTORY_SIZE.
1931 A HISTORY_SIZE of -1 stands for unlimited. */
1934 set_readline_history_size (int history_size
)
1936 gdb_assert (history_size
>= -1);
1938 if (history_size
== -1)
1939 unstifle_history ();
1941 stifle_history (history_size
);
1944 /* Called by do_setshow_command. */
1946 set_history_size_command (const char *args
,
1947 int from_tty
, struct cmd_list_element
*c
)
1949 set_readline_history_size (history_size_setshow_var
);
1952 bool info_verbose
= false; /* Default verbose msgs off. */
1954 /* Called by do_set_command. An elaborate joke. */
1956 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1958 const char *cmdname
= "verbose";
1959 struct cmd_list_element
*showcmd
;
1961 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1962 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1964 if (c
->doc
&& c
->doc_allocated
)
1965 xfree ((char *) c
->doc
);
1966 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1967 xfree ((char *) showcmd
->doc
);
1970 c
->doc
= _("Set verbose printing of informational messages.");
1971 showcmd
->doc
= _("Show verbose printing of informational messages.");
1975 c
->doc
= _("Set verbosity.");
1976 showcmd
->doc
= _("Show verbosity.");
1978 c
->doc_allocated
= 0;
1979 showcmd
->doc_allocated
= 0;
1982 /* Init the history buffer. Note that we are called after the init file(s)
1983 have been read so that the user can change the history file via his
1984 .gdbinit file (for instance). The GDBHISTFILE environment variable
1985 overrides all of this. */
1992 tmpenv
= getenv ("GDBHISTSIZE");
1999 tmpenv
= skip_spaces (tmpenv
);
2001 var
= strtol (tmpenv
, &endptr
, 10);
2002 saved_errno
= errno
;
2003 endptr
= skip_spaces (endptr
);
2005 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
2006 empty string, a negative number or a huge positive number (larger than
2007 INT_MAX) then set the history size to unlimited. Otherwise set our
2008 history size to the number we have read. This behavior is consistent
2009 with how bash handles HISTSIZE. */
2010 if (*endptr
!= '\0')
2012 else if (*tmpenv
== '\0'
2015 /* On targets where INT_MAX == LONG_MAX, we have to look at
2016 errno after calling strtol to distinguish between a value that
2017 is exactly INT_MAX and an overflowing value that was clamped
2019 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2020 history_size_setshow_var
= -1;
2022 history_size_setshow_var
= var
;
2025 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2027 if (history_size_setshow_var
== -2)
2028 history_size_setshow_var
= 256;
2030 set_readline_history_size (history_size_setshow_var
);
2032 tmpenv
= getenv ("GDBHISTFILE");
2033 if (tmpenv
!= nullptr)
2034 history_filename
= xstrdup (tmpenv
);
2035 else if (history_filename
== nullptr)
2037 /* We include the current directory so that if the user changes
2038 directories the file written will be the same as the one
2041 /* No leading dots in file names are allowed on MSDOS. */
2042 const char *fname
= "_gdb_history";
2044 const char *fname
= ".gdb_history";
2047 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (fname
));
2048 history_filename
= temp
.release ();
2051 if (!history_filename_empty ())
2052 read_history (history_filename
);
2056 show_prompt (struct ui_file
*file
, int from_tty
,
2057 struct cmd_list_element
*c
, const char *value
)
2059 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2062 /* "set editing" command. */
2065 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2067 change_line_handler (set_editing_cmd_var
);
2068 /* Update the control variable so that MI's =cmd-param-changed event
2069 shows the correct value. */
2070 set_editing_cmd_var
= current_ui
->command_editing
;
2074 show_editing (struct ui_file
*file
, int from_tty
,
2075 struct cmd_list_element
*c
, const char *value
)
2077 fprintf_filtered (file
, _("Editing of command lines as "
2078 "they are typed is %s.\n"),
2079 current_ui
->command_editing
? _("on") : _("off"));
2083 show_annotation_level (struct ui_file
*file
, int from_tty
,
2084 struct cmd_list_element
*c
, const char *value
)
2086 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2090 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2091 struct cmd_list_element
*c
, const char *value
)
2093 fprintf_filtered (file
, _("Notification of completion for "
2094 "asynchronous execution commands is %s.\n"),
2098 /* New values of the "data-directory" parameter are staged here. */
2099 static char *staged_gdb_datadir
;
2101 /* "set" command for the gdb_datadir configuration variable. */
2104 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2106 set_gdb_data_directory (staged_gdb_datadir
);
2107 gdb::observers::gdb_datadir_changed
.notify ();
2110 /* "show" command for the gdb_datadir configuration variable. */
2113 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2114 struct cmd_list_element
*c
, const char *value
)
2116 fprintf_filtered (file
, _("GDB's data directory is \"%ps\".\n"),
2117 styled_string (file_name_style
.style (),
2118 gdb_datadir
.c_str ()));
2121 /* Implement 'set history filename'. */
2124 set_history_filename (const char *args
,
2125 int from_tty
, struct cmd_list_element
*c
)
2127 /* We include the current directory so that if the user changes
2128 directories the file written will be the same as the one
2130 if (!history_filename_empty () && !IS_ABSOLUTE_PATH (history_filename
))
2132 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (history_filename
));
2134 xfree (history_filename
);
2135 history_filename
= temp
.release ();
2140 init_gdb_version_vars (void)
2142 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2143 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2144 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2145 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2146 set_internalvar_integer (major_version_var
, vmajor
);
2147 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2153 struct cmd_list_element
*c
;
2155 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2156 the DEFAULT_PROMPT is. */
2157 set_prompt (DEFAULT_PROMPT
);
2159 /* Set the important stuff up for command editing. */
2160 command_editing_p
= 1;
2161 history_expansion_p
= 0;
2162 write_history_p
= 0;
2164 /* Setup important stuff for command line editing. */
2165 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2166 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2167 set_rl_completer_word_break_characters (default_word_break_characters ());
2168 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2169 rl_completion_display_matches_hook
= cli_display_match_list
;
2170 rl_readline_name
= "gdb";
2171 rl_terminal_name
= getenv ("TERM");
2173 /* The name for this defun comes from Bash, where it originated.
2174 15 is Control-o, the same binding this function has in Bash. */
2175 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2177 add_setshow_string_cmd ("prompt", class_support
,
2179 _("Set gdb's prompt."),
2180 _("Show gdb's prompt."),
2183 &setlist
, &showlist
);
2185 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2186 Don't repeat this command.\nPrimarily \
2187 used inside of user-defined commands that should not be repeated when\n\
2190 add_setshow_boolean_cmd ("editing", class_support
,
2191 &set_editing_cmd_var
, _("\
2192 Set editing of command lines as they are typed."), _("\
2193 Show editing of command lines as they are typed."), _("\
2194 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2195 Without an argument, command line editing is enabled. To edit, use\n\
2196 EMACS-like or VI-like commands like control-P or ESC."),
2199 &setlist
, &showlist
);
2201 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2202 Set saving of the history record on exit."), _("\
2203 Show saving of the history record on exit."), _("\
2204 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2205 Without an argument, saving is enabled."),
2207 show_write_history_p
,
2208 &sethistlist
, &showhistlist
);
2210 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2211 &history_size_setshow_var
, _("\
2212 Set the size of the command history."), _("\
2213 Show the size of the command history."), _("\
2214 This is the number of previous commands to keep a record of.\n\
2215 If set to \"unlimited\", the number of commands kept in the history\n\
2216 list is unlimited. This defaults to the value of the environment\n\
2217 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2218 set_history_size_command
,
2220 &sethistlist
, &showhistlist
);
2222 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2223 &history_remove_duplicates
, _("\
2224 Set how far back in history to look for and remove duplicate entries."), _("\
2225 Show how far back in history to look for and remove duplicate entries."), _("\
2226 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2227 and remove the first history entry that is a duplicate of the most recent\n\
2228 entry, each time a new history entry is added.\n\
2229 If set to \"unlimited\", this lookbehind is unbounded.\n\
2230 Only history entries added during this session are considered for removal.\n\
2231 If set to 0, removal of duplicate history entries is disabled.\n\
2232 By default this option is set to 0."),
2234 show_history_remove_duplicates
,
2235 &sethistlist
, &showhistlist
);
2237 add_setshow_optional_filename_cmd ("filename", no_class
, &history_filename
, _("\
2238 Set the filename in which to record the command history."), _("\
2239 Show the filename in which to record the command history."), _("\
2240 (the list of previous commands of which a record is kept)."),
2241 set_history_filename
,
2242 show_history_filename
,
2243 &sethistlist
, &showhistlist
);
2245 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2246 Set whether to confirm potentially dangerous operations."), _("\
2247 Show whether to confirm potentially dangerous operations."), NULL
,
2250 &setlist
, &showlist
);
2252 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2253 Set annotation_level."), _("\
2254 Show annotation_level."), _("\
2255 0 == normal; 1 == fullname (for use when running under emacs)\n\
2256 2 == output annotated suitably for use by programs that control GDB."),
2258 show_annotation_level
,
2259 &setlist
, &showlist
);
2261 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2262 &exec_done_display_p
, _("\
2263 Set notification of completion for asynchronous execution commands."), _("\
2264 Show notification of completion for asynchronous execution commands."), _("\
2265 Use \"on\" to enable the notification, and \"off\" to disable it."),
2267 show_exec_done_display_p
,
2268 &setlist
, &showlist
);
2270 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2271 &staged_gdb_datadir
, _("Set GDB's data directory."),
2272 _("Show GDB's data directory."),
2274 When set, GDB uses the specified path to search for data files."),
2275 set_gdb_datadir
, show_gdb_datadir
,
2279 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2280 &interactive_mode
, _("\
2281 Set whether GDB's standard input is a terminal."), _("\
2282 Show whether GDB's standard input is a terminal."), _("\
2283 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2284 means that GDB should wait for the user to answer queries associated to\n\
2285 commands entered at the command prompt. If off, GDB assumes that standard\n\
2286 input is not a terminal, and uses the default answer to all queries.\n\
2287 If auto (the default), determine which mode to use based on the standard\n\
2290 show_interactive_mode
,
2291 &setlist
, &showlist
);
2293 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2295 Usage: new-ui INTERPRETER TTY\n\
2296 The first argument is the name of the interpreter to run.\n\
2297 The second argument is the terminal the UI runs on."), &cmdlist
);
2298 set_cmd_completer (c
, interpreter_completer
);
2302 gdb_init (char *argv0
)
2304 saved_command_line
= xstrdup ("");
2305 previous_saved_command_line
= xstrdup ("");
2307 if (pre_init_ui_hook
)
2308 pre_init_ui_hook ();
2310 /* Run the init function of each source file. */
2313 /* Make sure we return to the original directory upon exit, come
2314 what may, since the OS doesn't do that for us. */
2315 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2318 init_cmd_lists (); /* This needs to be done first. */
2322 /* Here is where we call all the _initialize_foo routines. */
2323 initialize_all_files ();
2325 /* This creates the current_program_space. Do this after all the
2326 _initialize_foo routines have had a chance to install their
2327 per-sspace data keys. Also do this before
2328 initialize_current_architecture is called, because it accesses
2329 exec_bfd of the current program space. */
2330 initialize_progspace ();
2331 initialize_inferiors ();
2332 initialize_current_architecture ();
2333 init_main (); /* But that omits this file! Do it now. */
2335 initialize_stdin_serial ();
2337 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2339 set_initial_gdb_ttystate ();
2341 async_init_signals ();
2343 /* We need a default language for parsing expressions, so simple
2344 things like "set width 0" won't fail if no language is explicitly
2345 set in a config file or implicitly set by reading an executable
2347 set_language (language_c
);
2348 expected_language
= current_language
; /* Don't warn about the change. */
2350 /* Python initialization, for example, can require various commands to be
2351 installed. For example "info pretty-printer" needs the "info"
2352 prefix to be installed. Keep things simple and just do final
2353 script initialization here. */
2354 finish_ext_lang_initialization ();
2356 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2357 init_gdb_version_vars ();