1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 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"
58 /* readline include files. */
59 #include "readline/readline.h"
60 #include "readline/history.h"
62 /* readline defines this. */
65 #include <sys/types.h>
67 #include "event-top.h"
72 #include "tracepoint.h"
83 extern void initialize_all_files (void);
85 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
86 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
87 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
89 /* Default command line prompt. This is overridden in some configs. */
91 #ifndef DEFAULT_PROMPT
92 #define DEFAULT_PROMPT "(gdb) "
95 /* Generate a function that exports a pointer to a field of the
98 #define gen_ret_current_ui_field_ptr(type, name) \
100 current_ui_## name ## _ptr (void) \
102 return ¤t_ui->m_ ## name; \
105 gen_ret_current_ui_field_ptr (struct ui_file
*, gdb_stdout
)
106 gen_ret_current_ui_field_ptr (struct ui_file
*, gdb_stdin
)
107 gen_ret_current_ui_field_ptr (struct ui_file
*, gdb_stderr
)
108 gen_ret_current_ui_field_ptr (struct ui_file
*, gdb_stdlog
)
109 gen_ret_current_ui_field_ptr (struct ui_out
*, current_uiout
)
111 int inhibit_gdbinit
= 0;
113 /* Flag for whether we want to confirm potentially dangerous
114 operations. Default is yes. */
119 show_confirm (struct ui_file
*file
, int from_tty
,
120 struct cmd_list_element
*c
, const char *value
)
122 fprintf_filtered (file
, _("Whether to confirm potentially "
123 "dangerous operations is %s.\n"),
127 /* Current working directory. */
129 char *current_directory
;
131 /* The last command line executed on the console. Used for command
132 repetitions when the user enters an empty line. */
134 static char *saved_command_line
;
136 /* If not NULL, the arguments that should be passed if
137 saved_command_line is repeated. */
139 static const char *repeat_arguments
;
141 /* The previous last command line executed on the console. Used for command
142 repetitions when a command wants to relaunch the previously launched
143 command. We need this as when a command is running, saved_command_line
144 already contains the line of the currently executing command. */
146 char *previous_saved_command_line
;
148 /* If not NULL, the arguments that should be passed if the
149 previous_saved_command_line is repeated. */
151 static const char *previous_repeat_arguments
;
153 /* Nonzero if the current command is modified by "server ". This
154 affects things like recording into the command history, commands
155 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
156 whatever) can issue its own commands and also send along commands
157 from the user, and have the user not notice that the user interface
158 is issuing commands too. */
161 /* Timeout limit for response from target. */
163 /* The default value has been changed many times over the years. It
164 was originally 5 seconds. But that was thought to be a long time
165 to sit and wait, so it was changed to 2 seconds. That was thought
166 to be plenty unless the connection was going through some terminal
167 server or multiplexer or other form of hairy serial connection.
169 In mid-1996, remote_timeout was moved from remote.c to top.c and
170 it began being used in other remote-* targets. It appears that the
171 default was changed to 20 seconds at that time, perhaps because the
172 Renesas E7000 ICE didn't always respond in a timely manner.
174 But if 5 seconds is a long time to sit and wait for retransmissions,
175 20 seconds is far worse. This demonstrates the difficulty of using
176 a single variable for all protocol timeouts.
178 As remote.c is used much more than remote-e7000.c, it was changed
179 back to 2 seconds in 1999. */
181 int remote_timeout
= 2;
183 /* Non-zero tells remote* modules to output debugging info. */
185 int remote_debug
= 0;
187 /* Sbrk location on entry to main. Used for statistics only. */
188 #ifdef HAVE_USEFUL_SBRK
192 /* Hooks for alternate command interfaces. */
194 /* This hook is called from within gdb's many mini-event loops which
195 could steal control from a real user interface's event loop. It
196 returns non-zero if the user is requesting a detach, zero
199 int (*deprecated_ui_loop_hook
) (int);
202 /* Called from print_frame_info to list the line we stopped in. */
204 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
208 /* Replaces most of query. */
210 int (*deprecated_query_hook
) (const char *, va_list);
212 /* Replaces most of warning. */
214 void (*deprecated_warning_hook
) (const char *, va_list);
216 /* These three functions support getting lines of text from the user.
217 They are used in sequence. First deprecated_readline_begin_hook is
218 called with a text string that might be (for example) a message for
219 the user to type in a sequence of commands to be executed at a
220 breakpoint. If this function calls back to a GUI, it might take
221 this opportunity to pop up a text interaction window with this
222 message. Next, deprecated_readline_hook is called with a prompt
223 that is emitted prior to collecting the user input. It can be
224 called multiple times. Finally, deprecated_readline_end_hook is
225 called to notify the GUI that we are done with the interaction
226 window and it can close it. */
228 void (*deprecated_readline_begin_hook
) (const char *, ...);
229 char *(*deprecated_readline_hook
) (const char *);
230 void (*deprecated_readline_end_hook
) (void);
232 /* Called as appropriate to notify the interface that we have attached
233 to or detached from an already running process. */
235 void (*deprecated_attach_hook
) (void);
236 void (*deprecated_detach_hook
) (void);
238 /* Called when going to wait for the target. Usually allows the GUI
239 to run while waiting for target events. */
241 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
242 struct target_waitstatus
*status
,
245 /* Used by UI as a wrapper around command execution. May do various
246 things like enabling/disabling buttons, etc... */
248 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
249 const char *cmd
, int from_tty
);
251 /* Called when the current thread changes. Argument is thread id. */
253 void (*deprecated_context_hook
) (int id
);
255 /* The highest UI number ever assigned. */
256 static int highest_ui_num
;
260 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
262 num (++highest_ui_num
),
263 call_readline (nullptr),
264 input_handler (nullptr),
266 interp_info (nullptr),
268 secondary_prompt_depth (0),
269 stdin_stream (instream_
),
270 instream (instream_
),
271 outstream (outstream_
),
272 errstream (errstream_
),
273 input_fd (fileno (instream
)),
274 input_interactive_p (ISATTY (instream
)),
275 prompt_state (PROMPT_NEEDED
),
276 m_gdb_stdout (new stdio_file (outstream
)),
277 m_gdb_stdin (new stdio_file (instream
)),
278 m_gdb_stderr (new stderr_file (errstream
)),
279 m_gdb_stdlog (m_gdb_stderr
),
280 m_current_uiout (nullptr)
282 buffer_init (&line_buffer
);
290 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
298 struct ui
*ui
, *uiprev
;
302 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
306 gdb_assert (ui
!= NULL
);
318 /* Open file named NAME for read/write, making sure not to make it the
319 controlling terminal. */
322 open_terminal_stream (const char *name
)
326 fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
328 perror_with_name (_("opening terminal failed"));
330 return gdb_file_up (fdopen (fd
, "w+"));
333 /* Implementation of the "new-ui" command. */
336 new_ui_command (const char *args
, int from_tty
)
339 const char *interpreter_name
;
340 const char *tty_name
;
344 gdb_argv
argv (args
);
345 argc
= argv
.count ();
348 error (_("Usage: new-ui INTERPRETER TTY"));
350 interpreter_name
= argv
[0];
354 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
356 /* Open specified terminal. Note: we used to open it three times,
357 once for each of stdin/stdout/stderr, but that does not work
358 with Windows named pipes. */
359 gdb_file_up stream
= open_terminal_stream (tty_name
);
361 std::unique_ptr
<ui
> ui
362 (new struct ui (stream
.get (), stream
.get (), stream
.get ()));
366 current_ui
= ui
.get ();
368 set_top_level_interpreter (interpreter_name
);
370 interp_pre_command_loop (top_level_interpreter ());
372 /* Make sure the file is not closed. */
378 printf_unfiltered ("New UI allocated\n");
381 /* Handler for SIGHUP. */
384 /* NOTE 1999-04-29: This function will be static again, once we modify
385 gdb to use the event loop as the default command loop and we merge
386 event-top.c into this file, top.c. */
390 /* Stop asking user for confirmation --- we're exiting. This
391 prevents asking the user dumb questions. */
393 quit_command ((char *) 0, 0);
395 #endif /* defined SIGHUP */
397 /* Line number we are currently in, in a file which is being sourced. */
398 /* NOTE 1999-04-29: This variable will be static again, once we modify
399 gdb to use the event loop as the default command loop and we merge
400 event-top.c into this file, top.c. */
401 /* static */ int source_line_number
;
403 /* Name of the file we are sourcing. */
404 /* NOTE 1999-04-29: This variable will be static again, once we modify
405 gdb to use the event loop as the default command loop and we merge
406 event-top.c into this file, top.c. */
407 /* static */ std::string source_file_name
;
409 /* Read commands from STREAM. */
411 read_command_file (FILE *stream
)
413 struct ui
*ui
= current_ui
;
415 scoped_restore save_instream
416 = make_scoped_restore (&ui
->instream
, stream
);
418 /* Read commands from `instream' and execute them until end of file
419 or error reading instream. */
421 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
425 /* Get a command-line. This calls the readline package. */
426 command
= command_line_input (NULL
, NULL
);
429 command_handler (command
);
433 void (*pre_init_ui_hook
) (void);
437 do_chdir_cleanup (void *old_dir
)
439 chdir ((const char *) old_dir
);
445 prepare_execute_command ()
447 /* With multiple threads running while the one we're examining is
448 stopped, the dcache can get stale without us being able to detect
449 it. For the duration of the command, though, use the dcache to
450 help things like backtrace. */
452 target_dcache_invalidate ();
454 return scoped_value_mark ();
457 /* Tell the user if the language has changed (except first time) after
458 executing a command. */
461 check_frame_language_change (void)
463 static int warned
= 0;
464 struct frame_info
*frame
;
466 /* First make sure that a new frame has been selected, in case the
467 command or the hooks changed the program state. */
468 frame
= deprecated_safe_get_selected_frame ();
469 if (current_language
!= expected_language
)
471 if (language_mode
== language_mode_auto
&& info_verbose
)
473 language_info (1); /* Print what changed. */
478 /* Warn the user if the working language does not match the language
479 of the current frame. Only warn the user if we are actually
480 running the program, i.e. there is a stack. */
481 /* FIXME: This should be cacheing the frame and only running when
482 the frame changes. */
484 if (has_stack_frames ())
488 flang
= get_frame_language (frame
);
490 && flang
!= language_unknown
491 && flang
!= current_language
->la_language
)
493 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
502 wait_sync_command_done (void)
504 /* Processing events may change the current UI. */
505 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
506 struct ui
*ui
= current_ui
;
508 while (gdb_do_one_event () >= 0)
509 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
516 maybe_wait_sync_command_done (int was_sync
)
518 /* If the interpreter is in sync mode (we're running a user
519 command's list, running command hooks or similars), and we
520 just ran a synchronous command that started the target, wait
521 for that command to end. */
522 if (!current_ui
->async
524 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
525 wait_sync_command_done ();
531 set_repeat_arguments (const char *args
)
533 repeat_arguments
= args
;
536 /* Execute the line P as a command, in the current user context.
537 Pass FROM_TTY as second argument to the defining function. */
540 execute_command (const char *p
, int from_tty
)
542 struct cmd_list_element
*c
;
544 const char *cmd_start
= p
;
546 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
547 scoped_value_mark cleanup
= prepare_execute_command ();
549 /* This can happen when command_line_input hits end of file. */
552 cleanup_if_error
.release ();
556 target_log_command (p
);
558 while (*p
== ' ' || *p
== '\t')
564 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
568 /* If trace-commands is set then this will print this command. */
569 print_command_trace ("%s", p
);
571 c
= lookup_cmd (&cmd
, cmdlist
, "", 0, 1);
574 scoped_restore save_repeat_args
575 = make_scoped_restore (&repeat_arguments
, nullptr);
576 const char *args_pointer
= p
;
578 /* Pass null arg rather than an empty one. */
581 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
582 while the is_complete_command(cfunc) test is just plain
583 bogus. They should both be replaced by a test of the form
584 c->strip_trailing_white_space_p. */
585 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
586 can't be replaced with func. This is because it is the
587 cfunc, and not the func, that has the value that the
588 is_complete_command hack is testing for. */
589 /* Clear off trailing whitespace, except for set and complete
591 std::string without_whitespace
;
593 && c
->type
!= set_cmd
594 && !is_complete_command (c
))
596 const char *old_end
= arg
+ strlen (arg
) - 1;
598 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
602 without_whitespace
= std::string (arg
, p
+ 1);
603 arg
= without_whitespace
.c_str ();
607 /* If this command has been pre-hooked, run the hook first. */
608 execute_cmd_pre_hook (c
);
610 if (c
->deprecated_warn_user
)
611 deprecated_cmd_warning (line
);
613 /* c->user_commands would be NULL in the case of a python command. */
614 if (c
->theclass
== class_user
&& c
->user_commands
)
615 execute_user_command (c
, arg
);
616 else if (c
->type
== set_cmd
)
617 do_set_command (arg
, from_tty
, c
);
618 else if (c
->type
== show_cmd
)
619 do_show_command (arg
, from_tty
, c
);
620 else if (!cmd_func_p (c
))
621 error (_("That is not a command, just a help topic."));
622 else if (deprecated_call_command_hook
)
623 deprecated_call_command_hook (c
, arg
, from_tty
);
625 cmd_func (c
, arg
, from_tty
);
627 maybe_wait_sync_command_done (was_sync
);
629 /* If this command has been post-hooked, run the hook last. */
630 execute_cmd_post_hook (c
);
632 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
634 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
635 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
640 /* Only perform the frame-language-change check if the command
641 we just finished executing did not resume the inferior's execution.
642 If it did resume the inferior, we will do that check after
643 the inferior stopped. */
644 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
645 check_frame_language_change ();
647 cleanup_if_error
.release ();
650 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
651 do not display it to the screen. BATCH_FLAG will be
652 temporarily set to true. */
655 execute_command_to_ui_file (struct ui_file
*file
, const char *p
, int from_tty
)
657 /* GDB_STDOUT should be better already restored during these
658 restoration callbacks. */
659 set_batch_flag_and_restore_page_info save_page_info
;
661 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
664 current_uiout
->redirect (file
);
665 ui_out_redirect_pop
redirect_popper (current_uiout
);
667 scoped_restore save_stdout
668 = make_scoped_restore (&gdb_stdout
, file
);
669 scoped_restore save_stderr
670 = make_scoped_restore (&gdb_stderr
, file
);
671 scoped_restore save_stdlog
672 = make_scoped_restore (&gdb_stdlog
, file
);
673 scoped_restore save_stdtarg
674 = make_scoped_restore (&gdb_stdtarg
, file
);
675 scoped_restore save_stdtargerr
676 = make_scoped_restore (&gdb_stdtargerr
, file
);
678 execute_command (p
, from_tty
);
682 /* Run execute_command for P and FROM_TTY. Capture its output into the
683 returned string, do not display it to the screen. BATCH_FLAG will be
684 temporarily set to true. */
687 execute_command_to_string (const char *p
, int from_tty
,
690 string_file
str_file (term_out
);
692 execute_command_to_ui_file (&str_file
, p
, from_tty
);
693 return std::move (str_file
.string ());
697 /* When nonzero, cause dont_repeat to do nothing. This should only be
698 set via prevent_dont_repeat. */
700 static int suppress_dont_repeat
= 0;
707 struct ui
*ui
= current_ui
;
709 if (suppress_dont_repeat
|| server_command
)
712 /* If we aren't reading from standard input, we are saving the last
713 thing read from stdin in line and don't want to delete it. Null
714 lines won't repeat here in any case. */
715 if (ui
->instream
== ui
->stdin_stream
)
717 *saved_command_line
= 0;
718 repeat_arguments
= NULL
;
727 /* Do not repeat this command, as this command is a repeating command. */
730 /* We cannot free saved_command_line, as this line is being executed,
731 so swap it with previous_saved_command_line. */
732 std::swap (previous_saved_command_line
, saved_command_line
);
733 std::swap (previous_repeat_arguments
, repeat_arguments
);
735 const char *prev
= skip_spaces (get_saved_command_line ());
737 error (_("No previous command to relaunch"));
743 scoped_restore_tmpl
<int>
744 prevent_dont_repeat (void)
746 return make_scoped_restore (&suppress_dont_repeat
, 1);
752 get_saved_command_line ()
754 return saved_command_line
;
760 save_command_line (const char *cmd
)
762 xfree (previous_saved_command_line
);
763 previous_saved_command_line
= saved_command_line
;
764 previous_repeat_arguments
= repeat_arguments
;
765 saved_command_line
= xstrdup (cmd
);
766 repeat_arguments
= NULL
;
770 /* Read a line from the stream "instream" without command line editing.
772 It prints PROMPT once at the start.
773 Action is compatible with "readline", e.g. space for the result is
774 malloc'd and should be freed by the caller.
776 A NULL return means end of file. */
779 gdb_readline_no_editing (const char *prompt
)
781 struct buffer line_buffer
;
782 struct ui
*ui
= current_ui
;
783 /* Read from stdin if we are executing a user defined command. This
784 is the right thing for prompt_for_continue, at least. */
785 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
786 int fd
= fileno (stream
);
788 buffer_init (&line_buffer
);
792 /* Don't use a _filtered function here. It causes the assumed
793 character position to be off, since the newline we read from
794 the user is not accounted for. */
795 fputs_unfiltered (prompt
, gdb_stdout
);
796 gdb_flush (gdb_stdout
);
806 /* Wait until at least one byte of data is available. Control-C
807 can interrupt interruptible_select, but not fgetc. */
809 FD_SET (fd
, &readfds
);
810 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
814 /* If this was ctrl-c, the QUIT above handles it. */
817 perror_with_name (("select"));
824 if (line_buffer
.used_size
> 0)
825 /* The last line does not end with a newline. Return it, and
826 if we are called again fgetc will still return EOF and
827 we'll return NULL then. */
829 xfree (buffer_finish (&line_buffer
));
835 if (line_buffer
.used_size
> 0
836 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
837 line_buffer
.used_size
--;
841 buffer_grow_char (&line_buffer
, c
);
844 buffer_grow_char (&line_buffer
, '\0');
845 return buffer_finish (&line_buffer
);
848 /* Variables which control command line editing and history
849 substitution. These variables are given default values at the end
851 static bool command_editing_p
;
853 /* NOTE 1999-04-29: This variable will be static again, once we modify
854 gdb to use the event loop as the default command loop and we merge
855 event-top.c into this file, top.c. */
857 /* static */ bool history_expansion_p
;
859 static bool write_history_p
;
861 show_write_history_p (struct ui_file
*file
, int from_tty
,
862 struct cmd_list_element
*c
, const char *value
)
864 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
868 /* The variable associated with the "set/show history size"
869 command. The value -1 means unlimited, and -2 means undefined. */
870 static int history_size_setshow_var
= -2;
873 show_history_size (struct ui_file
*file
, int from_tty
,
874 struct cmd_list_element
*c
, const char *value
)
876 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
880 /* Variable associated with the "history remove-duplicates" option.
881 The value -1 means unlimited. */
882 static int history_remove_duplicates
= 0;
885 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
886 struct cmd_list_element
*c
, const char *value
)
888 fprintf_filtered (file
,
889 _("The number of history entries to look back at for "
890 "duplicates is %s.\n"),
894 static char *history_filename
;
896 show_history_filename (struct ui_file
*file
, int from_tty
,
897 struct cmd_list_element
*c
, const char *value
)
899 fprintf_filtered (file
, _("The filename in which to record "
900 "the command history is \"%s\".\n"),
904 /* This is like readline(), but it has some gdb-specific behavior.
905 gdb may want readline in both the synchronous and async modes during
906 a single gdb invocation. At the ordinary top-level prompt we might
907 be using the async readline. That means we can't use
908 rl_pre_input_hook, since it doesn't work properly in async mode.
909 However, for a secondary prompt (" >", such as occurs during a
910 `define'), gdb wants a synchronous response.
912 We used to call readline() directly, running it in synchronous
913 mode. But mixing modes this way is not supported, and as of
914 readline 5.x it no longer works; the arrow keys come unbound during
915 the synchronous call. So we make a nested call into the event
916 loop. That's what gdb_readline_wrapper is for. */
918 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
919 rely on gdb_readline_wrapper_result, which might still be NULL if
920 the user types Control-D for EOF. */
921 static int gdb_readline_wrapper_done
;
923 /* The result of the current call to gdb_readline_wrapper, once a newline
925 static char *gdb_readline_wrapper_result
;
927 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
928 to be called after the newline is processed (which will redisplay
929 the prompt). But in gdb_readline_wrapper we will not get a new
930 prompt until the next call, or until we return to the event loop.
931 So we disable this hook around the newline and restore it before we
933 static void (*saved_after_char_processing_hook
) (void);
939 gdb_in_secondary_prompt_p (struct ui
*ui
)
941 return ui
->secondary_prompt_depth
> 0;
945 /* This function is called when readline has seen a complete line of
949 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
951 gdb_assert (!gdb_readline_wrapper_done
);
952 gdb_readline_wrapper_result
= line
.release ();
953 gdb_readline_wrapper_done
= 1;
955 /* Prevent operate-and-get-next from acting too early. */
956 saved_after_char_processing_hook
= after_char_processing_hook
;
957 after_char_processing_hook
= NULL
;
959 /* Prevent parts of the prompt from being redisplayed if annotations
960 are enabled, and readline's state getting out of sync. We'll
961 reinstall the callback handler, which puts the terminal in raw
962 mode (or in readline lingo, in prepped state), when we're next
963 ready to process user input, either in display_gdb_prompt, or if
964 we're handling an asynchronous target event and running in the
965 background, just before returning to the event loop to process
966 further input (or more target events). */
967 if (current_ui
->command_editing
)
968 gdb_rl_callback_handler_remove ();
971 class gdb_readline_wrapper_cleanup
974 gdb_readline_wrapper_cleanup ()
975 : m_handler_orig (current_ui
->input_handler
),
976 m_already_prompted_orig (current_ui
->command_editing
977 ? rl_already_prompted
: 0),
978 m_target_is_async_orig (target_is_async_p ()),
979 m_save_ui (¤t_ui
)
981 current_ui
->input_handler
= gdb_readline_wrapper_line
;
982 current_ui
->secondary_prompt_depth
++;
984 if (m_target_is_async_orig
)
988 ~gdb_readline_wrapper_cleanup ()
990 struct ui
*ui
= current_ui
;
992 if (ui
->command_editing
)
993 rl_already_prompted
= m_already_prompted_orig
;
995 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
996 ui
->input_handler
= m_handler_orig
;
998 /* Don't restore our input handler in readline yet. That would make
999 readline prep the terminal (putting it in raw mode), while the
1000 line we just read may trigger execution of a command that expects
1001 the terminal in the default cooked/canonical mode, such as e.g.,
1002 running Python's interactive online help utility. See
1003 gdb_readline_wrapper_line for when we'll reinstall it. */
1005 gdb_readline_wrapper_result
= NULL
;
1006 gdb_readline_wrapper_done
= 0;
1007 ui
->secondary_prompt_depth
--;
1008 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1010 after_char_processing_hook
= saved_after_char_processing_hook
;
1011 saved_after_char_processing_hook
= NULL
;
1013 if (m_target_is_async_orig
)
1017 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1021 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1022 int m_already_prompted_orig
;
1024 /* Whether the target was async. */
1025 int m_target_is_async_orig
;
1027 /* Processing events may change the current UI. */
1028 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1032 gdb_readline_wrapper (const char *prompt
)
1034 struct ui
*ui
= current_ui
;
1036 gdb_readline_wrapper_cleanup cleanup
;
1038 /* Display our prompt and prevent double prompt display. Don't pass
1039 down a NULL prompt, since that has special meaning for
1040 display_gdb_prompt -- it indicates a request to print the primary
1041 prompt, while we want a secondary prompt here. */
1042 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1043 if (ui
->command_editing
)
1044 rl_already_prompted
= 1;
1046 if (after_char_processing_hook
)
1047 (*after_char_processing_hook
) ();
1048 gdb_assert (after_char_processing_hook
== NULL
);
1050 while (gdb_do_one_event () >= 0)
1051 if (gdb_readline_wrapper_done
)
1054 return gdb_readline_wrapper_result
;
1058 /* The current saved history number from operate-and-get-next.
1059 This is -1 if not valid. */
1060 static int operate_saved_history
= -1;
1062 /* This is put on the appropriate hook and helps operate-and-get-next
1065 gdb_rl_operate_and_get_next_completion (void)
1067 int delta
= where_history () - operate_saved_history
;
1069 /* The `key' argument to rl_get_previous_history is ignored. */
1070 rl_get_previous_history (delta
, 0);
1071 operate_saved_history
= -1;
1073 /* readline doesn't automatically update the display for us. */
1076 after_char_processing_hook
= NULL
;
1077 rl_pre_input_hook
= NULL
;
1080 /* This is a gdb-local readline command handler. It accepts the
1081 current command line (like RET does) and, if this command was taken
1082 from the history, arranges for the next command in the history to
1083 appear on the command line when the prompt returns.
1084 We ignore the arguments. */
1086 gdb_rl_operate_and_get_next (int count
, int key
)
1090 /* Use the async hook. */
1091 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1093 /* Find the current line, and find the next line to use. */
1094 where
= where_history();
1096 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1097 || (where
>= history_length
- 1))
1098 operate_saved_history
= where
;
1100 operate_saved_history
= where
+ 1;
1102 return rl_newline (1, key
);
1105 /* Number of user commands executed during this session. */
1107 static int command_count
= 0;
1109 /* Add the user command COMMAND to the input history list. */
1112 gdb_add_history (const char *command
)
1116 if (history_remove_duplicates
!= 0)
1119 int lookbehind_threshold
;
1121 /* The lookbehind threshold for finding a duplicate history entry is
1122 bounded by command_count because we can't meaningfully delete
1123 history entries that are already stored in the history file since
1124 the history file is appended to. */
1125 if (history_remove_duplicates
== -1
1126 || history_remove_duplicates
> command_count
)
1127 lookbehind_threshold
= command_count
;
1129 lookbehind_threshold
= history_remove_duplicates
;
1132 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1134 HIST_ENTRY
*temp
= previous_history ();
1139 if (strcmp (temp
->line
, command
) == 0)
1141 HIST_ENTRY
*prev
= remove_history (where_history ());
1143 free_history_entry (prev
);
1150 add_history (command
);
1153 /* Safely append new history entries to the history file in a corruption-free
1154 way using an intermediate local history file. */
1157 gdb_safe_append_history (void)
1159 int ret
, saved_errno
;
1161 std::string local_history_filename
1162 = string_printf ("%s-gdb%ld~", history_filename
, (long) getpid ());
1164 ret
= rename (history_filename
, local_history_filename
.c_str ());
1165 saved_errno
= errno
;
1166 if (ret
< 0 && saved_errno
!= ENOENT
)
1168 warning (_("Could not rename %s to %s: %s"),
1169 history_filename
, local_history_filename
.c_str (),
1170 safe_strerror (saved_errno
));
1176 /* If the rename failed with ENOENT then either the global history
1177 file never existed in the first place or another GDB process is
1178 currently appending to it (and has thus temporarily renamed it).
1179 Since we can't distinguish between these two cases, we have to
1180 conservatively assume the first case and therefore must write out
1181 (not append) our known history to our local history file and try
1182 to move it back anyway. Otherwise a global history file would
1183 never get created! */
1184 gdb_assert (saved_errno
== ENOENT
);
1185 write_history (local_history_filename
.c_str ());
1189 append_history (command_count
, local_history_filename
.c_str ());
1190 if (history_is_stifled ())
1191 history_truncate_file (local_history_filename
.c_str (),
1192 history_max_entries
);
1195 ret
= rename (local_history_filename
.c_str (), history_filename
);
1196 saved_errno
= errno
;
1197 if (ret
< 0 && saved_errno
!= EEXIST
)
1198 warning (_("Could not rename %s to %s: %s"),
1199 local_history_filename
.c_str (), history_filename
,
1200 safe_strerror (saved_errno
));
1204 /* Read one line from the command input stream `instream' into a local
1205 static buffer. The buffer is made bigger as necessary. Returns
1206 the address of the start of the line.
1208 NULL is returned for end of file.
1210 This routine either uses fancy command line editing or simple input
1211 as the user has requested. */
1214 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1216 static struct buffer cmd_line_buffer
;
1217 static int cmd_line_buffer_initialized
;
1218 struct ui
*ui
= current_ui
;
1219 const char *prompt
= prompt_arg
;
1221 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1223 /* The annotation suffix must be non-NULL. */
1224 if (annotation_suffix
== NULL
)
1225 annotation_suffix
= "";
1227 if (from_tty
&& annotation_level
> 1)
1232 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1233 + strlen (annotation_suffix
) + 40);
1235 local_prompt
[0] = '\0';
1237 strcpy (local_prompt
, prompt
);
1238 strcat (local_prompt
, "\n\032\032");
1239 strcat (local_prompt
, annotation_suffix
);
1240 strcat (local_prompt
, "\n");
1242 prompt
= local_prompt
;
1245 if (!cmd_line_buffer_initialized
)
1247 buffer_init (&cmd_line_buffer
);
1248 cmd_line_buffer_initialized
= 1;
1251 /* Starting a new command line. */
1252 cmd_line_buffer
.used_size
= 0;
1256 signal (SIGTSTP
, handle_sigtstp
);
1261 gdb::unique_xmalloc_ptr
<char> rl
;
1263 /* Make sure that all output has been output. Some machines may
1264 let you get away with leaving out some of the gdb_flush, but
1267 gdb_flush (gdb_stdout
);
1268 gdb_flush (gdb_stderr
);
1270 if (!source_file_name
.empty ())
1271 ++source_line_number
;
1273 if (from_tty
&& annotation_level
> 1)
1275 puts_unfiltered ("\n\032\032pre-");
1276 puts_unfiltered (annotation_suffix
);
1277 puts_unfiltered ("\n");
1280 /* Don't use fancy stuff if not talking to stdin. */
1281 if (deprecated_readline_hook
1283 && input_interactive_p (current_ui
))
1285 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1287 else if (command_editing_p
1289 && input_interactive_p (current_ui
))
1291 rl
.reset (gdb_readline_wrapper (prompt
));
1295 rl
.reset (gdb_readline_no_editing (prompt
));
1298 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1299 0, annotation_suffix
);
1300 if (cmd
== (char *) EOF
)
1308 /* Got partial input. I.e., got a line that ends with a
1309 continuation character (backslash). Suppress printing the
1316 signal (SIGTSTP
, SIG_DFL
);
1324 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1326 /* From GNU coding standards, first line is meant to be easy for a
1327 program to parse, and is just canonical program name and version
1328 number, which starts after last space. */
1330 ui_file_style style
;
1333 ui_file_style nstyle
= { ui_file_style::MAGENTA
, ui_file_style::NONE
,
1334 ui_file_style::BOLD
};
1337 fprintf_styled (stream
, style
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1339 /* Second line is a copyright notice. */
1341 fprintf_filtered (stream
,
1342 "Copyright (C) 2019 Free Software Foundation, Inc.\n");
1344 /* Following the copyright is a brief statement that the program is
1345 free software, that users are free to copy and change it on
1346 certain conditions, that it is covered by the GNU GPL, and that
1347 there is no warranty. */
1349 fprintf_filtered (stream
, "\
1350 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1351 \nThis is free software: you are free to change and redistribute it.\n\
1352 There is NO WARRANTY, to the extent permitted by law.");
1357 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1358 "\"show warranty\" for details.\n"));
1360 /* After the required info we print the configuration information. */
1362 fprintf_filtered (stream
, "This GDB was configured as \"");
1363 if (strcmp (host_name
, target_name
) != 0)
1365 fprintf_filtered (stream
, "--host=%s --target=%s",
1366 host_name
, target_name
);
1370 fprintf_filtered (stream
, "%s", host_name
);
1372 fprintf_filtered (stream
, "\".\n");
1374 fprintf_filtered (stream
, _("Type \"show configuration\" "
1375 "for configuration details.\n"));
1377 if (REPORT_BUGS_TO
[0])
1379 fprintf_filtered (stream
,
1380 _("For bug reporting instructions, please see:\n"));
1381 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1383 fprintf_filtered (stream
,
1384 _("Find the GDB manual and other documentation \
1385 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1386 fprintf_filtered (stream
, "\n\n");
1387 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1388 fprintf_filtered (stream
,
1389 _("Type \"apropos word\" to search for commands \
1390 related to \"word\"."));
1393 /* Print the details of GDB build-time configuration. */
1395 print_gdb_configuration (struct ui_file
*stream
)
1397 fprintf_filtered (stream
, _("\
1398 This GDB was configured as follows:\n\
1399 configure --host=%s --target=%s\n\
1400 "), host_name
, target_name
);
1401 fprintf_filtered (stream
, _("\
1402 --with-auto-load-dir=%s\n\
1403 --with-auto-load-safe-path=%s\n\
1404 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1406 fprintf_filtered (stream
, _("\
1410 fprintf_filtered (stream
, _("\
1415 fprintf_filtered (stream
, _("\
1416 --with-gdb-datadir=%s%s\n\
1417 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1419 fprintf_filtered (stream
, _("\
1420 --with-iconv-bin=%s%s\n\
1421 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1423 if (JIT_READER_DIR
[0])
1424 fprintf_filtered (stream
, _("\
1425 --with-jit-reader-dir=%s%s\n\
1426 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1427 #if HAVE_LIBUNWIND_IA64_H
1428 fprintf_filtered (stream
, _("\
1429 --with-libunwind-ia64\n\
1432 fprintf_filtered (stream
, _("\
1433 --without-libunwind-ia64\n\
1437 fprintf_filtered (stream
, _("\
1441 fprintf_filtered (stream
, _("\
1445 #if HAVE_LIBBABELTRACE
1446 fprintf_filtered (stream
, _("\
1447 --with-babeltrace\n\
1450 fprintf_filtered (stream
, _("\
1451 --without-babeltrace\n\
1455 fprintf_filtered (stream
, _("\
1459 fprintf_filtered (stream
, _("\
1460 --without-intel-pt\n\
1464 fprintf_filtered (stream
, _("\
1468 fprintf_filtered (stream
, _("\
1472 #ifdef WITH_PYTHON_PATH
1473 fprintf_filtered (stream
, _("\
1474 --with-python=%s%s\n\
1475 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1477 fprintf_filtered (stream
, _("\
1482 fprintf_filtered (stream
, _("\
1486 fprintf_filtered (stream
, _("\
1490 #if HAVE_SOURCE_HIGHLIGHT
1491 fprintf_filtered (stream
, _("\
1492 --enable-source-highlight\n\
1495 fprintf_filtered (stream
, _("\
1496 --disable-source-highlight\n\
1500 fprintf_filtered (stream
, _("\
1501 --with-relocated-sources=%s\n\
1505 fprintf_filtered (stream
, _("\
1506 --with-separate-debug-dir=%s%s\n\
1507 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1508 if (TARGET_SYSTEM_ROOT
[0])
1509 fprintf_filtered (stream
, _("\
1510 --with-sysroot=%s%s\n\
1511 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1512 if (SYSTEM_GDBINIT
[0])
1513 fprintf_filtered (stream
, _("\
1514 --with-system-gdbinit=%s%s\n\
1515 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1516 if (SYSTEM_GDBINIT_DIR
[0])
1517 fprintf_filtered (stream
, _("\
1518 --with-system-gdbinit-dir=%s%s\n\
1519 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1520 /* We assume "relocatable" will be printed at least once, thus we always
1521 print this text. It's a reasonably safe assumption for now. */
1522 fprintf_filtered (stream
, _("\n\
1523 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1524 tree, and GDB will still find it.)\n\
1529 /* The current top level prompt, settable with "set prompt", and/or
1530 with the python `gdb.prompt_hook' hook. */
1531 static char *top_prompt
;
1533 /* Access method for the GDB prompt string. */
1541 /* Set method for the GDB prompt string. */
1544 set_prompt (const char *s
)
1546 char *p
= xstrdup (s
);
1558 /* Callback for iterate_over_inferiors. Kills or detaches the given
1559 inferior, depending on how we originally gained control of it. */
1562 kill_or_detach (struct inferior
*inf
, void *args
)
1564 struct qt_args
*qt
= (struct qt_args
*) args
;
1569 thread_info
*thread
= any_thread_of_inferior (inf
);
1572 switch_to_thread (thread
);
1574 /* Leave core files alone. */
1575 if (target_has_execution
)
1577 if (inf
->attach_flag
)
1578 target_detach (inf
, qt
->from_tty
);
1587 /* Callback for iterate_over_inferiors. Prints info about what GDB
1588 will do to each inferior on a "quit". ARG points to a struct
1589 ui_out where output is to be collected. */
1592 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1594 struct ui_file
*stb
= (struct ui_file
*) arg
;
1599 if (inf
->attach_flag
)
1600 fprintf_filtered (stb
,
1601 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1602 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1604 fprintf_filtered (stb
,
1605 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1606 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1611 /* If necessary, make the user confirm that we should quit. Return
1612 non-zero if we should quit, zero if we shouldn't. */
1617 /* Don't even ask if we're only debugging a core file inferior. */
1618 if (!have_live_inferiors ())
1621 /* Build the query string as a single string. */
1624 stb
.puts (_("A debugging session is active.\n\n"));
1625 iterate_over_inferiors (print_inferior_quit_action
, &stb
);
1626 stb
.puts (_("\nQuit anyway? "));
1628 return query ("%s", stb
.c_str ());
1631 /* Prepare to exit GDB cleanly by undoing any changes made to the
1632 terminal so that we leave the terminal in the state we acquired it. */
1635 undo_terminal_modifications_before_exit (void)
1637 struct ui
*saved_top_level
= current_ui
;
1639 target_terminal::ours ();
1641 current_ui
= main_ui
;
1646 gdb_disable_readline ();
1648 current_ui
= saved_top_level
;
1652 /* Quit without asking for confirmation. */
1655 quit_force (int *exit_arg
, int from_tty
)
1660 undo_terminal_modifications_before_exit ();
1662 /* An optional expression may be used to cause gdb to terminate with the
1663 value of that expression. */
1665 exit_code
= *exit_arg
;
1666 else if (return_child_result
)
1667 exit_code
= return_child_result_value
;
1669 qt
.from_tty
= from_tty
;
1671 /* We want to handle any quit errors and exit regardless. */
1673 /* Get out of tfind mode, and kill or detach all inferiors. */
1676 disconnect_tracing ();
1677 iterate_over_inferiors (kill_or_detach
, &qt
);
1679 catch (const gdb_exception
&ex
)
1681 exception_print (gdb_stderr
, ex
);
1684 /* Give all pushed targets a chance to do minimal cleanup, and pop
1690 catch (const gdb_exception
&ex
)
1692 exception_print (gdb_stderr
, ex
);
1695 /* Save the history information if it is appropriate to do so. */
1698 if (write_history_p
&& history_filename
)
1703 /* History is currently shared between all UIs. If there's
1704 any UI with a terminal, save history. */
1707 if (input_interactive_p (ui
))
1715 gdb_safe_append_history ();
1718 catch (const gdb_exception
&ex
)
1720 exception_print (gdb_stderr
, ex
);
1723 /* Destroy any values currently allocated now instead of leaving it
1724 to global destructors, because that may be too late. For
1725 example, the destructors of xmethod values call into the Python
1726 runtime, which is finalized via a final cleanup. */
1729 /* Do any final cleanups before exiting. */
1732 do_final_cleanups ();
1734 catch (const gdb_exception
&ex
)
1736 exception_print (gdb_stderr
, ex
);
1742 /* The value of the "interactive-mode" setting. */
1743 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1745 /* Implement the "show interactive-mode" option. */
1748 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1749 struct cmd_list_element
*c
,
1752 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1753 fprintf_filtered (file
, "Debugger's interactive mode "
1754 "is %s (currently %s).\n",
1755 value
, input_interactive_p (current_ui
) ? "on" : "off");
1757 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1760 /* Returns whether GDB is running on an interactive terminal. */
1763 input_interactive_p (struct ui
*ui
)
1768 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1769 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1771 return ui
->input_interactive_p
;
1775 dont_repeat_command (const char *ignored
, int from_tty
)
1777 /* Can't call dont_repeat here because we're not necessarily reading
1779 *saved_command_line
= 0;
1782 /* Functions to manipulate command line editing control variables. */
1784 /* Number of commands to print in each call to show_commands. */
1785 #define Hist_print 10
1787 show_commands (const char *args
, int from_tty
)
1789 /* Index for history commands. Relative to history_base. */
1792 /* Number of the history entry which we are planning to display next.
1793 Relative to history_base. */
1796 /* Print out some of the commands from the command history. */
1800 if (args
[0] == '+' && args
[1] == '\0')
1801 /* "info editing +" should print from the stored position. */
1804 /* "info editing <exp>" should print around command number <exp>. */
1805 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1807 /* "show commands" means print the last Hist_print commands. */
1810 num
= history_length
- Hist_print
;
1816 /* If there are at least Hist_print commands, we want to display the last
1817 Hist_print rather than, say, the last 6. */
1818 if (history_length
- num
< Hist_print
)
1820 num
= history_length
- Hist_print
;
1826 offset
< num
+ Hist_print
&& offset
< history_length
;
1829 printf_filtered ("%5d %s\n", history_base
+ offset
,
1830 (history_get (history_base
+ offset
))->line
);
1833 /* The next command we want to display is the next one that we haven't
1837 /* If the user repeats this command with return, it should do what
1838 "show commands +" does. This is unnecessary if arg is null,
1839 because "show commands +" is not useful after "show commands". */
1840 if (from_tty
&& args
)
1841 set_repeat_arguments ("+");
1844 /* Update the size of our command history file to HISTORY_SIZE.
1846 A HISTORY_SIZE of -1 stands for unlimited. */
1849 set_readline_history_size (int history_size
)
1851 gdb_assert (history_size
>= -1);
1853 if (history_size
== -1)
1854 unstifle_history ();
1856 stifle_history (history_size
);
1859 /* Called by do_setshow_command. */
1861 set_history_size_command (const char *args
,
1862 int from_tty
, struct cmd_list_element
*c
)
1864 set_readline_history_size (history_size_setshow_var
);
1868 set_history (const char *args
, int from_tty
)
1870 printf_unfiltered (_("\"set history\" must be followed "
1871 "by the name of a history subcommand.\n"));
1872 help_list (sethistlist
, "set history ", all_commands
, gdb_stdout
);
1876 show_history (const char *args
, int from_tty
)
1878 cmd_show_list (showhistlist
, from_tty
, "");
1881 bool info_verbose
= false; /* Default verbose msgs off. */
1883 /* Called by do_set_command. An elaborate joke. */
1885 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1887 const char *cmdname
= "verbose";
1888 struct cmd_list_element
*showcmd
;
1890 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1891 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1893 if (c
->doc
&& c
->doc_allocated
)
1894 xfree ((char *) c
->doc
);
1895 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1896 xfree ((char *) showcmd
->doc
);
1899 c
->doc
= _("Set verbose printing of informational messages.");
1900 showcmd
->doc
= _("Show verbose printing of informational messages.");
1904 c
->doc
= _("Set verbosity.");
1905 showcmd
->doc
= _("Show verbosity.");
1907 c
->doc_allocated
= 0;
1908 showcmd
->doc_allocated
= 0;
1911 /* Init the history buffer. Note that we are called after the init file(s)
1912 have been read so that the user can change the history file via his
1913 .gdbinit file (for instance). The GDBHISTFILE environment variable
1914 overrides all of this. */
1921 tmpenv
= getenv ("GDBHISTSIZE");
1928 tmpenv
= skip_spaces (tmpenv
);
1930 var
= strtol (tmpenv
, &endptr
, 10);
1931 saved_errno
= errno
;
1932 endptr
= skip_spaces (endptr
);
1934 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1935 empty string, a negative number or a huge positive number (larger than
1936 INT_MAX) then set the history size to unlimited. Otherwise set our
1937 history size to the number we have read. This behavior is consistent
1938 with how bash handles HISTSIZE. */
1939 if (*endptr
!= '\0')
1941 else if (*tmpenv
== '\0'
1944 /* On targets where INT_MAX == LONG_MAX, we have to look at
1945 errno after calling strtol to distinguish between a value that
1946 is exactly INT_MAX and an overflowing value that was clamped
1948 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
1949 history_size_setshow_var
= -1;
1951 history_size_setshow_var
= var
;
1954 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1956 if (history_size_setshow_var
== -2)
1957 history_size_setshow_var
= 256;
1959 set_readline_history_size (history_size_setshow_var
);
1961 tmpenv
= getenv ("GDBHISTFILE");
1963 history_filename
= xstrdup (tmpenv
);
1964 else if (!history_filename
)
1966 /* We include the current directory so that if the user changes
1967 directories the file written will be the same as the one
1970 /* No leading dots in file names are allowed on MSDOS. */
1971 history_filename
= concat (current_directory
, "/_gdb_history",
1974 history_filename
= concat (current_directory
, "/.gdb_history",
1978 read_history (history_filename
);
1982 show_prompt (struct ui_file
*file
, int from_tty
,
1983 struct cmd_list_element
*c
, const char *value
)
1985 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1988 /* "set editing" command. */
1991 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1993 change_line_handler (set_editing_cmd_var
);
1994 /* Update the control variable so that MI's =cmd-param-changed event
1995 shows the correct value. */
1996 set_editing_cmd_var
= current_ui
->command_editing
;
2000 show_editing (struct ui_file
*file
, int from_tty
,
2001 struct cmd_list_element
*c
, const char *value
)
2003 fprintf_filtered (file
, _("Editing of command lines as "
2004 "they are typed is %s.\n"),
2005 current_ui
->command_editing
? _("on") : _("off"));
2009 show_annotation_level (struct ui_file
*file
, int from_tty
,
2010 struct cmd_list_element
*c
, const char *value
)
2012 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2016 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2017 struct cmd_list_element
*c
, const char *value
)
2019 fprintf_filtered (file
, _("Notification of completion for "
2020 "asynchronous execution commands is %s.\n"),
2024 /* New values of the "data-directory" parameter are staged here. */
2025 static char *staged_gdb_datadir
;
2027 /* "set" command for the gdb_datadir configuration variable. */
2030 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2032 set_gdb_data_directory (staged_gdb_datadir
);
2033 gdb::observers::gdb_datadir_changed
.notify ();
2036 /* "show" command for the gdb_datadir configuration variable. */
2039 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2040 struct cmd_list_element
*c
, const char *value
)
2042 fprintf_filtered (file
, _("GDB's data directory is \"%s\".\n"),
2043 gdb_datadir
.c_str ());
2047 set_history_filename (const char *args
,
2048 int from_tty
, struct cmd_list_element
*c
)
2050 /* We include the current directory so that if the user changes
2051 directories the file written will be the same as the one
2053 if (!IS_ABSOLUTE_PATH (history_filename
))
2054 history_filename
= reconcat (history_filename
, current_directory
, "/",
2055 history_filename
, (char *) NULL
);
2059 init_gdb_version_vars (void)
2061 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2062 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2063 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2064 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2065 set_internalvar_integer (major_version_var
, vmajor
);
2066 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2072 struct cmd_list_element
*c
;
2074 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2075 the DEFAULT_PROMPT is. */
2076 set_prompt (DEFAULT_PROMPT
);
2078 /* Set the important stuff up for command editing. */
2079 command_editing_p
= 1;
2080 history_expansion_p
= 0;
2081 write_history_p
= 0;
2083 /* Setup important stuff for command line editing. */
2084 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2085 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2086 set_rl_completer_word_break_characters (default_word_break_characters ());
2087 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2088 rl_completion_display_matches_hook
= cli_display_match_list
;
2089 rl_readline_name
= "gdb";
2090 rl_terminal_name
= getenv ("TERM");
2092 /* The name for this defun comes from Bash, where it originated.
2093 15 is Control-o, the same binding this function has in Bash. */
2094 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2096 add_setshow_string_cmd ("prompt", class_support
,
2098 _("Set gdb's prompt."),
2099 _("Show gdb's prompt."),
2102 &setlist
, &showlist
);
2104 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2105 Don't repeat this command.\nPrimarily \
2106 used inside of user-defined commands that should not be repeated when\n\
2109 add_setshow_boolean_cmd ("editing", class_support
,
2110 &set_editing_cmd_var
, _("\
2111 Set editing of command lines as they are typed."), _("\
2112 Show editing of command lines as they are typed."), _("\
2113 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2114 Without an argument, command line editing is enabled. To edit, use\n\
2115 EMACS-like or VI-like commands like control-P or ESC."),
2118 &setlist
, &showlist
);
2120 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2121 Set saving of the history record on exit."), _("\
2122 Show saving of the history record on exit."), _("\
2123 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2124 Without an argument, saving is enabled."),
2126 show_write_history_p
,
2127 &sethistlist
, &showhistlist
);
2129 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2130 &history_size_setshow_var
, _("\
2131 Set the size of the command history."), _("\
2132 Show the size of the command history."), _("\
2133 This is the number of previous commands to keep a record of.\n\
2134 If set to \"unlimited\", the number of commands kept in the history\n\
2135 list is unlimited. This defaults to the value of the environment\n\
2136 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2137 set_history_size_command
,
2139 &sethistlist
, &showhistlist
);
2141 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2142 &history_remove_duplicates
, _("\
2143 Set how far back in history to look for and remove duplicate entries."), _("\
2144 Show how far back in history to look for and remove duplicate entries."), _("\
2145 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2146 and remove the first history entry that is a duplicate of the most recent\n\
2147 entry, each time a new history entry is added.\n\
2148 If set to \"unlimited\", this lookbehind is unbounded.\n\
2149 Only history entries added during this session are considered for removal.\n\
2150 If set to 0, removal of duplicate history entries is disabled.\n\
2151 By default this option is set to 0."),
2153 show_history_remove_duplicates
,
2154 &sethistlist
, &showhistlist
);
2156 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
2157 Set the filename in which to record the command history."), _("\
2158 Show the filename in which to record the command history."), _("\
2159 (the list of previous commands of which a record is kept)."),
2160 set_history_filename
,
2161 show_history_filename
,
2162 &sethistlist
, &showhistlist
);
2164 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2165 Set whether to confirm potentially dangerous operations."), _("\
2166 Show whether to confirm potentially dangerous operations."), NULL
,
2169 &setlist
, &showlist
);
2171 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2172 Set annotation_level."), _("\
2173 Show annotation_level."), _("\
2174 0 == normal; 1 == fullname (for use when running under emacs)\n\
2175 2 == output annotated suitably for use by programs that control GDB."),
2177 show_annotation_level
,
2178 &setlist
, &showlist
);
2180 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2181 &exec_done_display_p
, _("\
2182 Set notification of completion for asynchronous execution commands."), _("\
2183 Show notification of completion for asynchronous execution commands."), _("\
2184 Use \"on\" to enable the notification, and \"off\" to disable it."),
2186 show_exec_done_display_p
,
2187 &setlist
, &showlist
);
2189 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2190 &staged_gdb_datadir
, _("Set GDB's data directory."),
2191 _("Show GDB's data directory."),
2193 When set, GDB uses the specified path to search for data files."),
2194 set_gdb_datadir
, show_gdb_datadir
,
2198 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2199 &interactive_mode
, _("\
2200 Set whether GDB's standard input is a terminal."), _("\
2201 Show whether GDB's standard input is a terminal."), _("\
2202 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2203 means that GDB should wait for the user to answer queries associated to\n\
2204 commands entered at the command prompt. If off, GDB assumes that standard\n\
2205 input is not a terminal, and uses the default answer to all queries.\n\
2206 If auto (the default), determine which mode to use based on the standard\n\
2209 show_interactive_mode
,
2210 &setlist
, &showlist
);
2212 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2214 Usage: new-ui INTERPRETER TTY\n\
2215 The first argument is the name of the interpreter to run.\n\
2216 The second argument is the terminal the UI runs on."), &cmdlist
);
2217 set_cmd_completer (c
, interpreter_completer
);
2221 gdb_init (char *argv0
)
2223 saved_command_line
= xstrdup ("");
2224 previous_saved_command_line
= xstrdup ("");
2226 if (pre_init_ui_hook
)
2227 pre_init_ui_hook ();
2229 /* Run the init function of each source file. */
2232 /* Make sure we return to the original directory upon exit, come
2233 what may, since the OS doesn't do that for us. */
2234 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2237 init_cmd_lists (); /* This needs to be done first. */
2238 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2242 /* Here is where we call all the _initialize_foo routines. */
2243 initialize_all_files ();
2245 /* This creates the current_program_space. Do this after all the
2246 _initialize_foo routines have had a chance to install their
2247 per-sspace data keys. Also do this before
2248 initialize_current_architecture is called, because it accesses
2249 exec_bfd of the current program space. */
2250 initialize_progspace ();
2251 initialize_inferiors ();
2252 initialize_current_architecture ();
2253 init_main (); /* But that omits this file! Do it now. */
2255 initialize_stdin_serial ();
2257 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2259 set_initial_gdb_ttystate ();
2261 async_init_signals ();
2263 /* We need a default language for parsing expressions, so simple
2264 things like "set width 0" won't fail if no language is explicitly
2265 set in a config file or implicitly set by reading an executable
2267 set_language (language_c
);
2268 expected_language
= current_language
; /* Don't warn about the change. */
2270 /* Python initialization, for example, can require various commands to be
2271 installed. For example "info pretty-printer" needs the "info"
2272 prefix to be installed. Keep things simple and just do final
2273 script initialization here. */
2274 finish_ext_lang_initialization ();
2276 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2277 init_gdb_version_vars ();