1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "call-cmds.h"
25 #include "cli/cli-cmds.h"
26 #include "cli/cli-script.h"
27 #include "cli/cli-setshow.h"
28 #include "cli/cli-decode.h"
31 #include "exceptions.h"
34 #include "breakpoint.h"
36 #include "expression.h"
39 #include "terminal.h" /* For job_control. */
41 #include "completer.h"
46 #include "gdb_assert.h"
48 #include "event-loop.h"
49 #include "gdbthread.h"
50 #include "python/python.h"
53 /* readline include files. */
54 #include "readline/readline.h"
55 #include "readline/history.h"
57 /* readline defines this. */
60 #include <sys/types.h>
62 #include "event-top.h"
63 #include "gdb_string.h"
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 all the "from_tty" gubbish printed. */
105 int caution
= 1; /* Default is yes, sigh. */
107 show_caution (struct ui_file
*file
, int from_tty
,
108 struct cmd_list_element
*c
, const char *value
)
110 fprintf_filtered (file
, _("Whether to confirm potentially "
111 "dangerous operations is %s.\n"),
115 /* stdio stream that command input is being read from. Set to stdin
116 normally. Set by source_command to the file we are sourcing. Set
117 to NULL if we are executing a user-defined command or interacting
122 /* Flag to indicate whether a user defined command is currently running. */
126 /* Current working directory. */
128 char *current_directory
;
130 /* The directory name is actually stored here (usually). */
131 char gdb_dirbuf
[1024];
133 /* Function to call before reading a command, if nonzero.
134 The function receives two args: an input stream,
135 and a prompt string. */
137 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 caution
= 0; /* Throw caution to the wind -- we're exiting.
295 This prevents asking the user dumb
297 quit_command ((char *) 0, 0);
300 #endif /* defined SIGHUP */
302 /* Line number we are currently in, in a file which is being sourced. */
303 /* NOTE 1999-04-29: This variable will be static again, once we modify
304 gdb to use the event loop as the default command loop and we merge
305 event-top.c into this file, top.c. */
306 /* static */ int source_line_number
;
308 /* Name of the file we are sourcing. */
309 /* NOTE 1999-04-29: This variable will be static again, once we modify
310 gdb to use the event loop as the default command loop and we merge
311 event-top.c into this file, top.c. */
312 /* static */ const char *source_file_name
;
314 /* Clean up on error during a "source" command (or execution of a
315 user-defined command). */
318 do_restore_instream_cleanup (void *stream
)
320 /* Restore the previous input stream. */
324 /* Read commands from STREAM. */
326 read_command_file (FILE *stream
)
328 struct cleanup
*cleanups
;
330 cleanups
= make_cleanup (do_restore_instream_cleanup
, instream
);
333 do_cleanups (cleanups
);
336 void (*pre_init_ui_hook
) (void);
340 do_chdir_cleanup (void *old_dir
)
348 prepare_execute_command (void)
351 struct cleanup
*cleanup
;
353 mark
= value_mark ();
354 cleanup
= make_cleanup_value_free_to_mark (mark
);
356 /* With multiple threads running while the one we're examining is
357 stopped, the dcache can get stale without us being able to detect
358 it. For the duration of the command, though, use the dcache to
359 help things like backtrace. */
361 target_dcache_invalidate ();
366 /* Execute the line P as a command, in the current user context.
367 Pass FROM_TTY as second argument to the defining function. */
370 execute_command (char *p
, int from_tty
)
372 struct cleanup
*cleanup_if_error
, *cleanup
;
373 struct cmd_list_element
*c
;
375 static int warned
= 0;
378 cleanup_if_error
= make_bpstat_clear_actions_cleanup ();
379 cleanup
= prepare_execute_command ();
381 /* Force cleanup of any alloca areas if using C alloca instead of
385 /* This can happen when command_line_input hits end of file. */
388 do_cleanups (cleanup
);
392 target_log_command (p
);
394 while (*p
== ' ' || *p
== '\t')
401 /* If trace-commands is set then this will print this command. */
402 print_command_trace (p
);
404 c
= lookup_cmd (&p
, cmdlist
, "", 0, 1);
406 /* Pass null arg rather than an empty one. */
409 /* FIXME: cagney/2002-02-02: The c->type test is pretty dodgy
410 while the is_complete_command(cfunc) test is just plain
411 bogus. They should both be replaced by a test of the form
412 c->strip_trailing_white_space_p. */
413 /* NOTE: cagney/2002-02-02: The function.cfunc in the below
414 can't be replaced with func. This is because it is the
415 cfunc, and not the func, that has the value that the
416 is_complete_command hack is testing for. */
417 /* Clear off trailing whitespace, except for set and complete
420 && c
->type
!= set_cmd
421 && !is_complete_command (c
))
423 p
= arg
+ strlen (arg
) - 1;
424 while (p
>= arg
&& (*p
== ' ' || *p
== '\t'))
429 /* If this command has been pre-hooked, run the hook first. */
430 execute_cmd_pre_hook (c
);
432 if (c
->flags
& DEPRECATED_WARN_USER
)
433 deprecated_cmd_warning (&line
);
435 if (c
->class == class_user
)
436 execute_user_command (c
, arg
);
437 else if (c
->type
== set_cmd
|| c
->type
== show_cmd
)
438 do_setshow_command (arg
, from_tty
& caution
, c
);
439 else if (!cmd_func_p (c
))
440 error (_("That is not a command, just a help topic."));
441 else if (deprecated_call_command_hook
)
442 deprecated_call_command_hook (c
, arg
, from_tty
& caution
);
444 cmd_func (c
, arg
, from_tty
& caution
);
446 /* If the interpreter is in sync mode (we're running a user
447 command's list, running command hooks or similars), and we
448 just ran a synchronous command that started the target, wait
449 for that command to end. */
450 if (!interpreter_async
&& sync_execution
)
452 while (gdb_do_one_event () >= 0)
457 /* If this command has been post-hooked, run the hook last. */
458 execute_cmd_post_hook (c
);
462 /* Tell the user if the language has changed (except first time).
463 First make sure that a new frame has been selected, in case this
464 command or the hooks changed the program state. */
465 deprecated_safe_get_selected_frame ();
466 if (current_language
!= expected_language
)
468 if (language_mode
== language_mode_auto
&& info_verbose
)
470 language_info (1); /* Print what changed. */
475 /* Warn the user if the working language does not match the
476 language of the current frame. Only warn the user if we are
477 actually running the program, i.e. there is a stack. */
478 /* FIXME: This should be cacheing the frame and only running when
479 the frame changes. */
481 if (has_stack_frames ())
483 flang
= get_frame_language ();
485 && flang
!= language_unknown
486 && flang
!= current_language
->la_language
)
488 printf_filtered ("%s\n", lang_frame_mismatch_warn
);
493 do_cleanups (cleanup
);
494 discard_cleanups (cleanup_if_error
);
497 /* Run execute_command for P and FROM_TTY. Capture its output into the
498 returned string, do not display it to the screen. BATCH_FLAG will be
499 temporarily set to true. */
502 execute_command_to_string (char *p
, int from_tty
)
504 struct ui_file
*str_file
;
505 struct cleanup
*cleanup
;
508 /* GDB_STDOUT should be better already restored during these
509 restoration callbacks. */
510 cleanup
= set_batch_flag_and_make_cleanup_restore_page_info ();
512 make_cleanup_restore_integer (&interpreter_async
);
513 interpreter_async
= 0;
515 str_file
= mem_fileopen ();
517 make_cleanup_ui_file_delete (str_file
);
518 make_cleanup_restore_ui_file (&gdb_stdout
);
519 make_cleanup_restore_ui_file (&gdb_stderr
);
520 make_cleanup_restore_ui_file (&gdb_stdlog
);
521 make_cleanup_restore_ui_file (&gdb_stdtarg
);
522 make_cleanup_restore_ui_file (&gdb_stdtargerr
);
524 if (ui_out_redirect (current_uiout
, str_file
) < 0)
525 warning (_("Current output protocol does not support redirection"));
527 make_cleanup_ui_out_redirect_pop (current_uiout
);
529 gdb_stdout
= str_file
;
530 gdb_stderr
= str_file
;
531 gdb_stdlog
= str_file
;
532 gdb_stdtarg
= str_file
;
533 gdb_stdtargerr
= str_file
;
535 execute_command (p
, from_tty
);
537 retval
= ui_file_xstrdup (str_file
, NULL
);
539 do_cleanups (cleanup
);
544 /* Read commands from `instream' and execute them
545 until end of file or error reading instream. */
550 struct cleanup
*old_chain
;
552 int stdin_is_tty
= ISATTY (stdin
);
554 while (instream
&& !feof (instream
))
556 if (window_hook
&& instream
== stdin
)
557 (*window_hook
) (instream
, get_prompt ());
560 if (instream
== stdin
&& stdin_is_tty
)
561 reinitialize_more_filter ();
562 old_chain
= make_cleanup (null_cleanup
, 0);
564 /* Get a command-line. This calls the readline package. */
565 command
= command_line_input (instream
== stdin
?
566 get_prompt () : (char *) NULL
,
567 instream
== stdin
, "prompt");
570 do_cleanups (old_chain
);
574 make_command_stats_cleanup (1);
576 execute_command (command
, instream
== stdin
);
578 /* Do any commands attached to breakpoint we are stopped at. */
579 bpstat_do_actions ();
581 do_cleanups (old_chain
);
585 /* When nonzero, cause dont_repeat to do nothing. This should only be
586 set via prevent_dont_repeat. */
588 static int suppress_dont_repeat
= 0;
590 /* Commands call this if they do not want to be repeated by null lines. */
595 if (suppress_dont_repeat
|| server_command
)
598 /* If we aren't reading from standard input, we are saving the last
599 thing read from stdin in line and don't want to delete it. Null
600 lines won't repeat here in any case. */
601 if (instream
== stdin
)
602 *saved_command_line
= 0;
605 /* Prevent dont_repeat from working, and return a cleanup that
606 restores the previous state. */
609 prevent_dont_repeat (void)
611 struct cleanup
*result
= make_cleanup_restore_integer (&suppress_dont_repeat
);
613 suppress_dont_repeat
= 1;
618 /* Read a line from the stream "instream" without command line editing.
620 It prints PROMPT_ARG once at the start.
621 Action is compatible with "readline", e.g. space for the result is
622 malloc'd and should be freed by the caller.
624 A NULL return means end of file. */
626 gdb_readline (char *prompt_arg
)
631 int result_size
= 80;
635 /* Don't use a _filtered function here. It causes the assumed
636 character position to be off, since the newline we read from
637 the user is not accounted for. */
638 fputs_unfiltered (prompt_arg
, gdb_stdout
);
639 gdb_flush (gdb_stdout
);
642 result
= (char *) xmalloc (result_size
);
646 /* Read from stdin if we are executing a user defined command.
647 This is the right thing for prompt_for_continue, at least. */
648 c
= fgetc (instream
? instream
: stdin
);
653 /* The last line does not end with a newline. Return it, and
654 if we are called again fgetc will still return EOF and
655 we'll return NULL then. */
663 if (input_index
> 0 && result
[input_index
- 1] == '\r')
668 result
[input_index
++] = c
;
669 while (input_index
>= result_size
)
672 result
= (char *) xrealloc (result
, result_size
);
676 result
[input_index
++] = '\0';
680 /* Variables which control command line editing and history
681 substitution. These variables are given default values at the end
683 static int command_editing_p
;
685 /* NOTE 1999-04-29: This variable will be static again, once we modify
686 gdb to use the event loop as the default command loop and we merge
687 event-top.c into this file, top.c. */
689 /* static */ int history_expansion_p
;
691 static int write_history_p
;
693 show_write_history_p (struct ui_file
*file
, int from_tty
,
694 struct cmd_list_element
*c
, const char *value
)
696 fprintf_filtered (file
, _("Saving of the history record on exit is %s.\n"),
700 static int history_size
;
702 show_history_size (struct ui_file
*file
, int from_tty
,
703 struct cmd_list_element
*c
, const char *value
)
705 fprintf_filtered (file
, _("The size of the command history is %s.\n"),
709 static char *history_filename
;
711 show_history_filename (struct ui_file
*file
, int from_tty
,
712 struct cmd_list_element
*c
, const char *value
)
714 fprintf_filtered (file
, _("The filename in which to record "
715 "the command history is \"%s\".\n"),
719 /* This is like readline(), but it has some gdb-specific behavior.
720 gdb may want readline in both the synchronous and async modes during
721 a single gdb invocation. At the ordinary top-level prompt we might
722 be using the async readline. That means we can't use
723 rl_pre_input_hook, since it doesn't work properly in async mode.
724 However, for a secondary prompt (" >", such as occurs during a
725 `define'), gdb wants a synchronous response.
727 We used to call readline() directly, running it in synchronous
728 mode. But mixing modes this way is not supported, and as of
729 readline 5.x it no longer works; the arrow keys come unbound during
730 the synchronous call. So we make a nested call into the event
731 loop. That's what gdb_readline_wrapper is for. */
733 /* A flag set as soon as gdb_readline_wrapper_line is called; we can't
734 rely on gdb_readline_wrapper_result, which might still be NULL if
735 the user types Control-D for EOF. */
736 static int gdb_readline_wrapper_done
;
738 /* The result of the current call to gdb_readline_wrapper, once a newline
740 static char *gdb_readline_wrapper_result
;
742 /* Any intercepted hook. Operate-and-get-next sets this, expecting it
743 to be called after the newline is processed (which will redisplay
744 the prompt). But in gdb_readline_wrapper we will not get a new
745 prompt until the next call, or until we return to the event loop.
746 So we disable this hook around the newline and restore it before we
748 static void (*saved_after_char_processing_hook
) (void);
750 /* This function is called when readline has seen a complete line of
754 gdb_readline_wrapper_line (char *line
)
756 gdb_assert (!gdb_readline_wrapper_done
);
757 gdb_readline_wrapper_result
= line
;
758 gdb_readline_wrapper_done
= 1;
760 /* Prevent operate-and-get-next from acting too early. */
761 saved_after_char_processing_hook
= after_char_processing_hook
;
762 after_char_processing_hook
= NULL
;
764 /* Prevent parts of the prompt from being redisplayed if annotations
765 are enabled, and readline's state getting out of sync. */
766 if (async_command_editing_p
)
767 rl_callback_handler_remove ();
770 struct gdb_readline_wrapper_cleanup
772 void (*handler_orig
) (char *);
773 int already_prompted_orig
;
777 gdb_readline_wrapper_cleanup (void *arg
)
779 struct gdb_readline_wrapper_cleanup
*cleanup
= arg
;
781 rl_already_prompted
= cleanup
->already_prompted_orig
;
783 gdb_assert (input_handler
== gdb_readline_wrapper_line
);
784 input_handler
= cleanup
->handler_orig
;
785 gdb_readline_wrapper_result
= NULL
;
786 gdb_readline_wrapper_done
= 0;
788 after_char_processing_hook
= saved_after_char_processing_hook
;
789 saved_after_char_processing_hook
= NULL
;
795 gdb_readline_wrapper (char *prompt
)
797 struct cleanup
*back_to
;
798 struct gdb_readline_wrapper_cleanup
*cleanup
;
801 cleanup
= xmalloc (sizeof (*cleanup
));
802 cleanup
->handler_orig
= input_handler
;
803 input_handler
= gdb_readline_wrapper_line
;
805 cleanup
->already_prompted_orig
= rl_already_prompted
;
807 back_to
= make_cleanup (gdb_readline_wrapper_cleanup
, cleanup
);
809 /* Display our prompt and prevent double prompt display. */
810 display_gdb_prompt (prompt
);
811 rl_already_prompted
= 1;
813 if (after_char_processing_hook
)
814 (*after_char_processing_hook
) ();
815 gdb_assert (after_char_processing_hook
== NULL
);
817 while (gdb_do_one_event () >= 0)
818 if (gdb_readline_wrapper_done
)
821 retval
= gdb_readline_wrapper_result
;
822 do_cleanups (back_to
);
827 /* The current saved history number from operate-and-get-next.
828 This is -1 if not valid. */
829 static int operate_saved_history
= -1;
831 /* This is put on the appropriate hook and helps operate-and-get-next
834 gdb_rl_operate_and_get_next_completion (void)
836 int delta
= where_history () - operate_saved_history
;
838 /* The `key' argument to rl_get_previous_history is ignored. */
839 rl_get_previous_history (delta
, 0);
840 operate_saved_history
= -1;
842 /* readline doesn't automatically update the display for us. */
845 after_char_processing_hook
= NULL
;
846 rl_pre_input_hook
= NULL
;
849 /* This is a gdb-local readline command handler. It accepts the
850 current command line (like RET does) and, if this command was taken
851 from the history, arranges for the next command in the history to
852 appear on the command line when the prompt returns.
853 We ignore the arguments. */
855 gdb_rl_operate_and_get_next (int count
, int key
)
859 /* Use the async hook. */
860 after_char_processing_hook
= gdb_rl_operate_and_get_next_completion
;
862 /* Find the current line, and find the next line to use. */
863 where
= where_history();
865 /* FIXME: kettenis/20020817: max_input_history is renamed into
866 history_max_entries in readline-4.2. When we do a new readline
867 import, we should probably change it here too, even though
868 readline maintains backwards compatibility for now by still
869 defining max_input_history. */
870 if ((history_is_stifled () && (history_length
>= max_input_history
)) ||
871 (where
>= history_length
- 1))
872 operate_saved_history
= where
;
874 operate_saved_history
= where
+ 1;
876 return rl_newline (1, key
);
879 /* Read one line from the command input stream `instream'
880 into the local static buffer `linebuffer' (whose current length
882 The buffer is made bigger as necessary.
883 Returns the address of the start of the line.
885 NULL is returned for end of file.
887 *If* the instream == stdin & stdin is a terminal, the line read
888 is copied into the file line saver (global var char *line,
889 length linesize) so that it can be duplicated.
891 This routine either uses fancy command line editing or
892 simple input as the user has requested. */
895 command_line_input (char *prompt_arg
, int repeat
, char *annotation_suffix
)
897 static char *linebuffer
= 0;
898 static unsigned linelength
= 0;
902 char *local_prompt
= prompt_arg
;
906 /* The annotation suffix must be non-NULL. */
907 if (annotation_suffix
== NULL
)
908 annotation_suffix
= "";
910 if (annotation_level
> 1 && instream
== stdin
)
912 local_prompt
= alloca ((prompt_arg
== NULL
? 0 : strlen (prompt_arg
))
913 + strlen (annotation_suffix
) + 40);
914 if (prompt_arg
== NULL
)
915 local_prompt
[0] = '\0';
917 strcpy (local_prompt
, prompt_arg
);
918 strcat (local_prompt
, "\n\032\032");
919 strcat (local_prompt
, annotation_suffix
);
920 strcat (local_prompt
, "\n");
926 linebuffer
= (char *) xmalloc (linelength
);
931 /* Control-C quits instantly if typed while in this loop
932 since it should not wait until the user types a newline. */
936 signal (STOP_SIGNAL
, handle_stop_sig
);
941 /* Make sure that all output has been output. Some machines may
942 let you get away with leaving out some of the gdb_flush, but
945 gdb_flush (gdb_stdout
);
946 gdb_flush (gdb_stderr
);
948 if (source_file_name
!= NULL
)
949 ++source_line_number
;
951 if (annotation_level
> 1 && instream
== stdin
)
953 puts_unfiltered ("\n\032\032pre-");
954 puts_unfiltered (annotation_suffix
);
955 puts_unfiltered ("\n");
958 /* Don't use fancy stuff if not talking to stdin. */
959 if (deprecated_readline_hook
&& input_from_terminal_p ())
961 rl
= (*deprecated_readline_hook
) (local_prompt
);
963 else if (command_editing_p
&& input_from_terminal_p ())
965 rl
= gdb_readline_wrapper (local_prompt
);
969 rl
= gdb_readline (local_prompt
);
972 if (annotation_level
> 1 && instream
== stdin
)
974 puts_unfiltered ("\n\032\032post-");
975 puts_unfiltered (annotation_suffix
);
976 puts_unfiltered ("\n");
979 if (!rl
|| rl
== (char *) EOF
)
984 if (strlen (rl
) + 1 + (p
- linebuffer
) > linelength
)
986 linelength
= strlen (rl
) + 1 + (p
- linebuffer
);
987 nline
= (char *) xrealloc (linebuffer
, linelength
);
988 p
+= nline
- linebuffer
;
992 /* Copy line. Don't copy null at end. (Leaves line alone
993 if this was just a newline). */
997 xfree (rl
); /* Allocated in readline. */
999 if (p
== linebuffer
|| *(p
- 1) != '\\')
1002 p
--; /* Put on top of '\'. */
1003 local_prompt
= (char *) 0;
1008 signal (STOP_SIGNAL
, SIG_DFL
);
1015 #define SERVER_COMMAND_LENGTH 7
1017 (p
- linebuffer
> SERVER_COMMAND_LENGTH
)
1018 && strncmp (linebuffer
, "server ", SERVER_COMMAND_LENGTH
) == 0;
1021 /* Note that we don't set `line'. Between this and the check in
1022 dont_repeat, this insures that repeating will still do the
1025 return linebuffer
+ SERVER_COMMAND_LENGTH
;
1028 /* Do history expansion if that is wished. */
1029 if (history_expansion_p
&& instream
== stdin
1030 && ISATTY (instream
))
1032 char *history_value
;
1035 *p
= '\0'; /* Insert null now. */
1036 expanded
= history_expand (linebuffer
, &history_value
);
1039 /* Print the changes. */
1040 printf_unfiltered ("%s\n", history_value
);
1042 /* If there was an error, call this function again. */
1045 xfree (history_value
);
1046 return command_line_input (prompt_arg
, repeat
,
1049 if (strlen (history_value
) > linelength
)
1051 linelength
= strlen (history_value
) + 1;
1052 linebuffer
= (char *) xrealloc (linebuffer
, linelength
);
1054 strcpy (linebuffer
, history_value
);
1055 p
= linebuffer
+ strlen (linebuffer
);
1057 xfree (history_value
);
1060 /* If we just got an empty line, and that is supposed to repeat the
1061 previous command, return the value in the global buffer. */
1062 if (repeat
&& p
== linebuffer
)
1063 return saved_command_line
;
1064 for (p1
= linebuffer
; *p1
== ' ' || *p1
== '\t'; p1
++);
1066 return saved_command_line
;
1070 /* Add line to history if appropriate. */
1071 if (instream
== stdin
1072 && ISATTY (stdin
) && *linebuffer
)
1073 add_history (linebuffer
);
1075 /* Note: lines consisting solely of comments are added to the command
1076 history. This is useful when you type a command, and then
1077 realize you don't want to execute it quite yet. You can comment
1078 out the command and then later fetch it from the value history
1079 and remove the '#'. The kill ring is probably better, but some
1080 people are in the habit of commenting things out. */
1082 *p1
= '\0'; /* Found a comment. */
1084 /* Save into global buffer if appropriate. */
1087 if (linelength
> saved_command_line_size
)
1089 saved_command_line
= xrealloc (saved_command_line
, linelength
);
1090 saved_command_line_size
= linelength
;
1092 strcpy (saved_command_line
, linebuffer
);
1093 return saved_command_line
;
1099 /* Print the GDB banner. */
1101 print_gdb_version (struct ui_file
*stream
)
1103 /* From GNU coding standards, first line is meant to be easy for a
1104 program to parse, and is just canonical program name and version
1105 number, which starts after last space. */
1107 fprintf_filtered (stream
, "GNU gdb %s%s\n", PKGVERSION
, version
);
1109 /* Second line is a copyright notice. */
1111 fprintf_filtered (stream
,
1112 "Copyright (C) 2011 Free Software Foundation, Inc.\n");
1114 /* Following the copyright is a brief statement that the program is
1115 free software, that users are free to copy and change it on
1116 certain conditions, that it is covered by the GNU GPL, and that
1117 there is no warranty. */
1119 fprintf_filtered (stream
, "\
1120 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\
1121 \nThis is free software: you are free to change and redistribute it.\n\
1122 There is NO WARRANTY, to the extent permitted by law. Type \"show copying\"\n\
1123 and \"show warranty\" for details.\n");
1125 /* After the required info we print the configuration information. */
1127 fprintf_filtered (stream
, "This GDB was configured as \"");
1128 if (strcmp (host_name
, target_name
) != 0)
1130 fprintf_filtered (stream
, "--host=%s --target=%s",
1131 host_name
, target_name
);
1135 fprintf_filtered (stream
, "%s", host_name
);
1137 fprintf_filtered (stream
, "\".");
1139 if (REPORT_BUGS_TO
[0])
1141 fprintf_filtered (stream
,
1142 _("\nFor bug reporting instructions, please see:\n"));
1143 fprintf_filtered (stream
, "%s.", REPORT_BUGS_TO
);
1148 /* The current top level prompt, settable with "set prompt", and/or
1149 with the python `gdb.prompt_hook' hook. */
1150 static char *top_prompt
;
1152 /* Access method for the GDB prompt string. */
1160 /* Set method for the GDB prompt string. */
1163 set_prompt (const char *s
)
1165 char *p
= xstrdup (s
);
1178 /* Callback for iterate_over_inferiors. Kills or detaches the given
1179 inferior, depending on how we originally gained control of it. */
1182 kill_or_detach (struct inferior
*inf
, void *args
)
1184 struct qt_args
*qt
= args
;
1185 struct thread_info
*thread
;
1190 thread
= any_thread_of_process (inf
->pid
);
1193 switch_to_thread (thread
->ptid
);
1195 /* Leave core files alone. */
1196 if (target_has_execution
)
1198 if (inf
->attach_flag
)
1199 target_detach (qt
->args
, qt
->from_tty
);
1208 /* Callback for iterate_over_inferiors. Prints info about what GDB
1209 will do to each inferior on a "quit". ARG points to a struct
1210 ui_out where output is to be collected. */
1213 print_inferior_quit_action (struct inferior
*inf
, void *arg
)
1215 struct ui_file
*stb
= arg
;
1220 if (inf
->attach_flag
)
1221 fprintf_filtered (stb
,
1222 _("\tInferior %d [%s] will be detached.\n"), inf
->num
,
1223 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1225 fprintf_filtered (stb
,
1226 _("\tInferior %d [%s] will be killed.\n"), inf
->num
,
1227 target_pid_to_str (pid_to_ptid (inf
->pid
)));
1232 /* If necessary, make the user confirm that we should quit. Return
1233 non-zero if we should quit, zero if we shouldn't. */
1238 struct ui_file
*stb
;
1239 struct cleanup
*old_chain
;
1243 /* Don't even ask if we're only debugging a core file inferior. */
1244 if (!have_live_inferiors ())
1247 /* Build the query string as a single string. */
1248 stb
= mem_fileopen ();
1249 old_chain
= make_cleanup_ui_file_delete (stb
);
1251 /* This is something of a hack. But there's no reliable way to see
1252 if a GUI is running. The `use_windows' variable doesn't cut
1254 if (deprecated_init_ui_hook
)
1255 fprintf_filtered (stb
, _("A debugging session is active.\n"
1256 "Do you still want to close the debugger?"));
1259 fprintf_filtered (stb
, _("A debugging session is active.\n\n"));
1260 iterate_over_inferiors (print_inferior_quit_action
, stb
);
1261 fprintf_filtered (stb
, _("\nQuit anyway? "));
1264 str
= ui_file_xstrdup (stb
, NULL
);
1265 make_cleanup (xfree
, str
);
1267 qr
= query ("%s", str
);
1268 do_cleanups (old_chain
);
1272 /* Helper routine for quit_force that requires error handling. */
1275 quit_target (void *arg
)
1277 struct qt_args
*qt
= (struct qt_args
*)arg
;
1279 /* Kill or detach all inferiors. */
1280 iterate_over_inferiors (kill_or_detach
, qt
);
1282 /* Give all pushed targets a chance to do minimal cleanup, and pop
1284 pop_all_targets (1);
1286 /* Save the history information if it is appropriate to do so. */
1287 if (write_history_p
&& history_filename
)
1288 write_history (history_filename
);
1290 do_final_cleanups (ALL_CLEANUPS
); /* Do any final cleanups before
1295 /* Quit without asking for confirmation. */
1298 quit_force (char *args
, int from_tty
)
1303 /* An optional expression may be used to cause gdb to terminate with the
1304 value of that expression. */
1307 struct value
*val
= parse_and_eval (args
);
1309 exit_code
= (int) value_as_long (val
);
1311 else if (return_child_result
)
1312 exit_code
= return_child_result_value
;
1315 qt
.from_tty
= from_tty
;
1317 /* We want to handle any quit errors and exit regardless. */
1318 catch_errors (quit_target
, &qt
,
1319 "Quitting: ", RETURN_MASK_ALL
);
1324 /* Returns whether GDB is running on a terminal and input is
1325 currently coming from that terminal. */
1328 input_from_terminal_p (void)
1333 if (gdb_has_a_terminal () && instream
== stdin
)
1336 /* If INSTREAM is unset, and we are not in a user command, we
1337 must be in Insight. That's like having a terminal, for our
1339 if (instream
== NULL
&& !in_user_command
)
1346 dont_repeat_command (char *ignored
, int from_tty
)
1348 /* Can't call dont_repeat here because we're not necessarily reading
1350 *saved_command_line
= 0;
1353 /* Functions to manipulate command line editing control variables. */
1355 /* Number of commands to print in each call to show_commands. */
1356 #define Hist_print 10
1358 show_commands (char *args
, int from_tty
)
1360 /* Index for history commands. Relative to history_base. */
1363 /* Number of the history entry which we are planning to display next.
1364 Relative to history_base. */
1367 /* The first command in the history which doesn't exist (i.e. one more
1368 than the number of the last command). Relative to history_base. */
1371 /* Print out some of the commands from the command history. */
1372 /* First determine the length of the history list. */
1373 hist_len
= history_size
;
1374 for (offset
= 0; offset
< history_size
; offset
++)
1376 if (!history_get (history_base
+ offset
))
1385 if (args
[0] == '+' && args
[1] == '\0')
1386 /* "info editing +" should print from the stored position. */
1389 /* "info editing <exp>" should print around command number <exp>. */
1390 num
= (parse_and_eval_long (args
) - history_base
) - Hist_print
/ 2;
1392 /* "show commands" means print the last Hist_print commands. */
1395 num
= hist_len
- Hist_print
;
1401 /* If there are at least Hist_print commands, we want to display the last
1402 Hist_print rather than, say, the last 6. */
1403 if (hist_len
- num
< Hist_print
)
1405 num
= hist_len
- Hist_print
;
1410 for (offset
= num
; offset
< num
+ Hist_print
&& offset
< hist_len
; offset
++)
1412 printf_filtered ("%5d %s\n", history_base
+ offset
,
1413 (history_get (history_base
+ offset
))->line
);
1416 /* The next command we want to display is the next one that we haven't
1420 /* If the user repeats this command with return, it should do what
1421 "show commands +" does. This is unnecessary if arg is null,
1422 because "show commands +" is not useful after "show commands". */
1423 if (from_tty
&& args
)
1430 /* Called by do_setshow_command. */
1432 set_history_size_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1434 if (history_size
== INT_MAX
)
1435 unstifle_history ();
1436 else if (history_size
>= 0)
1437 stifle_history (history_size
);
1440 history_size
= INT_MAX
;
1441 error (_("History size must be non-negative"));
1446 set_history (char *args
, int from_tty
)
1448 printf_unfiltered (_("\"set history\" must be followed "
1449 "by the name of a history subcommand.\n"));
1450 help_list (sethistlist
, "set history ", -1, gdb_stdout
);
1454 show_history (char *args
, int from_tty
)
1456 cmd_show_list (showhistlist
, from_tty
, "");
1459 int info_verbose
= 0; /* Default verbose msgs off. */
1461 /* Called by do_setshow_command. An elaborate joke. */
1463 set_verbose (char *args
, int from_tty
, struct cmd_list_element
*c
)
1465 char *cmdname
= "verbose";
1466 struct cmd_list_element
*showcmd
;
1468 showcmd
= lookup_cmd_1 (&cmdname
, showlist
, NULL
, 1);
1469 gdb_assert (showcmd
!= NULL
&& showcmd
!= CMD_LIST_AMBIGUOUS
);
1473 c
->doc
= "Set verbose printing of informational messages.";
1474 showcmd
->doc
= "Show verbose printing of informational messages.";
1478 c
->doc
= "Set verbosity.";
1479 showcmd
->doc
= "Show verbosity.";
1483 /* Init the history buffer. Note that we are called after the init file(s)
1484 have been read so that the user can change the history file via his
1485 .gdbinit file (for instance). The GDBHISTFILE environment variable
1486 overrides all of this. */
1493 tmpenv
= getenv ("HISTSIZE");
1495 history_size
= atoi (tmpenv
);
1496 else if (!history_size
)
1499 stifle_history (history_size
);
1501 tmpenv
= getenv ("GDBHISTFILE");
1503 history_filename
= xstrdup (tmpenv
);
1504 else if (!history_filename
)
1506 /* We include the current directory so that if the user changes
1507 directories the file written will be the same as the one
1510 /* No leading dots in file names are allowed on MSDOS. */
1511 history_filename
= concat (current_directory
, "/_gdb_history",
1514 history_filename
= concat (current_directory
, "/.gdb_history",
1518 read_history (history_filename
);
1522 show_prompt (struct ui_file
*file
, int from_tty
,
1523 struct cmd_list_element
*c
, const char *value
)
1525 fprintf_filtered (file
, _("Gdb's prompt is \"%s\".\n"), value
);
1529 show_async_command_editing_p (struct ui_file
*file
, int from_tty
,
1530 struct cmd_list_element
*c
, const char *value
)
1532 fprintf_filtered (file
, _("Editing of command lines as "
1533 "they are typed is %s.\n"),
1538 show_annotation_level (struct ui_file
*file
, int from_tty
,
1539 struct cmd_list_element
*c
, const char *value
)
1541 fprintf_filtered (file
, _("Annotation_level is %s.\n"), value
);
1545 show_exec_done_display_p (struct ui_file
*file
, int from_tty
,
1546 struct cmd_list_element
*c
, const char *value
)
1548 fprintf_filtered (file
, _("Notification of completion for "
1549 "asynchronous execution commands is %s.\n"),
1555 /* Initialize the prompt to a simple "(gdb) " prompt or to whatever
1556 the DEFAULT_PROMPT is. */
1557 set_prompt (DEFAULT_PROMPT
);
1559 /* Set things up for annotation_level > 1, if the user ever decides
1561 async_annotation_suffix
= "prompt";
1563 /* Set the important stuff up for command editing. */
1564 command_editing_p
= 1;
1565 history_expansion_p
= 0;
1566 write_history_p
= 0;
1568 /* Setup important stuff for command line editing. */
1569 rl_completion_word_break_hook
= gdb_completion_word_break_characters
;
1570 rl_completion_entry_function
= readline_line_completion_function
;
1571 rl_completer_word_break_characters
= default_word_break_characters ();
1572 rl_completer_quote_characters
= get_gdb_completer_quote_characters ();
1573 rl_readline_name
= "gdb";
1574 rl_terminal_name
= getenv ("TERM");
1576 /* The name for this defun comes from Bash, where it originated.
1577 15 is Control-o, the same binding this function has in Bash. */
1578 rl_add_defun ("operate-and-get-next", gdb_rl_operate_and_get_next
, 15);
1580 add_setshow_string_cmd ("prompt", class_support
,
1582 _("Set gdb's prompt"),
1583 _("Show gdb's prompt"),
1586 &setlist
, &showlist
);
1588 add_com ("dont-repeat", class_support
, dont_repeat_command
, _("\
1589 Don't repeat this command.\nPrimarily \
1590 used inside of user-defined commands that should not be repeated when\n\
1593 add_setshow_boolean_cmd ("editing", class_support
,
1594 &async_command_editing_p
, _("\
1595 Set editing of command lines as they are typed."), _("\
1596 Show editing of command lines as they are typed."), _("\
1597 Use \"on\" to enable the editing, and \"off\" to disable it.\n\
1598 Without an argument, command line editing is enabled. To edit, use\n\
1599 EMACS-like or VI-like commands like control-P or ESC."),
1600 set_async_editing_command
,
1601 show_async_command_editing_p
,
1602 &setlist
, &showlist
);
1604 add_setshow_boolean_cmd ("save", no_class
, &write_history_p
, _("\
1605 Set saving of the history record on exit."), _("\
1606 Show saving of the history record on exit."), _("\
1607 Use \"on\" to enable the saving, and \"off\" to disable it.\n\
1608 Without an argument, saving is enabled."),
1610 show_write_history_p
,
1611 &sethistlist
, &showhistlist
);
1613 add_setshow_integer_cmd ("size", no_class
, &history_size
, _("\
1614 Set the size of the command history,"), _("\
1615 Show the size of the command history,"), _("\
1616 ie. the number of previous commands to keep a record of."),
1617 set_history_size_command
,
1619 &sethistlist
, &showhistlist
);
1621 add_setshow_filename_cmd ("filename", no_class
, &history_filename
, _("\
1622 Set the filename in which to record the command history"), _("\
1623 Show the filename in which to record the command history"), _("\
1624 (the list of previous commands of which a record is kept)."),
1626 show_history_filename
,
1627 &sethistlist
, &showhistlist
);
1629 add_setshow_boolean_cmd ("confirm", class_support
, &caution
, _("\
1630 Set whether to confirm potentially dangerous operations."), _("\
1631 Show whether to confirm potentially dangerous operations."), NULL
,
1634 &setlist
, &showlist
);
1636 add_setshow_zinteger_cmd ("annotate", class_obscure
, &annotation_level
, _("\
1637 Set annotation_level."), _("\
1638 Show annotation_level."), _("\
1639 0 == normal; 1 == fullname (for use when running under emacs)\n\
1640 2 == output annotated suitably for use by programs that control GDB."),
1642 show_annotation_level
,
1643 &setlist
, &showlist
);
1645 add_setshow_boolean_cmd ("exec-done-display", class_support
,
1646 &exec_done_display_p
, _("\
1647 Set notification of completion for asynchronous execution commands."), _("\
1648 Show notification of completion for asynchronous execution commands."), _("\
1649 Use \"on\" to enable the notification, and \"off\" to disable it."),
1651 show_exec_done_display_p
,
1652 &setlist
, &showlist
);
1654 add_setshow_filename_cmd ("data-directory", class_maintenance
,
1655 &gdb_datadir
, _("Set GDB's data directory."),
1656 _("Show GDB's data directory."),
1658 When set, GDB uses the specified path to search for data files."),
1665 gdb_init (char *argv0
)
1667 if (pre_init_ui_hook
)
1668 pre_init_ui_hook ();
1670 /* Run the init function of each source file. */
1673 /* Make sure we return to the original directory upon exit, come
1674 what may, since the OS doesn't do that for us. */
1675 make_final_cleanup (do_chdir_cleanup
, xstrdup (current_directory
));
1678 init_cmd_lists (); /* This needs to be done first. */
1679 initialize_targets (); /* Setup target_terminal macros for utils.c. */
1680 initialize_utils (); /* Make errors and warnings possible. */
1682 /* Here is where we call all the _initialize_foo routines. */
1683 initialize_all_files ();
1685 /* This creates the current_program_space. Do this after all the
1686 _initialize_foo routines have had a chance to install their
1687 per-sspace data keys. Also do this before
1688 initialize_current_architecture is called, because it accesses
1689 exec_bfd of the current program space. */
1690 initialize_progspace ();
1691 initialize_inferiors ();
1692 initialize_current_architecture ();
1694 init_main (); /* But that omits this file! Do it now. */
1696 initialize_stdin_serial ();
1698 async_init_signals ();
1700 /* We need a default language for parsing expressions, so simple
1701 things like "set width 0" won't fail if no language is explicitly
1702 set in a config file or implicitly set by reading an executable
1704 set_language (language_c
);
1705 expected_language
= current_language
; /* Don't warn about the change. */
1707 /* Allow another UI to initialize. If the UI fails to initialize,
1708 and it wants GDB to revert to the CLI, it should clear
1709 deprecated_init_ui_hook. */
1710 if (deprecated_init_ui_hook
)
1711 deprecated_init_ui_hook (argv0
);
1714 /* Python initialization can require various commands to be
1715 installed. For example "info pretty-printer" needs the "info"
1716 prefix to be installed. Keep things simple and just do final
1717 python initialization here. */
1718 finish_python_initialization ();