1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "cli/cli-cmds.h"
23 #include "cli/cli-script.h"
24 #include "cli/cli-setshow.h"
25 #include "cli/cli-decode.h"
31 #include "target-dcache.h"
32 #include "breakpoint.h"
34 #include "expression.h"
38 #include "gdbsupport/job-control.h"
40 #include "completer.h"
42 #include "gdbsupport/version.h"
45 #include "event-loop.h"
46 #include "gdbthread.h"
47 #include "extension.h"
49 #include "observable.h"
51 #include "filenames.h"
53 #include "gdbsupport/buffer.h"
54 #include "gdb_select.h"
55 #include "gdbsupport/scope-exit.h"
58 /* readline include files. */
59 #include "readline/readline.h"
60 #include "readline/history.h"
62 /* readline defines this. */
65 #include <sys/types.h>
67 #include "event-top.h"
72 #include "tracepoint.h"
83 extern void initialize_all_files (void);
85 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
86 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
87 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
89 /* Default command line prompt. This is overridden in some configs. */
91 #ifndef DEFAULT_PROMPT
92 #define DEFAULT_PROMPT "(gdb) "
96 current_ui_gdb_stdout_ptr ()
98 return ¤t_ui
->m_gdb_stdout
;
102 current_ui_gdb_stdin_ptr ()
104 return ¤t_ui
->m_gdb_stdin
;
108 current_ui_gdb_stderr_ptr ()
110 return ¤t_ui
->m_gdb_stderr
;
114 current_ui_gdb_stdlog_ptr ()
116 return ¤t_ui
->m_gdb_stdlog
;
120 current_ui_current_uiout_ptr ()
122 return ¤t_ui
->m_current_uiout
;
125 int inhibit_gdbinit
= 0;
127 /* Flag for whether we want to confirm potentially dangerous
128 operations. Default is yes. */
133 show_confirm (struct ui_file
*file
, int from_tty
,
134 struct cmd_list_element
*c
, const char *value
)
136 fprintf_filtered (file
, _("Whether to confirm potentially "
137 "dangerous operations is %s.\n"),
141 /* Current working directory. */
143 char *current_directory
;
145 /* The last command line executed on the console. Used for command
146 repetitions when the user enters an empty line. */
148 static char *saved_command_line
;
150 /* If not NULL, the arguments that should be passed if
151 saved_command_line is repeated. */
153 static const char *repeat_arguments
;
155 /* The previous last command line executed on the console. Used for command
156 repetitions when a command wants to relaunch the previously launched
157 command. We need this as when a command is running, saved_command_line
158 already contains the line of the currently executing command. */
160 char *previous_saved_command_line
;
162 /* If not NULL, the arguments that should be passed if the
163 previous_saved_command_line is repeated. */
165 static const char *previous_repeat_arguments
;
167 /* Nonzero if the current command is modified by "server ". This
168 affects things like recording into the command history, commands
169 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
170 whatever) can issue its own commands and also send along commands
171 from the user, and have the user not notice that the user interface
172 is issuing commands too. */
175 /* Timeout limit for response from target. */
177 /* The default value has been changed many times over the years. It
178 was originally 5 seconds. But that was thought to be a long time
179 to sit and wait, so it was changed to 2 seconds. That was thought
180 to be plenty unless the connection was going through some terminal
181 server or multiplexer or other form of hairy serial connection.
183 In mid-1996, remote_timeout was moved from remote.c to top.c and
184 it began being used in other remote-* targets. It appears that the
185 default was changed to 20 seconds at that time, perhaps because the
186 Renesas E7000 ICE didn't always respond in a timely manner.
188 But if 5 seconds is a long time to sit and wait for retransmissions,
189 20 seconds is far worse. This demonstrates the difficulty of using
190 a single variable for all protocol timeouts.
192 As remote.c is used much more than remote-e7000.c, it was changed
193 back to 2 seconds in 1999. */
195 int remote_timeout
= 2;
197 /* Non-zero tells remote* modules to output debugging info. */
199 int remote_debug
= 0;
201 /* Sbrk location on entry to main. Used for statistics only. */
202 #ifdef HAVE_USEFUL_SBRK
206 /* Hooks for alternate command interfaces. */
208 /* This hook is called from within gdb's many mini-event loops which
209 could steal control from a real user interface's event loop. It
210 returns non-zero if the user is requesting a detach, zero
213 int (*deprecated_ui_loop_hook
) (int);
216 /* Called from print_frame_info to list the line we stopped in. */
218 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
222 /* Replaces most of query. */
224 int (*deprecated_query_hook
) (const char *, va_list);
226 /* Replaces most of warning. */
228 void (*deprecated_warning_hook
) (const char *, va_list);
230 /* These three functions support getting lines of text from the user.
231 They are used in sequence. First deprecated_readline_begin_hook is
232 called with a text string that might be (for example) a message for
233 the user to type in a sequence of commands to be executed at a
234 breakpoint. If this function calls back to a GUI, it might take
235 this opportunity to pop up a text interaction window with this
236 message. Next, deprecated_readline_hook is called with a prompt
237 that is emitted prior to collecting the user input. It can be
238 called multiple times. Finally, deprecated_readline_end_hook is
239 called to notify the GUI that we are done with the interaction
240 window and it can close it. */
242 void (*deprecated_readline_begin_hook
) (const char *, ...);
243 char *(*deprecated_readline_hook
) (const char *);
244 void (*deprecated_readline_end_hook
) (void);
246 /* Called as appropriate to notify the interface that we have attached
247 to or detached from an already running process. */
249 void (*deprecated_attach_hook
) (void);
250 void (*deprecated_detach_hook
) (void);
252 /* Called when going to wait for the target. Usually allows the GUI
253 to run while waiting for target events. */
255 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
256 struct target_waitstatus
*status
,
259 /* Used by UI as a wrapper around command execution. May do various
260 things like enabling/disabling buttons, etc... */
262 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
263 const char *cmd
, int from_tty
);
265 /* Called when the current thread changes. Argument is thread id. */
267 void (*deprecated_context_hook
) (int id
);
269 /* The highest UI number ever assigned. */
270 static int highest_ui_num
;
274 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
276 num (++highest_ui_num
),
277 call_readline (nullptr),
278 input_handler (nullptr),
280 interp_info (nullptr),
282 secondary_prompt_depth (0),
283 stdin_stream (instream_
),
284 instream (instream_
),
285 outstream (outstream_
),
286 errstream (errstream_
),
287 input_fd (fileno (instream
)),
288 input_interactive_p (ISATTY (instream
)),
289 prompt_state (PROMPT_NEEDED
),
290 m_gdb_stdout (new stdio_file (outstream
)),
291 m_gdb_stdin (new stdio_file (instream
)),
292 m_gdb_stderr (new stderr_file (errstream
)),
293 m_gdb_stdlog (m_gdb_stderr
),
294 m_current_uiout (nullptr)
296 buffer_init (&line_buffer
);
304 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
312 struct ui
*ui
, *uiprev
;
316 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
320 gdb_assert (ui
!= NULL
);
332 /* Open file named NAME for read/write, making sure not to make it the
333 controlling terminal. */
336 open_terminal_stream (const char *name
)
340 fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
342 perror_with_name (_("opening terminal failed"));
344 return gdb_file_up (fdopen (fd
, "w+"));
347 /* Implementation of the "new-ui" command. */
350 new_ui_command (const char *args
, int from_tty
)
353 const char *interpreter_name
;
354 const char *tty_name
;
358 gdb_argv
argv (args
);
359 argc
= argv
.count ();
362 error (_("Usage: new-ui INTERPRETER TTY"));
364 interpreter_name
= argv
[0];
368 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
370 /* Open specified terminal. Note: we used to open it three times,
371 once for each of stdin/stdout/stderr, but that does not work
372 with Windows named pipes. */
373 gdb_file_up stream
= open_terminal_stream (tty_name
);
375 std::unique_ptr
<ui
> ui
376 (new struct ui (stream
.get (), stream
.get (), stream
.get ()));
380 current_ui
= ui
.get ();
382 set_top_level_interpreter (interpreter_name
);
384 interp_pre_command_loop (top_level_interpreter ());
386 /* Make sure the file is not closed. */
392 printf_unfiltered ("New UI allocated\n");
395 /* Handler for SIGHUP. */
398 /* NOTE 1999-04-29: This function will be static again, once we modify
399 gdb to use the event loop as the default command loop and we merge
400 event-top.c into this file, top.c. */
404 /* Stop asking user for confirmation --- we're exiting. This
405 prevents asking the user dumb questions. */
407 quit_command ((char *) 0, 0);
409 #endif /* defined SIGHUP */
411 /* Line number we are currently in, in a file which is being sourced. */
412 /* NOTE 1999-04-29: This variable will be static again, once we modify
413 gdb to use the event loop as the default command loop and we merge
414 event-top.c into this file, top.c. */
415 /* static */ int source_line_number
;
417 /* Name of the file we are sourcing. */
418 /* NOTE 1999-04-29: This variable will be static again, once we modify
419 gdb to use the event loop as the default command loop and we merge
420 event-top.c into this file, top.c. */
421 /* static */ std::string source_file_name
;
423 /* Read commands from STREAM. */
425 read_command_file (FILE *stream
)
427 struct ui
*ui
= current_ui
;
429 scoped_restore save_instream
430 = make_scoped_restore (&ui
->instream
, stream
);
432 /* Read commands from `instream' and execute them until end of file
433 or error reading instream. */
435 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
439 /* Get a command-line. This calls the readline package. */
440 command
= command_line_input (NULL
, NULL
);
443 command_handler (command
);
447 void (*pre_init_ui_hook
) (void);
451 do_chdir_cleanup (void *old_dir
)
453 chdir ((const char *) old_dir
);
459 prepare_execute_command ()
461 /* With multiple threads running while the one we're examining is
462 stopped, the dcache can get stale without us being able to detect
463 it. For the duration of the command, though, use the dcache to
464 help things like backtrace. */
466 target_dcache_invalidate ();
468 return scoped_value_mark ();
471 /* Tell the user if the language has changed (except first time) after
472 executing a command. */
475 check_frame_language_change (void)
477 static int warned
= 0;
478 struct frame_info
*frame
;
480 /* First make sure that a new frame has been selected, in case the
481 command or the hooks changed the program state. */
482 frame
= deprecated_safe_get_selected_frame ();
483 if (current_language
!= expected_language
)
485 if (language_mode
== language_mode_auto
&& info_verbose
)
487 language_info (1); /* Print what changed. */
492 /* Warn the user if the working language does not match the language
493 of the current frame. Only warn the user if we are actually
494 running the program, i.e. there is a stack. */
495 /* FIXME: This should be cacheing the frame and only running when
496 the frame changes. */
498 if (has_stack_frames ())
502 flang
= get_frame_language (frame
);
504 && flang
!= language_unknown
505 && flang
!= current_language
->la_language
)
507 printf_filtered ("%s\n", _(lang_frame_mismatch_warn
));
516 wait_sync_command_done (void)
518 /* Processing events may change the current UI. */
519 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
520 struct ui
*ui
= current_ui
;
522 while (gdb_do_one_event () >= 0)
523 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
530 maybe_wait_sync_command_done (int was_sync
)
532 /* If the interpreter is in sync mode (we're running a user
533 command's list, running command hooks or similars), and we
534 just ran a synchronous command that started the target, wait
535 for that command to end. */
536 if (!current_ui
->async
538 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
539 wait_sync_command_done ();
545 set_repeat_arguments (const char *args
)
547 repeat_arguments
= args
;
550 /* Execute the line P as a command, in the current user context.
551 Pass FROM_TTY as second argument to the defining function. */
554 execute_command (const char *p
, int from_tty
)
556 struct cmd_list_element
*c
;
558 const char *cmd_start
= p
;
560 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
561 scoped_value_mark cleanup
= prepare_execute_command ();
563 /* This can happen when command_line_input hits end of file. */
566 cleanup_if_error
.release ();
570 target_log_command (p
);
572 while (*p
== ' ' || *p
== '\t')
578 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
582 /* If trace-commands is set then this will print this command. */
583 print_command_trace ("%s", p
);
585 c
= lookup_cmd (&cmd
, cmdlist
, "", 0, 1);
588 scoped_restore save_repeat_args
589 = make_scoped_restore (&repeat_arguments
, nullptr);
590 const char *args_pointer
= p
;
592 /* Pass null arg rather than an empty one. */
595 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
596 while the is_complete_command(cfunc) test is just plain
597 bogus. They should both be replaced by a test of the form
598 c->strip_trailing_white_space_p. */
599 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
600 can't be replaced with func. This is because it is the
601 cfunc, and not the func, that has the value that the
602 is_complete_command hack is testing for. */
603 /* Clear off trailing whitespace, except for set and complete
605 std::string without_whitespace
;
607 && c
->type
!= set_cmd
608 && !is_complete_command (c
))
610 const char *old_end
= arg
+ strlen (arg
) - 1;
612 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
616 without_whitespace
= std::string (arg
, p
+ 1);
617 arg
= without_whitespace
.c_str ();
621 /* If this command has been pre-hooked, run the hook first. */
622 execute_cmd_pre_hook (c
);
624 if (c
->deprecated_warn_user
)
625 deprecated_cmd_warning (line
);
627 /* c->user_commands would be NULL in the case of a python command. */
628 if (c
->theclass
== class_user
&& c
->user_commands
)
629 execute_user_command (c
, arg
);
630 else if (c
->theclass
== class_user
631 && c
->prefixlist
&& !c
->allow_unknown
)
632 /* If this is a user defined prefix that does not allow unknown
633 (in other words, C is a prefix command and not a command
634 that can be followed by its args), report the list of
638 ("\"%.*s\" must be followed by the name of a subcommand.\n",
639 (int) strlen (c
->prefixname
) - 1, c
->prefixname
);
640 help_list (*c
->prefixlist
, c
->prefixname
, all_commands
, gdb_stdout
);
642 else if (c
->type
== set_cmd
)
643 do_set_command (arg
, from_tty
, c
);
644 else if (c
->type
== show_cmd
)
645 do_show_command (arg
, from_tty
, c
);
646 else if (!cmd_func_p (c
))
647 error (_("That is not a command, just a help topic."));
648 else if (deprecated_call_command_hook
)
649 deprecated_call_command_hook (c
, arg
, from_tty
);
651 cmd_func (c
, arg
, from_tty
);
653 maybe_wait_sync_command_done (was_sync
);
655 /* If this command has been post-hooked, run the hook last. */
656 execute_cmd_post_hook (c
);
658 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
660 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
661 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
666 /* Only perform the frame-language-change check if the command
667 we just finished executing did not resume the inferior's execution.
668 If it did resume the inferior, we will do that check after
669 the inferior stopped. */
670 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
671 check_frame_language_change ();
673 cleanup_if_error
.release ();
676 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
677 do not display it to the screen. BATCH_FLAG will be
678 temporarily set to true. */
681 execute_command_to_ui_file (struct ui_file
*file
, const char *p
, int from_tty
)
683 /* GDB_STDOUT should be better already restored during these
684 restoration callbacks. */
685 set_batch_flag_and_restore_page_info save_page_info
;
687 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
690 current_uiout
->redirect (file
);
691 ui_out_redirect_pop
redirect_popper (current_uiout
);
693 scoped_restore save_stdout
694 = make_scoped_restore (&gdb_stdout
, file
);
695 scoped_restore save_stderr
696 = make_scoped_restore (&gdb_stderr
, file
);
697 scoped_restore save_stdlog
698 = make_scoped_restore (&gdb_stdlog
, file
);
699 scoped_restore save_stdtarg
700 = make_scoped_restore (&gdb_stdtarg
, file
);
701 scoped_restore save_stdtargerr
702 = make_scoped_restore (&gdb_stdtargerr
, file
);
704 execute_command (p
, from_tty
);
708 /* Run execute_command for P and FROM_TTY. Capture its output into the
709 returned string, do not display it to the screen. BATCH_FLAG will be
710 temporarily set to true. */
713 execute_command_to_string (const char *p
, int from_tty
,
716 string_file
str_file (term_out
);
718 execute_command_to_ui_file (&str_file
, p
, from_tty
);
719 return std::move (str_file
.string ());
723 /* When nonzero, cause dont_repeat to do nothing. This should only be
724 set via prevent_dont_repeat. */
726 static int suppress_dont_repeat
= 0;
733 struct ui
*ui
= current_ui
;
735 if (suppress_dont_repeat
|| server_command
)
738 /* If we aren't reading from standard input, we are saving the last
739 thing read from stdin in line and don't want to delete it. Null
740 lines won't repeat here in any case. */
741 if (ui
->instream
== ui
->stdin_stream
)
743 *saved_command_line
= 0;
744 repeat_arguments
= NULL
;
753 /* Do not repeat this command, as this command is a repeating command. */
756 /* We cannot free saved_command_line, as this line is being executed,
757 so swap it with previous_saved_command_line. */
758 std::swap (previous_saved_command_line
, saved_command_line
);
759 std::swap (previous_repeat_arguments
, repeat_arguments
);
761 const char *prev
= skip_spaces (get_saved_command_line ());
763 error (_("No previous command to relaunch"));
769 scoped_restore_tmpl
<int>
770 prevent_dont_repeat (void)
772 return make_scoped_restore (&suppress_dont_repeat
, 1);
778 get_saved_command_line ()
780 return saved_command_line
;
786 save_command_line (const char *cmd
)
788 xfree (previous_saved_command_line
);
789 previous_saved_command_line
= saved_command_line
;
790 previous_repeat_arguments
= repeat_arguments
;
791 saved_command_line
= xstrdup (cmd
);
792 repeat_arguments
= NULL
;
796 /* Read a line from the stream "instream" without command line editing.
798 It prints PROMPT once at the start.
799 Action is compatible with "readline", e.g. space for the result is
800 malloc'd and should be freed by the caller.
802 A NULL return means end of file. */
805 gdb_readline_no_editing (const char *prompt
)
807 struct buffer line_buffer
;
808 struct ui
*ui
= current_ui
;
809 /* Read from stdin if we are executing a user defined command. This
810 is the right thing for prompt_for_continue, at least. */
811 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
812 int fd
= fileno (stream
);
814 buffer_init (&line_buffer
);
818 /* Don't use a _filtered function here. It causes the assumed
819 character position to be off, since the newline we read from
820 the user is not accounted for. */
821 fputs_unfiltered (prompt
, gdb_stdout
);
822 gdb_flush (gdb_stdout
);
832 /* Wait until at least one byte of data is available. Control-C
833 can interrupt interruptible_select, but not fgetc. */
835 FD_SET (fd
, &readfds
);
836 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
840 /* If this was ctrl-c, the QUIT above handles it. */
843 perror_with_name (("select"));
850 if (line_buffer
.used_size
> 0)
851 /* The last line does not end with a newline. Return it, and
852 if we are called again fgetc will still return EOF and
853 we'll return NULL then. */
855 xfree (buffer_finish (&line_buffer
));
861 if (line_buffer
.used_size
> 0
862 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
863 line_buffer
.used_size
--;
867 buffer_grow_char (&line_buffer
, c
);
870 buffer_grow_char (&line_buffer
, '\0');
871 return buffer_finish (&line_buffer
);
874 /* Variables which control command line editing and history
875 substitution. These variables are given default values at the end
877 static bool command_editing_p
;
879 /* NOTE 1999-04-29: This variable will be static again, once we modify
880 gdb to use the event loop as the default command loop and we merge
881 event-top.c into this file, top.c. */
883 /* static */ bool history_expansion_p
;
885 static bool write_history_p
;
887 show_write_history_p (struct ui_file
*file
, int from_tty
,
888 struct cmd_list_element
*c
, const char *value
)
890 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
894 /* The variable associated with the "set/show history size"
895 command. The value -1 means unlimited, and -2 means undefined. */
896 static int history_size_setshow_var
= -2;
899 show_history_size (struct ui_file
*file
, int from_tty
,
900 struct cmd_list_element
*c
, const char *value
)
902 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
906 /* Variable associated with the "history remove-duplicates" option.
907 The value -1 means unlimited. */
908 static int history_remove_duplicates
= 0;
911 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
912 struct cmd_list_element
*c
, const char *value
)
914 fprintf_filtered (file
,
915 _("The number of history entries to look back at for "
916 "duplicates is %s.\n"),
920 static char *history_filename
;
922 show_history_filename (struct ui_file
*file
, int from_tty
,
923 struct cmd_list_element
*c
, const char *value
)
925 fprintf_filtered (file
, _("The filename in which to record "
926 "the command history is \"%s\".\n"),
930 /* This is like readline(), but it has some gdb-specific behavior.
931 gdb may want readline in both the synchronous and async modes during
932 a single gdb invocation. At the ordinary top-level prompt we might
933 be using the async readline. That means we can't use
934 rl_pre_input_hook, since it doesn't work properly in async mode.
935 However, for a secondary prompt (" >", such as occurs during a
936 `define'), gdb wants a synchronous response.
938 We used to call readline() directly, running it in synchronous
939 mode. But mixing modes this way is not supported, and as of
940 readline 5.x it no longer works; the arrow keys come unbound during
941 the synchronous call. So we make a nested call into the event
942 loop. That's what gdb_readline_wrapper is for. */
944 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
945 rely on gdb_readline_wrapper_result, which might still be NULL if
946 the user types Control-D for EOF. */
947 static int gdb_readline_wrapper_done
;
949 /* The result of the current call to gdb_readline_wrapper, once a newline
951 static char *gdb_readline_wrapper_result
;
953 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
954 to be called after the newline is processed (which will redisplay
955 the prompt). But in gdb_readline_wrapper we will not get a new
956 prompt until the next call, or until we return to the event loop.
957 So we disable this hook around the newline and restore it before we
959 static void (*saved_after_char_processing_hook
) (void);
965 gdb_in_secondary_prompt_p (struct ui
*ui
)
967 return ui
->secondary_prompt_depth
> 0;
971 /* This function is called when readline has seen a complete line of
975 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
977 gdb_assert (!gdb_readline_wrapper_done
);
978 gdb_readline_wrapper_result
= line
.release ();
979 gdb_readline_wrapper_done
= 1;
981 /* Prevent operate-and-get-next from acting too early. */
982 saved_after_char_processing_hook
= after_char_processing_hook
;
983 after_char_processing_hook
= NULL
;
985 /* Prevent parts of the prompt from being redisplayed if annotations
986 are enabled, and readline's state getting out of sync. We'll
987 reinstall the callback handler, which puts the terminal in raw
988 mode (or in readline lingo, in prepped state), when we're next
989 ready to process user input, either in display_gdb_prompt, or if
990 we're handling an asynchronous target event and running in the
991 background, just before returning to the event loop to process
992 further input (or more target events). */
993 if (current_ui
->command_editing
)
994 gdb_rl_callback_handler_remove ();
997 class gdb_readline_wrapper_cleanup
1000 gdb_readline_wrapper_cleanup ()
1001 : m_handler_orig (current_ui
->input_handler
),
1002 m_already_prompted_orig (current_ui
->command_editing
1003 ? rl_already_prompted
: 0),
1004 m_target_is_async_orig (target_is_async_p ()),
1005 m_save_ui (¤t_ui
)
1007 current_ui
->input_handler
= gdb_readline_wrapper_line
;
1008 current_ui
->secondary_prompt_depth
++;
1010 if (m_target_is_async_orig
)
1014 ~gdb_readline_wrapper_cleanup ()
1016 struct ui
*ui
= current_ui
;
1018 if (ui
->command_editing
)
1019 rl_already_prompted
= m_already_prompted_orig
;
1021 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1022 ui
->input_handler
= m_handler_orig
;
1024 /* Don't restore our input handler in readline yet. That would make
1025 readline prep the terminal (putting it in raw mode), while the
1026 line we just read may trigger execution of a command that expects
1027 the terminal in the default cooked/canonical mode, such as e.g.,
1028 running Python's interactive online help utility. See
1029 gdb_readline_wrapper_line for when we'll reinstall it. */
1031 gdb_readline_wrapper_result
= NULL
;
1032 gdb_readline_wrapper_done
= 0;
1033 ui
->secondary_prompt_depth
--;
1034 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1036 after_char_processing_hook
= saved_after_char_processing_hook
;
1037 saved_after_char_processing_hook
= NULL
;
1039 if (m_target_is_async_orig
)
1043 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1047 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1048 int m_already_prompted_orig
;
1050 /* Whether the target was async. */
1051 int m_target_is_async_orig
;
1053 /* Processing events may change the current UI. */
1054 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1058 gdb_readline_wrapper (const char *prompt
)
1060 struct ui
*ui
= current_ui
;
1062 gdb_readline_wrapper_cleanup cleanup
;
1064 /* Display our prompt and prevent double prompt display. Don't pass
1065 down a NULL prompt, since that has special meaning for
1066 display_gdb_prompt -- it indicates a request to print the primary
1067 prompt, while we want a secondary prompt here. */
1068 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1069 if (ui
->command_editing
)
1070 rl_already_prompted
= 1;
1072 if (after_char_processing_hook
)
1073 (*after_char_processing_hook
) ();
1074 gdb_assert (after_char_processing_hook
== NULL
);
1076 while (gdb_do_one_event () >= 0)
1077 if (gdb_readline_wrapper_done
)
1080 return gdb_readline_wrapper_result
;
1084 /* The current saved history number from operate-and-get-next.
1085 This is -1 if not valid. */
1086 static int operate_saved_history
= -1;
1088 /* This is put on the appropriate hook and helps operate-and-get-next
1091 gdb_rl_operate_and_get_next_completion (void)
1093 int delta
= where_history () - operate_saved_history
;
1095 /* The `key' argument to rl_get_previous_history is ignored. */
1096 rl_get_previous_history (delta
, 0);
1097 operate_saved_history
= -1;
1099 /* readline doesn't automatically update the display for us. */
1102 after_char_processing_hook
= NULL
;
1103 rl_pre_input_hook
= NULL
;
1106 /* This is a gdb-local readline command handler. It accepts the
1107 current command line (like RET does) and, if this command was taken
1108 from the history, arranges for the next command in the history to
1109 appear on the command line when the prompt returns.
1110 We ignore the arguments. */
1112 gdb_rl_operate_and_get_next (int count
, int key
)
1116 /* Use the async hook. */
1117 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1119 /* Find the current line, and find the next line to use. */
1120 where
= where_history();
1122 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1123 || (where
>= history_length
- 1))
1124 operate_saved_history
= where
;
1126 operate_saved_history
= where
+ 1;
1128 return rl_newline (1, key
);
1131 /* Number of user commands executed during this session. */
1133 static int command_count
= 0;
1135 /* Add the user command COMMAND to the input history list. */
1138 gdb_add_history (const char *command
)
1142 if (history_remove_duplicates
!= 0)
1145 int lookbehind_threshold
;
1147 /* The lookbehind threshold for finding a duplicate history entry is
1148 bounded by command_count because we can't meaningfully delete
1149 history entries that are already stored in the history file since
1150 the history file is appended to. */
1151 if (history_remove_duplicates
== -1
1152 || history_remove_duplicates
> command_count
)
1153 lookbehind_threshold
= command_count
;
1155 lookbehind_threshold
= history_remove_duplicates
;
1158 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1160 HIST_ENTRY
*temp
= previous_history ();
1165 if (strcmp (temp
->line
, command
) == 0)
1167 HIST_ENTRY
*prev
= remove_history (where_history ());
1169 free_history_entry (prev
);
1176 add_history (command
);
1179 /* Safely append new history entries to the history file in a corruption-free
1180 way using an intermediate local history file. */
1183 gdb_safe_append_history (void)
1185 int ret
, saved_errno
;
1187 std::string local_history_filename
1188 = string_printf ("%s-gdb%ld~", history_filename
, (long) getpid ());
1190 ret
= rename (history_filename
, local_history_filename
.c_str ());
1191 saved_errno
= errno
;
1192 if (ret
< 0 && saved_errno
!= ENOENT
)
1194 warning (_("Could not rename %s to %s: %s"),
1195 history_filename
, local_history_filename
.c_str (),
1196 safe_strerror (saved_errno
));
1202 /* If the rename failed with ENOENT then either the global history
1203 file never existed in the first place or another GDB process is
1204 currently appending to it (and has thus temporarily renamed it).
1205 Since we can't distinguish between these two cases, we have to
1206 conservatively assume the first case and therefore must write out
1207 (not append) our known history to our local history file and try
1208 to move it back anyway. Otherwise a global history file would
1209 never get created! */
1210 gdb_assert (saved_errno
== ENOENT
);
1211 write_history (local_history_filename
.c_str ());
1215 append_history (command_count
, local_history_filename
.c_str ());
1216 if (history_is_stifled ())
1217 history_truncate_file (local_history_filename
.c_str (),
1218 history_max_entries
);
1221 ret
= rename (local_history_filename
.c_str (), history_filename
);
1222 saved_errno
= errno
;
1223 if (ret
< 0 && saved_errno
!= EEXIST
)
1224 warning (_("Could not rename %s to %s: %s"),
1225 local_history_filename
.c_str (), history_filename
,
1226 safe_strerror (saved_errno
));
1230 /* Read one line from the command input stream `instream' into a local
1231 static buffer. The buffer is made bigger as necessary. Returns
1232 the address of the start of the line.
1234 NULL is returned for end of file.
1236 This routine either uses fancy command line editing or simple input
1237 as the user has requested. */
1240 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1242 static struct buffer cmd_line_buffer
;
1243 static int cmd_line_buffer_initialized
;
1244 struct ui
*ui
= current_ui
;
1245 const char *prompt
= prompt_arg
;
1247 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1249 /* The annotation suffix must be non-NULL. */
1250 if (annotation_suffix
== NULL
)
1251 annotation_suffix
= "";
1253 if (from_tty
&& annotation_level
> 1)
1258 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1259 + strlen (annotation_suffix
) + 40);
1261 local_prompt
[0] = '\0';
1263 strcpy (local_prompt
, prompt
);
1264 strcat (local_prompt
, "\n\032\032");
1265 strcat (local_prompt
, annotation_suffix
);
1266 strcat (local_prompt
, "\n");
1268 prompt
= local_prompt
;
1271 if (!cmd_line_buffer_initialized
)
1273 buffer_init (&cmd_line_buffer
);
1274 cmd_line_buffer_initialized
= 1;
1277 /* Starting a new command line. */
1278 cmd_line_buffer
.used_size
= 0;
1282 signal (SIGTSTP
, handle_sigtstp
);
1287 gdb::unique_xmalloc_ptr
<char> rl
;
1289 /* Make sure that all output has been output. Some machines may
1290 let you get away with leaving out some of the gdb_flush, but
1293 gdb_flush (gdb_stdout
);
1294 gdb_flush (gdb_stderr
);
1296 if (!source_file_name
.empty ())
1297 ++source_line_number
;
1299 if (from_tty
&& annotation_level
> 1)
1301 puts_unfiltered ("\n\032\032pre-");
1302 puts_unfiltered (annotation_suffix
);
1303 puts_unfiltered ("\n");
1306 /* Don't use fancy stuff if not talking to stdin. */
1307 if (deprecated_readline_hook
1309 && input_interactive_p (current_ui
))
1311 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1313 else if (command_editing_p
1315 && input_interactive_p (current_ui
))
1317 rl
.reset (gdb_readline_wrapper (prompt
));
1321 rl
.reset (gdb_readline_no_editing (prompt
));
1324 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1325 0, annotation_suffix
);
1326 if (cmd
== (char *) EOF
)
1334 /* Got partial input. I.e., got a line that ends with a
1335 continuation character (backslash). Suppress printing the
1342 signal (SIGTSTP
, SIG_DFL
);
1350 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1352 /* From GNU coding standards, first line is meant to be easy for a
1353 program to parse, and is just canonical program name and version
1354 number, which starts after last space. */
1356 ui_file_style style
;
1359 ui_file_style nstyle
= { ui_file_style::MAGENTA
, ui_file_style::NONE
,
1360 ui_file_style::BOLD
};
1363 fprintf_styled (stream
, style
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1365 /* Second line is a copyright notice. */
1367 fprintf_filtered (stream
,
1368 "Copyright (C) 2019 Free Software Foundation, Inc.\n");
1370 /* Following the copyright is a brief statement that the program is
1371 free software, that users are free to copy and change it on
1372 certain conditions, that it is covered by the GNU GPL, and that
1373 there is no warranty. */
1375 fprintf_filtered (stream
, "\
1376 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1377 \nThis is free software: you are free to change and redistribute it.\n\
1378 There is NO WARRANTY, to the extent permitted by law.");
1383 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1384 "\"show warranty\" for details.\n"));
1386 /* After the required info we print the configuration information. */
1388 fprintf_filtered (stream
, "This GDB was configured as \"");
1389 if (strcmp (host_name
, target_name
) != 0)
1391 fprintf_filtered (stream
, "--host=%s --target=%s",
1392 host_name
, target_name
);
1396 fprintf_filtered (stream
, "%s", host_name
);
1398 fprintf_filtered (stream
, "\".\n");
1400 fprintf_filtered (stream
, _("Type \"show configuration\" "
1401 "for configuration details.\n"));
1403 if (REPORT_BUGS_TO
[0])
1405 fprintf_filtered (stream
,
1406 _("For bug reporting instructions, please see:\n"));
1407 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1409 fprintf_filtered (stream
,
1410 _("Find the GDB manual and other documentation \
1411 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1412 fprintf_filtered (stream
, "\n\n");
1413 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1414 fprintf_filtered (stream
,
1415 _("Type \"apropos word\" to search for commands \
1416 related to \"word\"."));
1419 /* Print the details of GDB build-time configuration. */
1421 print_gdb_configuration (struct ui_file
*stream
)
1423 fprintf_filtered (stream
, _("\
1424 This GDB was configured as follows:\n\
1425 configure --host=%s --target=%s\n\
1426 "), host_name
, target_name
);
1427 fprintf_filtered (stream
, _("\
1428 --with-auto-load-dir=%s\n\
1429 --with-auto-load-safe-path=%s\n\
1430 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1432 fprintf_filtered (stream
, _("\
1436 fprintf_filtered (stream
, _("\
1441 fprintf_filtered (stream
, _("\
1442 --with-gdb-datadir=%s%s\n\
1443 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1445 fprintf_filtered (stream
, _("\
1446 --with-iconv-bin=%s%s\n\
1447 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1449 if (JIT_READER_DIR
[0])
1450 fprintf_filtered (stream
, _("\
1451 --with-jit-reader-dir=%s%s\n\
1452 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1453 #if HAVE_LIBUNWIND_IA64_H
1454 fprintf_filtered (stream
, _("\
1455 --with-libunwind-ia64\n\
1458 fprintf_filtered (stream
, _("\
1459 --without-libunwind-ia64\n\
1463 fprintf_filtered (stream
, _("\
1467 fprintf_filtered (stream
, _("\
1471 #if HAVE_LIBBABELTRACE
1472 fprintf_filtered (stream
, _("\
1473 --with-babeltrace\n\
1476 fprintf_filtered (stream
, _("\
1477 --without-babeltrace\n\
1481 fprintf_filtered (stream
, _("\
1485 fprintf_filtered (stream
, _("\
1486 --without-intel-pt\n\
1490 fprintf_filtered (stream
, _("\
1494 fprintf_filtered (stream
, _("\
1498 #ifdef WITH_PYTHON_PATH
1499 fprintf_filtered (stream
, _("\
1500 --with-python=%s%s\n\
1501 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1503 fprintf_filtered (stream
, _("\
1508 fprintf_filtered (stream
, _("\
1512 fprintf_filtered (stream
, _("\
1516 #if HAVE_SOURCE_HIGHLIGHT
1517 fprintf_filtered (stream
, _("\
1518 --enable-source-highlight\n\
1521 fprintf_filtered (stream
, _("\
1522 --disable-source-highlight\n\
1526 fprintf_filtered (stream
, _("\
1527 --with-relocated-sources=%s\n\
1531 fprintf_filtered (stream
, _("\
1532 --with-separate-debug-dir=%s%s\n\
1533 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1534 if (TARGET_SYSTEM_ROOT
[0])
1535 fprintf_filtered (stream
, _("\
1536 --with-sysroot=%s%s\n\
1537 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1538 if (SYSTEM_GDBINIT
[0])
1539 fprintf_filtered (stream
, _("\
1540 --with-system-gdbinit=%s%s\n\
1541 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1542 if (SYSTEM_GDBINIT_DIR
[0])
1543 fprintf_filtered (stream
, _("\
1544 --with-system-gdbinit-dir=%s%s\n\
1545 "), SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
? " (relocatable)" : "");
1546 /* We assume "relocatable" will be printed at least once, thus we always
1547 print this text. It's a reasonably safe assumption for now. */
1548 fprintf_filtered (stream
, _("\n\
1549 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1550 tree, and GDB will still find it.)\n\
1555 /* The current top level prompt, settable with "set prompt", and/or
1556 with the python `gdb.prompt_hook' hook. */
1557 static char *top_prompt
;
1559 /* Access method for the GDB prompt string. */
1567 /* Set method for the GDB prompt string. */
1570 set_prompt (const char *s
)
1572 char *p
= xstrdup (s
);
1584 /* Callback for iterate_over_inferiors. Kills or detaches the given
1585 inferior, depending on how we originally gained control of it. */
1588 kill_or_detach (struct inferior
*inf
, void *args
)
1590 struct qt_args
*qt
= (struct qt_args
*) args
;
1595 thread_info
*thread
= any_thread_of_inferior (inf
);
1598 switch_to_thread (thread
);
1600 /* Leave core files alone. */
1601 if (target_has_execution
)
1603 if (inf
->attach_flag
)
1604 target_detach (inf
, qt
->from_tty
);
1613 /* Callback for iterate_over_inferiors. Prints info about what GDB
1614 will do to each inferior on a "quit". ARG points to a struct
1615 ui_out where output is to be collected. */
1618 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1620 struct ui_file
*stb
= (struct ui_file
*) arg
;
1625 if (inf
->attach_flag
)
1626 fprintf_filtered (stb
,
1627 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1628 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1630 fprintf_filtered (stb
,
1631 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1632 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1637 /* If necessary, make the user confirm that we should quit. Return
1638 non-zero if we should quit, zero if we shouldn't. */
1643 /* Don't even ask if we're only debugging a core file inferior. */
1644 if (!have_live_inferiors ())
1647 /* Build the query string as a single string. */
1650 stb
.puts (_("A debugging session is active.\n\n"));
1651 iterate_over_inferiors (print_inferior_quit_action
, &stb
);
1652 stb
.puts (_("\nQuit anyway? "));
1654 return query ("%s", stb
.c_str ());
1657 /* Prepare to exit GDB cleanly by undoing any changes made to the
1658 terminal so that we leave the terminal in the state we acquired it. */
1661 undo_terminal_modifications_before_exit (void)
1663 struct ui
*saved_top_level
= current_ui
;
1665 target_terminal::ours ();
1667 current_ui
= main_ui
;
1672 gdb_disable_readline ();
1674 current_ui
= saved_top_level
;
1678 /* Quit without asking for confirmation. */
1681 quit_force (int *exit_arg
, int from_tty
)
1686 undo_terminal_modifications_before_exit ();
1688 /* An optional expression may be used to cause gdb to terminate with the
1689 value of that expression. */
1691 exit_code
= *exit_arg
;
1692 else if (return_child_result
)
1693 exit_code
= return_child_result_value
;
1695 qt
.from_tty
= from_tty
;
1697 /* We want to handle any quit errors and exit regardless. */
1699 /* Get out of tfind mode, and kill or detach all inferiors. */
1702 disconnect_tracing ();
1703 iterate_over_inferiors (kill_or_detach
, &qt
);
1705 catch (const gdb_exception
&ex
)
1707 exception_print (gdb_stderr
, ex
);
1710 /* Give all pushed targets a chance to do minimal cleanup, and pop
1716 catch (const gdb_exception
&ex
)
1718 exception_print (gdb_stderr
, ex
);
1721 /* Save the history information if it is appropriate to do so. */
1724 if (write_history_p
&& history_filename
)
1729 /* History is currently shared between all UIs. If there's
1730 any UI with a terminal, save history. */
1733 if (input_interactive_p (ui
))
1741 gdb_safe_append_history ();
1744 catch (const gdb_exception
&ex
)
1746 exception_print (gdb_stderr
, ex
);
1749 /* Destroy any values currently allocated now instead of leaving it
1750 to global destructors, because that may be too late. For
1751 example, the destructors of xmethod values call into the Python
1752 runtime, which is finalized via a final cleanup. */
1755 /* Do any final cleanups before exiting. */
1758 do_final_cleanups ();
1760 catch (const gdb_exception
&ex
)
1762 exception_print (gdb_stderr
, ex
);
1768 /* The value of the "interactive-mode" setting. */
1769 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1771 /* Implement the "show interactive-mode" option. */
1774 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1775 struct cmd_list_element
*c
,
1778 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1779 fprintf_filtered (file
, "Debugger's interactive mode "
1780 "is %s (currently %s).\n",
1781 value
, input_interactive_p (current_ui
) ? "on" : "off");
1783 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1786 /* Returns whether GDB is running on an interactive terminal. */
1789 input_interactive_p (struct ui
*ui
)
1794 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1795 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1797 return ui
->input_interactive_p
;
1801 dont_repeat_command (const char *ignored
, int from_tty
)
1803 /* Can't call dont_repeat here because we're not necessarily reading
1805 *saved_command_line
= 0;
1808 /* Functions to manipulate command line editing control variables. */
1810 /* Number of commands to print in each call to show_commands. */
1811 #define Hist_print 10
1813 show_commands (const char *args
, int from_tty
)
1815 /* Index for history commands. Relative to history_base. */
1818 /* Number of the history entry which we are planning to display next.
1819 Relative to history_base. */
1822 /* Print out some of the commands from the command history. */
1826 if (args
[0] == '+' && args
[1] == '\0')
1827 /* "info editing +" should print from the stored position. */
1830 /* "info editing <exp>" should print around command number <exp>. */
1831 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1833 /* "show commands" means print the last Hist_print commands. */
1836 num
= history_length
- Hist_print
;
1842 /* If there are at least Hist_print commands, we want to display the last
1843 Hist_print rather than, say, the last 6. */
1844 if (history_length
- num
< Hist_print
)
1846 num
= history_length
- Hist_print
;
1852 offset
< num
+ Hist_print
&& offset
< history_length
;
1855 printf_filtered ("%5d %s\n", history_base
+ offset
,
1856 (history_get (history_base
+ offset
))->line
);
1859 /* The next command we want to display is the next one that we haven't
1863 /* If the user repeats this command with return, it should do what
1864 "show commands +" does. This is unnecessary if arg is null,
1865 because "show commands +" is not useful after "show commands". */
1866 if (from_tty
&& args
)
1867 set_repeat_arguments ("+");
1870 /* Update the size of our command history file to HISTORY_SIZE.
1872 A HISTORY_SIZE of -1 stands for unlimited. */
1875 set_readline_history_size (int history_size
)
1877 gdb_assert (history_size
>= -1);
1879 if (history_size
== -1)
1880 unstifle_history ();
1882 stifle_history (history_size
);
1885 /* Called by do_setshow_command. */
1887 set_history_size_command (const char *args
,
1888 int from_tty
, struct cmd_list_element
*c
)
1890 set_readline_history_size (history_size_setshow_var
);
1894 set_history (const char *args
, int from_tty
)
1896 printf_unfiltered (_("\"set history\" must be followed "
1897 "by the name of a history subcommand.\n"));
1898 help_list (sethistlist
, "set history ", all_commands
, gdb_stdout
);
1902 show_history (const char *args
, int from_tty
)
1904 cmd_show_list (showhistlist
, from_tty
, "");
1907 bool info_verbose
= false; /* Default verbose msgs off. */
1909 /* Called by do_set_command. An elaborate joke. */
1911 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1913 const char *cmdname
= "verbose";
1914 struct cmd_list_element
*showcmd
;
1916 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1917 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1919 if (c
->doc
&& c
->doc_allocated
)
1920 xfree ((char *) c
->doc
);
1921 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1922 xfree ((char *) showcmd
->doc
);
1925 c
->doc
= _("Set verbose printing of informational messages.");
1926 showcmd
->doc
= _("Show verbose printing of informational messages.");
1930 c
->doc
= _("Set verbosity.");
1931 showcmd
->doc
= _("Show verbosity.");
1933 c
->doc_allocated
= 0;
1934 showcmd
->doc_allocated
= 0;
1937 /* Init the history buffer. Note that we are called after the init file(s)
1938 have been read so that the user can change the history file via his
1939 .gdbinit file (for instance). The GDBHISTFILE environment variable
1940 overrides all of this. */
1947 tmpenv
= getenv ("GDBHISTSIZE");
1954 tmpenv
= skip_spaces (tmpenv
);
1956 var
= strtol (tmpenv
, &endptr
, 10);
1957 saved_errno
= errno
;
1958 endptr
= skip_spaces (endptr
);
1960 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1961 empty string, a negative number or a huge positive number (larger than
1962 INT_MAX) then set the history size to unlimited. Otherwise set our
1963 history size to the number we have read. This behavior is consistent
1964 with how bash handles HISTSIZE. */
1965 if (*endptr
!= '\0')
1967 else if (*tmpenv
== '\0'
1970 /* On targets where INT_MAX == LONG_MAX, we have to look at
1971 errno after calling strtol to distinguish between a value that
1972 is exactly INT_MAX and an overflowing value that was clamped
1974 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
1975 history_size_setshow_var
= -1;
1977 history_size_setshow_var
= var
;
1980 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1982 if (history_size_setshow_var
== -2)
1983 history_size_setshow_var
= 256;
1985 set_readline_history_size (history_size_setshow_var
);
1987 tmpenv
= getenv ("GDBHISTFILE");
1989 history_filename
= xstrdup (tmpenv
);
1990 else if (!history_filename
)
1992 /* We include the current directory so that if the user changes
1993 directories the file written will be the same as the one
1996 /* No leading dots in file names are allowed on MSDOS. */
1997 history_filename
= concat (current_directory
, "/_gdb_history",
2000 history_filename
= concat (current_directory
, "/.gdb_history",
2004 read_history (history_filename
);
2008 show_prompt (struct ui_file
*file
, int from_tty
,
2009 struct cmd_list_element
*c
, const char *value
)
2011 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
2014 /* "set editing" command. */
2017 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2019 change_line_handler (set_editing_cmd_var
);
2020 /* Update the control variable so that MI's =cmd-param-changed event
2021 shows the correct value. */
2022 set_editing_cmd_var
= current_ui
->command_editing
;
2026 show_editing (struct ui_file
*file
, int from_tty
,
2027 struct cmd_list_element
*c
, const char *value
)
2029 fprintf_filtered (file
, _("Editing of command lines as "
2030 "they are typed is %s.\n"),
2031 current_ui
->command_editing
? _("on") : _("off"));
2035 show_annotation_level (struct ui_file
*file
, int from_tty
,
2036 struct cmd_list_element
*c
, const char *value
)
2038 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2042 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2043 struct cmd_list_element
*c
, const char *value
)
2045 fprintf_filtered (file
, _("Notification of completion for "
2046 "asynchronous execution commands is %s.\n"),
2050 /* New values of the "data-directory" parameter are staged here. */
2051 static char *staged_gdb_datadir
;
2053 /* "set" command for the gdb_datadir configuration variable. */
2056 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2058 set_gdb_data_directory (staged_gdb_datadir
);
2059 gdb::observers::gdb_datadir_changed
.notify ();
2062 /* "show" command for the gdb_datadir configuration variable. */
2065 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2066 struct cmd_list_element
*c
, const char *value
)
2068 fprintf_filtered (file
, _("GDB's data directory is \"%s\".\n"),
2069 gdb_datadir
.c_str ());
2073 set_history_filename (const char *args
,
2074 int from_tty
, struct cmd_list_element
*c
)
2076 /* We include the current directory so that if the user changes
2077 directories the file written will be the same as the one
2079 if (!IS_ABSOLUTE_PATH (history_filename
))
2080 history_filename
= reconcat (history_filename
, current_directory
, "/",
2081 history_filename
, (char *) NULL
);
2085 init_gdb_version_vars (void)
2087 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2088 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2089 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2090 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2091 set_internalvar_integer (major_version_var
, vmajor
);
2092 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2098 struct cmd_list_element
*c
;
2100 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2101 the DEFAULT_PROMPT is. */
2102 set_prompt (DEFAULT_PROMPT
);
2104 /* Set the important stuff up for command editing. */
2105 command_editing_p
= 1;
2106 history_expansion_p
= 0;
2107 write_history_p
= 0;
2109 /* Setup important stuff for command line editing. */
2110 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2111 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2112 set_rl_completer_word_break_characters (default_word_break_characters ());
2113 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2114 rl_completion_display_matches_hook
= cli_display_match_list
;
2115 rl_readline_name
= "gdb";
2116 rl_terminal_name
= getenv ("TERM");
2118 /* The name for this defun comes from Bash, where it originated.
2119 15 is Control-o, the same binding this function has in Bash. */
2120 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2122 add_setshow_string_cmd ("prompt", class_support
,
2124 _("Set gdb's prompt."),
2125 _("Show gdb's prompt."),
2128 &setlist
, &showlist
);
2130 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2131 Don't repeat this command.\nPrimarily \
2132 used inside of user-defined commands that should not be repeated when\n\
2135 add_setshow_boolean_cmd ("editing", class_support
,
2136 &set_editing_cmd_var
, _("\
2137 Set editing of command lines as they are typed."), _("\
2138 Show editing of command lines as they are typed."), _("\
2139 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2140 Without an argument, command line editing is enabled. To edit, use\n\
2141 EMACS-like or VI-like commands like control-P or ESC."),
2144 &setlist
, &showlist
);
2146 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2147 Set saving of the history record on exit."), _("\
2148 Show saving of the history record on exit."), _("\
2149 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2150 Without an argument, saving is enabled."),
2152 show_write_history_p
,
2153 &sethistlist
, &showhistlist
);
2155 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2156 &history_size_setshow_var
, _("\
2157 Set the size of the command history."), _("\
2158 Show the size of the command history."), _("\
2159 This is the number of previous commands to keep a record of.\n\
2160 If set to \"unlimited\", the number of commands kept in the history\n\
2161 list is unlimited. This defaults to the value of the environment\n\
2162 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2163 set_history_size_command
,
2165 &sethistlist
, &showhistlist
);
2167 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2168 &history_remove_duplicates
, _("\
2169 Set how far back in history to look for and remove duplicate entries."), _("\
2170 Show how far back in history to look for and remove duplicate entries."), _("\
2171 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2172 and remove the first history entry that is a duplicate of the most recent\n\
2173 entry, each time a new history entry is added.\n\
2174 If set to \"unlimited\", this lookbehind is unbounded.\n\
2175 Only history entries added during this session are considered for removal.\n\
2176 If set to 0, removal of duplicate history entries is disabled.\n\
2177 By default this option is set to 0."),
2179 show_history_remove_duplicates
,
2180 &sethistlist
, &showhistlist
);
2182 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
2183 Set the filename in which to record the command history."), _("\
2184 Show the filename in which to record the command history."), _("\
2185 (the list of previous commands of which a record is kept)."),
2186 set_history_filename
,
2187 show_history_filename
,
2188 &sethistlist
, &showhistlist
);
2190 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2191 Set whether to confirm potentially dangerous operations."), _("\
2192 Show whether to confirm potentially dangerous operations."), NULL
,
2195 &setlist
, &showlist
);
2197 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2198 Set annotation_level."), _("\
2199 Show annotation_level."), _("\
2200 0 == normal; 1 == fullname (for use when running under emacs)\n\
2201 2 == output annotated suitably for use by programs that control GDB."),
2203 show_annotation_level
,
2204 &setlist
, &showlist
);
2206 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2207 &exec_done_display_p
, _("\
2208 Set notification of completion for asynchronous execution commands."), _("\
2209 Show notification of completion for asynchronous execution commands."), _("\
2210 Use \"on\" to enable the notification, and \"off\" to disable it."),
2212 show_exec_done_display_p
,
2213 &setlist
, &showlist
);
2215 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2216 &staged_gdb_datadir
, _("Set GDB's data directory."),
2217 _("Show GDB's data directory."),
2219 When set, GDB uses the specified path to search for data files."),
2220 set_gdb_datadir
, show_gdb_datadir
,
2224 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2225 &interactive_mode
, _("\
2226 Set whether GDB's standard input is a terminal."), _("\
2227 Show whether GDB's standard input is a terminal."), _("\
2228 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2229 means that GDB should wait for the user to answer queries associated to\n\
2230 commands entered at the command prompt. If off, GDB assumes that standard\n\
2231 input is not a terminal, and uses the default answer to all queries.\n\
2232 If auto (the default), determine which mode to use based on the standard\n\
2235 show_interactive_mode
,
2236 &setlist
, &showlist
);
2238 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2240 Usage: new-ui INTERPRETER TTY\n\
2241 The first argument is the name of the interpreter to run.\n\
2242 The second argument is the terminal the UI runs on."), &cmdlist
);
2243 set_cmd_completer (c
, interpreter_completer
);
2247 gdb_init (char *argv0
)
2249 saved_command_line
= xstrdup ("");
2250 previous_saved_command_line
= xstrdup ("");
2252 if (pre_init_ui_hook
)
2253 pre_init_ui_hook ();
2255 /* Run the init function of each source file. */
2258 /* Make sure we return to the original directory upon exit, come
2259 what may, since the OS doesn't do that for us. */
2260 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2263 init_cmd_lists (); /* This needs to be done first. */
2264 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2268 /* Here is where we call all the _initialize_foo routines. */
2269 initialize_all_files ();
2271 /* This creates the current_program_space. Do this after all the
2272 _initialize_foo routines have had a chance to install their
2273 per-sspace data keys. Also do this before
2274 initialize_current_architecture is called, because it accesses
2275 exec_bfd of the current program space. */
2276 initialize_progspace ();
2277 initialize_inferiors ();
2278 initialize_current_architecture ();
2279 init_main (); /* But that omits this file! Do it now. */
2281 initialize_stdin_serial ();
2283 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2285 set_initial_gdb_ttystate ();
2287 async_init_signals ();
2289 /* We need a default language for parsing expressions, so simple
2290 things like "set width 0" won't fail if no language is explicitly
2291 set in a config file or implicitly set by reading an executable
2293 set_language (language_c
);
2294 expected_language
= current_language
; /* Don't warn about the change. */
2296 /* Python initialization, for example, can require various commands to be
2297 installed. For example "info pretty-printer" needs the "info"
2298 prefix to be installed. Keep things simple and just do final
2299 script initialization here. */
2300 finish_ext_lang_initialization ();
2302 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2303 init_gdb_version_vars ();