gdb/main.c

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