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, Boston, MA 02111-1307, USA. */
25 #include "call-cmds.h"
32 #include <sys/types.h>
36 #include "gdb_string.h"
37 #include "event-loop.h"
39 /* If nonzero, display time usage both at startup and for each command. */
43 /* If nonzero, display space usage both at startup and for each command. */
47 /* Whether this is the async version or not. The async version is
48 invoked on the command line with the -nw --async options. In this
49 version, the usual command_loop is substituted by and event loop which
50 processes UI events asynchronously. */
53 /* Whether this is the command line version or not */
56 /* Whether xdb commands will be handled */
59 /* Whether dbx commands will be handled */
65 GDB_FILE *gdb_stdtarg;
67 /* Whether to enable writing into executable and core files */
68 extern int write_files;
70 static void print_gdb_help PARAMS ((GDB_FILE *));
72 /* These two are used to set the external editor commands when gdb is farming
73 out files to be edited by another program. */
75 extern int enable_external_editor;
76 extern char * external_editor_command;
79 #include <windows.h> /* for MAX_PATH */
80 #include <sys/cygwin.h> /* for cygwin32_conv_to_posix_path */
92 /* Pointers to various arguments from command line. */
99 /* These are static so that we can take their address in an initializer. */
100 static int print_help;
101 static int print_version;
103 /* Pointers to all arguments of --command option. */
105 /* Allocated size of cmdarg. */
107 /* Number of elements of cmdarg used. */
110 /* Indices of all arguments of --directory option. */
112 /* Allocated size. */
114 /* Number of elements used. */
117 struct stat homebuf, cwdbuf;
118 char *homedir, *homeinit;
122 long time_at_startup = get_run_time ();
126 START_PROGRESS (argv[0], 0);
129 /* Do all Mac-specific setup. */
133 /* This needs to happen before the first use of malloc. */
134 init_malloc ((PTR) NULL);
136 #if defined (ALIGN_STACK_ON_STARTUP)
137 i = (int) &count & 0x3;
142 /* If error() is called from initialization code, just exit */
143 if (SET_TOP_LEVEL ()) {
148 cmdarg = (char **) xmalloc (cmdsize * sizeof (*cmdarg));
151 dirarg = (char **) xmalloc (dirsize * sizeof (*dirarg));
155 line = (char *) xmalloc (linesize);
156 line[0] = '\0'; /* Terminate saved (now empty) cmd line */
159 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
160 current_directory = gdb_dirbuf;
164 gdb_stdout = stdio_fileopen (stdout);
165 gdb_stderr = stdio_fileopen (stderr);
166 gdb_stdlog = gdb_stderr; /* for moment */
167 gdb_stdtarg = gdb_stderr; /* for moment */
169 gdb_stdout = tui_fileopen (stdout);
170 gdb_stderr = tui_fileopen (stderr);
171 gdb_stdlog = gdb_stdout; /* for moment */
172 gdb_stdtarg = gdb_stderr; /* for moment */
175 /* Parse arguments and options. */
178 /* When var field is 0, use flag field to record the equivalent
179 short option (or arbitrary numbers starting at 10 for those
180 with no equivalent). */
181 static struct option long_options[] =
183 {"async", no_argument, &async_p, 1},
184 {"noasync", no_argument, &async_p, 0},
186 {"tui", no_argument, &tui_version, 1},
188 {"xdb", no_argument, &xdb_commands, 1},
189 {"dbx", no_argument, &dbx_commands, 1},
190 {"readnow", no_argument, &readnow_symbol_files, 1},
191 {"r", no_argument, &readnow_symbol_files, 1},
192 {"mapped", no_argument, &mapped_symbol_files, 1},
193 {"m", no_argument, &mapped_symbol_files, 1},
194 {"quiet", no_argument, &quiet, 1},
195 {"q", no_argument, &quiet, 1},
196 {"silent", no_argument, &quiet, 1},
197 {"nx", no_argument, &inhibit_gdbinit, 1},
198 {"n", no_argument, &inhibit_gdbinit, 1},
199 {"batch", no_argument, &batch, 1},
200 {"epoch", no_argument, &epoch_interface, 1},
202 /* This is a synonym for "--annotate=1". --annotate is now preferred,
203 but keep this here for a long time because people will be running
204 emacses which use --fullname. */
205 {"fullname", no_argument, 0, 'f'},
206 {"f", no_argument, 0, 'f'},
208 {"annotate", required_argument, 0, 12},
209 {"help", no_argument, &print_help, 1},
210 {"se", required_argument, 0, 10},
211 {"symbols", required_argument, 0, 's'},
212 {"s", required_argument, 0, 's'},
213 {"exec", required_argument, 0, 'e'},
214 {"e", required_argument, 0, 'e'},
215 {"core", required_argument, 0, 'c'},
216 {"c", required_argument, 0, 'c'},
217 {"command", required_argument, 0, 'x'},
218 {"version", no_argument, &print_version, 1},
219 {"x", required_argument, 0, 'x'},
220 {"directory", required_argument, 0, 'd'},
221 {"cd", required_argument, 0, 11},
222 {"tty", required_argument, 0, 't'},
223 {"baud", required_argument, 0, 'b'},
224 {"b", required_argument, 0, 'b'},
225 {"nw", no_argument, &use_windows, 0},
226 {"nowindows", no_argument, &use_windows, 0},
227 {"w", no_argument, &use_windows, 1},
228 {"windows", no_argument, &use_windows, 1},
229 {"statistics", no_argument, 0, 13},
230 {"write", no_argument, &write_files, 1},
231 /* Allow machine descriptions to add more options... */
232 #ifdef ADDITIONAL_OPTIONS
235 {0, no_argument, 0, 0}
242 c = getopt_long_only (argc, argv, "",
243 long_options, &option_index);
247 /* Long option that takes an argument. */
248 if (c == 0 && long_options[option_index].flag == 0)
249 c = long_options[option_index].val;
254 /* Long option that just sets a flag. */
264 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
265 annotation_level = atoi (optarg);
268 /* Enable the display of both time and space usage. */
273 annotation_level = 1;
274 /* We have probably been invoked from emacs. Disable window interface. */
287 cmdarg[ncmd++] = optarg;
291 cmdarg = (char **) xrealloc ((char *)cmdarg,
292 cmdsize * sizeof (*cmdarg));
296 dirarg[ndir++] = optarg;
300 dirarg = (char **) xrealloc ((char *)dirarg,
301 dirsize * sizeof (*dirarg));
315 i = strtol (optarg, &p, 0);
316 if (i == 0 && p == optarg)
318 /* Don't use *_filtered or warning() (which relies on
319 current_target) until after initialize_all_files(). */
323 "warning: could not set baud rate to `%s'.\n", optarg);
332 i = strtol (optarg, &p, 0);
333 if (i == 0 && p == optarg)
335 /* Don't use *_filtered or warning() (which relies on
336 current_target) until after initialize_all_files(). */
340 "warning: could not set timeout limit to `%s'.\n", optarg);
346 #ifdef ADDITIONAL_OPTION_CASES
347 ADDITIONAL_OPTION_CASES
350 fprintf_unfiltered (gdb_stderr,
351 "Use `%s --help' for a complete list of options.\n",
357 /* If --help or --version, disable window interface. */
358 if (print_help || print_version)
362 /* Disable the TUI as well. */
368 /* An explicit --tui flag overrides the default UI, which is the
374 /* OK, that's all the options. The other arguments are filenames. */
376 for (; optind < argc; optind++)
380 symarg = argv[optind];
381 execarg = argv[optind];
384 corearg = argv[optind];
387 fprintf_unfiltered (gdb_stderr,
388 "Excess command line arguments ignored. (%s%s)\n",
389 argv[optind], (optind == argc - 1) ? "" : " ...");
397 /* Should this be moved to tui-top.c:_initialize_tui()? */
399 init_ui_hook = tuiInit;
402 /* Initialize all files. Give the interpreter a chance to take
403 control of the console via the init_ui_hook()) */
406 /* Do these (and anything which might call wrap_here or *_filtered)
407 after initialize_all_files. */
410 print_gdb_version (gdb_stdout);
412 printf_filtered ("\n");
418 print_gdb_help (gdb_stdout);
419 fputs_unfiltered ("\n", gdb_stdout);
425 /* Print all the junk at the top, with trailing "..." if we are about
426 to read a symbol file (possibly slowly). */
427 print_gdb_version (gdb_stdout);
429 printf_filtered ("..");
431 gdb_flush (gdb_stdout); /* Force to screen during slow operations */
434 error_pre_print = "\n\n";
435 quit_pre_print = error_pre_print;
437 /* We may get more than one warning, don't double space all of them... */
438 warning_pre_print = "\nwarning: ";
440 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
441 *before* all the command line arguments are processed; it sets
442 global parameters, which are independent of what file you are
443 debugging or what directory you are in. */
446 char * tmp = getenv ("HOME");
450 homedir = (char *) alloca (MAX_PATH+1);
451 cygwin32_conv_to_posix_path (tmp, homedir);
457 homedir = getenv ("HOME");
461 homeinit = (char *) alloca (strlen (homedir) +
462 strlen (gdbinit) + 10);
463 strcpy (homeinit, homedir);
464 strcat (homeinit, "/");
465 strcat (homeinit, gdbinit);
467 if (!inhibit_gdbinit)
469 if (!SET_TOP_LEVEL ())
470 source_command (homeinit, 0);
472 do_cleanups (ALL_CLEANUPS);
474 /* Do stats; no need to do them elsewhere since we'll only
475 need them if homedir is set. Make sure that they are
476 zero in case one of them fails (this guarantees that they
477 won't match if either exists). */
479 memset (&homebuf, 0, sizeof (struct stat));
480 memset (&cwdbuf, 0, sizeof (struct stat));
482 stat (homeinit, &homebuf);
483 stat (gdbinit, &cwdbuf); /* We'll only need this if
487 /* Now perform all the actions indicated by the arguments. */
490 if (!SET_TOP_LEVEL ())
492 cd_command (cdarg, 0);
495 do_cleanups (ALL_CLEANUPS);
497 for (i = 0; i < ndir; i++)
498 if (!SET_TOP_LEVEL ())
499 directory_command (dirarg[i], 0);
501 do_cleanups (ALL_CLEANUPS);
505 && STREQ (execarg, symarg))
507 /* The exec file and the symbol-file are the same. If we can't open
508 it, better only print one error message. */
509 if (!SET_TOP_LEVEL ())
511 exec_file_command (execarg, !batch);
512 symbol_file_command (symarg, 0);
518 if (!SET_TOP_LEVEL ())
519 exec_file_command (execarg, !batch);
521 if (!SET_TOP_LEVEL ())
522 symbol_file_command (symarg, 0);
524 do_cleanups (ALL_CLEANUPS);
526 /* After the symbol file has been read, print a newline to get us
527 beyond the copyright line... But errors should still set off
528 the error message with a (single) blank line. */
530 printf_filtered ("\n");
531 error_pre_print = "\n";
532 quit_pre_print = error_pre_print;
533 warning_pre_print = "\nwarning: ";
537 if (!SET_TOP_LEVEL ())
538 core_file_command (corearg, !batch);
539 else if (isdigit (corearg[0]) && !SET_TOP_LEVEL ())
540 attach_command (corearg, !batch);
542 do_cleanups (ALL_CLEANUPS);
545 if (!SET_TOP_LEVEL ())
546 tty_command (ttyarg, !batch);
547 do_cleanups (ALL_CLEANUPS);
549 #ifdef ADDITIONAL_OPTION_HANDLER
550 ADDITIONAL_OPTION_HANDLER;
553 /* Error messages should no longer be distinguished with extra output. */
554 error_pre_print = NULL;
555 quit_pre_print = NULL;
556 warning_pre_print = "warning: ";
558 /* Read the .gdbinit file in the current directory, *if* it isn't
559 the same as the $HOME/.gdbinit file (it should exist, also). */
562 || memcmp ((char *) &homebuf, (char *) &cwdbuf, sizeof (struct stat)))
563 if (!inhibit_gdbinit)
565 if (!SET_TOP_LEVEL ())
566 source_command (gdbinit, 0);
568 do_cleanups (ALL_CLEANUPS);
570 for (i = 0; i < ncmd; i++)
572 if (!SET_TOP_LEVEL ())
574 /* NOTE: I am commenting this out, because it is not clear
575 where this feature is used. It is very old and
576 undocumented. ezannoni: 1999-05-04*/
578 if (cmdarg[i][0] == '-' && cmdarg[i][1] == '\0')
579 read_command_file (stdin);
582 source_command (cmdarg[i], !batch);
583 do_cleanups (ALL_CLEANUPS);
588 /* Read in the old history after all the command files have been read. */
593 /* We have hit the end of the batch file. */
597 /* Do any host- or target-specific hacks. This is used for i960 targets
598 to force the user to set a nindy target and spec its parameters. */
600 #ifdef BEFORE_MAIN_LOOP_HOOK
601 BEFORE_MAIN_LOOP_HOOK;
604 END_PROGRESS (argv[0]);
606 /* Show time and/or space usage. */
610 long init_time = get_run_time () - time_at_startup;
612 printf_unfiltered ("Startup time: %ld.%06ld\n",
613 init_time / 1000000, init_time % 1000000);
619 extern char **environ;
620 char *lim = (char *) sbrk (0);
622 printf_unfiltered ("Startup size: data size %ld\n",
623 (long) (lim - (char *) &environ));
627 /* The default command loop.
628 The WIN32 Gui calls this main to set up gdb's state, and
629 has its own command loop. */
630 #if !defined _WIN32 || defined __GNUC__
633 if (!SET_TOP_LEVEL ())
635 do_cleanups (ALL_CLEANUPS); /* Do complete cleanup */
636 /* GUIs generally have their own command loop, mainloop, or whatever.
637 This is a good place to gain control because many error
638 conditions will end up here via longjmp(). */
639 if (command_loop_hook)
640 command_loop_hook ();
643 quit_command ((char *)0, instream == stdin);
646 /* No exit -- exit is through quit_command. */
651 /* Don't use *_filtered for printing help. We don't want to prompt
652 for continue no matter how small the screen or how much we're going
656 print_gdb_help (stream)
660 This is the GNU debugger. Usage:\n\n\
661 gdb [options] [executable-file [core-file or process-id]]\n\n\
665 --[no]async Enable (disable) asynchronous version of CLI\n\
668 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
669 --batch Exit after processing options.\n\
670 --cd=DIR Change current directory to DIR.\n\
671 --command=FILE Execute GDB commands from FILE.\n\
672 --core=COREFILE Analyze the core dump COREFILE.\n\
675 --dbx DBX compatibility mode.\n\
676 --directory=DIR Search for source files in DIR.\n\
677 --epoch Output information used by epoch emacs-GDB interface.\n\
678 --exec=EXECFILE Use EXECFILE as the executable.\n\
679 --fullname Output information used by emacs-GDB interface.\n\
680 --help Print this message.\n\
683 --mapped Use mapped symbol files if supported on this system.\n\
684 --nw Do not use a window interface.\n\
685 --nx Do not read .gdbinit file.\n\
686 --quiet Do not print version number on startup.\n\
687 --readnow Fully read symbol files on first access.\n\
690 --se=FILE Use FILE as symbol file and executable file.\n\
691 --symbols=SYMFILE Read symbols from SYMFILE.\n\
692 --tty=TTY Use TTY for input/output by the program being debugged.\n\
696 --tui Use a terminal user interface.\n\
700 --version Print version information and then exit.\n\
701 -w Use a window interface.\n\
702 --write Set writing into executable and core files.\n\
703 --xdb XDB compatibility mode.\n\
705 #ifdef ADDITIONAL_OPTION_HELP
706 fputs_unfiltered (ADDITIONAL_OPTION_HELP, stream);
708 fputs_unfiltered ("\n\
709 For more information, type \"help\" from within GDB, or consult the\n\
710 GDB manual (available as on-line info or a printed manual).\n\
711 Report bugs to \"bug-gdb@prep.ai.mit.edu\".\
716 /* All TUI I/O sent to the *_filtered and *_unfiltered functions
717 eventually ends up here. The fputs_unfiltered_hook is primarily
718 used by GUIs to collect all output and send it to the GUI, instead
719 of the controlling terminal. Only output to gdb_stdout and
720 gdb_stderr are sent to the hook. Everything else is sent on to
721 fputs to allow file I/O to be handled appropriately. */
723 /* FIXME: Should be broken up and moved to a TUI specific file. */
726 tui_file_fputs (linebuffer, file)
727 const char *linebuffer;
730 struct tui_stream *stream = gdb_file_data (file);
732 extern int tui_owns_terminal;
734 /* If anything (GUI, TUI) wants to capture GDB output, this is
735 * the place... the way to do it is to set up
736 * fputs_unfiltered_hook.
737 * Our TUI ("gdb -tui") used to hook output, but in the
738 * new (XDB style) scheme, we do not do that anymore... - RT
740 if (fputs_unfiltered_hook
741 && (file == gdb_stdout
742 || file == gdb_stderr))
743 fputs_unfiltered_hook (linebuffer, file);
747 if (tui_version && tui_owns_terminal) {
748 /* If we get here somehow while updating the TUI (from
749 * within a tuiDo(), then we need to temporarily
750 * set up the terminal for GDB output. This probably just
751 * happens on error output.
754 if (stream->ts_streamtype == astring) {
755 gdb_file_adjust_strbuf(strlen(linebuffer), stream);
756 strcat(stream->ts_strbuf, linebuffer);
758 tuiTermUnsetup(0, (tui_version) ? cmdWin->detail.commandInfo.curch : 0);
759 fputs (linebuffer, stream->ts_filestream);
761 if (linebuffer[strlen(linebuffer) - 1] == '\n')
762 tuiClearCommandCharCount();
764 tuiIncrCommandCharCountBy(strlen(linebuffer));
767 /* The normal case - just do a fputs() */
768 if (stream->ts_streamtype == astring) {
769 gdb_file_adjust_strbuf(strlen(linebuffer), stream);
770 strcat(stream->ts_strbuf, linebuffer);
771 } else fputs (linebuffer, stream->ts_filestream);
776 if (stream->ts_streamtype == astring) {
777 gdb_file_adjust_strbuf(strlen(linebuffer), file);
778 strcat(stream->ts_strbuf, linebuffer);
779 } else fputs (linebuffer, stream->ts_filestream);