1 /* Top level stuff for GDB, the GNU debugger.
3 Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994,
4 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
33 #include <sys/types.h>
37 #include "gdb_string.h"
38 #include "event-loop.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. */
58 /* The selected interpreter. This will be used as a set command
59 variable, so it should always be malloc'ed - since
60 do_setshow_command will free it. */
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 /* System root path, used to find libraries etc. */
73 char *gdb_sysroot
= 0;
75 struct ui_file
*gdb_stdout
;
76 struct ui_file
*gdb_stderr
;
77 struct ui_file
*gdb_stdlog
;
78 struct ui_file
*gdb_stdtarg
;
80 /* Used to initialize error() - defined in utils.c */
82 extern void error_init (void);
84 /* Whether to enable writing into executable and core files */
85 extern int write_files
;
87 static void print_gdb_help (struct ui_file
*);
89 /* These two are used to set the external editor commands when gdb is farming
90 out files to be edited by another program. */
92 extern char *external_editor_command
;
94 /* Call command_loop. If it happens to return, pass that through as a
95 non-zero return status. */
98 captured_command_loop (void *data
)
100 current_interp_command_loop ();
101 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
102 would clean things up (restoring the cleanup chain) to the state
103 they were just prior to the call. Technically, this means that
104 the do_cleanups() below is redundant. Unfortunately, many FUNCs
105 are not that well behaved. do_cleanups should either be replaced
106 with a do_cleanups call (to cover the problem) or an assertion
107 check to detect bad FUNCs code. */
108 do_cleanups (ALL_CLEANUPS
);
109 /* If the command_loop returned, normally (rather than threw an
110 error) we try to quit. If the quit is aborted, catch_errors()
111 which called this catch the signal and restart the command
113 quit_command (NULL
, instream
== stdin
);
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);
171 /* This needs to happen before the first use of malloc. */
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 gdb_stdout
= stdio_fileopen (stdout
);
196 gdb_stderr
= stdio_fileopen (stderr
);
197 gdb_stdlog
= gdb_stderr
; /* for moment */
198 gdb_stdtarg
= gdb_stderr
; /* for moment */
200 /* initialize error() */
203 /* Set the sysroot path. */
204 #ifdef TARGET_SYSTEM_ROOT_RELOCATABLE
205 gdb_sysroot
= make_relative_prefix (argv
[0], BINDIR
, TARGET_SYSTEM_ROOT
);
211 if (stat (gdb_sysroot
, &s
) == 0)
212 if (S_ISDIR (s
.st_mode
))
218 gdb_sysroot
= TARGET_SYSTEM_ROOT
;
222 gdb_sysroot
= TARGET_SYSTEM_ROOT
;
224 #if defined (TARGET_SYSTEM_ROOT)
225 gdb_sysroot
= TARGET_SYSTEM_ROOT
;
231 /* There will always be an interpreter. Either the one passed into
232 this captured main (not yet implemented), or one specified by the
233 user at start up, or the console. Make life easier by always
234 initializing the interpreter to something. */
235 interpreter_p
= xstrdup (INTERP_CONSOLE
);
237 /* Parse arguments and options. */
240 /* When var field is 0, use flag field to record the equivalent
241 short option (or arbitrary numbers starting at 10 for those
242 with no equivalent). */
243 static struct option long_options
[] =
245 {"async", no_argument
, &event_loop_p
, 1},
246 {"noasync", no_argument
, &event_loop_p
, 0},
248 {"tui", no_argument
, &tui_version
, 1},
250 {"xdb", no_argument
, &xdb_commands
, 1},
251 {"dbx", no_argument
, &dbx_commands
, 1},
252 {"readnow", no_argument
, &readnow_symbol_files
, 1},
253 {"r", no_argument
, &readnow_symbol_files
, 1},
254 {"mapped", no_argument
, &mapped_symbol_files
, 1},
255 {"m", no_argument
, &mapped_symbol_files
, 1},
256 {"quiet", no_argument
, &quiet
, 1},
257 {"q", no_argument
, &quiet
, 1},
258 {"silent", no_argument
, &quiet
, 1},
259 {"nx", no_argument
, &inhibit_gdbinit
, 1},
260 {"n", no_argument
, &inhibit_gdbinit
, 1},
261 {"batch", no_argument
, &batch
, 1},
262 {"epoch", no_argument
, &epoch_interface
, 1},
264 /* This is a synonym for "--annotate=1". --annotate is now preferred,
265 but keep this here for a long time because people will be running
266 emacses which use --fullname. */
267 {"fullname", no_argument
, 0, 'f'},
268 {"f", no_argument
, 0, 'f'},
270 {"annotate", required_argument
, 0, 12},
271 {"help", no_argument
, &print_help
, 1},
272 {"se", required_argument
, 0, 10},
273 {"symbols", required_argument
, 0, 's'},
274 {"s", required_argument
, 0, 's'},
275 {"exec", required_argument
, 0, 'e'},
276 {"e", required_argument
, 0, 'e'},
277 {"core", required_argument
, 0, 'c'},
278 {"c", required_argument
, 0, 'c'},
279 {"pid", required_argument
, 0, 'p'},
280 {"p", required_argument
, 0, 'p'},
281 {"command", required_argument
, 0, 'x'},
282 {"version", no_argument
, &print_version
, 1},
283 {"x", required_argument
, 0, 'x'},
285 {"tclcommand", required_argument
, 0, 'z'},
286 {"enable-external-editor", no_argument
, 0, 'y'},
287 {"editor-command", required_argument
, 0, 'w'},
289 {"ui", required_argument
, 0, 'i'},
290 {"interpreter", required_argument
, 0, 'i'},
291 {"i", required_argument
, 0, 'i'},
292 {"directory", required_argument
, 0, 'd'},
293 {"d", required_argument
, 0, 'd'},
294 {"cd", required_argument
, 0, 11},
295 {"tty", required_argument
, 0, 't'},
296 {"baud", required_argument
, 0, 'b'},
297 {"b", required_argument
, 0, 'b'},
298 {"nw", no_argument
, &use_windows
, 0},
299 {"nowindows", no_argument
, &use_windows
, 0},
300 {"w", no_argument
, &use_windows
, 1},
301 {"windows", no_argument
, &use_windows
, 1},
302 {"statistics", no_argument
, 0, 13},
303 {"write", no_argument
, &write_files
, 1},
304 {"args", no_argument
, &set_args
, 1},
305 {0, no_argument
, 0, 0}
312 c
= getopt_long_only (argc
, argv
, "",
313 long_options
, &option_index
);
314 if (c
== EOF
|| set_args
)
317 /* Long option that takes an argument. */
318 if (c
== 0 && long_options
[option_index
].flag
== 0)
319 c
= long_options
[option_index
].val
;
324 /* Long option that just sets a flag. */
334 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
335 annotation_level
= atoi (optarg
);
338 /* Enable the display of both time and space usage. */
343 annotation_level
= 1;
344 /* We have probably been invoked from emacs. Disable window interface. */
357 /* "corearg" is shared by "--core" and "--pid" */
361 cmdarg
[ncmd
++] = optarg
;
365 cmdarg
= (char **) xrealloc ((char *) cmdarg
,
366 cmdsize
* sizeof (*cmdarg
));
372 extern int gdbtk_test (char *);
373 if (!gdbtk_test (optarg
))
375 fprintf_unfiltered (gdb_stderr
, _("%s: unable to load tclcommand file \"%s\""),
382 /* Backwards compatibility only. */
386 external_editor_command
= xstrdup (optarg
);
391 xfree (interpreter_p
);
392 interpreter_p
= xstrdup (optarg
);
395 dirarg
[ndir
++] = optarg
;
399 dirarg
= (char **) xrealloc ((char *) dirarg
,
400 dirsize
* sizeof (*dirarg
));
414 i
= strtol (optarg
, &p
, 0);
415 if (i
== 0 && p
== optarg
)
417 /* Don't use *_filtered or warning() (which relies on
418 current_target) until after initialize_all_files(). */
422 _("warning: could not set baud rate to `%s'.\n"), optarg
);
432 i
= strtol (optarg
, &p
, 0);
433 if (i
== 0 && p
== optarg
)
435 /* Don't use *_filtered or warning() (which relies on
436 current_target) until after initialize_all_files(). */
440 _("warning: could not set timeout limit to `%s'.\n"), optarg
);
447 fprintf_unfiltered (gdb_stderr
,
448 _("Use `%s --help' for a complete list of options.\n"),
454 /* If --help or --version, disable window interface. */
455 if (print_help
|| print_version
)
459 /* Disable the TUI as well. */
465 /* An explicit --tui flag overrides the default UI, which is the
473 /* The remaining options are the command-line options for the
474 inferior. The first one is the sym/exec file, and the rest
478 fprintf_unfiltered (gdb_stderr
,
479 _("%s: `--args' specified but no program specified\n"),
483 symarg
= argv
[optind
];
484 execarg
= argv
[optind
];
486 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
490 /* OK, that's all the options. The other arguments are filenames. */
492 for (; optind
< argc
; optind
++)
496 symarg
= argv
[optind
];
497 execarg
= argv
[optind
];
500 /* The documentation says this can be a "ProcID" as well.
501 We will try it as both a corefile and a pid. */
502 corearg
= argv
[optind
];
505 fprintf_unfiltered (gdb_stderr
,
506 _("Excess command line arguments ignored. (%s%s)\n"),
507 argv
[optind
], (optind
== argc
- 1) ? "" : " ...");
515 /* Initialize all files. Give the interpreter a chance to take
516 control of the console via the init_ui_hook()) */
519 /* Do these (and anything which might call wrap_here or *_filtered)
520 after initialize_all_files() but before the interpreter has been
521 installed. Otherwize the help/version messages will be eaten by
522 the interpreter's output handler. */
526 print_gdb_version (gdb_stdout
);
528 printf_filtered ("\n");
534 print_gdb_help (gdb_stdout
);
535 fputs_unfiltered ("\n", gdb_stdout
);
539 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
540 GDB retain the old MI1 interpreter startup behavior. Output the
541 copyright message before the interpreter is installed. That way
542 it isn't encapsulated in MI output. */
543 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
545 /* Print all the junk at the top, with trailing "..." if we are about
546 to read a symbol file (possibly slowly). */
547 print_gdb_version (gdb_stdout
);
549 printf_filtered ("..");
551 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
555 /* Install the default UI. All the interpreters should have had a
556 look at things by now. Initialize the default interpreter. */
560 struct interp
*interp
= interp_lookup (interpreter_p
);
563 fprintf_unfiltered (gdb_stderr
, "Interpreter `%s' unrecognized.\n",
568 if (!interp_set (interp
))
570 fprintf_unfiltered (gdb_stderr
,
571 "Interpreter `%s' failed to initialize.\n",
577 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
578 GDB retain the old MI1 interpreter startup behavior. Output the
579 copyright message after the interpreter is installed when it is
580 any sane interpreter. */
581 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
583 /* Print all the junk at the top, with trailing "..." if we are about
584 to read a symbol file (possibly slowly). */
585 print_gdb_version (gdb_stdout
);
587 printf_filtered ("..");
589 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
592 error_pre_print
= "\n\n";
593 quit_pre_print
= error_pre_print
;
595 /* We may get more than one warning, don't double space all of them... */
596 warning_pre_print
= _("\nwarning: ");
598 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
599 *before* all the command line arguments are processed; it sets
600 global parameters, which are independent of what file you are
601 debugging or what directory you are in. */
602 homedir
= getenv ("HOME");
605 homeinit
= (char *) alloca (strlen (homedir
) +
606 strlen (gdbinit
) + 10);
607 strcpy (homeinit
, homedir
);
608 strcat (homeinit
, "/");
609 strcat (homeinit
, gdbinit
);
611 if (!inhibit_gdbinit
)
613 catch_command_errors (source_command
, homeinit
, 0, RETURN_MASK_ALL
);
616 /* Do stats; no need to do them elsewhere since we'll only
617 need them if homedir is set. Make sure that they are
618 zero in case one of them fails (this guarantees that they
619 won't match if either exists). */
621 memset (&homebuf
, 0, sizeof (struct stat
));
622 memset (&cwdbuf
, 0, sizeof (struct stat
));
624 stat (homeinit
, &homebuf
);
625 stat (gdbinit
, &cwdbuf
); /* We'll only need this if
629 /* Now perform all the actions indicated by the arguments. */
632 catch_command_errors (cd_command
, cdarg
, 0, RETURN_MASK_ALL
);
635 for (i
= 0; i
< ndir
; i
++)
636 catch_command_errors (directory_command
, dirarg
[i
], 0, RETURN_MASK_ALL
);
641 && strcmp (execarg
, symarg
) == 0)
643 /* The exec file and the symbol-file are the same. If we can't
644 open it, better only print one error message.
645 catch_command_errors returns non-zero on success! */
646 if (catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
))
647 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
652 catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
);
654 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
657 /* After the symbol file has been read, print a newline to get us
658 beyond the copyright line... But errors should still set off
659 the error message with a (single) blank line. */
661 printf_filtered ("\n");
662 error_pre_print
= "\n";
663 quit_pre_print
= error_pre_print
;
664 warning_pre_print
= _("\nwarning: ");
668 /* corearg may be either a corefile or a pid.
669 If its first character is a digit, try attach first
670 and then corefile. Otherwise try corefile first. */
672 if (isdigit (corearg
[0]))
674 if (catch_command_errors (attach_command
, corearg
,
675 !batch
, RETURN_MASK_ALL
) == 0)
676 catch_command_errors (core_file_command
, corearg
,
677 !batch
, RETURN_MASK_ALL
);
679 else /* Can't be a pid, better be a corefile. */
680 catch_command_errors (core_file_command
, corearg
,
681 !batch
, RETURN_MASK_ALL
);
685 catch_command_errors (tty_command
, ttyarg
, !batch
, RETURN_MASK_ALL
);
687 /* Error messages should no longer be distinguished with extra output. */
688 error_pre_print
= NULL
;
689 quit_pre_print
= NULL
;
690 warning_pre_print
= _("warning: ");
692 /* Read the .gdbinit file in the current directory, *if* it isn't
693 the same as the $HOME/.gdbinit file (it should exist, also). */
696 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
, sizeof (struct stat
)))
697 if (!inhibit_gdbinit
)
699 catch_command_errors (source_command
, gdbinit
, 0, RETURN_MASK_ALL
);
702 for (i
= 0; i
< ncmd
; i
++)
705 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
706 expanded into a call to setjmp(). */
707 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
709 /* NOTE: I am commenting this out, because it is not clear
710 where this feature is used. It is very old and
711 undocumented. ezannoni: 1999-05-04 */
713 if (cmdarg
[i
][0] == '-' && cmdarg
[i
][1] == '\0')
714 read_command_file (stdin
);
717 source_command (cmdarg
[i
], !batch
);
718 do_cleanups (ALL_CLEANUPS
);
721 catch_command_errors (source_command
, cmdarg
[i
], !batch
, RETURN_MASK_ALL
);
725 /* Read in the old history after all the command files have been read. */
730 /* We have hit the end of the batch file. */
734 /* Do any host- or target-specific hacks. This is used for i960 targets
735 to force the user to set a nindy target and spec its parameters. */
737 #ifdef BEFORE_MAIN_LOOP_HOOK
738 BEFORE_MAIN_LOOP_HOOK
;
741 END_PROGRESS (argv
[0]);
743 /* Show time and/or space usage. */
747 long init_time
= get_run_time () - time_at_startup
;
749 printf_unfiltered (_("Startup time: %ld.%06ld\n"),
750 init_time
/ 1000000, init_time
% 1000000);
756 extern char **environ
;
757 char *lim
= (char *) sbrk (0);
759 printf_unfiltered (_("Startup size: data size %ld\n"),
760 (long) (lim
- (char *) &environ
));
765 /* FIXME: cagney/1999-11-06: The original main loop was like: */
768 if (!SET_TOP_LEVEL ())
770 do_cleanups (ALL_CLEANUPS
); /* Do complete cleanup */
771 /* GUIs generally have their own command loop, mainloop, or whatever.
772 This is a good place to gain control because many error
773 conditions will end up here via longjmp(). */
774 if (command_loop_hook
)
775 command_loop_hook ();
778 quit_command ((char *) 0, instream
== stdin
);
781 /* NOTE: If the command_loop() returned normally, the loop would
782 attempt to exit by calling the function quit_command(). That
783 function would either call exit() or throw an error returning
784 control to SET_TOP_LEVEL. */
785 /* NOTE: The function do_cleanups() was called once each time round
786 the loop. The usefulness of the call isn't clear. If an error
787 was thrown, everything would have already been cleaned up. If
788 command_loop() returned normally and quit_command() was called,
789 either exit() or error() (again cleaning up) would be called. */
791 /* NOTE: cagney/1999-11-07: There is probably no reason for not
792 moving this loop and the code found in captured_command_loop()
793 into the command_loop() proper. The main thing holding back that
794 change - SET_TOP_LEVEL() - has been eliminated. */
797 catch_errors (captured_command_loop
, 0, "", RETURN_MASK_ALL
);
799 /* No exit -- exit is through quit_command. */
803 gdb_main (struct captured_main_args
*args
)
805 use_windows
= args
->use_windows
;
806 catch_errors (captured_main
, args
, "", RETURN_MASK_ALL
);
811 /* Don't use *_filtered for printing help. We don't want to prompt
812 for continue no matter how small the screen or how much we're going
816 print_gdb_help (struct ui_file
*stream
)
818 fputs_unfiltered (_("\
819 This is the GNU debugger. Usage:\n\n\
820 gdb [options] [executable-file [core-file or process-id]]\n\
821 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
824 fputs_unfiltered (_("\
825 --args Arguments after executable-file are passed to inferior\n\
827 fputs_unfiltered (_("\
828 --[no]async Enable (disable) asynchronous version of CLI\n\
830 fputs_unfiltered (_("\
831 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
832 --batch Exit after processing options.\n\
833 --cd=DIR Change current directory to DIR.\n\
834 --command=FILE Execute GDB commands from FILE.\n\
835 --core=COREFILE Analyze the core dump COREFILE.\n\
836 --pid=PID Attach to running process PID.\n\
838 fputs_unfiltered (_("\
839 --dbx DBX compatibility mode.\n\
840 --directory=DIR Search for source files in DIR.\n\
841 --epoch Output information used by epoch emacs-GDB interface.\n\
842 --exec=EXECFILE Use EXECFILE as the executable.\n\
843 --fullname Output information used by emacs-GDB interface.\n\
844 --help Print this message.\n\
846 fputs_unfiltered (_("\
847 --interpreter=INTERP\n\
848 Select a specific interpreter / user interface\n\
850 fputs_unfiltered (_("\
851 --mapped Use mapped symbol files if supported on this system.\n\
852 --nw Do not use a window interface.\n\
853 --nx Do not read "), stream
);
854 fputs_unfiltered (gdbinit
, stream
);
855 fputs_unfiltered (_(" file.\n\
856 --quiet Do not print version number on startup.\n\
857 --readnow Fully read symbol files on first access.\n\
859 fputs_unfiltered (_("\
860 --se=FILE Use FILE as symbol file and executable file.\n\
861 --symbols=SYMFILE Read symbols from SYMFILE.\n\
862 --tty=TTY Use TTY for input/output by the program being debugged.\n\
865 fputs_unfiltered (_("\
866 --tui Use a terminal user interface.\n\
869 fputs_unfiltered (_("\
870 --version Print version information and then exit.\n\
871 -w Use a window interface.\n\
872 --write Set writing into executable and core files.\n\
873 --xdb XDB compatibility mode.\n\
875 fputs_unfiltered (_("\n\
876 For more information, type \"help\" from within GDB, or consult the\n\
877 GDB manual (available as on-line info or a printed manual).\n\
878 Report bugs to \"bug-gdb@gnu.org\".\
This page took 0.04839 seconds and 4 git commands to generate.