sim/common/sim-config.h

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