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"
50 #include "gdbsupport/pathstuff.h"
51 #include "cli/cli-style.h"
53 #include "gdbtk/generic/gdbtk.h"
56 /* The selected interpreter. This will be used as a set command
57 variable, so it should always be malloc'ed - since
58 do_setshow_command will free it. */
61 /* Whether dbx commands will be handled. */
64 /* System root path, used to find libraries etc. */
65 char *gdb_sysroot
= 0;
67 /* GDB datadir, used to store data files. */
68 std::string gdb_datadir
;
70 /* Non-zero if GDB_DATADIR was provided on the command line.
71 This doesn't track whether data-directory is set later from the
72 command line, but we don't reread system.gdbinit when that happens. */
73 static int gdb_datadir_provided
= 0;
75 /* If gdb was configured with --with-python=/path,
76 the possibly relocated path to python's lib directory. */
77 std::string python_libdir
;
79 /* Target IO streams. */
80 struct ui_file
*gdb_stdtargin
;
81 struct ui_file
*gdb_stdtarg
;
82 struct ui_file
*gdb_stdtargerr
;
84 /* True if --batch or --batch-silent was seen. */
87 /* Support for the --batch-silent option. */
90 /* Support for --return-child-result option.
91 Set the default to -1 to return error in the case
92 that the program does not run or does not complete. */
93 int return_child_result
= 0;
94 int return_child_result_value
= -1;
97 /* GDB as it has been invoked from the command line (i.e. argv[0]). */
98 static char *gdb_program_name
;
100 /* Return read only pointer to GDB_PROGRAM_NAME. */
102 get_gdb_program_name (void)
104 return gdb_program_name
;
107 static void print_gdb_help (struct ui_file
*);
109 /* Set the data-directory parameter to NEW_DATADIR.
110 If NEW_DATADIR is not a directory then a warning is printed.
111 We don't signal an error for backward compatibility. */
114 set_gdb_data_directory (const char *new_datadir
)
118 if (stat (new_datadir
, &st
) < 0)
120 int save_errno
= errno
;
122 fprintf_unfiltered (gdb_stderr
, "Warning: ");
123 print_sys_errmsg (new_datadir
, save_errno
);
125 else if (!S_ISDIR (st
.st_mode
))
126 warning (_("%s is not a directory."), new_datadir
);
128 gdb_datadir
= gdb_realpath (new_datadir
).get ();
130 /* gdb_realpath won't return an absolute path if the path doesn't exist,
131 but we still want to record an absolute path here. If the user entered
132 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
133 isn't canonical, but that's ok. */
134 if (!IS_ABSOLUTE_PATH (gdb_datadir
.c_str ()))
136 gdb::unique_xmalloc_ptr
<char> abs_datadir
137 = gdb_abspath (gdb_datadir
.c_str ());
139 gdb_datadir
= abs_datadir
.get ();
143 /* Relocate a file or directory. PROGNAME is the name by which gdb
144 was invoked (i.e., argv[0]). INITIAL is the default value for the
145 file or directory. RELOCATABLE is true if the value is relocatable,
146 false otherwise. This may return an empty string under the same
147 conditions as make_relative_prefix returning NULL. */
150 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
154 gdb::unique_xmalloc_ptr
<char> str (make_relative_prefix (progname
,
159 return std::string ();
164 /* Like relocate_path, but specifically checks for a directory.
165 INITIAL is relocated according to the rules of relocate_path. If
166 the result is a directory, it is used; otherwise, INITIAL is used.
167 The chosen directory is then canonicalized using lrealpath. */
170 relocate_gdb_directory (const char *initial
, bool relocatable
)
172 std::string dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
177 if (stat (dir
.c_str (), &s
) != 0 || !S_ISDIR (s
.st_mode
))
185 /* Canonicalize the directory. */
188 gdb::unique_xmalloc_ptr
<char> canon_sysroot (lrealpath (dir
.c_str ()));
191 dir
= canon_sysroot
.get ();
197 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
198 parameter if it is in the data dir, or passes it through relocate_path
202 relocate_gdbinit_path_maybe_in_datadir (const std::string
&file
,
205 size_t datadir_len
= strlen (GDB_DATADIR
);
207 std::string relocated_path
;
209 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
210 has been provided, search for SYSTEM_GDBINIT there. */
211 if (gdb_datadir_provided
212 && datadir_len
< file
.length ()
213 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
214 && IS_DIR_SEPARATOR (file
[datadir_len
]))
216 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
219 size_t start
= datadir_len
;
220 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
222 relocated_path
= gdb_datadir
+ SLASH_STRING
+ file
.substr (start
);
226 relocated_path
= relocate_path (gdb_program_name
, file
.c_str (),
229 return relocated_path
;
232 /* Compute the locations of init files that GDB should source and
233 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
234 there is no system gdbinit (resp. home gdbinit and local gdbinit)
235 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
236 LOCAL_GDBINIT) is set to the empty string. */
238 get_init_files (std::vector
<std::string
> *system_gdbinit
,
239 std::string
*home_gdbinit
,
240 std::string
*local_gdbinit
)
242 static std::vector
<std::string
> sysgdbinit
;
243 static std::string homeinit
;
244 static std::string localinit
;
245 static int initialized
= 0;
249 struct stat homebuf
, cwdbuf
, s
;
251 if (SYSTEM_GDBINIT
[0])
253 std::string relocated_sysgdbinit
254 = relocate_gdbinit_path_maybe_in_datadir
255 (SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
);
256 if (!relocated_sysgdbinit
.empty ()
257 && stat (relocated_sysgdbinit
.c_str (), &s
) == 0)
258 sysgdbinit
.push_back (relocated_sysgdbinit
);
260 if (SYSTEM_GDBINIT_DIR
[0])
262 std::string relocated_gdbinit_dir
263 = relocate_gdbinit_path_maybe_in_datadir
264 (SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
);
265 if (!relocated_gdbinit_dir
.empty ()) {
266 gdb_dir_up
dir (opendir (relocated_gdbinit_dir
.c_str ()));
269 std::vector
<std::string
> files
;
272 struct dirent
*ent
= readdir (dir
.get ());
275 std::string
name (ent
->d_name
);
276 if (name
== "." || name
== "..")
278 /* ent->d_type is not available on all systems (e.g. mingw,
279 Solaris), so we have to call stat(). */
281 = relocated_gdbinit_dir
+ SLASH_STRING
+ name
;
282 if (stat (filename
.c_str (), &s
) != 0
283 || !S_ISREG (s
.st_mode
))
285 const struct extension_language_defn
*extlang
286 = get_ext_lang_of_file (filename
.c_str ());
287 /* We effectively don't support "set script-extension
288 off/soft", because we are loading system init files here,
289 so it does not really make sense to depend on a
291 if (extlang
!= nullptr && ext_lang_present_p (extlang
))
292 files
.push_back (std::move (filename
));
294 std::sort (files
.begin (), files
.end ());
295 sysgdbinit
.insert (sysgdbinit
.end (),
296 files
.begin (), files
.end ());
301 const char *homedir
= getenv ("HOME");
303 /* If the .gdbinit file in the current directory is the same as
304 the $HOME/.gdbinit file, it should not be sourced. homebuf
305 and cwdbuf are used in that purpose. Make sure that the stats
306 are zero in case one of them fails (this guarantees that they
307 won't match if either exists). */
309 memset (&homebuf
, 0, sizeof (struct stat
));
310 memset (&cwdbuf
, 0, sizeof (struct stat
));
314 homeinit
= std::string (homedir
) + SLASH_STRING
+ GDBINIT
;
315 if (stat (homeinit
.c_str (), &homebuf
) != 0)
321 if (stat (GDBINIT
, &cwdbuf
) == 0)
323 if (homeinit
.empty ()
324 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
325 sizeof (struct stat
)))
332 *system_gdbinit
= sysgdbinit
;
333 *home_gdbinit
= homeinit
;
334 *local_gdbinit
= localinit
;
337 /* Try to set up an alternate signal stack for SIGSEGV handlers.
338 This allows us to handle SIGSEGV signals generated when the
339 normal process stack is exhausted. If this stack is not set
340 up (sigaltstack is unavailable or fails) and a SIGSEGV is
341 generated when the normal stack is exhausted then the program
342 will behave as though no SIGSEGV handler was installed. */
345 setup_alternate_signal_stack (void)
347 #ifdef HAVE_SIGALTSTACK
350 /* FreeBSD versions older than 11.0 use char * for ss_sp instead of
351 void *. This cast works with both types. */
352 ss
.ss_sp
= (char *) xmalloc (SIGSTKSZ
);
353 ss
.ss_size
= SIGSTKSZ
;
356 sigaltstack(&ss
, NULL
);
360 /* Call command_loop. */
362 /* Prevent inlining this function for the benefit of GDB's selftests
363 in the testsuite. Those tests want to run GDB under GDB and stop
365 static void captured_command_loop () __attribute__((noinline
));
368 captured_command_loop ()
370 struct ui
*ui
= current_ui
;
372 /* Top-level execution commands can be run in the background from
374 current_ui
->async
= 1;
376 /* Give the interpreter a chance to print a prompt, if necessary */
377 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
378 interp_pre_command_loop (top_level_interpreter ());
380 /* Now it's time to start the event loop. */
383 /* If the command_loop returned, normally (rather than threw an
384 error) we try to quit. If the quit is aborted, our caller
385 catches the signal and restarts the command loop. */
386 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
389 /* Handle command errors thrown from within catch_command_errors. */
392 handle_command_errors (const struct gdb_exception
&e
)
396 exception_print (gdb_stderr
, e
);
398 /* If any exception escaped to here, we better enable stdin.
399 Otherwise, any command that calls async_disable_stdin, and
400 then throws, will leave stdin inoperable. */
401 async_enable_stdin ();
407 /* Type of the command callback passed to the const
408 catch_command_errors. */
410 typedef void (catch_command_errors_const_ftype
) (const char *, int);
412 /* Wrap calls to commands run before the event loop is started. */
415 catch_command_errors (catch_command_errors_const_ftype command
,
416 const char *arg
, int from_tty
)
420 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
422 command (arg
, from_tty
);
424 maybe_wait_sync_command_done (was_sync
);
426 catch (const gdb_exception
&e
)
428 return handle_command_errors (e
);
434 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
435 symfile_add_flags. */
438 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
440 symfile_add_flags add_flags
= 0;
443 add_flags
|= SYMFILE_VERBOSE
;
445 symbol_file_add_main (arg
, add_flags
);
448 /* Perform validation of the '--readnow' and '--readnever' flags. */
451 validate_readnow_readnever ()
453 if (readnever_symbol_files
&& readnow_symbol_files
)
455 error (_("%s: '--readnow' and '--readnever' cannot be "
456 "specified simultaneously"),
461 /* Type of this option. */
464 /* Option type -x. */
467 /* Option type -ex. */
470 /* Option type -ix. */
473 /* Option type -iex. */
477 /* Arguments of --command option and its counterpart. */
480 cmdarg (cmdarg_kind type_
, char *string_
)
481 : type (type_
), string (string_
)
484 /* Type of this option. */
485 enum cmdarg_kind type
;
487 /* Value of this option - filename or the GDB command itself. String memory
488 is not owned by this structure despite it is 'const'. */
493 captured_main_1 (struct captured_main_args
*context
)
495 int argc
= context
->argc
;
496 char **argv
= context
->argv
;
498 static int quiet
= 0;
499 static int set_args
= 0;
500 static int inhibit_home_gdbinit
= 0;
502 /* Pointers to various arguments from command line. */
504 char *execarg
= NULL
;
506 char *corearg
= NULL
;
507 char *pid_or_core_arg
= NULL
;
511 /* These are static so that we can take their address in an
513 static int print_help
;
514 static int print_version
;
515 static int print_configuration
;
517 /* Pointers to all arguments of --command option. */
518 std::vector
<struct cmdarg
> cmdarg_vec
;
520 /* All arguments of --directory option. */
521 std::vector
<char *> dirarg
;
527 #ifdef HAVE_USEFUL_SBRK
528 /* Set this before constructing scoped_command_stats. */
529 lim_at_start
= (char *) sbrk (0);
532 scoped_command_stats
stat_reporter (false);
534 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
535 setlocale (LC_MESSAGES
, "");
537 #if defined (HAVE_SETLOCALE)
538 setlocale (LC_CTYPE
, "");
541 bindtextdomain (PACKAGE
, LOCALEDIR
);
542 textdomain (PACKAGE
);
548 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
549 as a Windows pipe, and Windows buffers on pipes. */
550 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
553 /* Note: `error' cannot be called before this point, because the
554 caller will crash when trying to print the exception. */
555 main_ui
= new ui (stdin
, stdout
, stderr
);
556 current_ui
= main_ui
;
558 gdb_stdtargerr
= gdb_stderr
; /* for moment */
559 gdb_stdtargin
= gdb_stdin
; /* for moment */
561 if (bfd_init () != BFD_INIT_MAGIC
)
562 error (_("fatal error: libbfd ABI mismatch"));
565 /* On Windows, argv[0] is not necessarily set to absolute form when
566 GDB is found along PATH, without which relocation doesn't work. */
567 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
569 gdb_program_name
= xstrdup (argv
[0]);
572 /* Prefix warning messages with the command name. */
573 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
574 (xstrprintf ("%s: warning: ", gdb_program_name
));
575 warning_pre_print
= tmp_warn_preprint
.get ();
577 current_directory
= getcwd (NULL
, 0);
578 if (current_directory
== NULL
)
579 perror_warning_with_name (_("error finding working directory"));
581 /* Set the sysroot path. */
583 = xstrdup (relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
584 TARGET_SYSTEM_ROOT_RELOCATABLE
).c_str ());
586 if (*gdb_sysroot
== '\0')
589 gdb_sysroot
= xstrdup (TARGET_SYSROOT_PREFIX
);
593 = xstrdup (relocate_gdb_directory (DEBUGDIR
,
594 DEBUGDIR_RELOCATABLE
).c_str ());
596 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
597 GDB_DATADIR_RELOCATABLE
);
599 #ifdef WITH_PYTHON_PATH
601 /* For later use in helping Python find itself. */
602 char *tmp
= concat (WITH_PYTHON_PATH
, SLASH_STRING
, "lib", (char *) NULL
);
604 python_libdir
= relocate_gdb_directory (tmp
, PYTHON_PATH_RELOCATABLE
);
610 add_substitute_path_rule (RELOC_SRCDIR
,
611 make_relative_prefix (gdb_program_name
, BINDIR
,
615 /* There will always be an interpreter. Either the one passed into
616 this captured main, or one specified by the user at start up, or
617 the console. Initialize the interpreter to the one requested by
619 interpreter_p
= xstrdup (context
->interpreter_p
);
621 /* Parse arguments and options. */
624 /* When var field is 0, use flag field to record the equivalent
625 short option (or arbitrary numbers starting at 10 for those
626 with no equivalent). */
640 /* This struct requires int* in the struct, but write_files is a bool.
641 So use this temporary int that we write back after argument parsing. */
642 int write_files_1
= 0;
643 static struct option long_options
[] =
645 {"tui", no_argument
, 0, OPT_TUI
},
646 {"dbx", no_argument
, &dbx_commands
, 1},
647 {"readnow", no_argument
, NULL
, OPT_READNOW
},
648 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
649 {"r", no_argument
, NULL
, OPT_READNOW
},
650 {"quiet", no_argument
, &quiet
, 1},
651 {"q", no_argument
, &quiet
, 1},
652 {"silent", no_argument
, &quiet
, 1},
653 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
654 {"nx", no_argument
, &inhibit_gdbinit
, 1},
655 {"n", no_argument
, &inhibit_gdbinit
, 1},
656 {"batch-silent", no_argument
, 0, 'B'},
657 {"batch", no_argument
, &batch_flag
, 1},
659 /* This is a synonym for "--annotate=1". --annotate is now
660 preferred, but keep this here for a long time because people
661 will be running emacses which use --fullname. */
662 {"fullname", no_argument
, 0, 'f'},
663 {"f", no_argument
, 0, 'f'},
665 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
666 {"help", no_argument
, &print_help
, 1},
667 {"se", required_argument
, 0, OPT_SE
},
668 {"symbols", required_argument
, 0, 's'},
669 {"s", required_argument
, 0, 's'},
670 {"exec", required_argument
, 0, 'e'},
671 {"e", required_argument
, 0, 'e'},
672 {"core", required_argument
, 0, 'c'},
673 {"c", required_argument
, 0, 'c'},
674 {"pid", required_argument
, 0, 'p'},
675 {"p", required_argument
, 0, 'p'},
676 {"command", required_argument
, 0, 'x'},
677 {"eval-command", required_argument
, 0, 'X'},
678 {"version", no_argument
, &print_version
, 1},
679 {"configuration", no_argument
, &print_configuration
, 1},
680 {"x", required_argument
, 0, 'x'},
681 {"ex", required_argument
, 0, 'X'},
682 {"init-command", required_argument
, 0, OPT_IX
},
683 {"init-eval-command", required_argument
, 0, OPT_IEX
},
684 {"ix", required_argument
, 0, OPT_IX
},
685 {"iex", required_argument
, 0, OPT_IEX
},
687 {"tclcommand", required_argument
, 0, 'z'},
688 {"enable-external-editor", no_argument
, 0, 'y'},
689 {"editor-command", required_argument
, 0, 'w'},
691 {"ui", required_argument
, 0, 'i'},
692 {"interpreter", required_argument
, 0, 'i'},
693 {"i", required_argument
, 0, 'i'},
694 {"directory", required_argument
, 0, 'd'},
695 {"d", required_argument
, 0, 'd'},
696 {"data-directory", required_argument
, 0, 'D'},
697 {"D", required_argument
, 0, 'D'},
698 {"cd", required_argument
, 0, OPT_CD
},
699 {"tty", required_argument
, 0, 't'},
700 {"baud", required_argument
, 0, 'b'},
701 {"b", required_argument
, 0, 'b'},
702 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
703 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
704 {"w", no_argument
, NULL
, OPT_WINDOWS
},
705 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
706 {"statistics", no_argument
, 0, OPT_STATISTICS
},
707 {"write", no_argument
, &write_files_1
, 1},
708 {"args", no_argument
, &set_args
, 1},
709 {"l", required_argument
, 0, 'l'},
710 {"return-child-result", no_argument
, &return_child_result
, 1},
711 {0, no_argument
, 0, 0}
718 c
= getopt_long_only (argc
, argv
, "",
719 long_options
, &option_index
);
720 if (c
== EOF
|| set_args
)
723 /* Long option that takes an argument. */
724 if (c
== 0 && long_options
[option_index
].flag
== 0)
725 c
= long_options
[option_index
].val
;
730 /* Long option that just sets a flag. */
740 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
741 annotation_level
= atoi (optarg
);
744 /* Enable the display of both time and space usage. */
745 set_per_command_time (1);
746 set_per_command_space (1);
749 /* --tui is equivalent to -i=tui. */
751 xfree (interpreter_p
);
752 interpreter_p
= xstrdup (INTERP_TUI
);
754 error (_("%s: TUI mode is not supported"), gdb_program_name
);
758 /* FIXME: cagney/2003-03-01: Not sure if this option is
759 actually useful, and if it is, what it should do. */
761 /* --windows is equivalent to -i=insight. */
762 xfree (interpreter_p
);
763 interpreter_p
= xstrdup (INTERP_INSIGHT
);
767 /* -nw is equivalent to -i=console. */
768 xfree (interpreter_p
);
769 interpreter_p
= xstrdup (INTERP_CONSOLE
);
772 annotation_level
= 1;
787 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
790 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
793 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
796 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
799 batch_flag
= batch_silent
= 1;
800 gdb_stdout
= new null_file ();
803 if (optarg
[0] == '\0')
804 error (_("%s: empty path for `--data-directory'"),
806 set_gdb_data_directory (optarg
);
807 gdb_datadir_provided
= 1;
812 if (!gdbtk_test (optarg
))
813 error (_("%s: unable to load tclcommand file \"%s\""),
814 gdb_program_name
, optarg
);
818 /* Backwards compatibility only. */
822 /* Set the external editor commands when gdb is farming out files
823 to be edited by another program. */
824 external_editor_command
= xstrdup (optarg
);
829 xfree (interpreter_p
);
830 interpreter_p
= xstrdup (optarg
);
833 dirarg
.push_back (optarg
);
846 rate
= strtol (optarg
, &p
, 0);
847 if (rate
== 0 && p
== optarg
)
848 warning (_("could not set baud rate to `%s'."),
859 timeout
= strtol (optarg
, &p
, 0);
860 if (timeout
== 0 && p
== optarg
)
861 warning (_("could not set timeout limit to `%s'."),
864 remote_timeout
= timeout
;
870 readnow_symbol_files
= 1;
871 validate_readnow_readnever ();
877 readnever_symbol_files
= 1;
878 validate_readnow_readnever ();
883 error (_("Use `%s --help' for a complete list of options."),
887 write_files
= (write_files_1
!= 0);
893 /* Disable all output styling when running in batch mode. */
898 save_original_signals_state (quiet
);
900 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
901 setup_alternate_signal_stack ();
903 /* Initialize all files. */
904 gdb_init (gdb_program_name
);
906 /* Now that gdb_init has created the initial inferior, we're in
907 position to set args for that inferior. */
910 /* The remaining options are the command-line options for the
911 inferior. The first one is the sym/exec file, and the rest
914 error (_("%s: `--args' specified but no program specified"),
917 symarg
= argv
[optind
];
918 execarg
= argv
[optind
];
920 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
924 /* OK, that's all the options. */
926 /* The first argument, if specified, is the name of the
930 symarg
= argv
[optind
];
931 execarg
= argv
[optind
];
935 /* If the user hasn't already specified a PID or the name of a
936 core file, then a second optional argument is allowed. If
937 present, this argument should be interpreted as either a
938 PID or a core file, whichever works. */
939 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
941 pid_or_core_arg
= argv
[optind
];
945 /* Any argument left on the command line is unexpected and
946 will be ignored. Inform the user. */
948 fprintf_unfiltered (gdb_stderr
,
949 _("Excess command line "
950 "arguments ignored. (%s%s)\n"),
952 (optind
== argc
- 1) ? "" : " ...");
955 /* Lookup gdbinit files. Note that the gdbinit file name may be
956 overridden during file initialization, so get_init_files should be
957 called after gdb_init. */
958 std::vector
<std::string
> system_gdbinit
;
959 std::string home_gdbinit
;
960 std::string local_gdbinit
;
961 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
963 /* Do these (and anything which might call wrap_here or *_filtered)
964 after initialize_all_files() but before the interpreter has been
965 installed. Otherwize the help/version messages will be eaten by
966 the interpreter's output handler. */
970 print_gdb_version (gdb_stdout
, false);
972 printf_filtered ("\n");
978 print_gdb_help (gdb_stdout
);
979 fputs_unfiltered ("\n", gdb_stdout
);
983 if (print_configuration
)
985 print_gdb_configuration (gdb_stdout
);
987 printf_filtered ("\n");
991 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
992 GDB retain the old MI1 interpreter startup behavior. Output the
993 copyright message before the interpreter is installed. That way
994 it isn't encapsulated in MI output. */
995 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
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 /* Install the default UI. All the interpreters should have had a
1009 look at things by now. Initialize the default interpreter. */
1010 set_top_level_interpreter (interpreter_p
);
1012 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
1013 GDB retain the old MI1 interpreter startup behavior. Output the
1014 copyright message after the interpreter is installed when it is
1015 any sane interpreter. */
1016 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
1018 /* Print all the junk at the top, with trailing "..." if we are
1019 about to read a symbol file (possibly slowly). */
1020 print_gdb_version (gdb_stdout
, true);
1022 printf_filtered ("..");
1024 printf_filtered ("\n");
1025 gdb_flush (gdb_stdout
); /* Force to screen during slow
1029 /* Set off error and warning messages with a blank line. */
1030 tmp_warn_preprint
.reset ();
1031 warning_pre_print
= _("\nwarning: ");
1033 /* Read and execute the system-wide gdbinit file, if it exists.
1034 This is done *before* all the command line arguments are
1035 processed; it sets global parameters, which are independent of
1036 what file you are debugging or what directory you are in. */
1037 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
1039 for (const std::string
&file
: system_gdbinit
)
1040 ret
= catch_command_errors (source_script
, file
.c_str (), 0);
1043 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
1044 *before* all the command line arguments are processed; it sets
1045 global parameters, which are independent of what file you are
1046 debugging or what directory you are in. */
1048 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1049 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1051 /* Process '-ix' and '-iex' options early. */
1052 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1054 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1056 switch (cmdarg_p
.type
)
1058 case CMDARG_INIT_FILE
:
1059 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1062 case CMDARG_INIT_COMMAND
:
1063 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1069 /* Now perform all the actions indicated by the arguments. */
1072 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1075 for (i
= 0; i
< dirarg
.size (); i
++)
1076 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1078 /* Skip auto-loading section-specified scripts until we've sourced
1079 local_gdbinit (which is often used to augment the source search
1081 save_auto_load
= global_auto_load
;
1082 global_auto_load
= 0;
1086 && strcmp (execarg
, symarg
) == 0)
1088 /* The exec file and the symbol-file are the same. If we can't
1089 open it, better only print one error message.
1090 catch_command_errors returns non-zero on success! */
1091 ret
= catch_command_errors (exec_file_attach
, execarg
,
1094 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1095 symarg
, !batch_flag
);
1099 if (execarg
!= NULL
)
1100 ret
= catch_command_errors (exec_file_attach
, execarg
,
1103 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1104 symarg
, !batch_flag
);
1107 if (corearg
&& pidarg
)
1108 error (_("Can't attach to process and specify "
1109 "a core file at the same time."));
1111 if (corearg
!= NULL
)
1113 ret
= catch_command_errors (core_file_command
, corearg
,
1116 else if (pidarg
!= NULL
)
1118 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1120 else if (pid_or_core_arg
)
1122 /* The user specified 'gdb program pid' or gdb program core'.
1123 If pid_or_core_arg's first character is a digit, try attach
1124 first and then corefile. Otherwise try just corefile. */
1126 if (isdigit (pid_or_core_arg
[0]))
1128 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1131 ret
= catch_command_errors (core_file_command
,
1137 /* Can't be a pid, better be a corefile. */
1138 ret
= catch_command_errors (core_file_command
,
1145 set_inferior_io_terminal (ttyarg
);
1147 /* Error messages should no longer be distinguished with extra output. */
1148 warning_pre_print
= _("warning: ");
1150 /* Read the .gdbinit file in the current directory, *if* it isn't
1151 the same as the $HOME/.gdbinit file (it should exist, also). */
1152 if (!local_gdbinit
.empty ())
1154 auto_load_local_gdbinit_pathname
1155 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1157 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
1158 && file_is_auto_load_safe (local_gdbinit
.c_str (),
1159 _("auto-load: Loading .gdbinit "
1161 local_gdbinit
.c_str ()))
1163 auto_load_local_gdbinit_loaded
= 1;
1165 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1169 /* Now that all .gdbinit's have been read and all -d options have been
1170 processed, we can read any scripts mentioned in SYMARG.
1171 We wait until now because it is common to add to the source search
1172 path in local_gdbinit. */
1173 global_auto_load
= save_auto_load
;
1174 for (objfile
*objfile
: current_program_space
->objfiles ())
1175 load_auto_scripts_for_objfile (objfile
);
1177 /* Process '-x' and '-ex' options. */
1178 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1180 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1182 switch (cmdarg_p
.type
)
1185 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1188 case CMDARG_COMMAND
:
1189 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1195 /* Read in the old history after all the command files have been
1201 int error_status
= EXIT_FAILURE
;
1202 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1204 /* We have hit the end of the batch file. */
1205 quit_force (exit_arg
, 0);
1210 captured_main (void *data
)
1212 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1214 captured_main_1 (context
);
1216 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1217 moving this loop and the code found in captured_command_loop()
1218 into the command_loop() proper. The main thing holding back that
1219 change - SET_TOP_LEVEL() - has been eliminated. */
1224 captured_command_loop ();
1226 catch (const gdb_exception
&ex
)
1228 exception_print (gdb_stderr
, ex
);
1231 /* No exit -- exit is through quit_command. */
1235 gdb_main (struct captured_main_args
*args
)
1239 captured_main (args
);
1241 catch (const gdb_exception
&ex
)
1243 exception_print (gdb_stderr
, ex
);
1246 /* The only way to end up here is by an error (normal exit is
1247 handled by quit_force()), hence always return an error status. */
1252 /* Don't use *_filtered for printing help. We don't want to prompt
1253 for continue no matter how small the screen or how much we're going
1257 print_gdb_help (struct ui_file
*stream
)
1259 std::vector
<std::string
> system_gdbinit
;
1260 std::string home_gdbinit
;
1261 std::string local_gdbinit
;
1263 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1265 /* Note: The options in the list below are only approximately sorted
1266 in the alphabetical order, so as to group closely related options
1268 fputs_unfiltered (_("\
1269 This is the GNU debugger. Usage:\n\n\
1270 gdb [options] [executable-file [core-file or process-id]]\n\
1271 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1273 fputs_unfiltered (_("\
1274 Selection of debuggee and its files:\n\n\
1275 --args Arguments after executable-file are passed to inferior\n\
1276 --core=COREFILE Analyze the core dump COREFILE.\n\
1277 --exec=EXECFILE Use EXECFILE as the executable.\n\
1278 --pid=PID Attach to running process PID.\n\
1279 --directory=DIR Search for source files in DIR.\n\
1280 --se=FILE Use FILE as symbol file and executable file.\n\
1281 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1282 --readnow Fully read symbol files on first access.\n\
1283 --readnever Do not read symbol files.\n\
1284 --write Set writing into executable and core files.\n\n\
1286 fputs_unfiltered (_("\
1287 Initial commands and command files:\n\n\
1288 --command=FILE, -x Execute GDB commands from FILE.\n\
1289 --init-command=FILE, -ix\n\
1290 Like -x but execute commands before loading inferior.\n\
1291 --eval-command=COMMAND, -ex\n\
1292 Execute a single GDB command.\n\
1293 May be used multiple times and in conjunction\n\
1295 --init-eval-command=COMMAND, -iex\n\
1296 Like -ex but before loading inferior.\n\
1297 --nh Do not read ~/.gdbinit.\n\
1298 --nx Do not read any .gdbinit files in any directory.\n\n\
1300 fputs_unfiltered (_("\
1301 Output and user interface control:\n\n\
1302 --fullname Output information used by emacs-GDB interface.\n\
1303 --interpreter=INTERP\n\
1304 Select a specific interpreter / user interface\n\
1305 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1306 -w Use the GUI interface.\n\
1307 --nw Do not use the GUI interface.\n\
1310 fputs_unfiltered (_("\
1311 --tui Use a terminal user interface.\n\
1314 fputs_unfiltered (_("\
1315 --dbx DBX compatibility mode.\n\
1316 -q, --quiet, --silent\n\
1317 Do not print version number on startup.\n\n\
1319 fputs_unfiltered (_("\
1320 Operating modes:\n\n\
1321 --batch Exit after processing options.\n\
1322 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1323 --return-child-result\n\
1324 GDB exit code will be the child's exit code.\n\
1325 --configuration Print details about GDB configuration and then exit.\n\
1326 --help Print this message and then exit.\n\
1327 --version Print version information and then exit.\n\n\
1328 Remote debugging options:\n\n\
1329 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1330 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1332 --cd=DIR Change current directory to DIR.\n\
1333 --data-directory=DIR, -D\n\
1334 Set GDB's data-directory to DIR.\n\
1336 fputs_unfiltered (_("\n\
1337 At startup, GDB reads the following init files and executes their commands:\n\
1339 if (!system_gdbinit
.empty ())
1342 for (size_t idx
= 0; idx
< system_gdbinit
.size (); ++idx
)
1344 output
+= system_gdbinit
[idx
];
1345 if (idx
< system_gdbinit
.size () - 1)
1348 fprintf_unfiltered (stream
, _("\
1349 * system-wide init files: %s\n\
1350 "), output
.c_str ());
1352 if (!home_gdbinit
.empty ())
1353 fprintf_unfiltered (stream
, _("\
1354 * user-specific init file: %s\n\
1355 "), home_gdbinit
.c_str ());
1356 if (!local_gdbinit
.empty ())
1357 fprintf_unfiltered (stream
, _("\
1358 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1359 "), local_gdbinit
.c_str ());
1360 fputs_unfiltered (_("\n\
1361 For more information, type \"help\" from within GDB, or consult the\n\
1362 GDB manual (available as on-line info or a printed manual).\n\
1364 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1365 fprintf_unfiltered (stream
, _("\
1366 Report bugs to \"%s\".\n\
1367 "), REPORT_BUGS_TO
);