1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 #include <sys/types.h>
31 #include "event-loop.h"
37 #include "cli/cli-cmds.h"
39 #include "auto-load.h"
42 #include "filenames.h"
43 #include "gdbsupport/filestuff.h"
45 #include "event-top.h"
47 #include "gdbsupport/signals-state-save-restore.h"
49 #include "gdbsupport/pathstuff.h"
50 #include "cli/cli-style.h"
52 #include "gdbtk/generic/gdbtk.h"
55 /* The selected interpreter. This will be used as a set command
56 variable, so it should always be malloc'ed - since
57 do_setshow_command will free it. */
60 /* Whether dbx commands will be handled. */
63 /* System root path, used to find libraries etc. */
64 char *gdb_sysroot
= 0;
66 /* GDB datadir, used to store data files. */
67 std::string gdb_datadir
;
69 /* Non-zero if GDB_DATADIR was provided on the command line.
70 This doesn't track whether data-directory is set later from the
71 command line, but we don't reread system.gdbinit when that happens. */
72 static int gdb_datadir_provided
= 0;
74 /* If gdb was configured with --with-python=/path,
75 the possibly relocated path to python's lib directory. */
76 std::string python_libdir
;
78 /* Target IO streams. */
79 struct ui_file
*gdb_stdtargin
;
80 struct ui_file
*gdb_stdtarg
;
81 struct ui_file
*gdb_stdtargerr
;
83 /* True if --batch or --batch-silent was seen. */
86 /* Support for the --batch-silent option. */
89 /* Support for --return-child-result option.
90 Set the default to -1 to return error in the case
91 that the program does not run or does not complete. */
92 int return_child_result
= 0;
93 int return_child_result_value
= -1;
96 /* GDB as it has been invoked from the command line (i.e. argv[0]). */
97 static char *gdb_program_name
;
99 /* Return read only pointer to GDB_PROGRAM_NAME. */
101 get_gdb_program_name (void)
103 return gdb_program_name
;
106 static void print_gdb_help (struct ui_file
*);
108 /* Set the data-directory parameter to NEW_DATADIR.
109 If NEW_DATADIR is not a directory then a warning is printed.
110 We don't signal an error for backward compatibility. */
113 set_gdb_data_directory (const char *new_datadir
)
117 if (stat (new_datadir
, &st
) < 0)
119 int save_errno
= errno
;
121 fprintf_unfiltered (gdb_stderr
, "Warning: ");
122 print_sys_errmsg (new_datadir
, save_errno
);
124 else if (!S_ISDIR (st
.st_mode
))
125 warning (_("%s is not a directory."), new_datadir
);
127 gdb_datadir
= gdb_realpath (new_datadir
).get ();
129 /* gdb_realpath won't return an absolute path if the path doesn't exist,
130 but we still want to record an absolute path here. If the user entered
131 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
132 isn't canonical, but that's ok. */
133 if (!IS_ABSOLUTE_PATH (gdb_datadir
.c_str ()))
135 gdb::unique_xmalloc_ptr
<char> abs_datadir
136 = gdb_abspath (gdb_datadir
.c_str ());
138 gdb_datadir
= abs_datadir
.get ();
142 /* Relocate a file or directory. PROGNAME is the name by which gdb
143 was invoked (i.e., argv[0]). INITIAL is the default value for the
144 file or directory. RELOCATABLE is true if the value is relocatable,
145 false otherwise. This may return an empty string under the same
146 conditions as make_relative_prefix returning NULL. */
149 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
153 gdb::unique_xmalloc_ptr
<char> str (make_relative_prefix (progname
,
158 return std::string ();
163 /* Like relocate_path, but specifically checks for a directory.
164 INITIAL is relocated according to the rules of relocate_path. If
165 the result is a directory, it is used; otherwise, INITIAL is used.
166 The chosen directory is then canonicalized using lrealpath. */
169 relocate_gdb_directory (const char *initial
, bool relocatable
)
171 std::string dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
176 if (stat (dir
.c_str (), &s
) != 0 || !S_ISDIR (s
.st_mode
))
184 /* Canonicalize the directory. */
187 gdb::unique_xmalloc_ptr
<char> canon_sysroot (lrealpath (dir
.c_str ()));
190 dir
= canon_sysroot
.get ();
196 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
197 parameter if it is in the data dir, or passes it through relocate_path
201 relocate_gdbinit_path_maybe_in_datadir (const std::string
& file
)
203 size_t datadir_len
= strlen (GDB_DATADIR
);
205 std::string relocated_path
;
207 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
208 has been provided, search for SYSTEM_GDBINIT there. */
209 if (gdb_datadir_provided
210 && datadir_len
< file
.length ()
211 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
212 && IS_DIR_SEPARATOR (file
[datadir_len
]))
214 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
217 size_t start
= datadir_len
;
218 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
220 relocated_path
= gdb_datadir
+ SLASH_STRING
+ file
.substr (start
);
224 relocated_path
= relocate_path (gdb_program_name
,
226 SYSTEM_GDBINIT_RELOCATABLE
);
228 return relocated_path
;
231 /* Compute the locations of init files that GDB should source and
232 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
233 there is no system gdbinit (resp. home gdbinit and local gdbinit)
234 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
235 LOCAL_GDBINIT) is set to the empty string. */
237 get_init_files (std::string
*system_gdbinit
,
238 std::string
*home_gdbinit
,
239 std::string
*local_gdbinit
)
241 static std::string sysgdbinit
;
242 static std::string homeinit
;
243 static std::string localinit
;
244 static int initialized
= 0;
248 struct stat homebuf
, cwdbuf
, s
;
250 if (SYSTEM_GDBINIT
[0])
252 std::string relocated_sysgdbinit
253 = relocate_gdbinit_path_maybe_in_datadir (SYSTEM_GDBINIT
);
254 if (!relocated_sysgdbinit
.empty ()
255 && stat (relocated_sysgdbinit
.c_str (), &s
) == 0)
256 sysgdbinit
= relocated_sysgdbinit
;
259 const char *homedir
= getenv ("HOME");
261 /* If the .gdbinit file in the current directory is the same as
262 the $HOME/.gdbinit file, it should not be sourced. homebuf
263 and cwdbuf are used in that purpose. Make sure that the stats
264 are zero in case one of them fails (this guarantees that they
265 won't match if either exists). */
267 memset (&homebuf
, 0, sizeof (struct stat
));
268 memset (&cwdbuf
, 0, sizeof (struct stat
));
272 homeinit
= std::string (homedir
) + SLASH_STRING
+ GDBINIT
;
273 if (stat (homeinit
.c_str (), &homebuf
) != 0)
279 if (stat (GDBINIT
, &cwdbuf
) == 0)
281 if (homeinit
.empty ()
282 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
283 sizeof (struct stat
)))
290 *system_gdbinit
= sysgdbinit
;
291 *home_gdbinit
= homeinit
;
292 *local_gdbinit
= localinit
;
295 /* Try to set up an alternate signal stack for SIGSEGV handlers.
296 This allows us to handle SIGSEGV signals generated when the
297 normal process stack is exhausted. If this stack is not set
298 up (sigaltstack is unavailable or fails) and a SIGSEGV is
299 generated when the normal stack is exhausted then the program
300 will behave as though no SIGSEGV handler was installed. */
303 setup_alternate_signal_stack (void)
305 #ifdef HAVE_SIGALTSTACK
308 /* FreeBSD versions older than 11.0 use char * for ss_sp instead of
309 void *. This cast works with both types. */
310 ss
.ss_sp
= (char *) xmalloc (SIGSTKSZ
);
311 ss
.ss_size
= SIGSTKSZ
;
314 sigaltstack(&ss
, NULL
);
318 /* Call command_loop. */
320 /* Prevent inlining this function for the benefit of GDB's selftests
321 in the testsuite. Those tests want to run GDB under GDB and stop
323 static void captured_command_loop () __attribute__((noinline
));
326 captured_command_loop ()
328 struct ui
*ui
= current_ui
;
330 /* Top-level execution commands can be run in the background from
332 current_ui
->async
= 1;
334 /* Give the interpreter a chance to print a prompt, if necessary */
335 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
336 interp_pre_command_loop (top_level_interpreter ());
338 /* Now it's time to start the event loop. */
341 /* If the command_loop returned, normally (rather than threw an
342 error) we try to quit. If the quit is aborted, our caller
343 catches the signal and restarts the command loop. */
344 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
347 /* Handle command errors thrown from within catch_command_errors. */
350 handle_command_errors (const struct gdb_exception
&e
)
354 exception_print (gdb_stderr
, e
);
356 /* If any exception escaped to here, we better enable stdin.
357 Otherwise, any command that calls async_disable_stdin, and
358 then throws, will leave stdin inoperable. */
359 async_enable_stdin ();
365 /* Type of the command callback passed to the const
366 catch_command_errors. */
368 typedef void (catch_command_errors_const_ftype
) (const char *, int);
370 /* Wrap calls to commands run before the event loop is started. */
373 catch_command_errors (catch_command_errors_const_ftype command
,
374 const char *arg
, int from_tty
)
378 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
380 command (arg
, from_tty
);
382 maybe_wait_sync_command_done (was_sync
);
384 catch (const gdb_exception
&e
)
386 return handle_command_errors (e
);
392 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
393 symfile_add_flags. */
396 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
398 symfile_add_flags add_flags
= 0;
401 add_flags
|= SYMFILE_VERBOSE
;
403 symbol_file_add_main (arg
, add_flags
);
406 /* Perform validation of the '--readnow' and '--readnever' flags. */
409 validate_readnow_readnever ()
411 if (readnever_symbol_files
&& readnow_symbol_files
)
413 error (_("%s: '--readnow' and '--readnever' cannot be "
414 "specified simultaneously"),
419 /* Type of this option. */
422 /* Option type -x. */
425 /* Option type -ex. */
428 /* Option type -ix. */
431 /* Option type -iex. */
435 /* Arguments of --command option and its counterpart. */
438 cmdarg (cmdarg_kind type_
, char *string_
)
439 : type (type_
), string (string_
)
442 /* Type of this option. */
443 enum cmdarg_kind type
;
445 /* Value of this option - filename or the GDB command itself. String memory
446 is not owned by this structure despite it is 'const'. */
451 captured_main_1 (struct captured_main_args
*context
)
453 int argc
= context
->argc
;
454 char **argv
= context
->argv
;
456 static int quiet
= 0;
457 static int set_args
= 0;
458 static int inhibit_home_gdbinit
= 0;
460 /* Pointers to various arguments from command line. */
462 char *execarg
= NULL
;
464 char *corearg
= NULL
;
465 char *pid_or_core_arg
= NULL
;
469 /* These are static so that we can take their address in an
471 static int print_help
;
472 static int print_version
;
473 static int print_configuration
;
475 /* Pointers to all arguments of --command option. */
476 std::vector
<struct cmdarg
> cmdarg_vec
;
478 /* All arguments of --directory option. */
479 std::vector
<char *> dirarg
;
485 #ifdef HAVE_USEFUL_SBRK
486 /* Set this before constructing scoped_command_stats. */
487 lim_at_start
= (char *) sbrk (0);
490 scoped_command_stats
stat_reporter (false);
492 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
493 setlocale (LC_MESSAGES
, "");
495 #if defined (HAVE_SETLOCALE)
496 setlocale (LC_CTYPE
, "");
499 bindtextdomain (PACKAGE
, LOCALEDIR
);
500 textdomain (PACKAGE
);
506 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
507 as a Windows pipe, and Windows buffers on pipes. */
508 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
511 /* Note: `error' cannot be called before this point, because the
512 caller will crash when trying to print the exception. */
513 main_ui
= new ui (stdin
, stdout
, stderr
);
514 current_ui
= main_ui
;
516 gdb_stdtargerr
= gdb_stderr
; /* for moment */
517 gdb_stdtargin
= gdb_stdin
; /* for moment */
519 if (bfd_init () != BFD_INIT_MAGIC
)
520 error (_("fatal error: libbfd ABI mismatch"));
523 /* On Windows, argv[0] is not necessarily set to absolute form when
524 GDB is found along PATH, without which relocation doesn't work. */
525 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
527 gdb_program_name
= xstrdup (argv
[0]);
530 /* Prefix warning messages with the command name. */
531 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
532 (xstrprintf ("%s: warning: ", gdb_program_name
));
533 warning_pre_print
= tmp_warn_preprint
.get ();
535 current_directory
= getcwd (NULL
, 0);
536 if (current_directory
== NULL
)
537 perror_warning_with_name (_("error finding working directory"));
539 /* Set the sysroot path. */
541 = xstrdup (relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
542 TARGET_SYSTEM_ROOT_RELOCATABLE
).c_str ());
544 if (*gdb_sysroot
== '\0')
547 gdb_sysroot
= xstrdup (TARGET_SYSROOT_PREFIX
);
551 = xstrdup (relocate_gdb_directory (DEBUGDIR
,
552 DEBUGDIR_RELOCATABLE
).c_str ());
554 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
555 GDB_DATADIR_RELOCATABLE
);
557 #ifdef WITH_PYTHON_PATH
559 /* For later use in helping Python find itself. */
560 char *tmp
= concat (WITH_PYTHON_PATH
, SLASH_STRING
, "lib", (char *) NULL
);
562 python_libdir
= relocate_gdb_directory (tmp
, PYTHON_PATH_RELOCATABLE
);
568 add_substitute_path_rule (RELOC_SRCDIR
,
569 make_relative_prefix (gdb_program_name
, BINDIR
,
573 /* There will always be an interpreter. Either the one passed into
574 this captured main, or one specified by the user at start up, or
575 the console. Initialize the interpreter to the one requested by
577 interpreter_p
= xstrdup (context
->interpreter_p
);
579 /* Parse arguments and options. */
582 /* When var field is 0, use flag field to record the equivalent
583 short option (or arbitrary numbers starting at 10 for those
584 with no equivalent). */
598 /* This struct requires int* in the struct, but write_files is a bool.
599 So use this temporary int that we write back after argument parsing. */
600 int write_files_1
= 0;
601 static struct option long_options
[] =
603 {"tui", no_argument
, 0, OPT_TUI
},
604 {"dbx", no_argument
, &dbx_commands
, 1},
605 {"readnow", no_argument
, NULL
, OPT_READNOW
},
606 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
607 {"r", no_argument
, NULL
, OPT_READNOW
},
608 {"quiet", no_argument
, &quiet
, 1},
609 {"q", no_argument
, &quiet
, 1},
610 {"silent", no_argument
, &quiet
, 1},
611 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
612 {"nx", no_argument
, &inhibit_gdbinit
, 1},
613 {"n", no_argument
, &inhibit_gdbinit
, 1},
614 {"batch-silent", no_argument
, 0, 'B'},
615 {"batch", no_argument
, &batch_flag
, 1},
617 /* This is a synonym for "--annotate=1". --annotate is now
618 preferred, but keep this here for a long time because people
619 will be running emacses which use --fullname. */
620 {"fullname", no_argument
, 0, 'f'},
621 {"f", no_argument
, 0, 'f'},
623 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
624 {"help", no_argument
, &print_help
, 1},
625 {"se", required_argument
, 0, OPT_SE
},
626 {"symbols", required_argument
, 0, 's'},
627 {"s", required_argument
, 0, 's'},
628 {"exec", required_argument
, 0, 'e'},
629 {"e", required_argument
, 0, 'e'},
630 {"core", required_argument
, 0, 'c'},
631 {"c", required_argument
, 0, 'c'},
632 {"pid", required_argument
, 0, 'p'},
633 {"p", required_argument
, 0, 'p'},
634 {"command", required_argument
, 0, 'x'},
635 {"eval-command", required_argument
, 0, 'X'},
636 {"version", no_argument
, &print_version
, 1},
637 {"configuration", no_argument
, &print_configuration
, 1},
638 {"x", required_argument
, 0, 'x'},
639 {"ex", required_argument
, 0, 'X'},
640 {"init-command", required_argument
, 0, OPT_IX
},
641 {"init-eval-command", required_argument
, 0, OPT_IEX
},
642 {"ix", required_argument
, 0, OPT_IX
},
643 {"iex", required_argument
, 0, OPT_IEX
},
645 {"tclcommand", required_argument
, 0, 'z'},
646 {"enable-external-editor", no_argument
, 0, 'y'},
647 {"editor-command", required_argument
, 0, 'w'},
649 {"ui", required_argument
, 0, 'i'},
650 {"interpreter", required_argument
, 0, 'i'},
651 {"i", required_argument
, 0, 'i'},
652 {"directory", required_argument
, 0, 'd'},
653 {"d", required_argument
, 0, 'd'},
654 {"data-directory", required_argument
, 0, 'D'},
655 {"D", required_argument
, 0, 'D'},
656 {"cd", required_argument
, 0, OPT_CD
},
657 {"tty", required_argument
, 0, 't'},
658 {"baud", required_argument
, 0, 'b'},
659 {"b", required_argument
, 0, 'b'},
660 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
661 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
662 {"w", no_argument
, NULL
, OPT_WINDOWS
},
663 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
664 {"statistics", no_argument
, 0, OPT_STATISTICS
},
665 {"write", no_argument
, &write_files_1
, 1},
666 {"args", no_argument
, &set_args
, 1},
667 {"l", required_argument
, 0, 'l'},
668 {"return-child-result", no_argument
, &return_child_result
, 1},
669 {0, no_argument
, 0, 0}
676 c
= getopt_long_only (argc
, argv
, "",
677 long_options
, &option_index
);
678 if (c
== EOF
|| set_args
)
681 /* Long option that takes an argument. */
682 if (c
== 0 && long_options
[option_index
].flag
== 0)
683 c
= long_options
[option_index
].val
;
688 /* Long option that just sets a flag. */
698 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
699 annotation_level
= atoi (optarg
);
702 /* Enable the display of both time and space usage. */
703 set_per_command_time (1);
704 set_per_command_space (1);
707 /* --tui is equivalent to -i=tui. */
709 xfree (interpreter_p
);
710 interpreter_p
= xstrdup (INTERP_TUI
);
712 error (_("%s: TUI mode is not supported"), gdb_program_name
);
716 /* FIXME: cagney/2003-03-01: Not sure if this option is
717 actually useful, and if it is, what it should do. */
719 /* --windows is equivalent to -i=insight. */
720 xfree (interpreter_p
);
721 interpreter_p
= xstrdup (INTERP_INSIGHT
);
725 /* -nw is equivalent to -i=console. */
726 xfree (interpreter_p
);
727 interpreter_p
= xstrdup (INTERP_CONSOLE
);
730 annotation_level
= 1;
745 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
748 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
751 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
754 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
757 batch_flag
= batch_silent
= 1;
758 gdb_stdout
= new null_file ();
761 if (optarg
[0] == '\0')
762 error (_("%s: empty path for `--data-directory'"),
764 set_gdb_data_directory (optarg
);
765 gdb_datadir_provided
= 1;
770 if (!gdbtk_test (optarg
))
771 error (_("%s: unable to load tclcommand file \"%s\""),
772 gdb_program_name
, optarg
);
776 /* Backwards compatibility only. */
780 /* Set the external editor commands when gdb is farming out files
781 to be edited by another program. */
782 external_editor_command
= xstrdup (optarg
);
787 xfree (interpreter_p
);
788 interpreter_p
= xstrdup (optarg
);
791 dirarg
.push_back (optarg
);
804 rate
= strtol (optarg
, &p
, 0);
805 if (rate
== 0 && p
== optarg
)
806 warning (_("could not set baud rate to `%s'."),
817 timeout
= strtol (optarg
, &p
, 0);
818 if (timeout
== 0 && p
== optarg
)
819 warning (_("could not set timeout limit to `%s'."),
822 remote_timeout
= timeout
;
828 readnow_symbol_files
= 1;
829 validate_readnow_readnever ();
835 readnever_symbol_files
= 1;
836 validate_readnow_readnever ();
841 error (_("Use `%s --help' for a complete list of options."),
845 write_files
= (write_files_1
!= 0);
851 /* Disable all output styling when running in batch mode. */
856 save_original_signals_state (quiet
);
858 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
859 setup_alternate_signal_stack ();
861 /* Initialize all files. */
862 gdb_init (gdb_program_name
);
864 /* Now that gdb_init has created the initial inferior, we're in
865 position to set args for that inferior. */
868 /* The remaining options are the command-line options for the
869 inferior. The first one is the sym/exec file, and the rest
872 error (_("%s: `--args' specified but no program specified"),
875 symarg
= argv
[optind
];
876 execarg
= argv
[optind
];
878 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
882 /* OK, that's all the options. */
884 /* The first argument, if specified, is the name of the
888 symarg
= argv
[optind
];
889 execarg
= argv
[optind
];
893 /* If the user hasn't already specified a PID or the name of a
894 core file, then a second optional argument is allowed. If
895 present, this argument should be interpreted as either a
896 PID or a core file, whichever works. */
897 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
899 pid_or_core_arg
= argv
[optind
];
903 /* Any argument left on the command line is unexpected and
904 will be ignored. Inform the user. */
906 fprintf_unfiltered (gdb_stderr
,
907 _("Excess command line "
908 "arguments ignored. (%s%s)\n"),
910 (optind
== argc
- 1) ? "" : " ...");
913 /* Lookup gdbinit files. Note that the gdbinit file name may be
914 overriden during file initialization, so get_init_files should be
915 called after gdb_init. */
916 std::string system_gdbinit
;
917 std::string home_gdbinit
;
918 std::string local_gdbinit
;
919 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
921 /* Do these (and anything which might call wrap_here or *_filtered)
922 after initialize_all_files() but before the interpreter has been
923 installed. Otherwize the help/version messages will be eaten by
924 the interpreter's output handler. */
928 print_gdb_version (gdb_stdout
, false);
930 printf_filtered ("\n");
936 print_gdb_help (gdb_stdout
);
937 fputs_unfiltered ("\n", gdb_stdout
);
941 if (print_configuration
)
943 print_gdb_configuration (gdb_stdout
);
945 printf_filtered ("\n");
949 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
950 GDB retain the old MI1 interpreter startup behavior. Output the
951 copyright message before the interpreter is installed. That way
952 it isn't encapsulated in MI output. */
953 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
955 /* Print all the junk at the top, with trailing "..." if we are
956 about to read a symbol file (possibly slowly). */
957 print_gdb_version (gdb_stdout
, true);
959 printf_filtered ("..");
961 printf_filtered ("\n");
962 gdb_flush (gdb_stdout
); /* Force to screen during slow
966 /* Install the default UI. All the interpreters should have had a
967 look at things by now. Initialize the default interpreter. */
968 set_top_level_interpreter (interpreter_p
);
970 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
971 GDB retain the old MI1 interpreter startup behavior. Output the
972 copyright message after the interpreter is installed when it is
973 any sane interpreter. */
974 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
976 /* Print all the junk at the top, with trailing "..." if we are
977 about to read a symbol file (possibly slowly). */
978 print_gdb_version (gdb_stdout
, true);
980 printf_filtered ("..");
982 printf_filtered ("\n");
983 gdb_flush (gdb_stdout
); /* Force to screen during slow
987 /* Set off error and warning messages with a blank line. */
988 tmp_warn_preprint
.reset ();
989 warning_pre_print
= _("\nwarning: ");
991 /* Read and execute the system-wide gdbinit file, if it exists.
992 This is done *before* all the command line arguments are
993 processed; it sets global parameters, which are independent of
994 what file you are debugging or what directory you are in. */
995 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
996 ret
= catch_command_errors (source_script
, system_gdbinit
.c_str (), 0);
998 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
999 *before* all the command line arguments are processed; it sets
1000 global parameters, which are independent of what file you are
1001 debugging or what directory you are in. */
1003 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1004 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1006 /* Process '-ix' and '-iex' options early. */
1007 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1009 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1011 switch (cmdarg_p
.type
)
1013 case CMDARG_INIT_FILE
:
1014 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1017 case CMDARG_INIT_COMMAND
:
1018 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1024 /* Now perform all the actions indicated by the arguments. */
1027 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1030 for (i
= 0; i
< dirarg
.size (); i
++)
1031 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1033 /* Skip auto-loading section-specified scripts until we've sourced
1034 local_gdbinit (which is often used to augment the source search
1036 save_auto_load
= global_auto_load
;
1037 global_auto_load
= 0;
1041 && strcmp (execarg
, symarg
) == 0)
1043 /* The exec file and the symbol-file are the same. If we can't
1044 open it, better only print one error message.
1045 catch_command_errors returns non-zero on success! */
1046 ret
= catch_command_errors (exec_file_attach
, execarg
,
1049 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1050 symarg
, !batch_flag
);
1054 if (execarg
!= NULL
)
1055 ret
= catch_command_errors (exec_file_attach
, execarg
,
1058 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1059 symarg
, !batch_flag
);
1062 if (corearg
&& pidarg
)
1063 error (_("Can't attach to process and specify "
1064 "a core file at the same time."));
1066 if (corearg
!= NULL
)
1068 ret
= catch_command_errors (core_file_command
, corearg
,
1071 else if (pidarg
!= NULL
)
1073 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1075 else if (pid_or_core_arg
)
1077 /* The user specified 'gdb program pid' or gdb program core'.
1078 If pid_or_core_arg's first character is a digit, try attach
1079 first and then corefile. Otherwise try just corefile. */
1081 if (isdigit (pid_or_core_arg
[0]))
1083 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1086 ret
= catch_command_errors (core_file_command
,
1092 /* Can't be a pid, better be a corefile. */
1093 ret
= catch_command_errors (core_file_command
,
1100 set_inferior_io_terminal (ttyarg
);
1102 /* Error messages should no longer be distinguished with extra output. */
1103 warning_pre_print
= _("warning: ");
1105 /* Read the .gdbinit file in the current directory, *if* it isn't
1106 the same as the $HOME/.gdbinit file (it should exist, also). */
1107 if (!local_gdbinit
.empty ())
1109 auto_load_local_gdbinit_pathname
1110 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1112 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
1113 && file_is_auto_load_safe (local_gdbinit
.c_str (),
1114 _("auto-load: Loading .gdbinit "
1116 local_gdbinit
.c_str ()))
1118 auto_load_local_gdbinit_loaded
= 1;
1120 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1124 /* Now that all .gdbinit's have been read and all -d options have been
1125 processed, we can read any scripts mentioned in SYMARG.
1126 We wait until now because it is common to add to the source search
1127 path in local_gdbinit. */
1128 global_auto_load
= save_auto_load
;
1129 for (objfile
*objfile
: current_program_space
->objfiles ())
1130 load_auto_scripts_for_objfile (objfile
);
1132 /* Process '-x' and '-ex' options. */
1133 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1135 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1137 switch (cmdarg_p
.type
)
1140 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1143 case CMDARG_COMMAND
:
1144 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1150 /* Read in the old history after all the command files have been
1156 int error_status
= EXIT_FAILURE
;
1157 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1159 /* We have hit the end of the batch file. */
1160 quit_force (exit_arg
, 0);
1165 captured_main (void *data
)
1167 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1169 captured_main_1 (context
);
1171 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1172 moving this loop and the code found in captured_command_loop()
1173 into the command_loop() proper. The main thing holding back that
1174 change - SET_TOP_LEVEL() - has been eliminated. */
1179 captured_command_loop ();
1181 catch (const gdb_exception
&ex
)
1183 exception_print (gdb_stderr
, ex
);
1186 /* No exit -- exit is through quit_command. */
1190 gdb_main (struct captured_main_args
*args
)
1194 captured_main (args
);
1196 catch (const gdb_exception
&ex
)
1198 exception_print (gdb_stderr
, ex
);
1201 /* The only way to end up here is by an error (normal exit is
1202 handled by quit_force()), hence always return an error status. */
1207 /* Don't use *_filtered for printing help. We don't want to prompt
1208 for continue no matter how small the screen or how much we're going
1212 print_gdb_help (struct ui_file
*stream
)
1214 std::string system_gdbinit
;
1215 std::string home_gdbinit
;
1216 std::string local_gdbinit
;
1218 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1220 /* Note: The options in the list below are only approximately sorted
1221 in the alphabetical order, so as to group closely related options
1223 fputs_unfiltered (_("\
1224 This is the GNU debugger. Usage:\n\n\
1225 gdb [options] [executable-file [core-file or process-id]]\n\
1226 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1228 fputs_unfiltered (_("\
1229 Selection of debuggee and its files:\n\n\
1230 --args Arguments after executable-file are passed to inferior\n\
1231 --core=COREFILE Analyze the core dump COREFILE.\n\
1232 --exec=EXECFILE Use EXECFILE as the executable.\n\
1233 --pid=PID Attach to running process PID.\n\
1234 --directory=DIR Search for source files in DIR.\n\
1235 --se=FILE Use FILE as symbol file and executable file.\n\
1236 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1237 --readnow Fully read symbol files on first access.\n\
1238 --readnever Do not read symbol files.\n\
1239 --write Set writing into executable and core files.\n\n\
1241 fputs_unfiltered (_("\
1242 Initial commands and command files:\n\n\
1243 --command=FILE, -x Execute GDB commands from FILE.\n\
1244 --init-command=FILE, -ix\n\
1245 Like -x but execute commands before loading inferior.\n\
1246 --eval-command=COMMAND, -ex\n\
1247 Execute a single GDB command.\n\
1248 May be used multiple times and in conjunction\n\
1250 --init-eval-command=COMMAND, -iex\n\
1251 Like -ex but before loading inferior.\n\
1252 --nh Do not read ~/.gdbinit.\n\
1253 --nx Do not read any .gdbinit files in any directory.\n\n\
1255 fputs_unfiltered (_("\
1256 Output and user interface control:\n\n\
1257 --fullname Output information used by emacs-GDB interface.\n\
1258 --interpreter=INTERP\n\
1259 Select a specific interpreter / user interface\n\
1260 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1261 -w Use the GUI interface.\n\
1262 --nw Do not use the GUI interface.\n\
1265 fputs_unfiltered (_("\
1266 --tui Use a terminal user interface.\n\
1269 fputs_unfiltered (_("\
1270 --dbx DBX compatibility mode.\n\
1271 -q, --quiet, --silent\n\
1272 Do not print version number on startup.\n\n\
1274 fputs_unfiltered (_("\
1275 Operating modes:\n\n\
1276 --batch Exit after processing options.\n\
1277 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1278 --return-child-result\n\
1279 GDB exit code will be the child's exit code.\n\
1280 --configuration Print details about GDB configuration and then exit.\n\
1281 --help Print this message and then exit.\n\
1282 --version Print version information and then exit.\n\n\
1283 Remote debugging options:\n\n\
1284 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1285 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1287 --cd=DIR Change current directory to DIR.\n\
1288 --data-directory=DIR, -D\n\
1289 Set GDB's data-directory to DIR.\n\
1291 fputs_unfiltered (_("\n\
1292 At startup, GDB reads the following init files and executes their commands:\n\
1294 if (!system_gdbinit
.empty ())
1295 fprintf_unfiltered (stream
, _("\
1296 * system-wide init file: %s\n\
1297 "), system_gdbinit
.c_str ());
1298 if (!home_gdbinit
.empty ())
1299 fprintf_unfiltered (stream
, _("\
1300 * user-specific init file: %s\n\
1301 "), home_gdbinit
.c_str ());
1302 if (!local_gdbinit
.empty ())
1303 fprintf_unfiltered (stream
, _("\
1304 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1305 "), local_gdbinit
.c_str ());
1306 fputs_unfiltered (_("\n\
1307 For more information, type \"help\" from within GDB, or consult the\n\
1308 GDB manual (available as on-line info or a printed manual).\n\
1310 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1311 fprintf_unfiltered (stream
, _("\
1312 Report bugs to \"%s\".\n\
1313 "), REPORT_BUGS_TO
);