1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2022 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 "gdbsupport/event-loop.h"
37 #include "cli/cli-cmds.h"
39 #include "auto-load.h"
42 #include "filenames.h"
43 #include "gdbsupport/filestuff.h"
45 #include "event-top.h"
47 #include "gdbsupport/signals-state-save-restore.h"
50 #include "gdbsupport/pathstuff.h"
51 #include "cli/cli-style.h"
53 #include "gdbtk/generic/gdbtk.h"
55 #include "gdbsupport/alt-stack.h"
56 #include "observable.h"
59 /* The selected interpreter. This will be used as a set command
60 variable, so it should always be malloc'ed - since
61 do_setshow_command will free it. */
64 /* System root path, used to find libraries etc. */
65 std::string gdb_sysroot
;
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 gdb_printf (gdb_stderr
, "Warning: ");
123 print_sys_errmsg (new_datadir
, save_errno
);
125 else if (!S_ISDIR (st
.st_mode
))
126 warning (_("%ps is not a directory."),
127 styled_string (file_name_style
.style (), new_datadir
));
129 gdb_datadir
= gdb_realpath (new_datadir
).get ();
131 /* gdb_realpath won't return an absolute path if the path doesn't exist,
132 but we still want to record an absolute path here. If the user entered
133 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
134 isn't canonical, but that's ok. */
135 if (!IS_ABSOLUTE_PATH (gdb_datadir
.c_str ()))
137 gdb::unique_xmalloc_ptr
<char> abs_datadir
138 = gdb_abspath (gdb_datadir
.c_str ());
140 gdb_datadir
= abs_datadir
.get ();
144 /* Relocate a file or directory. PROGNAME is the name by which gdb
145 was invoked (i.e., argv[0]). INITIAL is the default value for the
146 file or directory. RELOCATABLE is true if the value is relocatable,
147 false otherwise. This may return an empty string under the same
148 conditions as make_relative_prefix returning NULL. */
151 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
155 gdb::unique_xmalloc_ptr
<char> str (make_relative_prefix (progname
,
160 return std::string ();
165 /* Like relocate_path, but specifically checks for a directory.
166 INITIAL is relocated according to the rules of relocate_path. If
167 the result is a directory, it is used; otherwise, INITIAL is used.
168 The chosen directory is then canonicalized using lrealpath. */
171 relocate_gdb_directory (const char *initial
, bool relocatable
)
173 std::string dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
178 if (stat (dir
.c_str (), &s
) != 0 || !S_ISDIR (s
.st_mode
))
186 /* Canonicalize the directory. */
189 gdb::unique_xmalloc_ptr
<char> canon_sysroot (lrealpath (dir
.c_str ()));
192 dir
= canon_sysroot
.get ();
198 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
199 parameter if it is in the data dir, or passes it through relocate_path
203 relocate_file_path_maybe_in_datadir (const std::string
&file
,
206 size_t datadir_len
= strlen (GDB_DATADIR
);
208 std::string relocated_path
;
210 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
211 has been provided, search for SYSTEM_GDBINIT there. */
212 if (gdb_datadir_provided
213 && datadir_len
< file
.length ()
214 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
215 && IS_DIR_SEPARATOR (file
[datadir_len
]))
217 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
220 size_t start
= datadir_len
;
221 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
223 relocated_path
= gdb_datadir
+ SLASH_STRING
+ file
.substr (start
);
227 relocated_path
= relocate_path (gdb_program_name
, file
.c_str (),
230 return relocated_path
;
233 /* A class to wrap up the logic for finding the three different types of
234 initialisation files GDB uses, system wide, home directory, and current
235 working directory. */
237 class gdb_initfile_finder
240 /* Constructor. Finds initialisation files named FILENAME in the home
241 directory or local (current working) directory. System initialisation
242 files are found in both SYSTEM_FILENAME and SYSTEM_DIRNAME if these
243 are not nullptr (either or both can be). The matching *_RELOCATABLE
244 flag is passed through to RELOCATE_FILE_PATH_MAYBE_IN_DATADIR.
246 If FILENAME starts with a '.' then when looking in the home directory
247 this first '.' can be ignored in some cases. */
248 explicit gdb_initfile_finder (const char *filename
,
249 const char *system_filename
,
250 bool system_filename_relocatable
,
251 const char *system_dirname
,
252 bool system_dirname_relocatable
,
253 bool lookup_local_file
)
257 if (system_filename
!= nullptr && system_filename
[0] != '\0')
259 std::string relocated_filename
260 = relocate_file_path_maybe_in_datadir (system_filename
,
261 system_filename_relocatable
);
262 if (!relocated_filename
.empty ()
263 && stat (relocated_filename
.c_str (), &s
) == 0)
264 m_system_files
.push_back (relocated_filename
);
267 if (system_dirname
!= nullptr && system_dirname
[0] != '\0')
269 std::string relocated_dirname
270 = relocate_file_path_maybe_in_datadir (system_dirname
,
271 system_dirname_relocatable
);
272 if (!relocated_dirname
.empty ())
274 gdb_dir_up
dir (opendir (relocated_dirname
.c_str ()));
277 std::vector
<std::string
> files
;
280 struct dirent
*ent
= readdir (dir
.get ());
283 std::string
name (ent
->d_name
);
284 if (name
== "." || name
== "..")
286 /* ent->d_type is not available on all systems
287 (e.g. mingw, Solaris), so we have to call stat(). */
288 std::string tmp_filename
289 = relocated_dirname
+ SLASH_STRING
+ name
;
290 if (stat (tmp_filename
.c_str (), &s
) != 0
291 || !S_ISREG (s
.st_mode
))
293 const struct extension_language_defn
*extlang
294 = get_ext_lang_of_file (tmp_filename
.c_str ());
295 /* We effectively don't support "set script-extension
296 off/soft", because we are loading system init files
297 here, so it does not really make sense to depend on
299 if (extlang
!= nullptr && ext_lang_present_p (extlang
))
300 files
.push_back (std::move (tmp_filename
));
302 std::sort (files
.begin (), files
.end ());
303 m_system_files
.insert (m_system_files
.end (),
304 files
.begin (), files
.end ());
309 /* If the .gdbinit file in the current directory is the same as
310 the $HOME/.gdbinit file, it should not be sourced. homebuf
311 and cwdbuf are used in that purpose. Make sure that the stats
312 are zero in case one of them fails (this guarantees that they
313 won't match if either exists). */
315 struct stat homebuf
, cwdbuf
;
316 memset (&homebuf
, 0, sizeof (struct stat
));
317 memset (&cwdbuf
, 0, sizeof (struct stat
));
319 m_home_file
= find_gdb_home_config_file (filename
, &homebuf
);
321 if (lookup_local_file
&& stat (filename
, &cwdbuf
) == 0)
323 if (m_home_file
.empty ()
324 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
325 sizeof (struct stat
)))
326 m_local_file
= filename
;
330 DISABLE_COPY_AND_ASSIGN (gdb_initfile_finder
);
332 /* Return a list of system initialisation files. The list could be
334 const std::vector
<std::string
> &system_files () const
335 { return m_system_files
; }
337 /* Return the path to the home initialisation file. The string can be
338 empty if there is no such file. */
339 const std::string
&home_file () const
340 { return m_home_file
; }
342 /* Return the path to the local initialisation file. The string can be
343 empty if there is no such file. */
344 const std::string
&local_file () const
345 { return m_local_file
; }
349 /* Vector of all system init files in the order they should be processed.
351 std::vector
<std::string
> m_system_files
;
353 /* Initialization file from the home directory. Could be the empty
354 string if there is no such file found. */
355 std::string m_home_file
;
357 /* Initialization file from the current working directory. Could be the
358 empty string if there is no such file found. */
359 std::string m_local_file
;
362 /* Compute the locations of init files that GDB should source and return
363 them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. The SYSTEM_GDBINIT
364 can be returned as an empty vector, and HOME_GDBINIT and LOCAL_GDBINIT
365 can be returned as empty strings if there is no init file of that
369 get_init_files (std::vector
<std::string
> *system_gdbinit
,
370 std::string
*home_gdbinit
,
371 std::string
*local_gdbinit
)
373 /* Cache the file lookup object so we only actually search for the files
375 static gdb::optional
<gdb_initfile_finder
> init_files
;
376 if (!init_files
.has_value ())
377 init_files
.emplace (GDBINIT
, SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
,
378 SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
,
381 *system_gdbinit
= init_files
->system_files ();
382 *home_gdbinit
= init_files
->home_file ();
383 *local_gdbinit
= init_files
->local_file ();
386 /* Compute the location of the early init file GDB should source and return
387 it in HOME_GDBEARLYINIT. HOME_GDBEARLYINIT could be returned as an
388 empty string if there is no early init file found. */
391 get_earlyinit_files (std::string
*home_gdbearlyinit
)
393 /* Cache the file lookup object so we only actually search for the files
395 static gdb::optional
<gdb_initfile_finder
> init_files
;
396 if (!init_files
.has_value ())
397 init_files
.emplace (GDBEARLYINIT
, nullptr, false, nullptr, false, false);
399 *home_gdbearlyinit
= init_files
->home_file ();
402 /* Start up the event loop. This is the entry point to the event loop
403 from the command loop. */
408 /* Loop until there is nothing to do. This is the entry point to
409 the event loop engine. gdb_do_one_event will process one event
410 for each invocation. It blocks waiting for an event and then
418 result
= gdb_do_one_event ();
420 catch (const gdb_exception
&ex
)
422 exception_print (gdb_stderr
, ex
);
424 /* If any exception escaped to here, we better enable
425 stdin. Otherwise, any command that calls async_disable_stdin,
426 and then throws, will leave stdin inoperable. */
427 SWITCH_THRU_ALL_UIS ()
429 async_enable_stdin ();
431 /* If we long-jumped out of do_one_event, we probably didn't
432 get around to resetting the prompt, which leaves readline
433 in a messed-up state. Reset it here. */
434 current_ui
->prompt_state
= PROMPT_NEEDED
;
435 gdb::observers::command_error
.notify ();
436 /* This call looks bizarre, but it is required. If the user
437 entered a command that caused an error,
438 after_char_processing_hook won't be called from
439 rl_callback_read_char_wrapper. Using a cleanup there
440 won't work, since we want this function to be called
441 after a new prompt is printed. */
442 if (after_char_processing_hook
)
443 (*after_char_processing_hook
) ();
444 /* Maybe better to set a flag to be checked somewhere as to
445 whether display the prompt or not. */
452 /* We are done with the event loop. There are no more event sources
453 to listen to. So we exit GDB. */
457 /* Call command_loop. */
459 /* Prevent inlining this function for the benefit of GDB's selftests
460 in the testsuite. Those tests want to run GDB under GDB and stop
462 static void captured_command_loop () __attribute__((noinline
));
465 captured_command_loop ()
467 struct ui
*ui
= current_ui
;
469 /* Top-level execution commands can be run in the background from
471 current_ui
->async
= 1;
473 /* Give the interpreter a chance to print a prompt, if necessary */
474 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
475 interp_pre_command_loop (top_level_interpreter ());
477 /* Now it's time to start the event loop. */
480 /* If the command_loop returned, normally (rather than threw an
481 error) we try to quit. If the quit is aborted, our caller
482 catches the signal and restarts the command loop. */
483 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
486 /* Handle command errors thrown from within catch_command_errors. */
489 handle_command_errors (const struct gdb_exception
&e
)
493 exception_print (gdb_stderr
, e
);
495 /* If any exception escaped to here, we better enable stdin.
496 Otherwise, any command that calls async_disable_stdin, and
497 then throws, will leave stdin inoperable. */
498 async_enable_stdin ();
504 /* Type of the command callback passed to the const
505 catch_command_errors. */
507 typedef void (catch_command_errors_const_ftype
) (const char *, int);
509 /* Wrap calls to commands run before the event loop is started. */
512 catch_command_errors (catch_command_errors_const_ftype command
,
513 const char *arg
, int from_tty
,
514 bool do_bp_actions
= false)
518 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
520 command (arg
, from_tty
);
522 maybe_wait_sync_command_done (was_sync
);
524 /* Do any commands attached to breakpoint we stopped at. */
526 bpstat_do_actions ();
528 catch (const gdb_exception
&e
)
530 return handle_command_errors (e
);
536 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
537 symfile_add_flags. */
540 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
542 symfile_add_flags add_flags
= 0;
545 add_flags
|= SYMFILE_VERBOSE
;
547 symbol_file_add_main (arg
, add_flags
);
550 /* Perform validation of the '--readnow' and '--readnever' flags. */
553 validate_readnow_readnever ()
555 if (readnever_symbol_files
&& readnow_symbol_files
)
557 error (_("%s: '--readnow' and '--readnever' cannot be "
558 "specified simultaneously"),
563 /* Type of this option. */
566 /* Option type -x. */
569 /* Option type -ex. */
572 /* Option type -ix. */
575 /* Option type -iex. */
578 /* Option type -eix. */
579 CMDARG_EARLYINIT_FILE
,
581 /* Option type -eiex. */
582 CMDARG_EARLYINIT_COMMAND
585 /* Arguments of --command option and its counterpart. */
588 cmdarg (cmdarg_kind type_
, char *string_
)
589 : type (type_
), string (string_
)
592 /* Type of this option. */
593 enum cmdarg_kind type
;
595 /* Value of this option - filename or the GDB command itself. String memory
596 is not owned by this structure despite it is 'const'. */
600 /* From CMDARG_VEC execute command files (matching FILE_TYPE) or commands
601 (matching CMD_TYPE). Update the value in *RET if and scripts or
602 commands are executed. */
605 execute_cmdargs (const std::vector
<struct cmdarg
> *cmdarg_vec
,
606 cmdarg_kind file_type
, cmdarg_kind cmd_type
,
609 for (const auto &cmdarg_p
: *cmdarg_vec
)
611 if (cmdarg_p
.type
== file_type
)
612 *ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
614 else if (cmdarg_p
.type
== cmd_type
)
615 *ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
621 captured_main_1 (struct captured_main_args
*context
)
623 int argc
= context
->argc
;
624 char **argv
= context
->argv
;
626 static int quiet
= 0;
627 static int set_args
= 0;
628 static int inhibit_home_gdbinit
= 0;
630 /* Pointers to various arguments from command line. */
632 char *execarg
= NULL
;
634 char *corearg
= NULL
;
635 char *pid_or_core_arg
= NULL
;
639 /* These are static so that we can take their address in an
641 static int print_help
;
642 static int print_version
;
643 static int print_configuration
;
645 /* Pointers to all arguments of --command option. */
646 std::vector
<struct cmdarg
> cmdarg_vec
;
648 /* All arguments of --directory option. */
649 std::vector
<char *> dirarg
;
655 #ifdef HAVE_USEFUL_SBRK
656 /* Set this before constructing scoped_command_stats. */
657 lim_at_start
= (char *) sbrk (0);
660 scoped_command_stats
stat_reporter (false);
662 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
663 setlocale (LC_MESSAGES
, "");
665 #if defined (HAVE_SETLOCALE)
666 setlocale (LC_CTYPE
, "");
669 bindtextdomain (PACKAGE
, LOCALEDIR
);
670 textdomain (PACKAGE
);
676 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
677 as a Windows pipe, and Windows buffers on pipes. */
678 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
681 /* Note: `error' cannot be called before this point, because the
682 caller will crash when trying to print the exception. */
683 main_ui
= new ui (stdin
, stdout
, stderr
);
684 current_ui
= main_ui
;
686 gdb_stdtargerr
= gdb_stderr
; /* for moment */
687 gdb_stdtargin
= gdb_stdin
; /* for moment */
689 if (bfd_init () != BFD_INIT_MAGIC
)
690 error (_("fatal error: libbfd ABI mismatch"));
693 /* On Windows, argv[0] is not necessarily set to absolute form when
694 GDB is found along PATH, without which relocation doesn't work. */
695 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
697 gdb_program_name
= xstrdup (argv
[0]);
700 /* Prefix warning messages with the command name. */
701 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
702 = xstrprintf ("%s: warning: ", gdb_program_name
);
703 warning_pre_print
= tmp_warn_preprint
.get ();
705 current_directory
= getcwd (NULL
, 0);
706 if (current_directory
== NULL
)
707 perror_warning_with_name (_("error finding working directory"));
709 /* Set the sysroot path. */
710 gdb_sysroot
= relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
711 TARGET_SYSTEM_ROOT_RELOCATABLE
);
713 if (gdb_sysroot
.empty ())
714 gdb_sysroot
= TARGET_SYSROOT_PREFIX
;
717 = relocate_gdb_directory (DEBUGDIR
, DEBUGDIR_RELOCATABLE
);
719 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
720 GDB_DATADIR_RELOCATABLE
);
722 #ifdef WITH_PYTHON_LIBDIR
723 python_libdir
= relocate_gdb_directory (WITH_PYTHON_LIBDIR
,
724 PYTHON_LIBDIR_RELOCATABLE
);
728 add_substitute_path_rule (RELOC_SRCDIR
,
729 make_relative_prefix (gdb_program_name
, BINDIR
,
733 /* There will always be an interpreter. Either the one passed into
734 this captured main, or one specified by the user at start up, or
735 the console. Initialize the interpreter to the one requested by
737 interpreter_p
= xstrdup (context
->interpreter_p
);
739 /* Parse arguments and options. */
742 /* When var field is 0, use flag field to record the equivalent
743 short option (or arbitrary numbers starting at 10 for those
744 with no equivalent). */
760 /* This struct requires int* in the struct, but write_files is a bool.
761 So use this temporary int that we write back after argument parsing. */
762 int write_files_1
= 0;
763 static struct option long_options
[] =
765 {"tui", no_argument
, 0, OPT_TUI
},
766 {"readnow", no_argument
, NULL
, OPT_READNOW
},
767 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
768 {"r", no_argument
, NULL
, OPT_READNOW
},
769 {"quiet", no_argument
, &quiet
, 1},
770 {"q", no_argument
, &quiet
, 1},
771 {"silent", no_argument
, &quiet
, 1},
772 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
773 {"nx", no_argument
, &inhibit_gdbinit
, 1},
774 {"n", no_argument
, &inhibit_gdbinit
, 1},
775 {"batch-silent", no_argument
, 0, 'B'},
776 {"batch", no_argument
, &batch_flag
, 1},
778 /* This is a synonym for "--annotate=1". --annotate is now
779 preferred, but keep this here for a long time because people
780 will be running emacses which use --fullname. */
781 {"fullname", no_argument
, 0, 'f'},
782 {"f", no_argument
, 0, 'f'},
784 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
785 {"help", no_argument
, &print_help
, 1},
786 {"se", required_argument
, 0, OPT_SE
},
787 {"symbols", required_argument
, 0, 's'},
788 {"s", required_argument
, 0, 's'},
789 {"exec", required_argument
, 0, 'e'},
790 {"e", required_argument
, 0, 'e'},
791 {"core", required_argument
, 0, 'c'},
792 {"c", required_argument
, 0, 'c'},
793 {"pid", required_argument
, 0, 'p'},
794 {"p", required_argument
, 0, 'p'},
795 {"command", required_argument
, 0, 'x'},
796 {"eval-command", required_argument
, 0, 'X'},
797 {"version", no_argument
, &print_version
, 1},
798 {"configuration", no_argument
, &print_configuration
, 1},
799 {"x", required_argument
, 0, 'x'},
800 {"ex", required_argument
, 0, 'X'},
801 {"init-command", required_argument
, 0, OPT_IX
},
802 {"init-eval-command", required_argument
, 0, OPT_IEX
},
803 {"ix", required_argument
, 0, OPT_IX
},
804 {"iex", required_argument
, 0, OPT_IEX
},
805 {"early-init-command", required_argument
, 0, OPT_EIX
},
806 {"early-init-eval-command", required_argument
, 0, OPT_EIEX
},
807 {"eix", required_argument
, 0, OPT_EIX
},
808 {"eiex", required_argument
, 0, OPT_EIEX
},
810 {"tclcommand", required_argument
, 0, 'z'},
811 {"enable-external-editor", no_argument
, 0, 'y'},
812 {"editor-command", required_argument
, 0, 'w'},
814 {"ui", required_argument
, 0, 'i'},
815 {"interpreter", required_argument
, 0, 'i'},
816 {"i", required_argument
, 0, 'i'},
817 {"directory", required_argument
, 0, 'd'},
818 {"d", required_argument
, 0, 'd'},
819 {"data-directory", required_argument
, 0, 'D'},
820 {"D", required_argument
, 0, 'D'},
821 {"cd", required_argument
, 0, OPT_CD
},
822 {"tty", required_argument
, 0, 't'},
823 {"baud", required_argument
, 0, 'b'},
824 {"b", required_argument
, 0, 'b'},
825 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
826 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
827 {"w", no_argument
, NULL
, OPT_WINDOWS
},
828 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
829 {"statistics", no_argument
, 0, OPT_STATISTICS
},
830 {"write", no_argument
, &write_files_1
, 1},
831 {"args", no_argument
, &set_args
, 1},
832 {"l", required_argument
, 0, 'l'},
833 {"return-child-result", no_argument
, &return_child_result
, 1},
834 {0, no_argument
, 0, 0}
841 c
= getopt_long_only (argc
, argv
, "",
842 long_options
, &option_index
);
843 if (c
== EOF
|| set_args
)
846 /* Long option that takes an argument. */
847 if (c
== 0 && long_options
[option_index
].flag
== 0)
848 c
= long_options
[option_index
].val
;
853 /* Long option that just sets a flag. */
863 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
864 annotation_level
= atoi (optarg
);
867 /* Enable the display of both time and space usage. */
868 set_per_command_time (1);
869 set_per_command_space (1);
872 /* --tui is equivalent to -i=tui. */
874 xfree (interpreter_p
);
875 interpreter_p
= xstrdup (INTERP_TUI
);
877 error (_("%s: TUI mode is not supported"), gdb_program_name
);
881 /* FIXME: cagney/2003-03-01: Not sure if this option is
882 actually useful, and if it is, what it should do. */
884 /* --windows is equivalent to -i=insight. */
885 xfree (interpreter_p
);
886 interpreter_p
= xstrdup (INTERP_INSIGHT
);
890 /* -nw is equivalent to -i=console. */
891 xfree (interpreter_p
);
892 interpreter_p
= xstrdup (INTERP_CONSOLE
);
895 annotation_level
= 1;
910 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
913 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
916 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
919 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
922 cmdarg_vec
.emplace_back (CMDARG_EARLYINIT_FILE
, optarg
);
925 cmdarg_vec
.emplace_back (CMDARG_EARLYINIT_COMMAND
, optarg
);
928 batch_flag
= batch_silent
= 1;
929 gdb_stdout
= new null_file ();
932 if (optarg
[0] == '\0')
933 error (_("%s: empty path for `--data-directory'"),
935 set_gdb_data_directory (optarg
);
936 gdb_datadir_provided
= 1;
941 if (!gdbtk_test (optarg
))
942 error (_("%s: unable to load tclcommand file \"%s\""),
943 gdb_program_name
, optarg
);
947 /* Backwards compatibility only. */
951 /* Set the external editor commands when gdb is farming out files
952 to be edited by another program. */
953 external_editor_command
= xstrdup (optarg
);
958 xfree (interpreter_p
);
959 interpreter_p
= xstrdup (optarg
);
962 dirarg
.push_back (optarg
);
975 rate
= strtol (optarg
, &p
, 0);
976 if (rate
== 0 && p
== optarg
)
977 warning (_("could not set baud rate to `%s'."),
988 timeout
= strtol (optarg
, &p
, 0);
989 if (timeout
== 0 && p
== optarg
)
990 warning (_("could not set timeout limit to `%s'."),
993 remote_timeout
= timeout
;
999 readnow_symbol_files
= 1;
1000 validate_readnow_readnever ();
1006 readnever_symbol_files
= 1;
1007 validate_readnow_readnever ();
1012 error (_("Use `%s --help' for a complete list of options."),
1016 write_files
= (write_files_1
!= 0);
1022 /* Disable all output styling when running in batch mode. */
1027 save_original_signals_state (quiet
);
1029 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
1030 gdb::alternate_signal_stack signal_stack
;
1032 /* Initialize all files. */
1035 /* Process early init files and early init options from the command line. */
1036 if (!inhibit_gdbinit
)
1038 std::string home_gdbearlyinit
;
1039 get_earlyinit_files (&home_gdbearlyinit
);
1040 if (!home_gdbearlyinit
.empty () && !inhibit_home_gdbinit
)
1041 ret
= catch_command_errors (source_script
,
1042 home_gdbearlyinit
.c_str (), 0);
1044 execute_cmdargs (&cmdarg_vec
, CMDARG_EARLYINIT_FILE
,
1045 CMDARG_EARLYINIT_COMMAND
, &ret
);
1047 /* Initialize the extension languages. */
1048 ext_lang_initialization ();
1050 /* Recheck if we're starting up quietly after processing the startup
1051 scripts and commands. */
1053 quiet
= check_quiet_mode ();
1055 /* Now that gdb_init has created the initial inferior, we're in
1056 position to set args for that inferior. */
1059 /* The remaining options are the command-line options for the
1060 inferior. The first one is the sym/exec file, and the rest
1063 error (_("%s: `--args' specified but no program specified"),
1066 symarg
= argv
[optind
];
1067 execarg
= argv
[optind
];
1069 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
1073 /* OK, that's all the options. */
1075 /* The first argument, if specified, is the name of the
1079 symarg
= argv
[optind
];
1080 execarg
= argv
[optind
];
1084 /* If the user hasn't already specified a PID or the name of a
1085 core file, then a second optional argument is allowed. If
1086 present, this argument should be interpreted as either a
1087 PID or a core file, whichever works. */
1088 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
1090 pid_or_core_arg
= argv
[optind
];
1094 /* Any argument left on the command line is unexpected and
1095 will be ignored. Inform the user. */
1097 gdb_printf (gdb_stderr
,
1098 _("Excess command line "
1099 "arguments ignored. (%s%s)\n"),
1101 (optind
== argc
- 1) ? "" : " ...");
1104 /* Lookup gdbinit files. Note that the gdbinit file name may be
1105 overridden during file initialization, so get_init_files should be
1106 called after gdb_init. */
1107 std::vector
<std::string
> system_gdbinit
;
1108 std::string home_gdbinit
;
1109 std::string local_gdbinit
;
1110 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1112 /* Do these (and anything which might call wrap_here or *_filtered)
1113 after initialize_all_files() but before the interpreter has been
1114 installed. Otherwize the help/version messages will be eaten by
1115 the interpreter's output handler. */
1119 print_gdb_version (gdb_stdout
, false);
1126 print_gdb_help (gdb_stdout
);
1130 if (print_configuration
)
1132 print_gdb_configuration (gdb_stdout
);
1137 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
1138 GDB retain the old MI1 interpreter startup behavior. Output the
1139 copyright message before the interpreter is installed. That way
1140 it isn't encapsulated in MI output. */
1141 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
1143 /* Print all the junk at the top, with trailing "..." if we are
1144 about to read a symbol file (possibly slowly). */
1145 print_gdb_version (gdb_stdout
, true);
1149 gdb_flush (gdb_stdout
); /* Force to screen during slow
1153 /* Install the default UI. All the interpreters should have had a
1154 look at things by now. Initialize the default interpreter. */
1155 set_top_level_interpreter (interpreter_p
);
1157 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
1158 GDB retain the old MI1 interpreter startup behavior. Output the
1159 copyright message after the interpreter is installed when it is
1160 any sane interpreter. */
1161 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
1163 /* Print all the junk at the top, with trailing "..." if we are
1164 about to read a symbol file (possibly slowly). */
1165 print_gdb_version (gdb_stdout
, true);
1169 gdb_flush (gdb_stdout
); /* Force to screen during slow
1173 /* Set off error and warning messages with a blank line. */
1174 tmp_warn_preprint
.reset ();
1175 warning_pre_print
= _("\nwarning: ");
1177 /* Read and execute the system-wide gdbinit file, if it exists.
1178 This is done *before* all the command line arguments are
1179 processed; it sets global parameters, which are independent of
1180 what file you are debugging or what directory you are in. */
1181 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
1183 for (const std::string
&file
: system_gdbinit
)
1184 ret
= catch_command_errors (source_script
, file
.c_str (), 0);
1187 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
1188 *before* all the command line arguments are processed; it sets
1189 global parameters, which are independent of what file you are
1190 debugging or what directory you are in. */
1192 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1193 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1195 /* Process '-ix' and '-iex' options early. */
1196 execute_cmdargs (&cmdarg_vec
, CMDARG_INIT_FILE
, CMDARG_INIT_COMMAND
, &ret
);
1198 /* Now perform all the actions indicated by the arguments. */
1201 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1204 for (i
= 0; i
< dirarg
.size (); i
++)
1205 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1207 /* Skip auto-loading section-specified scripts until we've sourced
1208 local_gdbinit (which is often used to augment the source search
1210 save_auto_load
= global_auto_load
;
1211 global_auto_load
= 0;
1215 && strcmp (execarg
, symarg
) == 0)
1217 /* The exec file and the symbol-file are the same. If we can't
1218 open it, better only print one error message.
1219 catch_command_errors returns non-zero on success! */
1220 ret
= catch_command_errors (exec_file_attach
, execarg
,
1223 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1224 symarg
, !batch_flag
);
1228 if (execarg
!= NULL
)
1229 ret
= catch_command_errors (exec_file_attach
, execarg
,
1232 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1233 symarg
, !batch_flag
);
1236 if (corearg
&& pidarg
)
1237 error (_("Can't attach to process and specify "
1238 "a core file at the same time."));
1240 if (corearg
!= NULL
)
1242 ret
= catch_command_errors (core_file_command
, corearg
,
1245 else if (pidarg
!= NULL
)
1247 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1249 else if (pid_or_core_arg
)
1251 /* The user specified 'gdb program pid' or gdb program core'.
1252 If pid_or_core_arg's first character is a digit, try attach
1253 first and then corefile. Otherwise try just corefile. */
1255 if (isdigit (pid_or_core_arg
[0]))
1257 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1260 ret
= catch_command_errors (core_file_command
,
1266 /* Can't be a pid, better be a corefile. */
1267 ret
= catch_command_errors (core_file_command
,
1274 current_inferior ()->set_tty (ttyarg
);
1276 /* Error messages should no longer be distinguished with extra output. */
1277 warning_pre_print
= _("warning: ");
1279 /* Read the .gdbinit file in the current directory, *if* it isn't
1280 the same as the $HOME/.gdbinit file (it should exist, also). */
1281 if (!local_gdbinit
.empty ())
1283 auto_load_local_gdbinit_pathname
1284 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1286 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
)
1288 auto_load_debug_printf ("Loading .gdbinit file \"%s\".",
1289 local_gdbinit
.c_str ());
1291 if (file_is_auto_load_safe (local_gdbinit
.c_str ()))
1293 auto_load_local_gdbinit_loaded
= 1;
1295 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1300 /* Now that all .gdbinit's have been read and all -d options have been
1301 processed, we can read any scripts mentioned in SYMARG.
1302 We wait until now because it is common to add to the source search
1303 path in local_gdbinit. */
1304 global_auto_load
= save_auto_load
;
1305 for (objfile
*objfile
: current_program_space
->objfiles ())
1306 load_auto_scripts_for_objfile (objfile
);
1308 /* Process '-x' and '-ex' options. */
1309 execute_cmdargs (&cmdarg_vec
, CMDARG_FILE
, CMDARG_COMMAND
, &ret
);
1311 /* Read in the old history after all the command files have been
1317 int error_status
= EXIT_FAILURE
;
1318 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1320 /* We have hit the end of the batch file. */
1321 quit_force (exit_arg
, 0);
1326 captured_main (void *data
)
1328 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1330 captured_main_1 (context
);
1332 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1333 moving this loop and the code found in captured_command_loop()
1334 into the command_loop() proper. The main thing holding back that
1335 change - SET_TOP_LEVEL() - has been eliminated. */
1340 captured_command_loop ();
1342 catch (const gdb_exception
&ex
)
1344 exception_print (gdb_stderr
, ex
);
1347 /* No exit -- exit is through quit_command. */
1351 gdb_main (struct captured_main_args
*args
)
1355 captured_main (args
);
1357 catch (const gdb_exception
&ex
)
1359 exception_print (gdb_stderr
, ex
);
1362 /* The only way to end up here is by an error (normal exit is
1363 handled by quit_force()), hence always return an error status. */
1368 /* Don't use *_filtered for printing help. We don't want to prompt
1369 for continue no matter how small the screen or how much we're going
1373 print_gdb_help (struct ui_file
*stream
)
1375 std::vector
<std::string
> system_gdbinit
;
1376 std::string home_gdbinit
;
1377 std::string local_gdbinit
;
1378 std::string home_gdbearlyinit
;
1380 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1381 get_earlyinit_files (&home_gdbearlyinit
);
1383 /* Note: The options in the list below are only approximately sorted
1384 in the alphabetical order, so as to group closely related options
1387 This is the GNU debugger. Usage:\n\n\
1388 gdb [options] [executable-file [core-file or process-id]]\n\
1389 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1392 Selection of debuggee and its files:\n\n\
1393 --args Arguments after executable-file are passed to inferior.\n\
1394 --core=COREFILE Analyze the core dump COREFILE.\n\
1395 --exec=EXECFILE Use EXECFILE as the executable.\n\
1396 --pid=PID Attach to running process PID.\n\
1397 --directory=DIR Search for source files in DIR.\n\
1398 --se=FILE Use FILE as symbol file and executable file.\n\
1399 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1400 --readnow Fully read symbol files on first access.\n\
1401 --readnever Do not read symbol files.\n\
1402 --write Set writing into executable and core files.\n\n\
1405 Initial commands and command files:\n\n\
1406 --command=FILE, -x Execute GDB commands from FILE.\n\
1407 --init-command=FILE, -ix\n\
1408 Like -x but execute commands before loading inferior.\n\
1409 --eval-command=COMMAND, -ex\n\
1410 Execute a single GDB command.\n\
1411 May be used multiple times and in conjunction\n\
1413 --init-eval-command=COMMAND, -iex\n\
1414 Like -ex but before loading inferior.\n\
1415 --nh Do not read ~/.gdbinit.\n\
1416 --nx Do not read any .gdbinit files in any directory.\n\n\
1419 Output and user interface control:\n\n\
1420 --fullname Output information used by emacs-GDB interface.\n\
1421 --interpreter=INTERP\n\
1422 Select a specific interpreter / user interface.\n\
1423 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1424 -w Use the GUI interface.\n\
1425 --nw Do not use the GUI interface.\n\
1429 --tui Use a terminal user interface.\n\
1433 -q, --quiet, --silent\n\
1434 Do not print version number on startup.\n\n\
1437 Operating modes:\n\n\
1438 --batch Exit after processing options.\n\
1439 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1440 --return-child-result\n\
1441 GDB exit code will be the child's exit code.\n\
1442 --configuration Print details about GDB configuration and then exit.\n\
1443 --help Print this message and then exit.\n\
1444 --version Print version information and then exit.\n\n\
1445 Remote debugging options:\n\n\
1446 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1447 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1449 --cd=DIR Change current directory to DIR.\n\
1450 --data-directory=DIR, -D\n\
1451 Set GDB's data-directory to DIR.\n\
1454 At startup, GDB reads the following early init files and executes their\n\
1457 if (!home_gdbearlyinit
.empty ())
1458 gdb_printf (stream
, _("\
1459 * user-specific early init file: %s\n\
1460 "), home_gdbearlyinit
.c_str ());
1461 if (home_gdbearlyinit
.empty ())
1462 gdb_printf (stream
, _("\
1465 At startup, GDB reads the following init files and executes their commands:\n\
1467 if (!system_gdbinit
.empty ())
1470 for (size_t idx
= 0; idx
< system_gdbinit
.size (); ++idx
)
1472 output
+= system_gdbinit
[idx
];
1473 if (idx
< system_gdbinit
.size () - 1)
1476 gdb_printf (stream
, _("\
1477 * system-wide init files: %s\n\
1478 "), output
.c_str ());
1480 if (!home_gdbinit
.empty ())
1481 gdb_printf (stream
, _("\
1482 * user-specific init file: %s\n\
1483 "), home_gdbinit
.c_str ());
1484 if (!local_gdbinit
.empty ())
1485 gdb_printf (stream
, _("\
1486 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1487 "), local_gdbinit
.c_str ());
1488 if (system_gdbinit
.empty () && home_gdbinit
.empty ()
1489 && local_gdbinit
.empty ())
1490 gdb_printf (stream
, _("\
1493 For more information, type \"help\" from within GDB, or consult the\n\
1494 GDB manual (available as on-line info or a printed manual).\n\
1496 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1497 gdb_printf (stream
, _("\n\
1498 Report bugs to %ps.\n\
1499 "), styled_string (file_name_style
.style (), REPORT_BUGS_TO
));
1500 if (stream
== gdb_stdout
)
1501 gdb_printf (stream
, _("\n\
1502 You can ask GDB-related questions on the GDB users mailing list\n\
1503 (gdb@sourceware.org) or on GDB's IRC channel (#gdb on Freenode).\n"));