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