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 overriden in some configs. */
91 #ifndef DEFAULT_PROMPT
92 #define DEFAULT_PROMPT "(gdb) "
95 /* Generate a function that exports a pointer to a field of the
98 #define gen_ret_current_ui_field_ptr(type, name) \
100 current_ui_## name ## _ptr (void) \
102 return ¤t_ui->m_ ## name; \
105 gen_ret_current_ui_field_ptr (struct ui_file
*, gdb_stdout
)
106 gen_ret_current_ui_field_ptr (struct ui_file
*, gdb_stdin
)
107 gen_ret_current_ui_field_ptr (struct ui_file
*, gdb_stderr
)
108 gen_ret_current_ui_field_ptr (struct ui_file
*, gdb_stdlog
)
109 gen_ret_current_ui_field_ptr (struct ui_out
*, current_uiout
)
111 int inhibit_gdbinit
= 0;
113 extern char lang_frame_mismatch_warn
[]; /* language.c */
115 /* Flag for whether we want to confirm potentially dangerous
116 operations. Default is yes. */
121 show_confirm (struct ui_file
*file
, int from_tty
,
122 struct cmd_list_element
*c
, const char *value
)
124 fprintf_filtered (file
, _("Whether to confirm potentially "
125 "dangerous operations is %s.\n"),
129 /* Current working directory. */
131 char *current_directory
;
133 /* The last command line executed on the console. Used for command
134 repetitions when the user enters an empty line. */
136 static char *saved_command_line
;
138 /* If not NULL, the arguments that should be passed if
139 saved_command_line is repeated. */
141 static const char *repeat_arguments
;
143 /* The previous last command line executed on the console. Used for command
144 repetitions when a command wants to relaunch the previously launched
145 command. We need this as when a command is running, saved_command_line
146 already contains the line of the currently executing command. */
148 char *previous_saved_command_line
;
150 /* If not NULL, the arguments that should be passed if the
151 previous_saved_command_line is repeated. */
153 static const char *previous_repeat_arguments
;
155 /* Nonzero if the current command is modified by "server ". This
156 affects things like recording into the command history, commands
157 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
158 whatever) can issue its own commands and also send along commands
159 from the user, and have the user not notice that the user interface
160 is issuing commands too. */
163 /* Timeout limit for response from target. */
165 /* The default value has been changed many times over the years. It
166 was originally 5 seconds. But that was thought to be a long time
167 to sit and wait, so it was changed to 2 seconds. That was thought
168 to be plenty unless the connection was going through some terminal
169 server or multiplexer or other form of hairy serial connection.
171 In mid-1996, remote_timeout was moved from remote.c to top.c and
172 it began being used in other remote-* targets. It appears that the
173 default was changed to 20 seconds at that time, perhaps because the
174 Renesas E7000 ICE didn't always respond in a timely manner.
176 But if 5 seconds is a long time to sit and wait for retransmissions,
177 20 seconds is far worse. This demonstrates the difficulty of using
178 a single variable for all protocol timeouts.
180 As remote.c is used much more than remote-e7000.c, it was changed
181 back to 2 seconds in 1999. */
183 int remote_timeout
= 2;
185 /* Non-zero tells remote* modules to output debugging info. */
187 int remote_debug
= 0;
189 /* Sbrk location on entry to main. Used for statistics only. */
190 #ifdef HAVE_USEFUL_SBRK
194 /* Hooks for alternate command interfaces. */
196 /* This hook is called from within gdb's many mini-event loops which
197 could steal control from a real user interface's event loop. It
198 returns non-zero if the user is requesting a detach, zero
201 int (*deprecated_ui_loop_hook
) (int);
204 /* Called from print_frame_info to list the line we stopped in. */
206 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
210 /* Replaces most of query. */
212 int (*deprecated_query_hook
) (const char *, va_list);
214 /* Replaces most of warning. */
216 void (*deprecated_warning_hook
) (const char *, va_list);
218 /* These three functions support getting lines of text from the user.
219 They are used in sequence. First deprecated_readline_begin_hook is
220 called with a text string that might be (for example) a message for
221 the user to type in a sequence of commands to be executed at a
222 breakpoint. If this function calls back to a GUI, it might take
223 this opportunity to pop up a text interaction window with this
224 message. Next, deprecated_readline_hook is called with a prompt
225 that is emitted prior to collecting the user input. It can be
226 called multiple times. Finally, deprecated_readline_end_hook is
227 called to notify the GUI that we are done with the interaction
228 window and it can close it. */
230 void (*deprecated_readline_begin_hook
) (const char *, ...);
231 char *(*deprecated_readline_hook
) (const char *);
232 void (*deprecated_readline_end_hook
) (void);
234 /* Called as appropriate to notify the interface that we have attached
235 to or detached from an already running process. */
237 void (*deprecated_attach_hook
) (void);
238 void (*deprecated_detach_hook
) (void);
240 /* Called when going to wait for the target. Usually allows the GUI
241 to run while waiting for target events. */
243 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
244 struct target_waitstatus
*status
,
247 /* Used by UI as a wrapper around command execution. May do various
248 things like enabling/disabling buttons, etc... */
250 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
251 const char *cmd
, int from_tty
);
253 /* Called when the current thread changes. Argument is thread id. */
255 void (*deprecated_context_hook
) (int id
);
257 /* The highest UI number ever assigned. */
258 static int highest_ui_num
;
262 ui::ui (FILE *instream_
, FILE *outstream_
, FILE *errstream_
)
264 num (++highest_ui_num
),
265 call_readline (nullptr),
266 input_handler (nullptr),
268 interp_info (nullptr),
270 secondary_prompt_depth (0),
271 stdin_stream (instream_
),
272 instream (instream_
),
273 outstream (outstream_
),
274 errstream (errstream_
),
275 input_fd (fileno (instream
)),
276 input_interactive_p (ISATTY (instream
)),
277 prompt_state (PROMPT_NEEDED
),
278 m_gdb_stdout (new stdio_file (outstream
)),
279 m_gdb_stdin (new stdio_file (instream
)),
280 m_gdb_stderr (new stderr_file (errstream
)),
281 m_gdb_stdlog (m_gdb_stderr
),
282 m_current_uiout (nullptr)
284 buffer_init (&line_buffer
);
292 for (last
= ui_list
; last
->next
!= NULL
; last
= last
->next
)
300 struct ui
*ui
, *uiprev
;
304 for (ui
= ui_list
; ui
!= NULL
; uiprev
= ui
, ui
= ui
->next
)
308 gdb_assert (ui
!= NULL
);
320 /* Open file named NAME for read/write, making sure not to make it the
321 controlling terminal. */
324 open_terminal_stream (const char *name
)
328 fd
= gdb_open_cloexec (name
, O_RDWR
| O_NOCTTY
, 0);
330 perror_with_name (_("opening terminal failed"));
332 return gdb_file_up (fdopen (fd
, "w+"));
335 /* Implementation of the "new-ui" command. */
338 new_ui_command (const char *args
, int from_tty
)
340 gdb_file_up stream
[3];
343 const char *interpreter_name
;
344 const char *tty_name
;
348 gdb_argv
argv (args
);
349 argc
= argv
.count ();
352 error (_("Usage: new-ui INTERPRETER TTY"));
354 interpreter_name
= argv
[0];
358 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
360 /* Open specified terminal, once for each of
361 stdin/stdout/stderr. */
362 for (i
= 0; i
< 3; i
++)
363 stream
[i
] = open_terminal_stream (tty_name
);
365 std::unique_ptr
<ui
> ui
366 (new struct ui (stream
[0].get (), stream
[1].get (), stream
[2].get ()));
370 current_ui
= ui
.get ();
372 set_top_level_interpreter (interpreter_name
);
374 interp_pre_command_loop (top_level_interpreter ());
376 /* Make sure the files are not closed. */
377 stream
[0].release ();
378 stream
[1].release ();
379 stream
[2].release ();
384 printf_unfiltered ("New UI allocated\n");
387 /* Handler for SIGHUP. */
390 /* NOTE 1999-04-29: This function will be static again, once we modify
391 gdb to use the event loop as the default command loop and we merge
392 event-top.c into this file, top.c. */
396 /* Stop asking user for confirmation --- we're exiting. This
397 prevents asking the user dumb questions. */
399 quit_command ((char *) 0, 0);
401 #endif /* defined SIGHUP */
403 /* Line number we are currently in, in a file which is being sourced. */
404 /* NOTE 1999-04-29: This variable will be static again, once we modify
405 gdb to use the event loop as the default command loop and we merge
406 event-top.c into this file, top.c. */
407 /* static */ int source_line_number
;
409 /* Name of the file we are sourcing. */
410 /* NOTE 1999-04-29: This variable will be static again, once we modify
411 gdb to use the event loop as the default command loop and we merge
412 event-top.c into this file, top.c. */
413 /* static */ std::string source_file_name
;
415 /* Read commands from STREAM. */
417 read_command_file (FILE *stream
)
419 struct ui
*ui
= current_ui
;
421 scoped_restore save_instream
422 = make_scoped_restore (&ui
->instream
, stream
);
424 /* Read commands from `instream' and execute them until end of file
425 or error reading instream. */
427 while (ui
->instream
!= NULL
&& !feof (ui
->instream
))
431 /* Get a command-line. This calls the readline package. */
432 command
= command_line_input (NULL
, NULL
);
435 command_handler (command
);
439 void (*pre_init_ui_hook
) (void);
443 do_chdir_cleanup (void *old_dir
)
445 chdir ((const char *) old_dir
);
451 prepare_execute_command ()
453 /* With multiple threads running while the one we're examining is
454 stopped, the dcache can get stale without us being able to detect
455 it. For the duration of the command, though, use the dcache to
456 help things like backtrace. */
458 target_dcache_invalidate ();
460 return scoped_value_mark ();
463 /* Tell the user if the language has changed (except first time) after
464 executing a command. */
467 check_frame_language_change (void)
469 static int warned
= 0;
470 struct frame_info
*frame
;
472 /* First make sure that a new frame has been selected, in case the
473 command or the hooks changed the program state. */
474 frame
= deprecated_safe_get_selected_frame ();
475 if (current_language
!= expected_language
)
477 if (language_mode
== language_mode_auto
&& info_verbose
)
479 language_info (1); /* Print what changed. */
484 /* Warn the user if the working language does not match the language
485 of the current frame. Only warn the user if we are actually
486 running the program, i.e. there is a stack. */
487 /* FIXME: This should be cacheing the frame and only running when
488 the frame changes. */
490 if (has_stack_frames ())
494 flang
= get_frame_language (frame
);
496 && flang
!= language_unknown
497 && flang
!= current_language
->la_language
)
499 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
508 wait_sync_command_done (void)
510 /* Processing events may change the current UI. */
511 scoped_restore save_ui
= make_scoped_restore (¤t_ui
);
512 struct ui
*ui
= current_ui
;
514 while (gdb_do_one_event () >= 0)
515 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
522 maybe_wait_sync_command_done (int was_sync
)
524 /* If the interpreter is in sync mode (we're running a user
525 command's list, running command hooks or similars), and we
526 just ran a synchronous command that started the target, wait
527 for that command to end. */
528 if (!current_ui
->async
530 && current_ui
->prompt_state
== PROMPT_BLOCKED
)
531 wait_sync_command_done ();
537 set_repeat_arguments (const char *args
)
539 repeat_arguments
= args
;
542 /* Execute the line P as a command, in the current user context.
543 Pass FROM_TTY as second argument to the defining function. */
546 execute_command (const char *p
, int from_tty
)
548 struct cmd_list_element
*c
;
550 const char *cmd_start
= p
;
552 auto cleanup_if_error
= make_scope_exit (bpstat_clear_actions
);
553 scoped_value_mark cleanup
= prepare_execute_command ();
555 /* This can happen when command_line_input hits end of file. */
558 cleanup_if_error
.release ();
562 target_log_command (p
);
564 while (*p
== ' ' || *p
== '\t')
570 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
574 /* If trace-commands is set then this will print this command. */
575 print_command_trace ("%s", p
);
577 c
= lookup_cmd (&cmd
, cmdlist
, "", 0, 1);
580 scoped_restore save_repeat_args
581 = make_scoped_restore (&repeat_arguments
, nullptr);
582 const char *args_pointer
= p
;
584 /* Pass null arg rather than an empty one. */
587 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
588 while the is_complete_command(cfunc) test is just plain
589 bogus. They should both be replaced by a test of the form
590 c->strip_trailing_white_space_p. */
591 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
592 can't be replaced with func. This is because it is the
593 cfunc, and not the func, that has the value that the
594 is_complete_command hack is testing for. */
595 /* Clear off trailing whitespace, except for set and complete
597 std::string without_whitespace
;
599 && c
->type
!= set_cmd
600 && !is_complete_command (c
))
602 const char *old_end
= arg
+ strlen (arg
) - 1;
604 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
608 without_whitespace
= std::string (arg
, p
+ 1);
609 arg
= without_whitespace
.c_str ();
613 /* If this command has been pre-hooked, run the hook first. */
614 execute_cmd_pre_hook (c
);
616 if (c
->deprecated_warn_user
)
617 deprecated_cmd_warning (line
);
619 /* c->user_commands would be NULL in the case of a python command. */
620 if (c
->theclass
== class_user
&& c
->user_commands
)
621 execute_user_command (c
, arg
);
622 else if (c
->type
== set_cmd
)
623 do_set_command (arg
, from_tty
, c
);
624 else if (c
->type
== show_cmd
)
625 do_show_command (arg
, from_tty
, c
);
626 else if (!cmd_func_p (c
))
627 error (_("That is not a command, just a help topic."));
628 else if (deprecated_call_command_hook
)
629 deprecated_call_command_hook (c
, arg
, from_tty
);
631 cmd_func (c
, arg
, from_tty
);
633 maybe_wait_sync_command_done (was_sync
);
635 /* If this command has been post-hooked, run the hook last. */
636 execute_cmd_post_hook (c
);
638 if (repeat_arguments
!= NULL
&& cmd_start
== saved_command_line
)
640 gdb_assert (strlen (args_pointer
) >= strlen (repeat_arguments
));
641 strcpy (saved_command_line
+ (args_pointer
- cmd_start
),
646 /* Only perform the frame-language-change check if the command
647 we just finished executing did not resume the inferior's execution.
648 If it did resume the inferior, we will do that check after
649 the inferior stopped. */
650 if (has_stack_frames () && inferior_thread ()->state
!= THREAD_RUNNING
)
651 check_frame_language_change ();
653 cleanup_if_error
.release ();
656 /* Run execute_command for P and FROM_TTY. Sends its output to FILE,
657 do not display it to the screen. BATCH_FLAG will be
658 temporarily set to true. */
661 execute_command_to_ui_file (struct ui_file
*file
, const char *p
, int from_tty
)
663 /* GDB_STDOUT should be better already restored during these
664 restoration callbacks. */
665 set_batch_flag_and_restore_page_info save_page_info
;
667 scoped_restore save_async
= make_scoped_restore (¤t_ui
->async
, 0);
670 current_uiout
->redirect (file
);
671 ui_out_redirect_pop
redirect_popper (current_uiout
);
673 scoped_restore save_stdout
674 = make_scoped_restore (&gdb_stdout
, file
);
675 scoped_restore save_stderr
676 = make_scoped_restore (&gdb_stderr
, file
);
677 scoped_restore save_stdlog
678 = make_scoped_restore (&gdb_stdlog
, file
);
679 scoped_restore save_stdtarg
680 = make_scoped_restore (&gdb_stdtarg
, file
);
681 scoped_restore save_stdtargerr
682 = make_scoped_restore (&gdb_stdtargerr
, file
);
684 execute_command (p
, from_tty
);
688 /* Run execute_command for P and FROM_TTY. Capture its output into the
689 returned string, do not display it to the screen. BATCH_FLAG will be
690 temporarily set to true. */
693 execute_command_to_string (const char *p
, int from_tty
,
696 string_file
str_file (term_out
);
698 execute_command_to_ui_file (&str_file
, p
, from_tty
);
699 return std::move (str_file
.string ());
703 /* When nonzero, cause dont_repeat to do nothing. This should only be
704 set via prevent_dont_repeat. */
706 static int suppress_dont_repeat
= 0;
713 struct ui
*ui
= current_ui
;
715 if (suppress_dont_repeat
|| server_command
)
718 /* If we aren't reading from standard input, we are saving the last
719 thing read from stdin in line and don't want to delete it. Null
720 lines won't repeat here in any case. */
721 if (ui
->instream
== ui
->stdin_stream
)
723 *saved_command_line
= 0;
724 repeat_arguments
= NULL
;
733 /* Do not repeat this command, as this command is a repeating command. */
736 /* We cannot free saved_command_line, as this line is being executed,
737 so swap it with previous_saved_command_line. */
738 std::swap (previous_saved_command_line
, saved_command_line
);
739 std::swap (previous_repeat_arguments
, repeat_arguments
);
741 const char *prev
= skip_spaces (get_saved_command_line ());
743 error (_("No previous command to relaunch"));
749 scoped_restore_tmpl
<int>
750 prevent_dont_repeat (void)
752 return make_scoped_restore (&suppress_dont_repeat
, 1);
758 get_saved_command_line ()
760 return saved_command_line
;
766 save_command_line (const char *cmd
)
768 xfree (previous_saved_command_line
);
769 previous_saved_command_line
= saved_command_line
;
770 previous_repeat_arguments
= repeat_arguments
;
771 saved_command_line
= xstrdup (cmd
);
772 repeat_arguments
= NULL
;
776 /* Read a line from the stream "instream" without command line editing.
778 It prints PROMPT once at the start.
779 Action is compatible with "readline", e.g. space for the result is
780 malloc'd and should be freed by the caller.
782 A NULL return means end of file. */
785 gdb_readline_no_editing (const char *prompt
)
787 struct buffer line_buffer
;
788 struct ui
*ui
= current_ui
;
789 /* Read from stdin if we are executing a user defined command. This
790 is the right thing for prompt_for_continue, at least. */
791 FILE *stream
= ui
->instream
!= NULL
? ui
->instream
: stdin
;
792 int fd
= fileno (stream
);
794 buffer_init (&line_buffer
);
798 /* Don't use a _filtered function here. It causes the assumed
799 character position to be off, since the newline we read from
800 the user is not accounted for. */
801 fputs_unfiltered (prompt
, gdb_stdout
);
802 gdb_flush (gdb_stdout
);
812 /* Wait until at least one byte of data is available. Control-C
813 can interrupt interruptible_select, but not fgetc. */
815 FD_SET (fd
, &readfds
);
816 if (interruptible_select (fd
+ 1, &readfds
, NULL
, NULL
, NULL
) == -1)
820 /* If this was ctrl-c, the QUIT above handles it. */
823 perror_with_name (("select"));
830 if (line_buffer
.used_size
> 0)
831 /* The last line does not end with a newline. Return it, and
832 if we are called again fgetc will still return EOF and
833 we'll return NULL then. */
835 xfree (buffer_finish (&line_buffer
));
841 if (line_buffer
.used_size
> 0
842 && line_buffer
.buffer
[line_buffer
.used_size
- 1] == '\r')
843 line_buffer
.used_size
--;
847 buffer_grow_char (&line_buffer
, c
);
850 buffer_grow_char (&line_buffer
, '\0');
851 return buffer_finish (&line_buffer
);
854 /* Variables which control command line editing and history
855 substitution. These variables are given default values at the end
857 static int command_editing_p
;
859 /* NOTE 1999-04-29: This variable will be static again, once we modify
860 gdb to use the event loop as the default command loop and we merge
861 event-top.c into this file, top.c. */
863 /* static */ int history_expansion_p
;
865 static int write_history_p
;
867 show_write_history_p (struct ui_file
*file
, int from_tty
,
868 struct cmd_list_element
*c
, const char *value
)
870 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
874 /* The variable associated with the "set/show history size"
875 command. The value -1 means unlimited, and -2 means undefined. */
876 static int history_size_setshow_var
= -2;
879 show_history_size (struct ui_file
*file
, int from_tty
,
880 struct cmd_list_element
*c
, const char *value
)
882 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
886 /* Variable associated with the "history remove-duplicates" option.
887 The value -1 means unlimited. */
888 static int history_remove_duplicates
= 0;
891 show_history_remove_duplicates (struct ui_file
*file
, int from_tty
,
892 struct cmd_list_element
*c
, const char *value
)
894 fprintf_filtered (file
,
895 _("The number of history entries to look back at for "
896 "duplicates is %s.\n"),
900 static char *history_filename
;
902 show_history_filename (struct ui_file
*file
, int from_tty
,
903 struct cmd_list_element
*c
, const char *value
)
905 fprintf_filtered (file
, _("The filename in which to record "
906 "the command history is \"%s\".\n"),
910 /* This is like readline(), but it has some gdb-specific behavior.
911 gdb may want readline in both the synchronous and async modes during
912 a single gdb invocation. At the ordinary top-level prompt we might
913 be using the async readline. That means we can't use
914 rl_pre_input_hook, since it doesn't work properly in async mode.
915 However, for a secondary prompt (" >", such as occurs during a
916 `define'), gdb wants a synchronous response.
918 We used to call readline() directly, running it in synchronous
919 mode. But mixing modes this way is not supported, and as of
920 readline 5.x it no longer works; the arrow keys come unbound during
921 the synchronous call. So we make a nested call into the event
922 loop. That's what gdb_readline_wrapper is for. */
924 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
925 rely on gdb_readline_wrapper_result, which might still be NULL if
926 the user types Control-D for EOF. */
927 static int gdb_readline_wrapper_done
;
929 /* The result of the current call to gdb_readline_wrapper, once a newline
931 static char *gdb_readline_wrapper_result
;
933 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
934 to be called after the newline is processed (which will redisplay
935 the prompt). But in gdb_readline_wrapper we will not get a new
936 prompt until the next call, or until we return to the event loop.
937 So we disable this hook around the newline and restore it before we
939 static void (*saved_after_char_processing_hook
) (void);
945 gdb_in_secondary_prompt_p (struct ui
*ui
)
947 return ui
->secondary_prompt_depth
> 0;
951 /* This function is called when readline has seen a complete line of
955 gdb_readline_wrapper_line (gdb::unique_xmalloc_ptr
<char> &&line
)
957 gdb_assert (!gdb_readline_wrapper_done
);
958 gdb_readline_wrapper_result
= line
.release ();
959 gdb_readline_wrapper_done
= 1;
961 /* Prevent operate-and-get-next from acting too early. */
962 saved_after_char_processing_hook
= after_char_processing_hook
;
963 after_char_processing_hook
= NULL
;
965 /* Prevent parts of the prompt from being redisplayed if annotations
966 are enabled, and readline's state getting out of sync. We'll
967 reinstall the callback handler, which puts the terminal in raw
968 mode (or in readline lingo, in prepped state), when we're next
969 ready to process user input, either in display_gdb_prompt, or if
970 we're handling an asynchronous target event and running in the
971 background, just before returning to the event loop to process
972 further input (or more target events). */
973 if (current_ui
->command_editing
)
974 gdb_rl_callback_handler_remove ();
977 class gdb_readline_wrapper_cleanup
980 gdb_readline_wrapper_cleanup ()
981 : m_handler_orig (current_ui
->input_handler
),
982 m_already_prompted_orig (current_ui
->command_editing
983 ? rl_already_prompted
: 0),
984 m_target_is_async_orig (target_is_async_p ()),
985 m_save_ui (¤t_ui
)
987 current_ui
->input_handler
= gdb_readline_wrapper_line
;
988 current_ui
->secondary_prompt_depth
++;
990 if (m_target_is_async_orig
)
994 ~gdb_readline_wrapper_cleanup ()
996 struct ui
*ui
= current_ui
;
998 if (ui
->command_editing
)
999 rl_already_prompted
= m_already_prompted_orig
;
1001 gdb_assert (ui
->input_handler
== gdb_readline_wrapper_line
);
1002 ui
->input_handler
= m_handler_orig
;
1004 /* Don't restore our input handler in readline yet. That would make
1005 readline prep the terminal (putting it in raw mode), while the
1006 line we just read may trigger execution of a command that expects
1007 the terminal in the default cooked/canonical mode, such as e.g.,
1008 running Python's interactive online help utility. See
1009 gdb_readline_wrapper_line for when we'll reinstall it. */
1011 gdb_readline_wrapper_result
= NULL
;
1012 gdb_readline_wrapper_done
= 0;
1013 ui
->secondary_prompt_depth
--;
1014 gdb_assert (ui
->secondary_prompt_depth
>= 0);
1016 after_char_processing_hook
= saved_after_char_processing_hook
;
1017 saved_after_char_processing_hook
= NULL
;
1019 if (m_target_is_async_orig
)
1023 DISABLE_COPY_AND_ASSIGN (gdb_readline_wrapper_cleanup
);
1027 void (*m_handler_orig
) (gdb::unique_xmalloc_ptr
<char> &&);
1028 int m_already_prompted_orig
;
1030 /* Whether the target was async. */
1031 int m_target_is_async_orig
;
1033 /* Processing events may change the current UI. */
1034 scoped_restore_tmpl
<struct ui
*> m_save_ui
;
1038 gdb_readline_wrapper (const char *prompt
)
1040 struct ui
*ui
= current_ui
;
1042 gdb_readline_wrapper_cleanup cleanup
;
1044 /* Display our prompt and prevent double prompt display. Don't pass
1045 down a NULL prompt, since that has special meaning for
1046 display_gdb_prompt -- it indicates a request to print the primary
1047 prompt, while we want a secondary prompt here. */
1048 display_gdb_prompt (prompt
!= NULL
? prompt
: "");
1049 if (ui
->command_editing
)
1050 rl_already_prompted
= 1;
1052 if (after_char_processing_hook
)
1053 (*after_char_processing_hook
) ();
1054 gdb_assert (after_char_processing_hook
== NULL
);
1056 while (gdb_do_one_event () >= 0)
1057 if (gdb_readline_wrapper_done
)
1060 return gdb_readline_wrapper_result
;
1064 /* The current saved history number from operate-and-get-next.
1065 This is -1 if not valid. */
1066 static int operate_saved_history
= -1;
1068 /* This is put on the appropriate hook and helps operate-and-get-next
1071 gdb_rl_operate_and_get_next_completion (void)
1073 int delta
= where_history () - operate_saved_history
;
1075 /* The `key' argument to rl_get_previous_history is ignored. */
1076 rl_get_previous_history (delta
, 0);
1077 operate_saved_history
= -1;
1079 /* readline doesn't automatically update the display for us. */
1082 after_char_processing_hook
= NULL
;
1083 rl_pre_input_hook
= NULL
;
1086 /* This is a gdb-local readline command handler. It accepts the
1087 current command line (like RET does) and, if this command was taken
1088 from the history, arranges for the next command in the history to
1089 appear on the command line when the prompt returns.
1090 We ignore the arguments. */
1092 gdb_rl_operate_and_get_next (int count
, int key
)
1096 /* Use the async hook. */
1097 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
1099 /* Find the current line, and find the next line to use. */
1100 where
= where_history();
1102 if ((history_is_stifled () && (history_length
>= history_max_entries
))
1103 || (where
>= history_length
- 1))
1104 operate_saved_history
= where
;
1106 operate_saved_history
= where
+ 1;
1108 return rl_newline (1, key
);
1111 /* Number of user commands executed during this session. */
1113 static int command_count
= 0;
1115 /* Add the user command COMMAND to the input history list. */
1118 gdb_add_history (const char *command
)
1122 if (history_remove_duplicates
!= 0)
1125 int lookbehind_threshold
;
1127 /* The lookbehind threshold for finding a duplicate history entry is
1128 bounded by command_count because we can't meaningfully delete
1129 history entries that are already stored in the history file since
1130 the history file is appended to. */
1131 if (history_remove_duplicates
== -1
1132 || history_remove_duplicates
> command_count
)
1133 lookbehind_threshold
= command_count
;
1135 lookbehind_threshold
= history_remove_duplicates
;
1138 for (lookbehind
= 0; lookbehind
< lookbehind_threshold
; lookbehind
++)
1140 HIST_ENTRY
*temp
= previous_history ();
1145 if (strcmp (temp
->line
, command
) == 0)
1147 HIST_ENTRY
*prev
= remove_history (where_history ());
1149 free_history_entry (prev
);
1156 add_history (command
);
1159 /* Safely append new history entries to the history file in a corruption-free
1160 way using an intermediate local history file. */
1163 gdb_safe_append_history (void)
1165 int ret
, saved_errno
;
1167 std::string local_history_filename
1168 = string_printf ("%s-gdb%ld~", history_filename
, (long) getpid ());
1170 ret
= rename (history_filename
, local_history_filename
.c_str ());
1171 saved_errno
= errno
;
1172 if (ret
< 0 && saved_errno
!= ENOENT
)
1174 warning (_("Could not rename %s to %s: %s"),
1175 history_filename
, local_history_filename
.c_str (),
1176 safe_strerror (saved_errno
));
1182 /* If the rename failed with ENOENT then either the global history
1183 file never existed in the first place or another GDB process is
1184 currently appending to it (and has thus temporarily renamed it).
1185 Since we can't distinguish between these two cases, we have to
1186 conservatively assume the first case and therefore must write out
1187 (not append) our known history to our local history file and try
1188 to move it back anyway. Otherwise a global history file would
1189 never get created! */
1190 gdb_assert (saved_errno
== ENOENT
);
1191 write_history (local_history_filename
.c_str ());
1195 append_history (command_count
, local_history_filename
.c_str ());
1196 if (history_is_stifled ())
1197 history_truncate_file (local_history_filename
.c_str (),
1198 history_max_entries
);
1201 ret
= rename (local_history_filename
.c_str (), history_filename
);
1202 saved_errno
= errno
;
1203 if (ret
< 0 && saved_errno
!= EEXIST
)
1204 warning (_("Could not rename %s to %s: %s"),
1205 local_history_filename
.c_str (), history_filename
,
1206 safe_strerror (saved_errno
));
1210 /* Read one line from the command input stream `instream' into a local
1211 static buffer. The buffer is made bigger as necessary. Returns
1212 the address of the start of the line.
1214 NULL is returned for end of file.
1216 This routine either uses fancy command line editing or simple input
1217 as the user has requested. */
1220 command_line_input (const char *prompt_arg
, const char *annotation_suffix
)
1222 static struct buffer cmd_line_buffer
;
1223 static int cmd_line_buffer_initialized
;
1224 struct ui
*ui
= current_ui
;
1225 const char *prompt
= prompt_arg
;
1227 int from_tty
= ui
->instream
== ui
->stdin_stream
;
1229 /* The annotation suffix must be non-NULL. */
1230 if (annotation_suffix
== NULL
)
1231 annotation_suffix
= "";
1233 if (from_tty
&& annotation_level
> 1)
1238 = (char *) alloca ((prompt
== NULL
? 0 : strlen (prompt
))
1239 + strlen (annotation_suffix
) + 40);
1241 local_prompt
[0] = '\0';
1243 strcpy (local_prompt
, prompt
);
1244 strcat (local_prompt
, "\n\032\032");
1245 strcat (local_prompt
, annotation_suffix
);
1246 strcat (local_prompt
, "\n");
1248 prompt
= local_prompt
;
1251 if (!cmd_line_buffer_initialized
)
1253 buffer_init (&cmd_line_buffer
);
1254 cmd_line_buffer_initialized
= 1;
1257 /* Starting a new command line. */
1258 cmd_line_buffer
.used_size
= 0;
1262 signal (SIGTSTP
, handle_sigtstp
);
1267 gdb::unique_xmalloc_ptr
<char> rl
;
1269 /* Make sure that all output has been output. Some machines may
1270 let you get away with leaving out some of the gdb_flush, but
1273 gdb_flush (gdb_stdout
);
1274 gdb_flush (gdb_stderr
);
1276 if (!source_file_name
.empty ())
1277 ++source_line_number
;
1279 if (from_tty
&& annotation_level
> 1)
1281 puts_unfiltered ("\n\032\032pre-");
1282 puts_unfiltered (annotation_suffix
);
1283 puts_unfiltered ("\n");
1286 /* Don't use fancy stuff if not talking to stdin. */
1287 if (deprecated_readline_hook
1289 && input_interactive_p (current_ui
))
1291 rl
.reset ((*deprecated_readline_hook
) (prompt
));
1293 else if (command_editing_p
1295 && input_interactive_p (current_ui
))
1297 rl
.reset (gdb_readline_wrapper (prompt
));
1301 rl
.reset (gdb_readline_no_editing (prompt
));
1304 cmd
= handle_line_of_input (&cmd_line_buffer
, rl
.get (),
1305 0, annotation_suffix
);
1306 if (cmd
== (char *) EOF
)
1314 /* Got partial input. I.e., got a line that ends with a
1315 continuation character (backslash). Suppress printing the
1322 signal (SIGTSTP
, SIG_DFL
);
1330 print_gdb_version (struct ui_file
*stream
, bool interactive
)
1332 /* From GNU coding standards, first line is meant to be easy for a
1333 program to parse, and is just canonical program name and version
1334 number, which starts after last space. */
1336 ui_file_style style
;
1339 ui_file_style nstyle
= { ui_file_style::MAGENTA
, ui_file_style::NONE
,
1340 ui_file_style::BOLD
};
1343 fprintf_styled (stream
, style
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1345 /* Second line is a copyright notice. */
1347 fprintf_filtered (stream
,
1348 "Copyright (C) 2019 Free Software Foundation, Inc.\n");
1350 /* Following the copyright is a brief statement that the program is
1351 free software, that users are free to copy and change it on
1352 certain conditions, that it is covered by the GNU GPL, and that
1353 there is no warranty. */
1355 fprintf_filtered (stream
, "\
1356 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1357 \nThis is free software: you are free to change and redistribute it.\n\
1358 There is NO WARRANTY, to the extent permitted by law.");
1363 fprintf_filtered (stream
, ("\nType \"show copying\" and "
1364 "\"show warranty\" for details.\n"));
1366 /* After the required info we print the configuration information. */
1368 fprintf_filtered (stream
, "This GDB was configured as \"");
1369 if (strcmp (host_name
, target_name
) != 0)
1371 fprintf_filtered (stream
, "--host=%s --target=%s",
1372 host_name
, target_name
);
1376 fprintf_filtered (stream
, "%s", host_name
);
1378 fprintf_filtered (stream
, "\".\n");
1380 fprintf_filtered (stream
, _("Type \"show configuration\" "
1381 "for configuration details.\n"));
1383 if (REPORT_BUGS_TO
[0])
1385 fprintf_filtered (stream
,
1386 _("For bug reporting instructions, please see:\n"));
1387 fprintf_filtered (stream
, "%s.\n", REPORT_BUGS_TO
);
1389 fprintf_filtered (stream
,
1390 _("Find the GDB manual and other documentation \
1391 resources online at:\n <http://www.gnu.org/software/gdb/documentation/>."));
1392 fprintf_filtered (stream
, "\n\n");
1393 fprintf_filtered (stream
, _("For help, type \"help\".\n"));
1394 fprintf_filtered (stream
,
1395 _("Type \"apropos word\" to search for commands \
1396 related to \"word\"."));
1399 /* Print the details of GDB build-time configuration. */
1401 print_gdb_configuration (struct ui_file
*stream
)
1403 fprintf_filtered (stream
, _("\
1404 This GDB was configured as follows:\n\
1405 configure --host=%s --target=%s\n\
1406 "), host_name
, target_name
);
1407 fprintf_filtered (stream
, _("\
1408 --with-auto-load-dir=%s\n\
1409 --with-auto-load-safe-path=%s\n\
1410 "), AUTO_LOAD_DIR
, AUTO_LOAD_SAFE_PATH
);
1412 fprintf_filtered (stream
, _("\
1416 fprintf_filtered (stream
, _("\
1421 fprintf_filtered (stream
, _("\
1422 --with-gdb-datadir=%s%s\n\
1423 "), GDB_DATADIR
, GDB_DATADIR_RELOCATABLE
? " (relocatable)" : "");
1425 fprintf_filtered (stream
, _("\
1426 --with-iconv-bin=%s%s\n\
1427 "), ICONV_BIN
, ICONV_BIN_RELOCATABLE
? " (relocatable)" : "");
1429 if (JIT_READER_DIR
[0])
1430 fprintf_filtered (stream
, _("\
1431 --with-jit-reader-dir=%s%s\n\
1432 "), JIT_READER_DIR
, JIT_READER_DIR_RELOCATABLE
? " (relocatable)" : "");
1433 #if HAVE_LIBUNWIND_IA64_H
1434 fprintf_filtered (stream
, _("\
1435 --with-libunwind-ia64\n\
1438 fprintf_filtered (stream
, _("\
1439 --without-libunwind-ia64\n\
1443 fprintf_filtered (stream
, _("\
1447 fprintf_filtered (stream
, _("\
1451 #if HAVE_LIBBABELTRACE
1452 fprintf_filtered (stream
, _("\
1453 --with-babeltrace\n\
1456 fprintf_filtered (stream
, _("\
1457 --without-babeltrace\n\
1461 fprintf_filtered (stream
, _("\
1465 fprintf_filtered (stream
, _("\
1466 --without-intel-pt\n\
1470 fprintf_filtered (stream
, _("\
1471 --enable-libmcheck\n\
1474 fprintf_filtered (stream
, _("\
1475 --disable-libmcheck\n\
1479 fprintf_filtered (stream
, _("\
1483 fprintf_filtered (stream
, _("\
1487 #ifdef WITH_PYTHON_PATH
1488 fprintf_filtered (stream
, _("\
1489 --with-python=%s%s\n\
1490 "), WITH_PYTHON_PATH
, PYTHON_PATH_RELOCATABLE
? " (relocatable)" : "");
1492 fprintf_filtered (stream
, _("\
1497 fprintf_filtered (stream
, _("\
1501 fprintf_filtered (stream
, _("\
1505 #if HAVE_SOURCE_HIGHLIGHT
1506 fprintf_filtered (stream
, _("\
1507 --enable-source-highlight\n\
1510 fprintf_filtered (stream
, _("\
1511 --disable-source-highlight\n\
1515 fprintf_filtered (stream
, _("\
1516 --with-relocated-sources=%s\n\
1520 fprintf_filtered (stream
, _("\
1521 --with-separate-debug-dir=%s%s\n\
1522 "), DEBUGDIR
, DEBUGDIR_RELOCATABLE
? " (relocatable)" : "");
1523 if (TARGET_SYSTEM_ROOT
[0])
1524 fprintf_filtered (stream
, _("\
1525 --with-sysroot=%s%s\n\
1526 "), TARGET_SYSTEM_ROOT
, TARGET_SYSTEM_ROOT_RELOCATABLE
? " (relocatable)" : "");
1527 if (SYSTEM_GDBINIT
[0])
1528 fprintf_filtered (stream
, _("\
1529 --with-system-gdbinit=%s%s\n\
1530 "), SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
? " (relocatable)" : "");
1531 /* We assume "relocatable" will be printed at least once, thus we always
1532 print this text. It's a reasonably safe assumption for now. */
1533 fprintf_filtered (stream
, _("\n\
1534 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1535 tree, and GDB will still find it.)\n\
1540 /* The current top level prompt, settable with "set prompt", and/or
1541 with the python `gdb.prompt_hook' hook. */
1542 static char *top_prompt
;
1544 /* Access method for the GDB prompt string. */
1552 /* Set method for the GDB prompt string. */
1555 set_prompt (const char *s
)
1557 char *p
= xstrdup (s
);
1569 /* Callback for iterate_over_inferiors. Kills or detaches the given
1570 inferior, depending on how we originally gained control of it. */
1573 kill_or_detach (struct inferior
*inf
, void *args
)
1575 struct qt_args
*qt
= (struct qt_args
*) args
;
1580 thread_info
*thread
= any_thread_of_inferior (inf
);
1583 switch_to_thread (thread
);
1585 /* Leave core files alone. */
1586 if (target_has_execution
)
1588 if (inf
->attach_flag
)
1589 target_detach (inf
, qt
->from_tty
);
1598 /* Callback for iterate_over_inferiors. Prints info about what GDB
1599 will do to each inferior on a "quit". ARG points to a struct
1600 ui_out where output is to be collected. */
1603 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1605 struct ui_file
*stb
= (struct ui_file
*) arg
;
1610 if (inf
->attach_flag
)
1611 fprintf_filtered (stb
,
1612 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1613 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1615 fprintf_filtered (stb
,
1616 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1617 target_pid_to_str (ptid_t (inf
->pid
)).c_str ());
1622 /* If necessary, make the user confirm that we should quit. Return
1623 non-zero if we should quit, zero if we shouldn't. */
1628 /* Don't even ask if we're only debugging a core file inferior. */
1629 if (!have_live_inferiors ())
1632 /* Build the query string as a single string. */
1635 stb
.puts (_("A debugging session is active.\n\n"));
1636 iterate_over_inferiors (print_inferior_quit_action
, &stb
);
1637 stb
.puts (_("\nQuit anyway? "));
1639 return query ("%s", stb
.c_str ());
1642 /* Prepare to exit GDB cleanly by undoing any changes made to the
1643 terminal so that we leave the terminal in the state we acquired it. */
1646 undo_terminal_modifications_before_exit (void)
1648 struct ui
*saved_top_level
= current_ui
;
1650 target_terminal::ours ();
1652 current_ui
= main_ui
;
1657 gdb_disable_readline ();
1659 current_ui
= saved_top_level
;
1663 /* Quit without asking for confirmation. */
1666 quit_force (int *exit_arg
, int from_tty
)
1671 undo_terminal_modifications_before_exit ();
1673 /* An optional expression may be used to cause gdb to terminate with the
1674 value of that expression. */
1676 exit_code
= *exit_arg
;
1677 else if (return_child_result
)
1678 exit_code
= return_child_result_value
;
1680 qt
.from_tty
= from_tty
;
1682 /* We want to handle any quit errors and exit regardless. */
1684 /* Get out of tfind mode, and kill or detach all inferiors. */
1687 disconnect_tracing ();
1688 iterate_over_inferiors (kill_or_detach
, &qt
);
1690 catch (const gdb_exception
&ex
)
1692 exception_print (gdb_stderr
, ex
);
1695 /* Give all pushed targets a chance to do minimal cleanup, and pop
1701 catch (const gdb_exception
&ex
)
1703 exception_print (gdb_stderr
, ex
);
1706 /* Save the history information if it is appropriate to do so. */
1709 if (write_history_p
&& history_filename
)
1714 /* History is currently shared between all UIs. If there's
1715 any UI with a terminal, save history. */
1718 if (input_interactive_p (ui
))
1726 gdb_safe_append_history ();
1729 catch (const gdb_exception
&ex
)
1731 exception_print (gdb_stderr
, ex
);
1734 /* Destroy any values currently allocated now instead of leaving it
1735 to global destructors, because that may be too late. For
1736 example, the destructors of xmethod values call into the Python
1737 runtime, which is finalized via a final cleanup. */
1740 /* Do any final cleanups before exiting. */
1743 do_final_cleanups ();
1745 catch (const gdb_exception
&ex
)
1747 exception_print (gdb_stderr
, ex
);
1753 /* The value of the "interactive-mode" setting. */
1754 static enum auto_boolean interactive_mode
= AUTO_BOOLEAN_AUTO
;
1756 /* Implement the "show interactive-mode" option. */
1759 show_interactive_mode (struct ui_file
*file
, int from_tty
,
1760 struct cmd_list_element
*c
,
1763 if (interactive_mode
== AUTO_BOOLEAN_AUTO
)
1764 fprintf_filtered (file
, "Debugger's interactive mode "
1765 "is %s (currently %s).\n",
1766 value
, input_interactive_p (current_ui
) ? "on" : "off");
1768 fprintf_filtered (file
, "Debugger's interactive mode is %s.\n", value
);
1771 /* Returns whether GDB is running on an interactive terminal. */
1774 input_interactive_p (struct ui
*ui
)
1779 if (interactive_mode
!= AUTO_BOOLEAN_AUTO
)
1780 return interactive_mode
== AUTO_BOOLEAN_TRUE
;
1782 return ui
->input_interactive_p
;
1786 dont_repeat_command (const char *ignored
, int from_tty
)
1788 /* Can't call dont_repeat here because we're not necessarily reading
1790 *saved_command_line
= 0;
1793 /* Functions to manipulate command line editing control variables. */
1795 /* Number of commands to print in each call to show_commands. */
1796 #define Hist_print 10
1798 show_commands (const char *args
, int from_tty
)
1800 /* Index for history commands. Relative to history_base. */
1803 /* Number of the history entry which we are planning to display next.
1804 Relative to history_base. */
1807 /* Print out some of the commands from the command history. */
1811 if (args
[0] == '+' && args
[1] == '\0')
1812 /* "info editing +" should print from the stored position. */
1815 /* "info editing <exp>" should print around command number <exp>. */
1816 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1818 /* "show commands" means print the last Hist_print commands. */
1821 num
= history_length
- Hist_print
;
1827 /* If there are at least Hist_print commands, we want to display the last
1828 Hist_print rather than, say, the last 6. */
1829 if (history_length
- num
< Hist_print
)
1831 num
= history_length
- Hist_print
;
1837 offset
< num
+ Hist_print
&& offset
< history_length
;
1840 printf_filtered ("%5d %s\n", history_base
+ offset
,
1841 (history_get (history_base
+ offset
))->line
);
1844 /* The next command we want to display is the next one that we haven't
1848 /* If the user repeats this command with return, it should do what
1849 "show commands +" does. This is unnecessary if arg is null,
1850 because "show commands +" is not useful after "show commands". */
1851 if (from_tty
&& args
)
1852 set_repeat_arguments ("+");
1855 /* Update the size of our command history file to HISTORY_SIZE.
1857 A HISTORY_SIZE of -1 stands for unlimited. */
1860 set_readline_history_size (int history_size
)
1862 gdb_assert (history_size
>= -1);
1864 if (history_size
== -1)
1865 unstifle_history ();
1867 stifle_history (history_size
);
1870 /* Called by do_setshow_command. */
1872 set_history_size_command (const char *args
,
1873 int from_tty
, struct cmd_list_element
*c
)
1875 set_readline_history_size (history_size_setshow_var
);
1879 set_history (const char *args
, int from_tty
)
1881 printf_unfiltered (_("\"set history\" must be followed "
1882 "by the name of a history subcommand.\n"));
1883 help_list (sethistlist
, "set history ", all_commands
, gdb_stdout
);
1887 show_history (const char *args
, int from_tty
)
1889 cmd_show_list (showhistlist
, from_tty
, "");
1892 int info_verbose
= 0; /* Default verbose msgs off. */
1894 /* Called by do_set_command. An elaborate joke. */
1896 set_verbose (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1898 const char *cmdname
= "verbose";
1899 struct cmd_list_element
*showcmd
;
1901 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1902 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1904 if (c
->doc
&& c
->doc_allocated
)
1905 xfree ((char *) c
->doc
);
1906 if (showcmd
->doc
&& showcmd
->doc_allocated
)
1907 xfree ((char *) showcmd
->doc
);
1910 c
->doc
= _("Set verbose printing of informational messages.");
1911 showcmd
->doc
= _("Show verbose printing of informational messages.");
1915 c
->doc
= _("Set verbosity.");
1916 showcmd
->doc
= _("Show verbosity.");
1918 c
->doc_allocated
= 0;
1919 showcmd
->doc_allocated
= 0;
1922 /* Init the history buffer. Note that we are called after the init file(s)
1923 have been read so that the user can change the history file via his
1924 .gdbinit file (for instance). The GDBHISTFILE environment variable
1925 overrides all of this. */
1932 tmpenv
= getenv ("GDBHISTSIZE");
1939 tmpenv
= skip_spaces (tmpenv
);
1941 var
= strtol (tmpenv
, &endptr
, 10);
1942 saved_errno
= errno
;
1943 endptr
= skip_spaces (endptr
);
1945 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1946 empty string, a negative number or a huge positive number (larger than
1947 INT_MAX) then set the history size to unlimited. Otherwise set our
1948 history size to the number we have read. This behavior is consistent
1949 with how bash handles HISTSIZE. */
1950 if (*endptr
!= '\0')
1952 else if (*tmpenv
== '\0'
1955 /* On targets where INT_MAX == LONG_MAX, we have to look at
1956 errno after calling strtol to distinguish between a value that
1957 is exactly INT_MAX and an overflowing value that was clamped
1959 || (var
== INT_MAX
&& saved_errno
== ERANGE
))
1960 history_size_setshow_var
= -1;
1962 history_size_setshow_var
= var
;
1965 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1967 if (history_size_setshow_var
== -2)
1968 history_size_setshow_var
= 256;
1970 set_readline_history_size (history_size_setshow_var
);
1972 tmpenv
= getenv ("GDBHISTFILE");
1974 history_filename
= xstrdup (tmpenv
);
1975 else if (!history_filename
)
1977 /* We include the current directory so that if the user changes
1978 directories the file written will be the same as the one
1981 /* No leading dots in file names are allowed on MSDOS. */
1982 history_filename
= concat (current_directory
, "/_gdb_history",
1985 history_filename
= concat (current_directory
, "/.gdb_history",
1989 read_history (history_filename
);
1993 show_prompt (struct ui_file
*file
, int from_tty
,
1994 struct cmd_list_element
*c
, const char *value
)
1996 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1999 /* "set editing" command. */
2002 set_editing (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2004 change_line_handler (set_editing_cmd_var
);
2005 /* Update the control variable so that MI's =cmd-param-changed event
2006 shows the correct value. */
2007 set_editing_cmd_var
= current_ui
->command_editing
;
2011 show_editing (struct ui_file
*file
, int from_tty
,
2012 struct cmd_list_element
*c
, const char *value
)
2014 fprintf_filtered (file
, _("Editing of command lines as "
2015 "they are typed is %s.\n"),
2016 current_ui
->command_editing
? _("on") : _("off"));
2020 show_annotation_level (struct ui_file
*file
, int from_tty
,
2021 struct cmd_list_element
*c
, const char *value
)
2023 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
2027 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
2028 struct cmd_list_element
*c
, const char *value
)
2030 fprintf_filtered (file
, _("Notification of completion for "
2031 "asynchronous execution commands is %s.\n"),
2035 /* New values of the "data-directory" parameter are staged here. */
2036 static char *staged_gdb_datadir
;
2038 /* "set" command for the gdb_datadir configuration variable. */
2041 set_gdb_datadir (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2043 set_gdb_data_directory (staged_gdb_datadir
);
2044 gdb::observers::gdb_datadir_changed
.notify ();
2047 /* "show" command for the gdb_datadir configuration variable. */
2050 show_gdb_datadir (struct ui_file
*file
, int from_tty
,
2051 struct cmd_list_element
*c
, const char *value
)
2053 fprintf_filtered (file
, _("GDB's data directory is \"%s\".\n"),
2058 set_history_filename (const char *args
,
2059 int from_tty
, struct cmd_list_element
*c
)
2061 /* We include the current directory so that if the user changes
2062 directories the file written will be the same as the one
2064 if (!IS_ABSOLUTE_PATH (history_filename
))
2065 history_filename
= reconcat (history_filename
, current_directory
, "/",
2066 history_filename
, (char *) NULL
);
2070 init_gdb_version_vars (void)
2072 struct internalvar
*major_version_var
= create_internalvar ("_gdb_major");
2073 struct internalvar
*minor_version_var
= create_internalvar ("_gdb_minor");
2074 int vmajor
= 0, vminor
= 0, vrevision
= 0;
2075 sscanf (version
, "%d.%d.%d", &vmajor
, &vminor
, &vrevision
);
2076 set_internalvar_integer (major_version_var
, vmajor
);
2077 set_internalvar_integer (minor_version_var
, vminor
+ (vrevision
> 0));
2083 struct cmd_list_element
*c
;
2085 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2086 the DEFAULT_PROMPT is. */
2087 set_prompt (DEFAULT_PROMPT
);
2089 /* Set the important stuff up for command editing. */
2090 command_editing_p
= 1;
2091 history_expansion_p
= 0;
2092 write_history_p
= 0;
2094 /* Setup important stuff for command line editing. */
2095 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
2096 rl_attempted_completion_function
= gdb_rl_attempted_completion_function
;
2097 set_rl_completer_word_break_characters (default_word_break_characters ());
2098 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
2099 rl_completion_display_matches_hook
= cli_display_match_list
;
2100 rl_readline_name
= "gdb";
2101 rl_terminal_name
= getenv ("TERM");
2103 /* The name for this defun comes from Bash, where it originated.
2104 15 is Control-o, the same binding this function has in Bash. */
2105 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
2107 add_setshow_string_cmd ("prompt", class_support
,
2109 _("Set gdb's prompt"),
2110 _("Show gdb's prompt"),
2113 &setlist
, &showlist
);
2115 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
2116 Don't repeat this command.\nPrimarily \
2117 used inside of user-defined commands that should not be repeated when\n\
2120 add_setshow_boolean_cmd ("editing", class_support
,
2121 &set_editing_cmd_var
, _("\
2122 Set editing of command lines as they are typed."), _("\
2123 Show editing of command lines as they are typed."), _("\
2124 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2125 Without an argument, command line editing is enabled. To edit, use\n\
2126 EMACS-like or VI-like commands like control-P or ESC."),
2129 &setlist
, &showlist
);
2131 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
2132 Set saving of the history record on exit."), _("\
2133 Show saving of the history record on exit."), _("\
2134 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2135 Without an argument, saving is enabled."),
2137 show_write_history_p
,
2138 &sethistlist
, &showhistlist
);
2140 add_setshow_zuinteger_unlimited_cmd ("size", no_class
,
2141 &history_size_setshow_var
, _("\
2142 Set the size of the command history,"), _("\
2143 Show the size of the command history,"), _("\
2144 ie. the number of previous commands to keep a record of.\n\
2145 If set to \"unlimited\", the number of commands kept in the history\n\
2146 list is unlimited. This defaults to the value of the environment\n\
2147 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2148 set_history_size_command
,
2150 &sethistlist
, &showhistlist
);
2152 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class
,
2153 &history_remove_duplicates
, _("\
2154 Set how far back in history to look for and remove duplicate entries."), _("\
2155 Show how far back in history to look for and remove duplicate entries."), _("\
2156 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2157 and remove the first history entry that is a duplicate of the most recent\n\
2158 entry, each time a new history entry is added.\n\
2159 If set to \"unlimited\", this lookbehind is unbounded.\n\
2160 Only history entries added during this session are considered for removal.\n\
2161 If set to 0, removal of duplicate history entries is disabled.\n\
2162 By default this option is set to 0."),
2164 show_history_remove_duplicates
,
2165 &sethistlist
, &showhistlist
);
2167 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
2168 Set the filename in which to record the command history"), _("\
2169 Show the filename in which to record the command history"), _("\
2170 (the list of previous commands of which a record is kept)."),
2171 set_history_filename
,
2172 show_history_filename
,
2173 &sethistlist
, &showhistlist
);
2175 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
2176 Set whether to confirm potentially dangerous operations."), _("\
2177 Show whether to confirm potentially dangerous operations."), NULL
,
2180 &setlist
, &showlist
);
2182 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
2183 Set annotation_level."), _("\
2184 Show annotation_level."), _("\
2185 0 == normal; 1 == fullname (for use when running under emacs)\n\
2186 2 == output annotated suitably for use by programs that control GDB."),
2188 show_annotation_level
,
2189 &setlist
, &showlist
);
2191 add_setshow_boolean_cmd ("exec-done-display", class_support
,
2192 &exec_done_display_p
, _("\
2193 Set notification of completion for asynchronous execution commands."), _("\
2194 Show notification of completion for asynchronous execution commands."), _("\
2195 Use \"on\" to enable the notification, and \"off\" to disable it."),
2197 show_exec_done_display_p
,
2198 &setlist
, &showlist
);
2200 add_setshow_filename_cmd ("data-directory", class_maintenance
,
2201 &staged_gdb_datadir
, _("Set GDB's data directory."),
2202 _("Show GDB's data directory."),
2204 When set, GDB uses the specified path to search for data files."),
2205 set_gdb_datadir
, show_gdb_datadir
,
2209 add_setshow_auto_boolean_cmd ("interactive-mode", class_support
,
2210 &interactive_mode
, _("\
2211 Set whether GDB's standard input is a terminal."), _("\
2212 Show whether GDB's standard input is a terminal."), _("\
2213 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2214 means that GDB should wait for the user to answer queries associated to\n\
2215 commands entered at the command prompt. If off, GDB assumes that standard\n\
2216 input is not a terminal, and uses the default answer to all queries.\n\
2217 If auto (the default), determine which mode to use based on the standard\n\
2220 show_interactive_mode
,
2221 &setlist
, &showlist
);
2223 c
= add_cmd ("new-ui", class_support
, new_ui_command
, _("\
2224 Create a new UI. It takes two arguments:\n\
2225 The first argument is the name of the interpreter to run.\n\
2226 The second argument is the terminal the UI runs on."), &cmdlist
);
2227 set_cmd_completer (c
, interpreter_completer
);
2231 gdb_init (char *argv0
)
2233 saved_command_line
= xstrdup ("");
2234 previous_saved_command_line
= xstrdup ("");
2236 if (pre_init_ui_hook
)
2237 pre_init_ui_hook ();
2239 /* Run the init function of each source file. */
2242 /* Make sure we return to the original directory upon exit, come
2243 what may, since the OS doesn't do that for us. */
2244 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
2247 init_cmd_lists (); /* This needs to be done first. */
2248 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2249 initialize_utils (); /* Make errors and warnings possible. */
2253 /* Here is where we call all the _initialize_foo routines. */
2254 initialize_all_files ();
2256 /* This creates the current_program_space. Do this after all the
2257 _initialize_foo routines have had a chance to install their
2258 per-sspace data keys. Also do this before
2259 initialize_current_architecture is called, because it accesses
2260 exec_bfd of the current program space. */
2261 initialize_progspace ();
2262 initialize_inferiors ();
2263 initialize_current_architecture ();
2264 init_main (); /* But that omits this file! Do it now. */
2266 initialize_stdin_serial ();
2268 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2270 set_initial_gdb_ttystate ();
2272 async_init_signals ();
2274 /* We need a default language for parsing expressions, so simple
2275 things like "set width 0" won't fail if no language is explicitly
2276 set in a config file or implicitly set by reading an executable
2278 set_language (language_c
);
2279 expected_language
= current_language
; /* Don't warn about the change. */
2281 /* Python initialization, for example, can require various commands to be
2282 installed. For example "info pretty-printer" needs the "info"
2283 prefix to be installed. Keep things simple and just do final
2284 script initialization here. */
2285 finish_ext_lang_initialization ();
2287 /* Create $_gdb_major and $_gdb_minor convenience variables. */
2288 init_gdb_version_vars ();