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 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 2 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, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
31 #include <sys/types.h>
35 #include "gdb_string.h"
36 #include "event-loop.h"
38 #if defined (TUI) || defined (GDBTK)
39 /* FIXME: cagney/2000-01-31: This #include is to allow older code such
40 as that found in the TUI to continue to build. */
41 #include "tui/tui-file.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 /* Whether this is the async version or not. The async version is
53 invoked on the command line with the -nw --async options. In this
54 version, the usual command_loop is substituted by and event loop which
55 processes UI events asynchronously. */
59 /* Has an interpreter been specified and if so, which. */
63 /* Whether this is the command line version or not */
66 /* Whether xdb commands will be handled */
69 /* Whether dbx commands will be handled */
72 struct ui_file
*gdb_stdout
;
73 struct ui_file
*gdb_stderr
;
74 struct ui_file
*gdb_stdlog
;
75 struct ui_file
*gdb_stdtarg
;
77 /* Used to initialize error() - defined in utils.c */
79 extern void error_init (void);
81 /* Whether to enable writing into executable and core files */
82 extern int write_files
;
84 static void print_gdb_help (struct ui_file
*);
86 /* These two are used to set the external editor commands when gdb is farming
87 out files to be edited by another program. */
89 extern int enable_external_editor
;
90 extern char *external_editor_command
;
93 #include <windows.h> /* for MAX_PATH */
94 #include <sys/cygwin.h> /* for cygwin32_conv_to_posix_path */
97 /* Call command_loop. If it happens to return, pass that through as a
98 non-zero return status. */
101 captured_command_loop (void *data
)
103 if (command_loop_hook
== NULL
)
106 command_loop_hook ();
107 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
108 would clean things up (restoring the cleanup chain) to the state
109 they were just prior to the call. Technically, this means that
110 the do_cleanups() below is redundant. Unfortunately, many FUNCs
111 are not that well behaved. do_cleanups should either be replaced
112 with a do_cleanups call (to cover the problem) or an assertion
113 check to detect bad FUNCs code. */
114 do_cleanups (ALL_CLEANUPS
);
115 /* If the command_loop returned, normally (rather than threw an
116 error) we try to quit. If the quit is aborted, catch_errors()
117 which called this catch the signal and restart the command
119 quit_command (NULL
, instream
== stdin
);
123 struct captured_main_args
130 captured_main (void *data
)
132 struct captured_main_args
*context
= data
;
133 int argc
= context
->argc
;
134 char **argv
= context
->argv
;
136 static int quiet
= 0;
137 static int batch
= 0;
139 /* Pointers to various arguments from command line. */
141 char *execarg
= NULL
;
142 char *corearg
= NULL
;
146 /* These are static so that we can take their address in an initializer. */
147 static int print_help
;
148 static int print_version
;
150 /* Pointers to all arguments of --command option. */
152 /* Allocated size of cmdarg. */
154 /* Number of elements of cmdarg used. */
157 /* Indices of all arguments of --directory option. */
159 /* Allocated size. */
161 /* Number of elements used. */
164 struct stat homebuf
, cwdbuf
;
165 char *homedir
, *homeinit
;
169 long time_at_startup
= get_run_time ();
171 START_PROGRESS (argv
[0], 0);
174 /* Do all Mac-specific setup. */
178 /* This needs to happen before the first use of malloc. */
179 init_malloc ((PTR
) NULL
);
181 #if defined (ALIGN_STACK_ON_STARTUP)
182 i
= (int) &count
& 0x3;
188 cmdarg
= (char **) xmalloc (cmdsize
* sizeof (*cmdarg
));
191 dirarg
= (char **) xmalloc (dirsize
* sizeof (*dirarg
));
195 line
= (char *) xmalloc (linesize
);
196 line
[0] = '\0'; /* Terminate saved (now empty) cmd line */
199 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
200 current_directory
= gdb_dirbuf
;
202 #if defined (TUI) || defined (GDBTK)
203 /* Older code uses the tui_file and fputs_unfiltered_hook(). It
204 should be using a customized UI_FILE object and re-initializing
205 within its own _initialize function. */
206 gdb_stdout
= tui_fileopen (stdout
);
207 gdb_stderr
= tui_fileopen (stderr
);
208 gdb_stdlog
= gdb_stdout
; /* for moment */
209 gdb_stdtarg
= gdb_stderr
; /* for moment */
211 gdb_stdout
= stdio_fileopen (stdout
);
212 gdb_stderr
= stdio_fileopen (stderr
);
213 gdb_stdlog
= gdb_stderr
; /* for moment */
214 gdb_stdtarg
= gdb_stderr
; /* for moment */
217 /* initialize error() */
220 /* Parse arguments and options. */
223 /* When var field is 0, use flag field to record the equivalent
224 short option (or arbitrary numbers starting at 10 for those
225 with no equivalent). */
226 static struct option long_options
[] =
228 {"async", no_argument
, &event_loop_p
, 1},
229 {"noasync", no_argument
, &event_loop_p
, 0},
231 {"tui", no_argument
, &tui_version
, 1},
233 {"xdb", no_argument
, &xdb_commands
, 1},
234 {"dbx", no_argument
, &dbx_commands
, 1},
235 {"readnow", no_argument
, &readnow_symbol_files
, 1},
236 {"r", no_argument
, &readnow_symbol_files
, 1},
237 {"mapped", no_argument
, &mapped_symbol_files
, 1},
238 {"m", no_argument
, &mapped_symbol_files
, 1},
239 {"quiet", no_argument
, &quiet
, 1},
240 {"q", no_argument
, &quiet
, 1},
241 {"silent", no_argument
, &quiet
, 1},
242 {"nx", no_argument
, &inhibit_gdbinit
, 1},
243 {"n", no_argument
, &inhibit_gdbinit
, 1},
244 {"batch", no_argument
, &batch
, 1},
245 {"epoch", no_argument
, &epoch_interface
, 1},
247 /* This is a synonym for "--annotate=1". --annotate is now preferred,
248 but keep this here for a long time because people will be running
249 emacses which use --fullname. */
250 {"fullname", no_argument
, 0, 'f'},
251 {"f", no_argument
, 0, 'f'},
253 {"annotate", required_argument
, 0, 12},
254 {"help", no_argument
, &print_help
, 1},
255 {"se", required_argument
, 0, 10},
256 {"symbols", required_argument
, 0, 's'},
257 {"s", required_argument
, 0, 's'},
258 {"exec", required_argument
, 0, 'e'},
259 {"e", required_argument
, 0, 'e'},
260 {"core", required_argument
, 0, 'c'},
261 {"c", required_argument
, 0, 'c'},
262 {"command", required_argument
, 0, 'x'},
263 {"version", no_argument
, &print_version
, 1},
264 {"x", required_argument
, 0, 'x'},
266 {"tclcommand", required_argument
, 0, 'z'},
267 {"enable-external-editor", no_argument
, 0, 'y'},
268 {"editor-command", required_argument
, 0, 'w'},
271 {"ui", required_argument
, 0, 'i'},
272 {"interpreter", required_argument
, 0, 'i'},
273 {"i", required_argument
, 0, 'i'},
275 {"directory", required_argument
, 0, 'd'},
276 {"d", required_argument
, 0, 'd'},
277 {"cd", required_argument
, 0, 11},
278 {"tty", required_argument
, 0, 't'},
279 {"baud", required_argument
, 0, 'b'},
280 {"b", required_argument
, 0, 'b'},
281 {"nw", no_argument
, &use_windows
, 0},
282 {"nowindows", no_argument
, &use_windows
, 0},
283 {"w", no_argument
, &use_windows
, 1},
284 {"windows", no_argument
, &use_windows
, 1},
285 {"statistics", no_argument
, 0, 13},
286 {"write", no_argument
, &write_files
, 1},
287 /* Allow machine descriptions to add more options... */
288 #ifdef ADDITIONAL_OPTIONS
291 {0, no_argument
, 0, 0}
298 c
= getopt_long_only (argc
, argv
, "",
299 long_options
, &option_index
);
303 /* Long option that takes an argument. */
304 if (c
== 0 && long_options
[option_index
].flag
== 0)
305 c
= long_options
[option_index
].val
;
310 /* Long option that just sets a flag. */
320 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
321 annotation_level
= atoi (optarg
);
324 /* Enable the display of both time and space usage. */
329 annotation_level
= 1;
330 /* We have probably been invoked from emacs. Disable window interface. */
343 cmdarg
[ncmd
++] = optarg
;
347 cmdarg
= (char **) xrealloc ((char *) cmdarg
,
348 cmdsize
* sizeof (*cmdarg
));
354 extern int gdbtk_test (char *);
355 if (!gdbtk_test (optarg
))
357 fprintf_unfiltered (gdb_stderr
, "%s: unable to load tclcommand file \"%s\"",
366 * This enables the edit/button in the main window, even
367 * when IDE_ENABLED is set to false. In this case you must
368 * use --tclcommand to specify a tcl/script to be called,
369 * Tcl/Variable to store the edit/command is:
372 enable_external_editor
= 1;
378 * if editor command is enabled, both flags are set
380 enable_external_editor
= 1;
381 external_editor_command
= xstrdup (optarg
);
387 interpreter_p
= optarg
;
391 dirarg
[ndir
++] = optarg
;
395 dirarg
= (char **) xrealloc ((char *) dirarg
,
396 dirsize
* sizeof (*dirarg
));
410 i
= strtol (optarg
, &p
, 0);
411 if (i
== 0 && p
== optarg
)
413 /* Don't use *_filtered or warning() (which relies on
414 current_target) until after initialize_all_files(). */
418 "warning: could not set baud rate to `%s'.\n", optarg
);
427 i
= strtol (optarg
, &p
, 0);
428 if (i
== 0 && p
== optarg
)
430 /* Don't use *_filtered or warning() (which relies on
431 current_target) until after initialize_all_files(). */
435 "warning: could not set timeout limit to `%s'.\n", optarg
);
441 #ifdef ADDITIONAL_OPTION_CASES
442 ADDITIONAL_OPTION_CASES
445 fprintf_unfiltered (gdb_stderr
,
446 "Use `%s --help' for a complete list of options.\n",
452 /* If --help or --version, disable window interface. */
453 if (print_help
|| print_version
)
457 /* Disable the TUI as well. */
463 /* An explicit --tui flag overrides the default UI, which is the
469 /* OK, that's all the options. The other arguments are filenames. */
471 for (; optind
< argc
; optind
++)
475 symarg
= argv
[optind
];
476 execarg
= argv
[optind
];
479 /* FIXME: The documentation says this can be a "ProcID". as well. */
480 corearg
= argv
[optind
];
483 fprintf_unfiltered (gdb_stderr
,
484 "Excess command line arguments ignored. (%s%s)\n",
485 argv
[optind
], (optind
== argc
- 1) ? "" : " ...");
493 /* Should this be moved to tui-top.c:_initialize_tui()? */
495 init_ui_hook
= tuiInit
;
498 /* Initialize all files. Give the interpreter a chance to take
499 control of the console via the init_ui_hook()) */
502 /* Do these (and anything which might call wrap_here or *_filtered)
503 after initialize_all_files. */
506 print_gdb_version (gdb_stdout
);
508 printf_filtered ("\n");
514 print_gdb_help (gdb_stdout
);
515 fputs_unfiltered ("\n", gdb_stdout
);
521 /* Print all the junk at the top, with trailing "..." if we are about
522 to read a symbol file (possibly slowly). */
523 print_gdb_version (gdb_stdout
);
525 printf_filtered ("..");
527 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
530 error_pre_print
= "\n\n";
531 quit_pre_print
= error_pre_print
;
533 /* We may get more than one warning, don't double space all of them... */
534 warning_pre_print
= "\nwarning: ";
536 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
537 *before* all the command line arguments are processed; it sets
538 global parameters, which are independent of what file you are
539 debugging or what directory you are in. */
542 char *tmp
= getenv ("HOME");
546 homedir
= (char *) alloca (MAX_PATH
+ 1);
547 cygwin32_conv_to_posix_path (tmp
, homedir
);
553 homedir
= getenv ("HOME");
557 homeinit
= (char *) alloca (strlen (homedir
) +
558 strlen (gdbinit
) + 10);
559 strcpy (homeinit
, homedir
);
560 strcat (homeinit
, "/");
561 strcat (homeinit
, gdbinit
);
563 if (!inhibit_gdbinit
)
565 catch_command_errors (source_command
, homeinit
, 0, RETURN_MASK_ALL
);
568 /* Do stats; no need to do them elsewhere since we'll only
569 need them if homedir is set. Make sure that they are
570 zero in case one of them fails (this guarantees that they
571 won't match if either exists). */
573 memset (&homebuf
, 0, sizeof (struct stat
));
574 memset (&cwdbuf
, 0, sizeof (struct stat
));
576 stat (homeinit
, &homebuf
);
577 stat (gdbinit
, &cwdbuf
); /* We'll only need this if
581 /* Now perform all the actions indicated by the arguments. */
584 catch_command_errors (cd_command
, cdarg
, 0, RETURN_MASK_ALL
);
587 for (i
= 0; i
< ndir
; i
++)
588 catch_command_errors (directory_command
, dirarg
[i
], 0, RETURN_MASK_ALL
);
593 && STREQ (execarg
, symarg
))
595 /* The exec file and the symbol-file are the same. If we can't
596 open it, better only print one error message.
597 catch_command_errors returns non-zero on success! */
598 if (catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
))
599 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
604 catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
);
606 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
609 /* After the symbol file has been read, print a newline to get us
610 beyond the copyright line... But errors should still set off
611 the error message with a (single) blank line. */
613 printf_filtered ("\n");
614 error_pre_print
= "\n";
615 quit_pre_print
= error_pre_print
;
616 warning_pre_print
= "\nwarning: ";
620 if (catch_command_errors (core_file_command
, corearg
, !batch
, RETURN_MASK_ALL
) == 0)
622 /* See if the core file is really a PID. */
623 if (isdigit (corearg
[0]))
624 catch_command_errors (attach_command
, corearg
, !batch
, RETURN_MASK_ALL
);
629 catch_command_errors (tty_command
, ttyarg
, !batch
, RETURN_MASK_ALL
);
631 #ifdef ADDITIONAL_OPTION_HANDLER
632 ADDITIONAL_OPTION_HANDLER
;
635 /* Error messages should no longer be distinguished with extra output. */
636 error_pre_print
= NULL
;
637 quit_pre_print
= NULL
;
638 warning_pre_print
= "warning: ";
640 /* Read the .gdbinit file in the current directory, *if* it isn't
641 the same as the $HOME/.gdbinit file (it should exist, also). */
644 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
, sizeof (struct stat
)))
645 if (!inhibit_gdbinit
)
647 catch_command_errors (source_command
, gdbinit
, 0, RETURN_MASK_ALL
);
650 for (i
= 0; i
< ncmd
; i
++)
653 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
654 expanded into a call to setjmp(). */
655 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
657 /* NOTE: I am commenting this out, because it is not clear
658 where this feature is used. It is very old and
659 undocumented. ezannoni: 1999-05-04 */
661 if (cmdarg
[i
][0] == '-' && cmdarg
[i
][1] == '\0')
662 read_command_file (stdin
);
665 source_command (cmdarg
[i
], !batch
);
666 do_cleanups (ALL_CLEANUPS
);
669 catch_command_errors (source_command
, cmdarg
[i
], !batch
, RETURN_MASK_ALL
);
673 /* Read in the old history after all the command files have been read. */
678 /* We have hit the end of the batch file. */
682 /* Do any host- or target-specific hacks. This is used for i960 targets
683 to force the user to set a nindy target and spec its parameters. */
685 #ifdef BEFORE_MAIN_LOOP_HOOK
686 BEFORE_MAIN_LOOP_HOOK
;
689 END_PROGRESS (argv
[0]);
691 /* Show time and/or space usage. */
695 long init_time
= get_run_time () - time_at_startup
;
697 printf_unfiltered ("Startup time: %ld.%06ld\n",
698 init_time
/ 1000000, init_time
% 1000000);
704 extern char **environ
;
705 char *lim
= (char *) sbrk (0);
707 printf_unfiltered ("Startup size: data size %ld\n",
708 (long) (lim
- (char *) &environ
));
712 /* The default command loop.
713 The WIN32 Gui calls this main to set up gdb's state, and
714 has its own command loop. */
715 #if !defined _WIN32 || defined __GNUC__
716 /* GUIs generally have their own command loop, mainloop, or
717 whatever. This is a good place to gain control because many
718 error conditions will end up here via longjmp(). */
720 /* FIXME: cagney/1999-11-06: The original main loop was like: */
723 if (!SET_TOP_LEVEL ())
725 do_cleanups (ALL_CLEANUPS
); /* Do complete cleanup */
726 /* GUIs generally have their own command loop, mainloop, or whatever.
727 This is a good place to gain control because many error
728 conditions will end up here via longjmp(). */
729 if (command_loop_hook
)
730 command_loop_hook ();
733 quit_command ((char *) 0, instream
== stdin
);
736 /* NOTE: If the command_loop() returned normally, the loop would
737 attempt to exit by calling the function quit_command(). That
738 function would either call exit() or throw an error returning
739 control to SET_TOP_LEVEL. */
740 /* NOTE: The function do_cleanups() was called once each time round
741 the loop. The usefulness of the call isn't clear. If an error
742 was thrown, everything would have already been cleaned up. If
743 command_loop() returned normally and quit_command() was called,
744 either exit() or error() (again cleaning up) would be called. */
746 /* NOTE: cagney/1999-11-07: There is probably no reason for not
747 moving this loop and the code found in captured_command_loop()
748 into the command_loop() proper. The main thing holding back that
749 change - SET_TOP_LEVEL() - has been eliminated. */
752 catch_errors (captured_command_loop
, 0, "", RETURN_MASK_ALL
);
755 /* No exit -- exit is through quit_command. */
759 main (int argc
, char **argv
)
761 struct captured_main_args args
;
764 catch_errors (captured_main
, &args
, "", RETURN_MASK_ALL
);
769 /* Don't use *_filtered for printing help. We don't want to prompt
770 for continue no matter how small the screen or how much we're going
774 print_gdb_help (struct ui_file
*stream
)
777 This is the GNU debugger. Usage:\n\n\
778 gdb [options] [executable-file [core-file or process-id]]\n\n\
782 --[no]async Enable (disable) asynchronous version of CLI\n\
785 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
786 --batch Exit after processing options.\n\
787 --cd=DIR Change current directory to DIR.\n\
788 --command=FILE Execute GDB commands from FILE.\n\
789 --core=COREFILE Analyze the core dump COREFILE.\n\
792 --dbx DBX compatibility mode.\n\
793 --directory=DIR Search for source files in DIR.\n\
794 --epoch Output information used by epoch emacs-GDB interface.\n\
795 --exec=EXECFILE Use EXECFILE as the executable.\n\
796 --fullname Output information used by emacs-GDB interface.\n\
797 --help Print this message.\n\
800 --interpreter=INTERP\n\
801 Select a specific interpreter / user interface\n\
804 --mapped Use mapped symbol files if supported on this system.\n\
805 --nw Do not use a window interface.\n\
806 --nx Do not read ", stream
);
807 fputs_unfiltered (gdbinit
, stream
);
808 fputs_unfiltered (" file.\n\
809 --quiet Do not print version number on startup.\n\
810 --readnow Fully read symbol files on first access.\n\
813 --se=FILE Use FILE as symbol file and executable file.\n\
814 --symbols=SYMFILE Read symbols from SYMFILE.\n\
815 --tty=TTY Use TTY for input/output by the program being debugged.\n\
819 --tui Use a terminal user interface.\n\
823 --version Print version information and then exit.\n\
824 -w Use a window interface.\n\
825 --write Set writing into executable and core files.\n\
826 --xdb XDB compatibility mode.\n\
828 #ifdef ADDITIONAL_OPTION_HELP
829 fputs_unfiltered (ADDITIONAL_OPTION_HELP
, stream
);
831 fputs_unfiltered ("\n\
832 For more information, type \"help\" from within GDB, or consult the\n\
833 GDB manual (available as on-line info or a printed manual).\n\
834 Report bugs to \"bug-gdb@gnu.org\".\