1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2018 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"
37 #include "terminal.h" /* For job_control. */
38 #include "job-control.h"
40 #include "completer.h"
45 #include "event-loop.h"
46 #include "gdbthread.h"
47 #include "extension.h"
49 #include "observable.h"
51 #include "filenames.h"
54 #include "gdb_select.h"
56 /* readline include files. */
57 #include "readline/readline.h"
58 #include "readline/history.h"
60 /* readline defines this. */
63 #include <sys/types.h>
65 #include "event-top.h"
70 #include "tracepoint.h"
81 extern void initialize_all_files (void);
83 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
84 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
85 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
87 /* Default command line prompt. This is overriden in some configs. */
89 #ifndef DEFAULT_PROMPT
90 #define DEFAULT_PROMPT "(gdb) "
93 /* Generate a function that exports a pointer to a field of the
96 #define gen_ret_current_ui_field_ptr(type, name) \
98 current_ui_## name ## _ptr (void) \
100 return ¤t_ui->m_ ## name; \
103 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdout)
104 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdin)
105 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stderr)
106 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdlog)
107 gen_ret_current_ui_field_ptr (struct ui_out *, current_uiout)
109 /* Initialization file name for gdb. This is host-dependent. */
111 const char gdbinit[] = GDBINIT;
113 int inhibit_gdbinit = 0;
115 extern char lang_frame_mismatch_warn[]; /* language.c */
117 /* Flag for whether we want to confirm potentially dangerous
118 operations. Default is yes. */
123 show_confirm (struct ui_file *file, int from_tty,
124 struct cmd_list_element *c, const char *value)
126 fprintf_filtered (file, _("Whether to confirm potentially "
127 "dangerous operations is %s.\n"),
131 /* Current working directory. */
133 char *current_directory;
135 /* The last command line executed on the console. Used for command
137 char *saved_command_line;
139 /* Nonzero if the current command is modified by "server ". This
140 affects things like recording into the command history, commands
141 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
142 whatever) can issue its own commands and also send along commands
143 from the user, and have the user not notice that the user interface
144 is issuing commands too. */
147 /* Timeout limit for response from target. */
149 /* The default value has been changed many times over the years. It
150 was originally 5 seconds. But that was thought to be a long time
151 to sit and wait, so it was changed to 2 seconds. That was thought
152 to be plenty unless the connection was going through some terminal
153 server or multiplexer or other form of hairy serial connection.
155 In mid-1996, remote_timeout was moved from remote.c to top.c and
156 it began being used in other remote-* targets. It appears that the
157 default was changed to 20 seconds at that time, perhaps because the
158 Renesas E7000 ICE didn't always respond in a timely manner.
160 But if 5 seconds is a long time to sit and wait for retransmissions,
161 20 seconds is far worse. This demonstrates the difficulty of using
162 a single variable for all protocol timeouts.
164 As remote.c is used much more than remote-e7000.c, it was changed
165 back to 2 seconds in 1999. */
167 int remote_timeout = 2;
169 /* Non-zero tells remote* modules to output debugging info. */
171 int remote_debug = 0;
173 /* Sbrk location on entry to main. Used for statistics only. */
178 /* Hooks for alternate command interfaces. */
180 /* This hook is called from within gdb's many mini-event loops which
181 could steal control from a real user interface's event loop. It
182 returns non-zero if the user is requesting a detach, zero
185 int (*deprecated_ui_loop_hook) (int);
188 /* Called from print_frame_info to list the line we stopped in. */
190 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
194 /* Replaces most of query. */
196 int (*deprecated_query_hook) (const char *, va_list);
198 /* Replaces most of warning. */
200 void (*deprecated_warning_hook) (const char *, va_list);
202 /* These three functions support getting lines of text from the user.
203 They are used in sequence. First deprecated_readline_begin_hook is
204 called with a text string that might be (for example) a message for
205 the user to type in a sequence of commands to be executed at a
206 breakpoint. If this function calls back to a GUI, it might take
207 this opportunity to pop up a text interaction window with this
208 message. Next, deprecated_readline_hook is called with a prompt
209 that is emitted prior to collecting the user input. It can be
210 called multiple times. Finally, deprecated_readline_end_hook is
211 called to notify the GUI that we are done with the interaction
212 window and it can close it. */
214 void (*deprecated_readline_begin_hook) (const char *, ...);
215 char *(*deprecated_readline_hook) (const char *);
216 void (*deprecated_readline_end_hook) (void);
218 /* Called as appropriate to notify the interface that we have attached
219 to or detached from an already running process. */
221 void (*deprecated_attach_hook) (void);
222 void (*deprecated_detach_hook) (void);
224 /* Called during long calculations to allow GUI to repair window
225 damage, and to check for stop buttons, etc... */
227 void (*deprecated_interactive_hook) (void);
229 /* Called when going to wait for the target. Usually allows the GUI
230 to run while waiting for target events. */
232 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
233 struct target_waitstatus *status,
236 /* Used by UI as a wrapper around command execution. May do various
237 things like enabling/disabling buttons, etc... */
239 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
240 const char *cmd, int from_tty);
242 /* Called when the current thread changes. Argument is thread id. */
244 void (*deprecated_context_hook) (int id);
246 /* The highest UI number ever assigned. */
247 static int highest_ui_num;
251 ui::ui (FILE *instream_, FILE *outstream_, FILE *errstream_)
253 num (++highest_ui_num),
254 call_readline (nullptr),
255 input_handler (nullptr),
257 interp_info (nullptr),
259 secondary_prompt_depth (0),
260 stdin_stream (instream_),
261 instream (instream_),
262 outstream (outstream_),
263 errstream (errstream_),
264 input_fd (fileno (instream)),
265 input_interactive_p (ISATTY (instream)),
266 prompt_state (PROMPT_NEEDED),
267 m_gdb_stdout (new stdio_file (outstream)),
268 m_gdb_stdin (new stdio_file (instream)),
269 m_gdb_stderr (new stderr_file (errstream)),
270 m_gdb_stdlog (m_gdb_stderr),
271 m_current_uiout (nullptr)
273 buffer_init (&line_buffer);
281 for (last = ui_list; last->next != NULL; last = last->next)
289 struct ui *ui, *uiprev;
293 for (ui = ui_list; ui != NULL; uiprev = ui, ui = ui->next)
297 gdb_assert (ui != NULL);
309 /* Open file named NAME for read/write, making sure not to make it the
310 controlling terminal. */
313 open_terminal_stream (const char *name)
317 fd = gdb_open_cloexec (name, O_RDWR | O_NOCTTY, 0);
319 perror_with_name (_("opening terminal failed"));
321 return gdb_file_up (fdopen (fd, "w+"));
324 /* Implementation of the "new-ui" command. */
327 new_ui_command (const char *args, int from_tty)
329 gdb_file_up stream[3];
332 const char *interpreter_name;
333 const char *tty_name;
337 gdb_argv argv (args);
338 argc = argv.count ();
341 error (_("usage: new-ui <interpreter> <tty>"));
343 interpreter_name = argv[0];
347 scoped_restore save_ui = make_scoped_restore (¤t_ui);
349 /* Open specified terminal, once for each of
350 stdin/stdout/stderr. */
351 for (i = 0; i < 3; i++)
352 stream[i] = open_terminal_stream (tty_name);
354 std::unique_ptr<ui> ui
355 (new struct ui (stream[0].get (), stream[1].get (), stream[2].get ()));
359 current_ui = ui.get ();
361 set_top_level_interpreter (interpreter_name);
363 interp_pre_command_loop (top_level_interpreter ());
365 /* Make sure the files are not closed. */
366 stream[0].release ();
367 stream[1].release ();
368 stream[2].release ();
373 printf_unfiltered ("New UI allocated\n");
376 /* Handler for SIGHUP. */
379 /* NOTE 1999-04-29: This function will be static again, once we modify
380 gdb to use the event loop as the default command loop and we merge
381 event-top.c into this file, top.c. */
385 /* Stop asking user for confirmation --- we're exiting. This
386 prevents asking the user dumb questions. */
388 quit_command ((char *) 0, 0);
390 #endif /* defined SIGHUP */
392 /* Line number we are currently in, in a file which is being sourced. */
393 /* NOTE 1999-04-29: This variable will be static again, once we modify
394 gdb to use the event loop as the default command loop and we merge
395 event-top.c into this file, top.c. */
396 /* static */ int source_line_number;
398 /* Name of the file we are sourcing. */
399 /* NOTE 1999-04-29: This variable will be static again, once we modify
400 gdb to use the event loop as the default command loop and we merge
401 event-top.c into this file, top.c. */
402 /* static */ const char *source_file_name;
404 /* Read commands from STREAM. */
406 read_command_file (FILE *stream)
408 struct ui *ui = current_ui;
410 scoped_restore save_instream
411 = make_scoped_restore (&ui->instream, stream);
413 /* Read commands from `instream' and execute them until end of file
414 or error reading instream. */
416 while (ui->instream != NULL && !feof (ui->instream))
420 /* Get a command-line. This calls the readline package. */
421 command = command_line_input (NULL, 0, NULL);
424 command_handler (command);
428 void (*pre_init_ui_hook) (void);
432 do_chdir_cleanup (void *old_dir)
434 chdir ((const char *) old_dir);
440 prepare_execute_command ()
442 /* With multiple threads running while the one we're examining is
443 stopped, the dcache can get stale without us being able to detect
444 it. For the duration of the command, though, use the dcache to
445 help things like backtrace. */
447 target_dcache_invalidate ();
449 return scoped_value_mark ();
452 /* Tell the user if the language has changed (except first time) after
453 executing a command. */
456 check_frame_language_change (void)
458 static int warned = 0;
459 struct frame_info *frame;
461 /* First make sure that a new frame has been selected, in case the
462 command or the hooks changed the program state. */
463 frame = deprecated_safe_get_selected_frame ();
464 if (current_language != expected_language)
466 if (language_mode == language_mode_auto && info_verbose)
468 language_info (1); /* Print what changed. */
473 /* Warn the user if the working language does not match the language
474 of the current frame. Only warn the user if we are actually
475 running the program, i.e. there is a stack. */
476 /* FIXME: This should be cacheing the frame and only running when
477 the frame changes. */
479 if (has_stack_frames ())
483 flang = get_frame_language (frame);
485 && flang != language_unknown
486 && flang != current_language->la_language)
488 printf_filtered ("%s\n", lang_frame_mismatch_warn);
497 wait_sync_command_done (void)
499 /* Processing events may change the current UI. */
500 scoped_restore save_ui = make_scoped_restore (¤t_ui);
501 struct ui *ui = current_ui;
503 while (gdb_do_one_event () >= 0)
504 if (ui->prompt_state != PROMPT_BLOCKED)
511 maybe_wait_sync_command_done (int was_sync)
513 /* If the interpreter is in sync mode (we're running a user
514 command's list, running command hooks or similars), and we
515 just ran a synchronous command that started the target, wait
516 for that command to end. */
517 if (!current_ui->async
519 && current_ui->prompt_state == PROMPT_BLOCKED)
520 wait_sync_command_done ();
523 /* If not NULL, the arguments that should be passed if the current
524 command is repeated. */
526 static const char *repeat_arguments;
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 cleanup *cleanup_if_error;
543 struct cmd_list_element *c;
545 const char *cmd_start = p;
547 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
548 scoped_value_mark cleanup = prepare_execute_command ();
550 /* Force cleanup of any alloca areas if using C alloca instead of
554 /* This can happen when command_line_input hits end of file. */
557 discard_cleanups (cleanup_if_error);
561 target_log_command (p);
563 while (*p == ' ' || *p == '\t')
569 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
573 /* If trace-commands is set then this will print this command. */
574 print_command_trace (p);
576 c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
579 scoped_restore save_repeat_args
580 = make_scoped_restore (&repeat_arguments, nullptr);
581 const char *args_pointer = p;
583 /* Pass null arg rather than an empty one. */
586 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
587 while the is_complete_command(cfunc) test is just plain
588 bogus. They should both be replaced by a test of the form
589 c->strip_trailing_white_space_p. */
590 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
591 can't be replaced with func. This is because it is the
592 cfunc, and not the func, that has the value that the
593 is_complete_command hack is testing for. */
594 /* Clear off trailing whitespace, except for set and complete
596 std::string without_whitespace;
598 && c->type != set_cmd
599 && !is_complete_command (c))
601 const char *old_end = arg + strlen (arg) - 1;
603 while (p >= arg && (*p == ' ' || *p == '\t'))
607 without_whitespace = std::string (arg, p + 1);
608 arg = without_whitespace.c_str ();
612 /* If this command has been pre-hooked, run the hook first. */
613 execute_cmd_pre_hook (c);
615 if (c->deprecated_warn_user)
616 deprecated_cmd_warning (line);
618 /* c->user_commands would be NULL in the case of a python command. */
619 if (c->theclass == class_user && c->user_commands)
620 execute_user_command (c, arg);
621 else if (c->type == set_cmd)
622 do_set_command (arg, from_tty, c);
623 else if (c->type == show_cmd)
624 do_show_command (arg, from_tty, c);
625 else if (!cmd_func_p (c))
626 error (_("That is not a command, just a help topic."));
627 else if (deprecated_call_command_hook)
628 deprecated_call_command_hook (c, arg, from_tty);
630 cmd_func (c, arg, from_tty);
632 maybe_wait_sync_command_done (was_sync);
634 /* If this command has been post-hooked, run the hook last. */
635 execute_cmd_post_hook (c);
637 if (repeat_arguments != NULL && cmd_start == saved_command_line)
639 gdb_assert (strlen (args_pointer) >= strlen (repeat_arguments));
640 strcpy (saved_command_line + (args_pointer - cmd_start),
645 check_frame_language_change ();
647 discard_cleanups (cleanup_if_error);
650 /* Run execute_command for P and FROM_TTY. Capture its output into the
651 returned string, do not display it to the screen. BATCH_FLAG will be
652 temporarily set to true. */
655 execute_command_to_string (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);
663 string_file str_file;
666 current_uiout->redirect (&str_file);
667 ui_out_redirect_pop redirect_popper (current_uiout);
669 scoped_restore save_stdout
670 = make_scoped_restore (&gdb_stdout, &str_file);
671 scoped_restore save_stderr
672 = make_scoped_restore (&gdb_stderr, &str_file);
673 scoped_restore save_stdlog
674 = make_scoped_restore (&gdb_stdlog, &str_file);
675 scoped_restore save_stdtarg
676 = make_scoped_restore (&gdb_stdtarg, &str_file);
677 scoped_restore save_stdtargerr
678 = make_scoped_restore (&gdb_stdtargerr, &str_file);
680 execute_command (p, from_tty);
683 return std::move (str_file.string ());
687 /* When nonzero, cause dont_repeat to do nothing. This should only be
688 set via prevent_dont_repeat. */
690 static int suppress_dont_repeat = 0;
692 /* Commands call this if they do not want to be repeated by null lines. */
697 struct ui *ui = current_ui;
699 if (suppress_dont_repeat || server_command)
702 /* If we aren't reading from standard input, we are saving the last
703 thing read from stdin in line and don't want to delete it. Null
704 lines won't repeat here in any case. */
705 if (ui->instream == ui->stdin_stream)
706 *saved_command_line = 0;
709 /* Prevent dont_repeat from working, and return a cleanup that
710 restores the previous state. */
712 scoped_restore_tmpl<int>
713 prevent_dont_repeat (void)
715 return make_scoped_restore (&suppress_dont_repeat, 1);
719 /* Read a line from the stream "instream" without command line editing.
721 It prints PROMPT once at the start.
722 Action is compatible with "readline", e.g. space for the result is
723 malloc'd and should be freed by the caller.
725 A NULL return means end of file. */
728 gdb_readline_no_editing (const char *prompt)
730 struct buffer line_buffer;
731 struct ui *ui = current_ui;
732 /* Read from stdin if we are executing a user defined command. This
733 is the right thing for prompt_for_continue, at least. */
734 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
735 int fd = fileno (stream);
737 buffer_init (&line_buffer);
741 /* Don't use a _filtered function here. It causes the assumed
742 character position to be off, since the newline we read from
743 the user is not accounted for. */
744 fputs_unfiltered (prompt, gdb_stdout);
745 gdb_flush (gdb_stdout);
755 /* Wait until at least one byte of data is available. Control-C
756 can interrupt interruptible_select, but not fgetc. */
758 FD_SET (fd, &readfds);
759 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
763 /* If this was ctrl-c, the QUIT above handles it. */
766 perror_with_name (("select"));
773 if (line_buffer.used_size > 0)
774 /* The last line does not end with a newline. Return it, and
775 if we are called again fgetc will still return EOF and
776 we'll return NULL then. */
778 xfree (buffer_finish (&line_buffer));
784 if (line_buffer.used_size > 0
785 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
786 line_buffer.used_size--;
790 buffer_grow_char (&line_buffer, c);
793 buffer_grow_char (&line_buffer, '\0');
794 return buffer_finish (&line_buffer);
797 /* Variables which control command line editing and history
798 substitution. These variables are given default values at the end
800 static int command_editing_p;
802 /* NOTE 1999-04-29: This variable will be static again, once we modify
803 gdb to use the event loop as the default command loop and we merge
804 event-top.c into this file, top.c. */
806 /* static */ int history_expansion_p;
808 static int write_history_p;
810 show_write_history_p (struct ui_file *file, int from_tty,
811 struct cmd_list_element *c, const char *value)
813 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
817 /* The variable associated with the "set/show history size"
818 command. The value -1 means unlimited, and -2 means undefined. */
819 static int history_size_setshow_var = -2;
822 show_history_size (struct ui_file *file, int from_tty,
823 struct cmd_list_element *c, const char *value)
825 fprintf_filtered (file, _("The size of the command history is %s.\n"),
829 /* Variable associated with the "history remove-duplicates" option.
830 The value -1 means unlimited. */
831 static int history_remove_duplicates = 0;
834 show_history_remove_duplicates (struct ui_file *file, int from_tty,
835 struct cmd_list_element *c, const char *value)
837 fprintf_filtered (file,
838 _("The number of history entries to look back at for "
839 "duplicates is %s.\n"),
843 static char *history_filename;
845 show_history_filename (struct ui_file *file, int from_tty,
846 struct cmd_list_element *c, const char *value)
848 fprintf_filtered (file, _("The filename in which to record "
849 "the command history is \"%s\".\n"),
853 /* This is like readline(), but it has some gdb-specific behavior.
854 gdb may want readline in both the synchronous and async modes during
855 a single gdb invocation. At the ordinary top-level prompt we might
856 be using the async readline. That means we can't use
857 rl_pre_input_hook, since it doesn't work properly in async mode.
858 However, for a secondary prompt (" >", such as occurs during a
859 `define'), gdb wants a synchronous response.
861 We used to call readline() directly, running it in synchronous
862 mode. But mixing modes this way is not supported, and as of
863 readline 5.x it no longer works; the arrow keys come unbound during
864 the synchronous call. So we make a nested call into the event
865 loop. That's what gdb_readline_wrapper is for. */
867 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
868 rely on gdb_readline_wrapper_result, which might still be NULL if
869 the user types Control-D for EOF. */
870 static int gdb_readline_wrapper_done;
872 /* The result of the current call to gdb_readline_wrapper, once a newline
874 static char *gdb_readline_wrapper_result;
876 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
877 to be called after the newline is processed (which will redisplay
878 the prompt). But in gdb_readline_wrapper we will not get a new
879 prompt until the next call, or until we return to the event loop.
880 So we disable this hook around the newline and restore it before we
882 static void (*saved_after_char_processing_hook) (void);
888 gdb_in_secondary_prompt_p (struct ui *ui)
890 return ui->secondary_prompt_depth > 0;
894 /* This function is called when readline has seen a complete line of
898 gdb_readline_wrapper_line (char *line)
900 gdb_assert (!gdb_readline_wrapper_done);
901 gdb_readline_wrapper_result = line;
902 gdb_readline_wrapper_done = 1;
904 /* Prevent operate-and-get-next from acting too early. */
905 saved_after_char_processing_hook = after_char_processing_hook;
906 after_char_processing_hook = NULL;
908 /* Prevent parts of the prompt from being redisplayed if annotations
909 are enabled, and readline's state getting out of sync. We'll
910 reinstall the callback handler, which puts the terminal in raw
911 mode (or in readline lingo, in prepped state), when we're next
912 ready to process user input, either in display_gdb_prompt, or if
913 we're handling an asynchronous target event and running in the
914 background, just before returning to the event loop to process
915 further input (or more target events). */
916 if (current_ui->command_editing)
917 gdb_rl_callback_handler_remove ();
920 class gdb_readline_wrapper_cleanup
923 gdb_readline_wrapper_cleanup ()
924 : m_handler_orig (current_ui->input_handler),
925 m_already_prompted_orig (current_ui->command_editing
926 ? rl_already_prompted : 0),
927 m_target_is_async_orig (target_is_async_p ()),
928 m_save_ui (¤t_ui)
930 current_ui->input_handler = gdb_readline_wrapper_line;
931 current_ui->secondary_prompt_depth++;
933 if (m_target_is_async_orig)
937 ~gdb_readline_wrapper_cleanup ()
939 struct ui *ui = current_ui;
941 if (ui->command_editing)
942 rl_already_prompted = m_already_prompted_orig;
944 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
945 ui->input_handler = m_handler_orig;
947 /* Don't restore our input handler in readline yet. That would make
948 readline prep the terminal (putting it in raw mode), while the
949 line we just read may trigger execution of a command that expects
950 the terminal in the default cooked/canonical mode, such as e.g.,
951 running Python's interactive online help utility. See
952 gdb_readline_wrapper_line for when we'll reinstall it. */
954 gdb_readline_wrapper_result = NULL;
955 gdb_readline_wrapper_done = 0;
956 ui->secondary_prompt_depth--;
957 gdb_assert (ui->secondary_prompt_depth >= 0);
959 after_char_processing_hook = saved_after_char_processing_hook;
960 saved_after_char_processing_hook = NULL;
962 if (m_target_is_async_orig)
966 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup);
970 void (*m_handler_orig) (char *);
971 int m_already_prompted_orig;
973 /* Whether the target was async. */
974 int m_target_is_async_orig;
976 /* Processing events may change the current UI. */
977 scoped_restore_tmpl<struct ui *> m_save_ui;
981 gdb_readline_wrapper (const char *prompt)
983 struct ui *ui = current_ui;
985 gdb_readline_wrapper_cleanup cleanup;
987 /* Display our prompt and prevent double prompt display. Don't pass
988 down a NULL prompt, since that has special meaning for
989 display_gdb_prompt -- it indicates a request to print the primary
990 prompt, while we want a secondary prompt here. */
991 display_gdb_prompt (prompt != NULL ? prompt : "");
992 if (ui->command_editing)
993 rl_already_prompted = 1;
995 if (after_char_processing_hook)
996 (*after_char_processing_hook) ();
997 gdb_assert (after_char_processing_hook == NULL);
999 while (gdb_do_one_event () >= 0)
1000 if (gdb_readline_wrapper_done)
1003 return gdb_readline_wrapper_result;
1007 /* The current saved history number from operate-and-get-next.
1008 This is -1 if not valid. */
1009 static int operate_saved_history = -1;
1011 /* This is put on the appropriate hook and helps operate-and-get-next
1014 gdb_rl_operate_and_get_next_completion (void)
1016 int delta = where_history () - operate_saved_history;
1018 /* The `key' argument to rl_get_previous_history is ignored. */
1019 rl_get_previous_history (delta, 0);
1020 operate_saved_history = -1;
1022 /* readline doesn't automatically update the display for us. */
1025 after_char_processing_hook = NULL;
1026 rl_pre_input_hook = NULL;
1029 /* This is a gdb-local readline command handler. It accepts the
1030 current command line (like RET does) and, if this command was taken
1031 from the history, arranges for the next command in the history to
1032 appear on the command line when the prompt returns.
1033 We ignore the arguments. */
1035 gdb_rl_operate_and_get_next (int count, int key)
1039 /* Use the async hook. */
1040 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1042 /* Find the current line, and find the next line to use. */
1043 where = where_history();
1045 if ((history_is_stifled () && (history_length >= history_max_entries))
1046 || (where >= history_length - 1))
1047 operate_saved_history = where;
1049 operate_saved_history = where + 1;
1051 return rl_newline (1, key);
1054 /* Number of user commands executed during this session. */
1056 static int command_count = 0;
1058 /* Add the user command COMMAND to the input history list. */
1061 gdb_add_history (const char *command)
1065 if (history_remove_duplicates != 0)
1068 int lookbehind_threshold;
1070 /* The lookbehind threshold for finding a duplicate history entry is
1071 bounded by command_count because we can't meaningfully delete
1072 history entries that are already stored in the history file since
1073 the history file is appended to. */
1074 if (history_remove_duplicates == -1
1075 || history_remove_duplicates > command_count)
1076 lookbehind_threshold = command_count;
1078 lookbehind_threshold = history_remove_duplicates;
1081 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1083 HIST_ENTRY *temp = previous_history ();
1088 if (strcmp (temp->line, command) == 0)
1090 HIST_ENTRY *prev = remove_history (where_history ());
1092 free_history_entry (prev);
1099 add_history (command);
1102 /* Safely append new history entries to the history file in a corruption-free
1103 way using an intermediate local history file. */
1106 gdb_safe_append_history (void)
1108 int ret, saved_errno;
1110 std::string local_history_filename
1111 = string_printf ("%s-gdb%ld~", history_filename, (long) getpid ());
1113 ret = rename (history_filename, local_history_filename.c_str ());
1114 saved_errno = errno;
1115 if (ret < 0 && saved_errno != ENOENT)
1117 warning (_("Could not rename %s to %s: %s"),
1118 history_filename, local_history_filename.c_str (),
1119 safe_strerror (saved_errno));
1125 /* If the rename failed with ENOENT then either the global history
1126 file never existed in the first place or another GDB process is
1127 currently appending to it (and has thus temporarily renamed it).
1128 Since we can't distinguish between these two cases, we have to
1129 conservatively assume the first case and therefore must write out
1130 (not append) our known history to our local history file and try
1131 to move it back anyway. Otherwise a global history file would
1132 never get created! */
1133 gdb_assert (saved_errno == ENOENT);
1134 write_history (local_history_filename.c_str ());
1138 append_history (command_count, local_history_filename.c_str ());
1139 if (history_is_stifled ())
1140 history_truncate_file (local_history_filename.c_str (),
1141 history_max_entries);
1144 ret = rename (local_history_filename.c_str (), history_filename);
1145 saved_errno = errno;
1146 if (ret < 0 && saved_errno != EEXIST)
1147 warning (_("Could not rename %s to %s: %s"),
1148 local_history_filename.c_str (), history_filename,
1149 safe_strerror (saved_errno));
1153 /* Read one line from the command input stream `instream' into a local
1154 static buffer. The buffer is made bigger as necessary. Returns
1155 the address of the start of the line.
1157 NULL is returned for end of file.
1159 *If* input is from an interactive stream (stdin), the line read is
1160 copied into the global 'saved_command_line' so that it can be
1163 This routine either uses fancy command line editing or simple input
1164 as the user has requested. */
1167 command_line_input (const char *prompt_arg, int repeat,
1168 const char *annotation_suffix)
1170 static struct buffer cmd_line_buffer;
1171 static int cmd_line_buffer_initialized;
1172 struct ui *ui = current_ui;
1173 const char *prompt = prompt_arg;
1175 int from_tty = ui->instream == ui->stdin_stream;
1177 /* The annotation suffix must be non-NULL. */
1178 if (annotation_suffix == NULL)
1179 annotation_suffix = "";
1181 if (from_tty && annotation_level > 1)
1186 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1187 + strlen (annotation_suffix) + 40);
1189 local_prompt[0] = '\0';
1191 strcpy (local_prompt, prompt);
1192 strcat (local_prompt, "\n\032\032");
1193 strcat (local_prompt, annotation_suffix);
1194 strcat (local_prompt, "\n");
1196 prompt = local_prompt;
1199 if (!cmd_line_buffer_initialized)
1201 buffer_init (&cmd_line_buffer);
1202 cmd_line_buffer_initialized = 1;
1205 /* Starting a new command line. */
1206 cmd_line_buffer.used_size = 0;
1210 signal (SIGTSTP, handle_sigtstp);
1217 /* Make sure that all output has been output. Some machines may
1218 let you get away with leaving out some of the gdb_flush, but
1221 gdb_flush (gdb_stdout);
1222 gdb_flush (gdb_stderr);
1224 if (source_file_name != NULL)
1225 ++source_line_number;
1227 if (from_tty && annotation_level > 1)
1229 puts_unfiltered ("\n\032\032pre-");
1230 puts_unfiltered (annotation_suffix);
1231 puts_unfiltered ("\n");
1234 /* Don't use fancy stuff if not talking to stdin. */
1235 if (deprecated_readline_hook
1237 && input_interactive_p (current_ui))
1239 rl = (*deprecated_readline_hook) (prompt);
1241 else if (command_editing_p
1243 && input_interactive_p (current_ui))
1245 rl = gdb_readline_wrapper (prompt);
1249 rl = gdb_readline_no_editing (prompt);
1252 cmd = handle_line_of_input (&cmd_line_buffer, rl,
1253 repeat, annotation_suffix);
1254 if (cmd == (char *) EOF)
1262 /* Got partial input. I.e., got a line that ends with a
1263 continuation character (backslash). Suppress printing the
1270 signal (SIGTSTP, SIG_DFL);
1276 /* Print the GDB banner. */
1278 print_gdb_version (struct ui_file *stream)
1280 /* From GNU coding standards, first line is meant to be easy for a
1281 program to parse, and is just canonical program name and version
1282 number, which starts after last space. */
1284 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1286 /* Second line is a copyright notice. */
1288 fprintf_filtered (stream,
1289 "Copyright (C) 2018 Free Software Foundation, Inc.\n");
1291 /* Following the copyright is a brief statement that the program is
1292 free software, that users are free to copy and change it on
1293 certain conditions, that it is covered by the GNU GPL, and that
1294 there is no warranty. */
1296 fprintf_filtered (stream, "\
1297 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1298 \nThis is free software: you are free to change and redistribute it.\n\
1299 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1300 and \"show warranty\" for details.\n");
1302 /* After the required info we print the configuration information. */
1304 fprintf_filtered (stream, "This GDB was configured as \"");
1305 if (strcmp (host_name, target_name) != 0)
1307 fprintf_filtered (stream, "--host=%s --target=%s",
1308 host_name, target_name);
1312 fprintf_filtered (stream, "%s", host_name);
1314 fprintf_filtered (stream, "\".\n\
1315 Type \"show configuration\" for configuration details.");
1317 if (REPORT_BUGS_TO[0])
1319 fprintf_filtered (stream,
1320 _("\nFor bug reporting instructions, please see:\n"));
1321 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1323 fprintf_filtered (stream,
1324 _("Find the GDB manual and other documentation \
1325 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1326 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1327 fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1328 commands related to \"word\"."));
1331 /* Print the details of GDB build-time configuration. */
1333 print_gdb_configuration (struct ui_file *stream)
1335 fprintf_filtered (stream, _("\
1336 This GDB was configured as follows:\n\
1337 configure --host=%s --target=%s\n\
1338 "), host_name, target_name);
1339 fprintf_filtered (stream, _("\
1340 --with-auto-load-dir=%s\n\
1341 --with-auto-load-safe-path=%s\n\
1342 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1344 fprintf_filtered (stream, _("\
1348 fprintf_filtered (stream, _("\
1353 fprintf_filtered (stream, _("\
1354 --with-gdb-datadir=%s%s\n\
1355 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1357 fprintf_filtered (stream, _("\
1358 --with-iconv-bin=%s%s\n\
1359 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1361 if (JIT_READER_DIR[0])
1362 fprintf_filtered (stream, _("\
1363 --with-jit-reader-dir=%s%s\n\
1364 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1365 #if HAVE_LIBUNWIND_IA64_H
1366 fprintf_filtered (stream, _("\
1367 --with-libunwind-ia64\n\
1370 fprintf_filtered (stream, _("\
1371 --without-libunwind-ia64\n\
1375 fprintf_filtered (stream, _("\
1379 fprintf_filtered (stream, _("\
1383 #if HAVE_LIBBABELTRACE
1384 fprintf_filtered (stream, _("\
1385 --with-babeltrace\n\
1388 fprintf_filtered (stream, _("\
1389 --without-babeltrace\n\
1393 fprintf_filtered (stream, _("\
1397 fprintf_filtered (stream, _("\
1398 --without-intel-pt\n\
1402 fprintf_filtered (stream, _("\
1403 --enable-libmcheck\n\
1406 fprintf_filtered (stream, _("\
1407 --disable-libmcheck\n\
1411 fprintf_filtered (stream, _("\
1415 fprintf_filtered (stream, _("\
1419 #ifdef WITH_PYTHON_PATH
1420 fprintf_filtered (stream, _("\
1421 --with-python=%s%s\n\
1422 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1425 fprintf_filtered (stream, _("\
1429 fprintf_filtered (stream, _("\
1434 fprintf_filtered (stream, _("\
1435 --with-relocated-sources=%s\n\
1439 fprintf_filtered (stream, _("\
1440 --with-separate-debug-dir=%s%s\n\
1441 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1442 if (TARGET_SYSTEM_ROOT[0])
1443 fprintf_filtered (stream, _("\
1444 --with-sysroot=%s%s\n\
1445 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1446 if (SYSTEM_GDBINIT[0])
1447 fprintf_filtered (stream, _("\
1448 --with-system-gdbinit=%s%s\n\
1449 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1450 /* We assume "relocatable" will be printed at least once, thus we always
1451 print this text. It's a reasonably safe assumption for now. */
1452 fprintf_filtered (stream, _("\n\
1453 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1454 tree, and GDB will still find it.)\n\
1459 /* The current top level prompt, settable with "set prompt", and/or
1460 with the python `gdb.prompt_hook' hook. */
1461 static char *top_prompt;
1463 /* Access method for the GDB prompt string. */
1471 /* Set method for the GDB prompt string. */
1474 set_prompt (const char *s)
1476 char *p = xstrdup (s);
1488 /* Callback for iterate_over_inferiors. Kills or detaches the given
1489 inferior, depending on how we originally gained control of it. */
1492 kill_or_detach (struct inferior *inf, void *args)
1494 struct qt_args *qt = (struct qt_args *) args;
1495 struct thread_info *thread;
1500 thread = any_thread_of_process (inf->pid);
1503 switch_to_thread (thread->ptid);
1505 /* Leave core files alone. */
1506 if (target_has_execution)
1508 if (inf->attach_flag)
1509 target_detach (inf, qt->from_tty);
1518 /* Callback for iterate_over_inferiors. Prints info about what GDB
1519 will do to each inferior on a "quit". ARG points to a struct
1520 ui_out where output is to be collected. */
1523 print_inferior_quit_action (struct inferior *inf, void *arg)
1525 struct ui_file *stb = (struct ui_file *) arg;
1530 if (inf->attach_flag)
1531 fprintf_filtered (stb,
1532 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1533 target_pid_to_str (pid_to_ptid (inf->pid)));
1535 fprintf_filtered (stb,
1536 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1537 target_pid_to_str (pid_to_ptid (inf->pid)));
1542 /* If necessary, make the user confirm that we should quit. Return
1543 non-zero if we should quit, zero if we shouldn't. */
1548 /* Don't even ask if we're only debugging a core file inferior. */
1549 if (!have_live_inferiors ())
1552 /* Build the query string as a single string. */
1555 stb.puts (_("A debugging session is active.\n\n"));
1556 iterate_over_inferiors (print_inferior_quit_action, &stb);
1557 stb.puts (_("\nQuit anyway? "));
1559 return query ("%s", stb.c_str ());
1562 /* Prepare to exit GDB cleanly by undoing any changes made to the
1563 terminal so that we leave the terminal in the state we acquired it. */
1566 undo_terminal_modifications_before_exit (void)
1568 struct ui *saved_top_level = current_ui;
1570 target_terminal::ours ();
1572 current_ui = main_ui;
1577 gdb_disable_readline ();
1579 current_ui = saved_top_level;
1583 /* Quit without asking for confirmation. */
1586 quit_force (int *exit_arg, int from_tty)
1591 undo_terminal_modifications_before_exit ();
1593 /* An optional expression may be used to cause gdb to terminate with the
1594 value of that expression. */
1596 exit_code = *exit_arg;
1597 else if (return_child_result)
1598 exit_code = return_child_result_value;
1600 qt.from_tty = from_tty;
1602 /* We want to handle any quit errors and exit regardless. */
1604 /* Get out of tfind mode, and kill or detach all inferiors. */
1607 disconnect_tracing ();
1608 iterate_over_inferiors (kill_or_detach, &qt);
1610 CATCH (ex, RETURN_MASK_ALL)
1612 exception_print (gdb_stderr, ex);
1616 /* Give all pushed targets a chance to do minimal cleanup, and pop
1622 CATCH (ex, RETURN_MASK_ALL)
1624 exception_print (gdb_stderr, ex);
1628 /* Save the history information if it is appropriate to do so. */
1631 if (write_history_p && history_filename)
1636 /* History is currently shared between all UIs. If there's
1637 any UI with a terminal, save history. */
1640 if (input_interactive_p (ui))
1648 gdb_safe_append_history ();
1651 CATCH (ex, RETURN_MASK_ALL)
1653 exception_print (gdb_stderr, ex);
1657 /* Do any final cleanups before exiting. */
1660 do_final_cleanups (all_cleanups ());
1662 CATCH (ex, RETURN_MASK_ALL)
1664 exception_print (gdb_stderr, ex);
1671 /* The value of the "interactive-mode" setting. */
1672 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1674 /* Implement the "show interactive-mode" option. */
1677 show_interactive_mode (struct ui_file *file, int from_tty,
1678 struct cmd_list_element *c,
1681 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1682 fprintf_filtered (file, "Debugger's interactive mode "
1683 "is %s (currently %s).\n",
1684 value, input_interactive_p (current_ui) ? "on" : "off");
1686 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1689 /* Returns whether GDB is running on an interactive terminal. */
1692 input_interactive_p (struct ui *ui)
1697 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1698 return interactive_mode == AUTO_BOOLEAN_TRUE;
1700 return ui->input_interactive_p;
1704 dont_repeat_command (const char *ignored, int from_tty)
1706 /* Can't call dont_repeat here because we're not necessarily reading
1708 *saved_command_line = 0;
1711 /* Functions to manipulate command line editing control variables. */
1713 /* Number of commands to print in each call to show_commands. */
1714 #define Hist_print 10
1716 show_commands (const char *args, int from_tty)
1718 /* Index for history commands. Relative to history_base. */
1721 /* Number of the history entry which we are planning to display next.
1722 Relative to history_base. */
1725 /* Print out some of the commands from the command history. */
1729 if (args[0] == '+' && args[1] == '\0')
1730 /* "info editing +" should print from the stored position. */
1733 /* "info editing <exp>" should print around command number <exp>. */
1734 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1736 /* "show commands" means print the last Hist_print commands. */
1739 num = history_length - Hist_print;
1745 /* If there are at least Hist_print commands, we want to display the last
1746 Hist_print rather than, say, the last 6. */
1747 if (history_length - num < Hist_print)
1749 num = history_length - Hist_print;
1755 offset < num + Hist_print && offset < history_length;
1758 printf_filtered ("%5d %s\n", history_base + offset,
1759 (history_get (history_base + offset))->line);
1762 /* The next command we want to display is the next one that we haven't
1766 /* If the user repeats this command with return, it should do what
1767 "show commands +" does. This is unnecessary if arg is null,
1768 because "show commands +" is not useful after "show commands". */
1769 if (from_tty && args)
1770 set_repeat_arguments ("+");
1773 /* Update the size of our command history file to HISTORY_SIZE.
1775 A HISTORY_SIZE of -1 stands for unlimited. */
1778 set_readline_history_size (int history_size)
1780 gdb_assert (history_size >= -1);
1782 if (history_size == -1)
1783 unstifle_history ();
1785 stifle_history (history_size);
1788 /* Called by do_setshow_command. */
1790 set_history_size_command (const char *args,
1791 int from_tty, struct cmd_list_element *c)
1793 set_readline_history_size (history_size_setshow_var);
1797 set_history (const char *args, int from_tty)
1799 printf_unfiltered (_("\"set history\" must be followed "
1800 "by the name of a history subcommand.\n"));
1801 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1805 show_history (const char *args, int from_tty)
1807 cmd_show_list (showhistlist, from_tty, "");
1810 int info_verbose = 0; /* Default verbose msgs off. */
1812 /* Called by do_setshow_command. An elaborate joke. */
1814 set_verbose (const char *args, int from_tty, struct cmd_list_element *c)
1816 const char *cmdname = "verbose";
1817 struct cmd_list_element *showcmd;
1819 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1820 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1824 c->doc = "Set verbose printing of informational messages.";
1825 showcmd->doc = "Show verbose printing of informational messages.";
1829 c->doc = "Set verbosity.";
1830 showcmd->doc = "Show verbosity.";
1834 /* Init the history buffer. Note that we are called after the init file(s)
1835 have been read so that the user can change the history file via his
1836 .gdbinit file (for instance). The GDBHISTFILE environment variable
1837 overrides all of this. */
1844 tmpenv = getenv ("GDBHISTSIZE");
1851 tmpenv = skip_spaces (tmpenv);
1853 var = strtol (tmpenv, &endptr, 10);
1854 saved_errno = errno;
1855 endptr = skip_spaces (endptr);
1857 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1858 empty string, a negative number or a huge positive number (larger than
1859 INT_MAX) then set the history size to unlimited. Otherwise set our
1860 history size to the number we have read. This behavior is consistent
1861 with how bash handles HISTSIZE. */
1862 if (*endptr != '\0')
1864 else if (*tmpenv == '\0'
1867 /* On targets where INT_MAX == LONG_MAX, we have to look at
1868 errno after calling strtol to distinguish between a value that
1869 is exactly INT_MAX and an overflowing value that was clamped
1871 || (var == INT_MAX && saved_errno == ERANGE))
1872 history_size_setshow_var = -1;
1874 history_size_setshow_var = var;
1877 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1879 if (history_size_setshow_var == -2)
1880 history_size_setshow_var = 256;
1882 set_readline_history_size (history_size_setshow_var);
1884 tmpenv = getenv ("GDBHISTFILE");
1886 history_filename = xstrdup (tmpenv);
1887 else if (!history_filename)
1889 /* We include the current directory so that if the user changes
1890 directories the file written will be the same as the one
1893 /* No leading dots in file names are allowed on MSDOS. */
1894 history_filename = concat (current_directory, "/_gdb_history",
1897 history_filename = concat (current_directory, "/.gdb_history",
1901 read_history (history_filename);
1905 show_prompt (struct ui_file *file, int from_tty,
1906 struct cmd_list_element *c, const char *value)
1908 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1911 /* "set editing" command. */
1914 set_editing (const char *args, int from_tty, struct cmd_list_element *c)
1916 change_line_handler (set_editing_cmd_var);
1917 /* Update the control variable so that MI's =cmd-param-changed event
1918 shows the correct value. */
1919 set_editing_cmd_var = current_ui->command_editing;
1923 show_editing (struct ui_file *file, int from_tty,
1924 struct cmd_list_element *c, const char *value)
1926 fprintf_filtered (file, _("Editing of command lines as "
1927 "they are typed is %s.\n"),
1928 current_ui->command_editing ? _("on") : _("off"));
1932 show_annotation_level (struct ui_file *file, int from_tty,
1933 struct cmd_list_element *c, const char *value)
1935 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1939 show_exec_done_display_p (struct ui_file *file, int from_tty,
1940 struct cmd_list_element *c, const char *value)
1942 fprintf_filtered (file, _("Notification of completion for "
1943 "asynchronous execution commands is %s.\n"),
1947 /* New values of the "data-directory" parameter are staged here. */
1948 static char *staged_gdb_datadir;
1950 /* "set" command for the gdb_datadir configuration variable. */
1953 set_gdb_datadir (const char *args, int from_tty, struct cmd_list_element *c)
1955 set_gdb_data_directory (staged_gdb_datadir);
1956 gdb::observers::gdb_datadir_changed.notify ();
1959 /* "show" command for the gdb_datadir configuration variable. */
1962 show_gdb_datadir (struct ui_file *file, int from_tty,
1963 struct cmd_list_element *c, const char *value)
1965 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1970 set_history_filename (const char *args,
1971 int from_tty, struct cmd_list_element *c)
1973 /* We include the current directory so that if the user changes
1974 directories the file written will be the same as the one
1976 if (!IS_ABSOLUTE_PATH (history_filename))
1977 history_filename = reconcat (history_filename, current_directory, "/",
1978 history_filename, (char *) NULL);
1984 struct cmd_list_element *c;
1986 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1987 the DEFAULT_PROMPT is. */
1988 set_prompt (DEFAULT_PROMPT);
1990 /* Set the important stuff up for command editing. */
1991 command_editing_p = 1;
1992 history_expansion_p = 0;
1993 write_history_p = 0;
1995 /* Setup important stuff for command line editing. */
1996 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1997 rl_attempted_completion_function = gdb_rl_attempted_completion_function;
1998 set_rl_completer_word_break_characters (default_word_break_characters ());
1999 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
2000 rl_completion_display_matches_hook = cli_display_match_list;
2001 rl_readline_name = "gdb";
2002 rl_terminal_name = getenv ("TERM");
2004 /* The name for this defun comes from Bash, where it originated.
2005 15 is Control-o, the same binding this function has in Bash. */
2006 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2008 add_setshow_string_cmd ("prompt", class_support,
2010 _("Set gdb's prompt"),
2011 _("Show gdb's prompt"),
2014 &setlist, &showlist);
2016 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2017 Don't repeat this command.\nPrimarily \
2018 used inside of user-defined commands that should not be repeated when\n\
2021 add_setshow_boolean_cmd ("editing", class_support,
2022 &set_editing_cmd_var, _("\
2023 Set editing of command lines as they are typed."), _("\
2024 Show editing of command lines as they are typed."), _("\
2025 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2026 Without an argument, command line editing is enabled. To edit, use\n\
2027 EMACS-like or VI-like commands like control-P or ESC."),
2030 &setlist, &showlist);
2032 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2033 Set saving of the history record on exit."), _("\
2034 Show saving of the history record on exit."), _("\
2035 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2036 Without an argument, saving is enabled."),
2038 show_write_history_p,
2039 &sethistlist, &showhistlist);
2041 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2042 &history_size_setshow_var, _("\
2043 Set the size of the command history,"), _("\
2044 Show the size of the command history,"), _("\
2045 ie. the number of previous commands to keep a record of.\n\
2046 If set to \"unlimited\", the number of commands kept in the history\n\
2047 list is unlimited. This defaults to the value of the environment\n\
2048 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2049 set_history_size_command,
2051 &sethistlist, &showhistlist);
2053 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2054 &history_remove_duplicates, _("\
2055 Set how far back in history to look for and remove duplicate entries."), _("\
2056 Show how far back in history to look for and remove duplicate entries."), _("\
2057 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2058 and remove the first history entry that is a duplicate of the most recent\n\
2059 entry, each time a new history entry is added.\n\
2060 If set to \"unlimited\", this lookbehind is unbounded.\n\
2061 Only history entries added during this session are considered for removal.\n\
2062 If set to 0, removal of duplicate history entries is disabled.\n\
2063 By default this option is set to 0."),
2065 show_history_remove_duplicates,
2066 &sethistlist, &showhistlist);
2068 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2069 Set the filename in which to record the command history"), _("\
2070 Show the filename in which to record the command history"), _("\
2071 (the list of previous commands of which a record is kept)."),
2072 set_history_filename,
2073 show_history_filename,
2074 &sethistlist, &showhistlist);
2076 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2077 Set whether to confirm potentially dangerous operations."), _("\
2078 Show whether to confirm potentially dangerous operations."), NULL,
2081 &setlist, &showlist);
2083 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2084 Set annotation_level."), _("\
2085 Show annotation_level."), _("\
2086 0 == normal; 1 == fullname (for use when running under emacs)\n\
2087 2 == output annotated suitably for use by programs that control GDB."),
2089 show_annotation_level,
2090 &setlist, &showlist);
2092 add_setshow_boolean_cmd ("exec-done-display", class_support,
2093 &exec_done_display_p, _("\
2094 Set notification of completion for asynchronous execution commands."), _("\
2095 Show notification of completion for asynchronous execution commands."), _("\
2096 Use \"on\" to enable the notification, and \"off\" to disable it."),
2098 show_exec_done_display_p,
2099 &setlist, &showlist);
2101 add_setshow_filename_cmd ("data-directory", class_maintenance,
2102 &staged_gdb_datadir, _("Set GDB's data directory."),
2103 _("Show GDB's data directory."),
2105 When set, GDB uses the specified path to search for data files."),
2106 set_gdb_datadir, show_gdb_datadir,
2110 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2111 &interactive_mode, _("\
2112 Set whether GDB's standard input is a terminal."), _("\
2113 Show whether GDB's standard input is a terminal."), _("\
2114 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2115 means that GDB should wait for the user to answer queries associated to\n\
2116 commands entered at the command prompt. If off, GDB assumes that standard\n\
2117 input is not a terminal, and uses the default answer to all queries.\n\
2118 If auto (the default), determine which mode to use based on the standard\n\
2121 show_interactive_mode,
2122 &setlist, &showlist);
2124 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2125 Create a new UI. It takes two arguments:\n\
2126 The first argument is the name of the interpreter to run.\n\
2127 The second argument is the terminal the UI runs on.\n"), &cmdlist);
2128 set_cmd_completer (c, interpreter_completer);
2132 gdb_init (char *argv0)
2134 if (pre_init_ui_hook)
2135 pre_init_ui_hook ();
2137 /* Run the init function of each source file. */
2140 /* Make sure we return to the original directory upon exit, come
2141 what may, since the OS doesn't do that for us. */
2142 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2145 init_cmd_lists (); /* This needs to be done first. */
2146 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2147 initialize_utils (); /* Make errors and warnings possible. */
2151 /* Here is where we call all the _initialize_foo routines. */
2152 initialize_all_files ();
2154 /* This creates the current_program_space. Do this after all the
2155 _initialize_foo routines have had a chance to install their
2156 per-sspace data keys. Also do this before
2157 initialize_current_architecture is called, because it accesses
2158 exec_bfd of the current program space. */
2159 initialize_progspace ();
2160 initialize_inferiors ();
2161 initialize_current_architecture ();
2163 init_main (); /* But that omits this file! Do it now. */
2165 initialize_stdin_serial ();
2167 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2169 set_initial_gdb_ttystate ();
2171 async_init_signals ();
2173 /* We need a default language for parsing expressions, so simple
2174 things like "set width 0" won't fail if no language is explicitly
2175 set in a config file or implicitly set by reading an executable
2177 set_language (language_c);
2178 expected_language = current_language; /* Don't warn about the change. */
2180 /* Python initialization, for example, can require various commands to be
2181 installed. For example "info pretty-printer" needs the "info"
2182 prefix to be installed. Keep things simple and just do final
2183 script initialization here. */
2184 finish_ext_lang_initialization ();