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