sim/common/sim-config.h

   1 /* The common simulator framework for GDB, the GNU Debugger.
   2
   3    Copyright 2002, 2004, 2007 Free Software Foundation, Inc.
   4
   5    Contributed by Andrew Cagney and Red Hat.
   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 2 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, write to the Free Software
  21    Foundation, Inc., 59 Temple Place - Suite 330,
  22    Boston, MA 02111-1307, USA.  */
  23
  24
  25 #ifndef SIM_CONFIG_H
  26 #define SIM_CONFIG_H
  27
  28
  29 /* Host dependant:
  30
  31    The CPP below defines information about the compilation host.  In
  32    particular it defines the macro's:
  33
  34         WITH_HOST_BYTE_ORDER    The byte order of the host. Could
  35                                 be any of LITTLE_ENDIAN, BIG_ENDIAN
  36                                 or 0 (unknown).  Those macro's also
  37                                 need to be defined.
  38
  39  */
  40
  41
  42 /* NetBSD:
  43
  44    NetBSD is easy, everything you could ever want is in a header file
  45    (well almost :-) */
  46
  47 #if defined(__NetBSD__)
  48 # include <machine/endian.h>
  49 # if (WITH_HOST_BYTE_ORDER == 0)
  50 #  undef WITH_HOST_BYTE_ORDER
  51 #  define WITH_HOST_BYTE_ORDER BYTE_ORDER
  52 # endif
  53 # if (BYTE_ORDER != WITH_HOST_BYTE_ORDER)
  54 #  error "host endian incorrectly configured, check config.h"
  55 # endif
  56 #endif
  57
  58 /* Linux is similarly easy.  */
  59
  60 #if defined(__linux__)
  61 # include <endian.h>
  62 # if defined(__LITTLE_ENDIAN) && !defined(LITTLE_ENDIAN)
  63 #  define LITTLE_ENDIAN __LITTLE_ENDIAN
  64 # endif
  65 # if defined(__BIG_ENDIAN) && !defined(BIG_ENDIAN)
  66 #  define BIG_ENDIAN __BIG_ENDIAN
  67 # endif
  68 # if defined(__BYTE_ORDER) && !defined(BYTE_ORDER)
  69 #  define BYTE_ORDER __BYTE_ORDER
  70 # endif
  71 # if (WITH_HOST_BYTE_ORDER == 0)
  72 #  undef WITH_HOST_BYTE_ORDER
  73 #  define WITH_HOST_BYTE_ORDER BYTE_ORDER
  74 # endif
  75 # if (BYTE_ORDER != WITH_HOST_BYTE_ORDER)
  76 #  error "host endian incorrectly configured, check config.h"
  77 # endif
  78 #endif
  79
  80 /* INSERT HERE - hosts that have available LITTLE_ENDIAN and
  81    BIG_ENDIAN macro's */
  82
  83
  84 /* Some hosts don't define LITTLE_ENDIAN or BIG_ENDIAN, help them out */
  85
  86 #ifndef LITTLE_ENDIAN
  87 #define LITTLE_ENDIAN 1234
  88 #endif
  89 #ifndef BIG_ENDIAN
  90 #define BIG_ENDIAN 4321
  91 #endif
  92
  93
  94 /* SunOS on SPARC:
  95
  96    Big endian last time I looked */
  97
  98 #if defined(sparc) || defined(__sparc__)
  99 # if (WITH_HOST_BYTE_ORDER == 0)
 100 #  undef WITH_HOST_BYTE_ORDER
 101 #  define WITH_HOST_BYTE_ORDER BIG_ENDIAN
 102 # endif
 103 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
 104 #  error "sun was big endian last time I looked ..."
 105 # endif
 106 #endif
 107
 108
 109 /* Random x86
 110
 111    Little endian last time I looked */
 112
 113 #if defined(i386) || defined(i486) || defined(i586) || defined (i686) || defined(__i386__) || defined(__i486__) || defined(__i586__) || defined (__i686__)
 114 # if (WITH_HOST_BYTE_ORDER == 0)
 115 #  undef WITH_HOST_BYTE_ORDER
 116 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 117 # endif
 118 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 119 #  error "x86 was little endian last time I looked ..."
 120 # endif
 121 #endif
 122
 123 #if (defined (__i486__) || defined (__i586__) || defined (__i686__)) && defined(__GNUC__) && WITH_BSWAP
 124 #undef  htonl
 125 #undef  ntohl
 126 #define htonl(IN) __extension__ ({ int _out; __asm__ ("bswap %0" : "=r" (_out) : "0" (IN)); _out; })
 127 #define ntohl(IN) __extension__ ({ int _out; __asm__ ("bswap %0" : "=r" (_out) : "0" (IN)); _out; })
 128 #endif
 129
 130 /* Power or PowerPC running AIX  */
 131 #if defined(_POWER) && defined(_AIX)
 132 # if (WITH_HOST_BYTE_ORDER == 0)
 133 #  undef WITH_HOST_BYTE_ORDER
 134 #  define WITH_HOST_BYTE_ORDER BIG_ENDIAN
 135 # endif
 136 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
 137 #  error "Power/PowerPC AIX was big endian last time I looked ..."
 138 # endif
 139 #endif
 140
 141 /* Solaris running PowerPC */
 142 #if defined(__PPC) && defined(__sun__)
 143 # if (WITH_HOST_BYTE_ORDER == 0)
 144 #  undef WITH_HOST_BYTE_ORDER
 145 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 146 # endif
 147 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 148 #  error "Solaris on PowerPCs was little endian last time I looked ..."
 149 # endif
 150 #endif
 151
 152 /* HP/PA */
 153 #if defined(__hppa__)
 154 # if (WITH_HOST_BYTE_ORDER == 0)
 155 #  undef WITH_HOST_BYTE_ORDER
 156 #  define WITH_HOST_BYTE_ORDER BIG_ENDIAN
 157 # endif
 158 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
 159 #  error "HP/PA was big endian last time I looked ..."
 160 # endif
 161 #endif
 162
 163 /* Big endian MIPS */
 164 #if defined(__MIPSEB__)
 165 # if (WITH_HOST_BYTE_ORDER == 0)
 166 #  undef WITH_HOST_BYTE_ORDER
 167 #  define WITH_HOST_BYTE_ORDER BIG_ENDIAN
 168 # endif
 169 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
 170 #  error "MIPSEB was big endian last time I looked ..."
 171 # endif
 172 #endif
 173
 174 /* Little endian MIPS */
 175 #if defined(__MIPSEL__)
 176 # if (WITH_HOST_BYTE_ORDER == 0)
 177 #  undef WITH_HOST_BYTE_ORDER
 178 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 179 # endif
 180 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 181 #  error "MIPSEL was little endian last time I looked ..."
 182 # endif
 183 #endif
 184
 185 /* Windows NT */
 186 #if defined(__WIN32__)
 187 # if (WITH_HOST_BYTE_ORDER == 0)
 188 #  undef WITH_HOST_BYTE_ORDER
 189 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 190 # endif
 191 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 192 #  error "Windows NT was little endian last time I looked ..."
 193 # endif
 194 #endif
 195
 196 /* Alpha running DEC unix */
 197 #if defined(__osf__) && defined(__alpha__)
 198 # if (WITH_HOST_BYTE_ORDER == 0)
 199 #  undef WITH_HOST_BYTE_ORDER
 200 #  define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
 201 # endif
 202 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
 203 #  error "AXP running DEC unix was little endian last time I looked ..."
 204 # endif
 205 #endif
 206
 207
 208 /* INSERT HERE - additional hosts that do not have LITTLE_ENDIAN and
 209    BIG_ENDIAN definitions available.  */
 210 \f
 211 /* Until devices and tree properties are sorted out, tell sim-config.c
 212    not to call the tree_find_foo fns.  */
 213 #define WITH_TREE_PROPERTIES 0
 214
 215
 216 /* endianness of the host/target:
 217
 218    If the build process is aware (at compile time) of the endianness
 219    of the host/target it is able to eliminate slower generic endian
 220    handling code.
 221
 222    Possible values are 0 (unknown), LITTLE_ENDIAN, BIG_ENDIAN */
 223
 224 #ifndef WITH_HOST_BYTE_ORDER
 225 #define WITH_HOST_BYTE_ORDER            0 /*unknown*/
 226 #endif
 227
 228 #ifndef WITH_TARGET_BYTE_ORDER
 229 #define WITH_TARGET_BYTE_ORDER          0 /*unknown*/
 230 #endif
 231
 232 #ifndef WITH_DEFAULT_TARGET_BYTE_ORDER
 233 #define WITH_DEFAULT_TARGET_BYTE_ORDER 0 /* fatal */
 234 #endif
 235
 236 extern int current_host_byte_order;
 237 #define CURRENT_HOST_BYTE_ORDER (WITH_HOST_BYTE_ORDER \
 238                                  ? WITH_HOST_BYTE_ORDER \
 239                                  : current_host_byte_order)
 240 extern int current_target_byte_order;
 241 #define CURRENT_TARGET_BYTE_ORDER (WITH_TARGET_BYTE_ORDER \
 242                                    ? WITH_TARGET_BYTE_ORDER \
 243                                    : current_target_byte_order)
 244
 245
 246
 247 /* XOR endian.
 248
 249    In addition to the above, the simulator can support the horrible
 250    XOR endian mode (as found in the PowerPC and MIPS ISA).  See
 251    sim-core for more information.
 252
 253    If WITH_XOR_ENDIAN is non-zero, it specifies the number of bytes
 254    potentially involved in the XOR munge. A typical value is 8. */
 255
 256 #ifndef WITH_XOR_ENDIAN
 257 #define WITH_XOR_ENDIAN         0
 258 #endif
 259
 260
 261
 262 /* Intel host BSWAP support:
 263
 264    Whether to use bswap on the 486 and pentiums rather than the 386
 265    sequence that uses xchgb/rorl/xchgb */
 266 #ifndef WITH_BSWAP
 267 #define WITH_BSWAP 0
 268 #endif
 269
 270
 271
 272 /* SMP support:
 273
 274    Sets a limit on the number of processors that can be simulated.  If
 275    WITH_SMP is set to zero (0), the simulator is restricted to
 276    suporting only one processor (and as a consequence leaves the SMP
 277    code out of the build process).
 278
 279    The actual number of processors is taken from the device
 280    /options/smp@<nr-cpu> */
 281
 282 #if defined (WITH_SMP) && (WITH_SMP > 0)
 283 #define MAX_NR_PROCESSORS               WITH_SMP
 284 #endif
 285
 286 #ifndef MAX_NR_PROCESSORS
 287 #define MAX_NR_PROCESSORS               1
 288 #endif
 289
 290
 291 /* Size of target word, address and OpenFirmware Cell:
 292
 293    The target word size is determined by the natural size of its
 294    reginsters.
 295
 296    On most hosts, the address and cell are the same size as a target
 297    word.  */
 298
 299 #ifndef WITH_TARGET_WORD_BITSIZE
 300 #define WITH_TARGET_WORD_BITSIZE        32
 301 #endif
 302
 303 #ifndef WITH_TARGET_ADDRESS_BITSIZE
 304 #define WITH_TARGET_ADDRESS_BITSIZE     WITH_TARGET_WORD_BITSIZE
 305 #endif
 306
 307 #ifndef WITH_TARGET_CELL_BITSIZE
 308 #define WITH_TARGET_CELL_BITSIZE        WITH_TARGET_WORD_BITSIZE
 309 #endif
 310
 311 #ifndef WITH_TARGET_FLOATING_POINT_BITSIZE
 312 #define WITH_TARGET_FLOATING_POINT_BITSIZE 64
 313 #endif
 314
 315
 316
 317 /* Most significant bit of target:
 318
 319    Set this according to your target's bit numbering convention.  For
 320    the PowerPC it is zero, for many other targets it is 31 or 63.
 321
 322    For targets that can both have either 32 or 64 bit words and number
 323    MSB as 31, 63.  Define this to be (WITH_TARGET_WORD_BITSIZE - 1) */
 324
 325 #ifndef WITH_TARGET_WORD_MSB
 326 #define WITH_TARGET_WORD_MSB            0
 327 #endif
 328
 329
 330
 331 /* Program environment:
 332
 333    Three environments are available - UEA (user), VEA (virtual) and
 334    OEA (perating).  The former two are environment that users would
 335    expect to see (VEA includes things like coherency and the time
 336    base) while OEA is what an operating system expects to see.  By
 337    setting these to specific values, the build process is able to
 338    eliminate non relevent environment code.
 339
 340    STATE_ENVIRONMENT(sd) specifies which of vea or oea is required for
 341    the current runtime.
 342
 343    ALL_ENVIRONMENT is used during configuration as a value for
 344    WITH_ENVIRONMENT to indicate the choice is runtime selectable.
 345    The default is then USER_ENVIRONMENT [since allowing the user to choose
 346    the default at configure time seems like featuritis and since people using
 347    OPERATING_ENVIRONMENT have more to worry about than selecting the
 348    default].
 349    ALL_ENVIRONMENT is also used to set STATE_ENVIRONMENT to the
 350    "uninitialized" state.  */
 351
 352 enum sim_environment {
 353   ALL_ENVIRONMENT,
 354   USER_ENVIRONMENT,
 355   VIRTUAL_ENVIRONMENT,
 356   OPERATING_ENVIRONMENT
 357 };
 358
 359 /* If the simulator specified SIM_AC_OPTION_ENVIRONMENT, indicate so.  */
 360 #ifdef WITH_ENVIRONMENT
 361 #define SIM_HAVE_ENVIRONMENT
 362 #endif
 363
 364 /* If the simulator doesn't specify SIM_AC_OPTION_ENVIRONMENT in its
 365    configure.in, the only supported environment is the user environment.  */
 366 #ifndef WITH_ENVIRONMENT
 367 #define WITH_ENVIRONMENT USER_ENVIRONMENT
 368 #endif
 369
 370 #define DEFAULT_ENVIRONMENT (WITH_ENVIRONMENT != ALL_ENVIRONMENT \
 371                              ? WITH_ENVIRONMENT \
 372                              : USER_ENVIRONMENT)
 373
 374 /* To be prepended to simulator calls with absolute file paths and
 375    chdir:ed at startup.  */
 376 extern char *simulator_sysroot;
 377
 378 /* Callback & Modulo Memory.
 379
 380    Core includes a builtin memory type (raw_memory) that is
 381    implemented using an array.  raw_memory does not require any
 382    additional functions etc.
 383
 384    Callback memory is where the core calls a core device for the data
 385    it requires.  Callback memory can be layered using priorities.
 386
 387    Modulo memory is a variation on raw_memory where ADDRESS & (MODULO
 388    - 1) is used as the index into the memory array.
 389
 390    The OEA model uses callback memory for devices.
 391
 392    The VEA model uses callback memory to capture `page faults'.
 393
 394    BTW, while raw_memory could have been implemented as a callback,
 395    profiling has shown that there is a biger win (at least for the
 396    x86) in eliminating a function call for the most common
 397    (raw_memory) case. */
 398
 399 #ifndef WITH_CALLBACK_MEMORY
 400 #define WITH_CALLBACK_MEMORY            1
 401 #endif
 402
 403 #ifndef WITH_MODULO_MEMORY
 404 #define WITH_MODULO_MEMORY              0
 405 #endif
 406
 407
 408
 409 /* Alignment:
 410
 411    A processor architecture may or may not handle miss aligned
 412    transfers.
 413
 414    As alternatives: both little and big endian modes take an exception
 415    (STRICT_ALIGNMENT); big and little endian models handle mis aligned
 416    transfers (NONSTRICT_ALIGNMENT); or the address is forced into
 417    alignment using a mask (FORCED_ALIGNMENT).
 418
 419    Mixed alignment should be specified when the simulator needs to be
 420    able to change the alignment requirements on the fly (eg for
 421    bi-endian support). */
 422
 423 enum sim_alignments {
 424   MIXED_ALIGNMENT,
 425   NONSTRICT_ALIGNMENT,
 426   STRICT_ALIGNMENT,
 427   FORCED_ALIGNMENT,
 428 };
 429
 430 extern enum sim_alignments current_alignment;
 431
 432 #if !defined (WITH_ALIGNMENT)
 433 #define WITH_ALIGNMENT 0
 434 #endif
 435
 436 #if !defined (WITH_DEFAULT_ALIGNMENT)
 437 #define WITH_DEFAULT_ALIGNMENT 0 /* fatal */
 438 #endif
 439
 440
 441
 442
 443 #define CURRENT_ALIGNMENT (WITH_ALIGNMENT \
 444                            ? WITH_ALIGNMENT \
 445                            : current_alignment)
 446
 447
 448
 449 /* Floating point suport:
 450
 451    Should the processor trap for all floating point instructions (as
 452    if the hardware wasn't implemented) or implement the floating point
 453    instructions directly. */
 454
 455 #if defined (WITH_FLOATING_POINT)
 456
 457 #define SOFT_FLOATING_POINT             1
 458 #define HARD_FLOATING_POINT             2
 459
 460 extern int current_floating_point;
 461 #define CURRENT_FLOATING_POINT (WITH_FLOATING_POINT \
 462                                 ? WITH_FLOATING_POINT \
 463                                 : current_floating_point)
 464
 465 #endif
 466
 467
 468
 469 /* Engine module.
 470
 471    Use the common start/stop/restart framework (sim-engine).
 472    Simulators using the other modules but not the engine should define
 473    WITH_ENGINE=0. */
 474
 475 #ifndef WITH_ENGINE
 476 #define WITH_ENGINE                     1
 477 #endif
 478
 479
 480
 481 /* Debugging:
 482
 483    Control the inclusion of debugging code.
 484    Debugging is only turned on in rare circumstances [say during development]
 485    and is not intended to be turned on otherwise.  */
 486
 487 #ifndef WITH_DEBUG
 488 #define WITH_DEBUG                      0
 489 #endif
 490
 491 /* Include the tracing code.  Disabling this eliminates all tracing
 492    code */
 493
 494 #ifndef WITH_TRACE
 495 #define WITH_TRACE                      (-1)
 496 #endif
 497
 498 /* Include the profiling code.  Disabling this eliminates all profiling
 499    code.  */
 500
 501 #ifndef WITH_PROFILE
 502 #define WITH_PROFILE                    (-1)
 503 #endif
 504
 505
 506 /* include code that checks assertions scattered through out the
 507    program */
 508
 509 #ifndef WITH_ASSERT
 510 #define WITH_ASSERT                     1
 511 #endif
 512
 513
 514 /* Whether to check instructions for reserved bits being set */
 515
 516 /* #define WITH_RESERVED_BITS           1 */
 517
 518
 519
 520 /* include monitoring code */
 521
 522 #define MONITOR_INSTRUCTION_ISSUE       1
 523 #define MONITOR_LOAD_STORE_UNIT         2
 524 /* do not define WITH_MON by default */
 525 #define DEFAULT_WITH_MON                (MONITOR_LOAD_STORE_UNIT \
 526                                          | MONITOR_INSTRUCTION_ISSUE)
 527
 528
 529 /* Current CPU model (models are in the generated models.h include file)  */
 530 #ifndef WITH_MODEL
 531 #define WITH_MODEL                      0
 532 #endif
 533
 534 #define CURRENT_MODEL (WITH_MODEL       \
 535                        ? WITH_MODEL     \
 536                        : current_model)
 537
 538 #ifndef WITH_DEFAULT_MODEL
 539 #define WITH_DEFAULT_MODEL              DEFAULT_MODEL
 540 #endif
 541
 542 #define MODEL_ISSUE_IGNORE              (-1)
 543 #define MODEL_ISSUE_PROCESS             1
 544
 545 #ifndef WITH_MODEL_ISSUE
 546 #define WITH_MODEL_ISSUE                0
 547 #endif
 548
 549 extern int current_model_issue;
 550 #define CURRENT_MODEL_ISSUE (WITH_MODEL_ISSUE   \
 551                              ? WITH_MODEL_ISSUE \
 552                              : current_model_issue)
 553
 554
 555
 556 /* Whether or not input/output just uses stdio, or uses printf_filtered for
 557    output, and polling input for input.  */
 558
 559 #define DONT_USE_STDIO                  2
 560 #define DO_USE_STDIO                    1
 561
 562 #ifndef WITH_STDIO
 563 #define WITH_STDIO                      0
 564 #endif
 565
 566 extern int current_stdio;
 567 #define CURRENT_STDIO (WITH_STDIO       \
 568                        ? WITH_STDIO     \
 569                        : current_stdio)
 570
 571
 572
 573 /* Specify that configured calls pass parameters in registers when the
 574    convention is that they are placed on the stack */
 575
 576 #ifndef WITH_REGPARM
 577 #define WITH_REGPARM                   0
 578 #endif
 579
 580 /* Specify that configured calls use an alternative calling mechanism */
 581
 582 #ifndef WITH_STDCALL
 583 #define WITH_STDCALL                   0
 584 #endif
 585
 586
 587 /* Set the default state configuration, before parsing argv.  */
 588
 589 extern void sim_config_default (SIM_DESC sd);
 590
 591 /* Complete and verify the simulator configuration.  */
 592
 593 extern SIM_RC sim_config (SIM_DESC sd);
 594
 595 /* Print the simulator configuration.  */
 596
 597 extern void print_sim_config (SIM_DESC sd);
 598
 599
 600 #endif