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