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