gdb/defs.h

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