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