1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2017 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"
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 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 struct interp *interp;
330 gdb_file_up stream[3];
334 const char *interpreter_name;
335 const char *tty_name;
339 gdb_argv argv (args);
340 argc = argv.count ();
343 error (_("usage: new-ui <interpreter> <tty>"));
345 interpreter_name = argv[0];
349 scoped_restore save_ui = make_scoped_restore (¤t_ui);
351 /* Open specified terminal, once for each of
352 stdin/stdout/stderr. */
353 for (i = 0; i < 3; i++)
354 stream[i] = open_terminal_stream (tty_name);
356 std::unique_ptr<ui> ui
357 (new struct ui (stream[0].get (), stream[1].get (), stream[2].get ()));
361 current_ui = ui.get ();
363 set_top_level_interpreter (interpreter_name);
365 interp_pre_command_loop (top_level_interpreter ());
367 /* Make sure the files are not closed. */
368 stream[0].release ();
369 stream[1].release ();
370 stream[2].release ();
375 printf_unfiltered ("New UI allocated\n");
378 /* Handler for SIGHUP. */
381 /* NOTE 1999-04-29: This function will be static again, once we modify
382 gdb to use the event loop as the default command loop and we merge
383 event-top.c into this file, top.c. */
387 /* Stop asking user for confirmation --- we're exiting. This
388 prevents asking the user dumb questions. */
390 quit_command ((char *) 0, 0);
392 #endif /* defined SIGHUP */
394 /* Line number we are currently in, in a file which is being sourced. */
395 /* NOTE 1999-04-29: This variable will be static again, once we modify
396 gdb to use the event loop as the default command loop and we merge
397 event-top.c into this file, top.c. */
398 /* static */ int source_line_number;
400 /* Name of the file we are sourcing. */
401 /* NOTE 1999-04-29: This variable will be static again, once we modify
402 gdb to use the event loop as the default command loop and we merge
403 event-top.c into this file, top.c. */
404 /* static */ const char *source_file_name;
406 /* Read commands from STREAM. */
408 read_command_file (FILE *stream)
410 struct ui *ui = current_ui;
412 scoped_restore save_instream
413 = make_scoped_restore (&ui->instream, stream);
415 /* Read commands from `instream' and execute them until end of file
416 or error reading instream. */
418 while (ui->instream != NULL && !feof (ui->instream))
422 /* Get a command-line. This calls the readline package. */
423 command = command_line_input (NULL, 0, NULL);
426 command_handler (command);
430 void (*pre_init_ui_hook) (void);
434 do_chdir_cleanup (void *old_dir)
436 chdir ((const char *) old_dir);
442 prepare_execute_command ()
444 /* With multiple threads running while the one we're examining is
445 stopped, the dcache can get stale without us being able to detect
446 it. For the duration of the command, though, use the dcache to
447 help things like backtrace. */
449 target_dcache_invalidate ();
451 return scoped_value_mark ();
454 /* Tell the user if the language has changed (except first time) after
455 executing a command. */
458 check_frame_language_change (void)
460 static int warned = 0;
461 struct frame_info *frame;
463 /* First make sure that a new frame has been selected, in case the
464 command or the hooks changed the program state. */
465 frame = deprecated_safe_get_selected_frame ();
466 if (current_language != expected_language)
468 if (language_mode == language_mode_auto && info_verbose)
470 language_info (1); /* Print what changed. */
475 /* Warn the user if the working language does not match the language
476 of the current frame. Only warn the user if we are actually
477 running the program, i.e. there is a stack. */
478 /* FIXME: This should be cacheing the frame and only running when
479 the frame changes. */
481 if (has_stack_frames ())
485 flang = get_frame_language (frame);
487 && flang != language_unknown
488 && flang != current_language->la_language)
490 printf_filtered ("%s\n", lang_frame_mismatch_warn);
499 wait_sync_command_done (void)
501 /* Processing events may change the current UI. */
502 scoped_restore save_ui = make_scoped_restore (¤t_ui);
503 struct ui *ui = current_ui;
505 while (gdb_do_one_event () >= 0)
506 if (ui->prompt_state != PROMPT_BLOCKED)
513 maybe_wait_sync_command_done (int was_sync)
515 /* If the interpreter is in sync mode (we're running a user
516 command's list, running command hooks or similars), and we
517 just ran a synchronous command that started the target, wait
518 for that command to end. */
519 if (!current_ui->async
521 && current_ui->prompt_state == PROMPT_BLOCKED)
522 wait_sync_command_done ();
525 /* If not NULL, the arguments that should be passed if the current
526 command is repeated. */
528 static const char *repeat_arguments;
533 set_repeat_arguments (const char *args)
535 repeat_arguments = args;
538 /* Execute the line P as a command, in the current user context.
539 Pass FROM_TTY as second argument to the defining function. */
542 execute_command (char *p, int from_tty)
544 struct cleanup *cleanup_if_error;
545 struct cmd_list_element *c;
548 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
549 scoped_value_mark cleanup = prepare_execute_command ();
551 /* Force cleanup of any alloca areas if using C alloca instead of
555 /* This can happen when command_line_input hits end of file. */
558 discard_cleanups (cleanup_if_error);
562 target_log_command (p);
564 while (*p == ' ' || *p == '\t')
570 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
574 /* If trace-commands is set then this will print this command. */
575 print_command_trace (p);
577 c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
580 scoped_restore save_repeat_args
581 = make_scoped_restore (&repeat_arguments, nullptr);
582 char *args_pointer = p;
584 /* Pass null arg rather than an empty one. */
587 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
588 while the is_complete_command(cfunc) test is just plain
589 bogus. They should both be replaced by a test of the form
590 c->strip_trailing_white_space_p. */
591 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
592 can't be replaced with func. This is because it is the
593 cfunc, and not the func, that has the value that the
594 is_complete_command hack is testing for. */
595 /* Clear off trailing whitespace, except for set and complete
598 && c->type != set_cmd
599 && !is_complete_command (c))
601 p = arg + strlen (arg) - 1;
602 while (p >= arg && (*p == ' ' || *p == '\t'))
607 /* If this command has been pre-hooked, run the hook first. */
608 execute_cmd_pre_hook (c);
610 if (c->deprecated_warn_user)
611 deprecated_cmd_warning (line);
613 /* c->user_commands would be NULL in the case of a python command. */
614 if (c->theclass == class_user && c->user_commands)
615 execute_user_command (c, arg);
616 else if (c->type == set_cmd)
617 do_set_command (arg, from_tty, c);
618 else if (c->type == show_cmd)
619 do_show_command (arg, from_tty, c);
620 else if (!cmd_func_p (c))
621 error (_("That is not a command, just a help topic."));
622 else if (deprecated_call_command_hook)
623 deprecated_call_command_hook (c, arg, from_tty);
625 cmd_func (c, arg, from_tty);
627 maybe_wait_sync_command_done (was_sync);
629 /* If this command has been post-hooked, run the hook last. */
630 execute_cmd_post_hook (c);
632 if (repeat_arguments != NULL)
634 gdb_assert (strlen (args_pointer) >= strlen (repeat_arguments));
635 strcpy (args_pointer, repeat_arguments);
639 check_frame_language_change ();
641 discard_cleanups (cleanup_if_error);
644 /* Run execute_command for P and FROM_TTY. Capture its output into the
645 returned string, do not display it to the screen. BATCH_FLAG will be
646 temporarily set to true. */
649 execute_command_to_string (char *p, int from_tty)
651 /* GDB_STDOUT should be better already restored during these
652 restoration callbacks. */
653 set_batch_flag_and_restore_page_info save_page_info;
655 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
657 string_file str_file;
660 current_uiout->redirect (&str_file);
661 ui_out_redirect_pop redirect_popper (current_uiout);
663 scoped_restore save_stdout
664 = make_scoped_restore (&gdb_stdout, &str_file);
665 scoped_restore save_stderr
666 = make_scoped_restore (&gdb_stderr, &str_file);
667 scoped_restore save_stdlog
668 = make_scoped_restore (&gdb_stdlog, &str_file);
669 scoped_restore save_stdtarg
670 = make_scoped_restore (&gdb_stdtarg, &str_file);
671 scoped_restore save_stdtargerr
672 = make_scoped_restore (&gdb_stdtargerr, &str_file);
674 execute_command (p, from_tty);
677 return std::move (str_file.string ());
681 /* When nonzero, cause dont_repeat to do nothing. This should only be
682 set via prevent_dont_repeat. */
684 static int suppress_dont_repeat = 0;
686 /* Commands call this if they do not want to be repeated by null lines. */
691 struct ui *ui = current_ui;
693 if (suppress_dont_repeat || server_command)
696 /* If we aren't reading from standard input, we are saving the last
697 thing read from stdin in line and don't want to delete it. Null
698 lines won't repeat here in any case. */
699 if (ui->instream == ui->stdin_stream)
700 *saved_command_line = 0;
703 /* Prevent dont_repeat from working, and return a cleanup that
704 restores the previous state. */
706 scoped_restore_tmpl<int>
707 prevent_dont_repeat (void)
709 return make_scoped_restore (&suppress_dont_repeat, 1);
713 /* Read a line from the stream "instream" without command line editing.
715 It prints PROMPT once at the start.
716 Action is compatible with "readline", e.g. space for the result is
717 malloc'd and should be freed by the caller.
719 A NULL return means end of file. */
722 gdb_readline_no_editing (const char *prompt)
724 struct buffer line_buffer;
725 struct ui *ui = current_ui;
726 /* Read from stdin if we are executing a user defined command. This
727 is the right thing for prompt_for_continue, at least. */
728 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
729 int fd = fileno (stream);
731 buffer_init (&line_buffer);
735 /* Don't use a _filtered function here. It causes the assumed
736 character position to be off, since the newline we read from
737 the user is not accounted for. */
738 fputs_unfiltered (prompt, gdb_stdout);
739 gdb_flush (gdb_stdout);
750 /* Wait until at least one byte of data is available. Control-C
751 can interrupt interruptible_select, but not fgetc. */
753 FD_SET (fd, &readfds);
754 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
758 /* If this was ctrl-c, the QUIT above handles it. */
761 perror_with_name (("select"));
768 if (line_buffer.used_size > 0)
769 /* The last line does not end with a newline. Return it, and
770 if we are called again fgetc will still return EOF and
771 we'll return NULL then. */
773 xfree (buffer_finish (&line_buffer));
779 if (line_buffer.used_size > 0
780 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
781 line_buffer.used_size--;
785 buffer_grow_char (&line_buffer, c);
788 buffer_grow_char (&line_buffer, '\0');
789 return buffer_finish (&line_buffer);
792 /* Variables which control command line editing and history
793 substitution. These variables are given default values at the end
795 static int command_editing_p;
797 /* NOTE 1999-04-29: This variable will be static again, once we modify
798 gdb to use the event loop as the default command loop and we merge
799 event-top.c into this file, top.c. */
801 /* static */ int history_expansion_p;
803 static int write_history_p;
805 show_write_history_p (struct ui_file *file, int from_tty,
806 struct cmd_list_element *c, const char *value)
808 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
812 /* The variable associated with the "set/show history size"
813 command. The value -1 means unlimited, and -2 means undefined. */
814 static int history_size_setshow_var = -2;
817 show_history_size (struct ui_file *file, int from_tty,
818 struct cmd_list_element *c, const char *value)
820 fprintf_filtered (file, _("The size of the command history is %s.\n"),
824 /* Variable associated with the "history remove-duplicates" option.
825 The value -1 means unlimited. */
826 static int history_remove_duplicates = 0;
829 show_history_remove_duplicates (struct ui_file *file, int from_tty,
830 struct cmd_list_element *c, const char *value)
832 fprintf_filtered (file,
833 _("The number of history entries to look back at for "
834 "duplicates is %s.\n"),
838 static char *history_filename;
840 show_history_filename (struct ui_file *file, int from_tty,
841 struct cmd_list_element *c, const char *value)
843 fprintf_filtered (file, _("The filename in which to record "
844 "the command history is \"%s\".\n"),
848 /* This is like readline(), but it has some gdb-specific behavior.
849 gdb may want readline in both the synchronous and async modes during
850 a single gdb invocation. At the ordinary top-level prompt we might
851 be using the async readline. That means we can't use
852 rl_pre_input_hook, since it doesn't work properly in async mode.
853 However, for a secondary prompt (" >", such as occurs during a
854 `define'), gdb wants a synchronous response.
856 We used to call readline() directly, running it in synchronous
857 mode. But mixing modes this way is not supported, and as of
858 readline 5.x it no longer works; the arrow keys come unbound during
859 the synchronous call. So we make a nested call into the event
860 loop. That's what gdb_readline_wrapper is for. */
862 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
863 rely on gdb_readline_wrapper_result, which might still be NULL if
864 the user types Control-D for EOF. */
865 static int gdb_readline_wrapper_done;
867 /* The result of the current call to gdb_readline_wrapper, once a newline
869 static char *gdb_readline_wrapper_result;
871 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
872 to be called after the newline is processed (which will redisplay
873 the prompt). But in gdb_readline_wrapper we will not get a new
874 prompt until the next call, or until we return to the event loop.
875 So we disable this hook around the newline and restore it before we
877 static void (*saved_after_char_processing_hook) (void);
883 gdb_in_secondary_prompt_p (struct ui *ui)
885 return ui->secondary_prompt_depth > 0;
889 /* This function is called when readline has seen a complete line of
893 gdb_readline_wrapper_line (char *line)
895 gdb_assert (!gdb_readline_wrapper_done);
896 gdb_readline_wrapper_result = line;
897 gdb_readline_wrapper_done = 1;
899 /* Prevent operate-and-get-next from acting too early. */
900 saved_after_char_processing_hook = after_char_processing_hook;
901 after_char_processing_hook = NULL;
903 /* Prevent parts of the prompt from being redisplayed if annotations
904 are enabled, and readline's state getting out of sync. We'll
905 reinstall the callback handler, which puts the terminal in raw
906 mode (or in readline lingo, in prepped state), when we're next
907 ready to process user input, either in display_gdb_prompt, or if
908 we're handling an asynchronous target event and running in the
909 background, just before returning to the event loop to process
910 further input (or more target events). */
911 if (current_ui->command_editing)
912 gdb_rl_callback_handler_remove ();
915 struct gdb_readline_wrapper_cleanup
917 void (*handler_orig) (char *);
918 int already_prompted_orig;
920 /* Whether the target was async. */
921 int target_is_async_orig;
925 gdb_readline_wrapper_cleanup (void *arg)
927 struct ui *ui = current_ui;
928 struct gdb_readline_wrapper_cleanup *cleanup
929 = (struct gdb_readline_wrapper_cleanup *) arg;
931 if (ui->command_editing)
932 rl_already_prompted = cleanup->already_prompted_orig;
934 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
935 ui->input_handler = cleanup->handler_orig;
937 /* Don't restore our input handler in readline yet. That would make
938 readline prep the terminal (putting it in raw mode), while the
939 line we just read may trigger execution of a command that expects
940 the terminal in the default cooked/canonical mode, such as e.g.,
941 running Python's interactive online help utility. See
942 gdb_readline_wrapper_line for when we'll reinstall it. */
944 gdb_readline_wrapper_result = NULL;
945 gdb_readline_wrapper_done = 0;
946 ui->secondary_prompt_depth--;
947 gdb_assert (ui->secondary_prompt_depth >= 0);
949 after_char_processing_hook = saved_after_char_processing_hook;
950 saved_after_char_processing_hook = NULL;
952 if (cleanup->target_is_async_orig)
959 gdb_readline_wrapper (const char *prompt)
961 struct ui *ui = current_ui;
962 struct cleanup *back_to;
963 struct gdb_readline_wrapper_cleanup *cleanup;
966 cleanup = XNEW (struct gdb_readline_wrapper_cleanup);
967 cleanup->handler_orig = ui->input_handler;
968 ui->input_handler = gdb_readline_wrapper_line;
970 if (ui->command_editing)
971 cleanup->already_prompted_orig = rl_already_prompted;
973 cleanup->already_prompted_orig = 0;
975 cleanup->target_is_async_orig = target_is_async_p ();
977 ui->secondary_prompt_depth++;
978 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
980 /* Processing events may change the current UI. */
981 scoped_restore save_ui = make_scoped_restore (¤t_ui);
983 if (cleanup->target_is_async_orig)
986 /* Display our prompt and prevent double prompt display. Don't pass
987 down a NULL prompt, since that has special meaning for
988 display_gdb_prompt -- it indicates a request to print the primary
989 prompt, while we want a secondary prompt here. */
990 display_gdb_prompt (prompt != NULL ? prompt : "");
991 if (ui->command_editing)
992 rl_already_prompted = 1;
994 if (after_char_processing_hook)
995 (*after_char_processing_hook) ();
996 gdb_assert (after_char_processing_hook == NULL);
998 while (gdb_do_one_event () >= 0)
999 if (gdb_readline_wrapper_done)
1002 retval = gdb_readline_wrapper_result;
1003 do_cleanups (back_to);
1008 /* The current saved history number from operate-and-get-next.
1009 This is -1 if not valid. */
1010 static int operate_saved_history = -1;
1012 /* This is put on the appropriate hook and helps operate-and-get-next
1015 gdb_rl_operate_and_get_next_completion (void)
1017 int delta = where_history () - operate_saved_history;
1019 /* The `key' argument to rl_get_previous_history is ignored. */
1020 rl_get_previous_history (delta, 0);
1021 operate_saved_history = -1;
1023 /* readline doesn't automatically update the display for us. */
1026 after_char_processing_hook = NULL;
1027 rl_pre_input_hook = NULL;
1030 /* This is a gdb-local readline command handler. It accepts the
1031 current command line (like RET does) and, if this command was taken
1032 from the history, arranges for the next command in the history to
1033 appear on the command line when the prompt returns.
1034 We ignore the arguments. */
1036 gdb_rl_operate_and_get_next (int count, int key)
1040 /* Use the async hook. */
1041 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1043 /* Find the current line, and find the next line to use. */
1044 where = where_history();
1046 if ((history_is_stifled () && (history_length >= history_max_entries))
1047 || (where >= history_length - 1))
1048 operate_saved_history = where;
1050 operate_saved_history = where + 1;
1052 return rl_newline (1, key);
1055 /* Number of user commands executed during this session. */
1057 static int command_count = 0;
1059 /* Add the user command COMMAND to the input history list. */
1062 gdb_add_history (const char *command)
1066 if (history_remove_duplicates != 0)
1069 int lookbehind_threshold;
1071 /* The lookbehind threshold for finding a duplicate history entry is
1072 bounded by command_count because we can't meaningfully delete
1073 history entries that are already stored in the history file since
1074 the history file is appended to. */
1075 if (history_remove_duplicates == -1
1076 || history_remove_duplicates > command_count)
1077 lookbehind_threshold = command_count;
1079 lookbehind_threshold = history_remove_duplicates;
1082 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1084 HIST_ENTRY *temp = previous_history ();
1089 if (strcmp (temp->line, command) == 0)
1091 HIST_ENTRY *prev = remove_history (where_history ());
1093 free_history_entry (prev);
1100 add_history (command);
1103 /* Safely append new history entries to the history file in a corruption-free
1104 way using an intermediate local history file. */
1107 gdb_safe_append_history (void)
1109 int ret, saved_errno;
1111 std::string local_history_filename
1112 = string_printf ("%s-gdb%ld~", history_filename, (long) getpid ());
1114 ret = rename (history_filename, local_history_filename.c_str ());
1115 saved_errno = errno;
1116 if (ret < 0 && saved_errno != ENOENT)
1118 warning (_("Could not rename %s to %s: %s"),
1119 history_filename, local_history_filename.c_str (),
1120 safe_strerror (saved_errno));
1126 /* If the rename failed with ENOENT then either the global history
1127 file never existed in the first place or another GDB process is
1128 currently appending to it (and has thus temporarily renamed it).
1129 Since we can't distinguish between these two cases, we have to
1130 conservatively assume the first case and therefore must write out
1131 (not append) our known history to our local history file and try
1132 to move it back anyway. Otherwise a global history file would
1133 never get created! */
1134 gdb_assert (saved_errno == ENOENT);
1135 write_history (local_history_filename.c_str ());
1139 append_history (command_count, local_history_filename.c_str ());
1140 if (history_is_stifled ())
1141 history_truncate_file (local_history_filename.c_str (),
1142 history_max_entries);
1145 ret = rename (local_history_filename.c_str (), history_filename);
1146 saved_errno = errno;
1147 if (ret < 0 && saved_errno != EEXIST)
1148 warning (_("Could not rename %s to %s: %s"),
1149 local_history_filename.c_str (), history_filename,
1150 safe_strerror (saved_errno));
1154 /* Read one line from the command input stream `instream' into a local
1155 static buffer. The buffer is made bigger as necessary. Returns
1156 the address of the start of the line.
1158 NULL is returned for end of file.
1160 *If* input is from an interactive stream (stdin), the line read is
1161 copied into the global 'saved_command_line' so that it can be
1164 This routine either uses fancy command line editing or simple input
1165 as the user has requested. */
1168 command_line_input (const char *prompt_arg, int repeat,
1169 const char *annotation_suffix)
1171 static struct buffer cmd_line_buffer;
1172 static int cmd_line_buffer_initialized;
1173 struct ui *ui = current_ui;
1174 const char *prompt = prompt_arg;
1176 int from_tty = ui->instream == ui->stdin_stream;
1178 /* The annotation suffix must be non-NULL. */
1179 if (annotation_suffix == NULL)
1180 annotation_suffix = "";
1182 if (from_tty && annotation_level > 1)
1187 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1188 + strlen (annotation_suffix) + 40);
1190 local_prompt[0] = '\0';
1192 strcpy (local_prompt, prompt);
1193 strcat (local_prompt, "\n\032\032");
1194 strcat (local_prompt, annotation_suffix);
1195 strcat (local_prompt, "\n");
1197 prompt = local_prompt;
1200 if (!cmd_line_buffer_initialized)
1202 buffer_init (&cmd_line_buffer);
1203 cmd_line_buffer_initialized = 1;
1206 /* Starting a new command line. */
1207 cmd_line_buffer.used_size = 0;
1211 signal (SIGTSTP, handle_sigtstp);
1218 /* Make sure that all output has been output. Some machines may
1219 let you get away with leaving out some of the gdb_flush, but
1222 gdb_flush (gdb_stdout);
1223 gdb_flush (gdb_stderr);
1225 if (source_file_name != NULL)
1226 ++source_line_number;
1228 if (from_tty && annotation_level > 1)
1230 puts_unfiltered ("\n\032\032pre-");
1231 puts_unfiltered (annotation_suffix);
1232 puts_unfiltered ("\n");
1235 /* Don't use fancy stuff if not talking to stdin. */
1236 if (deprecated_readline_hook
1238 && input_interactive_p (current_ui))
1240 rl = (*deprecated_readline_hook) (prompt);
1242 else if (command_editing_p
1244 && input_interactive_p (current_ui))
1246 rl = gdb_readline_wrapper (prompt);
1250 rl = gdb_readline_no_editing (prompt);
1253 cmd = handle_line_of_input (&cmd_line_buffer, rl,
1254 repeat, annotation_suffix);
1255 if (cmd == (char *) EOF)
1263 /* Got partial input. I.e., got a line that ends with a
1264 continuation character (backslash). Suppress printing the
1271 signal (SIGTSTP, SIG_DFL);
1277 /* Print the GDB banner. */
1279 print_gdb_version (struct ui_file *stream)
1281 /* From GNU coding standards, first line is meant to be easy for a
1282 program to parse, and is just canonical program name and version
1283 number, which starts after last space. */
1285 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1287 /* Second line is a copyright notice. */
1289 fprintf_filtered (stream,
1290 "Copyright (C) 2017 Free Software Foundation, Inc.\n");
1292 /* Following the copyright is a brief statement that the program is
1293 free software, that users are free to copy and change it on
1294 certain conditions, that it is covered by the GNU GPL, and that
1295 there is no warranty. */
1297 fprintf_filtered (stream, "\
1298 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1299 \nThis is free software: you are free to change and redistribute it.\n\
1300 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1301 and \"show warranty\" for details.\n");
1303 /* After the required info we print the configuration information. */
1305 fprintf_filtered (stream, "This GDB was configured as \"");
1306 if (strcmp (host_name, target_name) != 0)
1308 fprintf_filtered (stream, "--host=%s --target=%s",
1309 host_name, target_name);
1313 fprintf_filtered (stream, "%s", host_name);
1315 fprintf_filtered (stream, "\".\n\
1316 Type \"show configuration\" for configuration details.");
1318 if (REPORT_BUGS_TO[0])
1320 fprintf_filtered (stream,
1321 _("\nFor bug reporting instructions, please see:\n"));
1322 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1324 fprintf_filtered (stream,
1325 _("Find the GDB manual and other documentation \
1326 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1327 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1328 fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1329 commands related to \"word\"."));
1332 /* Print the details of GDB build-time configuration. */
1334 print_gdb_configuration (struct ui_file *stream)
1336 fprintf_filtered (stream, _("\
1337 This GDB was configured as follows:\n\
1338 configure --host=%s --target=%s\n\
1339 "), host_name, target_name);
1340 fprintf_filtered (stream, _("\
1341 --with-auto-load-dir=%s\n\
1342 --with-auto-load-safe-path=%s\n\
1343 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1345 fprintf_filtered (stream, _("\
1349 fprintf_filtered (stream, _("\
1354 fprintf_filtered (stream, _("\
1355 --with-gdb-datadir=%s%s\n\
1356 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1358 fprintf_filtered (stream, _("\
1359 --with-iconv-bin=%s%s\n\
1360 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1362 if (JIT_READER_DIR[0])
1363 fprintf_filtered (stream, _("\
1364 --with-jit-reader-dir=%s%s\n\
1365 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1366 #if HAVE_LIBUNWIND_IA64_H
1367 fprintf_filtered (stream, _("\
1368 --with-libunwind-ia64\n\
1371 fprintf_filtered (stream, _("\
1372 --without-libunwind-ia64\n\
1376 fprintf_filtered (stream, _("\
1380 fprintf_filtered (stream, _("\
1384 #ifdef WITH_PYTHON_PATH
1385 fprintf_filtered (stream, _("\
1386 --with-python=%s%s\n\
1387 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1390 fprintf_filtered (stream, _("\
1394 fprintf_filtered (stream, _("\
1399 fprintf_filtered (stream, _("\
1400 --with-relocated-sources=%s\n\
1404 fprintf_filtered (stream, _("\
1405 --with-separate-debug-dir=%s%s\n\
1406 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1407 if (TARGET_SYSTEM_ROOT[0])
1408 fprintf_filtered (stream, _("\
1409 --with-sysroot=%s%s\n\
1410 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1411 if (SYSTEM_GDBINIT[0])
1412 fprintf_filtered (stream, _("\
1413 --with-system-gdbinit=%s%s\n\
1414 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1415 #if HAVE_LIBBABELTRACE
1416 fprintf_filtered (stream, _("\
1417 --with-babeltrace\n\
1420 fprintf_filtered (stream, _("\
1421 --without-babeltrace\n\
1424 /* We assume "relocatable" will be printed at least once, thus we always
1425 print this text. It's a reasonably safe assumption for now. */
1426 fprintf_filtered (stream, _("\n\
1427 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1428 tree, and GDB will still find it.)\n\
1433 /* The current top level prompt, settable with "set prompt", and/or
1434 with the python `gdb.prompt_hook' hook. */
1435 static char *top_prompt;
1437 /* Access method for the GDB prompt string. */
1445 /* Set method for the GDB prompt string. */
1448 set_prompt (const char *s)
1450 char *p = xstrdup (s);
1463 /* Callback for iterate_over_inferiors. Kills or detaches the given
1464 inferior, depending on how we originally gained control of it. */
1467 kill_or_detach (struct inferior *inf, void *args)
1469 struct qt_args *qt = (struct qt_args *) args;
1470 struct thread_info *thread;
1475 thread = any_thread_of_process (inf->pid);
1478 switch_to_thread (thread->ptid);
1480 /* Leave core files alone. */
1481 if (target_has_execution)
1483 if (inf->attach_flag)
1484 target_detach (qt->args, qt->from_tty);
1493 /* Callback for iterate_over_inferiors. Prints info about what GDB
1494 will do to each inferior on a "quit". ARG points to a struct
1495 ui_out where output is to be collected. */
1498 print_inferior_quit_action (struct inferior *inf, void *arg)
1500 struct ui_file *stb = (struct ui_file *) arg;
1505 if (inf->attach_flag)
1506 fprintf_filtered (stb,
1507 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1508 target_pid_to_str (pid_to_ptid (inf->pid)));
1510 fprintf_filtered (stb,
1511 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1512 target_pid_to_str (pid_to_ptid (inf->pid)));
1517 /* If necessary, make the user confirm that we should quit. Return
1518 non-zero if we should quit, zero if we shouldn't. */
1523 /* Don't even ask if we're only debugging a core file inferior. */
1524 if (!have_live_inferiors ())
1527 /* Build the query string as a single string. */
1530 stb.puts (_("A debugging session is active.\n\n"));
1531 iterate_over_inferiors (print_inferior_quit_action, &stb);
1532 stb.puts (_("\nQuit anyway? "));
1534 return query ("%s", stb.c_str ());
1537 /* Prepare to exit GDB cleanly by undoing any changes made to the
1538 terminal so that we leave the terminal in the state we acquired it. */
1541 undo_terminal_modifications_before_exit (void)
1543 struct ui *saved_top_level = current_ui;
1545 target_terminal::ours ();
1547 current_ui = main_ui;
1552 gdb_disable_readline ();
1554 current_ui = saved_top_level;
1558 /* Quit without asking for confirmation. */
1561 quit_force (int *exit_arg, int from_tty)
1566 undo_terminal_modifications_before_exit ();
1568 /* An optional expression may be used to cause gdb to terminate with the
1569 value of that expression. */
1571 exit_code = *exit_arg;
1572 else if (return_child_result)
1573 exit_code = return_child_result_value;
1576 qt.from_tty = from_tty;
1578 /* We want to handle any quit errors and exit regardless. */
1580 /* Get out of tfind mode, and kill or detach all inferiors. */
1583 disconnect_tracing ();
1584 iterate_over_inferiors (kill_or_detach, &qt);
1586 CATCH (ex, RETURN_MASK_ALL)
1588 exception_print (gdb_stderr, ex);
1592 /* Give all pushed targets a chance to do minimal cleanup, and pop
1598 CATCH (ex, RETURN_MASK_ALL)
1600 exception_print (gdb_stderr, ex);
1604 /* Save the history information if it is appropriate to do so. */
1607 if (write_history_p && history_filename)
1612 /* History is currently shared between all UIs. If there's
1613 any UI with a terminal, save history. */
1616 if (input_interactive_p (ui))
1624 gdb_safe_append_history ();
1627 CATCH (ex, RETURN_MASK_ALL)
1629 exception_print (gdb_stderr, ex);
1633 /* Do any final cleanups before exiting. */
1636 do_final_cleanups (all_cleanups ());
1638 CATCH (ex, RETURN_MASK_ALL)
1640 exception_print (gdb_stderr, ex);
1647 /* The value of the "interactive-mode" setting. */
1648 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1650 /* Implement the "show interactive-mode" option. */
1653 show_interactive_mode (struct ui_file *file, int from_tty,
1654 struct cmd_list_element *c,
1657 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1658 fprintf_filtered (file, "Debugger's interactive mode "
1659 "is %s (currently %s).\n",
1660 value, input_interactive_p (current_ui) ? "on" : "off");
1662 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1665 /* Returns whether GDB is running on an interactive terminal. */
1668 input_interactive_p (struct ui *ui)
1673 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1674 return interactive_mode == AUTO_BOOLEAN_TRUE;
1676 return ui->input_interactive_p;
1680 dont_repeat_command (const char *ignored, int from_tty)
1682 /* Can't call dont_repeat here because we're not necessarily reading
1684 *saved_command_line = 0;
1687 /* Functions to manipulate command line editing control variables. */
1689 /* Number of commands to print in each call to show_commands. */
1690 #define Hist_print 10
1692 show_commands (const char *args, int from_tty)
1694 /* Index for history commands. Relative to history_base. */
1697 /* Number of the history entry which we are planning to display next.
1698 Relative to history_base. */
1701 /* Print out some of the commands from the command history. */
1705 if (args[0] == '+' && args[1] == '\0')
1706 /* "info editing +" should print from the stored position. */
1709 /* "info editing <exp>" should print around command number <exp>. */
1710 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1712 /* "show commands" means print the last Hist_print commands. */
1715 num = history_length - Hist_print;
1721 /* If there are at least Hist_print commands, we want to display the last
1722 Hist_print rather than, say, the last 6. */
1723 if (history_length - num < Hist_print)
1725 num = history_length - Hist_print;
1731 offset < num + Hist_print && offset < history_length;
1734 printf_filtered ("%5d %s\n", history_base + offset,
1735 (history_get (history_base + offset))->line);
1738 /* The next command we want to display is the next one that we haven't
1742 /* If the user repeats this command with return, it should do what
1743 "show commands +" does. This is unnecessary if arg is null,
1744 because "show commands +" is not useful after "show commands". */
1745 if (from_tty && args)
1746 set_repeat_arguments ("+");
1749 /* Update the size of our command history file to HISTORY_SIZE.
1751 A HISTORY_SIZE of -1 stands for unlimited. */
1754 set_readline_history_size (int history_size)
1756 gdb_assert (history_size >= -1);
1758 if (history_size == -1)
1759 unstifle_history ();
1761 stifle_history (history_size);
1764 /* Called by do_setshow_command. */
1766 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1768 set_readline_history_size (history_size_setshow_var);
1772 set_history (const char *args, int from_tty)
1774 printf_unfiltered (_("\"set history\" must be followed "
1775 "by the name of a history subcommand.\n"));
1776 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1780 show_history (const char *args, int from_tty)
1782 cmd_show_list (showhistlist, from_tty, "");
1785 int info_verbose = 0; /* Default verbose msgs off. */
1787 /* Called by do_setshow_command. An elaborate joke. */
1789 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1791 const char *cmdname = "verbose";
1792 struct cmd_list_element *showcmd;
1794 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1795 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1799 c->doc = "Set verbose printing of informational messages.";
1800 showcmd->doc = "Show verbose printing of informational messages.";
1804 c->doc = "Set verbosity.";
1805 showcmd->doc = "Show verbosity.";
1809 /* Init the history buffer. Note that we are called after the init file(s)
1810 have been read so that the user can change the history file via his
1811 .gdbinit file (for instance). The GDBHISTFILE environment variable
1812 overrides all of this. */
1819 tmpenv = getenv ("GDBHISTSIZE");
1826 tmpenv = skip_spaces (tmpenv);
1828 var = strtol (tmpenv, &endptr, 10);
1829 saved_errno = errno;
1830 endptr = skip_spaces (endptr);
1832 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1833 empty string, a negative number or a huge positive number (larger than
1834 INT_MAX) then set the history size to unlimited. Otherwise set our
1835 history size to the number we have read. This behavior is consistent
1836 with how bash handles HISTSIZE. */
1837 if (*endptr != '\0')
1839 else if (*tmpenv == '\0'
1842 /* On targets where INT_MAX == LONG_MAX, we have to look at
1843 errno after calling strtol to distinguish between a value that
1844 is exactly INT_MAX and an overflowing value that was clamped
1846 || (var == INT_MAX && saved_errno == ERANGE))
1847 history_size_setshow_var = -1;
1849 history_size_setshow_var = var;
1852 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1854 if (history_size_setshow_var == -2)
1855 history_size_setshow_var = 256;
1857 set_readline_history_size (history_size_setshow_var);
1859 tmpenv = getenv ("GDBHISTFILE");
1861 history_filename = xstrdup (tmpenv);
1862 else if (!history_filename)
1864 /* We include the current directory so that if the user changes
1865 directories the file written will be the same as the one
1868 /* No leading dots in file names are allowed on MSDOS. */
1869 history_filename = concat (current_directory, "/_gdb_history",
1872 history_filename = concat (current_directory, "/.gdb_history",
1876 read_history (history_filename);
1880 show_prompt (struct ui_file *file, int from_tty,
1881 struct cmd_list_element *c, const char *value)
1883 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1886 /* "set editing" command. */
1889 set_editing (char *args, int from_tty, struct cmd_list_element *c)
1891 change_line_handler (set_editing_cmd_var);
1892 /* Update the control variable so that MI's =cmd-param-changed event
1893 shows the correct value. */
1894 set_editing_cmd_var = current_ui->command_editing;
1898 show_editing (struct ui_file *file, int from_tty,
1899 struct cmd_list_element *c, const char *value)
1901 fprintf_filtered (file, _("Editing of command lines as "
1902 "they are typed is %s.\n"),
1903 current_ui->command_editing ? _("on") : _("off"));
1907 show_annotation_level (struct ui_file *file, int from_tty,
1908 struct cmd_list_element *c, const char *value)
1910 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1914 show_exec_done_display_p (struct ui_file *file, int from_tty,
1915 struct cmd_list_element *c, const char *value)
1917 fprintf_filtered (file, _("Notification of completion for "
1918 "asynchronous execution commands is %s.\n"),
1922 /* New values of the "data-directory" parameter are staged here. */
1923 static char *staged_gdb_datadir;
1925 /* "set" command for the gdb_datadir configuration variable. */
1928 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1930 set_gdb_data_directory (staged_gdb_datadir);
1931 observer_notify_gdb_datadir_changed ();
1934 /* "show" command for the gdb_datadir configuration variable. */
1937 show_gdb_datadir (struct ui_file *file, int from_tty,
1938 struct cmd_list_element *c, const char *value)
1940 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1945 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
1947 /* We include the current directory so that if the user changes
1948 directories the file written will be the same as the one
1950 if (!IS_ABSOLUTE_PATH (history_filename))
1951 history_filename = reconcat (history_filename, current_directory, "/",
1952 history_filename, (char *) NULL);
1958 struct cmd_list_element *c;
1960 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1961 the DEFAULT_PROMPT is. */
1962 set_prompt (DEFAULT_PROMPT);
1964 /* Set the important stuff up for command editing. */
1965 command_editing_p = 1;
1966 history_expansion_p = 0;
1967 write_history_p = 0;
1969 /* Setup important stuff for command line editing. */
1970 rl_completion_word_break_hook = gdb_completion_word_break_characters;
1971 rl_attempted_completion_function = gdb_rl_attempted_completion_function;
1972 set_rl_completer_word_break_characters (default_word_break_characters ());
1973 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
1974 rl_completion_display_matches_hook = cli_display_match_list;
1975 rl_readline_name = "gdb";
1976 rl_terminal_name = getenv ("TERM");
1978 /* The name for this defun comes from Bash, where it originated.
1979 15 is Control-o, the same binding this function has in Bash. */
1980 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
1982 add_setshow_string_cmd ("prompt", class_support,
1984 _("Set gdb's prompt"),
1985 _("Show gdb's prompt"),
1988 &setlist, &showlist);
1990 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
1991 Don't repeat this command.\nPrimarily \
1992 used inside of user-defined commands that should not be repeated when\n\
1995 add_setshow_boolean_cmd ("editing", class_support,
1996 &set_editing_cmd_var, _("\
1997 Set editing of command lines as they are typed."), _("\
1998 Show editing of command lines as they are typed."), _("\
1999 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2000 Without an argument, command line editing is enabled. To edit, use\n\
2001 EMACS-like or VI-like commands like control-P or ESC."),
2004 &setlist, &showlist);
2006 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2007 Set saving of the history record on exit."), _("\
2008 Show saving of the history record on exit."), _("\
2009 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2010 Without an argument, saving is enabled."),
2012 show_write_history_p,
2013 &sethistlist, &showhistlist);
2015 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2016 &history_size_setshow_var, _("\
2017 Set the size of the command history,"), _("\
2018 Show the size of the command history,"), _("\
2019 ie. the number of previous commands to keep a record of.\n\
2020 If set to \"unlimited\", the number of commands kept in the history\n\
2021 list is unlimited. This defaults to the value of the environment\n\
2022 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2023 set_history_size_command,
2025 &sethistlist, &showhistlist);
2027 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2028 &history_remove_duplicates, _("\
2029 Set how far back in history to look for and remove duplicate entries."), _("\
2030 Show how far back in history to look for and remove duplicate entries."), _("\
2031 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2032 and remove the first history entry that is a duplicate of the most recent\n\
2033 entry, each time a new history entry is added.\n\
2034 If set to \"unlimited\", this lookbehind is unbounded.\n\
2035 Only history entries added during this session are considered for removal.\n\
2036 If set to 0, removal of duplicate history entries is disabled.\n\
2037 By default this option is set to 0."),
2039 show_history_remove_duplicates,
2040 &sethistlist, &showhistlist);
2042 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2043 Set the filename in which to record the command history"), _("\
2044 Show the filename in which to record the command history"), _("\
2045 (the list of previous commands of which a record is kept)."),
2046 set_history_filename,
2047 show_history_filename,
2048 &sethistlist, &showhistlist);
2050 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2051 Set whether to confirm potentially dangerous operations."), _("\
2052 Show whether to confirm potentially dangerous operations."), NULL,
2055 &setlist, &showlist);
2057 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2058 Set annotation_level."), _("\
2059 Show annotation_level."), _("\
2060 0 == normal; 1 == fullname (for use when running under emacs)\n\
2061 2 == output annotated suitably for use by programs that control GDB."),
2063 show_annotation_level,
2064 &setlist, &showlist);
2066 add_setshow_boolean_cmd ("exec-done-display", class_support,
2067 &exec_done_display_p, _("\
2068 Set notification of completion for asynchronous execution commands."), _("\
2069 Show notification of completion for asynchronous execution commands."), _("\
2070 Use \"on\" to enable the notification, and \"off\" to disable it."),
2072 show_exec_done_display_p,
2073 &setlist, &showlist);
2075 add_setshow_filename_cmd ("data-directory", class_maintenance,
2076 &staged_gdb_datadir, _("Set GDB's data directory."),
2077 _("Show GDB's data directory."),
2079 When set, GDB uses the specified path to search for data files."),
2080 set_gdb_datadir, show_gdb_datadir,
2084 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2085 &interactive_mode, _("\
2086 Set whether GDB's standard input is a terminal."), _("\
2087 Show whether GDB's standard input is a terminal."), _("\
2088 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2089 means that GDB should wait for the user to answer queries associated to\n\
2090 commands entered at the command prompt. If off, GDB assumes that standard\n\
2091 input is not a terminal, and uses the default answer to all queries.\n\
2092 If auto (the default), determine which mode to use based on the standard\n\
2095 show_interactive_mode,
2096 &setlist, &showlist);
2098 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2099 Create a new UI. It takes two arguments:\n\
2100 The first argument is the name of the interpreter to run.\n\
2101 The second argument is the terminal the UI runs on.\n"), &cmdlist);
2102 set_cmd_completer (c, interpreter_completer);
2106 gdb_init (char *argv0)
2108 if (pre_init_ui_hook)
2109 pre_init_ui_hook ();
2111 /* Run the init function of each source file. */
2114 /* Make sure we return to the original directory upon exit, come
2115 what may, since the OS doesn't do that for us. */
2116 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2119 init_cmd_lists (); /* This needs to be done first. */
2120 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2121 initialize_utils (); /* Make errors and warnings possible. */
2125 /* Here is where we call all the _initialize_foo routines. */
2126 initialize_all_files ();
2128 /* This creates the current_program_space. Do this after all the
2129 _initialize_foo routines have had a chance to install their
2130 per-sspace data keys. Also do this before
2131 initialize_current_architecture is called, because it accesses
2132 exec_bfd of the current program space. */
2133 initialize_progspace ();
2134 initialize_inferiors ();
2135 initialize_current_architecture ();
2137 init_main (); /* But that omits this file! Do it now. */
2139 initialize_stdin_serial ();
2141 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2143 set_initial_gdb_ttystate ();
2145 async_init_signals ();
2147 /* We need a default language for parsing expressions, so simple
2148 things like "set width 0" won't fail if no language is explicitly
2149 set in a config file or implicitly set by reading an executable
2151 set_language (language_c);
2152 expected_language = current_language; /* Don't warn about the change. */
2154 /* Python initialization, for example, can require various commands to be
2155 installed. For example "info pretty-printer" needs the "info"
2156 prefix to be installed. Keep things simple and just do final
2157 script initialization here. */
2158 finish_ext_lang_initialization ();