1 /* Top level stuff for GDB, the GNU debugger.
2 Copyright 1986-1995, 1999-2000 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
25 #include "call-cmds.h"
29 #include <sys/types.h>
33 #include "gdb_string.h"
34 #include "event-loop.h"
36 #if defined (TUI) || defined (GDBTK)
37 /* FIXME: cagney/2000-01-31: This #include is to allow older code such
38 as that found in the TUI to continue to build. */
39 #include "tui/tui-file.h"
42 /* If nonzero, display time usage both at startup and for each command. */
46 /* If nonzero, display space usage both at startup and for each command. */
50 /* Whether this is the async version or not. The async version is
51 invoked on the command line with the -nw --async options. In this
52 version, the usual command_loop is substituted by and event loop which
53 processes UI events asynchronously. */
56 /* Whether this is the command line version or not */
59 /* Whether xdb commands will be handled */
62 /* Whether dbx commands will be handled */
65 struct ui_file
*gdb_stdout
;
66 struct ui_file
*gdb_stderr
;
67 struct ui_file
*gdb_stdlog
;
68 struct ui_file
*gdb_stdtarg
;
70 /* Used to initialize error() - defined in utils.c */
72 extern void error_init (void);
74 /* Whether to enable writing into executable and core files */
75 extern int write_files
;
77 static void print_gdb_help (struct ui_file
*);
79 /* These two are used to set the external editor commands when gdb is farming
80 out files to be edited by another program. */
82 extern int enable_external_editor
;
83 extern char *external_editor_command
;
86 #include <windows.h> /* for MAX_PATH */
87 #include <sys/cygwin.h> /* for cygwin32_conv_to_posix_path */
90 /* Call command_loop. If it happens to return, pass that through as a
91 non-zero return status. */
94 captured_command_loop (void *data
)
96 if (command_loop_hook
== NULL
)
100 /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
101 would clean things up (restoring the cleanup chain) to the state
102 they were just prior to the call. Technically, this means that
103 the do_cleanups() below is redundant. Unfortunatly, many FUNC's
104 are not that well behaved. do_cleanups should either be replaced
105 with a do_cleanups call (to cover the problem) or an assertion
106 check to detect bad FUNCs code. */
107 do_cleanups (ALL_CLEANUPS
);
108 /* If the command_loop returned, normally (rather than threw an
109 error) we try to quit. If the quit is aborted, catch_errors()
110 which called this catch the signal and restart the command
112 quit_command (NULL
, instream
== stdin
);
116 struct captured_main_args
123 captured_main (void *data
)
125 struct captured_main_args
*context
= data
;
126 int argc
= context
->argc
;
127 char **argv
= context
->argv
;
129 static int quiet
= 0;
130 static int batch
= 0;
132 /* Pointers to various arguments from command line. */
134 char *execarg
= NULL
;
135 char *corearg
= NULL
;
139 /* These are static so that we can take their address in an initializer. */
140 static int print_help
;
141 static int print_version
;
143 /* Pointers to all arguments of --command option. */
145 /* Allocated size of cmdarg. */
147 /* Number of elements of cmdarg used. */
150 /* Indices of all arguments of --directory option. */
152 /* Allocated size. */
154 /* Number of elements used. */
157 struct stat homebuf
, cwdbuf
;
158 char *homedir
, *homeinit
;
162 long time_at_startup
= get_run_time ();
164 START_PROGRESS (argv
[0], 0);
167 /* Do all Mac-specific setup. */
171 /* This needs to happen before the first use of malloc. */
172 init_malloc ((PTR
) NULL
);
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 #if defined (TUI) || defined (GDBTK)
196 /* Older code uses the tui_file and fputs_unfiltered_hook(). It
197 should be using a customized UI_FILE object and re-initializing
198 within its own _initialize function. */
199 gdb_stdout
= tui_fileopen (stdout
);
200 gdb_stderr
= tui_fileopen (stderr
);
201 gdb_stdlog
= gdb_stdout
; /* for moment */
202 gdb_stdtarg
= gdb_stderr
; /* for moment */
204 gdb_stdout
= stdio_fileopen (stdout
);
205 gdb_stderr
= stdio_fileopen (stderr
);
206 gdb_stdlog
= gdb_stderr
; /* for moment */
207 gdb_stdtarg
= gdb_stderr
; /* for moment */
210 /* initialize error() */
213 /* Parse arguments and options. */
216 /* When var field is 0, use flag field to record the equivalent
217 short option (or arbitrary numbers starting at 10 for those
218 with no equivalent). */
219 static struct option long_options
[] =
221 {"async", no_argument
, &event_loop_p
, 1},
222 {"noasync", no_argument
, &event_loop_p
, 0},
224 {"tui", no_argument
, &tui_version
, 1},
226 {"xdb", no_argument
, &xdb_commands
, 1},
227 {"dbx", no_argument
, &dbx_commands
, 1},
228 {"readnow", no_argument
, &readnow_symbol_files
, 1},
229 {"r", no_argument
, &readnow_symbol_files
, 1},
230 {"mapped", no_argument
, &mapped_symbol_files
, 1},
231 {"m", no_argument
, &mapped_symbol_files
, 1},
232 {"quiet", no_argument
, &quiet
, 1},
233 {"q", no_argument
, &quiet
, 1},
234 {"silent", no_argument
, &quiet
, 1},
235 {"nx", no_argument
, &inhibit_gdbinit
, 1},
236 {"n", no_argument
, &inhibit_gdbinit
, 1},
237 {"batch", no_argument
, &batch
, 1},
238 {"epoch", no_argument
, &epoch_interface
, 1},
240 /* This is a synonym for "--annotate=1". --annotate is now preferred,
241 but keep this here for a long time because people will be running
242 emacses which use --fullname. */
243 {"fullname", no_argument
, 0, 'f'},
244 {"f", no_argument
, 0, 'f'},
246 {"annotate", required_argument
, 0, 12},
247 {"help", no_argument
, &print_help
, 1},
248 {"se", required_argument
, 0, 10},
249 {"symbols", required_argument
, 0, 's'},
250 {"s", required_argument
, 0, 's'},
251 {"exec", required_argument
, 0, 'e'},
252 {"e", required_argument
, 0, 'e'},
253 {"core", required_argument
, 0, 'c'},
254 {"c", required_argument
, 0, 'c'},
255 {"command", required_argument
, 0, 'x'},
256 {"version", no_argument
, &print_version
, 1},
257 {"x", required_argument
, 0, 'x'},
258 {"ui", required_argument
, 0, 'i'},
259 {"interpreter", required_argument
, 0, 'i'},
260 {"i", required_argument
, 0, 'i'},
261 {"directory", required_argument
, 0, 'd'},
262 {"d", required_argument
, 0, 'd'},
263 {"cd", required_argument
, 0, 11},
264 {"tty", required_argument
, 0, 't'},
265 {"baud", required_argument
, 0, 'b'},
266 {"b", required_argument
, 0, 'b'},
267 {"nw", no_argument
, &use_windows
, 0},
268 {"nowindows", no_argument
, &use_windows
, 0},
269 {"w", no_argument
, &use_windows
, 1},
270 {"windows", no_argument
, &use_windows
, 1},
271 {"statistics", no_argument
, 0, 13},
272 {"write", no_argument
, &write_files
, 1},
273 /* Allow machine descriptions to add more options... */
274 #ifdef ADDITIONAL_OPTIONS
277 {0, no_argument
, 0, 0}
284 c
= getopt_long_only (argc
, argv
, "",
285 long_options
, &option_index
);
289 /* Long option that takes an argument. */
290 if (c
== 0 && long_options
[option_index
].flag
== 0)
291 c
= long_options
[option_index
].val
;
296 /* Long option that just sets a flag. */
306 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
307 annotation_level
= atoi (optarg
);
310 /* Enable the display of both time and space usage. */
315 annotation_level
= 1;
316 /* We have probably been invoked from emacs. Disable window interface. */
329 cmdarg
[ncmd
++] = optarg
;
333 cmdarg
= (char **) xrealloc ((char *) cmdarg
,
334 cmdsize
* sizeof (*cmdarg
));
338 dirarg
[ndir
++] = optarg
;
342 dirarg
= (char **) xrealloc ((char *) dirarg
,
343 dirsize
* sizeof (*dirarg
));
357 i
= strtol (optarg
, &p
, 0);
358 if (i
== 0 && p
== optarg
)
360 /* Don't use *_filtered or warning() (which relies on
361 current_target) until after initialize_all_files(). */
365 "warning: could not set baud rate to `%s'.\n", optarg
);
374 i
= strtol (optarg
, &p
, 0);
375 if (i
== 0 && p
== optarg
)
377 /* Don't use *_filtered or warning() (which relies on
378 current_target) until after initialize_all_files(). */
382 "warning: could not set timeout limit to `%s'.\n", optarg
);
388 #ifdef ADDITIONAL_OPTION_CASES
389 ADDITIONAL_OPTION_CASES
392 fprintf_unfiltered (gdb_stderr
,
393 "Use `%s --help' for a complete list of options.\n",
399 /* If --help or --version, disable window interface. */
400 if (print_help
|| print_version
)
404 /* Disable the TUI as well. */
410 /* An explicit --tui flag overrides the default UI, which is the
416 /* OK, that's all the options. The other arguments are filenames. */
418 for (; optind
< argc
; optind
++)
422 symarg
= argv
[optind
];
423 execarg
= argv
[optind
];
426 corearg
= argv
[optind
];
429 fprintf_unfiltered (gdb_stderr
,
430 "Excess command line arguments ignored. (%s%s)\n",
431 argv
[optind
], (optind
== argc
- 1) ? "" : " ...");
439 /* Should this be moved to tui-top.c:_initialize_tui()? */
441 init_ui_hook
= tuiInit
;
444 /* Initialize all files. Give the interpreter a chance to take
445 control of the console via the init_ui_hook()) */
448 /* Do these (and anything which might call wrap_here or *_filtered)
449 after initialize_all_files. */
452 print_gdb_version (gdb_stdout
);
454 printf_filtered ("\n");
460 print_gdb_help (gdb_stdout
);
461 fputs_unfiltered ("\n", gdb_stdout
);
467 /* Print all the junk at the top, with trailing "..." if we are about
468 to read a symbol file (possibly slowly). */
469 print_gdb_version (gdb_stdout
);
471 printf_filtered ("..");
473 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
476 error_pre_print
= "\n\n";
477 quit_pre_print
= error_pre_print
;
479 /* We may get more than one warning, don't double space all of them... */
480 warning_pre_print
= "\nwarning: ";
482 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
483 *before* all the command line arguments are processed; it sets
484 global parameters, which are independent of what file you are
485 debugging or what directory you are in. */
488 char *tmp
= getenv ("HOME");
492 homedir
= (char *) alloca (MAX_PATH
+ 1);
493 cygwin32_conv_to_posix_path (tmp
, homedir
);
499 homedir
= getenv ("HOME");
503 homeinit
= (char *) alloca (strlen (homedir
) +
504 strlen (gdbinit
) + 10);
505 strcpy (homeinit
, homedir
);
506 strcat (homeinit
, "/");
507 strcat (homeinit
, gdbinit
);
509 if (!inhibit_gdbinit
)
511 catch_command_errors (source_command
, homeinit
, 0, RETURN_MASK_ALL
);
514 /* Do stats; no need to do them elsewhere since we'll only
515 need them if homedir is set. Make sure that they are
516 zero in case one of them fails (this guarantees that they
517 won't match if either exists). */
519 memset (&homebuf
, 0, sizeof (struct stat
));
520 memset (&cwdbuf
, 0, sizeof (struct stat
));
522 stat (homeinit
, &homebuf
);
523 stat (gdbinit
, &cwdbuf
); /* We'll only need this if
527 /* Now perform all the actions indicated by the arguments. */
530 catch_command_errors (cd_command
, cdarg
, 0, RETURN_MASK_ALL
);
533 for (i
= 0; i
< ndir
; i
++)
534 catch_command_errors (directory_command
, dirarg
[i
], 0, RETURN_MASK_ALL
);
539 && STREQ (execarg
, symarg
))
541 /* The exec file and the symbol-file are the same. If we can't
542 open it, better only print one error message.
543 catch_command_errors returns non-zero on success! */
544 if (catch_command_errors (exec_file_command
, execarg
, !batch
, RETURN_MASK_ALL
))
545 catch_command_errors (symbol_file_command
, symarg
, 0, RETURN_MASK_ALL
);
550 catch_command_errors (exec_file_command
, execarg
, !batch
, RETURN_MASK_ALL
);
552 catch_command_errors (symbol_file_command
, symarg
, 0, RETURN_MASK_ALL
);
555 /* After the symbol file has been read, print a newline to get us
556 beyond the copyright line... But errors should still set off
557 the error message with a (single) blank line. */
559 printf_filtered ("\n");
560 error_pre_print
= "\n";
561 quit_pre_print
= error_pre_print
;
562 warning_pre_print
= "\nwarning: ";
566 if (catch_command_errors (core_file_command
, corearg
, !batch
, RETURN_MASK_ALL
) == 0)
568 /* See if the core file is really a PID. */
569 if (isdigit (corearg
[0]))
570 catch_command_errors (attach_command
, corearg
, !batch
, RETURN_MASK_ALL
);
575 catch_command_errors (tty_command
, ttyarg
, !batch
, RETURN_MASK_ALL
);
577 #ifdef ADDITIONAL_OPTION_HANDLER
578 ADDITIONAL_OPTION_HANDLER
;
581 /* Error messages should no longer be distinguished with extra output. */
582 error_pre_print
= NULL
;
583 quit_pre_print
= NULL
;
584 warning_pre_print
= "warning: ";
586 /* Read the .gdbinit file in the current directory, *if* it isn't
587 the same as the $HOME/.gdbinit file (it should exist, also). */
590 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
, sizeof (struct stat
)))
591 if (!inhibit_gdbinit
)
593 catch_command_errors (source_command
, gdbinit
, 0, RETURN_MASK_ALL
);
596 for (i
= 0; i
< ncmd
; i
++)
599 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
600 expanded into a call to setjmp(). */
601 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
603 /* NOTE: I am commenting this out, because it is not clear
604 where this feature is used. It is very old and
605 undocumented. ezannoni: 1999-05-04 */
607 if (cmdarg
[i
][0] == '-' && cmdarg
[i
][1] == '\0')
608 read_command_file (stdin
);
611 source_command (cmdarg
[i
], !batch
);
612 do_cleanups (ALL_CLEANUPS
);
615 catch_command_errors (source_command
, cmdarg
[i
], !batch
, RETURN_MASK_ALL
);
619 /* Read in the old history after all the command files have been read. */
624 /* We have hit the end of the batch file. */
628 /* Do any host- or target-specific hacks. This is used for i960 targets
629 to force the user to set a nindy target and spec its parameters. */
631 #ifdef BEFORE_MAIN_LOOP_HOOK
632 BEFORE_MAIN_LOOP_HOOK
;
635 END_PROGRESS (argv
[0]);
637 /* Show time and/or space usage. */
641 long init_time
= get_run_time () - time_at_startup
;
643 printf_unfiltered ("Startup time: %ld.%06ld\n",
644 init_time
/ 1000000, init_time
% 1000000);
650 extern char **environ
;
651 char *lim
= (char *) sbrk (0);
653 printf_unfiltered ("Startup size: data size %ld\n",
654 (long) (lim
- (char *) &environ
));
658 /* The default command loop.
659 The WIN32 Gui calls this main to set up gdb's state, and
660 has its own command loop. */
661 #if !defined _WIN32 || defined __GNUC__
662 /* GUIs generally have their own command loop, mainloop, or
663 whatever. This is a good place to gain control because many
664 error conditions will end up here via longjmp(). */
666 /* FIXME: cagney/1999-11-06: The original main loop was like: */
669 if (!SET_TOP_LEVEL ())
671 do_cleanups (ALL_CLEANUPS
); /* Do complete cleanup */
672 /* GUIs generally have their own command loop, mainloop, or whatever.
673 This is a good place to gain control because many error
674 conditions will end up here via longjmp(). */
675 if (command_loop_hook
)
676 command_loop_hook ();
679 quit_command ((char *) 0, instream
== stdin
);
682 /* NOTE: If the command_loop() returned normally, the loop would
683 attempt to exit by calling the function quit_command(). That
684 function would either call exit() or throw an error returning
685 control to SET_TOP_LEVEL. */
686 /* NOTE: The function do_cleanups() was called once each time round
687 the loop. The usefulness of the call isn't clear. If an error
688 was thrown, everything would have already been cleaned up. If
689 command_loop() returned normally and quit_command() was called,
690 either exit() or error() (again cleaning up) would be called. */
692 /* NOTE: cagney/1999-11-07: There is probably no reason for not
693 moving this loop and the code found in captured_command_loop()
694 into the command_loop() proper. The main thing holding back that
695 change - SET_TOP_LEVEL() - has been eliminated. */
698 catch_errors (captured_command_loop
, 0, "", RETURN_MASK_ALL
);
701 /* No exit -- exit is through quit_command. */
705 main (int argc
, char **argv
)
707 struct captured_main_args args
;
710 catch_errors (captured_main
, &args
, "", RETURN_MASK_ALL
);
715 /* Don't use *_filtered for printing help. We don't want to prompt
716 for continue no matter how small the screen or how much we're going
720 print_gdb_help (struct ui_file
*stream
)
723 This is the GNU debugger. Usage:\n\n\
724 gdb [options] [executable-file [core-file or process-id]]\n\n\
728 --[no]async Enable (disable) asynchronous version of CLI\n\
731 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
732 --batch Exit after processing options.\n\
733 --cd=DIR Change current directory to DIR.\n\
734 --command=FILE Execute GDB commands from FILE.\n\
735 --core=COREFILE Analyze the core dump COREFILE.\n\
738 --dbx DBX compatibility mode.\n\
739 --directory=DIR Search for source files in DIR.\n\
740 --epoch Output information used by epoch emacs-GDB interface.\n\
741 --exec=EXECFILE Use EXECFILE as the executable.\n\
742 --fullname Output information used by emacs-GDB interface.\n\
743 --help Print this message.\n\
746 --interpreter=INTERP\n\
747 Select a specific interpreter / user interface\n\
750 --mapped Use mapped symbol files if supported on this system.\n\
751 --nw Do not use a window interface.\n\
752 --nx Do not read ", stream
);
753 fputs_unfiltered (gdbinit
, stream
);
754 fputs_unfiltered (" file.\n\
755 --quiet Do not print version number on startup.\n\
756 --readnow Fully read symbol files on first access.\n\
759 --se=FILE Use FILE as symbol file and executable file.\n\
760 --symbols=SYMFILE Read symbols from SYMFILE.\n\
761 --tty=TTY Use TTY for input/output by the program being debugged.\n\
765 --tui Use a terminal user interface.\n\
769 --version Print version information and then exit.\n\
770 -w Use a window interface.\n\
771 --write Set writing into executable and core files.\n\
772 --xdb XDB compatibility mode.\n\
774 #ifdef ADDITIONAL_OPTION_HELP
775 fputs_unfiltered (ADDITIONAL_OPTION_HELP
, stream
);
777 fputs_unfiltered ("\n\
778 For more information, type \"help\" from within GDB, or consult the\n\
779 GDB manual (available as on-line info or a printed manual).\n\
780 Report bugs to \"bug-gdb@gnu.org\".\