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_close (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 \f
 392 /* Annotation stuff.  */
 393
 394 extern int annotation_level;    /* in stack.c */
 395 \f
 396 extern void begin_line (void);
 397
 398 extern void wrap_here (char *);
 399
 400 extern void reinitialize_more_filter (void);
 401
 402 /* Normal results */
 403 extern struct ui_file *gdb_stdout;
 404 /* Input stream */
 405 extern struct ui_file *gdb_stdin;
 406 /* Serious error notifications */
 407 extern struct ui_file *gdb_stderr;
 408 /* Log/debug/trace messages that should bypass normal stdout/stderr
 409    filtering.  For moment, always call this stream using
 410    *_unfiltered.  In the very near future that restriction shall be
 411    removed - either call shall be unfiltered.  (cagney 1999-06-13).  */
 412 extern struct ui_file *gdb_stdlog;
 413 /* Target output that should bypass normal stdout/stderr filtering.
 414    For moment, always call this stream using *_unfiltered.  In the
 415    very near future that restriction shall be removed - either call
 416    shall be unfiltered.  (cagney 1999-07-02).  */
 417 extern struct ui_file *gdb_stdtarg;
 418 extern struct ui_file *gdb_stdtargerr;
 419 extern struct ui_file *gdb_stdtargin;
 420
 421 #include "ui-file.h"
 422
 423 /* More generic printf like operations.  Filtered versions may return
 424    non-locally on error.  */
 425
 426 extern void fputs_filtered (const char *, struct ui_file *);
 427
 428 extern void fputs_unfiltered (const char *, struct ui_file *);
 429
 430 extern int fputc_filtered (int c, struct ui_file *);
 431
 432 extern int fputc_unfiltered (int c, struct ui_file *);
 433
 434 extern int putchar_filtered (int c);
 435
 436 extern int putchar_unfiltered (int c);
 437
 438 extern void puts_filtered (const char *);
 439
 440 extern void puts_unfiltered (const char *);
 441
 442 extern void puts_filtered_tabular (char *string, int width, int right);
 443
 444 extern void puts_debug (char *prefix, char *string, char *suffix);
 445
 446 extern void vprintf_filtered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 447
 448 extern void vfprintf_filtered (struct ui_file *, const char *, va_list)
 449   ATTRIBUTE_PRINTF (2, 0);
 450
 451 extern void fprintf_filtered (struct ui_file *, const char *, ...)
 452   ATTRIBUTE_PRINTF (2, 3);
 453
 454 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...)
 455   ATTRIBUTE_PRINTF (3, 4);
 456
 457 extern void printf_filtered (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 458
 459 extern void printfi_filtered (int, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 460
 461 extern void vprintf_unfiltered (const char *, va_list) ATTRIBUTE_PRINTF (1, 0);
 462
 463 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list)
 464   ATTRIBUTE_PRINTF (2, 0);
 465
 466 extern void fprintf_unfiltered (struct ui_file *, const char *, ...)
 467   ATTRIBUTE_PRINTF (2, 3);
 468
 469 extern void printf_unfiltered (const char *, ...) ATTRIBUTE_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,
 478                               struct ui_file * stream);
 479
 480 extern void fputstr_unfiltered (const char *str, int quotr,
 481                                 struct ui_file * stream);
 482
 483 extern void fputstrn_filtered (const char *str, int n, int quotr,
 484                                struct ui_file * stream);
 485
 486 extern void fputstrn_unfiltered (const char *str, int n, int quotr,
 487                                  struct ui_file * stream);
 488
 489 /* Display the host ADDR on STREAM formatted as ``0x%x''.  */
 490 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 491
 492 extern const char *host_address_to_string (const void *addr);
 493
 494 /* Convert CORE_ADDR to string in platform-specific manner.
 495    This is usually formatted similar to 0x%lx.  */
 496 extern const char *paddress (struct gdbarch *gdbarch, CORE_ADDR addr);
 497
 498 /* Return a string representation in hexadecimal notation of ADDRESS,
 499    which is suitable for printing.  */
 500
 501 extern const char *print_core_address (struct gdbarch *gdbarch,
 502                                        CORE_ADDR address);
 503
 504 /* Callback hash_f and eq_f for htab_create_alloc or htab_create_alloc_ex.  */
 505
 506 extern hashval_t core_addr_hash (const void *ap);
 507 extern int core_addr_eq (const void *ap, const void *bp);
 508
 509 /* %d for LONGEST */
 510 extern char *plongest (LONGEST l);
 511 /* %u for ULONGEST */
 512 extern char *pulongest (ULONGEST l);
 513
 514 extern char *phex (ULONGEST l, int sizeof_l);
 515 extern char *phex_nz (ULONGEST l, int sizeof_l);
 516 extern char *int_string (LONGEST, int, int, int, int);
 517
 518 /* Convert a CORE_ADDR into a HEX string with leading zeros.
 519    The output from core_addr_to_string() can be passed direct to
 520    string_to_core_addr().  */
 521 extern const char *core_addr_to_string (const CORE_ADDR addr);
 522 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 523 extern CORE_ADDR string_to_core_addr (const char *my_string);
 524
 525 /* Return a string that contains a number formatted as a hex
 526    string.  */
 527 extern char *hex_string (LONGEST);
 528 extern char *hex_string_custom (LONGEST, int);
 529
 530 extern void fprintf_symbol_filtered (struct ui_file *, const char *,
 531                                      enum language, int);
 532
 533 extern void perror_with_name (const char *) ATTRIBUTE_NORETURN;
 534
 535 extern void print_sys_errmsg (const char *, int);
 536
 537 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 538    "const char *" in unistd.h, so we can't declare the argument
 539    as "char *".  */
 540
 541 extern char *re_comp (const char *);
 542
 543 /* From symfile.c */
 544
 545 extern void symbol_file_command (char *, int);
 546
 547 /* Remote targets may wish to use this as their load function.  */
 548 extern void generic_load (char *name, int from_tty);
 549
 550 /* Report on STREAM the performance of memory transfer operation,
 551    such as 'load'.
 552    DATA_COUNT is the number of bytes transferred.
 553    WRITE_COUNT is the number of separate write operations, or 0,
 554    if that information is not available.
 555    START_TIME is the time at which an operation was started.
 556    END_TIME is the time at which an operation ended.  */
 557 struct timeval;
 558 extern void print_transfer_performance (struct ui_file *stream,
 559                                         unsigned long data_count,
 560                                         unsigned long write_count,
 561                                         const struct timeval *start_time,
 562                                         const struct timeval *end_time);
 563
 564 /* From top.c */
 565
 566 typedef void initialize_file_ftype (void);
 567
 568 extern char *skip_quoted (char *);
 569
 570 extern char *gdb_readline (char *);
 571
 572 extern char *gdb_readline_wrapper (char *);
 573
 574 extern char *command_line_input (char *, int, char *);
 575
 576 extern void print_prompt (void);
 577
 578 extern int input_from_terminal_p (void);
 579
 580 extern int info_verbose;
 581
 582 /* From printcmd.c */
 583
 584 extern void set_next_address (struct gdbarch *, CORE_ADDR);
 585
 586 extern int print_address_symbolic (struct gdbarch *, CORE_ADDR,
 587                                    struct ui_file *, int, char *);
 588
 589 extern int build_address_symbolic (struct gdbarch *,
 590                                    CORE_ADDR addr,
 591                                    int do_demangle,
 592                                    char **name,
 593                                    int *offset,
 594                                    char **filename,
 595                                    int *line,
 596                                    int *unmapped);
 597
 598 extern void print_address (struct gdbarch *, CORE_ADDR, struct ui_file *);
 599 extern const char *pc_prefix (CORE_ADDR);
 600
 601 /* From source.c */
 602
 603 #define OPF_TRY_CWD_FIRST     0x01
 604 #define OPF_SEARCH_IN_PATH    0x02
 605
 606 extern int openp (const char *, int, const char *, int, char **);
 607
 608 extern int source_full_path_of (const char *, char **);
 609
 610 extern void mod_path (char *, char **);
 611
 612 extern void add_path (char *, char **, int);
 613
 614 extern void directory_command (char *, int);
 615
 616 extern void directory_switch (char *, int);
 617
 618 extern char *source_path;
 619
 620 extern void init_source_path (void);
 621
 622 /* From exec.c */
 623
 624 typedef int (*find_memory_region_ftype) (CORE_ADDR addr, unsigned long size,
 625                                          int read, int write, int exec,
 626                                          void *data);
 627
 628 /* Take over the 'find_mapped_memory' vector from exec.c.  */
 629 extern void exec_set_find_memory_regions
 630   (int (*func) (find_memory_region_ftype func, void *data));
 631
 632 /* Possible lvalue types.  Like enum language, this should be in
 633    value.h, but needs to be here for the same reason.  */
 634
 635 enum lval_type
 636   {
 637     /* Not an lval.  */
 638     not_lval,
 639     /* In memory.  */
 640     lval_memory,
 641     /* In a register.  Registers are relative to a frame.  */
 642     lval_register,
 643     /* In a gdb internal variable.  */
 644     lval_internalvar,
 645     /* Part of a gdb internal variable (structure field).  */
 646     lval_internalvar_component,
 647     /* Value's bits are fetched and stored using functions provided by
 648        its creator.  */
 649     lval_computed
 650   };
 651
 652 /* Control types for commands */
 653
 654 enum misc_command_type
 655   {
 656     ok_command,
 657     end_command,
 658     else_command,
 659     nop_command
 660   };
 661
 662 enum command_control_type
 663   {
 664     simple_control,
 665     break_control,
 666     continue_control,
 667     while_control,
 668     if_control,
 669     commands_control,
 670     python_control,
 671     while_stepping_control,
 672     invalid_control
 673   };
 674
 675 /* Structure for saved commands lines
 676    (for breakpoints, defined commands, etc).  */
 677
 678 struct command_line
 679   {
 680     struct command_line *next;
 681     char *line;
 682     enum command_control_type control_type;
 683     /* The number of elements in body_list.  */
 684     int body_count;
 685     /* For composite commands, the nested lists of commands.  For
 686        example, for "if" command this will contain the then branch and
 687        the else branch, if that is available.  */
 688     struct command_line **body_list;
 689   };
 690
 691 extern struct command_line *read_command_lines (char *, int, int,
 692                                                 void (*)(char *, void *),
 693                                                 void *);
 694 extern struct command_line *read_command_lines_1 (char * (*) (void), int,
 695                                                   void (*)(char *, void *),
 696                                                   void *);
 697
 698 extern void free_command_lines (struct command_line **);
 699
 700 /* Parameters of the "info proc" command.  */
 701
 702 enum info_proc_what
 703   {
 704     /* Display the default cmdline, cwd and exe outputs.  */
 705     IP_MINIMAL,
 706
 707     /* Display `info proc mappings'.  */
 708     IP_MAPPINGS,
 709
 710     /* Display `info proc status'.  */
 711     IP_STATUS,
 712
 713     /* Display `info proc stat'.  */
 714     IP_STAT,
 715
 716     /* Display `info proc cmdline'.  */
 717     IP_CMDLINE,
 718
 719     /* Display `info proc exe'.  */
 720     IP_EXE,
 721
 722     /* Display `info proc cwd'.  */
 723     IP_CWD,
 724
 725     /* Display all of the above.  */
 726     IP_ALL
 727   };
 728
 729 /* String containing the current directory (what getwd would return).  */
 730
 731 extern char *current_directory;
 732
 733 /* Default radixes for input and output.  Only some values supported.  */
 734 extern unsigned input_radix;
 735 extern unsigned output_radix;
 736
 737 /* Possibilities for prettyprint parameters to routines which print
 738    things.  Like enum language, this should be in value.h, but needs
 739    to be here for the same reason.  FIXME:  If we can eliminate this
 740    as an arg to LA_VAL_PRINT, then we can probably move it back to
 741    value.h.  */
 742
 743 enum val_prettyprint
 744   {
 745     Val_no_prettyprint = 0,
 746     Val_prettyprint,
 747     /* Use the default setting which the user has specified.  */
 748     Val_pretty_default
 749   };
 750
 751 /* Optional native machine support.  Non-native (and possibly pure
 752    multi-arch) targets do not need a "nm.h" file.  This will be a
 753    symlink to one of the nm-*.h files, built by the `configure'
 754    script.  */
 755
 756 #ifdef GDB_NM_FILE
 757 #include "nm.h"
 758 #endif
 759
 760 /* Assume that fopen accepts the letter "b" in the mode string.
 761    It is demanded by ISO C9X, and should be supported on all
 762    platforms that claim to have a standard-conforming C library.  On
 763    true POSIX systems it will be ignored and have no effect.  There
 764    may still be systems without a standard-conforming C library where
 765    an ISO C9X compiler (GCC) is available.  Known examples are SunOS
 766    4.x and 4.3BSD.  This assumption means these systems are no longer
 767    supported.  */
 768 #ifndef FOPEN_RB
 769 # include "fopen-bin.h"
 770 #endif
 771
 772 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 773    FIXME: Assumes 2's complement arithmetic.  */
 774
 775 #if !defined (UINT_MAX)
 776 #define UINT_MAX ((unsigned int)(~0))       /* 0xFFFFFFFF for 32-bits */
 777 #endif
 778
 779 #if !defined (INT_MAX)
 780 #define INT_MAX ((int)(UINT_MAX >> 1))      /* 0x7FFFFFFF for 32-bits */
 781 #endif
 782
 783 #if !defined (INT_MIN)
 784 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
 785 #endif
 786
 787 #if !defined (ULONG_MAX)
 788 #define ULONG_MAX ((unsigned long)(~0L))    /* 0xFFFFFFFF for 32-bits */
 789 #endif
 790
 791 #if !defined (LONG_MAX)
 792 #define LONG_MAX ((long)(ULONG_MAX >> 1))   /* 0x7FFFFFFF for 32-bits */
 793 #endif
 794
 795 #if !defined (ULONGEST_MAX)
 796 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 797 #endif
 798
 799 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 800 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 801 #endif
 802
 803 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 804    arguments to a function, number in a value history, register number, etc.)
 805    where the value must not be larger than can fit in an int.  */
 806
 807 extern int longest_to_int (LONGEST);
 808
 809 /* Assorted functions we can declare, now that const and volatile are
 810    defined.  */
 811
 812 extern char *savestring (const char *, size_t);
 813
 814 /* Utility macros to allocate typed memory.  Avoids errors like:
 815    struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
 816    sizeof (struct foo), 0).  */
 817 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
 818 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 819 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 820
 821 #include "common-utils.h"
 822
 823 extern int parse_escape (struct gdbarch *, char **);
 824
 825 /* Message to be printed before the error message, when an error occurs.  */
 826
 827 extern char *error_pre_print;
 828
 829 /* Message to be printed before the error message, when an error occurs.  */
 830
 831 extern char *quit_pre_print;
 832
 833 /* Message to be printed before the warning message, when a warning occurs.  */
 834
 835 extern char *warning_pre_print;
 836
 837 extern void verror (const char *fmt, va_list ap)
 838      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 839
 840 extern void error (const char *fmt, ...)
 841      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 842
 843 extern void error_stream (struct ui_file *) ATTRIBUTE_NORETURN;
 844
 845 extern void vfatal (const char *fmt, va_list ap)
 846      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 0);
 847
 848 extern void fatal (const char *fmt, ...)
 849      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (1, 2);
 850
 851 extern void internal_verror (const char *file, int line, const char *,
 852                              va_list ap)
 853      ATTRIBUTE_NORETURN ATTRIBUTE_PRINTF (3, 0);
 854
 855 extern void internal_vwarning (const char *file, int line,
 856                                const char *, va_list ap)
 857      ATTRIBUTE_PRINTF (3, 0);
 858
 859 extern void internal_warning (const char *file, int line,
 860                               const char *, ...) ATTRIBUTE_PRINTF (3, 4);
 861
 862 extern void warning (const char *, ...) ATTRIBUTE_PRINTF (1, 2);
 863
 864 extern void vwarning (const char *, va_list args) ATTRIBUTE_PRINTF (1, 0);
 865
 866 /* List of known OS ABIs.  If you change this, make sure to update the
 867    table in osabi.c.  */
 868 enum gdb_osabi
 869 {
 870   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
 871
 872   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
 873
 874   GDB_OSABI_SVR4,
 875   GDB_OSABI_HURD,
 876   GDB_OSABI_SOLARIS,
 877   GDB_OSABI_OSF1,
 878   GDB_OSABI_LINUX,
 879   GDB_OSABI_FREEBSD_AOUT,
 880   GDB_OSABI_FREEBSD_ELF,
 881   GDB_OSABI_NETBSD_AOUT,
 882   GDB_OSABI_NETBSD_ELF,
 883   GDB_OSABI_OPENBSD_ELF,
 884   GDB_OSABI_WINCE,
 885   GDB_OSABI_GO32,
 886   GDB_OSABI_IRIX,
 887   GDB_OSABI_INTERIX,
 888   GDB_OSABI_HPUX_ELF,
 889   GDB_OSABI_HPUX_SOM,
 890   GDB_OSABI_QNXNTO,
 891   GDB_OSABI_CYGWIN,
 892   GDB_OSABI_AIX,
 893   GDB_OSABI_DICOS,
 894   GDB_OSABI_DARWIN,
 895   GDB_OSABI_SYMBIAN,
 896   GDB_OSABI_OPENVMS,
 897
 898   GDB_OSABI_INVALID             /* keep this last */
 899 };
 900
 901 /* Global functions from other, non-gdb GNU thingies.
 902    Libiberty thingies are no longer declared here.  We include libiberty.h
 903    above, instead.  */
 904
 905 /* From other system libraries */
 906
 907 #ifdef HAVE_STDDEF_H
 908 #include <stddef.h>
 909 #endif
 910
 911 #ifdef HAVE_STDLIB_H
 912 #include <stdlib.h>
 913 #endif
 914 #ifndef min
 915 #define min(a, b) ((a) < (b) ? (a) : (b))
 916 #endif
 917 #ifndef max
 918 #define max(a, b) ((a) > (b) ? (a) : (b))
 919 #endif
 920
 921
 922 #ifndef atof
 923 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
 924 #endif
 925
 926 /* Various possibilities for alloca.  */
 927 #ifndef alloca
 928 #ifdef __GNUC__
 929 #define alloca __builtin_alloca
 930 #else /* Not GNU C */
 931 #ifdef HAVE_ALLOCA_H
 932 #include <alloca.h>
 933 #else
 934 #ifdef _AIX
 935 #pragma alloca
 936 #else
 937
 938 /* We need to be careful not to declare this in a way which conflicts with
 939    bison.  Bison never declares it as char *, but under various circumstances
 940    (like __hpux) we need to use void *.  */
 941 extern void *alloca ();
 942 #endif /* Not _AIX */
 943 #endif /* Not HAVE_ALLOCA_H */
 944 #endif /* Not GNU C */
 945 #endif /* alloca not defined */
 946
 947 /* Dynamic target-system-dependent parameters for GDB.  */
 948 #include "gdbarch.h"
 949
 950 /* Maximum size of a register.  Something small, but large enough for
 951    all known ISAs.  If it turns out to be too small, make it bigger.  */
 952
 953 enum { MAX_REGISTER_SIZE = 64 };
 954
 955 /* Static target-system-dependent parameters for GDB.  */
 956
 957 /* Number of bits in a char or unsigned char for the target machine.
 958    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
 959 #if !defined (TARGET_CHAR_BIT)
 960 #define TARGET_CHAR_BIT 8
 961 #endif
 962
 963 /* If we picked up a copy of CHAR_BIT from a configuration file
 964    (which may get it by including <limits.h>) then use it to set
 965    the number of bits in a host char.  If not, use the same size
 966    as the target.  */
 967
 968 #if defined (CHAR_BIT)
 969 #define HOST_CHAR_BIT CHAR_BIT
 970 #else
 971 #define HOST_CHAR_BIT TARGET_CHAR_BIT
 972 #endif
 973
 974 /* In findvar.c.  */
 975
 976 extern LONGEST extract_signed_integer (const gdb_byte *, int,
 977                                        enum bfd_endian);
 978
 979 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int,
 980                                           enum bfd_endian);
 981
 982 extern int extract_long_unsigned_integer (const gdb_byte *, int,
 983                                           enum bfd_endian, LONGEST *);
 984
 985 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
 986                                         struct type *type);
 987
 988 extern void store_signed_integer (gdb_byte *, int,
 989                                   enum bfd_endian, LONGEST);
 990
 991 extern void store_unsigned_integer (gdb_byte *, int,
 992                                     enum bfd_endian, ULONGEST);
 993
 994 extern void store_typed_address (gdb_byte *buf, struct type *type,
 995                                  CORE_ADDR addr);
 996
 997 \f
 998 /* From valops.c */
 999
1000 extern int watchdog;
1001
1002 /* Hooks for alternate command interfaces.  */
1003
1004 /* The name of the interpreter if specified on the command line.  */
1005 extern char *interpreter_p;
1006
1007 /* If a given interpreter matches INTERPRETER_P then it should update
1008    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1009    per-interpreter implementation.  */
1010 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1011    should be moved here.  */
1012
1013 struct target_waitstatus;
1014 struct cmd_list_element;
1015
1016 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1017 extern void (*deprecated_post_add_symbol_hook) (void);
1018 extern void (*selected_frame_level_changed_hook) (int);
1019 extern int (*deprecated_ui_loop_hook) (int signo);
1020 extern void (*deprecated_init_ui_hook) (char *argv0);
1021 extern void (*deprecated_command_loop_hook) (void);
1022 extern void (*deprecated_show_load_progress) (const char *section,
1023                                               unsigned long section_sent,
1024                                               unsigned long section_size,
1025                                               unsigned long total_sent,
1026                                               unsigned long total_size);
1027 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1028                                                          int line,
1029                                                          int stopline,
1030                                                          int noerror);
1031 extern int (*deprecated_query_hook) (const char *, va_list)
1032      ATTRIBUTE_FPTR_PRINTF(1,0);
1033 extern void (*deprecated_warning_hook) (const char *, va_list)
1034      ATTRIBUTE_FPTR_PRINTF(1,0);
1035 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1036 extern void (*deprecated_interactive_hook) (void);
1037 extern void (*deprecated_readline_begin_hook) (char *, ...)
1038      ATTRIBUTE_FPTR_PRINTF_1;
1039 extern char *(*deprecated_readline_hook) (char *);
1040 extern void (*deprecated_readline_end_hook) (void);
1041 extern void (*deprecated_register_changed_hook) (int regno);
1042 extern void (*deprecated_context_hook) (int);
1043 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1044                                               struct target_waitstatus *status,
1045                                               int options);
1046
1047 extern void (*deprecated_attach_hook) (void);
1048 extern void (*deprecated_detach_hook) (void);
1049 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1050                                              char *cmd, int from_tty);
1051
1052 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1053
1054 extern void (*deprecated_error_begin_hook) (void);
1055
1056 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1057                                                 unsigned long num);
1058
1059
1060 /* Inhibit window interface if non-zero.  */
1061
1062 extern int use_windows;
1063
1064 /* Definitions of filename-related things.  */
1065
1066 /* Host specific things.  */
1067
1068 #ifdef __MSDOS__
1069 # define CANT_FORK
1070 # define GLOBAL_CURDIR
1071 # define DIRNAME_SEPARATOR ';'
1072 #endif
1073
1074 #if !defined (__CYGWIN__) && defined (_WIN32)
1075 # define DIRNAME_SEPARATOR ';'
1076 #endif
1077
1078 #ifndef DIRNAME_SEPARATOR
1079 #define DIRNAME_SEPARATOR ':'
1080 #endif
1081
1082 #ifndef SLASH_STRING
1083 #define SLASH_STRING "/"
1084 #endif
1085
1086 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1087    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1088    in the code actually refer to a lightweight process id, i.e,
1089    something that can be considered a process id in its own right for
1090    certain purposes.  */
1091
1092 #ifndef PIDGET
1093 #define PIDGET(PTID) (ptid_get_pid (PTID))
1094 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1095 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1096 #endif
1097
1098 /* Define well known filenos if the system does not define them.  */
1099 #ifndef STDIN_FILENO
1100 #define STDIN_FILENO   0
1101 #endif
1102 #ifndef STDOUT_FILENO
1103 #define STDOUT_FILENO  1
1104 #endif
1105 #ifndef STDERR_FILENO
1106 #define STDERR_FILENO  2
1107 #endif
1108
1109 /* If this definition isn't overridden by the header files, assume
1110    that isatty and fileno exist on this system.  */
1111 #ifndef ISATTY
1112 #define ISATTY(FP)      (isatty (fileno (FP)))
1113 #endif
1114
1115 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1116    power of 2).  Round up/down when necessary.  Examples of correct
1117    use include:
1118
1119    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1120    write_memory (addr, value, len);
1121    addr += len;
1122
1123    and:
1124
1125    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1126    write_memory (sp, value, len);
1127
1128    Note that uses such as:
1129
1130    write_memory (addr, value, len);
1131    addr += align_up (len, 8);
1132
1133    and:
1134
1135    sp -= align_up (len, 8);
1136    write_memory (sp, value, len);
1137
1138    are typically not correct as they don't ensure that the address (SP
1139    or ADDR) is correctly aligned (relying on previous alignment to
1140    keep things right).  This is also why the methods are called
1141    "align_..." instead of "round_..." as the latter reads better with
1142    this incorrect coding style.  */
1143
1144 extern ULONGEST align_up (ULONGEST v, int n);
1145 extern ULONGEST align_down (ULONGEST v, int n);
1146
1147 /* Allocation and deallocation functions for the libiberty hash table
1148    which use obstacks.  */
1149 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
1150 void dummy_obstack_deallocate (void *object, void *data);
1151
1152 /* From progspace.c */
1153
1154 extern void initialize_progspace (void);
1155 extern void initialize_inferiors (void);
1156
1157 /* Special block numbers */
1158
1159 enum block_enum
1160 {
1161   GLOBAL_BLOCK = 0,
1162   STATIC_BLOCK = 1,
1163   FIRST_LOCAL_BLOCK = 2
1164 };
1165
1166 #endif /* #ifndef DEFS_H */