1 /* Top level stuff for GDB, the GNU debugger.
2 Copyright 1986, 87, 88, 89, 90, 91, 92, 93, 94, 95, 1999
3 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. */
26 #include "call-cmds.h"
30 #include <sys/types.h>
34 #include "gdb_string.h"
35 #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 */
68 GDB_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
PARAMS ((GDB_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 GDB_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 {"directory", required_argument
, 0, 'd'},
259 {"d", required_argument
, 0, 'd'},
260 {"cd", required_argument
, 0, 11},
261 {"tty", required_argument
, 0, 't'},
262 {"baud", required_argument
, 0, 'b'},
263 {"b", required_argument
, 0, 'b'},
264 {"nw", no_argument
, &use_windows
, 0},
265 {"nowindows", no_argument
, &use_windows
, 0},
266 {"w", no_argument
, &use_windows
, 1},
267 {"windows", no_argument
, &use_windows
, 1},
268 {"statistics", no_argument
, 0, 13},
269 {"write", no_argument
, &write_files
, 1},
270 /* Allow machine descriptions to add more options... */
271 #ifdef ADDITIONAL_OPTIONS
274 {0, no_argument
, 0, 0}
281 c
= getopt_long_only (argc
, argv
, "",
282 long_options
, &option_index
);
286 /* Long option that takes an argument. */
287 if (c
== 0 && long_options
[option_index
].flag
== 0)
288 c
= long_options
[option_index
].val
;
293 /* Long option that just sets a flag. */
303 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
304 annotation_level
= atoi (optarg
);
307 /* Enable the display of both time and space usage. */
312 annotation_level
= 1;
313 /* We have probably been invoked from emacs. Disable window interface. */
326 cmdarg
[ncmd
++] = optarg
;
330 cmdarg
= (char **) xrealloc ((char *) cmdarg
,
331 cmdsize
* sizeof (*cmdarg
));
335 dirarg
[ndir
++] = optarg
;
339 dirarg
= (char **) xrealloc ((char *) dirarg
,
340 dirsize
* sizeof (*dirarg
));
354 i
= strtol (optarg
, &p
, 0);
355 if (i
== 0 && p
== optarg
)
357 /* Don't use *_filtered or warning() (which relies on
358 current_target) until after initialize_all_files(). */
362 "warning: could not set baud rate to `%s'.\n", optarg
);
371 i
= strtol (optarg
, &p
, 0);
372 if (i
== 0 && p
== optarg
)
374 /* Don't use *_filtered or warning() (which relies on
375 current_target) until after initialize_all_files(). */
379 "warning: could not set timeout limit to `%s'.\n", optarg
);
385 #ifdef ADDITIONAL_OPTION_CASES
386 ADDITIONAL_OPTION_CASES
389 fprintf_unfiltered (gdb_stderr
,
390 "Use `%s --help' for a complete list of options.\n",
396 /* If --help or --version, disable window interface. */
397 if (print_help
|| print_version
)
401 /* Disable the TUI as well. */
407 /* An explicit --tui flag overrides the default UI, which is the
413 /* OK, that's all the options. The other arguments are filenames. */
415 for (; optind
< argc
; optind
++)
419 symarg
= argv
[optind
];
420 execarg
= argv
[optind
];
423 corearg
= argv
[optind
];
426 fprintf_unfiltered (gdb_stderr
,
427 "Excess command line arguments ignored. (%s%s)\n",
428 argv
[optind
], (optind
== argc
- 1) ? "" : " ...");
436 /* Should this be moved to tui-top.c:_initialize_tui()? */
438 init_ui_hook
= tuiInit
;
441 /* Initialize all files. Give the interpreter a chance to take
442 control of the console via the init_ui_hook()) */
445 /* Do these (and anything which might call wrap_here or *_filtered)
446 after initialize_all_files. */
449 print_gdb_version (gdb_stdout
);
451 printf_filtered ("\n");
457 print_gdb_help (gdb_stdout
);
458 fputs_unfiltered ("\n", gdb_stdout
);
464 /* Print all the junk at the top, with trailing "..." if we are about
465 to read a symbol file (possibly slowly). */
466 print_gdb_version (gdb_stdout
);
468 printf_filtered ("..");
470 gdb_flush (gdb_stdout
); /* Force to screen during slow operations */
473 error_pre_print
= "\n\n";
474 quit_pre_print
= error_pre_print
;
476 /* We may get more than one warning, don't double space all of them... */
477 warning_pre_print
= "\nwarning: ";
479 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
480 *before* all the command line arguments are processed; it sets
481 global parameters, which are independent of what file you are
482 debugging or what directory you are in. */
485 char *tmp
= getenv ("HOME");
489 homedir
= (char *) alloca (MAX_PATH
+ 1);
490 cygwin32_conv_to_posix_path (tmp
, homedir
);
496 homedir
= getenv ("HOME");
500 homeinit
= (char *) alloca (strlen (homedir
) +
501 strlen (gdbinit
) + 10);
502 strcpy (homeinit
, homedir
);
503 strcat (homeinit
, "/");
504 strcat (homeinit
, gdbinit
);
506 if (!inhibit_gdbinit
)
508 catch_command_errors (source_command
, homeinit
, 0, RETURN_MASK_ALL
);
511 /* Do stats; no need to do them elsewhere since we'll only
512 need them if homedir is set. Make sure that they are
513 zero in case one of them fails (this guarantees that they
514 won't match if either exists). */
516 memset (&homebuf
, 0, sizeof (struct stat
));
517 memset (&cwdbuf
, 0, sizeof (struct stat
));
519 stat (homeinit
, &homebuf
);
520 stat (gdbinit
, &cwdbuf
); /* We'll only need this if
524 /* Now perform all the actions indicated by the arguments. */
527 catch_command_errors (cd_command
, cdarg
, 0, RETURN_MASK_ALL
);
530 for (i
= 0; i
< ndir
; i
++)
531 catch_command_errors (directory_command
, dirarg
[i
], 0, RETURN_MASK_ALL
);
536 && STREQ (execarg
, symarg
))
538 /* The exec file and the symbol-file are the same. If we can't
539 open it, better only print one error message.
540 catch_command_errors returns non-zero on success! */
541 if (catch_command_errors (exec_file_command
, execarg
, !batch
, RETURN_MASK_ALL
))
542 catch_command_errors (symbol_file_command
, symarg
, 0, RETURN_MASK_ALL
);
547 catch_command_errors (exec_file_command
, execarg
, !batch
, RETURN_MASK_ALL
);
549 catch_command_errors (symbol_file_command
, symarg
, 0, RETURN_MASK_ALL
);
552 /* After the symbol file has been read, print a newline to get us
553 beyond the copyright line... But errors should still set off
554 the error message with a (single) blank line. */
556 printf_filtered ("\n");
557 error_pre_print
= "\n";
558 quit_pre_print
= error_pre_print
;
559 warning_pre_print
= "\nwarning: ";
563 if (catch_command_errors (core_file_command
, corearg
, !batch
, RETURN_MASK_ALL
) == 0)
565 /* See if the core file is really a PID. */
566 if (isdigit (corearg
[0]))
567 catch_command_errors (attach_command
, corearg
, !batch
, RETURN_MASK_ALL
);
572 catch_command_errors (tty_command
, ttyarg
, !batch
, RETURN_MASK_ALL
);
574 #ifdef ADDITIONAL_OPTION_HANDLER
575 ADDITIONAL_OPTION_HANDLER
;
578 /* Error messages should no longer be distinguished with extra output. */
579 error_pre_print
= NULL
;
580 quit_pre_print
= NULL
;
581 warning_pre_print
= "warning: ";
583 /* Read the .gdbinit file in the current directory, *if* it isn't
584 the same as the $HOME/.gdbinit file (it should exist, also). */
587 || memcmp ((char *) &homebuf
, (char *) &cwdbuf
, sizeof (struct stat
)))
588 if (!inhibit_gdbinit
)
590 catch_command_errors (source_command
, gdbinit
, 0, RETURN_MASK_ALL
);
593 for (i
= 0; i
< ncmd
; i
++)
596 /* NOTE: cagney/1999-11-03: SET_TOP_LEVEL() was a macro that
597 expanded into a call to setjmp(). */
598 if (!SET_TOP_LEVEL ()) /* NB: This is #if 0'd out */
600 /* NOTE: I am commenting this out, because it is not clear
601 where this feature is used. It is very old and
602 undocumented. ezannoni: 1999-05-04 */
604 if (cmdarg
[i
][0] == '-' && cmdarg
[i
][1] == '\0')
605 read_command_file (stdin
);
608 source_command (cmdarg
[i
], !batch
);
609 do_cleanups (ALL_CLEANUPS
);
612 catch_command_errors (source_command
, cmdarg
[i
], !batch
, RETURN_MASK_ALL
);
616 /* Read in the old history after all the command files have been read. */
621 /* We have hit the end of the batch file. */
625 /* Do any host- or target-specific hacks. This is used for i960 targets
626 to force the user to set a nindy target and spec its parameters. */
628 #ifdef BEFORE_MAIN_LOOP_HOOK
629 BEFORE_MAIN_LOOP_HOOK
;
632 END_PROGRESS (argv
[0]);
634 /* Show time and/or space usage. */
638 long init_time
= get_run_time () - time_at_startup
;
640 printf_unfiltered ("Startup time: %ld.%06ld\n",
641 init_time
/ 1000000, init_time
% 1000000);
647 extern char **environ
;
648 char *lim
= (char *) sbrk (0);
650 printf_unfiltered ("Startup size: data size %ld\n",
651 (long) (lim
- (char *) &environ
));
655 /* The default command loop.
656 The WIN32 Gui calls this main to set up gdb's state, and
657 has its own command loop. */
658 #if !defined _WIN32 || defined __GNUC__
659 /* GUIs generally have their own command loop, mainloop, or
660 whatever. This is a good place to gain control because many
661 error conditions will end up here via longjmp(). */
663 /* FIXME: cagney/1999-11-06: The original main loop was like: */
666 if (!SET_TOP_LEVEL ())
668 do_cleanups (ALL_CLEANUPS
); /* Do complete cleanup */
669 /* GUIs generally have their own command loop, mainloop, or whatever.
670 This is a good place to gain control because many error
671 conditions will end up here via longjmp(). */
672 if (command_loop_hook
)
673 command_loop_hook ();
676 quit_command ((char *) 0, instream
== stdin
);
679 /* NOTE: If the command_loop() returned normally, the loop would
680 attempt to exit by calling the function quit_command(). That
681 function would either call exit() or throw an error returning
682 control to SET_TOP_LEVEL. */
683 /* NOTE: The function do_cleanups() was called once each time round
684 the loop. The usefulness of the call isn't clear. If an error
685 was thrown, everything would have already been cleaned up. If
686 command_loop() returned normally and quit_command() was called,
687 either exit() or error() (again cleaning up) would be called. */
689 /* NOTE: cagney/1999-11-07: There is probably no reason for not
690 moving this loop and the code found in captured_command_loop()
691 into the command_loop() proper. The main thing holding back that
692 change - SET_TOP_LEVEL() - has been eliminated. */
695 catch_errors (captured_command_loop
, 0, "", RETURN_MASK_ALL
);
698 /* No exit -- exit is through quit_command. */
702 main (int argc
, char **argv
)
704 struct captured_main_args args
;
707 catch_errors (captured_main
, &args
, "", RETURN_MASK_ALL
);
712 /* Don't use *_filtered for printing help. We don't want to prompt
713 for continue no matter how small the screen or how much we're going
717 print_gdb_help (stream
)
721 This is the GNU debugger. Usage:\n\n\
722 gdb [options] [executable-file [core-file or process-id]]\n\n\
726 --[no]async Enable (disable) asynchronous version of CLI\n\
729 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
730 --batch Exit after processing options.\n\
731 --cd=DIR Change current directory to DIR.\n\
732 --command=FILE Execute GDB commands from FILE.\n\
733 --core=COREFILE Analyze the core dump COREFILE.\n\
736 --dbx DBX compatibility mode.\n\
737 --directory=DIR Search for source files in DIR.\n\
738 --epoch Output information used by epoch emacs-GDB interface.\n\
739 --exec=EXECFILE Use EXECFILE as the executable.\n\
740 --fullname Output information used by emacs-GDB interface.\n\
741 --help Print this message.\n\
744 --mapped Use mapped symbol files if supported on this system.\n\
745 --nw Do not use a window interface.\n\
746 --nx Do not read ", stream
);
747 fputs_unfiltered (gdbinit
, stream
);
748 fputs_unfiltered (" file.\n\
749 --quiet Do not print version number on startup.\n\
750 --readnow Fully read symbol files on first access.\n\
753 --se=FILE Use FILE as symbol file and executable file.\n\
754 --symbols=SYMFILE Read symbols from SYMFILE.\n\
755 --tty=TTY Use TTY for input/output by the program being debugged.\n\
759 --tui Use a terminal user interface.\n\
763 --version Print version information and then exit.\n\
764 -w Use a window interface.\n\
765 --write Set writing into executable and core files.\n\
766 --xdb XDB compatibility mode.\n\
768 #ifdef ADDITIONAL_OPTION_HELP
769 fputs_unfiltered (ADDITIONAL_OPTION_HELP
, stream
);
771 fputs_unfiltered ("\n\
772 For more information, type \"help\" from within GDB, or consult the\n\
773 GDB manual (available as on-line info or a printed manual).\n\
774 Report bugs to \"bug-gdb@gnu.org\".\