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"
58 /* The selected interpreter. This will be used as a set command
59 variable, so it should always be malloc'ed - since
60 do_setshow_command will free it. */
63 /* Whether dbx commands will be handled. */
66 /* System root path, used to find libraries etc. */
67 char *gdb_sysroot
= 0;
69 /* GDB datadir, used to store data files. */
70 std::string gdb_datadir
;
72 /* Non-zero if GDB_DATADIR was provided on the command line.
73 This doesn't track whether data-directory is set later from the
74 command line, but we don't reread system.gdbinit when that happens. */
75 static int gdb_datadir_provided
= 0;
77 /* If gdb was configured with --with-python=/path,
78 the possibly relocated path to python's lib directory. */
79 std::string python_libdir
;
81 /* Target IO streams. */
82 struct ui_file
*gdb_stdtargin
;
83 struct ui_file
*gdb_stdtarg
;
84 struct ui_file
*gdb_stdtargerr
;
86 /* True if --batch or --batch-silent was seen. */
89 /* Support for the --batch-silent option. */
92 /* Support for --return-child-result option.
93 Set the default to -1 to return error in the case
94 that the program does not run or does not complete. */
95 int return_child_result
= 0;
96 int return_child_result_value
= -1;
99 /* GDB as it has been invoked from the command line (i.e. argv[0]). */
100 static char *gdb_program_name
;
102 /* Return read only pointer to GDB_PROGRAM_NAME. */
104 get_gdb_program_name (void)
106 return gdb_program_name
;
109 static void print_gdb_help (struct ui_file
*);
111 /* Set the data-directory parameter to NEW_DATADIR.
112 If NEW_DATADIR is not a directory then a warning is printed.
113 We don't signal an error for backward compatibility. */
116 set_gdb_data_directory (const char *new_datadir
)
120 if (stat (new_datadir
, &st
) < 0)
122 int save_errno
= errno
;
124 fprintf_unfiltered (gdb_stderr
, "Warning: ");
125 print_sys_errmsg (new_datadir
, save_errno
);
127 else if (!S_ISDIR (st
.st_mode
))
128 warning (_("%ps is not a directory."),
129 styled_string (file_name_style
.style (), new_datadir
));
131 gdb_datadir
= gdb_realpath (new_datadir
).get ();
133 /* gdb_realpath won't return an absolute path if the path doesn't exist,
134 but we still want to record an absolute path here. If the user entered
135 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
136 isn't canonical, but that's ok. */
137 if (!IS_ABSOLUTE_PATH (gdb_datadir
.c_str ()))
139 gdb::unique_xmalloc_ptr
<char> abs_datadir
140 = gdb_abspath (gdb_datadir
.c_str ());
142 gdb_datadir
= abs_datadir
.get ();
146 /* Relocate a file or directory. PROGNAME is the name by which gdb
147 was invoked (i.e., argv[0]). INITIAL is the default value for the
148 file or directory. RELOCATABLE is true if the value is relocatable,
149 false otherwise. This may return an empty string under the same
150 conditions as make_relative_prefix returning NULL. */
153 relocate_path (const char *progname
, const char *initial
, bool relocatable
)
157 gdb::unique_xmalloc_ptr
<char> str (make_relative_prefix (progname
,
162 return std::string ();
167 /* Like relocate_path, but specifically checks for a directory.
168 INITIAL is relocated according to the rules of relocate_path. If
169 the result is a directory, it is used; otherwise, INITIAL is used.
170 The chosen directory is then canonicalized using lrealpath. */
173 relocate_gdb_directory (const char *initial
, bool relocatable
)
175 std::string dir
= relocate_path (gdb_program_name
, initial
, relocatable
);
180 if (stat (dir
.c_str (), &s
) != 0 || !S_ISDIR (s
.st_mode
))
188 /* Canonicalize the directory. */
191 gdb::unique_xmalloc_ptr
<char> canon_sysroot (lrealpath (dir
.c_str ()));
194 dir
= canon_sysroot
.get ();
200 /* Given a gdbinit path in FILE, adjusts it according to the gdb_datadir
201 parameter if it is in the data dir, or passes it through relocate_path
205 relocate_gdbinit_path_maybe_in_datadir (const std::string
&file
,
208 size_t datadir_len
= strlen (GDB_DATADIR
);
210 std::string relocated_path
;
212 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
213 has been provided, search for SYSTEM_GDBINIT there. */
214 if (gdb_datadir_provided
215 && datadir_len
< file
.length ()
216 && filename_ncmp (file
.c_str (), GDB_DATADIR
, datadir_len
) == 0
217 && IS_DIR_SEPARATOR (file
[datadir_len
]))
219 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
222 size_t start
= datadir_len
;
223 for (; IS_DIR_SEPARATOR (file
[start
]); ++start
)
225 relocated_path
= gdb_datadir
+ SLASH_STRING
+ file
.substr (start
);
229 relocated_path
= relocate_path (gdb_program_name
, file
.c_str (),
232 return relocated_path
;
235 /* Compute the locations of init files that GDB should source and
236 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
237 there is no system gdbinit (resp. home gdbinit and local gdbinit)
238 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
239 LOCAL_GDBINIT) is set to the empty string. */
241 get_init_files (std::vector
<std::string
> *system_gdbinit
,
242 std::string
*home_gdbinit
,
243 std::string
*local_gdbinit
)
245 static std::vector
<std::string
> sysgdbinit
;
246 static std::string homeinit
;
247 static std::string localinit
;
248 static int initialized
= 0;
252 struct stat homebuf
, cwdbuf
, s
;
254 if (SYSTEM_GDBINIT
[0])
256 std::string relocated_sysgdbinit
257 = relocate_gdbinit_path_maybe_in_datadir
258 (SYSTEM_GDBINIT
, SYSTEM_GDBINIT_RELOCATABLE
);
259 if (!relocated_sysgdbinit
.empty ()
260 && stat (relocated_sysgdbinit
.c_str (), &s
) == 0)
261 sysgdbinit
.push_back (relocated_sysgdbinit
);
263 if (SYSTEM_GDBINIT_DIR
[0])
265 std::string relocated_gdbinit_dir
266 = relocate_gdbinit_path_maybe_in_datadir
267 (SYSTEM_GDBINIT_DIR
, SYSTEM_GDBINIT_DIR_RELOCATABLE
);
268 if (!relocated_gdbinit_dir
.empty ()) {
269 gdb_dir_up
dir (opendir (relocated_gdbinit_dir
.c_str ()));
272 std::vector
<std::string
> files
;
275 struct dirent
*ent
= readdir (dir
.get ());
278 std::string
name (ent
->d_name
);
279 if (name
== "." || name
== "..")
281 /* ent->d_type is not available on all systems (e.g. mingw,
282 Solaris), so we have to call stat(). */
284 = relocated_gdbinit_dir
+ SLASH_STRING
+ name
;
285 if (stat (filename
.c_str (), &s
) != 0
286 || !S_ISREG (s
.st_mode
))
288 const struct extension_language_defn
*extlang
289 = get_ext_lang_of_file (filename
.c_str ());
290 /* We effectively don't support "set script-extension
291 off/soft", because we are loading system init files here,
292 so it does not really make sense to depend on a
294 if (extlang
!= nullptr && ext_lang_present_p (extlang
))
295 files
.push_back (std::move (filename
));
297 std::sort (files
.begin (), files
.end ());
298 sysgdbinit
.insert (sysgdbinit
.end (),
299 files
.begin (), files
.end ());
304 /* If the .gdbinit file in the current directory is the same as
305 the $HOME/.gdbinit file, it should not be sourced. homebuf
306 and cwdbuf are used in that purpose. Make sure that the stats
307 are zero in case one of them fails (this guarantees that they
308 won't match if either exists). */
310 memset (&homebuf
, 0, sizeof (struct stat
));
311 memset (&cwdbuf
, 0, sizeof (struct stat
));
313 homeinit
= find_gdb_home_config_file (GDBINIT
, &homebuf
);
315 if (stat (GDBINIT
, &cwdbuf
) == 0)
317 if (homeinit
.empty ()
318 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
319 sizeof (struct stat
)))
326 *system_gdbinit
= sysgdbinit
;
327 *home_gdbinit
= homeinit
;
328 *local_gdbinit
= localinit
;
331 /* Start up the event loop. This is the entry point to the event loop
332 from the command loop. */
337 /* Loop until there is nothing to do. This is the entry point to
338 the event loop engine. gdb_do_one_event will process one event
339 for each invocation. It blocks waiting for an event and then
347 result
= gdb_do_one_event ();
349 catch (const gdb_exception
&ex
)
351 exception_print (gdb_stderr
, ex
);
353 /* If any exception escaped to here, we better enable
354 stdin. Otherwise, any command that calls async_disable_stdin,
355 and then throws, will leave stdin inoperable. */
356 SWITCH_THRU_ALL_UIS ()
358 async_enable_stdin ();
360 /* If we long-jumped out of do_one_event, we probably didn't
361 get around to resetting the prompt, which leaves readline
362 in a messed-up state. Reset it here. */
363 current_ui
->prompt_state
= PROMPT_NEEDED
;
364 gdb::observers::command_error
.notify ();
365 /* This call looks bizarre, but it is required. If the user
366 entered a command that caused an error,
367 after_char_processing_hook won't be called from
368 rl_callback_read_char_wrapper. Using a cleanup there
369 won't work, since we want this function to be called
370 after a new prompt is printed. */
371 if (after_char_processing_hook
)
372 (*after_char_processing_hook
) ();
373 /* Maybe better to set a flag to be checked somewhere as to
374 whether display the prompt or not. */
381 /* We are done with the event loop. There are no more event sources
382 to listen to. So we exit GDB. */
386 /* Call command_loop. */
388 /* Prevent inlining this function for the benefit of GDB's selftests
389 in the testsuite. Those tests want to run GDB under GDB and stop
391 static void captured_command_loop () __attribute__((noinline
));
394 captured_command_loop ()
396 struct ui
*ui
= current_ui
;
398 /* Top-level execution commands can be run in the background from
400 current_ui
->async
= 1;
402 /* Give the interpreter a chance to print a prompt, if necessary */
403 if (ui
->prompt_state
!= PROMPT_BLOCKED
)
404 interp_pre_command_loop (top_level_interpreter ());
406 /* Now it's time to start the event loop. */
409 /* If the command_loop returned, normally (rather than threw an
410 error) we try to quit. If the quit is aborted, our caller
411 catches the signal and restarts the command loop. */
412 quit_command (NULL
, ui
->instream
== ui
->stdin_stream
);
415 /* Handle command errors thrown from within catch_command_errors. */
418 handle_command_errors (const struct gdb_exception
&e
)
422 exception_print (gdb_stderr
, e
);
424 /* If any exception escaped to here, we better enable stdin.
425 Otherwise, any command that calls async_disable_stdin, and
426 then throws, will leave stdin inoperable. */
427 async_enable_stdin ();
433 /* Type of the command callback passed to the const
434 catch_command_errors. */
436 typedef void (catch_command_errors_const_ftype
) (const char *, int);
438 /* Wrap calls to commands run before the event loop is started. */
441 catch_command_errors (catch_command_errors_const_ftype command
,
442 const char *arg
, int from_tty
,
443 bool do_bp_actions
= false)
447 int was_sync
= current_ui
->prompt_state
== PROMPT_BLOCKED
;
449 command (arg
, from_tty
);
451 maybe_wait_sync_command_done (was_sync
);
453 /* Do any commands attached to breakpoint we stopped at. */
455 bpstat_do_actions ();
457 catch (const gdb_exception
&e
)
459 return handle_command_errors (e
);
465 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
466 symfile_add_flags. */
469 symbol_file_add_main_adapter (const char *arg
, int from_tty
)
471 symfile_add_flags add_flags
= 0;
474 add_flags
|= SYMFILE_VERBOSE
;
476 symbol_file_add_main (arg
, add_flags
);
479 /* Perform validation of the '--readnow' and '--readnever' flags. */
482 validate_readnow_readnever ()
484 if (readnever_symbol_files
&& readnow_symbol_files
)
486 error (_("%s: '--readnow' and '--readnever' cannot be "
487 "specified simultaneously"),
492 /* Type of this option. */
495 /* Option type -x. */
498 /* Option type -ex. */
501 /* Option type -ix. */
504 /* Option type -iex. */
508 /* Arguments of --command option and its counterpart. */
511 cmdarg (cmdarg_kind type_
, char *string_
)
512 : type (type_
), string (string_
)
515 /* Type of this option. */
516 enum cmdarg_kind type
;
518 /* Value of this option - filename or the GDB command itself. String memory
519 is not owned by this structure despite it is 'const'. */
523 /* From CMDARG_VEC execute command files (matching FILE_TYPE) or commands
524 (matching CMD_TYPE). Update the value in *RET if and scripts or
525 commands are executed. */
528 execute_cmdargs (const std::vector
<struct cmdarg
> *cmdarg_vec
,
529 cmdarg_kind file_type
, cmdarg_kind cmd_type
,
532 for (const auto &cmdarg_p
: *cmdarg_vec
)
534 if (cmdarg_p
.type
== file_type
)
535 *ret
= catch_command_errors (source_script
, cmdarg_p
.string
,
537 else if (cmdarg_p
.type
== cmd_type
)
538 *ret
= catch_command_errors (execute_command
, cmdarg_p
.string
,
544 captured_main_1 (struct captured_main_args
*context
)
546 int argc
= context
->argc
;
547 char **argv
= context
->argv
;
549 static int quiet
= 0;
550 static int set_args
= 0;
551 static int inhibit_home_gdbinit
= 0;
553 /* Pointers to various arguments from command line. */
555 char *execarg
= NULL
;
557 char *corearg
= NULL
;
558 char *pid_or_core_arg
= NULL
;
562 /* These are static so that we can take their address in an
564 static int print_help
;
565 static int print_version
;
566 static int print_configuration
;
568 /* Pointers to all arguments of --command option. */
569 std::vector
<struct cmdarg
> cmdarg_vec
;
571 /* All arguments of --directory option. */
572 std::vector
<char *> dirarg
;
578 #ifdef HAVE_USEFUL_SBRK
579 /* Set this before constructing scoped_command_stats. */
580 lim_at_start
= (char *) sbrk (0);
583 scoped_command_stats
stat_reporter (false);
585 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
586 setlocale (LC_MESSAGES
, "");
588 #if defined (HAVE_SETLOCALE)
589 setlocale (LC_CTYPE
, "");
592 bindtextdomain (PACKAGE
, LOCALEDIR
);
593 textdomain (PACKAGE
);
599 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
600 as a Windows pipe, and Windows buffers on pipes. */
601 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
604 /* Note: `error' cannot be called before this point, because the
605 caller will crash when trying to print the exception. */
606 main_ui
= new ui (stdin
, stdout
, stderr
);
607 current_ui
= main_ui
;
609 gdb_stdtargerr
= gdb_stderr
; /* for moment */
610 gdb_stdtargin
= gdb_stdin
; /* for moment */
612 if (bfd_init () != BFD_INIT_MAGIC
)
613 error (_("fatal error: libbfd ABI mismatch"));
616 /* On Windows, argv[0] is not necessarily set to absolute form when
617 GDB is found along PATH, without which relocation doesn't work. */
618 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
620 gdb_program_name
= xstrdup (argv
[0]);
623 /* Prefix warning messages with the command name. */
624 gdb::unique_xmalloc_ptr
<char> tmp_warn_preprint
625 (xstrprintf ("%s: warning: ", gdb_program_name
));
626 warning_pre_print
= tmp_warn_preprint
.get ();
628 current_directory
= getcwd (NULL
, 0);
629 if (current_directory
== NULL
)
630 perror_warning_with_name (_("error finding working directory"));
632 /* Set the sysroot path. */
634 = xstrdup (relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
635 TARGET_SYSTEM_ROOT_RELOCATABLE
).c_str ());
637 if (*gdb_sysroot
== '\0')
640 gdb_sysroot
= xstrdup (TARGET_SYSROOT_PREFIX
);
644 = xstrdup (relocate_gdb_directory (DEBUGDIR
,
645 DEBUGDIR_RELOCATABLE
).c_str ());
647 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
648 GDB_DATADIR_RELOCATABLE
);
650 #ifdef WITH_PYTHON_LIBDIR
651 python_libdir
= relocate_gdb_directory (WITH_PYTHON_LIBDIR
,
652 PYTHON_LIBDIR_RELOCATABLE
);
656 add_substitute_path_rule (RELOC_SRCDIR
,
657 make_relative_prefix (gdb_program_name
, BINDIR
,
661 /* There will always be an interpreter. Either the one passed into
662 this captured main, or one specified by the user at start up, or
663 the console. Initialize the interpreter to the one requested by
665 interpreter_p
= xstrdup (context
->interpreter_p
);
667 /* Parse arguments and options. */
670 /* When var field is 0, use flag field to record the equivalent
671 short option (or arbitrary numbers starting at 10 for those
672 with no equivalent). */
686 /* This struct requires int* in the struct, but write_files is a bool.
687 So use this temporary int that we write back after argument parsing. */
688 int write_files_1
= 0;
689 static struct option long_options
[] =
691 {"tui", no_argument
, 0, OPT_TUI
},
692 {"dbx", no_argument
, &dbx_commands
, 1},
693 {"readnow", no_argument
, NULL
, OPT_READNOW
},
694 {"readnever", no_argument
, NULL
, OPT_READNEVER
},
695 {"r", no_argument
, NULL
, OPT_READNOW
},
696 {"quiet", no_argument
, &quiet
, 1},
697 {"q", no_argument
, &quiet
, 1},
698 {"silent", no_argument
, &quiet
, 1},
699 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
700 {"nx", no_argument
, &inhibit_gdbinit
, 1},
701 {"n", no_argument
, &inhibit_gdbinit
, 1},
702 {"batch-silent", no_argument
, 0, 'B'},
703 {"batch", no_argument
, &batch_flag
, 1},
705 /* This is a synonym for "--annotate=1". --annotate is now
706 preferred, but keep this here for a long time because people
707 will be running emacses which use --fullname. */
708 {"fullname", no_argument
, 0, 'f'},
709 {"f", no_argument
, 0, 'f'},
711 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
712 {"help", no_argument
, &print_help
, 1},
713 {"se", required_argument
, 0, OPT_SE
},
714 {"symbols", required_argument
, 0, 's'},
715 {"s", required_argument
, 0, 's'},
716 {"exec", required_argument
, 0, 'e'},
717 {"e", required_argument
, 0, 'e'},
718 {"core", required_argument
, 0, 'c'},
719 {"c", required_argument
, 0, 'c'},
720 {"pid", required_argument
, 0, 'p'},
721 {"p", required_argument
, 0, 'p'},
722 {"command", required_argument
, 0, 'x'},
723 {"eval-command", required_argument
, 0, 'X'},
724 {"version", no_argument
, &print_version
, 1},
725 {"configuration", no_argument
, &print_configuration
, 1},
726 {"x", required_argument
, 0, 'x'},
727 {"ex", required_argument
, 0, 'X'},
728 {"init-command", required_argument
, 0, OPT_IX
},
729 {"init-eval-command", required_argument
, 0, OPT_IEX
},
730 {"ix", required_argument
, 0, OPT_IX
},
731 {"iex", required_argument
, 0, OPT_IEX
},
733 {"tclcommand", required_argument
, 0, 'z'},
734 {"enable-external-editor", no_argument
, 0, 'y'},
735 {"editor-command", required_argument
, 0, 'w'},
737 {"ui", required_argument
, 0, 'i'},
738 {"interpreter", required_argument
, 0, 'i'},
739 {"i", required_argument
, 0, 'i'},
740 {"directory", required_argument
, 0, 'd'},
741 {"d", required_argument
, 0, 'd'},
742 {"data-directory", required_argument
, 0, 'D'},
743 {"D", required_argument
, 0, 'D'},
744 {"cd", required_argument
, 0, OPT_CD
},
745 {"tty", required_argument
, 0, 't'},
746 {"baud", required_argument
, 0, 'b'},
747 {"b", required_argument
, 0, 'b'},
748 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
749 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
750 {"w", no_argument
, NULL
, OPT_WINDOWS
},
751 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
752 {"statistics", no_argument
, 0, OPT_STATISTICS
},
753 {"write", no_argument
, &write_files_1
, 1},
754 {"args", no_argument
, &set_args
, 1},
755 {"l", required_argument
, 0, 'l'},
756 {"return-child-result", no_argument
, &return_child_result
, 1},
757 {0, no_argument
, 0, 0}
764 c
= getopt_long_only (argc
, argv
, "",
765 long_options
, &option_index
);
766 if (c
== EOF
|| set_args
)
769 /* Long option that takes an argument. */
770 if (c
== 0 && long_options
[option_index
].flag
== 0)
771 c
= long_options
[option_index
].val
;
776 /* Long option that just sets a flag. */
786 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
787 annotation_level
= atoi (optarg
);
790 /* Enable the display of both time and space usage. */
791 set_per_command_time (1);
792 set_per_command_space (1);
795 /* --tui is equivalent to -i=tui. */
797 xfree (interpreter_p
);
798 interpreter_p
= xstrdup (INTERP_TUI
);
800 error (_("%s: TUI mode is not supported"), gdb_program_name
);
804 /* FIXME: cagney/2003-03-01: Not sure if this option is
805 actually useful, and if it is, what it should do. */
807 /* --windows is equivalent to -i=insight. */
808 xfree (interpreter_p
);
809 interpreter_p
= xstrdup (INTERP_INSIGHT
);
813 /* -nw is equivalent to -i=console. */
814 xfree (interpreter_p
);
815 interpreter_p
= xstrdup (INTERP_CONSOLE
);
818 annotation_level
= 1;
833 cmdarg_vec
.emplace_back (CMDARG_FILE
, optarg
);
836 cmdarg_vec
.emplace_back (CMDARG_COMMAND
, optarg
);
839 cmdarg_vec
.emplace_back (CMDARG_INIT_FILE
, optarg
);
842 cmdarg_vec
.emplace_back (CMDARG_INIT_COMMAND
, optarg
);
845 batch_flag
= batch_silent
= 1;
846 gdb_stdout
= new null_file ();
849 if (optarg
[0] == '\0')
850 error (_("%s: empty path for `--data-directory'"),
852 set_gdb_data_directory (optarg
);
853 gdb_datadir_provided
= 1;
858 if (!gdbtk_test (optarg
))
859 error (_("%s: unable to load tclcommand file \"%s\""),
860 gdb_program_name
, optarg
);
864 /* Backwards compatibility only. */
868 /* Set the external editor commands when gdb is farming out files
869 to be edited by another program. */
870 external_editor_command
= xstrdup (optarg
);
875 xfree (interpreter_p
);
876 interpreter_p
= xstrdup (optarg
);
879 dirarg
.push_back (optarg
);
892 rate
= strtol (optarg
, &p
, 0);
893 if (rate
== 0 && p
== optarg
)
894 warning (_("could not set baud rate to `%s'."),
905 timeout
= strtol (optarg
, &p
, 0);
906 if (timeout
== 0 && p
== optarg
)
907 warning (_("could not set timeout limit to `%s'."),
910 remote_timeout
= timeout
;
916 readnow_symbol_files
= 1;
917 validate_readnow_readnever ();
923 readnever_symbol_files
= 1;
924 validate_readnow_readnever ();
929 error (_("Use `%s --help' for a complete list of options."),
933 write_files
= (write_files_1
!= 0);
939 /* Disable all output styling when running in batch mode. */
944 save_original_signals_state (quiet
);
946 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
947 gdb::alternate_signal_stack signal_stack
;
949 /* Initialize all files. */
950 gdb_init (gdb_program_name
);
952 /* Now that gdb_init has created the initial inferior, we're in
953 position to set args for that inferior. */
956 /* The remaining options are the command-line options for the
957 inferior. The first one is the sym/exec file, and the rest
960 error (_("%s: `--args' specified but no program specified"),
963 symarg
= argv
[optind
];
964 execarg
= argv
[optind
];
966 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
970 /* OK, that's all the options. */
972 /* The first argument, if specified, is the name of the
976 symarg
= argv
[optind
];
977 execarg
= argv
[optind
];
981 /* If the user hasn't already specified a PID or the name of a
982 core file, then a second optional argument is allowed. If
983 present, this argument should be interpreted as either a
984 PID or a core file, whichever works. */
985 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
987 pid_or_core_arg
= argv
[optind
];
991 /* Any argument left on the command line is unexpected and
992 will be ignored. Inform the user. */
994 fprintf_unfiltered (gdb_stderr
,
995 _("Excess command line "
996 "arguments ignored. (%s%s)\n"),
998 (optind
== argc
- 1) ? "" : " ...");
1001 /* Lookup gdbinit files. Note that the gdbinit file name may be
1002 overridden during file initialization, so get_init_files should be
1003 called after gdb_init. */
1004 std::vector
<std::string
> system_gdbinit
;
1005 std::string home_gdbinit
;
1006 std::string local_gdbinit
;
1007 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1009 /* Do these (and anything which might call wrap_here or *_filtered)
1010 after initialize_all_files() but before the interpreter has been
1011 installed. Otherwize the help/version messages will be eaten by
1012 the interpreter's output handler. */
1016 print_gdb_version (gdb_stdout
, false);
1018 printf_filtered ("\n");
1024 print_gdb_help (gdb_stdout
);
1028 if (print_configuration
)
1030 print_gdb_configuration (gdb_stdout
);
1032 printf_filtered ("\n");
1036 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
1037 GDB retain the old MI1 interpreter startup behavior. Output the
1038 copyright message before the interpreter is installed. That way
1039 it isn't encapsulated in MI output. */
1040 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
1042 /* Print all the junk at the top, with trailing "..." if we are
1043 about to read a symbol file (possibly slowly). */
1044 print_gdb_version (gdb_stdout
, true);
1046 printf_filtered ("..");
1048 printf_filtered ("\n");
1049 gdb_flush (gdb_stdout
); /* Force to screen during slow
1053 /* Install the default UI. All the interpreters should have had a
1054 look at things by now. Initialize the default interpreter. */
1055 set_top_level_interpreter (interpreter_p
);
1057 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
1058 GDB retain the old MI1 interpreter startup behavior. Output the
1059 copyright message after the interpreter is installed when it is
1060 any sane interpreter. */
1061 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
1063 /* Print all the junk at the top, with trailing "..." if we are
1064 about to read a symbol file (possibly slowly). */
1065 print_gdb_version (gdb_stdout
, true);
1067 printf_filtered ("..");
1069 printf_filtered ("\n");
1070 gdb_flush (gdb_stdout
); /* Force to screen during slow
1074 /* Set off error and warning messages with a blank line. */
1075 tmp_warn_preprint
.reset ();
1076 warning_pre_print
= _("\nwarning: ");
1078 /* Read and execute the system-wide gdbinit file, if it exists.
1079 This is done *before* all the command line arguments are
1080 processed; it sets global parameters, which are independent of
1081 what file you are debugging or what directory you are in. */
1082 if (!system_gdbinit
.empty () && !inhibit_gdbinit
)
1084 for (const std::string
&file
: system_gdbinit
)
1085 ret
= catch_command_errors (source_script
, file
.c_str (), 0);
1088 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
1089 *before* all the command line arguments are processed; it sets
1090 global parameters, which are independent of what file you are
1091 debugging or what directory you are in. */
1093 if (!home_gdbinit
.empty () && !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
1094 ret
= catch_command_errors (source_script
, home_gdbinit
.c_str (), 0);
1096 /* Process '-ix' and '-iex' options early. */
1097 execute_cmdargs (&cmdarg_vec
, CMDARG_INIT_FILE
, CMDARG_INIT_COMMAND
, &ret
);
1099 /* Now perform all the actions indicated by the arguments. */
1102 ret
= catch_command_errors (cd_command
, cdarg
, 0);
1105 for (i
= 0; i
< dirarg
.size (); i
++)
1106 ret
= catch_command_errors (directory_switch
, dirarg
[i
], 0);
1108 /* Skip auto-loading section-specified scripts until we've sourced
1109 local_gdbinit (which is often used to augment the source search
1111 save_auto_load
= global_auto_load
;
1112 global_auto_load
= 0;
1116 && strcmp (execarg
, symarg
) == 0)
1118 /* The exec file and the symbol-file are the same. If we can't
1119 open it, better only print one error message.
1120 catch_command_errors returns non-zero on success! */
1121 ret
= catch_command_errors (exec_file_attach
, execarg
,
1124 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1125 symarg
, !batch_flag
);
1129 if (execarg
!= NULL
)
1130 ret
= catch_command_errors (exec_file_attach
, execarg
,
1133 ret
= catch_command_errors (symbol_file_add_main_adapter
,
1134 symarg
, !batch_flag
);
1137 if (corearg
&& pidarg
)
1138 error (_("Can't attach to process and specify "
1139 "a core file at the same time."));
1141 if (corearg
!= NULL
)
1143 ret
= catch_command_errors (core_file_command
, corearg
,
1146 else if (pidarg
!= NULL
)
1148 ret
= catch_command_errors (attach_command
, pidarg
, !batch_flag
);
1150 else if (pid_or_core_arg
)
1152 /* The user specified 'gdb program pid' or gdb program core'.
1153 If pid_or_core_arg's first character is a digit, try attach
1154 first and then corefile. Otherwise try just corefile. */
1156 if (isdigit (pid_or_core_arg
[0]))
1158 ret
= catch_command_errors (attach_command
, pid_or_core_arg
,
1161 ret
= catch_command_errors (core_file_command
,
1167 /* Can't be a pid, better be a corefile. */
1168 ret
= catch_command_errors (core_file_command
,
1175 current_inferior ()->set_tty (ttyarg
);
1177 /* Error messages should no longer be distinguished with extra output. */
1178 warning_pre_print
= _("warning: ");
1180 /* Read the .gdbinit file in the current directory, *if* it isn't
1181 the same as the $HOME/.gdbinit file (it should exist, also). */
1182 if (!local_gdbinit
.empty ())
1184 auto_load_local_gdbinit_pathname
1185 = gdb_realpath (local_gdbinit
.c_str ()).release ();
1187 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
1188 && file_is_auto_load_safe (local_gdbinit
.c_str (),
1189 _("auto-load: Loading .gdbinit "
1191 local_gdbinit
.c_str ()))
1193 auto_load_local_gdbinit_loaded
= 1;
1195 ret
= catch_command_errors (source_script
, local_gdbinit
.c_str (), 0);
1199 /* Now that all .gdbinit's have been read and all -d options have been
1200 processed, we can read any scripts mentioned in SYMARG.
1201 We wait until now because it is common to add to the source search
1202 path in local_gdbinit. */
1203 global_auto_load
= save_auto_load
;
1204 for (objfile
*objfile
: current_program_space
->objfiles ())
1205 load_auto_scripts_for_objfile (objfile
);
1207 /* Process '-x' and '-ex' options. */
1208 execute_cmdargs (&cmdarg_vec
, CMDARG_FILE
, CMDARG_COMMAND
, &ret
);
1210 /* Read in the old history after all the command files have been
1216 int error_status
= EXIT_FAILURE
;
1217 int *exit_arg
= ret
== 0 ? &error_status
: NULL
;
1219 /* We have hit the end of the batch file. */
1220 quit_force (exit_arg
, 0);
1225 captured_main (void *data
)
1227 struct captured_main_args
*context
= (struct captured_main_args
*) data
;
1229 captured_main_1 (context
);
1231 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1232 moving this loop and the code found in captured_command_loop()
1233 into the command_loop() proper. The main thing holding back that
1234 change - SET_TOP_LEVEL() - has been eliminated. */
1239 captured_command_loop ();
1241 catch (const gdb_exception
&ex
)
1243 exception_print (gdb_stderr
, ex
);
1246 /* No exit -- exit is through quit_command. */
1250 gdb_main (struct captured_main_args
*args
)
1254 captured_main (args
);
1256 catch (const gdb_exception
&ex
)
1258 exception_print (gdb_stderr
, ex
);
1261 /* The only way to end up here is by an error (normal exit is
1262 handled by quit_force()), hence always return an error status. */
1267 /* Don't use *_filtered for printing help. We don't want to prompt
1268 for continue no matter how small the screen or how much we're going
1272 print_gdb_help (struct ui_file
*stream
)
1274 std::vector
<std::string
> system_gdbinit
;
1275 std::string home_gdbinit
;
1276 std::string local_gdbinit
;
1278 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1280 /* Note: The options in the list below are only approximately sorted
1281 in the alphabetical order, so as to group closely related options
1283 fputs_unfiltered (_("\
1284 This is the GNU debugger. Usage:\n\n\
1285 gdb [options] [executable-file [core-file or process-id]]\n\
1286 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1288 fputs_unfiltered (_("\
1289 Selection of debuggee and its files:\n\n\
1290 --args Arguments after executable-file are passed to inferior\n\
1291 --core=COREFILE Analyze the core dump COREFILE.\n\
1292 --exec=EXECFILE Use EXECFILE as the executable.\n\
1293 --pid=PID Attach to running process PID.\n\
1294 --directory=DIR Search for source files in DIR.\n\
1295 --se=FILE Use FILE as symbol file and executable file.\n\
1296 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1297 --readnow Fully read symbol files on first access.\n\
1298 --readnever Do not read symbol files.\n\
1299 --write Set writing into executable and core files.\n\n\
1301 fputs_unfiltered (_("\
1302 Initial commands and command files:\n\n\
1303 --command=FILE, -x Execute GDB commands from FILE.\n\
1304 --init-command=FILE, -ix\n\
1305 Like -x but execute commands before loading inferior.\n\
1306 --eval-command=COMMAND, -ex\n\
1307 Execute a single GDB command.\n\
1308 May be used multiple times and in conjunction\n\
1310 --init-eval-command=COMMAND, -iex\n\
1311 Like -ex but before loading inferior.\n\
1312 --nh Do not read ~/.gdbinit.\n\
1313 --nx Do not read any .gdbinit files in any directory.\n\n\
1315 fputs_unfiltered (_("\
1316 Output and user interface control:\n\n\
1317 --fullname Output information used by emacs-GDB interface.\n\
1318 --interpreter=INTERP\n\
1319 Select a specific interpreter / user interface\n\
1320 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1321 -w Use the GUI interface.\n\
1322 --nw Do not use the GUI interface.\n\
1325 fputs_unfiltered (_("\
1326 --tui Use a terminal user interface.\n\
1329 fputs_unfiltered (_("\
1330 --dbx DBX compatibility mode.\n\
1331 -q, --quiet, --silent\n\
1332 Do not print version number on startup.\n\n\
1334 fputs_unfiltered (_("\
1335 Operating modes:\n\n\
1336 --batch Exit after processing options.\n\
1337 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1338 --return-child-result\n\
1339 GDB exit code will be the child's exit code.\n\
1340 --configuration Print details about GDB configuration and then exit.\n\
1341 --help Print this message and then exit.\n\
1342 --version Print version information and then exit.\n\n\
1343 Remote debugging options:\n\n\
1344 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1345 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1347 --cd=DIR Change current directory to DIR.\n\
1348 --data-directory=DIR, -D\n\
1349 Set GDB's data-directory to DIR.\n\
1351 fputs_unfiltered (_("\n\
1352 At startup, GDB reads the following init files and executes their commands:\n\
1354 if (!system_gdbinit
.empty ())
1357 for (size_t idx
= 0; idx
< system_gdbinit
.size (); ++idx
)
1359 output
+= system_gdbinit
[idx
];
1360 if (idx
< system_gdbinit
.size () - 1)
1363 fprintf_unfiltered (stream
, _("\
1364 * system-wide init files: %s\n\
1365 "), output
.c_str ());
1367 if (!home_gdbinit
.empty ())
1368 fprintf_unfiltered (stream
, _("\
1369 * user-specific init file: %s\n\
1370 "), home_gdbinit
.c_str ());
1371 if (!local_gdbinit
.empty ())
1372 fprintf_unfiltered (stream
, _("\
1373 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1374 "), local_gdbinit
.c_str ());
1375 fputs_unfiltered (_("\n\
1376 For more information, type \"help\" from within GDB, or consult the\n\
1377 GDB manual (available as on-line info or a printed manual).\n\
1379 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1380 fprintf_unfiltered (stream
, _("\n\
1381 Report bugs to %s.\n\
1382 "), REPORT_BUGS_TO
);
1383 if (stream
== gdb_stdout
)
1384 fprintf_unfiltered (stream
, _("\n\
1385 You can ask GDB-related questions on the GDB users mailing list\n\
1386 (gdb@sourceware.org) or on GDB's IRC channel (#gdb on Freenode).\n"));