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