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 START_PROGRESS (argv
[0], 0);
163 /* Do all Mac-specific setup. */
167 /* This needs to happen before the first use of malloc. */
168 init_malloc ((PTR
) NULL
);
170 #if defined (ALIGN_STACK_ON_STARTUP)
171 i
= (int) &count
& 0x3;
177 cmdarg
= (char **) xmalloc (cmdsize
* sizeof (*cmdarg
));
180 dirarg
= (char **) xmalloc (dirsize
* sizeof (*dirarg
));
184 line
= (char *) xmalloc (linesize
);
185 line
[0] = '\0'; /* Terminate saved (now empty) cmd line */
188 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
189 current_directory
= gdb_dirbuf
;
191 gdb_stdout
= stdio_fileopen (stdout
);
192 gdb_stderr
= stdio_fileopen (stderr
);
193 gdb_stdlog
= gdb_stderr
; /* for moment */
194 gdb_stdtarg
= gdb_stderr
; /* for moment */
196 /* initialize error() */
199 /* Parse arguments and options. */
202 /* When var field is 0, use flag field to record the equivalent
203 short option (or arbitrary numbers starting at 10 for those
204 with no equivalent). */
205 static struct option long_options
[] =
207 {"async", no_argument
, &event_loop_p
, 1},
208 {"noasync", no_argument
, &event_loop_p
, 0},
210 {"tui", no_argument
, &tui_version
, 1},
212 {"xdb", no_argument
, &xdb_commands
, 1},
213 {"dbx", no_argument
, &dbx_commands
, 1},
214 {"readnow", no_argument
, &readnow_symbol_files
, 1},
215 {"r", no_argument
, &readnow_symbol_files
, 1},
216 {"mapped", no_argument
, &mapped_symbol_files
, 1},
217 {"m", no_argument
, &mapped_symbol_files
, 1},
218 {"quiet", no_argument
, &quiet
, 1},
219 {"q", no_argument
, &quiet
, 1},
220 {"silent", no_argument
, &quiet
, 1},
221 {"nx", no_argument
, &inhibit_gdbinit
, 1},
222 {"n", no_argument
, &inhibit_gdbinit
, 1},
223 {"batch", no_argument
, &batch
, 1},
224 {"epoch", no_argument
, &epoch_interface
, 1},
226 /* This is a synonym for "--annotate=1". --annotate is now preferred,
227 but keep this here for a long time because people will be running
228 emacses which use --fullname. */
229 {"fullname", no_argument
, 0, 'f'},
230 {"f", no_argument
, 0, 'f'},
232 {"annotate", required_argument
, 0, 12},
233 {"help", no_argument
, &print_help
, 1},
234 {"se", required_argument
, 0, 10},
235 {"symbols", required_argument
, 0, 's'},
236 {"s", required_argument
, 0, 's'},
237 {"exec", required_argument
, 0, 'e'},
238 {"e", required_argument
, 0, 'e'},
239 {"core", required_argument
, 0, 'c'},
240 {"c", required_argument
, 0, 'c'},
241 {"pid", required_argument
, 0, 'p'},
242 {"p", required_argument
, 0, 'p'},
243 {"command", required_argument
, 0, 'x'},
244 {"version", no_argument
, &print_version
, 1},
245 {"x", required_argument
, 0, 'x'},
247 {"tclcommand", required_argument
, 0, 'z'},
248 {"enable-external-editor", no_argument
, 0, 'y'},
249 {"editor-command", required_argument
, 0, 'w'},
251 {"ui", required_argument
, 0, 'i'},
252 {"interpreter", required_argument
, 0, 'i'},
253 {"i", required_argument
, 0, 'i'},
254 {"directory", required_argument
, 0, 'd'},
255 {"d", required_argument
, 0, 'd'},
256 {"cd", required_argument
, 0, 11},
257 {"tty", required_argument
, 0, 't'},
258 {"baud", required_argument
, 0, 'b'},
259 {"b", required_argument
, 0, 'b'},
260 {"nw", no_argument
, &use_windows
, 0},
261 {"nowindows", no_argument
, &use_windows
, 0},
262 {"w", no_argument
, &use_windows
, 1},
263 {"windows", no_argument
, &use_windows
, 1},
264 {"statistics", no_argument
, 0, 13},
265 {"write", no_argument
, &write_files
, 1},
266 {"args", no_argument
, &set_args
, 1},
267 /* Allow machine descriptions to add more options... */
268 #ifdef ADDITIONAL_OPTIONS
271 {0, no_argument
, 0, 0}
278 c
= getopt_long_only (argc
, argv
, "",
279 long_options
, &option_index
);
280 if (c
== EOF
|| set_args
)
283 /* Long option that takes an argument. */
284 if (c
== 0 && long_options
[option_index
].flag
== 0)
285 c
= long_options
[option_index
].val
;
290 /* Long option that just sets a flag. */
300 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
301 annotation_level
= atoi (optarg
);
304 /* Enable the display of both time and space usage. */
309 annotation_level
= 1;
310 /* We have probably been invoked from emacs. Disable window interface. */
323 /* "corearg" is shared by "--core" and "--pid" */
327 cmdarg
[ncmd
++] = optarg
;
331 cmdarg
= (char **) xrealloc ((char *) cmdarg
,
332 cmdsize
* sizeof (*cmdarg
));
338 extern int gdbtk_test (char *);
339 if (!gdbtk_test (optarg
))
341 fprintf_unfiltered (gdb_stderr
, "%s: unable to load tclcommand file \"%s\"",
348 /* Backwards compatibility only. */
352 external_editor_command
= xstrdup (optarg
);
357 interpreter_p
= optarg
;
360 dirarg
[ndir
++] = optarg
;
364 dirarg
= (char **) xrealloc ((char *) dirarg
,
365 dirsize
* sizeof (*dirarg
));
379 i
= strtol (optarg
, &p
, 0);
380 if (i
== 0 && p
== optarg
)
382 /* Don't use *_filtered or warning() (which relies on
383 current_target) until after initialize_all_files(). */
387 "warning: could not set baud rate to `%s'.\n", optarg
);
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 timeout limit to `%s'.\n", optarg
);
410 #ifdef ADDITIONAL_OPTION_CASES
411 ADDITIONAL_OPTION_CASES
414 fprintf_unfiltered (gdb_stderr
,
415 "Use `%s --help' for a complete list of options.\n",
421 /* If --help or --version, disable window interface. */
422 if (print_help
|| print_version
)
426 /* Disable the TUI as well. */
432 /* An explicit --tui flag overrides the default UI, which is the
440 /* The remaining options are the command-line options for the
441 inferior. The first one is the sym/exec file, and the rest
445 fprintf_unfiltered (gdb_stderr
,
446 "%s: `--args' specified but no program specified\n",
450 symarg
= argv
[optind
];
451 execarg
= argv
[optind
];
453 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
457 /* OK, that's all the options. The other arguments are filenames. */
459 for (; optind
< argc
; optind
++)
463 symarg
= argv
[optind
];
464 execarg
= argv
[optind
];
467 /* The documentation says this can be a "ProcID" as well.
468 We will try it as both a corefile and a pid. */
469 corearg
= argv
[optind
];
472 fprintf_unfiltered (gdb_stderr
,
473 "Excess command line arguments ignored. (%s%s)\n",
474 argv
[optind
], (optind
== argc
- 1) ? "" : " ...");
482 /* Initialize all files. Give the interpreter a chance to take
483 control of the console via the init_ui_hook()) */
486 /* Do these (and anything which might call wrap_here or *_filtered)
487 after initialize_all_files. */
490 print_gdb_version (gdb_stdout
);
492 printf_filtered ("\n");
498 print_gdb_help (gdb_stdout
);
499 fputs_unfiltered ("\n", gdb_stdout
);
505 /* Print all the junk at the top, with trailing "..." if we are about
506 to read a symbol file (possibly slowly). */
507 print_gdb_version (gdb_stdout
);
509 printf_filtered ("..");
511 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
514 error_pre_print
= "\n\n";
515 quit_pre_print
= error_pre_print
;
517 /* We may get more than one warning, don't double space all of them... */
518 warning_pre_print
= "\nwarning: ";
520 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
521 *before* all the command line arguments are processed; it sets
522 global parameters, which are independent of what file you are
523 debugging or what directory you are in. */
524 homedir
= getenv ("HOME");
527 homeinit
= (char *) alloca (strlen (homedir
) +
528 strlen (gdbinit
) + 10);
529 strcpy (homeinit
, homedir
);
530 strcat (homeinit
, "/");
531 strcat (homeinit
, gdbinit
);
533 if (!inhibit_gdbinit
)
535 catch_command_errors (source_command
, homeinit
, 0, RETURN_MASK_ALL
);
538 /* Do stats; no need to do them elsewhere since we'll only
539 need them if homedir is set. Make sure that they are
540 zero in case one of them fails (this guarantees that they
541 won't match if either exists). */
543 memset (&homebuf
, 0, sizeof (struct stat
));
544 memset (&cwdbuf
, 0, sizeof (struct stat
));
546 stat (homeinit
, &homebuf
);
547 stat (gdbinit
, &cwdbuf
); /* We'll only need this if
551 /* Now perform all the actions indicated by the arguments. */
554 catch_command_errors (cd_command
, cdarg
, 0, RETURN_MASK_ALL
);
557 for (i
= 0; i
< ndir
; i
++)
558 catch_command_errors (directory_command
, dirarg
[i
], 0, RETURN_MASK_ALL
);
563 && STREQ (execarg
, symarg
))
565 /* The exec file and the symbol-file are the same. If we can't
566 open it, better only print one error message.
567 catch_command_errors returns non-zero on success! */
568 if (catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
))
569 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
574 catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
);
576 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
579 /* After the symbol file has been read, print a newline to get us
580 beyond the copyright line... But errors should still set off
581 the error message with a (single) blank line. */
583 printf_filtered ("\n");
584 error_pre_print
= "\n";
585 quit_pre_print
= error_pre_print
;
586 warning_pre_print
= "\nwarning: ";
590 /* corearg may be either a corefile or a pid.
591 If its first character is a digit, try attach first
592 and then corefile. Otherwise try corefile first. */
594 if (isdigit (corearg
[0]))
596 if (catch_command_errors (attach_command
, corearg
,
597 !batch
, RETURN_MASK_ALL
) == 0)
598 catch_command_errors (core_file_command
, corearg
,
599 !batch
, RETURN_MASK_ALL
);
601 else /* Can't be a pid, better be a corefile. */
602 catch_command_errors (core_file_command
, corearg
,
603 !batch
, RETURN_MASK_ALL
);
607 catch_command_errors (tty_command
, ttyarg
, !batch
, RETURN_MASK_ALL
);
609 #ifdef ADDITIONAL_OPTION_HANDLER
610 ADDITIONAL_OPTION_HANDLER
;
613 /* Error messages should no longer be distinguished with extra output. */
614 error_pre_print
= NULL
;
615 quit_pre_print
= NULL
;
616 warning_pre_print
= "warning: ";
618 /* Read the .gdbinit file in the current directory, *if* it isn't
619 the same as the $HOME/.gdbinit file (it should exist, also). */
622 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
, sizeof (struct stat
)))
623 if (!inhibit_gdbinit
)
625 catch_command_errors (source_command
, gdbinit
, 0, RETURN_MASK_ALL
);
628 for (i
= 0; i
< ncmd
; i
++)
631 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
632 expanded into a call to setjmp(). */
633 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
635 /* NOTE: I am commenting this out, because it is not clear
636 where this feature is used. It is very old and
637 undocumented. ezannoni: 1999-05-04 */
639 if (cmdarg
[i
][0] == '-' && cmdarg
[i
][1] == '\0')
640 read_command_file (stdin
);
643 source_command (cmdarg
[i
], !batch
);
644 do_cleanups (ALL_CLEANUPS
);
647 catch_command_errors (source_command
, cmdarg
[i
], !batch
, RETURN_MASK_ALL
);
651 /* Read in the old history after all the command files have been read. */
656 /* We have hit the end of the batch file. */
660 /* Do any host- or target-specific hacks. This is used for i960 targets
661 to force the user to set a nindy target and spec its parameters. */
663 #ifdef BEFORE_MAIN_LOOP_HOOK
664 BEFORE_MAIN_LOOP_HOOK
;
667 END_PROGRESS (argv
[0]);
669 /* Show time and/or space usage. */
673 long init_time
= get_run_time () - time_at_startup
;
675 printf_unfiltered ("Startup time: %ld.%06ld\n",
676 init_time
/ 1000000, init_time
% 1000000);
682 extern char **environ
;
683 char *lim
= (char *) sbrk (0);
685 printf_unfiltered ("Startup size: data size %ld\n",
686 (long) (lim
- (char *) &environ
));
691 /* FIXME: cagney/1999-11-06: The original main loop was like: */
694 if (!SET_TOP_LEVEL ())
696 do_cleanups (ALL_CLEANUPS
); /* Do complete cleanup */
697 /* GUIs generally have their own command loop, mainloop, or whatever.
698 This is a good place to gain control because many error
699 conditions will end up here via longjmp(). */
700 if (command_loop_hook
)
701 command_loop_hook ();
704 quit_command ((char *) 0, instream
== stdin
);
707 /* NOTE: If the command_loop() returned normally, the loop would
708 attempt to exit by calling the function quit_command(). That
709 function would either call exit() or throw an error returning
710 control to SET_TOP_LEVEL. */
711 /* NOTE: The function do_cleanups() was called once each time round
712 the loop. The usefulness of the call isn't clear. If an error
713 was thrown, everything would have already been cleaned up. If
714 command_loop() returned normally and quit_command() was called,
715 either exit() or error() (again cleaning up) would be called. */
717 /* NOTE: cagney/1999-11-07: There is probably no reason for not
718 moving this loop and the code found in captured_command_loop()
719 into the command_loop() proper. The main thing holding back that
720 change - SET_TOP_LEVEL() - has been eliminated. */
723 catch_errors (captured_command_loop
, 0, "", RETURN_MASK_ALL
);
725 /* No exit -- exit is through quit_command. */
729 main (int argc
, char **argv
)
731 struct captured_main_args args
;
734 catch_errors (captured_main
, &args
, "", RETURN_MASK_ALL
);
739 /* Don't use *_filtered for printing help. We don't want to prompt
740 for continue no matter how small the screen or how much we're going
744 print_gdb_help (struct ui_file
*stream
)
747 This is the GNU debugger. Usage:\n\n\
748 gdb [options] [executable-file [core-file or process-id]]\n\
749 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
753 --args Arguments after executable-file are passed to inferior\n\
756 --[no]async Enable (disable) asynchronous version of CLI\n\
759 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
760 --batch Exit after processing options.\n\
761 --cd=DIR Change current directory to DIR.\n\
762 --command=FILE Execute GDB commands from FILE.\n\
763 --core=COREFILE Analyze the core dump COREFILE.\n\
764 --pid=PID Attach to running process PID.\n\
767 --dbx DBX compatibility mode.\n\
768 --directory=DIR Search for source files in DIR.\n\
769 --epoch Output information used by epoch emacs-GDB interface.\n\
770 --exec=EXECFILE Use EXECFILE as the executable.\n\
771 --fullname Output information used by emacs-GDB interface.\n\
772 --help Print this message.\n\
775 --interpreter=INTERP\n\
776 Select a specific interpreter / user interface\n\
779 --mapped Use mapped symbol files if supported on this system.\n\
780 --nw Do not use a window interface.\n\
781 --nx Do not read ", stream
);
782 fputs_unfiltered (gdbinit
, stream
);
783 fputs_unfiltered (" file.\n\
784 --quiet Do not print version number on startup.\n\
785 --readnow Fully read symbol files on first access.\n\
788 --se=FILE Use FILE as symbol file and executable file.\n\
789 --symbols=SYMFILE Read symbols from SYMFILE.\n\
790 --tty=TTY Use TTY for input/output by the program being debugged.\n\
794 --tui Use a terminal user interface.\n\
798 --version Print version information and then exit.\n\
799 -w Use a window interface.\n\
800 --write Set writing into executable and core files.\n\
801 --xdb XDB compatibility mode.\n\
803 #ifdef ADDITIONAL_OPTION_HELP
804 fputs_unfiltered (ADDITIONAL_OPTION_HELP
, stream
);
806 fputs_unfiltered ("\n\
807 For more information, type \"help\" from within GDB, or consult the\n\
808 GDB manual (available as on-line info or a printed manual).\n\
809 Report bugs to \"bug-gdb@gnu.org\".\