gdb/defs.h

   1 /* Basic, host-specific, and target-specific definitions for GDB.
   2    Copyright (C) 1986, 1989, 1991 Free Software Foundation, Inc.
   3
   4 This file is part of GDB.
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program; if not, write to the Free Software
  18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20 #if !defined (DEFS_H)
  21 #define DEFS_H 1
  22
  23 #include <stdio.h>
  24
  25 /* First include ansidecl.h so we can use the various macro definitions
  26    in all subsequent file inclusions.  FIXME:  This inclusion can now
  27    be removed from all files that include defs.h */
  28
  29 #include "ansidecl.h"
  30
  31 /* We could use the EXFUN macro in ansidecl.h to handle prototypes, but
  32    the name is misleading the the result is ugly.  So just define a simple
  33    macro to handle the parameter lists. */
  34
  35 #ifdef __STDC__
  36 #define PARAMS(paramlist) paramlist
  37 #else
  38 #define PARAMS(paramlist) ()
  39 #endif
  40
  41 /* An address in the program being debugged.  Host byte order.  */
  42 typedef unsigned int CORE_ADDR;
  43
  44 #define min(a, b) ((a) < (b) ? (a) : (b))
  45 #define max(a, b) ((a) > (b) ? (a) : (b))
  46
  47 /* The character C++ uses to build identifiers that must be unique from
  48    the program's identifiers (such as $this and $$vptr).  */
  49 #define CPLUS_MARKER '$'        /* May be overridden to '.' for SysV */
  50
  51 extern int errno;                       /* System call error return status */
  52
  53 extern int quit_flag;
  54 extern int immediate_quit;
  55
  56 extern void
  57 quit PARAMS ((void));
  58
  59 #define QUIT { if (quit_flag) quit (); }
  60
  61 /* Notes on classes: class_alias is for alias commands which are not
  62    abbreviations of the original command.  */
  63
  64 enum command_class
  65 {
  66   /* Special args to help_list */
  67   all_classes = -2, all_commands = -1,
  68   /* Classes of commands */
  69   no_class = -1, class_run = 0, class_vars, class_stack,
  70   class_files, class_support, class_info, class_breakpoint,
  71   class_alias, class_obscure, class_user
  72 };
  73
  74 /* the cleanup list records things that have to be undone
  75    if an error happens (descriptors to be closed, memory to be freed, etc.)
  76    Each link in the chain records a function to call and an
  77    argument to give it.
  78
  79    Use make_cleanup to add an element to the cleanup chain.
  80    Use do_cleanups to do all cleanup actions back to a given
  81    point in the chain.  Use discard_cleanups to remove cleanups
  82    from the chain back to a given point, not doing them.  */
  83
  84 struct cleanup
  85 {
  86   struct cleanup *next;
  87   void (*function) PARAMS ((PTR));
  88   PTR arg;
  89 };
  90
  91 /* From blockframe.c */
  92
  93 extern int
  94 inside_entry_scope PARAMS ((CORE_ADDR));
  95
  96 extern int
  97 outside_startup_file PARAMS ((CORE_ADDR addr));
  98
  99 extern int
 100 inside_main_scope PARAMS ((CORE_ADDR pc));
 101
 102 /* From cplus-dem.c */
 103
 104 extern char *
 105 cplus_demangle PARAMS ((const char *, int));
 106
 107 extern char *
 108 cplus_mangle_opname PARAMS ((char *, int));
 109
 110 /* From mmap-*.c */
 111
 112 extern PTR
 113 mmap_malloc PARAMS ((long));
 114
 115 extern PTR
 116 mmap_realloc PARAMS ((PTR, long));
 117
 118 extern PTR
 119 mmap_xmalloc PARAMS ((long));
 120
 121 extern PTR
 122 mmap_xrealloc PARAMS ((PTR, long));
 123
 124 extern void
 125 mmap_free PARAMS ((PTR));
 126
 127 extern PTR
 128 mmap_sbrk PARAMS ((int));
 129
 130 extern PTR
 131 mmap_base PARAMS ((void));
 132
 133 extern PTR
 134 mmap_page_align PARAMS ((PTR));
 135
 136 extern PTR
 137 mmap_remap PARAMS ((PTR, long, int, long));
 138
 139 /* From utils.c */
 140
 141 extern void
 142 init_malloc PARAMS ((void));
 143
 144 extern void
 145 request_quit PARAMS ((int));
 146
 147 extern void
 148 do_cleanups PARAMS ((struct cleanup *));
 149
 150 extern void
 151 discard_cleanups PARAMS ((struct cleanup *));
 152
 153 /* The bare make_cleanup function is one of those rare beasts that
 154    takes almost any type of function as the first arg and anything that
 155    will fit in a "void *" as the second arg.
 156
 157    Should be, once all calls and called-functions are cleaned up:
 158 extern struct cleanup *
 159 make_cleanup PARAMS ((void (*function) (PTR), PTR));
 160
 161    Until then, lint and/or various type-checking compiler options will
 162    complain about make_cleanup calls.  It'd be wrong to just cast things,
 163    since the type actually passed when the function is called would be
 164    wrong.  */
 165
 166 extern struct cleanup *
 167 make_cleanup ();
 168
 169 extern struct cleanup *
 170 save_cleanups PARAMS ((void));
 171
 172 extern void
 173 restore_cleanups PARAMS ((struct cleanup *));
 174
 175 extern void
 176 free_current_contents PARAMS ((char **));
 177
 178 extern void
 179 null_cleanup PARAMS ((char **));
 180
 181 extern int
 182 myread PARAMS ((int, char *, int));
 183
 184 extern int
 185 query ();
 186
 187 extern void
 188 wrap_here PARAMS ((char *));
 189
 190 extern void
 191 reinitialize_more_filter PARAMS ((void));
 192
 193 extern int
 194 print_insn PARAMS ((CORE_ADDR, FILE *));
 195
 196 extern void
 197 fputs_filtered PARAMS ((const char *, FILE *));
 198
 199 extern void
 200 puts_filtered PARAMS ((char *));
 201
 202 extern void
 203 fprintf_filtered ();
 204
 205 extern void
 206 printf_filtered ();
 207
 208 extern void
 209 print_spaces PARAMS ((int, FILE *));
 210
 211 extern void
 212 print_spaces_filtered PARAMS ((int, FILE *));
 213
 214 extern char *
 215 n_spaces PARAMS ((int));
 216
 217 extern void
 218 printchar PARAMS ((int, FILE *, int));
 219
 220 extern void
 221 fprint_symbol PARAMS ((FILE *, char *));
 222
 223 extern void
 224 fputs_demangled PARAMS ((char *, FILE *, int));
 225
 226 extern void
 227 perror_with_name PARAMS ((char *));
 228
 229 extern void
 230 print_sys_errmsg PARAMS ((char *, int));
 231
 232 /* From regex.c */
 233
 234 extern char *
 235 re_comp PARAMS ((char *));
 236
 237 /* From symfile.c */
 238
 239 extern void
 240 symbol_file_command PARAMS ((char *, int));
 241
 242 /* From main.c */
 243
 244 extern char *
 245 gdb_readline PARAMS ((char *));
 246
 247 extern char *
 248 command_line_input PARAMS ((char *, int));
 249
 250 extern void
 251 print_prompt PARAMS ((void));
 252
 253 extern int
 254 batch_mode PARAMS ((void));
 255
 256 extern int
 257 input_from_terminal_p PARAMS ((void));
 258
 259 extern int
 260 catch_errors PARAMS ((int (*) (char *), char *, char *));
 261
 262 /* From printcmd.c */
 263
 264 extern void
 265 set_next_address PARAMS ((CORE_ADDR));
 266
 267 extern void
 268 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
 269
 270 extern void
 271 print_address PARAMS ((CORE_ADDR, FILE *));
 272
 273 /* From source.c */
 274
 275 extern int
 276 openp PARAMS ((char *, int, char *, int, int, char **));
 277
 278 extern void
 279 mod_path PARAMS ((char *, char **));
 280
 281 extern void
 282 directory_command PARAMS ((char *, int));
 283
 284 extern void
 285 init_source_path PARAMS ((void));
 286
 287 /* From findvar.c */
 288
 289 extern int
 290 read_relative_register_raw_bytes PARAMS ((int, char *));
 291
 292 /* From readline (but not in any readline .h files).  */
 293
 294 extern char *
 295 tilde_expand PARAMS ((char *));
 296
 297 /* Structure for saved commands lines
 298    (for breakpoints, defined commands, etc).  */
 299
 300 struct command_line
 301 {
 302   struct command_line *next;
 303   char *line;
 304 };
 305
 306 extern struct command_line *
 307 read_command_lines PARAMS ((void));
 308
 309 extern void
 310 free_command_lines PARAMS ((struct command_line **));
 311
 312 /* String containing the current directory (what getwd would return).  */
 313
 314 extern char *current_directory;
 315
 316 /* Default radixes for input and output.  Only some values supported.  */
 317 extern unsigned input_radix;
 318 extern unsigned output_radix;
 319
 320 /* Baud rate specified for communication with serial target systems.  */
 321 extern char *baud_rate;
 322
 323 /* Languages represented in the symbol table and elsewhere. */
 324
 325 enum language
 326 {
 327    language_unknown,            /* Language not known */
 328    language_auto,               /* Placeholder for automatic setting */
 329    language_c,                  /* C */
 330    language_cplus,              /* C++ */
 331    language_m2                  /* Modula-2 */
 332 };
 333
 334 /* Return a format string for printf that will print a number in the local
 335    (language-specific) hexadecimal format.  Result is static and is
 336    overwritten by the next call.  local_hex_format_custom takes printf
 337    options like "08" or "l" (to produce e.g. %08x or %lx).  */
 338
 339 #define local_hex_format() (current_language->la_hex_format)
 340
 341 extern char *
 342 local_hex_format_custom PARAMS ((char *));      /* language.c */
 343
 344 /* Return a string that contains a number formatted in the local
 345    (language-specific) hexadecimal format.  Result is static and is
 346    overwritten by the next call.  local_hex_string_custom takes printf
 347    options like "08" or "l".  */
 348
 349 extern char *
 350 local_hex_string PARAMS ((int));                /* language.c */
 351
 352 extern char *
 353 local_hex_string_custom PARAMS ((int, char *)); /* language.c */
 354
 355 \f
 356 /* Host machine definition.  This will be a symlink to one of the
 357    xm-*.h files, built by the `configure' script.  */
 358
 359 #include "xm.h"
 360
 361 /*
 362  * Allow things in gdb to be declared "const".  If compiling ANSI, it
 363  * just works.  If compiling with gcc but non-ansi, redefine to __const__.
 364  * If non-ansi, non-gcc, then eliminate "const" entirely, making those
 365  * objects be read-write rather than read-only.
 366  */
 367
 368 #ifndef const
 369 #ifndef __STDC__
 370 # ifdef __GNUC__
 371 #  define const __const__
 372 # else
 373 #  define const /*nothing*/
 374 # endif /* GNUC */
 375 #endif /* STDC */
 376 #endif /* const */
 377
 378 #ifndef volatile
 379 #ifndef __STDC__
 380 # ifdef __GNUC__
 381 #  define volatile __volatile__
 382 # else
 383 #  define volatile /*nothing*/
 384 # endif /* GNUC */
 385 #endif /* STDC */
 386 #endif /* volatile */
 387
 388 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
 389    declarations of functions that never return (exit for instance) as
 390    "volatile void".  For such compilers "NORETURN" can be defined away
 391    to keep them happy */
 392
 393 #ifndef NORETURN
 394 # define NORETURN volatile
 395 #endif
 396
 397 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).  */
 398
 399 #if !defined (UINT_MAX)
 400 #define UINT_MAX 0xffffffff
 401 #endif
 402
 403 #if !defined (LONG_MAX)
 404 #define LONG_MAX 0x7fffffff
 405 #endif
 406
 407 #if !defined (INT_MAX)
 408 #define INT_MAX 0x7fffffff
 409 #endif
 410
 411 #if !defined (INT_MIN)
 412 /* Two's complement, 32 bit.  */
 413 #define INT_MIN -0x80000000
 414 #endif
 415
 416 /* Number of bits in a char or unsigned char for the target machine.
 417    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
 418 #if !defined (TARGET_CHAR_BIT)
 419 #define TARGET_CHAR_BIT 8
 420 #endif
 421
 422 /* Number of bits in a short or unsigned short for the target machine. */
 423 #if !defined (TARGET_SHORT_BIT)
 424 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
 425 #endif
 426
 427 /* Number of bits in an int or unsigned int for the target machine. */
 428 #if !defined (TARGET_INT_BIT)
 429 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
 430 #endif
 431
 432 /* Number of bits in a long or unsigned long for the target machine. */
 433 #if !defined (TARGET_LONG_BIT)
 434 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
 435 #endif
 436
 437 /* Number of bits in a long long or unsigned long long for the target machine. */
 438 #if !defined (TARGET_LONG_LONG_BIT)
 439 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
 440 #endif
 441
 442 /* Number of bits in a float for the target machine. */
 443 #if !defined (TARGET_FLOAT_BIT)
 444 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
 445 #endif
 446
 447 /* Number of bits in a double for the target machine. */
 448 #if !defined (TARGET_DOUBLE_BIT)
 449 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
 450 #endif
 451
 452 /* Number of bits in a long double for the target machine. */
 453 #if !defined (TARGET_LONG_DOUBLE_BIT)
 454 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
 455 #endif
 456
 457 /* Number of bits in a "complex" for the target machine. */
 458 #if !defined (TARGET_COMPLEX_BIT)
 459 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
 460 #endif
 461
 462 /* Number of bits in a "double complex" for the target machine. */
 463 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
 464 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
 465 #endif
 466
 467 /* Number of bits in a pointer for the target machine */
 468 #if !defined (TARGET_PTR_BIT)
 469 #define TARGET_PTR_BIT TARGET_INT_BIT
 470 #endif
 471
 472 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number
 473    of arguments to a function, number in a value history, register
 474    number, etc.) where the value must not be larger than can fit
 475    in an int.  */
 476 #if !defined (longest_to_int)
 477 #if defined (LONG_LONG)
 478 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
 479                            ? error ("Value out of range.") : (int) (x))
 480 #else /* No LONG_LONG.  */
 481 /* Assume sizeof (int) == sizeof (long).  */
 482 #define longest_to_int(x) ((int) (x))
 483 #endif /* No LONG_LONG.  */
 484 #endif /* No longest_to_int.  */
 485
 486 /* This should not be a typedef, because "unsigned LONGEST" needs
 487    to work. LONG_LONG is defined if the host has "long long".  */
 488
 489 #ifndef LONGEST
 490 # ifdef LONG_LONG
 491 #  define LONGEST long long
 492 # else
 493 #  define LONGEST long
 494 # endif
 495 #endif
 496
 497 /* Assorted functions we can declare, now that const and volatile are
 498    defined.  */
 499
 500 extern char *
 501 savestring PARAMS ((const char *, int));
 502
 503 extern char *
 504 strsave PARAMS ((const char *));
 505
 506 extern char *
 507 concat PARAMS ((char *, ...));
 508
 509 extern PTR
 510 xmalloc PARAMS ((long));
 511
 512 extern PTR
 513 xrealloc PARAMS ((char *, long));
 514
 515 extern int
 516 parse_escape PARAMS ((char **));
 517
 518 extern char *reg_names[];
 519
 520 extern NORETURN void                    /* Does not return to the caller.  */
 521 error ();
 522
 523 extern NORETURN void                    /* Does not return to the caller.  */
 524 fatal ();
 525
 526 extern NORETURN void                    /* Not specified as volatile in ... */
 527 exit PARAMS ((int));                    /* 4.10.4.3 */
 528
 529 extern NORETURN void                    /* Does not return to the caller.  */
 530 return_to_top_level PARAMS ((void));
 531
 532 extern void
 533 warning_setup PARAMS ((void));
 534
 535 extern void
 536 warning ();
 537
 538 /* Global functions from other, non-gdb GNU thingies (libiberty for
 539    instance) */
 540
 541 extern char *
 542 basename PARAMS ((char *));
 543
 544 extern char *
 545 getenv PARAMS ((CONST char *));
 546
 547 extern char **
 548 buildargv PARAMS ((char *));
 549
 550 extern void
 551 freeargv PARAMS ((char **));
 552
 553 /* For now, we can't include <stdlib.h> because it conflicts with
 554    "../include/getopt.h".  (FIXME)
 555
 556    However, since any prototypes for any functions defined in the ANSI
 557    specific, defined in any header files in an ANSI conforming environment,
 558    must match those in the ANSI standard, we can just duplicate them here
 559    since they must be the same in all conforming ANSI environments.  If
 560    these cause problems, then the environment is not ANSI conformant. */
 561
 562 #ifdef __STDC__
 563 #include <stddef.h>
 564 #endif
 565
 566 extern int
 567 fclose PARAMS ((FILE *stream));                         /* 4.9.5.1 */
 568
 569 extern double
 570 atof PARAMS ((const char *nptr));                       /* 4.10.1.1 */
 571
 572 #ifndef MALLOC_INCOMPATIBLE
 573 extern PTR
 574 malloc PARAMS ((size_t size));                          /* 4.10.3.3 */
 575
 576 extern PTR
 577 realloc PARAMS ((void *ptr, size_t size));              /* 4.10.3.4 */
 578
 579 extern void
 580 free PARAMS ((void *));                 /* 4.10.3.2 */
 581 #endif
 582
 583 extern void
 584 qsort PARAMS ((void *base, size_t nmemb,                /* 4.10.5.2 */
 585                size_t size,
 586                int (*comp)(const void *, const void *)));
 587
 588 extern char *
 589 strchr PARAMS ((const char *, int));                    /* 4.11.5.2 */
 590
 591 extern char *
 592 strrchr PARAMS ((const char *, int));                   /* 4.11.5.5 */
 593
 594 extern char *
 595 strtok PARAMS ((char *, const char *));                 /* 4.11.5.8 */
 596
 597 extern char *
 598 strerror PARAMS ((int));                                /* 4.11.6.2 */
 599
 600 /* Various possibilities for alloca.  */
 601 #ifndef alloca
 602 # ifdef __GNUC__
 603 #  define alloca __builtin_alloca
 604 # else
 605 #  ifdef sparc
 606 #   include <alloca.h>
 607 #  endif
 608    extern char *alloca ();
 609 # endif
 610 #endif
 611
 612 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER should be defined to one of these.  */
 613
 614 #if !defined (BIG_ENDIAN)
 615 #define BIG_ENDIAN 4321
 616 #endif
 617
 618 #if !defined (LITTLE_ENDIAN)
 619 #define LITTLE_ENDIAN 1234
 620 #endif
 621
 622 /* Target-system-dependent parameters for GDB.
 623
 624    The standard thing is to include defs.h.  However, files that are
 625    specific to a particular target can define TM_FILE_OVERRIDE before
 626    including defs.h, then can include any particular tm-file they desire.  */
 627
 628 /* Target machine definition.  This will be a symlink to one of the
 629    tm-*.h files, built by the `configure' script.  */
 630
 631 #ifndef TM_FILE_OVERRIDE
 632 #include "tm.h"
 633 #endif
 634
 635 /* The bit byte-order has to do just with numbering of bits in
 636    debugging symbols and such.  Conceptually, it's quite separate
 637    from byte/word byte order.  */
 638
 639 #if !defined (BITS_BIG_ENDIAN)
 640 #if TARGET_BYTE_ORDER == BIG_ENDIAN
 641 #define BITS_BIG_ENDIAN 1
 642 #endif /* Big endian.  */
 643
 644 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
 645 #define BITS_BIG_ENDIAN 0
 646 #endif /* Little endian.  */
 647 #endif /* BITS_BIG_ENDIAN not defined.  */
 648
 649 /* Swap LEN bytes at BUFFER between target and host byte-order.  */
 650 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
 651 #define SWAP_TARGET_AND_HOST(buffer,len)
 652 #else /* Target and host byte order differ.  */
 653 #define SWAP_TARGET_AND_HOST(buffer,len) \
 654   {                                                                      \
 655     char tmp;                                                            \
 656     char *p = (char *)(buffer);                                          \
 657     char *q = ((char *)(buffer)) + len - 1;                              \
 658     for (; p < q; p++, q--)                                              \
 659       {                                                                  \
 660         tmp = *q;                                                        \
 661         *q = *p;                                                         \
 662         *p = tmp;                                                        \
 663       }                                                                  \
 664   }
 665 #endif /* Target and host byte order differ.  */
 666
 667 /* On some machines there are bits in addresses which are not really
 668    part of the address, but are used by the kernel, the hardware, etc.
 669    for special purposes.  ADDR_BITS_REMOVE takes out any such bits
 670    so we get a "real" address such as one would find in a symbol
 671    table.  ADDR_BITS_SET sets those bits the way the system wants
 672    them.  */
 673 #if !defined (ADDR_BITS_REMOVE)
 674 #define ADDR_BITS_REMOVE(addr) (addr)
 675 #define ADDR_BITS_SET(addr) (addr)
 676 #endif /* No ADDR_BITS_REMOVE.  */
 677
 678 #if !defined (SYS_SIGLIST_MISSING)
 679 #define SYS_SIGLIST_MISSING defined (USG)
 680 #endif /* No SYS_SIGLIST_MISSING */
 681
 682 /* From valops.c */
 683
 684 extern CORE_ADDR
 685 push_bytes PARAMS ((CORE_ADDR, char *, int));
 686
 687 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
 688    must avoid prototyping this function for now.  FIXME.  Should be:
 689 extern CORE_ADDR
 690 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
 691  */
 692 extern CORE_ADDR
 693 push_word ();
 694
 695 #endif /* !defined (DEFS_H) */