gdb/defs.h

   1 /* *INDENT-OFF* */ /* ATTR_FORMAT confuses indent, avoid running it for now */
   2 /* Basic, host-specific, and target-specific definitions for GDB.
   3    Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
   4    1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008
   5    Free Software Foundation, Inc.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 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 #include "config.h"             /* Generated by configure.  */
  26
  27 #include <sys/types.h>
  28 #include <stdio.h>
  29 #include <errno.h>              /* System call error return status.  */
  30 #include <limits.h>
  31
  32 #ifdef HAVE_STDDEF_H
  33 #include <stddef.h>
  34 #endif
  35
  36 #ifdef HAVE_UNISTD_H
  37 #include <unistd.h>
  38 #endif
  39
  40 #include <fcntl.h>
  41
  42 /* First include ansidecl.h so we can use the various macro definitions
  43    here and in all subsequent file inclusions.  */
  44
  45 #include "ansidecl.h"
  46
  47 #include "gdb_locale.h"
  48
  49 /* For ``enum target_signal''.  */
  50 #include "gdb/signals.h"
  51
  52 /* Just in case they're not defined in stdio.h.  */
  53
  54 #ifndef SEEK_SET
  55 #define SEEK_SET 0
  56 #endif
  57 #ifndef SEEK_CUR
  58 #define SEEK_CUR 1
  59 #endif
  60
  61 /* The O_BINARY flag is defined in fcntl.h on some non-Posix platforms.
  62    It is used as an access modifier in calls to open(), where it acts
  63    similarly to the "b" character in fopen()'s MODE argument. On Posix
  64    platforms it should be a no-op, so it is defined as 0 here. This
  65    ensures that the symbol may be used freely elsewhere in gdb. */
  66
  67 #ifndef O_BINARY
  68 #define O_BINARY 0
  69 #endif
  70
  71 #include <stdarg.h>             /* For va_list.  */
  72
  73 #include "libiberty.h"
  74
  75 /* Rather than duplicate all the logic in BFD for figuring out what
  76    types to use (which can be pretty complicated), symply define them
  77    in terms of the corresponding type from BFD.  */
  78
  79 #include "bfd.h"
  80
  81 /* A byte from the program being debugged.  */
  82 typedef bfd_byte gdb_byte;
  83
  84 /* An address in the program being debugged.  Host byte order.  */
  85 typedef bfd_vma CORE_ADDR;
  86
  87 /* The largest CORE_ADDR value.  */
  88 #define CORE_ADDR_MAX (~ (CORE_ADDR) 0)
  89
  90 /* This is to make sure that LONGEST is at least as big as CORE_ADDR.  */
  91
  92 #ifndef LONGEST
  93
  94 #ifdef BFD64
  95
  96 #define LONGEST BFD_HOST_64_BIT
  97 #define ULONGEST BFD_HOST_U_64_BIT
  98
  99 #else /* No BFD64 */
 100
 101 #ifdef CC_HAS_LONG_LONG
 102 #define LONGEST long long
 103 #define ULONGEST unsigned long long
 104 #else
 105 #ifdef BFD_HOST_64_BIT
 106 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
 107    (e.g. i386-windows) so try it.  */
 108 #define LONGEST BFD_HOST_64_BIT
 109 #define ULONGEST BFD_HOST_U_64_BIT
 110 #else
 111 #define LONGEST long
 112 #define ULONGEST unsigned long
 113 #endif
 114 #endif
 115
 116 #endif /* No BFD64 */
 117
 118 #endif /* ! LONGEST */
 119
 120 #ifndef min
 121 #define min(a, b) ((a) < (b) ? (a) : (b))
 122 #endif
 123 #ifndef max
 124 #define max(a, b) ((a) > (b) ? (a) : (b))
 125 #endif
 126
 127 /* Check if a character is one of the commonly used C++ marker characters.  */
 128 extern int is_cplus_marker (int);
 129
 130 /* enable xdb commands if set */
 131 extern int xdb_commands;
 132
 133 /* enable dbx commands if set */
 134 extern int dbx_commands;
 135
 136 /* System root path, used to find libraries etc.  */
 137 extern char *gdb_sysroot;
 138
 139 /* Search path for separate debug files.  */
 140 extern char *debug_file_directory;
 141
 142 extern int quit_flag;
 143 extern int immediate_quit;
 144 extern int sevenbit_strings;
 145
 146 extern void quit (void);
 147
 148 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
 149    benefits of having a ``QUIT'' macro rather than a function are
 150    marginal.  If the overhead of a QUIT function call is proving
 151    significant then its calling frequency should probably be reduced
 152    [kingdon].  A profile analyzing the current situtation is
 153    needed. */
 154
 155 #ifdef QUIT
 156 /* do twice to force compiler warning */
 157 #define QUIT_FIXME "FIXME"
 158 #define QUIT_FIXME "ignoring redefinition of QUIT"
 159 #else
 160 #define QUIT { \
 161   if (quit_flag) quit (); \
 162   if (deprecated_interactive_hook) deprecated_interactive_hook (); \
 163 }
 164 #endif
 165
 166 /* Languages represented in the symbol table and elsewhere.
 167    This should probably be in language.h, but since enum's can't
 168    be forward declared to satisfy opaque references before their
 169    actual definition, needs to be here. */
 170
 171 enum language
 172   {
 173     language_unknown,           /* Language not known */
 174     language_auto,              /* Placeholder for automatic setting */
 175     language_c,                 /* C */
 176     language_cplus,             /* C++ */
 177     language_objc,              /* Objective-C */
 178     language_java,              /* Java */
 179     language_fortran,           /* Fortran */
 180     language_m2,                /* Modula-2 */
 181     language_asm,               /* Assembly language */
 182     language_pascal,            /* Pascal */
 183     language_ada,               /* Ada */
 184     language_scm,               /* Guile Scheme */
 185     language_minimal,           /* All other languages, minimal support only */
 186     nr_languages
 187   };
 188
 189 enum precision_type
 190   {
 191     single_precision,
 192     double_precision,
 193     unspecified_precision
 194   };
 195
 196 /* A generic, not quite boolean, enumeration.  */
 197 enum auto_boolean
 198 {
 199   AUTO_BOOLEAN_TRUE,
 200   AUTO_BOOLEAN_FALSE,
 201   AUTO_BOOLEAN_AUTO
 202 };
 203
 204 /* Potential ways that a function can return a value of a given type.  */
 205 enum return_value_convention
 206 {
 207   /* Where the return value has been squeezed into one or more
 208      registers.  */
 209   RETURN_VALUE_REGISTER_CONVENTION,
 210   /* Commonly known as the "struct return convention".  The caller
 211      passes an additional hidden first parameter to the caller.  That
 212      parameter contains the address at which the value being returned
 213      should be stored.  While typically, and historically, used for
 214      large structs, this is convention is applied to values of many
 215      different types.  */
 216   RETURN_VALUE_STRUCT_CONVENTION,
 217   /* Like the "struct return convention" above, but where the ABI
 218      guarantees that the called function stores the address at which
 219      the value being returned is stored in a well-defined location,
 220      such as a register or memory slot in the stack frame.  Don't use
 221      this if the ABI doesn't explicitly guarantees this.  */
 222   RETURN_VALUE_ABI_RETURNS_ADDRESS,
 223   /* Like the "struct return convention" above, but where the ABI
 224      guarantees that the address at which the value being returned is
 225      stored will be available in a well-defined location, such as a
 226      register or memory slot in the stack frame.  Don't use this if
 227      the ABI doesn't explicitly guarantees this.  */
 228   RETURN_VALUE_ABI_PRESERVES_ADDRESS,
 229 };
 230
 231 /* the cleanup list records things that have to be undone
 232    if an error happens (descriptors to be closed, memory to be freed, etc.)
 233    Each link in the chain records a function to call and an
 234    argument to give it.
 235
 236    Use make_cleanup to add an element to the cleanup chain.
 237    Use do_cleanups to do all cleanup actions back to a given
 238    point in the chain.  Use discard_cleanups to remove cleanups
 239    from the chain back to a given point, not doing them.  */
 240
 241 struct cleanup
 242   {
 243     struct cleanup *next;
 244     void (*function) (void *);
 245     void *arg;
 246   };
 247
 248
 249 /* The ability to declare that a function never returns is useful, but
 250    not really required to compile GDB successfully, so the NORETURN and
 251    ATTR_NORETURN macros normally expand into nothing.  */
 252
 253 /* If compiling with older versions of GCC, a function may be declared
 254    "volatile" to indicate that it does not return.  */
 255
 256 #ifndef NORETURN
 257 #if defined(__GNUC__) \
 258      && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
 259 #define NORETURN volatile
 260 #else
 261 #define NORETURN                /* nothing */
 262 #endif
 263 #endif
 264
 265 /* GCC 2.5 and later versions define a function attribute "noreturn",
 266    which is the preferred way to declare that a function never returns.
 267    However GCC 2.7 appears to be the first version in which this fully
 268    works everywhere we use it. */
 269
 270 #ifndef ATTR_NORETURN
 271 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
 272 #define ATTR_NORETURN __attribute__ ((noreturn))
 273 #else
 274 #define ATTR_NORETURN           /* nothing */
 275 #endif
 276 #endif
 277
 278 #ifndef ATTR_FORMAT
 279 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
 280 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
 281 #else
 282 #define ATTR_FORMAT(type, x, y) /* nothing */
 283 #endif
 284 #endif
 285
 286 /* Be conservative and use enum bitfields only with GCC.
 287    This is copied from gcc 3.3.1, system.h.  */
 288
 289 #if defined(__GNUC__) && (__GNUC__ >= 2)
 290 #define ENUM_BITFIELD(TYPE) enum TYPE
 291 #else
 292 #define ENUM_BITFIELD(TYPE) unsigned int
 293 #endif
 294
 295 /* Needed for various prototypes */
 296
 297 struct symtab;
 298 struct breakpoint;
 299 struct frame_info;
 300
 301 /* From utils.c */
 302
 303 extern void initialize_utils (void);
 304
 305 extern void notice_quit (void);
 306
 307 extern int strcmp_iw (const char *, const char *);
 308
 309 extern int strcmp_iw_ordered (const char *, const char *);
 310
 311 extern int streq (const char *, const char *);
 312
 313 extern int subset_compare (char *, char *);
 314
 315 extern char *safe_strerror (int);
 316
 317 #define ALL_CLEANUPS    ((struct cleanup *)0)
 318
 319 extern void do_cleanups (struct cleanup *);
 320 extern void do_final_cleanups (struct cleanup *);
 321 extern void do_exec_cleanups (struct cleanup *);
 322
 323 extern void discard_cleanups (struct cleanup *);
 324 extern void discard_final_cleanups (struct cleanup *);
 325 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
 326
 327 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
 328    make_cleanup function declarations below. Do not use this typedef
 329    as a cast when passing functions into the make_cleanup() code.
 330    Instead either use a bounce function or add a wrapper function.
 331    Calling a f(char*) function with f(void*) is non-portable. */
 332 typedef void (make_cleanup_ftype) (void *);
 333
 334 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
 335
 336 extern struct cleanup *make_cleanup_freeargv (char **);
 337
 338 struct ui_file;
 339 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
 340
 341 struct section_addr_info;
 342 extern struct cleanup *(make_cleanup_free_section_addr_info
 343                         (struct section_addr_info *));
 344
 345 extern struct cleanup *make_cleanup_close (int fd);
 346
 347 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
 348
 349 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
 350
 351 extern struct cleanup *make_my_cleanup (struct cleanup **,
 352                                         make_cleanup_ftype *, void *);
 353
 354 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
 355
 356 extern struct cleanup *save_cleanups (void);
 357 extern struct cleanup *save_final_cleanups (void);
 358 extern struct cleanup *save_my_cleanups (struct cleanup **);
 359
 360 extern void restore_cleanups (struct cleanup *);
 361 extern void restore_final_cleanups (struct cleanup *);
 362 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
 363
 364 extern void free_current_contents (void *);
 365
 366 extern void null_cleanup (void *);
 367
 368 extern int myread (int, char *, int);
 369
 370 extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 371 extern int nquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 372 extern int yquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 373
 374 extern void init_page_info (void);
 375
 376 extern char *gdb_realpath (const char *);
 377 extern char *xfullpath (const char *);
 378
 379 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
 380                                           unsigned char *buf, size_t len);
 381
 382 ULONGEST strtoulst (const char *num, const char **trailer, int base);
 383
 384 char *ldirname (const char *filename);
 385
 386 /* From demangle.c */
 387
 388 extern void set_demangling_style (char *);
 389
 390 \f
 391 /* Annotation stuff.  */
 392
 393 extern int annotation_level;    /* in stack.c */
 394 \f
 395 extern void begin_line (void);
 396
 397 extern void wrap_here (char *);
 398
 399 extern void reinitialize_more_filter (void);
 400
 401 /* Normal results */
 402 extern struct ui_file *gdb_stdout;
 403 /* Input stream */
 404 extern struct ui_file *gdb_stdin;
 405 /* Serious error notifications */
 406 extern struct ui_file *gdb_stderr;
 407 /* Log/debug/trace messages that should bypass normal stdout/stderr
 408    filtering.  For moment, always call this stream using
 409    *_unfiltered. In the very near future that restriction shall be
 410    removed - either call shall be unfiltered. (cagney 1999-06-13). */
 411 extern struct ui_file *gdb_stdlog;
 412 /* Target output that should bypass normal stdout/stderr filtering.
 413    For moment, always call this stream using *_unfiltered. In the
 414    very near future that restriction shall be removed - either call
 415    shall be unfiltered. (cagney 1999-07-02). */
 416 extern struct ui_file *gdb_stdtarg;
 417 extern struct ui_file *gdb_stdtargerr;
 418 extern struct ui_file *gdb_stdtargin;
 419
 420 #include "ui-file.h"
 421
 422 /* More generic printf like operations.  Filtered versions may return
 423    non-locally on error.  */
 424
 425 extern void fputs_filtered (const char *, struct ui_file *);
 426
 427 extern void fputs_unfiltered (const char *, struct ui_file *);
 428
 429 extern int fputc_filtered (int c, struct ui_file *);
 430
 431 extern int fputc_unfiltered (int c, struct ui_file *);
 432
 433 extern int putchar_filtered (int c);
 434
 435 extern int putchar_unfiltered (int c);
 436
 437 extern void puts_filtered (const char *);
 438
 439 extern void puts_unfiltered (const char *);
 440
 441 extern void puts_filtered_tabular (char *string, int width, int right);
 442
 443 extern void puts_debug (char *prefix, char *string, char *suffix);
 444
 445 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 446
 447 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 448
 449 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 450
 451 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
 452
 453 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 454
 455 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 456
 457 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
 458
 459 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
 460
 461 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
 462
 463 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 464
 465 extern void print_spaces (int, struct ui_file *);
 466
 467 extern void print_spaces_filtered (int, struct ui_file *);
 468
 469 extern char *n_spaces (int);
 470
 471 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
 472
 473 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
 474
 475 extern void fputstrn_filtered (const char *str, int n, int quotr, struct ui_file * stream);
 476
 477 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
 478
 479 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
 480 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
 481
 482 /* Convert a CORE_ADDR into a HEX string.  paddr() is like %08lx.
 483    paddr_nz() is like %lx.  paddr_u() is like %lu. paddr_width() is
 484    for ``%*''. */
 485 extern int strlen_paddr (void);
 486 extern char *paddr (CORE_ADDR addr);
 487 extern char *paddr_nz (CORE_ADDR addr);
 488 extern char *paddr_u (CORE_ADDR addr);
 489 extern char *paddr_d (LONGEST addr);
 490
 491 /* Like 0x%lx, replaces deprecated_print_address_numeric.  */
 492 extern const char *paddress (CORE_ADDR addr);
 493
 494 extern char *phex (ULONGEST l, int sizeof_l);
 495 extern char *phex_nz (ULONGEST l, int sizeof_l);
 496 extern char *int_string (LONGEST, int, int, int, int);
 497
 498 /* Like paddr() only print/scan raw CORE_ADDR.  The output from
 499    core_addr_to_string() can be passed direct to
 500    string_to_core_addr().  */
 501 extern const char *core_addr_to_string (const CORE_ADDR addr);
 502 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
 503 extern CORE_ADDR string_to_core_addr (const char *my_string);
 504
 505 /* Return a string that contains a number formatted as a hex
 506    string.  */
 507 extern char *hex_string (LONGEST);
 508 extern char *hex_string_custom (LONGEST, int);
 509
 510 extern void fprintf_symbol_filtered (struct ui_file *, char *,
 511                                      enum language, int);
 512
 513 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
 514
 515 extern void print_sys_errmsg (const char *, int);
 516
 517 /* From regex.c or libc.  BSD 4.4 declares this with the argument type as
 518    "const char *" in unistd.h, so we can't declare the argument
 519    as "char *".  */
 520
 521 extern char *re_comp (const char *);
 522
 523 /* From symfile.c */
 524
 525 extern void symbol_file_command (char *, int);
 526
 527 /* Remote targets may wish to use this as their load function.  */
 528 extern void generic_load (char *name, int from_tty);
 529
 530 /* Report on STREAM the performance of memory transfer operation,
 531    such as 'load'.
 532    DATA_COUNT is the number of bytes transferred.
 533    WRITE_COUNT is the number of separate write operations, or 0,
 534    if that information is not available.
 535    START_TIME is the time at which an operation was started.
 536    END_TIME is the time at which an operation ended.  */
 537 struct timeval;
 538 extern void print_transfer_performance (struct ui_file *stream,
 539                                         unsigned long data_count,
 540                                         unsigned long write_count,
 541                                         const struct timeval *start_time,
 542                                         const struct timeval *end_time);
 543
 544 /* From top.c */
 545
 546 typedef void initialize_file_ftype (void);
 547
 548 extern char *skip_quoted (char *);
 549
 550 extern char *gdb_readline (char *);
 551
 552 extern char *gdb_readline_wrapper (char *);
 553
 554 extern char *command_line_input (char *, int, char *);
 555
 556 extern void print_prompt (void);
 557
 558 extern int input_from_terminal_p (void);
 559
 560 extern int info_verbose;
 561
 562 /* From printcmd.c */
 563
 564 extern void set_next_address (CORE_ADDR);
 565
 566 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
 567                                     char *);
 568
 569 extern int build_address_symbolic (CORE_ADDR addr,
 570                                    int do_demangle,
 571                                    char **name,
 572                                    int *offset,
 573                                    char **filename,
 574                                    int *line,
 575                                    int *unmapped);
 576
 577 extern void deprecated_print_address_numeric (CORE_ADDR, int, struct ui_file *);
 578
 579 extern void print_address (CORE_ADDR, struct ui_file *);
 580
 581 /* From source.c */
 582
 583 #define OPF_TRY_CWD_FIRST     0x01
 584 #define OPF_SEARCH_IN_PATH    0x02
 585
 586 extern int openp (const char *, int, const char *, int, int, char **);
 587
 588 extern int source_full_path_of (char *, char **);
 589
 590 extern void mod_path (char *, char **);
 591
 592 extern void add_path (char *, char **, int);
 593
 594 extern void directory_command (char *, int);
 595
 596 extern void directory_switch (char *, int);
 597
 598 extern char *source_path;
 599
 600 extern void init_source_path (void);
 601
 602 extern void init_last_source_visited (void);
 603
 604 /* From exec.c */
 605
 606 /* Take over the 'find_mapped_memory' vector from exec.c. */
 607 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
 608                                                             unsigned long,
 609                                                             int, int, int,
 610                                                             void *),
 611                                                    void *));
 612
 613 /* Possible lvalue types.  Like enum language, this should be in
 614    value.h, but needs to be here for the same reason. */
 615
 616 enum lval_type
 617   {
 618     /* Not an lval. */
 619     not_lval,
 620     /* In memory.  */
 621     lval_memory,
 622     /* In a register.  Registers are relative to a frame.  */
 623     lval_register,
 624     /* In a gdb internal variable.  */
 625     lval_internalvar,
 626     /* Part of a gdb internal variable (structure field).  */
 627     lval_internalvar_component
 628   };
 629
 630 /* Control types for commands */
 631
 632 enum misc_command_type
 633   {
 634     ok_command,
 635     end_command,
 636     else_command,
 637     nop_command
 638   };
 639
 640 enum command_control_type
 641   {
 642     simple_control,
 643     break_control,
 644     continue_control,
 645     while_control,
 646     if_control,
 647     commands_control,
 648     invalid_control
 649   };
 650
 651 /* Structure for saved commands lines
 652    (for breakpoints, defined commands, etc).  */
 653
 654 struct command_line
 655   {
 656     struct command_line *next;
 657     char *line;
 658     enum command_control_type control_type;
 659     int body_count;
 660     struct command_line **body_list;
 661   };
 662
 663 extern struct command_line *read_command_lines (char *, int);
 664
 665 extern void free_command_lines (struct command_line **);
 666
 667 /* To continue the execution commands when running gdb asynchronously.
 668    A continuation structure contains a pointer to a function to be called
 669    to finish the command, once the target has stopped. Such mechanism is
 670    used by the finish and until commands, and in the remote protocol
 671    when opening an extended-remote connection. */
 672
 673 struct continuation_arg
 674   {
 675     struct continuation_arg *next;
 676     union continuation_data {
 677       void *pointer;
 678       int   integer;
 679       long  longint;
 680     } data;
 681   };
 682
 683 struct continuation
 684   {
 685     void (*continuation_hook) (struct continuation_arg *);
 686     struct continuation_arg *arg_list;
 687     struct continuation *next;
 688   };
 689
 690 /* In infrun.c. */
 691 extern struct continuation *cmd_continuation;
 692 /* Used only by the step_1 function. */
 693 extern struct continuation *intermediate_continuation;
 694
 695 /* From utils.c */
 696 extern void add_continuation (void (*)(struct continuation_arg *),
 697                               struct continuation_arg *);
 698 extern void do_all_continuations (void);
 699 extern void discard_all_continuations (void);
 700
 701 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
 702                               struct continuation_arg *);
 703 extern void do_all_intermediate_continuations (void);
 704 extern void discard_all_intermediate_continuations (void);
 705
 706 /* String containing the current directory (what getwd would return).  */
 707
 708 extern char *current_directory;
 709
 710 /* Default radixes for input and output.  Only some values supported.  */
 711 extern unsigned input_radix;
 712 extern unsigned output_radix;
 713
 714 /* Possibilities for prettyprint parameters to routines which print
 715    things.  Like enum language, this should be in value.h, but needs
 716    to be here for the same reason.  FIXME:  If we can eliminate this
 717    as an arg to LA_VAL_PRINT, then we can probably move it back to
 718    value.h. */
 719
 720 enum val_prettyprint
 721   {
 722     Val_no_prettyprint = 0,
 723     Val_prettyprint,
 724     /* Use the default setting which the user has specified.  */
 725     Val_pretty_default
 726   };
 727
 728 /* The ptid struct is a collection of the various "ids" necessary
 729    for identifying the inferior.  This consists of the process id
 730    (pid), thread id (tid), and other fields necessary for uniquely
 731    identifying the inferior process/thread being debugged.  When
 732    manipulating ptids, the constructors, accessors, and predicate
 733    declared in inferior.h should be used.  These are as follows:
 734
 735       ptid_build        - Make a new ptid from a pid, lwp, and tid.
 736       pid_to_ptid       - Make a new ptid from just a pid.
 737       ptid_get_pid      - Fetch the pid component of a ptid.
 738       ptid_get_lwp      - Fetch the lwp component of a ptid.
 739       ptid_get_tid      - Fetch the tid component of a ptid.
 740       ptid_equal        - Test to see if two ptids are equal.
 741
 742    Please do NOT access the struct ptid members directly (except, of
 743    course, in the implementation of the above ptid manipulation
 744    functions).  */
 745
 746 struct ptid
 747   {
 748     /* Process id */
 749     int pid;
 750
 751     /* Lightweight process id */
 752     long lwp;
 753
 754     /* Thread id */
 755     long tid;
 756   };
 757
 758 typedef struct ptid ptid_t;
 759
 760 \f
 761
 762 /* Optional native machine support.  Non-native (and possibly pure
 763    multi-arch) targets do not need a "nm.h" file.  This will be a
 764    symlink to one of the nm-*.h files, built by the `configure'
 765    script.  */
 766
 767 #ifdef GDB_NM_FILE
 768 #include "nm.h"
 769 #endif
 770
 771 /* Assume that fopen accepts the letter "b" in the mode string.
 772    It is demanded by ISO C9X, and should be supported on all
 773    platforms that claim to have a standard-conforming C library.  On
 774    true POSIX systems it will be ignored and have no effect.  There
 775    may still be systems without a standard-conforming C library where
 776    an ISO C9X compiler (GCC) is available.  Known examples are SunOS
 777    4.x and 4.3BSD.  This assumption means these systems are no longer
 778    supported.  */
 779 #ifndef FOPEN_RB
 780 # include "fopen-bin.h"
 781 #endif
 782
 783 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
 784    FIXME: Assumes 2's complement arithmetic */
 785
 786 #if !defined (UINT_MAX)
 787 #define UINT_MAX ((unsigned int)(~0))   /* 0xFFFFFFFF for 32-bits */
 788 #endif
 789
 790 #if !defined (INT_MAX)
 791 #define INT_MAX ((int)(UINT_MAX >> 1))  /* 0x7FFFFFFF for 32-bits */
 792 #endif
 793
 794 #if !defined (INT_MIN)
 795 #define INT_MIN ((int)((int) ~0 ^ INT_MAX))     /* 0x80000000 for 32-bits */
 796 #endif
 797
 798 #if !defined (ULONG_MAX)
 799 #define ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
 800 #endif
 801
 802 #if !defined (LONG_MAX)
 803 #define LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 804 #endif
 805
 806 #if !defined (ULONGEST_MAX)
 807 #define ULONGEST_MAX (~(ULONGEST)0)        /* 0xFFFFFFFFFFFFFFFF for 64-bits */
 808 #endif
 809
 810 #if !defined (LONGEST_MAX)                 /* 0x7FFFFFFFFFFFFFFF for 64-bits */
 811 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
 812 #endif
 813
 814 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
 815    arguments to a function, number in a value history, register number, etc.)
 816    where the value must not be larger than can fit in an int.  */
 817
 818 extern int longest_to_int (LONGEST);
 819
 820 /* Assorted functions we can declare, now that const and volatile are
 821    defined.  */
 822
 823 extern char *savestring (const char *, size_t);
 824
 825 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
 826    "libiberty.h". */
 827 extern void xfree (void *);
 828
 829 /* Like xmalloc, but zero the memory.  */
 830 extern void *xzalloc (size_t);
 831
 832 /* Utility macros to allocate typed memory.  Avoids errors like:
 833    struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
 834    sizeof (struct foo), 0).  */
 835 #define XZALLOC(TYPE) ((TYPE*) xzalloc (sizeof (TYPE)))
 836 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
 837 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
 838
 839 /* Like asprintf/vasprintf but get an internal_error if the call
 840    fails. */
 841 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
 842 extern void xvasprintf (char **ret, const char *format, va_list ap)
 843      ATTR_FORMAT (printf, 2, 0);
 844
 845 /* Like asprintf and vasprintf, but return the string, throw an error
 846    if no memory.  */
 847 extern char *xstrprintf (const char *format, ...) ATTR_FORMAT (printf, 1, 2);
 848 extern char *xstrvprintf (const char *format, va_list ap)
 849      ATTR_FORMAT (printf, 1, 0);
 850
 851 /* Like snprintf, but throw an error if the output buffer is too small.  */
 852 extern int xsnprintf (char *str, size_t size, const char *format, ...)
 853      ATTR_FORMAT (printf, 3, 4);
 854
 855 extern int parse_escape (char **);
 856
 857 /* Message to be printed before the error message, when an error occurs.  */
 858
 859 extern char *error_pre_print;
 860
 861 /* Message to be printed before the error message, when an error occurs.  */
 862
 863 extern char *quit_pre_print;
 864
 865 /* Message to be printed before the warning message, when a warning occurs.  */
 866
 867 extern char *warning_pre_print;
 868
 869 extern NORETURN void verror (const char *fmt, va_list ap)
 870      ATTR_NORETURN ATTR_FORMAT (printf, 1, 0);
 871
 872 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 873
 874 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
 875
 876 extern NORETURN void vfatal (const char *fmt, va_list ap)
 877      ATTR_NORETURN ATTR_FORMAT (printf, 1, 0);
 878
 879 extern NORETURN void fatal (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
 880
 881 extern NORETURN void internal_verror (const char *file, int line,
 882                                       const char *, va_list ap)
 883      ATTR_NORETURN ATTR_FORMAT (printf, 3, 0);
 884
 885 extern NORETURN void internal_error (const char *file, int line,
 886                                      const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
 887
 888 extern void internal_vwarning (const char *file, int line,
 889                                const char *, va_list ap)
 890      ATTR_FORMAT (printf, 3, 0);
 891
 892 extern void internal_warning (const char *file, int line,
 893                               const char *, ...) ATTR_FORMAT (printf, 3, 4);
 894
 895 extern NORETURN void nomem (long) ATTR_NORETURN;
 896
 897 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
 898
 899 extern void vwarning (const char *, va_list args) ATTR_FORMAT (printf, 1, 0);
 900
 901 /* List of known OS ABIs.  If you change this, make sure to update the
 902    table in osabi.c.  */
 903 enum gdb_osabi
 904 {
 905   GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info.  */
 906
 907   GDB_OSABI_UNKNOWN = 0,        /* keep this zero */
 908
 909   GDB_OSABI_SVR4,
 910   GDB_OSABI_HURD,
 911   GDB_OSABI_SOLARIS,
 912   GDB_OSABI_OSF1,
 913   GDB_OSABI_LINUX,
 914   GDB_OSABI_FREEBSD_AOUT,
 915   GDB_OSABI_FREEBSD_ELF,
 916   GDB_OSABI_NETBSD_AOUT,
 917   GDB_OSABI_NETBSD_ELF,
 918   GDB_OSABI_OPENBSD_ELF,
 919   GDB_OSABI_WINCE,
 920   GDB_OSABI_GO32,
 921   GDB_OSABI_IRIX,
 922   GDB_OSABI_INTERIX,
 923   GDB_OSABI_HPUX_ELF,
 924   GDB_OSABI_HPUX_SOM,
 925
 926   GDB_OSABI_QNXNTO,
 927
 928   GDB_OSABI_CYGWIN,
 929   GDB_OSABI_AIX,
 930
 931   GDB_OSABI_INVALID             /* keep this last */
 932 };
 933
 934 /* Global functions from other, non-gdb GNU thingies.
 935    Libiberty thingies are no longer declared here.  We include libiberty.h
 936    above, instead.  */
 937
 938 /* From other system libraries */
 939
 940 #ifdef HAVE_STDDEF_H
 941 #include <stddef.h>
 942 #endif
 943
 944 #ifdef HAVE_STDLIB_H
 945 #include <stdlib.h>
 946 #endif
 947 #ifndef min
 948 #define min(a, b) ((a) < (b) ? (a) : (b))
 949 #endif
 950 #ifndef max
 951 #define max(a, b) ((a) > (b) ? (a) : (b))
 952 #endif
 953
 954
 955 #ifndef atof
 956 extern double atof (const char *);      /* X3.159-1989  4.10.1.1 */
 957 #endif
 958
 959 /* Various possibilities for alloca.  */
 960 #ifndef alloca
 961 #ifdef __GNUC__
 962 #define alloca __builtin_alloca
 963 #else /* Not GNU C */
 964 #ifdef HAVE_ALLOCA_H
 965 #include <alloca.h>
 966 #else
 967 #ifdef _AIX
 968 #pragma alloca
 969 #else
 970
 971 /* We need to be careful not to declare this in a way which conflicts with
 972    bison.  Bison never declares it as char *, but under various circumstances
 973    (like __hpux) we need to use void *.  */
 974 extern void *alloca ();
 975 #endif /* Not _AIX */
 976 #endif /* Not HAVE_ALLOCA_H */
 977 #endif /* Not GNU C */
 978 #endif /* alloca not defined */
 979
 980 /* Dynamic target-system-dependent parameters for GDB. */
 981 #include "gdbarch.h"
 982
 983 /* Maximum size of a register.  Something small, but large enough for
 984    all known ISAs.  If it turns out to be too small, make it bigger.  */
 985
 986 enum { MAX_REGISTER_SIZE = 16 };
 987
 988 /* Static target-system-dependent parameters for GDB. */
 989
 990 /* Number of bits in a char or unsigned char for the target machine.
 991    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
 992 #if !defined (TARGET_CHAR_BIT)
 993 #define TARGET_CHAR_BIT 8
 994 #endif
 995
 996 /* If we picked up a copy of CHAR_BIT from a configuration file
 997    (which may get it by including <limits.h>) then use it to set
 998    the number of bits in a host char.  If not, use the same size
 999    as the target. */
1000
1001 #if defined (CHAR_BIT)
1002 #define HOST_CHAR_BIT CHAR_BIT
1003 #else
1004 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1005 #endif
1006
1007 /* In findvar.c.  */
1008
1009 extern LONGEST extract_signed_integer (const gdb_byte *, int);
1010
1011 extern ULONGEST extract_unsigned_integer (const gdb_byte *, int);
1012
1013 extern int extract_long_unsigned_integer (const gdb_byte *, int, LONGEST *);
1014
1015 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
1016                                         struct type *type);
1017
1018 extern void store_signed_integer (gdb_byte *, int, LONGEST);
1019
1020 extern void store_unsigned_integer (gdb_byte *, int, ULONGEST);
1021
1022 extern void store_typed_address (gdb_byte *buf, struct type *type,
1023                                  CORE_ADDR addr);
1024
1025 \f
1026 /* From valops.c */
1027
1028 extern int watchdog;
1029
1030 /* Hooks for alternate command interfaces.  */
1031
1032 /* The name of the interpreter if specified on the command line. */
1033 extern char *interpreter_p;
1034
1035 /* If a given interpreter matches INTERPRETER_P then it should update
1036    deprecated_command_loop_hook and deprecated_init_ui_hook with the
1037    per-interpreter implementation.  */
1038 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1039    should be moved here. */
1040
1041 struct target_waitstatus;
1042 struct cmd_list_element;
1043
1044 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1045 extern void (*deprecated_post_add_symbol_hook) (void);
1046 extern void (*selected_frame_level_changed_hook) (int);
1047 extern int (*deprecated_ui_loop_hook) (int signo);
1048 extern void (*deprecated_init_ui_hook) (char *argv0);
1049 extern void (*deprecated_command_loop_hook) (void);
1050 extern void (*deprecated_show_load_progress) (const char *section,
1051                                               unsigned long section_sent,
1052                                               unsigned long section_size,
1053                                               unsigned long total_sent,
1054                                               unsigned long total_size);
1055 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1056                                                          int line, int stopline,
1057                                                          int noerror);
1058 extern int (*deprecated_query_hook) (const char *, va_list)
1059      ATTRIBUTE_FPTR_PRINTF(1,0);
1060 extern void (*deprecated_warning_hook) (const char *, va_list)
1061      ATTRIBUTE_FPTR_PRINTF(1,0);
1062 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1063 extern void (*deprecated_create_breakpoint_hook) (struct breakpoint * b);
1064 extern void (*deprecated_delete_breakpoint_hook) (struct breakpoint * bpt);
1065 extern void (*deprecated_modify_breakpoint_hook) (struct breakpoint * bpt);
1066 extern void (*deprecated_interactive_hook) (void);
1067 extern void (*deprecated_readline_begin_hook) (char *, ...)
1068      ATTRIBUTE_FPTR_PRINTF_1;
1069 extern char *(*deprecated_readline_hook) (char *);
1070 extern void (*deprecated_readline_end_hook) (void);
1071 extern void (*deprecated_register_changed_hook) (int regno);
1072 extern void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
1073 extern void (*deprecated_context_hook) (int);
1074 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1075                                          struct target_waitstatus * status);
1076
1077 extern void (*deprecated_attach_hook) (void);
1078 extern void (*deprecated_detach_hook) (void);
1079 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1080                                              char *cmd, int from_tty);
1081
1082 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1083
1084 extern void (*deprecated_error_hook) (void);
1085
1086 extern void (*deprecated_error_begin_hook) (void);
1087
1088 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1089                                                 unsigned long num);
1090
1091
1092 /* Inhibit window interface if non-zero. */
1093
1094 extern int use_windows;
1095
1096 /* Symbolic definitions of filename-related things.  */
1097 /* FIXME, this doesn't work very well if host and executable
1098    filesystems conventions are different.  */
1099
1100 #ifdef __MSDOS__
1101 # define CANT_FORK
1102 # define GLOBAL_CURDIR
1103 # define DIRNAME_SEPARATOR ';'
1104 #endif
1105
1106 #if !defined (__CYGWIN__) && defined (_WIN32)
1107 # define DIRNAME_SEPARATOR ';'
1108 #endif
1109
1110 #ifndef DIRNAME_SEPARATOR
1111 #define DIRNAME_SEPARATOR ':'
1112 #endif
1113
1114 #ifndef SLASH_STRING
1115 #define SLASH_STRING "/"
1116 #endif
1117
1118 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1119    The name ``TIDGET'' is a historical accident.  Many uses of TIDGET
1120    in the code actually refer to a lightweight process id, i.e,
1121    something that can be considered a process id in its own right for
1122    certain purposes.  */
1123
1124 #ifndef PIDGET
1125 #define PIDGET(PTID) (ptid_get_pid (PTID))
1126 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1127 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1128 #endif
1129
1130 /* Define well known filenos if the system does not define them.  */
1131 #ifndef STDIN_FILENO
1132 #define STDIN_FILENO   0
1133 #endif
1134 #ifndef STDOUT_FILENO
1135 #define STDOUT_FILENO  1
1136 #endif
1137 #ifndef STDERR_FILENO
1138 #define STDERR_FILENO  2
1139 #endif
1140
1141 /* If this definition isn't overridden by the header files, assume
1142    that isatty and fileno exist on this system.  */
1143 #ifndef ISATTY
1144 #define ISATTY(FP)      (isatty (fileno (FP)))
1145 #endif
1146
1147 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1148    power of 2).  Round up/down when necessary.  Examples of correct
1149    use include:
1150
1151    addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1152    write_memory (addr, value, len);
1153    addr += len;
1154
1155    and:
1156
1157    sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1158    write_memory (sp, value, len);
1159
1160    Note that uses such as:
1161
1162    write_memory (addr, value, len);
1163    addr += align_up (len, 8);
1164
1165    and:
1166
1167    sp -= align_up (len, 8);
1168    write_memory (sp, value, len);
1169
1170    are typically not correct as they don't ensure that the address (SP
1171    or ADDR) is correctly aligned (relying on previous alignment to
1172    keep things right).  This is also why the methods are called
1173    "align_..." instead of "round_..." as the latter reads better with
1174    this incorrect coding style.  */
1175
1176 extern ULONGEST align_up (ULONGEST v, int n);
1177 extern ULONGEST align_down (ULONGEST v, int n);
1178
1179 /* Allocation and deallocation functions for the libiberty hash table
1180    which use obstacks.  */
1181 void *hashtab_obstack_allocate (void *data, size_t size, size_t count);
1182 void dummy_obstack_deallocate (void *object, void *data);
1183
1184 #endif /* #ifndef DEFS_H */