Revert "Add support for the readnever concept"
[external/binutils.git] / gdb / main.c
1 /* Top level stuff for GDB, the GNU debugger.
2
3    Copyright (C) 1986-2017 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
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 3 of the License, or
10    (at your option) any later version.
11
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.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #include "defs.h"
21 #include "top.h"
22 #include "target.h"
23 #include "inferior.h"
24 #include "symfile.h"
25 #include "gdbcore.h"
26 #include "getopt.h"
27
28 #include <sys/types.h>
29 #include <sys/stat.h>
30 #include <ctype.h>
31 #include "event-loop.h"
32 #include "ui-out.h"
33
34 #include "interps.h"
35 #include "main.h"
36 #include "source.h"
37 #include "cli/cli-cmds.h"
38 #include "objfiles.h"
39 #include "auto-load.h"
40 #include "maint.h"
41
42 #include "filenames.h"
43 #include "filestuff.h"
44 #include <signal.h>
45 #include "event-top.h"
46 #include "infrun.h"
47 #include "signals-state-save-restore.h"
48 #include <vector>
49
50 /* The selected interpreter.  This will be used as a set command
51    variable, so it should always be malloc'ed - since
52    do_setshow_command will free it.  */
53 char *interpreter_p;
54
55 /* Whether dbx commands will be handled.  */
56 int dbx_commands = 0;
57
58 /* System root path, used to find libraries etc.  */
59 char *gdb_sysroot = 0;
60
61 /* GDB datadir, used to store data files.  */
62 char *gdb_datadir = 0;
63
64 /* Non-zero if GDB_DATADIR was provided on the command line.
65    This doesn't track whether data-directory is set later from the
66    command line, but we don't reread system.gdbinit when that happens.  */
67 static int gdb_datadir_provided = 0;
68
69 /* If gdb was configured with --with-python=/path,
70    the possibly relocated path to python's lib directory.  */
71 char *python_libdir = 0;
72
73 /* Target IO streams.  */
74 struct ui_file *gdb_stdtargin;
75 struct ui_file *gdb_stdtarg;
76 struct ui_file *gdb_stdtargerr;
77
78 /* True if --batch or --batch-silent was seen.  */
79 int batch_flag = 0;
80
81 /* Support for the --batch-silent option.  */
82 int batch_silent = 0;
83
84 /* Support for --return-child-result option.
85    Set the default to -1 to return error in the case
86    that the program does not run or does not complete.  */
87 int return_child_result = 0;
88 int return_child_result_value = -1;
89
90
91 /* GDB as it has been invoked from the command line (i.e. argv[0]).  */
92 static char *gdb_program_name;
93
94 /* Return read only pointer to GDB_PROGRAM_NAME.  */
95 const char *
96 get_gdb_program_name (void)
97 {
98   return gdb_program_name;
99 }
100
101 static void print_gdb_help (struct ui_file *);
102
103 /* Set the data-directory parameter to NEW_DATADIR.
104    If NEW_DATADIR is not a directory then a warning is printed.
105    We don't signal an error for backward compatibility.  */
106
107 void
108 set_gdb_data_directory (const char *new_datadir)
109 {
110   struct stat st;
111
112   if (stat (new_datadir, &st) < 0)
113     {
114       int save_errno = errno;
115
116       fprintf_unfiltered (gdb_stderr, "Warning: ");
117       print_sys_errmsg (new_datadir, save_errno);
118     }
119   else if (!S_ISDIR (st.st_mode))
120     warning (_("%s is not a directory."), new_datadir);
121
122   xfree (gdb_datadir);
123   gdb_datadir = gdb_realpath (new_datadir).release ();
124
125   /* gdb_realpath won't return an absolute path if the path doesn't exist,
126      but we still want to record an absolute path here.  If the user entered
127      "../foo" and "../foo" doesn't exist then we'll record $(pwd)/../foo which
128      isn't canonical, but that's ok.  */
129   if (!IS_ABSOLUTE_PATH (gdb_datadir))
130     {
131       gdb::unique_xmalloc_ptr<char> abs_datadir = gdb_abspath (gdb_datadir);
132
133       xfree (gdb_datadir);
134       gdb_datadir = abs_datadir.release ();
135     }
136 }
137
138 /* Relocate a file or directory.  PROGNAME is the name by which gdb
139    was invoked (i.e., argv[0]).  INITIAL is the default value for the
140    file or directory.  FLAG is true if the value is relocatable, false
141    otherwise.  Returns a newly allocated string; this may return NULL
142    under the same conditions as make_relative_prefix.  */
143
144 static char *
145 relocate_path (const char *progname, const char *initial, int flag)
146 {
147   if (flag)
148     return make_relative_prefix (progname, BINDIR, initial);
149   return xstrdup (initial);
150 }
151
152 /* Like relocate_path, but specifically checks for a directory.
153    INITIAL is relocated according to the rules of relocate_path.  If
154    the result is a directory, it is used; otherwise, INITIAL is used.
155    The chosen directory is then canonicalized using lrealpath.  This
156    function always returns a newly-allocated string.  */
157
158 char *
159 relocate_gdb_directory (const char *initial, int flag)
160 {
161   char *dir;
162
163   dir = relocate_path (gdb_program_name, initial, flag);
164   if (dir)
165     {
166       struct stat s;
167
168       if (*dir == '\0' || stat (dir, &s) != 0 || !S_ISDIR (s.st_mode))
169         {
170           xfree (dir);
171           dir = NULL;
172         }
173     }
174   if (!dir)
175     dir = xstrdup (initial);
176
177   /* Canonicalize the directory.  */
178   if (*dir)
179     {
180       char *canon_sysroot = lrealpath (dir);
181
182       if (canon_sysroot)
183         {
184           xfree (dir);
185           dir = canon_sysroot;
186         }
187     }
188
189   return dir;
190 }
191
192 /* Compute the locations of init files that GDB should source and
193    return them in SYSTEM_GDBINIT, HOME_GDBINIT, LOCAL_GDBINIT.  If
194    there is no system gdbinit (resp. home gdbinit and local gdbinit)
195    to be loaded, then SYSTEM_GDBINIT (resp. HOME_GDBINIT and
196    LOCAL_GDBINIT) is set to NULL.  */
197 static void
198 get_init_files (const char **system_gdbinit,
199                 const char **home_gdbinit,
200                 const char **local_gdbinit)
201 {
202   static const char *sysgdbinit = NULL;
203   static char *homeinit = NULL;
204   static const char *localinit = NULL;
205   static int initialized = 0;
206
207   if (!initialized)
208     {
209       struct stat homebuf, cwdbuf, s;
210       char *homedir;
211
212       if (SYSTEM_GDBINIT[0])
213         {
214           int datadir_len = strlen (GDB_DATADIR);
215           int sys_gdbinit_len = strlen (SYSTEM_GDBINIT);
216           char *relocated_sysgdbinit;
217
218           /* If SYSTEM_GDBINIT lives in data-directory, and data-directory
219              has been provided, search for SYSTEM_GDBINIT there.  */
220           if (gdb_datadir_provided
221               && datadir_len < sys_gdbinit_len
222               && filename_ncmp (SYSTEM_GDBINIT, GDB_DATADIR, datadir_len) == 0
223               && IS_DIR_SEPARATOR (SYSTEM_GDBINIT[datadir_len]))
224             {
225               /* Append the part of SYSTEM_GDBINIT that follows GDB_DATADIR
226                  to gdb_datadir.  */
227               char *tmp_sys_gdbinit = xstrdup (&SYSTEM_GDBINIT[datadir_len]);
228               char *p;
229
230               for (p = tmp_sys_gdbinit; IS_DIR_SEPARATOR (*p); ++p)
231                 continue;
232               relocated_sysgdbinit = concat (gdb_datadir, SLASH_STRING, p,
233                                              (char *) NULL);
234               xfree (tmp_sys_gdbinit);
235             }
236           else
237             {
238               relocated_sysgdbinit = relocate_path (gdb_program_name,
239                                                     SYSTEM_GDBINIT,
240                                                     SYSTEM_GDBINIT_RELOCATABLE);
241             }
242           if (relocated_sysgdbinit && stat (relocated_sysgdbinit, &s) == 0)
243             sysgdbinit = relocated_sysgdbinit;
244           else
245             xfree (relocated_sysgdbinit);
246         }
247
248       homedir = getenv ("HOME");
249
250       /* If the .gdbinit file in the current directory is the same as
251          the $HOME/.gdbinit file, it should not be sourced.  homebuf
252          and cwdbuf are used in that purpose.  Make sure that the stats
253          are zero in case one of them fails (this guarantees that they
254          won't match if either exists).  */
255
256       memset (&homebuf, 0, sizeof (struct stat));
257       memset (&cwdbuf, 0, sizeof (struct stat));
258
259       if (homedir)
260         {
261           homeinit = xstrprintf ("%s/%s", homedir, gdbinit);
262           if (stat (homeinit, &homebuf) != 0)
263             {
264               xfree (homeinit);
265               homeinit = NULL;
266             }
267         }
268
269       if (stat (gdbinit, &cwdbuf) == 0)
270         {
271           if (!homeinit
272               || memcmp ((char *) &homebuf, (char *) &cwdbuf,
273                          sizeof (struct stat)))
274             localinit = gdbinit;
275         }
276       
277       initialized = 1;
278     }
279
280   *system_gdbinit = sysgdbinit;
281   *home_gdbinit = homeinit;
282   *local_gdbinit = localinit;
283 }
284
285 /* Try to set up an alternate signal stack for SIGSEGV handlers.
286    This allows us to handle SIGSEGV signals generated when the
287    normal process stack is exhausted.  If this stack is not set
288    up (sigaltstack is unavailable or fails) and a SIGSEGV is
289    generated when the normal stack is exhausted then the program
290    will behave as though no SIGSEGV handler was installed.  */
291
292 static void
293 setup_alternate_signal_stack (void)
294 {
295 #ifdef HAVE_SIGALTSTACK
296   stack_t ss;
297
298   /* FreeBSD versions older than 11.0 use char * for ss_sp instead of
299      void *.  This cast works with both types.  */
300   ss.ss_sp = (char *) xmalloc (SIGSTKSZ);
301   ss.ss_size = SIGSTKSZ;
302   ss.ss_flags = 0;
303
304   sigaltstack(&ss, NULL);
305 #endif
306 }
307
308 /* Call command_loop.  */
309
310 /* Prevent inlining this function for the benefit of GDB's selftests
311    in the testsuite.  Those tests want to run GDB under GDB and stop
312    here.  */
313 static void captured_command_loop () __attribute__((noinline));
314
315 static void
316 captured_command_loop ()
317 {
318   struct ui *ui = current_ui;
319
320   /* Top-level execution commands can be run in the background from
321      here on.  */
322   current_ui->async = 1;
323
324   /* Give the interpreter a chance to print a prompt, if necessary  */
325   if (ui->prompt_state != PROMPT_BLOCKED)
326     interp_pre_command_loop (top_level_interpreter ());
327
328   /* Now it's time to start the event loop.  */
329   start_event_loop ();
330
331   /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
332      would clean things up (restoring the cleanup chain) to the state
333      they were just prior to the call.  Technically, this means that
334      the do_cleanups() below is redundant.  Unfortunately, many FUNCs
335      are not that well behaved.  do_cleanups should either be replaced
336      with a do_cleanups call (to cover the problem) or an assertion
337      check to detect bad FUNCs code.  */
338   do_cleanups (all_cleanups ());
339   /* If the command_loop returned, normally (rather than threw an
340      error) we try to quit.  If the quit is aborted, our caller
341      catches the signal and restarts the command loop.  */
342   quit_command (NULL, ui->instream == ui->stdin_stream);
343 }
344
345 /* Handle command errors thrown from within catch_command_errors.  */
346
347 static int
348 handle_command_errors (struct gdb_exception e)
349 {
350   if (e.reason < 0)
351     {
352       exception_print (gdb_stderr, e);
353
354       /* If any exception escaped to here, we better enable stdin.
355          Otherwise, any command that calls async_disable_stdin, and
356          then throws, will leave stdin inoperable.  */
357       async_enable_stdin ();
358       return 0;
359     }
360   return 1;
361 }
362
363 /* Type of the command callback passed to the const
364    catch_command_errors.  */
365
366 typedef void (catch_command_errors_const_ftype) (const char *, int);
367
368 /* Wrap calls to commands run before the event loop is started.  */
369
370 static int
371 catch_command_errors (catch_command_errors_const_ftype command,
372                       const char *arg, int from_tty)
373 {
374   TRY
375     {
376       int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
377
378       command (arg, from_tty);
379
380       maybe_wait_sync_command_done (was_sync);
381     }
382   CATCH (e, RETURN_MASK_ALL)
383     {
384       return handle_command_errors (e);
385     }
386   END_CATCH
387
388   return 1;
389 }
390
391 /* Adapter for symbol_file_add_main that translates 'from_tty' to a
392    symfile_add_flags.  */
393
394 static void
395 symbol_file_add_main_adapter (const char *arg, int from_tty)
396 {
397   symfile_add_flags add_flags = 0;
398
399   if (from_tty)
400     add_flags |= SYMFILE_VERBOSE;
401
402   symbol_file_add_main (arg, add_flags);
403 }
404
405 /* Type of this option.  */
406 enum cmdarg_kind
407 {
408   /* Option type -x.  */
409   CMDARG_FILE,
410
411   /* Option type -ex.  */
412   CMDARG_COMMAND,
413
414   /* Option type -ix.  */
415   CMDARG_INIT_FILE,
416     
417   /* Option type -iex.  */
418   CMDARG_INIT_COMMAND
419 };
420
421 /* Arguments of --command option and its counterpart.  */
422 struct cmdarg
423 {
424   cmdarg (cmdarg_kind type_, char *string_)
425     : type (type_), string (string_)
426   {}
427
428   /* Type of this option.  */
429   enum cmdarg_kind type;
430
431   /* Value of this option - filename or the GDB command itself.  String memory
432      is not owned by this structure despite it is 'const'.  */
433   char *string;
434 };
435
436 static void
437 captured_main_1 (struct captured_main_args *context)
438 {
439   int argc = context->argc;
440   char **argv = context->argv;
441
442   static int quiet = 0;
443   static int set_args = 0;
444   static int inhibit_home_gdbinit = 0;
445
446   /* Pointers to various arguments from command line.  */
447   char *symarg = NULL;
448   char *execarg = NULL;
449   char *pidarg = NULL;
450   char *corearg = NULL;
451   char *pid_or_core_arg = NULL;
452   char *cdarg = NULL;
453   char *ttyarg = NULL;
454
455   /* These are static so that we can take their address in an
456      initializer.  */
457   static int print_help;
458   static int print_version;
459   static int print_configuration;
460
461   /* Pointers to all arguments of --command option.  */
462   std::vector<struct cmdarg> cmdarg_vec;
463
464   /* All arguments of --directory option.  */
465   std::vector<char *> dirarg;
466
467   /* gdb init files.  */
468   const char *system_gdbinit;
469   const char *home_gdbinit;
470   const char *local_gdbinit;
471
472   int i;
473   int save_auto_load;
474   struct objfile *objfile;
475
476 #ifdef HAVE_SBRK
477   /* Set this before constructing scoped_command_stats.  */
478   lim_at_start = (char *) sbrk (0);
479 #endif
480
481   scoped_command_stats stat_reporter (false);
482
483 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
484   setlocale (LC_MESSAGES, "");
485 #endif
486 #if defined (HAVE_SETLOCALE)
487   setlocale (LC_CTYPE, "");
488 #endif
489 #ifdef ENABLE_NLS
490   bindtextdomain (PACKAGE, LOCALEDIR);
491   textdomain (PACKAGE);
492 #endif
493
494   bfd_init ();
495   notice_open_fds ();
496   save_original_signals_state ();
497
498   saved_command_line = (char *) xstrdup ("");
499
500 #ifdef __MINGW32__
501   /* Ensure stderr is unbuffered.  A Cygwin pty or pipe is implemented
502      as a Windows pipe, and Windows buffers on pipes.  */
503   setvbuf (stderr, NULL, _IONBF, BUFSIZ);
504 #endif
505
506   main_ui = new ui (stdin, stdout, stderr);
507   current_ui = main_ui;
508
509   gdb_stdtargerr = gdb_stderr;  /* for moment */
510   gdb_stdtargin = gdb_stdin;    /* for moment */
511
512 #ifdef __MINGW32__
513   /* On Windows, argv[0] is not necessarily set to absolute form when
514      GDB is found along PATH, without which relocation doesn't work.  */
515   gdb_program_name = windows_get_absolute_argv0 (argv[0]);
516 #else
517   gdb_program_name = xstrdup (argv[0]);
518 #endif
519
520   /* Prefix warning messages with the command name.  */
521   gdb::unique_xmalloc_ptr<char> tmp_warn_preprint
522     (xstrprintf ("%s: warning: ", gdb_program_name));
523   warning_pre_print = tmp_warn_preprint.get ();
524
525   current_directory = getcwd (NULL, 0);
526   if (current_directory == NULL)
527     perror_warning_with_name (_("error finding working directory"));
528
529   /* Set the sysroot path.  */
530   gdb_sysroot = relocate_gdb_directory (TARGET_SYSTEM_ROOT,
531                                         TARGET_SYSTEM_ROOT_RELOCATABLE);
532
533   if (gdb_sysroot == NULL || *gdb_sysroot == '\0')
534     {
535       xfree (gdb_sysroot);
536       gdb_sysroot = xstrdup (TARGET_SYSROOT_PREFIX);
537     }
538
539   debug_file_directory = relocate_gdb_directory (DEBUGDIR,
540                                                  DEBUGDIR_RELOCATABLE);
541
542   gdb_datadir = relocate_gdb_directory (GDB_DATADIR,
543                                         GDB_DATADIR_RELOCATABLE);
544
545 #ifdef WITH_PYTHON_PATH
546   {
547     /* For later use in helping Python find itself.  */
548     char *tmp = concat (WITH_PYTHON_PATH, SLASH_STRING, "lib", (char *) NULL);
549
550     python_libdir = relocate_gdb_directory (tmp, PYTHON_PATH_RELOCATABLE);
551     xfree (tmp);
552   }
553 #endif
554
555 #ifdef RELOC_SRCDIR
556   add_substitute_path_rule (RELOC_SRCDIR,
557                             make_relative_prefix (gdb_program_name, BINDIR,
558                                                   RELOC_SRCDIR));
559 #endif
560
561   /* There will always be an interpreter.  Either the one passed into
562      this captured main, or one specified by the user at start up, or
563      the console.  Initialize the interpreter to the one requested by 
564      the application.  */
565   interpreter_p = xstrdup (context->interpreter_p);
566
567   /* Parse arguments and options.  */
568   {
569     int c;
570     /* When var field is 0, use flag field to record the equivalent
571        short option (or arbitrary numbers starting at 10 for those
572        with no equivalent).  */
573     enum {
574       OPT_SE = 10,
575       OPT_CD,
576       OPT_ANNOTATE,
577       OPT_STATISTICS,
578       OPT_TUI,
579       OPT_NOWINDOWS,
580       OPT_WINDOWS,
581       OPT_IX,
582       OPT_IEX
583     };
584     static struct option long_options[] =
585     {
586       {"tui", no_argument, 0, OPT_TUI},
587       {"dbx", no_argument, &dbx_commands, 1},
588       {"readnow", no_argument, &readnow_symbol_files, 1},
589       {"r", no_argument, &readnow_symbol_files, 1},
590       {"quiet", no_argument, &quiet, 1},
591       {"q", no_argument, &quiet, 1},
592       {"silent", no_argument, &quiet, 1},
593       {"nh", no_argument, &inhibit_home_gdbinit, 1},
594       {"nx", no_argument, &inhibit_gdbinit, 1},
595       {"n", no_argument, &inhibit_gdbinit, 1},
596       {"batch-silent", no_argument, 0, 'B'},
597       {"batch", no_argument, &batch_flag, 1},
598
599     /* This is a synonym for "--annotate=1".  --annotate is now
600        preferred, but keep this here for a long time because people
601        will be running emacses which use --fullname.  */
602       {"fullname", no_argument, 0, 'f'},
603       {"f", no_argument, 0, 'f'},
604
605       {"annotate", required_argument, 0, OPT_ANNOTATE},
606       {"help", no_argument, &print_help, 1},
607       {"se", required_argument, 0, OPT_SE},
608       {"symbols", required_argument, 0, 's'},
609       {"s", required_argument, 0, 's'},
610       {"exec", required_argument, 0, 'e'},
611       {"e", required_argument, 0, 'e'},
612       {"core", required_argument, 0, 'c'},
613       {"c", required_argument, 0, 'c'},
614       {"pid", required_argument, 0, 'p'},
615       {"p", required_argument, 0, 'p'},
616       {"command", required_argument, 0, 'x'},
617       {"eval-command", required_argument, 0, 'X'},
618       {"version", no_argument, &print_version, 1},
619       {"configuration", no_argument, &print_configuration, 1},
620       {"x", required_argument, 0, 'x'},
621       {"ex", required_argument, 0, 'X'},
622       {"init-command", required_argument, 0, OPT_IX},
623       {"init-eval-command", required_argument, 0, OPT_IEX},
624       {"ix", required_argument, 0, OPT_IX},
625       {"iex", required_argument, 0, OPT_IEX},
626 #ifdef GDBTK
627       {"tclcommand", required_argument, 0, 'z'},
628       {"enable-external-editor", no_argument, 0, 'y'},
629       {"editor-command", required_argument, 0, 'w'},
630 #endif
631       {"ui", required_argument, 0, 'i'},
632       {"interpreter", required_argument, 0, 'i'},
633       {"i", required_argument, 0, 'i'},
634       {"directory", required_argument, 0, 'd'},
635       {"d", required_argument, 0, 'd'},
636       {"data-directory", required_argument, 0, 'D'},
637       {"D", required_argument, 0, 'D'},
638       {"cd", required_argument, 0, OPT_CD},
639       {"tty", required_argument, 0, 't'},
640       {"baud", required_argument, 0, 'b'},
641       {"b", required_argument, 0, 'b'},
642       {"nw", no_argument, NULL, OPT_NOWINDOWS},
643       {"nowindows", no_argument, NULL, OPT_NOWINDOWS},
644       {"w", no_argument, NULL, OPT_WINDOWS},
645       {"windows", no_argument, NULL, OPT_WINDOWS},
646       {"statistics", no_argument, 0, OPT_STATISTICS},
647       {"write", no_argument, &write_files, 1},
648       {"args", no_argument, &set_args, 1},
649       {"l", required_argument, 0, 'l'},
650       {"return-child-result", no_argument, &return_child_result, 1},
651       {0, no_argument, 0, 0}
652     };
653
654     while (1)
655       {
656         int option_index;
657
658         c = getopt_long_only (argc, argv, "",
659                               long_options, &option_index);
660         if (c == EOF || set_args)
661           break;
662
663         /* Long option that takes an argument.  */
664         if (c == 0 && long_options[option_index].flag == 0)
665           c = long_options[option_index].val;
666
667         switch (c)
668           {
669           case 0:
670             /* Long option that just sets a flag.  */
671             break;
672           case OPT_SE:
673             symarg = optarg;
674             execarg = optarg;
675             break;
676           case OPT_CD:
677             cdarg = optarg;
678             break;
679           case OPT_ANNOTATE:
680             /* FIXME: what if the syntax is wrong (e.g. not digits)?  */
681             annotation_level = atoi (optarg);
682             break;
683           case OPT_STATISTICS:
684             /* Enable the display of both time and space usage.  */
685             set_per_command_time (1);
686             set_per_command_space (1);
687             break;
688           case OPT_TUI:
689             /* --tui is equivalent to -i=tui.  */
690 #ifdef TUI
691             xfree (interpreter_p);
692             interpreter_p = xstrdup (INTERP_TUI);
693 #else
694             error (_("%s: TUI mode is not supported"), gdb_program_name);
695 #endif
696             break;
697           case OPT_WINDOWS:
698             /* FIXME: cagney/2003-03-01: Not sure if this option is
699                actually useful, and if it is, what it should do.  */
700 #ifdef GDBTK
701             /* --windows is equivalent to -i=insight.  */
702             xfree (interpreter_p);
703             interpreter_p = xstrdup (INTERP_INSIGHT);
704 #endif
705             break;
706           case OPT_NOWINDOWS:
707             /* -nw is equivalent to -i=console.  */
708             xfree (interpreter_p);
709             interpreter_p = xstrdup (INTERP_CONSOLE);
710             break;
711           case 'f':
712             annotation_level = 1;
713             break;
714           case 's':
715             symarg = optarg;
716             break;
717           case 'e':
718             execarg = optarg;
719             break;
720           case 'c':
721             corearg = optarg;
722             break;
723           case 'p':
724             pidarg = optarg;
725             break;
726           case 'x':
727             cmdarg_vec.emplace_back (CMDARG_FILE, optarg);
728             break;
729           case 'X':
730             cmdarg_vec.emplace_back (CMDARG_COMMAND, optarg);
731             break;
732           case OPT_IX:
733             cmdarg_vec.emplace_back (CMDARG_INIT_FILE, optarg);
734             break;
735           case OPT_IEX:
736             cmdarg_vec.emplace_back (CMDARG_INIT_COMMAND, optarg);
737             break;
738           case 'B':
739             batch_flag = batch_silent = 1;
740             gdb_stdout = new null_file ();
741             break;
742           case 'D':
743             if (optarg[0] == '\0')
744               error (_("%s: empty path for `--data-directory'"),
745                      gdb_program_name);
746             set_gdb_data_directory (optarg);
747             gdb_datadir_provided = 1;
748             break;
749 #ifdef GDBTK
750           case 'z':
751             {
752               extern int gdbtk_test (char *);
753
754               if (!gdbtk_test (optarg))
755                 error (_("%s: unable to load tclcommand file \"%s\""),
756                        gdb_program_name, optarg);
757               break;
758             }
759           case 'y':
760             /* Backwards compatibility only.  */
761             break;
762           case 'w':
763             {
764               /* Set the external editor commands when gdb is farming out files
765                  to be edited by another program.  */
766               extern char *external_editor_command;
767
768               external_editor_command = xstrdup (optarg);
769               break;
770             }
771 #endif /* GDBTK */
772           case 'i':
773             xfree (interpreter_p);
774             interpreter_p = xstrdup (optarg);
775             break;
776           case 'd':
777             dirarg.push_back (optarg);
778             break;
779           case 't':
780             ttyarg = optarg;
781             break;
782           case 'q':
783             quiet = 1;
784             break;
785           case 'b':
786             {
787               int i;
788               char *p;
789
790               i = strtol (optarg, &p, 0);
791               if (i == 0 && p == optarg)
792                 warning (_("could not set baud rate to `%s'."),
793                          optarg);
794               else
795                 baud_rate = i;
796             }
797             break;
798           case 'l':
799             {
800               int i;
801               char *p;
802
803               i = strtol (optarg, &p, 0);
804               if (i == 0 && p == optarg)
805                 warning (_("could not set timeout limit to `%s'."),
806                          optarg);
807               else
808                 remote_timeout = i;
809             }
810             break;
811
812           case '?':
813             error (_("Use `%s --help' for a complete list of options."),
814                    gdb_program_name);
815           }
816       }
817
818     if (batch_flag)
819       quiet = 1;
820   }
821
822   /* Try to set up an alternate signal stack for SIGSEGV handlers.  */
823   setup_alternate_signal_stack ();
824
825   /* Initialize all files.  */
826   gdb_init (gdb_program_name);
827
828   /* Now that gdb_init has created the initial inferior, we're in
829      position to set args for that inferior.  */
830   if (set_args)
831     {
832       /* The remaining options are the command-line options for the
833          inferior.  The first one is the sym/exec file, and the rest
834          are arguments.  */
835       if (optind >= argc)
836         error (_("%s: `--args' specified but no program specified"),
837                gdb_program_name);
838
839       symarg = argv[optind];
840       execarg = argv[optind];
841       ++optind;
842       set_inferior_args_vector (argc - optind, &argv[optind]);
843     }
844   else
845     {
846       /* OK, that's all the options.  */
847
848       /* The first argument, if specified, is the name of the
849          executable.  */
850       if (optind < argc)
851         {
852           symarg = argv[optind];
853           execarg = argv[optind];
854           optind++;
855         }
856
857       /* If the user hasn't already specified a PID or the name of a
858          core file, then a second optional argument is allowed.  If
859          present, this argument should be interpreted as either a
860          PID or a core file, whichever works.  */
861       if (pidarg == NULL && corearg == NULL && optind < argc)
862         {
863           pid_or_core_arg = argv[optind];
864           optind++;
865         }
866
867       /* Any argument left on the command line is unexpected and
868          will be ignored.  Inform the user.  */
869       if (optind < argc)
870         fprintf_unfiltered (gdb_stderr,
871                             _("Excess command line "
872                               "arguments ignored. (%s%s)\n"),
873                             argv[optind],
874                             (optind == argc - 1) ? "" : " ...");
875     }
876
877   /* Lookup gdbinit files.  Note that the gdbinit file name may be
878      overriden during file initialization, so get_init_files should be
879      called after gdb_init.  */
880   get_init_files (&system_gdbinit, &home_gdbinit, &local_gdbinit);
881
882   /* Do these (and anything which might call wrap_here or *_filtered)
883      after initialize_all_files() but before the interpreter has been
884      installed.  Otherwize the help/version messages will be eaten by
885      the interpreter's output handler.  */
886
887   if (print_version)
888     {
889       print_gdb_version (gdb_stdout);
890       wrap_here ("");
891       printf_filtered ("\n");
892       exit (0);
893     }
894
895   if (print_help)
896     {
897       print_gdb_help (gdb_stdout);
898       fputs_unfiltered ("\n", gdb_stdout);
899       exit (0);
900     }
901
902   if (print_configuration)
903     {
904       print_gdb_configuration (gdb_stdout);
905       wrap_here ("");
906       printf_filtered ("\n");
907       exit (0);
908     }
909
910   /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
911      GDB retain the old MI1 interpreter startup behavior.  Output the
912      copyright message before the interpreter is installed.  That way
913      it isn't encapsulated in MI output.  */
914   if (!quiet && strcmp (interpreter_p, INTERP_MI1) == 0)
915     {
916       /* Print all the junk at the top, with trailing "..." if we are
917          about to read a symbol file (possibly slowly).  */
918       print_gdb_version (gdb_stdout);
919       if (symarg)
920         printf_filtered ("..");
921       wrap_here ("");
922       printf_filtered ("\n");
923       gdb_flush (gdb_stdout);   /* Force to screen during slow
924                                    operations.  */
925     }
926
927   /* Install the default UI.  All the interpreters should have had a
928      look at things by now.  Initialize the default interpreter.  */
929   set_top_level_interpreter (interpreter_p);
930
931   /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
932      GDB retain the old MI1 interpreter startup behavior.  Output the
933      copyright message after the interpreter is installed when it is
934      any sane interpreter.  */
935   if (!quiet && !current_interp_named_p (INTERP_MI1))
936     {
937       /* Print all the junk at the top, with trailing "..." if we are
938          about to read a symbol file (possibly slowly).  */
939       print_gdb_version (gdb_stdout);
940       if (symarg)
941         printf_filtered ("..");
942       wrap_here ("");
943       printf_filtered ("\n");
944       gdb_flush (gdb_stdout);   /* Force to screen during slow
945                                    operations.  */
946     }
947
948   /* Set off error and warning messages with a blank line.  */
949   tmp_warn_preprint.reset ();
950   warning_pre_print = _("\nwarning: ");
951
952   /* Read and execute the system-wide gdbinit file, if it exists.
953      This is done *before* all the command line arguments are
954      processed; it sets global parameters, which are independent of
955      what file you are debugging or what directory you are in.  */
956   if (system_gdbinit && !inhibit_gdbinit)
957     catch_command_errors (source_script, system_gdbinit, 0);
958
959   /* Read and execute $HOME/.gdbinit file, if it exists.  This is done
960      *before* all the command line arguments are processed; it sets
961      global parameters, which are independent of what file you are
962      debugging or what directory you are in.  */
963
964   if (home_gdbinit && !inhibit_gdbinit && !inhibit_home_gdbinit)
965     catch_command_errors (source_script, home_gdbinit, 0);
966
967   /* Process '-ix' and '-iex' options early.  */
968   for (i = 0; i < cmdarg_vec.size (); i++)
969     {
970       const struct cmdarg &cmdarg_p = cmdarg_vec[i];
971
972       switch (cmdarg_p.type)
973         {
974         case CMDARG_INIT_FILE:
975           catch_command_errors (source_script, cmdarg_p.string,
976                                 !batch_flag);
977           break;
978         case CMDARG_INIT_COMMAND:
979           catch_command_errors (execute_command, cmdarg_p.string,
980                                 !batch_flag);
981           break;
982         }
983     }
984
985   /* Now perform all the actions indicated by the arguments.  */
986   if (cdarg != NULL)
987     {
988       catch_command_errors (cd_command, cdarg, 0);
989     }
990
991   for (i = 0; i < dirarg.size (); i++)
992     catch_command_errors (directory_switch, dirarg[i], 0);
993
994   /* Skip auto-loading section-specified scripts until we've sourced
995      local_gdbinit (which is often used to augment the source search
996      path).  */
997   save_auto_load = global_auto_load;
998   global_auto_load = 0;
999
1000   if (execarg != NULL
1001       && symarg != NULL
1002       && strcmp (execarg, symarg) == 0)
1003     {
1004       /* The exec file and the symbol-file are the same.  If we can't
1005          open it, better only print one error message.
1006          catch_command_errors returns non-zero on success!  */
1007       if (catch_command_errors (exec_file_attach, execarg,
1008                                 !batch_flag))
1009         catch_command_errors (symbol_file_add_main_adapter, symarg,
1010                               !batch_flag);
1011     }
1012   else
1013     {
1014       if (execarg != NULL)
1015         catch_command_errors (exec_file_attach, execarg,
1016                               !batch_flag);
1017       if (symarg != NULL)
1018         catch_command_errors (symbol_file_add_main_adapter, symarg,
1019                               !batch_flag);
1020     }
1021
1022   if (corearg && pidarg)
1023     error (_("Can't attach to process and specify "
1024              "a core file at the same time."));
1025
1026   if (corearg != NULL)
1027     catch_command_errors (core_file_command, corearg, !batch_flag);
1028   else if (pidarg != NULL)
1029     catch_command_errors (attach_command, pidarg, !batch_flag);
1030   else if (pid_or_core_arg)
1031     {
1032       /* The user specified 'gdb program pid' or gdb program core'.
1033          If pid_or_core_arg's first character is a digit, try attach
1034          first and then corefile.  Otherwise try just corefile.  */
1035
1036       if (isdigit (pid_or_core_arg[0]))
1037         {
1038           if (catch_command_errors (attach_command, pid_or_core_arg,
1039                                     !batch_flag) == 0)
1040             catch_command_errors (core_file_command, pid_or_core_arg,
1041                                   !batch_flag);
1042         }
1043       else /* Can't be a pid, better be a corefile.  */
1044         catch_command_errors (core_file_command, pid_or_core_arg,
1045                               !batch_flag);
1046     }
1047
1048   if (ttyarg != NULL)
1049     set_inferior_io_terminal (ttyarg);
1050
1051   /* Error messages should no longer be distinguished with extra output.  */
1052   warning_pre_print = _("warning: ");
1053
1054   /* Read the .gdbinit file in the current directory, *if* it isn't
1055      the same as the $HOME/.gdbinit file (it should exist, also).  */
1056   if (local_gdbinit)
1057     {
1058       auto_load_local_gdbinit_pathname
1059         = gdb_realpath (local_gdbinit).release ();
1060
1061       if (!inhibit_gdbinit && auto_load_local_gdbinit
1062           && file_is_auto_load_safe (local_gdbinit,
1063                                      _("auto-load: Loading .gdbinit "
1064                                        "file \"%s\".\n"),
1065                                      local_gdbinit))
1066         {
1067           auto_load_local_gdbinit_loaded = 1;
1068
1069           catch_command_errors (source_script, local_gdbinit, 0);
1070         }
1071     }
1072
1073   /* Now that all .gdbinit's have been read and all -d options have been
1074      processed, we can read any scripts mentioned in SYMARG.
1075      We wait until now because it is common to add to the source search
1076      path in local_gdbinit.  */
1077   global_auto_load = save_auto_load;
1078   ALL_OBJFILES (objfile)
1079     load_auto_scripts_for_objfile (objfile);
1080
1081   /* Process '-x' and '-ex' options.  */
1082   for (i = 0; i < cmdarg_vec.size (); i++)
1083     {
1084       const struct cmdarg &cmdarg_p = cmdarg_vec[i];
1085
1086       switch (cmdarg_p.type)
1087         {
1088         case CMDARG_FILE:
1089           catch_command_errors (source_script, cmdarg_p.string,
1090                                 !batch_flag);
1091           break;
1092         case CMDARG_COMMAND:
1093           catch_command_errors (execute_command, cmdarg_p.string,
1094                                 !batch_flag);
1095           break;
1096         }
1097     }
1098
1099   /* Read in the old history after all the command files have been
1100      read.  */
1101   init_history ();
1102
1103   if (batch_flag)
1104     {
1105       /* We have hit the end of the batch file.  */
1106       quit_force (NULL, 0);
1107     }
1108 }
1109
1110 static void
1111 captured_main (void *data)
1112 {
1113   struct captured_main_args *context = (struct captured_main_args *) data;
1114
1115   captured_main_1 (context);
1116
1117   /* NOTE: cagney/1999-11-07: There is probably no reason for not
1118      moving this loop and the code found in captured_command_loop()
1119      into the command_loop() proper.  The main thing holding back that
1120      change - SET_TOP_LEVEL() - has been eliminated.  */
1121   while (1)
1122     {
1123       TRY
1124         {
1125           captured_command_loop ();
1126         }
1127       CATCH (ex, RETURN_MASK_ALL)
1128         {
1129           exception_print (gdb_stderr, ex);
1130         }
1131       END_CATCH
1132     }
1133   /* No exit -- exit is through quit_command.  */
1134 }
1135
1136 int
1137 gdb_main (struct captured_main_args *args)
1138 {
1139   TRY
1140     {
1141       captured_main (args);
1142     }
1143   CATCH (ex, RETURN_MASK_ALL)
1144     {
1145       exception_print (gdb_stderr, ex);
1146     }
1147   END_CATCH
1148
1149   /* The only way to end up here is by an error (normal exit is
1150      handled by quit_force()), hence always return an error status.  */
1151   return 1;
1152 }
1153
1154
1155 /* Don't use *_filtered for printing help.  We don't want to prompt
1156    for continue no matter how small the screen or how much we're going
1157    to print.  */
1158
1159 static void
1160 print_gdb_help (struct ui_file *stream)
1161 {
1162   const char *system_gdbinit;
1163   const char *home_gdbinit;
1164   const char *local_gdbinit;
1165
1166   get_init_files (&system_gdbinit, &home_gdbinit, &local_gdbinit);
1167
1168   /* Note: The options in the list below are only approximately sorted
1169      in the alphabetical order, so as to group closely related options
1170      together.  */
1171   fputs_unfiltered (_("\
1172 This is the GNU debugger.  Usage:\n\n\
1173     gdb [options] [executable-file [core-file or process-id]]\n\
1174     gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1175 "), stream);
1176   fputs_unfiltered (_("\
1177 Selection of debuggee and its files:\n\n\
1178   --args             Arguments after executable-file are passed to inferior\n\
1179   --core=COREFILE    Analyze the core dump COREFILE.\n\
1180   --exec=EXECFILE    Use EXECFILE as the executable.\n\
1181   --pid=PID          Attach to running process PID.\n\
1182   --directory=DIR    Search for source files in DIR.\n\
1183   --se=FILE          Use FILE as symbol file and executable file.\n\
1184   --symbols=SYMFILE  Read symbols from SYMFILE.\n\
1185   --readnow          Fully read symbol files on first access.\n\
1186   --write            Set writing into executable and core files.\n\n\
1187 "), stream);
1188   fputs_unfiltered (_("\
1189 Initial commands and command files:\n\n\
1190   --command=FILE, -x Execute GDB commands from FILE.\n\
1191   --init-command=FILE, -ix\n\
1192                      Like -x but execute commands before loading inferior.\n\
1193   --eval-command=COMMAND, -ex\n\
1194                      Execute a single GDB command.\n\
1195                      May be used multiple times and in conjunction\n\
1196                      with --command.\n\
1197   --init-eval-command=COMMAND, -iex\n\
1198                      Like -ex but before loading inferior.\n\
1199   --nh               Do not read ~/.gdbinit.\n\
1200   --nx               Do not read any .gdbinit files in any directory.\n\n\
1201 "), stream);
1202   fputs_unfiltered (_("\
1203 Output and user interface control:\n\n\
1204   --fullname         Output information used by emacs-GDB interface.\n\
1205   --interpreter=INTERP\n\
1206                      Select a specific interpreter / user interface\n\
1207   --tty=TTY          Use TTY for input/output by the program being debugged.\n\
1208   -w                 Use the GUI interface.\n\
1209   --nw               Do not use the GUI interface.\n\
1210 "), stream);
1211 #if defined(TUI)
1212   fputs_unfiltered (_("\
1213   --tui              Use a terminal user interface.\n\
1214 "), stream);
1215 #endif
1216   fputs_unfiltered (_("\
1217   --dbx              DBX compatibility mode.\n\
1218   -q, --quiet, --silent\n\
1219                      Do not print version number on startup.\n\n\
1220 "), stream);
1221   fputs_unfiltered (_("\
1222 Operating modes:\n\n\
1223   --batch            Exit after processing options.\n\
1224   --batch-silent     Like --batch, but suppress all gdb stdout output.\n\
1225   --return-child-result\n\
1226                      GDB exit code will be the child's exit code.\n\
1227   --configuration    Print details about GDB configuration and then exit.\n\
1228   --help             Print this message and then exit.\n\
1229   --version          Print version information and then exit.\n\n\
1230 Remote debugging options:\n\n\
1231   -b BAUDRATE        Set serial port baud rate used for remote debugging.\n\
1232   -l TIMEOUT         Set timeout in seconds for remote debugging.\n\n\
1233 Other options:\n\n\
1234   --cd=DIR           Change current directory to DIR.\n\
1235   --data-directory=DIR, -D\n\
1236                      Set GDB's data-directory to DIR.\n\
1237 "), stream);
1238   fputs_unfiltered (_("\n\
1239 At startup, GDB reads the following init files and executes their commands:\n\
1240 "), stream);
1241   if (system_gdbinit)
1242     fprintf_unfiltered (stream, _("\
1243    * system-wide init file: %s\n\
1244 "), system_gdbinit);
1245   if (home_gdbinit)
1246     fprintf_unfiltered (stream, _("\
1247    * user-specific init file: %s\n\
1248 "), home_gdbinit);
1249   if (local_gdbinit)
1250     fprintf_unfiltered (stream, _("\
1251    * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1252 "), local_gdbinit);
1253   fputs_unfiltered (_("\n\
1254 For more information, type \"help\" from within GDB, or consult the\n\
1255 GDB manual (available as on-line info or a printed manual).\n\
1256 "), stream);
1257   if (REPORT_BUGS_TO[0] && stream == gdb_stdout)
1258     fprintf_unfiltered (stream, _("\
1259 Report bugs to \"%s\".\n\
1260 "), REPORT_BUGS_TO);
1261 }