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"
51 /* readline include files. */
52 #include "readline/readline.h"
53 #include "readline/history.h"
55 /* readline defines this. */
58 #include <sys/types.h>
60 #include "event-top.h"
61 #include "gdb_string.h"
67 extern void initialize_all_files (void);
69 #define PROMPT(X) the_prompts.prompt_stack[the_prompts.top + X].prompt
70 #define PREFIX(X) the_prompts.prompt_stack[the_prompts.top + X].prefix
71 #define SUFFIX(X) the_prompts.prompt_stack[the_prompts.top + X].suffix
73 /* Default command line prompt. This is overriden in some configs. */
75 #ifndef DEFAULT_PROMPT
76 #define DEFAULT_PROMPT "(gdb) "
79 /* Initialization file name for gdb. This is overridden in some configs. */
83 # define PATH_MAX FILENAME_MAX
89 #ifndef GDBINIT_FILENAME
90 #define GDBINIT_FILENAME ".gdbinit"
92 char gdbinit
[PATH_MAX
+ 1] = GDBINIT_FILENAME
;
94 int inhibit_gdbinit
= 0;
96 /* If nonzero, and GDB has been configured to be able to use windows,
97 attempt to open them upon startup. */
101 extern char lang_frame_mismatch_warn
[]; /* language.c */
103 /* Flag for whether we want to confirm potentially dangerous
104 operations. Default is yes. */
109 show_confirm (struct ui_file
*file
, int from_tty
,
110 struct cmd_list_element
*c
, const char *value
)
112 fprintf_filtered (file
, _("Whether to confirm potentially "
113 "dangerous operations is %s.\n"),
117 /* stdio stream that command input is being read from. Set to stdin
118 normally. Set by source_command to the file we are sourcing. Set
119 to NULL if we are executing a user-defined command or interacting
124 /* Flag to indicate whether a user defined command is currently running. */
128 /* Current working directory. */
130 char *current_directory
;
132 /* The directory name is actually stored here (usually). */
133 char gdb_dirbuf
[1024];
135 /* Function to call before reading a command, if nonzero.
136 The function receives two args: an input stream,
137 and a prompt string. */
139 void (*window_hook
) (FILE *, char *);
141 /* Buffer used for reading command lines, and the size
142 allocated for it so far. */
144 char *saved_command_line
;
145 int saved_command_line_size
= 100;
147 /* Nonzero if the current command is modified by "server ". This
148 affects things like recording into the command history, commands
149 repeating on RETURN, etc. This is so a user interface (emacs, GUI,
150 whatever) can issue its own commands and also send along commands
151 from the user, and have the user not notice that the user interface
152 is issuing commands too. */
155 /* Baud rate specified for talking to serial target systems. Default
156 is left as -1, so targets can choose their own defaults. */
157 /* FIXME: This means that "show remotebaud" and gr_files_info can
158 print -1 or (unsigned int)-1. This is a Bad User Interface. */
162 /* Timeout limit for response from target. */
164 /* The default value has been changed many times over the years. It
165 was originally 5 seconds. But that was thought to be a long time
166 to sit and wait, so it was changed to 2 seconds. That was thought
167 to be plenty unless the connection was going through some terminal
168 server or multiplexer or other form of hairy serial connection.
170 In mid-1996, remote_timeout was moved from remote.c to top.c and
171 it began being used in other remote-* targets. It appears that the
172 default was changed to 20 seconds at that time, perhaps because the
173 Renesas E7000 ICE didn't always respond in a timely manner.
175 But if 5 seconds is a long time to sit and wait for retransmissions,
176 20 seconds is far worse. This demonstrates the difficulty of using
177 a single variable for all protocol timeouts.
179 As remote.c is used much more than remote-e7000.c, it was changed
180 back to 2 seconds in 1999. */
182 int remote_timeout
= 2;
184 /* Non-zero tells remote* modules to output debugging info. */
186 int remote_debug
= 0;
188 /* Sbrk location on entry to main. Used for statistics only. */
193 /* Hooks for alternate command interfaces. */
195 /* Called after most modules have been initialized, but before taking
198 If the UI fails to initialize and it wants GDB to continue using
199 the default UI, then it should clear this hook before returning. */
201 void (*deprecated_init_ui_hook
) (char *argv0
);
203 /* This hook is called from within gdb's many mini-event loops which
204 could steal control from a real user interface's event loop. It
205 returns non-zero if the user is requesting a detach, zero
208 int (*deprecated_ui_loop_hook
) (int);
210 /* Called instead of command_loop at top level. Can be invoked via
211 throw_exception(). */
213 void (*deprecated_command_loop_hook
) (void);
216 /* Called from print_frame_info to list the line we stopped in. */
218 void (*deprecated_print_frame_info_listing_hook
) (struct symtab
* s
,
222 /* Replaces most of query. */
224 int (*deprecated_query_hook
) (const char *, va_list);
226 /* Replaces most of warning. */
228 void (*deprecated_warning_hook
) (const char *, va_list);
230 /* These three functions support getting lines of text from the user.
231 They are used in sequence. First deprecated_readline_begin_hook is
232 called with a text string that might be (for example) a message for
233 the user to type in a sequence of commands to be executed at a
234 breakpoint. If this function calls back to a GUI, it might take
235 this opportunity to pop up a text interaction window with this
236 message. Next, deprecated_readline_hook is called with a prompt
237 that is emitted prior to collecting the user input. It can be
238 called multiple times. Finally, deprecated_readline_end_hook is
239 called to notify the GUI that we are done with the interaction
240 window and it can close it. */
242 void (*deprecated_readline_begin_hook
) (char *, ...);
243 char *(*deprecated_readline_hook
) (char *);
244 void (*deprecated_readline_end_hook
) (void);
246 /* Called as appropriate to notify the interface that we have attached
247 to or detached from an already running process. */
249 void (*deprecated_attach_hook
) (void);
250 void (*deprecated_detach_hook
) (void);
252 /* Called during long calculations to allow GUI to repair window
253 damage, and to check for stop buttons, etc... */
255 void (*deprecated_interactive_hook
) (void);
257 /* Tell the GUI someone changed the register REGNO. -1 means
258 that the caller does not know which register changed or
259 that several registers have changed (see value_assign). */
260 void (*deprecated_register_changed_hook
) (int regno
);
262 /* Called when going to wait for the target. Usually allows the GUI
263 to run while waiting for target events. */
265 ptid_t (*deprecated_target_wait_hook
) (ptid_t ptid
,
266 struct target_waitstatus
*status
,
269 /* Used by UI as a wrapper around command execution. May do various
270 things like enabling/disabling buttons, etc... */
272 void (*deprecated_call_command_hook
) (struct cmd_list_element
* c
,
273 char *cmd
, int from_tty
);
275 /* Called after a `set' command has finished. Is only run if the
276 `set' command succeeded. */
278 void (*deprecated_set_hook
) (struct cmd_list_element
* c
);
280 /* Called when the current thread changes. Argument is thread id. */
282 void (*deprecated_context_hook
) (int id
);
284 /* Handler for SIGHUP. */
287 /* NOTE 1999-04-29: This function will be static again, once we modify
288 gdb to use the event loop as the default command loop and we merge
289 event-top.c into this file, top.c. */
293 /* Stop asking user for confirmation --- we're exiting. This
294 prevents asking the user dumb questions. */
296 quit_command ((char *) 0, 0);
298 #endif /* defined SIGHUP */
300 /* Line number we are currently in, in a file which is being sourced. */
301 /* NOTE 1999-04-29: This variable will be static again, once we modify
302 gdb to use the event loop as the default command loop and we merge
303 event-top.c into this file, top.c. */
304 /* static */ int source_line_number
;
306 /* Name of the file we are sourcing. */
307 /* NOTE 1999-04-29: This variable will be static again, once we modify
308 gdb to use the event loop as the default command loop and we merge
309 event-top.c into this file, top.c. */
310 /* static */ const char *source_file_name
;
312 /* Clean up on error during a "source" command (or execution of a
313 user-defined command). */
316 do_restore_instream_cleanup (void *stream
)
318 /* Restore the previous input stream. */
322 /* Read commands from STREAM. */
324 read_command_file (FILE *stream
)
326 struct cleanup
*cleanups
;
328 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
331 do_cleanups (cleanups
);
334 void (*pre_init_ui_hook
) (void);
338 do_chdir_cleanup (void *old_dir
)
346 prepare_execute_command (void)
349 struct cleanup
*cleanup
;
351 mark
= value_mark ();
352 cleanup
= make_cleanup_value_free_to_mark (mark
);
354 /* With multiple threads running while the one we're examining is
355 stopped, the dcache can get stale without us being able to detect
356 it. For the duration of the command, though, use the dcache to
357 help things like backtrace. */
359 target_dcache_invalidate ();
364 /* Tell the user if the language has changed (except first time) after
365 executing a command. */
368 check_frame_language_change (void)
370 static int warned
= 0;
372 /* First make sure that a new frame has been selected, in case the
373 command or the hooks changed the program state. */
374 deprecated_safe_get_selected_frame ();
375 if (current_language
!= expected_language
)
377 if (language_mode
== language_mode_auto
&& info_verbose
)
379 language_info (1); /* Print what changed. */
384 /* Warn the user if the working language does not match the language
385 of the current frame. Only warn the user if we are actually
386 running the program, i.e. there is a stack. */
387 /* FIXME: This should be cacheing the frame and only running when
388 the frame changes. */
390 if (has_stack_frames ())
394 flang
= get_frame_language ();
396 && flang
!= language_unknown
397 && flang
!= current_language
->la_language
)
399 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
405 /* Execute the line P as a command, in the current user context.
406 Pass FROM_TTY as second argument to the defining function. */
409 execute_command (char *p
, int from_tty
)
411 struct cleanup
*cleanup_if_error
, *cleanup
;
412 struct cmd_list_element
*c
;
415 cleanup_if_error
= make_bpstat_clear_actions_cleanup ();
416 cleanup
= prepare_execute_command ();
418 /* Force cleanup of any alloca areas if using C alloca instead of
422 /* This can happen when command_line_input hits end of file. */
425 do_cleanups (cleanup
);
429 target_log_command (p
);
431 while (*p
== ' ' || *p
== '\t')
438 /* If trace-commands is set then this will print this command. */
439 print_command_trace (p
);
441 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
443 /* Pass null arg rather than an empty one. */
446 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
447 while the is_complete_command(cfunc) test is just plain
448 bogus. They should both be replaced by a test of the form
449 c->strip_trailing_white_space_p. */
450 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
451 can't be replaced with func. This is because it is the
452 cfunc, and not the func, that has the value that the
453 is_complete_command hack is testing for. */
454 /* Clear off trailing whitespace, except for set and complete
457 && c
->type
!= set_cmd
458 && !is_complete_command (c
))
460 p
= arg
+ strlen (arg
) - 1;
461 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
466 /* If this command has been pre-hooked, run the hook first. */
467 execute_cmd_pre_hook (c
);
469 if (c
->flags
& DEPRECATED_WARN_USER
)
470 deprecated_cmd_warning (&line
);
472 /* c->user_commands would be NULL in the case of a python command. */
473 if (c
->class == class_user
&& c
->user_commands
)
474 execute_user_command (c
, arg
);
475 else if (c
->type
== set_cmd
)
476 do_set_command (arg
, from_tty
, c
);
477 else if (c
->type
== show_cmd
)
478 do_show_command (arg
, from_tty
, c
);
479 else if (!cmd_func_p (c
))
480 error (_("That is not a command, just a help topic."));
481 else if (deprecated_call_command_hook
)
482 deprecated_call_command_hook (c
, arg
, from_tty
);
484 cmd_func (c
, arg
, from_tty
);
486 /* If the interpreter is in sync mode (we're running a user
487 command's list, running command hooks or similars), and we
488 just ran a synchronous command that started the target, wait
489 for that command to end. */
490 if (!interpreter_async
&& sync_execution
)
492 while (gdb_do_one_event () >= 0)
497 /* If this command has been post-hooked, run the hook last. */
498 execute_cmd_post_hook (c
);
502 check_frame_language_change ();
504 do_cleanups (cleanup
);
505 discard_cleanups (cleanup_if_error
);
508 /* Run execute_command for P and FROM_TTY. Capture its output into the
509 returned string, do not display it to the screen. BATCH_FLAG will be
510 temporarily set to true. */
513 execute_command_to_string (char *p
, int from_tty
)
515 struct ui_file
*str_file
;
516 struct cleanup
*cleanup
;
519 /* GDB_STDOUT should be better already restored during these
520 restoration callbacks. */
521 cleanup
= set_batch_flag_and_make_cleanup_restore_page_info ();
523 make_cleanup_restore_integer (&interpreter_async
);
524 interpreter_async
= 0;
526 str_file
= mem_fileopen ();
528 make_cleanup_ui_file_delete (str_file
);
529 make_cleanup_restore_ui_file (&gdb_stdout
);
530 make_cleanup_restore_ui_file (&gdb_stderr
);
531 make_cleanup_restore_ui_file (&gdb_stdlog
);
532 make_cleanup_restore_ui_file (&gdb_stdtarg
);
533 make_cleanup_restore_ui_file (&gdb_stdtargerr
);
535 if (ui_out_redirect (current_uiout
, str_file
) < 0)
536 warning (_("Current output protocol does not support redirection"));
538 make_cleanup_ui_out_redirect_pop (current_uiout
);
540 gdb_stdout
= str_file
;
541 gdb_stderr
= str_file
;
542 gdb_stdlog
= str_file
;
543 gdb_stdtarg
= str_file
;
544 gdb_stdtargerr
= str_file
;
546 execute_command (p
, from_tty
);
548 retval
= ui_file_xstrdup (str_file
, NULL
);
550 do_cleanups (cleanup
);
555 /* Read commands from `instream' and execute them
556 until end of file or error reading instream. */
561 struct cleanup
*old_chain
;
563 int stdin_is_tty
= ISATTY (stdin
);
565 while (instream
&& !feof (instream
))
567 if (window_hook
&& instream
== stdin
)
568 (*window_hook
) (instream
, get_prompt ());
571 if (instream
== stdin
&& stdin_is_tty
)
572 reinitialize_more_filter ();
573 old_chain
= make_cleanup (null_cleanup
, 0);
575 /* Get a command-line. This calls the readline package. */
576 command
= command_line_input (instream
== stdin
?
577 get_prompt () : (char *) NULL
,
578 instream
== stdin
, "prompt");
581 do_cleanups (old_chain
);
585 make_command_stats_cleanup (1);
587 execute_command (command
, instream
== stdin
);
589 /* Do any commands attached to breakpoint we are stopped at. */
590 bpstat_do_actions ();
592 do_cleanups (old_chain
);
596 /* When nonzero, cause dont_repeat to do nothing. This should only be
597 set via prevent_dont_repeat. */
599 static int suppress_dont_repeat
= 0;
601 /* Commands call this if they do not want to be repeated by null lines. */
606 if (suppress_dont_repeat
|| server_command
)
609 /* If we aren't reading from standard input, we are saving the last
610 thing read from stdin in line and don't want to delete it. Null
611 lines won't repeat here in any case. */
612 if (instream
== stdin
)
613 *saved_command_line
= 0;
616 /* Prevent dont_repeat from working, and return a cleanup that
617 restores the previous state. */
620 prevent_dont_repeat (void)
622 struct cleanup
*result
= make_cleanup_restore_integer (&suppress_dont_repeat
);
624 suppress_dont_repeat
= 1;
629 /* Read a line from the stream "instream" without command line editing.
631 It prints PROMPT_ARG once at the start.
632 Action is compatible with "readline", e.g. space for the result is
633 malloc'd and should be freed by the caller.
635 A NULL return means end of file. */
637 gdb_readline (char *prompt_arg
)
642 int result_size
= 80;
646 /* Don't use a _filtered function here. It causes the assumed
647 character position to be off, since the newline we read from
648 the user is not accounted for. */
649 fputs_unfiltered (prompt_arg
, gdb_stdout
);
650 gdb_flush (gdb_stdout
);
653 result
= (char *) xmalloc (result_size
);
657 /* Read from stdin if we are executing a user defined command.
658 This is the right thing for prompt_for_continue, at least. */
659 c
= fgetc (instream
? instream
: stdin
);
664 /* The last line does not end with a newline. Return it, and
665 if we are called again fgetc will still return EOF and
666 we'll return NULL then. */
674 if (input_index
> 0 && result
[input_index
- 1] == '\r')
679 result
[input_index
++] = c
;
680 while (input_index
>= result_size
)
683 result
= (char *) xrealloc (result
, result_size
);
687 result
[input_index
++] = '\0';
691 /* Variables which control command line editing and history
692 substitution. These variables are given default values at the end
694 static int command_editing_p
;
696 /* NOTE 1999-04-29: This variable will be static again, once we modify
697 gdb to use the event loop as the default command loop and we merge
698 event-top.c into this file, top.c. */
700 /* static */ int history_expansion_p
;
702 static int write_history_p
;
704 show_write_history_p (struct ui_file
*file
, int from_tty
,
705 struct cmd_list_element
*c
, const char *value
)
707 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
711 static unsigned int history_size
;
713 show_history_size (struct ui_file
*file
, int from_tty
,
714 struct cmd_list_element
*c
, const char *value
)
716 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
720 static char *history_filename
;
722 show_history_filename (struct ui_file
*file
, int from_tty
,
723 struct cmd_list_element
*c
, const char *value
)
725 fprintf_filtered (file
, _("The filename in which to record "
726 "the command history is \"%s\".\n"),
730 /* This is like readline(), but it has some gdb-specific behavior.
731 gdb may want readline in both the synchronous and async modes during
732 a single gdb invocation. At the ordinary top-level prompt we might
733 be using the async readline. That means we can't use
734 rl_pre_input_hook, since it doesn't work properly in async mode.
735 However, for a secondary prompt (" >", such as occurs during a
736 `define'), gdb wants a synchronous response.
738 We used to call readline() directly, running it in synchronous
739 mode. But mixing modes this way is not supported, and as of
740 readline 5.x it no longer works; the arrow keys come unbound during
741 the synchronous call. So we make a nested call into the event
742 loop. That's what gdb_readline_wrapper is for. */
744 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
745 rely on gdb_readline_wrapper_result, which might still be NULL if
746 the user types Control-D for EOF. */
747 static int gdb_readline_wrapper_done
;
749 /* The result of the current call to gdb_readline_wrapper, once a newline
751 static char *gdb_readline_wrapper_result
;
753 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
754 to be called after the newline is processed (which will redisplay
755 the prompt). But in gdb_readline_wrapper we will not get a new
756 prompt until the next call, or until we return to the event loop.
757 So we disable this hook around the newline and restore it before we
759 static void (*saved_after_char_processing_hook
) (void);
761 /* This function is called when readline has seen a complete line of
765 gdb_readline_wrapper_line (char *line
)
767 gdb_assert (!gdb_readline_wrapper_done
);
768 gdb_readline_wrapper_result
= line
;
769 gdb_readline_wrapper_done
= 1;
771 /* Prevent operate-and-get-next from acting too early. */
772 saved_after_char_processing_hook
= after_char_processing_hook
;
773 after_char_processing_hook
= NULL
;
775 /* Prevent parts of the prompt from being redisplayed if annotations
776 are enabled, and readline's state getting out of sync. */
777 if (async_command_editing_p
)
778 rl_callback_handler_remove ();
781 struct gdb_readline_wrapper_cleanup
783 void (*handler_orig
) (char *);
784 int already_prompted_orig
;
788 gdb_readline_wrapper_cleanup (void *arg
)
790 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
792 rl_already_prompted
= cleanup
->already_prompted_orig
;
794 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
795 input_handler
= cleanup
->handler_orig
;
796 gdb_readline_wrapper_result
= NULL
;
797 gdb_readline_wrapper_done
= 0;
799 after_char_processing_hook
= saved_after_char_processing_hook
;
800 saved_after_char_processing_hook
= NULL
;
806 gdb_readline_wrapper (char *prompt
)
808 struct cleanup
*back_to
;
809 struct gdb_readline_wrapper_cleanup
*cleanup
;
812 cleanup
= xmalloc (sizeof (*cleanup
));
813 cleanup
->handler_orig
= input_handler
;
814 input_handler
= gdb_readline_wrapper_line
;
816 cleanup
->already_prompted_orig
= rl_already_prompted
;
818 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
820 /* Display our prompt and prevent double prompt display. */
821 display_gdb_prompt (prompt
);
822 rl_already_prompted
= 1;
824 if (after_char_processing_hook
)
825 (*after_char_processing_hook
) ();
826 gdb_assert (after_char_processing_hook
== NULL
);
828 while (gdb_do_one_event () >= 0)
829 if (gdb_readline_wrapper_done
)
832 retval
= gdb_readline_wrapper_result
;
833 do_cleanups (back_to
);
838 /* The current saved history number from operate-and-get-next.
839 This is -1 if not valid. */
840 static int operate_saved_history
= -1;
842 /* This is put on the appropriate hook and helps operate-and-get-next
845 gdb_rl_operate_and_get_next_completion (void)
847 int delta
= where_history () - operate_saved_history
;
849 /* The `key' argument to rl_get_previous_history is ignored. */
850 rl_get_previous_history (delta
, 0);
851 operate_saved_history
= -1;
853 /* readline doesn't automatically update the display for us. */
856 after_char_processing_hook
= NULL
;
857 rl_pre_input_hook
= NULL
;
860 /* This is a gdb-local readline command handler. It accepts the
861 current command line (like RET does) and, if this command was taken
862 from the history, arranges for the next command in the history to
863 appear on the command line when the prompt returns.
864 We ignore the arguments. */
866 gdb_rl_operate_and_get_next (int count
, int key
)
870 /* Use the async hook. */
871 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
873 /* Find the current line, and find the next line to use. */
874 where
= where_history();
876 /* FIXME: kettenis/20020817: max_input_history is renamed into
877 history_max_entries in readline-4.2. When we do a new readline
878 import, we should probably change it here too, even though
879 readline maintains backwards compatibility for now by still
880 defining max_input_history. */
881 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
882 (where
>= history_length
- 1))
883 operate_saved_history
= where
;
885 operate_saved_history
= where
+ 1;
887 return rl_newline (1, key
);
890 /* Read one line from the command input stream `instream'
891 into the local static buffer `linebuffer' (whose current length
893 The buffer is made bigger as necessary.
894 Returns the address of the start of the line.
896 NULL is returned for end of file.
898 *If* the instream == stdin & stdin is a terminal, the line read
899 is copied into the file line saver (global var char *line,
900 length linesize) so that it can be duplicated.
902 This routine either uses fancy command line editing or
903 simple input as the user has requested. */
906 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
908 static char *linebuffer
= 0;
909 static unsigned linelength
= 0;
913 char *local_prompt
= prompt_arg
;
917 /* The annotation suffix must be non-NULL. */
918 if (annotation_suffix
== NULL
)
919 annotation_suffix
= "";
921 if (annotation_level
> 1 && instream
== stdin
)
923 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
924 + strlen (annotation_suffix
) + 40);
925 if (prompt_arg
== NULL
)
926 local_prompt
[0] = '\0';
928 strcpy (local_prompt
, prompt_arg
);
929 strcat (local_prompt
, "\n\032\032");
930 strcat (local_prompt
, annotation_suffix
);
931 strcat (local_prompt
, "\n");
937 linebuffer
= (char *) xmalloc (linelength
);
942 /* Control-C quits instantly if typed while in this loop
943 since it should not wait until the user types a newline. */
948 signal (STOP_SIGNAL
, handle_stop_sig
);
953 /* Make sure that all output has been output. Some machines may
954 let you get away with leaving out some of the gdb_flush, but
957 gdb_flush (gdb_stdout
);
958 gdb_flush (gdb_stderr
);
960 if (source_file_name
!= NULL
)
961 ++source_line_number
;
963 if (annotation_level
> 1 && instream
== stdin
)
965 puts_unfiltered ("\n\032\032pre-");
966 puts_unfiltered (annotation_suffix
);
967 puts_unfiltered ("\n");
970 /* Don't use fancy stuff if not talking to stdin. */
971 if (deprecated_readline_hook
&& input_from_terminal_p ())
973 rl
= (*deprecated_readline_hook
) (local_prompt
);
975 else if (command_editing_p
&& input_from_terminal_p ())
977 rl
= gdb_readline_wrapper (local_prompt
);
981 rl
= gdb_readline (local_prompt
);
984 if (annotation_level
> 1 && instream
== stdin
)
986 puts_unfiltered ("\n\032\032post-");
987 puts_unfiltered (annotation_suffix
);
988 puts_unfiltered ("\n");
991 if (!rl
|| rl
== (char *) EOF
)
996 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
998 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
999 nline
= (char *) xrealloc (linebuffer
, linelength
);
1000 p
+= nline
- linebuffer
;
1004 /* Copy line. Don't copy null at end. (Leaves line alone
1005 if this was just a newline). */
1009 xfree (rl
); /* Allocated in readline. */
1011 if (p
== linebuffer
|| *(p
- 1) != '\\')
1014 p
--; /* Put on top of '\'. */
1015 local_prompt
= (char *) 0;
1020 signal (STOP_SIGNAL
, SIG_DFL
);
1027 #define SERVER_COMMAND_LENGTH 7
1029 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1030 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1033 /* Note that we don't set `line'. Between this and the check in
1034 dont_repeat, this insures that repeating will still do the
1037 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1040 /* Do history expansion if that is wished. */
1041 if (history_expansion_p
&& instream
== stdin
1042 && ISATTY (instream
))
1044 char *history_value
;
1047 *p
= '\0'; /* Insert null now. */
1048 expanded
= history_expand (linebuffer
, &history_value
);
1051 /* Print the changes. */
1052 printf_unfiltered ("%s\n", history_value
);
1054 /* If there was an error, call this function again. */
1057 xfree (history_value
);
1058 return command_line_input (prompt_arg
, repeat
,
1061 if (strlen (history_value
) > linelength
)
1063 linelength
= strlen (history_value
) + 1;
1064 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1066 strcpy (linebuffer
, history_value
);
1067 p
= linebuffer
+ strlen (linebuffer
);
1069 xfree (history_value
);
1072 /* If we just got an empty line, and that is supposed to repeat the
1073 previous command, return the value in the global buffer. */
1074 if (repeat
&& p
== linebuffer
)
1075 return saved_command_line
;
1076 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1078 return saved_command_line
;
1082 /* Add line to history if appropriate. */
1083 if (instream
== stdin
1084 && ISATTY (stdin
) && *linebuffer
)
1085 add_history (linebuffer
);
1087 /* Note: lines consisting solely of comments are added to the command
1088 history. This is useful when you type a command, and then
1089 realize you don't want to execute it quite yet. You can comment
1090 out the command and then later fetch it from the value history
1091 and remove the '#'. The kill ring is probably better, but some
1092 people are in the habit of commenting things out. */
1094 *p1
= '\0'; /* Found a comment. */
1096 /* Save into global buffer if appropriate. */
1099 if (linelength
> saved_command_line_size
)
1101 saved_command_line
= xrealloc (saved_command_line
, linelength
);
1102 saved_command_line_size
= linelength
;
1104 strcpy (saved_command_line
, linebuffer
);
1105 return saved_command_line
;
1111 /* Print the GDB banner. */
1113 print_gdb_version (struct ui_file
*stream
)
1115 /* From GNU coding standards, first line is meant to be easy for a
1116 program to parse, and is just canonical program name and version
1117 number, which starts after last space. */
1119 fprintf_filtered (stream
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1121 /* Second line is a copyright notice. */
1123 fprintf_filtered (stream
,
1124 "Copyright (C) 2013 Free Software Foundation, Inc.\n");
1126 /* Following the copyright is a brief statement that the program is
1127 free software, that users are free to copy and change it on
1128 certain conditions, that it is covered by the GNU GPL, and that
1129 there is no warranty. */
1131 fprintf_filtered (stream
, "\
1132 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1133 \nThis is free software: you are free to change and redistribute it.\n\
1134 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1135 and \"show warranty\" for details.\n");
1137 /* After the required info we print the configuration information. */
1139 fprintf_filtered (stream
, "This GDB was configured as \"");
1140 if (strcmp (host_name
, target_name
) != 0)
1142 fprintf_filtered (stream
, "--host=%s --target=%s",
1143 host_name
, target_name
);
1147 fprintf_filtered (stream
, "%s", host_name
);
1149 fprintf_filtered (stream
, "\".");
1151 if (REPORT_BUGS_TO
[0])
1153 fprintf_filtered (stream
,
1154 _("\nFor bug reporting instructions, please see:\n"));
1155 fprintf_filtered (stream
, "%s.", REPORT_BUGS_TO
);
1160 /* The current top level prompt, settable with "set prompt", and/or
1161 with the python `gdb.prompt_hook' hook. */
1162 static char *top_prompt
;
1164 /* Access method for the GDB prompt string. */
1172 /* Set method for the GDB prompt string. */
1175 set_prompt (const char *s
)
1177 char *p
= xstrdup (s
);
1190 /* Callback for iterate_over_inferiors. Kills or detaches the given
1191 inferior, depending on how we originally gained control of it. */
1194 kill_or_detach (struct inferior
*inf
, void *args
)
1196 struct qt_args
*qt
= args
;
1197 struct thread_info
*thread
;
1202 thread
= any_thread_of_process (inf
->pid
);
1205 switch_to_thread (thread
->ptid
);
1207 /* Leave core files alone. */
1208 if (target_has_execution
)
1210 if (inf
->attach_flag
)
1211 target_detach (qt
->args
, qt
->from_tty
);
1220 /* Callback for iterate_over_inferiors. Prints info about what GDB
1221 will do to each inferior on a "quit". ARG points to a struct
1222 ui_out where output is to be collected. */
1225 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1227 struct ui_file
*stb
= arg
;
1232 if (inf
->attach_flag
)
1233 fprintf_filtered (stb
,
1234 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1235 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1237 fprintf_filtered (stb
,
1238 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1239 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1244 /* If necessary, make the user confirm that we should quit. Return
1245 non-zero if we should quit, zero if we shouldn't. */
1250 struct ui_file
*stb
;
1251 struct cleanup
*old_chain
;
1255 /* Don't even ask if we're only debugging a core file inferior. */
1256 if (!have_live_inferiors ())
1259 /* Build the query string as a single string. */
1260 stb
= mem_fileopen ();
1261 old_chain
= make_cleanup_ui_file_delete (stb
);
1263 /* This is something of a hack. But there's no reliable way to see
1264 if a GUI is running. The `use_windows' variable doesn't cut
1266 if (deprecated_init_ui_hook
)
1267 fprintf_filtered (stb
, _("A debugging session is active.\n"
1268 "Do you still want to close the debugger?"));
1271 fprintf_filtered (stb
, _("A debugging session is active.\n\n"));
1272 iterate_over_inferiors (print_inferior_quit_action
, stb
);
1273 fprintf_filtered (stb
, _("\nQuit anyway? "));
1276 str
= ui_file_xstrdup (stb
, NULL
);
1277 make_cleanup (xfree
, str
);
1279 qr
= query ("%s", str
);
1280 do_cleanups (old_chain
);
1284 /* Helper routine for quit_force that requires error handling. */
1287 quit_target (void *arg
)
1289 struct qt_args
*qt
= (struct qt_args
*)arg
;
1291 /* Kill or detach all inferiors. */
1292 iterate_over_inferiors (kill_or_detach
, qt
);
1294 /* Give all pushed targets a chance to do minimal cleanup, and pop
1296 pop_all_targets (1);
1298 /* Save the history information if it is appropriate to do so. */
1299 if (write_history_p
&& history_filename
)
1300 write_history (history_filename
);
1302 do_final_cleanups (all_cleanups ()); /* Do any final cleanups before
1307 /* Quit without asking for confirmation. */
1310 quit_force (char *args
, int from_tty
)
1315 /* An optional expression may be used to cause gdb to terminate with the
1316 value of that expression. */
1319 struct value
*val
= parse_and_eval (args
);
1321 exit_code
= (int) value_as_long (val
);
1323 else if (return_child_result
)
1324 exit_code
= return_child_result_value
;
1327 qt
.from_tty
= from_tty
;
1329 /* We want to handle any quit errors and exit regardless. */
1330 catch_errors (quit_target
, &qt
,
1331 "Quitting: ", RETURN_MASK_ALL
);
1336 /* Returns whether GDB is running on a terminal and input is
1337 currently coming from that terminal. */
1340 input_from_terminal_p (void)
1345 if (gdb_has_a_terminal () && instream
== stdin
)
1348 /* If INSTREAM is unset, and we are not in a user command, we
1349 must be in Insight. That's like having a terminal, for our
1351 if (instream
== NULL
&& !in_user_command
)
1358 dont_repeat_command (char *ignored
, int from_tty
)
1360 /* Can't call dont_repeat here because we're not necessarily reading
1362 *saved_command_line
= 0;
1365 /* Functions to manipulate command line editing control variables. */
1367 /* Number of commands to print in each call to show_commands. */
1368 #define Hist_print 10
1370 show_commands (char *args
, int from_tty
)
1372 /* Index for history commands. Relative to history_base. */
1375 /* Number of the history entry which we are planning to display next.
1376 Relative to history_base. */
1379 /* The first command in the history which doesn't exist (i.e. one more
1380 than the number of the last command). Relative to history_base. */
1381 unsigned int hist_len
;
1383 /* Print out some of the commands from the command history. */
1384 /* First determine the length of the history list. */
1385 hist_len
= history_size
;
1386 for (offset
= 0; offset
< history_size
; offset
++)
1388 if (!history_get (history_base
+ offset
))
1397 if (args
[0] == '+' && args
[1] == '\0')
1398 /* "info editing +" should print from the stored position. */
1401 /* "info editing <exp>" should print around command number <exp>. */
1402 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1404 /* "show commands" means print the last Hist_print commands. */
1407 num
= hist_len
- Hist_print
;
1413 /* If there are at least Hist_print commands, we want to display the last
1414 Hist_print rather than, say, the last 6. */
1415 if (hist_len
- num
< Hist_print
)
1417 num
= hist_len
- Hist_print
;
1422 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1424 printf_filtered ("%5d %s\n", history_base
+ offset
,
1425 (history_get (history_base
+ offset
))->line
);
1428 /* The next command we want to display is the next one that we haven't
1432 /* If the user repeats this command with return, it should do what
1433 "show commands +" does. This is unnecessary if arg is null,
1434 because "show commands +" is not useful after "show commands". */
1435 if (from_tty
&& args
)
1442 /* Called by do_setshow_command. */
1444 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1446 /* The type of parameter in stifle_history is int, so values from INT_MAX up
1447 mean 'unlimited'. */
1448 if (history_size
>= INT_MAX
)
1450 /* Ensure that 'show history size' prints 'unlimited'. */
1451 history_size
= UINT_MAX
;
1452 unstifle_history ();
1455 stifle_history (history_size
);
1459 set_history (char *args
, int from_tty
)
1461 printf_unfiltered (_("\"set history\" must be followed "
1462 "by the name of a history subcommand.\n"));
1463 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1467 show_history (char *args
, int from_tty
)
1469 cmd_show_list (showhistlist
, from_tty
, "");
1472 int info_verbose
= 0; /* Default verbose msgs off. */
1474 /* Called by do_setshow_command. An elaborate joke. */
1476 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1478 char *cmdname
= "verbose";
1479 struct cmd_list_element
*showcmd
;
1481 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1482 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1486 c
->doc
= "Set verbose printing of informational messages.";
1487 showcmd
->doc
= "Show verbose printing of informational messages.";
1491 c
->doc
= "Set verbosity.";
1492 showcmd
->doc
= "Show verbosity.";
1496 /* Init the history buffer. Note that we are called after the init file(s)
1497 have been read so that the user can change the history file via his
1498 .gdbinit file (for instance). The GDBHISTFILE environment variable
1499 overrides all of this. */
1506 tmpenv
= getenv ("HISTSIZE");
1508 history_size
= atoi (tmpenv
);
1509 else if (!history_size
)
1512 stifle_history (history_size
);
1514 tmpenv
= getenv ("GDBHISTFILE");
1516 history_filename
= xstrdup (tmpenv
);
1517 else if (!history_filename
)
1519 /* We include the current directory so that if the user changes
1520 directories the file written will be the same as the one
1523 /* No leading dots in file names are allowed on MSDOS. */
1524 history_filename
= concat (current_directory
, "/_gdb_history",
1527 history_filename
= concat (current_directory
, "/.gdb_history",
1531 read_history (history_filename
);
1535 show_prompt (struct ui_file
*file
, int from_tty
,
1536 struct cmd_list_element
*c
, const char *value
)
1538 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1542 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1543 struct cmd_list_element
*c
, const char *value
)
1545 fprintf_filtered (file
, _("Editing of command lines as "
1546 "they are typed is %s.\n"),
1551 show_annotation_level (struct ui_file
*file
, int from_tty
,
1552 struct cmd_list_element
*c
, const char *value
)
1554 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1558 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1559 struct cmd_list_element
*c
, const char *value
)
1561 fprintf_filtered (file
, _("Notification of completion for "
1562 "asynchronous execution commands is %s.\n"),
1566 /* "set" command for the gdb_datadir configuration variable. */
1569 set_gdb_datadir (char *args
, int from_tty
, struct cmd_list_element
*c
)
1571 observer_notify_gdb_datadir_changed ();
1577 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1578 the DEFAULT_PROMPT is. */
1579 set_prompt (DEFAULT_PROMPT
);
1581 /* Set things up for annotation_level > 1, if the user ever decides
1583 async_annotation_suffix
= "prompt";
1585 /* Set the important stuff up for command editing. */
1586 command_editing_p
= 1;
1587 history_expansion_p
= 0;
1588 write_history_p
= 0;
1590 /* Setup important stuff for command line editing. */
1591 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
1592 rl_completion_entry_function
= readline_line_completion_function
;
1593 rl_completer_word_break_characters
= default_word_break_characters ();
1594 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1595 rl_readline_name
= "gdb";
1596 rl_terminal_name
= getenv ("TERM");
1598 /* The name for this defun comes from Bash, where it originated.
1599 15 is Control-o, the same binding this function has in Bash. */
1600 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1602 add_setshow_string_cmd ("prompt", class_support
,
1604 _("Set gdb's prompt"),
1605 _("Show gdb's prompt"),
1608 &setlist
, &showlist
);
1610 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1611 Don't repeat this command.\nPrimarily \
1612 used inside of user-defined commands that should not be repeated when\n\
1615 add_setshow_boolean_cmd ("editing", class_support
,
1616 &async_command_editing_p
, _("\
1617 Set editing of command lines as they are typed."), _("\
1618 Show editing of command lines as they are typed."), _("\
1619 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1620 Without an argument, command line editing is enabled. To edit, use\n\
1621 EMACS-like or VI-like commands like control-P or ESC."),
1622 set_async_editing_command
,
1623 show_async_command_editing_p
,
1624 &setlist
, &showlist
);
1626 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1627 Set saving of the history record on exit."), _("\
1628 Show saving of the history record on exit."), _("\
1629 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1630 Without an argument, saving is enabled."),
1632 show_write_history_p
,
1633 &sethistlist
, &showhistlist
);
1635 add_setshow_uinteger_cmd ("size", no_class
, &history_size
, _("\
1636 Set the size of the command history,"), _("\
1637 Show the size of the command history,"), _("\
1638 ie. the number of previous commands to keep a record of."),
1639 set_history_size_command
,
1641 &sethistlist
, &showhistlist
);
1643 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1644 Set the filename in which to record the command history"), _("\
1645 Show the filename in which to record the command history"), _("\
1646 (the list of previous commands of which a record is kept)."),
1648 show_history_filename
,
1649 &sethistlist
, &showhistlist
);
1651 add_setshow_boolean_cmd ("confirm", class_support
, &confirm
, _("\
1652 Set whether to confirm potentially dangerous operations."), _("\
1653 Show whether to confirm potentially dangerous operations."), NULL
,
1656 &setlist
, &showlist
);
1658 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1659 Set annotation_level."), _("\
1660 Show annotation_level."), _("\
1661 0 == normal; 1 == fullname (for use when running under emacs)\n\
1662 2 == output annotated suitably for use by programs that control GDB."),
1664 show_annotation_level
,
1665 &setlist
, &showlist
);
1667 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1668 &exec_done_display_p
, _("\
1669 Set notification of completion for asynchronous execution commands."), _("\
1670 Show notification of completion for asynchronous execution commands."), _("\
1671 Use \"on\" to enable the notification, and \"off\" to disable it."),
1673 show_exec_done_display_p
,
1674 &setlist
, &showlist
);
1676 add_setshow_filename_cmd ("data-directory", class_maintenance
,
1677 &gdb_datadir
, _("Set GDB's data directory."),
1678 _("Show GDB's data directory."),
1680 When set, GDB uses the specified path to search for data files."),
1681 set_gdb_datadir
, NULL
,
1687 gdb_init (char *argv0
)
1689 if (pre_init_ui_hook
)
1690 pre_init_ui_hook ();
1692 /* Run the init function of each source file. */
1695 /* Make sure we return to the original directory upon exit, come
1696 what may, since the OS doesn't do that for us. */
1697 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1700 init_cmd_lists (); /* This needs to be done first. */
1701 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1702 initialize_utils (); /* Make errors and warnings possible. */
1704 /* Here is where we call all the _initialize_foo routines. */
1705 initialize_all_files ();
1707 /* This creates the current_program_space. Do this after all the
1708 _initialize_foo routines have had a chance to install their
1709 per-sspace data keys. Also do this before
1710 initialize_current_architecture is called, because it accesses
1711 exec_bfd of the current program space. */
1712 initialize_progspace ();
1713 initialize_inferiors ();
1714 initialize_current_architecture ();
1716 init_main (); /* But that omits this file! Do it now. */
1718 initialize_stdin_serial ();
1720 async_init_signals ();
1722 /* We need a default language for parsing expressions, so simple
1723 things like "set width 0" won't fail if no language is explicitly
1724 set in a config file or implicitly set by reading an executable
1726 set_language (language_c
);
1727 expected_language
= current_language
; /* Don't warn about the change. */
1729 /* Allow another UI to initialize. If the UI fails to initialize,
1730 and it wants GDB to revert to the CLI, it should clear
1731 deprecated_init_ui_hook. */
1732 if (deprecated_init_ui_hook
)
1733 deprecated_init_ui_hook (argv0
);
1736 /* Python initialization can require various commands to be
1737 installed. For example "info pretty-printer" needs the "info"
1738 prefix to be installed. Keep things simple and just do final
1739 python initialization here. */
1740 finish_python_initialization ();