1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "cli/cli-cmds.h"
23 #include "cli/cli-script.h"
24 #include "cli/cli-setshow.h"
25 #include "cli/cli-decode.h"
31 #include "target-dcache.h"
32 #include "breakpoint.h"
34 #include "expression.h"
37 #include "terminal.h" /* For job_control. */
39 #include "completer.h"
45 #include "event-loop.h"
46 #include "gdbthread.h"
47 #include "extension.h"
51 #include "filenames.h"
54 #include "gdb_select.h"
56 /* readline include files. */
57 #include "readline/readline.h"
58 #include "readline/history.h"
60 /* readline defines this. */
63 #include <sys/types.h>
65 #include "event-top.h"
70 #include "tracepoint.h"
81 extern void initialize_all_files (void);
83 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
84 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
85 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
87 /* Default command line prompt. This is overriden in some configs. */
89 #ifndef DEFAULT_PROMPT
90 #define DEFAULT_PROMPT "(gdb) "
93 /* Generate a function that exports a pointer to a field of the
96 #define gen_ret_current_ui_field_ptr(type, name) \
98 current_ui_## name ## _ptr (void) \
100 return ¤t_ui->m_ ## name; \
103 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdout)
104 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdin)
105 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stderr)
106 gen_ret_current_ui_field_ptr (struct ui_file *, gdb_stdlog)
107 gen_ret_current_ui_field_ptr (struct ui_out *, current_uiout)
109 /* Initialization file name for gdb. This is host-dependent. */
111 const char gdbinit[] = GDBINIT;
113 int inhibit_gdbinit = 0;
115 extern char lang_frame_mismatch_warn[]; /* language.c */
117 /* Flag for whether we want to confirm potentially dangerous
118 operations. Default is yes. */
123 show_confirm (struct ui_file *file, int from_tty,
124 struct cmd_list_element *c, const char *value)
126 fprintf_filtered (file, _("Whether to confirm potentially "
127 "dangerous operations is %s.\n"),
131 /* Flag to indicate whether a user defined command is currently running. */
135 /* Current working directory. */
137 char *current_directory;
139 /* The directory name is actually stored here (usually). */
140 char gdb_dirbuf[1024];
142 /* The last command line executed on the console. Used for command
144 char *saved_command_line;
146 /* Nonzero if the current command is modified by "server ". This
147 affects things like recording into the command history, commands
148 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
149 whatever) can issue its own commands and also send along commands
150 from the user, and have the user not notice that the user interface
151 is issuing commands too. */
154 /* Timeout limit for response from target. */
156 /* The default value has been changed many times over the years. It
157 was originally 5 seconds. But that was thought to be a long time
158 to sit and wait, so it was changed to 2 seconds. That was thought
159 to be plenty unless the connection was going through some terminal
160 server or multiplexer or other form of hairy serial connection.
162 In mid-1996, remote_timeout was moved from remote.c to top.c and
163 it began being used in other remote-* targets. It appears that the
164 default was changed to 20 seconds at that time, perhaps because the
165 Renesas E7000 ICE didn't always respond in a timely manner.
167 But if 5 seconds is a long time to sit and wait for retransmissions,
168 20 seconds is far worse. This demonstrates the difficulty of using
169 a single variable for all protocol timeouts.
171 As remote.c is used much more than remote-e7000.c, it was changed
172 back to 2 seconds in 1999. */
174 int remote_timeout = 2;
176 /* Non-zero tells remote* modules to output debugging info. */
178 int remote_debug = 0;
180 /* Sbrk location on entry to main. Used for statistics only. */
185 /* Hooks for alternate command interfaces. */
187 /* This hook is called from within gdb's many mini-event loops which
188 could steal control from a real user interface's event loop. It
189 returns non-zero if the user is requesting a detach, zero
192 int (*deprecated_ui_loop_hook) (int);
195 /* Called from print_frame_info to list the line we stopped in. */
197 void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
201 /* Replaces most of query. */
203 int (*deprecated_query_hook) (const char *, va_list);
205 /* Replaces most of warning. */
207 void (*deprecated_warning_hook) (const char *, va_list);
209 /* These three functions support getting lines of text from the user.
210 They are used in sequence. First deprecated_readline_begin_hook is
211 called with a text string that might be (for example) a message for
212 the user to type in a sequence of commands to be executed at a
213 breakpoint. If this function calls back to a GUI, it might take
214 this opportunity to pop up a text interaction window with this
215 message. Next, deprecated_readline_hook is called with a prompt
216 that is emitted prior to collecting the user input. It can be
217 called multiple times. Finally, deprecated_readline_end_hook is
218 called to notify the GUI that we are done with the interaction
219 window and it can close it. */
221 void (*deprecated_readline_begin_hook) (char *, ...);
222 char *(*deprecated_readline_hook) (const char *);
223 void (*deprecated_readline_end_hook) (void);
225 /* Called as appropriate to notify the interface that we have attached
226 to or detached from an already running process. */
228 void (*deprecated_attach_hook) (void);
229 void (*deprecated_detach_hook) (void);
231 /* Called during long calculations to allow GUI to repair window
232 damage, and to check for stop buttons, etc... */
234 void (*deprecated_interactive_hook) (void);
236 /* Called when going to wait for the target. Usually allows the GUI
237 to run while waiting for target events. */
239 ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
240 struct target_waitstatus *status,
243 /* Used by UI as a wrapper around command execution. May do various
244 things like enabling/disabling buttons, etc... */
246 void (*deprecated_call_command_hook) (struct cmd_list_element * c,
247 char *cmd, int from_tty);
249 /* Called when the current thread changes. Argument is thread id. */
251 void (*deprecated_context_hook) (int id);
253 /* The highest UI number ever assigned. */
254 static int highest_ui_num;
259 new_ui (FILE *instream, FILE *outstream, FILE *errstream)
263 ui = XCNEW (struct ui);
265 ui->num = ++highest_ui_num;
266 ui->stdin_stream = instream;
267 ui->instream = instream;
268 ui->outstream = outstream;
269 ui->errstream = errstream;
271 ui->input_fd = fileno (ui->instream);
273 ui->input_interactive_p = ISATTY (ui->instream);
275 ui->m_gdb_stdin = new stdio_file (ui->instream);
276 ui->m_gdb_stdout = new stdio_file (ui->outstream);
277 ui->m_gdb_stderr = new stderr_file (ui->errstream);
278 ui->m_gdb_stdlog = ui->m_gdb_stderr;
280 ui->prompt_state = PROMPT_NEEDED;
288 for (last = ui_list; last->next != NULL; last = last->next)
297 free_ui (struct ui *ui)
299 delete ui->m_gdb_stdin;
300 delete ui->m_gdb_stdout;
301 delete ui->m_gdb_stderr;
307 delete_ui (struct ui *todel)
309 struct ui *ui, *uiprev;
313 for (ui = ui_list; ui != NULL; uiprev = ui, ui = ui->next)
317 gdb_assert (ui != NULL);
320 uiprev->next = ui->next;
327 /* Cleanup that deletes a UI. */
330 delete_ui_cleanup (void *void_ui)
332 struct ui *ui = (struct ui *) void_ui;
340 make_delete_ui_cleanup (struct ui *ui)
342 return make_cleanup (delete_ui_cleanup, ui);
345 /* Open file named NAME for read/write, making sure not to make it the
346 controlling terminal. */
349 open_terminal_stream (const char *name)
353 fd = open (name, O_RDWR | O_NOCTTY);
355 perror_with_name (_("opening terminal failed"));
357 return fdopen (fd, "w+");
360 /* Implementation of the "new-ui" command. */
363 new_ui_command (char *args, int from_tty)
366 struct interp *interp;
367 FILE *stream[3] = { NULL, NULL, NULL };
372 const char *interpreter_name;
373 const char *tty_name;
374 struct cleanup *success_chain;
375 struct cleanup *failure_chain;
379 argv = gdb_buildargv (args);
380 success_chain = make_cleanup_freeargv (argv);
381 argc = countargv (argv);
384 error (_("usage: new-ui <interpreter> <tty>"));
386 interpreter_name = argv[0];
390 scoped_restore save_ui = make_scoped_restore (¤t_ui);
392 failure_chain = make_cleanup (null_cleanup, NULL);
394 /* Open specified terminal, once for each of
395 stdin/stdout/stderr. */
396 for (i = 0; i < 3; i++)
398 stream[i] = open_terminal_stream (tty_name);
399 make_cleanup_fclose (stream[i]);
402 ui = new_ui (stream[0], stream[1], stream[2]);
403 make_cleanup (delete_ui_cleanup, ui);
409 set_top_level_interpreter (interpreter_name);
411 interp_pre_command_loop (top_level_interpreter ());
413 discard_cleanups (failure_chain);
415 /* This restores the previous UI and frees argv. */
416 do_cleanups (success_chain);
419 printf_unfiltered ("New UI allocated\n");
422 /* Handler for SIGHUP. */
425 /* NOTE 1999-04-29: This function will be static again, once we modify
426 gdb to use the event loop as the default command loop and we merge
427 event-top.c into this file, top.c. */
431 /* Stop asking user for confirmation --- we're exiting. This
432 prevents asking the user dumb questions. */
434 quit_command ((char *) 0, 0);
436 #endif /* defined SIGHUP */
438 /* Line number we are currently in, in a file which is being sourced. */
439 /* NOTE 1999-04-29: This variable will be static again, once we modify
440 gdb to use the event loop as the default command loop and we merge
441 event-top.c into this file, top.c. */
442 /* static */ int source_line_number;
444 /* Name of the file we are sourcing. */
445 /* NOTE 1999-04-29: This variable will be static again, once we modify
446 gdb to use the event loop as the default command loop and we merge
447 event-top.c into this file, top.c. */
448 /* static */ const char *source_file_name;
450 /* Clean up on error during a "source" command (or execution of a
451 user-defined command). */
454 do_restore_instream_cleanup (void *stream)
456 struct ui *ui = current_ui;
458 /* Restore the previous input stream. */
459 ui->instream = (FILE *) stream;
462 /* Read commands from STREAM. */
464 read_command_file (FILE *stream)
466 struct ui *ui = current_ui;
467 struct cleanup *cleanups;
469 cleanups = make_cleanup (do_restore_instream_cleanup, ui->instream);
470 ui->instream = stream;
472 /* Read commands from `instream' and execute them until end of file
473 or error reading instream. */
475 while (ui->instream != NULL && !feof (ui->instream))
479 /* Get a command-line. This calls the readline package. */
480 command = command_line_input (NULL, 0, NULL);
483 command_handler (command);
486 do_cleanups (cleanups);
489 void (*pre_init_ui_hook) (void);
493 do_chdir_cleanup (void *old_dir)
495 chdir ((const char *) old_dir);
501 prepare_execute_command (void)
504 struct cleanup *cleanup;
506 mark = value_mark ();
507 cleanup = make_cleanup_value_free_to_mark (mark);
509 /* With multiple threads running while the one we're examining is
510 stopped, the dcache can get stale without us being able to detect
511 it. For the duration of the command, though, use the dcache to
512 help things like backtrace. */
514 target_dcache_invalidate ();
519 /* Tell the user if the language has changed (except first time) after
520 executing a command. */
523 check_frame_language_change (void)
525 static int warned = 0;
526 struct frame_info *frame;
528 /* First make sure that a new frame has been selected, in case the
529 command or the hooks changed the program state. */
530 frame = deprecated_safe_get_selected_frame ();
531 if (current_language != expected_language)
533 if (language_mode == language_mode_auto && info_verbose)
535 language_info (1); /* Print what changed. */
540 /* Warn the user if the working language does not match the language
541 of the current frame. Only warn the user if we are actually
542 running the program, i.e. there is a stack. */
543 /* FIXME: This should be cacheing the frame and only running when
544 the frame changes. */
546 if (has_stack_frames ())
550 flang = get_frame_language (frame);
552 && flang != language_unknown
553 && flang != current_language->la_language)
555 printf_filtered ("%s\n", lang_frame_mismatch_warn);
564 wait_sync_command_done (void)
566 /* Processing events may change the current UI. */
567 scoped_restore save_ui = make_scoped_restore (¤t_ui);
568 struct ui *ui = current_ui;
570 while (gdb_do_one_event () >= 0)
571 if (ui->prompt_state != PROMPT_BLOCKED)
578 maybe_wait_sync_command_done (int was_sync)
580 /* If the interpreter is in sync mode (we're running a user
581 command's list, running command hooks or similars), and we
582 just ran a synchronous command that started the target, wait
583 for that command to end. */
584 if (!current_ui->async
586 && current_ui->prompt_state == PROMPT_BLOCKED)
587 wait_sync_command_done ();
590 /* Execute the line P as a command, in the current user context.
591 Pass FROM_TTY as second argument to the defining function. */
594 execute_command (char *p, int from_tty)
596 struct cleanup *cleanup_if_error, *cleanup;
597 struct cmd_list_element *c;
600 cleanup_if_error = make_bpstat_clear_actions_cleanup ();
601 cleanup = prepare_execute_command ();
603 /* Force cleanup of any alloca areas if using C alloca instead of
607 /* This can happen when command_line_input hits end of file. */
610 do_cleanups (cleanup);
611 discard_cleanups (cleanup_if_error);
615 target_log_command (p);
617 while (*p == ' ' || *p == '\t')
623 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
627 /* If trace-commands is set then this will print this command. */
628 print_command_trace (p);
630 c = lookup_cmd (&cmd, cmdlist, "", 0, 1);
633 /* Pass null arg rather than an empty one. */
636 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
637 while the is_complete_command(cfunc) test is just plain
638 bogus. They should both be replaced by a test of the form
639 c->strip_trailing_white_space_p. */
640 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
641 can't be replaced with func. This is because it is the
642 cfunc, and not the func, that has the value that the
643 is_complete_command hack is testing for. */
644 /* Clear off trailing whitespace, except for set and complete
647 && c->type != set_cmd
648 && !is_complete_command (c))
650 p = arg + strlen (arg) - 1;
651 while (p >= arg && (*p == ' ' || *p == '\t'))
656 /* If this command has been pre-hooked, run the hook first. */
657 execute_cmd_pre_hook (c);
659 if (c->deprecated_warn_user)
660 deprecated_cmd_warning (line);
662 /* c->user_commands would be NULL in the case of a python command. */
663 if (c->theclass == class_user && c->user_commands)
664 execute_user_command (c, arg);
665 else if (c->type == set_cmd)
666 do_set_command (arg, from_tty, c);
667 else if (c->type == show_cmd)
668 do_show_command (arg, from_tty, c);
669 else if (!cmd_func_p (c))
670 error (_("That is not a command, just a help topic."));
671 else if (deprecated_call_command_hook)
672 deprecated_call_command_hook (c, arg, from_tty);
674 cmd_func (c, arg, from_tty);
676 maybe_wait_sync_command_done (was_sync);
678 /* If this command has been post-hooked, run the hook last. */
679 execute_cmd_post_hook (c);
683 check_frame_language_change ();
685 do_cleanups (cleanup);
686 discard_cleanups (cleanup_if_error);
689 /* Run execute_command for P and FROM_TTY. Capture its output into the
690 returned string, do not display it to the screen. BATCH_FLAG will be
691 temporarily set to true. */
694 execute_command_to_string (char *p, int from_tty)
696 struct cleanup *cleanup;
698 /* GDB_STDOUT should be better already restored during these
699 restoration callbacks. */
700 cleanup = set_batch_flag_and_make_cleanup_restore_page_info ();
702 scoped_restore save_async = make_scoped_restore (¤t_ui->async, 0);
704 string_file str_file;
706 current_uiout->redirect (&str_file);
707 make_cleanup_ui_out_redirect_pop (current_uiout);
709 scoped_restore save_stdout
710 = make_scoped_restore (&gdb_stdout, &str_file);
711 scoped_restore save_stderr
712 = make_scoped_restore (&gdb_stderr, &str_file);
713 scoped_restore save_stdlog
714 = make_scoped_restore (&gdb_stdlog, &str_file);
715 scoped_restore save_stdtarg
716 = make_scoped_restore (&gdb_stdtarg, &str_file);
717 scoped_restore save_stdtargerr
718 = make_scoped_restore (&gdb_stdtargerr, &str_file);
720 execute_command (p, from_tty);
722 do_cleanups (cleanup);
724 return std::move (str_file.string ());
728 /* When nonzero, cause dont_repeat to do nothing. This should only be
729 set via prevent_dont_repeat. */
731 static int suppress_dont_repeat = 0;
733 /* Commands call this if they do not want to be repeated by null lines. */
738 struct ui *ui = current_ui;
740 if (suppress_dont_repeat || server_command)
743 /* If we aren't reading from standard input, we are saving the last
744 thing read from stdin in line and don't want to delete it. Null
745 lines won't repeat here in any case. */
746 if (ui->instream == ui->stdin_stream)
747 *saved_command_line = 0;
750 /* Prevent dont_repeat from working, and return a cleanup that
751 restores the previous state. */
753 scoped_restore_tmpl<int>
754 prevent_dont_repeat (void)
756 return make_scoped_restore (&suppress_dont_repeat, 1);
760 /* Read a line from the stream "instream" without command line editing.
762 It prints PROMPT once at the start.
763 Action is compatible with "readline", e.g. space for the result is
764 malloc'd and should be freed by the caller.
766 A NULL return means end of file. */
769 gdb_readline_no_editing (const char *prompt)
771 struct buffer line_buffer;
772 struct ui *ui = current_ui;
773 /* Read from stdin if we are executing a user defined command. This
774 is the right thing for prompt_for_continue, at least. */
775 FILE *stream = ui->instream != NULL ? ui->instream : stdin;
776 int fd = fileno (stream);
778 buffer_init (&line_buffer);
782 /* Don't use a _filtered function here. It causes the assumed
783 character position to be off, since the newline we read from
784 the user is not accounted for. */
785 fputs_unfiltered (prompt, gdb_stdout);
786 gdb_flush (gdb_stdout);
797 /* Wait until at least one byte of data is available. Control-C
798 can interrupt interruptible_select, but not fgetc. */
800 FD_SET (fd, &readfds);
801 if (interruptible_select (fd + 1, &readfds, NULL, NULL, NULL) == -1)
805 /* If this was ctrl-c, the QUIT above handles it. */
808 perror_with_name (("select"));
815 if (line_buffer.used_size > 0)
816 /* The last line does not end with a newline. Return it, and
817 if we are called again fgetc will still return EOF and
818 we'll return NULL then. */
820 xfree (buffer_finish (&line_buffer));
826 if (line_buffer.used_size > 0
827 && line_buffer.buffer[line_buffer.used_size - 1] == '\r')
828 line_buffer.used_size--;
832 buffer_grow_char (&line_buffer, c);
835 buffer_grow_char (&line_buffer, '\0');
836 return buffer_finish (&line_buffer);
839 /* Variables which control command line editing and history
840 substitution. These variables are given default values at the end
842 static int command_editing_p;
844 /* NOTE 1999-04-29: This variable will be static again, once we modify
845 gdb to use the event loop as the default command loop and we merge
846 event-top.c into this file, top.c. */
848 /* static */ int history_expansion_p;
850 static int write_history_p;
852 show_write_history_p (struct ui_file *file, int from_tty,
853 struct cmd_list_element *c, const char *value)
855 fprintf_filtered (file, _("Saving of the history record on exit is %s.\n"),
859 /* The variable associated with the "set/show history size"
860 command. The value -1 means unlimited, and -2 means undefined. */
861 static int history_size_setshow_var = -2;
864 show_history_size (struct ui_file *file, int from_tty,
865 struct cmd_list_element *c, const char *value)
867 fprintf_filtered (file, _("The size of the command history is %s.\n"),
871 /* Variable associated with the "history remove-duplicates" option.
872 The value -1 means unlimited. */
873 static int history_remove_duplicates = 0;
876 show_history_remove_duplicates (struct ui_file *file, int from_tty,
877 struct cmd_list_element *c, const char *value)
879 fprintf_filtered (file,
880 _("The number of history entries to look back at for "
881 "duplicates is %s.\n"),
885 static char *history_filename;
887 show_history_filename (struct ui_file *file, int from_tty,
888 struct cmd_list_element *c, const char *value)
890 fprintf_filtered (file, _("The filename in which to record "
891 "the command history is \"%s\".\n"),
895 /* This is like readline(), but it has some gdb-specific behavior.
896 gdb may want readline in both the synchronous and async modes during
897 a single gdb invocation. At the ordinary top-level prompt we might
898 be using the async readline. That means we can't use
899 rl_pre_input_hook, since it doesn't work properly in async mode.
900 However, for a secondary prompt (" >", such as occurs during a
901 `define'), gdb wants a synchronous response.
903 We used to call readline() directly, running it in synchronous
904 mode. But mixing modes this way is not supported, and as of
905 readline 5.x it no longer works; the arrow keys come unbound during
906 the synchronous call. So we make a nested call into the event
907 loop. That's what gdb_readline_wrapper is for. */
909 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
910 rely on gdb_readline_wrapper_result, which might still be NULL if
911 the user types Control-D for EOF. */
912 static int gdb_readline_wrapper_done;
914 /* The result of the current call to gdb_readline_wrapper, once a newline
916 static char *gdb_readline_wrapper_result;
918 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
919 to be called after the newline is processed (which will redisplay
920 the prompt). But in gdb_readline_wrapper we will not get a new
921 prompt until the next call, or until we return to the event loop.
922 So we disable this hook around the newline and restore it before we
924 static void (*saved_after_char_processing_hook) (void);
930 gdb_in_secondary_prompt_p (struct ui *ui)
932 return ui->secondary_prompt_depth > 0;
936 /* This function is called when readline has seen a complete line of
940 gdb_readline_wrapper_line (char *line)
942 gdb_assert (!gdb_readline_wrapper_done);
943 gdb_readline_wrapper_result = line;
944 gdb_readline_wrapper_done = 1;
946 /* Prevent operate-and-get-next from acting too early. */
947 saved_after_char_processing_hook = after_char_processing_hook;
948 after_char_processing_hook = NULL;
950 /* Prevent parts of the prompt from being redisplayed if annotations
951 are enabled, and readline's state getting out of sync. We'll
952 reinstall the callback handler, which puts the terminal in raw
953 mode (or in readline lingo, in prepped state), when we're next
954 ready to process user input, either in display_gdb_prompt, or if
955 we're handling an asynchronous target event and running in the
956 background, just before returning to the event loop to process
957 further input (or more target events). */
958 if (current_ui->command_editing)
959 gdb_rl_callback_handler_remove ();
962 struct gdb_readline_wrapper_cleanup
964 void (*handler_orig) (char *);
965 int already_prompted_orig;
967 /* Whether the target was async. */
968 int target_is_async_orig;
972 gdb_readline_wrapper_cleanup (void *arg)
974 struct ui *ui = current_ui;
975 struct gdb_readline_wrapper_cleanup *cleanup
976 = (struct gdb_readline_wrapper_cleanup *) arg;
978 if (ui->command_editing)
979 rl_already_prompted = cleanup->already_prompted_orig;
981 gdb_assert (ui->input_handler == gdb_readline_wrapper_line);
982 ui->input_handler = cleanup->handler_orig;
984 /* Don't restore our input handler in readline yet. That would make
985 readline prep the terminal (putting it in raw mode), while the
986 line we just read may trigger execution of a command that expects
987 the terminal in the default cooked/canonical mode, such as e.g.,
988 running Python's interactive online help utility. See
989 gdb_readline_wrapper_line for when we'll reinstall it. */
991 gdb_readline_wrapper_result = NULL;
992 gdb_readline_wrapper_done = 0;
993 ui->secondary_prompt_depth--;
994 gdb_assert (ui->secondary_prompt_depth >= 0);
996 after_char_processing_hook = saved_after_char_processing_hook;
997 saved_after_char_processing_hook = NULL;
999 if (cleanup->target_is_async_orig)
1006 gdb_readline_wrapper (const char *prompt)
1008 struct ui *ui = current_ui;
1009 struct cleanup *back_to;
1010 struct gdb_readline_wrapper_cleanup *cleanup;
1013 cleanup = XNEW (struct gdb_readline_wrapper_cleanup);
1014 cleanup->handler_orig = ui->input_handler;
1015 ui->input_handler = gdb_readline_wrapper_line;
1017 if (ui->command_editing)
1018 cleanup->already_prompted_orig = rl_already_prompted;
1020 cleanup->already_prompted_orig = 0;
1022 cleanup->target_is_async_orig = target_is_async_p ();
1024 ui->secondary_prompt_depth++;
1025 back_to = make_cleanup (gdb_readline_wrapper_cleanup, cleanup);
1027 /* Processing events may change the current UI. */
1028 scoped_restore save_ui = make_scoped_restore (¤t_ui);
1030 if (cleanup->target_is_async_orig)
1033 /* Display our prompt and prevent double prompt display. */
1034 display_gdb_prompt (prompt);
1035 if (ui->command_editing)
1036 rl_already_prompted = 1;
1038 if (after_char_processing_hook)
1039 (*after_char_processing_hook) ();
1040 gdb_assert (after_char_processing_hook == NULL);
1042 while (gdb_do_one_event () >= 0)
1043 if (gdb_readline_wrapper_done)
1046 retval = gdb_readline_wrapper_result;
1047 do_cleanups (back_to);
1052 /* The current saved history number from operate-and-get-next.
1053 This is -1 if not valid. */
1054 static int operate_saved_history = -1;
1056 /* This is put on the appropriate hook and helps operate-and-get-next
1059 gdb_rl_operate_and_get_next_completion (void)
1061 int delta = where_history () - operate_saved_history;
1063 /* The `key' argument to rl_get_previous_history is ignored. */
1064 rl_get_previous_history (delta, 0);
1065 operate_saved_history = -1;
1067 /* readline doesn't automatically update the display for us. */
1070 after_char_processing_hook = NULL;
1071 rl_pre_input_hook = NULL;
1074 /* This is a gdb-local readline command handler. It accepts the
1075 current command line (like RET does) and, if this command was taken
1076 from the history, arranges for the next command in the history to
1077 appear on the command line when the prompt returns.
1078 We ignore the arguments. */
1080 gdb_rl_operate_and_get_next (int count, int key)
1084 /* Use the async hook. */
1085 after_char_processing_hook = gdb_rl_operate_and_get_next_completion;
1087 /* Find the current line, and find the next line to use. */
1088 where = where_history();
1090 if ((history_is_stifled () && (history_length >= history_max_entries))
1091 || (where >= history_length - 1))
1092 operate_saved_history = where;
1094 operate_saved_history = where + 1;
1096 return rl_newline (1, key);
1099 /* Number of user commands executed during this session. */
1101 static int command_count = 0;
1103 /* Add the user command COMMAND to the input history list. */
1106 gdb_add_history (const char *command)
1110 if (history_remove_duplicates != 0)
1113 int lookbehind_threshold;
1115 /* The lookbehind threshold for finding a duplicate history entry is
1116 bounded by command_count because we can't meaningfully delete
1117 history entries that are already stored in the history file since
1118 the history file is appended to. */
1119 if (history_remove_duplicates == -1
1120 || history_remove_duplicates > command_count)
1121 lookbehind_threshold = command_count;
1123 lookbehind_threshold = history_remove_duplicates;
1126 for (lookbehind = 0; lookbehind < lookbehind_threshold; lookbehind++)
1128 HIST_ENTRY *temp = previous_history ();
1133 if (strcmp (temp->line, command) == 0)
1135 HIST_ENTRY *prev = remove_history (where_history ());
1137 free_history_entry (prev);
1144 add_history (command);
1147 /* Safely append new history entries to the history file in a corruption-free
1148 way using an intermediate local history file. */
1151 gdb_safe_append_history (void)
1153 int ret, saved_errno;
1154 char *local_history_filename;
1155 struct cleanup *old_chain;
1157 local_history_filename
1158 = xstrprintf ("%s-gdb%ld~", history_filename, (long) getpid ());
1159 old_chain = make_cleanup (xfree, local_history_filename);
1161 ret = rename (history_filename, local_history_filename);
1162 saved_errno = errno;
1163 if (ret < 0 && saved_errno != ENOENT)
1165 warning (_("Could not rename %s to %s: %s"),
1166 history_filename, local_history_filename,
1167 safe_strerror (saved_errno));
1173 /* If the rename failed with ENOENT then either the global history
1174 file never existed in the first place or another GDB process is
1175 currently appending to it (and has thus temporarily renamed it).
1176 Since we can't distinguish between these two cases, we have to
1177 conservatively assume the first case and therefore must write out
1178 (not append) our known history to our local history file and try
1179 to move it back anyway. Otherwise a global history file would
1180 never get created! */
1181 gdb_assert (saved_errno == ENOENT);
1182 write_history (local_history_filename);
1186 append_history (command_count, local_history_filename);
1187 if (history_is_stifled ())
1188 history_truncate_file (local_history_filename, history_max_entries);
1191 ret = rename (local_history_filename, history_filename);
1192 saved_errno = errno;
1193 if (ret < 0 && saved_errno != EEXIST)
1194 warning (_("Could not rename %s to %s: %s"),
1195 local_history_filename, history_filename,
1196 safe_strerror (saved_errno));
1199 do_cleanups (old_chain);
1202 /* Read one line from the command input stream `instream' into a local
1203 static buffer. The buffer is made bigger as necessary. Returns
1204 the address of the start of the line.
1206 NULL is returned for end of file.
1208 *If* input is from an interactive stream (stdin), the line read is
1209 copied into the global 'saved_command_line' so that it can be
1212 This routine either uses fancy command line editing or simple input
1213 as the user has requested. */
1216 command_line_input (const char *prompt_arg, int repeat, char *annotation_suffix)
1218 static struct buffer cmd_line_buffer;
1219 static int cmd_line_buffer_initialized;
1220 struct ui *ui = current_ui;
1221 const char *prompt = prompt_arg;
1223 int from_tty = ui->instream == ui->stdin_stream;
1225 /* The annotation suffix must be non-NULL. */
1226 if (annotation_suffix == NULL)
1227 annotation_suffix = "";
1229 if (from_tty && annotation_level > 1)
1234 = (char *) alloca ((prompt == NULL ? 0 : strlen (prompt))
1235 + strlen (annotation_suffix) + 40);
1237 local_prompt[0] = '\0';
1239 strcpy (local_prompt, prompt);
1240 strcat (local_prompt, "\n\032\032");
1241 strcat (local_prompt, annotation_suffix);
1242 strcat (local_prompt, "\n");
1244 prompt = local_prompt;
1247 if (!cmd_line_buffer_initialized)
1249 buffer_init (&cmd_line_buffer);
1250 cmd_line_buffer_initialized = 1;
1253 /* Starting a new command line. */
1254 cmd_line_buffer.used_size = 0;
1258 signal (STOP_SIGNAL, handle_stop_sig);
1265 /* Make sure that all output has been output. Some machines may
1266 let you get away with leaving out some of the gdb_flush, but
1269 gdb_flush (gdb_stdout);
1270 gdb_flush (gdb_stderr);
1272 if (source_file_name != NULL)
1273 ++source_line_number;
1275 if (from_tty && annotation_level > 1)
1277 puts_unfiltered ("\n\032\032pre-");
1278 puts_unfiltered (annotation_suffix);
1279 puts_unfiltered ("\n");
1282 /* Don't use fancy stuff if not talking to stdin. */
1283 if (deprecated_readline_hook
1285 && input_interactive_p (current_ui))
1287 rl = (*deprecated_readline_hook) (prompt);
1289 else if (command_editing_p
1291 && input_interactive_p (current_ui))
1293 rl = gdb_readline_wrapper (prompt);
1297 rl = gdb_readline_no_editing (prompt);
1300 cmd = handle_line_of_input (&cmd_line_buffer, rl,
1301 repeat, annotation_suffix);
1302 if (cmd == (char *) EOF)
1315 signal (STOP_SIGNAL, SIG_DFL);
1321 /* Print the GDB banner. */
1323 print_gdb_version (struct ui_file *stream)
1325 /* From GNU coding standards, first line is meant to be easy for a
1326 program to parse, and is just canonical program name and version
1327 number, which starts after last space. */
1329 fprintf_filtered (stream, "GNU gdb %s%s\n", PKGVERSION, version);
1331 /* Second line is a copyright notice. */
1333 fprintf_filtered (stream,
1334 "Copyright (C) 2017 Free Software Foundation, Inc.\n");
1336 /* Following the copyright is a brief statement that the program is
1337 free software, that users are free to copy and change it on
1338 certain conditions, that it is covered by the GNU GPL, and that
1339 there is no warranty. */
1341 fprintf_filtered (stream, "\
1342 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1343 \nThis is free software: you are free to change and redistribute it.\n\
1344 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1345 and \"show warranty\" for details.\n");
1347 /* After the required info we print the configuration information. */
1349 fprintf_filtered (stream, "This GDB was configured as \"");
1350 if (strcmp (host_name, target_name) != 0)
1352 fprintf_filtered (stream, "--host=%s --target=%s",
1353 host_name, target_name);
1357 fprintf_filtered (stream, "%s", host_name);
1359 fprintf_filtered (stream, "\".\n\
1360 Type \"show configuration\" for configuration details.");
1362 if (REPORT_BUGS_TO[0])
1364 fprintf_filtered (stream,
1365 _("\nFor bug reporting instructions, please see:\n"));
1366 fprintf_filtered (stream, "%s.\n", REPORT_BUGS_TO);
1368 fprintf_filtered (stream,
1369 _("Find the GDB manual and other documentation \
1370 resources online at:\n<http://www.gnu.org/software/gdb/documentation/>.\n"));
1371 fprintf_filtered (stream, _("For help, type \"help\".\n"));
1372 fprintf_filtered (stream, _("Type \"apropos word\" to search for \
1373 commands related to \"word\"."));
1376 /* Print the details of GDB build-time configuration. */
1378 print_gdb_configuration (struct ui_file *stream)
1380 fprintf_filtered (stream, _("\
1381 This GDB was configured as follows:\n\
1382 configure --host=%s --target=%s\n\
1383 "), host_name, target_name);
1384 fprintf_filtered (stream, _("\
1385 --with-auto-load-dir=%s\n\
1386 --with-auto-load-safe-path=%s\n\
1387 "), AUTO_LOAD_DIR, AUTO_LOAD_SAFE_PATH);
1389 fprintf_filtered (stream, _("\
1393 fprintf_filtered (stream, _("\
1398 fprintf_filtered (stream, _("\
1399 --with-gdb-datadir=%s%s\n\
1400 "), GDB_DATADIR, GDB_DATADIR_RELOCATABLE ? " (relocatable)" : "");
1402 fprintf_filtered (stream, _("\
1403 --with-iconv-bin=%s%s\n\
1404 "), ICONV_BIN, ICONV_BIN_RELOCATABLE ? " (relocatable)" : "");
1406 if (JIT_READER_DIR[0])
1407 fprintf_filtered (stream, _("\
1408 --with-jit-reader-dir=%s%s\n\
1409 "), JIT_READER_DIR, JIT_READER_DIR_RELOCATABLE ? " (relocatable)" : "");
1410 #if HAVE_LIBUNWIND_IA64_H
1411 fprintf_filtered (stream, _("\
1412 --with-libunwind-ia64\n\
1415 fprintf_filtered (stream, _("\
1416 --without-libunwind-ia64\n\
1420 fprintf_filtered (stream, _("\
1424 fprintf_filtered (stream, _("\
1428 #ifdef WITH_PYTHON_PATH
1429 fprintf_filtered (stream, _("\
1430 --with-python=%s%s\n\
1431 "), WITH_PYTHON_PATH, PYTHON_PATH_RELOCATABLE ? " (relocatable)" : "");
1434 fprintf_filtered (stream, _("\
1438 fprintf_filtered (stream, _("\
1443 fprintf_filtered (stream, _("\
1444 --with-relocated-sources=%s\n\
1448 fprintf_filtered (stream, _("\
1449 --with-separate-debug-dir=%s%s\n\
1450 "), DEBUGDIR, DEBUGDIR_RELOCATABLE ? " (relocatable)" : "");
1451 if (TARGET_SYSTEM_ROOT[0])
1452 fprintf_filtered (stream, _("\
1453 --with-sysroot=%s%s\n\
1454 "), TARGET_SYSTEM_ROOT, TARGET_SYSTEM_ROOT_RELOCATABLE ? " (relocatable)" : "");
1455 if (SYSTEM_GDBINIT[0])
1456 fprintf_filtered (stream, _("\
1457 --with-system-gdbinit=%s%s\n\
1458 "), SYSTEM_GDBINIT, SYSTEM_GDBINIT_RELOCATABLE ? " (relocatable)" : "");
1459 #if HAVE_LIBBABELTRACE
1460 fprintf_filtered (stream, _("\
1461 --with-babeltrace\n\
1464 fprintf_filtered (stream, _("\
1465 --without-babeltrace\n\
1468 /* We assume "relocatable" will be printed at least once, thus we always
1469 print this text. It's a reasonably safe assumption for now. */
1470 fprintf_filtered (stream, _("\n\
1471 (\"Relocatable\" means the directory can be moved with the GDB installation\n\
1472 tree, and GDB will still find it.)\n\
1477 /* The current top level prompt, settable with "set prompt", and/or
1478 with the python `gdb.prompt_hook' hook. */
1479 static char *top_prompt;
1481 /* Access method for the GDB prompt string. */
1489 /* Set method for the GDB prompt string. */
1492 set_prompt (const char *s)
1494 char *p = xstrdup (s);
1507 /* Callback for iterate_over_inferiors. Kills or detaches the given
1508 inferior, depending on how we originally gained control of it. */
1511 kill_or_detach (struct inferior *inf, void *args)
1513 struct qt_args *qt = (struct qt_args *) args;
1514 struct thread_info *thread;
1519 thread = any_thread_of_process (inf->pid);
1522 switch_to_thread (thread->ptid);
1524 /* Leave core files alone. */
1525 if (target_has_execution)
1527 if (inf->attach_flag)
1528 target_detach (qt->args, qt->from_tty);
1537 /* Callback for iterate_over_inferiors. Prints info about what GDB
1538 will do to each inferior on a "quit". ARG points to a struct
1539 ui_out where output is to be collected. */
1542 print_inferior_quit_action (struct inferior *inf, void *arg)
1544 struct ui_file *stb = (struct ui_file *) arg;
1549 if (inf->attach_flag)
1550 fprintf_filtered (stb,
1551 _("\tInferior %d [%s] will be detached.\n"), inf->num,
1552 target_pid_to_str (pid_to_ptid (inf->pid)));
1554 fprintf_filtered (stb,
1555 _("\tInferior %d [%s] will be killed.\n"), inf->num,
1556 target_pid_to_str (pid_to_ptid (inf->pid)));
1561 /* If necessary, make the user confirm that we should quit. Return
1562 non-zero if we should quit, zero if we shouldn't. */
1567 /* Don't even ask if we're only debugging a core file inferior. */
1568 if (!have_live_inferiors ())
1571 /* Build the query string as a single string. */
1574 stb.puts (_("A debugging session is active.\n\n"));
1575 iterate_over_inferiors (print_inferior_quit_action, &stb);
1576 stb.puts (_("\nQuit anyway? "));
1578 return query ("%s", stb.c_str ());
1581 /* Prepare to exit GDB cleanly by undoing any changes made to the
1582 terminal so that we leave the terminal in the state we acquired it. */
1585 undo_terminal_modifications_before_exit (void)
1587 struct ui *saved_top_level = current_ui;
1589 target_terminal_ours ();
1591 current_ui = main_ui;
1596 gdb_disable_readline ();
1598 current_ui = saved_top_level;
1602 /* Quit without asking for confirmation. */
1605 quit_force (int *exit_arg, int from_tty)
1610 undo_terminal_modifications_before_exit ();
1612 /* An optional expression may be used to cause gdb to terminate with the
1613 value of that expression. */
1615 exit_code = *exit_arg;
1616 else if (return_child_result)
1617 exit_code = return_child_result_value;
1620 qt.from_tty = from_tty;
1622 /* We want to handle any quit errors and exit regardless. */
1624 /* Get out of tfind mode, and kill or detach all inferiors. */
1627 disconnect_tracing ();
1628 iterate_over_inferiors (kill_or_detach, &qt);
1630 CATCH (ex, RETURN_MASK_ALL)
1632 exception_print (gdb_stderr, ex);
1636 /* Give all pushed targets a chance to do minimal cleanup, and pop
1642 CATCH (ex, RETURN_MASK_ALL)
1644 exception_print (gdb_stderr, ex);
1648 /* Save the history information if it is appropriate to do so. */
1651 if (write_history_p && history_filename)
1656 /* History is currently shared between all UIs. If there's
1657 any UI with a terminal, save history. */
1660 if (input_interactive_p (ui))
1668 gdb_safe_append_history ();
1671 CATCH (ex, RETURN_MASK_ALL)
1673 exception_print (gdb_stderr, ex);
1677 /* Do any final cleanups before exiting. */
1680 do_final_cleanups (all_cleanups ());
1682 CATCH (ex, RETURN_MASK_ALL)
1684 exception_print (gdb_stderr, ex);
1691 /* The value of the "interactive-mode" setting. */
1692 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
1694 /* Implement the "show interactive-mode" option. */
1697 show_interactive_mode (struct ui_file *file, int from_tty,
1698 struct cmd_list_element *c,
1701 if (interactive_mode == AUTO_BOOLEAN_AUTO)
1702 fprintf_filtered (file, "Debugger's interactive mode "
1703 "is %s (currently %s).\n",
1704 value, input_interactive_p (current_ui) ? "on" : "off");
1706 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
1709 /* Returns whether GDB is running on an interactive terminal. */
1712 input_interactive_p (struct ui *ui)
1717 if (interactive_mode != AUTO_BOOLEAN_AUTO)
1718 return interactive_mode == AUTO_BOOLEAN_TRUE;
1720 return ui->input_interactive_p;
1724 dont_repeat_command (char *ignored, int from_tty)
1726 /* Can't call dont_repeat here because we're not necessarily reading
1728 *saved_command_line = 0;
1731 /* Functions to manipulate command line editing control variables. */
1733 /* Number of commands to print in each call to show_commands. */
1734 #define Hist_print 10
1736 show_commands (char *args, int from_tty)
1738 /* Index for history commands. Relative to history_base. */
1741 /* Number of the history entry which we are planning to display next.
1742 Relative to history_base. */
1745 /* Print out some of the commands from the command history. */
1749 if (args[0] == '+' && args[1] == '\0')
1750 /* "info editing +" should print from the stored position. */
1753 /* "info editing <exp>" should print around command number <exp>. */
1754 num = (parse_and_eval_long (args) - history_base) - Hist_print / 2;
1756 /* "show commands" means print the last Hist_print commands. */
1759 num = history_length - Hist_print;
1765 /* If there are at least Hist_print commands, we want to display the last
1766 Hist_print rather than, say, the last 6. */
1767 if (history_length - num < Hist_print)
1769 num = history_length - Hist_print;
1775 offset < num + Hist_print && offset < history_length;
1778 printf_filtered ("%5d %s\n", history_base + offset,
1779 (history_get (history_base + offset))->line);
1782 /* The next command we want to display is the next one that we haven't
1786 /* If the user repeats this command with return, it should do what
1787 "show commands +" does. This is unnecessary if arg is null,
1788 because "show commands +" is not useful after "show commands". */
1789 if (from_tty && args)
1796 /* Update the size of our command history file to HISTORY_SIZE.
1798 A HISTORY_SIZE of -1 stands for unlimited. */
1801 set_readline_history_size (int history_size)
1803 gdb_assert (history_size >= -1);
1805 if (history_size == -1)
1806 unstifle_history ();
1808 stifle_history (history_size);
1811 /* Called by do_setshow_command. */
1813 set_history_size_command (char *args, int from_tty, struct cmd_list_element *c)
1815 set_readline_history_size (history_size_setshow_var);
1819 set_history (char *args, int from_tty)
1821 printf_unfiltered (_("\"set history\" must be followed "
1822 "by the name of a history subcommand.\n"));
1823 help_list (sethistlist, "set history ", all_commands, gdb_stdout);
1827 show_history (char *args, int from_tty)
1829 cmd_show_list (showhistlist, from_tty, "");
1832 int info_verbose = 0; /* Default verbose msgs off. */
1834 /* Called by do_setshow_command. An elaborate joke. */
1836 set_verbose (char *args, int from_tty, struct cmd_list_element *c)
1838 const char *cmdname = "verbose";
1839 struct cmd_list_element *showcmd;
1841 showcmd = lookup_cmd_1 (&cmdname, showlist, NULL, 1);
1842 gdb_assert (showcmd != NULL && showcmd != CMD_LIST_AMBIGUOUS);
1846 c->doc = "Set verbose printing of informational messages.";
1847 showcmd->doc = "Show verbose printing of informational messages.";
1851 c->doc = "Set verbosity.";
1852 showcmd->doc = "Show verbosity.";
1856 /* Init the history buffer. Note that we are called after the init file(s)
1857 have been read so that the user can change the history file via his
1858 .gdbinit file (for instance). The GDBHISTFILE environment variable
1859 overrides all of this. */
1866 tmpenv = getenv ("GDBHISTSIZE");
1873 tmpenv = skip_spaces (tmpenv);
1875 var = strtol (tmpenv, &endptr, 10);
1876 saved_errno = errno;
1877 endptr = skip_spaces (endptr);
1879 /* If GDBHISTSIZE is non-numeric then ignore it. If GDBHISTSIZE is the
1880 empty string, a negative number or a huge positive number (larger than
1881 INT_MAX) then set the history size to unlimited. Otherwise set our
1882 history size to the number we have read. This behavior is consistent
1883 with how bash handles HISTSIZE. */
1884 if (*endptr != '\0')
1886 else if (*tmpenv == '\0'
1889 /* On targets where INT_MAX == LONG_MAX, we have to look at
1890 errno after calling strtol to distinguish between a value that
1891 is exactly INT_MAX and an overflowing value that was clamped
1893 || (var == INT_MAX && saved_errno == ERANGE))
1894 history_size_setshow_var = -1;
1896 history_size_setshow_var = var;
1899 /* If neither the init file nor GDBHISTSIZE has set a size yet, pick the
1901 if (history_size_setshow_var == -2)
1902 history_size_setshow_var = 256;
1904 set_readline_history_size (history_size_setshow_var);
1906 tmpenv = getenv ("GDBHISTFILE");
1908 history_filename = xstrdup (tmpenv);
1909 else if (!history_filename)
1911 /* We include the current directory so that if the user changes
1912 directories the file written will be the same as the one
1915 /* No leading dots in file names are allowed on MSDOS. */
1916 history_filename = concat (current_directory, "/_gdb_history",
1919 history_filename = concat (current_directory, "/.gdb_history",
1923 read_history (history_filename);
1927 show_prompt (struct ui_file *file, int from_tty,
1928 struct cmd_list_element *c, const char *value)
1930 fprintf_filtered (file, _("Gdb's prompt is \"%s\".\n"), value);
1933 /* "set editing" command. */
1936 set_editing (char *args, int from_tty, struct cmd_list_element *c)
1938 change_line_handler (set_editing_cmd_var);
1939 /* Update the control variable so that MI's =cmd-param-changed event
1940 shows the correct value. */
1941 set_editing_cmd_var = current_ui->command_editing;
1945 show_editing (struct ui_file *file, int from_tty,
1946 struct cmd_list_element *c, const char *value)
1948 fprintf_filtered (file, _("Editing of command lines as "
1949 "they are typed is %s.\n"),
1950 current_ui->command_editing ? _("on") : _("off"));
1954 show_annotation_level (struct ui_file *file, int from_tty,
1955 struct cmd_list_element *c, const char *value)
1957 fprintf_filtered (file, _("Annotation_level is %s.\n"), value);
1961 show_exec_done_display_p (struct ui_file *file, int from_tty,
1962 struct cmd_list_element *c, const char *value)
1964 fprintf_filtered (file, _("Notification of completion for "
1965 "asynchronous execution commands is %s.\n"),
1969 /* New values of the "data-directory" parameter are staged here. */
1970 static char *staged_gdb_datadir;
1972 /* "set" command for the gdb_datadir configuration variable. */
1975 set_gdb_datadir (char *args, int from_tty, struct cmd_list_element *c)
1977 set_gdb_data_directory (staged_gdb_datadir);
1978 observer_notify_gdb_datadir_changed ();
1981 /* "show" command for the gdb_datadir configuration variable. */
1984 show_gdb_datadir (struct ui_file *file, int from_tty,
1985 struct cmd_list_element *c, const char *value)
1987 fprintf_filtered (file, _("GDB's data directory is \"%s\".\n"),
1992 set_history_filename (char *args, int from_tty, struct cmd_list_element *c)
1994 /* We include the current directory so that if the user changes
1995 directories the file written will be the same as the one
1997 if (!IS_ABSOLUTE_PATH (history_filename))
1998 history_filename = reconcat (history_filename, current_directory, "/",
1999 history_filename, (char *) NULL);
2005 struct cmd_list_element *c;
2007 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
2008 the DEFAULT_PROMPT is. */
2009 set_prompt (DEFAULT_PROMPT);
2011 /* Set the important stuff up for command editing. */
2012 command_editing_p = 1;
2013 history_expansion_p = 0;
2014 write_history_p = 0;
2016 /* Setup important stuff for command line editing. */
2017 rl_completion_word_break_hook = gdb_completion_word_break_characters;
2018 rl_completion_entry_function = readline_line_completion_function;
2019 rl_completer_word_break_characters = default_word_break_characters ();
2020 rl_completer_quote_characters = get_gdb_completer_quote_characters ();
2021 rl_completion_display_matches_hook = cli_display_match_list;
2022 rl_readline_name = "gdb";
2023 rl_terminal_name = getenv ("TERM");
2025 /* The name for this defun comes from Bash, where it originated.
2026 15 is Control-o, the same binding this function has in Bash. */
2027 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next, 15);
2029 add_setshow_string_cmd ("prompt", class_support,
2031 _("Set gdb's prompt"),
2032 _("Show gdb's prompt"),
2035 &setlist, &showlist);
2037 add_com ("dont-repeat", class_support, dont_repeat_command, _("\
2038 Don't repeat this command.\nPrimarily \
2039 used inside of user-defined commands that should not be repeated when\n\
2042 add_setshow_boolean_cmd ("editing", class_support,
2043 &set_editing_cmd_var, _("\
2044 Set editing of command lines as they are typed."), _("\
2045 Show editing of command lines as they are typed."), _("\
2046 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
2047 Without an argument, command line editing is enabled. To edit, use\n\
2048 EMACS-like or VI-like commands like control-P or ESC."),
2051 &setlist, &showlist);
2053 add_setshow_boolean_cmd ("save", no_class, &write_history_p, _("\
2054 Set saving of the history record on exit."), _("\
2055 Show saving of the history record on exit."), _("\
2056 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
2057 Without an argument, saving is enabled."),
2059 show_write_history_p,
2060 &sethistlist, &showhistlist);
2062 add_setshow_zuinteger_unlimited_cmd ("size", no_class,
2063 &history_size_setshow_var, _("\
2064 Set the size of the command history,"), _("\
2065 Show the size of the command history,"), _("\
2066 ie. the number of previous commands to keep a record of.\n\
2067 If set to \"unlimited\", the number of commands kept in the history\n\
2068 list is unlimited. This defaults to the value of the environment\n\
2069 variable \"GDBHISTSIZE\", or to 256 if this variable is not set."),
2070 set_history_size_command,
2072 &sethistlist, &showhistlist);
2074 add_setshow_zuinteger_unlimited_cmd ("remove-duplicates", no_class,
2075 &history_remove_duplicates, _("\
2076 Set how far back in history to look for and remove duplicate entries."), _("\
2077 Show how far back in history to look for and remove duplicate entries."), _("\
2078 If set to a nonzero value N, GDB will look back at the last N history entries\n\
2079 and remove the first history entry that is a duplicate of the most recent\n\
2080 entry, each time a new history entry is added.\n\
2081 If set to \"unlimited\", this lookbehind is unbounded.\n\
2082 Only history entries added during this session are considered for removal.\n\
2083 If set to 0, removal of duplicate history entries is disabled.\n\
2084 By default this option is set to 0."),
2086 show_history_remove_duplicates,
2087 &sethistlist, &showhistlist);
2089 add_setshow_filename_cmd ("filename", no_class, &history_filename, _("\
2090 Set the filename in which to record the command history"), _("\
2091 Show the filename in which to record the command history"), _("\
2092 (the list of previous commands of which a record is kept)."),
2093 set_history_filename,
2094 show_history_filename,
2095 &sethistlist, &showhistlist);
2097 add_setshow_boolean_cmd ("confirm", class_support, &confirm, _("\
2098 Set whether to confirm potentially dangerous operations."), _("\
2099 Show whether to confirm potentially dangerous operations."), NULL,
2102 &setlist, &showlist);
2104 add_setshow_zinteger_cmd ("annotate", class_obscure, &annotation_level, _("\
2105 Set annotation_level."), _("\
2106 Show annotation_level."), _("\
2107 0 == normal; 1 == fullname (for use when running under emacs)\n\
2108 2 == output annotated suitably for use by programs that control GDB."),
2110 show_annotation_level,
2111 &setlist, &showlist);
2113 add_setshow_boolean_cmd ("exec-done-display", class_support,
2114 &exec_done_display_p, _("\
2115 Set notification of completion for asynchronous execution commands."), _("\
2116 Show notification of completion for asynchronous execution commands."), _("\
2117 Use \"on\" to enable the notification, and \"off\" to disable it."),
2119 show_exec_done_display_p,
2120 &setlist, &showlist);
2122 add_setshow_filename_cmd ("data-directory", class_maintenance,
2123 &staged_gdb_datadir, _("Set GDB's data directory."),
2124 _("Show GDB's data directory."),
2126 When set, GDB uses the specified path to search for data files."),
2127 set_gdb_datadir, show_gdb_datadir,
2131 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
2132 &interactive_mode, _("\
2133 Set whether GDB's standard input is a terminal."), _("\
2134 Show whether GDB's standard input is a terminal."), _("\
2135 If on, GDB assumes that standard input is a terminal. In practice, it\n\
2136 means that GDB should wait for the user to answer queries associated to\n\
2137 commands entered at the command prompt. If off, GDB assumes that standard\n\
2138 input is not a terminal, and uses the default answer to all queries.\n\
2139 If auto (the default), determine which mode to use based on the standard\n\
2142 show_interactive_mode,
2143 &setlist, &showlist);
2145 c = add_cmd ("new-ui", class_support, new_ui_command, _("\
2146 Create a new UI. It takes two arguments:\n\
2147 The first argument is the name of the interpreter to run.\n\
2148 The second argument is the terminal the UI runs on.\n"), &cmdlist);
2149 set_cmd_completer (c, interpreter_completer);
2153 gdb_init (char *argv0)
2155 if (pre_init_ui_hook)
2156 pre_init_ui_hook ();
2158 /* Run the init function of each source file. */
2161 /* Make sure we return to the original directory upon exit, come
2162 what may, since the OS doesn't do that for us. */
2163 make_final_cleanup (do_chdir_cleanup, xstrdup (current_directory));
2166 init_cmd_lists (); /* This needs to be done first. */
2167 initialize_targets (); /* Setup target_terminal macros for utils.c. */
2168 initialize_utils (); /* Make errors and warnings possible. */
2172 /* Here is where we call all the _initialize_foo routines. */
2173 initialize_all_files ();
2175 /* This creates the current_program_space. Do this after all the
2176 _initialize_foo routines have had a chance to install their
2177 per-sspace data keys. Also do this before
2178 initialize_current_architecture is called, because it accesses
2179 exec_bfd of the current program space. */
2180 initialize_progspace ();
2181 initialize_inferiors ();
2182 initialize_current_architecture ();
2184 init_main (); /* But that omits this file! Do it now. */
2186 initialize_stdin_serial ();
2188 /* Take a snapshot of our tty state before readline/ncurses have had a chance
2190 set_initial_gdb_ttystate ();
2192 async_init_signals ();
2194 /* We need a default language for parsing expressions, so simple
2195 things like "set width 0" won't fail if no language is explicitly
2196 set in a config file or implicitly set by reading an executable
2198 set_language (language_c);
2199 expected_language = current_language; /* Don't warn about the change. */
2201 /* Python initialization, for example, can require various commands to be
2202 installed. For example "info pretty-printer" needs the "info"
2203 prefix to be installed. Keep things simple and just do final
2204 script initialization here. */
2205 finish_ext_lang_initialization ();