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 request_quit (int);
 362
 363 extern void do_cleanups (struct cleanup *);
 364 extern void do_final_cleanups (struct cleanup *);
 365 extern void do_run_cleanups (struct cleanup *);
 366 extern void do_exec_cleanups (struct cleanup *);
 367 extern void do_exec_error_cleanups (struct cleanup *);
 368
 369 extern void discard_cleanups (struct cleanup *);
 370 extern void discard_final_cleanups (struct cleanup *);
 371 extern void discard_exec_error_cleanups (struct cleanup *);
 372 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
 373
 374 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
 375    make_cleanup function declarations below. Do not use this typedef
 376    as a cast when passing functions into the make_cleanup() code.
 377    Instead either use a bounce function or add a wrapper function.
 378    Calling a f(char*) function with f(void*) is non-portable. */
 379 typedef void (make_cleanup_ftype) (void *);
 380
 381 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
 382
 383 extern struct cleanup *make_cleanup_freeargv (char **);
 384
 385 struct ui_file;
 386 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
 387
 388 extern struct cleanup *make_cleanup_close (int fd);
 389
 390 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
 391
 392 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
 393
 394 extern struct cleanup *make_my_cleanup (struct cleanup **,
 395                                         make_cleanup_ftype *, void *);
 396
 397 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
 398
 399 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
 400 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
 401
 402 extern struct cleanup *save_cleanups (void);
 403 extern struct cleanup *save_final_cleanups (void);
 404 extern struct cleanup *save_my_cleanups (struct cleanup **);
 405
 406 extern void restore_cleanups (struct cleanup *);
 407 extern void restore_final_cleanups (struct cleanup *);
 408 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 409
 410 extern void free_current_contents (void *);
 411
 412 extern void null_cleanup (void *);
 413
 414 extern int myread (int, char *, int);
 415
 416 extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 417 extern int nquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 418 extern int yquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 419
 420 extern void init_page_info (void);
 421
 422 extern char *gdb_realpath (const char *);
 423 extern char *xfullpath (const char *);
 424
 425 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
 426                                           unsigned char *buf, size_t len);
 427
 428 /* From demangle.c */
 429
 430 extern void set_demangling_style (char *);
 431
 432 /* From tm.h */
 433
 434 struct type;
 435 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
 436 extern use_struct_convention_fn generic_use_struct_convention;
 437
 438 \f
 439 /* Annotation stuff.  */
 440
 441 extern int annotation_level;    /* in stack.c */
 442 \f
 443 extern void begin_line (void);
 444
 445 extern void wrap_here (char *);
 446
 447 extern void reinitialize_more_filter (void);
 448
 449 /* Normal results */
 450 extern struct ui_file *gdb_stdout;
 451 /* Input stream */
 452 extern struct ui_file *gdb_stdin;
 453 /* Serious error notifications */
 454 extern struct ui_file *gdb_stderr;
 455 /* Log/debug/trace messages that should bypass normal stdout/stderr
 456    filtering.  For moment, always call this stream using
 457    *_unfiltered. In the very near future that restriction shall be
 458    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 459 extern struct ui_file *gdb_stdlog;
 460 /* Target output that should bypass normal stdout/stderr filtering.
 461    For moment, always call this stream using *_unfiltered. In the
 462    very near future that restriction shall be removed - either call
 463    shall be unfiltered. (cagney 1999-07-02). */
 464 extern struct ui_file *gdb_stdtarg;
 465 extern struct ui_file *gdb_stdtargerr;
 466 extern struct ui_file *gdb_stdtargin;
 467
 468 #include "ui-file.h"
 469
 470 /* More generic printf like operations.  Filtered versions may return
 471    non-locally on error.  */
 472
 473 extern void fputs_filtered (const char *, struct ui_file *);
 474
 475 extern void fputs_unfiltered (const char *, struct ui_file *);
 476
 477 extern int fputc_filtered (int c, struct ui_file *);
 478
 479 extern int fputc_unfiltered (int c, struct ui_file *);
 480
 481 extern int putchar_filtered (int c);
 482
 483 extern int putchar_unfiltered (int c);
 484
 485 extern void puts_filtered (const char *);
 486
 487 extern void puts_unfiltered (const char *);
 488
 489 extern void puts_filtered_tabular (char *string, int width, int right);
 490
 491 extern void puts_debug (char *prefix, char *string, char *suffix);
 492
 493 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 494
 495 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 496
 497 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 498
 499 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 500
 501 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 502
 503 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 504
 505 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 506
 507 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 508
 509 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 510
 511 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 512
 513 extern void print_spaces (int, struct ui_file *);
 514
 515 extern void print_spaces_filtered (int, struct ui_file *);
 516
 517 extern char *n_spaces (int);
 518
 519 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 520
 521 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 522
 523 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 524
 525 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 526 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 527
 528 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 529    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
 530    for ``%*''. */
 531 extern int strlen_paddr (void);
 532 extern char *paddr (CORE_ADDR addr);
 533 extern char *paddr_nz (CORE_ADDR addr);
 534 extern char *paddr_u (CORE_ADDR addr);
 535 extern char *paddr_d (LONGEST addr);
 536
 537 extern char *phex (ULONGEST l, int sizeof_l);
 538 extern char *phex_nz (ULONGEST l, int sizeof_l);
 539
 540 /* Like paddr() only print/scan raw CORE_ADDR.  The output from
 541    core_addr_to_string() can be passed direct to
 542    string_to_core_addr().  */
 543 extern const char *core_addr_to_string (const CORE_ADDR addr);
 544 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 545 extern CORE_ADDR string_to_core_addr (const char *my_string);
 546
 547 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 548                                      enum language, int);
 549
 550 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
 551
 552 extern void print_sys_errmsg (const char *, int);
 553
 554 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 555    "const char *" in unistd.h, so we can't declare the argument
 556    as "char *".  */
 557
 558 extern char *re_comp (const char *);
 559
 560 /* From symfile.c */
 561
 562 extern void symbol_file_command (char *, int);
 563
 564 /* Remote targets may wish to use this as their load function.  */
 565 extern void generic_load (char *name, int from_tty);
 566
 567 /* Summarise a download */
 568 extern void print_transfer_performance (struct ui_file *stream,
 569                                         unsigned long data_count,
 570                                         unsigned long write_count,
 571                                         unsigned long time_count);
 572
 573 /* From top.c */
 574
 575 typedef void initialize_file_ftype (void);
 576
 577 extern char *skip_quoted (char *);
 578
 579 extern char *gdb_readline (char *);
 580
 581 extern char *gdb_readline_wrapper (char *);
 582
 583 extern char *command_line_input (char *, int, char *);
 584
 585 extern void print_prompt (void);
 586
 587 extern int input_from_terminal_p (void);
 588
 589 extern int info_verbose;
 590
 591 /* From printcmd.c */
 592
 593 extern void set_next_address (CORE_ADDR);
 594
 595 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
 596                                     char *);
 597
 598 extern int build_address_symbolic (CORE_ADDR addr,
 599                                    int do_demangle,
 600                                    char **name,
 601                                    int *offset,
 602                                    char **filename,
 603                                    int *line,
 604                                    int *unmapped);
 605
 606 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
 607
 608 extern void print_address (CORE_ADDR, struct ui_file *);
 609
 610 /* From source.c */
 611
 612 #define OPF_TRY_CWD_FIRST     0x01
 613 #define OPF_SEARCH_IN_PATH    0x02
 614
 615 extern int openp (const char *, int, const char *, int, int, char **);
 616
 617 extern int source_full_path_of (char *, char **);
 618
 619 extern void mod_path (char *, char **);
 620
 621 extern void add_path (char *, char **, int);
 622
 623 extern void directory_command (char *, int);
 624
 625 extern char *source_path;
 626
 627 extern void init_source_path (void);
 628
 629 extern void init_last_source_visited (void);
 630
 631 /* From exec.c */
 632
 633 extern void exec_set_section_offsets (bfd_signed_vma text_off,
 634                                       bfd_signed_vma data_off,
 635                                       bfd_signed_vma bss_off);
 636
 637 /* Take over the 'find_mapped_memory' vector from exec.c. */
 638 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
 639                                                             unsigned long,
 640                                                             int, int, int,
 641                                                             void *),
 642                                                    void *));
 643
 644 /* Possible lvalue types.  Like enum language, this should be in
 645    value.h, but needs to be here for the same reason. */
 646
 647 enum lval_type
 648   {
 649     /* Not an lval. */
 650     not_lval,
 651     /* In memory.  Could be a saved register.  */
 652     lval_memory,
 653     /* In a register.  */
 654     lval_register,
 655     /* In a gdb internal variable.  */
 656     lval_internalvar,
 657     /* Part of a gdb internal variable (structure field).  */
 658     lval_internalvar_component,
 659     /* In a register series in a frame not the current one, which may have been
 660        partially saved or saved in different places (otherwise would be
 661        lval_register or lval_memory).  */
 662     lval_reg_frame_relative
 663   };
 664
 665 /* Control types for commands */
 666
 667 enum misc_command_type
 668   {
 669     ok_command,
 670     end_command,
 671     else_command,
 672     nop_command
 673   };
 674
 675 enum command_control_type
 676   {
 677     simple_control,
 678     break_control,
 679     continue_control,
 680     while_control,
 681     if_control,
 682     invalid_control
 683   };
 684
 685 /* Structure for saved commands lines
 686    (for breakpoints, defined commands, etc).  */
 687
 688 struct command_line
 689   {
 690     struct command_line *next;
 691     char *line;
 692     enum command_control_type control_type;
 693     int body_count;
 694     struct command_line **body_list;
 695   };
 696
 697 extern struct command_line *read_command_lines (char *, int);
 698
 699 extern void free_command_lines (struct command_line **);
 700
 701 /* To continue the execution commands when running gdb asynchronously.
 702    A continuation structure contains a pointer to a function to be called
 703    to finish the command, once the target has stopped. Such mechanism is
 704    used bt the finish and until commands, and in the remote protocol
 705    when opening an extended-remote connection. */
 706
 707 struct continuation_arg
 708   {
 709     struct continuation_arg *next;
 710     union continuation_data {
 711       void *pointer;
 712       int   integer;
 713       long  longint;
 714     } data;
 715   };
 716
 717 struct continuation
 718   {
 719     void (*continuation_hook) (struct continuation_arg *);
 720     struct continuation_arg *arg_list;
 721     struct continuation *next;
 722   };
 723
 724 /* In infrun.c. */
 725 extern struct continuation *cmd_continuation;
 726 /* Used only by the step_1 function. */
 727 extern struct continuation *intermediate_continuation;
 728
 729 /* From utils.c */
 730 extern void add_continuation (void (*)(struct continuation_arg *),
 731                               struct continuation_arg *);
 732 extern void do_all_continuations (void);
 733 extern void discard_all_continuations (void);
 734
 735 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
 736                               struct continuation_arg *);
 737 extern void do_all_intermediate_continuations (void);
 738 extern void discard_all_intermediate_continuations (void);
 739
 740 /* String containing the current directory (what getwd would return).  */
 741
 742 extern char *current_directory;
 743
 744 /* Default radixes for input and output.  Only some values supported.  */
 745 extern unsigned input_radix;
 746 extern unsigned output_radix;
 747
 748 /* Possibilities for prettyprint parameters to routines which print
 749    things.  Like enum language, this should be in value.h, but needs
 750    to be here for the same reason.  FIXME:  If we can eliminate this
 751    as an arg to LA_VAL_PRINT, then we can probably move it back to
 752    value.h. */
 753
 754 enum val_prettyprint
 755   {
 756     Val_no_prettyprint = 0,
 757     Val_prettyprint,
 758     /* Use the default setting which the user has specified.  */
 759     Val_pretty_default
 760   };
 761
 762 /* The ptid struct is a collection of the various "ids" necessary
 763    for identifying the inferior.  This consists of the process id
 764    (pid), thread id (tid), and other fields necessary for uniquely
 765    identifying the inferior process/thread being debugged.  When
 766    manipulating ptids, the constructors, accessors, and predicate
 767    declared in inferior.h should be used.  These are as follows:
 768
 769       ptid_build        - Make a new ptid from a pid, lwp, and tid.
 770       pid_to_ptid       - Make a new ptid from just a pid.
 771       ptid_get_pid      - Fetch the pid component of a ptid.
 772       ptid_get_lwp      - Fetch the lwp component of a ptid.
 773       ptid_get_tid      - Fetch the tid component of a ptid.
 774       ptid_equal        - Test to see if two ptids are equal.
 775
 776    Please do NOT access the struct ptid members directly (except, of
 777    course, in the implementation of the above ptid manipulation
 778    functions).  */
 779
 780 struct ptid
 781   {
 782     /* Process id */
 783     int pid;
 784
 785     /* Lightweight process id */
 786     long lwp;
 787
 788     /* Thread id */
 789     long tid;
 790   };
 791
 792 typedef struct ptid ptid_t;
 793
 794 \f
 795
 796 /* Optional host machine definition.  Pure autoconf targets will not
 797    need a "xm.h" file.  This will be a symlink to one of the xm-*.h
 798    files, built by the `configure' script.  */
 799
 800 #ifdef GDB_XM_FILE
 801 #include "xm.h"
 802 #endif
 803
 804 /* Optional native machine support.  Non-native (and possibly pure
 805    multi-arch) targets do not need a "nm.h" file.  This will be a
 806    symlink to one of the nm-*.h files, built by the `configure'
 807    script.  */
 808
 809 #ifdef GDB_NM_FILE
 810 #include "nm.h"
 811 #endif
 812
 813 /* Optional target machine definition.  Pure multi-arch configurations
 814    do not need a "tm.h" file.  This will be a symlink to one of the
 815    tm-*.h files, built by the `configure' script.  */
 816
 817 #ifdef GDB_TM_FILE
 818 #include "tm.h"
 819 #endif
 820
 821 /* If the xm.h file did not define the mode string used to open the
 822    files, assume that binary files are opened the same way as text
 823    files */
 824 #ifndef FOPEN_RB
 825 #include "fopen-same.h"
 826 #endif
 827
 828 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 829    FIXME: Assumes 2's complement arithmetic */
 830
 831 #if !defined (UINT_MAX)
 832 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 833 #endif
 834
 835 #if !defined (INT_MAX)
 836 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 837 #endif
 838
 839 #if !defined (INT_MIN)
 840 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 841 #endif
 842
 843 #if !defined (ULONG_MAX)
 844 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 845 #endif
 846
 847 #if !defined (LONG_MAX)
 848 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 849 #endif
 850
 851 #if !defined (ULONGEST_MAX)
 852 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 853 #endif
 854
 855 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 856 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 857 #endif
 858
 859 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 860    arguments to a function, number in a value history, register number, etc.)
 861    where the value must not be larger than can fit in an int.  */
 862
 863 extern int longest_to_int (LONGEST);
 864
 865 /* Assorted functions we can declare, now that const and volatile are
 866    defined.  */
 867
 868 extern char *savestring (const char *, size_t);
 869
 870 extern char *msavestring (void *, const char *, size_t);
 871
 872 extern char *mstrsave (void *, const char *);
 873
 874 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
 875    "libiberty.h". */
 876 extern void xfree (void *);
 877
 878 /* Utility macros to allocate typed memory.  Avoids errors like:
 879    struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
 880    sizeof (struct foo), 0).  */
 881 #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE)))
 882 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 883 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 884
 885 /* Like asprintf/vasprintf but get an internal_error if the call
 886    fails. */
 887 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
 888 extern void xvasprintf (char **ret, const char *format, va_list ap);
 889
 890 /* Like asprintf and vasprintf, but return the string, throw an error
 891    if no memory.  */
 892 extern char *xstrprintf (const char *format, ...) ATTR_FORMAT (printf, 1, 2);
 893 extern char *xstrvprintf (const char *format, va_list ap);
 894
 895 extern int parse_escape (char **);
 896
 897 /* Message to be printed before the error message, when an error occurs.  */
 898
 899 extern char *error_pre_print;
 900
 901 /* Message to be printed before the error message, when an error occurs.  */
 902
 903 extern char *quit_pre_print;
 904
 905 /* Message to be printed before the warning message, when a warning occurs.  */
 906
 907 extern char *warning_pre_print;
 908
 909 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
 910
 911 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 912
 913 extern NORETURN void error_silent (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 914
 915 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
 916
 917 /* Initialize the error buffer.  */
 918 extern void error_init (void);
 919
 920 /* Returns a freshly allocate buffer containing the last error
 921    message.  */
 922 extern char *error_last_message (void);
 923
 924 /* Output arbitrary error message.  */
 925 extern void error_output_message (char *pre_print, char *msg);
 926
 927 extern NORETURN void internal_verror (const char *file, int line,
 928                                       const char *, va_list ap) ATTR_NORETURN;
 929
 930 extern NORETURN void internal_error (const char *file, int line,
 931                                      const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
 932
 933 extern void internal_vwarning (const char *file, int line,
 934                                const char *, va_list ap);
 935
 936 extern void internal_warning (const char *file, int line,
 937                               const char *, ...) ATTR_FORMAT (printf, 3, 4);
 938
 939 extern NORETURN void nomem (long) ATTR_NORETURN;
 940
 941 /* Reasons for calling throw_exception().  NOTE: all reason values
 942    must be less than zero.  enum value 0 is reserved for internal use
 943    as the return value from an initial setjmp().  The function
 944    catch_exceptions() reserves values >= 0 as legal results from its
 945    wrapped function.  */
 946
 947 enum return_reason
 948   {
 949     /* User interrupt.  */
 950     RETURN_QUIT = -2,
 951     /* Any other error.  */
 952     RETURN_ERROR
 953   };
 954
 955 #define ALL_CLEANUPS    ((struct cleanup *)0)
 956
 957 #define RETURN_MASK(reason)     (1 << (int)(-reason))
 958 #define RETURN_MASK_QUIT        RETURN_MASK (RETURN_QUIT)
 959 #define RETURN_MASK_ERROR       RETURN_MASK (RETURN_ERROR)
 960 #define RETURN_MASK_ALL         (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
 961 typedef int return_mask;
 962
 963 /* Throw an exception of type RETURN_REASON.  Will execute a LONG JUMP
 964    to the inner most containing exception handler established using
 965    catch_exceptions() (or the legacy catch_errors()).
 966
 967    Code normally throws an exception using error() et.al.  For various
 968    reaons, GDB also contains code that throws an exception directly.
 969    For instance, the remote*.c targets contain CNTRL-C signal handlers
 970    that propogate the QUIT event up the exception chain.  ``This could
 971    be a good thing or a dangerous thing.'' -- the Existential Wombat.  */
 972
 973 extern NORETURN void throw_exception (enum return_reason) ATTR_NORETURN;
 974
 975 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
 976    handler.  If an exception (enum return_reason) is thrown using
 977    throw_exception() than all cleanups installed since
 978    catch_exceptions() was entered are invoked, the (-ve) exception
 979    value is then returned by catch_exceptions.  If FUNC() returns
 980    normally (with a postive or zero return value) then that value is
 981    returned by catch_exceptions().  It is an internal_error() for
 982    FUNC() to return a negative value.
 983
 984    For the period of the FUNC() call: UIOUT is installed as the output
 985    builder; ERRSTRING is installed as the error/quit message; and a
 986    new cleanup_chain is established.  The old values are restored
 987    before catch_exceptions() returns.
 988
 989    The variant catch_exceptions_with_msg() is the same as
 990    catch_exceptions() but adds the ability to return an allocated
 991    copy of the gdb error message.  This is used when a silent error is
 992    issued and the caller wants to manually issue the error message.
 993
 994    FIXME; cagney/2001-08-13: The need to override the global UIOUT
 995    builder variable should just go away.
 996
 997    This function superseeds catch_errors().
 998
 999    This function uses SETJMP() and LONGJUMP().  */
1000
1001 struct ui_out;
1002 typedef int (catch_exceptions_ftype) (struct ui_out *ui_out, void *args);
1003 extern int catch_exceptions (struct ui_out *uiout,
1004                              catch_exceptions_ftype *func, void *func_args,
1005                              char *errstring, return_mask mask);
1006 extern int catch_exceptions_with_msg (struct ui_out *uiout,
1007                                       catch_exceptions_ftype *func,
1008                                       void *func_args,
1009                                       char *errstring, char **gdberrmsg,
1010                                       return_mask mask);
1011
1012 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
1013    otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
1014    probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
1015    value. It's unfortunate that, catch_errors() does not return an
1016    indication of the exact exception that it caught - quit_flag might
1017    help.
1018
1019    This function is superseeded by catch_exceptions().  */
1020
1021 typedef int (catch_errors_ftype) (void *);
1022 extern int catch_errors (catch_errors_ftype *, void *, char *, return_mask);
1023
1024 /* Template to catch_errors() that wraps calls to command
1025    functions. */
1026
1027 typedef void (catch_command_errors_ftype) (char *, int);
1028 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
1029
1030 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
1031
1032 extern void vwarning (const char *, va_list args);
1033
1034 /* List of known OS ABIs.  If you change this, make sure to update the
1035    table in osabi.c.  */
1036 enum gdb_osabi
1037 {
1038   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
1039
1040   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
1041
1042   GDB_OSABI_SVR4,
1043   GDB_OSABI_HURD,
1044   GDB_OSABI_SOLARIS,
1045   GDB_OSABI_OSF1,
1046   GDB_OSABI_LINUX,
1047   GDB_OSABI_FREEBSD_AOUT,
1048   GDB_OSABI_FREEBSD_ELF,
1049   GDB_OSABI_NETBSD_AOUT,
1050   GDB_OSABI_NETBSD_ELF,
1051   GDB_OSABI_OPENBSD_ELF,
1052   GDB_OSABI_WINCE,
1053   GDB_OSABI_GO32,
1054   GDB_OSABI_NETWARE,
1055   GDB_OSABI_IRIX,
1056   GDB_OSABI_LYNXOS,
1057   GDB_OSABI_INTERIX,
1058   GDB_OSABI_HPUX_ELF,
1059   GDB_OSABI_HPUX_SOM,
1060
1061   GDB_OSABI_ARM_EABI_V1,
1062   GDB_OSABI_ARM_EABI_V2,
1063   GDB_OSABI_ARM_APCS,
1064   GDB_OSABI_QNXNTO,
1065
1066   GDB_OSABI_CYGWIN,
1067
1068   GDB_OSABI_INVALID             /* keep this last */
1069 };
1070
1071 /* Global functions from other, non-gdb GNU thingies.
1072    Libiberty thingies are no longer declared here.  We include libiberty.h
1073    above, instead.  */
1074
1075 /* From other system libraries */
1076
1077 #ifdef HAVE_STDDEF_H
1078 #include <stddef.h>
1079 #endif
1080
1081 #ifdef HAVE_STDLIB_H
1082 #include <stdlib.h>
1083 #endif
1084 #ifndef min
1085 #define min(a, b) ((a) < (b) ? (a) : (b))
1086 #endif
1087 #ifndef max
1088 #define max(a, b) ((a) > (b) ? (a) : (b))
1089 #endif
1090
1091
1092 #ifndef atof
1093 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
1094 #endif
1095
1096 /* Various possibilities for alloca.  */
1097 #ifndef alloca
1098 #ifdef __GNUC__
1099 #define alloca __builtin_alloca
1100 #else /* Not GNU C */
1101 #ifdef HAVE_ALLOCA_H
1102 #include <alloca.h>
1103 #else
1104 #ifdef _AIX
1105 #pragma alloca
1106 #else
1107
1108 /* We need to be careful not to declare this in a way which conflicts with
1109    bison.  Bison never declares it as char *, but under various circumstances
1110    (like __hpux) we need to use void *.  */
1111 extern void *alloca ();
1112 #endif /* Not _AIX */
1113 #endif /* Not HAVE_ALLOCA_H */
1114 #endif /* Not GNU C */
1115 #endif /* alloca not defined */
1116
1117 /* Is GDB multi-arch?  If there's a "tm.h" file, it is not.  */
1118 #ifndef GDB_MULTI_ARCH
1119 #ifdef GDB_TM_FILE
1120 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PARTIAL
1121 #else
1122 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PURE
1123 #endif
1124 #endif
1125
1126 /* Dynamic target-system-dependent parameters for GDB. */
1127 #include "gdbarch.h"
1128
1129 /* Maximum size of a register.  Something small, but large enough for
1130    all known ISAs.  If it turns out to be too small, make it bigger.  */
1131
1132 enum { MAX_REGISTER_SIZE = 16 };
1133
1134 /* Static target-system-dependent parameters for GDB. */
1135
1136 /* Number of bits in a char or unsigned char for the target machine.
1137    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
1138 #if !defined (TARGET_CHAR_BIT)
1139 #define TARGET_CHAR_BIT 8
1140 #endif
1141
1142 /* If we picked up a copy of CHAR_BIT from a configuration file
1143    (which may get it by including <limits.h>) then use it to set
1144    the number of bits in a host char.  If not, use the same size
1145    as the target. */
1146
1147 #if defined (CHAR_BIT)
1148 #define HOST_CHAR_BIT CHAR_BIT
1149 #else
1150 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1151 #endif
1152
1153 /* The bit byte-order has to do just with numbering of bits in
1154    debugging symbols and such.  Conceptually, it's quite separate
1155    from byte/word byte order.  */
1156
1157 #if !defined (BITS_BIG_ENDIAN)
1158 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1159 #endif
1160
1161 /* In findvar.c.  */
1162
1163 extern LONGEST extract_signed_integer (const void *, int);
1164
1165 extern ULONGEST extract_unsigned_integer (const void *, int);
1166
1167 extern int extract_long_unsigned_integer (const void *, int, LONGEST *);
1168
1169 extern CORE_ADDR extract_typed_address (const void *buf, struct type *type);
1170
1171 extern void store_signed_integer (void *, int, LONGEST);
1172
1173 extern void store_unsigned_integer (void *, int, ULONGEST);
1174
1175 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1176
1177 \f
1178 /* From valops.c */
1179
1180 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1181
1182 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1183
1184 extern int watchdog;
1185
1186 /* Hooks for alternate command interfaces.  */
1187
1188 /* The name of the interpreter if specified on the command line. */
1189 extern char *interpreter_p;
1190
1191 /* If a given interpreter matches INTERPRETER_P then it should update
1192    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1193    per-interpreter implementation.  */
1194 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1195    should be moved here. */
1196
1197 struct target_waitstatus;
1198 struct cmd_list_element;
1199
1200 /* Should the asynchronous variant of the interpreter (using the
1201    event-loop) be enabled?  */
1202 /* NOTE: cagney/2004-06-10: GDB changed to always uses the event-loop.
1203    A follow-on cleanup is to eliminate references to
1204    "event_loop_p".  */
1205 #define event_loop_p 1
1206
1207 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1208 extern void (*deprecated_post_add_symbol_hook) (void);
1209 extern void (*selected_frame_level_changed_hook) (int);
1210 extern int (*deprecated_ui_loop_hook) (int signo);
1211 extern void (*deprecated_init_ui_hook) (char *argv0);
1212 extern void (*deprecated_command_loop_hook) (void);
1213 extern void (*deprecated_show_load_progress) (const char *section,
1214                                               unsigned long section_sent,
1215                                               unsigned long section_size,
1216                                               unsigned long total_sent,
1217                                               unsigned long total_size);
1218 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1219                                                          int line, int stopline,
1220                                                          int noerror);
1221 extern struct frame_info *parse_frame_specification (char *frame_exp);
1222 extern int (*deprecated_query_hook) (const char *, va_list);
1223 extern void (*deprecated_warning_hook) (const char *, va_list);
1224 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1225 extern void (*deprecated_create_breakpoint_hook) (struct breakpoint * b);
1226 extern void (*deprecated_delete_breakpoint_hook) (struct breakpoint * bpt);
1227 extern void (*deprecated_modify_breakpoint_hook) (struct breakpoint * bpt);
1228 extern void (*deprecated_interactive_hook) (void);
1229 extern void (*deprecated_registers_changed_hook) (void);
1230 extern void (*deprecated_readline_begin_hook) (char *,...);
1231 extern char *(*deprecated_readline_hook) (char *);
1232 extern void (*deprecated_readline_end_hook) (void);
1233 extern void (*deprecated_register_changed_hook) (int regno);
1234 extern void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
1235 extern void (*deprecated_context_hook) (int);
1236 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1237                                          struct target_waitstatus * status);
1238
1239 extern void (*deprecated_attach_hook) (void);
1240 extern void (*deprecated_detach_hook) (void);
1241 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1242                                              char *cmd, int from_tty);
1243
1244 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1245
1246 extern void (*deprecated_error_hook) (void);
1247
1248 extern void (*deprecated_error_begin_hook) (void);
1249
1250 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1251                                                 unsigned long num);
1252
1253
1254 /* Inhibit window interface if non-zero. */
1255
1256 extern int use_windows;
1257
1258 /* Symbolic definitions of filename-related things.  */
1259 /* FIXME, this doesn't work very well if host and executable
1260    filesystems conventions are different.  */
1261
1262 #ifndef DIRNAME_SEPARATOR
1263 #define DIRNAME_SEPARATOR ':'
1264 #endif
1265
1266 #ifndef SLASH_STRING
1267 #define SLASH_STRING "/"
1268 #endif
1269
1270 #ifdef __MSDOS__
1271 # define CANT_FORK
1272 # define GLOBAL_CURDIR
1273 #endif
1274
1275 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1276    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1277    in the code actually refer to a lightweight process id, i.e,
1278    something that can be considered a process id in its own right for
1279    certain purposes.  */
1280
1281 #ifndef PIDGET
1282 #define PIDGET(PTID) (ptid_get_pid (PTID))
1283 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1284 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1285 #endif
1286
1287 /* Define well known filenos if the system does not define them.  */
1288 #ifndef STDIN_FILENO
1289 #define STDIN_FILENO   0
1290 #endif
1291 #ifndef STDOUT_FILENO
1292 #define STDOUT_FILENO  1
1293 #endif
1294 #ifndef STDERR_FILENO
1295 #define STDERR_FILENO  2
1296 #endif
1297
1298 /* If this definition isn't overridden by the header files, assume
1299    that isatty and fileno exist on this system.  */
1300 #ifndef ISATTY
1301 #define ISATTY(FP)      (isatty (fileno (FP)))
1302 #endif
1303
1304 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1305    power of 2).  Round up/down when necessary.  Examples of correct
1306    use include:
1307
1308    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1309    write_memory (addr, value, len);
1310    addr += len;
1311
1312    and:
1313
1314    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1315    write_memory (sp, value, len);
1316
1317    Note that uses such as:
1318
1319    write_memory (addr, value, len);
1320    addr += align_up (len, 8);
1321
1322    and:
1323
1324    sp -= align_up (len, 8);
1325    write_memory (sp, value, len);
1326
1327    are typically not correct as they don't ensure that the address (SP
1328    or ADDR) is correctly aligned (relying on previous alignment to
1329    keep things right).  This is also why the methods are called
1330    "align_..." instead of "round_..." as the latter reads better with
1331    this incorrect coding style.  */
1332
1333 extern ULONGEST align_up (ULONGEST v, int n);
1334 extern ULONGEST align_down (ULONGEST v, int n);
1335
1336 #endif /* #ifndef DEFS_H */