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. */
55 /* Has an interpreter been specified and if so, which. */
59 /* Whether this is the command line version or not */
62 /* Whether xdb commands will be handled */
65 /* Whether dbx commands will be handled */
68 struct ui_file
*gdb_stdout
;
69 struct ui_file
*gdb_stderr
;
70 struct ui_file
*gdb_stdlog
;
71 struct ui_file
*gdb_stdtarg
;
73 /* Used to initialize error() - defined in utils.c */
75 extern void error_init (void);
77 /* Whether to enable writing into executable and core files */
78 extern int write_files
;
80 static void print_gdb_help (struct ui_file
*);
82 /* These two are used to set the external editor commands when gdb is farming
83 out files to be edited by another program. */
85 extern char *external_editor_command
;
87 /* Call command_loop. If it happens to return, pass that through as a
88 non-zero return status. */
91 captured_command_loop (void *data
)
93 if (command_loop_hook
== NULL
)
97 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
98 would clean things up (restoring the cleanup chain) to the state
99 they were just prior to the call. Technically, this means that
100 the do_cleanups() below is redundant. Unfortunately, many FUNCs
101 are not that well behaved. do_cleanups should either be replaced
102 with a do_cleanups call (to cover the problem) or an assertion
103 check to detect bad FUNCs code. */
104 do_cleanups (ALL_CLEANUPS
);
105 /* If the command_loop returned, normally (rather than threw an
106 error) we try to quit. If the quit is aborted, catch_errors()
107 which called this catch the signal and restart the command
109 quit_command (NULL
, instream
== stdin
);
113 struct captured_main_args
120 captured_main (void *data
)
122 struct captured_main_args
*context
= data
;
123 int argc
= context
->argc
;
124 char **argv
= context
->argv
;
126 static int quiet
= 0;
127 static int batch
= 0;
128 static int set_args
= 0;
130 /* Pointers to various arguments from command line. */
132 char *execarg
= NULL
;
133 char *corearg
= NULL
;
137 /* These are static so that we can take their address in an initializer. */
138 static int print_help
;
139 static int print_version
;
141 /* Pointers to all arguments of --command option. */
143 /* Allocated size of cmdarg. */
145 /* Number of elements of cmdarg used. */
148 /* Indices of all arguments of --directory option. */
150 /* Allocated size. */
152 /* Number of elements used. */
155 struct stat homebuf
, cwdbuf
;
156 char *homedir
, *homeinit
;
160 long time_at_startup
= get_run_time ();
162 START_PROGRESS (argv
[0], 0);
165 /* Do all Mac-specific setup. */
169 /* This needs to happen before the first use of malloc. */
170 init_malloc ((PTR
) NULL
);
172 #if defined (ALIGN_STACK_ON_STARTUP)
173 i
= (int) &count
& 0x3;
179 cmdarg
= (char **) xmalloc (cmdsize
* sizeof (*cmdarg
));
182 dirarg
= (char **) xmalloc (dirsize
* sizeof (*dirarg
));
186 line
= (char *) xmalloc (linesize
);
187 line
[0] = '\0'; /* Terminate saved (now empty) cmd line */
190 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
191 current_directory
= gdb_dirbuf
;
193 gdb_stdout
= stdio_fileopen (stdout
);
194 gdb_stderr
= stdio_fileopen (stderr
);
195 gdb_stdlog
= gdb_stderr
; /* for moment */
196 gdb_stdtarg
= gdb_stderr
; /* for moment */
198 /* initialize error() */
201 /* Parse arguments and options. */
204 /* When var field is 0, use flag field to record the equivalent
205 short option (or arbitrary numbers starting at 10 for those
206 with no equivalent). */
207 static struct option long_options
[] =
209 {"async", no_argument
, &event_loop_p
, 1},
210 {"noasync", no_argument
, &event_loop_p
, 0},
212 {"tui", no_argument
, &tui_version
, 1},
214 {"xdb", no_argument
, &xdb_commands
, 1},
215 {"dbx", no_argument
, &dbx_commands
, 1},
216 {"readnow", no_argument
, &readnow_symbol_files
, 1},
217 {"r", no_argument
, &readnow_symbol_files
, 1},
218 {"mapped", no_argument
, &mapped_symbol_files
, 1},
219 {"m", no_argument
, &mapped_symbol_files
, 1},
220 {"quiet", no_argument
, &quiet
, 1},
221 {"q", no_argument
, &quiet
, 1},
222 {"silent", no_argument
, &quiet
, 1},
223 {"nx", no_argument
, &inhibit_gdbinit
, 1},
224 {"n", no_argument
, &inhibit_gdbinit
, 1},
225 {"batch", no_argument
, &batch
, 1},
226 {"epoch", no_argument
, &epoch_interface
, 1},
228 /* This is a synonym for "--annotate=1". --annotate is now preferred,
229 but keep this here for a long time because people will be running
230 emacses which use --fullname. */
231 {"fullname", no_argument
, 0, 'f'},
232 {"f", no_argument
, 0, 'f'},
234 {"annotate", required_argument
, 0, 12},
235 {"help", no_argument
, &print_help
, 1},
236 {"se", required_argument
, 0, 10},
237 {"symbols", required_argument
, 0, 's'},
238 {"s", required_argument
, 0, 's'},
239 {"exec", required_argument
, 0, 'e'},
240 {"e", required_argument
, 0, 'e'},
241 {"core", required_argument
, 0, 'c'},
242 {"c", required_argument
, 0, 'c'},
243 {"pid", required_argument
, 0, 'p'},
244 {"p", required_argument
, 0, 'p'},
245 {"command", required_argument
, 0, 'x'},
246 {"version", no_argument
, &print_version
, 1},
247 {"x", required_argument
, 0, 'x'},
249 {"tclcommand", required_argument
, 0, 'z'},
250 {"enable-external-editor", no_argument
, 0, 'y'},
251 {"editor-command", required_argument
, 0, 'w'},
254 {"ui", required_argument
, 0, 'i'},
255 {"interpreter", required_argument
, 0, 'i'},
256 {"i", required_argument
, 0, 'i'},
258 {"directory", required_argument
, 0, 'd'},
259 {"d", required_argument
, 0, 'd'},
260 {"cd", required_argument
, 0, 11},
261 {"tty", required_argument
, 0, 't'},
262 {"baud", required_argument
, 0, 'b'},
263 {"b", required_argument
, 0, 'b'},
264 {"nw", no_argument
, &use_windows
, 0},
265 {"nowindows", no_argument
, &use_windows
, 0},
266 {"w", no_argument
, &use_windows
, 1},
267 {"windows", no_argument
, &use_windows
, 1},
268 {"statistics", no_argument
, 0, 13},
269 {"write", no_argument
, &write_files
, 1},
270 {"args", no_argument
, &set_args
, 1},
271 /* Allow machine descriptions to add more options... */
272 #ifdef ADDITIONAL_OPTIONS
275 {0, no_argument
, 0, 0}
282 c
= getopt_long_only (argc
, argv
, "",
283 long_options
, &option_index
);
284 if (c
== EOF
|| set_args
)
287 /* Long option that takes an argument. */
288 if (c
== 0 && long_options
[option_index
].flag
== 0)
289 c
= long_options
[option_index
].val
;
294 /* Long option that just sets a flag. */
304 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
305 annotation_level
= atoi (optarg
);
308 /* Enable the display of both time and space usage. */
313 annotation_level
= 1;
314 /* We have probably been invoked from emacs. Disable window interface. */
327 /* "corearg" is shared by "--core" and "--pid" */
331 cmdarg
[ncmd
++] = optarg
;
335 cmdarg
= (char **) xrealloc ((char *) cmdarg
,
336 cmdsize
* sizeof (*cmdarg
));
342 extern int gdbtk_test (char *);
343 if (!gdbtk_test (optarg
))
345 fprintf_unfiltered (gdb_stderr
, "%s: unable to load tclcommand file \"%s\"",
352 /* Backwards compatibility only. */
356 external_editor_command
= xstrdup (optarg
);
362 interpreter_p
= optarg
;
366 dirarg
[ndir
++] = optarg
;
370 dirarg
= (char **) xrealloc ((char *) dirarg
,
371 dirsize
* sizeof (*dirarg
));
385 i
= strtol (optarg
, &p
, 0);
386 if (i
== 0 && p
== optarg
)
388 /* Don't use *_filtered or warning() (which relies on
389 current_target) until after initialize_all_files(). */
393 "warning: could not set baud rate to `%s'.\n", optarg
);
402 i
= strtol (optarg
, &p
, 0);
403 if (i
== 0 && p
== optarg
)
405 /* Don't use *_filtered or warning() (which relies on
406 current_target) until after initialize_all_files(). */
410 "warning: could not set timeout limit to `%s'.\n", optarg
);
416 #ifdef ADDITIONAL_OPTION_CASES
417 ADDITIONAL_OPTION_CASES
420 fprintf_unfiltered (gdb_stderr
,
421 "Use `%s --help' for a complete list of options.\n",
427 /* If --help or --version, disable window interface. */
428 if (print_help
|| print_version
)
432 /* Disable the TUI as well. */
438 /* An explicit --tui flag overrides the default UI, which is the
446 /* The remaining options are the command-line options for the
447 inferior. The first one is the sym/exec file, and the rest
451 fprintf_unfiltered (gdb_stderr
,
452 "%s: `--args' specified but no program specified\n",
456 symarg
= argv
[optind
];
457 execarg
= argv
[optind
];
459 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
463 /* OK, that's all the options. The other arguments are filenames. */
465 for (; optind
< argc
; optind
++)
469 symarg
= argv
[optind
];
470 execarg
= argv
[optind
];
473 /* The documentation says this can be a "ProcID" as well.
474 We will try it as both a corefile and a pid. */
475 corearg
= argv
[optind
];
478 fprintf_unfiltered (gdb_stderr
,
479 "Excess command line arguments ignored. (%s%s)\n",
480 argv
[optind
], (optind
== argc
- 1) ? "" : " ...");
488 /* Initialize all files. Give the interpreter a chance to take
489 control of the console via the init_ui_hook()) */
492 /* Do these (and anything which might call wrap_here or *_filtered)
493 after initialize_all_files. */
496 print_gdb_version (gdb_stdout
);
498 printf_filtered ("\n");
504 print_gdb_help (gdb_stdout
);
505 fputs_unfiltered ("\n", gdb_stdout
);
511 /* Print all the junk at the top, with trailing "..." if we are about
512 to read a symbol file (possibly slowly). */
513 print_gdb_version (gdb_stdout
);
515 printf_filtered ("..");
517 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
520 error_pre_print
= "\n\n";
521 quit_pre_print
= error_pre_print
;
523 /* We may get more than one warning, don't double space all of them... */
524 warning_pre_print
= "\nwarning: ";
526 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
527 *before* all the command line arguments are processed; it sets
528 global parameters, which are independent of what file you are
529 debugging or what directory you are in. */
530 homedir
= getenv ("HOME");
533 homeinit
= (char *) alloca (strlen (homedir
) +
534 strlen (gdbinit
) + 10);
535 strcpy (homeinit
, homedir
);
536 strcat (homeinit
, "/");
537 strcat (homeinit
, gdbinit
);
539 if (!inhibit_gdbinit
)
541 catch_command_errors (source_command
, homeinit
, 0, RETURN_MASK_ALL
);
544 /* Do stats; no need to do them elsewhere since we'll only
545 need them if homedir is set. Make sure that they are
546 zero in case one of them fails (this guarantees that they
547 won't match if either exists). */
549 memset (&homebuf
, 0, sizeof (struct stat
));
550 memset (&cwdbuf
, 0, sizeof (struct stat
));
552 stat (homeinit
, &homebuf
);
553 stat (gdbinit
, &cwdbuf
); /* We'll only need this if
557 /* Now perform all the actions indicated by the arguments. */
560 catch_command_errors (cd_command
, cdarg
, 0, RETURN_MASK_ALL
);
563 for (i
= 0; i
< ndir
; i
++)
564 catch_command_errors (directory_command
, dirarg
[i
], 0, RETURN_MASK_ALL
);
569 && STREQ (execarg
, symarg
))
571 /* The exec file and the symbol-file are the same. If we can't
572 open it, better only print one error message.
573 catch_command_errors returns non-zero on success! */
574 if (catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
))
575 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
580 catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
);
582 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
585 /* After the symbol file has been read, print a newline to get us
586 beyond the copyright line... But errors should still set off
587 the error message with a (single) blank line. */
589 printf_filtered ("\n");
590 error_pre_print
= "\n";
591 quit_pre_print
= error_pre_print
;
592 warning_pre_print
= "\nwarning: ";
596 /* corearg may be either a corefile or a pid.
597 If its first character is a digit, try attach first
598 and then corefile. Otherwise try corefile first. */
600 if (isdigit (corearg
[0]))
602 if (catch_command_errors (attach_command
, corearg
,
603 !batch
, RETURN_MASK_ALL
) == 0)
604 catch_command_errors (core_file_command
, corearg
,
605 !batch
, RETURN_MASK_ALL
);
607 else /* Can't be a pid, better be a corefile. */
608 catch_command_errors (core_file_command
, corearg
,
609 !batch
, RETURN_MASK_ALL
);
613 catch_command_errors (tty_command
, ttyarg
, !batch
, RETURN_MASK_ALL
);
615 #ifdef ADDITIONAL_OPTION_HANDLER
616 ADDITIONAL_OPTION_HANDLER
;
619 /* Error messages should no longer be distinguished with extra output. */
620 error_pre_print
= NULL
;
621 quit_pre_print
= NULL
;
622 warning_pre_print
= "warning: ";
624 /* Read the .gdbinit file in the current directory, *if* it isn't
625 the same as the $HOME/.gdbinit file (it should exist, also). */
628 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
, sizeof (struct stat
)))
629 if (!inhibit_gdbinit
)
631 catch_command_errors (source_command
, gdbinit
, 0, RETURN_MASK_ALL
);
634 for (i
= 0; i
< ncmd
; i
++)
637 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
638 expanded into a call to setjmp(). */
639 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
641 /* NOTE: I am commenting this out, because it is not clear
642 where this feature is used. It is very old and
643 undocumented. ezannoni: 1999-05-04 */
645 if (cmdarg
[i
][0] == '-' && cmdarg
[i
][1] == '\0')
646 read_command_file (stdin
);
649 source_command (cmdarg
[i
], !batch
);
650 do_cleanups (ALL_CLEANUPS
);
653 catch_command_errors (source_command
, cmdarg
[i
], !batch
, RETURN_MASK_ALL
);
657 /* Read in the old history after all the command files have been read. */
662 /* We have hit the end of the batch file. */
666 /* Do any host- or target-specific hacks. This is used for i960 targets
667 to force the user to set a nindy target and spec its parameters. */
669 #ifdef BEFORE_MAIN_LOOP_HOOK
670 BEFORE_MAIN_LOOP_HOOK
;
673 END_PROGRESS (argv
[0]);
675 /* Show time and/or space usage. */
679 long init_time
= get_run_time () - time_at_startup
;
681 printf_unfiltered ("Startup time: %ld.%06ld\n",
682 init_time
/ 1000000, init_time
% 1000000);
688 extern char **environ
;
689 char *lim
= (char *) sbrk (0);
691 printf_unfiltered ("Startup size: data size %ld\n",
692 (long) (lim
- (char *) &environ
));
697 /* FIXME: cagney/1999-11-06: The original main loop was like: */
700 if (!SET_TOP_LEVEL ())
702 do_cleanups (ALL_CLEANUPS
); /* Do complete cleanup */
703 /* GUIs generally have their own command loop, mainloop, or whatever.
704 This is a good place to gain control because many error
705 conditions will end up here via longjmp(). */
706 if (command_loop_hook
)
707 command_loop_hook ();
710 quit_command ((char *) 0, instream
== stdin
);
713 /* NOTE: If the command_loop() returned normally, the loop would
714 attempt to exit by calling the function quit_command(). That
715 function would either call exit() or throw an error returning
716 control to SET_TOP_LEVEL. */
717 /* NOTE: The function do_cleanups() was called once each time round
718 the loop. The usefulness of the call isn't clear. If an error
719 was thrown, everything would have already been cleaned up. If
720 command_loop() returned normally and quit_command() was called,
721 either exit() or error() (again cleaning up) would be called. */
723 /* NOTE: cagney/1999-11-07: There is probably no reason for not
724 moving this loop and the code found in captured_command_loop()
725 into the command_loop() proper. The main thing holding back that
726 change - SET_TOP_LEVEL() - has been eliminated. */
729 catch_errors (captured_command_loop
, 0, "", RETURN_MASK_ALL
);
731 /* No exit -- exit is through quit_command. */
735 main (int argc
, char **argv
)
737 struct captured_main_args args
;
740 catch_errors (captured_main
, &args
, "", RETURN_MASK_ALL
);
745 /* Don't use *_filtered for printing help. We don't want to prompt
746 for continue no matter how small the screen or how much we're going
750 print_gdb_help (struct ui_file
*stream
)
753 This is the GNU debugger. Usage:\n\n\
754 gdb [options] [executable-file [core-file or process-id]]\n\
755 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
759 --args Arguments after executable-file are passed to inferior\n\
762 --[no]async Enable (disable) asynchronous version of CLI\n\
765 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
766 --batch Exit after processing options.\n\
767 --cd=DIR Change current directory to DIR.\n\
768 --command=FILE Execute GDB commands from FILE.\n\
769 --core=COREFILE Analyze the core dump COREFILE.\n\
770 --pid=PID Attach to running process PID.\n\
773 --dbx DBX compatibility mode.\n\
774 --directory=DIR Search for source files in DIR.\n\
775 --epoch Output information used by epoch emacs-GDB interface.\n\
776 --exec=EXECFILE Use EXECFILE as the executable.\n\
777 --fullname Output information used by emacs-GDB interface.\n\
778 --help Print this message.\n\
781 --interpreter=INTERP\n\
782 Select a specific interpreter / user interface\n\
785 --mapped Use mapped symbol files if supported on this system.\n\
786 --nw Do not use a window interface.\n\
787 --nx Do not read ", stream
);
788 fputs_unfiltered (gdbinit
, stream
);
789 fputs_unfiltered (" file.\n\
790 --quiet Do not print version number on startup.\n\
791 --readnow Fully read symbol files on first access.\n\
794 --se=FILE Use FILE as symbol file and executable file.\n\
795 --symbols=SYMFILE Read symbols from SYMFILE.\n\
796 --tty=TTY Use TTY for input/output by the program being debugged.\n\
800 --tui Use a terminal user interface.\n\
804 --version Print version information and then exit.\n\
805 -w Use a window interface.\n\
806 --write Set writing into executable and core files.\n\
807 --xdb XDB compatibility mode.\n\
809 #ifdef ADDITIONAL_OPTION_HELP
810 fputs_unfiltered (ADDITIONAL_OPTION_HELP
, stream
);
812 fputs_unfiltered ("\n\
813 For more information, type \"help\" from within GDB, or consult the\n\
814 GDB manual (available as on-line info or a printed manual).\n\
815 Report bugs to \"bug-gdb@gnu.org\".\