1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright (C) 1986-2014 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/>. */
27 #include "exceptions.h"
30 #include <sys/types.h>
33 #include "event-loop.h"
39 #include "cli/cli-cmds.h"
41 #include "auto-load.h"
44 #include "filenames.h"
45 #include "filestuff.h"
47 #include "event-top.h"
49 /* The selected interpreter. This will be used as a set command
50 variable, so it should always be malloc'ed - since
51 do_setshow_command will free it. */
54 /* Whether xdb commands will be handled. */
57 /* Whether dbx commands will be handled. */
60 /* System root path, used to find libraries etc. */
61 char *gdb_sysroot
= 0;
63 /* GDB datadir, used to store data files. */
64 char *gdb_datadir
= 0;
66 /* Non-zero if GDB_DATADIR was provided on the command line.
67 This doesn't track whether data-directory is set later from the
68 command line, but we don't reread system.gdbinit when that happens. */
69 static int gdb_datadir_provided
= 0;
71 /* If gdb was configured with --with-python=/path,
72 the possibly relocated path to python's lib directory. */
73 char *python_libdir
= 0;
75 struct ui_file
*gdb_stdout
;
76 struct ui_file
*gdb_stderr
;
77 struct ui_file
*gdb_stdlog
;
78 struct ui_file
*gdb_stdin
;
79 /* Target IO streams. */
80 struct ui_file
*gdb_stdtargin
;
81 struct ui_file
*gdb_stdtarg
;
82 struct ui_file
*gdb_stdtargerr
;
84 /* True if --batch or --batch-silent was seen. */
87 /* Support for the --batch-silent option. */
90 /* Support for --return-child-result option.
91 Set the default to -1 to return error in the case
92 that the program does not run or does not complete. */
93 int return_child_result
= 0;
94 int return_child_result_value
= -1;
97 /* GDB as it has been invoked from the command line (i.e. argv[0]). */
98 static char *gdb_program_name
;
100 /* Return read only pointer to GDB_PROGRAM_NAME. */
102 get_gdb_program_name (void)
104 return gdb_program_name
;
107 static void print_gdb_help (struct ui_file
*);
109 /* Set the data-directory parameter to NEW_DATADIR.
110 If NEW_DATADIR is not a directory then a warning is printed.
111 We don't signal an error for backward compatibility. */
114 set_gdb_data_directory (const char *new_datadir
)
118 if (stat (new_datadir
, &st
) < 0)
120 int save_errno
= errno
;
122 fprintf_unfiltered (gdb_stderr
, "Warning: ");
123 print_sys_errmsg (new_datadir
, save_errno
);
125 else if (!S_ISDIR (st
.st_mode
))
126 warning (_("%s is not a directory."), new_datadir
);
129 gdb_datadir
= gdb_realpath (new_datadir
);
131 /* gdb_realpath won't return an absolute path if the path doesn't exist,
132 but we still want to record an absolute path here. If the user entered
133 "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
134 isn't canonical, but that's ok. */
135 if (!IS_ABSOLUTE_PATH (gdb_datadir
))
137 char *abs_datadir
= gdb_abspath (gdb_datadir
);
140 gdb_datadir
= abs_datadir
;
144 /* Relocate a file or directory. PROGNAME is the name by which gdb
145 was invoked (i.e., argv[0]). INITIAL is the default value for the
146 file or directory. FLAG is true if the value is relocatable, false
147 otherwise. Returns a newly allocated string; this may return NULL
148 under the same conditions as make_relative_prefix. */
151 relocate_path (const char *progname
, const char *initial
, int flag
)
154 return make_relative_prefix (progname
, BINDIR
, initial
);
155 return xstrdup (initial
);
158 /* Like relocate_path, but specifically checks for a directory.
159 INITIAL is relocated according to the rules of relocate_path. If
160 the result is a directory, it is used; otherwise, INITIAL is used.
161 The chosen directory is then canonicalized using lrealpath. This
162 function always returns a newly-allocated string. */
165 relocate_gdb_directory (const char *initial
, int flag
)
169 dir
= relocate_path (gdb_program_name
, initial
, flag
);
174 if (*dir
== '\0' || stat (dir
, &s
) != 0 || !S_ISDIR (s
.st_mode
))
181 dir
= xstrdup (initial
);
183 /* Canonicalize the directory. */
186 char *canon_sysroot
= lrealpath (dir
);
198 /* Compute the locations of init files that GDB should source and
199 return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT. If
200 there is no system gdbinit (resp. home gdbinit and local gdbinit)
201 to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
202 LOCAL_GDBINIT) is set to NULL. */
204 get_init_files (const char **system_gdbinit
,
205 const char **home_gdbinit
,
206 const char **local_gdbinit
)
208 static const char *sysgdbinit
= NULL
;
209 static char *homeinit
= NULL
;
210 static const char *localinit
= NULL
;
211 static int initialized
= 0;
215 struct stat homebuf
, cwdbuf
, s
;
218 if (SYSTEM_GDBINIT
[0])
220 int datadir_len
= strlen (GDB_DATADIR
);
221 int sys_gdbinit_len
= strlen (SYSTEM_GDBINIT
);
222 char *relocated_sysgdbinit
;
224 /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
225 has been provided, search for SYSTEM_GDBINIT there. */
226 if (gdb_datadir_provided
227 && datadir_len
< sys_gdbinit_len
228 && filename_ncmp (SYSTEM_GDBINIT
, GDB_DATADIR
, datadir_len
) == 0
229 && IS_DIR_SEPARATOR (SYSTEM_GDBINIT
[datadir_len
]))
231 /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
233 char *tmp_sys_gdbinit
= xstrdup (SYSTEM_GDBINIT
+ datadir_len
);
236 for (p
= tmp_sys_gdbinit
; IS_DIR_SEPARATOR (*p
); ++p
)
238 relocated_sysgdbinit
= concat (gdb_datadir
, SLASH_STRING
, p
,
240 xfree (tmp_sys_gdbinit
);
244 relocated_sysgdbinit
= relocate_path (gdb_program_name
,
246 SYSTEM_GDBINIT_RELOCATABLE
);
248 if (relocated_sysgdbinit
&& stat (relocated_sysgdbinit
, &s
) == 0)
249 sysgdbinit
= relocated_sysgdbinit
;
251 xfree (relocated_sysgdbinit
);
254 homedir
= getenv ("HOME");
256 /* If the .gdbinit file in the current directory is the same as
257 the $HOME/.gdbinit file, it should not be sourced. homebuf
258 and cwdbuf are used in that purpose. Make sure that the stats
259 are zero in case one of them fails (this guarantees that they
260 won't match if either exists). */
262 memset (&homebuf
, 0, sizeof (struct stat
));
263 memset (&cwdbuf
, 0, sizeof (struct stat
));
267 homeinit
= xstrprintf ("%s/%s", homedir
, gdbinit
);
268 if (stat (homeinit
, &homebuf
) != 0)
275 if (stat (gdbinit
, &cwdbuf
) == 0)
278 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
,
279 sizeof (struct stat
)))
286 *system_gdbinit
= sysgdbinit
;
287 *home_gdbinit
= homeinit
;
288 *local_gdbinit
= localinit
;
291 /* Try to set up an alternate signal stack for SIGSEGV handlers.
292 This allows us to handle SIGSEGV signals generated when the
293 normal process stack is exhausted. If this stack is not set
294 up (sigaltstack is unavailable or fails) and a SIGSEGV is
295 generated when the normal stack is exhausted then the program
296 will behave as though no SIGSEGV handler was installed. */
299 setup_alternate_signal_stack (void)
301 #ifdef HAVE_SIGALTSTACK
304 ss
.ss_sp
= xmalloc (SIGSTKSZ
);
305 ss
.ss_size
= SIGSTKSZ
;
308 sigaltstack(&ss
, NULL
);
312 /* Call command_loop. If it happens to return, pass that through as a
313 non-zero return status. */
316 captured_command_loop (void *data
)
318 /* Top-level execution commands can be run in the background from
320 interpreter_async
= 1;
322 current_interp_command_loop ();
323 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
324 would clean things up (restoring the cleanup chain) to the state
325 they were just prior to the call. Technically, this means that
326 the do_cleanups() below is redundant. Unfortunately, many FUNCs
327 are not that well behaved. do_cleanups should either be replaced
328 with a do_cleanups call (to cover the problem) or an assertion
329 check to detect bad FUNCs code. */
330 do_cleanups (all_cleanups ());
331 /* If the command_loop returned, normally (rather than threw an
332 error) we try to quit. If the quit is aborted, catch_errors()
333 which called this catch the signal and restart the command
335 quit_command (NULL
, instream
== stdin
);
339 /* Handle command errors thrown from within
340 catch_command_errors/catch_command_errors_const. */
343 handle_command_errors (volatile struct gdb_exception e
)
347 exception_print (gdb_stderr
, e
);
349 /* If any exception escaped to here, we better enable stdin.
350 Otherwise, any command that calls async_disable_stdin, and
351 then throws, will leave stdin inoperable. */
352 async_enable_stdin ();
358 /* Type of the command callback passed to catch_command_errors. */
360 typedef void (catch_command_errors_ftype
) (char *, int);
362 /* Wrap calls to commands run before the event loop is started. */
365 catch_command_errors (catch_command_errors_ftype
*command
,
366 char *arg
, int from_tty
, return_mask mask
)
368 volatile struct gdb_exception e
;
372 command (arg
, from_tty
);
374 return handle_command_errors (e
);
377 /* Type of the command callback passed to catch_command_errors_const. */
379 typedef void (catch_command_errors_const_ftype
) (const char *, int);
381 /* Like catch_command_errors, but works with const command and args. */
384 catch_command_errors_const (catch_command_errors_const_ftype
*command
,
385 const char *arg
, int from_tty
, return_mask mask
)
387 volatile struct gdb_exception e
;
391 command (arg
, from_tty
);
393 return handle_command_errors (e
);
396 /* Arguments of --command option and its counterpart. */
397 typedef struct cmdarg
{
398 /* Type of this option. */
400 /* Option type -x. */
403 /* Option type -ex. */
406 /* Option type -ix. */
409 /* Option type -iex. */
413 /* Value of this option - filename or the GDB command itself. String memory
414 is not owned by this structure despite it is 'const'. */
418 /* Define type VEC (cmdarg_s). */
419 DEF_VEC_O (cmdarg_s
);
422 captured_main (void *data
)
424 struct captured_main_args
*context
= data
;
425 int argc
= context
->argc
;
426 char **argv
= context
->argv
;
427 static int quiet
= 0;
428 static int set_args
= 0;
429 static int inhibit_home_gdbinit
= 0;
431 /* Pointers to various arguments from command line. */
433 char *execarg
= NULL
;
435 char *corearg
= NULL
;
436 char *pid_or_core_arg
= NULL
;
440 /* These are static so that we can take their address in an
442 static int print_help
;
443 static int print_version
;
444 static int print_configuration
;
446 /* Pointers to all arguments of --command option. */
447 VEC (cmdarg_s
) *cmdarg_vec
= NULL
;
448 struct cmdarg
*cmdarg_p
;
450 /* Indices of all arguments of --directory option. */
452 /* Allocated size. */
454 /* Number of elements used. */
457 /* gdb init files. */
458 const char *system_gdbinit
;
459 const char *home_gdbinit
;
460 const char *local_gdbinit
;
464 struct objfile
*objfile
;
466 struct cleanup
*pre_stat_chain
;
469 /* Set this before calling make_command_stats_cleanup. */
470 lim_at_start
= (char *) sbrk (0);
473 pre_stat_chain
= make_command_stats_cleanup (0);
475 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
476 setlocale (LC_MESSAGES
, "");
478 #if defined (HAVE_SETLOCALE)
479 setlocale (LC_CTYPE
, "");
481 bindtextdomain (PACKAGE
, LOCALEDIR
);
482 textdomain (PACKAGE
);
487 make_cleanup (VEC_cleanup (cmdarg_s
), &cmdarg_vec
);
489 dirarg
= (char **) xmalloc (dirsize
* sizeof (*dirarg
));
493 saved_command_line
= (char *) xmalloc (saved_command_line_size
);
494 saved_command_line
[0] = '\0';
498 /* Ensure stderr is unbuffered. A Cygwin pty or pipe is implemented
499 as a Windows pipe, and Windows buffers on pipes. */
500 setvbuf (stderr
, NULL
, _IONBF
, BUFSIZ
);
503 gdb_stdout
= stdio_fileopen (stdout
);
504 gdb_stderr
= stderr_fileopen ();
506 gdb_stdlog
= gdb_stderr
; /* for moment */
507 gdb_stdtarg
= gdb_stderr
; /* for moment */
508 gdb_stdin
= stdio_fileopen (stdin
);
509 gdb_stdtargerr
= gdb_stderr
; /* for moment */
510 gdb_stdtargin
= gdb_stdin
; /* for moment */
513 /* On Windows, argv[0] is not necessarily set to absolute form when
514 GDB is found along PATH, without which relocation doesn't work. */
515 gdb_program_name
= windows_get_absolute_argv0 (argv
[0]);
517 gdb_program_name
= xstrdup (argv
[0]);
520 /* Prefix warning messages with the command name. */
521 warning_pre_print
= xstrprintf ("%s: warning: ", gdb_program_name
);
523 if (! getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
)))
524 perror_warning_with_name (_("error finding working directory"));
526 current_directory
= gdb_dirbuf
;
528 /* Set the sysroot path. */
529 gdb_sysroot
= relocate_gdb_directory (TARGET_SYSTEM_ROOT
,
530 TARGET_SYSTEM_ROOT_RELOCATABLE
);
532 debug_file_directory
= relocate_gdb_directory (DEBUGDIR
,
533 DEBUGDIR_RELOCATABLE
);
535 gdb_datadir
= relocate_gdb_directory (GDB_DATADIR
,
536 GDB_DATADIR_RELOCATABLE
);
538 #ifdef WITH_PYTHON_PATH
540 /* For later use in helping Python find itself. */
541 char *tmp
= concat (WITH_PYTHON_PATH
, SLASH_STRING
, "lib", NULL
);
543 python_libdir
= relocate_gdb_directory (tmp
, PYTHON_PATH_RELOCATABLE
);
549 add_substitute_path_rule (RELOC_SRCDIR
,
550 make_relative_prefix (gdb_program_name
, BINDIR
,
554 /* There will always be an interpreter. Either the one passed into
555 this captured main, or one specified by the user at start up, or
556 the console. Initialize the interpreter to the one requested by
558 interpreter_p
= xstrdup (context
->interpreter_p
);
560 /* Parse arguments and options. */
563 /* When var field is 0, use flag field to record the equivalent
564 short option (or arbitrary numbers starting at 10 for those
565 with no equivalent). */
577 static struct option long_options
[] =
579 {"tui", no_argument
, 0, OPT_TUI
},
580 {"xdb", no_argument
, &xdb_commands
, 1},
581 {"dbx", no_argument
, &dbx_commands
, 1},
582 {"readnow", no_argument
, &readnow_symbol_files
, 1},
583 {"r", no_argument
, &readnow_symbol_files
, 1},
584 {"quiet", no_argument
, &quiet
, 1},
585 {"q", no_argument
, &quiet
, 1},
586 {"silent", no_argument
, &quiet
, 1},
587 {"nh", no_argument
, &inhibit_home_gdbinit
, 1},
588 {"nx", no_argument
, &inhibit_gdbinit
, 1},
589 {"n", no_argument
, &inhibit_gdbinit
, 1},
590 {"batch-silent", no_argument
, 0, 'B'},
591 {"batch", no_argument
, &batch_flag
, 1},
593 /* This is a synonym for "--annotate=1". --annotate is now
594 preferred, but keep this here for a long time because people
595 will be running emacses which use --fullname. */
596 {"fullname", no_argument
, 0, 'f'},
597 {"f", no_argument
, 0, 'f'},
599 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
600 {"help", no_argument
, &print_help
, 1},
601 {"se", required_argument
, 0, OPT_SE
},
602 {"symbols", required_argument
, 0, 's'},
603 {"s", required_argument
, 0, 's'},
604 {"exec", required_argument
, 0, 'e'},
605 {"e", required_argument
, 0, 'e'},
606 {"core", required_argument
, 0, 'c'},
607 {"c", required_argument
, 0, 'c'},
608 {"pid", required_argument
, 0, 'p'},
609 {"p", required_argument
, 0, 'p'},
610 {"command", required_argument
, 0, 'x'},
611 {"eval-command", required_argument
, 0, 'X'},
612 {"version", no_argument
, &print_version
, 1},
613 {"configuration", no_argument
, &print_configuration
, 1},
614 {"x", required_argument
, 0, 'x'},
615 {"ex", required_argument
, 0, 'X'},
616 {"init-command", required_argument
, 0, OPT_IX
},
617 {"init-eval-command", required_argument
, 0, OPT_IEX
},
618 {"ix", required_argument
, 0, OPT_IX
},
619 {"iex", required_argument
, 0, OPT_IEX
},
621 {"tclcommand", required_argument
, 0, 'z'},
622 {"enable-external-editor", no_argument
, 0, 'y'},
623 {"editor-command", required_argument
, 0, 'w'},
625 {"ui", required_argument
, 0, 'i'},
626 {"interpreter", required_argument
, 0, 'i'},
627 {"i", required_argument
, 0, 'i'},
628 {"directory", required_argument
, 0, 'd'},
629 {"d", required_argument
, 0, 'd'},
630 {"data-directory", required_argument
, 0, 'D'},
631 {"D", required_argument
, 0, 'D'},
632 {"cd", required_argument
, 0, OPT_CD
},
633 {"tty", required_argument
, 0, 't'},
634 {"baud", required_argument
, 0, 'b'},
635 {"b", required_argument
, 0, 'b'},
636 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
637 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
638 {"w", no_argument
, NULL
, OPT_WINDOWS
},
639 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
640 {"statistics", no_argument
, 0, OPT_STATISTICS
},
641 {"write", no_argument
, &write_files
, 1},
642 {"args", no_argument
, &set_args
, 1},
643 {"l", required_argument
, 0, 'l'},
644 {"return-child-result", no_argument
, &return_child_result
, 1},
645 {0, no_argument
, 0, 0}
652 c
= getopt_long_only (argc
, argv
, "",
653 long_options
, &option_index
);
654 if (c
== EOF
|| set_args
)
657 /* Long option that takes an argument. */
658 if (c
== 0 && long_options
[option_index
].flag
== 0)
659 c
= long_options
[option_index
].val
;
664 /* Long option that just sets a flag. */
674 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
675 annotation_level
= atoi (optarg
);
678 /* Enable the display of both time and space usage. */
679 set_per_command_time (1);
680 set_per_command_space (1);
683 /* --tui is equivalent to -i=tui. */
685 xfree (interpreter_p
);
686 interpreter_p
= xstrdup (INTERP_TUI
);
688 error (_("%s: TUI mode is not supported"), gdb_program_name
);
692 /* FIXME: cagney/2003-03-01: Not sure if this option is
693 actually useful, and if it is, what it should do. */
695 /* --windows is equivalent to -i=insight. */
696 xfree (interpreter_p
);
697 interpreter_p
= xstrdup (INTERP_INSIGHT
);
701 /* -nw is equivalent to -i=console. */
702 xfree (interpreter_p
);
703 interpreter_p
= xstrdup (INTERP_CONSOLE
);
706 annotation_level
= 1;
722 struct cmdarg cmdarg
= { CMDARG_FILE
, optarg
};
724 VEC_safe_push (cmdarg_s
, cmdarg_vec
, &cmdarg
);
729 struct cmdarg cmdarg
= { CMDARG_COMMAND
, optarg
};
731 VEC_safe_push (cmdarg_s
, cmdarg_vec
, &cmdarg
);
736 struct cmdarg cmdarg
= { CMDARG_INIT_FILE
, optarg
};
738 VEC_safe_push (cmdarg_s
, cmdarg_vec
, &cmdarg
);
743 struct cmdarg cmdarg
= { CMDARG_INIT_COMMAND
, optarg
};
745 VEC_safe_push (cmdarg_s
, cmdarg_vec
, &cmdarg
);
749 batch_flag
= batch_silent
= 1;
750 gdb_stdout
= ui_file_new();
753 if (optarg
[0] == '\0')
754 error (_("%s: empty path for `--data-directory'"),
756 set_gdb_data_directory (optarg
);
757 gdb_datadir_provided
= 1;
762 extern int gdbtk_test (char *);
764 if (!gdbtk_test (optarg
))
765 error (_("%s: unable to load tclcommand file \"%s\""),
766 gdb_program_name
, optarg
);
770 /* Backwards compatibility only. */
774 /* Set the external editor commands when gdb is farming out files
775 to be edited by another program. */
776 extern char *external_editor_command
;
778 external_editor_command
= xstrdup (optarg
);
783 xfree (interpreter_p
);
784 interpreter_p
= xstrdup (optarg
);
787 dirarg
[ndir
++] = optarg
;
791 dirarg
= (char **) xrealloc ((char *) dirarg
,
792 dirsize
* sizeof (*dirarg
));
806 i
= strtol (optarg
, &p
, 0);
807 if (i
== 0 && p
== optarg
)
808 warning (_("could not set baud rate to `%s'."),
819 i
= strtol (optarg
, &p
, 0);
820 if (i
== 0 && p
== optarg
)
821 warning (_("could not set timeout limit to `%s'."),
829 error (_("Use `%s --help' for a complete list of options."),
838 /* Try to set up an alternate signal stack for SIGSEGV handlers. */
839 setup_alternate_signal_stack ();
841 /* Initialize all files. Give the interpreter a chance to take
842 control of the console via the deprecated_init_ui_hook (). */
843 gdb_init (gdb_program_name
);
845 /* Now that gdb_init has created the initial inferior, we're in
846 position to set args for that inferior. */
849 /* The remaining options are the command-line options for the
850 inferior. The first one is the sym/exec file, and the rest
853 error (_("%s: `--args' specified but no program specified"),
856 symarg
= argv
[optind
];
857 execarg
= argv
[optind
];
859 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
863 /* OK, that's all the options. */
865 /* The first argument, if specified, is the name of the
869 symarg
= argv
[optind
];
870 execarg
= argv
[optind
];
874 /* If the user hasn't already specified a PID or the name of a
875 core file, then a second optional argument is allowed. If
876 present, this argument should be interpreted as either a
877 PID or a core file, whichever works. */
878 if (pidarg
== NULL
&& corearg
== NULL
&& optind
< argc
)
880 pid_or_core_arg
= argv
[optind
];
884 /* Any argument left on the command line is unexpected and
885 will be ignored. Inform the user. */
887 fprintf_unfiltered (gdb_stderr
,
888 _("Excess command line "
889 "arguments ignored. (%s%s)\n"),
891 (optind
== argc
- 1) ? "" : " ...");
894 /* Lookup gdbinit files. Note that the gdbinit file name may be
895 overriden during file initialization, so get_init_files should be
896 called after gdb_init. */
897 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
899 /* Do these (and anything which might call wrap_here or *_filtered)
900 after initialize_all_files() but before the interpreter has been
901 installed. Otherwize the help/version messages will be eaten by
902 the interpreter's output handler. */
906 print_gdb_version (gdb_stdout
);
908 printf_filtered ("\n");
914 print_gdb_help (gdb_stdout
);
915 fputs_unfiltered ("\n", gdb_stdout
);
919 if (print_configuration
)
921 print_gdb_configuration (gdb_stdout
);
923 printf_filtered ("\n");
927 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
928 GDB retain the old MI1 interpreter startup behavior. Output the
929 copyright message before the interpreter is installed. That way
930 it isn't encapsulated in MI output. */
931 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
933 /* Print all the junk at the top, with trailing "..." if we are
934 about to read a symbol file (possibly slowly). */
935 print_gdb_version (gdb_stdout
);
937 printf_filtered ("..");
939 printf_filtered ("\n");
940 gdb_flush (gdb_stdout
); /* Force to screen during slow
944 /* Install the default UI. All the interpreters should have had a
945 look at things by now. Initialize the default interpreter. */
949 struct interp
*interp
= interp_lookup (interpreter_p
);
952 error (_("Interpreter `%s' unrecognized"), interpreter_p
);
954 if (!interp_set (interp
, 1))
955 error (_("Interpreter `%s' failed to initialize."), interpreter_p
);
958 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
959 GDB retain the old MI1 interpreter startup behavior. Output the
960 copyright message after the interpreter is installed when it is
961 any sane interpreter. */
962 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
964 /* Print all the junk at the top, with trailing "..." if we are
965 about to read a symbol file (possibly slowly). */
966 print_gdb_version (gdb_stdout
);
968 printf_filtered ("..");
970 printf_filtered ("\n");
971 gdb_flush (gdb_stdout
); /* Force to screen during slow
975 /* Set off error and warning messages with a blank line. */
976 xfree (warning_pre_print
);
977 warning_pre_print
= _("\nwarning: ");
979 /* Read and execute the system-wide gdbinit file, if it exists.
980 This is done *before* all the command line arguments are
981 processed; it sets global parameters, which are independent of
982 what file you are debugging or what directory you are in. */
983 if (system_gdbinit
&& !inhibit_gdbinit
)
984 catch_command_errors_const (source_script
, system_gdbinit
,
987 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
988 *before* all the command line arguments are processed; it sets
989 global parameters, which are independent of what file you are
990 debugging or what directory you are in. */
992 if (home_gdbinit
&& !inhibit_gdbinit
&& !inhibit_home_gdbinit
)
993 catch_command_errors_const (source_script
,
994 home_gdbinit
, 0, RETURN_MASK_ALL
);
996 /* Process '-ix' and '-iex' options early. */
997 for (i
= 0; VEC_iterate (cmdarg_s
, cmdarg_vec
, i
, cmdarg_p
); i
++)
998 switch (cmdarg_p
->type
)
1000 case CMDARG_INIT_FILE
:
1001 catch_command_errors_const (source_script
, cmdarg_p
->string
,
1002 !batch_flag
, RETURN_MASK_ALL
);
1004 case CMDARG_INIT_COMMAND
:
1005 catch_command_errors (execute_command
, cmdarg_p
->string
,
1006 !batch_flag
, RETURN_MASK_ALL
);
1010 /* Now perform all the actions indicated by the arguments. */
1013 catch_command_errors (cd_command
, cdarg
, 0, RETURN_MASK_ALL
);
1016 for (i
= 0; i
< ndir
; i
++)
1017 catch_command_errors (directory_switch
, dirarg
[i
], 0, RETURN_MASK_ALL
);
1020 /* Skip auto-loading section-specified scripts until we've sourced
1021 local_gdbinit (which is often used to augment the source search
1023 save_auto_load
= global_auto_load
;
1024 global_auto_load
= 0;
1028 && strcmp (execarg
, symarg
) == 0)
1030 /* The exec file and the symbol-file are the same. If we can't
1031 open it, better only print one error message.
1032 catch_command_errors returns non-zero on success! */
1033 if (catch_command_errors_const (exec_file_attach
, execarg
,
1034 !batch_flag
, RETURN_MASK_ALL
))
1035 catch_command_errors_const (symbol_file_add_main
, symarg
,
1036 !batch_flag
, RETURN_MASK_ALL
);
1040 if (execarg
!= NULL
)
1041 catch_command_errors_const (exec_file_attach
, execarg
,
1042 !batch_flag
, RETURN_MASK_ALL
);
1044 catch_command_errors_const (symbol_file_add_main
, symarg
,
1045 !batch_flag
, RETURN_MASK_ALL
);
1048 if (corearg
&& pidarg
)
1049 error (_("Can't attach to process and specify "
1050 "a core file at the same time."));
1052 if (corearg
!= NULL
)
1053 catch_command_errors (core_file_command
, corearg
,
1054 !batch_flag
, RETURN_MASK_ALL
);
1055 else if (pidarg
!= NULL
)
1056 catch_command_errors (attach_command
, pidarg
,
1057 !batch_flag
, RETURN_MASK_ALL
);
1058 else if (pid_or_core_arg
)
1060 /* The user specified 'gdb program pid' or gdb program core'.
1061 If pid_or_core_arg's first character is a digit, try attach
1062 first and then corefile. Otherwise try just corefile. */
1064 if (isdigit (pid_or_core_arg
[0]))
1066 if (catch_command_errors (attach_command
, pid_or_core_arg
,
1067 !batch_flag
, RETURN_MASK_ALL
) == 0)
1068 catch_command_errors (core_file_command
, pid_or_core_arg
,
1069 !batch_flag
, RETURN_MASK_ALL
);
1071 else /* Can't be a pid, better be a corefile. */
1072 catch_command_errors (core_file_command
, pid_or_core_arg
,
1073 !batch_flag
, RETURN_MASK_ALL
);
1077 set_inferior_io_terminal (ttyarg
);
1079 /* Error messages should no longer be distinguished with extra output. */
1080 warning_pre_print
= _("warning: ");
1082 /* Read the .gdbinit file in the current directory, *if* it isn't
1083 the same as the $HOME/.gdbinit file (it should exist, also). */
1086 auto_load_local_gdbinit_pathname
= gdb_realpath (local_gdbinit
);
1088 if (!inhibit_gdbinit
&& auto_load_local_gdbinit
1089 && file_is_auto_load_safe (local_gdbinit
,
1090 _("auto-load: Loading .gdbinit "
1094 auto_load_local_gdbinit_loaded
= 1;
1096 catch_command_errors_const (source_script
, local_gdbinit
, 0,
1101 /* Now that all .gdbinit's have been read and all -d options have been
1102 processed, we can read any scripts mentioned in SYMARG.
1103 We wait until now because it is common to add to the source search
1104 path in local_gdbinit. */
1105 global_auto_load
= save_auto_load
;
1106 ALL_OBJFILES (objfile
)
1107 load_auto_scripts_for_objfile (objfile
);
1109 /* Process '-x' and '-ex' options. */
1110 for (i
= 0; VEC_iterate (cmdarg_s
, cmdarg_vec
, i
, cmdarg_p
); i
++)
1111 switch (cmdarg_p
->type
)
1114 catch_command_errors_const (source_script
, cmdarg_p
->string
,
1115 !batch_flag
, RETURN_MASK_ALL
);
1117 case CMDARG_COMMAND
:
1118 catch_command_errors (execute_command
, cmdarg_p
->string
,
1119 !batch_flag
, RETURN_MASK_ALL
);
1123 /* Read in the old history after all the command files have been
1129 /* We have hit the end of the batch file. */
1130 quit_force (NULL
, 0);
1133 /* Show time and/or space usage. */
1134 do_cleanups (pre_stat_chain
);
1136 /* NOTE: cagney/1999-11-07: There is probably no reason for not
1137 moving this loop and the code found in captured_command_loop()
1138 into the command_loop() proper. The main thing holding back that
1139 change - SET_TOP_LEVEL() - has been eliminated. */
1142 catch_errors (captured_command_loop
, 0, "", RETURN_MASK_ALL
);
1144 /* No exit -- exit is through quit_command. */
1148 gdb_main (struct captured_main_args
*args
)
1150 catch_errors (captured_main
, args
, "", RETURN_MASK_ALL
);
1151 /* The only way to end up here is by an error (normal exit is
1152 handled by quit_force()), hence always return an error status. */
1157 /* Don't use *_filtered for printing help. We don't want to prompt
1158 for continue no matter how small the screen or how much we're going
1162 print_gdb_help (struct ui_file
*stream
)
1164 const char *system_gdbinit
;
1165 const char *home_gdbinit
;
1166 const char *local_gdbinit
;
1168 get_init_files (&system_gdbinit
, &home_gdbinit
, &local_gdbinit
);
1170 /* Note: The options in the list below are only approximately sorted
1171 in the alphabetical order, so as to group closely related options
1173 fputs_unfiltered (_("\
1174 This is the GNU debugger. Usage:\n\n\
1175 gdb [options] [executable-file [core-file or process-id]]\n\
1176 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1178 fputs_unfiltered (_("\
1179 Selection of debuggee and its files:\n\n\
1180 --args Arguments after executable-file are passed to inferior\n\
1181 --core=COREFILE Analyze the core dump COREFILE.\n\
1182 --exec=EXECFILE Use EXECFILE as the executable.\n\
1183 --pid=PID Attach to running process PID.\n\
1184 --directory=DIR Search for source files in DIR.\n\
1185 --se=FILE Use FILE as symbol file and executable file.\n\
1186 --symbols=SYMFILE Read symbols from SYMFILE.\n\
1187 --readnow Fully read symbol files on first access.\n\
1188 --write Set writing into executable and core files.\n\n\
1190 fputs_unfiltered (_("\
1191 Initial commands and command files:\n\n\
1192 --command=FILE, -x Execute GDB commands from FILE.\n\
1193 --init-command=FILE, -ix\n\
1194 Like -x but execute commands before loading inferior.\n\
1195 --eval-command=COMMAND, -ex\n\
1196 Execute a single GDB command.\n\
1197 May be used multiple times and in conjunction\n\
1199 --init-eval-command=COMMAND, -iex\n\
1200 Like -ex but before loading inferior.\n\
1201 --nh Do not read ~/.gdbinit.\n\
1202 --nx Do not read any .gdbinit files in any directory.\n\n\
1204 fputs_unfiltered (_("\
1205 Output and user interface control:\n\n\
1206 --fullname Output information used by emacs-GDB interface.\n\
1207 --interpreter=INTERP\n\
1208 Select a specific interpreter / user interface\n\
1209 --tty=TTY Use TTY for input/output by the program being debugged.\n\
1210 -w Use the GUI interface.\n\
1211 --nw Do not use the GUI interface.\n\
1214 fputs_unfiltered (_("\
1215 --tui Use a terminal user interface.\n\
1218 fputs_unfiltered (_("\
1219 --dbx DBX compatibility mode.\n\
1220 --xdb XDB compatibility mode.\n\
1221 -q, --quiet, --silent\n\
1222 Do not print version number on startup.\n\n\
1224 fputs_unfiltered (_("\
1225 Operating modes:\n\n\
1226 --batch Exit after processing options.\n\
1227 --batch-silent Like --batch, but suppress all gdb stdout output.\n\
1228 --return-child-result\n\
1229 GDB exit code will be the child's exit code.\n\
1230 --configuration Print details about GDB configuration and then exit.\n\
1231 --help Print this message and then exit.\n\
1232 --version Print version information and then exit.\n\n\
1233 Remote debugging options:\n\n\
1234 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
1235 -l TIMEOUT Set timeout in seconds for remote debugging.\n\n\
1237 --cd=DIR Change current directory to DIR.\n\
1238 --data-directory=DIR, -D\n\
1239 Set GDB's data-directory to DIR.\n\
1241 fputs_unfiltered (_("\n\
1242 At startup, GDB reads the following init files and executes their commands:\n\
1245 fprintf_unfiltered (stream
, _("\
1246 * system-wide init file: %s\n\
1247 "), system_gdbinit
);
1249 fprintf_unfiltered (stream
, _("\
1250 * user-specific init file: %s\n\
1253 fprintf_unfiltered (stream
, _("\
1254 * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1256 fputs_unfiltered (_("\n\
1257 For more information, type \"help\" from within GDB, or consult the\n\
1258 GDB manual (available as on-line info or a printed manual).\n\
1260 if (REPORT_BUGS_TO
[0] && stream
== gdb_stdout
)
1261 fprintf_unfiltered (stream
, _("\
1262 Report bugs to \"%s\".\n\
1263 "), REPORT_BUGS_TO
);