Remove last cleanup from captured_main_1
[external/binutils.git] / gdb / main.c
1 /* Top level stuff for GDB, the GNU debugger.
2
3    Copyright (C) 1986-2016 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);
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       char *abs_datadir = gdb_abspath (gdb_datadir);
132
133       xfree (gdb_datadir);
134       gdb_datadir = abs_datadir;
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.  If it happens to return, pass that through as a
309    non-zero return status.  */
310
311 static int
312 captured_command_loop (void *data)
313 {
314   struct ui *ui = current_ui;
315
316   /* Top-level execution commands can be run in the background from
317      here on.  */
318   current_ui->async = 1;
319
320   /* Give the interpreter a chance to print a prompt, if necessary  */
321   if (ui->prompt_state != PROMPT_BLOCKED)
322     interp_pre_command_loop (top_level_interpreter ());
323
324   /* Now it's time to start the event loop.  */
325   start_event_loop ();
326
327   /* FIXME: cagney/1999-11-05: A correct command_loop() implementaton
328      would clean things up (restoring the cleanup chain) to the state
329      they were just prior to the call.  Technically, this means that
330      the do_cleanups() below is redundant.  Unfortunately, many FUNCs
331      are not that well behaved.  do_cleanups should either be replaced
332      with a do_cleanups call (to cover the problem) or an assertion
333      check to detect bad FUNCs code.  */
334   do_cleanups (all_cleanups ());
335   /* If the command_loop returned, normally (rather than threw an
336      error) we try to quit.  If the quit is aborted, catch_errors()
337      which called this catch the signal and restart the command
338      loop.  */
339   quit_command (NULL, ui->instream == ui->stdin_stream);
340   return 1;
341 }
342
343 /* Handle command errors thrown from within
344    catch_command_errors/catch_command_errors_const.  */
345
346 static int
347 handle_command_errors (struct gdb_exception e)
348 {
349   if (e.reason < 0)
350     {
351       exception_print (gdb_stderr, e);
352
353       /* If any exception escaped to here, we better enable stdin.
354          Otherwise, any command that calls async_disable_stdin, and
355          then throws, will leave stdin inoperable.  */
356       async_enable_stdin ();
357       return 0;
358     }
359   return 1;
360 }
361
362 /* Type of the command callback passed to catch_command_errors.  */
363
364 typedef void (catch_command_errors_ftype) (char *, int);
365
366 /* Wrap calls to commands run before the event loop is started.  */
367
368 static int
369 catch_command_errors (catch_command_errors_ftype *command,
370                       char *arg, int from_tty)
371 {
372   TRY
373     {
374       int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
375
376       command (arg, from_tty);
377
378       maybe_wait_sync_command_done (was_sync);
379     }
380   CATCH (e, RETURN_MASK_ALL)
381     {
382       return handle_command_errors (e);
383     }
384   END_CATCH
385
386   return 1;
387 }
388
389 /* Type of the command callback passed to catch_command_errors_const.  */
390
391 typedef void (catch_command_errors_const_ftype) (const char *, int);
392
393 /* Like catch_command_errors, but works with const command and args.  */
394
395 static int
396 catch_command_errors_const (catch_command_errors_const_ftype *command,
397                             const char *arg, int from_tty)
398 {
399   TRY
400     {
401       int was_sync = current_ui->prompt_state == PROMPT_BLOCKED;
402
403       command (arg, from_tty);
404
405       maybe_wait_sync_command_done (was_sync);
406     }
407   CATCH (e, RETURN_MASK_ALL)
408     {
409       return handle_command_errors (e);
410     }
411   END_CATCH
412
413   return 1;
414 }
415
416 /* Type of this option.  */
417 enum cmdarg_kind
418 {
419   /* Option type -x.  */
420   CMDARG_FILE,
421
422   /* Option type -ex.  */
423   CMDARG_COMMAND,
424
425   /* Option type -ix.  */
426   CMDARG_INIT_FILE,
427     
428   /* Option type -iex.  */
429   CMDARG_INIT_COMMAND
430 };
431
432 /* Arguments of --command option and its counterpart.  */
433 struct cmdarg {
434   /* Type of this option.  */
435   enum cmdarg_kind type;
436
437   /* Value of this option - filename or the GDB command itself.  String memory
438      is not owned by this structure despite it is 'const'.  */
439   char *string;
440 };
441
442 static void
443 captured_main_1 (struct captured_main_args *context)
444 {
445   int argc = context->argc;
446   char **argv = context->argv;
447
448   static int quiet = 0;
449   static int set_args = 0;
450   static int inhibit_home_gdbinit = 0;
451
452   /* Pointers to various arguments from command line.  */
453   char *symarg = NULL;
454   char *execarg = NULL;
455   char *pidarg = NULL;
456   char *corearg = NULL;
457   char *pid_or_core_arg = NULL;
458   char *cdarg = NULL;
459   char *ttyarg = NULL;
460
461   /* These are static so that we can take their address in an
462      initializer.  */
463   static int print_help;
464   static int print_version;
465   static int print_configuration;
466
467   /* Pointers to all arguments of --command option.  */
468   std::vector<struct cmdarg> cmdarg_vec;
469
470   /* All arguments of --directory option.  */
471   std::vector<char *> dirarg;
472
473   /* gdb init files.  */
474   const char *system_gdbinit;
475   const char *home_gdbinit;
476   const char *local_gdbinit;
477
478   int i;
479   int save_auto_load;
480   struct objfile *objfile;
481
482   struct cleanup *chain;
483
484 #ifdef HAVE_SBRK
485   /* Set this before constructing scoped_command_stats.  */
486   lim_at_start = (char *) sbrk (0);
487 #endif
488
489   scoped_command_stats stat_reporter (false);
490
491 #if defined (HAVE_SETLOCALE) && defined (HAVE_LC_MESSAGES)
492   setlocale (LC_MESSAGES, "");
493 #endif
494 #if defined (HAVE_SETLOCALE)
495   setlocale (LC_CTYPE, "");
496 #endif
497 #ifdef ENABLE_NLS
498   bindtextdomain (PACKAGE, LOCALEDIR);
499   textdomain (PACKAGE);
500 #endif
501
502   bfd_init ();
503   notice_open_fds ();
504   save_original_signals_state ();
505
506   saved_command_line = (char *) xstrdup ("");
507
508 #ifdef __MINGW32__
509   /* Ensure stderr is unbuffered.  A Cygwin pty or pipe is implemented
510      as a Windows pipe, and Windows buffers on pipes.  */
511   setvbuf (stderr, NULL, _IONBF, BUFSIZ);
512 #endif
513
514   main_ui = new_ui (stdin, stdout, stderr);
515   current_ui = main_ui;
516
517   gdb_stdtargerr = gdb_stderr;  /* for moment */
518   gdb_stdtargin = gdb_stdin;    /* for moment */
519
520 #ifdef __MINGW32__
521   /* On Windows, argv[0] is not necessarily set to absolute form when
522      GDB is found along PATH, without which relocation doesn't work.  */
523   gdb_program_name = windows_get_absolute_argv0 (argv[0]);
524 #else
525   gdb_program_name = xstrdup (argv[0]);
526 #endif
527
528   /* Prefix warning messages with the command name.  */
529   warning_pre_print = xstrprintf ("%s: warning: ", gdb_program_name);
530
531   if (! getcwd (gdb_dirbuf, sizeof (gdb_dirbuf)))
532     perror_warning_with_name (_("error finding working directory"));
533
534   current_directory = gdb_dirbuf;
535
536   /* Set the sysroot path.  */
537   gdb_sysroot = relocate_gdb_directory (TARGET_SYSTEM_ROOT,
538                                         TARGET_SYSTEM_ROOT_RELOCATABLE);
539
540   if (gdb_sysroot == NULL || *gdb_sysroot == '\0')
541     {
542       xfree (gdb_sysroot);
543       gdb_sysroot = xstrdup (TARGET_SYSROOT_PREFIX);
544     }
545
546   debug_file_directory = relocate_gdb_directory (DEBUGDIR,
547                                                  DEBUGDIR_RELOCATABLE);
548
549   gdb_datadir = relocate_gdb_directory (GDB_DATADIR,
550                                         GDB_DATADIR_RELOCATABLE);
551
552 #ifdef WITH_PYTHON_PATH
553   {
554     /* For later use in helping Python find itself.  */
555     char *tmp = concat (WITH_PYTHON_PATH, SLASH_STRING, "lib", (char *) NULL);
556
557     python_libdir = relocate_gdb_directory (tmp, PYTHON_PATH_RELOCATABLE);
558     xfree (tmp);
559   }
560 #endif
561
562 #ifdef RELOC_SRCDIR
563   add_substitute_path_rule (RELOC_SRCDIR,
564                             make_relative_prefix (gdb_program_name, BINDIR,
565                                                   RELOC_SRCDIR));
566 #endif
567
568   /* There will always be an interpreter.  Either the one passed into
569      this captured main, or one specified by the user at start up, or
570      the console.  Initialize the interpreter to the one requested by 
571      the application.  */
572   interpreter_p = xstrdup (context->interpreter_p);
573
574   /* Parse arguments and options.  */
575   {
576     int c;
577     /* When var field is 0, use flag field to record the equivalent
578        short option (or arbitrary numbers starting at 10 for those
579        with no equivalent).  */
580     enum {
581       OPT_SE = 10,
582       OPT_CD,
583       OPT_ANNOTATE,
584       OPT_STATISTICS,
585       OPT_TUI,
586       OPT_NOWINDOWS,
587       OPT_WINDOWS,
588       OPT_IX,
589       OPT_IEX
590     };
591     static struct option long_options[] =
592     {
593       {"tui", no_argument, 0, OPT_TUI},
594       {"dbx", no_argument, &dbx_commands, 1},
595       {"readnow", no_argument, &readnow_symbol_files, 1},
596       {"r", no_argument, &readnow_symbol_files, 1},
597       {"quiet", no_argument, &quiet, 1},
598       {"q", no_argument, &quiet, 1},
599       {"silent", no_argument, &quiet, 1},
600       {"nh", no_argument, &inhibit_home_gdbinit, 1},
601       {"nx", no_argument, &inhibit_gdbinit, 1},
602       {"n", no_argument, &inhibit_gdbinit, 1},
603       {"batch-silent", no_argument, 0, 'B'},
604       {"batch", no_argument, &batch_flag, 1},
605
606     /* This is a synonym for "--annotate=1".  --annotate is now
607        preferred, but keep this here for a long time because people
608        will be running emacses which use --fullname.  */
609       {"fullname", no_argument, 0, 'f'},
610       {"f", no_argument, 0, 'f'},
611
612       {"annotate", required_argument, 0, OPT_ANNOTATE},
613       {"help", no_argument, &print_help, 1},
614       {"se", required_argument, 0, OPT_SE},
615       {"symbols", required_argument, 0, 's'},
616       {"s", required_argument, 0, 's'},
617       {"exec", required_argument, 0, 'e'},
618       {"e", required_argument, 0, 'e'},
619       {"core", required_argument, 0, 'c'},
620       {"c", required_argument, 0, 'c'},
621       {"pid", required_argument, 0, 'p'},
622       {"p", required_argument, 0, 'p'},
623       {"command", required_argument, 0, 'x'},
624       {"eval-command", required_argument, 0, 'X'},
625       {"version", no_argument, &print_version, 1},
626       {"configuration", no_argument, &print_configuration, 1},
627       {"x", required_argument, 0, 'x'},
628       {"ex", required_argument, 0, 'X'},
629       {"init-command", required_argument, 0, OPT_IX},
630       {"init-eval-command", required_argument, 0, OPT_IEX},
631       {"ix", required_argument, 0, OPT_IX},
632       {"iex", required_argument, 0, OPT_IEX},
633 #ifdef GDBTK
634       {"tclcommand", required_argument, 0, 'z'},
635       {"enable-external-editor", no_argument, 0, 'y'},
636       {"editor-command", required_argument, 0, 'w'},
637 #endif
638       {"ui", required_argument, 0, 'i'},
639       {"interpreter", required_argument, 0, 'i'},
640       {"i", required_argument, 0, 'i'},
641       {"directory", required_argument, 0, 'd'},
642       {"d", required_argument, 0, 'd'},
643       {"data-directory", required_argument, 0, 'D'},
644       {"D", required_argument, 0, 'D'},
645       {"cd", required_argument, 0, OPT_CD},
646       {"tty", required_argument, 0, 't'},
647       {"baud", required_argument, 0, 'b'},
648       {"b", required_argument, 0, 'b'},
649       {"nw", no_argument, NULL, OPT_NOWINDOWS},
650       {"nowindows", no_argument, NULL, OPT_NOWINDOWS},
651       {"w", no_argument, NULL, OPT_WINDOWS},
652       {"windows", no_argument, NULL, OPT_WINDOWS},
653       {"statistics", no_argument, 0, OPT_STATISTICS},
654       {"write", no_argument, &write_files, 1},
655       {"args", no_argument, &set_args, 1},
656       {"l", required_argument, 0, 'l'},
657       {"return-child-result", no_argument, &return_child_result, 1},
658       {0, no_argument, 0, 0}
659     };
660
661     while (1)
662       {
663         int option_index;
664
665         c = getopt_long_only (argc, argv, "",
666                               long_options, &option_index);
667         if (c == EOF || set_args)
668           break;
669
670         /* Long option that takes an argument.  */
671         if (c == 0 && long_options[option_index].flag == 0)
672           c = long_options[option_index].val;
673
674         switch (c)
675           {
676           case 0:
677             /* Long option that just sets a flag.  */
678             break;
679           case OPT_SE:
680             symarg = optarg;
681             execarg = optarg;
682             break;
683           case OPT_CD:
684             cdarg = optarg;
685             break;
686           case OPT_ANNOTATE:
687             /* FIXME: what if the syntax is wrong (e.g. not digits)?  */
688             annotation_level = atoi (optarg);
689             break;
690           case OPT_STATISTICS:
691             /* Enable the display of both time and space usage.  */
692             set_per_command_time (1);
693             set_per_command_space (1);
694             break;
695           case OPT_TUI:
696             /* --tui is equivalent to -i=tui.  */
697 #ifdef TUI
698             xfree (interpreter_p);
699             interpreter_p = xstrdup (INTERP_TUI);
700 #else
701             error (_("%s: TUI mode is not supported"), gdb_program_name);
702 #endif
703             break;
704           case OPT_WINDOWS:
705             /* FIXME: cagney/2003-03-01: Not sure if this option is
706                actually useful, and if it is, what it should do.  */
707 #ifdef GDBTK
708             /* --windows is equivalent to -i=insight.  */
709             xfree (interpreter_p);
710             interpreter_p = xstrdup (INTERP_INSIGHT);
711 #endif
712             break;
713           case OPT_NOWINDOWS:
714             /* -nw is equivalent to -i=console.  */
715             xfree (interpreter_p);
716             interpreter_p = xstrdup (INTERP_CONSOLE);
717             break;
718           case 'f':
719             annotation_level = 1;
720             break;
721           case 's':
722             symarg = optarg;
723             break;
724           case 'e':
725             execarg = optarg;
726             break;
727           case 'c':
728             corearg = optarg;
729             break;
730           case 'p':
731             pidarg = optarg;
732             break;
733           case 'x':
734             {
735               struct cmdarg cmdarg = { CMDARG_FILE, optarg };
736
737               cmdarg_vec.push_back (cmdarg);
738             }
739             break;
740           case 'X':
741             {
742               struct cmdarg cmdarg = { CMDARG_COMMAND, optarg };
743
744               cmdarg_vec.push_back (cmdarg);
745             }
746             break;
747           case OPT_IX:
748             {
749               struct cmdarg cmdarg = { CMDARG_INIT_FILE, optarg };
750
751               cmdarg_vec.push_back (cmdarg);
752             }
753             break;
754           case OPT_IEX:
755             {
756               struct cmdarg cmdarg = { CMDARG_INIT_COMMAND, optarg };
757
758               cmdarg_vec.push_back (cmdarg);
759             }
760             break;
761           case 'B':
762             batch_flag = batch_silent = 1;
763             gdb_stdout = ui_file_new();
764             break;
765           case 'D':
766             if (optarg[0] == '\0')
767               error (_("%s: empty path for `--data-directory'"),
768                      gdb_program_name);
769             set_gdb_data_directory (optarg);
770             gdb_datadir_provided = 1;
771             break;
772 #ifdef GDBTK
773           case 'z':
774             {
775               extern int gdbtk_test (char *);
776
777               if (!gdbtk_test (optarg))
778                 error (_("%s: unable to load tclcommand file \"%s\""),
779                        gdb_program_name, optarg);
780               break;
781             }
782           case 'y':
783             /* Backwards compatibility only.  */
784             break;
785           case 'w':
786             {
787               /* Set the external editor commands when gdb is farming out files
788                  to be edited by another program.  */
789               extern char *external_editor_command;
790
791               external_editor_command = xstrdup (optarg);
792               break;
793             }
794 #endif /* GDBTK */
795           case 'i':
796             xfree (interpreter_p);
797             interpreter_p = xstrdup (optarg);
798             break;
799           case 'd':
800             dirarg.push_back (optarg);
801             break;
802           case 't':
803             ttyarg = optarg;
804             break;
805           case 'q':
806             quiet = 1;
807             break;
808           case 'b':
809             {
810               int i;
811               char *p;
812
813               i = strtol (optarg, &p, 0);
814               if (i == 0 && p == optarg)
815                 warning (_("could not set baud rate to `%s'."),
816                          optarg);
817               else
818                 baud_rate = i;
819             }
820             break;
821           case 'l':
822             {
823               int i;
824               char *p;
825
826               i = strtol (optarg, &p, 0);
827               if (i == 0 && p == optarg)
828                 warning (_("could not set timeout limit to `%s'."),
829                          optarg);
830               else
831                 remote_timeout = i;
832             }
833             break;
834
835           case '?':
836             error (_("Use `%s --help' for a complete list of options."),
837                    gdb_program_name);
838           }
839       }
840
841     if (batch_flag)
842       quiet = 1;
843   }
844
845   /* Try to set up an alternate signal stack for SIGSEGV handlers.  */
846   setup_alternate_signal_stack ();
847
848   /* Initialize all files.  */
849   gdb_init (gdb_program_name);
850
851   /* Now that gdb_init has created the initial inferior, we're in
852      position to set args for that inferior.  */
853   if (set_args)
854     {
855       /* The remaining options are the command-line options for the
856          inferior.  The first one is the sym/exec file, and the rest
857          are arguments.  */
858       if (optind >= argc)
859         error (_("%s: `--args' specified but no program specified"),
860                gdb_program_name);
861
862       symarg = argv[optind];
863       execarg = argv[optind];
864       ++optind;
865       set_inferior_args_vector (argc - optind, &argv[optind]);
866     }
867   else
868     {
869       /* OK, that's all the options.  */
870
871       /* The first argument, if specified, is the name of the
872          executable.  */
873       if (optind < argc)
874         {
875           symarg = argv[optind];
876           execarg = argv[optind];
877           optind++;
878         }
879
880       /* If the user hasn't already specified a PID or the name of a
881          core file, then a second optional argument is allowed.  If
882          present, this argument should be interpreted as either a
883          PID or a core file, whichever works.  */
884       if (pidarg == NULL && corearg == NULL && optind < argc)
885         {
886           pid_or_core_arg = argv[optind];
887           optind++;
888         }
889
890       /* Any argument left on the command line is unexpected and
891          will be ignored.  Inform the user.  */
892       if (optind < argc)
893         fprintf_unfiltered (gdb_stderr,
894                             _("Excess command line "
895                               "arguments ignored. (%s%s)\n"),
896                             argv[optind],
897                             (optind == argc - 1) ? "" : " ...");
898     }
899
900   /* Lookup gdbinit files.  Note that the gdbinit file name may be
901      overriden during file initialization, so get_init_files should be
902      called after gdb_init.  */
903   get_init_files (&system_gdbinit, &home_gdbinit, &local_gdbinit);
904
905   /* Do these (and anything which might call wrap_here or *_filtered)
906      after initialize_all_files() but before the interpreter has been
907      installed.  Otherwize the help/version messages will be eaten by
908      the interpreter's output handler.  */
909
910   if (print_version)
911     {
912       print_gdb_version (gdb_stdout);
913       wrap_here ("");
914       printf_filtered ("\n");
915       exit (0);
916     }
917
918   if (print_help)
919     {
920       print_gdb_help (gdb_stdout);
921       fputs_unfiltered ("\n", gdb_stdout);
922       exit (0);
923     }
924
925   if (print_configuration)
926     {
927       print_gdb_configuration (gdb_stdout);
928       wrap_here ("");
929       printf_filtered ("\n");
930       exit (0);
931     }
932
933   /* FIXME: cagney/2003-02-03: The big hack (part 1 of 2) that lets
934      GDB retain the old MI1 interpreter startup behavior.  Output the
935      copyright message before the interpreter is installed.  That way
936      it isn't encapsulated in MI output.  */
937   if (!quiet && strcmp (interpreter_p, INTERP_MI1) == 0)
938     {
939       /* Print all the junk at the top, with trailing "..." if we are
940          about to read a symbol file (possibly slowly).  */
941       print_gdb_version (gdb_stdout);
942       if (symarg)
943         printf_filtered ("..");
944       wrap_here ("");
945       printf_filtered ("\n");
946       gdb_flush (gdb_stdout);   /* Force to screen during slow
947                                    operations.  */
948     }
949
950   /* Install the default UI.  All the interpreters should have had a
951      look at things by now.  Initialize the default interpreter.  */
952   set_top_level_interpreter (interpreter_p);
953
954   /* FIXME: cagney/2003-02-03: The big hack (part 2 of 2) that lets
955      GDB retain the old MI1 interpreter startup behavior.  Output the
956      copyright message after the interpreter is installed when it is
957      any sane interpreter.  */
958   if (!quiet && !current_interp_named_p (INTERP_MI1))
959     {
960       /* Print all the junk at the top, with trailing "..." if we are
961          about to read a symbol file (possibly slowly).  */
962       print_gdb_version (gdb_stdout);
963       if (symarg)
964         printf_filtered ("..");
965       wrap_here ("");
966       printf_filtered ("\n");
967       gdb_flush (gdb_stdout);   /* Force to screen during slow
968                                    operations.  */
969     }
970
971   /* Set off error and warning messages with a blank line.  */
972   xfree (warning_pre_print);
973   warning_pre_print = _("\nwarning: ");
974
975   /* Read and execute the system-wide gdbinit file, if it exists.
976      This is done *before* all the command line arguments are
977      processed; it sets global parameters, which are independent of
978      what file you are debugging or what directory you are in.  */
979   if (system_gdbinit && !inhibit_gdbinit)
980     catch_command_errors_const (source_script, system_gdbinit, 0);
981
982   /* Read and execute $HOME/.gdbinit file, if it exists.  This is done
983      *before* all the command line arguments are processed; it sets
984      global parameters, which are independent of what file you are
985      debugging or what directory you are in.  */
986
987   if (home_gdbinit && !inhibit_gdbinit && !inhibit_home_gdbinit)
988     catch_command_errors_const (source_script, home_gdbinit, 0);
989
990   /* Process '-ix' and '-iex' options early.  */
991   for (i = 0; i < cmdarg_vec.size (); i++)
992     {
993       const struct cmdarg &cmdarg_p = cmdarg_vec[i];
994
995       switch (cmdarg_p.type)
996         {
997         case CMDARG_INIT_FILE:
998           catch_command_errors_const (source_script, cmdarg_p.string,
999                                       !batch_flag);
1000           break;
1001         case CMDARG_INIT_COMMAND:
1002           catch_command_errors (execute_command, cmdarg_p.string,
1003                                 !batch_flag);
1004           break;
1005         }
1006     }
1007
1008   /* Now perform all the actions indicated by the arguments.  */
1009   if (cdarg != NULL)
1010     {
1011       catch_command_errors (cd_command, cdarg, 0);
1012     }
1013
1014   for (i = 0; i < dirarg.size (); i++)
1015     catch_command_errors (directory_switch, dirarg[i], 0);
1016
1017   /* Skip auto-loading section-specified scripts until we've sourced
1018      local_gdbinit (which is often used to augment the source search
1019      path).  */
1020   save_auto_load = global_auto_load;
1021   global_auto_load = 0;
1022
1023   if (execarg != NULL
1024       && symarg != NULL
1025       && strcmp (execarg, symarg) == 0)
1026     {
1027       /* The exec file and the symbol-file are the same.  If we can't
1028          open it, better only print one error message.
1029          catch_command_errors returns non-zero on success!  */
1030       if (catch_command_errors_const (exec_file_attach, execarg,
1031                                       !batch_flag))
1032         catch_command_errors_const (symbol_file_add_main, symarg,
1033                                     !batch_flag);
1034     }
1035   else
1036     {
1037       if (execarg != NULL)
1038         catch_command_errors_const (exec_file_attach, execarg,
1039                                     !batch_flag);
1040       if (symarg != NULL)
1041         catch_command_errors_const (symbol_file_add_main, symarg,
1042                                     !batch_flag);
1043     }
1044
1045   if (corearg && pidarg)
1046     error (_("Can't attach to process and specify "
1047              "a core file at the same time."));
1048
1049   if (corearg != NULL)
1050     catch_command_errors (core_file_command, corearg, !batch_flag);
1051   else if (pidarg != NULL)
1052     catch_command_errors (attach_command, pidarg, !batch_flag);
1053   else if (pid_or_core_arg)
1054     {
1055       /* The user specified 'gdb program pid' or gdb program core'.
1056          If pid_or_core_arg's first character is a digit, try attach
1057          first and then corefile.  Otherwise try just corefile.  */
1058
1059       if (isdigit (pid_or_core_arg[0]))
1060         {
1061           if (catch_command_errors (attach_command, pid_or_core_arg,
1062                                     !batch_flag) == 0)
1063             catch_command_errors (core_file_command, pid_or_core_arg,
1064                                   !batch_flag);
1065         }
1066       else /* Can't be a pid, better be a corefile.  */
1067         catch_command_errors (core_file_command, pid_or_core_arg,
1068                               !batch_flag);
1069     }
1070
1071   if (ttyarg != NULL)
1072     set_inferior_io_terminal (ttyarg);
1073
1074   /* Error messages should no longer be distinguished with extra output.  */
1075   warning_pre_print = _("warning: ");
1076
1077   /* Read the .gdbinit file in the current directory, *if* it isn't
1078      the same as the $HOME/.gdbinit file (it should exist, also).  */
1079   if (local_gdbinit)
1080     {
1081       auto_load_local_gdbinit_pathname = gdb_realpath (local_gdbinit);
1082
1083       if (!inhibit_gdbinit && auto_load_local_gdbinit
1084           && file_is_auto_load_safe (local_gdbinit,
1085                                      _("auto-load: Loading .gdbinit "
1086                                        "file \"%s\".\n"),
1087                                      local_gdbinit))
1088         {
1089           auto_load_local_gdbinit_loaded = 1;
1090
1091           catch_command_errors_const (source_script, local_gdbinit, 0);
1092         }
1093     }
1094
1095   /* Now that all .gdbinit's have been read and all -d options have been
1096      processed, we can read any scripts mentioned in SYMARG.
1097      We wait until now because it is common to add to the source search
1098      path in local_gdbinit.  */
1099   global_auto_load = save_auto_load;
1100   ALL_OBJFILES (objfile)
1101     load_auto_scripts_for_objfile (objfile);
1102
1103   /* Process '-x' and '-ex' options.  */
1104   for (i = 0; i < cmdarg_vec.size (); i++)
1105     {
1106       const struct cmdarg &cmdarg_p = cmdarg_vec[i];
1107
1108       switch (cmdarg_p.type)
1109         {
1110         case CMDARG_FILE:
1111           catch_command_errors_const (source_script, cmdarg_p.string,
1112                                       !batch_flag);
1113           break;
1114         case CMDARG_COMMAND:
1115           catch_command_errors (execute_command, cmdarg_p.string,
1116                                 !batch_flag);
1117           break;
1118         }
1119     }
1120
1121   /* Read in the old history after all the command files have been
1122      read.  */
1123   init_history ();
1124
1125   if (batch_flag)
1126     {
1127       /* We have hit the end of the batch file.  */
1128       quit_force (NULL, 0);
1129     }
1130 }
1131
1132 static void
1133 captured_main (void *data)
1134 {
1135   struct captured_main_args *context = (struct captured_main_args *) data;
1136
1137   captured_main_1 (context);
1138
1139   /* NOTE: cagney/1999-11-07: There is probably no reason for not
1140      moving this loop and the code found in captured_command_loop()
1141      into the command_loop() proper.  The main thing holding back that
1142      change - SET_TOP_LEVEL() - has been eliminated.  */
1143   while (1)
1144     {
1145       catch_errors (captured_command_loop, 0, "", RETURN_MASK_ALL);
1146     }
1147   /* No exit -- exit is through quit_command.  */
1148 }
1149
1150 int
1151 gdb_main (struct captured_main_args *args)
1152 {
1153   TRY
1154     {
1155       captured_main (args);
1156     }
1157   CATCH (ex, RETURN_MASK_ALL)
1158     {
1159       exception_print (gdb_stderr, ex);
1160     }
1161   END_CATCH
1162
1163   /* The only way to end up here is by an error (normal exit is
1164      handled by quit_force()), hence always return an error status.  */
1165   return 1;
1166 }
1167
1168
1169 /* Don't use *_filtered for printing help.  We don't want to prompt
1170    for continue no matter how small the screen or how much we're going
1171    to print.  */
1172
1173 static void
1174 print_gdb_help (struct ui_file *stream)
1175 {
1176   const char *system_gdbinit;
1177   const char *home_gdbinit;
1178   const char *local_gdbinit;
1179
1180   get_init_files (&system_gdbinit, &home_gdbinit, &local_gdbinit);
1181
1182   /* Note: The options in the list below are only approximately sorted
1183      in the alphabetical order, so as to group closely related options
1184      together.  */
1185   fputs_unfiltered (_("\
1186 This is the GNU debugger.  Usage:\n\n\
1187     gdb [options] [executable-file [core-file or process-id]]\n\
1188     gdb [options] --args executable-file [inferior-arguments ...]\n\n\
1189 "), stream);
1190   fputs_unfiltered (_("\
1191 Selection of debuggee and its files:\n\n\
1192   --args             Arguments after executable-file are passed to inferior\n\
1193   --core=COREFILE    Analyze the core dump COREFILE.\n\
1194   --exec=EXECFILE    Use EXECFILE as the executable.\n\
1195   --pid=PID          Attach to running process PID.\n\
1196   --directory=DIR    Search for source files in DIR.\n\
1197   --se=FILE          Use FILE as symbol file and executable file.\n\
1198   --symbols=SYMFILE  Read symbols from SYMFILE.\n\
1199   --readnow          Fully read symbol files on first access.\n\
1200   --write            Set writing into executable and core files.\n\n\
1201 "), stream);
1202   fputs_unfiltered (_("\
1203 Initial commands and command files:\n\n\
1204   --command=FILE, -x Execute GDB commands from FILE.\n\
1205   --init-command=FILE, -ix\n\
1206                      Like -x but execute commands before loading inferior.\n\
1207   --eval-command=COMMAND, -ex\n\
1208                      Execute a single GDB command.\n\
1209                      May be used multiple times and in conjunction\n\
1210                      with --command.\n\
1211   --init-eval-command=COMMAND, -iex\n\
1212                      Like -ex but before loading inferior.\n\
1213   --nh               Do not read ~/.gdbinit.\n\
1214   --nx               Do not read any .gdbinit files in any directory.\n\n\
1215 "), stream);
1216   fputs_unfiltered (_("\
1217 Output and user interface control:\n\n\
1218   --fullname         Output information used by emacs-GDB interface.\n\
1219   --interpreter=INTERP\n\
1220                      Select a specific interpreter / user interface\n\
1221   --tty=TTY          Use TTY for input/output by the program being debugged.\n\
1222   -w                 Use the GUI interface.\n\
1223   --nw               Do not use the GUI interface.\n\
1224 "), stream);
1225 #if defined(TUI)
1226   fputs_unfiltered (_("\
1227   --tui              Use a terminal user interface.\n\
1228 "), stream);
1229 #endif
1230   fputs_unfiltered (_("\
1231   --dbx              DBX compatibility mode.\n\
1232   -q, --quiet, --silent\n\
1233                      Do not print version number on startup.\n\n\
1234 "), stream);
1235   fputs_unfiltered (_("\
1236 Operating modes:\n\n\
1237   --batch            Exit after processing options.\n\
1238   --batch-silent     Like --batch, but suppress all gdb stdout output.\n\
1239   --return-child-result\n\
1240                      GDB exit code will be the child's exit code.\n\
1241   --configuration    Print details about GDB configuration and then exit.\n\
1242   --help             Print this message and then exit.\n\
1243   --version          Print version information and then exit.\n\n\
1244 Remote debugging options:\n\n\
1245   -b BAUDRATE        Set serial port baud rate used for remote debugging.\n\
1246   -l TIMEOUT         Set timeout in seconds for remote debugging.\n\n\
1247 Other options:\n\n\
1248   --cd=DIR           Change current directory to DIR.\n\
1249   --data-directory=DIR, -D\n\
1250                      Set GDB's data-directory to DIR.\n\
1251 "), stream);
1252   fputs_unfiltered (_("\n\
1253 At startup, GDB reads the following init files and executes their commands:\n\
1254 "), stream);
1255   if (system_gdbinit)
1256     fprintf_unfiltered (stream, _("\
1257    * system-wide init file: %s\n\
1258 "), system_gdbinit);
1259   if (home_gdbinit)
1260     fprintf_unfiltered (stream, _("\
1261    * user-specific init file: %s\n\
1262 "), home_gdbinit);
1263   if (local_gdbinit)
1264     fprintf_unfiltered (stream, _("\
1265    * local init file (see also 'set auto-load local-gdbinit'): ./%s\n\
1266 "), local_gdbinit);
1267   fputs_unfiltered (_("\n\
1268 For more information, type \"help\" from within GDB, or consult the\n\
1269 GDB manual (available as on-line info or a printed manual).\n\
1270 "), stream);
1271   if (REPORT_BUGS_TO[0] && stream == gdb_stdout)
1272     fprintf_unfiltered (stream, _("\
1273 Report bugs to \"%s\".\n\
1274 "), REPORT_BUGS_TO);
1275 }