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. */
174 #ifdef HAVE_USEFUL_SBRK
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 ("%s", 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 /* Only perform the frame-language-change check if the command
646 we just finished executing did not resume the inferior's execution.
647 If it did resume the inferior, we will do that check after
648 the inferior stopped. */
649 if (has_stack_frames () && inferior_thread ()->state != THREAD_RUNNING)
650 check_frame_language_change ();
652 discard_cleanups (cleanup_if_error);
655 /* Run execute_command for P and FROM_TTY. Capture its output into the
656 returned string, do not display it to the screen. BATCH_FLAG will be
657 temporarily set to true. */
660 execute_command_to_string (const char *p, int from_tty)
662 /* GDB_STDOUT should be better already restored during these
663 restoration callbacks. */
664 set_batch_flag_and_restore_page_info save_page_info;
666 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
668 string_file str_file;
671 current_uiout->redirect (&str_file);
672 ui_out_redirect_pop redirect_popper (current_uiout);
674 scoped_restore save_stdout
675 = make_scoped_restore (&gdb_stdout, &str_file);
676 scoped_restore save_stderr
677 = make_scoped_restore (&gdb_stderr, &str_file);
678 scoped_restore save_stdlog
679 = make_scoped_restore (&gdb_stdlog, &str_file);
680 scoped_restore save_stdtarg
681 = make_scoped_restore (&gdb_stdtarg, &str_file);
682 scoped_restore save_stdtargerr
683 = make_scoped_restore (&gdb_stdtargerr, &str_file);
685 execute_command (p, from_tty);
688 return std::move (str_file.string ());
692 /* When nonzero, cause dont_repeat to do nothing. This should only be
693 set via prevent_dont_repeat. */
695 static int suppress_dont_repeat = 0;
697 /* Commands call this if they do not want to be repeated by null lines. */
702 struct ui *ui = current_ui;
704 if (suppress_dont_repeat || server_command)
707 /* If we aren't reading from standard input, we are saving the last
708 thing read from stdin in line and don't want to delete it. Null
709 lines won't repeat here in any case. */
710 if (ui->instream == ui->stdin_stream)
711 *saved_command_line = 0;
714 /* Prevent dont_repeat from working, and return a cleanup that
715 restores the previous state. */
717 scoped_restore_tmpl<int>
718 prevent_dont_repeat (void)
720 return make_scoped_restore (&suppress_dont_repeat, 1);
724 /* Read a line from the stream "instream" without command line editing.
726 It prints PROMPT once at the start.
727 Action is compatible with "readline", e.g. space for the result is
728 malloc'd and should be freed by the caller.
730 A NULL return means end of file. */
733 gdb_readline_no_editing (const char *prompt)
735 struct buffer line_buffer;
736 struct ui *ui = current_ui;
737 /* Read from stdin if we are executing a user defined command. This
738 is the right thing for prompt_for_continue, at least. */
739 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
740 int fd = fileno (stream);
742 buffer_init (&line_buffer);
746 /* Don't use a _filtered function here. It causes the assumed
747 character position to be off, since the newline we read from
748 the user is not accounted for. */
749 fputs_unfiltered (prompt, gdb_stdout);
750 gdb_flush (gdb_stdout);
760 /* Wait until at least one byte of data is available. Control-C
761 can interrupt interruptible_select, but not fgetc. */
763 FD_SET (fd, &readfds);
764 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
768 /* If this was ctrl-c, the QUIT above handles it. */
771 perror_with_name (("select"));
778 if (line_buffer.used_size > 0)
779 /* The last line does not end with a newline. Return it, and
780 if we are called again fgetc will still return EOF and
781 we'll return NULL then. */
783 xfree (buffer_finish (&line_buffer));
789 if (line_buffer.used_size > 0
790 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
791 line_buffer.used_size--;
795 buffer_grow_char (&line_buffer, c);
798 buffer_grow_char (&line_buffer, '\0');
799 return buffer_finish (&line_buffer);
802 /* Variables which control command line editing and history
803 substitution. These variables are given default values at the end
805 static int command_editing_p;
807 /* NOTE 1999-04-29: This variable will be static again, once we modify
808 gdb to use the event loop as the default command loop and we merge
809 event-top.c into this file, top.c. */
811 /* static */ int history_expansion_p;
813 static int write_history_p;
815 show_write_history_p (struct ui_file *file, int from_tty,
816 struct cmd_list_element *c, const char *value)
818 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
822 /* The variable associated with the "set/show history size"
823 command. The value -1 means unlimited, and -2 means undefined. */
824 static int history_size_setshow_var = -2;
827 show_history_size (struct ui_file *file, int from_tty,
828 struct cmd_list_element *c, const char *value)
830 fprintf_filtered (file, _("The size of the command history is %s.\n"),
834 /* Variable associated with the "history remove-duplicates" option.
835 The value -1 means unlimited. */
836 static int history_remove_duplicates = 0;
839 show_history_remove_duplicates (struct ui_file *file, int from_tty,
840 struct cmd_list_element *c, const char *value)
842 fprintf_filtered (file,
843 _("The number of history entries to look back at for "
844 "duplicates is %s.\n"),
848 static char *history_filename;
850 show_history_filename (struct ui_file *file, int from_tty,
851 struct cmd_list_element *c, const char *value)
853 fprintf_filtered (file, _("The filename in which to record "
854 "the command history is \"%s\".\n"),
858 /* This is like readline(), but it has some gdb-specific behavior.
859 gdb may want readline in both the synchronous and async modes during
860 a single gdb invocation. At the ordinary top-level prompt we might
861 be using the async readline. That means we can't use
862 rl_pre_input_hook, since it doesn't work properly in async mode.
863 However, for a secondary prompt (" >", such as occurs during a
864 `define'), gdb wants a synchronous response.
866 We used to call readline() directly, running it in synchronous
867 mode. But mixing modes this way is not supported, and as of
868 readline 5.x it no longer works; the arrow keys come unbound during
869 the synchronous call. So we make a nested call into the event
870 loop. That's what gdb_readline_wrapper is for. */
872 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
873 rely on gdb_readline_wrapper_result, which might still be NULL if
874 the user types Control-D for EOF. */
875 static int gdb_readline_wrapper_done;
877 /* The result of the current call to gdb_readline_wrapper, once a newline
879 static char *gdb_readline_wrapper_result;
881 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
882 to be called after the newline is processed (which will redisplay
883 the prompt). But in gdb_readline_wrapper we will not get a new
884 prompt until the next call, or until we return to the event loop.
885 So we disable this hook around the newline and restore it before we
887 static void (*saved_after_char_processing_hook) (void);
893 gdb_in_secondary_prompt_p (struct ui *ui)
895 return ui->secondary_prompt_depth > 0;
899 /* This function is called when readline has seen a complete line of
903 gdb_readline_wrapper_line (char *line)
905 gdb_assert (!gdb_readline_wrapper_done);
906 gdb_readline_wrapper_result = line;
907 gdb_readline_wrapper_done = 1;
909 /* Prevent operate-and-get-next from acting too early. */
910 saved_after_char_processing_hook = after_char_processing_hook;
911 after_char_processing_hook = NULL;
913 /* Prevent parts of the prompt from being redisplayed if annotations
914 are enabled, and readline's state getting out of sync. We'll
915 reinstall the callback handler, which puts the terminal in raw
916 mode (or in readline lingo, in prepped state), when we're next
917 ready to process user input, either in display_gdb_prompt, or if
918 we're handling an asynchronous target event and running in the
919 background, just before returning to the event loop to process
920 further input (or more target events). */
921 if (current_ui->command_editing)
922 gdb_rl_callback_handler_remove ();
925 class gdb_readline_wrapper_cleanup
928 gdb_readline_wrapper_cleanup ()
929 : m_handler_orig (current_ui->input_handler),
930 m_already_prompted_orig (current_ui->command_editing
931 ? rl_already_prompted : 0),
932 m_target_is_async_orig (target_is_async_p ()),
933 m_save_ui (¤t_ui)
935 current_ui->input_handler = gdb_readline_wrapper_line;
936 current_ui->secondary_prompt_depth++;
938 if (m_target_is_async_orig)
942 ~gdb_readline_wrapper_cleanup ()
944 struct ui *ui = current_ui;
946 if (ui->command_editing)
947 rl_already_prompted = m_already_prompted_orig;
949 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
950 ui->input_handler = m_handler_orig;
952 /* Don't restore our input handler in readline yet. That would make
953 readline prep the terminal (putting it in raw mode), while the
954 line we just read may trigger execution of a command that expects
955 the terminal in the default cooked/canonical mode, such as e.g.,
956 running Python's interactive online help utility. See
957 gdb_readline_wrapper_line for when we'll reinstall it. */
959 gdb_readline_wrapper_result = NULL;
960 gdb_readline_wrapper_done = 0;
961 ui->secondary_prompt_depth--;
962 gdb_assert (ui->secondary_prompt_depth >= 0);
964 after_char_processing_hook = saved_after_char_processing_hook;
965 saved_after_char_processing_hook = NULL;
967 if (m_target_is_async_orig)
971 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup);
975 void (*m_handler_orig) (char *);
976 int m_already_prompted_orig;
978 /* Whether the target was async. */
979 int m_target_is_async_orig;
981 /* Processing events may change the current UI. */
982 scoped_restore_tmpl<struct ui *> m_save_ui;
986 gdb_readline_wrapper (const char *prompt)
988 struct ui *ui = current_ui;
990 gdb_readline_wrapper_cleanup cleanup;
992 /* Display our prompt and prevent double prompt display. Don't pass
993 down a NULL prompt, since that has special meaning for
994 display_gdb_prompt -- it indicates a request to print the primary
995 prompt, while we want a secondary prompt here. */
996 display_gdb_prompt (prompt != NULL ? prompt : "");
997 if (ui->command_editing)
998 rl_already_prompted = 1;
1000 if (after_char_processing_hook)
1001 (*after_char_processing_hook) ();
1002 gdb_assert (after_char_processing_hook == NULL);
1004 while (gdb_do_one_event () >= 0)
1005 if (gdb_readline_wrapper_done)
1008 return gdb_readline_wrapper_result;
1012 /* The current saved history number from operate-and-get-next.
1013 This is -1 if not valid. */
1014 static int operate_saved_history = -1;
1016 /* This is put on the appropriate hook and helps operate-and-get-next
1019 gdb_rl_operate_and_get_next_completion (void)
1021 int delta = where_history () - operate_saved_history;
1023 /* The `key' argument to rl_get_previous_history is ignored. */
1024 rl_get_previous_history (delta, 0);
1025 operate_saved_history = -1;
1027 /* readline doesn't automatically update the display for us. */
1030 after_char_processing_hook = NULL;
1031 rl_pre_input_hook = NULL;
1034 /* This is a gdb-local readline command handler. It accepts the
1035 current command line (like RET does) and, if this command was taken
1036 from the history, arranges for the next command in the history to
1037 appear on the command line when the prompt returns.
1038 We ignore the arguments. */
1040 gdb_rl_operate_and_get_next (int count, int key)
1044 /* Use the async hook. */
1045 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1047 /* Find the current line, and find the next line to use. */
1048 where = where_history();
1050 if ((history_is_stifled () && (history_length >= history_max_entries))
1051 || (where >= history_length - 1))
1052 operate_saved_history = where;
1054 operate_saved_history = where + 1;
1056 return rl_newline (1, key);
1059 /* Number of user commands executed during this session. */
1061 static int command_count = 0;
1063 /* Add the user command COMMAND to the input history list. */
1066 gdb_add_history (const char *command)
1070 if (history_remove_duplicates != 0)
1073 int lookbehind_threshold;
1075 /* The lookbehind threshold for finding a duplicate history entry is
1076 bounded by command_count because we can't meaningfully delete
1077 history entries that are already stored in the history file since
1078 the history file is appended to. */
1079 if (history_remove_duplicates == -1
1080 || history_remove_duplicates > command_count)
1081 lookbehind_threshold = command_count;
1083 lookbehind_threshold = history_remove_duplicates;
1086 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1088 HIST_ENTRY *temp = previous_history ();
1093 if (strcmp (temp->line, command) == 0)
1095 HIST_ENTRY *prev = remove_history (where_history ());
1097 free_history_entry (prev);
1104 add_history (command);
1107 /* Safely append new history entries to the history file in a corruption-free
1108 way using an intermediate local history file. */
1111 gdb_safe_append_history (void)
1113 int ret, saved_errno;
1115 std::string local_history_filename
1116 = string_printf ("%s-gdb%ld~", history_filename, (long) getpid ());
1118 ret = rename (history_filename, local_history_filename.c_str ());
1119 saved_errno = errno;
1120 if (ret < 0 && saved_errno != ENOENT)
1122 warning (_("Could not rename %s to %s: %s"),
1123 history_filename, local_history_filename.c_str (),
1124 safe_strerror (saved_errno));
1130 /* If the rename failed with ENOENT then either the global history
1131 file never existed in the first place or another GDB process is
1132 currently appending to it (and has thus temporarily renamed it).
1133 Since we can't distinguish between these two cases, we have to
1134 conservatively assume the first case and therefore must write out
1135 (not append) our known history to our local history file and try
1136 to move it back anyway. Otherwise a global history file would
1137 never get created! */
1138 gdb_assert (saved_errno == ENOENT);
1139 write_history (local_history_filename.c_str ());
1143 append_history (command_count, local_history_filename.c_str ());
1144 if (history_is_stifled ())
1145 history_truncate_file (local_history_filename.c_str (),
1146 history_max_entries);
1149 ret = rename (local_history_filename.c_str (), history_filename);
1150 saved_errno = errno;
1151 if (ret < 0 && saved_errno != EEXIST)
1152 warning (_("Could not rename %s to %s: %s"),
1153 local_history_filename.c_str (), history_filename,
1154 safe_strerror (saved_errno));
1158 /* Read one line from the command input stream `instream' into a local
1159 static buffer. The buffer is made bigger as necessary. Returns
1160 the address of the start of the line.
1162 NULL is returned for end of file.
1164 *If* input is from an interactive stream (stdin), the line read is
1165 copied into the global 'saved_command_line' so that it can be
1168 This routine either uses fancy command line editing or simple input
1169 as the user has requested. */
1172 command_line_input (const char *prompt_arg, int repeat,
1173 const char *annotation_suffix)
1175 static struct buffer cmd_line_buffer;
1176 static int cmd_line_buffer_initialized;
1177 struct ui *ui = current_ui;
1178 const char *prompt = prompt_arg;
1180 int from_tty = ui->instream == ui->stdin_stream;
1182 /* The annotation suffix must be non-NULL. */
1183 if (annotation_suffix == NULL)
1184 annotation_suffix = "";
1186 if (from_tty && annotation_level > 1)
1191 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1192 + strlen (annotation_suffix) + 40);
1194 local_prompt[0] = '\0';
1196 strcpy (local_prompt, prompt);
1197 strcat (local_prompt, "\n\032\032");
1198 strcat (local_prompt, annotation_suffix);
1199 strcat (local_prompt, "\n");
1201 prompt = local_prompt;
1204 if (!cmd_line_buffer_initialized)
1206 buffer_init (&cmd_line_buffer);
1207 cmd_line_buffer_initialized = 1;
1210 /* Starting a new command line. */
1211 cmd_line_buffer.used_size = 0;
1215 signal (SIGTSTP, handle_sigtstp);
1222 /* Make sure that all output has been output. Some machines may
1223 let you get away with leaving out some of the gdb_flush, but
1226 gdb_flush (gdb_stdout);
1227 gdb_flush (gdb_stderr);
1229 if (source_file_name != NULL)
1230 ++source_line_number;
1232 if (from_tty && annotation_level > 1)
1234 puts_unfiltered ("\n\032\032pre-");
1235 puts_unfiltered (annotation_suffix);
1236 puts_unfiltered ("\n");
1239 /* Don't use fancy stuff if not talking to stdin. */
1240 if (deprecated_readline_hook
1242 && input_interactive_p (current_ui))
1244 rl = (*deprecated_readline_hook) (prompt);
1246 else if (command_editing_p
1248 && input_interactive_p (current_ui))
1250 rl = gdb_readline_wrapper (prompt);
1254 rl = gdb_readline_no_editing (prompt);
1257 cmd = handle_line_of_input (&cmd_line_buffer, rl,
1258 repeat, annotation_suffix);
1259 if (cmd == (char *) EOF)
1267 /* Got partial input. I.e., got a line that ends with a
1268 continuation character (backslash). Suppress printing the
1275 signal (SIGTSTP, SIG_DFL);
1283 print_gdb_version (struct ui_file *stream, bool interactive)
1285 /* From GNU coding standards, first line is meant to be easy for a
1286 program to parse, and is just canonical program name and version
1287 number, which starts after last space. */
1289 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1291 /* Second line is a copyright notice. */
1293 fprintf_filtered (stream,
1294 "Copyright (C) 2018 Free Software Foundation, Inc.\n");
1296 /* Following the copyright is a brief statement that the program is
1297 free software, that users are free to copy and change it on
1298 certain conditions, that it is covered by the GNU GPL, and that
1299 there is no warranty. */
1301 fprintf_filtered (stream, "\
1302 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1303 \nThis is free software: you are free to change and redistribute it.\n\
1304 There is NO WARRANTY, to the extent permitted by law.");
1309 fprintf_filtered (stream, ("\nType \"show copying\" and "
1310 "\"show warranty\" for details.\n"));
1312 /* After the required info we print the configuration information. */
1314 fprintf_filtered (stream, "This GDB was configured as \"");
1315 if (strcmp (host_name, target_name) != 0)
1317 fprintf_filtered (stream, "--host=%s --target=%s",
1318 host_name, target_name);
1322 fprintf_filtered (stream, "%s", host_name);
1324 fprintf_filtered (stream, "\".\n");
1326 fprintf_filtered (stream, _("Type \"show configuration\" "
1327 "for configuration details.\n"));
1329 if (REPORT_BUGS_TO[0])
1331 fprintf_filtered (stream,
1332 _("For bug reporting instructions, please see:\n"));
1333 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1335 fprintf_filtered (stream,
1336 _("Find the GDB manual and other documentation \
1337 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1338 fprintf_filtered (stream, "\n\n");
1339 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1340 fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1341 commands related to \"word\"."));
1344 /* Print the details of GDB build-time configuration. */
1346 print_gdb_configuration (struct ui_file *stream)
1348 fprintf_filtered (stream, _("\
1349 This GDB was configured as follows:\n\
1350 configure --host=%s --target=%s\n\
1351 "), host_name, target_name);
1352 fprintf_filtered (stream, _("\
1353 --with-auto-load-dir=%s\n\
1354 --with-auto-load-safe-path=%s\n\
1355 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1357 fprintf_filtered (stream, _("\
1361 fprintf_filtered (stream, _("\
1366 fprintf_filtered (stream, _("\
1367 --with-gdb-datadir=%s%s\n\
1368 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1370 fprintf_filtered (stream, _("\
1371 --with-iconv-bin=%s%s\n\
1372 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1374 if (JIT_READER_DIR[0])
1375 fprintf_filtered (stream, _("\
1376 --with-jit-reader-dir=%s%s\n\
1377 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1378 #if HAVE_LIBUNWIND_IA64_H
1379 fprintf_filtered (stream, _("\
1380 --with-libunwind-ia64\n\
1383 fprintf_filtered (stream, _("\
1384 --without-libunwind-ia64\n\
1388 fprintf_filtered (stream, _("\
1392 fprintf_filtered (stream, _("\
1396 #if HAVE_LIBBABELTRACE
1397 fprintf_filtered (stream, _("\
1398 --with-babeltrace\n\
1401 fprintf_filtered (stream, _("\
1402 --without-babeltrace\n\
1406 fprintf_filtered (stream, _("\
1410 fprintf_filtered (stream, _("\
1411 --without-intel-pt\n\
1415 fprintf_filtered (stream, _("\
1416 --enable-libmcheck\n\
1419 fprintf_filtered (stream, _("\
1420 --disable-libmcheck\n\
1424 fprintf_filtered (stream, _("\
1428 fprintf_filtered (stream, _("\
1432 #ifdef WITH_PYTHON_PATH
1433 fprintf_filtered (stream, _("\
1434 --with-python=%s%s\n\
1435 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1438 fprintf_filtered (stream, _("\
1442 fprintf_filtered (stream, _("\
1447 fprintf_filtered (stream, _("\
1448 --with-relocated-sources=%s\n\
1452 fprintf_filtered (stream, _("\
1453 --with-separate-debug-dir=%s%s\n\
1454 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1455 if (TARGET_SYSTEM_ROOT[0])
1456 fprintf_filtered (stream, _("\
1457 --with-sysroot=%s%s\n\
1458 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1459 if (SYSTEM_GDBINIT[0])
1460 fprintf_filtered (stream, _("\
1461 --with-system-gdbinit=%s%s\n\
1462 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1463 /* We assume "relocatable" will be printed at least once, thus we always
1464 print this text. It's a reasonably safe assumption for now. */
1465 fprintf_filtered (stream, _("\n\
1466 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1467 tree, and GDB will still find it.)\n\
1472 /* The current top level prompt, settable with "set prompt", and/or
1473 with the python `gdb.prompt_hook' hook. */
1474 static char *top_prompt;
1476 /* Access method for the GDB prompt string. */
1484 /* Set method for the GDB prompt string. */
1487 set_prompt (const char *s)
1489 char *p = xstrdup (s);
1501 /* Callback for iterate_over_inferiors. Kills or detaches the given
1502 inferior, depending on how we originally gained control of it. */
1505 kill_or_detach (struct inferior *inf, void *args)
1507 struct qt_args *qt = (struct qt_args *) args;
1512 thread_info *thread = any_thread_of_inferior (inf);
1515 switch_to_thread (thread);
1517 /* Leave core files alone. */
1518 if (target_has_execution)
1520 if (inf->attach_flag)
1521 target_detach (inf, qt->from_tty);
1530 /* Callback for iterate_over_inferiors. Prints info about what GDB
1531 will do to each inferior on a "quit". ARG points to a struct
1532 ui_out where output is to be collected. */
1535 print_inferior_quit_action (struct inferior *inf, void *arg)
1537 struct ui_file *stb = (struct ui_file *) arg;
1542 if (inf->attach_flag)
1543 fprintf_filtered (stb,
1544 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1545 target_pid_to_str (ptid_t (inf->pid)));
1547 fprintf_filtered (stb,
1548 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1549 target_pid_to_str (ptid_t (inf->pid)));
1554 /* If necessary, make the user confirm that we should quit. Return
1555 non-zero if we should quit, zero if we shouldn't. */
1560 /* Don't even ask if we're only debugging a core file inferior. */
1561 if (!have_live_inferiors ())
1564 /* Build the query string as a single string. */
1567 stb.puts (_("A debugging session is active.\n\n"));
1568 iterate_over_inferiors (print_inferior_quit_action, &stb);
1569 stb.puts (_("\nQuit anyway? "));
1571 return query ("%s", stb.c_str ());
1574 /* Prepare to exit GDB cleanly by undoing any changes made to the
1575 terminal so that we leave the terminal in the state we acquired it. */
1578 undo_terminal_modifications_before_exit (void)
1580 struct ui *saved_top_level = current_ui;
1582 target_terminal::ours ();
1584 current_ui = main_ui;
1589 gdb_disable_readline ();
1591 current_ui = saved_top_level;
1595 /* Quit without asking for confirmation. */
1598 quit_force (int *exit_arg, int from_tty)
1603 undo_terminal_modifications_before_exit ();
1605 /* An optional expression may be used to cause gdb to terminate with the
1606 value of that expression. */
1608 exit_code = *exit_arg;
1609 else if (return_child_result)
1610 exit_code = return_child_result_value;
1612 qt.from_tty = from_tty;
1614 /* We want to handle any quit errors and exit regardless. */
1616 /* Get out of tfind mode, and kill or detach all inferiors. */
1619 disconnect_tracing ();
1620 iterate_over_inferiors (kill_or_detach, &qt);
1622 CATCH (ex, RETURN_MASK_ALL)
1624 exception_print (gdb_stderr, ex);
1628 /* Give all pushed targets a chance to do minimal cleanup, and pop
1634 CATCH (ex, RETURN_MASK_ALL)
1636 exception_print (gdb_stderr, ex);
1640 /* Save the history information if it is appropriate to do so. */
1643 if (write_history_p && history_filename)
1648 /* History is currently shared between all UIs. If there's
1649 any UI with a terminal, save history. */
1652 if (input_interactive_p (ui))
1660 gdb_safe_append_history ();
1663 CATCH (ex, RETURN_MASK_ALL)
1665 exception_print (gdb_stderr, ex);
1669 /* Do any final cleanups before exiting. */
1672 do_final_cleanups (all_cleanups ());
1674 CATCH (ex, RETURN_MASK_ALL)
1676 exception_print (gdb_stderr, ex);
1683 /* The value of the "interactive-mode" setting. */
1684 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1686 /* Implement the "show interactive-mode" option. */
1689 show_interactive_mode (struct ui_file *file, int from_tty,
1690 struct cmd_list_element *c,
1693 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1694 fprintf_filtered (file, "Debugger's interactive mode "
1695 "is %s (currently %s).\n",
1696 value, input_interactive_p (current_ui) ? "on" : "off");
1698 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1701 /* Returns whether GDB is running on an interactive terminal. */
1704 input_interactive_p (struct ui *ui)
1709 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1710 return interactive_mode == AUTO_BOOLEAN_TRUE;
1712 return ui->input_interactive_p;
1716 dont_repeat_command (const char *ignored, int from_tty)
1718 /* Can't call dont_repeat here because we're not necessarily reading
1720 *saved_command_line = 0;
1723 /* Functions to manipulate command line editing control variables. */
1725 /* Number of commands to print in each call to show_commands. */
1726 #define Hist_print 10
1728 show_commands (const char *args, int from_tty)
1730 /* Index for history commands. Relative to history_base. */
1733 /* Number of the history entry which we are planning to display next.
1734 Relative to history_base. */
1737 /* Print out some of the commands from the command history. */
1741 if (args[0] == '+' && args[1] == '\0')
1742 /* "info editing +" should print from the stored position. */
1745 /* "info editing <exp>" should print around command number <exp>. */
1746 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1748 /* "show commands" means print the last Hist_print commands. */
1751 num = history_length - Hist_print;
1757 /* If there are at least Hist_print commands, we want to display the last
1758 Hist_print rather than, say, the last 6. */
1759 if (history_length - num < Hist_print)
1761 num = history_length - Hist_print;
1767 offset < num + Hist_print && offset < history_length;
1770 printf_filtered ("%5d %s\n", history_base + offset,
1771 (history_get (history_base + offset))->line);
1774 /* The next command we want to display is the next one that we haven't
1778 /* If the user repeats this command with return, it should do what
1779 "show commands +" does. This is unnecessary if arg is null,
1780 because "show commands +" is not useful after "show commands". */
1781 if (from_tty && args)
1782 set_repeat_arguments ("+");
1785 /* Update the size of our command history file to HISTORY_SIZE.
1787 A HISTORY_SIZE of -1 stands for unlimited. */
1790 set_readline_history_size (int history_size)
1792 gdb_assert (history_size >= -1);
1794 if (history_size == -1)
1795 unstifle_history ();
1797 stifle_history (history_size);
1800 /* Called by do_setshow_command. */
1802 set_history_size_command (const char *args,
1803 int from_tty, struct cmd_list_element *c)
1805 set_readline_history_size (history_size_setshow_var);
1809 set_history (const char *args, int from_tty)
1811 printf_unfiltered (_("\"set history\" must be followed "
1812 "by the name of a history subcommand.\n"));
1813 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1817 show_history (const char *args, int from_tty)
1819 cmd_show_list (showhistlist, from_tty, "");
1822 int info_verbose = 0; /* Default verbose msgs off. */
1824 /* Called by do_setshow_command. An elaborate joke. */
1826 set_verbose (const char *args, int from_tty, struct cmd_list_element *c)
1828 const char *cmdname = "verbose";
1829 struct cmd_list_element *showcmd;
1831 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1832 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1836 c->doc = "Set verbose printing of informational messages.";
1837 showcmd->doc = "Show verbose printing of informational messages.";
1841 c->doc = "Set verbosity.";
1842 showcmd->doc = "Show verbosity.";
1846 /* Init the history buffer. Note that we are called after the init file(s)
1847 have been read so that the user can change the history file via his
1848 .gdbinit file (for instance). The GDBHISTFILE environment variable
1849 overrides all of this. */
1856 tmpenv = getenv ("GDBHISTSIZE");
1863 tmpenv = skip_spaces (tmpenv);
1865 var = strtol (tmpenv, &endptr, 10);
1866 saved_errno = errno;
1867 endptr = skip_spaces (endptr);
1869 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1870 empty string, a negative number or a huge positive number (larger than
1871 INT_MAX) then set the history size to unlimited. Otherwise set our
1872 history size to the number we have read. This behavior is consistent
1873 with how bash handles HISTSIZE. */
1874 if (*endptr != '\0')
1876 else if (*tmpenv == '\0'
1879 /* On targets where INT_MAX == LONG_MAX, we have to look at
1880 errno after calling strtol to distinguish between a value that
1881 is exactly INT_MAX and an overflowing value that was clamped
1883 || (var == INT_MAX && saved_errno == ERANGE))
1884 history_size_setshow_var = -1;
1886 history_size_setshow_var = var;
1889 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1891 if (history_size_setshow_var == -2)
1892 history_size_setshow_var = 256;
1894 set_readline_history_size (history_size_setshow_var);
1896 tmpenv = getenv ("GDBHISTFILE");
1898 history_filename = xstrdup (tmpenv);
1899 else if (!history_filename)
1901 /* We include the current directory so that if the user changes
1902 directories the file written will be the same as the one
1905 /* No leading dots in file names are allowed on MSDOS. */
1906 history_filename = concat (current_directory, "/_gdb_history",
1909 history_filename = concat (current_directory, "/.gdb_history",
1913 read_history (history_filename);
1917 show_prompt (struct ui_file *file, int from_tty,
1918 struct cmd_list_element *c, const char *value)
1920 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1923 /* "set editing" command. */
1926 set_editing (const char *args, int from_tty, struct cmd_list_element *c)
1928 change_line_handler (set_editing_cmd_var);
1929 /* Update the control variable so that MI's =cmd-param-changed event
1930 shows the correct value. */
1931 set_editing_cmd_var = current_ui->command_editing;
1935 show_editing (struct ui_file *file, int from_tty,
1936 struct cmd_list_element *c, const char *value)
1938 fprintf_filtered (file, _("Editing of command lines as "
1939 "they are typed is %s.\n"),
1940 current_ui->command_editing ? _("on") : _("off"));
1944 show_annotation_level (struct ui_file *file, int from_tty,
1945 struct cmd_list_element *c, const char *value)
1947 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1951 show_exec_done_display_p (struct ui_file *file, int from_tty,
1952 struct cmd_list_element *c, const char *value)
1954 fprintf_filtered (file, _("Notification of completion for "
1955 "asynchronous execution commands is %s.\n"),
1959 /* New values of the "data-directory" parameter are staged here. */
1960 static char *staged_gdb_datadir;
1962 /* "set" command for the gdb_datadir configuration variable. */
1965 set_gdb_datadir (const char *args, int from_tty, struct cmd_list_element *c)
1967 set_gdb_data_directory (staged_gdb_datadir);
1968 gdb::observers::gdb_datadir_changed.notify ();
1971 /* "show" command for the gdb_datadir configuration variable. */
1974 show_gdb_datadir (struct ui_file *file, int from_tty,
1975 struct cmd_list_element *c, const char *value)
1977 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1982 set_history_filename (const char *args,
1983 int from_tty, struct cmd_list_element *c)
1985 /* We include the current directory so that if the user changes
1986 directories the file written will be the same as the one
1988 if (!IS_ABSOLUTE_PATH (history_filename))
1989 history_filename = reconcat (history_filename, current_directory, "/",
1990 history_filename, (char *) NULL);
1996 struct cmd_list_element *c;
1998 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1999 the DEFAULT_PROMPT is. */
2000 set_prompt (DEFAULT_PROMPT);
2002 /* Set the important stuff up for command editing. */
2003 command_editing_p = 1;
2004 history_expansion_p = 0;
2005 write_history_p = 0;
2007 /* Setup important stuff for command line editing. */
2008 rl_completion_word_break_hook = gdb_completion_word_break_characters;
2009 rl_attempted_completion_function = gdb_rl_attempted_completion_function;
2010 set_rl_completer_word_break_characters (default_word_break_characters ());
2011 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
2012 rl_completion_display_matches_hook = cli_display_match_list;
2013 rl_readline_name = "gdb";
2014 rl_terminal_name = getenv ("TERM");
2016 /* The name for this defun comes from Bash, where it originated.
2017 15 is Control-o, the same binding this function has in Bash. */
2018 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2020 add_setshow_string_cmd ("prompt", class_support,
2022 _("Set gdb's prompt"),
2023 _("Show gdb's prompt"),
2026 &setlist, &showlist);
2028 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2029 Don't repeat this command.\nPrimarily \
2030 used inside of user-defined commands that should not be repeated when\n\
2033 add_setshow_boolean_cmd ("editing", class_support,
2034 &set_editing_cmd_var, _("\
2035 Set editing of command lines as they are typed."), _("\
2036 Show editing of command lines as they are typed."), _("\
2037 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2038 Without an argument, command line editing is enabled. To edit, use\n\
2039 EMACS-like or VI-like commands like control-P or ESC."),
2042 &setlist, &showlist);
2044 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2045 Set saving of the history record on exit."), _("\
2046 Show saving of the history record on exit."), _("\
2047 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2048 Without an argument, saving is enabled."),
2050 show_write_history_p,
2051 &sethistlist, &showhistlist);
2053 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2054 &history_size_setshow_var, _("\
2055 Set the size of the command history,"), _("\
2056 Show the size of the command history,"), _("\
2057 ie. the number of previous commands to keep a record of.\n\
2058 If set to \"unlimited\", the number of commands kept in the history\n\
2059 list is unlimited. This defaults to the value of the environment\n\
2060 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2061 set_history_size_command,
2063 &sethistlist, &showhistlist);
2065 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2066 &history_remove_duplicates, _("\
2067 Set how far back in history to look for and remove duplicate entries."), _("\
2068 Show how far back in history to look for and remove duplicate entries."), _("\
2069 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2070 and remove the first history entry that is a duplicate of the most recent\n\
2071 entry, each time a new history entry is added.\n\
2072 If set to \"unlimited\", this lookbehind is unbounded.\n\
2073 Only history entries added during this session are considered for removal.\n\
2074 If set to 0, removal of duplicate history entries is disabled.\n\
2075 By default this option is set to 0."),
2077 show_history_remove_duplicates,
2078 &sethistlist, &showhistlist);
2080 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2081 Set the filename in which to record the command history"), _("\
2082 Show the filename in which to record the command history"), _("\
2083 (the list of previous commands of which a record is kept)."),
2084 set_history_filename,
2085 show_history_filename,
2086 &sethistlist, &showhistlist);
2088 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2089 Set whether to confirm potentially dangerous operations."), _("\
2090 Show whether to confirm potentially dangerous operations."), NULL,
2093 &setlist, &showlist);
2095 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2096 Set annotation_level."), _("\
2097 Show annotation_level."), _("\
2098 0 == normal; 1 == fullname (for use when running under emacs)\n\
2099 2 == output annotated suitably for use by programs that control GDB."),
2101 show_annotation_level,
2102 &setlist, &showlist);
2104 add_setshow_boolean_cmd ("exec-done-display", class_support,
2105 &exec_done_display_p, _("\
2106 Set notification of completion for asynchronous execution commands."), _("\
2107 Show notification of completion for asynchronous execution commands."), _("\
2108 Use \"on\" to enable the notification, and \"off\" to disable it."),
2110 show_exec_done_display_p,
2111 &setlist, &showlist);
2113 add_setshow_filename_cmd ("data-directory", class_maintenance,
2114 &staged_gdb_datadir, _("Set GDB's data directory."),
2115 _("Show GDB's data directory."),
2117 When set, GDB uses the specified path to search for data files."),
2118 set_gdb_datadir, show_gdb_datadir,
2122 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2123 &interactive_mode, _("\
2124 Set whether GDB's standard input is a terminal."), _("\
2125 Show whether GDB's standard input is a terminal."), _("\
2126 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2127 means that GDB should wait for the user to answer queries associated to\n\
2128 commands entered at the command prompt. If off, GDB assumes that standard\n\
2129 input is not a terminal, and uses the default answer to all queries.\n\
2130 If auto (the default), determine which mode to use based on the standard\n\
2133 show_interactive_mode,
2134 &setlist, &showlist);
2136 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2137 Create a new UI. It takes two arguments:\n\
2138 The first argument is the name of the interpreter to run.\n\
2139 The second argument is the terminal the UI runs on.\n"), &cmdlist);
2140 set_cmd_completer (c, interpreter_completer);
2144 gdb_init (char *argv0)
2146 if (pre_init_ui_hook)
2147 pre_init_ui_hook ();
2149 /* Run the init function of each source file. */
2152 /* Make sure we return to the original directory upon exit, come
2153 what may, since the OS doesn't do that for us. */
2154 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2157 init_cmd_lists (); /* This needs to be done first. */
2158 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2159 initialize_utils (); /* Make errors and warnings possible. */
2163 /* Here is where we call all the _initialize_foo routines. */
2164 initialize_all_files ();
2166 /* This creates the current_program_space. Do this after all the
2167 _initialize_foo routines have had a chance to install their
2168 per-sspace data keys. Also do this before
2169 initialize_current_architecture is called, because it accesses
2170 exec_bfd of the current program space. */
2171 initialize_progspace ();
2172 initialize_inferiors ();
2173 initialize_current_architecture ();
2175 init_main (); /* But that omits this file! Do it now. */
2177 initialize_stdin_serial ();
2179 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2181 set_initial_gdb_ttystate ();
2183 async_init_signals ();
2185 /* We need a default language for parsing expressions, so simple
2186 things like "set width 0" won't fail if no language is explicitly
2187 set in a config file or implicitly set by reading an executable
2189 set_language (language_c);
2190 expected_language = current_language; /* Don't warn about the change. */
2192 /* Python initialization, for example, can require various commands to be
2193 installed. For example "info pretty-printer" needs the "info"
2194 prefix to be installed. Keep things simple and just do final
2195 script initialization here. */
2196 finish_ext_lang_initialization ();