1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994,
4 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
33 #include <sys/types.h>
37 #include "gdb_string.h"
38 #include "event-loop.h"
44 /* If nonzero, display time usage both at startup and for each command. */
48 /* If nonzero, display space usage both at startup and for each command. */
52 /* The selected interpreter. This will be used as a set command
53 variable, so it should always be malloc'ed - since
54 do_setshow_command will free it. */
57 /* Whether xdb commands will be handled */
60 /* Whether dbx commands will be handled */
63 /* System root path, used to find libraries etc. */
64 char *gdb_sysroot = 0;
66 struct ui_file *gdb_stdout;
67 struct ui_file *gdb_stderr;
68 struct ui_file *gdb_stdlog;
69 struct ui_file *gdb_stdin;
70 /* target IO streams */
71 struct ui_file *gdb_stdtargin;
72 struct ui_file *gdb_stdtarg;
73 struct ui_file *gdb_stdtargerr;
75 /* Whether to enable writing into executable and core files */
76 extern int write_files;
78 static void print_gdb_help (struct ui_file *);
80 /* These two are used to set the external editor commands when gdb is farming
81 out files to be edited by another program. */
83 extern char *external_editor_command;
85 /* Call command_loop. If it happens to return, pass that through as a
86 non-zero return status. */
89 captured_command_loop (void *data)
91 current_interp_command_loop ();
92 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
93 would clean things up (restoring the cleanup chain) to the state
94 they were just prior to the call. Technically, this means that
95 the do_cleanups() below is redundant. Unfortunately, many FUNCs
96 are not that well behaved. do_cleanups should either be replaced
97 with a do_cleanups call (to cover the problem) or an assertion
98 check to detect bad FUNCs code. */
99 do_cleanups (ALL_CLEANUPS);
100 /* If the command_loop returned, normally (rather than threw an
101 error) we try to quit. If the quit is aborted, catch_errors()
102 which called this catch the signal and restart the command
104 quit_command (NULL, instream == stdin);
109 captured_main (void *data)
111 struct captured_main_args *context = data;
112 int argc = context->argc;
113 char **argv = context->argv;
115 static int quiet = 0;
116 static int batch = 0;
117 static int set_args = 0;
119 /* Pointers to various arguments from command line. */
121 char *execarg = NULL;
122 char *corearg = NULL;
126 /* These are static so that we can take their address in an initializer. */
127 static int print_help;
128 static int print_version;
130 /* Pointers to all arguments of --command option. */
132 /* Allocated size of cmdarg. */
134 /* Number of elements of cmdarg used. */
137 /* Indices of all arguments of --directory option. */
139 /* Allocated size. */
141 /* Number of elements used. */
144 struct stat homebuf, cwdbuf;
145 char *homedir, *homeinit;
149 long time_at_startup = get_run_time ();
151 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
152 setlocale (LC_MESSAGES, "");
154 #if defined (HAVE_SETLOCALE)
155 setlocale (LC_CTYPE, "");
157 bindtextdomain (PACKAGE, LOCALEDIR);
158 textdomain (PACKAGE);
160 /* This needs to happen before the first use of malloc. */
164 lim_at_start = (char *) sbrk (0);
167 #if defined (ALIGN_STACK_ON_STARTUP)
168 i = (int) &count & 0x3;
174 cmdarg = (char **) xmalloc (cmdsize * sizeof (*cmdarg));
177 dirarg = (char **) xmalloc (dirsize * sizeof (*dirarg));
181 line = (char *) xmalloc (linesize);
182 line[0] = '\0'; /* Terminate saved (now empty) cmd line */
185 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
186 current_directory = gdb_dirbuf;
188 gdb_stdout = stdio_fileopen (stdout);
189 gdb_stderr = stdio_fileopen (stderr);
190 gdb_stdlog = gdb_stderr; /* for moment */
191 gdb_stdtarg = gdb_stderr; /* for moment */
192 gdb_stdin = stdio_fileopen (stdin);
193 gdb_stdtargerr = gdb_stderr; /* for moment */
194 gdb_stdtargin = gdb_stdin; /* for moment */
196 /* initialize error() */
199 /* Set the sysroot path. */
200 #ifdef TARGET_SYSTEM_ROOT_RELOCATABLE
201 gdb_sysroot = make_relative_prefix (argv[0], BINDIR, TARGET_SYSTEM_ROOT);
207 if (stat (gdb_sysroot, &s) == 0)
208 if (S_ISDIR (s.st_mode))
214 gdb_sysroot = TARGET_SYSTEM_ROOT;
218 gdb_sysroot = TARGET_SYSTEM_ROOT;
220 #if defined (TARGET_SYSTEM_ROOT)
221 gdb_sysroot = TARGET_SYSTEM_ROOT;
227 /* There will always be an interpreter. Either the one passed into
228 this captured main, or one specified by the user at start up, or
229 the console. Initialize the interpreter to the one requested by
231 interpreter_p = xstrdup (context->interpreter_p);
233 /* Parse arguments and options. */
236 /* When var field is 0, use flag field to record the equivalent
237 short option (or arbitrary numbers starting at 10 for those
238 with no equivalent). */
248 static struct option long_options[] =
251 {"tui", no_argument, 0, OPT_TUI},
253 {"xdb", no_argument, &xdb_commands, 1},
254 {"dbx", no_argument, &dbx_commands, 1},
255 {"readnow", no_argument, &readnow_symbol_files, 1},
256 {"r", no_argument, &readnow_symbol_files, 1},
257 {"quiet", no_argument, &quiet, 1},
258 {"q", no_argument, &quiet, 1},
259 {"silent", no_argument, &quiet, 1},
260 {"nx", no_argument, &inhibit_gdbinit, 1},
261 {"n", no_argument, &inhibit_gdbinit, 1},
262 {"batch", no_argument, &batch, 1},
263 {"epoch", no_argument, &epoch_interface, 1},
265 /* This is a synonym for "--annotate=1". --annotate is now preferred,
266 but keep this here for a long time because people will be running
267 emacses which use --fullname. */
268 {"fullname", no_argument, 0, 'f'},
269 {"f", no_argument, 0, 'f'},
271 {"annotate", required_argument, 0, OPT_ANNOTATE},
272 {"help", no_argument, &print_help, 1},
273 {"se", required_argument, 0, OPT_SE},
274 {"symbols", required_argument, 0, 's'},
275 {"s", required_argument, 0, 's'},
276 {"exec", required_argument, 0, 'e'},
277 {"e", required_argument, 0, 'e'},
278 {"core", required_argument, 0, 'c'},
279 {"c", required_argument, 0, 'c'},
280 {"pid", required_argument, 0, 'p'},
281 {"p", required_argument, 0, 'p'},
282 {"command", required_argument, 0, 'x'},
283 {"version", no_argument, &print_version, 1},
284 {"x", required_argument, 0, 'x'},
286 {"tclcommand", required_argument, 0, 'z'},
287 {"enable-external-editor", no_argument, 0, 'y'},
288 {"editor-command", required_argument, 0, 'w'},
290 {"ui", required_argument, 0, 'i'},
291 {"interpreter", required_argument, 0, 'i'},
292 {"i", required_argument, 0, 'i'},
293 {"directory", required_argument, 0, 'd'},
294 {"d", required_argument, 0, 'd'},
295 {"cd", required_argument, 0, OPT_CD},
296 {"tty", required_argument, 0, 't'},
297 {"baud", required_argument, 0, 'b'},
298 {"b", required_argument, 0, 'b'},
299 {"nw", no_argument, NULL, OPT_NOWINDOWS},
300 {"nowindows", no_argument, NULL, OPT_NOWINDOWS},
301 {"w", no_argument, NULL, OPT_WINDOWS},
302 {"windows", no_argument, NULL, OPT_WINDOWS},
303 {"statistics", no_argument, 0, OPT_STATISTICS},
304 {"write", no_argument, &write_files, 1},
305 {"args", no_argument, &set_args, 1},
306 {0, no_argument, 0, 0}
313 c = getopt_long_only (argc, argv, "",
314 long_options, &option_index);
315 if (c == EOF || set_args)
318 /* Long option that takes an argument. */
319 if (c == 0 && long_options[option_index].flag == 0)
320 c = long_options[option_index].val;
325 /* Long option that just sets a flag. */
335 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
336 annotation_level = atoi (optarg);
339 /* Enable the display of both time and space usage. */
344 /* --tui is equivalent to -i=tui. */
345 xfree (interpreter_p);
346 interpreter_p = xstrdup ("tui");
349 /* FIXME: cagney/2003-03-01: Not sure if this option is
350 actually useful, and if it is, what it should do. */
354 /* -nw is equivalent to -i=console. */
355 xfree (interpreter_p);
356 interpreter_p = xstrdup (INTERP_CONSOLE);
360 annotation_level = 1;
361 /* We have probably been invoked from emacs. Disable window interface. */
374 /* "corearg" is shared by "--core" and "--pid" */
378 cmdarg[ncmd++] = optarg;
382 cmdarg = (char **) xrealloc ((char *) cmdarg,
383 cmdsize * sizeof (*cmdarg));
389 extern int gdbtk_test (char *);
390 if (!gdbtk_test (optarg))
392 fprintf_unfiltered (gdb_stderr, _("%s: unable to load tclcommand file \"%s\""),
399 /* Backwards compatibility only. */
403 external_editor_command = xstrdup (optarg);
408 xfree (interpreter_p);
409 interpreter_p = xstrdup (optarg);
412 dirarg[ndir++] = optarg;
416 dirarg = (char **) xrealloc ((char *) dirarg,
417 dirsize * sizeof (*dirarg));
431 i = strtol (optarg, &p, 0);
432 if (i == 0 && p == optarg)
434 /* Don't use *_filtered or warning() (which relies on
435 current_target) until after initialize_all_files(). */
439 _("warning: could not set baud rate to `%s'.\n"), optarg);
449 i = strtol (optarg, &p, 0);
450 if (i == 0 && p == optarg)
452 /* Don't use *_filtered or warning() (which relies on
453 current_target) until after initialize_all_files(). */
457 _("warning: could not set timeout limit to `%s'.\n"), optarg);
464 fprintf_unfiltered (gdb_stderr,
465 _("Use `%s --help' for a complete list of options.\n"),
471 /* If --help or --version, disable window interface. */
472 if (print_help || print_version)
479 /* The remaining options are the command-line options for the
480 inferior. The first one is the sym/exec file, and the rest
484 fprintf_unfiltered (gdb_stderr,
485 _("%s: `--args' specified but no program specified\n"),
489 symarg = argv[optind];
490 execarg = argv[optind];
492 set_inferior_args_vector (argc - optind, &argv[optind]);
496 /* OK, that's all the options. The other arguments are filenames. */
498 for (; optind < argc; optind++)
502 symarg = argv[optind];
503 execarg = argv[optind];
506 /* The documentation says this can be a "ProcID" as well.
507 We will try it as both a corefile and a pid. */
508 corearg = argv[optind];
511 fprintf_unfiltered (gdb_stderr,
512 _("Excess command line arguments ignored. (%s%s)\n"),
513 argv[optind], (optind == argc - 1) ? "" : " ...");
521 /* Initialize all files. Give the interpreter a chance to take
522 control of the console via the deprecated_init_ui_hook(). */
525 /* Do these (and anything which might call wrap_here or *_filtered)
526 after initialize_all_files() but before the interpreter has been
527 installed. Otherwize the help/version messages will be eaten by
528 the interpreter's output handler. */
532 print_gdb_version (gdb_stdout);
534 printf_filtered ("\n");
540 print_gdb_help (gdb_stdout);
541 fputs_unfiltered ("\n", gdb_stdout);
545 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
546 GDB retain the old MI1 interpreter startup behavior. Output the
547 copyright message before the interpreter is installed. That way
548 it isn't encapsulated in MI output. */
549 if (!quiet && strcmp (interpreter_p, INTERP_MI1) == 0)
551 /* Print all the junk at the top, with trailing "..." if we are about
552 to read a symbol file (possibly slowly). */
553 print_gdb_version (gdb_stdout);
555 printf_filtered ("..");
557 gdb_flush (gdb_stdout); /* Force to screen during slow operations */
561 /* Install the default UI. All the interpreters should have had a
562 look at things by now. Initialize the default interpreter. */
566 struct interp *interp = interp_lookup (interpreter_p);
568 error ("Interpreter `%s' unrecognized", interpreter_p);
570 if (!interp_set (interp))
572 fprintf_unfiltered (gdb_stderr,
573 "Interpreter `%s' failed to initialize.\n",
579 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
580 GDB retain the old MI1 interpreter startup behavior. Output the
581 copyright message after the interpreter is installed when it is
582 any sane interpreter. */
583 if (!quiet && !current_interp_named_p (INTERP_MI1))
585 /* Print all the junk at the top, with trailing "..." if we are about
586 to read a symbol file (possibly slowly). */
587 print_gdb_version (gdb_stdout);
589 printf_filtered ("..");
591 gdb_flush (gdb_stdout); /* Force to screen during slow operations */
594 error_pre_print = "\n\n";
595 quit_pre_print = error_pre_print;
597 /* We may get more than one warning, don't double space all of them... */
598 warning_pre_print = _("\nwarning: ");
600 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
601 *before* all the command line arguments are processed; it sets
602 global parameters, which are independent of what file you are
603 debugging or what directory you are in. */
604 homedir = getenv ("HOME");
607 homeinit = (char *) alloca (strlen (homedir) +
608 strlen (gdbinit) + 10);
609 strcpy (homeinit, homedir);
610 strcat (homeinit, "/");
611 strcat (homeinit, gdbinit);
613 if (!inhibit_gdbinit)
615 catch_command_errors (source_command, homeinit, 0, RETURN_MASK_ALL);
618 /* Do stats; no need to do them elsewhere since we'll only
619 need them if homedir is set. Make sure that they are
620 zero in case one of them fails (this guarantees that they
621 won't match if either exists). */
623 memset (&homebuf, 0, sizeof (struct stat));
624 memset (&cwdbuf, 0, sizeof (struct stat));
626 stat (homeinit, &homebuf);
627 stat (gdbinit, &cwdbuf); /* We'll only need this if
631 /* Now perform all the actions indicated by the arguments. */
634 catch_command_errors (cd_command, cdarg, 0, RETURN_MASK_ALL);
637 for (i = 0; i < ndir; i++)
638 catch_command_errors (directory_command, dirarg[i], 0, RETURN_MASK_ALL);
643 && strcmp (execarg, symarg) == 0)
645 /* The exec file and the symbol-file are the same. If we can't
646 open it, better only print one error message.
647 catch_command_errors returns non-zero on success! */
648 if (catch_command_errors (exec_file_attach, execarg, !batch, RETURN_MASK_ALL))
649 catch_command_errors (symbol_file_add_main, symarg, 0, RETURN_MASK_ALL);
654 catch_command_errors (exec_file_attach, execarg, !batch, RETURN_MASK_ALL);
656 catch_command_errors (symbol_file_add_main, symarg, 0, RETURN_MASK_ALL);
659 /* After the symbol file has been read, print a newline to get us
660 beyond the copyright line... But errors should still set off
661 the error message with a (single) blank line. */
663 printf_filtered ("\n");
664 error_pre_print = "\n";
665 quit_pre_print = error_pre_print;
666 warning_pre_print = _("\nwarning: ");
670 /* corearg may be either a corefile or a pid.
671 If its first character is a digit, try attach first
672 and then corefile. Otherwise try corefile first. */
674 if (isdigit (corearg[0]))
676 if (catch_command_errors (attach_command, corearg,
677 !batch, RETURN_MASK_ALL) == 0)
678 catch_command_errors (core_file_command, corearg,
679 !batch, RETURN_MASK_ALL);
681 else /* Can't be a pid, better be a corefile. */
682 catch_command_errors (core_file_command, corearg,
683 !batch, RETURN_MASK_ALL);
687 catch_command_errors (tty_command, ttyarg, !batch, RETURN_MASK_ALL);
689 /* Error messages should no longer be distinguished with extra output. */
690 error_pre_print = NULL;
691 quit_pre_print = NULL;
692 warning_pre_print = _("warning: ");
694 /* Read the .gdbinit file in the current directory, *if* it isn't
695 the same as the $HOME/.gdbinit file (it should exist, also). */
698 || memcmp ((char *) &homebuf, (char *) &cwdbuf, sizeof (struct stat)))
699 if (!inhibit_gdbinit)
701 catch_command_errors (source_command, gdbinit, 0, RETURN_MASK_ALL);
704 for (i = 0; i < ncmd; i++)
707 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
708 expanded into a call to setjmp(). */
709 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
711 /* NOTE: I am commenting this out, because it is not clear
712 where this feature is used. It is very old and
713 undocumented. ezannoni: 1999-05-04 */
715 if (cmdarg[i][0] == '-' && cmdarg[i][1] == '\0')
716 read_command_file (stdin);
719 source_command (cmdarg[i], !batch);
720 do_cleanups (ALL_CLEANUPS);
723 catch_command_errors (source_command, cmdarg[i], !batch, RETURN_MASK_ALL);
727 /* Read in the old history after all the command files have been read. */
732 /* We have hit the end of the batch file. */
736 /* Do any host- or target-specific hacks. This is used for i960 targets
737 to force the user to set a nindy target and spec its parameters. */
739 #ifdef BEFORE_MAIN_LOOP_HOOK
740 BEFORE_MAIN_LOOP_HOOK;
743 /* Show time and/or space usage. */
747 long init_time = get_run_time () - time_at_startup;
749 printf_unfiltered (_("Startup time: %ld.%06ld\n"),
750 init_time / 1000000, init_time % 1000000);
756 extern char **environ;
757 char *lim = (char *) sbrk (0);
759 printf_unfiltered (_("Startup size: data size %ld\n"),
760 (long) (lim - (char *) &environ));
765 /* FIXME: cagney/1999-11-06: The original main loop was like: */
768 if (!SET_TOP_LEVEL ())
770 do_cleanups (ALL_CLEANUPS); /* Do complete cleanup */
771 /* GUIs generally have their own command loop, mainloop, or whatever.
772 This is a good place to gain control because many error
773 conditions will end up here via longjmp(). */
774 if (deprecated_command_loop_hook)
775 deprecated_command_loop_hook ();
777 deprecated_command_loop ();
778 quit_command ((char *) 0, instream == stdin);
781 /* NOTE: If the command_loop() returned normally, the loop would
782 attempt to exit by calling the function quit_command(). That
783 function would either call exit() or throw an error returning
784 control to SET_TOP_LEVEL. */
785 /* NOTE: The function do_cleanups() was called once each time round
786 the loop. The usefulness of the call isn't clear. If an error
787 was thrown, everything would have already been cleaned up. If
788 command_loop() returned normally and quit_command() was called,
789 either exit() or error() (again cleaning up) would be called. */
791 /* NOTE: cagney/1999-11-07: There is probably no reason for not
792 moving this loop and the code found in captured_command_loop()
793 into the command_loop() proper. The main thing holding back that
794 change - SET_TOP_LEVEL() - has been eliminated. */
797 catch_errors (captured_command_loop, 0, "", RETURN_MASK_ALL);
799 /* No exit -- exit is through quit_command. */
803 gdb_main (struct captured_main_args *args)
805 use_windows = args->use_windows;
806 catch_errors (captured_main, args, "", RETURN_MASK_ALL);
807 /* The only way to end up here is by an error (normal exit is
808 handled by quit_force()), hence always return an error status. */
813 /* Don't use *_filtered for printing help. We don't want to prompt
814 for continue no matter how small the screen or how much we're going
818 print_gdb_help (struct ui_file *stream)
820 fputs_unfiltered (_("\
821 This is the GNU debugger. Usage:\n\n\
822 gdb [options] [executable-file [core-file or process-id]]\n\
823 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
826 fputs_unfiltered (_("\
827 --args Arguments after executable-file are passed to inferior\n\
829 fputs_unfiltered (_("\
830 --[no]async Enable (disable) asynchronous version of CLI\n\
832 fputs_unfiltered (_("\
833 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
834 --batch Exit after processing options.\n\
835 --cd=DIR Change current directory to DIR.\n\
836 --command=FILE Execute GDB commands from FILE.\n\
837 --core=COREFILE Analyze the core dump COREFILE.\n\
838 --pid=PID Attach to running process PID.\n\
840 fputs_unfiltered (_("\
841 --dbx DBX compatibility mode.\n\
842 --directory=DIR Search for source files in DIR.\n\
843 --epoch Output information used by epoch emacs-GDB interface.\n\
844 --exec=EXECFILE Use EXECFILE as the executable.\n\
845 --fullname Output information used by emacs-GDB interface.\n\
846 --help Print this message.\n\
848 fputs_unfiltered (_("\
849 --interpreter=INTERP\n\
850 Select a specific interpreter / user interface\n\
852 fputs_unfiltered (_("\
853 --mapped Use mapped symbol files if supported on this system.\n\
854 --nw Do not use a window interface.\n\
855 --nx Do not read "), stream);
856 fputs_unfiltered (gdbinit, stream);
857 fputs_unfiltered (_(" file.\n\
858 --quiet Do not print version number on startup.\n\
859 --readnow Fully read symbol files on first access.\n\
861 fputs_unfiltered (_("\
862 --se=FILE Use FILE as symbol file and executable file.\n\
863 --symbols=SYMFILE Read symbols from SYMFILE.\n\
864 --tty=TTY Use TTY for input/output by the program being debugged.\n\
867 fputs_unfiltered (_("\
868 --tui Use a terminal user interface.\n\
871 fputs_unfiltered (_("\
872 --version Print version information and then exit.\n\
873 -w Use a window interface.\n\
874 --write Set writing into executable and core files.\n\
875 --xdb XDB compatibility mode.\n\
877 fputs_unfiltered (_("\n\
878 For more information, type \"help\" from within GDB, or consult the\n\
879 GDB manual (available as on-line info or a printed manual).\n\