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 char *gdb_datadir
= 0;
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 char *python_libdir
= 0;
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
);
125 gdb_datadir
= gdb_realpath (new_datadir
).release ();
127 /* gdb_realpath won't return an absolute path if the path doesn't exist,
128 but we still want to record an absolute path here. If the user entered
129 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
130 isn't canonical, but that's ok. */
131 if (!IS_ABSOLUTE_PATH (gdb_datadir
))
133 gdb::unique_xmalloc_ptr
<char> abs_datadir
= gdb_abspath (gdb_datadir
);
136 gdb_datadir
= abs_datadir
.release ();
140 /* Relocate a file or directory. PROGNAME is the name by which gdb
141 was invoked (i.e., argv[0]). INITIAL is the default value for the
142 file or directory. RELOCATABLE is true if the value is relocatable,
143 false otherwise. Returns a newly allocated string; this may return
144 NULL under the same conditions as make_relative_prefix. */
147 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
150 return make_relative_prefix (progname
, BINDIR
, initial
);
151 return xstrdup (initial
);
154 /* Like relocate_path, but specifically checks for a directory.
155 INITIAL is relocated according to the rules of relocate_path. If
156 the result is a directory, it is used; otherwise, INITIAL is used.
157 The chosen directory is then canonicalized using lrealpath. This
158 function always returns a newly-allocated string. */
161 relocate_gdb_directory (const char *initial
, bool relocatable
)
165 dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
170 if (*dir
== '\0' || stat (dir
, &s
) != 0 || !S_ISDIR (s
.st_mode
))
177 dir
= xstrdup (initial
);
179 /* Canonicalize the directory. */
182 char *canon_sysroot
= lrealpath (dir
);
194 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
195 parameter if it is in the data dir, or passes it through relocate_path
199 relocate_gdbinit_path_maybe_in_datadir (const std::string
& file
)
201 size_t datadir_len
= strlen (GDB_DATADIR
);
203 std::string relocated_path
;
205 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
206 has been provided, search for SYSTEM_GDBINIT there. */
207 if (gdb_datadir_provided
208 && datadir_len
< file
.length ()
209 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
210 && IS_DIR_SEPARATOR (file
[datadir_len
]))
212 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
215 size_t start
= datadir_len
;
216 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
218 relocated_path
= (std::string (gdb_datadir
) + SLASH_STRING
219 + file
.substr (start
));
223 char *relocated
= relocate_path (gdb_program_name
,
225 SYSTEM_GDBINIT_RELOCATABLE
);
226 if (relocated
!= nullptr)
228 relocated_path
= relocated
;
232 return relocated_path
;
235 /* Compute the locations of init files that GDB should source and
236 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
237 there is no system gdbinit (resp. home gdbinit and local gdbinit)
238 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
239 LOCAL_GDBINIT) is set to the empty string. */
241 get_init_files (std::string
*system_gdbinit
,
242 std::string
*home_gdbinit
,
243 std::string
*local_gdbinit
)
245 static std::string sysgdbinit
;
246 static std::string homeinit
;
247 static std::string localinit
;
248 static int initialized
= 0;
252 struct stat homebuf
, cwdbuf
, s
;
254 if (SYSTEM_GDBINIT
[0])
256 std::string relocated_sysgdbinit
257 = relocate_gdbinit_path_maybe_in_datadir (SYSTEM_GDBINIT
);
258 if (!relocated_sysgdbinit
.empty ()
259 && stat (relocated_sysgdbinit
.c_str (), &s
) == 0)
260 sysgdbinit
= relocated_sysgdbinit
;
263 const char *homedir
= getenv ("HOME");
265 /* If the .gdbinit file in the current directory is the same as
266 the $HOME/.gdbinit file, it should not be sourced. homebuf
267 and cwdbuf are used in that purpose. Make sure that the stats
268 are zero in case one of them fails (this guarantees that they
269 won't match if either exists). */
271 memset (&homebuf
, 0, sizeof (struct stat
));
272 memset (&cwdbuf
, 0, sizeof (struct stat
));
276 homeinit
= std::string (homedir
) + SLASH_STRING
+ GDBINIT
;
277 if (stat (homeinit
.c_str (), &homebuf
) != 0)
283 if (stat (GDBINIT
, &cwdbuf
) == 0)
285 if (homeinit
.empty ()
286 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
287 sizeof (struct stat
)))
294 *system_gdbinit
= sysgdbinit
;
295 *home_gdbinit
= homeinit
;
296 *local_gdbinit
= localinit
;
299 /* Try to set up an alternate signal stack for SIGSEGV handlers.
300 This allows us to handle SIGSEGV signals generated when the
301 normal process stack is exhausted. If this stack is not set
302 up (sigaltstack is unavailable or fails) and a SIGSEGV is
303 generated when the normal stack is exhausted then the program
304 will behave as though no SIGSEGV handler was installed. */
307 setup_alternate_signal_stack (void)
309 #ifdef HAVE_SIGALTSTACK
312 /* FreeBSD versions older than 11.0 use char * for ss_sp instead of
313 void *. This cast works with both types. */
314 ss
.ss_sp
= (char *) xmalloc (SIGSTKSZ
);
315 ss
.ss_size
= SIGSTKSZ
;
318 sigaltstack(&ss
, NULL
);
322 /* Call command_loop. */
324 /* Prevent inlining this function for the benefit of GDB's selftests
325 in the testsuite. Those tests want to run GDB under GDB and stop
327 static void captured_command_loop () __attribute__((noinline
));
330 captured_command_loop ()
332 struct ui
*ui
= current_ui
;
334 /* Top-level execution commands can be run in the background from
336 current_ui
->async
= 1;
338 /* Give the interpreter a chance to print a prompt, if necessary */
339 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
340 interp_pre_command_loop (top_level_interpreter ());
342 /* Now it's time to start the event loop. */
345 /* If the command_loop returned, normally (rather than threw an
346 error) we try to quit. If the quit is aborted, our caller
347 catches the signal and restarts the command loop. */
348 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
351 /* Handle command errors thrown from within catch_command_errors. */
354 handle_command_errors (const struct gdb_exception
&e
)
358 exception_print (gdb_stderr
, e
);
360 /* If any exception escaped to here, we better enable stdin.
361 Otherwise, any command that calls async_disable_stdin, and
362 then throws, will leave stdin inoperable. */
363 async_enable_stdin ();
369 /* Type of the command callback passed to the const
370 catch_command_errors. */
372 typedef void (catch_command_errors_const_ftype
) (const char *, int);
374 /* Wrap calls to commands run before the event loop is started. */
377 catch_command_errors (catch_command_errors_const_ftype command
,
378 const char *arg
, int from_tty
)
382 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
384 command (arg
, from_tty
);
386 maybe_wait_sync_command_done (was_sync
);
388 catch (const gdb_exception
&e
)
390 return handle_command_errors (e
);
396 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
397 symfile_add_flags. */
400 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
402 symfile_add_flags add_flags
= 0;
405 add_flags
|= SYMFILE_VERBOSE
;
407 symbol_file_add_main (arg
, add_flags
);
410 /* Perform validation of the '--readnow' and '--readnever' flags. */
413 validate_readnow_readnever ()
415 if (readnever_symbol_files
&& readnow_symbol_files
)
417 error (_("%s: '--readnow' and '--readnever' cannot be "
418 "specified simultaneously"),
423 /* Type of this option. */
426 /* Option type -x. */
429 /* Option type -ex. */
432 /* Option type -ix. */
435 /* Option type -iex. */
439 /* Arguments of --command option and its counterpart. */
442 cmdarg (cmdarg_kind type_
, char *string_
)
443 : type (type_
), string (string_
)
446 /* Type of this option. */
447 enum cmdarg_kind type
;
449 /* Value of this option - filename or the GDB command itself. String memory
450 is not owned by this structure despite it is 'const'. */
455 captured_main_1 (struct captured_main_args
*context
)
457 int argc
= context
->argc
;
458 char **argv
= context
->argv
;
460 static int quiet
= 0;
461 static int set_args
= 0;
462 static int inhibit_home_gdbinit
= 0;
464 /* Pointers to various arguments from command line. */
466 char *execarg
= NULL
;
468 char *corearg
= NULL
;
469 char *pid_or_core_arg
= NULL
;
473 /* These are static so that we can take their address in an
475 static int print_help
;
476 static int print_version
;
477 static int print_configuration
;
479 /* Pointers to all arguments of --command option. */
480 std::vector
<struct cmdarg
> cmdarg_vec
;
482 /* All arguments of --directory option. */
483 std::vector
<char *> dirarg
;
489 #ifdef HAVE_USEFUL_SBRK
490 /* Set this before constructing scoped_command_stats. */
491 lim_at_start
= (char *) sbrk (0);
494 scoped_command_stats
stat_reporter (false);
496 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
497 setlocale (LC_MESSAGES
, "");
499 #if defined (HAVE_SETLOCALE)
500 setlocale (LC_CTYPE
, "");
503 bindtextdomain (PACKAGE
, LOCALEDIR
);
504 textdomain (PACKAGE
);
510 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
511 as a Windows pipe, and Windows buffers on pipes. */
512 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
515 /* Note: `error' cannot be called before this point, because the
516 caller will crash when trying to print the exception. */
517 main_ui
= new ui (stdin
, stdout
, stderr
);
518 current_ui
= main_ui
;
520 gdb_stdtargerr
= gdb_stderr
; /* for moment */
521 gdb_stdtargin
= gdb_stdin
; /* for moment */
523 if (bfd_init () != BFD_INIT_MAGIC
)
524 error (_("fatal error: libbfd ABI mismatch"));
527 /* On Windows, argv[0] is not necessarily set to absolute form when
528 GDB is found along PATH, without which relocation doesn't work. */
529 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
531 gdb_program_name
= xstrdup (argv
[0]);
534 /* Prefix warning messages with the command name. */
535 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
536 (xstrprintf ("%s: warning: ", gdb_program_name
));
537 warning_pre_print
= tmp_warn_preprint
.get ();
539 current_directory
= getcwd (NULL
, 0);
540 if (current_directory
== NULL
)
541 perror_warning_with_name (_("error finding working directory"));
543 /* Set the sysroot path. */
544 gdb_sysroot
= relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
545 TARGET_SYSTEM_ROOT_RELOCATABLE
);
547 if (gdb_sysroot
== NULL
|| *gdb_sysroot
== '\0')
550 gdb_sysroot
= xstrdup (TARGET_SYSROOT_PREFIX
);
553 debug_file_directory
= relocate_gdb_directory (DEBUGDIR
,
554 DEBUGDIR_RELOCATABLE
);
556 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
557 GDB_DATADIR_RELOCATABLE
);
559 #ifdef WITH_PYTHON_PATH
561 /* For later use in helping Python find itself. */
562 char *tmp
= concat (WITH_PYTHON_PATH
, SLASH_STRING
, "lib", (char *) NULL
);
564 python_libdir
= relocate_gdb_directory (tmp
, PYTHON_PATH_RELOCATABLE
);
570 add_substitute_path_rule (RELOC_SRCDIR
,
571 make_relative_prefix (gdb_program_name
, BINDIR
,
575 /* There will always be an interpreter. Either the one passed into
576 this captured main, or one specified by the user at start up, or
577 the console. Initialize the interpreter to the one requested by
579 interpreter_p
= xstrdup (context
->interpreter_p
);
581 /* Parse arguments and options. */
584 /* When var field is 0, use flag field to record the equivalent
585 short option (or arbitrary numbers starting at 10 for those
586 with no equivalent). */
600 static struct option long_options
[] =
602 {"tui", no_argument
, 0, OPT_TUI
},
603 {"dbx", no_argument
, &dbx_commands
, 1},
604 {"readnow", no_argument
, NULL
, OPT_READNOW
},
605 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
606 {"r", no_argument
, NULL
, OPT_READNOW
},
607 {"quiet", no_argument
, &quiet
, 1},
608 {"q", no_argument
, &quiet
, 1},
609 {"silent", no_argument
, &quiet
, 1},
610 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
611 {"nx", no_argument
, &inhibit_gdbinit
, 1},
612 {"n", no_argument
, &inhibit_gdbinit
, 1},
613 {"batch-silent", no_argument
, 0, 'B'},
614 {"batch", no_argument
, &batch_flag
, 1},
616 /* This is a synonym for "--annotate=1". --annotate is now
617 preferred, but keep this here for a long time because people
618 will be running emacses which use --fullname. */
619 {"fullname", no_argument
, 0, 'f'},
620 {"f", no_argument
, 0, 'f'},
622 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
623 {"help", no_argument
, &print_help
, 1},
624 {"se", required_argument
, 0, OPT_SE
},
625 {"symbols", required_argument
, 0, 's'},
626 {"s", required_argument
, 0, 's'},
627 {"exec", required_argument
, 0, 'e'},
628 {"e", required_argument
, 0, 'e'},
629 {"core", required_argument
, 0, 'c'},
630 {"c", required_argument
, 0, 'c'},
631 {"pid", required_argument
, 0, 'p'},
632 {"p", required_argument
, 0, 'p'},
633 {"command", required_argument
, 0, 'x'},
634 {"eval-command", required_argument
, 0, 'X'},
635 {"version", no_argument
, &print_version
, 1},
636 {"configuration", no_argument
, &print_configuration
, 1},
637 {"x", required_argument
, 0, 'x'},
638 {"ex", required_argument
, 0, 'X'},
639 {"init-command", required_argument
, 0, OPT_IX
},
640 {"init-eval-command", required_argument
, 0, OPT_IEX
},
641 {"ix", required_argument
, 0, OPT_IX
},
642 {"iex", required_argument
, 0, OPT_IEX
},
644 {"tclcommand", required_argument
, 0, 'z'},
645 {"enable-external-editor", no_argument
, 0, 'y'},
646 {"editor-command", required_argument
, 0, 'w'},
648 {"ui", required_argument
, 0, 'i'},
649 {"interpreter", required_argument
, 0, 'i'},
650 {"i", required_argument
, 0, 'i'},
651 {"directory", required_argument
, 0, 'd'},
652 {"d", required_argument
, 0, 'd'},
653 {"data-directory", required_argument
, 0, 'D'},
654 {"D", required_argument
, 0, 'D'},
655 {"cd", required_argument
, 0, OPT_CD
},
656 {"tty", required_argument
, 0, 't'},
657 {"baud", required_argument
, 0, 'b'},
658 {"b", required_argument
, 0, 'b'},
659 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
660 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
661 {"w", no_argument
, NULL
, OPT_WINDOWS
},
662 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
663 {"statistics", no_argument
, 0, OPT_STATISTICS
},
664 {"write", no_argument
, &write_files
, 1},
665 {"args", no_argument
, &set_args
, 1},
666 {"l", required_argument
, 0, 'l'},
667 {"return-child-result", no_argument
, &return_child_result
, 1},
668 {0, no_argument
, 0, 0}
675 c
= getopt_long_only (argc
, argv
, "",
676 long_options
, &option_index
);
677 if (c
== EOF
|| set_args
)
680 /* Long option that takes an argument. */
681 if (c
== 0 && long_options
[option_index
].flag
== 0)
682 c
= long_options
[option_index
].val
;
687 /* Long option that just sets a flag. */
697 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
698 annotation_level
= atoi (optarg
);
701 /* Enable the display of both time and space usage. */
702 set_per_command_time (1);
703 set_per_command_space (1);
706 /* --tui is equivalent to -i=tui. */
708 xfree (interpreter_p
);
709 interpreter_p
= xstrdup (INTERP_TUI
);
711 error (_("%s: TUI mode is not supported"), gdb_program_name
);
715 /* FIXME: cagney/2003-03-01: Not sure if this option is
716 actually useful, and if it is, what it should do. */
718 /* --windows is equivalent to -i=insight. */
719 xfree (interpreter_p
);
720 interpreter_p
= xstrdup (INTERP_INSIGHT
);
724 /* -nw is equivalent to -i=console. */
725 xfree (interpreter_p
);
726 interpreter_p
= xstrdup (INTERP_CONSOLE
);
729 annotation_level
= 1;
744 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
747 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
750 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
753 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
756 batch_flag
= batch_silent
= 1;
757 gdb_stdout
= new null_file ();
760 if (optarg
[0] == '\0')
761 error (_("%s: empty path for `--data-directory'"),
763 set_gdb_data_directory (optarg
);
764 gdb_datadir_provided
= 1;
769 extern int gdbtk_test (char *);
771 if (!gdbtk_test (optarg
))
772 error (_("%s: unable to load tclcommand file \"%s\""),
773 gdb_program_name
, optarg
);
777 /* Backwards compatibility only. */
781 /* Set the external editor commands when gdb is farming out files
782 to be edited by another program. */
783 extern char *external_editor_command
;
785 external_editor_command
= xstrdup (optarg
);
790 xfree (interpreter_p
);
791 interpreter_p
= xstrdup (optarg
);
794 dirarg
.push_back (optarg
);
807 rate
= strtol (optarg
, &p
, 0);
808 if (rate
== 0 && p
== optarg
)
809 warning (_("could not set baud rate to `%s'."),
820 timeout
= strtol (optarg
, &p
, 0);
821 if (timeout
== 0 && p
== optarg
)
822 warning (_("could not set timeout limit to `%s'."),
825 remote_timeout
= timeout
;
831 readnow_symbol_files
= 1;
832 validate_readnow_readnever ();
838 readnever_symbol_files
= 1;
839 validate_readnow_readnever ();
844 error (_("Use `%s --help' for a complete list of options."),
853 /* Disable all output styling when running in batch mode. */
858 save_original_signals_state (quiet
);
860 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
861 setup_alternate_signal_stack ();
863 /* Initialize all files. */
864 gdb_init (gdb_program_name
);
866 /* Now that gdb_init has created the initial inferior, we're in
867 position to set args for that inferior. */
870 /* The remaining options are the command-line options for the
871 inferior. The first one is the sym/exec file, and the rest
874 error (_("%s: `--args' specified but no program specified"),
877 symarg
= argv
[optind
];
878 execarg
= argv
[optind
];
880 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
884 /* OK, that's all the options. */
886 /* The first argument, if specified, is the name of the
890 symarg
= argv
[optind
];
891 execarg
= argv
[optind
];
895 /* If the user hasn't already specified a PID or the name of a
896 core file, then a second optional argument is allowed. If
897 present, this argument should be interpreted as either a
898 PID or a core file, whichever works. */
899 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
901 pid_or_core_arg
= argv
[optind
];
905 /* Any argument left on the command line is unexpected and
906 will be ignored. Inform the user. */
908 fprintf_unfiltered (gdb_stderr
,
909 _("Excess command line "
910 "arguments ignored. (%s%s)\n"),
912 (optind
== argc
- 1) ? "" : " ...");
915 /* Lookup gdbinit files. Note that the gdbinit file name may be
916 overriden during file initialization, so get_init_files should be
917 called after gdb_init. */
918 std::string system_gdbinit
;
919 std::string home_gdbinit
;
920 std::string local_gdbinit
;
921 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
923 /* Do these (and anything which might call wrap_here or *_filtered)
924 after initialize_all_files() but before the interpreter has been
925 installed. Otherwize the help/version messages will be eaten by
926 the interpreter's output handler. */
930 print_gdb_version (gdb_stdout
, false);
932 printf_filtered ("\n");
938 print_gdb_help (gdb_stdout
);
939 fputs_unfiltered ("\n", gdb_stdout
);
943 if (print_configuration
)
945 print_gdb_configuration (gdb_stdout
);
947 printf_filtered ("\n");
951 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
952 GDB retain the old MI1 interpreter startup behavior. Output the
953 copyright message before the interpreter is installed. That way
954 it isn't encapsulated in MI output. */
955 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
957 /* Print all the junk at the top, with trailing "..." if we are
958 about to read a symbol file (possibly slowly). */
959 print_gdb_version (gdb_stdout
, true);
961 printf_filtered ("..");
963 printf_filtered ("\n");
964 gdb_flush (gdb_stdout
); /* Force to screen during slow
968 /* Install the default UI. All the interpreters should have had a
969 look at things by now. Initialize the default interpreter. */
970 set_top_level_interpreter (interpreter_p
);
972 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
973 GDB retain the old MI1 interpreter startup behavior. Output the
974 copyright message after the interpreter is installed when it is
975 any sane interpreter. */
976 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
978 /* Print all the junk at the top, with trailing "..." if we are
979 about to read a symbol file (possibly slowly). */
980 print_gdb_version (gdb_stdout
, true);
982 printf_filtered ("..");
984 printf_filtered ("\n");
985 gdb_flush (gdb_stdout
); /* Force to screen during slow
989 /* Set off error and warning messages with a blank line. */
990 tmp_warn_preprint
.reset ();
991 warning_pre_print
= _("\nwarning: ");
993 /* Read and execute the system-wide gdbinit file, if it exists.
994 This is done *before* all the command line arguments are
995 processed; it sets global parameters, which are independent of
996 what file you are debugging or what directory you are in. */
997 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
998 ret
= catch_command_errors (source_script
, system_gdbinit
.c_str (), 0);
1000 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
1001 *before* all the command line arguments are processed; it sets
1002 global parameters, which are independent of what file you are
1003 debugging or what directory you are in. */
1005 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1006 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1008 /* Process '-ix' and '-iex' options early. */
1009 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1011 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1013 switch (cmdarg_p
.type
)
1015 case CMDARG_INIT_FILE
:
1016 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1019 case CMDARG_INIT_COMMAND
:
1020 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1026 /* Now perform all the actions indicated by the arguments. */
1029 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1032 for (i
= 0; i
< dirarg
.size (); i
++)
1033 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1035 /* Skip auto-loading section-specified scripts until we've sourced
1036 local_gdbinit (which is often used to augment the source search
1038 save_auto_load
= global_auto_load
;
1039 global_auto_load
= 0;
1043 && strcmp (execarg
, symarg
) == 0)
1045 /* The exec file and the symbol-file are the same. If we can't
1046 open it, better only print one error message.
1047 catch_command_errors returns non-zero on success! */
1048 ret
= catch_command_errors (exec_file_attach
, execarg
,
1051 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1052 symarg
, !batch_flag
);
1056 if (execarg
!= NULL
)
1057 ret
= catch_command_errors (exec_file_attach
, execarg
,
1060 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1061 symarg
, !batch_flag
);
1064 if (corearg
&& pidarg
)
1065 error (_("Can't attach to process and specify "
1066 "a core file at the same time."));
1068 if (corearg
!= NULL
)
1070 ret
= catch_command_errors (core_file_command
, corearg
,
1073 else if (pidarg
!= NULL
)
1075 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1077 else if (pid_or_core_arg
)
1079 /* The user specified 'gdb program pid' or gdb program core'.
1080 If pid_or_core_arg's first character is a digit, try attach
1081 first and then corefile. Otherwise try just corefile. */
1083 if (isdigit (pid_or_core_arg
[0]))
1085 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1088 ret
= catch_command_errors (core_file_command
,
1094 /* Can't be a pid, better be a corefile. */
1095 ret
= catch_command_errors (core_file_command
,
1102 set_inferior_io_terminal (ttyarg
);
1104 /* Error messages should no longer be distinguished with extra output. */
1105 warning_pre_print
= _("warning: ");
1107 /* Read the .gdbinit file in the current directory, *if* it isn't
1108 the same as the $HOME/.gdbinit file (it should exist, also). */
1109 if (!local_gdbinit
.empty ())
1111 auto_load_local_gdbinit_pathname
1112 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1114 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
1115 && file_is_auto_load_safe (local_gdbinit
.c_str (),
1116 _("auto-load: Loading .gdbinit "
1118 local_gdbinit
.c_str ()))
1120 auto_load_local_gdbinit_loaded
= 1;
1122 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1126 /* Now that all .gdbinit's have been read and all -d options have been
1127 processed, we can read any scripts mentioned in SYMARG.
1128 We wait until now because it is common to add to the source search
1129 path in local_gdbinit. */
1130 global_auto_load
= save_auto_load
;
1131 for (objfile
*objfile
: current_program_space
->objfiles ())
1132 load_auto_scripts_for_objfile (objfile
);
1134 /* Process '-x' and '-ex' options. */
1135 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1137 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1139 switch (cmdarg_p
.type
)
1142 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1145 case CMDARG_COMMAND
:
1146 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1152 /* Read in the old history after all the command files have been
1158 int error_status
= EXIT_FAILURE
;
1159 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1161 /* We have hit the end of the batch file. */
1162 quit_force (exit_arg
, 0);
1167 captured_main (void *data
)
1169 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1171 captured_main_1 (context
);
1173 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1174 moving this loop and the code found in captured_command_loop()
1175 into the command_loop() proper. The main thing holding back that
1176 change - SET_TOP_LEVEL() - has been eliminated. */
1181 captured_command_loop ();
1183 catch (const gdb_exception
&ex
)
1185 exception_print (gdb_stderr
, ex
);
1188 /* No exit -- exit is through quit_command. */
1192 gdb_main (struct captured_main_args
*args
)
1196 captured_main (args
);
1198 catch (const gdb_exception
&ex
)
1200 exception_print (gdb_stderr
, ex
);
1203 /* The only way to end up here is by an error (normal exit is
1204 handled by quit_force()), hence always return an error status. */
1209 /* Don't use *_filtered for printing help. We don't want to prompt
1210 for continue no matter how small the screen or how much we're going
1214 print_gdb_help (struct ui_file
*stream
)
1216 std::string system_gdbinit
;
1217 std::string home_gdbinit
;
1218 std::string local_gdbinit
;
1220 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1222 /* Note: The options in the list below are only approximately sorted
1223 in the alphabetical order, so as to group closely related options
1225 fputs_unfiltered (_("\
1226 This is the GNU debugger. Usage:\n\n\
1227 gdb [options] [executable-file [core-file or process-id]]\n\
1228 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1230 fputs_unfiltered (_("\
1231 Selection of debuggee and its files:\n\n\
1232 --args Arguments after executable-file are passed to inferior\n\
1233 --core=COREFILE Analyze the core dump COREFILE.\n\
1234 --exec=EXECFILE Use EXECFILE as the executable.\n\
1235 --pid=PID Attach to running process PID.\n\
1236 --directory=DIR Search for source files in DIR.\n\
1237 --se=FILE Use FILE as symbol file and executable file.\n\
1238 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1239 --readnow Fully read symbol files on first access.\n\
1240 --readnever Do not read symbol files.\n\
1241 --write Set writing into executable and core files.\n\n\
1243 fputs_unfiltered (_("\
1244 Initial commands and command files:\n\n\
1245 --command=FILE, -x Execute GDB commands from FILE.\n\
1246 --init-command=FILE, -ix\n\
1247 Like -x but execute commands before loading inferior.\n\
1248 --eval-command=COMMAND, -ex\n\
1249 Execute a single GDB command.\n\
1250 May be used multiple times and in conjunction\n\
1252 --init-eval-command=COMMAND, -iex\n\
1253 Like -ex but before loading inferior.\n\
1254 --nh Do not read ~/.gdbinit.\n\
1255 --nx Do not read any .gdbinit files in any directory.\n\n\
1257 fputs_unfiltered (_("\
1258 Output and user interface control:\n\n\
1259 --fullname Output information used by emacs-GDB interface.\n\
1260 --interpreter=INTERP\n\
1261 Select a specific interpreter / user interface\n\
1262 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1263 -w Use the GUI interface.\n\
1264 --nw Do not use the GUI interface.\n\
1267 fputs_unfiltered (_("\
1268 --tui Use a terminal user interface.\n\
1271 fputs_unfiltered (_("\
1272 --dbx DBX compatibility mode.\n\
1273 -q, --quiet, --silent\n\
1274 Do not print version number on startup.\n\n\
1276 fputs_unfiltered (_("\
1277 Operating modes:\n\n\
1278 --batch Exit after processing options.\n\
1279 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1280 --return-child-result\n\
1281 GDB exit code will be the child's exit code.\n\
1282 --configuration Print details about GDB configuration and then exit.\n\
1283 --help Print this message and then exit.\n\
1284 --version Print version information and then exit.\n\n\
1285 Remote debugging options:\n\n\
1286 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1287 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1289 --cd=DIR Change current directory to DIR.\n\
1290 --data-directory=DIR, -D\n\
1291 Set GDB's data-directory to DIR.\n\
1293 fputs_unfiltered (_("\n\
1294 At startup, GDB reads the following init files and executes their commands:\n\
1296 if (!system_gdbinit
.empty ())
1297 fprintf_unfiltered (stream
, _("\
1298 * system-wide init file: %s\n\
1299 "), system_gdbinit
.c_str ());
1300 if (!home_gdbinit
.empty ())
1301 fprintf_unfiltered (stream
, _("\
1302 * user-specific init file: %s\n\
1303 "), home_gdbinit
.c_str ());
1304 if (!local_gdbinit
.empty ())
1305 fprintf_unfiltered (stream
, _("\
1306 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1307 "), local_gdbinit
.c_str ());
1308 fputs_unfiltered (_("\n\
1309 For more information, type \"help\" from within GDB, or consult the\n\
1310 GDB manual (available as on-line info or a printed manual).\n\
1312 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1313 fprintf_unfiltered (stream
, _("\
1314 Report bugs to \"%s\".\n\
1315 "), REPORT_BUGS_TO
);