1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "cli/cli-cmds.h"
23 #include "cli/cli-script.h"
24 #include "cli/cli-setshow.h"
25 #include "cli/cli-decode.h"
31 #include "target-dcache.h"
32 #include "breakpoint.h"
34 #include "expression.h"
38 #include "common/job-control.h"
40 #include "completer.h"
42 #include "common/version.h"
45 #include "event-loop.h"
46 #include "gdbthread.h"
47 #include "extension.h"
49 #include "observable.h"
51 #include "filenames.h"
53 #include "common/buffer.h"
54 #include "gdb_select.h"
55 #include "common/scope-exit.h"
57 /* readline include files. */
58 #include "readline/readline.h"
59 #include "readline/history.h"
61 /* readline defines this. */
64 #include <sys/types.h>
66 #include "event-top.h"
71 #include "tracepoint.h"
82 extern void initialize_all_files (void);
84 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
85 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
86 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
88 /* Default command line prompt. This is overriden in some configs. */
90 #ifndef DEFAULT_PROMPT
91 #define DEFAULT_PROMPT "(gdb) "
94 /* Generate a function that exports a pointer to a field of the
97 #define gen_ret_current_ui_field_ptr(type, name) \
99 current_ui_## name ## _ptr (void) \
101 return ¤t_ui->m_ ## name; \
104 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdout)
105 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdin)
106 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stderr)
107 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdlog)
108 gen_ret_current_ui_field_ptr (struct ui_out *, current_uiout)
110 /* Initialization file name for gdb. This is host-dependent. */
112 const char gdbinit[] = GDBINIT;
114 int inhibit_gdbinit = 0;
116 extern char lang_frame_mismatch_warn[]; /* language.c */
118 /* Flag for whether we want to confirm potentially dangerous
119 operations. Default is yes. */
124 show_confirm (struct ui_file *file, int from_tty,
125 struct cmd_list_element *c, const char *value)
127 fprintf_filtered (file, _("Whether to confirm potentially "
128 "dangerous operations is %s.\n"),
132 /* Current working directory. */
134 char *current_directory;
136 /* The last command line executed on the console. Used for command
137 repetitions when the user enters an empty line. */
139 static char *saved_command_line;
141 /* If not NULL, the arguments that should be passed if
142 saved_command_line is repeated. */
144 static const char *repeat_arguments;
146 /* The previous last command line executed on the console. Used for command
147 repetitions when a command wants to relaunch the previously launched
148 command. We need this as when a command is running, saved_command_line
149 already contains the line of the currently executing command. */
151 char *previous_saved_command_line;
153 /* If not NULL, the arguments that should be passed if the
154 previous_saved_command_line is repeated. */
156 static const char *previous_repeat_arguments;
158 /* Nonzero if the current command is modified by "server ". This
159 affects things like recording into the command history, commands
160 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
161 whatever) can issue its own commands and also send along commands
162 from the user, and have the user not notice that the user interface
163 is issuing commands too. */
166 /* Timeout limit for response from target. */
168 /* The default value has been changed many times over the years. It
169 was originally 5 seconds. But that was thought to be a long time
170 to sit and wait, so it was changed to 2 seconds. That was thought
171 to be plenty unless the connection was going through some terminal
172 server or multiplexer or other form of hairy serial connection.
174 In mid-1996, remote_timeout was moved from remote.c to top.c and
175 it began being used in other remote-* targets. It appears that the
176 default was changed to 20 seconds at that time, perhaps because the
177 Renesas E7000 ICE didn't always respond in a timely manner.
179 But if 5 seconds is a long time to sit and wait for retransmissions,
180 20 seconds is far worse. This demonstrates the difficulty of using
181 a single variable for all protocol timeouts.
183 As remote.c is used much more than remote-e7000.c, it was changed
184 back to 2 seconds in 1999. */
186 int remote_timeout = 2;
188 /* Non-zero tells remote* modules to output debugging info. */
190 int remote_debug = 0;
192 /* Sbrk location on entry to main. Used for statistics only. */
193 #ifdef HAVE_USEFUL_SBRK
197 /* Hooks for alternate command interfaces. */
199 /* This hook is called from within gdb's many mini-event loops which
200 could steal control from a real user interface's event loop. It
201 returns non-zero if the user is requesting a detach, zero
204 int (*deprecated_ui_loop_hook) (int);
207 /* Called from print_frame_info to list the line we stopped in. */
209 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
213 /* Replaces most of query. */
215 int (*deprecated_query_hook) (const char *, va_list);
217 /* Replaces most of warning. */
219 void (*deprecated_warning_hook) (const char *, va_list);
221 /* These three functions support getting lines of text from the user.
222 They are used in sequence. First deprecated_readline_begin_hook is
223 called with a text string that might be (for example) a message for
224 the user to type in a sequence of commands to be executed at a
225 breakpoint. If this function calls back to a GUI, it might take
226 this opportunity to pop up a text interaction window with this
227 message. Next, deprecated_readline_hook is called with a prompt
228 that is emitted prior to collecting the user input. It can be
229 called multiple times. Finally, deprecated_readline_end_hook is
230 called to notify the GUI that we are done with the interaction
231 window and it can close it. */
233 void (*deprecated_readline_begin_hook) (const char *, ...);
234 char *(*deprecated_readline_hook) (const char *);
235 void (*deprecated_readline_end_hook) (void);
237 /* Called as appropriate to notify the interface that we have attached
238 to or detached from an already running process. */
240 void (*deprecated_attach_hook) (void);
241 void (*deprecated_detach_hook) (void);
243 /* Called when going to wait for the target. Usually allows the GUI
244 to run while waiting for target events. */
246 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
247 struct target_waitstatus *status,
250 /* Used by UI as a wrapper around command execution. May do various
251 things like enabling/disabling buttons, etc... */
253 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
254 const char *cmd, int from_tty);
256 /* Called when the current thread changes. Argument is thread id. */
258 void (*deprecated_context_hook) (int id);
260 /* The highest UI number ever assigned. */
261 static int highest_ui_num;
265 ui::ui (FILE *instream_, FILE *outstream_, FILE *errstream_)
267 num (++highest_ui_num),
268 call_readline (nullptr),
269 input_handler (nullptr),
271 interp_info (nullptr),
273 secondary_prompt_depth (0),
274 stdin_stream (instream_),
275 instream (instream_),
276 outstream (outstream_),
277 errstream (errstream_),
278 input_fd (fileno (instream)),
279 input_interactive_p (ISATTY (instream)),
280 prompt_state (PROMPT_NEEDED),
281 m_gdb_stdout (new stdio_file (outstream)),
282 m_gdb_stdin (new stdio_file (instream)),
283 m_gdb_stderr (new stderr_file (errstream)),
284 m_gdb_stdlog (m_gdb_stderr),
285 m_current_uiout (nullptr)
287 buffer_init (&line_buffer);
295 for (last = ui_list; last->next != NULL; last = last->next)
303 struct ui *ui, *uiprev;
307 for (ui = ui_list; ui != NULL; uiprev = ui, ui = ui->next)
311 gdb_assert (ui != NULL);
323 /* Open file named NAME for read/write, making sure not to make it the
324 controlling terminal. */
327 open_terminal_stream (const char *name)
331 fd = gdb_open_cloexec (name, O_RDWR | O_NOCTTY, 0);
333 perror_with_name (_("opening terminal failed"));
335 return gdb_file_up (fdopen (fd, "w+"));
338 /* Implementation of the "new-ui" command. */
341 new_ui_command (const char *args, int from_tty)
343 gdb_file_up stream[3];
346 const char *interpreter_name;
347 const char *tty_name;
351 gdb_argv argv (args);
352 argc = argv.count ();
355 error (_("Usage: new-ui INTERPRETER TTY"));
357 interpreter_name = argv[0];
361 scoped_restore save_ui = make_scoped_restore (¤t_ui);
363 /* Open specified terminal, once for each of
364 stdin/stdout/stderr. */
365 for (i = 0; i < 3; i++)
366 stream[i] = open_terminal_stream (tty_name);
368 std::unique_ptr<ui> ui
369 (new struct ui (stream[0].get (), stream[1].get (), stream[2].get ()));
373 current_ui = ui.get ();
375 set_top_level_interpreter (interpreter_name);
377 interp_pre_command_loop (top_level_interpreter ());
379 /* Make sure the files are not closed. */
380 stream[0].release ();
381 stream[1].release ();
382 stream[2].release ();
387 printf_unfiltered ("New UI allocated\n");
390 /* Handler for SIGHUP. */
393 /* NOTE 1999-04-29: This function 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. */
399 /* Stop asking user for confirmation --- we're exiting. This
400 prevents asking the user dumb questions. */
402 quit_command ((char *) 0, 0);
404 #endif /* defined SIGHUP */
406 /* Line number we are currently in, in a file which is being sourced. */
407 /* NOTE 1999-04-29: This variable will be static again, once we modify
408 gdb to use the event loop as the default command loop and we merge
409 event-top.c into this file, top.c. */
410 /* static */ int source_line_number;
412 /* Name of the file we are sourcing. */
413 /* NOTE 1999-04-29: This variable will be static again, once we modify
414 gdb to use the event loop as the default command loop and we merge
415 event-top.c into this file, top.c. */
416 /* static */ std::string source_file_name;
418 /* Read commands from STREAM. */
420 read_command_file (FILE *stream)
422 struct ui *ui = current_ui;
424 scoped_restore save_instream
425 = make_scoped_restore (&ui->instream, stream);
427 /* Read commands from `instream' and execute them until end of file
428 or error reading instream. */
430 while (ui->instream != NULL && !feof (ui->instream))
434 /* Get a command-line. This calls the readline package. */
435 command = command_line_input (NULL, NULL);
438 command_handler (command);
442 void (*pre_init_ui_hook) (void);
446 do_chdir_cleanup (void *old_dir)
448 chdir ((const char *) old_dir);
454 prepare_execute_command ()
456 /* With multiple threads running while the one we're examining is
457 stopped, the dcache can get stale without us being able to detect
458 it. For the duration of the command, though, use the dcache to
459 help things like backtrace. */
461 target_dcache_invalidate ();
463 return scoped_value_mark ();
466 /* Tell the user if the language has changed (except first time) after
467 executing a command. */
470 check_frame_language_change (void)
472 static int warned = 0;
473 struct frame_info *frame;
475 /* First make sure that a new frame has been selected, in case the
476 command or the hooks changed the program state. */
477 frame = deprecated_safe_get_selected_frame ();
478 if (current_language != expected_language)
480 if (language_mode == language_mode_auto && info_verbose)
482 language_info (1); /* Print what changed. */
487 /* Warn the user if the working language does not match the language
488 of the current frame. Only warn the user if we are actually
489 running the program, i.e. there is a stack. */
490 /* FIXME: This should be cacheing the frame and only running when
491 the frame changes. */
493 if (has_stack_frames ())
497 flang = get_frame_language (frame);
499 && flang != language_unknown
500 && flang != current_language->la_language)
502 printf_filtered ("%s\n", lang_frame_mismatch_warn);
511 wait_sync_command_done (void)
513 /* Processing events may change the current UI. */
514 scoped_restore save_ui = make_scoped_restore (¤t_ui);
515 struct ui *ui = current_ui;
517 while (gdb_do_one_event () >= 0)
518 if (ui->prompt_state != PROMPT_BLOCKED)
525 maybe_wait_sync_command_done (int was_sync)
527 /* If the interpreter is in sync mode (we're running a user
528 command's list, running command hooks or similars), and we
529 just ran a synchronous command that started the target, wait
530 for that command to end. */
531 if (!current_ui->async
533 && current_ui->prompt_state == PROMPT_BLOCKED)
534 wait_sync_command_done ();
540 set_repeat_arguments (const char *args)
542 repeat_arguments = args;
545 /* Execute the line P as a command, in the current user context.
546 Pass FROM_TTY as second argument to the defining function. */
549 execute_command (const char *p, int from_tty)
551 struct cmd_list_element *c;
553 const char *cmd_start = p;
555 auto cleanup_if_error = make_scope_exit (bpstat_clear_actions);
556 scoped_value_mark cleanup = prepare_execute_command ();
558 /* This can happen when command_line_input hits end of file. */
561 cleanup_if_error.release ();
565 target_log_command (p);
567 while (*p == ' ' || *p == '\t')
573 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
577 /* If trace-commands is set then this will print this command. */
578 print_command_trace ("%s", p);
580 c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
583 scoped_restore save_repeat_args
584 = make_scoped_restore (&repeat_arguments, nullptr);
585 const char *args_pointer = p;
587 /* Pass null arg rather than an empty one. */
590 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
591 while the is_complete_command(cfunc) test is just plain
592 bogus. They should both be replaced by a test of the form
593 c->strip_trailing_white_space_p. */
594 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
595 can't be replaced with func. This is because it is the
596 cfunc, and not the func, that has the value that the
597 is_complete_command hack is testing for. */
598 /* Clear off trailing whitespace, except for set and complete
600 std::string without_whitespace;
602 && c->type != set_cmd
603 && !is_complete_command (c))
605 const char *old_end = arg + strlen (arg) - 1;
607 while (p >= arg && (*p == ' ' || *p == '\t'))
611 without_whitespace = std::string (arg, p + 1);
612 arg = without_whitespace.c_str ();
616 /* If this command has been pre-hooked, run the hook first. */
617 execute_cmd_pre_hook (c);
619 if (c->deprecated_warn_user)
620 deprecated_cmd_warning (line);
622 /* c->user_commands would be NULL in the case of a python command. */
623 if (c->theclass == class_user && c->user_commands)
624 execute_user_command (c, arg);
625 else if (c->type == set_cmd)
626 do_set_command (arg, from_tty, c);
627 else if (c->type == show_cmd)
628 do_show_command (arg, from_tty, c);
629 else if (!cmd_func_p (c))
630 error (_("That is not a command, just a help topic."));
631 else if (deprecated_call_command_hook)
632 deprecated_call_command_hook (c, arg, from_tty);
634 cmd_func (c, arg, from_tty);
636 maybe_wait_sync_command_done (was_sync);
638 /* If this command has been post-hooked, run the hook last. */
639 execute_cmd_post_hook (c);
641 if (repeat_arguments != NULL && cmd_start == saved_command_line)
643 gdb_assert (strlen (args_pointer) >= strlen (repeat_arguments));
644 strcpy (saved_command_line + (args_pointer - cmd_start),
649 /* Only perform the frame-language-change check if the command
650 we just finished executing did not resume the inferior's execution.
651 If it did resume the inferior, we will do that check after
652 the inferior stopped. */
653 if (has_stack_frames () && inferior_thread ()->state != THREAD_RUNNING)
654 check_frame_language_change ();
656 cleanup_if_error.release ();
659 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
660 do not display it to the screen. BATCH_FLAG will be
661 temporarily set to true. */
664 execute_command_to_ui_file (struct ui_file *file, const char *p, int from_tty)
666 /* GDB_STDOUT should be better already restored during these
667 restoration callbacks. */
668 set_batch_flag_and_restore_page_info save_page_info;
670 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
673 current_uiout->redirect (file);
674 ui_out_redirect_pop redirect_popper (current_uiout);
676 scoped_restore save_stdout
677 = make_scoped_restore (&gdb_stdout, file);
678 scoped_restore save_stderr
679 = make_scoped_restore (&gdb_stderr, file);
680 scoped_restore save_stdlog
681 = make_scoped_restore (&gdb_stdlog, file);
682 scoped_restore save_stdtarg
683 = make_scoped_restore (&gdb_stdtarg, file);
684 scoped_restore save_stdtargerr
685 = make_scoped_restore (&gdb_stdtargerr, file);
687 execute_command (p, from_tty);
691 /* Run execute_command for P and FROM_TTY. Capture its output into the
692 returned string, do not display it to the screen. BATCH_FLAG will be
693 temporarily set to true. */
696 execute_command_to_string (const char *p, int from_tty,
699 string_file str_file (term_out);
701 execute_command_to_ui_file (&str_file, p, from_tty);
702 return std::move (str_file.string ());
706 /* When nonzero, cause dont_repeat to do nothing. This should only be
707 set via prevent_dont_repeat. */
709 static int suppress_dont_repeat = 0;
716 struct ui *ui = current_ui;
718 if (suppress_dont_repeat || server_command)
721 /* If we aren't reading from standard input, we are saving the last
722 thing read from stdin in line and don't want to delete it. Null
723 lines won't repeat here in any case. */
724 if (ui->instream == ui->stdin_stream)
726 *saved_command_line = 0;
727 repeat_arguments = NULL;
736 /* Do not repeat this command, as this command is a repeating command. */
739 /* We cannot free saved_command_line, as this line is being executed,
740 so swap it with previous_saved_command_line. */
741 std::swap (previous_saved_command_line, saved_command_line);
742 std::swap (previous_repeat_arguments, repeat_arguments);
744 const char *prev = skip_spaces (get_saved_command_line ());
746 error (_("No previous command to relaunch"));
752 scoped_restore_tmpl<int>
753 prevent_dont_repeat (void)
755 return make_scoped_restore (&suppress_dont_repeat, 1);
761 get_saved_command_line ()
763 return saved_command_line;
769 save_command_line (const char *cmd)
771 xfree (previous_saved_command_line);
772 previous_saved_command_line = saved_command_line;
773 previous_repeat_arguments = repeat_arguments;
774 saved_command_line = xstrdup (cmd);
775 repeat_arguments = NULL;
779 /* Read a line from the stream "instream" without command line editing.
781 It prints PROMPT once at the start.
782 Action is compatible with "readline", e.g. space for the result is
783 malloc'd and should be freed by the caller.
785 A NULL return means end of file. */
788 gdb_readline_no_editing (const char *prompt)
790 struct buffer line_buffer;
791 struct ui *ui = current_ui;
792 /* Read from stdin if we are executing a user defined command. This
793 is the right thing for prompt_for_continue, at least. */
794 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
795 int fd = fileno (stream);
797 buffer_init (&line_buffer);
801 /* Don't use a _filtered function here. It causes the assumed
802 character position to be off, since the newline we read from
803 the user is not accounted for. */
804 fputs_unfiltered (prompt, gdb_stdout);
805 gdb_flush (gdb_stdout);
815 /* Wait until at least one byte of data is available. Control-C
816 can interrupt interruptible_select, but not fgetc. */
818 FD_SET (fd, &readfds);
819 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
823 /* If this was ctrl-c, the QUIT above handles it. */
826 perror_with_name (("select"));
833 if (line_buffer.used_size > 0)
834 /* The last line does not end with a newline. Return it, and
835 if we are called again fgetc will still return EOF and
836 we'll return NULL then. */
838 xfree (buffer_finish (&line_buffer));
844 if (line_buffer.used_size > 0
845 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
846 line_buffer.used_size--;
850 buffer_grow_char (&line_buffer, c);
853 buffer_grow_char (&line_buffer, '\0');
854 return buffer_finish (&line_buffer);
857 /* Variables which control command line editing and history
858 substitution. These variables are given default values at the end
860 static int command_editing_p;
862 /* NOTE 1999-04-29: This variable will be static again, once we modify
863 gdb to use the event loop as the default command loop and we merge
864 event-top.c into this file, top.c. */
866 /* static */ int history_expansion_p;
868 static int write_history_p;
870 show_write_history_p (struct ui_file *file, int from_tty,
871 struct cmd_list_element *c, const char *value)
873 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
877 /* The variable associated with the "set/show history size"
878 command. The value -1 means unlimited, and -2 means undefined. */
879 static int history_size_setshow_var = -2;
882 show_history_size (struct ui_file *file, int from_tty,
883 struct cmd_list_element *c, const char *value)
885 fprintf_filtered (file, _("The size of the command history is %s.\n"),
889 /* Variable associated with the "history remove-duplicates" option.
890 The value -1 means unlimited. */
891 static int history_remove_duplicates = 0;
894 show_history_remove_duplicates (struct ui_file *file, int from_tty,
895 struct cmd_list_element *c, const char *value)
897 fprintf_filtered (file,
898 _("The number of history entries to look back at for "
899 "duplicates is %s.\n"),
903 static char *history_filename;
905 show_history_filename (struct ui_file *file, int from_tty,
906 struct cmd_list_element *c, const char *value)
908 fprintf_filtered (file, _("The filename in which to record "
909 "the command history is \"%s\".\n"),
913 /* This is like readline(), but it has some gdb-specific behavior.
914 gdb may want readline in both the synchronous and async modes during
915 a single gdb invocation. At the ordinary top-level prompt we might
916 be using the async readline. That means we can't use
917 rl_pre_input_hook, since it doesn't work properly in async mode.
918 However, for a secondary prompt (" >", such as occurs during a
919 `define'), gdb wants a synchronous response.
921 We used to call readline() directly, running it in synchronous
922 mode. But mixing modes this way is not supported, and as of
923 readline 5.x it no longer works; the arrow keys come unbound during
924 the synchronous call. So we make a nested call into the event
925 loop. That's what gdb_readline_wrapper is for. */
927 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
928 rely on gdb_readline_wrapper_result, which might still be NULL if
929 the user types Control-D for EOF. */
930 static int gdb_readline_wrapper_done;
932 /* The result of the current call to gdb_readline_wrapper, once a newline
934 static char *gdb_readline_wrapper_result;
936 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
937 to be called after the newline is processed (which will redisplay
938 the prompt). But in gdb_readline_wrapper we will not get a new
939 prompt until the next call, or until we return to the event loop.
940 So we disable this hook around the newline and restore it before we
942 static void (*saved_after_char_processing_hook) (void);
948 gdb_in_secondary_prompt_p (struct ui *ui)
950 return ui->secondary_prompt_depth > 0;
954 /* This function is called when readline has seen a complete line of
958 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr<char> &&line)
960 gdb_assert (!gdb_readline_wrapper_done);
961 gdb_readline_wrapper_result = line.release ();
962 gdb_readline_wrapper_done = 1;
964 /* Prevent operate-and-get-next from acting too early. */
965 saved_after_char_processing_hook = after_char_processing_hook;
966 after_char_processing_hook = NULL;
968 /* Prevent parts of the prompt from being redisplayed if annotations
969 are enabled, and readline's state getting out of sync. We'll
970 reinstall the callback handler, which puts the terminal in raw
971 mode (or in readline lingo, in prepped state), when we're next
972 ready to process user input, either in display_gdb_prompt, or if
973 we're handling an asynchronous target event and running in the
974 background, just before returning to the event loop to process
975 further input (or more target events). */
976 if (current_ui->command_editing)
977 gdb_rl_callback_handler_remove ();
980 class gdb_readline_wrapper_cleanup
983 gdb_readline_wrapper_cleanup ()
984 : m_handler_orig (current_ui->input_handler),
985 m_already_prompted_orig (current_ui->command_editing
986 ? rl_already_prompted : 0),
987 m_target_is_async_orig (target_is_async_p ()),
988 m_save_ui (¤t_ui)
990 current_ui->input_handler = gdb_readline_wrapper_line;
991 current_ui->secondary_prompt_depth++;
993 if (m_target_is_async_orig)
997 ~gdb_readline_wrapper_cleanup ()
999 struct ui *ui = current_ui;
1001 if (ui->command_editing)
1002 rl_already_prompted = m_already_prompted_orig;
1004 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
1005 ui->input_handler = m_handler_orig;
1007 /* Don't restore our input handler in readline yet. That would make
1008 readline prep the terminal (putting it in raw mode), while the
1009 line we just read may trigger execution of a command that expects
1010 the terminal in the default cooked/canonical mode, such as e.g.,
1011 running Python's interactive online help utility. See
1012 gdb_readline_wrapper_line for when we'll reinstall it. */
1014 gdb_readline_wrapper_result = NULL;
1015 gdb_readline_wrapper_done = 0;
1016 ui->secondary_prompt_depth--;
1017 gdb_assert (ui->secondary_prompt_depth >= 0);
1019 after_char_processing_hook = saved_after_char_processing_hook;
1020 saved_after_char_processing_hook = NULL;
1022 if (m_target_is_async_orig)
1026 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup);
1030 void (*m_handler_orig) (gdb::unique_xmalloc_ptr<char> &&);
1031 int m_already_prompted_orig;
1033 /* Whether the target was async. */
1034 int m_target_is_async_orig;
1036 /* Processing events may change the current UI. */
1037 scoped_restore_tmpl<struct ui *> m_save_ui;
1041 gdb_readline_wrapper (const char *prompt)
1043 struct ui *ui = current_ui;
1045 gdb_readline_wrapper_cleanup cleanup;
1047 /* Display our prompt and prevent double prompt display. Don't pass
1048 down a NULL prompt, since that has special meaning for
1049 display_gdb_prompt -- it indicates a request to print the primary
1050 prompt, while we want a secondary prompt here. */
1051 display_gdb_prompt (prompt != NULL ? prompt : "");
1052 if (ui->command_editing)
1053 rl_already_prompted = 1;
1055 if (after_char_processing_hook)
1056 (*after_char_processing_hook) ();
1057 gdb_assert (after_char_processing_hook == NULL);
1059 while (gdb_do_one_event () >= 0)
1060 if (gdb_readline_wrapper_done)
1063 return gdb_readline_wrapper_result;
1067 /* The current saved history number from operate-and-get-next.
1068 This is -1 if not valid. */
1069 static int operate_saved_history = -1;
1071 /* This is put on the appropriate hook and helps operate-and-get-next
1074 gdb_rl_operate_and_get_next_completion (void)
1076 int delta = where_history () - operate_saved_history;
1078 /* The `key' argument to rl_get_previous_history is ignored. */
1079 rl_get_previous_history (delta, 0);
1080 operate_saved_history = -1;
1082 /* readline doesn't automatically update the display for us. */
1085 after_char_processing_hook = NULL;
1086 rl_pre_input_hook = NULL;
1089 /* This is a gdb-local readline command handler. It accepts the
1090 current command line (like RET does) and, if this command was taken
1091 from the history, arranges for the next command in the history to
1092 appear on the command line when the prompt returns.
1093 We ignore the arguments. */
1095 gdb_rl_operate_and_get_next (int count, int key)
1099 /* Use the async hook. */
1100 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1102 /* Find the current line, and find the next line to use. */
1103 where = where_history();
1105 if ((history_is_stifled () && (history_length >= history_max_entries))
1106 || (where >= history_length - 1))
1107 operate_saved_history = where;
1109 operate_saved_history = where + 1;
1111 return rl_newline (1, key);
1114 /* Number of user commands executed during this session. */
1116 static int command_count = 0;
1118 /* Add the user command COMMAND to the input history list. */
1121 gdb_add_history (const char *command)
1125 if (history_remove_duplicates != 0)
1128 int lookbehind_threshold;
1130 /* The lookbehind threshold for finding a duplicate history entry is
1131 bounded by command_count because we can't meaningfully delete
1132 history entries that are already stored in the history file since
1133 the history file is appended to. */
1134 if (history_remove_duplicates == -1
1135 || history_remove_duplicates > command_count)
1136 lookbehind_threshold = command_count;
1138 lookbehind_threshold = history_remove_duplicates;
1141 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1143 HIST_ENTRY *temp = previous_history ();
1148 if (strcmp (temp->line, command) == 0)
1150 HIST_ENTRY *prev = remove_history (where_history ());
1152 free_history_entry (prev);
1159 add_history (command);
1162 /* Safely append new history entries to the history file in a corruption-free
1163 way using an intermediate local history file. */
1166 gdb_safe_append_history (void)
1168 int ret, saved_errno;
1170 std::string local_history_filename
1171 = string_printf ("%s-gdb%ld~", history_filename, (long) getpid ());
1173 ret = rename (history_filename, local_history_filename.c_str ());
1174 saved_errno = errno;
1175 if (ret < 0 && saved_errno != ENOENT)
1177 warning (_("Could not rename %s to %s: %s"),
1178 history_filename, local_history_filename.c_str (),
1179 safe_strerror (saved_errno));
1185 /* If the rename failed with ENOENT then either the global history
1186 file never existed in the first place or another GDB process is
1187 currently appending to it (and has thus temporarily renamed it).
1188 Since we can't distinguish between these two cases, we have to
1189 conservatively assume the first case and therefore must write out
1190 (not append) our known history to our local history file and try
1191 to move it back anyway. Otherwise a global history file would
1192 never get created! */
1193 gdb_assert (saved_errno == ENOENT);
1194 write_history (local_history_filename.c_str ());
1198 append_history (command_count, local_history_filename.c_str ());
1199 if (history_is_stifled ())
1200 history_truncate_file (local_history_filename.c_str (),
1201 history_max_entries);
1204 ret = rename (local_history_filename.c_str (), history_filename);
1205 saved_errno = errno;
1206 if (ret < 0 && saved_errno != EEXIST)
1207 warning (_("Could not rename %s to %s: %s"),
1208 local_history_filename.c_str (), history_filename,
1209 safe_strerror (saved_errno));
1213 /* Read one line from the command input stream `instream' into a local
1214 static buffer. The buffer is made bigger as necessary. Returns
1215 the address of the start of the line.
1217 NULL is returned for end of file.
1219 This routine either uses fancy command line editing or simple input
1220 as the user has requested. */
1223 command_line_input (const char *prompt_arg, const char *annotation_suffix)
1225 static struct buffer cmd_line_buffer;
1226 static int cmd_line_buffer_initialized;
1227 struct ui *ui = current_ui;
1228 const char *prompt = prompt_arg;
1230 int from_tty = ui->instream == ui->stdin_stream;
1232 /* The annotation suffix must be non-NULL. */
1233 if (annotation_suffix == NULL)
1234 annotation_suffix = "";
1236 if (from_tty && annotation_level > 1)
1241 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1242 + strlen (annotation_suffix) + 40);
1244 local_prompt[0] = '\0';
1246 strcpy (local_prompt, prompt);
1247 strcat (local_prompt, "\n\032\032");
1248 strcat (local_prompt, annotation_suffix);
1249 strcat (local_prompt, "\n");
1251 prompt = local_prompt;
1254 if (!cmd_line_buffer_initialized)
1256 buffer_init (&cmd_line_buffer);
1257 cmd_line_buffer_initialized = 1;
1260 /* Starting a new command line. */
1261 cmd_line_buffer.used_size = 0;
1265 signal (SIGTSTP, handle_sigtstp);
1270 gdb::unique_xmalloc_ptr<char> rl;
1272 /* Make sure that all output has been output. Some machines may
1273 let you get away with leaving out some of the gdb_flush, but
1276 gdb_flush (gdb_stdout);
1277 gdb_flush (gdb_stderr);
1279 if (!source_file_name.empty ())
1280 ++source_line_number;
1282 if (from_tty && annotation_level > 1)
1284 puts_unfiltered ("\n\032\032pre-");
1285 puts_unfiltered (annotation_suffix);
1286 puts_unfiltered ("\n");
1289 /* Don't use fancy stuff if not talking to stdin. */
1290 if (deprecated_readline_hook
1292 && input_interactive_p (current_ui))
1294 rl.reset ((*deprecated_readline_hook) (prompt));
1296 else if (command_editing_p
1298 && input_interactive_p (current_ui))
1300 rl.reset (gdb_readline_wrapper (prompt));
1304 rl.reset (gdb_readline_no_editing (prompt));
1307 cmd = handle_line_of_input (&cmd_line_buffer, rl.get (),
1308 0, annotation_suffix);
1309 if (cmd == (char *) EOF)
1317 /* Got partial input. I.e., got a line that ends with a
1318 continuation character (backslash). Suppress printing the
1325 signal (SIGTSTP, SIG_DFL);
1333 print_gdb_version (struct ui_file *stream, bool interactive)
1335 /* From GNU coding standards, first line is meant to be easy for a
1336 program to parse, and is just canonical program name and version
1337 number, which starts after last space. */
1339 ui_file_style style;
1342 ui_file_style nstyle = { ui_file_style::MAGENTA, ui_file_style::NONE,
1343 ui_file_style::BOLD };
1346 fprintf_styled (stream, style, "GNU gdb %s%s\n", PKGVERSION, version);
1348 /* Second line is a copyright notice. */
1350 fprintf_filtered (stream,
1351 "Copyright (C) 2019 Free Software Foundation, Inc.\n");
1353 /* Following the copyright is a brief statement that the program is
1354 free software, that users are free to copy and change it on
1355 certain conditions, that it is covered by the GNU GPL, and that
1356 there is no warranty. */
1358 fprintf_filtered (stream, "\
1359 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1360 \nThis is free software: you are free to change and redistribute it.\n\
1361 There is NO WARRANTY, to the extent permitted by law.");
1366 fprintf_filtered (stream, ("\nType \"show copying\" and "
1367 "\"show warranty\" for details.\n"));
1369 /* After the required info we print the configuration information. */
1371 fprintf_filtered (stream, "This GDB was configured as \"");
1372 if (strcmp (host_name, target_name) != 0)
1374 fprintf_filtered (stream, "--host=%s --target=%s",
1375 host_name, target_name);
1379 fprintf_filtered (stream, "%s", host_name);
1381 fprintf_filtered (stream, "\".\n");
1383 fprintf_filtered (stream, _("Type \"show configuration\" "
1384 "for configuration details.\n"));
1386 if (REPORT_BUGS_TO[0])
1388 fprintf_filtered (stream,
1389 _("For bug reporting instructions, please see:\n"));
1390 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1392 fprintf_filtered (stream,
1393 _("Find the GDB manual and other documentation \
1394 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1395 fprintf_filtered (stream, "\n\n");
1396 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1397 fprintf_filtered (stream,
1398 _("Type \"apropos word\" to search for commands \
1399 related to \"word\"."));
1402 /* Print the details of GDB build-time configuration. */
1404 print_gdb_configuration (struct ui_file *stream)
1406 fprintf_filtered (stream, _("\
1407 This GDB was configured as follows:\n\
1408 configure --host=%s --target=%s\n\
1409 "), host_name, target_name);
1410 fprintf_filtered (stream, _("\
1411 --with-auto-load-dir=%s\n\
1412 --with-auto-load-safe-path=%s\n\
1413 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1415 fprintf_filtered (stream, _("\
1419 fprintf_filtered (stream, _("\
1424 fprintf_filtered (stream, _("\
1425 --with-gdb-datadir=%s%s\n\
1426 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1428 fprintf_filtered (stream, _("\
1429 --with-iconv-bin=%s%s\n\
1430 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1432 if (JIT_READER_DIR[0])
1433 fprintf_filtered (stream, _("\
1434 --with-jit-reader-dir=%s%s\n\
1435 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1436 #if HAVE_LIBUNWIND_IA64_H
1437 fprintf_filtered (stream, _("\
1438 --with-libunwind-ia64\n\
1441 fprintf_filtered (stream, _("\
1442 --without-libunwind-ia64\n\
1446 fprintf_filtered (stream, _("\
1450 fprintf_filtered (stream, _("\
1454 #if HAVE_LIBBABELTRACE
1455 fprintf_filtered (stream, _("\
1456 --with-babeltrace\n\
1459 fprintf_filtered (stream, _("\
1460 --without-babeltrace\n\
1464 fprintf_filtered (stream, _("\
1468 fprintf_filtered (stream, _("\
1469 --without-intel-pt\n\
1473 fprintf_filtered (stream, _("\
1474 --enable-libmcheck\n\
1477 fprintf_filtered (stream, _("\
1478 --disable-libmcheck\n\
1482 fprintf_filtered (stream, _("\
1486 fprintf_filtered (stream, _("\
1490 #ifdef WITH_PYTHON_PATH
1491 fprintf_filtered (stream, _("\
1492 --with-python=%s%s\n\
1493 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1495 fprintf_filtered (stream, _("\
1500 fprintf_filtered (stream, _("\
1504 fprintf_filtered (stream, _("\
1508 #if HAVE_SOURCE_HIGHLIGHT
1509 fprintf_filtered (stream, _("\
1510 --enable-source-highlight\n\
1513 fprintf_filtered (stream, _("\
1514 --disable-source-highlight\n\
1518 fprintf_filtered (stream, _("\
1519 --with-relocated-sources=%s\n\
1523 fprintf_filtered (stream, _("\
1524 --with-separate-debug-dir=%s%s\n\
1525 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1526 if (TARGET_SYSTEM_ROOT[0])
1527 fprintf_filtered (stream, _("\
1528 --with-sysroot=%s%s\n\
1529 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1530 if (SYSTEM_GDBINIT[0])
1531 fprintf_filtered (stream, _("\
1532 --with-system-gdbinit=%s%s\n\
1533 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1534 /* We assume "relocatable" will be printed at least once, thus we always
1535 print this text. It's a reasonably safe assumption for now. */
1536 fprintf_filtered (stream, _("\n\
1537 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1538 tree, and GDB will still find it.)\n\
1543 /* The current top level prompt, settable with "set prompt", and/or
1544 with the python `gdb.prompt_hook' hook. */
1545 static char *top_prompt;
1547 /* Access method for the GDB prompt string. */
1555 /* Set method for the GDB prompt string. */
1558 set_prompt (const char *s)
1560 char *p = xstrdup (s);
1572 /* Callback for iterate_over_inferiors. Kills or detaches the given
1573 inferior, depending on how we originally gained control of it. */
1576 kill_or_detach (struct inferior *inf, void *args)
1578 struct qt_args *qt = (struct qt_args *) args;
1583 thread_info *thread = any_thread_of_inferior (inf);
1586 switch_to_thread (thread);
1588 /* Leave core files alone. */
1589 if (target_has_execution)
1591 if (inf->attach_flag)
1592 target_detach (inf, qt->from_tty);
1601 /* Callback for iterate_over_inferiors. Prints info about what GDB
1602 will do to each inferior on a "quit". ARG points to a struct
1603 ui_out where output is to be collected. */
1606 print_inferior_quit_action (struct inferior *inf, void *arg)
1608 struct ui_file *stb = (struct ui_file *) arg;
1613 if (inf->attach_flag)
1614 fprintf_filtered (stb,
1615 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1616 target_pid_to_str (ptid_t (inf->pid)).c_str ());
1618 fprintf_filtered (stb,
1619 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1620 target_pid_to_str (ptid_t (inf->pid)).c_str ());
1625 /* If necessary, make the user confirm that we should quit. Return
1626 non-zero if we should quit, zero if we shouldn't. */
1631 /* Don't even ask if we're only debugging a core file inferior. */
1632 if (!have_live_inferiors ())
1635 /* Build the query string as a single string. */
1638 stb.puts (_("A debugging session is active.\n\n"));
1639 iterate_over_inferiors (print_inferior_quit_action, &stb);
1640 stb.puts (_("\nQuit anyway? "));
1642 return query ("%s", stb.c_str ());
1645 /* Prepare to exit GDB cleanly by undoing any changes made to the
1646 terminal so that we leave the terminal in the state we acquired it. */
1649 undo_terminal_modifications_before_exit (void)
1651 struct ui *saved_top_level = current_ui;
1653 target_terminal::ours ();
1655 current_ui = main_ui;
1660 gdb_disable_readline ();
1662 current_ui = saved_top_level;
1666 /* Quit without asking for confirmation. */
1669 quit_force (int *exit_arg, int from_tty)
1674 undo_terminal_modifications_before_exit ();
1676 /* An optional expression may be used to cause gdb to terminate with the
1677 value of that expression. */
1679 exit_code = *exit_arg;
1680 else if (return_child_result)
1681 exit_code = return_child_result_value;
1683 qt.from_tty = from_tty;
1685 /* We want to handle any quit errors and exit regardless. */
1687 /* Get out of tfind mode, and kill or detach all inferiors. */
1690 disconnect_tracing ();
1691 iterate_over_inferiors (kill_or_detach, &qt);
1693 catch (const gdb_exception &ex)
1695 exception_print (gdb_stderr, ex);
1698 /* Give all pushed targets a chance to do minimal cleanup, and pop
1704 catch (const gdb_exception &ex)
1706 exception_print (gdb_stderr, ex);
1709 /* Save the history information if it is appropriate to do so. */
1712 if (write_history_p && history_filename)
1717 /* History is currently shared between all UIs. If there's
1718 any UI with a terminal, save history. */
1721 if (input_interactive_p (ui))
1729 gdb_safe_append_history ();
1732 catch (const gdb_exception &ex)
1734 exception_print (gdb_stderr, ex);
1737 /* Destroy any values currently allocated now instead of leaving it
1738 to global destructors, because that may be too late. For
1739 example, the destructors of xmethod values call into the Python
1740 runtime, which is finalized via a final cleanup. */
1743 /* Do any final cleanups before exiting. */
1746 do_final_cleanups ();
1748 catch (const gdb_exception &ex)
1750 exception_print (gdb_stderr, ex);
1756 /* The value of the "interactive-mode" setting. */
1757 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1759 /* Implement the "show interactive-mode" option. */
1762 show_interactive_mode (struct ui_file *file, int from_tty,
1763 struct cmd_list_element *c,
1766 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1767 fprintf_filtered (file, "Debugger's interactive mode "
1768 "is %s (currently %s).\n",
1769 value, input_interactive_p (current_ui) ? "on" : "off");
1771 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1774 /* Returns whether GDB is running on an interactive terminal. */
1777 input_interactive_p (struct ui *ui)
1782 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1783 return interactive_mode == AUTO_BOOLEAN_TRUE;
1785 return ui->input_interactive_p;
1789 dont_repeat_command (const char *ignored, int from_tty)
1791 /* Can't call dont_repeat here because we're not necessarily reading
1793 *saved_command_line = 0;
1796 /* Functions to manipulate command line editing control variables. */
1798 /* Number of commands to print in each call to show_commands. */
1799 #define Hist_print 10
1801 show_commands (const char *args, int from_tty)
1803 /* Index for history commands. Relative to history_base. */
1806 /* Number of the history entry which we are planning to display next.
1807 Relative to history_base. */
1810 /* Print out some of the commands from the command history. */
1814 if (args[0] == '+' && args[1] == '\0')
1815 /* "info editing +" should print from the stored position. */
1818 /* "info editing <exp>" should print around command number <exp>. */
1819 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1821 /* "show commands" means print the last Hist_print commands. */
1824 num = history_length - Hist_print;
1830 /* If there are at least Hist_print commands, we want to display the last
1831 Hist_print rather than, say, the last 6. */
1832 if (history_length - num < Hist_print)
1834 num = history_length - Hist_print;
1840 offset < num + Hist_print && offset < history_length;
1843 printf_filtered ("%5d %s\n", history_base + offset,
1844 (history_get (history_base + offset))->line);
1847 /* The next command we want to display is the next one that we haven't
1851 /* If the user repeats this command with return, it should do what
1852 "show commands +" does. This is unnecessary if arg is null,
1853 because "show commands +" is not useful after "show commands". */
1854 if (from_tty && args)
1855 set_repeat_arguments ("+");
1858 /* Update the size of our command history file to HISTORY_SIZE.
1860 A HISTORY_SIZE of -1 stands for unlimited. */
1863 set_readline_history_size (int history_size)
1865 gdb_assert (history_size >= -1);
1867 if (history_size == -1)
1868 unstifle_history ();
1870 stifle_history (history_size);
1873 /* Called by do_setshow_command. */
1875 set_history_size_command (const char *args,
1876 int from_tty, struct cmd_list_element *c)
1878 set_readline_history_size (history_size_setshow_var);
1882 set_history (const char *args, int from_tty)
1884 printf_unfiltered (_("\"set history\" must be followed "
1885 "by the name of a history subcommand.\n"));
1886 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1890 show_history (const char *args, int from_tty)
1892 cmd_show_list (showhistlist, from_tty, "");
1895 int info_verbose = 0; /* Default verbose msgs off. */
1897 /* Called by do_set_command. An elaborate joke. */
1899 set_verbose (const char *args, int from_tty, struct cmd_list_element *c)
1901 const char *cmdname = "verbose";
1902 struct cmd_list_element *showcmd;
1904 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1905 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1907 if (c->doc && c->doc_allocated)
1908 xfree ((char *) c->doc);
1909 if (showcmd->doc && showcmd->doc_allocated)
1910 xfree ((char *) showcmd->doc);
1913 c->doc = _("Set verbose printing of informational messages.");
1914 showcmd->doc = _("Show verbose printing of informational messages.");
1918 c->doc = _("Set verbosity.");
1919 showcmd->doc = _("Show verbosity.");
1921 c->doc_allocated = 0;
1922 showcmd->doc_allocated = 0;
1925 /* Init the history buffer. Note that we are called after the init file(s)
1926 have been read so that the user can change the history file via his
1927 .gdbinit file (for instance). The GDBHISTFILE environment variable
1928 overrides all of this. */
1935 tmpenv = getenv ("GDBHISTSIZE");
1942 tmpenv = skip_spaces (tmpenv);
1944 var = strtol (tmpenv, &endptr, 10);
1945 saved_errno = errno;
1946 endptr = skip_spaces (endptr);
1948 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1949 empty string, a negative number or a huge positive number (larger than
1950 INT_MAX) then set the history size to unlimited. Otherwise set our
1951 history size to the number we have read. This behavior is consistent
1952 with how bash handles HISTSIZE. */
1953 if (*endptr != '\0')
1955 else if (*tmpenv == '\0'
1958 /* On targets where INT_MAX == LONG_MAX, we have to look at
1959 errno after calling strtol to distinguish between a value that
1960 is exactly INT_MAX and an overflowing value that was clamped
1962 || (var == INT_MAX && saved_errno == ERANGE))
1963 history_size_setshow_var = -1;
1965 history_size_setshow_var = var;
1968 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1970 if (history_size_setshow_var == -2)
1971 history_size_setshow_var = 256;
1973 set_readline_history_size (history_size_setshow_var);
1975 tmpenv = getenv ("GDBHISTFILE");
1977 history_filename = xstrdup (tmpenv);
1978 else if (!history_filename)
1980 /* We include the current directory so that if the user changes
1981 directories the file written will be the same as the one
1984 /* No leading dots in file names are allowed on MSDOS. */
1985 history_filename = concat (current_directory, "/_gdb_history",
1988 history_filename = concat (current_directory, "/.gdb_history",
1992 read_history (history_filename);
1996 show_prompt (struct ui_file *file, int from_tty,
1997 struct cmd_list_element *c, const char *value)
1999 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
2002 /* "set editing" command. */
2005 set_editing (const char *args, int from_tty, struct cmd_list_element *c)
2007 change_line_handler (set_editing_cmd_var);
2008 /* Update the control variable so that MI's =cmd-param-changed event
2009 shows the correct value. */
2010 set_editing_cmd_var = current_ui->command_editing;
2014 show_editing (struct ui_file *file, int from_tty,
2015 struct cmd_list_element *c, const char *value)
2017 fprintf_filtered (file, _("Editing of command lines as "
2018 "they are typed is %s.\n"),
2019 current_ui->command_editing ? _("on") : _("off"));
2023 show_annotation_level (struct ui_file *file, int from_tty,
2024 struct cmd_list_element *c, const char *value)
2026 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
2030 show_exec_done_display_p (struct ui_file *file, int from_tty,
2031 struct cmd_list_element *c, const char *value)
2033 fprintf_filtered (file, _("Notification of completion for "
2034 "asynchronous execution commands is %s.\n"),
2038 /* New values of the "data-directory" parameter are staged here. */
2039 static char *staged_gdb_datadir;
2041 /* "set" command for the gdb_datadir configuration variable. */
2044 set_gdb_datadir (const char *args, int from_tty, struct cmd_list_element *c)
2046 set_gdb_data_directory (staged_gdb_datadir);
2047 gdb::observers::gdb_datadir_changed.notify ();
2050 /* "show" command for the gdb_datadir configuration variable. */
2053 show_gdb_datadir (struct ui_file *file, int from_tty,
2054 struct cmd_list_element *c, const char *value)
2056 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
2061 set_history_filename (const char *args,
2062 int from_tty, struct cmd_list_element *c)
2064 /* We include the current directory so that if the user changes
2065 directories the file written will be the same as the one
2067 if (!IS_ABSOLUTE_PATH (history_filename))
2068 history_filename = reconcat (history_filename, current_directory, "/",
2069 history_filename, (char *) NULL);
2073 init_gdb_version_vars (void)
2075 struct internalvar *major_version_var = create_internalvar ("_gdb_major");
2076 struct internalvar *minor_version_var = create_internalvar ("_gdb_minor");
2077 int vmajor = 0, vminor = 0, vrevision = 0;
2078 sscanf (version, "%d.%d.%d", &vmajor, &vminor, &vrevision);
2079 set_internalvar_integer (major_version_var, vmajor);
2080 set_internalvar_integer (minor_version_var, vminor + (vrevision > 0));
2086 struct cmd_list_element *c;
2088 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2089 the DEFAULT_PROMPT is. */
2090 set_prompt (DEFAULT_PROMPT);
2092 /* Set the important stuff up for command editing. */
2093 command_editing_p = 1;
2094 history_expansion_p = 0;
2095 write_history_p = 0;
2097 /* Setup important stuff for command line editing. */
2098 rl_completion_word_break_hook = gdb_completion_word_break_characters;
2099 rl_attempted_completion_function = gdb_rl_attempted_completion_function;
2100 set_rl_completer_word_break_characters (default_word_break_characters ());
2101 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
2102 rl_completion_display_matches_hook = cli_display_match_list;
2103 rl_readline_name = "gdb";
2104 rl_terminal_name = getenv ("TERM");
2106 /* The name for this defun comes from Bash, where it originated.
2107 15 is Control-o, the same binding this function has in Bash. */
2108 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2110 add_setshow_string_cmd ("prompt", class_support,
2112 _("Set gdb's prompt"),
2113 _("Show gdb's prompt"),
2116 &setlist, &showlist);
2118 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2119 Don't repeat this command.\nPrimarily \
2120 used inside of user-defined commands that should not be repeated when\n\
2123 add_setshow_boolean_cmd ("editing", class_support,
2124 &set_editing_cmd_var, _("\
2125 Set editing of command lines as they are typed."), _("\
2126 Show editing of command lines as they are typed."), _("\
2127 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2128 Without an argument, command line editing is enabled. To edit, use\n\
2129 EMACS-like or VI-like commands like control-P or ESC."),
2132 &setlist, &showlist);
2134 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2135 Set saving of the history record on exit."), _("\
2136 Show saving of the history record on exit."), _("\
2137 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2138 Without an argument, saving is enabled."),
2140 show_write_history_p,
2141 &sethistlist, &showhistlist);
2143 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2144 &history_size_setshow_var, _("\
2145 Set the size of the command history,"), _("\
2146 Show the size of the command history,"), _("\
2147 ie. the number of previous commands to keep a record of.\n\
2148 If set to \"unlimited\", the number of commands kept in the history\n\
2149 list is unlimited. This defaults to the value of the environment\n\
2150 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2151 set_history_size_command,
2153 &sethistlist, &showhistlist);
2155 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2156 &history_remove_duplicates, _("\
2157 Set how far back in history to look for and remove duplicate entries."), _("\
2158 Show how far back in history to look for and remove duplicate entries."), _("\
2159 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2160 and remove the first history entry that is a duplicate of the most recent\n\
2161 entry, each time a new history entry is added.\n\
2162 If set to \"unlimited\", this lookbehind is unbounded.\n\
2163 Only history entries added during this session are considered for removal.\n\
2164 If set to 0, removal of duplicate history entries is disabled.\n\
2165 By default this option is set to 0."),
2167 show_history_remove_duplicates,
2168 &sethistlist, &showhistlist);
2170 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2171 Set the filename in which to record the command history"), _("\
2172 Show the filename in which to record the command history"), _("\
2173 (the list of previous commands of which a record is kept)."),
2174 set_history_filename,
2175 show_history_filename,
2176 &sethistlist, &showhistlist);
2178 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2179 Set whether to confirm potentially dangerous operations."), _("\
2180 Show whether to confirm potentially dangerous operations."), NULL,
2183 &setlist, &showlist);
2185 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2186 Set annotation_level."), _("\
2187 Show annotation_level."), _("\
2188 0 == normal; 1 == fullname (for use when running under emacs)\n\
2189 2 == output annotated suitably for use by programs that control GDB."),
2191 show_annotation_level,
2192 &setlist, &showlist);
2194 add_setshow_boolean_cmd ("exec-done-display", class_support,
2195 &exec_done_display_p, _("\
2196 Set notification of completion for asynchronous execution commands."), _("\
2197 Show notification of completion for asynchronous execution commands."), _("\
2198 Use \"on\" to enable the notification, and \"off\" to disable it."),
2200 show_exec_done_display_p,
2201 &setlist, &showlist);
2203 add_setshow_filename_cmd ("data-directory", class_maintenance,
2204 &staged_gdb_datadir, _("Set GDB's data directory."),
2205 _("Show GDB's data directory."),
2207 When set, GDB uses the specified path to search for data files."),
2208 set_gdb_datadir, show_gdb_datadir,
2212 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2213 &interactive_mode, _("\
2214 Set whether GDB's standard input is a terminal."), _("\
2215 Show whether GDB's standard input is a terminal."), _("\
2216 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2217 means that GDB should wait for the user to answer queries associated to\n\
2218 commands entered at the command prompt. If off, GDB assumes that standard\n\
2219 input is not a terminal, and uses the default answer to all queries.\n\
2220 If auto (the default), determine which mode to use based on the standard\n\
2223 show_interactive_mode,
2224 &setlist, &showlist);
2226 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2227 Create a new UI. It takes two arguments:\n\
2228 The first argument is the name of the interpreter to run.\n\
2229 The second argument is the terminal the UI runs on."), &cmdlist);
2230 set_cmd_completer (c, interpreter_completer);
2234 gdb_init (char *argv0)
2236 saved_command_line = xstrdup ("");
2237 previous_saved_command_line = xstrdup ("");
2239 if (pre_init_ui_hook)
2240 pre_init_ui_hook ();
2242 /* Run the init function of each source file. */
2245 /* Make sure we return to the original directory upon exit, come
2246 what may, since the OS doesn't do that for us. */
2247 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2250 init_cmd_lists (); /* This needs to be done first. */
2251 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2252 initialize_utils (); /* Make errors and warnings possible. */
2256 /* Here is where we call all the _initialize_foo routines. */
2257 initialize_all_files ();
2259 /* This creates the current_program_space. Do this after all the
2260 _initialize_foo routines have had a chance to install their
2261 per-sspace data keys. Also do this before
2262 initialize_current_architecture is called, because it accesses
2263 exec_bfd of the current program space. */
2264 initialize_progspace ();
2265 initialize_inferiors ();
2266 initialize_current_architecture ();
2268 init_main (); /* But that omits this file! Do it now. */
2270 initialize_stdin_serial ();
2272 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2274 set_initial_gdb_ttystate ();
2276 async_init_signals ();
2278 /* We need a default language for parsing expressions, so simple
2279 things like "set width 0" won't fail if no language is explicitly
2280 set in a config file or implicitly set by reading an executable
2282 set_language (language_c);
2283 expected_language = current_language; /* Don't warn about the change. */
2285 /* Python initialization, for example, can require various commands to be
2286 installed. For example "info pretty-printer" needs the "info"
2287 prefix to be installed. Keep things simple and just do final
2288 script initialization here. */
2289 finish_ext_lang_initialization ();
2291 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2292 init_gdb_version_vars ();