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