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