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 overriden 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 extern char lang_frame_mismatch_warn[]; /* language.c */
115 /* Flag for whether we want to confirm potentially dangerous
116 operations. Default is yes. */
121 show_confirm (struct ui_file *file, int from_tty,
122 struct cmd_list_element *c, const char *value)
124 fprintf_filtered (file, _("Whether to confirm potentially "
125 "dangerous operations is %s.\n"),
129 /* Current working directory. */
131 char *current_directory;
133 /* The last command line executed on the console. Used for command
134 repetitions when the user enters an empty line. */
136 static char *saved_command_line;
138 /* If not NULL, the arguments that should be passed if
139 saved_command_line is repeated. */
141 static const char *repeat_arguments;
143 /* The previous last command line executed on the console. Used for command
144 repetitions when a command wants to relaunch the previously launched
145 command. We need this as when a command is running, saved_command_line
146 already contains the line of the currently executing command. */
148 char *previous_saved_command_line;
150 /* If not NULL, the arguments that should be passed if the
151 previous_saved_command_line is repeated. */
153 static const char *previous_repeat_arguments;
155 /* Nonzero if the current command is modified by "server ". This
156 affects things like recording into the command history, commands
157 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
158 whatever) can issue its own commands and also send along commands
159 from the user, and have the user not notice that the user interface
160 is issuing commands too. */
163 /* Timeout limit for response from target. */
165 /* The default value has been changed many times over the years. It
166 was originally 5 seconds. But that was thought to be a long time
167 to sit and wait, so it was changed to 2 seconds. That was thought
168 to be plenty unless the connection was going through some terminal
169 server or multiplexer or other form of hairy serial connection.
171 In mid-1996, remote_timeout was moved from remote.c to top.c and
172 it began being used in other remote-* targets. It appears that the
173 default was changed to 20 seconds at that time, perhaps because the
174 Renesas E7000 ICE didn't always respond in a timely manner.
176 But if 5 seconds is a long time to sit and wait for retransmissions,
177 20 seconds is far worse. This demonstrates the difficulty of using
178 a single variable for all protocol timeouts.
180 As remote.c is used much more than remote-e7000.c, it was changed
181 back to 2 seconds in 1999. */
183 int remote_timeout = 2;
185 /* Non-zero tells remote* modules to output debugging info. */
187 int remote_debug = 0;
189 /* Sbrk location on entry to main. Used for statistics only. */
190 #ifdef HAVE_USEFUL_SBRK
194 /* Hooks for alternate command interfaces. */
196 /* This hook is called from within gdb's many mini-event loops which
197 could steal control from a real user interface's event loop. It
198 returns non-zero if the user is requesting a detach, zero
201 int (*deprecated_ui_loop_hook) (int);
204 /* Called from print_frame_info to list the line we stopped in. */
206 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
210 /* Replaces most of query. */
212 int (*deprecated_query_hook) (const char *, va_list);
214 /* Replaces most of warning. */
216 void (*deprecated_warning_hook) (const char *, va_list);
218 /* These three functions support getting lines of text from the user.
219 They are used in sequence. First deprecated_readline_begin_hook is
220 called with a text string that might be (for example) a message for
221 the user to type in a sequence of commands to be executed at a
222 breakpoint. If this function calls back to a GUI, it might take
223 this opportunity to pop up a text interaction window with this
224 message. Next, deprecated_readline_hook is called with a prompt
225 that is emitted prior to collecting the user input. It can be
226 called multiple times. Finally, deprecated_readline_end_hook is
227 called to notify the GUI that we are done with the interaction
228 window and it can close it. */
230 void (*deprecated_readline_begin_hook) (const char *, ...);
231 char *(*deprecated_readline_hook) (const char *);
232 void (*deprecated_readline_end_hook) (void);
234 /* Called as appropriate to notify the interface that we have attached
235 to or detached from an already running process. */
237 void (*deprecated_attach_hook) (void);
238 void (*deprecated_detach_hook) (void);
240 /* Called when going to wait for the target. Usually allows the GUI
241 to run while waiting for target events. */
243 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
244 struct target_waitstatus *status,
247 /* Used by UI as a wrapper around command execution. May do various
248 things like enabling/disabling buttons, etc... */
250 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
251 const char *cmd, int from_tty);
253 /* Called when the current thread changes. Argument is thread id. */
255 void (*deprecated_context_hook) (int id);
257 /* The highest UI number ever assigned. */
258 static int highest_ui_num;
262 ui::ui (FILE *instream_, FILE *outstream_, FILE *errstream_)
264 num (++highest_ui_num),
265 call_readline (nullptr),
266 input_handler (nullptr),
268 interp_info (nullptr),
270 secondary_prompt_depth (0),
271 stdin_stream (instream_),
272 instream (instream_),
273 outstream (outstream_),
274 errstream (errstream_),
275 input_fd (fileno (instream)),
276 input_interactive_p (ISATTY (instream)),
277 prompt_state (PROMPT_NEEDED),
278 m_gdb_stdout (new stdio_file (outstream)),
279 m_gdb_stdin (new stdio_file (instream)),
280 m_gdb_stderr (new stderr_file (errstream)),
281 m_gdb_stdlog (m_gdb_stderr),
282 m_current_uiout (nullptr)
284 buffer_init (&line_buffer);
292 for (last = ui_list; last->next != NULL; last = last->next)
300 struct ui *ui, *uiprev;
304 for (ui = ui_list; ui != NULL; uiprev = ui, ui = ui->next)
308 gdb_assert (ui != NULL);
320 /* Open file named NAME for read/write, making sure not to make it the
321 controlling terminal. */
324 open_terminal_stream (const char *name)
328 fd = gdb_open_cloexec (name, O_RDWR | O_NOCTTY, 0);
330 perror_with_name (_("opening terminal failed"));
332 return gdb_file_up (fdopen (fd, "w+"));
335 /* Implementation of the "new-ui" command. */
338 new_ui_command (const char *args, int from_tty)
341 const char *interpreter_name;
342 const char *tty_name;
346 gdb_argv argv (args);
347 argc = argv.count ();
350 error (_("Usage: new-ui INTERPRETER TTY"));
352 interpreter_name = argv[0];
356 scoped_restore save_ui = make_scoped_restore (¤t_ui);
358 /* Open specified terminal. Note: we used to open it three times,
359 once for each of stdin/stdout/stderr, but that does not work
360 with Windows named pipes. */
361 gdb_file_up stream = open_terminal_stream (tty_name);
363 std::unique_ptr<ui> ui
364 (new struct ui (stream.get (), stream.get (), stream.get ()));
368 current_ui = ui.get ();
370 set_top_level_interpreter (interpreter_name);
372 interp_pre_command_loop (top_level_interpreter ());
374 /* Make sure the file is not closed. */
380 printf_unfiltered ("New UI allocated\n");
383 /* Handler for SIGHUP. */
386 /* NOTE 1999-04-29: This function will be static again, once we modify
387 gdb to use the event loop as the default command loop and we merge
388 event-top.c into this file, top.c. */
392 /* Stop asking user for confirmation --- we're exiting. This
393 prevents asking the user dumb questions. */
395 quit_command ((char *) 0, 0);
397 #endif /* defined SIGHUP */
399 /* Line number we are currently in, in a file which is being sourced. */
400 /* NOTE 1999-04-29: This variable will be static again, once we modify
401 gdb to use the event loop as the default command loop and we merge
402 event-top.c into this file, top.c. */
403 /* static */ int source_line_number;
405 /* Name of the file we are sourcing. */
406 /* NOTE 1999-04-29: This variable will be static again, once we modify
407 gdb to use the event loop as the default command loop and we merge
408 event-top.c into this file, top.c. */
409 /* static */ std::string source_file_name;
411 /* Read commands from STREAM. */
413 read_command_file (FILE *stream)
415 struct ui *ui = current_ui;
417 scoped_restore save_instream
418 = make_scoped_restore (&ui->instream, stream);
420 /* Read commands from `instream' and execute them until end of file
421 or error reading instream. */
423 while (ui->instream != NULL && !feof (ui->instream))
427 /* Get a command-line. This calls the readline package. */
428 command = command_line_input (NULL, NULL);
431 command_handler (command);
435 void (*pre_init_ui_hook) (void);
439 do_chdir_cleanup (void *old_dir)
441 chdir ((const char *) old_dir);
447 prepare_execute_command ()
449 /* With multiple threads running while the one we're examining is
450 stopped, the dcache can get stale without us being able to detect
451 it. For the duration of the command, though, use the dcache to
452 help things like backtrace. */
454 target_dcache_invalidate ();
456 return scoped_value_mark ();
459 /* Tell the user if the language has changed (except first time) after
460 executing a command. */
463 check_frame_language_change (void)
465 static int warned = 0;
466 struct frame_info *frame;
468 /* First make sure that a new frame has been selected, in case the
469 command or the hooks changed the program state. */
470 frame = deprecated_safe_get_selected_frame ();
471 if (current_language != expected_language)
473 if (language_mode == language_mode_auto && info_verbose)
475 language_info (1); /* Print what changed. */
480 /* Warn the user if the working language does not match the language
481 of the current frame. Only warn the user if we are actually
482 running the program, i.e. there is a stack. */
483 /* FIXME: This should be cacheing the frame and only running when
484 the frame changes. */
486 if (has_stack_frames ())
490 flang = get_frame_language (frame);
492 && flang != language_unknown
493 && flang != current_language->la_language)
495 printf_filtered ("%s\n", lang_frame_mismatch_warn);
504 wait_sync_command_done (void)
506 /* Processing events may change the current UI. */
507 scoped_restore save_ui = make_scoped_restore (¤t_ui);
508 struct ui *ui = current_ui;
510 while (gdb_do_one_event () >= 0)
511 if (ui->prompt_state != PROMPT_BLOCKED)
518 maybe_wait_sync_command_done (int was_sync)
520 /* If the interpreter is in sync mode (we're running a user
521 command's list, running command hooks or similars), and we
522 just ran a synchronous command that started the target, wait
523 for that command to end. */
524 if (!current_ui->async
526 && current_ui->prompt_state == PROMPT_BLOCKED)
527 wait_sync_command_done ();
533 set_repeat_arguments (const char *args)
535 repeat_arguments = args;
538 /* Execute the line P as a command, in the current user context.
539 Pass FROM_TTY as second argument to the defining function. */
542 execute_command (const char *p, int from_tty)
544 struct cmd_list_element *c;
546 const char *cmd_start = p;
548 auto cleanup_if_error = make_scope_exit (bpstat_clear_actions);
549 scoped_value_mark cleanup = prepare_execute_command ();
551 /* This can happen when command_line_input hits end of file. */
554 cleanup_if_error.release ();
558 target_log_command (p);
560 while (*p == ' ' || *p == '\t')
566 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
570 /* If trace-commands is set then this will print this command. */
571 print_command_trace ("%s", p);
573 c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
576 scoped_restore save_repeat_args
577 = make_scoped_restore (&repeat_arguments, nullptr);
578 const char *args_pointer = p;
580 /* Pass null arg rather than an empty one. */
583 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
584 while the is_complete_command(cfunc) test is just plain
585 bogus. They should both be replaced by a test of the form
586 c->strip_trailing_white_space_p. */
587 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
588 can't be replaced with func. This is because it is the
589 cfunc, and not the func, that has the value that the
590 is_complete_command hack is testing for. */
591 /* Clear off trailing whitespace, except for set and complete
593 std::string without_whitespace;
595 && c->type != set_cmd
596 && !is_complete_command (c))
598 const char *old_end = arg + strlen (arg) - 1;
600 while (p >= arg && (*p == ' ' || *p == '\t'))
604 without_whitespace = std::string (arg, p + 1);
605 arg = without_whitespace.c_str ();
609 /* If this command has been pre-hooked, run the hook first. */
610 execute_cmd_pre_hook (c);
612 if (c->deprecated_warn_user)
613 deprecated_cmd_warning (line);
615 /* c->user_commands would be NULL in the case of a python command. */
616 if (c->theclass == class_user && c->user_commands)
617 execute_user_command (c, arg);
618 else if (c->type == set_cmd)
619 do_set_command (arg, from_tty, c);
620 else if (c->type == show_cmd)
621 do_show_command (arg, from_tty, c);
622 else if (!cmd_func_p (c))
623 error (_("That is not a command, just a help topic."));
624 else if (deprecated_call_command_hook)
625 deprecated_call_command_hook (c, arg, from_tty);
627 cmd_func (c, arg, from_tty);
629 maybe_wait_sync_command_done (was_sync);
631 /* If this command has been post-hooked, run the hook last. */
632 execute_cmd_post_hook (c);
634 if (repeat_arguments != NULL && cmd_start == saved_command_line)
636 gdb_assert (strlen (args_pointer) >= strlen (repeat_arguments));
637 strcpy (saved_command_line + (args_pointer - cmd_start),
642 /* Only perform the frame-language-change check if the command
643 we just finished executing did not resume the inferior's execution.
644 If it did resume the inferior, we will do that check after
645 the inferior stopped. */
646 if (has_stack_frames () && inferior_thread ()->state != THREAD_RUNNING)
647 check_frame_language_change ();
649 cleanup_if_error.release ();
652 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
653 do not display it to the screen. BATCH_FLAG will be
654 temporarily set to true. */
657 execute_command_to_ui_file (struct ui_file *file, const char *p, int from_tty)
659 /* GDB_STDOUT should be better already restored during these
660 restoration callbacks. */
661 set_batch_flag_and_restore_page_info save_page_info;
663 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
666 current_uiout->redirect (file);
667 ui_out_redirect_pop redirect_popper (current_uiout);
669 scoped_restore save_stdout
670 = make_scoped_restore (&gdb_stdout, file);
671 scoped_restore save_stderr
672 = make_scoped_restore (&gdb_stderr, file);
673 scoped_restore save_stdlog
674 = make_scoped_restore (&gdb_stdlog, file);
675 scoped_restore save_stdtarg
676 = make_scoped_restore (&gdb_stdtarg, file);
677 scoped_restore save_stdtargerr
678 = make_scoped_restore (&gdb_stdtargerr, file);
680 execute_command (p, from_tty);
684 /* Run execute_command for P and FROM_TTY. Capture its output into the
685 returned string, do not display it to the screen. BATCH_FLAG will be
686 temporarily set to true. */
689 execute_command_to_string (const char *p, int from_tty,
692 string_file str_file (term_out);
694 execute_command_to_ui_file (&str_file, p, from_tty);
695 return std::move (str_file.string ());
699 /* When nonzero, cause dont_repeat to do nothing. This should only be
700 set via prevent_dont_repeat. */
702 static int suppress_dont_repeat = 0;
709 struct ui *ui = current_ui;
711 if (suppress_dont_repeat || server_command)
714 /* If we aren't reading from standard input, we are saving the last
715 thing read from stdin in line and don't want to delete it. Null
716 lines won't repeat here in any case. */
717 if (ui->instream == ui->stdin_stream)
719 *saved_command_line = 0;
720 repeat_arguments = NULL;
729 /* Do not repeat this command, as this command is a repeating command. */
732 /* We cannot free saved_command_line, as this line is being executed,
733 so swap it with previous_saved_command_line. */
734 std::swap (previous_saved_command_line, saved_command_line);
735 std::swap (previous_repeat_arguments, repeat_arguments);
737 const char *prev = skip_spaces (get_saved_command_line ());
739 error (_("No previous command to relaunch"));
745 scoped_restore_tmpl<int>
746 prevent_dont_repeat (void)
748 return make_scoped_restore (&suppress_dont_repeat, 1);
754 get_saved_command_line ()
756 return saved_command_line;
762 save_command_line (const char *cmd)
764 xfree (previous_saved_command_line);
765 previous_saved_command_line = saved_command_line;
766 previous_repeat_arguments = repeat_arguments;
767 saved_command_line = xstrdup (cmd);
768 repeat_arguments = NULL;
772 /* Read a line from the stream "instream" without command line editing.
774 It prints PROMPT once at the start.
775 Action is compatible with "readline", e.g. space for the result is
776 malloc'd and should be freed by the caller.
778 A NULL return means end of file. */
781 gdb_readline_no_editing (const char *prompt)
783 struct buffer line_buffer;
784 struct ui *ui = current_ui;
785 /* Read from stdin if we are executing a user defined command. This
786 is the right thing for prompt_for_continue, at least. */
787 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
788 int fd = fileno (stream);
790 buffer_init (&line_buffer);
794 /* Don't use a _filtered function here. It causes the assumed
795 character position to be off, since the newline we read from
796 the user is not accounted for. */
797 fputs_unfiltered (prompt, gdb_stdout);
798 gdb_flush (gdb_stdout);
808 /* Wait until at least one byte of data is available. Control-C
809 can interrupt interruptible_select, but not fgetc. */
811 FD_SET (fd, &readfds);
812 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
816 /* If this was ctrl-c, the QUIT above handles it. */
819 perror_with_name (("select"));
826 if (line_buffer.used_size > 0)
827 /* The last line does not end with a newline. Return it, and
828 if we are called again fgetc will still return EOF and
829 we'll return NULL then. */
831 xfree (buffer_finish (&line_buffer));
837 if (line_buffer.used_size > 0
838 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
839 line_buffer.used_size--;
843 buffer_grow_char (&line_buffer, c);
846 buffer_grow_char (&line_buffer, '\0');
847 return buffer_finish (&line_buffer);
850 /* Variables which control command line editing and history
851 substitution. These variables are given default values at the end
853 static int command_editing_p;
855 /* NOTE 1999-04-29: This variable will be static again, once we modify
856 gdb to use the event loop as the default command loop and we merge
857 event-top.c into this file, top.c. */
859 /* static */ int history_expansion_p;
861 static int write_history_p;
863 show_write_history_p (struct ui_file *file, int from_tty,
864 struct cmd_list_element *c, const char *value)
866 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
870 /* The variable associated with the "set/show history size"
871 command. The value -1 means unlimited, and -2 means undefined. */
872 static int history_size_setshow_var = -2;
875 show_history_size (struct ui_file *file, int from_tty,
876 struct cmd_list_element *c, const char *value)
878 fprintf_filtered (file, _("The size of the command history is %s.\n"),
882 /* Variable associated with the "history remove-duplicates" option.
883 The value -1 means unlimited. */
884 static int history_remove_duplicates = 0;
887 show_history_remove_duplicates (struct ui_file *file, int from_tty,
888 struct cmd_list_element *c, const char *value)
890 fprintf_filtered (file,
891 _("The number of history entries to look back at for "
892 "duplicates is %s.\n"),
896 static char *history_filename;
898 show_history_filename (struct ui_file *file, int from_tty,
899 struct cmd_list_element *c, const char *value)
901 fprintf_filtered (file, _("The filename in which to record "
902 "the command history is \"%s\".\n"),
906 /* This is like readline(), but it has some gdb-specific behavior.
907 gdb may want readline in both the synchronous and async modes during
908 a single gdb invocation. At the ordinary top-level prompt we might
909 be using the async readline. That means we can't use
910 rl_pre_input_hook, since it doesn't work properly in async mode.
911 However, for a secondary prompt (" >", such as occurs during a
912 `define'), gdb wants a synchronous response.
914 We used to call readline() directly, running it in synchronous
915 mode. But mixing modes this way is not supported, and as of
916 readline 5.x it no longer works; the arrow keys come unbound during
917 the synchronous call. So we make a nested call into the event
918 loop. That's what gdb_readline_wrapper is for. */
920 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
921 rely on gdb_readline_wrapper_result, which might still be NULL if
922 the user types Control-D for EOF. */
923 static int gdb_readline_wrapper_done;
925 /* The result of the current call to gdb_readline_wrapper, once a newline
927 static char *gdb_readline_wrapper_result;
929 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
930 to be called after the newline is processed (which will redisplay
931 the prompt). But in gdb_readline_wrapper we will not get a new
932 prompt until the next call, or until we return to the event loop.
933 So we disable this hook around the newline and restore it before we
935 static void (*saved_after_char_processing_hook) (void);
941 gdb_in_secondary_prompt_p (struct ui *ui)
943 return ui->secondary_prompt_depth > 0;
947 /* This function is called when readline has seen a complete line of
951 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr<char> &&line)
953 gdb_assert (!gdb_readline_wrapper_done);
954 gdb_readline_wrapper_result = line.release ();
955 gdb_readline_wrapper_done = 1;
957 /* Prevent operate-and-get-next from acting too early. */
958 saved_after_char_processing_hook = after_char_processing_hook;
959 after_char_processing_hook = NULL;
961 /* Prevent parts of the prompt from being redisplayed if annotations
962 are enabled, and readline's state getting out of sync. We'll
963 reinstall the callback handler, which puts the terminal in raw
964 mode (or in readline lingo, in prepped state), when we're next
965 ready to process user input, either in display_gdb_prompt, or if
966 we're handling an asynchronous target event and running in the
967 background, just before returning to the event loop to process
968 further input (or more target events). */
969 if (current_ui->command_editing)
970 gdb_rl_callback_handler_remove ();
973 class gdb_readline_wrapper_cleanup
976 gdb_readline_wrapper_cleanup ()
977 : m_handler_orig (current_ui->input_handler),
978 m_already_prompted_orig (current_ui->command_editing
979 ? rl_already_prompted : 0),
980 m_target_is_async_orig (target_is_async_p ()),
981 m_save_ui (¤t_ui)
983 current_ui->input_handler = gdb_readline_wrapper_line;
984 current_ui->secondary_prompt_depth++;
986 if (m_target_is_async_orig)
990 ~gdb_readline_wrapper_cleanup ()
992 struct ui *ui = current_ui;
994 if (ui->command_editing)
995 rl_already_prompted = m_already_prompted_orig;
997 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
998 ui->input_handler = m_handler_orig;
1000 /* Don't restore our input handler in readline yet. That would make
1001 readline prep the terminal (putting it in raw mode), while the
1002 line we just read may trigger execution of a command that expects
1003 the terminal in the default cooked/canonical mode, such as e.g.,
1004 running Python's interactive online help utility. See
1005 gdb_readline_wrapper_line for when we'll reinstall it. */
1007 gdb_readline_wrapper_result = NULL;
1008 gdb_readline_wrapper_done = 0;
1009 ui->secondary_prompt_depth--;
1010 gdb_assert (ui->secondary_prompt_depth >= 0);
1012 after_char_processing_hook = saved_after_char_processing_hook;
1013 saved_after_char_processing_hook = NULL;
1015 if (m_target_is_async_orig)
1019 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup);
1023 void (*m_handler_orig) (gdb::unique_xmalloc_ptr<char> &&);
1024 int m_already_prompted_orig;
1026 /* Whether the target was async. */
1027 int m_target_is_async_orig;
1029 /* Processing events may change the current UI. */
1030 scoped_restore_tmpl<struct ui *> m_save_ui;
1034 gdb_readline_wrapper (const char *prompt)
1036 struct ui *ui = current_ui;
1038 gdb_readline_wrapper_cleanup cleanup;
1040 /* Display our prompt and prevent double prompt display. Don't pass
1041 down a NULL prompt, since that has special meaning for
1042 display_gdb_prompt -- it indicates a request to print the primary
1043 prompt, while we want a secondary prompt here. */
1044 display_gdb_prompt (prompt != NULL ? prompt : "");
1045 if (ui->command_editing)
1046 rl_already_prompted = 1;
1048 if (after_char_processing_hook)
1049 (*after_char_processing_hook) ();
1050 gdb_assert (after_char_processing_hook == NULL);
1052 while (gdb_do_one_event () >= 0)
1053 if (gdb_readline_wrapper_done)
1056 return gdb_readline_wrapper_result;
1060 /* The current saved history number from operate-and-get-next.
1061 This is -1 if not valid. */
1062 static int operate_saved_history = -1;
1064 /* This is put on the appropriate hook and helps operate-and-get-next
1067 gdb_rl_operate_and_get_next_completion (void)
1069 int delta = where_history () - operate_saved_history;
1071 /* The `key' argument to rl_get_previous_history is ignored. */
1072 rl_get_previous_history (delta, 0);
1073 operate_saved_history = -1;
1075 /* readline doesn't automatically update the display for us. */
1078 after_char_processing_hook = NULL;
1079 rl_pre_input_hook = NULL;
1082 /* This is a gdb-local readline command handler. It accepts the
1083 current command line (like RET does) and, if this command was taken
1084 from the history, arranges for the next command in the history to
1085 appear on the command line when the prompt returns.
1086 We ignore the arguments. */
1088 gdb_rl_operate_and_get_next (int count, int key)
1092 /* Use the async hook. */
1093 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1095 /* Find the current line, and find the next line to use. */
1096 where = where_history();
1098 if ((history_is_stifled () && (history_length >= history_max_entries))
1099 || (where >= history_length - 1))
1100 operate_saved_history = where;
1102 operate_saved_history = where + 1;
1104 return rl_newline (1, key);
1107 /* Number of user commands executed during this session. */
1109 static int command_count = 0;
1111 /* Add the user command COMMAND to the input history list. */
1114 gdb_add_history (const char *command)
1118 if (history_remove_duplicates != 0)
1121 int lookbehind_threshold;
1123 /* The lookbehind threshold for finding a duplicate history entry is
1124 bounded by command_count because we can't meaningfully delete
1125 history entries that are already stored in the history file since
1126 the history file is appended to. */
1127 if (history_remove_duplicates == -1
1128 || history_remove_duplicates > command_count)
1129 lookbehind_threshold = command_count;
1131 lookbehind_threshold = history_remove_duplicates;
1134 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1136 HIST_ENTRY *temp = previous_history ();
1141 if (strcmp (temp->line, command) == 0)
1143 HIST_ENTRY *prev = remove_history (where_history ());
1145 free_history_entry (prev);
1152 add_history (command);
1155 /* Safely append new history entries to the history file in a corruption-free
1156 way using an intermediate local history file. */
1159 gdb_safe_append_history (void)
1161 int ret, saved_errno;
1163 std::string local_history_filename
1164 = string_printf ("%s-gdb%ld~", history_filename, (long) getpid ());
1166 ret = rename (history_filename, local_history_filename.c_str ());
1167 saved_errno = errno;
1168 if (ret < 0 && saved_errno != ENOENT)
1170 warning (_("Could not rename %s to %s: %s"),
1171 history_filename, local_history_filename.c_str (),
1172 safe_strerror (saved_errno));
1178 /* If the rename failed with ENOENT then either the global history
1179 file never existed in the first place or another GDB process is
1180 currently appending to it (and has thus temporarily renamed it).
1181 Since we can't distinguish between these two cases, we have to
1182 conservatively assume the first case and therefore must write out
1183 (not append) our known history to our local history file and try
1184 to move it back anyway. Otherwise a global history file would
1185 never get created! */
1186 gdb_assert (saved_errno == ENOENT);
1187 write_history (local_history_filename.c_str ());
1191 append_history (command_count, local_history_filename.c_str ());
1192 if (history_is_stifled ())
1193 history_truncate_file (local_history_filename.c_str (),
1194 history_max_entries);
1197 ret = rename (local_history_filename.c_str (), history_filename);
1198 saved_errno = errno;
1199 if (ret < 0 && saved_errno != EEXIST)
1200 warning (_("Could not rename %s to %s: %s"),
1201 local_history_filename.c_str (), history_filename,
1202 safe_strerror (saved_errno));
1206 /* Read one line from the command input stream `instream' into a local
1207 static buffer. The buffer is made bigger as necessary. Returns
1208 the address of the start of the line.
1210 NULL is returned for end of file.
1212 This routine either uses fancy command line editing or simple input
1213 as the user has requested. */
1216 command_line_input (const char *prompt_arg, const char *annotation_suffix)
1218 static struct buffer cmd_line_buffer;
1219 static int cmd_line_buffer_initialized;
1220 struct ui *ui = current_ui;
1221 const char *prompt = prompt_arg;
1223 int from_tty = ui->instream == ui->stdin_stream;
1225 /* The annotation suffix must be non-NULL. */
1226 if (annotation_suffix == NULL)
1227 annotation_suffix = "";
1229 if (from_tty && annotation_level > 1)
1234 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1235 + strlen (annotation_suffix) + 40);
1237 local_prompt[0] = '\0';
1239 strcpy (local_prompt, prompt);
1240 strcat (local_prompt, "\n\032\032");
1241 strcat (local_prompt, annotation_suffix);
1242 strcat (local_prompt, "\n");
1244 prompt = local_prompt;
1247 if (!cmd_line_buffer_initialized)
1249 buffer_init (&cmd_line_buffer);
1250 cmd_line_buffer_initialized = 1;
1253 /* Starting a new command line. */
1254 cmd_line_buffer.used_size = 0;
1258 signal (SIGTSTP, handle_sigtstp);
1263 gdb::unique_xmalloc_ptr<char> rl;
1265 /* Make sure that all output has been output. Some machines may
1266 let you get away with leaving out some of the gdb_flush, but
1269 gdb_flush (gdb_stdout);
1270 gdb_flush (gdb_stderr);
1272 if (!source_file_name.empty ())
1273 ++source_line_number;
1275 if (from_tty && annotation_level > 1)
1277 puts_unfiltered ("\n\032\032pre-");
1278 puts_unfiltered (annotation_suffix);
1279 puts_unfiltered ("\n");
1282 /* Don't use fancy stuff if not talking to stdin. */
1283 if (deprecated_readline_hook
1285 && input_interactive_p (current_ui))
1287 rl.reset ((*deprecated_readline_hook) (prompt));
1289 else if (command_editing_p
1291 && input_interactive_p (current_ui))
1293 rl.reset (gdb_readline_wrapper (prompt));
1297 rl.reset (gdb_readline_no_editing (prompt));
1300 cmd = handle_line_of_input (&cmd_line_buffer, rl.get (),
1301 0, annotation_suffix);
1302 if (cmd == (char *) EOF)
1310 /* Got partial input. I.e., got a line that ends with a
1311 continuation character (backslash). Suppress printing the
1318 signal (SIGTSTP, SIG_DFL);
1326 print_gdb_version (struct ui_file *stream, bool interactive)
1328 /* From GNU coding standards, first line is meant to be easy for a
1329 program to parse, and is just canonical program name and version
1330 number, which starts after last space. */
1332 ui_file_style style;
1335 ui_file_style nstyle = { ui_file_style::MAGENTA, ui_file_style::NONE,
1336 ui_file_style::BOLD };
1339 fprintf_styled (stream, style, "GNU gdb %s%s\n", PKGVERSION, version);
1341 /* Second line is a copyright notice. */
1343 fprintf_filtered (stream,
1344 "Copyright (C) 2019 Free Software Foundation, Inc.\n");
1346 /* Following the copyright is a brief statement that the program is
1347 free software, that users are free to copy and change it on
1348 certain conditions, that it is covered by the GNU GPL, and that
1349 there is no warranty. */
1351 fprintf_filtered (stream, "\
1352 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1353 \nThis is free software: you are free to change and redistribute it.\n\
1354 There is NO WARRANTY, to the extent permitted by law.");
1359 fprintf_filtered (stream, ("\nType \"show copying\" and "
1360 "\"show warranty\" for details.\n"));
1362 /* After the required info we print the configuration information. */
1364 fprintf_filtered (stream, "This GDB was configured as \"");
1365 if (strcmp (host_name, target_name) != 0)
1367 fprintf_filtered (stream, "--host=%s --target=%s",
1368 host_name, target_name);
1372 fprintf_filtered (stream, "%s", host_name);
1374 fprintf_filtered (stream, "\".\n");
1376 fprintf_filtered (stream, _("Type \"show configuration\" "
1377 "for configuration details.\n"));
1379 if (REPORT_BUGS_TO[0])
1381 fprintf_filtered (stream,
1382 _("For bug reporting instructions, please see:\n"));
1383 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1385 fprintf_filtered (stream,
1386 _("Find the GDB manual and other documentation \
1387 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1388 fprintf_filtered (stream, "\n\n");
1389 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1390 fprintf_filtered (stream,
1391 _("Type \"apropos word\" to search for commands \
1392 related to \"word\"."));
1395 /* Print the details of GDB build-time configuration. */
1397 print_gdb_configuration (struct ui_file *stream)
1399 fprintf_filtered (stream, _("\
1400 This GDB was configured as follows:\n\
1401 configure --host=%s --target=%s\n\
1402 "), host_name, target_name);
1403 fprintf_filtered (stream, _("\
1404 --with-auto-load-dir=%s\n\
1405 --with-auto-load-safe-path=%s\n\
1406 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1408 fprintf_filtered (stream, _("\
1412 fprintf_filtered (stream, _("\
1417 fprintf_filtered (stream, _("\
1418 --with-gdb-datadir=%s%s\n\
1419 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1421 fprintf_filtered (stream, _("\
1422 --with-iconv-bin=%s%s\n\
1423 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1425 if (JIT_READER_DIR[0])
1426 fprintf_filtered (stream, _("\
1427 --with-jit-reader-dir=%s%s\n\
1428 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1429 #if HAVE_LIBUNWIND_IA64_H
1430 fprintf_filtered (stream, _("\
1431 --with-libunwind-ia64\n\
1434 fprintf_filtered (stream, _("\
1435 --without-libunwind-ia64\n\
1439 fprintf_filtered (stream, _("\
1443 fprintf_filtered (stream, _("\
1447 #if HAVE_LIBBABELTRACE
1448 fprintf_filtered (stream, _("\
1449 --with-babeltrace\n\
1452 fprintf_filtered (stream, _("\
1453 --without-babeltrace\n\
1457 fprintf_filtered (stream, _("\
1461 fprintf_filtered (stream, _("\
1462 --without-intel-pt\n\
1466 fprintf_filtered (stream, _("\
1467 --enable-libmcheck\n\
1470 fprintf_filtered (stream, _("\
1471 --disable-libmcheck\n\
1475 fprintf_filtered (stream, _("\
1479 fprintf_filtered (stream, _("\
1483 #ifdef WITH_PYTHON_PATH
1484 fprintf_filtered (stream, _("\
1485 --with-python=%s%s\n\
1486 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1488 fprintf_filtered (stream, _("\
1493 fprintf_filtered (stream, _("\
1497 fprintf_filtered (stream, _("\
1501 #if HAVE_SOURCE_HIGHLIGHT
1502 fprintf_filtered (stream, _("\
1503 --enable-source-highlight\n\
1506 fprintf_filtered (stream, _("\
1507 --disable-source-highlight\n\
1511 fprintf_filtered (stream, _("\
1512 --with-relocated-sources=%s\n\
1516 fprintf_filtered (stream, _("\
1517 --with-separate-debug-dir=%s%s\n\
1518 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1519 if (TARGET_SYSTEM_ROOT[0])
1520 fprintf_filtered (stream, _("\
1521 --with-sysroot=%s%s\n\
1522 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1523 if (SYSTEM_GDBINIT[0])
1524 fprintf_filtered (stream, _("\
1525 --with-system-gdbinit=%s%s\n\
1526 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1527 /* We assume "relocatable" will be printed at least once, thus we always
1528 print this text. It's a reasonably safe assumption for now. */
1529 fprintf_filtered (stream, _("\n\
1530 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1531 tree, and GDB will still find it.)\n\
1536 /* The current top level prompt, settable with "set prompt", and/or
1537 with the python `gdb.prompt_hook' hook. */
1538 static char *top_prompt;
1540 /* Access method for the GDB prompt string. */
1548 /* Set method for the GDB prompt string. */
1551 set_prompt (const char *s)
1553 char *p = xstrdup (s);
1565 /* Callback for iterate_over_inferiors. Kills or detaches the given
1566 inferior, depending on how we originally gained control of it. */
1569 kill_or_detach (struct inferior *inf, void *args)
1571 struct qt_args *qt = (struct qt_args *) args;
1576 thread_info *thread = any_thread_of_inferior (inf);
1579 switch_to_thread (thread);
1581 /* Leave core files alone. */
1582 if (target_has_execution)
1584 if (inf->attach_flag)
1585 target_detach (inf, qt->from_tty);
1594 /* Callback for iterate_over_inferiors. Prints info about what GDB
1595 will do to each inferior on a "quit". ARG points to a struct
1596 ui_out where output is to be collected. */
1599 print_inferior_quit_action (struct inferior *inf, void *arg)
1601 struct ui_file *stb = (struct ui_file *) arg;
1606 if (inf->attach_flag)
1607 fprintf_filtered (stb,
1608 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1609 target_pid_to_str (ptid_t (inf->pid)).c_str ());
1611 fprintf_filtered (stb,
1612 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1613 target_pid_to_str (ptid_t (inf->pid)).c_str ());
1618 /* If necessary, make the user confirm that we should quit. Return
1619 non-zero if we should quit, zero if we shouldn't. */
1624 /* Don't even ask if we're only debugging a core file inferior. */
1625 if (!have_live_inferiors ())
1628 /* Build the query string as a single string. */
1631 stb.puts (_("A debugging session is active.\n\n"));
1632 iterate_over_inferiors (print_inferior_quit_action, &stb);
1633 stb.puts (_("\nQuit anyway? "));
1635 return query ("%s", stb.c_str ());
1638 /* Prepare to exit GDB cleanly by undoing any changes made to the
1639 terminal so that we leave the terminal in the state we acquired it. */
1642 undo_terminal_modifications_before_exit (void)
1644 struct ui *saved_top_level = current_ui;
1646 target_terminal::ours ();
1648 current_ui = main_ui;
1653 gdb_disable_readline ();
1655 current_ui = saved_top_level;
1659 /* Quit without asking for confirmation. */
1662 quit_force (int *exit_arg, int from_tty)
1667 undo_terminal_modifications_before_exit ();
1669 /* An optional expression may be used to cause gdb to terminate with the
1670 value of that expression. */
1672 exit_code = *exit_arg;
1673 else if (return_child_result)
1674 exit_code = return_child_result_value;
1676 qt.from_tty = from_tty;
1678 /* We want to handle any quit errors and exit regardless. */
1680 /* Get out of tfind mode, and kill or detach all inferiors. */
1683 disconnect_tracing ();
1684 iterate_over_inferiors (kill_or_detach, &qt);
1686 catch (const gdb_exception &ex)
1688 exception_print (gdb_stderr, ex);
1691 /* Give all pushed targets a chance to do minimal cleanup, and pop
1697 catch (const gdb_exception &ex)
1699 exception_print (gdb_stderr, ex);
1702 /* Save the history information if it is appropriate to do so. */
1705 if (write_history_p && history_filename)
1710 /* History is currently shared between all UIs. If there's
1711 any UI with a terminal, save history. */
1714 if (input_interactive_p (ui))
1722 gdb_safe_append_history ();
1725 catch (const gdb_exception &ex)
1727 exception_print (gdb_stderr, ex);
1730 /* Destroy any values currently allocated now instead of leaving it
1731 to global destructors, because that may be too late. For
1732 example, the destructors of xmethod values call into the Python
1733 runtime, which is finalized via a final cleanup. */
1736 /* Do any final cleanups before exiting. */
1739 do_final_cleanups ();
1741 catch (const gdb_exception &ex)
1743 exception_print (gdb_stderr, ex);
1749 /* The value of the "interactive-mode" setting. */
1750 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1752 /* Implement the "show interactive-mode" option. */
1755 show_interactive_mode (struct ui_file *file, int from_tty,
1756 struct cmd_list_element *c,
1759 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1760 fprintf_filtered (file, "Debugger's interactive mode "
1761 "is %s (currently %s).\n",
1762 value, input_interactive_p (current_ui) ? "on" : "off");
1764 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1767 /* Returns whether GDB is running on an interactive terminal. */
1770 input_interactive_p (struct ui *ui)
1775 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1776 return interactive_mode == AUTO_BOOLEAN_TRUE;
1778 return ui->input_interactive_p;
1782 dont_repeat_command (const char *ignored, int from_tty)
1784 /* Can't call dont_repeat here because we're not necessarily reading
1786 *saved_command_line = 0;
1789 /* Functions to manipulate command line editing control variables. */
1791 /* Number of commands to print in each call to show_commands. */
1792 #define Hist_print 10
1794 show_commands (const char *args, int from_tty)
1796 /* Index for history commands. Relative to history_base. */
1799 /* Number of the history entry which we are planning to display next.
1800 Relative to history_base. */
1803 /* Print out some of the commands from the command history. */
1807 if (args[0] == '+' && args[1] == '\0')
1808 /* "info editing +" should print from the stored position. */
1811 /* "info editing <exp>" should print around command number <exp>. */
1812 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1814 /* "show commands" means print the last Hist_print commands. */
1817 num = history_length - Hist_print;
1823 /* If there are at least Hist_print commands, we want to display the last
1824 Hist_print rather than, say, the last 6. */
1825 if (history_length - num < Hist_print)
1827 num = history_length - Hist_print;
1833 offset < num + Hist_print && offset < history_length;
1836 printf_filtered ("%5d %s\n", history_base + offset,
1837 (history_get (history_base + offset))->line);
1840 /* The next command we want to display is the next one that we haven't
1844 /* If the user repeats this command with return, it should do what
1845 "show commands +" does. This is unnecessary if arg is null,
1846 because "show commands +" is not useful after "show commands". */
1847 if (from_tty && args)
1848 set_repeat_arguments ("+");
1851 /* Update the size of our command history file to HISTORY_SIZE.
1853 A HISTORY_SIZE of -1 stands for unlimited. */
1856 set_readline_history_size (int history_size)
1858 gdb_assert (history_size >= -1);
1860 if (history_size == -1)
1861 unstifle_history ();
1863 stifle_history (history_size);
1866 /* Called by do_setshow_command. */
1868 set_history_size_command (const char *args,
1869 int from_tty, struct cmd_list_element *c)
1871 set_readline_history_size (history_size_setshow_var);
1875 set_history (const char *args, int from_tty)
1877 printf_unfiltered (_("\"set history\" must be followed "
1878 "by the name of a history subcommand.\n"));
1879 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1883 show_history (const char *args, int from_tty)
1885 cmd_show_list (showhistlist, from_tty, "");
1888 int info_verbose = 0; /* Default verbose msgs off. */
1890 /* Called by do_set_command. An elaborate joke. */
1892 set_verbose (const char *args, int from_tty, struct cmd_list_element *c)
1894 const char *cmdname = "verbose";
1895 struct cmd_list_element *showcmd;
1897 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1898 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1900 if (c->doc && c->doc_allocated)
1901 xfree ((char *) c->doc);
1902 if (showcmd->doc && showcmd->doc_allocated)
1903 xfree ((char *) showcmd->doc);
1906 c->doc = _("Set verbose printing of informational messages.");
1907 showcmd->doc = _("Show verbose printing of informational messages.");
1911 c->doc = _("Set verbosity.");
1912 showcmd->doc = _("Show verbosity.");
1914 c->doc_allocated = 0;
1915 showcmd->doc_allocated = 0;
1918 /* Init the history buffer. Note that we are called after the init file(s)
1919 have been read so that the user can change the history file via his
1920 .gdbinit file (for instance). The GDBHISTFILE environment variable
1921 overrides all of this. */
1928 tmpenv = getenv ("GDBHISTSIZE");
1935 tmpenv = skip_spaces (tmpenv);
1937 var = strtol (tmpenv, &endptr, 10);
1938 saved_errno = errno;
1939 endptr = skip_spaces (endptr);
1941 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1942 empty string, a negative number or a huge positive number (larger than
1943 INT_MAX) then set the history size to unlimited. Otherwise set our
1944 history size to the number we have read. This behavior is consistent
1945 with how bash handles HISTSIZE. */
1946 if (*endptr != '\0')
1948 else if (*tmpenv == '\0'
1951 /* On targets where INT_MAX == LONG_MAX, we have to look at
1952 errno after calling strtol to distinguish between a value that
1953 is exactly INT_MAX and an overflowing value that was clamped
1955 || (var == INT_MAX && saved_errno == ERANGE))
1956 history_size_setshow_var = -1;
1958 history_size_setshow_var = var;
1961 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1963 if (history_size_setshow_var == -2)
1964 history_size_setshow_var = 256;
1966 set_readline_history_size (history_size_setshow_var);
1968 tmpenv = getenv ("GDBHISTFILE");
1970 history_filename = xstrdup (tmpenv);
1971 else if (!history_filename)
1973 /* We include the current directory so that if the user changes
1974 directories the file written will be the same as the one
1977 /* No leading dots in file names are allowed on MSDOS. */
1978 history_filename = concat (current_directory, "/_gdb_history",
1981 history_filename = concat (current_directory, "/.gdb_history",
1985 read_history (history_filename);
1989 show_prompt (struct ui_file *file, int from_tty,
1990 struct cmd_list_element *c, const char *value)
1992 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1995 /* "set editing" command. */
1998 set_editing (const char *args, int from_tty, struct cmd_list_element *c)
2000 change_line_handler (set_editing_cmd_var);
2001 /* Update the control variable so that MI's =cmd-param-changed event
2002 shows the correct value. */
2003 set_editing_cmd_var = current_ui->command_editing;
2007 show_editing (struct ui_file *file, int from_tty,
2008 struct cmd_list_element *c, const char *value)
2010 fprintf_filtered (file, _("Editing of command lines as "
2011 "they are typed is %s.\n"),
2012 current_ui->command_editing ? _("on") : _("off"));
2016 show_annotation_level (struct ui_file *file, int from_tty,
2017 struct cmd_list_element *c, const char *value)
2019 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
2023 show_exec_done_display_p (struct ui_file *file, int from_tty,
2024 struct cmd_list_element *c, const char *value)
2026 fprintf_filtered (file, _("Notification of completion for "
2027 "asynchronous execution commands is %s.\n"),
2031 /* New values of the "data-directory" parameter are staged here. */
2032 static char *staged_gdb_datadir;
2034 /* "set" command for the gdb_datadir configuration variable. */
2037 set_gdb_datadir (const char *args, int from_tty, struct cmd_list_element *c)
2039 set_gdb_data_directory (staged_gdb_datadir);
2040 gdb::observers::gdb_datadir_changed.notify ();
2043 /* "show" command for the gdb_datadir configuration variable. */
2046 show_gdb_datadir (struct ui_file *file, int from_tty,
2047 struct cmd_list_element *c, const char *value)
2049 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
2054 set_history_filename (const char *args,
2055 int from_tty, struct cmd_list_element *c)
2057 /* We include the current directory so that if the user changes
2058 directories the file written will be the same as the one
2060 if (!IS_ABSOLUTE_PATH (history_filename))
2061 history_filename = reconcat (history_filename, current_directory, "/",
2062 history_filename, (char *) NULL);
2066 init_gdb_version_vars (void)
2068 struct internalvar *major_version_var = create_internalvar ("_gdb_major");
2069 struct internalvar *minor_version_var = create_internalvar ("_gdb_minor");
2070 int vmajor = 0, vminor = 0, vrevision = 0;
2071 sscanf (version, "%d.%d.%d", &vmajor, &vminor, &vrevision);
2072 set_internalvar_integer (major_version_var, vmajor);
2073 set_internalvar_integer (minor_version_var, vminor + (vrevision > 0));
2079 struct cmd_list_element *c;
2081 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2082 the DEFAULT_PROMPT is. */
2083 set_prompt (DEFAULT_PROMPT);
2085 /* Set the important stuff up for command editing. */
2086 command_editing_p = 1;
2087 history_expansion_p = 0;
2088 write_history_p = 0;
2090 /* Setup important stuff for command line editing. */
2091 rl_completion_word_break_hook = gdb_completion_word_break_characters;
2092 rl_attempted_completion_function = gdb_rl_attempted_completion_function;
2093 set_rl_completer_word_break_characters (default_word_break_characters ());
2094 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
2095 rl_completion_display_matches_hook = cli_display_match_list;
2096 rl_readline_name = "gdb";
2097 rl_terminal_name = getenv ("TERM");
2099 /* The name for this defun comes from Bash, where it originated.
2100 15 is Control-o, the same binding this function has in Bash. */
2101 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2103 add_setshow_string_cmd ("prompt", class_support,
2105 _("Set gdb's prompt"),
2106 _("Show gdb's prompt"),
2109 &setlist, &showlist);
2111 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2112 Don't repeat this command.\nPrimarily \
2113 used inside of user-defined commands that should not be repeated when\n\
2116 add_setshow_boolean_cmd ("editing", class_support,
2117 &set_editing_cmd_var, _("\
2118 Set editing of command lines as they are typed."), _("\
2119 Show editing of command lines as they are typed."), _("\
2120 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2121 Without an argument, command line editing is enabled. To edit, use\n\
2122 EMACS-like or VI-like commands like control-P or ESC."),
2125 &setlist, &showlist);
2127 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2128 Set saving of the history record on exit."), _("\
2129 Show saving of the history record on exit."), _("\
2130 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2131 Without an argument, saving is enabled."),
2133 show_write_history_p,
2134 &sethistlist, &showhistlist);
2136 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2137 &history_size_setshow_var, _("\
2138 Set the size of the command history,"), _("\
2139 Show the size of the command history,"), _("\
2140 ie. the number of previous commands to keep a record of.\n\
2141 If set to \"unlimited\", the number of commands kept in the history\n\
2142 list is unlimited. This defaults to the value of the environment\n\
2143 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2144 set_history_size_command,
2146 &sethistlist, &showhistlist);
2148 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2149 &history_remove_duplicates, _("\
2150 Set how far back in history to look for and remove duplicate entries."), _("\
2151 Show how far back in history to look for and remove duplicate entries."), _("\
2152 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2153 and remove the first history entry that is a duplicate of the most recent\n\
2154 entry, each time a new history entry is added.\n\
2155 If set to \"unlimited\", this lookbehind is unbounded.\n\
2156 Only history entries added during this session are considered for removal.\n\
2157 If set to 0, removal of duplicate history entries is disabled.\n\
2158 By default this option is set to 0."),
2160 show_history_remove_duplicates,
2161 &sethistlist, &showhistlist);
2163 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2164 Set the filename in which to record the command history"), _("\
2165 Show the filename in which to record the command history"), _("\
2166 (the list of previous commands of which a record is kept)."),
2167 set_history_filename,
2168 show_history_filename,
2169 &sethistlist, &showhistlist);
2171 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2172 Set whether to confirm potentially dangerous operations."), _("\
2173 Show whether to confirm potentially dangerous operations."), NULL,
2176 &setlist, &showlist);
2178 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2179 Set annotation_level."), _("\
2180 Show annotation_level."), _("\
2181 0 == normal; 1 == fullname (for use when running under emacs)\n\
2182 2 == output annotated suitably for use by programs that control GDB."),
2184 show_annotation_level,
2185 &setlist, &showlist);
2187 add_setshow_boolean_cmd ("exec-done-display", class_support,
2188 &exec_done_display_p, _("\
2189 Set notification of completion for asynchronous execution commands."), _("\
2190 Show notification of completion for asynchronous execution commands."), _("\
2191 Use \"on\" to enable the notification, and \"off\" to disable it."),
2193 show_exec_done_display_p,
2194 &setlist, &showlist);
2196 add_setshow_filename_cmd ("data-directory", class_maintenance,
2197 &staged_gdb_datadir, _("Set GDB's data directory."),
2198 _("Show GDB's data directory."),
2200 When set, GDB uses the specified path to search for data files."),
2201 set_gdb_datadir, show_gdb_datadir,
2205 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2206 &interactive_mode, _("\
2207 Set whether GDB's standard input is a terminal."), _("\
2208 Show whether GDB's standard input is a terminal."), _("\
2209 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2210 means that GDB should wait for the user to answer queries associated to\n\
2211 commands entered at the command prompt. If off, GDB assumes that standard\n\
2212 input is not a terminal, and uses the default answer to all queries.\n\
2213 If auto (the default), determine which mode to use based on the standard\n\
2216 show_interactive_mode,
2217 &setlist, &showlist);
2219 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2220 Create a new UI. It takes two arguments:\n\
2221 The first argument is the name of the interpreter to run.\n\
2222 The second argument is the terminal the UI runs on."), &cmdlist);
2223 set_cmd_completer (c, interpreter_completer);
2227 gdb_init (char *argv0)
2229 saved_command_line = xstrdup ("");
2230 previous_saved_command_line = xstrdup ("");
2232 if (pre_init_ui_hook)
2233 pre_init_ui_hook ();
2235 /* Run the init function of each source file. */
2238 /* Make sure we return to the original directory upon exit, come
2239 what may, since the OS doesn't do that for us. */
2240 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2243 init_cmd_lists (); /* This needs to be done first. */
2244 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2245 initialize_utils (); /* Make errors and warnings possible. */
2249 /* Here is where we call all the _initialize_foo routines. */
2250 initialize_all_files ();
2252 /* This creates the current_program_space. Do this after all the
2253 _initialize_foo routines have had a chance to install their
2254 per-sspace data keys. Also do this before
2255 initialize_current_architecture is called, because it accesses
2256 exec_bfd of the current program space. */
2257 initialize_progspace ();
2258 initialize_inferiors ();
2259 initialize_current_architecture ();
2260 init_main (); /* But that omits this file! Do it now. */
2262 initialize_stdin_serial ();
2264 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2266 set_initial_gdb_ttystate ();
2268 async_init_signals ();
2270 /* We need a default language for parsing expressions, so simple
2271 things like "set width 0" won't fail if no language is explicitly
2272 set in a config file or implicitly set by reading an executable
2274 set_language (language_c);
2275 expected_language = current_language; /* Don't warn about the change. */
2277 /* Python initialization, for example, can require various commands to be
2278 installed. For example "info pretty-printer" needs the "info"
2279 prefix to be installed. Keep things simple and just do final
2280 script initialization here. */
2281 finish_ext_lang_initialization ();
2283 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2284 init_gdb_version_vars ();