gdb/defs.h

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