gdb/defs.h

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