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 "common/filestuff.h"
45 #include "event-top.h"
47 #include "common/signals-state-save-restore.h"
49 #include "common/pathstuff.h"
51 /* The selected interpreter. This will be used as a set command
52 variable, so it should always be malloc'ed - since
53 do_setshow_command will free it. */
56 /* Whether dbx commands will be handled. */
59 /* System root path, used to find libraries etc. */
60 char *gdb_sysroot = 0;
62 /* GDB datadir, used to store data files. */
63 char *gdb_datadir = 0;
65 /* Non-zero if GDB_DATADIR was provided on the command line.
66 This doesn't track whether data-directory is set later from the
67 command line, but we don't reread system.gdbinit when that happens. */
68 static int gdb_datadir_provided = 0;
70 /* If gdb was configured with --with-python=/path,
71 the possibly relocated path to python's lib directory. */
72 char *python_libdir = 0;
74 /* Target IO streams. */
75 struct ui_file *gdb_stdtargin;
76 struct ui_file *gdb_stdtarg;
77 struct ui_file *gdb_stdtargerr;
79 /* True if --batch or --batch-silent was seen. */
82 /* Support for the --batch-silent option. */
85 /* Support for --return-child-result option.
86 Set the default to -1 to return error in the case
87 that the program does not run or does not complete. */
88 int return_child_result = 0;
89 int return_child_result_value = -1;
92 /* GDB as it has been invoked from the command line (i.e. argv[0]). */
93 static char *gdb_program_name;
95 /* Return read only pointer to GDB_PROGRAM_NAME. */
97 get_gdb_program_name (void)
99 return gdb_program_name;
102 static void print_gdb_help (struct ui_file *);
104 /* Set the data-directory parameter to NEW_DATADIR.
105 If NEW_DATADIR is not a directory then a warning is printed.
106 We don't signal an error for backward compatibility. */
109 set_gdb_data_directory (const char *new_datadir)
113 if (stat (new_datadir, &st) < 0)
115 int save_errno = errno;
117 fprintf_unfiltered (gdb_stderr, "Warning: ");
118 print_sys_errmsg (new_datadir, save_errno);
120 else if (!S_ISDIR (st.st_mode))
121 warning (_("%s is not a directory."), new_datadir);
124 gdb_datadir = gdb_realpath (new_datadir).release ();
126 /* gdb_realpath won't return an absolute path if the path doesn't exist,
127 but we still want to record an absolute path here. If the user entered
128 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
129 isn't canonical, but that's ok. */
130 if (!IS_ABSOLUTE_PATH (gdb_datadir))
132 gdb::unique_xmalloc_ptr<char> abs_datadir = gdb_abspath (gdb_datadir);
135 gdb_datadir = abs_datadir.release ();
139 /* Relocate a file or directory. PROGNAME is the name by which gdb
140 was invoked (i.e., argv[0]). INITIAL is the default value for the
141 file or directory. FLAG is true if the value is relocatable, false
142 otherwise. Returns a newly allocated string; this may return NULL
143 under the same conditions as make_relative_prefix. */
146 relocate_path (const char *progname, const char *initial, int flag)
149 return make_relative_prefix (progname, BINDIR, initial);
150 return xstrdup (initial);
153 /* Like relocate_path, but specifically checks for a directory.
154 INITIAL is relocated according to the rules of relocate_path. If
155 the result is a directory, it is used; otherwise, INITIAL is used.
156 The chosen directory is then canonicalized using lrealpath. This
157 function always returns a newly-allocated string. */
160 relocate_gdb_directory (const char *initial, int flag)
164 dir = relocate_path (gdb_program_name, initial, flag);
169 if (*dir == '\0' || stat (dir, &s) != 0 || !S_ISDIR (s.st_mode))
176 dir = xstrdup (initial);
178 /* Canonicalize the directory. */
181 char *canon_sysroot = lrealpath (dir);
193 /* Compute the locations of init files that GDB should source and
194 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
195 there is no system gdbinit (resp. home gdbinit and local gdbinit)
196 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
197 LOCAL_GDBINIT) is set to NULL. */
199 get_init_files (const char **system_gdbinit,
200 const char **home_gdbinit,
201 const char **local_gdbinit)
203 static const char *sysgdbinit = NULL;
204 static char *homeinit = NULL;
205 static const char *localinit = NULL;
206 static int initialized = 0;
210 struct stat homebuf, cwdbuf, s;
213 if (SYSTEM_GDBINIT[0])
215 int datadir_len = strlen (GDB_DATADIR);
216 int sys_gdbinit_len = strlen (SYSTEM_GDBINIT);
217 char *relocated_sysgdbinit;
219 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
220 has been provided, search for SYSTEM_GDBINIT there. */
221 if (gdb_datadir_provided
222 && datadir_len < sys_gdbinit_len
223 && filename_ncmp (SYSTEM_GDBINIT, GDB_DATADIR, datadir_len) == 0
224 && IS_DIR_SEPARATOR (SYSTEM_GDBINIT[datadir_len]))
226 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
228 char *tmp_sys_gdbinit = xstrdup (&SYSTEM_GDBINIT[datadir_len]);
231 for (p = tmp_sys_gdbinit; IS_DIR_SEPARATOR (*p); ++p)
233 relocated_sysgdbinit = concat (gdb_datadir, SLASH_STRING, p,
235 xfree (tmp_sys_gdbinit);
239 relocated_sysgdbinit = relocate_path (gdb_program_name,
241 SYSTEM_GDBINIT_RELOCATABLE);
243 if (relocated_sysgdbinit && stat (relocated_sysgdbinit, &s) == 0)
244 sysgdbinit = relocated_sysgdbinit;
246 xfree (relocated_sysgdbinit);
249 homedir = getenv ("HOME");
251 /* If the .gdbinit file in the current directory is the same as
252 the $HOME/.gdbinit file, it should not be sourced. homebuf
253 and cwdbuf are used in that purpose. Make sure that the stats
254 are zero in case one of them fails (this guarantees that they
255 won't match if either exists). */
257 memset (&homebuf, 0, sizeof (struct stat));
258 memset (&cwdbuf, 0, sizeof (struct stat));
262 homeinit = xstrprintf ("%s/%s", homedir, gdbinit);
263 if (stat (homeinit, &homebuf) != 0)
270 if (stat (gdbinit, &cwdbuf) == 0)
273 || memcmp ((char *) &homebuf, (char *) &cwdbuf,
274 sizeof (struct stat)))
281 *system_gdbinit = sysgdbinit;
282 *home_gdbinit = homeinit;
283 *local_gdbinit = localinit;
286 /* Try to set up an alternate signal stack for SIGSEGV handlers.
287 This allows us to handle SIGSEGV signals generated when the
288 normal process stack is exhausted. If this stack is not set
289 up (sigaltstack is unavailable or fails) and a SIGSEGV is
290 generated when the normal stack is exhausted then the program
291 will behave as though no SIGSEGV handler was installed. */
294 setup_alternate_signal_stack (void)
296 #ifdef HAVE_SIGALTSTACK
299 /* FreeBSD versions older than 11.0 use char * for ss_sp instead of
300 void *. This cast works with both types. */
301 ss.ss_sp = (char *) xmalloc (SIGSTKSZ);
302 ss.ss_size = SIGSTKSZ;
305 sigaltstack(&ss, NULL);
309 /* Call command_loop. */
311 /* Prevent inlining this function for the benefit of GDB's selftests
312 in the testsuite. Those tests want to run GDB under GDB and stop
314 static void captured_command_loop () __attribute__((noinline));
317 captured_command_loop ()
319 struct ui *ui = current_ui;
321 /* Top-level execution commands can be run in the background from
323 current_ui->async = 1;
325 /* Give the interpreter a chance to print a prompt, if necessary */
326 if (ui->prompt_state != PROMPT_BLOCKED)
327 interp_pre_command_loop (top_level_interpreter ());
329 /* Now it's time to start the event loop. */
332 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
333 would clean things up (restoring the cleanup chain) to the state
334 they were just prior to the call. Technically, this means that
335 the do_cleanups() below is redundant. Unfortunately, many FUNCs
336 are not that well behaved. do_cleanups should either be replaced
337 with a do_cleanups call (to cover the problem) or an assertion
338 check to detect bad FUNCs code. */
339 do_cleanups (all_cleanups ());
340 /* If the command_loop returned, normally (rather than threw an
341 error) we try to quit. If the quit is aborted, our caller
342 catches the signal and restarts the command loop. */
343 quit_command (NULL, ui->instream == ui->stdin_stream);
346 /* Handle command errors thrown from within catch_command_errors. */
349 handle_command_errors (struct gdb_exception e)
353 exception_print (gdb_stderr, e);
355 /* If any exception escaped to here, we better enable stdin.
356 Otherwise, any command that calls async_disable_stdin, and
357 then throws, will leave stdin inoperable. */
358 async_enable_stdin ();
364 /* Type of the command callback passed to the const
365 catch_command_errors. */
367 typedef void (catch_command_errors_const_ftype) (const char *, int);
369 /* Wrap calls to commands run before the event loop is started. */
372 catch_command_errors (catch_command_errors_const_ftype command,
373 const char *arg, int from_tty)
377 int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
379 command (arg, from_tty);
381 maybe_wait_sync_command_done (was_sync);
383 CATCH (e, RETURN_MASK_ALL)
385 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;
481 /* gdb init files. */
482 const char *system_gdbinit;
483 const char *home_gdbinit;
484 const char *local_gdbinit;
490 #ifdef HAVE_USEFUL_SBRK
491 /* Set this before constructing scoped_command_stats. */
492 lim_at_start = (char *) sbrk (0);
495 scoped_command_stats stat_reporter (false);
497 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
498 setlocale (LC_MESSAGES, "");
500 #if defined (HAVE_SETLOCALE)
501 setlocale (LC_CTYPE, "");
504 bindtextdomain (PACKAGE, LOCALEDIR);
505 textdomain (PACKAGE);
510 saved_command_line = (char *) xstrdup ("");
513 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
514 as a Windows pipe, and Windows buffers on pipes. */
515 setvbuf (stderr, NULL, _IONBF, BUFSIZ);
518 /* Note: `error' cannot be called before this point, because the
519 caller will crash when trying to print the exception. */
520 main_ui = new ui (stdin, stdout, stderr);
521 current_ui = main_ui;
523 gdb_stdtargerr = gdb_stderr; /* for moment */
524 gdb_stdtargin = gdb_stdin; /* for moment */
526 if (bfd_init () != BFD_INIT_MAGIC)
527 error (_("fatal error: libbfd ABI mismatch"));
530 /* On Windows, argv[0] is not necessarily set to absolute form when
531 GDB is found along PATH, without which relocation doesn't work. */
532 gdb_program_name = windows_get_absolute_argv0 (argv[0]);
534 gdb_program_name = xstrdup (argv[0]);
537 /* Prefix warning messages with the command name. */
538 gdb::unique_xmalloc_ptr<char> tmp_warn_preprint
539 (xstrprintf ("%s: warning: ", gdb_program_name));
540 warning_pre_print = tmp_warn_preprint.get ();
542 current_directory = getcwd (NULL, 0);
543 if (current_directory == NULL)
544 perror_warning_with_name (_("error finding working directory"));
546 /* Set the sysroot path. */
547 gdb_sysroot = relocate_gdb_directory (TARGET_SYSTEM_ROOT,
548 TARGET_SYSTEM_ROOT_RELOCATABLE);
550 if (gdb_sysroot == NULL || *gdb_sysroot == '\0')
553 gdb_sysroot = xstrdup (TARGET_SYSROOT_PREFIX);
556 debug_file_directory = relocate_gdb_directory (DEBUGDIR,
557 DEBUGDIR_RELOCATABLE);
559 gdb_datadir = relocate_gdb_directory (GDB_DATADIR,
560 GDB_DATADIR_RELOCATABLE);
562 #ifdef WITH_PYTHON_PATH
564 /* For later use in helping Python find itself. */
565 char *tmp = concat (WITH_PYTHON_PATH, SLASH_STRING, "lib", (char *) NULL);
567 python_libdir = relocate_gdb_directory (tmp, PYTHON_PATH_RELOCATABLE);
573 add_substitute_path_rule (RELOC_SRCDIR,
574 make_relative_prefix (gdb_program_name, BINDIR,
578 /* There will always be an interpreter. Either the one passed into
579 this captured main, or one specified by the user at start up, or
580 the console. Initialize the interpreter to the one requested by
582 interpreter_p = xstrdup (context->interpreter_p);
584 /* Parse arguments and options. */
587 /* When var field is 0, use flag field to record the equivalent
588 short option (or arbitrary numbers starting at 10 for those
589 with no equivalent). */
603 static struct option long_options[] =
605 {"tui", no_argument, 0, OPT_TUI},
606 {"dbx", no_argument, &dbx_commands, 1},
607 {"readnow", no_argument, NULL, OPT_READNOW},
608 {"readnever", no_argument, NULL, OPT_READNEVER},
609 {"r", no_argument, NULL, OPT_READNOW},
610 {"quiet", no_argument, &quiet, 1},
611 {"q", no_argument, &quiet, 1},
612 {"silent", no_argument, &quiet, 1},
613 {"nh", no_argument, &inhibit_home_gdbinit, 1},
614 {"nx", no_argument, &inhibit_gdbinit, 1},
615 {"n", no_argument, &inhibit_gdbinit, 1},
616 {"batch-silent", no_argument, 0, 'B'},
617 {"batch", no_argument, &batch_flag, 1},
619 /* This is a synonym for "--annotate=1". --annotate is now
620 preferred, but keep this here for a long time because people
621 will be running emacses which use --fullname. */
622 {"fullname", no_argument, 0, 'f'},
623 {"f", no_argument, 0, 'f'},
625 {"annotate", required_argument, 0, OPT_ANNOTATE},
626 {"help", no_argument, &print_help, 1},
627 {"se", required_argument, 0, OPT_SE},
628 {"symbols", required_argument, 0, 's'},
629 {"s", required_argument, 0, 's'},
630 {"exec", required_argument, 0, 'e'},
631 {"e", required_argument, 0, 'e'},
632 {"core", required_argument, 0, 'c'},
633 {"c", required_argument, 0, 'c'},
634 {"pid", required_argument, 0, 'p'},
635 {"p", required_argument, 0, 'p'},
636 {"command", required_argument, 0, 'x'},
637 {"eval-command", required_argument, 0, 'X'},
638 {"version", no_argument, &print_version, 1},
639 {"configuration", no_argument, &print_configuration, 1},
640 {"x", required_argument, 0, 'x'},
641 {"ex", required_argument, 0, 'X'},
642 {"init-command", required_argument, 0, OPT_IX},
643 {"init-eval-command", required_argument, 0, OPT_IEX},
644 {"ix", required_argument, 0, OPT_IX},
645 {"iex", required_argument, 0, OPT_IEX},
647 {"tclcommand", required_argument, 0, 'z'},
648 {"enable-external-editor", no_argument, 0, 'y'},
649 {"editor-command", required_argument, 0, 'w'},
651 {"ui", required_argument, 0, 'i'},
652 {"interpreter", required_argument, 0, 'i'},
653 {"i", required_argument, 0, 'i'},
654 {"directory", required_argument, 0, 'd'},
655 {"d", required_argument, 0, 'd'},
656 {"data-directory", required_argument, 0, 'D'},
657 {"D", required_argument, 0, 'D'},
658 {"cd", required_argument, 0, OPT_CD},
659 {"tty", required_argument, 0, 't'},
660 {"baud", required_argument, 0, 'b'},
661 {"b", required_argument, 0, 'b'},
662 {"nw", no_argument, NULL, OPT_NOWINDOWS},
663 {"nowindows", no_argument, NULL, OPT_NOWINDOWS},
664 {"w", no_argument, NULL, OPT_WINDOWS},
665 {"windows", no_argument, NULL, OPT_WINDOWS},
666 {"statistics", no_argument, 0, OPT_STATISTICS},
667 {"write", no_argument, &write_files, 1},
668 {"args", no_argument, &set_args, 1},
669 {"l", required_argument, 0, 'l'},
670 {"return-child-result", no_argument, &return_child_result, 1},
671 {0, no_argument, 0, 0}
678 c = getopt_long_only (argc, argv, "",
679 long_options, &option_index);
680 if (c == EOF || set_args)
683 /* Long option that takes an argument. */
684 if (c == 0 && long_options[option_index].flag == 0)
685 c = long_options[option_index].val;
690 /* Long option that just sets a flag. */
700 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
701 annotation_level = atoi (optarg);
704 /* Enable the display of both time and space usage. */
705 set_per_command_time (1);
706 set_per_command_space (1);
709 /* --tui is equivalent to -i=tui. */
711 xfree (interpreter_p);
712 interpreter_p = xstrdup (INTERP_TUI);
714 error (_("%s: TUI mode is not supported"), gdb_program_name);
718 /* FIXME: cagney/2003-03-01: Not sure if this option is
719 actually useful, and if it is, what it should do. */
721 /* --windows is equivalent to -i=insight. */
722 xfree (interpreter_p);
723 interpreter_p = xstrdup (INTERP_INSIGHT);
727 /* -nw is equivalent to -i=console. */
728 xfree (interpreter_p);
729 interpreter_p = xstrdup (INTERP_CONSOLE);
732 annotation_level = 1;
747 cmdarg_vec.emplace_back (CMDARG_FILE, optarg);
750 cmdarg_vec.emplace_back (CMDARG_COMMAND, optarg);
753 cmdarg_vec.emplace_back (CMDARG_INIT_FILE, optarg);
756 cmdarg_vec.emplace_back (CMDARG_INIT_COMMAND, optarg);
759 batch_flag = batch_silent = 1;
760 gdb_stdout = new null_file ();
763 if (optarg[0] == '\0')
764 error (_("%s: empty path for `--data-directory'"),
766 set_gdb_data_directory (optarg);
767 gdb_datadir_provided = 1;
772 extern int gdbtk_test (char *);
774 if (!gdbtk_test (optarg))
775 error (_("%s: unable to load tclcommand file \"%s\""),
776 gdb_program_name, optarg);
780 /* Backwards compatibility only. */
784 /* Set the external editor commands when gdb is farming out files
785 to be edited by another program. */
786 extern char *external_editor_command;
788 external_editor_command = xstrdup (optarg);
793 xfree (interpreter_p);
794 interpreter_p = xstrdup (optarg);
797 dirarg.push_back (optarg);
810 rate = strtol (optarg, &p, 0);
811 if (rate == 0 && p == optarg)
812 warning (_("could not set baud rate to `%s'."),
823 timeout = strtol (optarg, &p, 0);
824 if (timeout == 0 && p == optarg)
825 warning (_("could not set timeout limit to `%s'."),
828 remote_timeout = timeout;
834 readnow_symbol_files = 1;
835 validate_readnow_readnever ();
841 readnever_symbol_files = 1;
842 validate_readnow_readnever ();
847 error (_("Use `%s --help' for a complete list of options."),
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 get_init_files (&system_gdbinit, &home_gdbinit, &local_gdbinit);
918 /* Do these (and anything which might call wrap_here or *_filtered)
919 after initialize_all_files() but before the interpreter has been
920 installed. Otherwize the help/version messages will be eaten by
921 the interpreter's output handler. */
925 print_gdb_version (gdb_stdout, false);
927 printf_filtered ("\n");
933 print_gdb_help (gdb_stdout);
934 fputs_unfiltered ("\n", gdb_stdout);
938 if (print_configuration)
940 print_gdb_configuration (gdb_stdout);
942 printf_filtered ("\n");
946 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
947 GDB retain the old MI1 interpreter startup behavior. Output the
948 copyright message before the interpreter is installed. That way
949 it isn't encapsulated in MI output. */
950 if (!quiet && strcmp (interpreter_p, INTERP_MI1) == 0)
952 /* Print all the junk at the top, with trailing "..." if we are
953 about to read a symbol file (possibly slowly). */
954 print_gdb_version (gdb_stdout, true);
956 printf_filtered ("..");
958 printf_filtered ("\n");
959 gdb_flush (gdb_stdout); /* Force to screen during slow
963 /* Install the default UI. All the interpreters should have had a
964 look at things by now. Initialize the default interpreter. */
965 set_top_level_interpreter (interpreter_p);
967 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
968 GDB retain the old MI1 interpreter startup behavior. Output the
969 copyright message after the interpreter is installed when it is
970 any sane interpreter. */
971 if (!quiet && !current_interp_named_p (INTERP_MI1))
973 /* Print all the junk at the top, with trailing "..." if we are
974 about to read a symbol file (possibly slowly). */
975 print_gdb_version (gdb_stdout, true);
977 printf_filtered ("..");
979 printf_filtered ("\n");
980 gdb_flush (gdb_stdout); /* Force to screen during slow
984 /* Set off error and warning messages with a blank line. */
985 tmp_warn_preprint.reset ();
986 warning_pre_print = _("\nwarning: ");
988 /* Read and execute the system-wide gdbinit file, if it exists.
989 This is done *before* all the command line arguments are
990 processed; it sets global parameters, which are independent of
991 what file you are debugging or what directory you are in. */
992 if (system_gdbinit && !inhibit_gdbinit)
993 ret = catch_command_errors (source_script, system_gdbinit, 0);
995 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
996 *before* all the command line arguments are processed; it sets
997 global parameters, which are independent of what file you are
998 debugging or what directory you are in. */
1000 if (home_gdbinit && !inhibit_gdbinit && !inhibit_home_gdbinit)
1001 ret = catch_command_errors (source_script, home_gdbinit, 0);
1003 /* Process '-ix' and '-iex' options early. */
1004 for (i = 0; i < cmdarg_vec.size (); i++)
1006 const struct cmdarg &cmdarg_p = cmdarg_vec[i];
1008 switch (cmdarg_p.type)
1010 case CMDARG_INIT_FILE:
1011 ret = catch_command_errors (source_script, cmdarg_p.string,
1014 case CMDARG_INIT_COMMAND:
1015 ret = catch_command_errors (execute_command, cmdarg_p.string,
1021 /* Now perform all the actions indicated by the arguments. */
1024 ret = catch_command_errors (cd_command, cdarg, 0);
1027 for (i = 0; i < dirarg.size (); i++)
1028 ret = catch_command_errors (directory_switch, dirarg[i], 0);
1030 /* Skip auto-loading section-specified scripts until we've sourced
1031 local_gdbinit (which is often used to augment the source search
1033 save_auto_load = global_auto_load;
1034 global_auto_load = 0;
1038 && strcmp (execarg, symarg) == 0)
1040 /* The exec file and the symbol-file are the same. If we can't
1041 open it, better only print one error message.
1042 catch_command_errors returns non-zero on success! */
1043 ret = catch_command_errors (exec_file_attach, execarg,
1046 ret = catch_command_errors (symbol_file_add_main_adapter,
1047 symarg, !batch_flag);
1051 if (execarg != NULL)
1052 ret = catch_command_errors (exec_file_attach, execarg,
1055 ret = catch_command_errors (symbol_file_add_main_adapter,
1056 symarg, !batch_flag);
1059 if (corearg && pidarg)
1060 error (_("Can't attach to process and specify "
1061 "a core file at the same time."));
1063 if (corearg != NULL)
1065 ret = catch_command_errors (core_file_command, corearg,
1068 else if (pidarg != NULL)
1070 ret = catch_command_errors (attach_command, pidarg, !batch_flag);
1072 else if (pid_or_core_arg)
1074 /* The user specified 'gdb program pid' or gdb program core'.
1075 If pid_or_core_arg's first character is a digit, try attach
1076 first and then corefile. Otherwise try just corefile. */
1078 if (isdigit (pid_or_core_arg[0]))
1080 ret = catch_command_errors (attach_command, pid_or_core_arg,
1083 ret = catch_command_errors (core_file_command,
1089 /* Can't be a pid, better be a corefile. */
1090 ret = catch_command_errors (core_file_command,
1097 set_inferior_io_terminal (ttyarg);
1099 /* Error messages should no longer be distinguished with extra output. */
1100 warning_pre_print = _("warning: ");
1102 /* Read the .gdbinit file in the current directory, *if* it isn't
1103 the same as the $HOME/.gdbinit file (it should exist, also). */
1106 auto_load_local_gdbinit_pathname
1107 = gdb_realpath (local_gdbinit).release ();
1109 if (!inhibit_gdbinit && auto_load_local_gdbinit
1110 && file_is_auto_load_safe (local_gdbinit,
1111 _("auto-load: Loading .gdbinit "
1115 auto_load_local_gdbinit_loaded = 1;
1117 ret = catch_command_errors (source_script, local_gdbinit, 0);
1121 /* Now that all .gdbinit's have been read and all -d options have been
1122 processed, we can read any scripts mentioned in SYMARG.
1123 We wait until now because it is common to add to the source search
1124 path in local_gdbinit. */
1125 global_auto_load = save_auto_load;
1126 for (objfile *objfile : current_program_space->objfiles ())
1127 load_auto_scripts_for_objfile (objfile);
1129 /* Process '-x' and '-ex' options. */
1130 for (i = 0; i < cmdarg_vec.size (); i++)
1132 const struct cmdarg &cmdarg_p = cmdarg_vec[i];
1134 switch (cmdarg_p.type)
1137 ret = catch_command_errors (source_script, cmdarg_p.string,
1140 case CMDARG_COMMAND:
1141 ret = catch_command_errors (execute_command, cmdarg_p.string,
1147 /* Read in the old history after all the command files have been
1153 int error_status = EXIT_FAILURE;
1154 int *exit_arg = ret == 0 ? &error_status : NULL;
1156 /* We have hit the end of the batch file. */
1157 quit_force (exit_arg, 0);
1162 captured_main (void *data)
1164 struct captured_main_args *context = (struct captured_main_args *) data;
1166 captured_main_1 (context);
1168 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1169 moving this loop and the code found in captured_command_loop()
1170 into the command_loop() proper. The main thing holding back that
1171 change - SET_TOP_LEVEL() - has been eliminated. */
1176 captured_command_loop ();
1178 CATCH (ex, RETURN_MASK_ALL)
1180 exception_print (gdb_stderr, ex);
1184 /* No exit -- exit is through quit_command. */
1188 gdb_main (struct captured_main_args *args)
1192 captured_main (args);
1194 CATCH (ex, RETURN_MASK_ALL)
1196 exception_print (gdb_stderr, ex);
1200 /* The only way to end up here is by an error (normal exit is
1201 handled by quit_force()), hence always return an error status. */
1206 /* Don't use *_filtered for printing help. We don't want to prompt
1207 for continue no matter how small the screen or how much we're going
1211 print_gdb_help (struct ui_file *stream)
1213 const char *system_gdbinit;
1214 const char *home_gdbinit;
1215 const char *local_gdbinit;
1217 get_init_files (&system_gdbinit, &home_gdbinit, &local_gdbinit);
1219 /* Note: The options in the list below are only approximately sorted
1220 in the alphabetical order, so as to group closely related options
1222 fputs_unfiltered (_("\
1223 This is the GNU debugger. Usage:\n\n\
1224 gdb [options] [executable-file [core-file or process-id]]\n\
1225 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1227 fputs_unfiltered (_("\
1228 Selection of debuggee and its files:\n\n\
1229 --args Arguments after executable-file are passed to inferior\n\
1230 --core=COREFILE Analyze the core dump COREFILE.\n\
1231 --exec=EXECFILE Use EXECFILE as the executable.\n\
1232 --pid=PID Attach to running process PID.\n\
1233 --directory=DIR Search for source files in DIR.\n\
1234 --se=FILE Use FILE as symbol file and executable file.\n\
1235 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1236 --readnow Fully read symbol files on first access.\n\
1237 --readnever Do not read symbol files.\n\
1238 --write Set writing into executable and core files.\n\n\
1240 fputs_unfiltered (_("\
1241 Initial commands and command files:\n\n\
1242 --command=FILE, -x Execute GDB commands from FILE.\n\
1243 --init-command=FILE, -ix\n\
1244 Like -x but execute commands before loading inferior.\n\
1245 --eval-command=COMMAND, -ex\n\
1246 Execute a single GDB command.\n\
1247 May be used multiple times and in conjunction\n\
1249 --init-eval-command=COMMAND, -iex\n\
1250 Like -ex but before loading inferior.\n\
1251 --nh Do not read ~/.gdbinit.\n\
1252 --nx Do not read any .gdbinit files in any directory.\n\n\
1254 fputs_unfiltered (_("\
1255 Output and user interface control:\n\n\
1256 --fullname Output information used by emacs-GDB interface.\n\
1257 --interpreter=INTERP\n\
1258 Select a specific interpreter / user interface\n\
1259 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1260 -w Use the GUI interface.\n\
1261 --nw Do not use the GUI interface.\n\
1264 fputs_unfiltered (_("\
1265 --tui Use a terminal user interface.\n\
1268 fputs_unfiltered (_("\
1269 --dbx DBX compatibility mode.\n\
1270 -q, --quiet, --silent\n\
1271 Do not print version number on startup.\n\n\
1273 fputs_unfiltered (_("\
1274 Operating modes:\n\n\
1275 --batch Exit after processing options.\n\
1276 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1277 --return-child-result\n\
1278 GDB exit code will be the child's exit code.\n\
1279 --configuration Print details about GDB configuration and then exit.\n\
1280 --help Print this message and then exit.\n\
1281 --version Print version information and then exit.\n\n\
1282 Remote debugging options:\n\n\
1283 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1284 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1286 --cd=DIR Change current directory to DIR.\n\
1287 --data-directory=DIR, -D\n\
1288 Set GDB's data-directory to DIR.\n\
1290 fputs_unfiltered (_("\n\
1291 At startup, GDB reads the following init files and executes their commands:\n\
1294 fprintf_unfiltered (stream, _("\
1295 * system-wide init file: %s\n\
1296 "), system_gdbinit);
1298 fprintf_unfiltered (stream, _("\
1299 * user-specific init file: %s\n\
1302 fprintf_unfiltered (stream, _("\
1303 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1305 fputs_unfiltered (_("\n\
1306 For more information, type \"help\" from within GDB, or consult the\n\
1307 GDB manual (available as on-line info or a printed manual).\n\
1309 if (REPORT_BUGS_TO[0] && stream == gdb_stdout)
1310 fprintf_unfiltered (stream, _("\
1311 Report bugs to \"%s\".\n\
1312 "), REPORT_BUGS_TO);