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