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 xdb commands will be handled */
66 /* Whether dbx commands will be handled */
69 /* System root path, used to find libraries etc. */
70 char *gdb_sysroot
= 0;
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 char *external_editor_command
;
91 /* Call command_loop. If it happens to return, pass that through as a
92 non-zero return status. */
95 captured_command_loop (void *data
)
97 current_interp_command_loop ();
98 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
99 would clean things up (restoring the cleanup chain) to the state
100 they were just prior to the call. Technically, this means that
101 the do_cleanups() below is redundant. Unfortunately, many FUNCs
102 are not that well behaved. do_cleanups should either be replaced
103 with a do_cleanups call (to cover the problem) or an assertion
104 check to detect bad FUNCs code. */
105 do_cleanups (ALL_CLEANUPS
);
106 /* If the command_loop returned, normally (rather than threw an
107 error) we try to quit. If the quit is aborted, catch_errors()
108 which called this catch the signal and restart the command
110 quit_command (NULL
, instream
== stdin
);
115 captured_main (void *data
)
117 struct captured_main_args
*context
= data
;
118 int argc
= context
->argc
;
119 char **argv
= context
->argv
;
121 static int quiet
= 0;
122 static int batch
= 0;
123 static int set_args
= 0;
125 /* Pointers to various arguments from command line. */
127 char *execarg
= NULL
;
128 char *corearg
= NULL
;
132 /* These are static so that we can take their address in an initializer. */
133 static int print_help
;
134 static int print_version
;
136 /* Pointers to all arguments of --command option. */
138 /* Allocated size of cmdarg. */
140 /* Number of elements of cmdarg used. */
143 /* Indices of all arguments of --directory option. */
145 /* Allocated size. */
147 /* Number of elements used. */
150 struct stat homebuf
, cwdbuf
;
151 char *homedir
, *homeinit
;
155 long time_at_startup
= get_run_time ();
157 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
158 setlocale (LC_MESSAGES
, "");
160 #if defined (HAVE_SETLOCALE)
161 setlocale (LC_CTYPE
, "");
163 bindtextdomain (PACKAGE
, LOCALEDIR
);
164 textdomain (PACKAGE
);
166 START_PROGRESS (argv
[0], 0);
168 /* This needs to happen before the first use of malloc. */
171 #if defined (ALIGN_STACK_ON_STARTUP)
172 i
= (int) &count
& 0x3;
178 cmdarg
= (char **) xmalloc (cmdsize
* sizeof (*cmdarg
));
181 dirarg
= (char **) xmalloc (dirsize
* sizeof (*dirarg
));
185 line
= (char *) xmalloc (linesize
);
186 line
[0] = '\0'; /* Terminate saved (now empty) cmd line */
189 getcwd (gdb_dirbuf
, sizeof (gdb_dirbuf
));
190 current_directory
= gdb_dirbuf
;
192 gdb_stdout
= stdio_fileopen (stdout
);
193 gdb_stderr
= stdio_fileopen (stderr
);
194 gdb_stdlog
= gdb_stderr
; /* for moment */
195 gdb_stdtarg
= gdb_stderr
; /* for moment */
197 /* initialize error() */
200 /* Set the sysroot path. */
201 #ifdef TARGET_SYSTEM_ROOT_RELOCATABLE
202 gdb_sysroot
= make_relative_prefix (argv
[0], BINDIR
, TARGET_SYSTEM_ROOT
);
208 if (stat (gdb_sysroot
, &s
) == 0)
209 if (S_ISDIR (s
.st_mode
))
215 gdb_sysroot
= TARGET_SYSTEM_ROOT
;
219 gdb_sysroot
= TARGET_SYSTEM_ROOT
;
221 #if defined (TARGET_SYSTEM_ROOT)
222 gdb_sysroot
= TARGET_SYSTEM_ROOT
;
228 /* There will always be an interpreter. Either the one passed into
229 this captured main, or one specified by the user at start up, or
230 the console. Initialize the interpreter to the one requested by
232 interpreter_p
= xstrdup (context
->interpreter_p
);
234 /* Parse arguments and options. */
237 /* When var field is 0, use flag field to record the equivalent
238 short option (or arbitrary numbers starting at 10 for those
239 with no equivalent). */
249 static struct option long_options
[] =
251 {"async", no_argument
, &event_loop_p
, 1},
252 {"noasync", no_argument
, &event_loop_p
, 0},
254 {"tui", no_argument
, 0, OPT_TUI
},
256 {"xdb", no_argument
, &xdb_commands
, 1},
257 {"dbx", no_argument
, &dbx_commands
, 1},
258 {"readnow", no_argument
, &readnow_symbol_files
, 1},
259 {"r", no_argument
, &readnow_symbol_files
, 1},
260 {"mapped", no_argument
, &mapped_symbol_files
, 1},
261 {"m", no_argument
, &mapped_symbol_files
, 1},
262 {"quiet", no_argument
, &quiet
, 1},
263 {"q", no_argument
, &quiet
, 1},
264 {"silent", no_argument
, &quiet
, 1},
265 {"nx", no_argument
, &inhibit_gdbinit
, 1},
266 {"n", no_argument
, &inhibit_gdbinit
, 1},
267 {"batch", no_argument
, &batch
, 1},
268 {"epoch", no_argument
, &epoch_interface
, 1},
270 /* This is a synonym for "--annotate=1". --annotate is now preferred,
271 but keep this here for a long time because people will be running
272 emacses which use --fullname. */
273 {"fullname", no_argument
, 0, 'f'},
274 {"f", no_argument
, 0, 'f'},
276 {"annotate", required_argument
, 0, OPT_ANNOTATE
},
277 {"help", no_argument
, &print_help
, 1},
278 {"se", required_argument
, 0, OPT_SE
},
279 {"symbols", required_argument
, 0, 's'},
280 {"s", required_argument
, 0, 's'},
281 {"exec", required_argument
, 0, 'e'},
282 {"e", required_argument
, 0, 'e'},
283 {"core", required_argument
, 0, 'c'},
284 {"c", required_argument
, 0, 'c'},
285 {"pid", required_argument
, 0, 'p'},
286 {"p", required_argument
, 0, 'p'},
287 {"command", required_argument
, 0, 'x'},
288 {"version", no_argument
, &print_version
, 1},
289 {"x", required_argument
, 0, 'x'},
291 {"tclcommand", required_argument
, 0, 'z'},
292 {"enable-external-editor", no_argument
, 0, 'y'},
293 {"editor-command", required_argument
, 0, 'w'},
295 {"ui", required_argument
, 0, 'i'},
296 {"interpreter", required_argument
, 0, 'i'},
297 {"i", required_argument
, 0, 'i'},
298 {"directory", required_argument
, 0, 'd'},
299 {"d", required_argument
, 0, 'd'},
300 {"cd", required_argument
, 0, OPT_CD
},
301 {"tty", required_argument
, 0, 't'},
302 {"baud", required_argument
, 0, 'b'},
303 {"b", required_argument
, 0, 'b'},
304 {"nw", no_argument
, NULL
, OPT_NOWINDOWS
},
305 {"nowindows", no_argument
, NULL
, OPT_NOWINDOWS
},
306 {"w", no_argument
, NULL
, OPT_WINDOWS
},
307 {"windows", no_argument
, NULL
, OPT_WINDOWS
},
308 {"statistics", no_argument
, 0, OPT_STATISTICS
},
309 {"write", no_argument
, &write_files
, 1},
310 {"args", no_argument
, &set_args
, 1},
311 {0, no_argument
, 0, 0}
318 c
= getopt_long_only (argc
, argv
, "",
319 long_options
, &option_index
);
320 if (c
== EOF
|| set_args
)
323 /* Long option that takes an argument. */
324 if (c
== 0 && long_options
[option_index
].flag
== 0)
325 c
= long_options
[option_index
].val
;
330 /* Long option that just sets a flag. */
340 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
341 annotation_level
= atoi (optarg
);
344 /* Enable the display of both time and space usage. */
349 /* --tui is equivalent to -i=tui. */
350 xfree (interpreter_p
);
351 interpreter_p
= xstrdup ("tui");
354 /* FIXME: cagney/2003-03-01: Not sure if this option is
355 actually useful, and if it is, what it should do. */
359 /* -nw is equivalent to -i=console. */
360 xfree (interpreter_p
);
361 interpreter_p
= xstrdup (INTERP_CONSOLE
);
365 annotation_level
= 1;
366 /* We have probably been invoked from emacs. Disable window interface. */
379 /* "corearg" is shared by "--core" and "--pid" */
383 cmdarg
[ncmd
++] = optarg
;
387 cmdarg
= (char **) xrealloc ((char *) cmdarg
,
388 cmdsize
* sizeof (*cmdarg
));
394 extern int gdbtk_test (char *);
395 if (!gdbtk_test (optarg
))
397 fprintf_unfiltered (gdb_stderr
, _("%s: unable to load tclcommand file \"%s\""),
404 /* Backwards compatibility only. */
408 external_editor_command
= xstrdup (optarg
);
413 xfree (interpreter_p
);
414 interpreter_p
= xstrdup (optarg
);
417 dirarg
[ndir
++] = optarg
;
421 dirarg
= (char **) xrealloc ((char *) dirarg
,
422 dirsize
* sizeof (*dirarg
));
436 i
= strtol (optarg
, &p
, 0);
437 if (i
== 0 && p
== optarg
)
439 /* Don't use *_filtered or warning() (which relies on
440 current_target) until after initialize_all_files(). */
444 _("warning: could not set baud rate to `%s'.\n"), optarg
);
454 i
= strtol (optarg
, &p
, 0);
455 if (i
== 0 && p
== optarg
)
457 /* Don't use *_filtered or warning() (which relies on
458 current_target) until after initialize_all_files(). */
462 _("warning: could not set timeout limit to `%s'.\n"), optarg
);
469 fprintf_unfiltered (gdb_stderr
,
470 _("Use `%s --help' for a complete list of options.\n"),
476 /* If --help or --version, disable window interface. */
477 if (print_help
|| print_version
)
484 /* The remaining options are the command-line options for the
485 inferior. The first one is the sym/exec file, and the rest
489 fprintf_unfiltered (gdb_stderr
,
490 _("%s: `--args' specified but no program specified\n"),
494 symarg
= argv
[optind
];
495 execarg
= argv
[optind
];
497 set_inferior_args_vector (argc
- optind
, &argv
[optind
]);
501 /* OK, that's all the options. The other arguments are filenames. */
503 for (; optind
< argc
; optind
++)
507 symarg
= argv
[optind
];
508 execarg
= argv
[optind
];
511 /* The documentation says this can be a "ProcID" as well.
512 We will try it as both a corefile and a pid. */
513 corearg
= argv
[optind
];
516 fprintf_unfiltered (gdb_stderr
,
517 _("Excess command line arguments ignored. (%s%s)\n"),
518 argv
[optind
], (optind
== argc
- 1) ? "" : " ...");
526 /* Initialize all files. Give the interpreter a chance to take
527 control of the console via the init_ui_hook()) */
530 /* Do these (and anything which might call wrap_here or *_filtered)
531 after initialize_all_files() but before the interpreter has been
532 installed. Otherwize the help/version messages will be eaten by
533 the interpreter's output handler. */
537 print_gdb_version (gdb_stdout
);
539 printf_filtered ("\n");
545 print_gdb_help (gdb_stdout
);
546 fputs_unfiltered ("\n", gdb_stdout
);
550 /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
551 GDB retain the old MI1 interpreter startup behavior. Output the
552 copyright message before the interpreter is installed. That way
553 it isn't encapsulated in MI output. */
554 if (!quiet
&& strcmp (interpreter_p
, INTERP_MI1
) == 0)
556 /* Print all the junk at the top, with trailing "..." if we are about
557 to read a symbol file (possibly slowly). */
558 print_gdb_version (gdb_stdout
);
560 printf_filtered ("..");
562 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
566 /* Install the default UI. All the interpreters should have had a
567 look at things by now. Initialize the default interpreter. */
571 struct interp
*interp
= interp_lookup (interpreter_p
);
573 error ("Interpreter `%s' unrecognized", interpreter_p
);
575 if (!interp_set (interp
))
577 fprintf_unfiltered (gdb_stderr
,
578 "Interpreter `%s' failed to initialize.\n",
584 /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
585 GDB retain the old MI1 interpreter startup behavior. Output the
586 copyright message after the interpreter is installed when it is
587 any sane interpreter. */
588 if (!quiet
&& !current_interp_named_p (INTERP_MI1
))
590 /* Print all the junk at the top, with trailing "..." if we are about
591 to read a symbol file (possibly slowly). */
592 print_gdb_version (gdb_stdout
);
594 printf_filtered ("..");
596 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
599 error_pre_print
= "\n\n";
600 quit_pre_print
= error_pre_print
;
602 /* We may get more than one warning, don't double space all of them... */
603 warning_pre_print
= _("\nwarning: ");
605 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
606 *before* all the command line arguments are processed; it sets
607 global parameters, which are independent of what file you are
608 debugging or what directory you are in. */
609 homedir
= getenv ("HOME");
612 homeinit
= (char *) alloca (strlen (homedir
) +
613 strlen (gdbinit
) + 10);
614 strcpy (homeinit
, homedir
);
615 strcat (homeinit
, "/");
616 strcat (homeinit
, gdbinit
);
618 if (!inhibit_gdbinit
)
620 catch_command_errors (source_command
, homeinit
, 0, RETURN_MASK_ALL
);
623 /* Do stats; no need to do them elsewhere since we'll only
624 need them if homedir is set. Make sure that they are
625 zero in case one of them fails (this guarantees that they
626 won't match if either exists). */
628 memset (&homebuf
, 0, sizeof (struct stat
));
629 memset (&cwdbuf
, 0, sizeof (struct stat
));
631 stat (homeinit
, &homebuf
);
632 stat (gdbinit
, &cwdbuf
); /* We'll only need this if
636 /* Now perform all the actions indicated by the arguments. */
639 catch_command_errors (cd_command
, cdarg
, 0, RETURN_MASK_ALL
);
642 for (i
= 0; i
< ndir
; i
++)
643 catch_command_errors (directory_command
, dirarg
[i
], 0, RETURN_MASK_ALL
);
648 && strcmp (execarg
, symarg
) == 0)
650 /* The exec file and the symbol-file are the same. If we can't
651 open it, better only print one error message.
652 catch_command_errors returns non-zero on success! */
653 if (catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
))
654 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
659 catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
);
661 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
664 /* After the symbol file has been read, print a newline to get us
665 beyond the copyright line... But errors should still set off
666 the error message with a (single) blank line. */
668 printf_filtered ("\n");
669 error_pre_print
= "\n";
670 quit_pre_print
= error_pre_print
;
671 warning_pre_print
= _("\nwarning: ");
675 /* corearg may be either a corefile or a pid.
676 If its first character is a digit, try attach first
677 and then corefile. Otherwise try corefile first. */
679 if (isdigit (corearg
[0]))
681 if (catch_command_errors (attach_command
, corearg
,
682 !batch
, RETURN_MASK_ALL
) == 0)
683 catch_command_errors (core_file_command
, corearg
,
684 !batch
, RETURN_MASK_ALL
);
686 else /* Can't be a pid, better be a corefile. */
687 catch_command_errors (core_file_command
, corearg
,
688 !batch
, RETURN_MASK_ALL
);
692 catch_command_errors (tty_command
, ttyarg
, !batch
, RETURN_MASK_ALL
);
694 /* Error messages should no longer be distinguished with extra output. */
695 error_pre_print
= NULL
;
696 quit_pre_print
= NULL
;
697 warning_pre_print
= _("warning: ");
699 /* Read the .gdbinit file in the current directory, *if* it isn't
700 the same as the $HOME/.gdbinit file (it should exist, also). */
703 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
, sizeof (struct stat
)))
704 if (!inhibit_gdbinit
)
706 catch_command_errors (source_command
, gdbinit
, 0, RETURN_MASK_ALL
);
709 for (i
= 0; i
< ncmd
; i
++)
712 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
713 expanded into a call to setjmp(). */
714 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
716 /* NOTE: I am commenting this out, because it is not clear
717 where this feature is used. It is very old and
718 undocumented. ezannoni: 1999-05-04 */
720 if (cmdarg
[i
][0] == '-' && cmdarg
[i
][1] == '\0')
721 read_command_file (stdin
);
724 source_command (cmdarg
[i
], !batch
);
725 do_cleanups (ALL_CLEANUPS
);
728 catch_command_errors (source_command
, cmdarg
[i
], !batch
, RETURN_MASK_ALL
);
732 /* Read in the old history after all the command files have been read. */
737 /* We have hit the end of the batch file. */
741 /* Do any host- or target-specific hacks. This is used for i960 targets
742 to force the user to set a nindy target and spec its parameters. */
744 #ifdef BEFORE_MAIN_LOOP_HOOK
745 BEFORE_MAIN_LOOP_HOOK
;
748 END_PROGRESS (argv
[0]);
750 /* Show time and/or space usage. */
754 long init_time
= get_run_time () - time_at_startup
;
756 printf_unfiltered (_("Startup time: %ld.%06ld\n"),
757 init_time
/ 1000000, init_time
% 1000000);
763 extern char **environ
;
764 char *lim
= (char *) sbrk (0);
766 printf_unfiltered (_("Startup size: data size %ld\n"),
767 (long) (lim
- (char *) &environ
));
772 /* FIXME: cagney/1999-11-06: The original main loop was like: */
775 if (!SET_TOP_LEVEL ())
777 do_cleanups (ALL_CLEANUPS
); /* Do complete cleanup */
778 /* GUIs generally have their own command loop, mainloop, or whatever.
779 This is a good place to gain control because many error
780 conditions will end up here via longjmp(). */
781 if (command_loop_hook
)
782 command_loop_hook ();
785 quit_command ((char *) 0, instream
== stdin
);
788 /* NOTE: If the command_loop() returned normally, the loop would
789 attempt to exit by calling the function quit_command(). That
790 function would either call exit() or throw an error returning
791 control to SET_TOP_LEVEL. */
792 /* NOTE: The function do_cleanups() was called once each time round
793 the loop. The usefulness of the call isn't clear. If an error
794 was thrown, everything would have already been cleaned up. If
795 command_loop() returned normally and quit_command() was called,
796 either exit() or error() (again cleaning up) would be called. */
798 /* NOTE: cagney/1999-11-07: There is probably no reason for not
799 moving this loop and the code found in captured_command_loop()
800 into the command_loop() proper. The main thing holding back that
801 change - SET_TOP_LEVEL() - has been eliminated. */
804 catch_errors (captured_command_loop
, 0, "", RETURN_MASK_ALL
);
806 /* No exit -- exit is through quit_command. */
810 gdb_main (struct captured_main_args
*args
)
812 use_windows
= args
->use_windows
;
813 catch_errors (captured_main
, args
, "", RETURN_MASK_ALL
);
814 /* The only way to end up here is by an error (normal exit is
815 handled by quit_force()), hence always return an error status. */
820 /* Don't use *_filtered for printing help. We don't want to prompt
821 for continue no matter how small the screen or how much we're going
825 print_gdb_help (struct ui_file
*stream
)
827 fputs_unfiltered (_("\
828 This is the GNU debugger. Usage:\n\n\
829 gdb [options] [executable-file [core-file or process-id]]\n\
830 gdb [options] --args executable-file [inferior-arguments ...]\n\n\
833 fputs_unfiltered (_("\
834 --args Arguments after executable-file are passed to inferior\n\
836 fputs_unfiltered (_("\
837 --[no]async Enable (disable) asynchronous version of CLI\n\
839 fputs_unfiltered (_("\
840 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
841 --batch Exit after processing options.\n\
842 --cd=DIR Change current directory to DIR.\n\
843 --command=FILE Execute GDB commands from FILE.\n\
844 --core=COREFILE Analyze the core dump COREFILE.\n\
845 --pid=PID Attach to running process PID.\n\
847 fputs_unfiltered (_("\
848 --dbx DBX compatibility mode.\n\
849 --directory=DIR Search for source files in DIR.\n\
850 --epoch Output information used by epoch emacs-GDB interface.\n\
851 --exec=EXECFILE Use EXECFILE as the executable.\n\
852 --fullname Output information used by emacs-GDB interface.\n\
853 --help Print this message.\n\
855 fputs_unfiltered (_("\
856 --interpreter=INTERP\n\
857 Select a specific interpreter / user interface\n\
859 fputs_unfiltered (_("\
860 --mapped Use mapped symbol files if supported on this system.\n\
861 --nw Do not use a window interface.\n\
862 --nx Do not read "), stream
);
863 fputs_unfiltered (gdbinit
, stream
);
864 fputs_unfiltered (_(" file.\n\
865 --quiet Do not print version number on startup.\n\
866 --readnow Fully read symbol files on first access.\n\
868 fputs_unfiltered (_("\
869 --se=FILE Use FILE as symbol file and executable file.\n\
870 --symbols=SYMFILE Read symbols from SYMFILE.\n\
871 --tty=TTY Use TTY for input/output by the program being debugged.\n\
874 fputs_unfiltered (_("\
875 --tui Use a terminal user interface.\n\
878 fputs_unfiltered (_("\
879 --version Print version information and then exit.\n\
880 -w Use a window interface.\n\
881 --write Set writing into executable and core files.\n\
882 --xdb XDB compatibility mode.\n\
884 fputs_unfiltered (_("\n\
885 For more information, type \"help\" from within GDB, or consult the\n\
886 GDB manual (available as on-line info or a printed manual).\n\
887 Report bugs to \"bug-gdb@gnu.org\".\
This page took 0.083455 seconds and 4 git commands to generate.