gdb/defs.h

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