1 /* Top level stuff for GDB, the GNU debugger.
2 Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
3 1996, 1997, 1998, 1999, 2000, 2001, 2002
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
32 #include <sys/types.h>
36 #include "gdb_string.h"
37 #include "event-loop.h"
40 /* If nonzero, display time usage both at startup and for each command. */
44 /* If nonzero, display space usage both at startup and for each command. */
48 /* Whether this is the async version or not. The async version is
49 invoked on the command line with the -nw --async options. In this
50 version, the usual command_loop is substituted by and event loop which
51 processes UI events asynchronously. */
54 /* Has an interpreter been specified and if so, which. */
57 /* Whether this is the command line version or not */
60 /* Whether xdb commands will be handled */
63 /* Whether dbx commands will be handled */
66 struct ui_file *gdb_stdout;
67 struct ui_file *gdb_stderr;
68 struct ui_file *gdb_stdlog;
69 struct ui_file *gdb_stdtarg;
71 /* Used to initialize error() - defined in utils.c */
73 extern void error_init (void);
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 if (command_loop_hook == NULL)
95 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
96 would clean things up (restoring the cleanup chain) to the state
97 they were just prior to the call. Technically, this means that
98 the do_cleanups() below is redundant. Unfortunately, many FUNCs
99 are not that well behaved. do_cleanups should either be replaced
100 with a do_cleanups call (to cover the problem) or an assertion
101 check to detect bad FUNCs code. */
102 do_cleanups (ALL_CLEANUPS);
103 /* If the command_loop returned, normally (rather than threw an
104 error) we try to quit. If the quit is aborted, catch_errors()
105 which called this catch the signal and restart the command
107 quit_command (NULL, instream == stdin);
111 struct captured_main_args
118 captured_main (void *data)
120 struct captured_main_args *context = data;
121 int argc = context->argc;
122 char **argv = context->argv;
124 static int quiet = 0;
125 static int batch = 0;
126 static int set_args = 0;
128 /* Pointers to various arguments from command line. */
130 char *execarg = NULL;
131 char *corearg = NULL;
135 /* These are static so that we can take their address in an initializer. */
136 static int print_help;
137 static int print_version;
139 /* Pointers to all arguments of --command option. */
141 /* Allocated size of cmdarg. */
143 /* Number of elements of cmdarg used. */
146 /* Indices of all arguments of --directory option. */
148 /* Allocated size. */
150 /* Number of elements used. */
153 struct stat homebuf, cwdbuf;
154 char *homedir, *homeinit;
158 long time_at_startup = get_run_time ();
160 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
161 setlocale (LC_MESSAGES, "");
163 #if defined (HAVE_SETLOCALE)
164 setlocale (LC_CTYPE, "");
166 bindtextdomain (PACKAGE, LOCALEDIR);
167 textdomain (PACKAGE);
169 START_PROGRESS (argv[0], 0);
172 /* Do all Mac-specific setup. */
176 /* This needs to happen before the first use of malloc. */
177 init_malloc ((PTR) NULL);
179 #if defined (ALIGN_STACK_ON_STARTUP)
180 i = (int) &count & 0x3;
186 cmdarg = (char **) xmalloc (cmdsize * sizeof (*cmdarg));
189 dirarg = (char **) xmalloc (dirsize * sizeof (*dirarg));
193 line = (char *) xmalloc (linesize);
194 line[0] = '\0'; /* Terminate saved (now empty) cmd line */
197 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
198 current_directory = gdb_dirbuf;
200 gdb_stdout = stdio_fileopen (stdout);
201 gdb_stderr = stdio_fileopen (stderr);
202 gdb_stdlog = gdb_stderr; /* for moment */
203 gdb_stdtarg = gdb_stderr; /* for moment */
205 /* initialize error() */
208 /* Parse arguments and options. */
211 /* When var field is 0, use flag field to record the equivalent
212 short option (or arbitrary numbers starting at 10 for those
213 with no equivalent). */
214 static struct option long_options[] =
216 {"async", no_argument, &event_loop_p, 1},
217 {"noasync", no_argument, &event_loop_p, 0},
219 {"tui", no_argument, &tui_version, 1},
221 {"xdb", no_argument, &xdb_commands, 1},
222 {"dbx", no_argument, &dbx_commands, 1},
223 {"readnow", no_argument, &readnow_symbol_files, 1},
224 {"r", no_argument, &readnow_symbol_files, 1},
225 {"mapped", no_argument, &mapped_symbol_files, 1},
226 {"m", no_argument, &mapped_symbol_files, 1},
227 {"quiet", no_argument, &quiet, 1},
228 {"q", no_argument, &quiet, 1},
229 {"silent", no_argument, &quiet, 1},
230 {"nx", no_argument, &inhibit_gdbinit, 1},
231 {"n", no_argument, &inhibit_gdbinit, 1},
232 {"batch", no_argument, &batch, 1},
233 {"epoch", no_argument, &epoch_interface, 1},
235 /* This is a synonym for "--annotate=1". --annotate is now preferred,
236 but keep this here for a long time because people will be running
237 emacses which use --fullname. */
238 {"fullname", no_argument, 0, 'f'},
239 {"f", no_argument, 0, 'f'},
241 {"annotate", required_argument, 0, 12},
242 {"help", no_argument, &print_help, 1},
243 {"se", required_argument, 0, 10},
244 {"symbols", required_argument, 0, 's'},
245 {"s", required_argument, 0, 's'},
246 {"exec", required_argument, 0, 'e'},
247 {"e", required_argument, 0, 'e'},
248 {"core", required_argument, 0, 'c'},
249 {"c", required_argument, 0, 'c'},
250 {"pid", required_argument, 0, 'p'},
251 {"p", required_argument, 0, 'p'},
252 {"command", required_argument, 0, 'x'},
253 {"version", no_argument, &print_version, 1},
254 {"x", required_argument, 0, 'x'},
256 {"tclcommand", required_argument, 0, 'z'},
257 {"enable-external-editor", no_argument, 0, 'y'},
258 {"editor-command", required_argument, 0, 'w'},
260 {"ui", required_argument, 0, 'i'},
261 {"interpreter", required_argument, 0, 'i'},
262 {"i", required_argument, 0, 'i'},
263 {"directory", required_argument, 0, 'd'},
264 {"d", required_argument, 0, 'd'},
265 {"cd", required_argument, 0, 11},
266 {"tty", required_argument, 0, 't'},
267 {"baud", required_argument, 0, 'b'},
268 {"b", required_argument, 0, 'b'},
269 {"nw", no_argument, &use_windows, 0},
270 {"nowindows", no_argument, &use_windows, 0},
271 {"w", no_argument, &use_windows, 1},
272 {"windows", no_argument, &use_windows, 1},
273 {"statistics", no_argument, 0, 13},
274 {"write", no_argument, &write_files, 1},
275 {"args", no_argument, &set_args, 1},
276 /* Allow machine descriptions to add more options... */
277 #ifdef ADDITIONAL_OPTIONS
280 {0, no_argument, 0, 0}
287 c = getopt_long_only (argc, argv, "",
288 long_options, &option_index);
289 if (c == EOF || set_args)
292 /* Long option that takes an argument. */
293 if (c == 0 && long_options[option_index].flag == 0)
294 c = long_options[option_index].val;
299 /* Long option that just sets a flag. */
309 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
310 annotation_level = atoi (optarg);
313 /* Enable the display of both time and space usage. */
318 annotation_level = 1;
319 /* We have probably been invoked from emacs. Disable window interface. */
332 /* "corearg" is shared by "--core" and "--pid" */
336 cmdarg[ncmd++] = optarg;
340 cmdarg = (char **) xrealloc ((char *) cmdarg,
341 cmdsize * sizeof (*cmdarg));
347 extern int gdbtk_test (char *);
348 if (!gdbtk_test (optarg))
350 fprintf_unfiltered (gdb_stderr, _("%s: unable to load tclcommand file \"%s\""),
357 /* Backwards compatibility only. */
361 external_editor_command = xstrdup (optarg);
366 interpreter_p = optarg;
369 dirarg[ndir++] = optarg;
373 dirarg = (char **) xrealloc ((char *) dirarg,
374 dirsize * sizeof (*dirarg));
388 i = strtol (optarg, &p, 0);
389 if (i == 0 && p == optarg)
391 /* Don't use *_filtered or warning() (which relies on
392 current_target) until after initialize_all_files(). */
396 _("warning: could not set baud rate to `%s'.\n"), optarg);
405 i = strtol (optarg, &p, 0);
406 if (i == 0 && p == optarg)
408 /* Don't use *_filtered or warning() (which relies on
409 current_target) until after initialize_all_files(). */
413 _("warning: could not set timeout limit to `%s'.\n"), optarg);
419 #ifdef ADDITIONAL_OPTION_CASES
420 ADDITIONAL_OPTION_CASES
423 fprintf_unfiltered (gdb_stderr,
424 _("Use `%s --help' for a complete list of options.\n"),
430 /* If --help or --version, disable window interface. */
431 if (print_help || print_version)
435 /* Disable the TUI as well. */
441 /* An explicit --tui flag overrides the default UI, which is the
449 /* The remaining options are the command-line options for the
450 inferior. The first one is the sym/exec file, and the rest
454 fprintf_unfiltered (gdb_stderr,
455 _("%s: `--args' specified but no program specified\n"),
459 symarg = argv[optind];
460 execarg = argv[optind];
462 set_inferior_args_vector (argc - optind, &argv[optind]);
466 /* OK, that's all the options. The other arguments are filenames. */
468 for (; optind < argc; optind++)
472 symarg = argv[optind];
473 execarg = argv[optind];
476 /* The documentation says this can be a "ProcID" as well.
477 We will try it as both a corefile and a pid. */
478 corearg = argv[optind];
481 fprintf_unfiltered (gdb_stderr,
482 _("Excess command line arguments ignored. (%s%s)\n"),
483 argv[optind], (optind == argc - 1) ? "" : " ...");
491 /* Initialize all files. Give the interpreter a chance to take
492 control of the console via the init_ui_hook()) */
495 /* Do these (and anything which might call wrap_here or *_filtered)
496 after initialize_all_files. */
499 print_gdb_version (gdb_stdout);
501 printf_filtered ("\n");
507 print_gdb_help (gdb_stdout);
508 fputs_unfiltered ("\n", gdb_stdout);
514 /* Print all the junk at the top, with trailing "..." if we are about
515 to read a symbol file (possibly slowly). */
516 print_gdb_version (gdb_stdout);
518 printf_filtered ("..");
520 gdb_flush (gdb_stdout); /* Force to screen during slow operations */
523 error_pre_print = "\n\n";
524 quit_pre_print = error_pre_print;
526 /* We may get more than one warning, don't double space all of them... */
527 warning_pre_print = _("\nwarning: ");
529 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
530 *before* all the command line arguments are processed; it sets
531 global parameters, which are independent of what file you are
532 debugging or what directory you are in. */
533 homedir = getenv ("HOME");
536 homeinit = (char *) alloca (strlen (homedir) +
537 strlen (gdbinit) + 10);
538 strcpy (homeinit, homedir);
539 strcat (homeinit, "/");
540 strcat (homeinit, gdbinit);
542 if (!inhibit_gdbinit)
544 catch_command_errors (source_command, homeinit, 0, RETURN_MASK_ALL);
547 /* Do stats; no need to do them elsewhere since we'll only
548 need them if homedir is set. Make sure that they are
549 zero in case one of them fails (this guarantees that they
550 won't match if either exists). */
552 memset (&homebuf, 0, sizeof (struct stat));
553 memset (&cwdbuf, 0, sizeof (struct stat));
555 stat (homeinit, &homebuf);
556 stat (gdbinit, &cwdbuf); /* We'll only need this if
560 /* Now perform all the actions indicated by the arguments. */
563 catch_command_errors (cd_command, cdarg, 0, RETURN_MASK_ALL);
566 for (i = 0; i < ndir; i++)
567 catch_command_errors (directory_command, dirarg[i], 0, RETURN_MASK_ALL);
572 && STREQ (execarg, symarg))
574 /* The exec file and the symbol-file are the same. If we can't
575 open it, better only print one error message.
576 catch_command_errors returns non-zero on success! */
577 if (catch_command_errors (exec_file_attach, execarg, !batch, RETURN_MASK_ALL))
578 catch_command_errors (symbol_file_add_main, symarg, 0, RETURN_MASK_ALL);
583 catch_command_errors (exec_file_attach, execarg, !batch, RETURN_MASK_ALL);
585 catch_command_errors (symbol_file_add_main, symarg, 0, RETURN_MASK_ALL);
588 /* After the symbol file has been read, print a newline to get us
589 beyond the copyright line... But errors should still set off
590 the error message with a (single) blank line. */
592 printf_filtered ("\n");
593 error_pre_print = "\n";
594 quit_pre_print = error_pre_print;
595 warning_pre_print = _("\nwarning: ");
599 /* corearg may be either a corefile or a pid.
600 If its first character is a digit, try attach first
601 and then corefile. Otherwise try corefile first. */
603 if (isdigit (corearg[0]))
605 if (catch_command_errors (attach_command, corearg,
606 !batch, RETURN_MASK_ALL) == 0)
607 catch_command_errors (core_file_command, corearg,
608 !batch, RETURN_MASK_ALL);
610 else /* Can't be a pid, better be a corefile. */
611 catch_command_errors (core_file_command, corearg,
612 !batch, RETURN_MASK_ALL);
616 catch_command_errors (tty_command, ttyarg, !batch, RETURN_MASK_ALL);
618 #ifdef ADDITIONAL_OPTION_HANDLER
619 ADDITIONAL_OPTION_HANDLER;
622 /* Error messages should no longer be distinguished with extra output. */
623 error_pre_print = NULL;
624 quit_pre_print = NULL;
625 warning_pre_print = _("warning: ");
627 /* Read the .gdbinit file in the current directory, *if* it isn't
628 the same as the $HOME/.gdbinit file (it should exist, also). */
631 || memcmp ((char *) &homebuf, (char *) &cwdbuf, sizeof (struct stat)))
632 if (!inhibit_gdbinit)
634 catch_command_errors (source_command, gdbinit, 0, RETURN_MASK_ALL);
637 for (i = 0; i < ncmd; i++)
640 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
641 expanded into a call to setjmp(). */
642 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
644 /* NOTE: I am commenting this out, because it is not clear
645 where this feature is used. It is very old and
646 undocumented. ezannoni: 1999-05-04 */
648 if (cmdarg[i][0] == '-' && cmdarg[i][1] == '\0')
649 read_command_file (stdin);
652 source_command (cmdarg[i], !batch);
653 do_cleanups (ALL_CLEANUPS);
656 catch_command_errors (source_command, cmdarg[i], !batch, RETURN_MASK_ALL);
660 /* Read in the old history after all the command files have been read. */
665 /* We have hit the end of the batch file. */
669 /* Do any host- or target-specific hacks. This is used for i960 targets
670 to force the user to set a nindy target and spec its parameters. */
672 #ifdef BEFORE_MAIN_LOOP_HOOK
673 BEFORE_MAIN_LOOP_HOOK;
676 END_PROGRESS (argv[0]);
678 /* Show time and/or space usage. */
682 long init_time = get_run_time () - time_at_startup;
684 printf_unfiltered (_("Startup time: %ld.%06ld\n"),
685 init_time / 1000000, init_time % 1000000);
691 extern char **environ;
692 char *lim = (char *) sbrk (0);
694 printf_unfiltered (_("Startup size: data size %ld\n"),
695 (long) (lim - (char *) &environ));
700 /* FIXME: cagney/1999-11-06: The original main loop was like: */
703 if (!SET_TOP_LEVEL ())
705 do_cleanups (ALL_CLEANUPS); /* Do complete cleanup */
706 /* GUIs generally have their own command loop, mainloop, or whatever.
707 This is a good place to gain control because many error
708 conditions will end up here via longjmp(). */
709 if (command_loop_hook)
710 command_loop_hook ();
713 quit_command ((char *) 0, instream == stdin);
716 /* NOTE: If the command_loop() returned normally, the loop would
717 attempt to exit by calling the function quit_command(). That
718 function would either call exit() or throw an error returning
719 control to SET_TOP_LEVEL. */
720 /* NOTE: The function do_cleanups() was called once each time round
721 the loop. The usefulness of the call isn't clear. If an error
722 was thrown, everything would have already been cleaned up. If
723 command_loop() returned normally and quit_command() was called,
724 either exit() or error() (again cleaning up) would be called. */
726 /* NOTE: cagney/1999-11-07: There is probably no reason for not
727 moving this loop and the code found in captured_command_loop()
728 into the command_loop() proper. The main thing holding back that
729 change - SET_TOP_LEVEL() - has been eliminated. */
732 catch_errors (captured_command_loop, 0, "", RETURN_MASK_ALL);
734 /* No exit -- exit is through quit_command. */
738 main (int argc, char **argv)
740 struct captured_main_args args;
743 catch_errors (captured_main, &args, "", RETURN_MASK_ALL);
748 /* Don't use *_filtered for printing help. We don't want to prompt
749 for continue no matter how small the screen or how much we're going
753 print_gdb_help (struct ui_file *stream)
755 fputs_unfiltered (_("\
756 This is the GNU debugger. Usage:\n\n\
757 gdb [options] [executable-file [core-file or process-id]]\n\
758 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
761 fputs_unfiltered (_("\
762 --args Arguments after executable-file are passed to inferior\n\
764 fputs_unfiltered (_("\
765 --[no]async Enable (disable) asynchronous version of CLI\n\
767 fputs_unfiltered (_("\
768 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
769 --batch Exit after processing options.\n\
770 --cd=DIR Change current directory to DIR.\n\
771 --command=FILE Execute GDB commands from FILE.\n\
772 --core=COREFILE Analyze the core dump COREFILE.\n\
773 --pid=PID Attach to running process PID.\n\
775 fputs_unfiltered (_("\
776 --dbx DBX compatibility mode.\n\
777 --directory=DIR Search for source files in DIR.\n\
778 --epoch Output information used by epoch emacs-GDB interface.\n\
779 --exec=EXECFILE Use EXECFILE as the executable.\n\
780 --fullname Output information used by emacs-GDB interface.\n\
781 --help Print this message.\n\
783 fputs_unfiltered (_("\
784 --interpreter=INTERP\n\
785 Select a specific interpreter / user interface\n\
787 fputs_unfiltered (_("\
788 --mapped Use mapped symbol files if supported on this system.\n\
789 --nw Do not use a window interface.\n\
790 --nx Do not read "), stream);
791 fputs_unfiltered (gdbinit, stream);
792 fputs_unfiltered (_(" file.\n\
793 --quiet Do not print version number on startup.\n\
794 --readnow Fully read symbol files on first access.\n\
796 fputs_unfiltered (_("\
797 --se=FILE Use FILE as symbol file and executable file.\n\
798 --symbols=SYMFILE Read symbols from SYMFILE.\n\
799 --tty=TTY Use TTY for input/output by the program being debugged.\n\
802 fputs_unfiltered (_("\
803 --tui Use a terminal user interface.\n\
806 fputs_unfiltered (_("\
807 --version Print version information and then exit.\n\
808 -w Use a window interface.\n\
809 --write Set writing into executable and core files.\n\
810 --xdb XDB compatibility mode.\n\
812 #ifdef ADDITIONAL_OPTION_HELP
813 fputs_unfiltered (ADDITIONAL_OPTION_HELP, stream);
815 fputs_unfiltered (_("\n\
816 For more information, type \"help\" from within GDB, or consult the\n\
817 GDB manual (available as on-line info or a printed manual).\n\