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