gdb/defs.h

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