1 /* Top level stuff for GDB, the GNU debugger.
2 Copyright 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995
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. */
27 #include "call-cmds.h"
31 #include <sys/types.h>
35 #include "gdb_string.h"
37 /* Temporary variable for SET_TOP_LEVEL. */
39 static int top_level_val;
41 /* Do a setjmp on error_return and quit_return. catch_errors is
42 generally a cleaner way to do this, but main() would look pretty
43 ugly if it had to use catch_errors each time. */
45 #define SET_TOP_LEVEL() \
46 (((top_level_val = SIGSETJMP (error_return)) \
47 ? (PTR) 0 : (PTR) memcpy (quit_return, error_return, sizeof (SIGJMP_BUF))) \
50 /* If nonzero, display time usage both at startup and for each command. */
54 /* If nonzero, display space usage both at startup and for each command. */
58 /* Whether this is the command line version or not */
61 /* Whether xdb commands will be handled */
64 /* Whether dbx commands will be handled */
70 /* Whether to enable writing into executable and core files */
71 extern int write_files;
73 static void print_gdb_help PARAMS ((GDB_FILE *));
74 extern void gdb_init PARAMS ((char *));
76 /* These two are used to set the external editor commands when gdb is farming
77 out files to be edited by another program. */
79 extern int enable_external_editor;
80 extern char * external_editor_command;
83 #include <windows.h> /* for MAX_PATH */
84 #include <sys/cygwin.h> /* for cygwin32_conv_to_posix_path */
96 /* Pointers to various arguments from command line. */
103 /* These are static so that we can take their address in an initializer. */
104 static int print_help;
105 static int print_version;
107 /* Pointers to all arguments of --command option. */
109 /* Allocated size of cmdarg. */
111 /* Number of elements of cmdarg used. */
114 /* Indices of all arguments of --directory option. */
116 /* Allocated size. */
118 /* Number of elements used. */
121 struct stat homebuf, cwdbuf;
122 char *homedir, *homeinit;
126 long time_at_startup = get_run_time ();
130 START_PROGRESS (argv[0], 0);
133 /* Do all Mac-specific setup. */
137 /* This needs to happen before the first use of malloc. */
138 init_malloc ((PTR) NULL);
140 #if defined (ALIGN_STACK_ON_STARTUP)
141 i = (int) &count & 0x3;
146 /* If error() is called from initialization code, just exit */
147 if (SET_TOP_LEVEL ()) {
152 cmdarg = (char **) xmalloc (cmdsize * sizeof (*cmdarg));
155 dirarg = (char **) xmalloc (dirsize * sizeof (*dirarg));
159 line = (char *) xmalloc (linesize);
160 line[0] = '\0'; /* Terminate saved (now empty) cmd line */
163 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
164 current_directory = gdb_dirbuf;
166 gdb_file_size = sizeof(GDB_FILE);
168 gdb_stdout = (GDB_FILE *)xmalloc (gdb_file_size);
169 gdb_stdout->ts_streamtype = afile;
170 gdb_stdout->ts_filestream = stdout;
171 gdb_stdout->ts_strbuf = NULL;
172 gdb_stdout->ts_buflen = 0;
174 gdb_stderr = (GDB_FILE *)xmalloc (gdb_file_size);
175 gdb_stderr->ts_streamtype = afile;
176 gdb_stderr->ts_filestream = stderr;
177 gdb_stderr->ts_strbuf = NULL;
178 gdb_stderr->ts_buflen = 0;
180 /* Parse arguments and options. */
183 /* When var field is 0, use flag field to record the equivalent
184 short option (or arbitrary numbers starting at 10 for those
185 with no equivalent). */
186 static struct option long_options[] =
189 {"tui", no_argument, &tui_version, 1},
191 {"xdb", no_argument, &xdb_commands, 1},
192 {"dbx", no_argument, &dbx_commands, 1},
193 {"readnow", no_argument, &readnow_symbol_files, 1},
194 {"r", no_argument, &readnow_symbol_files, 1},
195 {"mapped", no_argument, &mapped_symbol_files, 1},
196 {"m", no_argument, &mapped_symbol_files, 1},
197 {"quiet", no_argument, &quiet, 1},
198 {"q", no_argument, &quiet, 1},
199 {"silent", no_argument, &quiet, 1},
200 {"nx", no_argument, &inhibit_gdbinit, 1},
201 {"n", no_argument, &inhibit_gdbinit, 1},
202 {"batch", no_argument, &batch, 1},
203 {"epoch", no_argument, &epoch_interface, 1},
205 /* This is a synonym for "--annotate=1". --annotate is now preferred,
206 but keep this here for a long time because people will be running
207 emacses which use --fullname. */
208 {"fullname", no_argument, 0, 'f'},
209 {"f", no_argument, 0, 'f'},
211 {"annotate", required_argument, 0, 12},
212 {"help", no_argument, &print_help, 1},
213 {"se", required_argument, 0, 10},
214 {"symbols", required_argument, 0, 's'},
215 {"s", required_argument, 0, 's'},
216 {"exec", required_argument, 0, 'e'},
217 {"e", required_argument, 0, 'e'},
218 {"core", required_argument, 0, 'c'},
219 {"c", required_argument, 0, 'c'},
220 {"command", required_argument, 0, 'x'},
221 {"version", no_argument, &print_version, 1},
222 {"x", required_argument, 0, 'x'},
223 {"directory", required_argument, 0, 'd'},
224 {"cd", required_argument, 0, 11},
225 {"tty", required_argument, 0, 't'},
226 {"baud", required_argument, 0, 'b'},
227 {"b", required_argument, 0, 'b'},
228 {"nw", no_argument, &use_windows, 0},
229 {"nowindows", no_argument, &use_windows, 0},
230 {"w", no_argument, &use_windows, 1},
231 {"windows", no_argument, &use_windows, 1},
232 {"statistics", no_argument, 0, 13},
233 {"write", no_argument, &write_files, 1},
234 /* Allow machine descriptions to add more options... */
235 #ifdef ADDITIONAL_OPTIONS
238 {0, no_argument, 0, 0}
245 c = getopt_long_only (argc, argv, "",
246 long_options, &option_index);
250 /* Long option that takes an argument. */
251 if (c == 0 && long_options[option_index].flag == 0)
252 c = long_options[option_index].val;
257 /* Long option that just sets a flag. */
267 /* FIXME: what if the syntax is wrong (e.g. not digits)? */
268 annotation_level = atoi (optarg);
271 /* Enable the display of both time and space usage. */
276 annotation_level = 1;
277 /* We have probably been invoked from emacs. Disable window interface. */
290 cmdarg[ncmd++] = optarg;
294 cmdarg = (char **) xrealloc ((char *)cmdarg,
295 cmdsize * sizeof (*cmdarg));
299 dirarg[ndir++] = optarg;
303 dirarg = (char **) xrealloc ((char *)dirarg,
304 dirsize * sizeof (*dirarg));
318 i = strtol (optarg, &p, 0);
319 if (i == 0 && p == optarg)
321 /* Don't use *_filtered or warning() (which relies on
322 current_target) until after initialize_all_files(). */
326 "warning: could not set baud rate to `%s'.\n", optarg);
335 i = strtol (optarg, &p, 0);
336 if (i == 0 && p == optarg)
338 /* Don't use *_filtered or warning() (which relies on
339 current_target) until after initialize_all_files(). */
343 "warning: could not set timeout limit to `%s'.\n", optarg);
349 #ifdef ADDITIONAL_OPTION_CASES
350 ADDITIONAL_OPTION_CASES
353 fprintf_unfiltered (gdb_stderr,
354 "Use `%s --help' for a complete list of options.\n",
360 /* If --help or --version, disable window interface. */
361 if (print_help || print_version)
365 /* Disable the TUI as well. */
371 /* An explicit --tui flag overrides the default UI, which is the
377 /* OK, that's all the options. The other arguments are filenames. */
379 for (; optind < argc; optind++)
383 symarg = argv[optind];
384 execarg = argv[optind];
387 corearg = argv[optind];
390 fprintf_unfiltered (gdb_stderr,
391 "Excess command line arguments ignored. (%s%s)\n",
392 argv[optind], (optind == argc - 1) ? "" : " ...");
401 init_ui_hook = tuiInit;
405 /* Do these (and anything which might call wrap_here or *_filtered)
406 after initialize_all_files. */
409 print_gdb_version (gdb_stdout);
411 printf_filtered ("\n");
417 print_gdb_help (gdb_stdout);
418 fputs_unfiltered ("\n", gdb_stdout);
424 /* Print all the junk at the top, with trailing "..." if we are about
425 to read a symbol file (possibly slowly). */
426 print_gdb_version (gdb_stdout);
428 printf_filtered ("..");
430 gdb_flush (gdb_stdout); /* Force to screen during slow operations */
433 error_pre_print = "\n\n";
434 quit_pre_print = error_pre_print;
436 /* We may get more than one warning, don't double space all of them... */
437 warning_pre_print = "\nwarning: ";
439 /* Read and execute $HOME/.gdbinit file, if it exists. This is done
440 *before* all the command line arguments are processed; it sets
441 global parameters, which are independent of what file you are
442 debugging or what directory you are in. */
445 char * tmp = getenv ("HOME");
449 homedir = (char *) alloca (MAX_PATH+1);
450 cygwin32_conv_to_posix_path (tmp, homedir);
456 homedir = getenv ("HOME");
460 homeinit = (char *) alloca (strlen (homedir) +
461 strlen (gdbinit) + 10);
462 strcpy (homeinit, homedir);
463 strcat (homeinit, "/");
464 strcat (homeinit, gdbinit);
466 if (!inhibit_gdbinit)
468 if (!SET_TOP_LEVEL ())
469 source_command (homeinit, 0);
471 do_cleanups (ALL_CLEANUPS);
473 /* Do stats; no need to do them elsewhere since we'll only
474 need them if homedir is set. Make sure that they are
475 zero in case one of them fails (this guarantees that they
476 won't match if either exists). */
478 memset (&homebuf, 0, sizeof (struct stat));
479 memset (&cwdbuf, 0, sizeof (struct stat));
481 stat (homeinit, &homebuf);
482 stat (gdbinit, &cwdbuf); /* We'll only need this if
486 /* Now perform all the actions indicated by the arguments. */
489 if (!SET_TOP_LEVEL ())
491 cd_command (cdarg, 0);
494 do_cleanups (ALL_CLEANUPS);
496 for (i = 0; i < ndir; i++)
497 if (!SET_TOP_LEVEL ())
498 directory_command (dirarg[i], 0);
500 do_cleanups (ALL_CLEANUPS);
504 && STREQ (execarg, symarg))
506 /* The exec file and the symbol-file are the same. If we can't open
507 it, better only print one error message. */
508 if (!SET_TOP_LEVEL ())
510 exec_file_command (execarg, !batch);
511 symbol_file_command (symarg, 0);
517 if (!SET_TOP_LEVEL ())
518 exec_file_command (execarg, !batch);
520 if (!SET_TOP_LEVEL ())
521 symbol_file_command (symarg, 0);
523 do_cleanups (ALL_CLEANUPS);
525 /* After the symbol file has been read, print a newline to get us
526 beyond the copyright line... But errors should still set off
527 the error message with a (single) blank line. */
529 printf_filtered ("\n");
530 error_pre_print = "\n";
531 quit_pre_print = error_pre_print;
532 warning_pre_print = "\nwarning: ";
536 if (!SET_TOP_LEVEL ())
537 core_file_command (corearg, !batch);
538 else if (isdigit (corearg[0]) && !SET_TOP_LEVEL ())
539 attach_command (corearg, !batch);
541 do_cleanups (ALL_CLEANUPS);
544 if (!SET_TOP_LEVEL ())
545 tty_command (ttyarg, !batch);
546 do_cleanups (ALL_CLEANUPS);
548 #ifdef ADDITIONAL_OPTION_HANDLER
549 ADDITIONAL_OPTION_HANDLER;
552 /* Error messages should no longer be distinguished with extra output. */
553 error_pre_print = NULL;
554 quit_pre_print = NULL;
555 warning_pre_print = "warning: ";
557 /* Read the .gdbinit file in the current directory, *if* it isn't
558 the same as the $HOME/.gdbinit file (it should exist, also). */
561 || memcmp ((char *) &homebuf, (char *) &cwdbuf, sizeof (struct stat)))
562 if (!inhibit_gdbinit)
564 if (!SET_TOP_LEVEL ())
565 source_command (gdbinit, 0);
567 do_cleanups (ALL_CLEANUPS);
569 for (i = 0; i < ncmd; i++)
571 if (!SET_TOP_LEVEL ())
573 if (cmdarg[i][0] == '-' && cmdarg[i][1] == '\0')
574 read_command_file (stdin);
576 source_command (cmdarg[i], !batch);
577 do_cleanups (ALL_CLEANUPS);
582 /* Read in the old history after all the command files have been read. */
587 /* We have hit the end of the batch file. */
591 /* Do any host- or target-specific hacks. This is used for i960 targets
592 to force the user to set a nindy target and spec its parameters. */
594 #ifdef BEFORE_MAIN_LOOP_HOOK
595 BEFORE_MAIN_LOOP_HOOK;
598 END_PROGRESS (argv[0]);
600 /* Show time and/or space usage. */
604 long init_time = get_run_time () - time_at_startup;
606 printf_unfiltered ("Startup time: %ld.%06ld\n",
607 init_time / 1000000, init_time % 1000000);
613 extern char **environ;
614 char *lim = (char *) sbrk (0);
616 printf_unfiltered ("Startup size: data size %ld\n",
617 (long) (lim - (char *) &environ));
621 /* The default command loop.
622 The WIN32 Gui calls this main to set up gdb's state, and
623 has its own command loop. */
624 #if !defined _WIN32 || defined __GNUC__
627 if (!SET_TOP_LEVEL ())
629 do_cleanups (ALL_CLEANUPS); /* Do complete cleanup */
630 /* GUIs generally have their own command loop, mainloop, or whatever.
631 This is a good place to gain control because many error
632 conditions will end up here via longjmp(). */
633 if (command_loop_hook)
634 command_loop_hook ();
637 quit_command ((char *)0, instream == stdin);
641 /* No exit -- exit is through quit_command. */
646 /* Don't use *_filtered for printing help. We don't want to prompt
647 for continue no matter how small the screen or how much we're going
651 print_gdb_help (stream)
655 This is the GNU debugger. Usage:\n\n\
656 gdb [options] [executable-file [core-file or process-id]]\n\n\
660 -b BAUDRATE Set serial port baud rate used for remote debugging.\n\
661 --batch Exit after processing options.\n\
662 --cd=DIR Change current directory to DIR.\n\
663 --command=FILE Execute GDB commands from FILE.\n\
664 --core=COREFILE Analyze the core dump COREFILE.\n\
667 --dbx DBX compatibility mode.\n\
668 --directory=DIR Search for source files in DIR.\n\
669 --epoch Output information used by epoch emacs-GDB interface.\n\
670 --exec=EXECFILE Use EXECFILE as the executable.\n\
671 --fullname Output information used by emacs-GDB interface.\n\
672 --help Print this message.\n\
675 --mapped Use mapped symbol files if supported on this system.\n\
676 --nw Do not use a window interface.\n\
677 --nx Do not read .gdbinit file.\n\
678 --quiet Do not print version number on startup.\n\
679 --readnow Fully read symbol files on first access.\n\
682 --se=FILE Use FILE as symbol file and executable file.\n\
683 --symbols=SYMFILE Read symbols from SYMFILE.\n\
684 --tty=TTY Use TTY for input/output by the program being debugged.\n\
688 --tui Use a terminal user interface.\n\
692 --version Print version information and then exit.\n\
693 -w Use a window interface.\n\
694 --write Set writing into executable and core files.\n\
695 --xdb XDB compatibility mode.\n\
697 #ifdef ADDITIONAL_OPTION_HELP
698 fputs_unfiltered (ADDITIONAL_OPTION_HELP, stream);
700 fputs_unfiltered ("\n\
701 For more information, type \"help\" from within GDB, or consult the\n\
702 GDB manual (available as on-line info or a printed manual).\n\
703 Report bugs to \"bug-gdb@prep.ai.mit.edu\".\
714 proc_remove_foreign (pid)
719 /* All I/O sent to the *_filtered and *_unfiltered functions eventually ends up
720 here. The fputs_unfiltered_hook is primarily used by GUIs to collect all
721 output and send it to the GUI, instead of the controlling terminal. Only
722 output to gdb_stdout and gdb_stderr are sent to the hook. Everything else
723 is sent on to fputs to allow file I/O to be handled appropriately. */
726 fputs_unfiltered (linebuffer, stream)
727 const char *linebuffer;
731 extern int tui_owns_terminal;
733 /* If anything (GUI, TUI) wants to capture GDB output, this is
734 * the place... the way to do it is to set up
735 * fputs_unfiltered_hook.
736 * Our TUI ("gdb -tui") used to hook output, but in the
737 * new (XDB style) scheme, we do not do that anymore... - RT
739 if (fputs_unfiltered_hook
740 && (stream == gdb_stdout
741 || stream == gdb_stderr))
742 fputs_unfiltered_hook (linebuffer, stream);
746 if (tui_version && tui_owns_terminal) {
747 /* If we get here somehow while updating the TUI (from
748 * within a tuiDo(), then we need to temporarily
749 * set up the terminal for GDB output. This probably just
750 * happens on error output.
753 if (stream->ts_streamtype == astring) {
754 gdb_file_adjust_strbuf(strlen(linebuffer), stream);
755 strcat(stream->ts_strbuf, linebuffer);
757 tuiTermUnsetup(0, (tui_version) ? cmdWin->detail.commandInfo.curch : 0);
758 fputs (linebuffer, stream->ts_filestream);
760 if (linebuffer[strlen(linebuffer) - 1] == '\n')
761 tuiClearCommandCharCount();
763 tuiIncrCommandCharCountBy(strlen(linebuffer));
766 /* The normal case - just do a fputs() */
767 if (stream->ts_streamtype == astring) {
768 gdb_file_adjust_strbuf(strlen(linebuffer), stream);
769 strcat(stream->ts_strbuf, linebuffer);
770 } else fputs (linebuffer, stream->ts_filestream);
775 if (stream->ts_streamtype == astring) {
776 gdb_file_adjust_strbuf(strlen(linebuffer), stream);
777 strcat(stream->ts_strbuf, linebuffer);
778 } else fputs (linebuffer, stream->ts_filestream);