gdb/defs.h

   1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
   2                       for now.  */
   3 /* Basic, host-specific, and target-specific definitions for GDB.
   4    Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
   5    1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009,
   6    2010, 2011 Free Software Foundation, Inc.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 #ifndef DEFS_H
  24 #define DEFS_H
  25
  26 #ifdef GDBSERVER
  27 #  error gdbserver should not include gdb/defs.h
  28 #endif
  29
  30 #include "config.h"             /* Generated by configure.  */
  31
  32 #include <sys/types.h>
  33 #include <stdio.h>
  34 #include <errno.h>              /* System call error return status.  */
  35 #include <limits.h>
  36 #include <stdint.h>
  37
  38 /* The libdecnumber library, on which GDB depends, includes a header file
  39    called gstdint.h instead of relying directly on stdint.h.  GDB, on the
  40    other hand, includes stdint.h directly, relying on the fact that gnulib
  41    generates a copy if the system doesn't provide one or if it is missing
  42    some features.  Unfortunately, gstdint.h and stdint.h cannot be included
  43    at the same time, which may happen when we include a file from
  44    libdecnumber.
  45
  46    The following macro definition effectively prevents the inclusion of
  47    gstdint.h, as all the definitions it provides are guarded against
  48    the GCC_GENERATED_STDINT_H macro.  We already have gnulib/stdint.h
  49    included, so it's ok to blank out gstdint.h.  */
  50 #define GCC_GENERATED_STDINT_H 1
  51
  52 #ifdef HAVE_STDDEF_H
  53 #include <stddef.h>
  54 #endif
  55
  56 #ifdef HAVE_UNISTD_H
  57 #include <unistd.h>
  58 #endif
  59
  60 #include <fcntl.h>
  61
  62 /* First include ansidecl.h so we can use the various macro definitions
  63    here and in all subsequent file inclusions.  */
  64
  65 #include "ansidecl.h"
  66
  67 #include "gdb_locale.h"
  68
  69 #include "gdb_wchar.h"
  70
  71 /* For ``enum target_signal''.  */
  72 #include "gdb/signals.h"
  73
  74 /* Just in case they're not defined in stdio.h.  */
  75
  76 #ifndef SEEK_SET
  77 #define SEEK_SET 0
  78 #endif
  79 #ifndef SEEK_CUR
  80 #define SEEK_CUR 1
  81 #endif
  82
  83 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
  84    It is used as an access modifier in calls to open(), where it acts
  85    similarly to the "b" character in fopen()'s MODE argument.  On Posix
  86    platforms it should be a no-op, so it is defined as 0 here.  This
  87    ensures that the symbol may be used freely elsewhere in gdb.  */
  88
  89 #ifndef O_BINARY
  90 #define O_BINARY 0
  91 #endif
  92
  93 #include <stdarg.h>             /* For va_list.  */
  94
  95 #include "libiberty.h"
  96
  97 /* Rather than duplicate all the logic in BFD for figuring out what
  98    types to use (which can be pretty complicated), symply define them
  99    in terms of the corresponding type from BFD.  */
 100
 101 #include "bfd.h"
 102
 103 /* A byte from the program being debugged.  */
 104 typedef bfd_byte gdb_byte;
 105
 106 /* An address in the program being debugged.  Host byte order.  */
 107 typedef bfd_vma CORE_ADDR;
 108
 109 /* The largest CORE_ADDR value.  */
 110 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
 111
 112 /* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */
 113
 114 #ifndef LONGEST
 115
 116 #ifdef BFD64
 117
 118 #define LONGEST BFD_HOST_64_BIT
 119 #define ULONGEST BFD_HOST_U_64_BIT
 120
 121 #else /* No BFD64 */
 122
 123 #ifdef CC_HAS_LONG_LONG
 124 #define LONGEST long long
 125 #define ULONGEST unsigned long long
 126 #else
 127 #ifdef BFD_HOST_64_BIT
 128 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
 129    (e.g. i386-windows) so try it.  */
 130 #define LONGEST BFD_HOST_64_BIT
 131 #define ULONGEST BFD_HOST_U_64_BIT
 132 #else
 133 #define LONGEST long
 134 #define ULONGEST unsigned long
 135 #endif
 136 #endif
 137
 138 #endif /* No BFD64 */
 139
 140 #endif /* ! LONGEST */
 141
 142 #ifndef min
 143 #define min(a, b) ((a) < (b) ? (a) : (b))
 144 #endif
 145 #ifndef max
 146 #define max(a, b) ((a) > (b) ? (a) : (b))
 147 #endif
 148
 149 #include "ptid.h"
 150
 151 /* Check if a character is one of the commonly used C++ marker characters.  */
 152 extern int is_cplus_marker (int);
 153
 154 /* Enable xdb commands if set.  */
 155 extern int xdb_commands;
 156
 157 /* Enable dbx commands if set.  */
 158 extern int dbx_commands;
 159
 160 /* System root path, used to find libraries etc.  */
 161 extern char *gdb_sysroot;
 162
 163 /* GDB datadir, used to store data files.  */
 164 extern char *gdb_datadir;
 165
 166 /* If non-NULL, the possibly relocated path to python's "lib" directory
 167    specified with --with-python.  */
 168 extern char *python_libdir;
 169
 170 /* Search path for separate debug files.  */
 171 extern char *debug_file_directory;
 172
 173 extern int quit_flag;
 174 extern int immediate_quit;
 175 extern int sevenbit_strings;
 176
 177 extern void quit (void);
 178
 179 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
 180    benefits of having a ``QUIT'' macro rather than a function are
 181    marginal.  If the overhead of a QUIT function call is proving
 182    significant then its calling frequency should probably be reduced
 183    [kingdon].  A profile analyzing the current situtation is
 184    needed.  */
 185
 186 #define QUIT { \
 187   if (quit_flag) quit (); \
 188   if (deprecated_interactive_hook) deprecated_interactive_hook (); \
 189 }
 190
 191 /* Languages represented in the symbol table and elsewhere.
 192    This should probably be in language.h, but since enum's can't
 193    be forward declared to satisfy opaque references before their
 194    actual definition, needs to be here.  */
 195
 196 enum language
 197   {
 198     language_unknown,           /* Language not known */
 199     language_auto,              /* Placeholder for automatic setting */
 200     language_c,                 /* C */
 201     language_cplus,             /* C++ */
 202     language_d,                 /* D */
 203     language_objc,              /* Objective-C */
 204     language_java,              /* Java */
 205     language_fortran,           /* Fortran */
 206     language_m2,                /* Modula-2 */
 207     language_asm,               /* Assembly language */
 208     language_pascal,            /* Pascal */
 209     language_ada,               /* Ada */
 210     language_opencl,            /* OpenCL */
 211     language_minimal,           /* All other languages, minimal support only */
 212     nr_languages
 213   };
 214
 215 enum precision_type
 216   {
 217     single_precision,
 218     double_precision,
 219     unspecified_precision
 220   };
 221
 222 /* A generic, not quite boolean, enumeration.  */
 223 enum auto_boolean
 224 {
 225   AUTO_BOOLEAN_TRUE,
 226   AUTO_BOOLEAN_FALSE,
 227   AUTO_BOOLEAN_AUTO
 228 };
 229
 230 /* Potential ways that a function can return a value of a given type.  */
 231 enum return_value_convention
 232 {
 233   /* Where the return value has been squeezed into one or more
 234      registers.  */
 235   RETURN_VALUE_REGISTER_CONVENTION,
 236   /* Commonly known as the "struct return convention".  The caller
 237      passes an additional hidden first parameter to the caller.  That
 238      parameter contains the address at which the value being returned
 239      should be stored.  While typically, and historically, used for
 240      large structs, this is convention is applied to values of many
 241      different types.  */
 242   RETURN_VALUE_STRUCT_CONVENTION,
 243   /* Like the "struct return convention" above, but where the ABI
 244      guarantees that the called function stores the address at which
 245      the value being returned is stored in a well-defined location,
 246      such as a register or memory slot in the stack frame.  Don't use
 247      this if the ABI doesn't explicitly guarantees this.  */
 248   RETURN_VALUE_ABI_RETURNS_ADDRESS,
 249   /* Like the "struct return convention" above, but where the ABI
 250      guarantees that the address at which the value being returned is
 251      stored will be available in a well-defined location, such as a
 252      register or memory slot in the stack frame.  Don't use this if
 253      the ABI doesn't explicitly guarantees this.  */
 254   RETURN_VALUE_ABI_PRESERVES_ADDRESS,
 255 };
 256
 257 /* the cleanup list records things that have to be undone
 258    if an error happens (descriptors to be closed, memory to be freed, etc.)
 259    Each link in the chain records a function to call and an
 260    argument to give it.
 261
 262    Use make_cleanup to add an element to the cleanup chain.
 263    Use do_cleanups to do all cleanup actions back to a given
 264    point in the chain.  Use discard_cleanups to remove cleanups
 265    from the chain back to a given point, not doing them.
 266
 267    If the argument is pointer to allocated memory, then you need
 268    to additionally set the 'free_arg' member to a function that will
 269    free that memory.  This function will be called both when the cleanup
 270    is executed and when it's discarded.  */
 271
 272 struct cleanup
 273   {
 274     struct cleanup *next;
 275     void (*function) (void *);
 276     void (*free_arg) (void *);
 277     void *arg;
 278   };
 279
 280 /* vec.h-style vectors of strings want a typedef for char * or const char *.  */
 281
 282 typedef char * char_ptr;
 283 typedef const char * const_char_ptr;
 284
 285 /* Needed for various prototypes */
 286
 287 struct symtab;
 288 struct breakpoint;
 289 struct frame_info;
 290 struct gdbarch;
 291 struct value;
 292
 293 /* From main.c.  */
 294
 295 /* This really belong in utils.c (path-utils.c?), but it references some
 296    globals that are currently only available to main.c.  */
 297 extern char *relocate_gdb_directory (const char *initial, int flag);
 298
 299 /* From utils.c */
 300
 301 extern void initialize_utils (void);
 302
 303 extern void notice_quit (void);
 304
 305 extern int strcmp_iw (const char *, const char *);
 306
 307 extern int strcmp_iw_ordered (const char *, const char *);
 308
 309 extern int streq (const char *, const char *);
 310
 311 extern int subset_compare (char *, char *);
 312
 313 extern char *safe_strerror (int);
 314
 315 extern void set_display_time (int);
 316
 317 extern void set_display_space (int);
 318
 319 #define ALL_CLEANUPS    ((struct cleanup *)0)
 320
 321 extern void do_cleanups (struct cleanup *);
 322 extern void do_final_cleanups (struct cleanup *);
 323
 324 extern void discard_cleanups (struct cleanup *);
 325 extern void discard_final_cleanups (struct cleanup *);
 326 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
 327
 328 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
 329    make_cleanup function declarations below.  Do not use this typedef
 330    as a cast when passing functions into the make_cleanup() code.
 331    Instead either use a bounce function or add a wrapper function.
 332    Calling a f(char*) function with f(void*) is non-portable.  */
 333 typedef void (make_cleanup_ftype) (void *);
 334
 335 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
 336
 337 extern struct cleanup *make_cleanup_dtor (make_cleanup_ftype *, void *,
 338                                           void (*dtor) (void *));
 339
 340 extern struct cleanup *make_cleanup_freeargv (char **);
 341
 342 struct ui_file;
 343 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
 344
 345 struct ui_out;
 346 extern struct cleanup *
 347   make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
 348
 349 struct section_addr_info;
 350 extern struct cleanup *(make_cleanup_free_section_addr_info
 351                         (struct section_addr_info *));
 352
 353 extern struct cleanup *make_cleanup_close (int fd);
 354
 355 extern struct cleanup *make_cleanup_fclose (FILE *file);
 356
 357 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
 358
 359 struct obstack;
 360 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
 361
 362 extern struct cleanup *make_cleanup_restore_integer (int *variable);
 363 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
 364
 365 struct target_ops;
 366 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
 367
 368 extern struct cleanup *
 369   make_cleanup_restore_ui_file (struct ui_file **variable);
 370
 371 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
 372 extern struct cleanup *make_cleanup_value_free (struct value *);
 373
 374 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
 375
 376 extern struct cleanup *make_my_cleanup (struct cleanup **,
 377                                         make_cleanup_ftype *, void *);
 378
 379 extern struct cleanup *make_my_cleanup2 (struct cleanup **,
 380                                          make_cleanup_ftype *, void *,
 381                                          void (*free_arg) (void *));
 382
 383 extern struct cleanup *save_cleanups (void);
 384 extern struct cleanup *save_final_cleanups (void);
 385 extern struct cleanup *save_my_cleanups (struct cleanup **);
 386
 387 extern void restore_cleanups (struct cleanup *);
 388 extern void restore_final_cleanups (struct cleanup *);
 389 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 390
 391 extern void free_current_contents (void *);
 392
 393 extern void null_cleanup (void *);
 394
 395 extern struct cleanup *make_command_stats_cleanup (int);
 396
 397 extern int myread (int, char *, int);
 398
 399 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 400 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 401 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 402
 403 extern void init_page_info (void);
 404
 405 extern struct cleanup *make_cleanup_restore_page_info (void);
 406 extern struct cleanup *
 407   set_batch_flag_and_make_cleanup_restore_page_info (void);
 408
 409 extern char *gdb_realpath (const char *);
 410 extern char *xfullpath (const char *);
 411
 412 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
 413                                           unsigned char *buf, size_t len);
 414
 415 ULONGEST strtoulst (const char *num, const char **trailer, int base);
 416
 417 char *ldirname (const char *filename);
 418
 419 char **gdb_buildargv (const char *);
 420
 421 int compare_positive_ints (const void *ap, const void *bp);
 422
 423 /* A wrapper for bfd_errmsg to produce a more helpful error message
 424    in the case of bfd_error_file_ambiguously recognized.
 425    MATCHING, if non-NULL, is the corresponding argument to
 426    bfd_check_format_matches, and will be freed.  */
 427
 428 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
 429
 430 extern int parse_pid_to_attach (char *args);
 431
 432 /* From demangle.c */
 433
 434 extern void set_demangling_style (char *);
 435
 436 \f
 437 /* Annotation stuff.  */
 438
 439 extern int annotation_level;    /* in stack.c */
 440 \f
 441 extern void begin_line (void);
 442
 443 extern void wrap_here (char *);
 444
 445 extern void reinitialize_more_filter (void);
 446
 447 /* Normal results */
 448 extern struct ui_file *gdb_stdout;
 449 /* Input stream */
 450 extern struct ui_file *gdb_stdin;
 451 /* Serious error notifications */
 452 extern struct ui_file *gdb_stderr;
 453 /* Log/debug/trace messages that should bypass normal stdout/stderr
 454    filtering.  For moment, always call this stream using
 455    *_unfiltered.  In the very near future that restriction shall be
 456    removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
 457 extern struct ui_file *gdb_stdlog;
 458 /* Target output that should bypass normal stdout/stderr filtering.
 459    For moment, always call this stream using *_unfiltered.  In the
 460    very near future that restriction shall be removed - either call
 461    shall be unfiltered.  (cagney 1999-07-02).  */
 462 extern struct ui_file *gdb_stdtarg;
 463 extern struct ui_file *gdb_stdtargerr;
 464 extern struct ui_file *gdb_stdtargin;
 465
 466 #include "ui-file.h"
 467
 468 /* More generic printf like operations.  Filtered versions may return
 469    non-locally on error.  */
 470
 471 extern void fputs_filtered (const char *, struct ui_file *);
 472
 473 extern void fputs_unfiltered (const char *, struct ui_file *);
 474
 475 extern int fputc_filtered (int c, struct ui_file *);
 476
 477 extern int fputc_unfiltered (int c, struct ui_file *);
 478
 479 extern int putchar_filtered (int c);
 480
 481 extern int putchar_unfiltered (int c);
 482
 483 extern void puts_filtered (const char *);
 484
 485 extern void puts_unfiltered (const char *);
 486
 487 extern void puts_filtered_tabular (char *string, int width, int right);
 488
 489 extern void puts_debug (char *prefix, char *string, char *suffix);
 490
 491 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 492
 493 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 494   ATTRIBUTE_PRINTF (2, 0);
 495
 496 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 497   ATTRIBUTE_PRINTF (2, 3);
 498
 499 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 500   ATTRIBUTE_PRINTF (3, 4);
 501
 502 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 503
 504 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 505
 506 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 507
 508 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 509   ATTRIBUTE_PRINTF (2, 0);
 510
 511 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 512   ATTRIBUTE_PRINTF (2, 3);
 513
 514 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 515
 516 extern void print_spaces (int, struct ui_file *);
 517
 518 extern void print_spaces_filtered (int, struct ui_file *);
 519
 520 extern char *n_spaces (int);
 521
 522 extern void fputstr_filtered (const char *str, int quotr,
 523                               struct ui_file * stream);
 524
 525 extern void fputstr_unfiltered (const char *str, int quotr,
 526                                 struct ui_file * stream);
 527
 528 extern void fputstrn_filtered (const char *str, int n, int quotr,
 529                                struct ui_file * stream);
 530
 531 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 532                                  struct ui_file * stream);
 533
 534 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 535 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 536
 537 extern const char *host_address_to_string (const void *addr);
 538
 539 /* Convert CORE_ADDR to string in platform-specific manner.
 540    This is usually formatted similar to 0x%lx.  */
 541 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 542
 543 /* Return a string representation in hexadecimal notation of ADDRESS,
 544    which is suitable for printing.  */
 545
 546 extern const char *print_core_address (struct gdbarch *gdbarch,
 547                                        CORE_ADDR address);
 548
 549 /* %d for LONGEST */
 550 extern char *plongest (LONGEST l);
 551 /* %u for ULONGEST */
 552 extern char *pulongest (ULONGEST l);
 553
 554 extern char *phex (ULONGEST l, int sizeof_l);
 555 extern char *phex_nz (ULONGEST l, int sizeof_l);
 556 extern char *int_string (LONGEST, int, int, int, int);
 557
 558 /* Convert a CORE_ADDR into a HEX string with leading zeros.
 559    The output from core_addr_to_string() can be passed direct to
 560    string_to_core_addr().  */
 561 extern const char *core_addr_to_string (const CORE_ADDR addr);
 562 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 563 extern CORE_ADDR string_to_core_addr (const char *my_string);
 564
 565 /* Return a string that contains a number formatted as a hex
 566    string.  */
 567 extern char *hex_string (LONGEST);
 568 extern char *hex_string_custom (LONGEST, int);
 569
 570 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 571                                      enum language, int);
 572
 573 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
 574
 575 extern void print_sys_errmsg (const char *, int);
 576
 577 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 578    "const char *" in unistd.h, so we can't declare the argument
 579    as "char *".  */
 580
 581 extern char *re_comp (const char *);
 582
 583 /* From symfile.c */
 584
 585 extern void symbol_file_command (char *, int);
 586
 587 /* Remote targets may wish to use this as their load function.  */
 588 extern void generic_load (char *name, int from_tty);
 589
 590 /* Report on STREAM the performance of memory transfer operation,
 591    such as 'load'.
 592    DATA_COUNT is the number of bytes transferred.
 593    WRITE_COUNT is the number of separate write operations, or 0,
 594    if that information is not available.
 595    START_TIME is the time at which an operation was started.
 596    END_TIME is the time at which an operation ended.  */
 597 struct timeval;
 598 extern void print_transfer_performance (struct ui_file *stream,
 599                                         unsigned long data_count,
 600                                         unsigned long write_count,
 601                                         const struct timeval *start_time,
 602                                         const struct timeval *end_time);
 603
 604 /* From top.c */
 605
 606 typedef void initialize_file_ftype (void);
 607
 608 extern char *skip_quoted (char *);
 609
 610 extern char *gdb_readline (char *);
 611
 612 extern char *gdb_readline_wrapper (char *);
 613
 614 extern char *command_line_input (char *, int, char *);
 615
 616 extern void print_prompt (void);
 617
 618 extern int input_from_terminal_p (void);
 619
 620 extern int info_verbose;
 621
 622 /* From printcmd.c */
 623
 624 extern void set_next_address (struct gdbarch *, CORE_ADDR);
 625
 626 extern void print_address_symbolic (struct gdbarch *, CORE_ADDR,
 627                                     struct ui_file *, int, char *);
 628
 629 extern int build_address_symbolic (struct gdbarch *,
 630                                    CORE_ADDR addr,
 631                                    int do_demangle,
 632                                    char **name,
 633                                    int *offset,
 634                                    char **filename,
 635                                    int *line,
 636                                    int *unmapped);
 637
 638 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
 639 extern const char *pc_prefix (CORE_ADDR);
 640
 641 /* From source.c */
 642
 643 #define OPF_TRY_CWD_FIRST     0x01
 644 #define OPF_SEARCH_IN_PATH    0x02
 645
 646 extern int openp (const char *, int, const char *, int, char **);
 647
 648 extern int source_full_path_of (const char *, char **);
 649
 650 extern void mod_path (char *, char **);
 651
 652 extern void add_path (char *, char **, int);
 653
 654 extern void directory_command (char *, int);
 655
 656 extern void directory_switch (char *, int);
 657
 658 extern char *source_path;
 659
 660 extern void init_source_path (void);
 661
 662 /* From exec.c */
 663
 664 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
 665                                          int read, int write, int exec,
 666                                          void *data);
 667
 668 /* Take over the 'find_mapped_memory' vector from exec.c.  */
 669 extern void exec_set_find_memory_regions
 670   (int (*func) (find_memory_region_ftype func, void *data));
 671
 672 /* Possible lvalue types.  Like enum language, this should be in
 673    value.h, but needs to be here for the same reason.  */
 674
 675 enum lval_type
 676   {
 677     /* Not an lval.  */
 678     not_lval,
 679     /* In memory.  */
 680     lval_memory,
 681     /* In a register.  Registers are relative to a frame.  */
 682     lval_register,
 683     /* In a gdb internal variable.  */
 684     lval_internalvar,
 685     /* Part of a gdb internal variable (structure field).  */
 686     lval_internalvar_component,
 687     /* Value's bits are fetched and stored using functions provided by
 688        its creator.  */
 689     lval_computed
 690   };
 691
 692 /* Control types for commands */
 693
 694 enum misc_command_type
 695   {
 696     ok_command,
 697     end_command,
 698     else_command,
 699     nop_command
 700   };
 701
 702 enum command_control_type
 703   {
 704     simple_control,
 705     break_control,
 706     continue_control,
 707     while_control,
 708     if_control,
 709     commands_control,
 710     python_control,
 711     while_stepping_control,
 712     invalid_control
 713   };
 714
 715 /* Structure for saved commands lines
 716    (for breakpoints, defined commands, etc).  */
 717
 718 struct command_line
 719   {
 720     struct command_line *next;
 721     char *line;
 722     enum command_control_type control_type;
 723     /* The number of elements in body_list.  */
 724     int body_count;
 725     /* For composite commands, the nested lists of commands.  For
 726        example, for "if" command this will contain the then branch and
 727        the else branch, if that is available.  */
 728     struct command_line **body_list;
 729   };
 730
 731 extern struct command_line *read_command_lines (char *, int, int,
 732                                                 void (*)(char *, void *),
 733                                                 void *);
 734 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
 735                                                   void (*)(char *, void *),
 736                                                   void *);
 737
 738 extern void free_command_lines (struct command_line **);
 739
 740 /* String containing the current directory (what getwd would return).  */
 741
 742 extern char *current_directory;
 743
 744 /* Default radixes for input and output.  Only some values supported.  */
 745 extern unsigned input_radix;
 746 extern unsigned output_radix;
 747
 748 /* Possibilities for prettyprint parameters to routines which print
 749    things.  Like enum language, this should be in value.h, but needs
 750    to be here for the same reason.  FIXME:  If we can eliminate this
 751    as an arg to LA_VAL_PRINT, then we can probably move it back to
 752    value.h.  */
 753
 754 enum val_prettyprint
 755   {
 756     Val_no_prettyprint = 0,
 757     Val_prettyprint,
 758     /* Use the default setting which the user has specified.  */
 759     Val_pretty_default
 760   };
 761
 762 /* Optional native machine support.  Non-native (and possibly pure
 763    multi-arch) targets do not need a "nm.h" file.  This will be a
 764    symlink to one of the nm-*.h files, built by the `configure'
 765    script.  */
 766
 767 #ifdef GDB_NM_FILE
 768 #include "nm.h"
 769 #endif
 770
 771 /* Assume that fopen accepts the letter "b" in the mode string.
 772    It is demanded by ISO C9X, and should be supported on all
 773    platforms that claim to have a standard-conforming C library.  On
 774    true POSIX systems it will be ignored and have no effect.  There
 775    may still be systems without a standard-conforming C library where
 776    an ISO C9X compiler (GCC) is available.  Known examples are SunOS
 777    4.x and 4.3BSD.  This assumption means these systems are no longer
 778    supported.  */
 779 #ifndef FOPEN_RB
 780 # include "fopen-bin.h"
 781 #endif
 782
 783 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 784    FIXME: Assumes 2's complement arithmetic.  */
 785
 786 #if !defined (UINT_MAX)
 787 #define UINT_MAX ((unsigned int)(~0))       /* 0xFFFFFFFF for 32-bits */
 788 #endif
 789
 790 #if !defined (INT_MAX)
 791 #define INT_MAX ((int)(UINT_MAX >> 1))      /* 0x7FFFFFFF for 32-bits */
 792 #endif
 793
 794 #if !defined (INT_MIN)
 795 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
 796 #endif
 797
 798 #if !defined (ULONG_MAX)
 799 #define ULONG_MAX ((unsigned long)(~0L))    /* 0xFFFFFFFF for 32-bits */
 800 #endif
 801
 802 #if !defined (LONG_MAX)
 803 #define LONG_MAX ((long)(ULONG_MAX >> 1))   /* 0x7FFFFFFF for 32-bits */
 804 #endif
 805
 806 #if !defined (ULONGEST_MAX)
 807 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 808 #endif
 809
 810 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 811 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 812 #endif
 813
 814 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 815    arguments to a function, number in a value history, register number, etc.)
 816    where the value must not be larger than can fit in an int.  */
 817
 818 extern int longest_to_int (LONGEST);
 819
 820 /* Assorted functions we can declare, now that const and volatile are
 821    defined.  */
 822
 823 extern char *savestring (const char *, size_t);
 824
 825 /* Utility macros to allocate typed memory.  Avoids errors like:
 826    struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
 827    sizeof (struct foo), 0).  */
 828 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
 829 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 830 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 831
 832 #include "common-utils.h"
 833
 834 extern int parse_escape (struct gdbarch *, char **);
 835
 836 /* Message to be printed before the error message, when an error occurs.  */
 837
 838 extern char *error_pre_print;
 839
 840 /* Message to be printed before the error message, when an error occurs.  */
 841
 842 extern char *quit_pre_print;
 843
 844 /* Message to be printed before the warning message, when a warning occurs.  */
 845
 846 extern char *warning_pre_print;
 847
 848 extern void verror (const char *fmt, va_list ap)
 849      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 850
 851 extern void error (const char *fmt, ...)
 852      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 853
 854 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
 855
 856 extern void vfatal (const char *fmt, va_list ap)
 857      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 858
 859 extern void fatal (const char *fmt, ...)
 860      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 861
 862 extern void internal_verror (const char *file, int line, const char *,
 863                              va_list ap)
 864      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
 865
 866 extern void internal_vwarning (const char *file, int line,
 867                                const char *, va_list ap)
 868      ATTRIBUTE_PRINTF (3, 0);
 869
 870 extern void internal_warning (const char *file, int line,
 871                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 872
 873 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 874
 875 extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
 876
 877 /* List of known OS ABIs.  If you change this, make sure to update the
 878    table in osabi.c.  */
 879 enum gdb_osabi
 880 {
 881   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
 882
 883   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
 884
 885   GDB_OSABI_SVR4,
 886   GDB_OSABI_HURD,
 887   GDB_OSABI_SOLARIS,
 888   GDB_OSABI_OSF1,
 889   GDB_OSABI_LINUX,
 890   GDB_OSABI_FREEBSD_AOUT,
 891   GDB_OSABI_FREEBSD_ELF,
 892   GDB_OSABI_NETBSD_AOUT,
 893   GDB_OSABI_NETBSD_ELF,
 894   GDB_OSABI_OPENBSD_ELF,
 895   GDB_OSABI_WINCE,
 896   GDB_OSABI_GO32,
 897   GDB_OSABI_IRIX,
 898   GDB_OSABI_INTERIX,
 899   GDB_OSABI_HPUX_ELF,
 900   GDB_OSABI_HPUX_SOM,
 901   GDB_OSABI_QNXNTO,
 902   GDB_OSABI_CYGWIN,
 903   GDB_OSABI_AIX,
 904   GDB_OSABI_DICOS,
 905   GDB_OSABI_DARWIN,
 906   GDB_OSABI_SYMBIAN,
 907
 908   GDB_OSABI_INVALID             /* keep this last */
 909 };
 910
 911 /* Global functions from other, non-gdb GNU thingies.
 912    Libiberty thingies are no longer declared here.  We include libiberty.h
 913    above, instead.  */
 914
 915 /* From other system libraries */
 916
 917 #ifdef HAVE_STDDEF_H
 918 #include <stddef.h>
 919 #endif
 920
 921 #ifdef HAVE_STDLIB_H
 922 #include <stdlib.h>
 923 #endif
 924 #ifndef min
 925 #define min(a, b) ((a) < (b) ? (a) : (b))
 926 #endif
 927 #ifndef max
 928 #define max(a, b) ((a) > (b) ? (a) : (b))
 929 #endif
 930
 931
 932 #ifndef atof
 933 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
 934 #endif
 935
 936 /* Various possibilities for alloca.  */
 937 #ifndef alloca
 938 #ifdef __GNUC__
 939 #define alloca __builtin_alloca
 940 #else /* Not GNU C */
 941 #ifdef HAVE_ALLOCA_H
 942 #include <alloca.h>
 943 #else
 944 #ifdef _AIX
 945 #pragma alloca
 946 #else
 947
 948 /* We need to be careful not to declare this in a way which conflicts with
 949    bison.  Bison never declares it as char *, but under various circumstances
 950    (like __hpux) we need to use void *.  */
 951 extern void *alloca ();
 952 #endif /* Not _AIX */
 953 #endif /* Not HAVE_ALLOCA_H */
 954 #endif /* Not GNU C */
 955 #endif /* alloca not defined */
 956
 957 /* Dynamic target-system-dependent parameters for GDB.  */
 958 #include "gdbarch.h"
 959
 960 /* Maximum size of a register.  Something small, but large enough for
 961    all known ISAs.  If it turns out to be too small, make it bigger.  */
 962
 963 enum { MAX_REGISTER_SIZE = 64 };
 964
 965 /* Static target-system-dependent parameters for GDB.  */
 966
 967 /* Number of bits in a char or unsigned char for the target machine.
 968    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
 969 #if !defined (TARGET_CHAR_BIT)
 970 #define TARGET_CHAR_BIT 8
 971 #endif
 972
 973 /* If we picked up a copy of CHAR_BIT from a configuration file
 974    (which may get it by including <limits.h>) then use it to set
 975    the number of bits in a host char.  If not, use the same size
 976    as the target.  */
 977
 978 #if defined (CHAR_BIT)
 979 #define HOST_CHAR_BIT CHAR_BIT
 980 #else
 981 #define HOST_CHAR_BIT TARGET_CHAR_BIT
 982 #endif
 983
 984 /* In findvar.c.  */
 985
 986 extern LONGEST extract_signed_integer (const gdb_byte *, int,
 987                                        enum bfd_endian);
 988
 989 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
 990                                           enum bfd_endian);
 991
 992 extern int extract_long_unsigned_integer (const gdb_byte *, int,
 993                                           enum bfd_endian, LONGEST *);
 994
 995 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
 996                                         struct type *type);
 997
 998 extern void store_signed_integer (gdb_byte *, int,
 999                                   enum bfd_endian, LONGEST);
1000
1001 extern void store_unsigned_integer (gdb_byte *, int,
1002                                     enum bfd_endian, ULONGEST);
1003
1004 extern void store_typed_address (gdb_byte *buf, struct type *type,
1005                                  CORE_ADDR addr);
1006
1007 \f
1008 /* From valops.c */
1009
1010 extern int watchdog;
1011
1012 /* Hooks for alternate command interfaces.  */
1013
1014 /* The name of the interpreter if specified on the command line.  */
1015 extern char *interpreter_p;
1016
1017 /* If a given interpreter matches INTERPRETER_P then it should update
1018    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1019    per-interpreter implementation.  */
1020 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1021    should be moved here.  */
1022
1023 struct target_waitstatus;
1024 struct cmd_list_element;
1025
1026 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1027 extern void (*deprecated_post_add_symbol_hook) (void);
1028 extern void (*selected_frame_level_changed_hook) (int);
1029 extern int (*deprecated_ui_loop_hook) (int signo);
1030 extern void (*deprecated_init_ui_hook) (char *argv0);
1031 extern void (*deprecated_command_loop_hook) (void);
1032 extern void (*deprecated_show_load_progress) (const char *section,
1033                                               unsigned long section_sent,
1034                                               unsigned long section_size,
1035                                               unsigned long total_sent,
1036                                               unsigned long total_size);
1037 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1038                                                          int line,
1039                                                          int stopline,
1040                                                          int noerror);
1041 extern int (*deprecated_query_hook) (const char *, va_list)
1042      ATTRIBUTE_FPTR_PRINTF(1,0);
1043 extern void (*deprecated_warning_hook) (const char *, va_list)
1044      ATTRIBUTE_FPTR_PRINTF(1,0);
1045 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1046 extern void (*deprecated_interactive_hook) (void);
1047 extern void (*deprecated_readline_begin_hook) (char *, ...)
1048      ATTRIBUTE_FPTR_PRINTF_1;
1049 extern char *(*deprecated_readline_hook) (char *);
1050 extern void (*deprecated_readline_end_hook) (void);
1051 extern void (*deprecated_register_changed_hook) (int regno);
1052 extern void (*deprecated_context_hook) (int);
1053 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1054                                               struct target_waitstatus *status,
1055                                               int options);
1056
1057 extern void (*deprecated_attach_hook) (void);
1058 extern void (*deprecated_detach_hook) (void);
1059 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1060                                              char *cmd, int from_tty);
1061
1062 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1063
1064 extern void (*deprecated_error_begin_hook) (void);
1065
1066 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1067                                                 unsigned long num);
1068
1069
1070 /* Inhibit window interface if non-zero.  */
1071
1072 extern int use_windows;
1073
1074 /* Definitions of filename-related things.  */
1075
1076 /* Host specific things.  */
1077
1078 #ifdef __MSDOS__
1079 # define CANT_FORK
1080 # define GLOBAL_CURDIR
1081 # define DIRNAME_SEPARATOR ';'
1082 #endif
1083
1084 #if !defined (__CYGWIN__) && defined (_WIN32)
1085 # define DIRNAME_SEPARATOR ';'
1086 #endif
1087
1088 #ifndef DIRNAME_SEPARATOR
1089 #define DIRNAME_SEPARATOR ':'
1090 #endif
1091
1092 #ifndef SLASH_STRING
1093 #define SLASH_STRING "/"
1094 #endif
1095
1096 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1097    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1098    in the code actually refer to a lightweight process id, i.e,
1099    something that can be considered a process id in its own right for
1100    certain purposes.  */
1101
1102 #ifndef PIDGET
1103 #define PIDGET(PTID) (ptid_get_pid (PTID))
1104 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1105 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1106 #endif
1107
1108 /* Define well known filenos if the system does not define them.  */
1109 #ifndef STDIN_FILENO
1110 #define STDIN_FILENO   0
1111 #endif
1112 #ifndef STDOUT_FILENO
1113 #define STDOUT_FILENO  1
1114 #endif
1115 #ifndef STDERR_FILENO
1116 #define STDERR_FILENO  2
1117 #endif
1118
1119 /* If this definition isn't overridden by the header files, assume
1120    that isatty and fileno exist on this system.  */
1121 #ifndef ISATTY
1122 #define ISATTY(FP)      (isatty (fileno (FP)))
1123 #endif
1124
1125 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1126    power of 2).  Round up/down when necessary.  Examples of correct
1127    use include:
1128
1129    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1130    write_memory (addr, value, len);
1131    addr += len;
1132
1133    and:
1134
1135    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1136    write_memory (sp, value, len);
1137
1138    Note that uses such as:
1139
1140    write_memory (addr, value, len);
1141    addr += align_up (len, 8);
1142
1143    and:
1144
1145    sp -= align_up (len, 8);
1146    write_memory (sp, value, len);
1147
1148    are typically not correct as they don't ensure that the address (SP
1149    or ADDR) is correctly aligned (relying on previous alignment to
1150    keep things right).  This is also why the methods are called
1151    "align_..." instead of "round_..." as the latter reads better with
1152    this incorrect coding style.  */
1153
1154 extern ULONGEST align_up (ULONGEST v, int n);
1155 extern ULONGEST align_down (ULONGEST v, int n);
1156
1157 /* Allocation and deallocation functions for the libiberty hash table
1158    which use obstacks.  */
1159 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
1160 void dummy_obstack_deallocate (void *object, void *data);
1161
1162 /* From progspace.c */
1163
1164 extern void initialize_progspace (void);
1165 extern void initialize_inferiors (void);
1166
1167 /* Special block numbers */
1168
1169 enum block_enum
1170 {
1171   GLOBAL_BLOCK = 0,
1172   STATIC_BLOCK = 1,
1173   FIRST_LOCAL_BLOCK = 2
1174 };
1175
1176 #endif /* #ifndef DEFS_H */