1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2020 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"
50 #include "gdbsupport/pathstuff.h"
51 #include "cli/cli-style.h"
53 #include "gdbtk/generic/gdbtk.h"
55 #include "gdbsupport/alt-stack.h"
57 /* The selected interpreter. This will be used as a set command
58 variable, so it should always be malloc'ed - since
59 do_setshow_command will free it. */
62 /* Whether dbx commands will be handled. */
65 /* System root path, used to find libraries etc. */
66 char *gdb_sysroot
= 0;
68 /* GDB datadir, used to store data files. */
69 std::string gdb_datadir
;
71 /* Non-zero if GDB_DATADIR was provided on the command line.
72 This doesn't track whether data-directory is set later from the
73 command line, but we don't reread system.gdbinit when that happens. */
74 static int gdb_datadir_provided
= 0;
76 /* If gdb was configured with --with-python=/path,
77 the possibly relocated path to python's lib directory. */
78 std::string python_libdir
;
80 /* Target IO streams. */
81 struct ui_file
*gdb_stdtargin
;
82 struct ui_file
*gdb_stdtarg
;
83 struct ui_file
*gdb_stdtargerr
;
85 /* True if --batch or --batch-silent was seen. */
88 /* Support for the --batch-silent option. */
91 /* Support for --return-child-result option.
92 Set the default to -1 to return error in the case
93 that the program does not run or does not complete. */
94 int return_child_result
= 0;
95 int return_child_result_value
= -1;
98 /* GDB as it has been invoked from the command line (i.e. argv[0]). */
99 static char *gdb_program_name
;
101 /* Return read only pointer to GDB_PROGRAM_NAME. */
103 get_gdb_program_name (void)
105 return gdb_program_name
;
108 static void print_gdb_help (struct ui_file
*);
110 /* Set the data-directory parameter to NEW_DATADIR.
111 If NEW_DATADIR is not a directory then a warning is printed.
112 We don't signal an error for backward compatibility. */
115 set_gdb_data_directory (const char *new_datadir
)
119 if (stat (new_datadir
, &st
) < 0)
121 int save_errno
= errno
;
123 fprintf_unfiltered (gdb_stderr
, "Warning: ");
124 print_sys_errmsg (new_datadir
, save_errno
);
126 else if (!S_ISDIR (st
.st_mode
))
127 warning (_("%ps is not a directory."),
128 styled_string (file_name_style
.style (), new_datadir
));
130 gdb_datadir
= gdb_realpath (new_datadir
).get ();
132 /* gdb_realpath won't return an absolute path if the path doesn't exist,
133 but we still want to record an absolute path here. If the user entered
134 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
135 isn't canonical, but that's ok. */
136 if (!IS_ABSOLUTE_PATH (gdb_datadir
.c_str ()))
138 gdb::unique_xmalloc_ptr
<char> abs_datadir
139 = gdb_abspath (gdb_datadir
.c_str ());
141 gdb_datadir
= abs_datadir
.get ();
145 /* Relocate a file or directory. PROGNAME is the name by which gdb
146 was invoked (i.e., argv[0]). INITIAL is the default value for the
147 file or directory. RELOCATABLE is true if the value is relocatable,
148 false otherwise. This may return an empty string under the same
149 conditions as make_relative_prefix returning NULL. */
152 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
156 gdb::unique_xmalloc_ptr
<char> str (make_relative_prefix (progname
,
161 return std::string ();
166 /* Like relocate_path, but specifically checks for a directory.
167 INITIAL is relocated according to the rules of relocate_path. If
168 the result is a directory, it is used; otherwise, INITIAL is used.
169 The chosen directory is then canonicalized using lrealpath. */
172 relocate_gdb_directory (const char *initial
, bool relocatable
)
174 std::string dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
179 if (stat (dir
.c_str (), &s
) != 0 || !S_ISDIR (s
.st_mode
))
187 /* Canonicalize the directory. */
190 gdb::unique_xmalloc_ptr
<char> canon_sysroot (lrealpath (dir
.c_str ()));
193 dir
= canon_sysroot
.get ();
199 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
200 parameter if it is in the data dir, or passes it through relocate_path
204 relocate_gdbinit_path_maybe_in_datadir (const std::string
&file
,
207 size_t datadir_len
= strlen (GDB_DATADIR
);
209 std::string relocated_path
;
211 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
212 has been provided, search for SYSTEM_GDBINIT there. */
213 if (gdb_datadir_provided
214 && datadir_len
< file
.length ()
215 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
216 && IS_DIR_SEPARATOR (file
[datadir_len
]))
218 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
221 size_t start
= datadir_len
;
222 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
224 relocated_path
= gdb_datadir
+ SLASH_STRING
+ file
.substr (start
);
228 relocated_path
= relocate_path (gdb_program_name
, file
.c_str (),
231 return relocated_path
;
234 /* Compute the locations of init files that GDB should source and
235 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
236 there is no system gdbinit (resp. home gdbinit and local gdbinit)
237 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
238 LOCAL_GDBINIT) is set to the empty string. */
240 get_init_files (std::vector
<std::string
> *system_gdbinit
,
241 std::string
*home_gdbinit
,
242 std::string
*local_gdbinit
)
244 static std::vector
<std::string
> sysgdbinit
;
245 static std::string homeinit
;
246 static std::string localinit
;
247 static int initialized
= 0;
251 struct stat homebuf
, cwdbuf
, s
;
253 if (SYSTEM_GDBINIT
[0])
255 std::string relocated_sysgdbinit
256 = relocate_gdbinit_path_maybe_in_datadir
257 (SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
);
258 if (!relocated_sysgdbinit
.empty ()
259 && stat (relocated_sysgdbinit
.c_str (), &s
) == 0)
260 sysgdbinit
.push_back (relocated_sysgdbinit
);
262 if (SYSTEM_GDBINIT_DIR
[0])
264 std::string relocated_gdbinit_dir
265 = relocate_gdbinit_path_maybe_in_datadir
266 (SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
);
267 if (!relocated_gdbinit_dir
.empty ()) {
268 gdb_dir_up
dir (opendir (relocated_gdbinit_dir
.c_str ()));
271 std::vector
<std::string
> files
;
274 struct dirent
*ent
= readdir (dir
.get ());
277 std::string
name (ent
->d_name
);
278 if (name
== "." || name
== "..")
280 /* ent->d_type is not available on all systems (e.g. mingw,
281 Solaris), so we have to call stat(). */
283 = relocated_gdbinit_dir
+ SLASH_STRING
+ name
;
284 if (stat (filename
.c_str (), &s
) != 0
285 || !S_ISREG (s
.st_mode
))
287 const struct extension_language_defn
*extlang
288 = get_ext_lang_of_file (filename
.c_str ());
289 /* We effectively don't support "set script-extension
290 off/soft", because we are loading system init files here,
291 so it does not really make sense to depend on a
293 if (extlang
!= nullptr && ext_lang_present_p (extlang
))
294 files
.push_back (std::move (filename
));
296 std::sort (files
.begin (), files
.end ());
297 sysgdbinit
.insert (sysgdbinit
.end (),
298 files
.begin (), files
.end ());
303 const char *homedir
= getenv ("HOME");
305 /* If the .gdbinit file in the current directory is the same as
306 the $HOME/.gdbinit file, it should not be sourced. homebuf
307 and cwdbuf are used in that purpose. Make sure that the stats
308 are zero in case one of them fails (this guarantees that they
309 won't match if either exists). */
311 memset (&homebuf
, 0, sizeof (struct stat
));
312 memset (&cwdbuf
, 0, sizeof (struct stat
));
316 homeinit
= std::string (homedir
) + SLASH_STRING
+ GDBINIT
;
317 if (stat (homeinit
.c_str (), &homebuf
) != 0)
323 if (stat (GDBINIT
, &cwdbuf
) == 0)
325 if (homeinit
.empty ()
326 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
327 sizeof (struct stat
)))
334 *system_gdbinit
= sysgdbinit
;
335 *home_gdbinit
= homeinit
;
336 *local_gdbinit
= localinit
;
339 /* Call command_loop. */
341 /* Prevent inlining this function for the benefit of GDB's selftests
342 in the testsuite. Those tests want to run GDB under GDB and stop
344 static void captured_command_loop () __attribute__((noinline
));
347 captured_command_loop ()
349 struct ui
*ui
= current_ui
;
351 /* Top-level execution commands can be run in the background from
353 current_ui
->async
= 1;
355 /* Give the interpreter a chance to print a prompt, if necessary */
356 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
357 interp_pre_command_loop (top_level_interpreter ());
359 /* Now it's time to start the event loop. */
362 /* If the command_loop returned, normally (rather than threw an
363 error) we try to quit. If the quit is aborted, our caller
364 catches the signal and restarts the command loop. */
365 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
368 /* Handle command errors thrown from within catch_command_errors. */
371 handle_command_errors (const struct gdb_exception
&e
)
375 exception_print (gdb_stderr
, e
);
377 /* If any exception escaped to here, we better enable stdin.
378 Otherwise, any command that calls async_disable_stdin, and
379 then throws, will leave stdin inoperable. */
380 async_enable_stdin ();
386 /* Type of the command callback passed to the const
387 catch_command_errors. */
389 typedef void (catch_command_errors_const_ftype
) (const char *, int);
391 /* Wrap calls to commands run before the event loop is started. */
394 catch_command_errors (catch_command_errors_const_ftype command
,
395 const char *arg
, int from_tty
)
399 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
401 command (arg
, from_tty
);
403 maybe_wait_sync_command_done (was_sync
);
405 catch (const gdb_exception
&e
)
407 return handle_command_errors (e
);
413 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
414 symfile_add_flags. */
417 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
419 symfile_add_flags add_flags
= 0;
422 add_flags
|= SYMFILE_VERBOSE
;
424 symbol_file_add_main (arg
, add_flags
);
427 /* Perform validation of the '--readnow' and '--readnever' flags. */
430 validate_readnow_readnever ()
432 if (readnever_symbol_files
&& readnow_symbol_files
)
434 error (_("%s: '--readnow' and '--readnever' cannot be "
435 "specified simultaneously"),
440 /* Type of this option. */
443 /* Option type -x. */
446 /* Option type -ex. */
449 /* Option type -ix. */
452 /* Option type -iex. */
456 /* Arguments of --command option and its counterpart. */
459 cmdarg (cmdarg_kind type_
, char *string_
)
460 : type (type_
), string (string_
)
463 /* Type of this option. */
464 enum cmdarg_kind type
;
466 /* Value of this option - filename or the GDB command itself. String memory
467 is not owned by this structure despite it is 'const'. */
472 captured_main_1 (struct captured_main_args
*context
)
474 int argc
= context
->argc
;
475 char **argv
= context
->argv
;
477 static int quiet
= 0;
478 static int set_args
= 0;
479 static int inhibit_home_gdbinit
= 0;
481 /* Pointers to various arguments from command line. */
483 char *execarg
= NULL
;
485 char *corearg
= NULL
;
486 char *pid_or_core_arg
= NULL
;
490 /* These are static so that we can take their address in an
492 static int print_help
;
493 static int print_version
;
494 static int print_configuration
;
496 /* Pointers to all arguments of --command option. */
497 std::vector
<struct cmdarg
> cmdarg_vec
;
499 /* All arguments of --directory option. */
500 std::vector
<char *> dirarg
;
506 #ifdef HAVE_USEFUL_SBRK
507 /* Set this before constructing scoped_command_stats. */
508 lim_at_start
= (char *) sbrk (0);
511 scoped_command_stats
stat_reporter (false);
513 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
514 setlocale (LC_MESSAGES
, "");
516 #if defined (HAVE_SETLOCALE)
517 setlocale (LC_CTYPE
, "");
520 bindtextdomain (PACKAGE
, LOCALEDIR
);
521 textdomain (PACKAGE
);
527 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
528 as a Windows pipe, and Windows buffers on pipes. */
529 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
532 /* Note: `error' cannot be called before this point, because the
533 caller will crash when trying to print the exception. */
534 main_ui
= new ui (stdin
, stdout
, stderr
);
535 current_ui
= main_ui
;
537 gdb_stdtargerr
= gdb_stderr
; /* for moment */
538 gdb_stdtargin
= gdb_stdin
; /* for moment */
540 if (bfd_init () != BFD_INIT_MAGIC
)
541 error (_("fatal error: libbfd ABI mismatch"));
544 /* On Windows, argv[0] is not necessarily set to absolute form when
545 GDB is found along PATH, without which relocation doesn't work. */
546 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
548 gdb_program_name
= xstrdup (argv
[0]);
551 /* Prefix warning messages with the command name. */
552 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
553 (xstrprintf ("%s: warning: ", gdb_program_name
));
554 warning_pre_print
= tmp_warn_preprint
.get ();
556 current_directory
= getcwd (NULL
, 0);
557 if (current_directory
== NULL
)
558 perror_warning_with_name (_("error finding working directory"));
560 /* Set the sysroot path. */
562 = xstrdup (relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
563 TARGET_SYSTEM_ROOT_RELOCATABLE
).c_str ());
565 if (*gdb_sysroot
== '\0')
568 gdb_sysroot
= xstrdup (TARGET_SYSROOT_PREFIX
);
572 = xstrdup (relocate_gdb_directory (DEBUGDIR
,
573 DEBUGDIR_RELOCATABLE
).c_str ());
575 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
576 GDB_DATADIR_RELOCATABLE
);
578 #ifdef WITH_PYTHON_PATH
580 /* For later use in helping Python find itself. */
581 char *tmp
= concat (WITH_PYTHON_PATH
, SLASH_STRING
, "lib", (char *) NULL
);
583 python_libdir
= relocate_gdb_directory (tmp
, PYTHON_PATH_RELOCATABLE
);
589 add_substitute_path_rule (RELOC_SRCDIR
,
590 make_relative_prefix (gdb_program_name
, BINDIR
,
594 /* There will always be an interpreter. Either the one passed into
595 this captured main, or one specified by the user at start up, or
596 the console. Initialize the interpreter to the one requested by
598 interpreter_p
= xstrdup (context
->interpreter_p
);
600 /* Parse arguments and options. */
603 /* When var field is 0, use flag field to record the equivalent
604 short option (or arbitrary numbers starting at 10 for those
605 with no equivalent). */
619 /* This struct requires int* in the struct, but write_files is a bool.
620 So use this temporary int that we write back after argument parsing. */
621 int write_files_1
= 0;
622 static struct option long_options
[] =
624 {"tui", no_argument
, 0, OPT_TUI
},
625 {"dbx", no_argument
, &dbx_commands
, 1},
626 {"readnow", no_argument
, NULL
, OPT_READNOW
},
627 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
628 {"r", no_argument
, NULL
, OPT_READNOW
},
629 {"quiet", no_argument
, &quiet
, 1},
630 {"q", no_argument
, &quiet
, 1},
631 {"silent", no_argument
, &quiet
, 1},
632 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
633 {"nx", no_argument
, &inhibit_gdbinit
, 1},
634 {"n", no_argument
, &inhibit_gdbinit
, 1},
635 {"batch-silent", no_argument
, 0, 'B'},
636 {"batch", no_argument
, &batch_flag
, 1},
638 /* This is a synonym for "--annotate=1". --annotate is now
639 preferred, but keep this here for a long time because people
640 will be running emacses which use --fullname. */
641 {"fullname", no_argument
, 0, 'f'},
642 {"f", no_argument
, 0, 'f'},
644 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
645 {"help", no_argument
, &print_help
, 1},
646 {"se", required_argument
, 0, OPT_SE
},
647 {"symbols", required_argument
, 0, 's'},
648 {"s", required_argument
, 0, 's'},
649 {"exec", required_argument
, 0, 'e'},
650 {"e", required_argument
, 0, 'e'},
651 {"core", required_argument
, 0, 'c'},
652 {"c", required_argument
, 0, 'c'},
653 {"pid", required_argument
, 0, 'p'},
654 {"p", required_argument
, 0, 'p'},
655 {"command", required_argument
, 0, 'x'},
656 {"eval-command", required_argument
, 0, 'X'},
657 {"version", no_argument
, &print_version
, 1},
658 {"configuration", no_argument
, &print_configuration
, 1},
659 {"x", required_argument
, 0, 'x'},
660 {"ex", required_argument
, 0, 'X'},
661 {"init-command", required_argument
, 0, OPT_IX
},
662 {"init-eval-command", required_argument
, 0, OPT_IEX
},
663 {"ix", required_argument
, 0, OPT_IX
},
664 {"iex", required_argument
, 0, OPT_IEX
},
666 {"tclcommand", required_argument
, 0, 'z'},
667 {"enable-external-editor", no_argument
, 0, 'y'},
668 {"editor-command", required_argument
, 0, 'w'},
670 {"ui", required_argument
, 0, 'i'},
671 {"interpreter", required_argument
, 0, 'i'},
672 {"i", required_argument
, 0, 'i'},
673 {"directory", required_argument
, 0, 'd'},
674 {"d", required_argument
, 0, 'd'},
675 {"data-directory", required_argument
, 0, 'D'},
676 {"D", required_argument
, 0, 'D'},
677 {"cd", required_argument
, 0, OPT_CD
},
678 {"tty", required_argument
, 0, 't'},
679 {"baud", required_argument
, 0, 'b'},
680 {"b", required_argument
, 0, 'b'},
681 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
682 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
683 {"w", no_argument
, NULL
, OPT_WINDOWS
},
684 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
685 {"statistics", no_argument
, 0, OPT_STATISTICS
},
686 {"write", no_argument
, &write_files_1
, 1},
687 {"args", no_argument
, &set_args
, 1},
688 {"l", required_argument
, 0, 'l'},
689 {"return-child-result", no_argument
, &return_child_result
, 1},
690 {0, no_argument
, 0, 0}
697 c
= getopt_long_only (argc
, argv
, "",
698 long_options
, &option_index
);
699 if (c
== EOF
|| set_args
)
702 /* Long option that takes an argument. */
703 if (c
== 0 && long_options
[option_index
].flag
== 0)
704 c
= long_options
[option_index
].val
;
709 /* Long option that just sets a flag. */
719 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
720 annotation_level
= atoi (optarg
);
723 /* Enable the display of both time and space usage. */
724 set_per_command_time (1);
725 set_per_command_space (1);
728 /* --tui is equivalent to -i=tui. */
730 xfree (interpreter_p
);
731 interpreter_p
= xstrdup (INTERP_TUI
);
733 error (_("%s: TUI mode is not supported"), gdb_program_name
);
737 /* FIXME: cagney/2003-03-01: Not sure if this option is
738 actually useful, and if it is, what it should do. */
740 /* --windows is equivalent to -i=insight. */
741 xfree (interpreter_p
);
742 interpreter_p
= xstrdup (INTERP_INSIGHT
);
746 /* -nw is equivalent to -i=console. */
747 xfree (interpreter_p
);
748 interpreter_p
= xstrdup (INTERP_CONSOLE
);
751 annotation_level
= 1;
766 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
769 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
772 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
775 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
778 batch_flag
= batch_silent
= 1;
779 gdb_stdout
= new null_file ();
782 if (optarg
[0] == '\0')
783 error (_("%s: empty path for `--data-directory'"),
785 set_gdb_data_directory (optarg
);
786 gdb_datadir_provided
= 1;
791 if (!gdbtk_test (optarg
))
792 error (_("%s: unable to load tclcommand file \"%s\""),
793 gdb_program_name
, optarg
);
797 /* Backwards compatibility only. */
801 /* Set the external editor commands when gdb is farming out files
802 to be edited by another program. */
803 external_editor_command
= xstrdup (optarg
);
808 xfree (interpreter_p
);
809 interpreter_p
= xstrdup (optarg
);
812 dirarg
.push_back (optarg
);
825 rate
= strtol (optarg
, &p
, 0);
826 if (rate
== 0 && p
== optarg
)
827 warning (_("could not set baud rate to `%s'."),
838 timeout
= strtol (optarg
, &p
, 0);
839 if (timeout
== 0 && p
== optarg
)
840 warning (_("could not set timeout limit to `%s'."),
843 remote_timeout
= timeout
;
849 readnow_symbol_files
= 1;
850 validate_readnow_readnever ();
856 readnever_symbol_files
= 1;
857 validate_readnow_readnever ();
862 error (_("Use `%s --help' for a complete list of options."),
866 write_files
= (write_files_1
!= 0);
872 /* Disable all output styling when running in batch mode. */
877 save_original_signals_state (quiet
);
879 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
880 gdb::alternate_signal_stack signal_stack
;
882 /* Initialize all files. */
883 gdb_init (gdb_program_name
);
885 /* Now that gdb_init has created the initial inferior, we're in
886 position to set args for that inferior. */
889 /* The remaining options are the command-line options for the
890 inferior. The first one is the sym/exec file, and the rest
893 error (_("%s: `--args' specified but no program specified"),
896 symarg
= argv
[optind
];
897 execarg
= argv
[optind
];
899 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
903 /* OK, that's all the options. */
905 /* The first argument, if specified, is the name of the
909 symarg
= argv
[optind
];
910 execarg
= argv
[optind
];
914 /* If the user hasn't already specified a PID or the name of a
915 core file, then a second optional argument is allowed. If
916 present, this argument should be interpreted as either a
917 PID or a core file, whichever works. */
918 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
920 pid_or_core_arg
= argv
[optind
];
924 /* Any argument left on the command line is unexpected and
925 will be ignored. Inform the user. */
927 fprintf_unfiltered (gdb_stderr
,
928 _("Excess command line "
929 "arguments ignored. (%s%s)\n"),
931 (optind
== argc
- 1) ? "" : " ...");
934 /* Lookup gdbinit files. Note that the gdbinit file name may be
935 overridden during file initialization, so get_init_files should be
936 called after gdb_init. */
937 std::vector
<std::string
> system_gdbinit
;
938 std::string home_gdbinit
;
939 std::string local_gdbinit
;
940 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
942 /* Do these (and anything which might call wrap_here or *_filtered)
943 after initialize_all_files() but before the interpreter has been
944 installed. Otherwize the help/version messages will be eaten by
945 the interpreter's output handler. */
949 print_gdb_version (gdb_stdout
, false);
951 printf_filtered ("\n");
957 print_gdb_help (gdb_stdout
);
958 fputs_unfiltered ("\n", gdb_stdout
);
962 if (print_configuration
)
964 print_gdb_configuration (gdb_stdout
);
966 printf_filtered ("\n");
970 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
971 GDB retain the old MI1 interpreter startup behavior. Output the
972 copyright message before the interpreter is installed. That way
973 it isn't encapsulated in MI output. */
974 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
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 /* Install the default UI. All the interpreters should have had a
988 look at things by now. Initialize the default interpreter. */
989 set_top_level_interpreter (interpreter_p
);
991 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
992 GDB retain the old MI1 interpreter startup behavior. Output the
993 copyright message after the interpreter is installed when it is
994 any sane interpreter. */
995 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
997 /* Print all the junk at the top, with trailing "..." if we are
998 about to read a symbol file (possibly slowly). */
999 print_gdb_version (gdb_stdout
, true);
1001 printf_filtered ("..");
1003 printf_filtered ("\n");
1004 gdb_flush (gdb_stdout
); /* Force to screen during slow
1008 /* Set off error and warning messages with a blank line. */
1009 tmp_warn_preprint
.reset ();
1010 warning_pre_print
= _("\nwarning: ");
1012 /* Read and execute the system-wide gdbinit file, if it exists.
1013 This is done *before* all the command line arguments are
1014 processed; it sets global parameters, which are independent of
1015 what file you are debugging or what directory you are in. */
1016 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
1018 for (const std::string
&file
: system_gdbinit
)
1019 ret
= catch_command_errors (source_script
, file
.c_str (), 0);
1022 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
1023 *before* all the command line arguments are processed; it sets
1024 global parameters, which are independent of what file you are
1025 debugging or what directory you are in. */
1027 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1028 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1030 /* Process '-ix' and '-iex' options early. */
1031 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1033 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1035 switch (cmdarg_p
.type
)
1037 case CMDARG_INIT_FILE
:
1038 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1041 case CMDARG_INIT_COMMAND
:
1042 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1048 /* Now perform all the actions indicated by the arguments. */
1051 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1054 for (i
= 0; i
< dirarg
.size (); i
++)
1055 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1057 /* Skip auto-loading section-specified scripts until we've sourced
1058 local_gdbinit (which is often used to augment the source search
1060 save_auto_load
= global_auto_load
;
1061 global_auto_load
= 0;
1065 && strcmp (execarg
, symarg
) == 0)
1067 /* The exec file and the symbol-file are the same. If we can't
1068 open it, better only print one error message.
1069 catch_command_errors returns non-zero on success! */
1070 ret
= catch_command_errors (exec_file_attach
, execarg
,
1073 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1074 symarg
, !batch_flag
);
1078 if (execarg
!= NULL
)
1079 ret
= catch_command_errors (exec_file_attach
, execarg
,
1082 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1083 symarg
, !batch_flag
);
1086 if (corearg
&& pidarg
)
1087 error (_("Can't attach to process and specify "
1088 "a core file at the same time."));
1090 if (corearg
!= NULL
)
1092 ret
= catch_command_errors (core_file_command
, corearg
,
1095 else if (pidarg
!= NULL
)
1097 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1099 else if (pid_or_core_arg
)
1101 /* The user specified 'gdb program pid' or gdb program core'.
1102 If pid_or_core_arg's first character is a digit, try attach
1103 first and then corefile. Otherwise try just corefile. */
1105 if (isdigit (pid_or_core_arg
[0]))
1107 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1110 ret
= catch_command_errors (core_file_command
,
1116 /* Can't be a pid, better be a corefile. */
1117 ret
= catch_command_errors (core_file_command
,
1124 set_inferior_io_terminal (ttyarg
);
1126 /* Error messages should no longer be distinguished with extra output. */
1127 warning_pre_print
= _("warning: ");
1129 /* Read the .gdbinit file in the current directory, *if* it isn't
1130 the same as the $HOME/.gdbinit file (it should exist, also). */
1131 if (!local_gdbinit
.empty ())
1133 auto_load_local_gdbinit_pathname
1134 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1136 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
1137 && file_is_auto_load_safe (local_gdbinit
.c_str (),
1138 _("auto-load: Loading .gdbinit "
1140 local_gdbinit
.c_str ()))
1142 auto_load_local_gdbinit_loaded
= 1;
1144 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1148 /* Now that all .gdbinit's have been read and all -d options have been
1149 processed, we can read any scripts mentioned in SYMARG.
1150 We wait until now because it is common to add to the source search
1151 path in local_gdbinit. */
1152 global_auto_load
= save_auto_load
;
1153 for (objfile
*objfile
: current_program_space
->objfiles ())
1154 load_auto_scripts_for_objfile (objfile
);
1156 /* Process '-x' and '-ex' options. */
1157 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1159 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1161 switch (cmdarg_p
.type
)
1164 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1167 case CMDARG_COMMAND
:
1168 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1174 /* Read in the old history after all the command files have been
1180 int error_status
= EXIT_FAILURE
;
1181 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1183 /* We have hit the end of the batch file. */
1184 quit_force (exit_arg
, 0);
1189 captured_main (void *data
)
1191 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1193 captured_main_1 (context
);
1195 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1196 moving this loop and the code found in captured_command_loop()
1197 into the command_loop() proper. The main thing holding back that
1198 change - SET_TOP_LEVEL() - has been eliminated. */
1203 captured_command_loop ();
1205 catch (const gdb_exception
&ex
)
1207 exception_print (gdb_stderr
, ex
);
1210 /* No exit -- exit is through quit_command. */
1214 gdb_main (struct captured_main_args
*args
)
1218 captured_main (args
);
1220 catch (const gdb_exception
&ex
)
1222 exception_print (gdb_stderr
, ex
);
1225 /* The only way to end up here is by an error (normal exit is
1226 handled by quit_force()), hence always return an error status. */
1231 /* Don't use *_filtered for printing help. We don't want to prompt
1232 for continue no matter how small the screen or how much we're going
1236 print_gdb_help (struct ui_file
*stream
)
1238 std::vector
<std::string
> system_gdbinit
;
1239 std::string home_gdbinit
;
1240 std::string local_gdbinit
;
1242 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1244 /* Note: The options in the list below are only approximately sorted
1245 in the alphabetical order, so as to group closely related options
1247 fputs_unfiltered (_("\
1248 This is the GNU debugger. Usage:\n\n\
1249 gdb [options] [executable-file [core-file or process-id]]\n\
1250 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1252 fputs_unfiltered (_("\
1253 Selection of debuggee and its files:\n\n\
1254 --args Arguments after executable-file are passed to inferior\n\
1255 --core=COREFILE Analyze the core dump COREFILE.\n\
1256 --exec=EXECFILE Use EXECFILE as the executable.\n\
1257 --pid=PID Attach to running process PID.\n\
1258 --directory=DIR Search for source files in DIR.\n\
1259 --se=FILE Use FILE as symbol file and executable file.\n\
1260 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1261 --readnow Fully read symbol files on first access.\n\
1262 --readnever Do not read symbol files.\n\
1263 --write Set writing into executable and core files.\n\n\
1265 fputs_unfiltered (_("\
1266 Initial commands and command files:\n\n\
1267 --command=FILE, -x Execute GDB commands from FILE.\n\
1268 --init-command=FILE, -ix\n\
1269 Like -x but execute commands before loading inferior.\n\
1270 --eval-command=COMMAND, -ex\n\
1271 Execute a single GDB command.\n\
1272 May be used multiple times and in conjunction\n\
1274 --init-eval-command=COMMAND, -iex\n\
1275 Like -ex but before loading inferior.\n\
1276 --nh Do not read ~/.gdbinit.\n\
1277 --nx Do not read any .gdbinit files in any directory.\n\n\
1279 fputs_unfiltered (_("\
1280 Output and user interface control:\n\n\
1281 --fullname Output information used by emacs-GDB interface.\n\
1282 --interpreter=INTERP\n\
1283 Select a specific interpreter / user interface\n\
1284 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1285 -w Use the GUI interface.\n\
1286 --nw Do not use the GUI interface.\n\
1289 fputs_unfiltered (_("\
1290 --tui Use a terminal user interface.\n\
1293 fputs_unfiltered (_("\
1294 --dbx DBX compatibility mode.\n\
1295 -q, --quiet, --silent\n\
1296 Do not print version number on startup.\n\n\
1298 fputs_unfiltered (_("\
1299 Operating modes:\n\n\
1300 --batch Exit after processing options.\n\
1301 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1302 --return-child-result\n\
1303 GDB exit code will be the child's exit code.\n\
1304 --configuration Print details about GDB configuration and then exit.\n\
1305 --help Print this message and then exit.\n\
1306 --version Print version information and then exit.\n\n\
1307 Remote debugging options:\n\n\
1308 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1309 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1311 --cd=DIR Change current directory to DIR.\n\
1312 --data-directory=DIR, -D\n\
1313 Set GDB's data-directory to DIR.\n\
1315 fputs_unfiltered (_("\n\
1316 At startup, GDB reads the following init files and executes their commands:\n\
1318 if (!system_gdbinit
.empty ())
1321 for (size_t idx
= 0; idx
< system_gdbinit
.size (); ++idx
)
1323 output
+= system_gdbinit
[idx
];
1324 if (idx
< system_gdbinit
.size () - 1)
1327 fprintf_unfiltered (stream
, _("\
1328 * system-wide init files: %s\n\
1329 "), output
.c_str ());
1331 if (!home_gdbinit
.empty ())
1332 fprintf_unfiltered (stream
, _("\
1333 * user-specific init file: %s\n\
1334 "), home_gdbinit
.c_str ());
1335 if (!local_gdbinit
.empty ())
1336 fprintf_unfiltered (stream
, _("\
1337 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1338 "), local_gdbinit
.c_str ());
1339 fputs_unfiltered (_("\n\
1340 For more information, type \"help\" from within GDB, or consult the\n\
1341 GDB manual (available as on-line info or a printed manual).\n\
1343 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1344 fprintf_unfiltered (stream
, _("\
1345 Report bugs to \"%s\".\n\
1346 "), REPORT_BUGS_TO
);