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 "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 "gdb_select.h"
55 #include "gdbsupport/scope-exit.h"
57 #include "gdbsupport/pathstuff.h"
59 /* readline include files. */
60 #include "readline/readline.h"
61 #include "readline/history.h"
63 /* readline defines this. */
66 #include <sys/types.h>
68 #include "event-top.h"
73 #include "tracepoint.h"
84 extern void initialize_all_files (void);
86 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
87 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
88 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
90 /* Default command line prompt. This is overridden in some configs. */
92 #ifndef DEFAULT_PROMPT
93 #define DEFAULT_PROMPT "(gdb) "
97 current_ui_gdb_stdout_ptr ()
99 return ¤t_ui
->m_gdb_stdout
;
103 current_ui_gdb_stdin_ptr ()
105 return ¤t_ui
->m_gdb_stdin
;
109 current_ui_gdb_stderr_ptr ()
111 return ¤t_ui
->m_gdb_stderr
;
115 current_ui_gdb_stdlog_ptr ()
117 return ¤t_ui
->m_gdb_stdlog
;
121 current_ui_current_uiout_ptr ()
123 return ¤t_ui
->m_current_uiout
;
126 int inhibit_gdbinit
= 0;
128 /* Flag for whether we want to confirm potentially dangerous
129 operations. Default is yes. */
134 show_confirm (struct ui_file
*file
, int from_tty
,
135 struct cmd_list_element
*c
, const char *value
)
137 fprintf_filtered (file
, _("Whether to confirm potentially "
138 "dangerous operations is %s.\n"),
142 /* Current working directory. */
144 char *current_directory
;
146 /* The last command line executed on the console. Used for command
147 repetitions when the user enters an empty line. */
149 static char *saved_command_line
;
151 /* If not NULL, the arguments that should be passed if
152 saved_command_line is repeated. */
154 static const char *repeat_arguments
;
156 /* The previous last command line executed on the console. Used for command
157 repetitions when a command wants to relaunch the previously launched
158 command. We need this as when a command is running, saved_command_line
159 already contains the line of the currently executing command. */
161 char *previous_saved_command_line
;
163 /* If not NULL, the arguments that should be passed if the
164 previous_saved_command_line is repeated. */
166 static const char *previous_repeat_arguments
;
168 /* Nonzero if the current command is modified by "server ". This
169 affects things like recording into the command history, commands
170 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
171 whatever) can issue its own commands and also send along commands
172 from the user, and have the user not notice that the user interface
173 is issuing commands too. */
176 /* Timeout limit for response from target. */
178 /* The default value has been changed many times over the years. It
179 was originally 5 seconds. But that was thought to be a long time
180 to sit and wait, so it was changed to 2 seconds. That was thought
181 to be plenty unless the connection was going through some terminal
182 server or multiplexer or other form of hairy serial connection.
184 In mid-1996, remote_timeout was moved from remote.c to top.c and
185 it began being used in other remote-* targets. It appears that the
186 default was changed to 20 seconds at that time, perhaps because the
187 Renesas E7000 ICE didn't always respond in a timely manner.
189 But if 5 seconds is a long time to sit and wait for retransmissions,
190 20 seconds is far worse. This demonstrates the difficulty of using
191 a single variable for all protocol timeouts.
193 As remote.c is used much more than remote-e7000.c, it was changed
194 back to 2 seconds in 1999. */
196 int remote_timeout
= 2;
198 /* Non-zero tells remote* modules to output debugging info. */
200 int remote_debug
= 0;
202 /* Sbrk location on entry to main. Used for statistics only. */
203 #ifdef HAVE_USEFUL_SBRK
207 /* Hooks for alternate command interfaces. */
209 /* This hook is called from within gdb's many mini-event loops which
210 could steal control from a real user interface's event loop. It
211 returns non-zero if the user is requesting a detach, zero
214 int (*deprecated_ui_loop_hook
) (int);
217 /* Called from print_frame_info to list the line we stopped in. */
219 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
223 /* Replaces most of query. */
225 int (*deprecated_query_hook
) (const char *, va_list);
227 /* Replaces most of warning. */
229 void (*deprecated_warning_hook
) (const char *, va_list);
231 /* These three functions support getting lines of text from the user.
232 They are used in sequence. First deprecated_readline_begin_hook is
233 called with a text string that might be (for example) a message for
234 the user to type in a sequence of commands to be executed at a
235 breakpoint. If this function calls back to a GUI, it might take
236 this opportunity to pop up a text interaction window with this
237 message. Next, deprecated_readline_hook is called with a prompt
238 that is emitted prior to collecting the user input. It can be
239 called multiple times. Finally, deprecated_readline_end_hook is
240 called to notify the GUI that we are done with the interaction
241 window and it can close it. */
243 void (*deprecated_readline_begin_hook
) (const char *, ...);
244 char *(*deprecated_readline_hook
) (const char *);
245 void (*deprecated_readline_end_hook
) (void);
247 /* Called as appropriate to notify the interface that we have attached
248 to or detached from an already running process. */
250 void (*deprecated_attach_hook
) (void);
251 void (*deprecated_detach_hook
) (void);
253 /* Called when going to wait for the target. Usually allows the GUI
254 to run while waiting for target events. */
256 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
257 struct target_waitstatus
*status
,
260 /* Used by UI as a wrapper around command execution. May do various
261 things like enabling/disabling buttons, etc... */
263 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
264 const char *cmd
, int from_tty
);
266 /* Called when the current thread changes. Argument is thread id. */
268 void (*deprecated_context_hook
) (int id
);
270 /* The highest UI number ever assigned. */
271 static int highest_ui_num
;
275 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
277 num (++highest_ui_num
),
278 call_readline (nullptr),
279 input_handler (nullptr),
281 interp_info (nullptr),
283 secondary_prompt_depth (0),
284 stdin_stream (instream_
),
285 instream (instream_
),
286 outstream (outstream_
),
287 errstream (errstream_
),
288 input_fd (fileno (instream
)),
289 input_interactive_p (ISATTY (instream
)),
290 prompt_state (PROMPT_NEEDED
),
291 m_gdb_stdout (new stdio_file (outstream
)),
292 m_gdb_stdin (new stdio_file (instream
)),
293 m_gdb_stderr (new stderr_file (errstream
)),
294 m_gdb_stdlog (m_gdb_stderr
),
295 m_current_uiout (nullptr)
297 buffer_init (&line_buffer
);
305 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
313 struct ui
*ui
, *uiprev
;
317 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
321 gdb_assert (ui
!= NULL
);
333 /* Open file named NAME for read/write, making sure not to make it the
334 controlling terminal. */
337 open_terminal_stream (const char *name
)
341 fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
343 perror_with_name (_("opening terminal failed"));
345 return gdb_file_up (fdopen (fd
, "w+"));
348 /* Implementation of the "new-ui" command. */
351 new_ui_command (const char *args
, int from_tty
)
354 const char *interpreter_name
;
355 const char *tty_name
;
359 gdb_argv
argv (args
);
360 argc
= argv
.count ();
363 error (_("Usage: new-ui INTERPRETER TTY"));
365 interpreter_name
= argv
[0];
369 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
371 /* Open specified terminal. Note: we used to open it three times,
372 once for each of stdin/stdout/stderr, but that does not work
373 with Windows named pipes. */
374 gdb_file_up stream
= open_terminal_stream (tty_name
);
376 std::unique_ptr
<ui
> ui
377 (new struct ui (stream
.get (), stream
.get (), stream
.get ()));
381 current_ui
= ui
.get ();
383 set_top_level_interpreter (interpreter_name
);
385 interp_pre_command_loop (top_level_interpreter ());
387 /* Make sure the file is not closed. */
393 printf_unfiltered ("New UI allocated\n");
396 /* Handler for SIGHUP. */
399 /* NOTE 1999-04-29: This function will be static again, once we modify
400 gdb to use the event loop as the default command loop and we merge
401 event-top.c into this file, top.c. */
405 /* Stop asking user for confirmation --- we're exiting. This
406 prevents asking the user dumb questions. */
408 quit_command ((char *) 0, 0);
410 #endif /* defined SIGHUP */
412 /* Line number we are currently in, in a file which is being sourced. */
413 /* NOTE 1999-04-29: This variable will be static again, once we modify
414 gdb to use the event loop as the default command loop and we merge
415 event-top.c into this file, top.c. */
416 /* static */ int source_line_number
;
418 /* Name of the file we are sourcing. */
419 /* NOTE 1999-04-29: This variable will be static again, once we modify
420 gdb to use the event loop as the default command loop and we merge
421 event-top.c into this file, top.c. */
422 /* static */ std::string source_file_name
;
424 /* Read commands from STREAM. */
426 read_command_file (FILE *stream
)
428 struct ui
*ui
= current_ui
;
430 scoped_restore save_instream
431 = make_scoped_restore (&ui
->instream
, stream
);
433 /* Read commands from `instream' and execute them until end of file
434 or error reading instream. */
436 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
440 /* Get a command-line. This calls the readline package. */
441 command
= command_line_input (NULL
, NULL
);
444 command_handler (command
);
448 void (*pre_init_ui_hook
) (void);
452 do_chdir_cleanup (void *old_dir
)
454 chdir ((const char *) old_dir
);
460 prepare_execute_command ()
462 /* With multiple threads running while the one we're examining is
463 stopped, the dcache can get stale without us being able to detect
464 it. For the duration of the command, though, use the dcache to
465 help things like backtrace. */
467 target_dcache_invalidate ();
469 return scoped_value_mark ();
472 /* Tell the user if the language has changed (except first time) after
473 executing a command. */
476 check_frame_language_change (void)
478 static int warned
= 0;
479 struct frame_info
*frame
;
481 /* First make sure that a new frame has been selected, in case the
482 command or the hooks changed the program state. */
483 frame
= deprecated_safe_get_selected_frame ();
484 if (current_language
!= expected_language
)
486 if (language_mode
== language_mode_auto
&& info_verbose
)
488 language_info (1); /* Print what changed. */
493 /* Warn the user if the working language does not match the language
494 of the current frame. Only warn the user if we are actually
495 running the program, i.e. there is a stack. */
496 /* FIXME: This should be cacheing the frame and only running when
497 the frame changes. */
499 if (has_stack_frames ())
503 flang
= get_frame_language (frame
);
505 && flang
!= language_unknown
506 && flang
!= current_language
->la_language
)
508 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
517 wait_sync_command_done (void)
519 /* Processing events may change the current UI. */
520 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
521 struct ui
*ui
= current_ui
;
523 while (gdb_do_one_event () >= 0)
524 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
531 maybe_wait_sync_command_done (int was_sync
)
533 /* If the interpreter is in sync mode (we're running a user
534 command's list, running command hooks or similars), and we
535 just ran a synchronous command that started the target, wait
536 for that command to end. */
537 if (!current_ui
->async
539 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
540 wait_sync_command_done ();
546 set_repeat_arguments (const char *args
)
548 repeat_arguments
= args
;
551 /* Execute the line P as a command, in the current user context.
552 Pass FROM_TTY as second argument to the defining function. */
555 execute_command (const char *p
, int from_tty
)
557 struct cmd_list_element
*c
;
559 const char *cmd_start
= p
;
561 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
562 scoped_value_mark cleanup
= prepare_execute_command ();
564 /* This can happen when command_line_input hits end of file. */
567 cleanup_if_error
.release ();
571 target_log_command (p
);
573 while (*p
== ' ' || *p
== '\t')
579 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
583 /* If trace-commands is set then this will print this command. */
584 print_command_trace ("%s", p
);
586 c
= lookup_cmd (&cmd
, cmdlist
, "", 0, 1);
589 scoped_restore save_repeat_args
590 = make_scoped_restore (&repeat_arguments
, nullptr);
591 const char *args_pointer
= p
;
593 /* Pass null arg rather than an empty one. */
596 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
597 while the is_complete_command(cfunc) test is just plain
598 bogus. They should both be replaced by a test of the form
599 c->strip_trailing_white_space_p. */
600 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
601 can't be replaced with func. This is because it is the
602 cfunc, and not the func, that has the value that the
603 is_complete_command hack is testing for. */
604 /* Clear off trailing whitespace, except for set and complete
606 std::string without_whitespace
;
608 && c
->type
!= set_cmd
609 && !is_complete_command (c
))
611 const char *old_end
= arg
+ strlen (arg
) - 1;
613 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
617 without_whitespace
= std::string (arg
, p
+ 1);
618 arg
= without_whitespace
.c_str ();
622 /* If this command has been pre-hooked, run the hook first. */
623 execute_cmd_pre_hook (c
);
625 if (c
->deprecated_warn_user
)
626 deprecated_cmd_warning (line
);
628 /* c->user_commands would be NULL in the case of a python command. */
629 if (c
->theclass
== class_user
&& c
->user_commands
)
630 execute_user_command (c
, arg
);
631 else if (c
->theclass
== class_user
632 && c
->prefixlist
&& !c
->allow_unknown
)
633 /* If this is a user defined prefix that does not allow unknown
634 (in other words, C is a prefix command and not a command
635 that can be followed by its args), report the list of
639 ("\"%.*s\" must be followed by the name of a subcommand.\n",
640 (int) strlen (c
->prefixname
) - 1, c
->prefixname
);
641 help_list (*c
->prefixlist
, c
->prefixname
, all_commands
, gdb_stdout
);
643 else if (c
->type
== set_cmd
)
644 do_set_command (arg
, from_tty
, c
);
645 else if (c
->type
== show_cmd
)
646 do_show_command (arg
, from_tty
, c
);
647 else if (!cmd_func_p (c
))
648 error (_("That is not a command, just a help topic."));
649 else if (deprecated_call_command_hook
)
650 deprecated_call_command_hook (c
, arg
, from_tty
);
652 cmd_func (c
, arg
, from_tty
);
654 maybe_wait_sync_command_done (was_sync
);
656 /* If this command has been post-hooked, run the hook last. */
657 execute_cmd_post_hook (c
);
659 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
661 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
662 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
667 /* Only perform the frame-language-change check if the command
668 we just finished executing did not resume the inferior's execution.
669 If it did resume the inferior, we will do that check after
670 the inferior stopped. */
671 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
672 check_frame_language_change ();
674 cleanup_if_error
.release ();
677 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
678 do not display it to the screen. BATCH_FLAG will be
679 temporarily set to true. */
682 execute_command_to_ui_file (struct ui_file
*file
, const char *p
, int from_tty
)
684 /* GDB_STDOUT should be better already restored during these
685 restoration callbacks. */
686 set_batch_flag_and_restore_page_info save_page_info
;
688 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
691 current_uiout
->redirect (file
);
692 ui_out_redirect_pop
redirect_popper (current_uiout
);
694 scoped_restore save_stdout
695 = make_scoped_restore (&gdb_stdout
, file
);
696 scoped_restore save_stderr
697 = make_scoped_restore (&gdb_stderr
, file
);
698 scoped_restore save_stdlog
699 = make_scoped_restore (&gdb_stdlog
, file
);
700 scoped_restore save_stdtarg
701 = make_scoped_restore (&gdb_stdtarg
, file
);
702 scoped_restore save_stdtargerr
703 = make_scoped_restore (&gdb_stdtargerr
, file
);
705 execute_command (p
, from_tty
);
709 /* Run execute_command for P and FROM_TTY. Capture its output into the
710 returned string, do not display it to the screen. BATCH_FLAG will be
711 temporarily set to true. */
714 execute_command_to_string (const char *p
, int from_tty
,
717 string_file
str_file (term_out
);
719 execute_command_to_ui_file (&str_file
, p
, from_tty
);
720 return std::move (str_file
.string ());
724 /* When nonzero, cause dont_repeat to do nothing. This should only be
725 set via prevent_dont_repeat. */
727 static int suppress_dont_repeat
= 0;
734 struct ui
*ui
= current_ui
;
736 if (suppress_dont_repeat
|| server_command
)
739 /* If we aren't reading from standard input, we are saving the last
740 thing read from stdin in line and don't want to delete it. Null
741 lines won't repeat here in any case. */
742 if (ui
->instream
== ui
->stdin_stream
)
744 *saved_command_line
= 0;
745 repeat_arguments
= NULL
;
754 /* Do not repeat this command, as this command is a repeating command. */
757 /* We cannot free saved_command_line, as this line is being executed,
758 so swap it with previous_saved_command_line. */
759 std::swap (previous_saved_command_line
, saved_command_line
);
760 std::swap (previous_repeat_arguments
, repeat_arguments
);
762 const char *prev
= skip_spaces (get_saved_command_line ());
764 error (_("No previous command to relaunch"));
770 scoped_restore_tmpl
<int>
771 prevent_dont_repeat (void)
773 return make_scoped_restore (&suppress_dont_repeat
, 1);
779 get_saved_command_line ()
781 return saved_command_line
;
787 save_command_line (const char *cmd
)
789 xfree (previous_saved_command_line
);
790 previous_saved_command_line
= saved_command_line
;
791 previous_repeat_arguments
= repeat_arguments
;
792 saved_command_line
= xstrdup (cmd
);
793 repeat_arguments
= NULL
;
797 /* Read a line from the stream "instream" without command line editing.
799 It prints PROMPT once at the start.
800 Action is compatible with "readline", e.g. space for the result is
801 malloc'd and should be freed by the caller.
803 A NULL return means end of file. */
806 gdb_readline_no_editing (const char *prompt
)
808 struct buffer line_buffer
;
809 struct ui
*ui
= current_ui
;
810 /* Read from stdin if we are executing a user defined command. This
811 is the right thing for prompt_for_continue, at least. */
812 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
813 int fd
= fileno (stream
);
815 buffer_init (&line_buffer
);
819 /* Don't use a _filtered function here. It causes the assumed
820 character position to be off, since the newline we read from
821 the user is not accounted for. */
822 fputs_unfiltered (prompt
, gdb_stdout
);
823 gdb_flush (gdb_stdout
);
833 /* Wait until at least one byte of data is available. Control-C
834 can interrupt interruptible_select, but not fgetc. */
836 FD_SET (fd
, &readfds
);
837 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
841 /* If this was ctrl-c, the QUIT above handles it. */
844 perror_with_name (("select"));
851 if (line_buffer
.used_size
> 0)
852 /* The last line does not end with a newline. Return it, and
853 if we are called again fgetc will still return EOF and
854 we'll return NULL then. */
856 xfree (buffer_finish (&line_buffer
));
862 if (line_buffer
.used_size
> 0
863 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
864 line_buffer
.used_size
--;
868 buffer_grow_char (&line_buffer
, c
);
871 buffer_grow_char (&line_buffer
, '\0');
872 return buffer_finish (&line_buffer
);
875 /* Variables which control command line editing and history
876 substitution. These variables are given default values at the end
878 static bool command_editing_p
;
880 /* NOTE 1999-04-29: This variable will be static again, once we modify
881 gdb to use the event loop as the default command loop and we merge
882 event-top.c into this file, top.c. */
884 /* static */ bool history_expansion_p
;
886 static bool write_history_p
;
888 show_write_history_p (struct ui_file
*file
, int from_tty
,
889 struct cmd_list_element
*c
, const char *value
)
891 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
895 /* The variable associated with the "set/show history size"
896 command. The value -1 means unlimited, and -2 means undefined. */
897 static int history_size_setshow_var
= -2;
900 show_history_size (struct ui_file
*file
, int from_tty
,
901 struct cmd_list_element
*c
, const char *value
)
903 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
907 /* Variable associated with the "history remove-duplicates" option.
908 The value -1 means unlimited. */
909 static int history_remove_duplicates
= 0;
912 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
913 struct cmd_list_element
*c
, const char *value
)
915 fprintf_filtered (file
,
916 _("The number of history entries to look back at for "
917 "duplicates is %s.\n"),
921 static char *history_filename
;
923 show_history_filename (struct ui_file
*file
, int from_tty
,
924 struct cmd_list_element
*c
, const char *value
)
926 fprintf_filtered (file
, _("The filename in which to record "
927 "the command history is \"%s\".\n"),
931 /* This is like readline(), but it has some gdb-specific behavior.
932 gdb may want readline in both the synchronous and async modes during
933 a single gdb invocation. At the ordinary top-level prompt we might
934 be using the async readline. That means we can't use
935 rl_pre_input_hook, since it doesn't work properly in async mode.
936 However, for a secondary prompt (" >", such as occurs during a
937 `define'), gdb wants a synchronous response.
939 We used to call readline() directly, running it in synchronous
940 mode. But mixing modes this way is not supported, and as of
941 readline 5.x it no longer works; the arrow keys come unbound during
942 the synchronous call. So we make a nested call into the event
943 loop. That's what gdb_readline_wrapper is for. */
945 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
946 rely on gdb_readline_wrapper_result, which might still be NULL if
947 the user types Control-D for EOF. */
948 static int gdb_readline_wrapper_done
;
950 /* The result of the current call to gdb_readline_wrapper, once a newline
952 static char *gdb_readline_wrapper_result
;
954 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
955 to be called after the newline is processed (which will redisplay
956 the prompt). But in gdb_readline_wrapper we will not get a new
957 prompt until the next call, or until we return to the event loop.
958 So we disable this hook around the newline and restore it before we
960 static void (*saved_after_char_processing_hook
) (void);
966 gdb_in_secondary_prompt_p (struct ui
*ui
)
968 return ui
->secondary_prompt_depth
> 0;
972 /* This function is called when readline has seen a complete line of
976 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
978 gdb_assert (!gdb_readline_wrapper_done
);
979 gdb_readline_wrapper_result
= line
.release ();
980 gdb_readline_wrapper_done
= 1;
982 /* Prevent operate-and-get-next from acting too early. */
983 saved_after_char_processing_hook
= after_char_processing_hook
;
984 after_char_processing_hook
= NULL
;
986 /* Prevent parts of the prompt from being redisplayed if annotations
987 are enabled, and readline's state getting out of sync. We'll
988 reinstall the callback handler, which puts the terminal in raw
989 mode (or in readline lingo, in prepped state), when we're next
990 ready to process user input, either in display_gdb_prompt, or if
991 we're handling an asynchronous target event and running in the
992 background, just before returning to the event loop to process
993 further input (or more target events). */
994 if (current_ui
->command_editing
)
995 gdb_rl_callback_handler_remove ();
998 class gdb_readline_wrapper_cleanup
1001 gdb_readline_wrapper_cleanup ()
1002 : m_handler_orig (current_ui
->input_handler
),
1003 m_already_prompted_orig (current_ui
->command_editing
1004 ? rl_already_prompted
: 0),
1005 m_target_is_async_orig (target_is_async_p ()),
1006 m_save_ui (¤t_ui
)
1008 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1009 current_ui
->secondary_prompt_depth
++;
1011 if (m_target_is_async_orig
)
1015 ~gdb_readline_wrapper_cleanup ()
1017 struct ui
*ui
= current_ui
;
1019 if (ui
->command_editing
)
1020 rl_already_prompted
= m_already_prompted_orig
;
1022 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1023 ui
->input_handler
= m_handler_orig
;
1025 /* Don't restore our input handler in readline yet. That would make
1026 readline prep the terminal (putting it in raw mode), while the
1027 line we just read may trigger execution of a command that expects
1028 the terminal in the default cooked/canonical mode, such as e.g.,
1029 running Python's interactive online help utility. See
1030 gdb_readline_wrapper_line for when we'll reinstall it. */
1032 gdb_readline_wrapper_result
= NULL
;
1033 gdb_readline_wrapper_done
= 0;
1034 ui
->secondary_prompt_depth
--;
1035 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1037 after_char_processing_hook
= saved_after_char_processing_hook
;
1038 saved_after_char_processing_hook
= NULL
;
1040 if (m_target_is_async_orig
)
1044 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1048 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1049 int m_already_prompted_orig
;
1051 /* Whether the target was async. */
1052 int m_target_is_async_orig
;
1054 /* Processing events may change the current UI. */
1055 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1059 gdb_readline_wrapper (const char *prompt
)
1061 struct ui
*ui
= current_ui
;
1063 gdb_readline_wrapper_cleanup cleanup
;
1065 /* Display our prompt and prevent double prompt display. Don't pass
1066 down a NULL prompt, since that has special meaning for
1067 display_gdb_prompt -- it indicates a request to print the primary
1068 prompt, while we want a secondary prompt here. */
1069 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1070 if (ui
->command_editing
)
1071 rl_already_prompted
= 1;
1073 if (after_char_processing_hook
)
1074 (*after_char_processing_hook
) ();
1075 gdb_assert (after_char_processing_hook
== NULL
);
1077 while (gdb_do_one_event () >= 0)
1078 if (gdb_readline_wrapper_done
)
1081 return gdb_readline_wrapper_result
;
1085 /* The current saved history number from operate-and-get-next.
1086 This is -1 if not valid. */
1087 static int operate_saved_history
= -1;
1089 /* This is put on the appropriate hook and helps operate-and-get-next
1092 gdb_rl_operate_and_get_next_completion (void)
1094 int delta
= where_history () - operate_saved_history
;
1096 /* The `key' argument to rl_get_previous_history is ignored. */
1097 rl_get_previous_history (delta
, 0);
1098 operate_saved_history
= -1;
1100 /* readline doesn't automatically update the display for us. */
1103 after_char_processing_hook
= NULL
;
1104 rl_pre_input_hook
= NULL
;
1107 /* This is a gdb-local readline command handler. It accepts the
1108 current command line (like RET does) and, if this command was taken
1109 from the history, arranges for the next command in the history to
1110 appear on the command line when the prompt returns.
1111 We ignore the arguments. */
1113 gdb_rl_operate_and_get_next (int count
, int key
)
1117 /* Use the async hook. */
1118 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1120 /* Find the current line, and find the next line to use. */
1121 where
= where_history();
1123 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1124 || (where
>= history_length
- 1))
1125 operate_saved_history
= where
;
1127 operate_saved_history
= where
+ 1;
1129 return rl_newline (1, key
);
1132 /* Number of user commands executed during this session. */
1134 static int command_count
= 0;
1136 /* Add the user command COMMAND to the input history list. */
1139 gdb_add_history (const char *command
)
1143 if (history_remove_duplicates
!= 0)
1146 int lookbehind_threshold
;
1148 /* The lookbehind threshold for finding a duplicate history entry is
1149 bounded by command_count because we can't meaningfully delete
1150 history entries that are already stored in the history file since
1151 the history file is appended to. */
1152 if (history_remove_duplicates
== -1
1153 || history_remove_duplicates
> command_count
)
1154 lookbehind_threshold
= command_count
;
1156 lookbehind_threshold
= history_remove_duplicates
;
1159 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1161 HIST_ENTRY
*temp
= previous_history ();
1166 if (strcmp (temp
->line
, command
) == 0)
1168 HIST_ENTRY
*prev
= remove_history (where_history ());
1170 free_history_entry (prev
);
1177 add_history (command
);
1180 /* Safely append new history entries to the history file in a corruption-free
1181 way using an intermediate local history file. */
1184 gdb_safe_append_history (void)
1186 int ret
, saved_errno
;
1188 std::string local_history_filename
1189 = string_printf ("%s-gdb%ld~", history_filename
, (long) getpid ());
1191 ret
= rename (history_filename
, local_history_filename
.c_str ());
1192 saved_errno
= errno
;
1193 if (ret
< 0 && saved_errno
!= ENOENT
)
1195 warning (_("Could not rename %s to %s: %s"),
1196 history_filename
, local_history_filename
.c_str (),
1197 safe_strerror (saved_errno
));
1203 /* If the rename failed with ENOENT then either the global history
1204 file never existed in the first place or another GDB process is
1205 currently appending to it (and has thus temporarily renamed it).
1206 Since we can't distinguish between these two cases, we have to
1207 conservatively assume the first case and therefore must write out
1208 (not append) our known history to our local history file and try
1209 to move it back anyway. Otherwise a global history file would
1210 never get created! */
1211 gdb_assert (saved_errno
== ENOENT
);
1212 write_history (local_history_filename
.c_str ());
1216 append_history (command_count
, local_history_filename
.c_str ());
1217 if (history_is_stifled ())
1218 history_truncate_file (local_history_filename
.c_str (),
1219 history_max_entries
);
1222 ret
= rename (local_history_filename
.c_str (), history_filename
);
1223 saved_errno
= errno
;
1224 if (ret
< 0 && saved_errno
!= EEXIST
)
1225 warning (_("Could not rename %s to %s: %s"),
1226 local_history_filename
.c_str (), history_filename
,
1227 safe_strerror (saved_errno
));
1231 /* Read one line from the command input stream `instream' into a local
1232 static buffer. The buffer is made bigger as necessary. Returns
1233 the address of the start of the line.
1235 NULL is returned for end of file.
1237 This routine either uses fancy command line editing or simple input
1238 as the user has requested. */
1241 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1243 static struct buffer cmd_line_buffer
;
1244 static int cmd_line_buffer_initialized
;
1245 struct ui
*ui
= current_ui
;
1246 const char *prompt
= prompt_arg
;
1248 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1250 /* The annotation suffix must be non-NULL. */
1251 if (annotation_suffix
== NULL
)
1252 annotation_suffix
= "";
1254 if (from_tty
&& annotation_level
> 1)
1259 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1260 + strlen (annotation_suffix
) + 40);
1262 local_prompt
[0] = '\0';
1264 strcpy (local_prompt
, prompt
);
1265 strcat (local_prompt
, "\n\032\032");
1266 strcat (local_prompt
, annotation_suffix
);
1267 strcat (local_prompt
, "\n");
1269 prompt
= local_prompt
;
1272 if (!cmd_line_buffer_initialized
)
1274 buffer_init (&cmd_line_buffer
);
1275 cmd_line_buffer_initialized
= 1;
1278 /* Starting a new command line. */
1279 cmd_line_buffer
.used_size
= 0;
1283 signal (SIGTSTP
, handle_sigtstp
);
1288 gdb::unique_xmalloc_ptr
<char> rl
;
1290 /* Make sure that all output has been output. Some machines may
1291 let you get away with leaving out some of the gdb_flush, but
1294 gdb_flush (gdb_stdout
);
1295 gdb_flush (gdb_stderr
);
1297 if (!source_file_name
.empty ())
1298 ++source_line_number
;
1300 if (from_tty
&& annotation_level
> 1)
1302 puts_unfiltered ("\n\032\032pre-");
1303 puts_unfiltered (annotation_suffix
);
1304 puts_unfiltered ("\n");
1307 /* Don't use fancy stuff if not talking to stdin. */
1308 if (deprecated_readline_hook
1310 && input_interactive_p (current_ui
))
1312 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1314 else if (command_editing_p
1316 && input_interactive_p (current_ui
))
1318 rl
.reset (gdb_readline_wrapper (prompt
));
1322 rl
.reset (gdb_readline_no_editing (prompt
));
1325 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1326 0, annotation_suffix
);
1327 if (cmd
== (char *) EOF
)
1335 /* Got partial input. I.e., got a line that ends with a
1336 continuation character (backslash). Suppress printing the
1343 signal (SIGTSTP
, SIG_DFL
);
1351 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1353 /* From GNU coding standards, first line is meant to be easy for a
1354 program to parse, and is just canonical program name and version
1355 number, which starts after last space. */
1357 ui_file_style style
;
1360 ui_file_style nstyle
= { ui_file_style::MAGENTA
, ui_file_style::NONE
,
1361 ui_file_style::BOLD
};
1364 fprintf_styled (stream
, style
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1366 /* Second line is a copyright notice. */
1368 fprintf_filtered (stream
,
1369 "Copyright (C) 2020 Free Software Foundation, Inc.\n");
1371 /* Following the copyright is a brief statement that the program is
1372 free software, that users are free to copy and change it on
1373 certain conditions, that it is covered by the GNU GPL, and that
1374 there is no warranty. */
1376 fprintf_filtered (stream
, "\
1377 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1378 \nThis is free software: you are free to change and redistribute it.\n\
1379 There is NO WARRANTY, to the extent permitted by law.");
1384 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1385 "\"show warranty\" for details.\n"));
1387 /* After the required info we print the configuration information. */
1389 fprintf_filtered (stream
, "This GDB was configured as \"");
1390 if (strcmp (host_name
, target_name
) != 0)
1392 fprintf_filtered (stream
, "--host=%s --target=%s",
1393 host_name
, target_name
);
1397 fprintf_filtered (stream
, "%s", host_name
);
1399 fprintf_filtered (stream
, "\".\n");
1401 fprintf_filtered (stream
, _("Type \"show configuration\" "
1402 "for configuration details.\n"));
1404 if (REPORT_BUGS_TO
[0])
1406 fprintf_filtered (stream
,
1407 _("For bug reporting instructions, please see:\n"));
1408 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1410 fprintf_filtered (stream
,
1411 _("Find the GDB manual and other documentation \
1412 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1413 fprintf_filtered (stream
, "\n\n");
1414 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1415 fprintf_filtered (stream
,
1416 _("Type \"apropos word\" to search for commands \
1417 related to \"word\"."));
1420 /* Print the details of GDB build-time configuration. */
1422 print_gdb_configuration (struct ui_file
*stream
)
1424 fprintf_filtered (stream
, _("\
1425 This GDB was configured as follows:\n\
1426 configure --host=%s --target=%s\n\
1427 "), host_name
, target_name
);
1429 fprintf_filtered (stream
, _("\
1430 --with-auto-load-dir=%s\n\
1431 --with-auto-load-safe-path=%s\n\
1432 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1435 fprintf_filtered (stream
, _("\
1439 fprintf_filtered (stream
, _("\
1445 fprintf_filtered (stream
, _("\
1446 --with-gdb-datadir=%s%s\n\
1447 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1450 fprintf_filtered (stream
, _("\
1451 --with-iconv-bin=%s%s\n\
1452 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1455 if (JIT_READER_DIR
[0])
1456 fprintf_filtered (stream
, _("\
1457 --with-jit-reader-dir=%s%s\n\
1458 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1460 #if HAVE_LIBUNWIND_IA64_H
1461 fprintf_filtered (stream
, _("\
1462 --with-libunwind-ia64\n\
1465 fprintf_filtered (stream
, _("\
1466 --without-libunwind-ia64\n\
1471 fprintf_filtered (stream
, _("\
1475 fprintf_filtered (stream
, _("\
1480 #if HAVE_LIBBABELTRACE
1481 fprintf_filtered (stream
, _("\
1482 --with-babeltrace\n\
1485 fprintf_filtered (stream
, _("\
1486 --without-babeltrace\n\
1491 fprintf_filtered (stream
, _("\
1495 fprintf_filtered (stream
, _("\
1496 --without-intel-pt\n\
1501 fprintf_filtered (stream
, _("\
1505 fprintf_filtered (stream
, _("\
1510 fprintf_filtered (stream
, _("\
1514 fprintf_filtered (stream
, _("\
1518 #ifdef WITH_PYTHON_PATH
1519 fprintf_filtered (stream
, _("\
1520 --with-python=%s%s\n\
1521 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1523 fprintf_filtered (stream
, _("\
1529 fprintf_filtered (stream
, _("\
1533 fprintf_filtered (stream
, _("\
1538 #if HAVE_SOURCE_HIGHLIGHT
1539 fprintf_filtered (stream
, _("\
1540 --enable-source-highlight\n\
1543 fprintf_filtered (stream
, _("\
1544 --disable-source-highlight\n\
1549 fprintf_filtered (stream
, _("\
1550 --with-relocated-sources=%s\n\
1555 fprintf_filtered (stream
, _("\
1556 --with-separate-debug-dir=%s%s\n\
1557 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1559 if (TARGET_SYSTEM_ROOT
[0])
1560 fprintf_filtered (stream
, _("\
1561 --with-sysroot=%s%s\n\
1562 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1564 if (SYSTEM_GDBINIT
[0])
1565 fprintf_filtered (stream
, _("\
1566 --with-system-gdbinit=%s%s\n\
1567 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1569 if (SYSTEM_GDBINIT_DIR
[0])
1570 fprintf_filtered (stream
, _("\
1571 --with-system-gdbinit-dir=%s%s\n\
1572 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1574 /* We assume "relocatable" will be printed at least once, thus we always
1575 print this text. It's a reasonably safe assumption for now. */
1576 fprintf_filtered (stream
, _("\n\
1577 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1578 tree, and GDB will still find it.)\n\
1583 /* The current top level prompt, settable with "set prompt", and/or
1584 with the python `gdb.prompt_hook' hook. */
1585 static char *top_prompt
;
1587 /* Access method for the GDB prompt string. */
1595 /* Set method for the GDB prompt string. */
1598 set_prompt (const char *s
)
1600 char *p
= xstrdup (s
);
1612 /* Callback for iterate_over_inferiors. Kills or detaches the given
1613 inferior, depending on how we originally gained control of it. */
1616 kill_or_detach (struct inferior
*inf
, void *args
)
1618 struct qt_args
*qt
= (struct qt_args
*) args
;
1623 thread_info
*thread
= any_thread_of_inferior (inf
);
1626 switch_to_thread (thread
);
1628 /* Leave core files alone. */
1629 if (target_has_execution
)
1631 if (inf
->attach_flag
)
1632 target_detach (inf
, qt
->from_tty
);
1641 /* Callback for iterate_over_inferiors. Prints info about what GDB
1642 will do to each inferior on a "quit". ARG points to a struct
1643 ui_out where output is to be collected. */
1646 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1648 struct ui_file
*stb
= (struct ui_file
*) arg
;
1653 if (inf
->attach_flag
)
1654 fprintf_filtered (stb
,
1655 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1656 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1658 fprintf_filtered (stb
,
1659 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1660 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1665 /* If necessary, make the user confirm that we should quit. Return
1666 non-zero if we should quit, zero if we shouldn't. */
1671 /* Don't even ask if we're only debugging a core file inferior. */
1672 if (!have_live_inferiors ())
1675 /* Build the query string as a single string. */
1678 stb
.puts (_("A debugging session is active.\n\n"));
1679 iterate_over_inferiors (print_inferior_quit_action
, &stb
);
1680 stb
.puts (_("\nQuit anyway? "));
1682 return query ("%s", stb
.c_str ());
1685 /* Prepare to exit GDB cleanly by undoing any changes made to the
1686 terminal so that we leave the terminal in the state we acquired it. */
1689 undo_terminal_modifications_before_exit (void)
1691 struct ui
*saved_top_level
= current_ui
;
1693 target_terminal::ours ();
1695 current_ui
= main_ui
;
1700 gdb_disable_readline ();
1702 current_ui
= saved_top_level
;
1706 /* Quit without asking for confirmation. */
1709 quit_force (int *exit_arg
, int from_tty
)
1714 undo_terminal_modifications_before_exit ();
1716 /* An optional expression may be used to cause gdb to terminate with the
1717 value of that expression. */
1719 exit_code
= *exit_arg
;
1720 else if (return_child_result
)
1721 exit_code
= return_child_result_value
;
1723 qt
.from_tty
= from_tty
;
1725 /* We want to handle any quit errors and exit regardless. */
1727 /* Get out of tfind mode, and kill or detach all inferiors. */
1730 disconnect_tracing ();
1731 iterate_over_inferiors (kill_or_detach
, &qt
);
1733 catch (const gdb_exception
&ex
)
1735 exception_print (gdb_stderr
, ex
);
1738 /* Give all pushed targets a chance to do minimal cleanup, and pop
1744 catch (const gdb_exception
&ex
)
1746 exception_print (gdb_stderr
, ex
);
1749 /* Save the history information if it is appropriate to do so. */
1752 if (write_history_p
&& history_filename
)
1757 /* History is currently shared between all UIs. If there's
1758 any UI with a terminal, save history. */
1761 if (input_interactive_p (ui
))
1769 gdb_safe_append_history ();
1772 catch (const gdb_exception
&ex
)
1774 exception_print (gdb_stderr
, ex
);
1777 /* Destroy any values currently allocated now instead of leaving it
1778 to global destructors, because that may be too late. For
1779 example, the destructors of xmethod values call into the Python
1780 runtime, which is finalized via a final cleanup. */
1783 /* Do any final cleanups before exiting. */
1786 do_final_cleanups ();
1788 catch (const gdb_exception
&ex
)
1790 exception_print (gdb_stderr
, ex
);
1796 /* The value of the "interactive-mode" setting. */
1797 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1799 /* Implement the "show interactive-mode" option. */
1802 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1803 struct cmd_list_element
*c
,
1806 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1807 fprintf_filtered (file
, "Debugger's interactive mode "
1808 "is %s (currently %s).\n",
1809 value
, input_interactive_p (current_ui
) ? "on" : "off");
1811 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1814 /* Returns whether GDB is running on an interactive terminal. */
1817 input_interactive_p (struct ui
*ui
)
1822 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1823 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1825 return ui
->input_interactive_p
;
1829 dont_repeat_command (const char *ignored
, int from_tty
)
1831 /* Can't call dont_repeat here because we're not necessarily reading
1833 *saved_command_line
= 0;
1836 /* Functions to manipulate command line editing control variables. */
1838 /* Number of commands to print in each call to show_commands. */
1839 #define Hist_print 10
1841 show_commands (const char *args
, int from_tty
)
1843 /* Index for history commands. Relative to history_base. */
1846 /* Number of the history entry which we are planning to display next.
1847 Relative to history_base. */
1850 /* Print out some of the commands from the command history. */
1854 if (args
[0] == '+' && args
[1] == '\0')
1855 /* "info editing +" should print from the stored position. */
1858 /* "info editing <exp>" should print around command number <exp>. */
1859 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1861 /* "show commands" means print the last Hist_print commands. */
1864 num
= history_length
- Hist_print
;
1870 /* If there are at least Hist_print commands, we want to display the last
1871 Hist_print rather than, say, the last 6. */
1872 if (history_length
- num
< Hist_print
)
1874 num
= history_length
- Hist_print
;
1880 offset
< num
+ Hist_print
&& offset
< history_length
;
1883 printf_filtered ("%5d %s\n", history_base
+ offset
,
1884 (history_get (history_base
+ offset
))->line
);
1887 /* The next command we want to display is the next one that we haven't
1891 /* If the user repeats this command with return, it should do what
1892 "show commands +" does. This is unnecessary if arg is null,
1893 because "show commands +" is not useful after "show commands". */
1894 if (from_tty
&& args
)
1895 set_repeat_arguments ("+");
1898 /* Update the size of our command history file to HISTORY_SIZE.
1900 A HISTORY_SIZE of -1 stands for unlimited. */
1903 set_readline_history_size (int history_size
)
1905 gdb_assert (history_size
>= -1);
1907 if (history_size
== -1)
1908 unstifle_history ();
1910 stifle_history (history_size
);
1913 /* Called by do_setshow_command. */
1915 set_history_size_command (const char *args
,
1916 int from_tty
, struct cmd_list_element
*c
)
1918 set_readline_history_size (history_size_setshow_var
);
1922 set_history (const char *args
, int from_tty
)
1924 printf_unfiltered (_("\"set history\" must be followed "
1925 "by the name of a history subcommand.\n"));
1926 help_list (sethistlist
, "set history ", all_commands
, gdb_stdout
);
1930 show_history (const char *args
, int from_tty
)
1932 cmd_show_list (showhistlist
, from_tty
, "");
1935 bool info_verbose
= false; /* Default verbose msgs off. */
1937 /* Called by do_set_command. An elaborate joke. */
1939 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1941 const char *cmdname
= "verbose";
1942 struct cmd_list_element
*showcmd
;
1944 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1945 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1947 if (c
->doc
&& c
->doc_allocated
)
1948 xfree ((char *) c
->doc
);
1949 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1950 xfree ((char *) showcmd
->doc
);
1953 c
->doc
= _("Set verbose printing of informational messages.");
1954 showcmd
->doc
= _("Show verbose printing of informational messages.");
1958 c
->doc
= _("Set verbosity.");
1959 showcmd
->doc
= _("Show verbosity.");
1961 c
->doc_allocated
= 0;
1962 showcmd
->doc_allocated
= 0;
1965 /* Init the history buffer. Note that we are called after the init file(s)
1966 have been read so that the user can change the history file via his
1967 .gdbinit file (for instance). The GDBHISTFILE environment variable
1968 overrides all of this. */
1975 tmpenv
= getenv ("GDBHISTSIZE");
1982 tmpenv
= skip_spaces (tmpenv
);
1984 var
= strtol (tmpenv
, &endptr
, 10);
1985 saved_errno
= errno
;
1986 endptr
= skip_spaces (endptr
);
1988 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1989 empty string, a negative number or a huge positive number (larger than
1990 INT_MAX) then set the history size to unlimited. Otherwise set our
1991 history size to the number we have read. This behavior is consistent
1992 with how bash handles HISTSIZE. */
1993 if (*endptr
!= '\0')
1995 else if (*tmpenv
== '\0'
1998 /* On targets where INT_MAX == LONG_MAX, we have to look at
1999 errno after calling strtol to distinguish between a value that
2000 is exactly INT_MAX and an overflowing value that was clamped
2002 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
2003 history_size_setshow_var
= -1;
2005 history_size_setshow_var
= var
;
2008 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
2010 if (history_size_setshow_var
== -2)
2011 history_size_setshow_var
= 256;
2013 set_readline_history_size (history_size_setshow_var
);
2015 tmpenv
= getenv ("GDBHISTFILE");
2017 history_filename
= xstrdup (tmpenv
);
2018 else if (!history_filename
)
2020 /* We include the current directory so that if the user changes
2021 directories the file written will be the same as the one
2024 /* No leading dots in file names are allowed on MSDOS. */
2025 const char *fname
= "_gdb_history";
2027 const char *fname
= ".gdb_history";
2030 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (fname
));
2031 history_filename
= temp
.release ();
2033 read_history (history_filename
);
2037 show_prompt (struct ui_file
*file
, int from_tty
,
2038 struct cmd_list_element
*c
, const char *value
)
2040 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2043 /* "set editing" command. */
2046 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2048 change_line_handler (set_editing_cmd_var
);
2049 /* Update the control variable so that MI's =cmd-param-changed event
2050 shows the correct value. */
2051 set_editing_cmd_var
= current_ui
->command_editing
;
2055 show_editing (struct ui_file
*file
, int from_tty
,
2056 struct cmd_list_element
*c
, const char *value
)
2058 fprintf_filtered (file
, _("Editing of command lines as "
2059 "they are typed is %s.\n"),
2060 current_ui
->command_editing
? _("on") : _("off"));
2064 show_annotation_level (struct ui_file
*file
, int from_tty
,
2065 struct cmd_list_element
*c
, const char *value
)
2067 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2071 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2072 struct cmd_list_element
*c
, const char *value
)
2074 fprintf_filtered (file
, _("Notification of completion for "
2075 "asynchronous execution commands is %s.\n"),
2079 /* New values of the "data-directory" parameter are staged here. */
2080 static char *staged_gdb_datadir
;
2082 /* "set" command for the gdb_datadir configuration variable. */
2085 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2087 set_gdb_data_directory (staged_gdb_datadir
);
2088 gdb::observers::gdb_datadir_changed
.notify ();
2091 /* "show" command for the gdb_datadir configuration variable. */
2094 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2095 struct cmd_list_element
*c
, const char *value
)
2097 fprintf_filtered (file
, _("GDB's data directory is \"%s\".\n"),
2098 gdb_datadir
.c_str ());
2102 set_history_filename (const char *args
,
2103 int from_tty
, struct cmd_list_element
*c
)
2105 /* We include the current directory so that if the user changes
2106 directories the file written will be the same as the one
2108 if (!IS_ABSOLUTE_PATH (history_filename
))
2110 gdb::unique_xmalloc_ptr
<char> temp (gdb_abspath (history_filename
));
2112 xfree (history_filename
);
2113 history_filename
= temp
.release ();
2118 init_gdb_version_vars (void)
2120 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2121 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2122 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2123 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2124 set_internalvar_integer (major_version_var
, vmajor
);
2125 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2131 struct cmd_list_element
*c
;
2133 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2134 the DEFAULT_PROMPT is. */
2135 set_prompt (DEFAULT_PROMPT
);
2137 /* Set the important stuff up for command editing. */
2138 command_editing_p
= 1;
2139 history_expansion_p
= 0;
2140 write_history_p
= 0;
2142 /* Setup important stuff for command line editing. */
2143 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2144 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2145 set_rl_completer_word_break_characters (default_word_break_characters ());
2146 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2147 rl_completion_display_matches_hook
= cli_display_match_list
;
2148 rl_readline_name
= "gdb";
2149 rl_terminal_name
= getenv ("TERM");
2151 /* The name for this defun comes from Bash, where it originated.
2152 15 is Control-o, the same binding this function has in Bash. */
2153 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2155 add_setshow_string_cmd ("prompt", class_support
,
2157 _("Set gdb's prompt."),
2158 _("Show gdb's prompt."),
2161 &setlist
, &showlist
);
2163 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2164 Don't repeat this command.\nPrimarily \
2165 used inside of user-defined commands that should not be repeated when\n\
2168 add_setshow_boolean_cmd ("editing", class_support
,
2169 &set_editing_cmd_var
, _("\
2170 Set editing of command lines as they are typed."), _("\
2171 Show editing of command lines as they are typed."), _("\
2172 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2173 Without an argument, command line editing is enabled. To edit, use\n\
2174 EMACS-like or VI-like commands like control-P or ESC."),
2177 &setlist
, &showlist
);
2179 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2180 Set saving of the history record on exit."), _("\
2181 Show saving of the history record on exit."), _("\
2182 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2183 Without an argument, saving is enabled."),
2185 show_write_history_p
,
2186 &sethistlist
, &showhistlist
);
2188 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2189 &history_size_setshow_var
, _("\
2190 Set the size of the command history."), _("\
2191 Show the size of the command history."), _("\
2192 This is the number of previous commands to keep a record of.\n\
2193 If set to \"unlimited\", the number of commands kept in the history\n\
2194 list is unlimited. This defaults to the value of the environment\n\
2195 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2196 set_history_size_command
,
2198 &sethistlist
, &showhistlist
);
2200 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2201 &history_remove_duplicates
, _("\
2202 Set how far back in history to look for and remove duplicate entries."), _("\
2203 Show how far back in history to look for and remove duplicate entries."), _("\
2204 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2205 and remove the first history entry that is a duplicate of the most recent\n\
2206 entry, each time a new history entry is added.\n\
2207 If set to \"unlimited\", this lookbehind is unbounded.\n\
2208 Only history entries added during this session are considered for removal.\n\
2209 If set to 0, removal of duplicate history entries is disabled.\n\
2210 By default this option is set to 0."),
2212 show_history_remove_duplicates
,
2213 &sethistlist
, &showhistlist
);
2215 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
2216 Set the filename in which to record the command history."), _("\
2217 Show the filename in which to record the command history."), _("\
2218 (the list of previous commands of which a record is kept)."),
2219 set_history_filename
,
2220 show_history_filename
,
2221 &sethistlist
, &showhistlist
);
2223 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2224 Set whether to confirm potentially dangerous operations."), _("\
2225 Show whether to confirm potentially dangerous operations."), NULL
,
2228 &setlist
, &showlist
);
2230 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2231 Set annotation_level."), _("\
2232 Show annotation_level."), _("\
2233 0 == normal; 1 == fullname (for use when running under emacs)\n\
2234 2 == output annotated suitably for use by programs that control GDB."),
2236 show_annotation_level
,
2237 &setlist
, &showlist
);
2239 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2240 &exec_done_display_p
, _("\
2241 Set notification of completion for asynchronous execution commands."), _("\
2242 Show notification of completion for asynchronous execution commands."), _("\
2243 Use \"on\" to enable the notification, and \"off\" to disable it."),
2245 show_exec_done_display_p
,
2246 &setlist
, &showlist
);
2248 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2249 &staged_gdb_datadir
, _("Set GDB's data directory."),
2250 _("Show GDB's data directory."),
2252 When set, GDB uses the specified path to search for data files."),
2253 set_gdb_datadir
, show_gdb_datadir
,
2257 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2258 &interactive_mode
, _("\
2259 Set whether GDB's standard input is a terminal."), _("\
2260 Show whether GDB's standard input is a terminal."), _("\
2261 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2262 means that GDB should wait for the user to answer queries associated to\n\
2263 commands entered at the command prompt. If off, GDB assumes that standard\n\
2264 input is not a terminal, and uses the default answer to all queries.\n\
2265 If auto (the default), determine which mode to use based on the standard\n\
2268 show_interactive_mode
,
2269 &setlist
, &showlist
);
2271 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2273 Usage: new-ui INTERPRETER TTY\n\
2274 The first argument is the name of the interpreter to run.\n\
2275 The second argument is the terminal the UI runs on."), &cmdlist
);
2276 set_cmd_completer (c
, interpreter_completer
);
2280 gdb_init (char *argv0
)
2282 saved_command_line
= xstrdup ("");
2283 previous_saved_command_line
= xstrdup ("");
2285 if (pre_init_ui_hook
)
2286 pre_init_ui_hook ();
2288 /* Run the init function of each source file. */
2291 /* Make sure we return to the original directory upon exit, come
2292 what may, since the OS doesn't do that for us. */
2293 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2296 init_cmd_lists (); /* This needs to be done first. */
2297 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2301 /* Here is where we call all the _initialize_foo routines. */
2302 initialize_all_files ();
2304 /* This creates the current_program_space. Do this after all the
2305 _initialize_foo routines have had a chance to install their
2306 per-sspace data keys. Also do this before
2307 initialize_current_architecture is called, because it accesses
2308 exec_bfd of the current program space. */
2309 initialize_progspace ();
2310 initialize_inferiors ();
2311 initialize_current_architecture ();
2312 init_main (); /* But that omits this file! Do it now. */
2314 initialize_stdin_serial ();
2316 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2318 set_initial_gdb_ttystate ();
2320 async_init_signals ();
2322 /* We need a default language for parsing expressions, so simple
2323 things like "set width 0" won't fail if no language is explicitly
2324 set in a config file or implicitly set by reading an executable
2326 set_language (language_c
);
2327 expected_language
= current_language
; /* Don't warn about the change. */
2329 /* Python initialization, for example, can require various commands to be
2330 installed. For example "info pretty-printer" needs the "info"
2331 prefix to be installed. Keep things simple and just do final
2332 script initialization here. */
2333 finish_ext_lang_initialization ();
2335 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2336 init_gdb_version_vars ();