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_gdbinit_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 /* Compute the locations of init files that GDB should source and
237 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
238 there is no system gdbinit (resp. home gdbinit and local gdbinit)
239 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
240 LOCAL_GDBINIT) is set to the empty string. */
242 get_init_files (std::vector
<std::string
> *system_gdbinit
,
243 std::string
*home_gdbinit
,
244 std::string
*local_gdbinit
)
246 static std::vector
<std::string
> sysgdbinit
;
247 static std::string homeinit
;
248 static std::string localinit
;
249 static int initialized
= 0;
253 struct stat homebuf
, cwdbuf
, s
;
255 if (SYSTEM_GDBINIT
[0])
257 std::string relocated_sysgdbinit
258 = relocate_gdbinit_path_maybe_in_datadir
259 (SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
);
260 if (!relocated_sysgdbinit
.empty ()
261 && stat (relocated_sysgdbinit
.c_str (), &s
) == 0)
262 sysgdbinit
.push_back (relocated_sysgdbinit
);
264 if (SYSTEM_GDBINIT_DIR
[0])
266 std::string relocated_gdbinit_dir
267 = relocate_gdbinit_path_maybe_in_datadir
268 (SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
);
269 if (!relocated_gdbinit_dir
.empty ()) {
270 gdb_dir_up
dir (opendir (relocated_gdbinit_dir
.c_str ()));
273 std::vector
<std::string
> files
;
276 struct dirent
*ent
= readdir (dir
.get ());
279 std::string
name (ent
->d_name
);
280 if (name
== "." || name
== "..")
282 /* ent->d_type is not available on all systems (e.g. mingw,
283 Solaris), so we have to call stat(). */
285 = relocated_gdbinit_dir
+ SLASH_STRING
+ name
;
286 if (stat (filename
.c_str (), &s
) != 0
287 || !S_ISREG (s
.st_mode
))
289 const struct extension_language_defn
*extlang
290 = get_ext_lang_of_file (filename
.c_str ());
291 /* We effectively don't support "set script-extension
292 off/soft", because we are loading system init files here,
293 so it does not really make sense to depend on a
295 if (extlang
!= nullptr && ext_lang_present_p (extlang
))
296 files
.push_back (std::move (filename
));
298 std::sort (files
.begin (), files
.end ());
299 sysgdbinit
.insert (sysgdbinit
.end (),
300 files
.begin (), files
.end ());
305 /* If the .gdbinit file in the current directory is the same as
306 the $HOME/.gdbinit file, it should not be sourced. homebuf
307 and cwdbuf are used in that purpose. Make sure that the stats
308 are zero in case one of them fails (this guarantees that they
309 won't match if either exists). */
311 memset (&homebuf
, 0, sizeof (struct stat
));
312 memset (&cwdbuf
, 0, sizeof (struct stat
));
314 homeinit
= find_gdb_home_config_file (GDBINIT
, &homebuf
);
316 if (stat (GDBINIT
, &cwdbuf
) == 0)
318 if (homeinit
.empty ()
319 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
320 sizeof (struct stat
)))
327 *system_gdbinit
= sysgdbinit
;
328 *home_gdbinit
= homeinit
;
329 *local_gdbinit
= localinit
;
332 /* Start up the event loop. This is the entry point to the event loop
333 from the command loop. */
338 /* Loop until there is nothing to do. This is the entry point to
339 the event loop engine. gdb_do_one_event will process one event
340 for each invocation. It blocks waiting for an event and then
348 result
= gdb_do_one_event ();
350 catch (const gdb_exception
&ex
)
352 exception_print (gdb_stderr
, ex
);
354 /* If any exception escaped to here, we better enable
355 stdin. Otherwise, any command that calls async_disable_stdin,
356 and then throws, will leave stdin inoperable. */
357 SWITCH_THRU_ALL_UIS ()
359 async_enable_stdin ();
361 /* If we long-jumped out of do_one_event, we probably didn't
362 get around to resetting the prompt, which leaves readline
363 in a messed-up state. Reset it here. */
364 current_ui
->prompt_state
= PROMPT_NEEDED
;
365 gdb::observers::command_error
.notify ();
366 /* This call looks bizarre, but it is required. If the user
367 entered a command that caused an error,
368 after_char_processing_hook won't be called from
369 rl_callback_read_char_wrapper. Using a cleanup there
370 won't work, since we want this function to be called
371 after a new prompt is printed. */
372 if (after_char_processing_hook
)
373 (*after_char_processing_hook
) ();
374 /* Maybe better to set a flag to be checked somewhere as to
375 whether display the prompt or not. */
382 /* We are done with the event loop. There are no more event sources
383 to listen to. So we exit GDB. */
387 /* Call command_loop. */
389 /* Prevent inlining this function for the benefit of GDB's selftests
390 in the testsuite. Those tests want to run GDB under GDB and stop
392 static void captured_command_loop () __attribute__((noinline
));
395 captured_command_loop ()
397 struct ui
*ui
= current_ui
;
399 /* Top-level execution commands can be run in the background from
401 current_ui
->async
= 1;
403 /* Give the interpreter a chance to print a prompt, if necessary */
404 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
405 interp_pre_command_loop (top_level_interpreter ());
407 /* Now it's time to start the event loop. */
410 /* If the command_loop returned, normally (rather than threw an
411 error) we try to quit. If the quit is aborted, our caller
412 catches the signal and restarts the command loop. */
413 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
416 /* Handle command errors thrown from within catch_command_errors. */
419 handle_command_errors (const struct gdb_exception
&e
)
423 exception_print (gdb_stderr
, e
);
425 /* If any exception escaped to here, we better enable stdin.
426 Otherwise, any command that calls async_disable_stdin, and
427 then throws, will leave stdin inoperable. */
428 async_enable_stdin ();
434 /* Type of the command callback passed to the const
435 catch_command_errors. */
437 typedef void (catch_command_errors_const_ftype
) (const char *, int);
439 /* Wrap calls to commands run before the event loop is started. */
442 catch_command_errors (catch_command_errors_const_ftype command
,
443 const char *arg
, int from_tty
,
444 bool do_bp_actions
= false)
448 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
450 command (arg
, from_tty
);
452 maybe_wait_sync_command_done (was_sync
);
454 /* Do any commands attached to breakpoint we stopped at. */
456 bpstat_do_actions ();
458 catch (const gdb_exception
&e
)
460 return handle_command_errors (e
);
466 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
467 symfile_add_flags. */
470 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
472 symfile_add_flags add_flags
= 0;
475 add_flags
|= SYMFILE_VERBOSE
;
477 symbol_file_add_main (arg
, add_flags
);
480 /* Perform validation of the '--readnow' and '--readnever' flags. */
483 validate_readnow_readnever ()
485 if (readnever_symbol_files
&& readnow_symbol_files
)
487 error (_("%s: '--readnow' and '--readnever' cannot be "
488 "specified simultaneously"),
493 /* Type of this option. */
496 /* Option type -x. */
499 /* Option type -ex. */
502 /* Option type -ix. */
505 /* Option type -iex. */
509 /* Arguments of --command option and its counterpart. */
512 cmdarg (cmdarg_kind type_
, char *string_
)
513 : type (type_
), string (string_
)
516 /* Type of this option. */
517 enum cmdarg_kind type
;
519 /* Value of this option - filename or the GDB command itself. String memory
520 is not owned by this structure despite it is 'const'. */
524 /* From CMDARG_VEC execute command files (matching FILE_TYPE) or commands
525 (matching CMD_TYPE). Update the value in *RET if and scripts or
526 commands are executed. */
529 execute_cmdargs (const std::vector
<struct cmdarg
> *cmdarg_vec
,
530 cmdarg_kind file_type
, cmdarg_kind cmd_type
,
533 for (const auto &cmdarg_p
: *cmdarg_vec
)
535 if (cmdarg_p
.type
== file_type
)
536 *ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
538 else if (cmdarg_p
.type
== cmd_type
)
539 *ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
545 captured_main_1 (struct captured_main_args
*context
)
547 int argc
= context
->argc
;
548 char **argv
= context
->argv
;
550 static int quiet
= 0;
551 static int set_args
= 0;
552 static int inhibit_home_gdbinit
= 0;
554 /* Pointers to various arguments from command line. */
556 char *execarg
= NULL
;
558 char *corearg
= NULL
;
559 char *pid_or_core_arg
= NULL
;
563 /* These are static so that we can take their address in an
565 static int print_help
;
566 static int print_version
;
567 static int print_configuration
;
569 /* Pointers to all arguments of --command option. */
570 std::vector
<struct cmdarg
> cmdarg_vec
;
572 /* All arguments of --directory option. */
573 std::vector
<char *> dirarg
;
579 #ifdef HAVE_USEFUL_SBRK
580 /* Set this before constructing scoped_command_stats. */
581 lim_at_start
= (char *) sbrk (0);
584 scoped_command_stats
stat_reporter (false);
586 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
587 setlocale (LC_MESSAGES
, "");
589 #if defined (HAVE_SETLOCALE)
590 setlocale (LC_CTYPE
, "");
593 bindtextdomain (PACKAGE
, LOCALEDIR
);
594 textdomain (PACKAGE
);
600 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
601 as a Windows pipe, and Windows buffers on pipes. */
602 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
605 /* Note: `error' cannot be called before this point, because the
606 caller will crash when trying to print the exception. */
607 main_ui
= new ui (stdin
, stdout
, stderr
);
608 current_ui
= main_ui
;
610 gdb_stdtargerr
= gdb_stderr
; /* for moment */
611 gdb_stdtargin
= gdb_stdin
; /* for moment */
613 if (bfd_init () != BFD_INIT_MAGIC
)
614 error (_("fatal error: libbfd ABI mismatch"));
617 /* On Windows, argv[0] is not necessarily set to absolute form when
618 GDB is found along PATH, without which relocation doesn't work. */
619 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
621 gdb_program_name
= xstrdup (argv
[0]);
624 /* Prefix warning messages with the command name. */
625 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
626 (xstrprintf ("%s: warning: ", gdb_program_name
));
627 warning_pre_print
= tmp_warn_preprint
.get ();
629 current_directory
= getcwd (NULL
, 0);
630 if (current_directory
== NULL
)
631 perror_warning_with_name (_("error finding working directory"));
633 /* Set the sysroot path. */
635 = xstrdup (relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
636 TARGET_SYSTEM_ROOT_RELOCATABLE
).c_str ());
638 if (*gdb_sysroot
== '\0')
641 gdb_sysroot
= xstrdup (TARGET_SYSROOT_PREFIX
);
645 = xstrdup (relocate_gdb_directory (DEBUGDIR
,
646 DEBUGDIR_RELOCATABLE
).c_str ());
648 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
649 GDB_DATADIR_RELOCATABLE
);
651 #ifdef WITH_PYTHON_LIBDIR
652 python_libdir
= relocate_gdb_directory (WITH_PYTHON_LIBDIR
,
653 PYTHON_LIBDIR_RELOCATABLE
);
657 add_substitute_path_rule (RELOC_SRCDIR
,
658 make_relative_prefix (gdb_program_name
, BINDIR
,
662 /* There will always be an interpreter. Either the one passed into
663 this captured main, or one specified by the user at start up, or
664 the console. Initialize the interpreter to the one requested by
666 interpreter_p
= xstrdup (context
->interpreter_p
);
668 /* Parse arguments and options. */
671 /* When var field is 0, use flag field to record the equivalent
672 short option (or arbitrary numbers starting at 10 for those
673 with no equivalent). */
687 /* This struct requires int* in the struct, but write_files is a bool.
688 So use this temporary int that we write back after argument parsing. */
689 int write_files_1
= 0;
690 static struct option long_options
[] =
692 {"tui", no_argument
, 0, OPT_TUI
},
693 {"dbx", no_argument
, &dbx_commands
, 1},
694 {"readnow", no_argument
, NULL
, OPT_READNOW
},
695 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
696 {"r", no_argument
, NULL
, OPT_READNOW
},
697 {"quiet", no_argument
, &quiet
, 1},
698 {"q", no_argument
, &quiet
, 1},
699 {"silent", no_argument
, &quiet
, 1},
700 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
701 {"nx", no_argument
, &inhibit_gdbinit
, 1},
702 {"n", no_argument
, &inhibit_gdbinit
, 1},
703 {"batch-silent", no_argument
, 0, 'B'},
704 {"batch", no_argument
, &batch_flag
, 1},
706 /* This is a synonym for "--annotate=1". --annotate is now
707 preferred, but keep this here for a long time because people
708 will be running emacses which use --fullname. */
709 {"fullname", no_argument
, 0, 'f'},
710 {"f", no_argument
, 0, 'f'},
712 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
713 {"help", no_argument
, &print_help
, 1},
714 {"se", required_argument
, 0, OPT_SE
},
715 {"symbols", required_argument
, 0, 's'},
716 {"s", required_argument
, 0, 's'},
717 {"exec", required_argument
, 0, 'e'},
718 {"e", required_argument
, 0, 'e'},
719 {"core", required_argument
, 0, 'c'},
720 {"c", required_argument
, 0, 'c'},
721 {"pid", required_argument
, 0, 'p'},
722 {"p", required_argument
, 0, 'p'},
723 {"command", required_argument
, 0, 'x'},
724 {"eval-command", required_argument
, 0, 'X'},
725 {"version", no_argument
, &print_version
, 1},
726 {"configuration", no_argument
, &print_configuration
, 1},
727 {"x", required_argument
, 0, 'x'},
728 {"ex", required_argument
, 0, 'X'},
729 {"init-command", required_argument
, 0, OPT_IX
},
730 {"init-eval-command", required_argument
, 0, OPT_IEX
},
731 {"ix", required_argument
, 0, OPT_IX
},
732 {"iex", required_argument
, 0, OPT_IEX
},
734 {"tclcommand", required_argument
, 0, 'z'},
735 {"enable-external-editor", no_argument
, 0, 'y'},
736 {"editor-command", required_argument
, 0, 'w'},
738 {"ui", required_argument
, 0, 'i'},
739 {"interpreter", required_argument
, 0, 'i'},
740 {"i", required_argument
, 0, 'i'},
741 {"directory", required_argument
, 0, 'd'},
742 {"d", required_argument
, 0, 'd'},
743 {"data-directory", required_argument
, 0, 'D'},
744 {"D", required_argument
, 0, 'D'},
745 {"cd", required_argument
, 0, OPT_CD
},
746 {"tty", required_argument
, 0, 't'},
747 {"baud", required_argument
, 0, 'b'},
748 {"b", required_argument
, 0, 'b'},
749 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
750 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
751 {"w", no_argument
, NULL
, OPT_WINDOWS
},
752 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
753 {"statistics", no_argument
, 0, OPT_STATISTICS
},
754 {"write", no_argument
, &write_files_1
, 1},
755 {"args", no_argument
, &set_args
, 1},
756 {"l", required_argument
, 0, 'l'},
757 {"return-child-result", no_argument
, &return_child_result
, 1},
758 {0, no_argument
, 0, 0}
765 c
= getopt_long_only (argc
, argv
, "",
766 long_options
, &option_index
);
767 if (c
== EOF
|| set_args
)
770 /* Long option that takes an argument. */
771 if (c
== 0 && long_options
[option_index
].flag
== 0)
772 c
= long_options
[option_index
].val
;
777 /* Long option that just sets a flag. */
787 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
788 annotation_level
= atoi (optarg
);
791 /* Enable the display of both time and space usage. */
792 set_per_command_time (1);
793 set_per_command_space (1);
796 /* --tui is equivalent to -i=tui. */
798 xfree (interpreter_p
);
799 interpreter_p
= xstrdup (INTERP_TUI
);
801 error (_("%s: TUI mode is not supported"), gdb_program_name
);
805 /* FIXME: cagney/2003-03-01: Not sure if this option is
806 actually useful, and if it is, what it should do. */
808 /* --windows is equivalent to -i=insight. */
809 xfree (interpreter_p
);
810 interpreter_p
= xstrdup (INTERP_INSIGHT
);
814 /* -nw is equivalent to -i=console. */
815 xfree (interpreter_p
);
816 interpreter_p
= xstrdup (INTERP_CONSOLE
);
819 annotation_level
= 1;
834 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
837 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
840 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
843 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
846 batch_flag
= batch_silent
= 1;
847 gdb_stdout
= new null_file ();
850 if (optarg
[0] == '\0')
851 error (_("%s: empty path for `--data-directory'"),
853 set_gdb_data_directory (optarg
);
854 gdb_datadir_provided
= 1;
859 if (!gdbtk_test (optarg
))
860 error (_("%s: unable to load tclcommand file \"%s\""),
861 gdb_program_name
, optarg
);
865 /* Backwards compatibility only. */
869 /* Set the external editor commands when gdb is farming out files
870 to be edited by another program. */
871 external_editor_command
= xstrdup (optarg
);
876 xfree (interpreter_p
);
877 interpreter_p
= xstrdup (optarg
);
880 dirarg
.push_back (optarg
);
893 rate
= strtol (optarg
, &p
, 0);
894 if (rate
== 0 && p
== optarg
)
895 warning (_("could not set baud rate to `%s'."),
906 timeout
= strtol (optarg
, &p
, 0);
907 if (timeout
== 0 && p
== optarg
)
908 warning (_("could not set timeout limit to `%s'."),
911 remote_timeout
= timeout
;
917 readnow_symbol_files
= 1;
918 validate_readnow_readnever ();
924 readnever_symbol_files
= 1;
925 validate_readnow_readnever ();
930 error (_("Use `%s --help' for a complete list of options."),
934 write_files
= (write_files_1
!= 0);
940 /* Disable all output styling when running in batch mode. */
945 save_original_signals_state (quiet
);
947 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
948 gdb::alternate_signal_stack signal_stack
;
950 /* Initialize all files. */
951 gdb_init (gdb_program_name
);
953 /* Now that gdb_init has created the initial inferior, we're in
954 position to set args for that inferior. */
957 /* The remaining options are the command-line options for the
958 inferior. The first one is the sym/exec file, and the rest
961 error (_("%s: `--args' specified but no program specified"),
964 symarg
= argv
[optind
];
965 execarg
= argv
[optind
];
967 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
971 /* OK, that's all the options. */
973 /* The first argument, if specified, is the name of the
977 symarg
= argv
[optind
];
978 execarg
= argv
[optind
];
982 /* If the user hasn't already specified a PID or the name of a
983 core file, then a second optional argument is allowed. If
984 present, this argument should be interpreted as either a
985 PID or a core file, whichever works. */
986 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
988 pid_or_core_arg
= argv
[optind
];
992 /* Any argument left on the command line is unexpected and
993 will be ignored. Inform the user. */
995 fprintf_unfiltered (gdb_stderr
,
996 _("Excess command line "
997 "arguments ignored. (%s%s)\n"),
999 (optind
== argc
- 1) ? "" : " ...");
1002 /* Lookup gdbinit files. Note that the gdbinit file name may be
1003 overridden during file initialization, so get_init_files should be
1004 called after gdb_init. */
1005 std::vector
<std::string
> system_gdbinit
;
1006 std::string home_gdbinit
;
1007 std::string local_gdbinit
;
1008 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1010 /* Do these (and anything which might call wrap_here or *_filtered)
1011 after initialize_all_files() but before the interpreter has been
1012 installed. Otherwize the help/version messages will be eaten by
1013 the interpreter's output handler. */
1017 print_gdb_version (gdb_stdout
, false);
1019 printf_filtered ("\n");
1025 print_gdb_help (gdb_stdout
);
1029 if (print_configuration
)
1031 print_gdb_configuration (gdb_stdout
);
1033 printf_filtered ("\n");
1037 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
1038 GDB retain the old MI1 interpreter startup behavior. Output the
1039 copyright message before the interpreter is installed. That way
1040 it isn't encapsulated in MI output. */
1041 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
1043 /* Print all the junk at the top, with trailing "..." if we are
1044 about to read a symbol file (possibly slowly). */
1045 print_gdb_version (gdb_stdout
, true);
1047 printf_filtered ("..");
1049 printf_filtered ("\n");
1050 gdb_flush (gdb_stdout
); /* Force to screen during slow
1054 /* Install the default UI. All the interpreters should have had a
1055 look at things by now. Initialize the default interpreter. */
1056 set_top_level_interpreter (interpreter_p
);
1058 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
1059 GDB retain the old MI1 interpreter startup behavior. Output the
1060 copyright message after the interpreter is installed when it is
1061 any sane interpreter. */
1062 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
1064 /* Print all the junk at the top, with trailing "..." if we are
1065 about to read a symbol file (possibly slowly). */
1066 print_gdb_version (gdb_stdout
, true);
1068 printf_filtered ("..");
1070 printf_filtered ("\n");
1071 gdb_flush (gdb_stdout
); /* Force to screen during slow
1075 /* Set off error and warning messages with a blank line. */
1076 tmp_warn_preprint
.reset ();
1077 warning_pre_print
= _("\nwarning: ");
1079 /* Read and execute the system-wide gdbinit file, if it exists.
1080 This is done *before* all the command line arguments are
1081 processed; it sets global parameters, which are independent of
1082 what file you are debugging or what directory you are in. */
1083 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
1085 for (const std::string
&file
: system_gdbinit
)
1086 ret
= catch_command_errors (source_script
, file
.c_str (), 0);
1089 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
1090 *before* all the command line arguments are processed; it sets
1091 global parameters, which are independent of what file you are
1092 debugging or what directory you are in. */
1094 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1095 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1097 /* Process '-ix' and '-iex' options early. */
1098 execute_cmdargs (&cmdarg_vec
, CMDARG_INIT_FILE
, CMDARG_INIT_COMMAND
, &ret
);
1100 /* Now perform all the actions indicated by the arguments. */
1103 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1106 for (i
= 0; i
< dirarg
.size (); i
++)
1107 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1109 /* Skip auto-loading section-specified scripts until we've sourced
1110 local_gdbinit (which is often used to augment the source search
1112 save_auto_load
= global_auto_load
;
1113 global_auto_load
= 0;
1117 && strcmp (execarg
, symarg
) == 0)
1119 /* The exec file and the symbol-file are the same. If we can't
1120 open it, better only print one error message.
1121 catch_command_errors returns non-zero on success! */
1122 ret
= catch_command_errors (exec_file_attach
, execarg
,
1125 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1126 symarg
, !batch_flag
);
1130 if (execarg
!= NULL
)
1131 ret
= catch_command_errors (exec_file_attach
, execarg
,
1134 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1135 symarg
, !batch_flag
);
1138 if (corearg
&& pidarg
)
1139 error (_("Can't attach to process and specify "
1140 "a core file at the same time."));
1142 if (corearg
!= NULL
)
1144 ret
= catch_command_errors (core_file_command
, corearg
,
1147 else if (pidarg
!= NULL
)
1149 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1151 else if (pid_or_core_arg
)
1153 /* The user specified 'gdb program pid' or gdb program core'.
1154 If pid_or_core_arg's first character is a digit, try attach
1155 first and then corefile. Otherwise try just corefile. */
1157 if (isdigit (pid_or_core_arg
[0]))
1159 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1162 ret
= catch_command_errors (core_file_command
,
1168 /* Can't be a pid, better be a corefile. */
1169 ret
= catch_command_errors (core_file_command
,
1176 current_inferior ()->set_tty (ttyarg
);
1178 /* Error messages should no longer be distinguished with extra output. */
1179 warning_pre_print
= _("warning: ");
1181 /* Read the .gdbinit file in the current directory, *if* it isn't
1182 the same as the $HOME/.gdbinit file (it should exist, also). */
1183 if (!local_gdbinit
.empty ())
1185 auto_load_local_gdbinit_pathname
1186 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1188 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
)
1190 auto_load_debug_printf ("Loading .gdbinit file \"%s\".",
1191 local_gdbinit
.c_str ());
1193 if (file_is_auto_load_safe (local_gdbinit
.c_str ()))
1195 auto_load_local_gdbinit_loaded
= 1;
1197 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1202 /* Now that all .gdbinit's have been read and all -d options have been
1203 processed, we can read any scripts mentioned in SYMARG.
1204 We wait until now because it is common to add to the source search
1205 path in local_gdbinit. */
1206 global_auto_load
= save_auto_load
;
1207 for (objfile
*objfile
: current_program_space
->objfiles ())
1208 load_auto_scripts_for_objfile (objfile
);
1210 /* Process '-x' and '-ex' options. */
1211 execute_cmdargs (&cmdarg_vec
, CMDARG_FILE
, CMDARG_COMMAND
, &ret
);
1213 /* Read in the old history after all the command files have been
1219 int error_status
= EXIT_FAILURE
;
1220 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1222 /* We have hit the end of the batch file. */
1223 quit_force (exit_arg
, 0);
1228 captured_main (void *data
)
1230 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1232 captured_main_1 (context
);
1234 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1235 moving this loop and the code found in captured_command_loop()
1236 into the command_loop() proper. The main thing holding back that
1237 change - SET_TOP_LEVEL() - has been eliminated. */
1242 captured_command_loop ();
1244 catch (const gdb_exception
&ex
)
1246 exception_print (gdb_stderr
, ex
);
1249 /* No exit -- exit is through quit_command. */
1253 gdb_main (struct captured_main_args
*args
)
1257 captured_main (args
);
1259 catch (const gdb_exception
&ex
)
1261 exception_print (gdb_stderr
, ex
);
1264 /* The only way to end up here is by an error (normal exit is
1265 handled by quit_force()), hence always return an error status. */
1270 /* Don't use *_filtered for printing help. We don't want to prompt
1271 for continue no matter how small the screen or how much we're going
1275 print_gdb_help (struct ui_file
*stream
)
1277 std::vector
<std::string
> system_gdbinit
;
1278 std::string home_gdbinit
;
1279 std::string local_gdbinit
;
1281 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1283 /* Note: The options in the list below are only approximately sorted
1284 in the alphabetical order, so as to group closely related options
1286 fputs_unfiltered (_("\
1287 This is the GNU debugger. Usage:\n\n\
1288 gdb [options] [executable-file [core-file or process-id]]\n\
1289 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1291 fputs_unfiltered (_("\
1292 Selection of debuggee and its files:\n\n\
1293 --args Arguments after executable-file are passed to inferior.\n\
1294 --core=COREFILE Analyze the core dump COREFILE.\n\
1295 --exec=EXECFILE Use EXECFILE as the executable.\n\
1296 --pid=PID Attach to running process PID.\n\
1297 --directory=DIR Search for source files in DIR.\n\
1298 --se=FILE Use FILE as symbol file and executable file.\n\
1299 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1300 --readnow Fully read symbol files on first access.\n\
1301 --readnever Do not read symbol files.\n\
1302 --write Set writing into executable and core files.\n\n\
1304 fputs_unfiltered (_("\
1305 Initial commands and command files:\n\n\
1306 --command=FILE, -x Execute GDB commands from FILE.\n\
1307 --init-command=FILE, -ix\n\
1308 Like -x but execute commands before loading inferior.\n\
1309 --eval-command=COMMAND, -ex\n\
1310 Execute a single GDB command.\n\
1311 May be used multiple times and in conjunction\n\
1313 --init-eval-command=COMMAND, -iex\n\
1314 Like -ex but before loading inferior.\n\
1315 --nh Do not read ~/.gdbinit.\n\
1316 --nx Do not read any .gdbinit files in any directory.\n\n\
1318 fputs_unfiltered (_("\
1319 Output and user interface control:\n\n\
1320 --fullname Output information used by emacs-GDB interface.\n\
1321 --interpreter=INTERP\n\
1322 Select a specific interpreter / user interface.\n\
1323 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1324 -w Use the GUI interface.\n\
1325 --nw Do not use the GUI interface.\n\
1328 fputs_unfiltered (_("\
1329 --tui Use a terminal user interface.\n\
1332 fputs_unfiltered (_("\
1333 --dbx DBX compatibility mode.\n\
1334 -q, --quiet, --silent\n\
1335 Do not print version number on startup.\n\n\
1337 fputs_unfiltered (_("\
1338 Operating modes:\n\n\
1339 --batch Exit after processing options.\n\
1340 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1341 --return-child-result\n\
1342 GDB exit code will be the child's exit code.\n\
1343 --configuration Print details about GDB configuration and then exit.\n\
1344 --help Print this message and then exit.\n\
1345 --version Print version information and then exit.\n\n\
1346 Remote debugging options:\n\n\
1347 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1348 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1350 --cd=DIR Change current directory to DIR.\n\
1351 --data-directory=DIR, -D\n\
1352 Set GDB's data-directory to DIR.\n\
1354 fputs_unfiltered (_("\n\
1355 At startup, GDB reads the following init files and executes their commands:\n\
1357 if (!system_gdbinit
.empty ())
1360 for (size_t idx
= 0; idx
< system_gdbinit
.size (); ++idx
)
1362 output
+= system_gdbinit
[idx
];
1363 if (idx
< system_gdbinit
.size () - 1)
1366 fprintf_unfiltered (stream
, _("\
1367 * system-wide init files: %s\n\
1368 "), output
.c_str ());
1370 if (!home_gdbinit
.empty ())
1371 fprintf_unfiltered (stream
, _("\
1372 * user-specific init file: %s\n\
1373 "), home_gdbinit
.c_str ());
1374 if (!local_gdbinit
.empty ())
1375 fprintf_unfiltered (stream
, _("\
1376 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1377 "), local_gdbinit
.c_str ());
1378 fputs_unfiltered (_("\n\
1379 For more information, type \"help\" from within GDB, or consult the\n\
1380 GDB manual (available as on-line info or a printed manual).\n\
1382 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1383 fprintf_unfiltered (stream
, _("\n\
1384 Report bugs to %s.\n\
1385 "), REPORT_BUGS_TO
);
1386 if (stream
== gdb_stdout
)
1387 fprintf_unfiltered (stream
, _("\n\
1388 You can ask GDB-related questions on the GDB users mailing list\n\
1389 (gdb@sourceware.org) or on GDB's IRC channel (#gdb on Freenode).\n"));