gdb/defs.h

   1 /* *INDENT-OFF* */ /* ATTRIBUTE_PRINTF confuses indent, avoid running it
   2                       for now.  */
   3 /* Basic, host-specific, and target-specific definitions for GDB.
   4    Copyright (C) 1986, 1988-2005, 2007-2012 Free Software Foundation,
   5    Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef DEFS_H
  23 #define DEFS_H
  24
  25 #ifdef GDBSERVER
  26 #  error gdbserver should not include gdb/defs.h
  27 #endif
  28
  29 #include "config.h"             /* Generated by configure.  */
  30
  31 #include <sys/types.h>
  32 #include <stdio.h>
  33 #include <errno.h>              /* System call error return status.  */
  34 #include <limits.h>
  35 #include <stdint.h>
  36
  37 /* The libdecnumber library, on which GDB depends, includes a header file
  38    called gstdint.h instead of relying directly on stdint.h.  GDB, on the
  39    other hand, includes stdint.h directly, relying on the fact that gnulib
  40    generates a copy if the system doesn't provide one or if it is missing
  41    some features.  Unfortunately, gstdint.h and stdint.h cannot be included
  42    at the same time, which may happen when we include a file from
  43    libdecnumber.
  44
  45    The following macro definition effectively prevents the inclusion of
  46    gstdint.h, as all the definitions it provides are guarded against
  47    the GCC_GENERATED_STDINT_H macro.  We already have gnulib/stdint.h
  48    included, so it's ok to blank out gstdint.h.  */
  49 #define GCC_GENERATED_STDINT_H 1
  50
  51 #ifdef HAVE_STDDEF_H
  52 #include <stddef.h>
  53 #endif
  54
  55 #ifdef HAVE_UNISTD_H
  56 #include <unistd.h>
  57 #endif
  58
  59 #include <fcntl.h>
  60
  61 /* First include ansidecl.h so we can use the various macro definitions
  62    here and in all subsequent file inclusions.  */
  63
  64 #include "ansidecl.h"
  65
  66 #include "gdb_locale.h"
  67
  68 #include "gdb_wchar.h"
  69
  70 /* For ``enum gdb_signal''.  */
  71 #include "gdb/signals.h"
  72
  73 /* Just in case they're not defined in stdio.h.  */
  74
  75 #ifndef SEEK_SET
  76 #define SEEK_SET 0
  77 #endif
  78 #ifndef SEEK_CUR
  79 #define SEEK_CUR 1
  80 #endif
  81
  82 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
  83    It is used as an access modifier in calls to open(), where it acts
  84    similarly to the "b" character in fopen()'s MODE argument.  On Posix
  85    platforms it should be a no-op, so it is defined as 0 here.  This
  86    ensures that the symbol may be used freely elsewhere in gdb.  */
  87
  88 #ifndef O_BINARY
  89 #define O_BINARY 0
  90 #endif
  91
  92 #include <stdarg.h>             /* For va_list.  */
  93
  94 #include "libiberty.h"
  95 #include "hashtab.h"
  96
  97 /* Rather than duplicate all the logic in BFD for figuring out what
  98    types to use (which can be pretty complicated), symply define them
  99    in terms of the corresponding type from BFD.  */
 100
 101 #include "bfd.h"
 102
 103 /* A byte from the program being debugged.  */
 104 typedef bfd_byte gdb_byte;
 105
 106 /* An address in the program being debugged.  Host byte order.  */
 107 typedef bfd_vma CORE_ADDR;
 108
 109 /* The largest CORE_ADDR value.  */
 110 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
 111
 112 /* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */
 113
 114 #ifndef LONGEST
 115
 116 #ifdef BFD64
 117
 118 #define LONGEST BFD_HOST_64_BIT
 119 #define ULONGEST BFD_HOST_U_64_BIT
 120
 121 #else /* No BFD64 */
 122
 123 #ifdef CC_HAS_LONG_LONG
 124 #define LONGEST long long
 125 #define ULONGEST unsigned long long
 126 #else
 127 #ifdef BFD_HOST_64_BIT
 128 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
 129    (e.g. i386-windows) so try it.  */
 130 #define LONGEST BFD_HOST_64_BIT
 131 #define ULONGEST BFD_HOST_U_64_BIT
 132 #else
 133 #define LONGEST long
 134 #define ULONGEST unsigned long
 135 #endif
 136 #endif
 137
 138 #endif /* No BFD64 */
 139
 140 #endif /* ! LONGEST */
 141
 142 #ifndef min
 143 #define min(a, b) ((a) < (b) ? (a) : (b))
 144 #endif
 145 #ifndef max
 146 #define max(a, b) ((a) > (b) ? (a) : (b))
 147 #endif
 148
 149 #include "ptid.h"
 150
 151 /* Enable xdb commands if set.  */
 152 extern int xdb_commands;
 153
 154 /* Enable dbx commands if set.  */
 155 extern int dbx_commands;
 156
 157 /* System root path, used to find libraries etc.  */
 158 extern char *gdb_sysroot;
 159
 160 /* GDB datadir, used to store data files.  */
 161 extern char *gdb_datadir;
 162
 163 /* If non-NULL, the possibly relocated path to python's "lib" directory
 164    specified with --with-python.  */
 165 extern char *python_libdir;
 166
 167 /* Search path for separate debug files.  */
 168 extern char *debug_file_directory;
 169
 170 extern int quit_flag;
 171 extern int immediate_quit;
 172 extern int sevenbit_strings;
 173
 174 extern void quit (void);
 175
 176 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
 177    benefits of having a ``QUIT'' macro rather than a function are
 178    marginal.  If the overhead of a QUIT function call is proving
 179    significant then its calling frequency should probably be reduced
 180    [kingdon].  A profile analyzing the current situtation is
 181    needed.  */
 182
 183 #define QUIT { \
 184   if (quit_flag) quit (); \
 185   if (deprecated_interactive_hook) deprecated_interactive_hook (); \
 186 }
 187
 188 /* Languages represented in the symbol table and elsewhere.
 189    This should probably be in language.h, but since enum's can't
 190    be forward declared to satisfy opaque references before their
 191    actual definition, needs to be here.  */
 192
 193 enum language
 194   {
 195     language_unknown,           /* Language not known */
 196     language_auto,              /* Placeholder for automatic setting */
 197     language_c,                 /* C */
 198     language_cplus,             /* C++ */
 199     language_d,                 /* D */
 200     language_go,                /* Go */
 201     language_objc,              /* Objective-C */
 202     language_java,              /* Java */
 203     language_fortran,           /* Fortran */
 204     language_m2,                /* Modula-2 */
 205     language_asm,               /* Assembly language */
 206     language_pascal,            /* Pascal */
 207     language_ada,               /* Ada */
 208     language_opencl,            /* OpenCL */
 209     language_minimal,           /* All other languages, minimal support only */
 210     nr_languages
 211   };
 212
 213 enum precision_type
 214   {
 215     single_precision,
 216     double_precision,
 217     unspecified_precision
 218   };
 219
 220 /* A generic, not quite boolean, enumeration.  */
 221 enum auto_boolean
 222 {
 223   AUTO_BOOLEAN_TRUE,
 224   AUTO_BOOLEAN_FALSE,
 225   AUTO_BOOLEAN_AUTO
 226 };
 227
 228 /* Potential ways that a function can return a value of a given type.  */
 229 enum return_value_convention
 230 {
 231   /* Where the return value has been squeezed into one or more
 232      registers.  */
 233   RETURN_VALUE_REGISTER_CONVENTION,
 234   /* Commonly known as the "struct return convention".  The caller
 235      passes an additional hidden first parameter to the caller.  That
 236      parameter contains the address at which the value being returned
 237      should be stored.  While typically, and historically, used for
 238      large structs, this is convention is applied to values of many
 239      different types.  */
 240   RETURN_VALUE_STRUCT_CONVENTION,
 241   /* Like the "struct return convention" above, but where the ABI
 242      guarantees that the called function stores the address at which
 243      the value being returned is stored in a well-defined location,
 244      such as a register or memory slot in the stack frame.  Don't use
 245      this if the ABI doesn't explicitly guarantees this.  */
 246   RETURN_VALUE_ABI_RETURNS_ADDRESS,
 247   /* Like the "struct return convention" above, but where the ABI
 248      guarantees that the address at which the value being returned is
 249      stored will be available in a well-defined location, such as a
 250      register or memory slot in the stack frame.  Don't use this if
 251      the ABI doesn't explicitly guarantees this.  */
 252   RETURN_VALUE_ABI_PRESERVES_ADDRESS,
 253 };
 254
 255 /* vec.h-style vectors of strings want a typedef for char * or const char *.  */
 256
 257 typedef char * char_ptr;
 258 typedef const char * const_char_ptr;
 259
 260 /* Needed for various prototypes */
 261
 262 struct symtab;
 263 struct breakpoint;
 264 struct frame_info;
 265 struct gdbarch;
 266 struct value;
 267
 268 /* From main.c.  */
 269
 270 /* This really belong in utils.c (path-utils.c?), but it references some
 271    globals that are currently only available to main.c.  */
 272 extern char *relocate_gdb_directory (const char *initial, int flag);
 273
 274 /* From utils.c */
 275
 276 extern void initialize_utils (void);
 277
 278 extern void notice_quit (void);
 279
 280 extern int strcmp_iw (const char *, const char *);
 281
 282 extern int strcmp_iw_ordered (const char *, const char *);
 283
 284 extern int streq (const char *, const char *);
 285
 286 extern int subset_compare (char *, char *);
 287
 288 extern char *safe_strerror (int);
 289
 290 extern void set_display_time (int);
 291
 292 extern void set_display_space (int);
 293
 294 /* Cleanup utilities.  */
 295
 296 #include "cleanups.h"
 297
 298 extern struct cleanup *make_cleanup_freeargv (char **);
 299
 300 struct dyn_string;
 301 extern struct cleanup *make_cleanup_dyn_string_delete (struct dyn_string *);
 302
 303 struct ui_file;
 304 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
 305
 306 struct ui_out;
 307 extern struct cleanup *
 308   make_cleanup_ui_out_redirect_pop (struct ui_out *uiout);
 309
 310 struct section_addr_info;
 311 extern struct cleanup *(make_cleanup_free_section_addr_info
 312                         (struct section_addr_info *));
 313
 314 extern struct cleanup *make_cleanup_close (int fd);
 315
 316 extern struct cleanup *make_cleanup_fclose (FILE *file);
 317
 318 extern struct cleanup *make_cleanup_bfd_unref (bfd *abfd);
 319
 320 struct obstack;
 321 extern struct cleanup *make_cleanup_obstack_free (struct obstack *obstack);
 322
 323 extern struct cleanup *make_cleanup_restore_integer (int *variable);
 324 extern struct cleanup *make_cleanup_restore_uinteger (unsigned int *variable);
 325
 326 struct target_ops;
 327 extern struct cleanup *make_cleanup_unpush_target (struct target_ops *ops);
 328
 329 extern struct cleanup *
 330   make_cleanup_restore_ui_file (struct ui_file **variable);
 331
 332 extern struct cleanup *make_cleanup_value_free_to_mark (struct value *);
 333 extern struct cleanup *make_cleanup_value_free (struct value *);
 334
 335 struct so_list;
 336 extern struct cleanup *make_cleanup_free_so (struct so_list *so);
 337
 338 extern struct cleanup *make_cleanup_htab_delete (htab_t htab);
 339
 340 extern void free_current_contents (void *);
 341
 342 extern struct cleanup *make_command_stats_cleanup (int);
 343
 344 extern int myread (int, char *, int);
 345
 346 extern int query (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 347 extern int nquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 348 extern int yquery (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 349
 350 extern void init_page_info (void);
 351
 352 extern struct cleanup *make_cleanup_restore_page_info (void);
 353 extern struct cleanup *
 354   set_batch_flag_and_make_cleanup_restore_page_info (void);
 355
 356 extern char *gdb_realpath (const char *);
 357 extern char *xfullpath (const char *);
 358
 359 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
 360                                           unsigned char *buf, size_t len);
 361
 362 ULONGEST strtoulst (const char *num, const char **trailer, int base);
 363
 364 char *ldirname (const char *filename);
 365
 366 char **gdb_buildargv (const char *);
 367
 368 int compare_positive_ints (const void *ap, const void *bp);
 369 int compare_strings (const void *ap, const void *bp);
 370
 371 /* A wrapper for bfd_errmsg to produce a more helpful error message
 372    in the case of bfd_error_file_ambiguously recognized.
 373    MATCHING, if non-NULL, is the corresponding argument to
 374    bfd_check_format_matches, and will be freed.  */
 375
 376 extern const char *gdb_bfd_errmsg (bfd_error_type error_tag, char **matching);
 377
 378 extern int parse_pid_to_attach (char *args);
 379
 380 extern struct cleanup *make_bpstat_clear_actions_cleanup (void);
 381
 382 extern int producer_is_gcc_ge_4 (const char *producer);
 383
 384 extern void substitute_path_component (char **stringp, const char *from,
 385                                        const char *to);
 386
 387 #ifdef HAVE_WAITPID
 388 extern pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout);
 389 #endif
 390
 391 extern int gdb_filename_fnmatch (const char *pattern, const char *string,
 392                                  int flags);
 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 /* Input stream */
 408 extern struct ui_file *gdb_stdin;
 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 moment, 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 moment, 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 extern struct ui_file *gdb_stdtargerr;
 422 extern struct ui_file *gdb_stdtargin;
 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) ATTRIBUTE_PRINTF (1, 0);
 450
 451 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 452   ATTRIBUTE_PRINTF (2, 0);
 453
 454 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 455   ATTRIBUTE_PRINTF (2, 3);
 456
 457 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 458   ATTRIBUTE_PRINTF (3, 4);
 459
 460 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 461
 462 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 463
 464 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 465
 466 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 467   ATTRIBUTE_PRINTF (2, 0);
 468
 469 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 470   ATTRIBUTE_PRINTF (2, 3);
 471
 472 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 473
 474 extern void print_spaces (int, struct ui_file *);
 475
 476 extern void print_spaces_filtered (int, struct ui_file *);
 477
 478 extern char *n_spaces (int);
 479
 480 extern void fputstr_filtered (const char *str, int quotr,
 481                               struct ui_file * stream);
 482
 483 extern void fputstr_unfiltered (const char *str, int quotr,
 484                                 struct ui_file * stream);
 485
 486 extern void fputstrn_filtered (const char *str, int n, int quotr,
 487                                struct ui_file * stream);
 488
 489 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 490                                  struct ui_file * stream);
 491
 492 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 493 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 494
 495 extern const char *host_address_to_string (const void *addr);
 496
 497 /* Convert CORE_ADDR to string in platform-specific manner.
 498    This is usually formatted similar to 0x%lx.  */
 499 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 500
 501 /* Return a string representation in hexadecimal notation of ADDRESS,
 502    which is suitable for printing.  */
 503
 504 extern const char *print_core_address (struct gdbarch *gdbarch,
 505                                        CORE_ADDR address);
 506
 507 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
 508
 509 extern hashval_t core_addr_hash (const void *ap);
 510 extern int core_addr_eq (const void *ap, const void *bp);
 511
 512 /* %d for LONGEST */
 513 extern char *plongest (LONGEST l);
 514 /* %u for ULONGEST */
 515 extern char *pulongest (ULONGEST l);
 516
 517 extern char *phex (ULONGEST l, int sizeof_l);
 518 extern char *phex_nz (ULONGEST l, int sizeof_l);
 519 extern char *int_string (LONGEST, int, int, int, int);
 520
 521 /* Convert a CORE_ADDR into a HEX string with leading zeros.
 522    The output from core_addr_to_string() can be passed direct to
 523    string_to_core_addr().  */
 524 extern const char *core_addr_to_string (const CORE_ADDR addr);
 525 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 526 extern CORE_ADDR string_to_core_addr (const char *my_string);
 527
 528 /* Return a string that contains a number formatted as a hex
 529    string.  */
 530 extern char *hex_string (LONGEST);
 531 extern char *hex_string_custom (LONGEST, int);
 532
 533 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 534                                      enum language, int);
 535
 536 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
 537
 538 extern void print_sys_errmsg (const char *, int);
 539
 540 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 541    "const char *" in unistd.h, so we can't declare the argument
 542    as "char *".  */
 543
 544 extern char *re_comp (const char *);
 545
 546 /* From symfile.c */
 547
 548 extern void symbol_file_command (char *, int);
 549
 550 /* Remote targets may wish to use this as their load function.  */
 551 extern void generic_load (char *name, int from_tty);
 552
 553 /* Report on STREAM the performance of memory transfer operation,
 554    such as 'load'.
 555    DATA_COUNT is the number of bytes transferred.
 556    WRITE_COUNT is the number of separate write operations, or 0,
 557    if that information is not available.
 558    START_TIME is the time at which an operation was started.
 559    END_TIME is the time at which an operation ended.  */
 560 struct timeval;
 561 extern void print_transfer_performance (struct ui_file *stream,
 562                                         unsigned long data_count,
 563                                         unsigned long write_count,
 564                                         const struct timeval *start_time,
 565                                         const struct timeval *end_time);
 566
 567 /* From top.c */
 568
 569 typedef void initialize_file_ftype (void);
 570
 571 extern char *skip_quoted (char *);
 572
 573 extern char *gdb_readline (char *);
 574
 575 extern char *gdb_readline_wrapper (char *);
 576
 577 extern char *command_line_input (char *, int, char *);
 578
 579 extern void print_prompt (void);
 580
 581 extern int input_from_terminal_p (void);
 582
 583 extern int info_verbose;
 584
 585 /* From printcmd.c */
 586
 587 extern void set_next_address (struct gdbarch *, CORE_ADDR);
 588
 589 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
 590                                    struct ui_file *, int, char *);
 591
 592 extern int build_address_symbolic (struct gdbarch *,
 593                                    CORE_ADDR addr,
 594                                    int do_demangle,
 595                                    char **name,
 596                                    int *offset,
 597                                    char **filename,
 598                                    int *line,
 599                                    int *unmapped);
 600
 601 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
 602 extern const char *pc_prefix (CORE_ADDR);
 603
 604 /* From source.c */
 605
 606 #define OPF_TRY_CWD_FIRST     0x01
 607 #define OPF_SEARCH_IN_PATH    0x02
 608
 609 extern int openp (const char *, int, const char *, int, char **);
 610
 611 extern int source_full_path_of (const char *, char **);
 612
 613 extern void mod_path (char *, char **);
 614
 615 extern void add_path (char *, char **, int);
 616
 617 extern void directory_command (char *, int);
 618
 619 extern void directory_switch (char *, int);
 620
 621 extern char *source_path;
 622
 623 extern void init_source_path (void);
 624
 625 /* From exec.c */
 626
 627 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
 628                                          int read, int write, int exec,
 629                                          void *data);
 630
 631 /* Take over the 'find_mapped_memory' vector from exec.c.  */
 632 extern void exec_set_find_memory_regions
 633   (int (*func) (find_memory_region_ftype func, void *data));
 634
 635 /* Possible lvalue types.  Like enum language, this should be in
 636    value.h, but needs to be here for the same reason.  */
 637
 638 enum lval_type
 639   {
 640     /* Not an lval.  */
 641     not_lval,
 642     /* In memory.  */
 643     lval_memory,
 644     /* In a register.  Registers are relative to a frame.  */
 645     lval_register,
 646     /* In a gdb internal variable.  */
 647     lval_internalvar,
 648     /* Part of a gdb internal variable (structure field).  */
 649     lval_internalvar_component,
 650     /* Value's bits are fetched and stored using functions provided by
 651        its creator.  */
 652     lval_computed
 653   };
 654
 655 /* Control types for commands */
 656
 657 enum misc_command_type
 658   {
 659     ok_command,
 660     end_command,
 661     else_command,
 662     nop_command
 663   };
 664
 665 enum command_control_type
 666   {
 667     simple_control,
 668     break_control,
 669     continue_control,
 670     while_control,
 671     if_control,
 672     commands_control,
 673     python_control,
 674     while_stepping_control,
 675     invalid_control
 676   };
 677
 678 /* Structure for saved commands lines
 679    (for breakpoints, defined commands, etc).  */
 680
 681 struct command_line
 682   {
 683     struct command_line *next;
 684     char *line;
 685     enum command_control_type control_type;
 686     /* The number of elements in body_list.  */
 687     int body_count;
 688     /* For composite commands, the nested lists of commands.  For
 689        example, for "if" command this will contain the then branch and
 690        the else branch, if that is available.  */
 691     struct command_line **body_list;
 692   };
 693
 694 extern struct command_line *read_command_lines (char *, int, int,
 695                                                 void (*)(char *, void *),
 696                                                 void *);
 697 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
 698                                                   void (*)(char *, void *),
 699                                                   void *);
 700
 701 extern void free_command_lines (struct command_line **);
 702
 703 /* Parameters of the "info proc" command.  */
 704
 705 enum info_proc_what
 706   {
 707     /* Display the default cmdline, cwd and exe outputs.  */
 708     IP_MINIMAL,
 709
 710     /* Display `info proc mappings'.  */
 711     IP_MAPPINGS,
 712
 713     /* Display `info proc status'.  */
 714     IP_STATUS,
 715
 716     /* Display `info proc stat'.  */
 717     IP_STAT,
 718
 719     /* Display `info proc cmdline'.  */
 720     IP_CMDLINE,
 721
 722     /* Display `info proc exe'.  */
 723     IP_EXE,
 724
 725     /* Display `info proc cwd'.  */
 726     IP_CWD,
 727
 728     /* Display all of the above.  */
 729     IP_ALL
 730   };
 731
 732 /* String containing the current directory (what getwd would return).  */
 733
 734 extern char *current_directory;
 735
 736 /* Default radixes for input and output.  Only some values supported.  */
 737 extern unsigned input_radix;
 738 extern unsigned output_radix;
 739
 740 /* Possibilities for prettyprint parameters to routines which print
 741    things.  Like enum language, this should be in value.h, but needs
 742    to be here for the same reason.  FIXME:  If we can eliminate this
 743    as an arg to LA_VAL_PRINT, then we can probably move it back to
 744    value.h.  */
 745
 746 enum val_prettyprint
 747   {
 748     Val_no_prettyprint = 0,
 749     Val_prettyprint,
 750     /* Use the default setting which the user has specified.  */
 751     Val_pretty_default
 752   };
 753
 754 /* Optional native machine support.  Non-native (and possibly pure
 755    multi-arch) targets do not need a "nm.h" file.  This will be a
 756    symlink to one of the nm-*.h files, built by the `configure'
 757    script.  */
 758
 759 #ifdef GDB_NM_FILE
 760 #include "nm.h"
 761 #endif
 762
 763 /* Assume that fopen accepts the letter "b" in the mode string.
 764    It is demanded by ISO C9X, and should be supported on all
 765    platforms that claim to have a standard-conforming C library.  On
 766    true POSIX systems it will be ignored and have no effect.  There
 767    may still be systems without a standard-conforming C library where
 768    an ISO C9X compiler (GCC) is available.  Known examples are SunOS
 769    4.x and 4.3BSD.  This assumption means these systems are no longer
 770    supported.  */
 771 #ifndef FOPEN_RB
 772 # include "fopen-bin.h"
 773 #endif
 774
 775 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 776    FIXME: Assumes 2's complement arithmetic.  */
 777
 778 #if !defined (UINT_MAX)
 779 #define UINT_MAX ((unsigned int)(~0))       /* 0xFFFFFFFF for 32-bits */
 780 #endif
 781
 782 #if !defined (INT_MAX)
 783 #define INT_MAX ((int)(UINT_MAX >> 1))      /* 0x7FFFFFFF for 32-bits */
 784 #endif
 785
 786 #if !defined (INT_MIN)
 787 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
 788 #endif
 789
 790 #if !defined (ULONG_MAX)
 791 #define ULONG_MAX ((unsigned long)(~0L))    /* 0xFFFFFFFF for 32-bits */
 792 #endif
 793
 794 #if !defined (LONG_MAX)
 795 #define LONG_MAX ((long)(ULONG_MAX >> 1))   /* 0x7FFFFFFF for 32-bits */
 796 #endif
 797
 798 #if !defined (ULONGEST_MAX)
 799 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 800 #endif
 801
 802 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 803 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 804 #endif
 805
 806 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 807    arguments to a function, number in a value history, register number, etc.)
 808    where the value must not be larger than can fit in an int.  */
 809
 810 extern int longest_to_int (LONGEST);
 811
 812 /* Assorted functions we can declare, now that const and volatile are
 813    defined.  */
 814
 815 extern char *savestring (const char *, size_t);
 816
 817 /* Utility macros to allocate typed memory.  Avoids errors like:
 818    struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
 819    sizeof (struct foo), 0).  */
 820 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
 821 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 822 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 823
 824 #include "common-utils.h"
 825
 826 extern int parse_escape (struct gdbarch *, char **);
 827
 828 /* Message to be printed before the error message, when an error occurs.  */
 829
 830 extern char *error_pre_print;
 831
 832 /* Message to be printed before the error message, when an error occurs.  */
 833
 834 extern char *quit_pre_print;
 835
 836 /* Message to be printed before the warning message, when a warning occurs.  */
 837
 838 extern char *warning_pre_print;
 839
 840 extern void verror (const char *fmt, va_list ap)
 841      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 842
 843 extern void error (const char *fmt, ...)
 844      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 845
 846 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
 847
 848 extern void vfatal (const char *fmt, va_list ap)
 849      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 850
 851 extern void fatal (const char *fmt, ...)
 852      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 853
 854 extern void internal_verror (const char *file, int line, const char *,
 855                              va_list ap)
 856      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
 857
 858 extern void internal_vwarning (const char *file, int line,
 859                                const char *, va_list ap)
 860      ATTRIBUTE_PRINTF (3, 0);
 861
 862 extern void internal_warning (const char *file, int line,
 863                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 864
 865 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 866
 867 extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
 868
 869 /* List of known OS ABIs.  If you change this, make sure to update the
 870    table in osabi.c.  */
 871 enum gdb_osabi
 872 {
 873   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
 874
 875   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
 876
 877   GDB_OSABI_SVR4,
 878   GDB_OSABI_HURD,
 879   GDB_OSABI_SOLARIS,
 880   GDB_OSABI_OSF1,
 881   GDB_OSABI_LINUX,
 882   GDB_OSABI_FREEBSD_AOUT,
 883   GDB_OSABI_FREEBSD_ELF,
 884   GDB_OSABI_NETBSD_AOUT,
 885   GDB_OSABI_NETBSD_ELF,
 886   GDB_OSABI_OPENBSD_ELF,
 887   GDB_OSABI_WINCE,
 888   GDB_OSABI_GO32,
 889   GDB_OSABI_IRIX,
 890   GDB_OSABI_INTERIX,
 891   GDB_OSABI_HPUX_ELF,
 892   GDB_OSABI_HPUX_SOM,
 893   GDB_OSABI_QNXNTO,
 894   GDB_OSABI_CYGWIN,
 895   GDB_OSABI_AIX,
 896   GDB_OSABI_DICOS,
 897   GDB_OSABI_DARWIN,
 898   GDB_OSABI_SYMBIAN,
 899   GDB_OSABI_OPENVMS,
 900
 901   GDB_OSABI_INVALID             /* keep this last */
 902 };
 903
 904 /* Global functions from other, non-gdb GNU thingies.
 905    Libiberty thingies are no longer declared here.  We include libiberty.h
 906    above, instead.  */
 907
 908 /* From other system libraries */
 909
 910 #ifdef HAVE_STDDEF_H
 911 #include <stddef.h>
 912 #endif
 913
 914 #ifdef HAVE_STDLIB_H
 915 #include <stdlib.h>
 916 #endif
 917 #ifndef min
 918 #define min(a, b) ((a) < (b) ? (a) : (b))
 919 #endif
 920 #ifndef max
 921 #define max(a, b) ((a) > (b) ? (a) : (b))
 922 #endif
 923
 924
 925 #ifndef atof
 926 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
 927 #endif
 928
 929 /* Various possibilities for alloca.  */
 930 #ifndef alloca
 931 #ifdef __GNUC__
 932 #define alloca __builtin_alloca
 933 #else /* Not GNU C */
 934 #ifdef HAVE_ALLOCA_H
 935 #include <alloca.h>
 936 #else
 937 #ifdef _AIX
 938 #pragma alloca
 939 #else
 940
 941 /* We need to be careful not to declare this in a way which conflicts with
 942    bison.  Bison never declares it as char *, but under various circumstances
 943    (like __hpux) we need to use void *.  */
 944 extern void *alloca ();
 945 #endif /* Not _AIX */
 946 #endif /* Not HAVE_ALLOCA_H */
 947 #endif /* Not GNU C */
 948 #endif /* alloca not defined */
 949
 950 /* Dynamic target-system-dependent parameters for GDB.  */
 951 #include "gdbarch.h"
 952
 953 /* Maximum size of a register.  Something small, but large enough for
 954    all known ISAs.  If it turns out to be too small, make it bigger.  */
 955
 956 enum { MAX_REGISTER_SIZE = 64 };
 957
 958 /* Static target-system-dependent parameters for GDB.  */
 959
 960 /* Number of bits in a char or unsigned char for the target machine.
 961    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
 962 #if !defined (TARGET_CHAR_BIT)
 963 #define TARGET_CHAR_BIT 8
 964 #endif
 965
 966 /* If we picked up a copy of CHAR_BIT from a configuration file
 967    (which may get it by including <limits.h>) then use it to set
 968    the number of bits in a host char.  If not, use the same size
 969    as the target.  */
 970
 971 #if defined (CHAR_BIT)
 972 #define HOST_CHAR_BIT CHAR_BIT
 973 #else
 974 #define HOST_CHAR_BIT TARGET_CHAR_BIT
 975 #endif
 976
 977 /* In findvar.c.  */
 978
 979 extern LONGEST extract_signed_integer (const gdb_byte *, int,
 980                                        enum bfd_endian);
 981
 982 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
 983                                           enum bfd_endian);
 984
 985 extern int extract_long_unsigned_integer (const gdb_byte *, int,
 986                                           enum bfd_endian, LONGEST *);
 987
 988 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
 989                                         struct type *type);
 990
 991 extern void store_signed_integer (gdb_byte *, int,
 992                                   enum bfd_endian, LONGEST);
 993
 994 extern void store_unsigned_integer (gdb_byte *, int,
 995                                     enum bfd_endian, ULONGEST);
 996
 997 extern void store_typed_address (gdb_byte *buf, struct type *type,
 998                                  CORE_ADDR addr);
 999
1000 \f
1001 /* From valops.c */
1002
1003 extern int watchdog;
1004
1005 /* Hooks for alternate command interfaces.  */
1006
1007 /* The name of the interpreter if specified on the command line.  */
1008 extern char *interpreter_p;
1009
1010 /* If a given interpreter matches INTERPRETER_P then it should update
1011    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1012    per-interpreter implementation.  */
1013 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1014    should be moved here.  */
1015
1016 struct target_waitstatus;
1017 struct cmd_list_element;
1018
1019 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1020 extern void (*deprecated_post_add_symbol_hook) (void);
1021 extern void (*selected_frame_level_changed_hook) (int);
1022 extern int (*deprecated_ui_loop_hook) (int signo);
1023 extern void (*deprecated_init_ui_hook) (char *argv0);
1024 extern void (*deprecated_command_loop_hook) (void);
1025 extern void (*deprecated_show_load_progress) (const char *section,
1026                                               unsigned long section_sent,
1027                                               unsigned long section_size,
1028                                               unsigned long total_sent,
1029                                               unsigned long total_size);
1030 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1031                                                          int line,
1032                                                          int stopline,
1033                                                          int noerror);
1034 extern int (*deprecated_query_hook) (const char *, va_list)
1035      ATTRIBUTE_FPTR_PRINTF(1,0);
1036 extern void (*deprecated_warning_hook) (const char *, va_list)
1037      ATTRIBUTE_FPTR_PRINTF(1,0);
1038 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1039 extern void (*deprecated_interactive_hook) (void);
1040 extern void (*deprecated_readline_begin_hook) (char *, ...)
1041      ATTRIBUTE_FPTR_PRINTF_1;
1042 extern char *(*deprecated_readline_hook) (char *);
1043 extern void (*deprecated_readline_end_hook) (void);
1044 extern void (*deprecated_register_changed_hook) (int regno);
1045 extern void (*deprecated_context_hook) (int);
1046 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1047                                               struct target_waitstatus *status,
1048                                               int options);
1049
1050 extern void (*deprecated_attach_hook) (void);
1051 extern void (*deprecated_detach_hook) (void);
1052 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1053                                              char *cmd, int from_tty);
1054
1055 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1056
1057 extern void (*deprecated_error_begin_hook) (void);
1058
1059 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1060                                                 unsigned long num);
1061
1062
1063 /* Inhibit window interface if non-zero.  */
1064
1065 extern int use_windows;
1066
1067 /* Definitions of filename-related things.  */
1068
1069 /* Host specific things.  */
1070
1071 #ifdef __MSDOS__
1072 # define CANT_FORK
1073 # define GLOBAL_CURDIR
1074 # define DIRNAME_SEPARATOR ';'
1075 #endif
1076
1077 #if !defined (__CYGWIN__) && defined (_WIN32)
1078 # define DIRNAME_SEPARATOR ';'
1079 #endif
1080
1081 #ifndef DIRNAME_SEPARATOR
1082 #define DIRNAME_SEPARATOR ':'
1083 #endif
1084
1085 #ifndef SLASH_STRING
1086 #define SLASH_STRING "/"
1087 #endif
1088
1089 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1090    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1091    in the code actually refer to a lightweight process id, i.e,
1092    something that can be considered a process id in its own right for
1093    certain purposes.  */
1094
1095 #ifndef PIDGET
1096 #define PIDGET(PTID) (ptid_get_pid (PTID))
1097 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1098 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1099 #endif
1100
1101 /* Define well known filenos if the system does not define them.  */
1102 #ifndef STDIN_FILENO
1103 #define STDIN_FILENO   0
1104 #endif
1105 #ifndef STDOUT_FILENO
1106 #define STDOUT_FILENO  1
1107 #endif
1108 #ifndef STDERR_FILENO
1109 #define STDERR_FILENO  2
1110 #endif
1111
1112 /* If this definition isn't overridden by the header files, assume
1113    that isatty and fileno exist on this system.  */
1114 #ifndef ISATTY
1115 #define ISATTY(FP)      (isatty (fileno (FP)))
1116 #endif
1117
1118 /* A width that can achieve a better legibility for GDB MI mode.  */
1119 #define GDB_MI_MSG_WIDTH  80
1120
1121 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1122    power of 2).  Round up/down when necessary.  Examples of correct
1123    use include:
1124
1125    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1126    write_memory (addr, value, len);
1127    addr += len;
1128
1129    and:
1130
1131    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1132    write_memory (sp, value, len);
1133
1134    Note that uses such as:
1135
1136    write_memory (addr, value, len);
1137    addr += align_up (len, 8);
1138
1139    and:
1140
1141    sp -= align_up (len, 8);
1142    write_memory (sp, value, len);
1143
1144    are typically not correct as they don't ensure that the address (SP
1145    or ADDR) is correctly aligned (relying on previous alignment to
1146    keep things right).  This is also why the methods are called
1147    "align_..." instead of "round_..." as the latter reads better with
1148    this incorrect coding style.  */
1149
1150 extern ULONGEST align_up (ULONGEST v, int n);
1151 extern ULONGEST align_down (ULONGEST v, int n);
1152
1153 /* Allocation and deallocation functions for the libiberty hash table
1154    which use obstacks.  */
1155 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
1156 void dummy_obstack_deallocate (void *object, void *data);
1157
1158 /* From progspace.c */
1159
1160 extern void initialize_progspace (void);
1161 extern void initialize_inferiors (void);
1162
1163 /* Special block numbers */
1164
1165 enum block_enum
1166 {
1167   GLOBAL_BLOCK = 0,
1168   STATIC_BLOCK = 1,
1169   FIRST_LOCAL_BLOCK = 2
1170 };
1171
1172 #endif /* #ifndef DEFS_H */