1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 #include <sys/types.h>
31 #include "event-loop.h"
37 #include "cli/cli-cmds.h"
39 #include "auto-load.h"
42 #include "filenames.h"
43 #include "common/filestuff.h"
45 #include "event-top.h"
47 #include "common/signals-state-save-restore.h"
49 #include "common/pathstuff.h"
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. FLAG is true if the value is relocatable, false
143 otherwise. Returns a newly allocated string; this may return NULL
144 under the same conditions as make_relative_prefix. */
147 relocate_path (const char *progname
, const char *initial
, int flag
)
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
, int flag
)
165 dir
= relocate_path (gdb_program_name
, initial
, flag
);
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 /* Compute the locations of init files that GDB should source and
195 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
196 there is no system gdbinit (resp. home gdbinit and local gdbinit)
197 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
198 LOCAL_GDBINIT) is set to NULL. */
200 get_init_files (const char **system_gdbinit
,
201 const char **home_gdbinit
,
202 const char **local_gdbinit
)
204 static const char *sysgdbinit
= NULL
;
205 static char *homeinit
= NULL
;
206 static const char *localinit
= NULL
;
207 static int initialized
= 0;
211 struct stat homebuf
, cwdbuf
, s
;
214 if (SYSTEM_GDBINIT
[0])
216 int datadir_len
= strlen (GDB_DATADIR
);
217 int sys_gdbinit_len
= strlen (SYSTEM_GDBINIT
);
218 char *relocated_sysgdbinit
;
220 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
221 has been provided, search for SYSTEM_GDBINIT there. */
222 if (gdb_datadir_provided
223 && datadir_len
< sys_gdbinit_len
224 && filename_ncmp (SYSTEM_GDBINIT
, GDB_DATADIR
, datadir_len
) == 0
225 && IS_DIR_SEPARATOR (SYSTEM_GDBINIT
[datadir_len
]))
227 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
229 char *tmp_sys_gdbinit
= xstrdup (&SYSTEM_GDBINIT
[datadir_len
]);
232 for (p
= tmp_sys_gdbinit
; IS_DIR_SEPARATOR (*p
); ++p
)
234 relocated_sysgdbinit
= concat (gdb_datadir
, SLASH_STRING
, p
,
236 xfree (tmp_sys_gdbinit
);
240 relocated_sysgdbinit
= relocate_path (gdb_program_name
,
242 SYSTEM_GDBINIT_RELOCATABLE
);
244 if (relocated_sysgdbinit
&& stat (relocated_sysgdbinit
, &s
) == 0)
245 sysgdbinit
= relocated_sysgdbinit
;
247 xfree (relocated_sysgdbinit
);
250 homedir
= getenv ("HOME");
252 /* If the .gdbinit file in the current directory is the same as
253 the $HOME/.gdbinit file, it should not be sourced. homebuf
254 and cwdbuf are used in that purpose. Make sure that the stats
255 are zero in case one of them fails (this guarantees that they
256 won't match if either exists). */
258 memset (&homebuf
, 0, sizeof (struct stat
));
259 memset (&cwdbuf
, 0, sizeof (struct stat
));
263 homeinit
= xstrprintf ("%s/%s", homedir
, gdbinit
);
264 if (stat (homeinit
, &homebuf
) != 0)
271 if (stat (gdbinit
, &cwdbuf
) == 0)
274 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
275 sizeof (struct stat
)))
282 *system_gdbinit
= sysgdbinit
;
283 *home_gdbinit
= homeinit
;
284 *local_gdbinit
= localinit
;
287 /* Try to set up an alternate signal stack for SIGSEGV handlers.
288 This allows us to handle SIGSEGV signals generated when the
289 normal process stack is exhausted. If this stack is not set
290 up (sigaltstack is unavailable or fails) and a SIGSEGV is
291 generated when the normal stack is exhausted then the program
292 will behave as though no SIGSEGV handler was installed. */
295 setup_alternate_signal_stack (void)
297 #ifdef HAVE_SIGALTSTACK
300 /* FreeBSD versions older than 11.0 use char * for ss_sp instead of
301 void *. This cast works with both types. */
302 ss
.ss_sp
= (char *) xmalloc (SIGSTKSZ
);
303 ss
.ss_size
= SIGSTKSZ
;
306 sigaltstack(&ss
, NULL
);
310 /* Call command_loop. */
312 /* Prevent inlining this function for the benefit of GDB's selftests
313 in the testsuite. Those tests want to run GDB under GDB and stop
315 static void captured_command_loop () __attribute__((noinline
));
318 captured_command_loop ()
320 struct ui
*ui
= current_ui
;
322 /* Top-level execution commands can be run in the background from
324 current_ui
->async
= 1;
326 /* Give the interpreter a chance to print a prompt, if necessary */
327 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
328 interp_pre_command_loop (top_level_interpreter ());
330 /* Now it's time to start the event loop. */
333 /* If the command_loop returned, normally (rather than threw an
334 error) we try to quit. If the quit is aborted, our caller
335 catches the signal and restarts the command loop. */
336 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
339 /* Handle command errors thrown from within catch_command_errors. */
342 handle_command_errors (struct gdb_exception e
)
346 exception_print (gdb_stderr
, e
);
348 /* If any exception escaped to here, we better enable stdin.
349 Otherwise, any command that calls async_disable_stdin, and
350 then throws, will leave stdin inoperable. */
351 async_enable_stdin ();
357 /* Type of the command callback passed to the const
358 catch_command_errors. */
360 typedef void (catch_command_errors_const_ftype
) (const char *, int);
362 /* Wrap calls to commands run before the event loop is started. */
365 catch_command_errors (catch_command_errors_const_ftype command
,
366 const char *arg
, int from_tty
)
370 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
372 command (arg
, from_tty
);
374 maybe_wait_sync_command_done (was_sync
);
376 CATCH (e
, RETURN_MASK_ALL
)
378 return handle_command_errors (e
);
385 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
386 symfile_add_flags. */
389 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
391 symfile_add_flags add_flags
= 0;
394 add_flags
|= SYMFILE_VERBOSE
;
396 symbol_file_add_main (arg
, add_flags
);
399 /* Perform validation of the '--readnow' and '--readnever' flags. */
402 validate_readnow_readnever ()
404 if (readnever_symbol_files
&& readnow_symbol_files
)
406 error (_("%s: '--readnow' and '--readnever' cannot be "
407 "specified simultaneously"),
412 /* Type of this option. */
415 /* Option type -x. */
418 /* Option type -ex. */
421 /* Option type -ix. */
424 /* Option type -iex. */
428 /* Arguments of --command option and its counterpart. */
431 cmdarg (cmdarg_kind type_
, char *string_
)
432 : type (type_
), string (string_
)
435 /* Type of this option. */
436 enum cmdarg_kind type
;
438 /* Value of this option - filename or the GDB command itself. String memory
439 is not owned by this structure despite it is 'const'. */
444 captured_main_1 (struct captured_main_args
*context
)
446 int argc
= context
->argc
;
447 char **argv
= context
->argv
;
449 static int quiet
= 0;
450 static int set_args
= 0;
451 static int inhibit_home_gdbinit
= 0;
453 /* Pointers to various arguments from command line. */
455 char *execarg
= NULL
;
457 char *corearg
= NULL
;
458 char *pid_or_core_arg
= NULL
;
462 /* These are static so that we can take their address in an
464 static int print_help
;
465 static int print_version
;
466 static int print_configuration
;
468 /* Pointers to all arguments of --command option. */
469 std::vector
<struct cmdarg
> cmdarg_vec
;
471 /* All arguments of --directory option. */
472 std::vector
<char *> dirarg
;
474 /* gdb init files. */
475 const char *system_gdbinit
;
476 const char *home_gdbinit
;
477 const char *local_gdbinit
;
483 #ifdef HAVE_USEFUL_SBRK
484 /* Set this before constructing scoped_command_stats. */
485 lim_at_start
= (char *) sbrk (0);
488 scoped_command_stats
stat_reporter (false);
490 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
491 setlocale (LC_MESSAGES
, "");
493 #if defined (HAVE_SETLOCALE)
494 setlocale (LC_CTYPE
, "");
497 bindtextdomain (PACKAGE
, LOCALEDIR
);
498 textdomain (PACKAGE
);
503 saved_command_line
= (char *) xstrdup ("");
506 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
507 as a Windows pipe, and Windows buffers on pipes. */
508 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
511 /* Note: `error' cannot be called before this point, because the
512 caller will crash when trying to print the exception. */
513 main_ui
= new ui (stdin
, stdout
, stderr
);
514 current_ui
= main_ui
;
516 gdb_stdtargerr
= gdb_stderr
; /* for moment */
517 gdb_stdtargin
= gdb_stdin
; /* for moment */
519 if (bfd_init () != BFD_INIT_MAGIC
)
520 error (_("fatal error: libbfd ABI mismatch"));
523 /* On Windows, argv[0] is not necessarily set to absolute form when
524 GDB is found along PATH, without which relocation doesn't work. */
525 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
527 gdb_program_name
= xstrdup (argv
[0]);
530 /* Prefix warning messages with the command name. */
531 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
532 (xstrprintf ("%s: warning: ", gdb_program_name
));
533 warning_pre_print
= tmp_warn_preprint
.get ();
535 current_directory
= getcwd (NULL
, 0);
536 if (current_directory
== NULL
)
537 perror_warning_with_name (_("error finding working directory"));
539 /* Set the sysroot path. */
540 gdb_sysroot
= relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
541 TARGET_SYSTEM_ROOT_RELOCATABLE
);
543 if (gdb_sysroot
== NULL
|| *gdb_sysroot
== '\0')
546 gdb_sysroot
= xstrdup (TARGET_SYSROOT_PREFIX
);
549 debug_file_directory
= relocate_gdb_directory (DEBUGDIR
,
550 DEBUGDIR_RELOCATABLE
);
552 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
553 GDB_DATADIR_RELOCATABLE
);
555 #ifdef WITH_PYTHON_PATH
557 /* For later use in helping Python find itself. */
558 char *tmp
= concat (WITH_PYTHON_PATH
, SLASH_STRING
, "lib", (char *) NULL
);
560 python_libdir
= relocate_gdb_directory (tmp
, PYTHON_PATH_RELOCATABLE
);
566 add_substitute_path_rule (RELOC_SRCDIR
,
567 make_relative_prefix (gdb_program_name
, BINDIR
,
571 /* There will always be an interpreter. Either the one passed into
572 this captured main, or one specified by the user at start up, or
573 the console. Initialize the interpreter to the one requested by
575 interpreter_p
= xstrdup (context
->interpreter_p
);
577 /* Parse arguments and options. */
580 /* When var field is 0, use flag field to record the equivalent
581 short option (or arbitrary numbers starting at 10 for those
582 with no equivalent). */
596 static struct option long_options
[] =
598 {"tui", no_argument
, 0, OPT_TUI
},
599 {"dbx", no_argument
, &dbx_commands
, 1},
600 {"readnow", no_argument
, NULL
, OPT_READNOW
},
601 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
602 {"r", no_argument
, NULL
, OPT_READNOW
},
603 {"quiet", no_argument
, &quiet
, 1},
604 {"q", no_argument
, &quiet
, 1},
605 {"silent", no_argument
, &quiet
, 1},
606 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
607 {"nx", no_argument
, &inhibit_gdbinit
, 1},
608 {"n", no_argument
, &inhibit_gdbinit
, 1},
609 {"batch-silent", no_argument
, 0, 'B'},
610 {"batch", no_argument
, &batch_flag
, 1},
612 /* This is a synonym for "--annotate=1". --annotate is now
613 preferred, but keep this here for a long time because people
614 will be running emacses which use --fullname. */
615 {"fullname", no_argument
, 0, 'f'},
616 {"f", no_argument
, 0, 'f'},
618 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
619 {"help", no_argument
, &print_help
, 1},
620 {"se", required_argument
, 0, OPT_SE
},
621 {"symbols", required_argument
, 0, 's'},
622 {"s", required_argument
, 0, 's'},
623 {"exec", required_argument
, 0, 'e'},
624 {"e", required_argument
, 0, 'e'},
625 {"core", required_argument
, 0, 'c'},
626 {"c", required_argument
, 0, 'c'},
627 {"pid", required_argument
, 0, 'p'},
628 {"p", required_argument
, 0, 'p'},
629 {"command", required_argument
, 0, 'x'},
630 {"eval-command", required_argument
, 0, 'X'},
631 {"version", no_argument
, &print_version
, 1},
632 {"configuration", no_argument
, &print_configuration
, 1},
633 {"x", required_argument
, 0, 'x'},
634 {"ex", required_argument
, 0, 'X'},
635 {"init-command", required_argument
, 0, OPT_IX
},
636 {"init-eval-command", required_argument
, 0, OPT_IEX
},
637 {"ix", required_argument
, 0, OPT_IX
},
638 {"iex", required_argument
, 0, OPT_IEX
},
640 {"tclcommand", required_argument
, 0, 'z'},
641 {"enable-external-editor", no_argument
, 0, 'y'},
642 {"editor-command", required_argument
, 0, 'w'},
644 {"ui", required_argument
, 0, 'i'},
645 {"interpreter", required_argument
, 0, 'i'},
646 {"i", required_argument
, 0, 'i'},
647 {"directory", required_argument
, 0, 'd'},
648 {"d", required_argument
, 0, 'd'},
649 {"data-directory", required_argument
, 0, 'D'},
650 {"D", required_argument
, 0, 'D'},
651 {"cd", required_argument
, 0, OPT_CD
},
652 {"tty", required_argument
, 0, 't'},
653 {"baud", required_argument
, 0, 'b'},
654 {"b", required_argument
, 0, 'b'},
655 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
656 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
657 {"w", no_argument
, NULL
, OPT_WINDOWS
},
658 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
659 {"statistics", no_argument
, 0, OPT_STATISTICS
},
660 {"write", no_argument
, &write_files
, 1},
661 {"args", no_argument
, &set_args
, 1},
662 {"l", required_argument
, 0, 'l'},
663 {"return-child-result", no_argument
, &return_child_result
, 1},
664 {0, no_argument
, 0, 0}
671 c
= getopt_long_only (argc
, argv
, "",
672 long_options
, &option_index
);
673 if (c
== EOF
|| set_args
)
676 /* Long option that takes an argument. */
677 if (c
== 0 && long_options
[option_index
].flag
== 0)
678 c
= long_options
[option_index
].val
;
683 /* Long option that just sets a flag. */
693 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
694 annotation_level
= atoi (optarg
);
697 /* Enable the display of both time and space usage. */
698 set_per_command_time (1);
699 set_per_command_space (1);
702 /* --tui is equivalent to -i=tui. */
704 xfree (interpreter_p
);
705 interpreter_p
= xstrdup (INTERP_TUI
);
707 error (_("%s: TUI mode is not supported"), gdb_program_name
);
711 /* FIXME: cagney/2003-03-01: Not sure if this option is
712 actually useful, and if it is, what it should do. */
714 /* --windows is equivalent to -i=insight. */
715 xfree (interpreter_p
);
716 interpreter_p
= xstrdup (INTERP_INSIGHT
);
720 /* -nw is equivalent to -i=console. */
721 xfree (interpreter_p
);
722 interpreter_p
= xstrdup (INTERP_CONSOLE
);
725 annotation_level
= 1;
740 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
743 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
746 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
749 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
752 batch_flag
= batch_silent
= 1;
753 gdb_stdout
= new null_file ();
756 if (optarg
[0] == '\0')
757 error (_("%s: empty path for `--data-directory'"),
759 set_gdb_data_directory (optarg
);
760 gdb_datadir_provided
= 1;
765 extern int gdbtk_test (char *);
767 if (!gdbtk_test (optarg
))
768 error (_("%s: unable to load tclcommand file \"%s\""),
769 gdb_program_name
, optarg
);
773 /* Backwards compatibility only. */
777 /* Set the external editor commands when gdb is farming out files
778 to be edited by another program. */
779 extern char *external_editor_command
;
781 external_editor_command
= xstrdup (optarg
);
786 xfree (interpreter_p
);
787 interpreter_p
= xstrdup (optarg
);
790 dirarg
.push_back (optarg
);
803 rate
= strtol (optarg
, &p
, 0);
804 if (rate
== 0 && p
== optarg
)
805 warning (_("could not set baud rate to `%s'."),
816 timeout
= strtol (optarg
, &p
, 0);
817 if (timeout
== 0 && p
== optarg
)
818 warning (_("could not set timeout limit to `%s'."),
821 remote_timeout
= timeout
;
827 readnow_symbol_files
= 1;
828 validate_readnow_readnever ();
834 readnever_symbol_files
= 1;
835 validate_readnow_readnever ();
840 error (_("Use `%s --help' for a complete list of options."),
849 /* Disable all output styling when running in batch mode. */
854 save_original_signals_state (quiet
);
856 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
857 setup_alternate_signal_stack ();
859 /* Initialize all files. */
860 gdb_init (gdb_program_name
);
862 /* Now that gdb_init has created the initial inferior, we're in
863 position to set args for that inferior. */
866 /* The remaining options are the command-line options for the
867 inferior. The first one is the sym/exec file, and the rest
870 error (_("%s: `--args' specified but no program specified"),
873 symarg
= argv
[optind
];
874 execarg
= argv
[optind
];
876 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
880 /* OK, that's all the options. */
882 /* The first argument, if specified, is the name of the
886 symarg
= argv
[optind
];
887 execarg
= argv
[optind
];
891 /* If the user hasn't already specified a PID or the name of a
892 core file, then a second optional argument is allowed. If
893 present, this argument should be interpreted as either a
894 PID or a core file, whichever works. */
895 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
897 pid_or_core_arg
= argv
[optind
];
901 /* Any argument left on the command line is unexpected and
902 will be ignored. Inform the user. */
904 fprintf_unfiltered (gdb_stderr
,
905 _("Excess command line "
906 "arguments ignored. (%s%s)\n"),
908 (optind
== argc
- 1) ? "" : " ...");
911 /* Lookup gdbinit files. Note that the gdbinit file name may be
912 overriden during file initialization, so get_init_files should be
913 called after gdb_init. */
914 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
916 /* Do these (and anything which might call wrap_here or *_filtered)
917 after initialize_all_files() but before the interpreter has been
918 installed. Otherwize the help/version messages will be eaten by
919 the interpreter's output handler. */
923 print_gdb_version (gdb_stdout
, false);
925 printf_filtered ("\n");
931 print_gdb_help (gdb_stdout
);
932 fputs_unfiltered ("\n", gdb_stdout
);
936 if (print_configuration
)
938 print_gdb_configuration (gdb_stdout
);
940 printf_filtered ("\n");
944 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
945 GDB retain the old MI1 interpreter startup behavior. Output the
946 copyright message before the interpreter is installed. That way
947 it isn't encapsulated in MI output. */
948 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
950 /* Print all the junk at the top, with trailing "..." if we are
951 about to read a symbol file (possibly slowly). */
952 print_gdb_version (gdb_stdout
, true);
954 printf_filtered ("..");
956 printf_filtered ("\n");
957 gdb_flush (gdb_stdout
); /* Force to screen during slow
961 /* Install the default UI. All the interpreters should have had a
962 look at things by now. Initialize the default interpreter. */
963 set_top_level_interpreter (interpreter_p
);
965 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
966 GDB retain the old MI1 interpreter startup behavior. Output the
967 copyright message after the interpreter is installed when it is
968 any sane interpreter. */
969 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
971 /* Print all the junk at the top, with trailing "..." if we are
972 about to read a symbol file (possibly slowly). */
973 print_gdb_version (gdb_stdout
, true);
975 printf_filtered ("..");
977 printf_filtered ("\n");
978 gdb_flush (gdb_stdout
); /* Force to screen during slow
982 /* Set off error and warning messages with a blank line. */
983 tmp_warn_preprint
.reset ();
984 warning_pre_print
= _("\nwarning: ");
986 /* Read and execute the system-wide gdbinit file, if it exists.
987 This is done *before* all the command line arguments are
988 processed; it sets global parameters, which are independent of
989 what file you are debugging or what directory you are in. */
990 if (system_gdbinit
&& !inhibit_gdbinit
)
991 ret
= catch_command_errors (source_script
, system_gdbinit
, 0);
993 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
994 *before* all the command line arguments are processed; it sets
995 global parameters, which are independent of what file you are
996 debugging or what directory you are in. */
998 if (home_gdbinit
&& !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
999 ret
= catch_command_errors (source_script
, home_gdbinit
, 0);
1001 /* Process '-ix' and '-iex' options early. */
1002 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1004 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1006 switch (cmdarg_p
.type
)
1008 case CMDARG_INIT_FILE
:
1009 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1012 case CMDARG_INIT_COMMAND
:
1013 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1019 /* Now perform all the actions indicated by the arguments. */
1022 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1025 for (i
= 0; i
< dirarg
.size (); i
++)
1026 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1028 /* Skip auto-loading section-specified scripts until we've sourced
1029 local_gdbinit (which is often used to augment the source search
1031 save_auto_load
= global_auto_load
;
1032 global_auto_load
= 0;
1036 && strcmp (execarg
, symarg
) == 0)
1038 /* The exec file and the symbol-file are the same. If we can't
1039 open it, better only print one error message.
1040 catch_command_errors returns non-zero on success! */
1041 ret
= catch_command_errors (exec_file_attach
, execarg
,
1044 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1045 symarg
, !batch_flag
);
1049 if (execarg
!= NULL
)
1050 ret
= catch_command_errors (exec_file_attach
, execarg
,
1053 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1054 symarg
, !batch_flag
);
1057 if (corearg
&& pidarg
)
1058 error (_("Can't attach to process and specify "
1059 "a core file at the same time."));
1061 if (corearg
!= NULL
)
1063 ret
= catch_command_errors (core_file_command
, corearg
,
1066 else if (pidarg
!= NULL
)
1068 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1070 else if (pid_or_core_arg
)
1072 /* The user specified 'gdb program pid' or gdb program core'.
1073 If pid_or_core_arg's first character is a digit, try attach
1074 first and then corefile. Otherwise try just corefile. */
1076 if (isdigit (pid_or_core_arg
[0]))
1078 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1081 ret
= catch_command_errors (core_file_command
,
1087 /* Can't be a pid, better be a corefile. */
1088 ret
= catch_command_errors (core_file_command
,
1095 set_inferior_io_terminal (ttyarg
);
1097 /* Error messages should no longer be distinguished with extra output. */
1098 warning_pre_print
= _("warning: ");
1100 /* Read the .gdbinit file in the current directory, *if* it isn't
1101 the same as the $HOME/.gdbinit file (it should exist, also). */
1104 auto_load_local_gdbinit_pathname
1105 = gdb_realpath (local_gdbinit
).release ();
1107 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
1108 && file_is_auto_load_safe (local_gdbinit
,
1109 _("auto-load: Loading .gdbinit "
1113 auto_load_local_gdbinit_loaded
= 1;
1115 ret
= catch_command_errors (source_script
, local_gdbinit
, 0);
1119 /* Now that all .gdbinit's have been read and all -d options have been
1120 processed, we can read any scripts mentioned in SYMARG.
1121 We wait until now because it is common to add to the source search
1122 path in local_gdbinit. */
1123 global_auto_load
= save_auto_load
;
1124 for (objfile
*objfile
: current_program_space
->objfiles ())
1125 load_auto_scripts_for_objfile (objfile
);
1127 /* Process '-x' and '-ex' options. */
1128 for (i
= 0; i
< cmdarg_vec
.size (); i
++)
1130 const struct cmdarg
&cmdarg_p
= cmdarg_vec
[i
];
1132 switch (cmdarg_p
.type
)
1135 ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
1138 case CMDARG_COMMAND
:
1139 ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
1145 /* Read in the old history after all the command files have been
1151 int error_status
= EXIT_FAILURE
;
1152 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1154 /* We have hit the end of the batch file. */
1155 quit_force (exit_arg
, 0);
1160 captured_main (void *data
)
1162 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1164 captured_main_1 (context
);
1166 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1167 moving this loop and the code found in captured_command_loop()
1168 into the command_loop() proper. The main thing holding back that
1169 change - SET_TOP_LEVEL() - has been eliminated. */
1174 captured_command_loop ();
1176 CATCH (ex
, RETURN_MASK_ALL
)
1178 exception_print (gdb_stderr
, ex
);
1182 /* No exit -- exit is through quit_command. */
1186 gdb_main (struct captured_main_args
*args
)
1190 captured_main (args
);
1192 CATCH (ex
, RETURN_MASK_ALL
)
1194 exception_print (gdb_stderr
, ex
);
1198 /* The only way to end up here is by an error (normal exit is
1199 handled by quit_force()), hence always return an error status. */
1204 /* Don't use *_filtered for printing help. We don't want to prompt
1205 for continue no matter how small the screen or how much we're going
1209 print_gdb_help (struct ui_file
*stream
)
1211 const char *system_gdbinit
;
1212 const char *home_gdbinit
;
1213 const char *local_gdbinit
;
1215 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1217 /* Note: The options in the list below are only approximately sorted
1218 in the alphabetical order, so as to group closely related options
1220 fputs_unfiltered (_("\
1221 This is the GNU debugger. Usage:\n\n\
1222 gdb [options] [executable-file [core-file or process-id]]\n\
1223 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1225 fputs_unfiltered (_("\
1226 Selection of debuggee and its files:\n\n\
1227 --args Arguments after executable-file are passed to inferior\n\
1228 --core=COREFILE Analyze the core dump COREFILE.\n\
1229 --exec=EXECFILE Use EXECFILE as the executable.\n\
1230 --pid=PID Attach to running process PID.\n\
1231 --directory=DIR Search for source files in DIR.\n\
1232 --se=FILE Use FILE as symbol file and executable file.\n\
1233 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1234 --readnow Fully read symbol files on first access.\n\
1235 --readnever Do not read symbol files.\n\
1236 --write Set writing into executable and core files.\n\n\
1238 fputs_unfiltered (_("\
1239 Initial commands and command files:\n\n\
1240 --command=FILE, -x Execute GDB commands from FILE.\n\
1241 --init-command=FILE, -ix\n\
1242 Like -x but execute commands before loading inferior.\n\
1243 --eval-command=COMMAND, -ex\n\
1244 Execute a single GDB command.\n\
1245 May be used multiple times and in conjunction\n\
1247 --init-eval-command=COMMAND, -iex\n\
1248 Like -ex but before loading inferior.\n\
1249 --nh Do not read ~/.gdbinit.\n\
1250 --nx Do not read any .gdbinit files in any directory.\n\n\
1252 fputs_unfiltered (_("\
1253 Output and user interface control:\n\n\
1254 --fullname Output information used by emacs-GDB interface.\n\
1255 --interpreter=INTERP\n\
1256 Select a specific interpreter / user interface\n\
1257 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1258 -w Use the GUI interface.\n\
1259 --nw Do not use the GUI interface.\n\
1262 fputs_unfiltered (_("\
1263 --tui Use a terminal user interface.\n\
1266 fputs_unfiltered (_("\
1267 --dbx DBX compatibility mode.\n\
1268 -q, --quiet, --silent\n\
1269 Do not print version number on startup.\n\n\
1271 fputs_unfiltered (_("\
1272 Operating modes:\n\n\
1273 --batch Exit after processing options.\n\
1274 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1275 --return-child-result\n\
1276 GDB exit code will be the child's exit code.\n\
1277 --configuration Print details about GDB configuration and then exit.\n\
1278 --help Print this message and then exit.\n\
1279 --version Print version information and then exit.\n\n\
1280 Remote debugging options:\n\n\
1281 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1282 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1284 --cd=DIR Change current directory to DIR.\n\
1285 --data-directory=DIR, -D\n\
1286 Set GDB's data-directory to DIR.\n\
1288 fputs_unfiltered (_("\n\
1289 At startup, GDB reads the following init files and executes their commands:\n\
1292 fprintf_unfiltered (stream
, _("\
1293 * system-wide init file: %s\n\
1294 "), system_gdbinit
);
1296 fprintf_unfiltered (stream
, _("\
1297 * user-specific init file: %s\n\
1300 fprintf_unfiltered (stream
, _("\
1301 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1303 fputs_unfiltered (_("\n\
1304 For more information, type \"help\" from within GDB, or consult the\n\
1305 GDB manual (available as on-line info or a printed manual).\n\
1307 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1308 fprintf_unfiltered (stream
, _("\
1309 Report bugs to \"%s\".\n\
1310 "), REPORT_BUGS_TO
);