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    here and in all subsequent file inclusions.  */
  27
  28 #include "ansidecl.h"
  29
  30 /* An address in the program being debugged.  Host byte order.  */
  31 typedef unsigned int CORE_ADDR;
  32
  33 #define min(a, b) ((a) < (b) ? (a) : (b))
  34 #define max(a, b) ((a) > (b) ? (a) : (b))
  35
  36 /* Gdb does *lots* of string compares.  Use macros to speed them up by
  37    avoiding function calls if the first characters are not the same. */
  38
  39 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : *(a) - *(b))
  40 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
  41 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
  42
  43 /* The character C++ uses to build identifiers that must be unique from
  44    the program's identifiers (such as $this and $$vptr).  */
  45 #define CPLUS_MARKER '$'        /* May be overridden to '.' for SysV */
  46
  47 #include <errno.h>              /* System call error return status */
  48
  49 extern int quit_flag;
  50 extern int immediate_quit;
  51 extern int sevenbit_strings;
  52
  53 extern void
  54 quit PARAMS ((void));
  55
  56 #define QUIT { if (quit_flag) quit (); }
  57
  58 /* Command classes are top-level categories into which commands are broken
  59    down for "help" purposes.
  60    Notes on classes: class_alias is for alias commands which are not
  61    abbreviations of the original command.  class-pseudo is for commands
  62    which are not really commands nor help topics ("stop").  */
  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, class_maintenance,
  72   class_pseudo
  73 };
  74
  75 /* the cleanup list records things that have to be undone
  76    if an error happens (descriptors to be closed, memory to be freed, etc.)
  77    Each link in the chain records a function to call and an
  78    argument to give it.
  79
  80    Use make_cleanup to add an element to the cleanup chain.
  81    Use do_cleanups to do all cleanup actions back to a given
  82    point in the chain.  Use discard_cleanups to remove cleanups
  83    from the chain back to a given point, not doing them.  */
  84
  85 struct cleanup
  86 {
  87   struct cleanup *next;
  88   void (*function) PARAMS ((PTR));
  89   PTR arg;
  90 };
  91
  92 /* From blockframe.c */
  93
  94 extern int
  95 inside_entry_func PARAMS ((CORE_ADDR));
  96
  97 extern int
  98 inside_entry_file PARAMS ((CORE_ADDR addr));
  99
 100 extern int
 101 inside_main_func PARAMS ((CORE_ADDR pc));
 102
 103 /* start-sanitize-chill */
 104 /* From ch-lang.c, for the moment. (FIXME) */
 105
 106 extern char *
 107 chill_demangle PARAMS ((const char *));
 108 /* end-sanitize-chill */
 109
 110 /* From libiberty.a */
 111
 112 extern char *
 113 cplus_demangle PARAMS ((const char *, int));
 114
 115 extern char *
 116 cplus_mangle_opname PARAMS ((char *, int));
 117
 118 /* From libmmalloc.a (memory mapped malloc library) */
 119
 120 extern PTR
 121 mmalloc_attach PARAMS ((int, PTR));
 122
 123 extern PTR
 124 mmalloc_detach PARAMS ((PTR));
 125
 126 extern PTR
 127 mmalloc PARAMS ((PTR, long));
 128
 129 extern PTR
 130 mrealloc PARAMS ((PTR, PTR, long));
 131
 132 extern void
 133 mfree PARAMS ((PTR, PTR));
 134
 135 extern int
 136 mmalloc_setkey PARAMS ((PTR, int, PTR));
 137
 138 extern PTR
 139 mmalloc_getkey PARAMS ((PTR, int));
 140
 141 /* From utils.c */
 142
 143 extern int
 144 strcmp_iw PARAMS ((const char *, const char *));
 145
 146 extern char *
 147 safe_strerror PARAMS ((int));
 148
 149 extern char *
 150 safe_strsignal PARAMS ((int));
 151
 152 extern void
 153 init_malloc PARAMS ((PTR));
 154
 155 extern void
 156 request_quit PARAMS ((int));
 157
 158 extern void
 159 do_cleanups PARAMS ((struct cleanup *));
 160
 161 extern void
 162 discard_cleanups PARAMS ((struct cleanup *));
 163
 164 /* The bare make_cleanup function is one of those rare beasts that
 165    takes almost any type of function as the first arg and anything that
 166    will fit in a "void *" as the second arg.
 167
 168    Should be, once all calls and called-functions are cleaned up:
 169 extern struct cleanup *
 170 make_cleanup PARAMS ((void (*function) (PTR), PTR));
 171
 172    Until then, lint and/or various type-checking compiler options will
 173    complain about make_cleanup calls.  It'd be wrong to just cast things,
 174    since the type actually passed when the function is called would be
 175    wrong.  */
 176
 177 extern struct cleanup *
 178 make_cleanup ();
 179
 180 extern struct cleanup *
 181 save_cleanups PARAMS ((void));
 182
 183 extern void
 184 restore_cleanups PARAMS ((struct cleanup *));
 185
 186 extern void
 187 free_current_contents PARAMS ((char **));
 188
 189 extern void
 190 null_cleanup PARAMS ((char **));
 191
 192 extern int
 193 myread PARAMS ((int, char *, int));
 194
 195 extern int
 196 query ();
 197
 198 extern void
 199 begin_line PARAMS ((void));
 200
 201 extern void
 202 wrap_here PARAMS ((char *));
 203
 204 extern void
 205 reinitialize_more_filter PARAMS ((void));
 206
 207 extern int
 208 print_insn PARAMS ((CORE_ADDR, FILE *));
 209
 210 extern void
 211 fputs_filtered PARAMS ((const char *, FILE *));
 212
 213 extern void
 214 puts_filtered PARAMS ((char *));
 215
 216 extern void
 217 vprintf_filtered ();
 218
 219 extern void
 220 vfprintf_filtered ();
 221
 222 extern void
 223 fprintf_filtered ();
 224
 225 extern void
 226 fprintfi_filtered ();
 227
 228 extern void
 229 printf_filtered ();
 230
 231 extern void
 232 printfi_filtered ();
 233
 234 extern void
 235 print_spaces PARAMS ((int, FILE *));
 236
 237 extern void
 238 print_spaces_filtered PARAMS ((int, FILE *));
 239
 240 extern char *
 241 n_spaces PARAMS ((int));
 242
 243 extern void
 244 gdb_printchar PARAMS ((int, FILE *, int));
 245
 246 extern void
 247 fprint_symbol PARAMS ((FILE *, char *));
 248
 249 extern void
 250 fputs_demangled PARAMS ((char *, FILE *, int));
 251
 252 extern void
 253 perror_with_name PARAMS ((char *));
 254
 255 extern void
 256 print_sys_errmsg PARAMS ((char *, int));
 257
 258 /* From regex.c */
 259
 260 extern char *
 261 re_comp PARAMS ((char *));
 262
 263 /* From symfile.c */
 264
 265 extern void
 266 symbol_file_command PARAMS ((char *, int));
 267
 268 /* From main.c */
 269
 270 extern char *
 271 skip_quoted PARAMS ((char *));
 272
 273 extern char *
 274 gdb_readline PARAMS ((char *));
 275
 276 extern char *
 277 command_line_input PARAMS ((char *, int));
 278
 279 extern void
 280 print_prompt PARAMS ((void));
 281
 282 extern int
 283 batch_mode PARAMS ((void));
 284
 285 extern int
 286 input_from_terminal_p PARAMS ((void));
 287
 288 extern int
 289 catch_errors PARAMS ((int (*) (char *), char *, char *));
 290
 291 /* From printcmd.c */
 292
 293 extern void
 294 set_next_address PARAMS ((CORE_ADDR));
 295
 296 extern void
 297 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
 298
 299 extern void
 300 print_address PARAMS ((CORE_ADDR, FILE *));
 301
 302 /* From source.c */
 303
 304 extern int
 305 openp PARAMS ((char *, int, char *, int, int, char **));
 306
 307 extern void
 308 mod_path PARAMS ((char *, char **));
 309
 310 extern void
 311 directory_command PARAMS ((char *, int));
 312
 313 extern void
 314 init_source_path PARAMS ((void));
 315
 316 /* From findvar.c */
 317
 318 extern int
 319 read_relative_register_raw_bytes PARAMS ((int, char *));
 320
 321 /* From readline (but not in any readline .h files).  */
 322
 323 extern char *
 324 tilde_expand PARAMS ((char *));
 325
 326 /* Structure for saved commands lines
 327    (for breakpoints, defined commands, etc).  */
 328
 329 struct command_line
 330 {
 331   struct command_line *next;
 332   char *line;
 333 };
 334
 335 extern struct command_line *
 336 read_command_lines PARAMS ((void));
 337
 338 extern void
 339 free_command_lines PARAMS ((struct command_line **));
 340
 341 /* String containing the current directory (what getwd would return).  */
 342
 343 extern char *current_directory;
 344
 345 /* Default radixes for input and output.  Only some values supported.  */
 346 extern unsigned input_radix;
 347 extern unsigned output_radix;
 348
 349 /* Baud rate specified for communication with serial target systems.  */
 350 extern char *baud_rate;
 351
 352 /* Languages represented in the symbol table and elsewhere.
 353    This should probably be in language.h, but since enum's can't
 354    be forward declared to satisfy opaque references before their
 355    actual definition, needs to be here. */
 356
 357 enum language
 358 {
 359    language_unknown,            /* Language not known */
 360    language_auto,               /* Placeholder for automatic setting */
 361    language_c,                  /* C */
 362    language_cplus,              /* C++ */
 363                                 /* start-sanitize-chill */
 364    language_chill,              /* Chill */
 365                                 /* end-sanitize-chill */
 366    language_m2                  /* Modula-2 */
 367 };
 368
 369 /* Possibilities for prettyprint parameters to routines which print
 370    things.  Like enum language, this should be in value.h, but needs
 371    to be here for the same reason.  FIXME:  If we can eliminate this
 372    as an arg to LA_VAL_PRINT, then we can probably move it back to
 373    value.h. */
 374
 375 enum val_prettyprint
 376 {
 377   Val_no_prettyprint = 0,
 378   Val_prettyprint,
 379   /* Use the default setting which the user has specified.  */
 380   Val_pretty_default
 381 };
 382
 383 \f
 384 /* Host machine definition.  This will be a symlink to one of the
 385    xm-*.h files, built by the `configure' script.  */
 386
 387 #include "xm.h"
 388
 389 /* Native machine support.  This will be a symlink to one of the
 390    nm-*.h files, built by the `configure' script.  */
 391
 392 #include "nm.h"
 393
 394 /* If the xm.h file did not define the mode string used to open the
 395    files, assume that binary files are opened the same way as text
 396    files */
 397 #ifndef FOPEN_RB
 398 #include "fopen-same.h"
 399 #endif
 400
 401 /*
 402  * Allow things in gdb to be declared "const".  If compiling ANSI, it
 403  * just works.  If compiling with gcc but non-ansi, redefine to __const__.
 404  * If non-ansi, non-gcc, then eliminate "const" entirely, making those
 405  * objects be read-write rather than read-only.
 406  */
 407
 408 #ifndef const
 409 #ifndef __STDC__
 410 # ifdef __GNUC__
 411 #  define const __const__
 412 # else
 413 #  define const /*nothing*/
 414 # endif /* GNUC */
 415 #endif /* STDC */
 416 #endif /* const */
 417
 418 #ifndef volatile
 419 #ifndef __STDC__
 420 # ifdef __GNUC__
 421 #  define volatile __volatile__
 422 # else
 423 #  define volatile /*nothing*/
 424 # endif /* GNUC */
 425 #endif /* STDC */
 426 #endif /* volatile */
 427
 428 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
 429    declarations of functions that never return (exit for instance) as
 430    "volatile void".  For such compilers "NORETURN" can be defined away
 431    to keep them happy */
 432
 433 #ifndef NORETURN
 434 # ifdef __lucid
 435 #   define NORETURN /*nothing*/
 436 # else
 437 #   define NORETURN volatile
 438 # endif
 439 #endif
 440
 441 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).  */
 442
 443 #if !defined (UINT_MAX)
 444 #define UINT_MAX 0xffffffff
 445 #endif
 446
 447 #if !defined (LONG_MAX)
 448 #define LONG_MAX 0x7fffffff
 449 #endif
 450
 451 #if !defined (INT_MAX)
 452 #define INT_MAX 0x7fffffff
 453 #endif
 454
 455 #if !defined (INT_MIN)
 456 /* Two's complement, 32 bit.  */
 457 #define INT_MIN -0x80000000
 458 #endif
 459
 460 /* Number of bits in a char or unsigned char for the target machine.
 461    Just like CHAR_BIT in <limits.h> but describes the target machine.  */
 462 #if !defined (TARGET_CHAR_BIT)
 463 #define TARGET_CHAR_BIT 8
 464 #endif
 465
 466 /* Number of bits in a short or unsigned short for the target machine. */
 467 #if !defined (TARGET_SHORT_BIT)
 468 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
 469 #endif
 470
 471 /* Number of bits in an int or unsigned int for the target machine. */
 472 #if !defined (TARGET_INT_BIT)
 473 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
 474 #endif
 475
 476 /* Number of bits in a long or unsigned long for the target machine. */
 477 #if !defined (TARGET_LONG_BIT)
 478 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
 479 #endif
 480
 481 /* Number of bits in a long long or unsigned long long for the target machine. */
 482 #if !defined (TARGET_LONG_LONG_BIT)
 483 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
 484 #endif
 485
 486 /* Number of bits in a float for the target machine. */
 487 #if !defined (TARGET_FLOAT_BIT)
 488 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
 489 #endif
 490
 491 /* Number of bits in a double for the target machine. */
 492 #if !defined (TARGET_DOUBLE_BIT)
 493 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
 494 #endif
 495
 496 /* Number of bits in a long double for the target machine. */
 497 #if !defined (TARGET_LONG_DOUBLE_BIT)
 498 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
 499 #endif
 500
 501 /* Number of bits in a "complex" for the target machine. */
 502 #if !defined (TARGET_COMPLEX_BIT)
 503 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
 504 #endif
 505
 506 /* Number of bits in a "double complex" for the target machine. */
 507 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
 508 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
 509 #endif
 510
 511 /* Number of bits in a pointer for the target machine */
 512 #if !defined (TARGET_PTR_BIT)
 513 #define TARGET_PTR_BIT TARGET_INT_BIT
 514 #endif
 515
 516 /* Convert a LONGEST to an int.  This is used in contexts (e.g. number
 517    of arguments to a function, number in a value history, register
 518    number, etc.) where the value must not be larger than can fit
 519    in an int.  */
 520 #if !defined (longest_to_int)
 521 #if defined (LONG_LONG)
 522 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
 523                            ? (error ("Value out of range."),0) : (int) (x))
 524 #else /* No LONG_LONG.  */
 525 /* Assume sizeof (int) == sizeof (long).  */
 526 #define longest_to_int(x) ((int) (x))
 527 #endif /* No LONG_LONG.  */
 528 #endif /* No longest_to_int.  */
 529
 530 /* This should not be a typedef, because "unsigned LONGEST" needs
 531    to work. LONG_LONG is defined if the host has "long long".  */
 532
 533 #ifndef LONGEST
 534 # ifdef LONG_LONG
 535 #  define LONGEST long long
 536 # else
 537 #  define LONGEST long
 538 # endif
 539 #endif
 540
 541 /* Assorted functions we can declare, now that const and volatile are
 542    defined.  */
 543
 544 extern char *
 545 savestring PARAMS ((const char *, int));
 546
 547 extern char *
 548 msavestring PARAMS ((void *, const char *, int));
 549
 550 extern char *
 551 strsave PARAMS ((const char *));
 552
 553 extern char *
 554 mstrsave PARAMS ((void *, const char *));
 555
 556 extern char *
 557 concat PARAMS ((char *, ...));
 558
 559 extern PTR
 560 xmalloc PARAMS ((long));
 561
 562 extern PTR
 563 xrealloc PARAMS ((PTR, long));
 564
 565 extern PTR
 566 xmmalloc PARAMS ((PTR, long));
 567
 568 extern PTR
 569 xmrealloc PARAMS ((PTR, PTR, long));
 570
 571 extern PTR
 572 mmalloc PARAMS ((PTR, long));
 573
 574 extern PTR
 575 mrealloc PARAMS ((PTR, PTR, long));
 576
 577 extern void
 578 mfree PARAMS ((PTR, PTR));
 579
 580 extern int
 581 mmcheck PARAMS ((PTR, void (*) (void)));
 582
 583 extern int
 584 mmtrace PARAMS ((void));
 585
 586 extern int
 587 parse_escape PARAMS ((char **));
 588
 589 extern const char * const reg_names[];
 590
 591 extern NORETURN void                    /* Does not return to the caller.  */
 592 error ();
 593
 594 extern NORETURN void                    /* Does not return to the caller.  */
 595 fatal ();
 596
 597 extern NORETURN void                    /* Not specified as volatile in ... */
 598 exit PARAMS ((int));                    /* 4.10.4.3 */
 599
 600 extern NORETURN void                    /* Does not return to the caller.  */
 601 nomem PARAMS ((long));
 602
 603 extern NORETURN void                    /* Does not return to the caller.  */
 604 return_to_top_level PARAMS ((void));
 605
 606 extern void
 607 warning_setup PARAMS ((void));
 608
 609 extern void
 610 warning ();
 611
 612 /* Global functions from other, non-gdb GNU thingies (libiberty for
 613    instance) */
 614
 615 extern char *
 616 basename PARAMS ((char *));
 617
 618 extern char *
 619 getenv PARAMS ((const char *));
 620
 621 extern char **
 622 buildargv PARAMS ((char *));
 623
 624 extern void
 625 freeargv PARAMS ((char **));
 626
 627 extern char *
 628 strerrno PARAMS ((int));
 629
 630 extern char *
 631 strsigno PARAMS ((int));
 632
 633 extern int
 634 errno_max PARAMS ((void));
 635
 636 extern int
 637 signo_max PARAMS ((void));
 638
 639 extern int
 640 strtoerrno PARAMS ((char *));
 641
 642 extern int
 643 strtosigno PARAMS ((char *));
 644
 645 extern char *
 646 strsignal PARAMS ((int));
 647
 648 /* From other system libraries */
 649
 650 #ifndef PSIGNAL_IN_SIGNAL_H
 651 extern void
 652 psignal PARAMS ((unsigned, char *));
 653 #endif
 654
 655 /* For now, we can't include <stdlib.h> because it conflicts with
 656    "../include/getopt.h".  (FIXME)
 657
 658    However, if a function is defined in the ANSI C standard and a prototype
 659    for that function is defined and visible in any header file in an ANSI
 660    conforming environment, then that prototype must match the definition in
 661    the ANSI standard.  So we can just duplicate them here without conflict,
 662    since they must be the same in all conforming ANSI environments.  If
 663    these cause problems, then the environment is not ANSI conformant. */
 664
 665 #ifdef __STDC__
 666 #include <stddef.h>
 667 #endif
 668
 669 extern int
 670 fclose PARAMS ((FILE *stream));                         /* 4.9.5.1 */
 671
 672 extern void
 673 perror PARAMS ((const char *));                         /* 4.9.10.4 */
 674
 675 extern double
 676 atof PARAMS ((const char *nptr));                       /* 4.10.1.1 */
 677
 678 extern int
 679 atoi PARAMS ((const char *));                           /* 4.10.1.2 */
 680
 681 #ifndef MALLOC_INCOMPATIBLE
 682
 683 extern PTR
 684 malloc PARAMS ((size_t size));                          /* 4.10.3.3 */
 685
 686 extern PTR
 687 realloc PARAMS ((void *ptr, size_t size));              /* 4.10.3.4 */
 688
 689 extern void
 690 free PARAMS ((void *));                                 /* 4.10.3.2 */
 691
 692 #endif  /* MALLOC_INCOMPATIBLE */
 693
 694 extern void
 695 qsort PARAMS ((void *base, size_t nmemb,                /* 4.10.5.2 */
 696                size_t size,
 697                int (*comp)(const void *, const void *)));
 698
 699 #ifndef MEM_FNS_DECLARED        /* Some non-ANSI use void *, not char *.  */
 700 extern PTR
 701 memcpy PARAMS ((void *, const void *, size_t));         /* 4.11.2.1 */
 702 #endif
 703
 704 extern int
 705 memcmp PARAMS ((const void *, const void *, size_t));   /* 4.11.4.1 */
 706
 707 extern char *
 708 strchr PARAMS ((const char *, int));                    /* 4.11.5.2 */
 709
 710 extern char *
 711 strrchr PARAMS ((const char *, int));                   /* 4.11.5.5 */
 712
 713 extern char *
 714 strstr PARAMS ((const char *, const char *));           /* 4.11.5.7 */
 715
 716 extern char *
 717 strtok PARAMS ((char *, const char *));                 /* 4.11.5.8 */
 718
 719 #ifndef MEM_FNS_DECLARED        /* Some non-ANSI use void *, not char *.  */
 720 extern PTR
 721 memset PARAMS ((void *, int, size_t));                  /* 4.11.6.1 */
 722 #endif
 723
 724 extern char *
 725 strerror PARAMS ((int));                                /* 4.11.6.2 */
 726
 727 /* Various possibilities for alloca.  */
 728 #ifndef alloca
 729 # ifdef __GNUC__
 730 #  define alloca __builtin_alloca
 731 # else
 732 #  ifdef sparc
 733 #   include <alloca.h>          /* NOTE:  Doesn't declare alloca() */
 734 #  endif
 735 #  ifdef __STDC__
 736    extern void *alloca (size_t);
 737 #  else /* __STDC__ */
 738    extern char *alloca ();
 739 #  endif
 740 # endif
 741 #endif
 742
 743 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these.  */
 744
 745 #if !defined (BIG_ENDIAN)
 746 #define BIG_ENDIAN 4321
 747 #endif
 748
 749 #if !defined (LITTLE_ENDIAN)
 750 #define LITTLE_ENDIAN 1234
 751 #endif
 752
 753 /* Target-system-dependent parameters for GDB.
 754
 755    The standard thing is to include defs.h.  However, files that are
 756    specific to a particular target can define TM_FILE_OVERRIDE before
 757    including defs.h, then can include any particular tm-file they desire.  */
 758
 759 /* Target machine definition.  This will be a symlink to one of the
 760    tm-*.h files, built by the `configure' script.  */
 761
 762 #ifndef TM_FILE_OVERRIDE
 763 #include "tm.h"
 764 #endif
 765
 766 /* The bit byte-order has to do just with numbering of bits in
 767    debugging symbols and such.  Conceptually, it's quite separate
 768    from byte/word byte order.  */
 769
 770 #if !defined (BITS_BIG_ENDIAN)
 771 #if TARGET_BYTE_ORDER == BIG_ENDIAN
 772 #define BITS_BIG_ENDIAN 1
 773 #endif /* Big endian.  */
 774
 775 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
 776 #define BITS_BIG_ENDIAN 0
 777 #endif /* Little endian.  */
 778 #endif /* BITS_BIG_ENDIAN not defined.  */
 779
 780 /* Swap LEN bytes at BUFFER between target and host byte-order.  */
 781 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
 782 #define SWAP_TARGET_AND_HOST(buffer,len)
 783 #else /* Target and host byte order differ.  */
 784 #define SWAP_TARGET_AND_HOST(buffer,len) \
 785   {                                                                      \
 786     char tmp;                                                            \
 787     char *p = (char *)(buffer);                                          \
 788     char *q = ((char *)(buffer)) + len - 1;                              \
 789     for (; p < q; p++, q--)                                              \
 790       {                                                                  \
 791         tmp = *q;                                                        \
 792         *q = *p;                                                         \
 793         *p = tmp;                                                        \
 794       }                                                                  \
 795   }
 796 #endif /* Target and host byte order differ.  */
 797
 798 /* On some machines there are bits in addresses which are not really
 799    part of the address, but are used by the kernel, the hardware, etc.
 800    for special purposes.  ADDR_BITS_REMOVE takes out any such bits
 801    so we get a "real" address such as one would find in a symbol
 802    table.  ADDR_BITS_SET sets those bits the way the system wants
 803    them.  */
 804 #if !defined (ADDR_BITS_REMOVE)
 805 #define ADDR_BITS_REMOVE(addr) (addr)
 806 #define ADDR_BITS_SET(addr) (addr)
 807 #endif /* No ADDR_BITS_REMOVE.  */
 808
 809 /* From valops.c */
 810
 811 extern CORE_ADDR
 812 push_bytes PARAMS ((CORE_ADDR, char *, int));
 813
 814 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
 815    must avoid prototyping this function for now.  FIXME.  Should be:
 816 extern CORE_ADDR
 817 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
 818  */
 819 extern CORE_ADDR
 820 push_word ();
 821
 822 /* Some parts of gdb might be considered optional, in the sense that they
 823    are not essential for being able to build a working, usable debugger
 824    for a specific environment.  For example, the maintenance commands
 825    are there for the benefit of gdb maintainers.  As another example,
 826    some environments really don't need gdb's that are able to read N
 827    different object file formats.  In order to make it possible (but
 828    not necessarily recommended) to build "stripped down" versions of
 829    gdb, the following defines control selective compilation of those
 830    parts of gdb which can be safely left out when necessary.  Note that
 831    the default is to include everything. */
 832
 833 #ifndef MAINTENANCE_CMDS
 834 #define MAINTENANCE_CMDS 1
 835 #endif
 836
 837 #endif /* !defined (DEFS_H) */