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"
40 /* FIXME: cagney/2000-01-31: This #include is to allow older code such
41 as that found in the TUI to continue to build. */
42 #include "tui/tui-file.h"
45 /* If nonzero, display time usage both at startup and for each command. */
49 /* If nonzero, display space usage both at startup and for each command. */
53 /* Whether this is the async version or not. The async version is
54 invoked on the command line with the -nw --async options. In this
55 version, the usual command_loop is substituted by and event loop which
56 processes UI events asynchronously. */
60 /* Has an interpreter been specified and if so, which. */
64 /* Whether this is the command line version or not */
67 /* Whether xdb commands will be handled */
70 /* Whether dbx commands will be handled */
73 struct ui_file
*gdb_stdout
;
74 struct ui_file
*gdb_stderr
;
75 struct ui_file
*gdb_stdlog
;
76 struct ui_file
*gdb_stdtarg
;
78 /* Used to initialize error() - defined in utils.c */
80 extern void error_init (void);
82 /* Whether to enable writing into executable and core files */
83 extern int write_files
;
85 static void print_gdb_help (struct ui_file
*);
87 /* These two are used to set the external editor commands when gdb is farming
88 out files to be edited by another program. */
90 extern int enable_external_editor
;
91 extern char *external_editor_command
;
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
;
203 gdb_stdout
= tui_fileopen (stdout
);
204 gdb_stderr
= tui_fileopen (stderr
);
205 gdb_stdlog
= gdb_stdout
; /* for moment */
206 gdb_stdtarg
= gdb_stderr
; /* for moment */
208 gdb_stdout
= stdio_fileopen (stdout
);
209 gdb_stderr
= stdio_fileopen (stderr
);
210 gdb_stdlog
= gdb_stderr
; /* for moment */
211 gdb_stdtarg
= gdb_stderr
; /* for moment */
214 /* initialize error() */
217 /* Parse arguments and options. */
220 /* When var field is 0, use flag field to record the equivalent
221 short option (or arbitrary numbers starting at 10 for those
222 with no equivalent). */
223 static struct option long_options
[] =
225 {"async", no_argument
, &event_loop_p
, 1},
226 {"noasync", no_argument
, &event_loop_p
, 0},
228 {"tui", no_argument
, &tui_version
, 1},
230 {"xdb", no_argument
, &xdb_commands
, 1},
231 {"dbx", no_argument
, &dbx_commands
, 1},
232 {"readnow", no_argument
, &readnow_symbol_files
, 1},
233 {"r", no_argument
, &readnow_symbol_files
, 1},
234 {"mapped", no_argument
, &mapped_symbol_files
, 1},
235 {"m", no_argument
, &mapped_symbol_files
, 1},
236 {"quiet", no_argument
, &quiet
, 1},
237 {"q", no_argument
, &quiet
, 1},
238 {"silent", no_argument
, &quiet
, 1},
239 {"nx", no_argument
, &inhibit_gdbinit
, 1},
240 {"n", no_argument
, &inhibit_gdbinit
, 1},
241 {"batch", no_argument
, &batch
, 1},
242 {"epoch", no_argument
, &epoch_interface
, 1},
244 /* This is a synonym for "--annotate=1". --annotate is now preferred,
245 but keep this here for a long time because people will be running
246 emacses which use --fullname. */
247 {"fullname", no_argument
, 0, 'f'},
248 {"f", no_argument
, 0, 'f'},
250 {"annotate", required_argument
, 0, 12},
251 {"help", no_argument
, &print_help
, 1},
252 {"se", required_argument
, 0, 10},
253 {"symbols", required_argument
, 0, 's'},
254 {"s", required_argument
, 0, 's'},
255 {"exec", required_argument
, 0, 'e'},
256 {"e", required_argument
, 0, 'e'},
257 {"core", required_argument
, 0, 'c'},
258 {"c", required_argument
, 0, 'c'},
259 {"command", required_argument
, 0, 'x'},
260 {"version", no_argument
, &print_version
, 1},
261 {"x", required_argument
, 0, 'x'},
263 {"tclcommand", required_argument
, 0, 'z'},
264 {"enable-external-editor", no_argument
, 0, 'y'},
265 {"editor-command", required_argument
, 0, 'w'},
268 {"ui", required_argument
, 0, 'i'},
269 {"interpreter", required_argument
, 0, 'i'},
270 {"i", required_argument
, 0, 'i'},
272 {"directory", required_argument
, 0, 'd'},
273 {"d", required_argument
, 0, 'd'},
274 {"cd", required_argument
, 0, 11},
275 {"tty", required_argument
, 0, 't'},
276 {"baud", required_argument
, 0, 'b'},
277 {"b", required_argument
, 0, 'b'},
278 {"nw", no_argument
, &use_windows
, 0},
279 {"nowindows", no_argument
, &use_windows
, 0},
280 {"w", no_argument
, &use_windows
, 1},
281 {"windows", no_argument
, &use_windows
, 1},
282 {"statistics", no_argument
, 0, 13},
283 {"write", no_argument
, &write_files
, 1},
284 /* Allow machine descriptions to add more options... */
285 #ifdef ADDITIONAL_OPTIONS
288 {0, no_argument
, 0, 0}
295 c
= getopt_long_only (argc
, argv
, "",
296 long_options
, &option_index
);
300 /* Long option that takes an argument. */
301 if (c
== 0 && long_options
[option_index
].flag
== 0)
302 c
= long_options
[option_index
].val
;
307 /* Long option that just sets a flag. */
317 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
318 annotation_level
= atoi (optarg
);
321 /* Enable the display of both time and space usage. */
326 annotation_level
= 1;
327 /* We have probably been invoked from emacs. Disable window interface. */
340 cmdarg
[ncmd
++] = optarg
;
344 cmdarg
= (char **) xrealloc ((char *) cmdarg
,
345 cmdsize
* sizeof (*cmdarg
));
351 extern int gdbtk_test (char *);
352 if (!gdbtk_test (optarg
))
354 fprintf_unfiltered (gdb_stderr
, "%s: unable to load tclcommand file \"%s\"",
363 * This enables the edit/button in the main window, even
364 * when IDE_ENABLED is set to false. In this case you must
365 * use --tclcommand to specify a tcl/script to be called,
366 * Tcl/Variable to store the edit/command is:
369 enable_external_editor
= 1;
375 * if editor command is enabled, both flags are set
377 enable_external_editor
= 1;
378 external_editor_command
= xstrdup (optarg
);
384 interpreter_p
= optarg
;
388 dirarg
[ndir
++] = optarg
;
392 dirarg
= (char **) xrealloc ((char *) dirarg
,
393 dirsize
* sizeof (*dirarg
));
407 i
= strtol (optarg
, &p
, 0);
408 if (i
== 0 && p
== optarg
)
410 /* Don't use *_filtered or warning() (which relies on
411 current_target) until after initialize_all_files(). */
415 "warning: could not set baud rate to `%s'.\n", optarg
);
424 i
= strtol (optarg
, &p
, 0);
425 if (i
== 0 && p
== optarg
)
427 /* Don't use *_filtered or warning() (which relies on
428 current_target) until after initialize_all_files(). */
432 "warning: could not set timeout limit to `%s'.\n", optarg
);
438 #ifdef ADDITIONAL_OPTION_CASES
439 ADDITIONAL_OPTION_CASES
442 fprintf_unfiltered (gdb_stderr
,
443 "Use `%s --help' for a complete list of options.\n",
449 /* If --help or --version, disable window interface. */
450 if (print_help
|| print_version
)
454 /* Disable the TUI as well. */
460 /* An explicit --tui flag overrides the default UI, which is the
466 /* OK, that's all the options. The other arguments are filenames. */
468 for (; optind
< argc
; optind
++)
472 symarg
= argv
[optind
];
473 execarg
= argv
[optind
];
476 /* FIXME: The documentation says this can be a "ProcID". as well. */
477 corearg
= argv
[optind
];
480 fprintf_unfiltered (gdb_stderr
,
481 "Excess command line arguments ignored. (%s%s)\n",
482 argv
[optind
], (optind
== argc
- 1) ? "" : " ...");
490 /* Should this be moved to tui-top.c:_initialize_tui()? */
492 init_ui_hook
= tuiInit
;
495 /* Initialize all files. Give the interpreter a chance to take
496 control of the console via the init_ui_hook()) */
499 /* Do these (and anything which might call wrap_here or *_filtered)
500 after initialize_all_files. */
503 print_gdb_version (gdb_stdout
);
505 printf_filtered ("\n");
511 print_gdb_help (gdb_stdout
);
512 fputs_unfiltered ("\n", gdb_stdout
);
518 /* Print all the junk at the top, with trailing "..." if we are about
519 to read a symbol file (possibly slowly). */
520 print_gdb_version (gdb_stdout
);
522 printf_filtered ("..");
524 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
527 error_pre_print
= "\n\n";
528 quit_pre_print
= error_pre_print
;
530 /* We may get more than one warning, don't double space all of them... */
531 warning_pre_print
= "\nwarning: ";
533 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
534 *before* all the command line arguments are processed; it sets
535 global parameters, which are independent of what file you are
536 debugging or what directory you are in. */
539 char *tmp
= getenv ("HOME");
543 homedir
= (char *) alloca (PATH_MAX
+ 1);
544 cygwin32_conv_to_posix_path (tmp
, homedir
);
550 homedir
= getenv ("HOME");
554 homeinit
= (char *) alloca (strlen (homedir
) +
555 strlen (gdbinit
) + 10);
556 strcpy (homeinit
, homedir
);
557 strcat (homeinit
, "/");
558 strcat (homeinit
, gdbinit
);
560 if (!inhibit_gdbinit
)
562 catch_command_errors (source_command
, homeinit
, 0, RETURN_MASK_ALL
);
565 /* Do stats; no need to do them elsewhere since we'll only
566 need them if homedir is set. Make sure that they are
567 zero in case one of them fails (this guarantees that they
568 won't match if either exists). */
570 memset (&homebuf
, 0, sizeof (struct stat
));
571 memset (&cwdbuf
, 0, sizeof (struct stat
));
573 stat (homeinit
, &homebuf
);
574 stat (gdbinit
, &cwdbuf
); /* We'll only need this if
578 /* Now perform all the actions indicated by the arguments. */
581 catch_command_errors (cd_command
, cdarg
, 0, RETURN_MASK_ALL
);
584 for (i
= 0; i
< ndir
; i
++)
585 catch_command_errors (directory_command
, dirarg
[i
], 0, RETURN_MASK_ALL
);
590 && STREQ (execarg
, symarg
))
592 /* The exec file and the symbol-file are the same. If we can't
593 open it, better only print one error message.
594 catch_command_errors returns non-zero on success! */
595 if (catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
))
596 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
601 catch_command_errors (exec_file_attach
, execarg
, !batch
, RETURN_MASK_ALL
);
603 catch_command_errors (symbol_file_add_main
, symarg
, 0, RETURN_MASK_ALL
);
606 /* After the symbol file has been read, print a newline to get us
607 beyond the copyright line... But errors should still set off
608 the error message with a (single) blank line. */
610 printf_filtered ("\n");
611 error_pre_print
= "\n";
612 quit_pre_print
= error_pre_print
;
613 warning_pre_print
= "\nwarning: ";
617 if (catch_command_errors (core_file_command
, corearg
, !batch
, RETURN_MASK_ALL
) == 0)
619 /* See if the core file is really a PID. */
620 if (isdigit (corearg
[0]))
621 catch_command_errors (attach_command
, corearg
, !batch
, RETURN_MASK_ALL
);
626 catch_command_errors (tty_command
, ttyarg
, !batch
, RETURN_MASK_ALL
);
628 #ifdef ADDITIONAL_OPTION_HANDLER
629 ADDITIONAL_OPTION_HANDLER
;
632 /* Error messages should no longer be distinguished with extra output. */
633 error_pre_print
= NULL
;
634 quit_pre_print
= NULL
;
635 warning_pre_print
= "warning: ";
637 /* Read the .gdbinit file in the current directory, *if* it isn't
638 the same as the $HOME/.gdbinit file (it should exist, also). */
641 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
, sizeof (struct stat
)))
642 if (!inhibit_gdbinit
)
644 catch_command_errors (source_command
, gdbinit
, 0, RETURN_MASK_ALL
);
647 for (i
= 0; i
< ncmd
; i
++)
650 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
651 expanded into a call to setjmp(). */
652 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
654 /* NOTE: I am commenting this out, because it is not clear
655 where this feature is used. It is very old and
656 undocumented. ezannoni: 1999-05-04 */
658 if (cmdarg
[i
][0] == '-' && cmdarg
[i
][1] == '\0')
659 read_command_file (stdin
);
662 source_command (cmdarg
[i
], !batch
);
663 do_cleanups (ALL_CLEANUPS
);
666 catch_command_errors (source_command
, cmdarg
[i
], !batch
, RETURN_MASK_ALL
);
670 /* Read in the old history after all the command files have been read. */
675 /* We have hit the end of the batch file. */
679 /* Do any host- or target-specific hacks. This is used for i960 targets
680 to force the user to set a nindy target and spec its parameters. */
682 #ifdef BEFORE_MAIN_LOOP_HOOK
683 BEFORE_MAIN_LOOP_HOOK
;
686 END_PROGRESS (argv
[0]);
688 /* Show time and/or space usage. */
692 long init_time
= get_run_time () - time_at_startup
;
694 printf_unfiltered ("Startup time: %ld.%06ld\n",
695 init_time
/ 1000000, init_time
% 1000000);
701 extern char **environ
;
702 char *lim
= (char *) sbrk (0);
704 printf_unfiltered ("Startup size: data size %ld\n",
705 (long) (lim
- (char *) &environ
));
710 /* FIXME: cagney/1999-11-06: The original main loop was like: */
713 if (!SET_TOP_LEVEL ())
715 do_cleanups (ALL_CLEANUPS
); /* Do complete cleanup */
716 /* GUIs generally have their own command loop, mainloop, or whatever.
717 This is a good place to gain control because many error
718 conditions will end up here via longjmp(). */
719 if (command_loop_hook
)
720 command_loop_hook ();
723 quit_command ((char *) 0, instream
== stdin
);
726 /* NOTE: If the command_loop() returned normally, the loop would
727 attempt to exit by calling the function quit_command(). That
728 function would either call exit() or throw an error returning
729 control to SET_TOP_LEVEL. */
730 /* NOTE: The function do_cleanups() was called once each time round
731 the loop. The usefulness of the call isn't clear. If an error
732 was thrown, everything would have already been cleaned up. If
733 command_loop() returned normally and quit_command() was called,
734 either exit() or error() (again cleaning up) would be called. */
736 /* NOTE: cagney/1999-11-07: There is probably no reason for not
737 moving this loop and the code found in captured_command_loop()
738 into the command_loop() proper. The main thing holding back that
739 change - SET_TOP_LEVEL() - has been eliminated. */
742 catch_errors (captured_command_loop
, 0, "", RETURN_MASK_ALL
);
744 /* No exit -- exit is through quit_command. */
748 main (int argc
, char **argv
)
750 struct captured_main_args args
;
753 catch_errors (captured_main
, &args
, "", RETURN_MASK_ALL
);
758 /* Don't use *_filtered for printing help. We don't want to prompt
759 for continue no matter how small the screen or how much we're going
763 print_gdb_help (struct ui_file
*stream
)
766 This is the GNU debugger. Usage:\n\n\
767 gdb [options] [executable-file [core-file or process-id]]\n\n\
771 --[no]async Enable (disable) asynchronous version of CLI\n\
774 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
775 --batch Exit after processing options.\n\
776 --cd=DIR Change current directory to DIR.\n\
777 --command=FILE Execute GDB commands from FILE.\n\
778 --core=COREFILE Analyze the core dump COREFILE.\n\
781 --dbx DBX compatibility mode.\n\
782 --directory=DIR Search for source files in DIR.\n\
783 --epoch Output information used by epoch emacs-GDB interface.\n\
784 --exec=EXECFILE Use EXECFILE as the executable.\n\
785 --fullname Output information used by emacs-GDB interface.\n\
786 --help Print this message.\n\
789 --interpreter=INTERP\n\
790 Select a specific interpreter / user interface\n\
793 --mapped Use mapped symbol files if supported on this system.\n\
794 --nw Do not use a window interface.\n\
795 --nx Do not read ", stream
);
796 fputs_unfiltered (gdbinit
, stream
);
797 fputs_unfiltered (" file.\n\
798 --quiet Do not print version number on startup.\n\
799 --readnow Fully read symbol files on first access.\n\
802 --se=FILE Use FILE as symbol file and executable file.\n\
803 --symbols=SYMFILE Read symbols from SYMFILE.\n\
804 --tty=TTY Use TTY for input/output by the program being debugged.\n\
808 --tui Use a terminal user interface.\n\
812 --version Print version information and then exit.\n\
813 -w Use a window interface.\n\
814 --write Set writing into executable and core files.\n\
815 --xdb XDB compatibility mode.\n\
817 #ifdef ADDITIONAL_OPTION_HELP
818 fputs_unfiltered (ADDITIONAL_OPTION_HELP
, stream
);
820 fputs_unfiltered ("\n\
821 For more information, type \"help\" from within GDB, or consult the\n\
822 GDB manual (available as on-line info or a printed manual).\n\
823 Report bugs to \"bug-gdb@gnu.org\".\