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
 208
 209 /* endianness of the host/target:
 210
 211    If the build process is aware (at compile time) of the endianness
 212    of the host/target it is able to eliminate slower generic endian
 213    handling code.
 214
 215    Possible values are 0 (unknown), LITTLE_ENDIAN, BIG_ENDIAN */
 216
 217 #ifndef WITH_HOST_BYTE_ORDER
 218 #define WITH_HOST_BYTE_ORDER            0 /*unknown*/
 219 #endif
 220
 221 #ifndef WITH_TARGET_BYTE_ORDER
 222 #define WITH_TARGET_BYTE_ORDER          0 /*unknown*/
 223 #endif
 224
 225 #ifndef WITH_DEFAULT_TARGET_BYTE_ORDER
 226 #define WITH_DEFAULT_TARGET_BYTE_ORDER 0 /* fatal */
 227 #endif
 228
 229 extern int current_host_byte_order;
 230 #define CURRENT_HOST_BYTE_ORDER (WITH_HOST_BYTE_ORDER \
 231                                  ? WITH_HOST_BYTE_ORDER \
 232                                  : current_host_byte_order)
 233 extern int current_target_byte_order;
 234 #define CURRENT_TARGET_BYTE_ORDER (WITH_TARGET_BYTE_ORDER \
 235                                    ? WITH_TARGET_BYTE_ORDER \
 236                                    : current_target_byte_order)
 237
 238
 239
 240 /* XOR endian.
 241
 242    In addition to the above, the simulator can support the horrible
 243    XOR endian mode (as found in the PowerPC and MIPS ISA).  See
 244    sim-core for more information.
 245
 246    If WITH_XOR_ENDIAN is non-zero, it specifies the number of bytes
 247    potentially involved in the XOR munge. A typical value is 8. */
 248
 249 #ifndef WITH_XOR_ENDIAN
 250 #define WITH_XOR_ENDIAN         0
 251 #endif
 252
 253
 254
 255 /* Intel host BSWAP support:
 256
 257    Whether to use bswap on the 486 and pentiums rather than the 386
 258    sequence that uses xchgb/rorl/xchgb */
 259 #ifndef WITH_BSWAP
 260 #define WITH_BSWAP 0
 261 #endif
 262
 263
 264
 265 /* SMP support:
 266
 267    Sets a limit on the number of processors that can be simulated.  If
 268    WITH_SMP is set to zero (0), the simulator is restricted to
 269    suporting only one processor (and as a consequence leaves the SMP
 270    code out of the build process).
 271
 272    The actual number of processors is taken from the device
 273    /options/smp@<nr-cpu> */
 274
 275 #if defined (WITH_SMP) && WITH_SMP > 0
 276 #define MAX_NR_PROCESSORS               WITH_SMP
 277 #endif
 278
 279 #ifndef MAX_NR_PROCESSORS
 280 #define MAX_NR_PROCESSORS               1
 281 #endif
 282
 283
 284 /* Word size of host/target:
 285
 286    Set these according to your host and target requirements.  At this
 287    point in time, I've only compiled (not run) for a 64bit and never
 288    built for a 64bit host.  This will always remain a compile time
 289    option */
 290
 291 #ifndef WITH_TARGET_WORD_BITSIZE
 292 #define WITH_TARGET_WORD_BITSIZE        32 /* compiled only */
 293 #endif
 294
 295 #ifndef WITH_HOST_WORD_BITSIZE
 296 #define WITH_HOST_WORD_BITSIZE          32 /* 64bit ready? */
 297 #endif
 298
 299
 300
 301 /* Most significant bit of target:
 302
 303    Set this according to your target's bit numbering convention.  For
 304    the PowerPC it is zero, for many other targets it is 31 or 63.
 305
 306    For targets that can both have either 32 or 64 bit words and number
 307    MSB as 31, 63.  Define this to be (WITH_TARGET_WORD_BITSIZE - 1) */
 308
 309 #ifndef WITH_TARGET_WORD_MSB
 310 #define WITH_TARGET_WORD_MSB            0
 311 #endif
 312
 313
 314
 315 /* Program environment:
 316
 317    Three environments are available - UEA (user), VEA (virtual) and
 318    OEA (perating).  The former two are environment that users would
 319    expect to see (VEA includes things like coherency and the time
 320    base) while OEA is what an operating system expects to see.  By
 321    setting these to specific values, the build process is able to
 322    eliminate non relevent environment code.
 323
 324    CURRENT_ENVIRONMENT specifies which of vea or oea is required for
 325    the current runtime.
 326
 327    ALL_ENVIRONMENT is used during configuration as a value for
 328    WITH_ENVIRONMENT to indicate the choice is runtime selectable.
 329    The default is then USER_ENVIRONMENT [since allowing the user to choose
 330    the default at configure time seems like featuritis and since people using
 331    OPERATING_ENVIRONMENT have more to worry about than selecting the default].
 332    ALL_ENVIRONMENT is also used to set `current_environment' to the
 333    "unknown" state.  */
 334
 335 enum sim_environment {
 336   ALL_ENVIRONMENT,
 337   USER_ENVIRONMENT,
 338   VIRTUAL_ENVIRONMENT,
 339   OPERATING_ENVIRONMENT
 340 };
 341
 342 /* If the simulator specified SIM_AC_OPTION_ENVIRONMENT, indicate so.  */
 343 #ifdef WITH_ENVIRONMENT
 344 #define SIM_HAVE_ENVIRONMENT
 345 #endif
 346
 347 /* If the simulator doesn't specify SIM_AC_OPTION_ENVIRONMENT in its
 348    configure.in, the only supported environment is the user environment.  */
 349 #ifndef WITH_ENVIRONMENT
 350 #define WITH_ENVIRONMENT USER_ENVIRONMENT
 351 #endif
 352
 353 #define DEFAULT_ENVIRONMENT (WITH_ENVIRONMENT != ALL_ENVIRONMENT \
 354                              ? WITH_ENVIRONMENT \
 355                              : USER_ENVIRONMENT)
 356
 357 extern enum sim_environment current_environment;
 358 #define CURRENT_ENVIRONMENT (WITH_ENVIRONMENT != ALL_ENVIRONMENT \
 359                              ? WITH_ENVIRONMENT \
 360                              : current_environment)
 361
 362
 363 /* Callback & Modulo Memory.
 364
 365    Core includes a builtin memory type (raw_memory) that is
 366    implemented using an array.  raw_memory does not require any
 367    additional functions etc.
 368
 369    Callback memory is where the core calls a core device for the data
 370    it requires.  Callback memory can be layered using priorities.
 371
 372    Modulo memory is a variation on raw_memory where ADDRESS & (MODULO
 373    - 1) is used as the index into the memory array.
 374
 375    The OEA model uses callback memory for devices.
 376
 377    The VEA model uses callback memory to capture `page faults'.
 378
 379    BTW, while raw_memory could have been implemented as a callback,
 380    profiling has shown that there is a biger win (at least for the
 381    x86) in eliminating a function call for the most common
 382    (raw_memory) case. */
 383
 384 #ifndef WITH_CALLBACK_MEMORY
 385 #define WITH_CALLBACK_MEMORY            1
 386 #endif
 387
 388 #ifndef WITH_MODULO_MEMORY
 389 #define WITH_MODULO_MEMORY              0
 390 #endif
 391
 392
 393
 394 /* Alignment:
 395
 396    A processor architecture may or may not handle miss aligned
 397    transfers.
 398
 399    As alternatives: both little and big endian modes take an exception
 400    (STRICT_ALIGNMENT); big and little endian models handle mis aligned
 401    transfers (NONSTRICT_ALIGNMENT); or the address is forced into
 402    alignment using a mask (FORCED_ALIGNMENT).
 403
 404    Mixed alignment should be specified when the simulator needs to be
 405    able to change the alignment requirements on the fly (eg for
 406    bi-endian support). */
 407
 408 enum sim_alignments {
 409   MIXED_ALIGNMENT,
 410   NONSTRICT_ALIGNMENT,
 411   STRICT_ALIGNMENT,
 412   FORCED_ALIGNMENT,
 413 };
 414
 415 extern enum sim_alignments current_alignment;
 416
 417 #if !defined (WITH_ALIGNMENT)
 418 #define WITH_ALIGNMENT 0
 419 #endif
 420
 421 #if !defined (WITH_DEFAULT_ALIGNMENT)
 422 #define WITH_DEFAULT_ALIGNMENT 0 /* fatal */
 423 #endif
 424
 425
 426
 427
 428 #define CURRENT_ALIGNMENT (WITH_ALIGNMENT \
 429                            ? WITH_ALIGNMENT \
 430                            : current_alignment)
 431
 432
 433
 434 /* Floating point suport:
 435
 436    Should the processor trap for all floating point instructions (as
 437    if the hardware wasn't implemented) or implement the floating point
 438    instructions directly. */
 439
 440 #if defined (WITH_FLOATING_POINT)
 441
 442 #define SOFT_FLOATING_POINT             1
 443 #define HARD_FLOATING_POINT             2
 444
 445 extern int current_floating_point;
 446 #define CURRENT_FLOATING_POINT (WITH_FLOATING_POINT \
 447                                 ? WITH_FLOATING_POINT \
 448                                 : current_floating_point)
 449
 450 #endif
 451
 452
 453
 454 /* Engine module.
 455
 456    Use the common start/stop/restart framework (sim-engine).
 457    Simulators using the other modules but not the engine should define
 458    WITH_ENGINE=0. */
 459
 460 #ifndef WITH_ENGINE
 461 #define WITH_ENGINE                     1
 462 #endif
 463
 464
 465
 466 /* Debugging:
 467
 468    Control the inclusion of debugging code.
 469    Debugging is only turned on in rare circumstances [say during development]
 470    and is not intended to be turned on otherwise.  */
 471
 472 #ifndef WITH_DEBUG
 473 #define WITH_DEBUG                      0
 474 #endif
 475
 476 /* Include the tracing code.  Disabling this eliminates all tracing
 477    code */
 478
 479 #ifndef WITH_TRACE
 480 #define WITH_TRACE                      (-1)
 481 #endif
 482
 483 /* Include the profiling code.  Disabling this eliminates all profiling
 484    code.  */
 485
 486 #ifndef WITH_PROFILE
 487 #define WITH_PROFILE                    (-1)
 488 #endif
 489
 490
 491 /* include code that checks assertions scattered through out the
 492    program */
 493
 494 #ifndef WITH_ASSERT
 495 #define WITH_ASSERT                     1
 496 #endif
 497
 498
 499 /* Whether to check instructions for reserved bits being set */
 500
 501 /* #define WITH_RESERVED_BITS           1 */
 502
 503
 504
 505 /* include monitoring code */
 506
 507 #define MONITOR_INSTRUCTION_ISSUE       1
 508 #define MONITOR_LOAD_STORE_UNIT         2
 509 /* do not define WITH_MON by default */
 510 #define DEFAULT_WITH_MON                (MONITOR_LOAD_STORE_UNIT \
 511                                          | MONITOR_INSTRUCTION_ISSUE)
 512
 513
 514 /* Current CPU model (models are in the generated models.h include file)  */
 515 #ifndef WITH_MODEL
 516 #define WITH_MODEL                      0
 517 #endif
 518
 519 #define CURRENT_MODEL (WITH_MODEL       \
 520                        ? WITH_MODEL     \
 521                        : current_model)
 522
 523 #ifndef WITH_DEFAULT_MODEL
 524 #define WITH_DEFAULT_MODEL              DEFAULT_MODEL
 525 #endif
 526
 527 #define MODEL_ISSUE_IGNORE              (-1)
 528 #define MODEL_ISSUE_PROCESS             1
 529
 530 #ifndef WITH_MODEL_ISSUE
 531 #define WITH_MODEL_ISSUE                0
 532 #endif
 533
 534 extern int current_model_issue;
 535 #define CURRENT_MODEL_ISSUE (WITH_MODEL_ISSUE   \
 536                              ? WITH_MODEL_ISSUE \
 537                              : current_model_issue)
 538
 539
 540
 541 /* Whether or not input/output just uses stdio, or uses printf_filtered for
 542    output, and polling input for input.  */
 543
 544 #define DONT_USE_STDIO                  2
 545 #define DO_USE_STDIO                    1
 546
 547 #ifndef WITH_STDIO
 548 #define WITH_STDIO                      0
 549 #endif
 550
 551 extern int current_stdio;
 552 #define CURRENT_STDIO (WITH_STDIO       \
 553                        ? WITH_STDIO     \
 554                        : current_stdio)
 555
 556
 557
 558 /* Specify that configured calls pass parameters in registers when the
 559    convention is that they are placed on the stack */
 560
 561 #ifndef WITH_REGPARM
 562 #define WITH_REGPARM                   0
 563 #endif
 564
 565 /* Specify that configured calls use an alternative calling mechanism */
 566
 567 #ifndef WITH_STDCALL
 568 #define WITH_STDCALL                   0
 569 #endif
 570
 571
 572 /* complete/verify/print the simulator configuration */
 573
 574 extern SIM_RC sim_config
 575 (SIM_DESC sd);
 576
 577
 578 extern void print_sim_config (SIM_DESC sd);
 579
 580
 581 #endif /* _PSIM_CONFIG_H */