1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2024 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/>. */
21 #include "exceptions.h"
30 #include <sys/types.h>
33 #include "gdbsupport/event-loop.h"
39 #include "cli/cli-cmds.h"
41 #include "auto-load.h"
44 #include "filenames.h"
45 #include "gdbsupport/filestuff.h"
47 #include "event-top.h"
49 #include "gdbsupport/signals-state-save-restore.h"
52 #include "gdbsupport/pathstuff.h"
53 #include "cli/cli-style.h"
55 #include "gdbtk/generic/gdbtk.h"
57 #include "gdbsupport/alt-stack.h"
58 #include "observable.h"
62 /* The selected interpreter. */
63 std::string interpreter_p
;
65 /* System root path, used to find libraries etc. */
66 std::string gdb_sysroot
;
68 /* GDB datadir, used to store data files. */
69 std::string gdb_datadir
;
71 /* Non-zero if GDB_DATADIR was provided on the command line.
72 This doesn't track whether data-directory is set later from the
73 command line, but we don't reread system.gdbinit when that happens. */
74 static int gdb_datadir_provided
= 0;
76 /* If gdb was configured with --with-python=/path,
77 the possibly relocated path to python's lib directory. */
78 std::string python_libdir
;
80 /* Target IO streams. */
81 struct ui_file
*gdb_stdtargin
;
82 struct ui_file
*gdb_stdtarg
;
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 static void print_gdb_help (struct ui_file
*);
102 /* Set the data-directory parameter to NEW_DATADIR.
103 If NEW_DATADIR is not a directory then a warning is printed.
104 We don't signal an error for backward compatibility. */
107 set_gdb_data_directory (const char *new_datadir
)
111 if (stat (new_datadir
, &st
) < 0)
112 warning_filename_and_errno (new_datadir
, errno
);
113 else if (!S_ISDIR (st
.st_mode
))
114 warning (_("%ps is not a directory."),
115 styled_string (file_name_style
.style (), new_datadir
));
117 gdb_datadir
= gdb_realpath (new_datadir
).get ();
119 /* gdb_realpath won't return an absolute path if the path doesn't exist,
120 but we still want to record an absolute path here. If the user entered
121 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
122 isn't canonical, but that's ok. */
123 if (!IS_ABSOLUTE_PATH (gdb_datadir
.c_str ()))
124 gdb_datadir
= gdb_abspath (gdb_datadir
.c_str ());
127 /* Relocate a file or directory. PROGNAME is the name by which gdb
128 was invoked (i.e., argv[0]). INITIAL is the default value for the
129 file or directory. RELOCATABLE is true if the value is relocatable,
130 false otherwise. This may return an empty string under the same
131 conditions as make_relative_prefix returning NULL. */
134 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
138 gdb::unique_xmalloc_ptr
<char> str (make_relative_prefix (progname
,
143 return std::string ();
148 /* Like relocate_path, but specifically checks for a directory.
149 INITIAL is relocated according to the rules of relocate_path. If
150 the result is a directory, it is used; otherwise, INITIAL is used.
151 The chosen directory is then canonicalized using lrealpath. */
154 relocate_gdb_directory (const char *initial
, bool relocatable
)
156 std::string dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
161 if (stat (dir
.c_str (), &s
) != 0 || !S_ISDIR (s
.st_mode
))
169 /* Canonicalize the directory. */
172 gdb::unique_xmalloc_ptr
<char> canon_sysroot (lrealpath (dir
.c_str ()));
175 dir
= canon_sysroot
.get ();
181 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
182 parameter if it is in the data dir, or passes it through relocate_path
186 relocate_file_path_maybe_in_datadir (const std::string
&file
,
189 size_t datadir_len
= strlen (GDB_DATADIR
);
191 std::string relocated_path
;
193 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
194 has been provided, search for SYSTEM_GDBINIT there. */
195 if (gdb_datadir_provided
196 && datadir_len
< file
.length ()
197 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
198 && IS_DIR_SEPARATOR (file
[datadir_len
]))
200 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
203 size_t start
= datadir_len
;
204 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
206 relocated_path
= gdb_datadir
+ SLASH_STRING
+ file
.substr (start
);
210 relocated_path
= relocate_path (gdb_program_name
, file
.c_str (),
213 return relocated_path
;
216 /* A class to wrap up the logic for finding the three different types of
217 initialisation files GDB uses, system wide, home directory, and current
218 working directory. */
220 class gdb_initfile_finder
223 /* Constructor. Finds initialisation files named FILENAME in the home
224 directory or local (current working) directory. System initialisation
225 files are found in both SYSTEM_FILENAME and SYSTEM_DIRNAME if these
226 are not nullptr (either or both can be). The matching *_RELOCATABLE
227 flag is passed through to RELOCATE_FILE_PATH_MAYBE_IN_DATADIR.
229 If FILENAME starts with a '.' then when looking in the home directory
230 this first '.' can be ignored in some cases. */
231 explicit gdb_initfile_finder (const char *filename
,
232 const char *system_filename
,
233 bool system_filename_relocatable
,
234 const char *system_dirname
,
235 bool system_dirname_relocatable
,
236 bool lookup_local_file
)
240 if (system_filename
!= nullptr && system_filename
[0] != '\0')
242 std::string relocated_filename
243 = relocate_file_path_maybe_in_datadir (system_filename
,
244 system_filename_relocatable
);
245 if (!relocated_filename
.empty ()
246 && stat (relocated_filename
.c_str (), &s
) == 0)
247 m_system_files
.push_back (relocated_filename
);
250 if (system_dirname
!= nullptr && system_dirname
[0] != '\0')
252 std::string relocated_dirname
253 = relocate_file_path_maybe_in_datadir (system_dirname
,
254 system_dirname_relocatable
);
255 if (!relocated_dirname
.empty ())
257 gdb_dir_up
dir (opendir (relocated_dirname
.c_str ()));
260 std::vector
<std::string
> files
;
263 struct dirent
*ent
= readdir (dir
.get ());
266 std::string
name (ent
->d_name
);
267 if (name
== "." || name
== "..")
269 /* ent->d_type is not available on all systems
270 (e.g. mingw, Solaris), so we have to call stat(). */
271 std::string tmp_filename
272 = relocated_dirname
+ SLASH_STRING
+ name
;
273 if (stat (tmp_filename
.c_str (), &s
) != 0
274 || !S_ISREG (s
.st_mode
))
276 const struct extension_language_defn
*extlang
277 = get_ext_lang_of_file (tmp_filename
.c_str ());
278 /* We effectively don't support "set script-extension
279 off/soft", because we are loading system init files
280 here, so it does not really make sense to depend on
282 if (extlang
!= nullptr && ext_lang_present_p (extlang
))
283 files
.push_back (std::move (tmp_filename
));
285 std::sort (files
.begin (), files
.end ());
286 m_system_files
.insert (m_system_files
.end (),
287 files
.begin (), files
.end ());
292 /* If the .gdbinit file in the current directory is the same as
293 the $HOME/.gdbinit file, it should not be sourced. homebuf
294 and cwdbuf are used in that purpose. Make sure that the stats
295 are zero in case one of them fails (this guarantees that they
296 won't match if either exists). */
298 struct stat homebuf
, cwdbuf
;
299 memset (&homebuf
, 0, sizeof (struct stat
));
300 memset (&cwdbuf
, 0, sizeof (struct stat
));
302 m_home_file
= find_gdb_home_config_file (filename
, &homebuf
);
304 if (lookup_local_file
&& stat (filename
, &cwdbuf
) == 0)
306 if (m_home_file
.empty ()
307 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
308 sizeof (struct stat
)))
309 m_local_file
= filename
;
313 DISABLE_COPY_AND_ASSIGN (gdb_initfile_finder
);
315 /* Return a list of system initialisation files. The list could be
317 const std::vector
<std::string
> &system_files () const
318 { return m_system_files
; }
320 /* Return the path to the home initialisation file. The string can be
321 empty if there is no such file. */
322 const std::string
&home_file () const
323 { return m_home_file
; }
325 /* Return the path to the local initialisation file. The string can be
326 empty if there is no such file. */
327 const std::string
&local_file () const
328 { return m_local_file
; }
332 /* Vector of all system init files in the order they should be processed.
334 std::vector
<std::string
> m_system_files
;
336 /* Initialization file from the home directory. Could be the empty
337 string if there is no such file found. */
338 std::string m_home_file
;
340 /* Initialization file from the current working directory. Could be the
341 empty string if there is no such file found. */
342 std::string m_local_file
;
345 /* Compute the locations of init files that GDB should source and return
346 them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. The SYSTEM_GDBINIT
347 can be returned as an empty vector, and HOME_GDBINIT and LOCAL_GDBINIT
348 can be returned as empty strings if there is no init file of that
352 get_init_files (std::vector
<std::string
> *system_gdbinit
,
353 std::string
*home_gdbinit
,
354 std::string
*local_gdbinit
)
356 /* Cache the file lookup object so we only actually search for the files
358 static std::optional
<gdb_initfile_finder
> init_files
;
359 if (!init_files
.has_value ())
360 init_files
.emplace (GDBINIT
, SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
,
361 SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
,
364 *system_gdbinit
= init_files
->system_files ();
365 *home_gdbinit
= init_files
->home_file ();
366 *local_gdbinit
= init_files
->local_file ();
369 /* Compute the location of the early init file GDB should source and return
370 it in HOME_GDBEARLYINIT. HOME_GDBEARLYINIT could be returned as an
371 empty string if there is no early init file found. */
374 get_earlyinit_files (std::string
*home_gdbearlyinit
)
376 /* Cache the file lookup object so we only actually search for the files
378 static std::optional
<gdb_initfile_finder
> init_files
;
379 if (!init_files
.has_value ())
380 init_files
.emplace (GDBEARLYINIT
, nullptr, false, nullptr, false, false);
382 *home_gdbearlyinit
= init_files
->home_file ();
385 /* Start up the event loop. This is the entry point to the event loop
386 from the command loop. */
391 /* Loop until there is nothing to do. This is the entry point to
392 the event loop engine. gdb_do_one_event will process one event
393 for each invocation. It blocks waiting for an event and then
401 result
= gdb_do_one_event ();
403 catch (const gdb_exception_forced_quit
&ex
)
407 catch (const gdb_exception
&ex
)
409 exception_print (gdb_stderr
, ex
);
411 /* If any exception escaped to here, we better enable
412 stdin. Otherwise, any command that calls async_disable_stdin,
413 and then throws, will leave stdin inoperable. */
414 SWITCH_THRU_ALL_UIS ()
416 async_enable_stdin ();
418 /* If we long-jumped out of do_one_event, we probably didn't
419 get around to resetting the prompt, which leaves readline
420 in a messed-up state. Reset it here. */
421 current_ui
->prompt_state
= PROMPT_NEEDED
;
422 top_level_interpreter ()->on_command_error ();
423 /* This call looks bizarre, but it is required. If the user
424 entered a command that caused an error,
425 after_char_processing_hook won't be called from
426 rl_callback_read_char_wrapper. Using a cleanup there
427 won't work, since we want this function to be called
428 after a new prompt is printed. */
429 if (after_char_processing_hook
)
430 (*after_char_processing_hook
) ();
431 /* Maybe better to set a flag to be checked somewhere as to
432 whether display the prompt or not. */
439 /* We are done with the event loop. There are no more event sources
440 to listen to. So we exit GDB. */
444 /* Call command_loop. */
446 /* Prevent inlining this function for the benefit of GDB's selftests
447 in the testsuite. Those tests want to run GDB under GDB and stop
449 static void captured_command_loop () __attribute__((noinline
));
452 captured_command_loop ()
454 struct ui
*ui
= current_ui
;
456 /* Top-level execution commands can be run in the background from
458 current_ui
->async
= 1;
460 /* Give the interpreter a chance to print a prompt, if necessary */
461 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
462 top_level_interpreter ()->pre_command_loop ();
464 /* Now it's time to start the event loop. */
467 /* If the command_loop returned, normally (rather than threw an
468 error) we try to quit. If the quit is aborted, our caller
469 catches the signal and restarts the command loop. */
470 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
473 /* Handle command errors thrown from within catch_command_errors. */
476 handle_command_errors (const struct gdb_exception
&e
)
480 exception_print (gdb_stderr
, e
);
482 /* If any exception escaped to here, we better enable stdin.
483 Otherwise, any command that calls async_disable_stdin, and
484 then throws, will leave stdin inoperable. */
485 async_enable_stdin ();
491 /* Type of the command callback passed to the const
492 catch_command_errors. */
494 typedef void (catch_command_errors_const_ftype
) (const char *, int);
496 /* Wrap calls to commands run before the event loop is started. */
499 catch_command_errors (catch_command_errors_const_ftype command
,
500 const char *arg
, int from_tty
,
501 bool do_bp_actions
= false)
505 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
507 command (arg
, from_tty
);
509 maybe_wait_sync_command_done (was_sync
);
511 /* Do any commands attached to breakpoint we stopped at. */
513 bpstat_do_actions ();
515 catch (const gdb_exception_forced_quit
&e
)
517 quit_force (NULL
, 0);
519 catch (const gdb_exception
&e
)
521 return handle_command_errors (e
);
527 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
528 symfile_add_flags. */
531 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
533 symfile_add_flags add_flags
= 0;
536 add_flags
|= SYMFILE_VERBOSE
;
538 symbol_file_add_main (arg
, add_flags
);
541 /* Perform validation of the '--readnow' and '--readnever' flags. */
544 validate_readnow_readnever ()
546 if (readnever_symbol_files
&& readnow_symbol_files
)
548 error (_("%s: '--readnow' and '--readnever' cannot be "
549 "specified simultaneously"),
554 /* Type of this option. */
557 /* Option type -x. */
560 /* Option type -ex. */
563 /* Option type -ix. */
566 /* Option type -iex. */
569 /* Option type -eix. */
570 CMDARG_EARLYINIT_FILE
,
572 /* Option type -eiex. */
573 CMDARG_EARLYINIT_COMMAND
576 /* Arguments of --command option and its counterpart. */
579 cmdarg (cmdarg_kind type_
, char *string_
)
580 : type (type_
), string (string_
)
583 /* Type of this option. */
584 enum cmdarg_kind type
;
586 /* Value of this option - filename or the GDB command itself. String memory
587 is not owned by this structure despite it is 'const'. */
591 /* From CMDARG_VEC execute command files (matching FILE_TYPE) or commands
592 (matching CMD_TYPE). Update the value in *RET if and scripts or
593 commands are executed. */
596 execute_cmdargs (const std::vector
<struct cmdarg
> *cmdarg_vec
,
597 cmdarg_kind file_type
, cmdarg_kind cmd_type
,
600 for (const auto &cmdarg_p
: *cmdarg_vec
)
602 if (cmdarg_p
.type
== file_type
)
603 *ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
605 else if (cmdarg_p
.type
== cmd_type
)
606 *ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
612 captured_main_1 (struct captured_main_args
*context
)
614 int argc
= context
->argc
;
615 char **argv
= context
->argv
;
617 static int quiet
= 0;
618 static int set_args
= 0;
619 static int inhibit_home_gdbinit
= 0;
621 /* Pointers to various arguments from command line. */
623 char *execarg
= NULL
;
625 char *corearg
= NULL
;
626 char *pid_or_core_arg
= NULL
;
630 /* These are static so that we can take their address in an
632 static int print_help
;
633 static int print_version
;
634 static int print_configuration
;
636 /* Pointers to all arguments of --command option. */
637 std::vector
<struct cmdarg
> cmdarg_vec
;
639 /* All arguments of --directory option. */
640 std::vector
<char *> dirarg
;
646 const char *no_color
= getenv ("NO_COLOR");
647 if (no_color
!= nullptr && *no_color
!= '\0')
650 #ifdef HAVE_USEFUL_SBRK
651 /* Set this before constructing scoped_command_stats. */
652 lim_at_start
= (char *) sbrk (0);
655 scoped_command_stats
stat_reporter (false);
657 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
658 setlocale (LC_MESSAGES
, "");
660 #if defined (HAVE_SETLOCALE)
661 setlocale (LC_CTYPE
, "");
664 bindtextdomain (PACKAGE
, LOCALEDIR
);
665 textdomain (PACKAGE
);
671 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
672 as a Windows pipe, and Windows buffers on pipes. */
673 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
676 /* Note: `error' cannot be called before this point, because the
677 caller will crash when trying to print the exception. */
678 main_ui
= new ui (stdin
, stdout
, stderr
);
679 current_ui
= main_ui
;
681 gdb_stdtarg
= gdb_stderr
;
682 gdb_stdtargin
= gdb_stdin
;
684 /* Put a CLI based uiout in place early. If the early initialization
685 files trigger any I/O then it isn't hard to reach parts of GDB that
686 assume current_uiout is not nullptr. Maybe we should just install the
687 CLI interpreter initially, then switch to the application requested
688 interpreter later? But that would (potentially) result in an
689 interpreter being instantiated "just in case". For now this feels
690 like the least effort way to protect GDB from crashing. */
691 auto temp_uiout
= std::make_unique
<cli_ui_out
> (gdb_stdout
);
692 current_uiout
= temp_uiout
.get ();
697 /* On Windows, argv[0] is not necessarily set to absolute form when
698 GDB is found along PATH, without which relocation doesn't work. */
699 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
701 gdb_program_name
= xstrdup (argv
[0]);
704 /* Prefix warning messages with the command name. */
705 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
706 = xstrprintf ("%s: warning: ", gdb_program_name
);
707 warning_pre_print
= tmp_warn_preprint
.get ();
709 current_directory
= getcwd (NULL
, 0);
710 if (current_directory
== NULL
)
711 perror_warning_with_name (_("error finding working directory"));
713 /* Set the sysroot path. */
714 gdb_sysroot
= relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
715 TARGET_SYSTEM_ROOT_RELOCATABLE
);
717 if (gdb_sysroot
.empty ())
718 gdb_sysroot
= TARGET_SYSROOT_PREFIX
;
721 = relocate_gdb_directory (DEBUGDIR
, DEBUGDIR_RELOCATABLE
);
723 #ifdef ADDITIONAL_DEBUG_DIRS
724 debug_file_directory
= (debug_file_directory
+ DIRNAME_SEPARATOR
725 + ADDITIONAL_DEBUG_DIRS
);
728 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
729 GDB_DATADIR_RELOCATABLE
);
731 #ifdef WITH_PYTHON_LIBDIR
732 python_libdir
= relocate_gdb_directory (WITH_PYTHON_LIBDIR
,
733 PYTHON_LIBDIR_RELOCATABLE
);
737 add_substitute_path_rule (RELOC_SRCDIR
,
738 make_relative_prefix (gdb_program_name
, BINDIR
,
742 /* There will always be an interpreter. Either the one passed into
743 this captured main, or one specified by the user at start up, or
744 the console. Initialize the interpreter to the one requested by
746 interpreter_p
= context
->interpreter_p
;
748 /* Parse arguments and options. */
751 /* When var field is 0, use flag field to record the equivalent
752 short option (or arbitrary numbers starting at 10 for those
753 with no equivalent). */
769 /* This struct requires int* in the struct, but write_files is a bool.
770 So use this temporary int that we write back after argument parsing. */
771 int write_files_1
= 0;
772 static struct option long_options
[] =
774 {"tui", no_argument
, 0, OPT_TUI
},
775 {"readnow", no_argument
, NULL
, OPT_READNOW
},
776 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
777 {"r", no_argument
, NULL
, OPT_READNOW
},
778 {"quiet", no_argument
, &quiet
, 1},
779 {"q", no_argument
, &quiet
, 1},
780 {"silent", no_argument
, &quiet
, 1},
781 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
782 {"nx", no_argument
, &inhibit_gdbinit
, 1},
783 {"n", no_argument
, &inhibit_gdbinit
, 1},
784 {"batch-silent", no_argument
, 0, 'B'},
785 {"batch", no_argument
, &batch_flag
, 1},
787 /* This is a synonym for "--annotate=1". --annotate is now
788 preferred, but keep this here for a long time because people
789 will be running emacses which use --fullname. */
790 {"fullname", no_argument
, 0, 'f'},
791 {"f", no_argument
, 0, 'f'},
793 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
794 {"help", no_argument
, &print_help
, 1},
795 {"se", required_argument
, 0, OPT_SE
},
796 {"symbols", required_argument
, 0, 's'},
797 {"s", required_argument
, 0, 's'},
798 {"exec", required_argument
, 0, 'e'},
799 {"e", required_argument
, 0, 'e'},
800 {"core", required_argument
, 0, 'c'},
801 {"c", required_argument
, 0, 'c'},
802 {"pid", required_argument
, 0, 'p'},
803 {"p", required_argument
, 0, 'p'},
804 {"command", required_argument
, 0, 'x'},
805 {"eval-command", required_argument
, 0, 'X'},
806 {"version", no_argument
, &print_version
, 1},
807 {"configuration", no_argument
, &print_configuration
, 1},
808 {"x", required_argument
, 0, 'x'},
809 {"ex", required_argument
, 0, 'X'},
810 {"init-command", required_argument
, 0, OPT_IX
},
811 {"init-eval-command", required_argument
, 0, OPT_IEX
},
812 {"ix", required_argument
, 0, OPT_IX
},
813 {"iex", required_argument
, 0, OPT_IEX
},
814 {"early-init-command", required_argument
, 0, OPT_EIX
},
815 {"early-init-eval-command", required_argument
, 0, OPT_EIEX
},
816 {"eix", required_argument
, 0, OPT_EIX
},
817 {"eiex", required_argument
, 0, OPT_EIEX
},
819 {"tclcommand", required_argument
, 0, 'z'},
820 {"enable-external-editor", no_argument
, 0, 'y'},
821 {"editor-command", required_argument
, 0, 'w'},
823 {"ui", required_argument
, 0, 'i'},
824 {"interpreter", required_argument
, 0, 'i'},
825 {"i", required_argument
, 0, 'i'},
826 {"directory", required_argument
, 0, 'd'},
827 {"d", required_argument
, 0, 'd'},
828 {"data-directory", required_argument
, 0, 'D'},
829 {"D", required_argument
, 0, 'D'},
830 {"cd", required_argument
, 0, OPT_CD
},
831 {"tty", required_argument
, 0, 't'},
832 {"baud", required_argument
, 0, 'b'},
833 {"b", required_argument
, 0, 'b'},
834 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
835 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
836 {"w", no_argument
, NULL
, OPT_WINDOWS
},
837 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
838 {"statistics", no_argument
, 0, OPT_STATISTICS
},
839 {"write", no_argument
, &write_files_1
, 1},
840 {"args", no_argument
, &set_args
, 1},
841 {"l", required_argument
, 0, 'l'},
842 {"return-child-result", no_argument
, &return_child_result
, 1},
843 {0, no_argument
, 0, 0}
850 c
= getopt_long_only (argc
, argv
, "",
851 long_options
, &option_index
);
852 if (c
== EOF
|| set_args
)
855 /* Long option that takes an argument. */
856 if (c
== 0 && long_options
[option_index
].flag
== 0)
857 c
= long_options
[option_index
].val
;
862 /* Long option that just sets a flag. */
872 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
873 annotation_level
= atoi (optarg
);
876 /* Enable the display of both time and space usage. */
877 set_per_command_time (1);
878 set_per_command_space (1);
881 /* --tui is equivalent to -i=tui. */
883 interpreter_p
= INTERP_TUI
;
885 error (_("%s: TUI mode is not supported"), gdb_program_name
);
889 /* FIXME: cagney/2003-03-01: Not sure if this option is
890 actually useful, and if it is, what it should do. */
892 /* --windows is equivalent to -i=insight. */
893 interpreter_p
= INTERP_INSIGHT
;
897 /* -nw is equivalent to -i=console. */
898 interpreter_p
= INTERP_CONSOLE
;
901 annotation_level
= 1;
916 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
919 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
922 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
925 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
928 cmdarg_vec
.emplace_back (CMDARG_EARLYINIT_FILE
, optarg
);
931 cmdarg_vec
.emplace_back (CMDARG_EARLYINIT_COMMAND
, optarg
);
934 batch_flag
= batch_silent
= 1;
935 gdb_stdout
= new null_file ();
938 if (optarg
[0] == '\0')
939 error (_("%s: empty path for `--data-directory'"),
941 set_gdb_data_directory (optarg
);
942 gdb_datadir_provided
= 1;
947 if (!gdbtk_test (optarg
))
948 error (_("%s: unable to load tclcommand file \"%s\""),
949 gdb_program_name
, optarg
);
953 /* Backwards compatibility only. */
957 /* Set the external editor commands when gdb is farming out files
958 to be edited by another program. */
959 external_editor_command
= xstrdup (optarg
);
964 interpreter_p
= optarg
;
967 dirarg
.push_back (optarg
);
980 rate
= strtol (optarg
, &p
, 0);
981 if (rate
== 0 && p
== optarg
)
982 warning (_("could not set baud rate to `%s'."),
993 timeout
= strtol (optarg
, &p
, 0);
994 if (timeout
== 0 && p
== optarg
)
995 warning (_("could not set timeout limit to `%s'."),
998 remote_timeout
= timeout
;
1004 readnow_symbol_files
= 1;
1005 validate_readnow_readnever ();
1011 readnever_symbol_files
= 1;
1012 validate_readnow_readnever ();
1017 error (_("Use `%s --help' for a complete list of options."),
1021 write_files
= (write_files_1
!= 0);
1027 /* Disable all output styling when running in batch mode. */
1032 save_original_signals_state (quiet
);
1034 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
1035 gdb::alternate_signal_stack signal_stack
;
1037 /* Initialize all files. */
1040 /* Process early init files and early init options from the command line. */
1041 if (!inhibit_gdbinit
)
1043 std::string home_gdbearlyinit
;
1044 get_earlyinit_files (&home_gdbearlyinit
);
1045 if (!home_gdbearlyinit
.empty () && !inhibit_home_gdbinit
)
1046 ret
= catch_command_errors (source_script
,
1047 home_gdbearlyinit
.c_str (), 0);
1049 execute_cmdargs (&cmdarg_vec
, CMDARG_EARLYINIT_FILE
,
1050 CMDARG_EARLYINIT_COMMAND
, &ret
);
1052 /* Set the thread pool size here, so the size can be influenced by the
1053 early initialization commands. */
1054 update_thread_pool_size ();
1056 /* Initialize the extension languages. */
1057 ext_lang_initialization ();
1059 /* Recheck if we're starting up quietly after processing the startup
1060 scripts and commands. */
1062 quiet
= check_quiet_mode ();
1064 /* Now that gdb_init has created the initial inferior, we're in
1065 position to set args for that inferior. */
1068 /* The remaining options are the command-line options for the
1069 inferior. The first one is the sym/exec file, and the rest
1072 error (_("%s: `--args' specified but no program specified"),
1075 symarg
= argv
[optind
];
1076 execarg
= argv
[optind
];
1078 current_inferior ()->set_args
1079 (gdb::array_view
<char * const> (&argv
[optind
], argc
- optind
));
1083 /* OK, that's all the options. */
1085 /* The first argument, if specified, is the name of the
1089 symarg
= argv
[optind
];
1090 execarg
= argv
[optind
];
1094 /* If the user hasn't already specified a PID or the name of a
1095 core file, then a second optional argument is allowed. If
1096 present, this argument should be interpreted as either a
1097 PID or a core file, whichever works. */
1098 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
1100 pid_or_core_arg
= argv
[optind
];
1104 /* Any argument left on the command line is unexpected and
1105 will be ignored. Inform the user. */
1107 gdb_printf (gdb_stderr
,
1108 _("Excess command line "
1109 "arguments ignored. (%s%s)\n"),
1111 (optind
== argc
- 1) ? "" : " ...");
1114 /* Lookup gdbinit files. Note that the gdbinit file name may be
1115 overridden during file initialization, so get_init_files should be
1116 called after gdb_init. */
1117 std::vector
<std::string
> system_gdbinit
;
1118 std::string home_gdbinit
;
1119 std::string local_gdbinit
;
1120 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1122 /* Do these (and anything which might call wrap_here or *_filtered)
1123 after initialize_all_files() but before the interpreter has been
1124 installed. Otherwize the help/version messages will be eaten by
1125 the interpreter's output handler. */
1129 print_gdb_version (gdb_stdout
, false);
1136 print_gdb_help (gdb_stdout
);
1140 if (print_configuration
)
1142 print_gdb_configuration (gdb_stdout
);
1147 /* Install the default UI. All the interpreters should have had a
1148 look at things by now. Initialize the default interpreter. */
1149 set_top_level_interpreter (interpreter_p
.c_str (), false);
1151 /* The interpreter should have installed the real uiout by now. */
1152 gdb_assert (current_uiout
!= temp_uiout
.get ());
1153 temp_uiout
= nullptr;
1157 /* Print all the junk at the top, with trailing "..." if we are
1158 about to read a symbol file (possibly slowly). */
1159 print_gdb_version (gdb_stdout
, true);
1163 gdb_flush (gdb_stdout
); /* Force to screen during slow
1167 /* Set off error and warning messages with a blank line. */
1168 tmp_warn_preprint
.reset ();
1169 warning_pre_print
= _("\nwarning: ");
1171 /* Read and execute the system-wide gdbinit file, if it exists.
1172 This is done *before* all the command line arguments are
1173 processed; it sets global parameters, which are independent of
1174 what file you are debugging or what directory you are in. */
1175 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
1177 for (const std::string
&file
: system_gdbinit
)
1178 ret
= catch_command_errors (source_script
, file
.c_str (), 0);
1181 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
1182 *before* all the command line arguments are processed; it sets
1183 global parameters, which are independent of what file you are
1184 debugging or what directory you are in. */
1186 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1187 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1189 /* Process '-ix' and '-iex' options early. */
1190 execute_cmdargs (&cmdarg_vec
, CMDARG_INIT_FILE
, CMDARG_INIT_COMMAND
, &ret
);
1192 /* Now perform all the actions indicated by the arguments. */
1195 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1198 for (i
= 0; i
< dirarg
.size (); i
++)
1199 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1201 /* Skip auto-loading section-specified scripts until we've sourced
1202 local_gdbinit (which is often used to augment the source search
1204 save_auto_load
= global_auto_load
;
1205 global_auto_load
= 0;
1209 && strcmp (execarg
, symarg
) == 0)
1211 /* The exec file and the symbol-file are the same. If we can't
1212 open it, better only print one error message.
1213 catch_command_errors returns non-zero on success! */
1214 ret
= catch_command_errors (exec_file_attach
, execarg
,
1217 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1218 symarg
, !batch_flag
);
1222 if (execarg
!= NULL
)
1223 ret
= catch_command_errors (exec_file_attach
, execarg
,
1226 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1227 symarg
, !batch_flag
);
1230 if (corearg
&& pidarg
)
1231 error (_("Can't attach to process and specify "
1232 "a core file at the same time."));
1234 if (corearg
!= NULL
)
1236 ret
= catch_command_errors (core_file_command
, corearg
,
1239 else if (pidarg
!= NULL
)
1241 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1243 else if (pid_or_core_arg
)
1245 /* The user specified 'gdb program pid' or gdb program core'.
1246 If pid_or_core_arg's first character is a digit, try attach
1247 first and then corefile. Otherwise try just corefile. */
1249 if (isdigit (pid_or_core_arg
[0]))
1251 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1254 ret
= catch_command_errors (core_file_command
,
1260 /* Can't be a pid, better be a corefile. */
1261 ret
= catch_command_errors (core_file_command
,
1268 current_inferior ()->set_tty (ttyarg
);
1270 /* Error messages should no longer be distinguished with extra output. */
1271 warning_pre_print
= _("warning: ");
1273 /* Read the .gdbinit file in the current directory, *if* it isn't
1274 the same as the $HOME/.gdbinit file (it should exist, also). */
1275 if (!local_gdbinit
.empty ())
1277 auto_load_local_gdbinit_pathname
1278 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1280 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
)
1282 auto_load_debug_printf ("Loading .gdbinit file \"%s\".",
1283 local_gdbinit
.c_str ());
1285 if (file_is_auto_load_safe (local_gdbinit
.c_str ()))
1287 auto_load_local_gdbinit_loaded
= 1;
1289 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1294 /* Now that all .gdbinit's have been read and all -d options have been
1295 processed, we can read any scripts mentioned in SYMARG.
1296 We wait until now because it is common to add to the source search
1297 path in local_gdbinit. */
1298 global_auto_load
= save_auto_load
;
1299 for (objfile
*objfile
: current_program_space
->objfiles ())
1300 load_auto_scripts_for_objfile (objfile
);
1302 /* Process '-x' and '-ex' options. */
1303 execute_cmdargs (&cmdarg_vec
, CMDARG_FILE
, CMDARG_COMMAND
, &ret
);
1307 int error_status
= EXIT_FAILURE
;
1308 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1310 /* We have hit the end of the batch file. */
1311 quit_force (exit_arg
, 0);
1314 /* We are starting an interactive session. */
1316 /* Read in the history. This is after all the command files have been read,
1317 so that the user can change the history file via a .gdbinit file. This
1318 is also after the batch_flag check, because we don't need the history in
1324 captured_main (void *data
)
1326 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1328 captured_main_1 (context
);
1330 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1331 moving this loop and the code found in captured_command_loop()
1332 into the command_loop() proper. The main thing holding back that
1333 change - SET_TOP_LEVEL() - has been eliminated. */
1338 captured_command_loop ();
1340 catch (const gdb_exception_forced_quit
&ex
)
1342 quit_force (NULL
, 0);
1344 catch (const gdb_exception
&ex
)
1346 exception_print (gdb_stderr
, ex
);
1349 /* No exit -- exit is through quit_command. */
1353 gdb_main (struct captured_main_args
*args
)
1357 captured_main (args
);
1359 catch (const gdb_exception
&ex
)
1361 exception_print (gdb_stderr
, ex
);
1364 /* The only way to end up here is by an error (normal exit is
1365 handled by quit_force()), hence always return an error status. */
1370 /* Don't use *_filtered for printing help. We don't want to prompt
1371 for continue no matter how small the screen or how much we're going
1375 print_gdb_help (struct ui_file
*stream
)
1377 std::vector
<std::string
> system_gdbinit
;
1378 std::string home_gdbinit
;
1379 std::string local_gdbinit
;
1380 std::string home_gdbearlyinit
;
1382 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1383 get_earlyinit_files (&home_gdbearlyinit
);
1385 /* Note: The options in the list below are only approximately sorted
1386 in the alphabetical order, so as to group closely related options
1389 This is the GNU debugger. Usage:\n\n\
1390 gdb [options] [executable-file [core-file or process-id]]\n\
1391 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1394 Selection of debuggee and its files:\n\n\
1395 --args Arguments after executable-file are passed to inferior.\n\
1396 --core=COREFILE Analyze the core dump COREFILE.\n\
1397 --exec=EXECFILE Use EXECFILE as the executable.\n\
1398 --pid=PID Attach to running process PID.\n\
1399 --directory=DIR Search for source files in DIR.\n\
1400 --se=FILE Use FILE as symbol file and executable file.\n\
1401 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1402 --readnow Fully read symbol files on first access.\n\
1403 --readnever Do not read symbol files.\n\
1404 --write Set writing into executable and core files.\n\n\
1407 Initial commands and command files:\n\n\
1408 --command=FILE, -x Execute GDB commands from FILE.\n\
1409 --init-command=FILE, -ix\n\
1410 Like -x but execute commands before loading inferior.\n\
1411 --eval-command=COMMAND, -ex\n\
1412 Execute a single GDB command.\n\
1413 May be used multiple times and in conjunction\n\
1415 --init-eval-command=COMMAND, -iex\n\
1416 Like -ex but before loading inferior.\n\
1417 --nh Do not read ~/.gdbinit.\n\
1418 --nx Do not read any .gdbinit files in any directory.\n\n\
1421 Output and user interface control:\n\n\
1422 --fullname Output information used by emacs-GDB interface.\n\
1423 --interpreter=INTERP\n\
1424 Select a specific interpreter / user interface.\n\
1425 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1426 -w Use the GUI interface.\n\
1427 --nw Do not use the GUI interface.\n\
1431 --tui Use a terminal user interface.\n\
1435 -q, --quiet, --silent\n\
1436 Do not print version number on startup.\n\n\
1439 Operating modes:\n\n\
1440 --batch Exit after processing options.\n\
1441 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1442 --return-child-result\n\
1443 GDB exit code will be the child's exit code.\n\
1444 --configuration Print details about GDB configuration and then exit.\n\
1445 --help Print this message and then exit.\n\
1446 --version Print version information and then exit.\n\n\
1447 Remote debugging options:\n\n\
1448 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1449 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1451 --cd=DIR Change current directory to DIR.\n\
1452 --data-directory=DIR, -D\n\
1453 Set GDB's data-directory to DIR.\n\
1456 At startup, GDB reads the following early init files and executes their\n\
1459 if (!home_gdbearlyinit
.empty ())
1460 gdb_printf (stream
, _("\
1461 * user-specific early init file: %s\n\
1462 "), home_gdbearlyinit
.c_str ());
1463 if (home_gdbearlyinit
.empty ())
1464 gdb_printf (stream
, _("\
1467 At startup, GDB reads the following init files and executes their commands:\n\
1469 if (!system_gdbinit
.empty ())
1472 for (size_t idx
= 0; idx
< system_gdbinit
.size (); ++idx
)
1474 output
+= system_gdbinit
[idx
];
1475 if (idx
< system_gdbinit
.size () - 1)
1478 gdb_printf (stream
, _("\
1479 * system-wide init files: %s\n\
1480 "), output
.c_str ());
1482 if (!home_gdbinit
.empty ())
1483 gdb_printf (stream
, _("\
1484 * user-specific init file: %s\n\
1485 "), home_gdbinit
.c_str ());
1486 if (!local_gdbinit
.empty ())
1487 gdb_printf (stream
, _("\
1488 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1489 "), local_gdbinit
.c_str ());
1490 if (system_gdbinit
.empty () && home_gdbinit
.empty ()
1491 && local_gdbinit
.empty ())
1492 gdb_printf (stream
, _("\
1495 For more information, type \"help\" from within GDB, or consult the\n\
1496 GDB manual (available as on-line info or a printed manual).\n\
1498 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1499 gdb_printf (stream
, _("\n\
1500 Report bugs to %ps.\n\
1501 "), styled_string (file_name_style
.style (), REPORT_BUGS_TO
));
1502 if (stream
== gdb_stdout
)
1503 gdb_printf (stream
, _("\n\
1504 You can ask GDB-related questions on the GDB users mailing list\n\
1505 (gdb@sourceware.org) or on GDB's IRC channel (#gdb on Libera.Chat).\n"));