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