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