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