1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2021 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 /* Whether dbx commands will be handled. */
67 /* System root path, used to find libraries etc. */
68 char *gdb_sysroot
= 0;
70 /* GDB datadir, used to store data files. */
71 std::string gdb_datadir
;
73 /* Non-zero if GDB_DATADIR was provided on the command line.
74 This doesn't track whether data-directory is set later from the
75 command line, but we don't reread system.gdbinit when that happens. */
76 static int gdb_datadir_provided
= 0;
78 /* If gdb was configured with --with-python=/path,
79 the possibly relocated path to python's lib directory. */
80 std::string python_libdir
;
82 /* Target IO streams. */
83 struct ui_file
*gdb_stdtargin
;
84 struct ui_file
*gdb_stdtarg
;
85 struct ui_file
*gdb_stdtargerr
;
87 /* True if --batch or --batch-silent was seen. */
90 /* Support for the --batch-silent option. */
93 /* Support for --return-child-result option.
94 Set the default to -1 to return error in the case
95 that the program does not run or does not complete. */
96 int return_child_result
= 0;
97 int return_child_result_value
= -1;
100 /* GDB as it has been invoked from the command line (i.e. argv[0]). */
101 static char *gdb_program_name
;
103 /* Return read only pointer to GDB_PROGRAM_NAME. */
105 get_gdb_program_name (void)
107 return gdb_program_name
;
110 static void print_gdb_help (struct ui_file
*);
112 /* Set the data-directory parameter to NEW_DATADIR.
113 If NEW_DATADIR is not a directory then a warning is printed.
114 We don't signal an error for backward compatibility. */
117 set_gdb_data_directory (const char *new_datadir
)
121 if (stat (new_datadir
, &st
) < 0)
123 int save_errno
= errno
;
125 fprintf_unfiltered (gdb_stderr
, "Warning: ");
126 print_sys_errmsg (new_datadir
, save_errno
);
128 else if (!S_ISDIR (st
.st_mode
))
129 warning (_("%ps is not a directory."),
130 styled_string (file_name_style
.style (), new_datadir
));
132 gdb_datadir
= gdb_realpath (new_datadir
).get ();
134 /* gdb_realpath won't return an absolute path if the path doesn't exist,
135 but we still want to record an absolute path here. If the user entered
136 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
137 isn't canonical, but that's ok. */
138 if (!IS_ABSOLUTE_PATH (gdb_datadir
.c_str ()))
140 gdb::unique_xmalloc_ptr
<char> abs_datadir
141 = gdb_abspath (gdb_datadir
.c_str ());
143 gdb_datadir
= abs_datadir
.get ();
147 /* Relocate a file or directory. PROGNAME is the name by which gdb
148 was invoked (i.e., argv[0]). INITIAL is the default value for the
149 file or directory. RELOCATABLE is true if the value is relocatable,
150 false otherwise. This may return an empty string under the same
151 conditions as make_relative_prefix returning NULL. */
154 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
158 gdb::unique_xmalloc_ptr
<char> str (make_relative_prefix (progname
,
163 return std::string ();
168 /* Like relocate_path, but specifically checks for a directory.
169 INITIAL is relocated according to the rules of relocate_path. If
170 the result is a directory, it is used; otherwise, INITIAL is used.
171 The chosen directory is then canonicalized using lrealpath. */
174 relocate_gdb_directory (const char *initial
, bool relocatable
)
176 std::string dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
181 if (stat (dir
.c_str (), &s
) != 0 || !S_ISDIR (s
.st_mode
))
189 /* Canonicalize the directory. */
192 gdb::unique_xmalloc_ptr
<char> canon_sysroot (lrealpath (dir
.c_str ()));
195 dir
= canon_sysroot
.get ();
201 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
202 parameter if it is in the data dir, or passes it through relocate_path
206 relocate_file_path_maybe_in_datadir (const std::string
&file
,
209 size_t datadir_len
= strlen (GDB_DATADIR
);
211 std::string relocated_path
;
213 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
214 has been provided, search for SYSTEM_GDBINIT there. */
215 if (gdb_datadir_provided
216 && datadir_len
< file
.length ()
217 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
218 && IS_DIR_SEPARATOR (file
[datadir_len
]))
220 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
223 size_t start
= datadir_len
;
224 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
226 relocated_path
= gdb_datadir
+ SLASH_STRING
+ file
.substr (start
);
230 relocated_path
= relocate_path (gdb_program_name
, file
.c_str (),
233 return relocated_path
;
236 /* A class to wrap up the logic for finding the three different types of
237 initialisation files GDB uses, system wide, home directory, and current
238 working directory. */
240 class gdb_initfile_finder
243 /* Constructor. Finds initialisation files named FILENAME in the home
244 directory or local (current working) directory. System initialisation
245 files are found in both SYSTEM_FILENAME and SYSTEM_DIRNAME if these
246 are not nullptr (either or both can be). The matching *_RELOCATABLE
247 flag is passed through to RELOCATE_FILE_PATH_MAYBE_IN_DATADIR.
249 If FILENAME starts with a '.' then when looking in the home directory
250 this first '.' can be ignored in some cases. */
251 explicit gdb_initfile_finder (const char *filename
,
252 const char *system_filename
,
253 bool system_filename_relocatable
,
254 const char *system_dirname
,
255 bool system_dirname_relocatable
,
256 bool lookup_local_file
)
260 if (system_filename
!= nullptr && system_filename
[0] != '\0')
262 std::string relocated_filename
263 = relocate_file_path_maybe_in_datadir (system_filename
,
264 system_filename_relocatable
);
265 if (!relocated_filename
.empty ()
266 && stat (relocated_filename
.c_str (), &s
) == 0)
267 m_system_files
.push_back (relocated_filename
);
270 if (system_dirname
!= nullptr && system_dirname
[0] != '\0')
272 std::string relocated_dirname
273 = relocate_file_path_maybe_in_datadir (system_dirname
,
274 system_dirname_relocatable
);
275 if (!relocated_dirname
.empty ())
277 gdb_dir_up
dir (opendir (relocated_dirname
.c_str ()));
280 std::vector
<std::string
> files
;
283 struct dirent
*ent
= readdir (dir
.get ());
286 std::string
name (ent
->d_name
);
287 if (name
== "." || name
== "..")
289 /* ent->d_type is not available on all systems
290 (e.g. mingw, Solaris), so we have to call stat(). */
291 std::string tmp_filename
292 = relocated_dirname
+ SLASH_STRING
+ name
;
293 if (stat (tmp_filename
.c_str (), &s
) != 0
294 || !S_ISREG (s
.st_mode
))
296 const struct extension_language_defn
*extlang
297 = get_ext_lang_of_file (tmp_filename
.c_str ());
298 /* We effectively don't support "set script-extension
299 off/soft", because we are loading system init files
300 here, so it does not really make sense to depend on
302 if (extlang
!= nullptr && ext_lang_present_p (extlang
))
303 files
.push_back (std::move (tmp_filename
));
305 std::sort (files
.begin (), files
.end ());
306 m_system_files
.insert (m_system_files
.end (),
307 files
.begin (), files
.end ());
312 /* If the .gdbinit file in the current directory is the same as
313 the $HOME/.gdbinit file, it should not be sourced. homebuf
314 and cwdbuf are used in that purpose. Make sure that the stats
315 are zero in case one of them fails (this guarantees that they
316 won't match if either exists). */
318 struct stat homebuf
, cwdbuf
;
319 memset (&homebuf
, 0, sizeof (struct stat
));
320 memset (&cwdbuf
, 0, sizeof (struct stat
));
322 m_home_file
= find_gdb_home_config_file (filename
, &homebuf
);
324 if (lookup_local_file
&& stat (filename
, &cwdbuf
) == 0)
326 if (m_home_file
.empty ()
327 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
328 sizeof (struct stat
)))
329 m_local_file
= filename
;
333 DISABLE_COPY_AND_ASSIGN (gdb_initfile_finder
);
335 /* Return a list of system initialisation files. The list could be
337 const std::vector
<std::string
> &system_files () const
338 { return m_system_files
; }
340 /* Return the path to the home initialisation file. The string can be
341 empty if there is no such file. */
342 const std::string
&home_file () const
343 { return m_home_file
; }
345 /* Return the path to the local initialisation file. The string can be
346 empty if there is no such file. */
347 const std::string
&local_file () const
348 { return m_local_file
; }
352 /* Vector of all system init files in the order they should be processed.
354 std::vector
<std::string
> m_system_files
;
356 /* Initialization file from the home directory. Could be the empty
357 string if there is no such file found. */
358 std::string m_home_file
;
360 /* Initialization file from the current working directory. Could be the
361 empty string if there is no such file found. */
362 std::string m_local_file
;
365 /* Compute the locations of init files that GDB should source and return
366 them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. The SYSTEM_GDBINIT
367 can be returned as an empty vector, and HOME_GDBINIT and LOCAL_GDBINIT
368 can be returned as empty strings if there is no init file of that
372 get_init_files (std::vector
<std::string
> *system_gdbinit
,
373 std::string
*home_gdbinit
,
374 std::string
*local_gdbinit
)
376 /* Cache the file lookup object so we only actually search for the files
378 static gdb::optional
<gdb_initfile_finder
> init_files
;
379 if (!init_files
.has_value ())
380 init_files
.emplace (GDBINIT
, SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
,
381 SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
,
384 *system_gdbinit
= init_files
->system_files ();
385 *home_gdbinit
= init_files
->home_file ();
386 *local_gdbinit
= init_files
->local_file ();
389 /* Compute the location of the early init file GDB should source and return
390 it in HOME_GDBEARLYINIT. HOME_GDBEARLYINIT could be returned as an
391 empty string if there is no early init file found. */
394 get_earlyinit_files (std::string
*home_gdbearlyinit
)
396 /* Cache the file lookup object so we only actually search for the files
398 static gdb::optional
<gdb_initfile_finder
> init_files
;
399 if (!init_files
.has_value ())
400 init_files
.emplace (GDBEARLYINIT
, nullptr, false, nullptr, false, false);
402 *home_gdbearlyinit
= init_files
->home_file ();
405 /* Start up the event loop. This is the entry point to the event loop
406 from the command loop. */
411 /* Loop until there is nothing to do. This is the entry point to
412 the event loop engine. gdb_do_one_event will process one event
413 for each invocation. It blocks waiting for an event and then
421 result
= gdb_do_one_event ();
423 catch (const gdb_exception
&ex
)
425 exception_print (gdb_stderr
, ex
);
427 /* If any exception escaped to here, we better enable
428 stdin. Otherwise, any command that calls async_disable_stdin,
429 and then throws, will leave stdin inoperable. */
430 SWITCH_THRU_ALL_UIS ()
432 async_enable_stdin ();
434 /* If we long-jumped out of do_one_event, we probably didn't
435 get around to resetting the prompt, which leaves readline
436 in a messed-up state. Reset it here. */
437 current_ui
->prompt_state
= PROMPT_NEEDED
;
438 gdb::observers::command_error
.notify ();
439 /* This call looks bizarre, but it is required. If the user
440 entered a command that caused an error,
441 after_char_processing_hook won't be called from
442 rl_callback_read_char_wrapper. Using a cleanup there
443 won't work, since we want this function to be called
444 after a new prompt is printed. */
445 if (after_char_processing_hook
)
446 (*after_char_processing_hook
) ();
447 /* Maybe better to set a flag to be checked somewhere as to
448 whether display the prompt or not. */
455 /* We are done with the event loop. There are no more event sources
456 to listen to. So we exit GDB. */
460 /* Call command_loop. */
462 /* Prevent inlining this function for the benefit of GDB's selftests
463 in the testsuite. Those tests want to run GDB under GDB and stop
465 static void captured_command_loop () __attribute__((noinline
));
468 captured_command_loop ()
470 struct ui
*ui
= current_ui
;
472 /* Top-level execution commands can be run in the background from
474 current_ui
->async
= 1;
476 /* Give the interpreter a chance to print a prompt, if necessary */
477 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
478 interp_pre_command_loop (top_level_interpreter ());
480 /* Now it's time to start the event loop. */
483 /* If the command_loop returned, normally (rather than threw an
484 error) we try to quit. If the quit is aborted, our caller
485 catches the signal and restarts the command loop. */
486 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
489 /* Handle command errors thrown from within catch_command_errors. */
492 handle_command_errors (const struct gdb_exception
&e
)
496 exception_print (gdb_stderr
, e
);
498 /* If any exception escaped to here, we better enable stdin.
499 Otherwise, any command that calls async_disable_stdin, and
500 then throws, will leave stdin inoperable. */
501 async_enable_stdin ();
507 /* Type of the command callback passed to the const
508 catch_command_errors. */
510 typedef void (catch_command_errors_const_ftype
) (const char *, int);
512 /* Wrap calls to commands run before the event loop is started. */
515 catch_command_errors (catch_command_errors_const_ftype command
,
516 const char *arg
, int from_tty
,
517 bool do_bp_actions
= false)
521 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
523 command (arg
, from_tty
);
525 maybe_wait_sync_command_done (was_sync
);
527 /* Do any commands attached to breakpoint we stopped at. */
529 bpstat_do_actions ();
531 catch (const gdb_exception
&e
)
533 return handle_command_errors (e
);
539 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
540 symfile_add_flags. */
543 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
545 symfile_add_flags add_flags
= 0;
548 add_flags
|= SYMFILE_VERBOSE
;
550 symbol_file_add_main (arg
, add_flags
);
553 /* Perform validation of the '--readnow' and '--readnever' flags. */
556 validate_readnow_readnever ()
558 if (readnever_symbol_files
&& readnow_symbol_files
)
560 error (_("%s: '--readnow' and '--readnever' cannot be "
561 "specified simultaneously"),
566 /* Type of this option. */
569 /* Option type -x. */
572 /* Option type -ex. */
575 /* Option type -ix. */
578 /* Option type -iex. */
581 /* Option type -sx. */
582 CMDARG_EARLYINIT_FILE
,
584 /* Option type -sex. */
585 CMDARG_EARLYINIT_COMMAND
588 /* Arguments of --command option and its counterpart. */
591 cmdarg (cmdarg_kind type_
, char *string_
)
592 : type (type_
), string (string_
)
595 /* Type of this option. */
596 enum cmdarg_kind type
;
598 /* Value of this option - filename or the GDB command itself. String memory
599 is not owned by this structure despite it is 'const'. */
603 /* From CMDARG_VEC execute command files (matching FILE_TYPE) or commands
604 (matching CMD_TYPE). Update the value in *RET if and scripts or
605 commands are executed. */
608 execute_cmdargs (const std::vector
<struct cmdarg
> *cmdarg_vec
,
609 cmdarg_kind file_type
, cmdarg_kind cmd_type
,
612 for (const auto &cmdarg_p
: *cmdarg_vec
)
614 if (cmdarg_p
.type
== file_type
)
615 *ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
617 else if (cmdarg_p
.type
== cmd_type
)
618 *ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
624 captured_main_1 (struct captured_main_args
*context
)
626 int argc
= context
->argc
;
627 char **argv
= context
->argv
;
629 static int quiet
= 0;
630 static int set_args
= 0;
631 static int inhibit_home_gdbinit
= 0;
633 /* Pointers to various arguments from command line. */
635 char *execarg
= NULL
;
637 char *corearg
= NULL
;
638 char *pid_or_core_arg
= NULL
;
642 /* These are static so that we can take their address in an
644 static int print_help
;
645 static int print_version
;
646 static int print_configuration
;
648 /* Pointers to all arguments of --command option. */
649 std::vector
<struct cmdarg
> cmdarg_vec
;
651 /* All arguments of --directory option. */
652 std::vector
<char *> dirarg
;
658 #ifdef HAVE_USEFUL_SBRK
659 /* Set this before constructing scoped_command_stats. */
660 lim_at_start
= (char *) sbrk (0);
663 scoped_command_stats
stat_reporter (false);
665 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
666 setlocale (LC_MESSAGES
, "");
668 #if defined (HAVE_SETLOCALE)
669 setlocale (LC_CTYPE
, "");
672 bindtextdomain (PACKAGE
, LOCALEDIR
);
673 textdomain (PACKAGE
);
679 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
680 as a Windows pipe, and Windows buffers on pipes. */
681 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
684 /* Note: `error' cannot be called before this point, because the
685 caller will crash when trying to print the exception. */
686 main_ui
= new ui (stdin
, stdout
, stderr
);
687 current_ui
= main_ui
;
689 gdb_stdtargerr
= gdb_stderr
; /* for moment */
690 gdb_stdtargin
= gdb_stdin
; /* for moment */
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. */
714 = xstrdup (relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
715 TARGET_SYSTEM_ROOT_RELOCATABLE
).c_str ());
717 if (*gdb_sysroot
== '\0')
720 gdb_sysroot
= xstrdup (TARGET_SYSROOT_PREFIX
);
724 = xstrdup (relocate_gdb_directory (DEBUGDIR
,
725 DEBUGDIR_RELOCATABLE
).c_str ());
727 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
728 GDB_DATADIR_RELOCATABLE
);
730 #ifdef WITH_PYTHON_LIBDIR
731 python_libdir
= relocate_gdb_directory (WITH_PYTHON_LIBDIR
,
732 PYTHON_LIBDIR_RELOCATABLE
);
736 add_substitute_path_rule (RELOC_SRCDIR
,
737 make_relative_prefix (gdb_program_name
, BINDIR
,
741 /* There will always be an interpreter. Either the one passed into
742 this captured main, or one specified by the user at start up, or
743 the console. Initialize the interpreter to the one requested by
745 interpreter_p
= xstrdup (context
->interpreter_p
);
747 /* Parse arguments and options. */
750 /* When var field is 0, use flag field to record the equivalent
751 short option (or arbitrary numbers starting at 10 for those
752 with no equivalent). */
768 /* This struct requires int* in the struct, but write_files is a bool.
769 So use this temporary int that we write back after argument parsing. */
770 int write_files_1
= 0;
771 static struct option long_options
[] =
773 {"tui", no_argument
, 0, OPT_TUI
},
774 {"dbx", no_argument
, &dbx_commands
, 1},
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 xfree (interpreter_p
);
884 interpreter_p
= xstrdup (INTERP_TUI
);
886 error (_("%s: TUI mode is not supported"), gdb_program_name
);
890 /* FIXME: cagney/2003-03-01: Not sure if this option is
891 actually useful, and if it is, what it should do. */
893 /* --windows is equivalent to -i=insight. */
894 xfree (interpreter_p
);
895 interpreter_p
= xstrdup (INTERP_INSIGHT
);
899 /* -nw is equivalent to -i=console. */
900 xfree (interpreter_p
);
901 interpreter_p
= xstrdup (INTERP_CONSOLE
);
904 annotation_level
= 1;
919 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
922 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
925 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
928 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
931 cmdarg_vec
.emplace_back (CMDARG_EARLYINIT_FILE
, optarg
);
934 cmdarg_vec
.emplace_back (CMDARG_EARLYINIT_COMMAND
, optarg
);
937 batch_flag
= batch_silent
= 1;
938 gdb_stdout
= new null_file ();
941 if (optarg
[0] == '\0')
942 error (_("%s: empty path for `--data-directory'"),
944 set_gdb_data_directory (optarg
);
945 gdb_datadir_provided
= 1;
950 if (!gdbtk_test (optarg
))
951 error (_("%s: unable to load tclcommand file \"%s\""),
952 gdb_program_name
, optarg
);
956 /* Backwards compatibility only. */
960 /* Set the external editor commands when gdb is farming out files
961 to be edited by another program. */
962 external_editor_command
= xstrdup (optarg
);
967 xfree (interpreter_p
);
968 interpreter_p
= xstrdup (optarg
);
971 dirarg
.push_back (optarg
);
984 rate
= strtol (optarg
, &p
, 0);
985 if (rate
== 0 && p
== optarg
)
986 warning (_("could not set baud rate to `%s'."),
997 timeout
= strtol (optarg
, &p
, 0);
998 if (timeout
== 0 && p
== optarg
)
999 warning (_("could not set timeout limit to `%s'."),
1002 remote_timeout
= timeout
;
1008 readnow_symbol_files
= 1;
1009 validate_readnow_readnever ();
1015 readnever_symbol_files
= 1;
1016 validate_readnow_readnever ();
1021 error (_("Use `%s --help' for a complete list of options."),
1025 write_files
= (write_files_1
!= 0);
1031 /* Disable all output styling when running in batch mode. */
1036 save_original_signals_state (quiet
);
1038 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
1039 gdb::alternate_signal_stack signal_stack
;
1041 /* Initialize all files. */
1044 /* Process early init files and early init options from the command line. */
1045 if (!inhibit_gdbinit
)
1047 std::string home_gdbearlyinit
;
1048 get_earlyinit_files (&home_gdbearlyinit
);
1049 if (!home_gdbearlyinit
.empty () && !inhibit_home_gdbinit
)
1050 ret
= catch_command_errors (source_script
,
1051 home_gdbearlyinit
.c_str (), 0);
1053 execute_cmdargs (&cmdarg_vec
, CMDARG_EARLYINIT_FILE
,
1054 CMDARG_EARLYINIT_COMMAND
, &ret
);
1056 /* Recheck if we're starting up quietly after processing the startup
1057 scripts and commands. */
1059 quiet
= check_quiet_mode ();
1061 /* Now that gdb_init has created the initial inferior, we're in
1062 position to set args for that inferior. */
1065 /* The remaining options are the command-line options for the
1066 inferior. The first one is the sym/exec file, and the rest
1069 error (_("%s: `--args' specified but no program specified"),
1072 symarg
= argv
[optind
];
1073 execarg
= argv
[optind
];
1075 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
1079 /* OK, that's all the options. */
1081 /* The first argument, if specified, is the name of the
1085 symarg
= argv
[optind
];
1086 execarg
= argv
[optind
];
1090 /* If the user hasn't already specified a PID or the name of a
1091 core file, then a second optional argument is allowed. If
1092 present, this argument should be interpreted as either a
1093 PID or a core file, whichever works. */
1094 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
1096 pid_or_core_arg
= argv
[optind
];
1100 /* Any argument left on the command line is unexpected and
1101 will be ignored. Inform the user. */
1103 fprintf_unfiltered (gdb_stderr
,
1104 _("Excess command line "
1105 "arguments ignored. (%s%s)\n"),
1107 (optind
== argc
- 1) ? "" : " ...");
1110 /* Lookup gdbinit files. Note that the gdbinit file name may be
1111 overridden during file initialization, so get_init_files should be
1112 called after gdb_init. */
1113 std::vector
<std::string
> system_gdbinit
;
1114 std::string home_gdbinit
;
1115 std::string local_gdbinit
;
1116 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1118 /* Do these (and anything which might call wrap_here or *_filtered)
1119 after initialize_all_files() but before the interpreter has been
1120 installed. Otherwize the help/version messages will be eaten by
1121 the interpreter's output handler. */
1125 print_gdb_version (gdb_stdout
, false);
1127 printf_filtered ("\n");
1133 print_gdb_help (gdb_stdout
);
1137 if (print_configuration
)
1139 print_gdb_configuration (gdb_stdout
);
1141 printf_filtered ("\n");
1145 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
1146 GDB retain the old MI1 interpreter startup behavior. Output the
1147 copyright message before the interpreter is installed. That way
1148 it isn't encapsulated in MI output. */
1149 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
1151 /* Print all the junk at the top, with trailing "..." if we are
1152 about to read a symbol file (possibly slowly). */
1153 print_gdb_version (gdb_stdout
, true);
1155 printf_filtered ("..");
1157 printf_filtered ("\n");
1158 gdb_flush (gdb_stdout
); /* Force to screen during slow
1162 /* Install the default UI. All the interpreters should have had a
1163 look at things by now. Initialize the default interpreter. */
1164 set_top_level_interpreter (interpreter_p
);
1166 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
1167 GDB retain the old MI1 interpreter startup behavior. Output the
1168 copyright message after the interpreter is installed when it is
1169 any sane interpreter. */
1170 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
1172 /* Print all the junk at the top, with trailing "..." if we are
1173 about to read a symbol file (possibly slowly). */
1174 print_gdb_version (gdb_stdout
, true);
1176 printf_filtered ("..");
1178 printf_filtered ("\n");
1179 gdb_flush (gdb_stdout
); /* Force to screen during slow
1183 /* Set off error and warning messages with a blank line. */
1184 tmp_warn_preprint
.reset ();
1185 warning_pre_print
= _("\nwarning: ");
1187 /* Read and execute the system-wide gdbinit file, if it exists.
1188 This is done *before* all the command line arguments are
1189 processed; it sets global parameters, which are independent of
1190 what file you are debugging or what directory you are in. */
1191 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
1193 for (const std::string
&file
: system_gdbinit
)
1194 ret
= catch_command_errors (source_script
, file
.c_str (), 0);
1197 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
1198 *before* all the command line arguments are processed; it sets
1199 global parameters, which are independent of what file you are
1200 debugging or what directory you are in. */
1202 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1203 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1205 /* Process '-ix' and '-iex' options early. */
1206 execute_cmdargs (&cmdarg_vec
, CMDARG_INIT_FILE
, CMDARG_INIT_COMMAND
, &ret
);
1208 /* Now perform all the actions indicated by the arguments. */
1211 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1214 for (i
= 0; i
< dirarg
.size (); i
++)
1215 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1217 /* Skip auto-loading section-specified scripts until we've sourced
1218 local_gdbinit (which is often used to augment the source search
1220 save_auto_load
= global_auto_load
;
1221 global_auto_load
= 0;
1225 && strcmp (execarg
, symarg
) == 0)
1227 /* The exec file and the symbol-file are the same. If we can't
1228 open it, better only print one error message.
1229 catch_command_errors returns non-zero on success! */
1230 ret
= catch_command_errors (exec_file_attach
, execarg
,
1233 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1234 symarg
, !batch_flag
);
1238 if (execarg
!= NULL
)
1239 ret
= catch_command_errors (exec_file_attach
, execarg
,
1242 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1243 symarg
, !batch_flag
);
1246 if (corearg
&& pidarg
)
1247 error (_("Can't attach to process and specify "
1248 "a core file at the same time."));
1250 if (corearg
!= NULL
)
1252 ret
= catch_command_errors (core_file_command
, corearg
,
1255 else if (pidarg
!= NULL
)
1257 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1259 else if (pid_or_core_arg
)
1261 /* The user specified 'gdb program pid' or gdb program core'.
1262 If pid_or_core_arg's first character is a digit, try attach
1263 first and then corefile. Otherwise try just corefile. */
1265 if (isdigit (pid_or_core_arg
[0]))
1267 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1270 ret
= catch_command_errors (core_file_command
,
1276 /* Can't be a pid, better be a corefile. */
1277 ret
= catch_command_errors (core_file_command
,
1284 current_inferior ()->set_tty (ttyarg
);
1286 /* Error messages should no longer be distinguished with extra output. */
1287 warning_pre_print
= _("warning: ");
1289 /* Read the .gdbinit file in the current directory, *if* it isn't
1290 the same as the $HOME/.gdbinit file (it should exist, also). */
1291 if (!local_gdbinit
.empty ())
1293 auto_load_local_gdbinit_pathname
1294 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1296 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
)
1298 auto_load_debug_printf ("Loading .gdbinit file \"%s\".",
1299 local_gdbinit
.c_str ());
1301 if (file_is_auto_load_safe (local_gdbinit
.c_str ()))
1303 auto_load_local_gdbinit_loaded
= 1;
1305 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1310 /* Now that all .gdbinit's have been read and all -d options have been
1311 processed, we can read any scripts mentioned in SYMARG.
1312 We wait until now because it is common to add to the source search
1313 path in local_gdbinit. */
1314 global_auto_load
= save_auto_load
;
1315 for (objfile
*objfile
: current_program_space
->objfiles ())
1316 load_auto_scripts_for_objfile (objfile
);
1318 /* Process '-x' and '-ex' options. */
1319 execute_cmdargs (&cmdarg_vec
, CMDARG_FILE
, CMDARG_COMMAND
, &ret
);
1321 /* Read in the old history after all the command files have been
1327 int error_status
= EXIT_FAILURE
;
1328 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1330 /* We have hit the end of the batch file. */
1331 quit_force (exit_arg
, 0);
1336 captured_main (void *data
)
1338 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1340 captured_main_1 (context
);
1342 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1343 moving this loop and the code found in captured_command_loop()
1344 into the command_loop() proper. The main thing holding back that
1345 change - SET_TOP_LEVEL() - has been eliminated. */
1350 captured_command_loop ();
1352 catch (const gdb_exception
&ex
)
1354 exception_print (gdb_stderr
, ex
);
1357 /* No exit -- exit is through quit_command. */
1361 gdb_main (struct captured_main_args
*args
)
1365 captured_main (args
);
1367 catch (const gdb_exception
&ex
)
1369 exception_print (gdb_stderr
, ex
);
1372 /* The only way to end up here is by an error (normal exit is
1373 handled by quit_force()), hence always return an error status. */
1378 /* Don't use *_filtered for printing help. We don't want to prompt
1379 for continue no matter how small the screen or how much we're going
1383 print_gdb_help (struct ui_file
*stream
)
1385 std::vector
<std::string
> system_gdbinit
;
1386 std::string home_gdbinit
;
1387 std::string local_gdbinit
;
1388 std::string home_gdbearlyinit
;
1390 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1391 get_earlyinit_files (&home_gdbearlyinit
);
1393 /* Note: The options in the list below are only approximately sorted
1394 in the alphabetical order, so as to group closely related options
1396 fputs_unfiltered (_("\
1397 This is the GNU debugger. Usage:\n\n\
1398 gdb [options] [executable-file [core-file or process-id]]\n\
1399 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1401 fputs_unfiltered (_("\
1402 Selection of debuggee and its files:\n\n\
1403 --args Arguments after executable-file are passed to inferior.\n\
1404 --core=COREFILE Analyze the core dump COREFILE.\n\
1405 --exec=EXECFILE Use EXECFILE as the executable.\n\
1406 --pid=PID Attach to running process PID.\n\
1407 --directory=DIR Search for source files in DIR.\n\
1408 --se=FILE Use FILE as symbol file and executable file.\n\
1409 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1410 --readnow Fully read symbol files on first access.\n\
1411 --readnever Do not read symbol files.\n\
1412 --write Set writing into executable and core files.\n\n\
1414 fputs_unfiltered (_("\
1415 Initial commands and command files:\n\n\
1416 --command=FILE, -x Execute GDB commands from FILE.\n\
1417 --init-command=FILE, -ix\n\
1418 Like -x but execute commands before loading inferior.\n\
1419 --eval-command=COMMAND, -ex\n\
1420 Execute a single GDB command.\n\
1421 May be used multiple times and in conjunction\n\
1423 --init-eval-command=COMMAND, -iex\n\
1424 Like -ex but before loading inferior.\n\
1425 --nh Do not read ~/.gdbinit.\n\
1426 --nx Do not read any .gdbinit files in any directory.\n\n\
1428 fputs_unfiltered (_("\
1429 Output and user interface control:\n\n\
1430 --fullname Output information used by emacs-GDB interface.\n\
1431 --interpreter=INTERP\n\
1432 Select a specific interpreter / user interface.\n\
1433 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1434 -w Use the GUI interface.\n\
1435 --nw Do not use the GUI interface.\n\
1438 fputs_unfiltered (_("\
1439 --tui Use a terminal user interface.\n\
1442 fputs_unfiltered (_("\
1443 --dbx DBX compatibility mode.\n\
1444 -q, --quiet, --silent\n\
1445 Do not print version number on startup.\n\n\
1447 fputs_unfiltered (_("\
1448 Operating modes:\n\n\
1449 --batch Exit after processing options.\n\
1450 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1451 --return-child-result\n\
1452 GDB exit code will be the child's exit code.\n\
1453 --configuration Print details about GDB configuration and then exit.\n\
1454 --help Print this message and then exit.\n\
1455 --version Print version information and then exit.\n\n\
1456 Remote debugging options:\n\n\
1457 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1458 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1460 --cd=DIR Change current directory to DIR.\n\
1461 --data-directory=DIR, -D\n\
1462 Set GDB's data-directory to DIR.\n\
1464 fputs_unfiltered (_("\n\
1465 At startup, GDB reads the following early init files and executes their\n\
1468 if (!home_gdbearlyinit
.empty ())
1469 fprintf_unfiltered (stream
, _("\
1470 * user-specific early init file: %s\n\
1471 "), home_gdbearlyinit
.c_str ());
1472 if (home_gdbearlyinit
.empty ())
1473 fprintf_unfiltered (stream
, _("\
1475 fputs_unfiltered (_("\n\
1476 At startup, GDB reads the following init files and executes their commands:\n\
1478 if (!system_gdbinit
.empty ())
1481 for (size_t idx
= 0; idx
< system_gdbinit
.size (); ++idx
)
1483 output
+= system_gdbinit
[idx
];
1484 if (idx
< system_gdbinit
.size () - 1)
1487 fprintf_unfiltered (stream
, _("\
1488 * system-wide init files: %s\n\
1489 "), output
.c_str ());
1491 if (!home_gdbinit
.empty ())
1492 fprintf_unfiltered (stream
, _("\
1493 * user-specific init file: %s\n\
1494 "), home_gdbinit
.c_str ());
1495 if (!local_gdbinit
.empty ())
1496 fprintf_unfiltered (stream
, _("\
1497 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1498 "), local_gdbinit
.c_str ());
1499 if (system_gdbinit
.empty () && home_gdbinit
.empty ()
1500 && local_gdbinit
.empty ())
1501 fprintf_unfiltered (stream
, _("\
1503 fputs_unfiltered (_("\n\
1504 For more information, type \"help\" from within GDB, or consult the\n\
1505 GDB manual (available as on-line info or a printed manual).\n\
1507 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1508 fprintf_unfiltered (stream
, _("\n\
1509 Report bugs to %s.\n\
1510 "), REPORT_BUGS_TO
);
1511 if (stream
== gdb_stdout
)
1512 fprintf_unfiltered (stream
, _("\n\
1513 You can ask GDB-related questions on the GDB users mailing list\n\
1514 (gdb@sourceware.org) or on GDB's IRC channel (#gdb on Freenode).\n"));