gdb/defs.h

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