1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2023 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/>. */
29 #include <sys/types.h>
32 #include "gdbsupport/event-loop.h"
38 #include "cli/cli-cmds.h"
40 #include "auto-load.h"
43 #include "filenames.h"
44 #include "gdbsupport/filestuff.h"
46 #include "event-top.h"
48 #include "gdbsupport/signals-state-save-restore.h"
51 #include "gdbsupport/pathstuff.h"
52 #include "cli/cli-style.h"
54 #include "gdbtk/generic/gdbtk.h"
56 #include "gdbsupport/alt-stack.h"
57 #include "observable.h"
60 /* The selected interpreter. */
61 std::string interpreter_p
;
63 /* System root path, used to find libraries etc. */
64 std::string gdb_sysroot
;
66 /* GDB datadir, used to store data files. */
67 std::string gdb_datadir
;
69 /* Non-zero if GDB_DATADIR was provided on the command line.
70 This doesn't track whether data-directory is set later from the
71 command line, but we don't reread system.gdbinit when that happens. */
72 static int gdb_datadir_provided
= 0;
74 /* If gdb was configured with --with-python=/path,
75 the possibly relocated path to python's lib directory. */
76 std::string python_libdir
;
78 /* Target IO streams. */
79 struct ui_file
*gdb_stdtargin
;
80 struct ui_file
*gdb_stdtarg
;
81 struct ui_file
*gdb_stdtargerr
;
83 /* True if --batch or --batch-silent was seen. */
86 /* Support for the --batch-silent option. */
89 /* Support for --return-child-result option.
90 Set the default to -1 to return error in the case
91 that the program does not run or does not complete. */
92 int return_child_result
= 0;
93 int return_child_result_value
= -1;
96 /* GDB as it has been invoked from the command line (i.e. argv[0]). */
97 static char *gdb_program_name
;
99 /* Return read only pointer to GDB_PROGRAM_NAME. */
101 get_gdb_program_name (void)
103 return gdb_program_name
;
106 static void print_gdb_help (struct ui_file
*);
108 /* Set the data-directory parameter to NEW_DATADIR.
109 If NEW_DATADIR is not a directory then a warning is printed.
110 We don't signal an error for backward compatibility. */
113 set_gdb_data_directory (const char *new_datadir
)
117 if (stat (new_datadir
, &st
) < 0)
119 int save_errno
= errno
;
121 gdb_printf (gdb_stderr
, "Warning: ");
122 print_sys_errmsg (new_datadir
, save_errno
);
124 else if (!S_ISDIR (st
.st_mode
))
125 warning (_("%ps is not a directory."),
126 styled_string (file_name_style
.style (), new_datadir
));
128 gdb_datadir
= gdb_realpath (new_datadir
).get ();
130 /* gdb_realpath won't return an absolute path if the path doesn't exist,
131 but we still want to record an absolute path here. If the user entered
132 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
133 isn't canonical, but that's ok. */
134 if (!IS_ABSOLUTE_PATH (gdb_datadir
.c_str ()))
135 gdb_datadir
= gdb_abspath (gdb_datadir
.c_str ());
138 /* Relocate a file or directory. PROGNAME is the name by which gdb
139 was invoked (i.e., argv[0]). INITIAL is the default value for the
140 file or directory. RELOCATABLE is true if the value is relocatable,
141 false otherwise. This may return an empty string under the same
142 conditions as make_relative_prefix returning NULL. */
145 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
149 gdb::unique_xmalloc_ptr
<char> str (make_relative_prefix (progname
,
154 return std::string ();
159 /* Like relocate_path, but specifically checks for a directory.
160 INITIAL is relocated according to the rules of relocate_path. If
161 the result is a directory, it is used; otherwise, INITIAL is used.
162 The chosen directory is then canonicalized using lrealpath. */
165 relocate_gdb_directory (const char *initial
, bool relocatable
)
167 std::string dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
172 if (stat (dir
.c_str (), &s
) != 0 || !S_ISDIR (s
.st_mode
))
180 /* Canonicalize the directory. */
183 gdb::unique_xmalloc_ptr
<char> canon_sysroot (lrealpath (dir
.c_str ()));
186 dir
= canon_sysroot
.get ();
192 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
193 parameter if it is in the data dir, or passes it through relocate_path
197 relocate_file_path_maybe_in_datadir (const std::string
&file
,
200 size_t datadir_len
= strlen (GDB_DATADIR
);
202 std::string relocated_path
;
204 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
205 has been provided, search for SYSTEM_GDBINIT there. */
206 if (gdb_datadir_provided
207 && datadir_len
< file
.length ()
208 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
209 && IS_DIR_SEPARATOR (file
[datadir_len
]))
211 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
214 size_t start
= datadir_len
;
215 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
217 relocated_path
= gdb_datadir
+ SLASH_STRING
+ file
.substr (start
);
221 relocated_path
= relocate_path (gdb_program_name
, file
.c_str (),
224 return relocated_path
;
227 /* A class to wrap up the logic for finding the three different types of
228 initialisation files GDB uses, system wide, home directory, and current
229 working directory. */
231 class gdb_initfile_finder
234 /* Constructor. Finds initialisation files named FILENAME in the home
235 directory or local (current working) directory. System initialisation
236 files are found in both SYSTEM_FILENAME and SYSTEM_DIRNAME if these
237 are not nullptr (either or both can be). The matching *_RELOCATABLE
238 flag is passed through to RELOCATE_FILE_PATH_MAYBE_IN_DATADIR.
240 If FILENAME starts with a '.' then when looking in the home directory
241 this first '.' can be ignored in some cases. */
242 explicit gdb_initfile_finder (const char *filename
,
243 const char *system_filename
,
244 bool system_filename_relocatable
,
245 const char *system_dirname
,
246 bool system_dirname_relocatable
,
247 bool lookup_local_file
)
251 if (system_filename
!= nullptr && system_filename
[0] != '\0')
253 std::string relocated_filename
254 = relocate_file_path_maybe_in_datadir (system_filename
,
255 system_filename_relocatable
);
256 if (!relocated_filename
.empty ()
257 && stat (relocated_filename
.c_str (), &s
) == 0)
258 m_system_files
.push_back (relocated_filename
);
261 if (system_dirname
!= nullptr && system_dirname
[0] != '\0')
263 std::string relocated_dirname
264 = relocate_file_path_maybe_in_datadir (system_dirname
,
265 system_dirname_relocatable
);
266 if (!relocated_dirname
.empty ())
268 gdb_dir_up
dir (opendir (relocated_dirname
.c_str ()));
271 std::vector
<std::string
> files
;
274 struct dirent
*ent
= readdir (dir
.get ());
277 std::string
name (ent
->d_name
);
278 if (name
== "." || name
== "..")
280 /* ent->d_type is not available on all systems
281 (e.g. mingw, Solaris), so we have to call stat(). */
282 std::string tmp_filename
283 = relocated_dirname
+ SLASH_STRING
+ name
;
284 if (stat (tmp_filename
.c_str (), &s
) != 0
285 || !S_ISREG (s
.st_mode
))
287 const struct extension_language_defn
*extlang
288 = get_ext_lang_of_file (tmp_filename
.c_str ());
289 /* We effectively don't support "set script-extension
290 off/soft", because we are loading system init files
291 here, so it does not really make sense to depend on
293 if (extlang
!= nullptr && ext_lang_present_p (extlang
))
294 files
.push_back (std::move (tmp_filename
));
296 std::sort (files
.begin (), files
.end ());
297 m_system_files
.insert (m_system_files
.end (),
298 files
.begin (), files
.end ());
303 /* If the .gdbinit file in the current directory is the same as
304 the $HOME/.gdbinit file, it should not be sourced. homebuf
305 and cwdbuf are used in that purpose. Make sure that the stats
306 are zero in case one of them fails (this guarantees that they
307 won't match if either exists). */
309 struct stat homebuf
, cwdbuf
;
310 memset (&homebuf
, 0, sizeof (struct stat
));
311 memset (&cwdbuf
, 0, sizeof (struct stat
));
313 m_home_file
= find_gdb_home_config_file (filename
, &homebuf
);
315 if (lookup_local_file
&& stat (filename
, &cwdbuf
) == 0)
317 if (m_home_file
.empty ()
318 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
319 sizeof (struct stat
)))
320 m_local_file
= filename
;
324 DISABLE_COPY_AND_ASSIGN (gdb_initfile_finder
);
326 /* Return a list of system initialisation files. The list could be
328 const std::vector
<std::string
> &system_files () const
329 { return m_system_files
; }
331 /* Return the path to the home initialisation file. The string can be
332 empty if there is no such file. */
333 const std::string
&home_file () const
334 { return m_home_file
; }
336 /* Return the path to the local initialisation file. The string can be
337 empty if there is no such file. */
338 const std::string
&local_file () const
339 { return m_local_file
; }
343 /* Vector of all system init files in the order they should be processed.
345 std::vector
<std::string
> m_system_files
;
347 /* Initialization file from the home directory. Could be the empty
348 string if there is no such file found. */
349 std::string m_home_file
;
351 /* Initialization file from the current working directory. Could be the
352 empty string if there is no such file found. */
353 std::string m_local_file
;
356 /* Compute the locations of init files that GDB should source and return
357 them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. The SYSTEM_GDBINIT
358 can be returned as an empty vector, and HOME_GDBINIT and LOCAL_GDBINIT
359 can be returned as empty strings if there is no init file of that
363 get_init_files (std::vector
<std::string
> *system_gdbinit
,
364 std::string
*home_gdbinit
,
365 std::string
*local_gdbinit
)
367 /* Cache the file lookup object so we only actually search for the files
369 static gdb::optional
<gdb_initfile_finder
> init_files
;
370 if (!init_files
.has_value ())
371 init_files
.emplace (GDBINIT
, SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
,
372 SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
,
375 *system_gdbinit
= init_files
->system_files ();
376 *home_gdbinit
= init_files
->home_file ();
377 *local_gdbinit
= init_files
->local_file ();
380 /* Compute the location of the early init file GDB should source and return
381 it in HOME_GDBEARLYINIT. HOME_GDBEARLYINIT could be returned as an
382 empty string if there is no early init file found. */
385 get_earlyinit_files (std::string
*home_gdbearlyinit
)
387 /* Cache the file lookup object so we only actually search for the files
389 static gdb::optional
<gdb_initfile_finder
> init_files
;
390 if (!init_files
.has_value ())
391 init_files
.emplace (GDBEARLYINIT
, nullptr, false, nullptr, false, false);
393 *home_gdbearlyinit
= init_files
->home_file ();
396 /* Start up the event loop. This is the entry point to the event loop
397 from the command loop. */
402 /* Loop until there is nothing to do. This is the entry point to
403 the event loop engine. gdb_do_one_event will process one event
404 for each invocation. It blocks waiting for an event and then
412 result
= gdb_do_one_event ();
414 catch (const gdb_exception_forced_quit
&ex
)
418 catch (const gdb_exception
&ex
)
420 exception_print (gdb_stderr
, ex
);
422 /* If any exception escaped to here, we better enable
423 stdin. Otherwise, any command that calls async_disable_stdin,
424 and then throws, will leave stdin inoperable. */
425 SWITCH_THRU_ALL_UIS ()
427 async_enable_stdin ();
429 /* If we long-jumped out of do_one_event, we probably didn't
430 get around to resetting the prompt, which leaves readline
431 in a messed-up state. Reset it here. */
432 current_ui
->prompt_state
= PROMPT_NEEDED
;
433 top_level_interpreter ()->on_command_error ();
434 /* This call looks bizarre, but it is required. If the user
435 entered a command that caused an error,
436 after_char_processing_hook won't be called from
437 rl_callback_read_char_wrapper. Using a cleanup there
438 won't work, since we want this function to be called
439 after a new prompt is printed. */
440 if (after_char_processing_hook
)
441 (*after_char_processing_hook
) ();
442 /* Maybe better to set a flag to be checked somewhere as to
443 whether display the prompt or not. */
450 /* We are done with the event loop. There are no more event sources
451 to listen to. So we exit GDB. */
455 /* Call command_loop. */
457 /* Prevent inlining this function for the benefit of GDB's selftests
458 in the testsuite. Those tests want to run GDB under GDB and stop
460 static void captured_command_loop () __attribute__((noinline
));
463 captured_command_loop ()
465 struct ui
*ui
= current_ui
;
467 /* Top-level execution commands can be run in the background from
469 current_ui
->async
= 1;
471 /* Give the interpreter a chance to print a prompt, if necessary */
472 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
473 interp_pre_command_loop (top_level_interpreter ());
475 /* Now it's time to start the event loop. */
478 /* If the command_loop returned, normally (rather than threw an
479 error) we try to quit. If the quit is aborted, our caller
480 catches the signal and restarts the command loop. */
481 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
484 /* Handle command errors thrown from within catch_command_errors. */
487 handle_command_errors (const struct gdb_exception
&e
)
491 exception_print (gdb_stderr
, e
);
493 /* If any exception escaped to here, we better enable stdin.
494 Otherwise, any command that calls async_disable_stdin, and
495 then throws, will leave stdin inoperable. */
496 async_enable_stdin ();
502 /* Type of the command callback passed to the const
503 catch_command_errors. */
505 typedef void (catch_command_errors_const_ftype
) (const char *, int);
507 /* Wrap calls to commands run before the event loop is started. */
510 catch_command_errors (catch_command_errors_const_ftype command
,
511 const char *arg
, int from_tty
,
512 bool do_bp_actions
= false)
516 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
518 command (arg
, from_tty
);
520 maybe_wait_sync_command_done (was_sync
);
522 /* Do any commands attached to breakpoint we stopped at. */
524 bpstat_do_actions ();
526 catch (const gdb_exception_forced_quit
&e
)
528 quit_force (NULL
, 0);
530 catch (const gdb_exception
&e
)
532 return handle_command_errors (e
);
538 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
539 symfile_add_flags. */
542 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
544 symfile_add_flags add_flags
= 0;
547 add_flags
|= SYMFILE_VERBOSE
;
549 symbol_file_add_main (arg
, add_flags
);
552 /* Perform validation of the '--readnow' and '--readnever' flags. */
555 validate_readnow_readnever ()
557 if (readnever_symbol_files
&& readnow_symbol_files
)
559 error (_("%s: '--readnow' and '--readnever' cannot be "
560 "specified simultaneously"),
565 /* Type of this option. */
568 /* Option type -x. */
571 /* Option type -ex. */
574 /* Option type -ix. */
577 /* Option type -iex. */
580 /* Option type -eix. */
581 CMDARG_EARLYINIT_FILE
,
583 /* Option type -eiex. */
584 CMDARG_EARLYINIT_COMMAND
587 /* Arguments of --command option and its counterpart. */
590 cmdarg (cmdarg_kind type_
, char *string_
)
591 : type (type_
), string (string_
)
594 /* Type of this option. */
595 enum cmdarg_kind type
;
597 /* Value of this option - filename or the GDB command itself. String memory
598 is not owned by this structure despite it is 'const'. */
602 /* From CMDARG_VEC execute command files (matching FILE_TYPE) or commands
603 (matching CMD_TYPE). Update the value in *RET if and scripts or
604 commands are executed. */
607 execute_cmdargs (const std::vector
<struct cmdarg
> *cmdarg_vec
,
608 cmdarg_kind file_type
, cmdarg_kind cmd_type
,
611 for (const auto &cmdarg_p
: *cmdarg_vec
)
613 if (cmdarg_p
.type
== file_type
)
614 *ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
616 else if (cmdarg_p
.type
== cmd_type
)
617 *ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
623 captured_main_1 (struct captured_main_args
*context
)
625 int argc
= context
->argc
;
626 char **argv
= context
->argv
;
628 static int quiet
= 0;
629 static int set_args
= 0;
630 static int inhibit_home_gdbinit
= 0;
632 /* Pointers to various arguments from command line. */
634 char *execarg
= NULL
;
636 char *corearg
= NULL
;
637 char *pid_or_core_arg
= NULL
;
641 /* These are static so that we can take their address in an
643 static int print_help
;
644 static int print_version
;
645 static int print_configuration
;
647 /* Pointers to all arguments of --command option. */
648 std::vector
<struct cmdarg
> cmdarg_vec
;
650 /* All arguments of --directory option. */
651 std::vector
<char *> dirarg
;
657 #ifdef HAVE_USEFUL_SBRK
658 /* Set this before constructing scoped_command_stats. */
659 lim_at_start
= (char *) sbrk (0);
662 scoped_command_stats
stat_reporter (false);
664 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
665 setlocale (LC_MESSAGES
, "");
667 #if defined (HAVE_SETLOCALE)
668 setlocale (LC_CTYPE
, "");
671 bindtextdomain (PACKAGE
, LOCALEDIR
);
672 textdomain (PACKAGE
);
678 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
679 as a Windows pipe, and Windows buffers on pipes. */
680 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
683 /* Note: `error' cannot be called before this point, because the
684 caller will crash when trying to print the exception. */
685 main_ui
= new ui (stdin
, stdout
, stderr
);
686 current_ui
= main_ui
;
688 gdb_stdtarg
= gdb_stderr
;
689 gdb_stdtargerr
= gdb_stderr
;
690 gdb_stdtargin
= gdb_stdin
;
692 if (bfd_init () != BFD_INIT_MAGIC
)
693 error (_("fatal error: libbfd ABI mismatch"));
696 /* On Windows, argv[0] is not necessarily set to absolute form when
697 GDB is found along PATH, without which relocation doesn't work. */
698 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
700 gdb_program_name
= xstrdup (argv
[0]);
703 /* Prefix warning messages with the command name. */
704 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
705 = xstrprintf ("%s: warning: ", gdb_program_name
);
706 warning_pre_print
= tmp_warn_preprint
.get ();
708 current_directory
= getcwd (NULL
, 0);
709 if (current_directory
== NULL
)
710 perror_warning_with_name (_("error finding working directory"));
712 /* Set the sysroot path. */
713 gdb_sysroot
= relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
714 TARGET_SYSTEM_ROOT_RELOCATABLE
);
716 if (gdb_sysroot
.empty ())
717 gdb_sysroot
= TARGET_SYSROOT_PREFIX
;
720 = relocate_gdb_directory (DEBUGDIR
, DEBUGDIR_RELOCATABLE
);
722 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
723 GDB_DATADIR_RELOCATABLE
);
725 #ifdef WITH_PYTHON_LIBDIR
726 python_libdir
= relocate_gdb_directory (WITH_PYTHON_LIBDIR
,
727 PYTHON_LIBDIR_RELOCATABLE
);
731 add_substitute_path_rule (RELOC_SRCDIR
,
732 make_relative_prefix (gdb_program_name
, BINDIR
,
736 /* There will always be an interpreter. Either the one passed into
737 this captured main, or one specified by the user at start up, or
738 the console. Initialize the interpreter to the one requested by
740 interpreter_p
= context
->interpreter_p
;
742 /* Parse arguments and options. */
745 /* When var field is 0, use flag field to record the equivalent
746 short option (or arbitrary numbers starting at 10 for those
747 with no equivalent). */
763 /* This struct requires int* in the struct, but write_files is a bool.
764 So use this temporary int that we write back after argument parsing. */
765 int write_files_1
= 0;
766 static struct option long_options
[] =
768 {"tui", no_argument
, 0, OPT_TUI
},
769 {"readnow", no_argument
, NULL
, OPT_READNOW
},
770 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
771 {"r", no_argument
, NULL
, OPT_READNOW
},
772 {"quiet", no_argument
, &quiet
, 1},
773 {"q", no_argument
, &quiet
, 1},
774 {"silent", no_argument
, &quiet
, 1},
775 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
776 {"nx", no_argument
, &inhibit_gdbinit
, 1},
777 {"n", no_argument
, &inhibit_gdbinit
, 1},
778 {"batch-silent", no_argument
, 0, 'B'},
779 {"batch", no_argument
, &batch_flag
, 1},
781 /* This is a synonym for "--annotate=1". --annotate is now
782 preferred, but keep this here for a long time because people
783 will be running emacses which use --fullname. */
784 {"fullname", no_argument
, 0, 'f'},
785 {"f", no_argument
, 0, 'f'},
787 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
788 {"help", no_argument
, &print_help
, 1},
789 {"se", required_argument
, 0, OPT_SE
},
790 {"symbols", required_argument
, 0, 's'},
791 {"s", required_argument
, 0, 's'},
792 {"exec", required_argument
, 0, 'e'},
793 {"e", required_argument
, 0, 'e'},
794 {"core", required_argument
, 0, 'c'},
795 {"c", required_argument
, 0, 'c'},
796 {"pid", required_argument
, 0, 'p'},
797 {"p", required_argument
, 0, 'p'},
798 {"command", required_argument
, 0, 'x'},
799 {"eval-command", required_argument
, 0, 'X'},
800 {"version", no_argument
, &print_version
, 1},
801 {"configuration", no_argument
, &print_configuration
, 1},
802 {"x", required_argument
, 0, 'x'},
803 {"ex", required_argument
, 0, 'X'},
804 {"init-command", required_argument
, 0, OPT_IX
},
805 {"init-eval-command", required_argument
, 0, OPT_IEX
},
806 {"ix", required_argument
, 0, OPT_IX
},
807 {"iex", required_argument
, 0, OPT_IEX
},
808 {"early-init-command", required_argument
, 0, OPT_EIX
},
809 {"early-init-eval-command", required_argument
, 0, OPT_EIEX
},
810 {"eix", required_argument
, 0, OPT_EIX
},
811 {"eiex", required_argument
, 0, OPT_EIEX
},
813 {"tclcommand", required_argument
, 0, 'z'},
814 {"enable-external-editor", no_argument
, 0, 'y'},
815 {"editor-command", required_argument
, 0, 'w'},
817 {"ui", required_argument
, 0, 'i'},
818 {"interpreter", required_argument
, 0, 'i'},
819 {"i", required_argument
, 0, 'i'},
820 {"directory", required_argument
, 0, 'd'},
821 {"d", required_argument
, 0, 'd'},
822 {"data-directory", required_argument
, 0, 'D'},
823 {"D", required_argument
, 0, 'D'},
824 {"cd", required_argument
, 0, OPT_CD
},
825 {"tty", required_argument
, 0, 't'},
826 {"baud", required_argument
, 0, 'b'},
827 {"b", required_argument
, 0, 'b'},
828 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
829 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
830 {"w", no_argument
, NULL
, OPT_WINDOWS
},
831 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
832 {"statistics", no_argument
, 0, OPT_STATISTICS
},
833 {"write", no_argument
, &write_files_1
, 1},
834 {"args", no_argument
, &set_args
, 1},
835 {"l", required_argument
, 0, 'l'},
836 {"return-child-result", no_argument
, &return_child_result
, 1},
837 {0, no_argument
, 0, 0}
844 c
= getopt_long_only (argc
, argv
, "",
845 long_options
, &option_index
);
846 if (c
== EOF
|| set_args
)
849 /* Long option that takes an argument. */
850 if (c
== 0 && long_options
[option_index
].flag
== 0)
851 c
= long_options
[option_index
].val
;
856 /* Long option that just sets a flag. */
866 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
867 annotation_level
= atoi (optarg
);
870 /* Enable the display of both time and space usage. */
871 set_per_command_time (1);
872 set_per_command_space (1);
875 /* --tui is equivalent to -i=tui. */
877 interpreter_p
= INTERP_TUI
;
879 error (_("%s: TUI mode is not supported"), gdb_program_name
);
883 /* FIXME: cagney/2003-03-01: Not sure if this option is
884 actually useful, and if it is, what it should do. */
886 /* --windows is equivalent to -i=insight. */
887 interpreter_p
= INTERP_INSIGHT
;
891 /* -nw is equivalent to -i=console. */
892 interpreter_p
= 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 interpreter_p
= optarg
;
961 dirarg
.push_back (optarg
);
974 rate
= strtol (optarg
, &p
, 0);
975 if (rate
== 0 && p
== optarg
)
976 warning (_("could not set baud rate to `%s'."),
987 timeout
= strtol (optarg
, &p
, 0);
988 if (timeout
== 0 && p
== optarg
)
989 warning (_("could not set timeout limit to `%s'."),
992 remote_timeout
= timeout
;
998 readnow_symbol_files
= 1;
999 validate_readnow_readnever ();
1005 readnever_symbol_files
= 1;
1006 validate_readnow_readnever ();
1011 error (_("Use `%s --help' for a complete list of options."),
1015 write_files
= (write_files_1
!= 0);
1021 /* Disable all output styling when running in batch mode. */
1026 save_original_signals_state (quiet
);
1028 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
1029 gdb::alternate_signal_stack signal_stack
;
1031 /* Initialize all files. */
1034 /* Process early init files and early init options from the command line. */
1035 if (!inhibit_gdbinit
)
1037 std::string home_gdbearlyinit
;
1038 get_earlyinit_files (&home_gdbearlyinit
);
1039 if (!home_gdbearlyinit
.empty () && !inhibit_home_gdbinit
)
1040 ret
= catch_command_errors (source_script
,
1041 home_gdbearlyinit
.c_str (), 0);
1043 execute_cmdargs (&cmdarg_vec
, CMDARG_EARLYINIT_FILE
,
1044 CMDARG_EARLYINIT_COMMAND
, &ret
);
1046 /* Initialize the extension languages. */
1047 ext_lang_initialization ();
1049 /* Recheck if we're starting up quietly after processing the startup
1050 scripts and commands. */
1052 quiet
= check_quiet_mode ();
1054 /* Now that gdb_init has created the initial inferior, we're in
1055 position to set args for that inferior. */
1058 /* The remaining options are the command-line options for the
1059 inferior. The first one is the sym/exec file, and the rest
1062 error (_("%s: `--args' specified but no program specified"),
1065 symarg
= argv
[optind
];
1066 execarg
= argv
[optind
];
1068 current_inferior ()->set_args
1069 (gdb::array_view
<char * const> (&argv
[optind
], argc
- 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 /* Install the default UI. All the interpreters should have had a
1138 look at things by now. Initialize the default interpreter. */
1139 set_top_level_interpreter (interpreter_p
.c_str ());
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 /* Set off error and warning messages with a blank line. */
1154 tmp_warn_preprint
.reset ();
1155 warning_pre_print
= _("\nwarning: ");
1157 /* Read and execute the system-wide gdbinit file, if it exists.
1158 This is done *before* all the command line arguments are
1159 processed; it sets global parameters, which are independent of
1160 what file you are debugging or what directory you are in. */
1161 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
1163 for (const std::string
&file
: system_gdbinit
)
1164 ret
= catch_command_errors (source_script
, file
.c_str (), 0);
1167 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
1168 *before* all the command line arguments are processed; it sets
1169 global parameters, which are independent of what file you are
1170 debugging or what directory you are in. */
1172 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1173 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1175 /* Process '-ix' and '-iex' options early. */
1176 execute_cmdargs (&cmdarg_vec
, CMDARG_INIT_FILE
, CMDARG_INIT_COMMAND
, &ret
);
1178 /* Now perform all the actions indicated by the arguments. */
1181 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1184 for (i
= 0; i
< dirarg
.size (); i
++)
1185 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1187 /* Skip auto-loading section-specified scripts until we've sourced
1188 local_gdbinit (which is often used to augment the source search
1190 save_auto_load
= global_auto_load
;
1191 global_auto_load
= 0;
1195 && strcmp (execarg
, symarg
) == 0)
1197 /* The exec file and the symbol-file are the same. If we can't
1198 open it, better only print one error message.
1199 catch_command_errors returns non-zero on success! */
1200 ret
= catch_command_errors (exec_file_attach
, execarg
,
1203 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1204 symarg
, !batch_flag
);
1208 if (execarg
!= NULL
)
1209 ret
= catch_command_errors (exec_file_attach
, execarg
,
1212 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1213 symarg
, !batch_flag
);
1216 if (corearg
&& pidarg
)
1217 error (_("Can't attach to process and specify "
1218 "a core file at the same time."));
1220 if (corearg
!= NULL
)
1222 ret
= catch_command_errors (core_file_command
, corearg
,
1225 else if (pidarg
!= NULL
)
1227 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1229 else if (pid_or_core_arg
)
1231 /* The user specified 'gdb program pid' or gdb program core'.
1232 If pid_or_core_arg's first character is a digit, try attach
1233 first and then corefile. Otherwise try just corefile. */
1235 if (isdigit (pid_or_core_arg
[0]))
1237 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1240 ret
= catch_command_errors (core_file_command
,
1246 /* Can't be a pid, better be a corefile. */
1247 ret
= catch_command_errors (core_file_command
,
1254 current_inferior ()->set_tty (ttyarg
);
1256 /* Error messages should no longer be distinguished with extra output. */
1257 warning_pre_print
= _("warning: ");
1259 /* Read the .gdbinit file in the current directory, *if* it isn't
1260 the same as the $HOME/.gdbinit file (it should exist, also). */
1261 if (!local_gdbinit
.empty ())
1263 auto_load_local_gdbinit_pathname
1264 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1266 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
)
1268 auto_load_debug_printf ("Loading .gdbinit file \"%s\".",
1269 local_gdbinit
.c_str ());
1271 if (file_is_auto_load_safe (local_gdbinit
.c_str ()))
1273 auto_load_local_gdbinit_loaded
= 1;
1275 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1280 /* Now that all .gdbinit's have been read and all -d options have been
1281 processed, we can read any scripts mentioned in SYMARG.
1282 We wait until now because it is common to add to the source search
1283 path in local_gdbinit. */
1284 global_auto_load
= save_auto_load
;
1285 for (objfile
*objfile
: current_program_space
->objfiles ())
1286 load_auto_scripts_for_objfile (objfile
);
1288 /* Process '-x' and '-ex' options. */
1289 execute_cmdargs (&cmdarg_vec
, CMDARG_FILE
, CMDARG_COMMAND
, &ret
);
1291 /* Read in the old history after all the command files have been
1297 int error_status
= EXIT_FAILURE
;
1298 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1300 /* We have hit the end of the batch file. */
1301 quit_force (exit_arg
, 0);
1306 captured_main (void *data
)
1308 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1310 captured_main_1 (context
);
1312 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1313 moving this loop and the code found in captured_command_loop()
1314 into the command_loop() proper. The main thing holding back that
1315 change - SET_TOP_LEVEL() - has been eliminated. */
1320 captured_command_loop ();
1322 catch (const gdb_exception_forced_quit
&ex
)
1324 quit_force (NULL
, 0);
1326 catch (const gdb_exception
&ex
)
1328 exception_print (gdb_stderr
, ex
);
1331 /* No exit -- exit is through quit_command. */
1335 gdb_main (struct captured_main_args
*args
)
1339 captured_main (args
);
1341 catch (const gdb_exception
&ex
)
1343 exception_print (gdb_stderr
, ex
);
1346 /* The only way to end up here is by an error (normal exit is
1347 handled by quit_force()), hence always return an error status. */
1352 /* Don't use *_filtered for printing help. We don't want to prompt
1353 for continue no matter how small the screen or how much we're going
1357 print_gdb_help (struct ui_file
*stream
)
1359 std::vector
<std::string
> system_gdbinit
;
1360 std::string home_gdbinit
;
1361 std::string local_gdbinit
;
1362 std::string home_gdbearlyinit
;
1364 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1365 get_earlyinit_files (&home_gdbearlyinit
);
1367 /* Note: The options in the list below are only approximately sorted
1368 in the alphabetical order, so as to group closely related options
1371 This is the GNU debugger. Usage:\n\n\
1372 gdb [options] [executable-file [core-file or process-id]]\n\
1373 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1376 Selection of debuggee and its files:\n\n\
1377 --args Arguments after executable-file are passed to inferior.\n\
1378 --core=COREFILE Analyze the core dump COREFILE.\n\
1379 --exec=EXECFILE Use EXECFILE as the executable.\n\
1380 --pid=PID Attach to running process PID.\n\
1381 --directory=DIR Search for source files in DIR.\n\
1382 --se=FILE Use FILE as symbol file and executable file.\n\
1383 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1384 --readnow Fully read symbol files on first access.\n\
1385 --readnever Do not read symbol files.\n\
1386 --write Set writing into executable and core files.\n\n\
1389 Initial commands and command files:\n\n\
1390 --command=FILE, -x Execute GDB commands from FILE.\n\
1391 --init-command=FILE, -ix\n\
1392 Like -x but execute commands before loading inferior.\n\
1393 --eval-command=COMMAND, -ex\n\
1394 Execute a single GDB command.\n\
1395 May be used multiple times and in conjunction\n\
1397 --init-eval-command=COMMAND, -iex\n\
1398 Like -ex but before loading inferior.\n\
1399 --nh Do not read ~/.gdbinit.\n\
1400 --nx Do not read any .gdbinit files in any directory.\n\n\
1403 Output and user interface control:\n\n\
1404 --fullname Output information used by emacs-GDB interface.\n\
1405 --interpreter=INTERP\n\
1406 Select a specific interpreter / user interface.\n\
1407 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1408 -w Use the GUI interface.\n\
1409 --nw Do not use the GUI interface.\n\
1413 --tui Use a terminal user interface.\n\
1417 -q, --quiet, --silent\n\
1418 Do not print version number on startup.\n\n\
1421 Operating modes:\n\n\
1422 --batch Exit after processing options.\n\
1423 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1424 --return-child-result\n\
1425 GDB exit code will be the child's exit code.\n\
1426 --configuration Print details about GDB configuration and then exit.\n\
1427 --help Print this message and then exit.\n\
1428 --version Print version information and then exit.\n\n\
1429 Remote debugging options:\n\n\
1430 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1431 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1433 --cd=DIR Change current directory to DIR.\n\
1434 --data-directory=DIR, -D\n\
1435 Set GDB's data-directory to DIR.\n\
1438 At startup, GDB reads the following early init files and executes their\n\
1441 if (!home_gdbearlyinit
.empty ())
1442 gdb_printf (stream
, _("\
1443 * user-specific early init file: %s\n\
1444 "), home_gdbearlyinit
.c_str ());
1445 if (home_gdbearlyinit
.empty ())
1446 gdb_printf (stream
, _("\
1449 At startup, GDB reads the following init files and executes their commands:\n\
1451 if (!system_gdbinit
.empty ())
1454 for (size_t idx
= 0; idx
< system_gdbinit
.size (); ++idx
)
1456 output
+= system_gdbinit
[idx
];
1457 if (idx
< system_gdbinit
.size () - 1)
1460 gdb_printf (stream
, _("\
1461 * system-wide init files: %s\n\
1462 "), output
.c_str ());
1464 if (!home_gdbinit
.empty ())
1465 gdb_printf (stream
, _("\
1466 * user-specific init file: %s\n\
1467 "), home_gdbinit
.c_str ());
1468 if (!local_gdbinit
.empty ())
1469 gdb_printf (stream
, _("\
1470 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1471 "), local_gdbinit
.c_str ());
1472 if (system_gdbinit
.empty () && home_gdbinit
.empty ()
1473 && local_gdbinit
.empty ())
1474 gdb_printf (stream
, _("\
1477 For more information, type \"help\" from within GDB, or consult the\n\
1478 GDB manual (available as on-line info or a printed manual).\n\
1480 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1481 gdb_printf (stream
, _("\n\
1482 Report bugs to %ps.\n\
1483 "), styled_string (file_name_style
.style (), REPORT_BUGS_TO
));
1484 if (stream
== gdb_stdout
)
1485 gdb_printf (stream
, _("\n\
1486 You can ask GDB-related questions on the GDB users mailing list\n\
1487 (gdb@sourceware.org) or on GDB's IRC channel (#gdb on Libera.Chat).\n"));