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 /* 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_fclose (FILE *file);
 366
 367 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
 368
 369 struct obstack;
 370 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
 371
 372 extern struct cleanup *make_cleanup_restore_integer (int *variable);
 373
 374 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
 375
 376 extern struct cleanup *make_my_cleanup (struct cleanup **,
 377                                         make_cleanup_ftype *, void *);
 378
 379 extern struct cleanup *make_my_cleanup2 (struct cleanup **,
 380                                          make_cleanup_ftype *, void *,
 381                                          void (*free_arg) (void *));
 382
 383 extern struct cleanup *save_cleanups (void);
 384 extern struct cleanup *save_final_cleanups (void);
 385 extern struct cleanup *save_my_cleanups (struct cleanup **);
 386
 387 extern void restore_cleanups (struct cleanup *);
 388 extern void restore_final_cleanups (struct cleanup *);
 389 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 390
 391 extern void free_current_contents (void *);
 392
 393 extern void null_cleanup (void *);
 394
 395 extern int myread (int, char *, int);
 396
 397 extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 398 extern int nquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 399 extern int yquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 400
 401 extern void init_page_info (void);
 402
 403 extern char *gdb_realpath (const char *);
 404 extern char *xfullpath (const char *);
 405
 406 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
 407                                           unsigned char *buf, size_t len);
 408
 409 ULONGEST strtoulst (const char *num, const char **trailer, int base);
 410
 411 char *ldirname (const char *filename);
 412
 413 char **gdb_buildargv (const char *);
 414
 415 /* From demangle.c */
 416
 417 extern void set_demangling_style (char *);
 418
 419 \f
 420 /* Annotation stuff.  */
 421
 422 extern int annotation_level;    /* in stack.c */
 423 \f
 424 extern void begin_line (void);
 425
 426 extern void wrap_here (char *);
 427
 428 extern void reinitialize_more_filter (void);
 429
 430 /* Normal results */
 431 extern struct ui_file *gdb_stdout;
 432 /* Input stream */
 433 extern struct ui_file *gdb_stdin;
 434 /* Serious error notifications */
 435 extern struct ui_file *gdb_stderr;
 436 /* Log/debug/trace messages that should bypass normal stdout/stderr
 437    filtering.  For moment, always call this stream using
 438    *_unfiltered. In the very near future that restriction shall be
 439    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 440 extern struct ui_file *gdb_stdlog;
 441 /* Target output that should bypass normal stdout/stderr filtering.
 442    For moment, always call this stream using *_unfiltered. In the
 443    very near future that restriction shall be removed - either call
 444    shall be unfiltered. (cagney 1999-07-02). */
 445 extern struct ui_file *gdb_stdtarg;
 446 extern struct ui_file *gdb_stdtargerr;
 447 extern struct ui_file *gdb_stdtargin;
 448
 449 #include "ui-file.h"
 450
 451 /* More generic printf like operations.  Filtered versions may return
 452    non-locally on error.  */
 453
 454 extern void fputs_filtered (const char *, struct ui_file *);
 455
 456 extern void fputs_unfiltered (const char *, struct ui_file *);
 457
 458 extern int fputc_filtered (int c, struct ui_file *);
 459
 460 extern int fputc_unfiltered (int c, struct ui_file *);
 461
 462 extern int putchar_filtered (int c);
 463
 464 extern int putchar_unfiltered (int c);
 465
 466 extern void puts_filtered (const char *);
 467
 468 extern void puts_unfiltered (const char *);
 469
 470 extern void puts_filtered_tabular (char *string, int width, int right);
 471
 472 extern void puts_debug (char *prefix, char *string, char *suffix);
 473
 474 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 475
 476 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 477
 478 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 479
 480 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 481
 482 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 483
 484 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 485
 486 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 487
 488 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 489
 490 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 491
 492 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 493
 494 extern void print_spaces (int, struct ui_file *);
 495
 496 extern void print_spaces_filtered (int, struct ui_file *);
 497
 498 extern char *n_spaces (int);
 499
 500 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 501
 502 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 503
 504 extern void fputstrn_filtered (const char *str, int n, int quotr, struct ui_file * stream);
 505
 506 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 507
 508 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 509 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 510
 511 extern const char *host_address_to_string (const void *addr);
 512
 513 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 514    paddr_nz() is like %lx.  */
 515 extern int strlen_paddr (void);
 516 extern char *paddr (CORE_ADDR addr);
 517 extern char *paddr_nz (CORE_ADDR addr);
 518
 519 /* Like 0x%lx.  */
 520 extern const char *paddress (CORE_ADDR addr);
 521
 522 /* %d for LONGEST */
 523 extern char *plongest (LONGEST l);
 524 /* %u for ULONGEST */
 525 extern char *pulongest (ULONGEST l);
 526
 527 extern char *phex (ULONGEST l, int sizeof_l);
 528 extern char *phex_nz (ULONGEST l, int sizeof_l);
 529 extern char *int_string (LONGEST, int, int, int, int);
 530
 531 /* Like paddr() only print/scan raw CORE_ADDR.  The output from
 532    core_addr_to_string() can be passed direct to
 533    string_to_core_addr().  */
 534 extern const char *core_addr_to_string (const CORE_ADDR addr);
 535 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 536 extern CORE_ADDR string_to_core_addr (const char *my_string);
 537
 538 /* Return a string that contains a number formatted as a hex
 539    string.  */
 540 extern char *hex_string (LONGEST);
 541 extern char *hex_string_custom (LONGEST, int);
 542
 543 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 544                                      enum language, int);
 545
 546 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
 547
 548 extern void print_sys_errmsg (const char *, int);
 549
 550 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 551    "const char *" in unistd.h, so we can't declare the argument
 552    as "char *".  */
 553
 554 extern char *re_comp (const char *);
 555
 556 /* From symfile.c */
 557
 558 extern void symbol_file_command (char *, int);
 559
 560 /* Remote targets may wish to use this as their load function.  */
 561 extern void generic_load (char *name, int from_tty);
 562
 563 /* Report on STREAM the performance of memory transfer operation,
 564    such as 'load'.
 565    DATA_COUNT is the number of bytes transferred.
 566    WRITE_COUNT is the number of separate write operations, or 0,
 567    if that information is not available.
 568    START_TIME is the time at which an operation was started.
 569    END_TIME is the time at which an operation ended.  */
 570 struct timeval;
 571 extern void print_transfer_performance (struct ui_file *stream,
 572                                         unsigned long data_count,
 573                                         unsigned long write_count,
 574                                         const struct timeval *start_time,
 575                                         const struct timeval *end_time);
 576
 577 /* From top.c */
 578
 579 typedef void initialize_file_ftype (void);
 580
 581 extern char *skip_quoted (char *);
 582
 583 extern char *gdb_readline (char *);
 584
 585 extern char *gdb_readline_wrapper (char *);
 586
 587 extern char *command_line_input (char *, int, char *);
 588
 589 extern void print_prompt (void);
 590
 591 extern int input_from_terminal_p (void);
 592
 593 extern int info_verbose;
 594
 595 /* From printcmd.c */
 596
 597 extern void set_next_address (struct gdbarch *, CORE_ADDR);
 598
 599 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
 600                                     char *);
 601
 602 extern int build_address_symbolic (CORE_ADDR addr,
 603                                    int do_demangle,
 604                                    char **name,
 605                                    int *offset,
 606                                    char **filename,
 607                                    int *line,
 608                                    int *unmapped);
 609
 610 extern void print_address (CORE_ADDR, struct ui_file *);
 611
 612 /* From source.c */
 613
 614 #define OPF_TRY_CWD_FIRST     0x01
 615 #define OPF_SEARCH_IN_PATH    0x02
 616
 617 extern int openp (const char *, int, const char *, int, int, char **);
 618
 619 extern int source_full_path_of (const char *, char **);
 620
 621 extern void mod_path (char *, char **);
 622
 623 extern void add_path (char *, char **, int);
 624
 625 extern void directory_command (char *, int);
 626
 627 extern void directory_switch (char *, int);
 628
 629 extern char *source_path;
 630
 631 extern void init_source_path (void);
 632
 633 extern void init_last_source_visited (void);
 634
 635 /* From exec.c */
 636
 637 /* Take over the 'find_mapped_memory' vector from exec.c. */
 638 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
 639                                                             unsigned long,
 640                                                             int, int, int,
 641                                                             void *),
 642                                                    void *));
 643
 644 /* Possible lvalue types.  Like enum language, this should be in
 645    value.h, but needs to be here for the same reason. */
 646
 647 enum lval_type
 648   {
 649     /* Not an lval. */
 650     not_lval,
 651     /* In memory.  */
 652     lval_memory,
 653     /* In a register.  Registers are relative to a frame.  */
 654     lval_register,
 655     /* In a gdb internal variable.  */
 656     lval_internalvar,
 657     /* Part of a gdb internal variable (structure field).  */
 658     lval_internalvar_component,
 659     /* Value's bits are fetched and stored using functions provided by
 660        its creator.  */
 661     lval_computed
 662   };
 663
 664 /* Control types for commands */
 665
 666 enum misc_command_type
 667   {
 668     ok_command,
 669     end_command,
 670     else_command,
 671     nop_command
 672   };
 673
 674 enum command_control_type
 675   {
 676     simple_control,
 677     break_control,
 678     continue_control,
 679     while_control,
 680     if_control,
 681     commands_control,
 682     python_control,
 683     invalid_control
 684   };
 685
 686 /* Structure for saved commands lines
 687    (for breakpoints, defined commands, etc).  */
 688
 689 struct command_line
 690   {
 691     struct command_line *next;
 692     char *line;
 693     enum command_control_type control_type;
 694     int body_count;
 695     struct command_line **body_list;
 696   };
 697
 698 extern struct command_line *read_command_lines (char *, int, int);
 699
 700 extern void free_command_lines (struct command_line **);
 701
 702 /* To continue the execution commands when running gdb asynchronously.
 703    A continuation structure contains a pointer to a function to be called
 704    to finish the command, once the target has stopped. Such mechanism is
 705    used by the finish and until commands, and in the remote protocol
 706    when opening an extended-remote connection. */
 707
 708 struct continuation;
 709 struct thread_info;
 710 struct inferior;
 711
 712 /* From utils.c */
 713
 714 /* Thread specific continuations.  */
 715
 716 extern void add_continuation (struct thread_info *,
 717                               void (*)(void *), void *,
 718                               void (*)(void *));
 719 extern void do_all_continuations (void);
 720 extern void do_all_continuations_thread (struct thread_info *);
 721 extern void discard_all_continuations (void);
 722 extern void discard_all_continuations_thread (struct thread_info *);
 723
 724 extern void add_intermediate_continuation (struct thread_info *,
 725                                            void (*)(void *), void *,
 726                                            void (*)(void *));
 727 extern void do_all_intermediate_continuations (void);
 728 extern void do_all_intermediate_continuations_thread (struct thread_info *);
 729 extern void discard_all_intermediate_continuations (void);
 730 extern void discard_all_intermediate_continuations_thread (struct thread_info *);
 731
 732 /* Inferior specific (any thread) continuations.  */
 733
 734 extern void add_inferior_continuation (void (*) (void *),
 735                                        void *,
 736                                        void (*) (void *));
 737 extern void do_all_inferior_continuations (void);
 738 extern void discard_all_inferior_continuations (struct inferior *inf);
 739
 740 /* String containing the current directory (what getwd would return).  */
 741
 742 extern char *current_directory;
 743
 744 /* Default radixes for input and output.  Only some values supported.  */
 745 extern unsigned input_radix;
 746 extern unsigned output_radix;
 747
 748 /* Possibilities for prettyprint parameters to routines which print
 749    things.  Like enum language, this should be in value.h, but needs
 750    to be here for the same reason.  FIXME:  If we can eliminate this
 751    as an arg to LA_VAL_PRINT, then we can probably move it back to
 752    value.h. */
 753
 754 enum val_prettyprint
 755   {
 756     Val_no_prettyprint = 0,
 757     Val_prettyprint,
 758     /* Use the default setting which the user has specified.  */
 759     Val_pretty_default
 760   };
 761
 762 /* The ptid struct is a collection of the various "ids" necessary
 763    for identifying the inferior.  This consists of the process id
 764    (pid), thread id (tid), and other fields necessary for uniquely
 765    identifying the inferior process/thread being debugged.  When
 766    manipulating ptids, the constructors, accessors, and predicate
 767    declared in inferior.h should be used.  These are as follows:
 768
 769       ptid_build        - Make a new ptid from a pid, lwp, and tid.
 770       pid_to_ptid       - Make a new ptid from just a pid.
 771       ptid_get_pid      - Fetch the pid component of a ptid.
 772       ptid_get_lwp      - Fetch the lwp component of a ptid.
 773       ptid_get_tid      - Fetch the tid component of a ptid.
 774       ptid_equal        - Test to see if two ptids are equal.
 775       ptid_is_pid       - Test to see if this ptid represents a process id.
 776
 777    Please do NOT access the struct ptid members directly (except, of
 778    course, in the implementation of the above ptid manipulation
 779    functions).  */
 780
 781 struct ptid
 782   {
 783     /* Process id */
 784     int pid;
 785
 786     /* Lightweight process id */
 787     long lwp;
 788
 789     /* Thread id */
 790     long tid;
 791   };
 792
 793 typedef struct ptid ptid_t;
 794
 795 \f
 796
 797 /* Optional native machine support.  Non-native (and possibly pure
 798    multi-arch) targets do not need a "nm.h" file.  This will be a
 799    symlink to one of the nm-*.h files, built by the `configure'
 800    script.  */
 801
 802 #ifdef GDB_NM_FILE
 803 #include "nm.h"
 804 #endif
 805
 806 /* Assume that fopen accepts the letter "b" in the mode string.
 807    It is demanded by ISO C9X, and should be supported on all
 808    platforms that claim to have a standard-conforming C library.  On
 809    true POSIX systems it will be ignored and have no effect.  There
 810    may still be systems without a standard-conforming C library where
 811    an ISO C9X compiler (GCC) is available.  Known examples are SunOS
 812    4.x and 4.3BSD.  This assumption means these systems are no longer
 813    supported.  */
 814 #ifndef FOPEN_RB
 815 # include "fopen-bin.h"
 816 #endif
 817
 818 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 819    FIXME: Assumes 2's complement arithmetic */
 820
 821 #if !defined (UINT_MAX)
 822 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 823 #endif
 824
 825 #if !defined (INT_MAX)
 826 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 827 #endif
 828
 829 #if !defined (INT_MIN)
 830 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 831 #endif
 832
 833 #if !defined (ULONG_MAX)
 834 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 835 #endif
 836
 837 #if !defined (LONG_MAX)
 838 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 839 #endif
 840
 841 #if !defined (ULONGEST_MAX)
 842 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 843 #endif
 844
 845 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 846 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 847 #endif
 848
 849 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 850    arguments to a function, number in a value history, register number, etc.)
 851    where the value must not be larger than can fit in an int.  */
 852
 853 extern int longest_to_int (LONGEST);
 854
 855 /* Assorted functions we can declare, now that const and volatile are
 856    defined.  */
 857
 858 extern char *savestring (const char *, size_t);
 859
 860 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
 861    "libiberty.h". */
 862 extern void xfree (void *);
 863
 864 /* Like xmalloc, but zero the memory.  */
 865 extern void *xzalloc (size_t);
 866
 867 /* Utility macros to allocate typed memory.  Avoids errors like:
 868    struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
 869    sizeof (struct foo), 0).  */
 870 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
 871 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 872 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 873
 874 /* Like asprintf/vasprintf but get an internal_error if the call
 875    fails. */
 876 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
 877 extern void xvasprintf (char **ret, const char *format, va_list ap)
 878      ATTR_FORMAT (printf, 2, 0);
 879
 880 /* Like asprintf and vasprintf, but return the string, throw an error
 881    if no memory.  */
 882 extern char *xstrprintf (const char *format, ...) ATTR_FORMAT (printf, 1, 2);
 883 extern char *xstrvprintf (const char *format, va_list ap)
 884      ATTR_FORMAT (printf, 1, 0);
 885
 886 /* Like snprintf, but throw an error if the output buffer is too small.  */
 887 extern int xsnprintf (char *str, size_t size, const char *format, ...)
 888      ATTR_FORMAT (printf, 3, 4);
 889
 890 extern int parse_escape (char **);
 891
 892 /* Message to be printed before the error message, when an error occurs.  */
 893
 894 extern char *error_pre_print;
 895
 896 /* Message to be printed before the error message, when an error occurs.  */
 897
 898 extern char *quit_pre_print;
 899
 900 /* Message to be printed before the warning message, when a warning occurs.  */
 901
 902 extern char *warning_pre_print;
 903
 904 extern NORETURN void verror (const char *fmt, va_list ap)
 905      ATTR_NORETURN ATTR_FORMAT (printf, 1, 0);
 906
 907 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 908
 909 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
 910
 911 extern NORETURN void vfatal (const char *fmt, va_list ap)
 912      ATTR_NORETURN ATTR_FORMAT (printf, 1, 0);
 913
 914 extern NORETURN void fatal (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 915
 916 extern NORETURN void internal_verror (const char *file, int line,
 917                                       const char *, va_list ap)
 918      ATTR_NORETURN ATTR_FORMAT (printf, 3, 0);
 919
 920 extern NORETURN void internal_error (const char *file, int line,
 921                                      const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
 922
 923 extern void internal_vwarning (const char *file, int line,
 924                                const char *, va_list ap)
 925      ATTR_FORMAT (printf, 3, 0);
 926
 927 extern void internal_warning (const char *file, int line,
 928                               const char *, ...) ATTR_FORMAT (printf, 3, 4);
 929
 930 extern NORETURN void nomem (long) ATTR_NORETURN;
 931
 932 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 933
 934 extern void vwarning (const char *, va_list args) ATTR_FORMAT (printf, 1, 0);
 935
 936 /* List of known OS ABIs.  If you change this, make sure to update the
 937    table in osabi.c.  */
 938 enum gdb_osabi
 939 {
 940   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
 941
 942   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
 943
 944   GDB_OSABI_SVR4,
 945   GDB_OSABI_HURD,
 946   GDB_OSABI_SOLARIS,
 947   GDB_OSABI_OSF1,
 948   GDB_OSABI_LINUX,
 949   GDB_OSABI_FREEBSD_AOUT,
 950   GDB_OSABI_FREEBSD_ELF,
 951   GDB_OSABI_NETBSD_AOUT,
 952   GDB_OSABI_NETBSD_ELF,
 953   GDB_OSABI_OPENBSD_ELF,
 954   GDB_OSABI_WINCE,
 955   GDB_OSABI_GO32,
 956   GDB_OSABI_IRIX,
 957   GDB_OSABI_INTERIX,
 958   GDB_OSABI_HPUX_ELF,
 959   GDB_OSABI_HPUX_SOM,
 960
 961   GDB_OSABI_QNXNTO,
 962
 963   GDB_OSABI_CYGWIN,
 964   GDB_OSABI_AIX,
 965   GDB_OSABI_DICOS,
 966   GDB_OSABI_DARWIN,
 967
 968   GDB_OSABI_INVALID             /* keep this last */
 969 };
 970
 971 /* Global functions from other, non-gdb GNU thingies.
 972    Libiberty thingies are no longer declared here.  We include libiberty.h
 973    above, instead.  */
 974
 975 /* From other system libraries */
 976
 977 #ifdef HAVE_STDDEF_H
 978 #include <stddef.h>
 979 #endif
 980
 981 #ifdef HAVE_STDLIB_H
 982 #include <stdlib.h>
 983 #endif
 984 #ifndef min
 985 #define min(a, b) ((a) < (b) ? (a) : (b))
 986 #endif
 987 #ifndef max
 988 #define max(a, b) ((a) > (b) ? (a) : (b))
 989 #endif
 990
 991
 992 #ifndef atof
 993 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
 994 #endif
 995
 996 /* Various possibilities for alloca.  */
 997 #ifndef alloca
 998 #ifdef __GNUC__
 999 #define alloca __builtin_alloca
1000 #else /* Not GNU C */
1001 #ifdef HAVE_ALLOCA_H
1002 #include <alloca.h>
1003 #else
1004 #ifdef _AIX
1005 #pragma alloca
1006 #else
1007
1008 /* We need to be careful not to declare this in a way which conflicts with
1009    bison.  Bison never declares it as char *, but under various circumstances
1010    (like __hpux) we need to use void *.  */
1011 extern void *alloca ();
1012 #endif /* Not _AIX */
1013 #endif /* Not HAVE_ALLOCA_H */
1014 #endif /* Not GNU C */
1015 #endif /* alloca not defined */
1016
1017 /* Dynamic target-system-dependent parameters for GDB. */
1018 #include "gdbarch.h"
1019
1020 /* Maximum size of a register.  Something small, but large enough for
1021    all known ISAs.  If it turns out to be too small, make it bigger.  */
1022
1023 enum { MAX_REGISTER_SIZE = 16 };
1024
1025 /* Static target-system-dependent parameters for GDB. */
1026
1027 /* Number of bits in a char or unsigned char for the target machine.
1028    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
1029 #if !defined (TARGET_CHAR_BIT)
1030 #define TARGET_CHAR_BIT 8
1031 #endif
1032
1033 /* If we picked up a copy of CHAR_BIT from a configuration file
1034    (which may get it by including <limits.h>) then use it to set
1035    the number of bits in a host char.  If not, use the same size
1036    as the target. */
1037
1038 #if defined (CHAR_BIT)
1039 #define HOST_CHAR_BIT CHAR_BIT
1040 #else
1041 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1042 #endif
1043
1044 /* In findvar.c.  */
1045
1046 extern LONGEST extract_signed_integer (const gdb_byte *, int);
1047
1048 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int);
1049
1050 extern int extract_long_unsigned_integer (const gdb_byte *, int, LONGEST *);
1051
1052 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
1053                                         struct type *type);
1054
1055 extern void store_signed_integer (gdb_byte *, int, LONGEST);
1056
1057 extern void store_unsigned_integer (gdb_byte *, int, ULONGEST);
1058
1059 extern void store_typed_address (gdb_byte *buf, struct type *type,
1060                                  CORE_ADDR addr);
1061
1062 \f
1063 /* From valops.c */
1064
1065 extern int watchdog;
1066
1067 /* Hooks for alternate command interfaces.  */
1068
1069 /* The name of the interpreter if specified on the command line. */
1070 extern char *interpreter_p;
1071
1072 /* If a given interpreter matches INTERPRETER_P then it should update
1073    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1074    per-interpreter implementation.  */
1075 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1076    should be moved here. */
1077
1078 struct target_waitstatus;
1079 struct cmd_list_element;
1080
1081 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1082 extern void (*deprecated_post_add_symbol_hook) (void);
1083 extern void (*selected_frame_level_changed_hook) (int);
1084 extern int (*deprecated_ui_loop_hook) (int signo);
1085 extern void (*deprecated_init_ui_hook) (char *argv0);
1086 extern void (*deprecated_command_loop_hook) (void);
1087 extern void (*deprecated_show_load_progress) (const char *section,
1088                                               unsigned long section_sent,
1089                                               unsigned long section_size,
1090                                               unsigned long total_sent,
1091                                               unsigned long total_size);
1092 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1093                                                          int line, int stopline,
1094                                                          int noerror);
1095 extern int (*deprecated_query_hook) (const char *, va_list)
1096      ATTRIBUTE_FPTR_PRINTF(1,0);
1097 extern void (*deprecated_warning_hook) (const char *, va_list)
1098      ATTRIBUTE_FPTR_PRINTF(1,0);
1099 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1100 extern void (*deprecated_interactive_hook) (void);
1101 extern void (*deprecated_readline_begin_hook) (char *, ...)
1102      ATTRIBUTE_FPTR_PRINTF_1;
1103 extern char *(*deprecated_readline_hook) (char *);
1104 extern void (*deprecated_readline_end_hook) (void);
1105 extern void (*deprecated_register_changed_hook) (int regno);
1106 extern void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
1107 extern void (*deprecated_context_hook) (int);
1108 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1109                                          struct target_waitstatus * status);
1110
1111 extern void (*deprecated_attach_hook) (void);
1112 extern void (*deprecated_detach_hook) (void);
1113 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1114                                              char *cmd, int from_tty);
1115
1116 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1117
1118 extern void (*deprecated_error_begin_hook) (void);
1119
1120 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1121                                                 unsigned long num);
1122
1123
1124 /* Inhibit window interface if non-zero. */
1125
1126 extern int use_windows;
1127
1128 /* Symbolic definitions of filename-related things.  */
1129 /* FIXME, this doesn't work very well if host and executable
1130    filesystems conventions are different.  */
1131
1132 #ifdef __MSDOS__
1133 # define CANT_FORK
1134 # define GLOBAL_CURDIR
1135 # define DIRNAME_SEPARATOR ';'
1136 #endif
1137
1138 #if !defined (__CYGWIN__) && defined (_WIN32)
1139 # define DIRNAME_SEPARATOR ';'
1140 #endif
1141
1142 #ifndef DIRNAME_SEPARATOR
1143 #define DIRNAME_SEPARATOR ':'
1144 #endif
1145
1146 #ifndef SLASH_STRING
1147 #define SLASH_STRING "/"
1148 #endif
1149
1150 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1151    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1152    in the code actually refer to a lightweight process id, i.e,
1153    something that can be considered a process id in its own right for
1154    certain purposes.  */
1155
1156 #ifndef PIDGET
1157 #define PIDGET(PTID) (ptid_get_pid (PTID))
1158 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1159 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1160 #endif
1161
1162 /* Define well known filenos if the system does not define them.  */
1163 #ifndef STDIN_FILENO
1164 #define STDIN_FILENO   0
1165 #endif
1166 #ifndef STDOUT_FILENO
1167 #define STDOUT_FILENO  1
1168 #endif
1169 #ifndef STDERR_FILENO
1170 #define STDERR_FILENO  2
1171 #endif
1172
1173 /* If this definition isn't overridden by the header files, assume
1174    that isatty and fileno exist on this system.  */
1175 #ifndef ISATTY
1176 #define ISATTY(FP)      (isatty (fileno (FP)))
1177 #endif
1178
1179 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1180    power of 2).  Round up/down when necessary.  Examples of correct
1181    use include:
1182
1183    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1184    write_memory (addr, value, len);
1185    addr += len;
1186
1187    and:
1188
1189    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1190    write_memory (sp, value, len);
1191
1192    Note that uses such as:
1193
1194    write_memory (addr, value, len);
1195    addr += align_up (len, 8);
1196
1197    and:
1198
1199    sp -= align_up (len, 8);
1200    write_memory (sp, value, len);
1201
1202    are typically not correct as they don't ensure that the address (SP
1203    or ADDR) is correctly aligned (relying on previous alignment to
1204    keep things right).  This is also why the methods are called
1205    "align_..." instead of "round_..." as the latter reads better with
1206    this incorrect coding style.  */
1207
1208 extern ULONGEST align_up (ULONGEST v, int n);
1209 extern ULONGEST align_down (ULONGEST v, int n);
1210
1211 /* Allocation and deallocation functions for the libiberty hash table
1212    which use obstacks.  */
1213 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
1214 void dummy_obstack_deallocate (void *object, void *data);
1215
1216 #endif /* #ifndef DEFS_H */