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