1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2013 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"
28 #include "exceptions.h"
31 #include "breakpoint.h"
33 #include "expression.h"
36 #include "terminal.h" /* For job_control. */
38 #include "completer.h"
43 #include "gdb_assert.h"
45 #include "event-loop.h"
46 #include "gdbthread.h"
47 #include "python/python.h"
52 /* readline include files. */
53 #include "readline/readline.h"
54 #include "readline/history.h"
56 /* readline defines this. */
59 #include <sys/types.h>
61 #include "event-top.h"
62 #include "gdb_string.h"
68 extern void initialize_all_files (void);
70 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
71 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
72 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
74 /* Default command line prompt. This is overriden in some configs. */
76 #ifndef DEFAULT_PROMPT
77 #define DEFAULT_PROMPT "(gdb) "
80 /* Initialization file name for gdb. This is overridden in some configs. */
84 # define PATH_MAX FILENAME_MAX
90 #ifndef GDBINIT_FILENAME
91 #define GDBINIT_FILENAME ".gdbinit"
93 char gdbinit
[PATH_MAX
+ 1] = GDBINIT_FILENAME
;
95 int inhibit_gdbinit
= 0;
97 /* If nonzero, and GDB has been configured to be able to use windows,
98 attempt to open them upon startup. */
102 extern char lang_frame_mismatch_warn
[]; /* language.c */
104 /* Flag for whether we want to confirm potentially dangerous
105 operations. Default is yes. */
110 show_confirm (struct ui_file
*file
, int from_tty
,
111 struct cmd_list_element
*c
, const char *value
)
113 fprintf_filtered (file
, _("Whether to confirm potentially "
114 "dangerous operations is %s.\n"),
118 /* stdio stream that command input is being read from. Set to stdin
119 normally. Set by source_command to the file we are sourcing. Set
120 to NULL if we are executing a user-defined command or interacting
125 /* Flag to indicate whether a user defined command is currently running. */
129 /* Current working directory. */
131 char *current_directory
;
133 /* The directory name is actually stored here (usually). */
134 char gdb_dirbuf
[1024];
136 /* Function to call before reading a command, if nonzero.
137 The function receives two args: an input stream,
138 and a prompt string. */
140 void (*window_hook
) (FILE *, char *);
142 /* Buffer used for reading command lines, and the size
143 allocated for it so far. */
145 char *saved_command_line
;
146 int saved_command_line_size
= 100;
148 /* Nonzero if the current command is modified by "server ". This
149 affects things like recording into the command history, commands
150 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
151 whatever) can issue its own commands and also send along commands
152 from the user, and have the user not notice that the user interface
153 is issuing commands too. */
156 /* Baud rate specified for talking to serial target systems. Default
157 is left as -1, so targets can choose their own defaults. */
158 /* FIXME: This means that "show remotebaud" and gr_files_info can
159 print -1 or (unsigned int)-1. This is a Bad User Interface. */
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. */
194 /* Hooks for alternate command interfaces. */
196 /* Called after most modules have been initialized, but before taking
199 If the UI fails to initialize and it wants GDB to continue using
200 the default UI, then it should clear this hook before returning. */
202 void (*deprecated_init_ui_hook
) (char *argv0
);
204 /* This hook is called from within gdb's many mini-event loops which
205 could steal control from a real user interface's event loop. It
206 returns non-zero if the user is requesting a detach, zero
209 int (*deprecated_ui_loop_hook
) (int);
211 /* Called instead of command_loop at top level. Can be invoked via
212 throw_exception(). */
214 void (*deprecated_command_loop_hook
) (void);
217 /* Called from print_frame_info to list the line we stopped in. */
219 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
223 /* Replaces most of query. */
225 int (*deprecated_query_hook
) (const char *, va_list);
227 /* Replaces most of warning. */
229 void (*deprecated_warning_hook
) (const char *, va_list);
231 /* These three functions support getting lines of text from the user.
232 They are used in sequence. First deprecated_readline_begin_hook is
233 called with a text string that might be (for example) a message for
234 the user to type in a sequence of commands to be executed at a
235 breakpoint. If this function calls back to a GUI, it might take
236 this opportunity to pop up a text interaction window with this
237 message. Next, deprecated_readline_hook is called with a prompt
238 that is emitted prior to collecting the user input. It can be
239 called multiple times. Finally, deprecated_readline_end_hook is
240 called to notify the GUI that we are done with the interaction
241 window and it can close it. */
243 void (*deprecated_readline_begin_hook
) (char *, ...);
244 char *(*deprecated_readline_hook
) (char *);
245 void (*deprecated_readline_end_hook
) (void);
247 /* Called as appropriate to notify the interface that we have attached
248 to or detached from an already running process. */
250 void (*deprecated_attach_hook
) (void);
251 void (*deprecated_detach_hook
) (void);
253 /* Called during long calculations to allow GUI to repair window
254 damage, and to check for stop buttons, etc... */
256 void (*deprecated_interactive_hook
) (void);
258 /* Tell the GUI someone changed the register REGNO. -1 means
259 that the caller does not know which register changed or
260 that several registers have changed (see value_assign). */
261 void (*deprecated_register_changed_hook
) (int regno
);
263 /* Called when going to wait for the target. Usually allows the GUI
264 to run while waiting for target events. */
266 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
267 struct target_waitstatus
*status
,
270 /* Used by UI as a wrapper around command execution. May do various
271 things like enabling/disabling buttons, etc... */
273 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
274 char *cmd
, int from_tty
);
276 /* Called after a `set' command has finished. Is only run if the
277 `set' command succeeded. */
279 void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
281 /* Called when the current thread changes. Argument is thread id. */
283 void (*deprecated_context_hook
) (int id
);
285 /* Handler for SIGHUP. */
288 /* NOTE 1999-04-29: This function will be static again, once we modify
289 gdb to use the event loop as the default command loop and we merge
290 event-top.c into this file, top.c. */
294 /* Stop asking user for confirmation --- we're exiting. This
295 prevents asking the user dumb questions. */
297 quit_command ((char *) 0, 0);
299 #endif /* defined SIGHUP */
301 /* Line number we are currently in, in a file which is being sourced. */
302 /* NOTE 1999-04-29: This variable will be static again, once we modify
303 gdb to use the event loop as the default command loop and we merge
304 event-top.c into this file, top.c. */
305 /* static */ int source_line_number
;
307 /* Name of the file we are sourcing. */
308 /* NOTE 1999-04-29: This variable will be static again, once we modify
309 gdb to use the event loop as the default command loop and we merge
310 event-top.c into this file, top.c. */
311 /* static */ const char *source_file_name
;
313 /* Clean up on error during a "source" command (or execution of a
314 user-defined command). */
317 do_restore_instream_cleanup (void *stream
)
319 /* Restore the previous input stream. */
323 /* Read commands from STREAM. */
325 read_command_file (FILE *stream
)
327 struct cleanup
*cleanups
;
329 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
332 do_cleanups (cleanups
);
335 void (*pre_init_ui_hook
) (void);
339 do_chdir_cleanup (void *old_dir
)
347 prepare_execute_command (void)
350 struct cleanup
*cleanup
;
352 mark
= value_mark ();
353 cleanup
= make_cleanup_value_free_to_mark (mark
);
355 /* With multiple threads running while the one we're examining is
356 stopped, the dcache can get stale without us being able to detect
357 it. For the duration of the command, though, use the dcache to
358 help things like backtrace. */
360 target_dcache_invalidate ();
365 /* Tell the user if the language has changed (except first time) after
366 executing a command. */
369 check_frame_language_change (void)
371 static int warned
= 0;
373 /* First make sure that a new frame has been selected, in case the
374 command or the hooks changed the program state. */
375 deprecated_safe_get_selected_frame ();
376 if (current_language
!= expected_language
)
378 if (language_mode
== language_mode_auto
&& info_verbose
)
380 language_info (1); /* Print what changed. */
385 /* Warn the user if the working language does not match the language
386 of the current frame. Only warn the user if we are actually
387 running the program, i.e. there is a stack. */
388 /* FIXME: This should be cacheing the frame and only running when
389 the frame changes. */
391 if (has_stack_frames ())
395 flang
= get_frame_language ();
397 && flang
!= language_unknown
398 && flang
!= current_language
->la_language
)
400 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
406 /* Execute the line P as a command, in the current user context.
407 Pass FROM_TTY as second argument to the defining function. */
410 execute_command (char *p
, int from_tty
)
412 struct cleanup
*cleanup_if_error
, *cleanup
;
413 struct cmd_list_element
*c
;
416 cleanup_if_error
= make_bpstat_clear_actions_cleanup ();
417 cleanup
= prepare_execute_command ();
419 /* Force cleanup of any alloca areas if using C alloca instead of
423 /* This can happen when command_line_input hits end of file. */
426 do_cleanups (cleanup
);
430 target_log_command (p
);
432 while (*p
== ' ' || *p
== '\t')
440 /* If trace-commands is set then this will print this command. */
441 print_command_trace (p
);
443 c
= lookup_cmd (&cmd
, cmdlist
, "", 0, 1);
446 /* Pass null arg rather than an empty one. */
449 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
450 while the is_complete_command(cfunc) test is just plain
451 bogus. They should both be replaced by a test of the form
452 c->strip_trailing_white_space_p. */
453 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
454 can't be replaced with func. This is because it is the
455 cfunc, and not the func, that has the value that the
456 is_complete_command hack is testing for. */
457 /* Clear off trailing whitespace, except for set and complete
460 && c
->type
!= set_cmd
461 && !is_complete_command (c
))
463 p
= arg
+ strlen (arg
) - 1;
464 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
469 /* If this command has been pre-hooked, run the hook first. */
470 execute_cmd_pre_hook (c
);
472 if (c
->flags
& DEPRECATED_WARN_USER
)
473 deprecated_cmd_warning (line
);
475 /* c->user_commands would be NULL in the case of a python command. */
476 if (c
->class == class_user
&& c
->user_commands
)
477 execute_user_command (c
, arg
);
478 else if (c
->type
== set_cmd
)
479 do_set_command (arg
, from_tty
, c
);
480 else if (c
->type
== show_cmd
)
481 do_show_command (arg
, from_tty
, c
);
482 else if (!cmd_func_p (c
))
483 error (_("That is not a command, just a help topic."));
484 else if (deprecated_call_command_hook
)
485 deprecated_call_command_hook (c
, arg
, from_tty
);
487 cmd_func (c
, arg
, from_tty
);
489 /* If the interpreter is in sync mode (we're running a user
490 command's list, running command hooks or similars), and we
491 just ran a synchronous command that started the target, wait
492 for that command to end. */
493 if (!interpreter_async
&& sync_execution
)
495 while (gdb_do_one_event () >= 0)
500 /* If this command has been post-hooked, run the hook last. */
501 execute_cmd_post_hook (c
);
505 check_frame_language_change ();
507 do_cleanups (cleanup
);
508 discard_cleanups (cleanup_if_error
);
511 /* Run execute_command for P and FROM_TTY. Capture its output into the
512 returned string, do not display it to the screen. BATCH_FLAG will be
513 temporarily set to true. */
516 execute_command_to_string (char *p
, int from_tty
)
518 struct ui_file
*str_file
;
519 struct cleanup
*cleanup
;
522 /* GDB_STDOUT should be better already restored during these
523 restoration callbacks. */
524 cleanup
= set_batch_flag_and_make_cleanup_restore_page_info ();
526 make_cleanup_restore_integer (&interpreter_async
);
527 interpreter_async
= 0;
529 str_file
= mem_fileopen ();
531 make_cleanup_ui_file_delete (str_file
);
532 make_cleanup_restore_ui_file (&gdb_stdout
);
533 make_cleanup_restore_ui_file (&gdb_stderr
);
534 make_cleanup_restore_ui_file (&gdb_stdlog
);
535 make_cleanup_restore_ui_file (&gdb_stdtarg
);
536 make_cleanup_restore_ui_file (&gdb_stdtargerr
);
538 if (ui_out_redirect (current_uiout
, str_file
) < 0)
539 warning (_("Current output protocol does not support redirection"));
541 make_cleanup_ui_out_redirect_pop (current_uiout
);
543 gdb_stdout
= str_file
;
544 gdb_stderr
= str_file
;
545 gdb_stdlog
= str_file
;
546 gdb_stdtarg
= str_file
;
547 gdb_stdtargerr
= str_file
;
549 execute_command (p
, from_tty
);
551 retval
= ui_file_xstrdup (str_file
, NULL
);
553 do_cleanups (cleanup
);
558 /* Read commands from `instream' and execute them
559 until end of file or error reading instream. */
564 struct cleanup
*old_chain
;
566 int stdin_is_tty
= ISATTY (stdin
);
568 while (instream
&& !feof (instream
))
570 if (window_hook
&& instream
== stdin
)
571 (*window_hook
) (instream
, get_prompt ());
574 if (instream
== stdin
&& stdin_is_tty
)
575 reinitialize_more_filter ();
576 old_chain
= make_cleanup (null_cleanup
, 0);
578 /* Get a command-line. This calls the readline package. */
579 command
= command_line_input (instream
== stdin
?
580 get_prompt () : (char *) NULL
,
581 instream
== stdin
, "prompt");
584 do_cleanups (old_chain
);
588 make_command_stats_cleanup (1);
590 execute_command (command
, instream
== stdin
);
592 /* Do any commands attached to breakpoint we are stopped at. */
593 bpstat_do_actions ();
595 do_cleanups (old_chain
);
599 /* When nonzero, cause dont_repeat to do nothing. This should only be
600 set via prevent_dont_repeat. */
602 static int suppress_dont_repeat
= 0;
604 /* Commands call this if they do not want to be repeated by null lines. */
609 if (suppress_dont_repeat
|| server_command
)
612 /* If we aren't reading from standard input, we are saving the last
613 thing read from stdin in line and don't want to delete it. Null
614 lines won't repeat here in any case. */
615 if (instream
== stdin
)
616 *saved_command_line
= 0;
619 /* Prevent dont_repeat from working, and return a cleanup that
620 restores the previous state. */
623 prevent_dont_repeat (void)
625 struct cleanup
*result
= make_cleanup_restore_integer (&suppress_dont_repeat
);
627 suppress_dont_repeat
= 1;
632 /* Read a line from the stream "instream" without command line editing.
634 It prints PROMPT_ARG once at the start.
635 Action is compatible with "readline", e.g. space for the result is
636 malloc'd and should be freed by the caller.
638 A NULL return means end of file. */
640 gdb_readline (char *prompt_arg
)
645 int result_size
= 80;
649 /* Don't use a _filtered function here. It causes the assumed
650 character position to be off, since the newline we read from
651 the user is not accounted for. */
652 fputs_unfiltered (prompt_arg
, gdb_stdout
);
653 gdb_flush (gdb_stdout
);
656 result
= (char *) xmalloc (result_size
);
660 /* Read from stdin if we are executing a user defined command.
661 This is the right thing for prompt_for_continue, at least. */
662 c
= fgetc (instream
? instream
: stdin
);
667 /* The last line does not end with a newline. Return it, and
668 if we are called again fgetc will still return EOF and
669 we'll return NULL then. */
677 if (input_index
> 0 && result
[input_index
- 1] == '\r')
682 result
[input_index
++] = c
;
683 while (input_index
>= result_size
)
686 result
= (char *) xrealloc (result
, result_size
);
690 result
[input_index
++] = '\0';
694 /* Variables which control command line editing and history
695 substitution. These variables are given default values at the end
697 static int command_editing_p
;
699 /* NOTE 1999-04-29: This variable will be static again, once we modify
700 gdb to use the event loop as the default command loop and we merge
701 event-top.c into this file, top.c. */
703 /* static */ int history_expansion_p
;
705 static int write_history_p
;
707 show_write_history_p (struct ui_file
*file
, int from_tty
,
708 struct cmd_list_element
*c
, const char *value
)
710 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
714 static unsigned int history_size
;
716 show_history_size (struct ui_file
*file
, int from_tty
,
717 struct cmd_list_element
*c
, const char *value
)
719 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
723 static char *history_filename
;
725 show_history_filename (struct ui_file
*file
, int from_tty
,
726 struct cmd_list_element
*c
, const char *value
)
728 fprintf_filtered (file
, _("The filename in which to record "
729 "the command history is \"%s\".\n"),
733 /* This is like readline(), but it has some gdb-specific behavior.
734 gdb may want readline in both the synchronous and async modes during
735 a single gdb invocation. At the ordinary top-level prompt we might
736 be using the async readline. That means we can't use
737 rl_pre_input_hook, since it doesn't work properly in async mode.
738 However, for a secondary prompt (" >", such as occurs during a
739 `define'), gdb wants a synchronous response.
741 We used to call readline() directly, running it in synchronous
742 mode. But mixing modes this way is not supported, and as of
743 readline 5.x it no longer works; the arrow keys come unbound during
744 the synchronous call. So we make a nested call into the event
745 loop. That's what gdb_readline_wrapper is for. */
747 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
748 rely on gdb_readline_wrapper_result, which might still be NULL if
749 the user types Control-D for EOF. */
750 static int gdb_readline_wrapper_done
;
752 /* The result of the current call to gdb_readline_wrapper, once a newline
754 static char *gdb_readline_wrapper_result
;
756 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
757 to be called after the newline is processed (which will redisplay
758 the prompt). But in gdb_readline_wrapper we will not get a new
759 prompt until the next call, or until we return to the event loop.
760 So we disable this hook around the newline and restore it before we
762 static void (*saved_after_char_processing_hook
) (void);
764 /* This function is called when readline has seen a complete line of
768 gdb_readline_wrapper_line (char *line
)
770 gdb_assert (!gdb_readline_wrapper_done
);
771 gdb_readline_wrapper_result
= line
;
772 gdb_readline_wrapper_done
= 1;
774 /* Prevent operate-and-get-next from acting too early. */
775 saved_after_char_processing_hook
= after_char_processing_hook
;
776 after_char_processing_hook
= NULL
;
778 /* Prevent parts of the prompt from being redisplayed if annotations
779 are enabled, and readline's state getting out of sync. */
780 if (async_command_editing_p
)
781 rl_callback_handler_remove ();
784 struct gdb_readline_wrapper_cleanup
786 void (*handler_orig
) (char *);
787 int already_prompted_orig
;
791 gdb_readline_wrapper_cleanup (void *arg
)
793 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
795 rl_already_prompted
= cleanup
->already_prompted_orig
;
797 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
798 input_handler
= cleanup
->handler_orig
;
799 gdb_readline_wrapper_result
= NULL
;
800 gdb_readline_wrapper_done
= 0;
802 after_char_processing_hook
= saved_after_char_processing_hook
;
803 saved_after_char_processing_hook
= NULL
;
809 gdb_readline_wrapper (char *prompt
)
811 struct cleanup
*back_to
;
812 struct gdb_readline_wrapper_cleanup
*cleanup
;
815 cleanup
= xmalloc (sizeof (*cleanup
));
816 cleanup
->handler_orig
= input_handler
;
817 input_handler
= gdb_readline_wrapper_line
;
819 cleanup
->already_prompted_orig
= rl_already_prompted
;
821 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
823 /* Display our prompt and prevent double prompt display. */
824 display_gdb_prompt (prompt
);
825 rl_already_prompted
= 1;
827 if (after_char_processing_hook
)
828 (*after_char_processing_hook
) ();
829 gdb_assert (after_char_processing_hook
== NULL
);
831 while (gdb_do_one_event () >= 0)
832 if (gdb_readline_wrapper_done
)
835 retval
= gdb_readline_wrapper_result
;
836 do_cleanups (back_to
);
841 /* The current saved history number from operate-and-get-next.
842 This is -1 if not valid. */
843 static int operate_saved_history
= -1;
845 /* This is put on the appropriate hook and helps operate-and-get-next
848 gdb_rl_operate_and_get_next_completion (void)
850 int delta
= where_history () - operate_saved_history
;
852 /* The `key' argument to rl_get_previous_history is ignored. */
853 rl_get_previous_history (delta
, 0);
854 operate_saved_history
= -1;
856 /* readline doesn't automatically update the display for us. */
859 after_char_processing_hook
= NULL
;
860 rl_pre_input_hook
= NULL
;
863 /* This is a gdb-local readline command handler. It accepts the
864 current command line (like RET does) and, if this command was taken
865 from the history, arranges for the next command in the history to
866 appear on the command line when the prompt returns.
867 We ignore the arguments. */
869 gdb_rl_operate_and_get_next (int count
, int key
)
873 /* Use the async hook. */
874 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
876 /* Find the current line, and find the next line to use. */
877 where
= where_history();
879 /* FIXME: kettenis/20020817: max_input_history is renamed into
880 history_max_entries in readline-4.2. When we do a new readline
881 import, we should probably change it here too, even though
882 readline maintains backwards compatibility for now by still
883 defining max_input_history. */
884 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
885 (where
>= history_length
- 1))
886 operate_saved_history
= where
;
888 operate_saved_history
= where
+ 1;
890 return rl_newline (1, key
);
893 /* Read one line from the command input stream `instream'
894 into the local static buffer `linebuffer' (whose current length
896 The buffer is made bigger as necessary.
897 Returns the address of the start of the line.
899 NULL is returned for end of file.
901 *If* the instream == stdin & stdin is a terminal, the line read
902 is copied into the file line saver (global var char *line,
903 length linesize) so that it can be duplicated.
905 This routine either uses fancy command line editing or
906 simple input as the user has requested. */
909 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
911 static char *linebuffer
= 0;
912 static unsigned linelength
= 0;
916 char *local_prompt
= prompt_arg
;
920 /* The annotation suffix must be non-NULL. */
921 if (annotation_suffix
== NULL
)
922 annotation_suffix
= "";
924 if (annotation_level
> 1 && instream
== stdin
)
926 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
927 + strlen (annotation_suffix
) + 40);
928 if (prompt_arg
== NULL
)
929 local_prompt
[0] = '\0';
931 strcpy (local_prompt
, prompt_arg
);
932 strcat (local_prompt
, "\n\032\032");
933 strcat (local_prompt
, annotation_suffix
);
934 strcat (local_prompt
, "\n");
940 linebuffer
= (char *) xmalloc (linelength
);
945 /* Control-C quits instantly if typed while in this loop
946 since it should not wait until the user types a newline. */
951 signal (STOP_SIGNAL
, handle_stop_sig
);
956 /* Make sure that all output has been output. Some machines may
957 let you get away with leaving out some of the gdb_flush, but
960 gdb_flush (gdb_stdout
);
961 gdb_flush (gdb_stderr
);
963 if (source_file_name
!= NULL
)
964 ++source_line_number
;
966 if (annotation_level
> 1 && instream
== stdin
)
968 puts_unfiltered ("\n\032\032pre-");
969 puts_unfiltered (annotation_suffix
);
970 puts_unfiltered ("\n");
973 /* Don't use fancy stuff if not talking to stdin. */
974 if (deprecated_readline_hook
&& input_from_terminal_p ())
976 rl
= (*deprecated_readline_hook
) (local_prompt
);
978 else if (command_editing_p
&& input_from_terminal_p ())
980 rl
= gdb_readline_wrapper (local_prompt
);
984 rl
= gdb_readline (local_prompt
);
987 if (annotation_level
> 1 && instream
== stdin
)
989 puts_unfiltered ("\n\032\032post-");
990 puts_unfiltered (annotation_suffix
);
991 puts_unfiltered ("\n");
994 if (!rl
|| rl
== (char *) EOF
)
999 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
1001 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
1002 nline
= (char *) xrealloc (linebuffer
, linelength
);
1003 p
+= nline
- linebuffer
;
1007 /* Copy line. Don't copy null at end. (Leaves line alone
1008 if this was just a newline). */
1012 xfree (rl
); /* Allocated in readline. */
1014 if (p
== linebuffer
|| *(p
- 1) != '\\')
1017 p
--; /* Put on top of '\'. */
1018 local_prompt
= (char *) 0;
1023 signal (STOP_SIGNAL
, SIG_DFL
);
1030 #define SERVER_COMMAND_LENGTH 7
1032 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1033 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1036 /* Note that we don't set `line'. Between this and the check in
1037 dont_repeat, this insures that repeating will still do the
1040 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1043 /* Do history expansion if that is wished. */
1044 if (history_expansion_p
&& instream
== stdin
1045 && ISATTY (instream
))
1047 char *history_value
;
1050 *p
= '\0'; /* Insert null now. */
1051 expanded
= history_expand (linebuffer
, &history_value
);
1054 /* Print the changes. */
1055 printf_unfiltered ("%s\n", history_value
);
1057 /* If there was an error, call this function again. */
1060 xfree (history_value
);
1061 return command_line_input (prompt_arg
, repeat
,
1064 if (strlen (history_value
) > linelength
)
1066 linelength
= strlen (history_value
) + 1;
1067 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1069 strcpy (linebuffer
, history_value
);
1070 p
= linebuffer
+ strlen (linebuffer
);
1072 xfree (history_value
);
1075 /* If we just got an empty line, and that is supposed to repeat the
1076 previous command, return the value in the global buffer. */
1077 if (repeat
&& p
== linebuffer
)
1078 return saved_command_line
;
1079 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1081 return saved_command_line
;
1085 /* Add line to history if appropriate. */
1086 if (instream
== stdin
1087 && ISATTY (stdin
) && *linebuffer
)
1088 add_history (linebuffer
);
1090 /* Note: lines consisting solely of comments are added to the command
1091 history. This is useful when you type a command, and then
1092 realize you don't want to execute it quite yet. You can comment
1093 out the command and then later fetch it from the value history
1094 and remove the '#'. The kill ring is probably better, but some
1095 people are in the habit of commenting things out. */
1097 *p1
= '\0'; /* Found a comment. */
1099 /* Save into global buffer if appropriate. */
1102 if (linelength
> saved_command_line_size
)
1104 saved_command_line
= xrealloc (saved_command_line
, linelength
);
1105 saved_command_line_size
= linelength
;
1107 strcpy (saved_command_line
, linebuffer
);
1108 return saved_command_line
;
1114 /* Print the GDB banner. */
1116 print_gdb_version (struct ui_file
*stream
)
1118 /* From GNU coding standards, first line is meant to be easy for a
1119 program to parse, and is just canonical program name and version
1120 number, which starts after last space. */
1122 fprintf_filtered (stream
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1124 /* Second line is a copyright notice. */
1126 fprintf_filtered (stream
,
1127 "Copyright (C) 2013 Free Software Foundation, Inc.\n");
1129 /* Following the copyright is a brief statement that the program is
1130 free software, that users are free to copy and change it on
1131 certain conditions, that it is covered by the GNU GPL, and that
1132 there is no warranty. */
1134 fprintf_filtered (stream
, "\
1135 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1136 \nThis is free software: you are free to change and redistribute it.\n\
1137 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1138 and \"show warranty\" for details.\n");
1140 /* After the required info we print the configuration information. */
1142 fprintf_filtered (stream
, "This GDB was configured as \"");
1143 if (strcmp (host_name
, target_name
) != 0)
1145 fprintf_filtered (stream
, "--host=%s --target=%s",
1146 host_name
, target_name
);
1150 fprintf_filtered (stream
, "%s", host_name
);
1152 fprintf_filtered (stream
, "\".");
1154 if (REPORT_BUGS_TO
[0])
1156 fprintf_filtered (stream
,
1157 _("\nFor bug reporting instructions, please see:\n"));
1158 fprintf_filtered (stream
, "%s.", REPORT_BUGS_TO
);
1163 /* The current top level prompt, settable with "set prompt", and/or
1164 with the python `gdb.prompt_hook' hook. */
1165 static char *top_prompt
;
1167 /* Access method for the GDB prompt string. */
1175 /* Set method for the GDB prompt string. */
1178 set_prompt (const char *s
)
1180 char *p
= xstrdup (s
);
1193 /* Callback for iterate_over_inferiors. Kills or detaches the given
1194 inferior, depending on how we originally gained control of it. */
1197 kill_or_detach (struct inferior
*inf
, void *args
)
1199 struct qt_args
*qt
= args
;
1200 struct thread_info
*thread
;
1205 thread
= any_thread_of_process (inf
->pid
);
1208 switch_to_thread (thread
->ptid
);
1210 /* Leave core files alone. */
1211 if (target_has_execution
)
1213 if (inf
->attach_flag
)
1214 target_detach (qt
->args
, qt
->from_tty
);
1223 /* Callback for iterate_over_inferiors. Prints info about what GDB
1224 will do to each inferior on a "quit". ARG points to a struct
1225 ui_out where output is to be collected. */
1228 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1230 struct ui_file
*stb
= arg
;
1235 if (inf
->attach_flag
)
1236 fprintf_filtered (stb
,
1237 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1238 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1240 fprintf_filtered (stb
,
1241 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1242 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1247 /* If necessary, make the user confirm that we should quit. Return
1248 non-zero if we should quit, zero if we shouldn't. */
1253 struct ui_file
*stb
;
1254 struct cleanup
*old_chain
;
1258 /* Don't even ask if we're only debugging a core file inferior. */
1259 if (!have_live_inferiors ())
1262 /* Build the query string as a single string. */
1263 stb
= mem_fileopen ();
1264 old_chain
= make_cleanup_ui_file_delete (stb
);
1266 /* This is something of a hack. But there's no reliable way to see
1267 if a GUI is running. The `use_windows' variable doesn't cut
1269 if (deprecated_init_ui_hook
)
1270 fprintf_filtered (stb
, _("A debugging session is active.\n"
1271 "Do you still want to close the debugger?"));
1274 fprintf_filtered (stb
, _("A debugging session is active.\n\n"));
1275 iterate_over_inferiors (print_inferior_quit_action
, stb
);
1276 fprintf_filtered (stb
, _("\nQuit anyway? "));
1279 str
= ui_file_xstrdup (stb
, NULL
);
1280 make_cleanup (xfree
, str
);
1282 qr
= query ("%s", str
);
1283 do_cleanups (old_chain
);
1287 /* Helper routine for quit_force that requires error handling. */
1290 quit_target (void *arg
)
1292 struct qt_args
*qt
= (struct qt_args
*)arg
;
1294 /* Kill or detach all inferiors. */
1295 iterate_over_inferiors (kill_or_detach
, qt
);
1297 /* Give all pushed targets a chance to do minimal cleanup, and pop
1301 /* Save the history information if it is appropriate to do so. */
1302 if (write_history_p
&& history_filename
)
1303 write_history (history_filename
);
1305 do_final_cleanups (all_cleanups ()); /* Do any final cleanups before
1310 /* Quit without asking for confirmation. */
1313 quit_force (char *args
, int from_tty
)
1318 /* An optional expression may be used to cause gdb to terminate with the
1319 value of that expression. */
1322 struct value
*val
= parse_and_eval (args
);
1324 exit_code
= (int) value_as_long (val
);
1326 else if (return_child_result
)
1327 exit_code
= return_child_result_value
;
1330 qt
.from_tty
= from_tty
;
1332 /* We want to handle any quit errors and exit regardless. */
1333 catch_errors (quit_target
, &qt
,
1334 "Quitting: ", RETURN_MASK_ALL
);
1339 /* Returns whether GDB is running on a terminal and input is
1340 currently coming from that terminal. */
1343 input_from_terminal_p (void)
1348 if (gdb_has_a_terminal () && instream
== stdin
)
1351 /* If INSTREAM is unset, and we are not in a user command, we
1352 must be in Insight. That's like having a terminal, for our
1354 if (instream
== NULL
&& !in_user_command
)
1361 dont_repeat_command (char *ignored
, int from_tty
)
1363 /* Can't call dont_repeat here because we're not necessarily reading
1365 *saved_command_line
= 0;
1368 /* Functions to manipulate command line editing control variables. */
1370 /* Number of commands to print in each call to show_commands. */
1371 #define Hist_print 10
1373 show_commands (char *args
, int from_tty
)
1375 /* Index for history commands. Relative to history_base. */
1378 /* Number of the history entry which we are planning to display next.
1379 Relative to history_base. */
1382 /* The first command in the history which doesn't exist (i.e. one more
1383 than the number of the last command). Relative to history_base. */
1384 unsigned int hist_len
;
1386 /* Print out some of the commands from the command history. */
1387 /* First determine the length of the history list. */
1388 hist_len
= history_size
;
1389 for (offset
= 0; offset
< history_size
; offset
++)
1391 if (!history_get (history_base
+ offset
))
1400 if (args
[0] == '+' && args
[1] == '\0')
1401 /* "info editing +" should print from the stored position. */
1404 /* "info editing <exp>" should print around command number <exp>. */
1405 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1407 /* "show commands" means print the last Hist_print commands. */
1410 num
= hist_len
- Hist_print
;
1416 /* If there are at least Hist_print commands, we want to display the last
1417 Hist_print rather than, say, the last 6. */
1418 if (hist_len
- num
< Hist_print
)
1420 num
= hist_len
- Hist_print
;
1425 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1427 printf_filtered ("%5d %s\n", history_base
+ offset
,
1428 (history_get (history_base
+ offset
))->line
);
1431 /* The next command we want to display is the next one that we haven't
1435 /* If the user repeats this command with return, it should do what
1436 "show commands +" does. This is unnecessary if arg is null,
1437 because "show commands +" is not useful after "show commands". */
1438 if (from_tty
&& args
)
1445 /* Called by do_setshow_command. */
1447 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1449 /* The type of parameter in stifle_history is int, so values from INT_MAX up
1450 mean 'unlimited'. */
1451 if (history_size
>= INT_MAX
)
1453 /* Ensure that 'show history size' prints 'unlimited'. */
1454 history_size
= UINT_MAX
;
1455 unstifle_history ();
1458 stifle_history (history_size
);
1462 set_history (char *args
, int from_tty
)
1464 printf_unfiltered (_("\"set history\" must be followed "
1465 "by the name of a history subcommand.\n"));
1466 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1470 show_history (char *args
, int from_tty
)
1472 cmd_show_list (showhistlist
, from_tty
, "");
1475 int info_verbose
= 0; /* Default verbose msgs off. */
1477 /* Called by do_setshow_command. An elaborate joke. */
1479 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1481 const char *cmdname
= "verbose";
1482 struct cmd_list_element
*showcmd
;
1484 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1485 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1489 c
->doc
= "Set verbose printing of informational messages.";
1490 showcmd
->doc
= "Show verbose printing of informational messages.";
1494 c
->doc
= "Set verbosity.";
1495 showcmd
->doc
= "Show verbosity.";
1499 /* Init the history buffer. Note that we are called after the init file(s)
1500 have been read so that the user can change the history file via his
1501 .gdbinit file (for instance). The GDBHISTFILE environment variable
1502 overrides all of this. */
1509 tmpenv
= getenv ("HISTSIZE");
1511 history_size
= atoi (tmpenv
);
1512 else if (!history_size
)
1515 stifle_history (history_size
);
1517 tmpenv
= getenv ("GDBHISTFILE");
1519 history_filename
= xstrdup (tmpenv
);
1520 else if (!history_filename
)
1522 /* We include the current directory so that if the user changes
1523 directories the file written will be the same as the one
1526 /* No leading dots in file names are allowed on MSDOS. */
1527 history_filename
= concat (current_directory
, "/_gdb_history",
1530 history_filename
= concat (current_directory
, "/.gdb_history",
1534 read_history (history_filename
);
1538 show_prompt (struct ui_file
*file
, int from_tty
,
1539 struct cmd_list_element
*c
, const char *value
)
1541 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1545 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1546 struct cmd_list_element
*c
, const char *value
)
1548 fprintf_filtered (file
, _("Editing of command lines as "
1549 "they are typed is %s.\n"),
1554 show_annotation_level (struct ui_file
*file
, int from_tty
,
1555 struct cmd_list_element
*c
, const char *value
)
1557 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1561 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1562 struct cmd_list_element
*c
, const char *value
)
1564 fprintf_filtered (file
, _("Notification of completion for "
1565 "asynchronous execution commands is %s.\n"),
1569 /* "set" command for the gdb_datadir configuration variable. */
1572 set_gdb_datadir (char *args
, int from_tty
, struct cmd_list_element
*c
)
1574 observer_notify_gdb_datadir_changed ();
1580 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1581 the DEFAULT_PROMPT is. */
1582 set_prompt (DEFAULT_PROMPT
);
1584 /* Set things up for annotation_level > 1, if the user ever decides
1586 async_annotation_suffix
= "prompt";
1588 /* Set the important stuff up for command editing. */
1589 command_editing_p
= 1;
1590 history_expansion_p
= 0;
1591 write_history_p
= 0;
1593 /* Setup important stuff for command line editing. */
1594 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
1595 rl_completion_entry_function
= readline_line_completion_function
;
1596 rl_completer_word_break_characters
= default_word_break_characters ();
1597 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1598 rl_readline_name
= "gdb";
1599 rl_terminal_name
= getenv ("TERM");
1601 /* The name for this defun comes from Bash, where it originated.
1602 15 is Control-o, the same binding this function has in Bash. */
1603 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1605 add_setshow_string_cmd ("prompt", class_support
,
1607 _("Set gdb's prompt"),
1608 _("Show gdb's prompt"),
1611 &setlist
, &showlist
);
1613 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1614 Don't repeat this command.\nPrimarily \
1615 used inside of user-defined commands that should not be repeated when\n\
1618 add_setshow_boolean_cmd ("editing", class_support
,
1619 &async_command_editing_p
, _("\
1620 Set editing of command lines as they are typed."), _("\
1621 Show editing of command lines as they are typed."), _("\
1622 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1623 Without an argument, command line editing is enabled. To edit, use\n\
1624 EMACS-like or VI-like commands like control-P or ESC."),
1625 set_async_editing_command
,
1626 show_async_command_editing_p
,
1627 &setlist
, &showlist
);
1629 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1630 Set saving of the history record on exit."), _("\
1631 Show saving of the history record on exit."), _("\
1632 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1633 Without an argument, saving is enabled."),
1635 show_write_history_p
,
1636 &sethistlist
, &showhistlist
);
1638 add_setshow_uinteger_cmd ("size", no_class
, &history_size
, _("\
1639 Set the size of the command history,"), _("\
1640 Show the size of the command history,"), _("\
1641 ie. the number of previous commands to keep a record of."),
1642 set_history_size_command
,
1644 &sethistlist
, &showhistlist
);
1646 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1647 Set the filename in which to record the command history"), _("\
1648 Show the filename in which to record the command history"), _("\
1649 (the list of previous commands of which a record is kept)."),
1651 show_history_filename
,
1652 &sethistlist
, &showhistlist
);
1654 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
1655 Set whether to confirm potentially dangerous operations."), _("\
1656 Show whether to confirm potentially dangerous operations."), NULL
,
1659 &setlist
, &showlist
);
1661 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1662 Set annotation_level."), _("\
1663 Show annotation_level."), _("\
1664 0 == normal; 1 == fullname (for use when running under emacs)\n\
1665 2 == output annotated suitably for use by programs that control GDB."),
1667 show_annotation_level
,
1668 &setlist
, &showlist
);
1670 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1671 &exec_done_display_p
, _("\
1672 Set notification of completion for asynchronous execution commands."), _("\
1673 Show notification of completion for asynchronous execution commands."), _("\
1674 Use \"on\" to enable the notification, and \"off\" to disable it."),
1676 show_exec_done_display_p
,
1677 &setlist
, &showlist
);
1679 add_setshow_filename_cmd ("data-directory", class_maintenance
,
1680 &gdb_datadir
, _("Set GDB's data directory."),
1681 _("Show GDB's data directory."),
1683 When set, GDB uses the specified path to search for data files."),
1684 set_gdb_datadir
, NULL
,
1690 gdb_init (char *argv0
)
1692 if (pre_init_ui_hook
)
1693 pre_init_ui_hook ();
1695 /* Run the init function of each source file. */
1698 /* Make sure we return to the original directory upon exit, come
1699 what may, since the OS doesn't do that for us. */
1700 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1703 init_cmd_lists (); /* This needs to be done first. */
1704 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1705 initialize_utils (); /* Make errors and warnings possible. */
1707 /* Here is where we call all the _initialize_foo routines. */
1708 initialize_all_files ();
1710 /* This creates the current_program_space. Do this after all the
1711 _initialize_foo routines have had a chance to install their
1712 per-sspace data keys. Also do this before
1713 initialize_current_architecture is called, because it accesses
1714 exec_bfd of the current program space. */
1715 initialize_progspace ();
1716 initialize_inferiors ();
1717 initialize_current_architecture ();
1719 initialize_event_loop ();
1720 init_main (); /* But that omits this file! Do it now. */
1722 initialize_stdin_serial ();
1724 async_init_signals ();
1726 /* We need a default language for parsing expressions, so simple
1727 things like "set width 0" won't fail if no language is explicitly
1728 set in a config file or implicitly set by reading an executable
1730 set_language (language_c
);
1731 expected_language
= current_language
; /* Don't warn about the change. */
1733 /* Allow another UI to initialize. If the UI fails to initialize,
1734 and it wants GDB to revert to the CLI, it should clear
1735 deprecated_init_ui_hook. */
1736 if (deprecated_init_ui_hook
)
1737 deprecated_init_ui_hook (argv0
);
1740 /* Python initialization can require various commands to be
1741 installed. For example "info pretty-printer" needs the "info"
1742 prefix to be installed. Keep things simple and just do final
1743 python initialization here. */
1744 finish_python_initialization ();