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 /* The selected interpreter. This will be used as a set command
53 variable, so it should always be malloc'ed - since
54 do_setshow_command will free it. */
57 /* Whether dbx commands will be handled. */
60 /* System root path, used to find libraries etc. */
61 char *gdb_sysroot
= 0;
63 /* GDB datadir, used to store data files. */
64 std::string gdb_datadir
;
66 /* Non-zero if GDB_DATADIR was provided on the command line.
67 This doesn't track whether data-directory is set later from the
68 command line, but we don't reread system.gdbinit when that happens. */
69 static int gdb_datadir_provided
= 0;
71 /* If gdb was configured with --with-python=/path,
72 the possibly relocated path to python's lib directory. */
73 std::string python_libdir
;
75 /* Target IO streams. */
76 struct ui_file
*gdb_stdtargin
;
77 struct ui_file
*gdb_stdtarg
;
78 struct ui_file
*gdb_stdtargerr
;
80 /* True if --batch or --batch-silent was seen. */
83 /* Support for the --batch-silent option. */
86 /* Support for --return-child-result option.
87 Set the default to -1 to return error in the case
88 that the program does not run or does not complete. */
89 int return_child_result
= 0;
90 int return_child_result_value
= -1;
93 /* GDB as it has been invoked from the command line (i.e. argv[0]). */
94 static char *gdb_program_name
;
96 /* Return read only pointer to GDB_PROGRAM_NAME. */
98 get_gdb_program_name (void)
100 return gdb_program_name
;
103 static void print_gdb_help (struct ui_file
*);
105 /* Set the data-directory parameter to NEW_DATADIR.
106 If NEW_DATADIR is not a directory then a warning is printed.
107 We don't signal an error for backward compatibility. */
110 set_gdb_data_directory (const char *new_datadir
)
114 if (stat (new_datadir
, &st
) < 0)
116 int save_errno
= errno
;
118 fprintf_unfiltered (gdb_stderr
, "Warning: ");
119 print_sys_errmsg (new_datadir
, save_errno
);
121 else if (!S_ISDIR (st
.st_mode
))
122 warning (_("%s is not a directory."), new_datadir
);
124 gdb_datadir
= gdb_realpath (new_datadir
).get ();
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
.c_str ()))
132 gdb::unique_xmalloc_ptr
<char> abs_datadir
133 = gdb_abspath (gdb_datadir
.c_str ());
135 gdb_datadir
= abs_datadir
.get ();
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. RELOCATABLE is true if the value is relocatable,
142 false otherwise. This may return an empty string under the same
143 conditions as make_relative_prefix returning NULL. */
146 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
150 gdb::unique_xmalloc_ptr
<char> str (make_relative_prefix (progname
,
155 return std::string ();
160 /* Like relocate_path, but specifically checks for a directory.
161 INITIAL is relocated according to the rules of relocate_path. If
162 the result is a directory, it is used; otherwise, INITIAL is used.
163 The chosen directory is then canonicalized using lrealpath. */
166 relocate_gdb_directory (const char *initial
, bool relocatable
)
168 std::string dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
173 if (stat (dir
.c_str (), &s
) != 0 || !S_ISDIR (s
.st_mode
))
181 /* Canonicalize the directory. */
184 gdb::unique_xmalloc_ptr
<char> canon_sysroot (lrealpath (dir
.c_str ()));
187 dir
= canon_sysroot
.get ();
193 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
194 parameter if it is in the data dir, or passes it through relocate_path
198 relocate_gdbinit_path_maybe_in_datadir (const std::string
& file
)
200 size_t datadir_len
= strlen (GDB_DATADIR
);
202 std::string relocated_path
;
204 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
205 has been provided, search for SYSTEM_GDBINIT there. */
206 if (gdb_datadir_provided
207 && datadir_len
< file
.length ()
208 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
209 && IS_DIR_SEPARATOR (file
[datadir_len
]))
211 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
214 size_t start
= datadir_len
;
215 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
217 relocated_path
= (std::string (gdb_datadir
) + SLASH_STRING
218 + file
.substr (start
));
222 relocated_path
= relocate_path (gdb_program_name
,
224 SYSTEM_GDBINIT_RELOCATABLE
);
226 return relocated_path
;
229 /* Compute the locations of init files that GDB should source and
230 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
231 there is no system gdbinit (resp. home gdbinit and local gdbinit)
232 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
233 LOCAL_GDBINIT) is set to the empty string. */
235 get_init_files (std::string
*system_gdbinit
,
236 std::string
*home_gdbinit
,
237 std::string
*local_gdbinit
)
239 static std::string sysgdbinit
;
240 static std::string homeinit
;
241 static std::string localinit
;
242 static int initialized
= 0;
246 struct stat homebuf
, cwdbuf
, s
;
248 if (SYSTEM_GDBINIT
[0])
250 std::string relocated_sysgdbinit
251 = relocate_gdbinit_path_maybe_in_datadir (SYSTEM_GDBINIT
);
252 if (!relocated_sysgdbinit
.empty ()
253 && stat (relocated_sysgdbinit
.c_str (), &s
) == 0)
254 sysgdbinit
= relocated_sysgdbinit
;
257 const char *homedir
= getenv ("HOME");
259 /* If the .gdbinit file in the current directory is the same as
260 the $HOME/.gdbinit file, it should not be sourced. homebuf
261 and cwdbuf are used in that purpose. Make sure that the stats
262 are zero in case one of them fails (this guarantees that they
263 won't match if either exists). */
265 memset (&homebuf
, 0, sizeof (struct stat
));
266 memset (&cwdbuf
, 0, sizeof (struct stat
));
270 homeinit
= std::string (homedir
) + SLASH_STRING
+ GDBINIT
;
271 if (stat (homeinit
.c_str (), &homebuf
) != 0)
277 if (stat (GDBINIT
, &cwdbuf
) == 0)
279 if (homeinit
.empty ()
280 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
281 sizeof (struct stat
)))
288 *system_gdbinit
= sysgdbinit
;
289 *home_gdbinit
= homeinit
;
290 *local_gdbinit
= localinit
;
293 /* Try to set up an alternate signal stack for SIGSEGV handlers.
294 This allows us to handle SIGSEGV signals generated when the
295 normal process stack is exhausted. If this stack is not set
296 up (sigaltstack is unavailable or fails) and a SIGSEGV is
297 generated when the normal stack is exhausted then the program
298 will behave as though no SIGSEGV handler was installed. */
301 setup_alternate_signal_stack (void)
303 #ifdef HAVE_SIGALTSTACK
306 /* FreeBSD versions older than 11.0 use char * for ss_sp instead of
307 void *. This cast works with both types. */
308 ss
.ss_sp
= (char *) xmalloc (SIGSTKSZ
);
309 ss
.ss_size
= SIGSTKSZ
;
312 sigaltstack(&ss
, NULL
);
316 /* Call command_loop. */
318 /* Prevent inlining this function for the benefit of GDB's selftests
319 in the testsuite. Those tests want to run GDB under GDB and stop
321 static void captured_command_loop () __attribute__((noinline
));
324 captured_command_loop ()
326 struct ui
*ui
= current_ui
;
328 /* Top-level execution commands can be run in the background from
330 current_ui
->async
= 1;
332 /* Give the interpreter a chance to print a prompt, if necessary */
333 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
334 interp_pre_command_loop (top_level_interpreter ());
336 /* Now it's time to start the event loop. */
339 /* If the command_loop returned, normally (rather than threw an
340 error) we try to quit. If the quit is aborted, our caller
341 catches the signal and restarts the command loop. */
342 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
345 /* Handle command errors thrown from within catch_command_errors. */
348 handle_command_errors (const struct gdb_exception
&e
)
352 exception_print (gdb_stderr
, e
);
354 /* If any exception escaped to here, we better enable stdin.
355 Otherwise, any command that calls async_disable_stdin, and
356 then throws, will leave stdin inoperable. */
357 async_enable_stdin ();
363 /* Type of the command callback passed to the const
364 catch_command_errors. */
366 typedef void (catch_command_errors_const_ftype
) (const char *, int);
368 /* Wrap calls to commands run before the event loop is started. */
371 catch_command_errors (catch_command_errors_const_ftype command
,
372 const char *arg
, int from_tty
)
376 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
378 command (arg
, from_tty
);
380 maybe_wait_sync_command_done (was_sync
);
382 catch (const gdb_exception
&e
)
384 return handle_command_errors (e
);
390 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
391 symfile_add_flags. */
394 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
396 symfile_add_flags add_flags
= 0;
399 add_flags
|= SYMFILE_VERBOSE
;
401 symbol_file_add_main (arg
, add_flags
);
404 /* Perform validation of the '--readnow' and '--readnever' flags. */
407 validate_readnow_readnever ()
409 if (readnever_symbol_files
&& readnow_symbol_files
)
411 error (_("%s: '--readnow' and '--readnever' cannot be "
412 "specified simultaneously"),
417 /* Type of this option. */
420 /* Option type -x. */
423 /* Option type -ex. */
426 /* Option type -ix. */
429 /* Option type -iex. */
433 /* Arguments of --command option and its counterpart. */
436 cmdarg (cmdarg_kind type_
, char *string_
)
437 : type (type_
), string (string_
)
440 /* Type of this option. */
441 enum cmdarg_kind type
;
443 /* Value of this option - filename or the GDB command itself. String memory
444 is not owned by this structure despite it is 'const'. */
449 captured_main_1 (struct captured_main_args
*context
)
451 int argc
= context
->argc
;
452 char **argv
= context
->argv
;
454 static int quiet
= 0;
455 static int set_args
= 0;
456 static int inhibit_home_gdbinit
= 0;
458 /* Pointers to various arguments from command line. */
460 char *execarg
= NULL
;
462 char *corearg
= NULL
;
463 char *pid_or_core_arg
= NULL
;
467 /* These are static so that we can take their address in an
469 static int print_help
;
470 static int print_version
;
471 static int print_configuration
;
473 /* Pointers to all arguments of --command option. */
474 std::vector
<struct cmdarg
> cmdarg_vec
;
476 /* All arguments of --directory option. */
477 std::vector
<char *> dirarg
;
483 #ifdef HAVE_USEFUL_SBRK
484 /* Set this before constructing scoped_command_stats. */
485 lim_at_start
= (char *) sbrk (0);
488 scoped_command_stats
stat_reporter (false);
490 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
491 setlocale (LC_MESSAGES
, "");
493 #if defined (HAVE_SETLOCALE)
494 setlocale (LC_CTYPE
, "");
497 bindtextdomain (PACKAGE
, LOCALEDIR
);
498 textdomain (PACKAGE
);
504 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
505 as a Windows pipe, and Windows buffers on pipes. */
506 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
509 /* Note: `error' cannot be called before this point, because the
510 caller will crash when trying to print the exception. */
511 main_ui
= new ui (stdin
, stdout
, stderr
);
512 current_ui
= main_ui
;
514 gdb_stdtargerr
= gdb_stderr
; /* for moment */
515 gdb_stdtargin
= gdb_stdin
; /* for moment */
517 if (bfd_init () != BFD_INIT_MAGIC
)
518 error (_("fatal error: libbfd ABI mismatch"));
521 /* On Windows, argv[0] is not necessarily set to absolute form when
522 GDB is found along PATH, without which relocation doesn't work. */
523 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
525 gdb_program_name
= xstrdup (argv
[0]);
528 /* Prefix warning messages with the command name. */
529 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
530 (xstrprintf ("%s: warning: ", gdb_program_name
));
531 warning_pre_print
= tmp_warn_preprint
.get ();
533 current_directory
= getcwd (NULL
, 0);
534 if (current_directory
== NULL
)
535 perror_warning_with_name (_("error finding working directory"));
537 /* Set the sysroot path. */
539 = xstrdup (relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
540 TARGET_SYSTEM_ROOT_RELOCATABLE
).c_str ());
542 if (*gdb_sysroot
== '\0')
545 gdb_sysroot
= xstrdup (TARGET_SYSROOT_PREFIX
);
549 = xstrdup (relocate_gdb_directory (DEBUGDIR
,
550 DEBUGDIR_RELOCATABLE
).c_str ());
553 = xstrdup (relocate_gdb_directory (GDB_DATADIR
,
554 GDB_DATADIR_RELOCATABLE
).c_str ());
556 #ifdef WITH_PYTHON_PATH
558 /* For later use in helping Python find itself. */
559 char *tmp
= concat (WITH_PYTHON_PATH
, SLASH_STRING
, "lib", (char *) NULL
);
561 python_libdir
= relocate_gdb_directory (tmp
, PYTHON_PATH_RELOCATABLE
);
567 add_substitute_path_rule (RELOC_SRCDIR
,
568 make_relative_prefix (gdb_program_name
, BINDIR
,
572 /* There will always be an interpreter. Either the one passed into
573 this captured main, or one specified by the user at start up, or
574 the console. Initialize the interpreter to the one requested by
576 interpreter_p
= xstrdup (context
->interpreter_p
);
578 /* Parse arguments and options. */
581 /* When var field is 0, use flag field to record the equivalent
582 short option (or arbitrary numbers starting at 10 for those
583 with no equivalent). */
597 static struct option long_options
[] =
599 {"tui", no_argument
, 0, OPT_TUI
},
600 {"dbx", no_argument
, &dbx_commands
, 1},
601 {"readnow", no_argument
, NULL
, OPT_READNOW
},
602 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
603 {"r", no_argument
, NULL
, OPT_READNOW
},
604 {"quiet", no_argument
, &quiet
, 1},
605 {"q", no_argument
, &quiet
, 1},
606 {"silent", no_argument
, &quiet
, 1},
607 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
608 {"nx", no_argument
, &inhibit_gdbinit
, 1},
609 {"n", no_argument
, &inhibit_gdbinit
, 1},
610 {"batch-silent", no_argument
, 0, 'B'},
611 {"batch", no_argument
, &batch_flag
, 1},
613 /* This is a synonym for "--annotate=1". --annotate is now
614 preferred, but keep this here for a long time because people
615 will be running emacses which use --fullname. */
616 {"fullname", no_argument
, 0, 'f'},
617 {"f", no_argument
, 0, 'f'},
619 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
620 {"help", no_argument
, &print_help
, 1},
621 {"se", required_argument
, 0, OPT_SE
},
622 {"symbols", required_argument
, 0, 's'},
623 {"s", required_argument
, 0, 's'},
624 {"exec", required_argument
, 0, 'e'},
625 {"e", required_argument
, 0, 'e'},
626 {"core", required_argument
, 0, 'c'},
627 {"c", required_argument
, 0, 'c'},
628 {"pid", required_argument
, 0, 'p'},
629 {"p", required_argument
, 0, 'p'},
630 {"command", required_argument
, 0, 'x'},
631 {"eval-command", required_argument
, 0, 'X'},
632 {"version", no_argument
, &print_version
, 1},
633 {"configuration", no_argument
, &print_configuration
, 1},
634 {"x", required_argument
, 0, 'x'},
635 {"ex", required_argument
, 0, 'X'},
636 {"init-command", required_argument
, 0, OPT_IX
},
637 {"init-eval-command", required_argument
, 0, OPT_IEX
},
638 {"ix", required_argument
, 0, OPT_IX
},
639 {"iex", required_argument
, 0, OPT_IEX
},
641 {"tclcommand", required_argument
, 0, 'z'},
642 {"enable-external-editor", no_argument
, 0, 'y'},
643 {"editor-command", required_argument
, 0, 'w'},
645 {"ui", required_argument
, 0, 'i'},
646 {"interpreter", required_argument
, 0, 'i'},
647 {"i", required_argument
, 0, 'i'},
648 {"directory", required_argument
, 0, 'd'},
649 {"d", required_argument
, 0, 'd'},
650 {"data-directory", required_argument
, 0, 'D'},
651 {"D", required_argument
, 0, 'D'},
652 {"cd", required_argument
, 0, OPT_CD
},
653 {"tty", required_argument
, 0, 't'},
654 {"baud", required_argument
, 0, 'b'},
655 {"b", required_argument
, 0, 'b'},
656 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
657 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
658 {"w", no_argument
, NULL
, OPT_WINDOWS
},
659 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
660 {"statistics", no_argument
, 0, OPT_STATISTICS
},
661 {"write", no_argument
, &write_files
, 1},
662 {"args", no_argument
, &set_args
, 1},
663 {"l", required_argument
, 0, 'l'},
664 {"return-child-result", no_argument
, &return_child_result
, 1},
665 {0, no_argument
, 0, 0}
672 c
= getopt_long_only (argc
, argv
, "",
673 long_options
, &option_index
);
674 if (c
== EOF
|| set_args
)
677 /* Long option that takes an argument. */
678 if (c
== 0 && long_options
[option_index
].flag
== 0)
679 c
= long_options
[option_index
].val
;
684 /* Long option that just sets a flag. */
694 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
695 annotation_level
= atoi (optarg
);
698 /* Enable the display of both time and space usage. */
699 set_per_command_time (1);
700 set_per_command_space (1);
703 /* --tui is equivalent to -i=tui. */
705 xfree (interpreter_p
);
706 interpreter_p
= xstrdup (INTERP_TUI
);
708 error (_("%s: TUI mode is not supported"), gdb_program_name
);
712 /* FIXME: cagney/2003-03-01: Not sure if this option is
713 actually useful, and if it is, what it should do. */
715 /* --windows is equivalent to -i=insight. */
716 xfree (interpreter_p
);
717 interpreter_p
= xstrdup (INTERP_INSIGHT
);
721 /* -nw is equivalent to -i=console. */
722 xfree (interpreter_p
);
723 interpreter_p
= xstrdup (INTERP_CONSOLE
);
726 annotation_level
= 1;
741 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
744 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
747 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
750 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
753 batch_flag
= batch_silent
= 1;
754 gdb_stdout
= new null_file ();
757 if (optarg
[0] == '\0')
758 error (_("%s: empty path for `--data-directory'"),
760 set_gdb_data_directory (optarg
);
761 gdb_datadir_provided
= 1;
766 extern int gdbtk_test (char *);
768 if (!gdbtk_test (optarg
))
769 error (_("%s: unable to load tclcommand file \"%s\""),
770 gdb_program_name
, optarg
);
774 /* Backwards compatibility only. */
778 /* Set the external editor commands when gdb is farming out files
779 to be edited by another program. */
780 extern char *external_editor_command
;
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."),
850 /* Disable all output styling when running in batch mode. */
855 save_original_signals_state (quiet
);
857 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
858 setup_alternate_signal_stack ();
860 /* Initialize all files. */
861 gdb_init (gdb_program_name
);
863 /* Now that gdb_init has created the initial inferior, we're in
864 position to set args for that inferior. */
867 /* The remaining options are the command-line options for the
868 inferior. The first one is the sym/exec file, and the rest
871 error (_("%s: `--args' specified but no program specified"),
874 symarg
= argv
[optind
];
875 execarg
= argv
[optind
];
877 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
881 /* OK, that's all the options. */
883 /* The first argument, if specified, is the name of the
887 symarg
= argv
[optind
];
888 execarg
= argv
[optind
];
892 /* If the user hasn't already specified a PID or the name of a
893 core file, then a second optional argument is allowed. If
894 present, this argument should be interpreted as either a
895 PID or a core file, whichever works. */
896 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
898 pid_or_core_arg
= argv
[optind
];
902 /* Any argument left on the command line is unexpected and
903 will be ignored. Inform the user. */
905 fprintf_unfiltered (gdb_stderr
,
906 _("Excess command line "
907 "arguments ignored. (%s%s)\n"),
909 (optind
== argc
- 1) ? "" : " ...");
912 /* Lookup gdbinit files. Note that the gdbinit file name may be
913 overriden during file initialization, so get_init_files should be
914 called after gdb_init. */
915 std::string system_gdbinit
;
916 std::string home_gdbinit
;
917 std::string local_gdbinit
;
918 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
920 /* Do these (and anything which might call wrap_here or *_filtered)
921 after initialize_all_files() but before the interpreter has been
922 installed. Otherwize the help/version messages will be eaten by
923 the interpreter's output handler. */
927 print_gdb_version (gdb_stdout
, false);
929 printf_filtered ("\n");
935 print_gdb_help (gdb_stdout
);
936 fputs_unfiltered ("\n", gdb_stdout
);
940 if (print_configuration
)
942 print_gdb_configuration (gdb_stdout
);
944 printf_filtered ("\n");
948 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
949 GDB retain the old MI1 interpreter startup behavior. Output the
950 copyright message before the interpreter is installed. That way
951 it isn't encapsulated in MI output. */
952 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
954 /* Print all the junk at the top, with trailing "..." if we are
955 about to read a symbol file (possibly slowly). */
956 print_gdb_version (gdb_stdout
, true);
958 printf_filtered ("..");
960 printf_filtered ("\n");
961 gdb_flush (gdb_stdout
); /* Force to screen during slow
965 /* Install the default UI. All the interpreters should have had a
966 look at things by now. Initialize the default interpreter. */
967 set_top_level_interpreter (interpreter_p
);
969 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
970 GDB retain the old MI1 interpreter startup behavior. Output the
971 copyright message after the interpreter is installed when it is
972 any sane interpreter. */
973 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
975 /* Print all the junk at the top, with trailing "..." if we are
976 about to read a symbol file (possibly slowly). */
977 print_gdb_version (gdb_stdout
, true);
979 printf_filtered ("..");
981 printf_filtered ("\n");
982 gdb_flush (gdb_stdout
); /* Force to screen during slow
986 /* Set off error and warning messages with a blank line. */
987 tmp_warn_preprint
.reset ();
988 warning_pre_print
= _("\nwarning: ");
990 /* Read and execute the system-wide gdbinit file, if it exists.
991 This is done *before* all the command line arguments are
992 processed; it sets global parameters, which are independent of
993 what file you are debugging or what directory you are in. */
994 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
995 ret
= catch_command_errors (source_script
, system_gdbinit
.c_str (), 0);
997 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
998 *before* all the command line arguments are processed; it sets
999 global parameters, which are independent of what file you are
1000 debugging or what directory you are in. */
1002 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1003 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1005 /* Process '-ix' and '-iex' options early. */
1006 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1008 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1010 switch (cmdarg_p
.type
)
1012 case CMDARG_INIT_FILE
:
1013 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1016 case CMDARG_INIT_COMMAND
:
1017 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1023 /* Now perform all the actions indicated by the arguments. */
1026 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1029 for (i
= 0; i
< dirarg
.size (); i
++)
1030 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1032 /* Skip auto-loading section-specified scripts until we've sourced
1033 local_gdbinit (which is often used to augment the source search
1035 save_auto_load
= global_auto_load
;
1036 global_auto_load
= 0;
1040 && strcmp (execarg
, symarg
) == 0)
1042 /* The exec file and the symbol-file are the same. If we can't
1043 open it, better only print one error message.
1044 catch_command_errors returns non-zero on success! */
1045 ret
= catch_command_errors (exec_file_attach
, execarg
,
1048 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1049 symarg
, !batch_flag
);
1053 if (execarg
!= NULL
)
1054 ret
= catch_command_errors (exec_file_attach
, execarg
,
1057 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1058 symarg
, !batch_flag
);
1061 if (corearg
&& pidarg
)
1062 error (_("Can't attach to process and specify "
1063 "a core file at the same time."));
1065 if (corearg
!= NULL
)
1067 ret
= catch_command_errors (core_file_command
, corearg
,
1070 else if (pidarg
!= NULL
)
1072 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1074 else if (pid_or_core_arg
)
1076 /* The user specified 'gdb program pid' or gdb program core'.
1077 If pid_or_core_arg's first character is a digit, try attach
1078 first and then corefile. Otherwise try just corefile. */
1080 if (isdigit (pid_or_core_arg
[0]))
1082 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1085 ret
= catch_command_errors (core_file_command
,
1091 /* Can't be a pid, better be a corefile. */
1092 ret
= catch_command_errors (core_file_command
,
1099 set_inferior_io_terminal (ttyarg
);
1101 /* Error messages should no longer be distinguished with extra output. */
1102 warning_pre_print
= _("warning: ");
1104 /* Read the .gdbinit file in the current directory, *if* it isn't
1105 the same as the $HOME/.gdbinit file (it should exist, also). */
1106 if (!local_gdbinit
.empty ())
1108 auto_load_local_gdbinit_pathname
1109 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1111 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
1112 && file_is_auto_load_safe (local_gdbinit
.c_str (),
1113 _("auto-load: Loading .gdbinit "
1115 local_gdbinit
.c_str ()))
1117 auto_load_local_gdbinit_loaded
= 1;
1119 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1123 /* Now that all .gdbinit's have been read and all -d options have been
1124 processed, we can read any scripts mentioned in SYMARG.
1125 We wait until now because it is common to add to the source search
1126 path in local_gdbinit. */
1127 global_auto_load
= save_auto_load
;
1128 for (objfile
*objfile
: current_program_space
->objfiles ())
1129 load_auto_scripts_for_objfile (objfile
);
1131 /* Process '-x' and '-ex' options. */
1132 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1134 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1136 switch (cmdarg_p
.type
)
1139 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1142 case CMDARG_COMMAND
:
1143 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1149 /* Read in the old history after all the command files have been
1155 int error_status
= EXIT_FAILURE
;
1156 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1158 /* We have hit the end of the batch file. */
1159 quit_force (exit_arg
, 0);
1164 captured_main (void *data
)
1166 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1168 captured_main_1 (context
);
1170 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1171 moving this loop and the code found in captured_command_loop()
1172 into the command_loop() proper. The main thing holding back that
1173 change - SET_TOP_LEVEL() - has been eliminated. */
1178 captured_command_loop ();
1180 catch (const gdb_exception
&ex
)
1182 exception_print (gdb_stderr
, ex
);
1185 /* No exit -- exit is through quit_command. */
1189 gdb_main (struct captured_main_args
*args
)
1193 captured_main (args
);
1195 catch (const gdb_exception
&ex
)
1197 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 std::string system_gdbinit
;
1214 std::string home_gdbinit
;
1215 std::string 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\
1293 if (!system_gdbinit
.empty ())
1294 fprintf_unfiltered (stream
, _("\
1295 * system-wide init file: %s\n\
1296 "), system_gdbinit
.c_str ());
1297 if (!home_gdbinit
.empty ())
1298 fprintf_unfiltered (stream
, _("\
1299 * user-specific init file: %s\n\
1300 "), home_gdbinit
.c_str ());
1301 if (!local_gdbinit
.empty ())
1302 fprintf_unfiltered (stream
, _("\
1303 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1304 "), local_gdbinit
.c_str ());
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
);