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