gdb/defs.h

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