1 /* Top level stuff for GDB, the GNU debugger.
2 Copyright 1986-1995, 1999-2000 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
25 #include "call-cmds.h"
29 #include <sys/types.h>
33 #include "gdb_string.h"
34 #include "event-loop.h"
36 #if defined (TUI) || defined (GDBTK)
37 /* FIXME: cagney/2000-01-31: This #include is to allow older code such
38 as that found in the TUI to continue to build. */
39 #include "tui/tui-file.h"
42 /* If nonzero, display time usage both at startup and for each command. */
46 /* If nonzero, display space usage both at startup and for each command. */
50 /* Whether this is the async version or not. The async version is
51 invoked on the command line with the -nw --async options. In this
52 version, the usual command_loop is substituted by and event loop which
53 processes UI events asynchronously. */
56 /* Whether this is the command line version or not */
59 /* Whether xdb commands will be handled */
62 /* Whether dbx commands will be handled */
65 struct ui_file *gdb_stdout;
66 struct ui_file *gdb_stderr;
67 struct ui_file *gdb_stdlog;
68 struct ui_file *gdb_stdtarg;
70 /* Used to initialize error() - defined in utils.c */
72 extern void error_init (void);
74 /* Whether to enable writing into executable and core files */
75 extern int write_files;
77 static void print_gdb_help (struct ui_file *);
79 /* These two are used to set the external editor commands when gdb is farming
80 out files to be edited by another program. */
82 extern int enable_external_editor;
83 extern char *external_editor_command;
86 #include <windows.h> /* for MAX_PATH */
87 #include <sys/cygwin.h> /* for cygwin32_conv_to_posix_path */
90 /* Call command_loop. If it happens to return, pass that through as a
91 non-zero return status. */
94 captured_command_loop (void *data)
96 if (command_loop_hook == NULL)
100 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
101 would clean things up (restoring the cleanup chain) to the state
102 they were just prior to the call. Technically, this means that
103 the do_cleanups() below is redundant. Unfortunatly, many FUNC's
104 are not that well behaved. do_cleanups should either be replaced
105 with a do_cleanups call (to cover the problem) or an assertion
106 check to detect bad FUNCs code. */
107 do_cleanups (ALL_CLEANUPS);
108 /* If the command_loop returned, normally (rather than threw an
109 error) we try to quit. If the quit is aborted, catch_errors()
110 which called this catch the signal and restart the command
112 quit_command (NULL, instream == stdin);
116 struct captured_main_args
123 captured_main (void *data)
125 struct captured_main_args *context = data;
126 int argc = context->argc;
127 char **argv = context->argv;
129 static int quiet = 0;
130 static int batch = 0;
132 /* Pointers to various arguments from command line. */
134 char *execarg = NULL;
135 char *corearg = NULL;
139 /* These are static so that we can take their address in an initializer. */
140 static int print_help;
141 static int print_version;
143 /* Pointers to all arguments of --command option. */
145 /* Allocated size of cmdarg. */
147 /* Number of elements of cmdarg used. */
150 /* Indices of all arguments of --directory option. */
152 /* Allocated size. */
154 /* Number of elements used. */
157 struct stat homebuf, cwdbuf;
158 char *homedir, *homeinit;
162 long time_at_startup = get_run_time ();
164 START_PROGRESS (argv[0], 0);
167 /* Do all Mac-specific setup. */
171 /* This needs to happen before the first use of malloc. */
172 init_malloc ((PTR) NULL);
174 #if defined (ALIGN_STACK_ON_STARTUP)
175 i = (int) &count & 0x3;
181 cmdarg = (char **) xmalloc (cmdsize * sizeof (*cmdarg));
184 dirarg = (char **) xmalloc (dirsize * sizeof (*dirarg));
188 line = (char *) xmalloc (linesize);
189 line[0] = '\0'; /* Terminate saved (now empty) cmd line */
192 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
193 current_directory = gdb_dirbuf;
195 #if defined (TUI) || defined (GDBTK)
196 /* Older code uses the tui_file and fputs_unfiltered_hook(). It
197 should be using a customized UI_FILE object and re-initializing
198 within its own _initialize function. */
199 gdb_stdout = tui_fileopen (stdout);
200 gdb_stderr = tui_fileopen (stderr);
201 gdb_stdlog = gdb_stdout; /* for moment */
202 gdb_stdtarg = gdb_stderr; /* for moment */
204 gdb_stdout = stdio_fileopen (stdout);
205 gdb_stderr = stdio_fileopen (stderr);
206 gdb_stdlog = gdb_stderr; /* for moment */
207 gdb_stdtarg = gdb_stderr; /* for moment */
210 /* initialize error() */
213 /* Parse arguments and options. */
216 /* When var field is 0, use flag field to record the equivalent
217 short option (or arbitrary numbers starting at 10 for those
218 with no equivalent). */
219 static struct option long_options[] =
221 {"async", no_argument, &event_loop_p, 1},
222 {"noasync", no_argument, &event_loop_p, 0},
224 {"tui", no_argument, &tui_version, 1},
226 {"xdb", no_argument, &xdb_commands, 1},
227 {"dbx", no_argument, &dbx_commands, 1},
228 {"readnow", no_argument, &readnow_symbol_files, 1},
229 {"r", no_argument, &readnow_symbol_files, 1},
230 {"mapped", no_argument, &mapped_symbol_files, 1},
231 {"m", no_argument, &mapped_symbol_files, 1},
232 {"quiet", no_argument, &quiet, 1},
233 {"q", no_argument, &quiet, 1},
234 {"silent", no_argument, &quiet, 1},
235 {"nx", no_argument, &inhibit_gdbinit, 1},
236 {"n", no_argument, &inhibit_gdbinit, 1},
237 {"batch", no_argument, &batch, 1},
238 {"epoch", no_argument, &epoch_interface, 1},
240 /* This is a synonym for "--annotate=1". --annotate is now preferred,
241 but keep this here for a long time because people will be running
242 emacses which use --fullname. */
243 {"fullname", no_argument, 0, 'f'},
244 {"f", no_argument, 0, 'f'},
246 {"annotate", required_argument, 0, 12},
247 {"help", no_argument, &print_help, 1},
248 {"se", required_argument, 0, 10},
249 {"symbols", required_argument, 0, 's'},
250 {"s", required_argument, 0, 's'},
251 {"exec", required_argument, 0, 'e'},
252 {"e", required_argument, 0, 'e'},
253 {"core", required_argument, 0, 'c'},
254 {"c", required_argument, 0, 'c'},
255 {"command", required_argument, 0, 'x'},
256 {"version", no_argument, &print_version, 1},
257 {"x", required_argument, 0, 'x'},
259 {"tclcommand", required_argument, 0, 'z'},
260 {"enable-external-editor", no_argument, 0, 'y'},
261 {"editor-command", required_argument, 0, 'w'},
263 {"ui", required_argument, 0, 'i'},
264 {"interpreter", required_argument, 0, 'i'},
265 {"i", required_argument, 0, 'i'},
266 {"directory", required_argument, 0, 'd'},
267 {"d", required_argument, 0, 'd'},
268 {"cd", required_argument, 0, 11},
269 {"tty", required_argument, 0, 't'},
270 {"baud", required_argument, 0, 'b'},
271 {"b", required_argument, 0, 'b'},
272 {"nw", no_argument, &use_windows, 0},
273 {"nowindows", no_argument, &use_windows, 0},
274 {"w", no_argument, &use_windows, 1},
275 {"windows", no_argument, &use_windows, 1},
276 {"statistics", no_argument, 0, 13},
277 {"write", no_argument, &write_files, 1},
278 /* Allow machine descriptions to add more options... */
279 #ifdef ADDITIONAL_OPTIONS
282 {0, no_argument, 0, 0}
289 c = getopt_long_only (argc, argv, "",
290 long_options, &option_index);
294 /* Long option that takes an argument. */
295 if (c == 0 && long_options[option_index].flag == 0)
296 c = long_options[option_index].val;
301 /* Long option that just sets a flag. */
311 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
312 annotation_level = atoi (optarg);
315 /* Enable the display of both time and space usage. */
320 annotation_level = 1;
321 /* We have probably been invoked from emacs. Disable window interface. */
334 cmdarg[ncmd++] = optarg;
338 cmdarg = (char **) xrealloc ((char *) cmdarg,
339 cmdsize * sizeof (*cmdarg));
345 extern int gdbtk_test PARAMS ((char *));
346 if (!gdbtk_test (optarg))
348 fprintf_unfiltered (gdb_stderr, "%s: unable to load tclcommand file \"%s\"",
357 * This enables the edit/button in the main window, even
358 * when IDE_ENABLED is set to false. In this case you must
359 * use --tclcommand to specify a tcl/script to be called,
360 * Tcl/Variable to store the edit/command is:
363 enable_external_editor = 1;
369 * if editor command is enabled, both flags are set
371 enable_external_editor = 1;
372 external_editor_command = xstrdup (optarg);
377 dirarg[ndir++] = optarg;
381 dirarg = (char **) xrealloc ((char *) dirarg,
382 dirsize * sizeof (*dirarg));
396 i = strtol (optarg, &p, 0);
397 if (i == 0 && p == optarg)
399 /* Don't use *_filtered or warning() (which relies on
400 current_target) until after initialize_all_files(). */
404 "warning: could not set baud rate to `%s'.\n", optarg);
413 i = strtol (optarg, &p, 0);
414 if (i == 0 && p == optarg)
416 /* Don't use *_filtered or warning() (which relies on
417 current_target) until after initialize_all_files(). */
421 "warning: could not set timeout limit to `%s'.\n", optarg);
427 #ifdef ADDITIONAL_OPTION_CASES
428 ADDITIONAL_OPTION_CASES
431 fprintf_unfiltered (gdb_stderr,
432 "Use `%s --help' for a complete list of options.\n",
438 /* If --help or --version, disable window interface. */
439 if (print_help || print_version)
443 /* Disable the TUI as well. */
449 /* An explicit --tui flag overrides the default UI, which is the
455 /* OK, that's all the options. The other arguments are filenames. */
457 for (; optind < argc; optind++)
461 symarg = argv[optind];
462 execarg = argv[optind];
465 corearg = argv[optind];
468 fprintf_unfiltered (gdb_stderr,
469 "Excess command line arguments ignored. (%s%s)\n",
470 argv[optind], (optind == argc - 1) ? "" : " ...");
478 /* Should this be moved to tui-top.c:_initialize_tui()? */
480 init_ui_hook = tuiInit;
483 /* Initialize all files. Give the interpreter a chance to take
484 control of the console via the init_ui_hook()) */
487 /* Do these (and anything which might call wrap_here or *_filtered)
488 after initialize_all_files. */
491 print_gdb_version (gdb_stdout);
493 printf_filtered ("\n");
499 print_gdb_help (gdb_stdout);
500 fputs_unfiltered ("\n", gdb_stdout);
506 /* Print all the junk at the top, with trailing "..." if we are about
507 to read a symbol file (possibly slowly). */
508 print_gdb_version (gdb_stdout);
510 printf_filtered ("..");
512 gdb_flush (gdb_stdout); /* Force to screen during slow operations */
515 error_pre_print = "\n\n";
516 quit_pre_print = error_pre_print;
518 /* We may get more than one warning, don't double space all of them... */
519 warning_pre_print = "\nwarning: ";
521 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
522 *before* all the command line arguments are processed; it sets
523 global parameters, which are independent of what file you are
524 debugging or what directory you are in. */
527 char *tmp = getenv ("HOME");
531 homedir = (char *) alloca (MAX_PATH + 1);
532 cygwin32_conv_to_posix_path (tmp, homedir);
538 homedir = getenv ("HOME");
542 homeinit = (char *) alloca (strlen (homedir) +
543 strlen (gdbinit) + 10);
544 strcpy (homeinit, homedir);
545 strcat (homeinit, "/");
546 strcat (homeinit, gdbinit);
548 if (!inhibit_gdbinit)
550 catch_command_errors (source_command, homeinit, 0, RETURN_MASK_ALL);
553 /* Do stats; no need to do them elsewhere since we'll only
554 need them if homedir is set. Make sure that they are
555 zero in case one of them fails (this guarantees that they
556 won't match if either exists). */
558 memset (&homebuf, 0, sizeof (struct stat));
559 memset (&cwdbuf, 0, sizeof (struct stat));
561 stat (homeinit, &homebuf);
562 stat (gdbinit, &cwdbuf); /* We'll only need this if
566 /* Now perform all the actions indicated by the arguments. */
569 catch_command_errors (cd_command, cdarg, 0, RETURN_MASK_ALL);
572 for (i = 0; i < ndir; i++)
573 catch_command_errors (directory_command, dirarg[i], 0, RETURN_MASK_ALL);
578 && STREQ (execarg, symarg))
580 /* The exec file and the symbol-file are the same. If we can't
581 open it, better only print one error message.
582 catch_command_errors returns non-zero on success! */
583 if (catch_command_errors (exec_file_command, execarg, !batch, RETURN_MASK_ALL))
584 catch_command_errors (symbol_file_command, symarg, 0, RETURN_MASK_ALL);
589 catch_command_errors (exec_file_command, execarg, !batch, RETURN_MASK_ALL);
591 catch_command_errors (symbol_file_command, symarg, 0, RETURN_MASK_ALL);
594 /* After the symbol file has been read, print a newline to get us
595 beyond the copyright line... But errors should still set off
596 the error message with a (single) blank line. */
598 printf_filtered ("\n");
599 error_pre_print = "\n";
600 quit_pre_print = error_pre_print;
601 warning_pre_print = "\nwarning: ";
605 if (catch_command_errors (core_file_command, corearg, !batch, RETURN_MASK_ALL) == 0)
607 /* See if the core file is really a PID. */
608 if (isdigit (corearg[0]))
609 catch_command_errors (attach_command, corearg, !batch, RETURN_MASK_ALL);
614 catch_command_errors (tty_command, ttyarg, !batch, RETURN_MASK_ALL);
616 #ifdef ADDITIONAL_OPTION_HANDLER
617 ADDITIONAL_OPTION_HANDLER;
620 /* Error messages should no longer be distinguished with extra output. */
621 error_pre_print = NULL;
622 quit_pre_print = NULL;
623 warning_pre_print = "warning: ";
625 /* Read the .gdbinit file in the current directory, *if* it isn't
626 the same as the $HOME/.gdbinit file (it should exist, also). */
629 || memcmp ((char *) &homebuf, (char *) &cwdbuf, sizeof (struct stat)))
630 if (!inhibit_gdbinit)
632 catch_command_errors (source_command, gdbinit, 0, RETURN_MASK_ALL);
635 for (i = 0; i < ncmd; i++)
638 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
639 expanded into a call to setjmp(). */
640 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
642 /* NOTE: I am commenting this out, because it is not clear
643 where this feature is used. It is very old and
644 undocumented. ezannoni: 1999-05-04 */
646 if (cmdarg[i][0] == '-' && cmdarg[i][1] == '\0')
647 read_command_file (stdin);
650 source_command (cmdarg[i], !batch);
651 do_cleanups (ALL_CLEANUPS);
654 catch_command_errors (source_command, cmdarg[i], !batch, RETURN_MASK_ALL);
658 /* Read in the old history after all the command files have been read. */
663 /* We have hit the end of the batch file. */
667 /* Do any host- or target-specific hacks. This is used for i960 targets
668 to force the user to set a nindy target and spec its parameters. */
670 #ifdef BEFORE_MAIN_LOOP_HOOK
671 BEFORE_MAIN_LOOP_HOOK;
674 END_PROGRESS (argv[0]);
676 /* Show time and/or space usage. */
680 long init_time = get_run_time () - time_at_startup;
682 printf_unfiltered ("Startup time: %ld.%06ld\n",
683 init_time / 1000000, init_time % 1000000);
689 extern char **environ;
690 char *lim = (char *) sbrk (0);
692 printf_unfiltered ("Startup size: data size %ld\n",
693 (long) (lim - (char *) &environ));
697 /* The default command loop.
698 The WIN32 Gui calls this main to set up gdb's state, and
699 has its own command loop. */
700 #if !defined _WIN32 || defined __GNUC__
701 /* GUIs generally have their own command loop, mainloop, or
702 whatever. This is a good place to gain control because many
703 error conditions will end up here via longjmp(). */
705 /* FIXME: cagney/1999-11-06: The original main loop was like: */
708 if (!SET_TOP_LEVEL ())
710 do_cleanups (ALL_CLEANUPS); /* Do complete cleanup */
711 /* GUIs generally have their own command loop, mainloop, or whatever.
712 This is a good place to gain control because many error
713 conditions will end up here via longjmp(). */
714 if (command_loop_hook)
715 command_loop_hook ();
718 quit_command ((char *) 0, instream == stdin);
721 /* NOTE: If the command_loop() returned normally, the loop would
722 attempt to exit by calling the function quit_command(). That
723 function would either call exit() or throw an error returning
724 control to SET_TOP_LEVEL. */
725 /* NOTE: The function do_cleanups() was called once each time round
726 the loop. The usefulness of the call isn't clear. If an error
727 was thrown, everything would have already been cleaned up. If
728 command_loop() returned normally and quit_command() was called,
729 either exit() or error() (again cleaning up) would be called. */
731 /* NOTE: cagney/1999-11-07: There is probably no reason for not
732 moving this loop and the code found in captured_command_loop()
733 into the command_loop() proper. The main thing holding back that
734 change - SET_TOP_LEVEL() - has been eliminated. */
737 catch_errors (captured_command_loop, 0, "", RETURN_MASK_ALL);
740 /* No exit -- exit is through quit_command. */
744 main (int argc, char **argv)
746 struct captured_main_args args;
749 catch_errors (captured_main, &args, "", RETURN_MASK_ALL);
754 /* Don't use *_filtered for printing help. We don't want to prompt
755 for continue no matter how small the screen or how much we're going
759 print_gdb_help (struct ui_file *stream)
762 This is the GNU debugger. Usage:\n\n\
763 gdb [options] [executable-file [core-file or process-id]]\n\n\
767 --[no]async Enable (disable) asynchronous version of CLI\n\
770 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
771 --batch Exit after processing options.\n\
772 --cd=DIR Change current directory to DIR.\n\
773 --command=FILE Execute GDB commands from FILE.\n\
774 --core=COREFILE Analyze the core dump COREFILE.\n\
777 --dbx DBX compatibility mode.\n\
778 --directory=DIR Search for source files in DIR.\n\
779 --epoch Output information used by epoch emacs-GDB interface.\n\
780 --exec=EXECFILE Use EXECFILE as the executable.\n\
781 --fullname Output information used by emacs-GDB interface.\n\
782 --help Print this message.\n\
785 --interpreter=INTERP\n\
786 Select a specific interpreter / user interface\n\
789 --mapped Use mapped symbol files if supported on this system.\n\
790 --nw Do not use a window interface.\n\
791 --nx Do not read ", stream);
792 fputs_unfiltered (gdbinit, stream);
793 fputs_unfiltered (" file.\n\
794 --quiet Do not print version number on startup.\n\
795 --readnow Fully read symbol files on first access.\n\
798 --se=FILE Use FILE as symbol file and executable file.\n\
799 --symbols=SYMFILE Read symbols from SYMFILE.\n\
800 --tty=TTY Use TTY for input/output by the program being debugged.\n\
804 --tui Use a terminal user interface.\n\
808 --version Print version information and then exit.\n\
809 -w Use a window interface.\n\
810 --write Set writing into executable and core files.\n\
811 --xdb XDB compatibility mode.\n\
813 #ifdef ADDITIONAL_OPTION_HELP
814 fputs_unfiltered (ADDITIONAL_OPTION_HELP, stream);
816 fputs_unfiltered ("\n\
817 For more information, type \"help\" from within GDB, or consult the\n\
818 GDB manual (available as on-line info or a printed manual).\n\