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 extern int current_host_byte_order;
 226 #define CURRENT_HOST_BYTE_ORDER (WITH_HOST_BYTE_ORDER \
 227                                  ? WITH_HOST_BYTE_ORDER \
 228                                  : current_host_byte_order)
 229 extern int current_target_byte_order;
 230 #define CURRENT_TARGET_BYTE_ORDER (WITH_TARGET_BYTE_ORDER \
 231                                    ? WITH_TARGET_BYTE_ORDER \
 232                                    : current_target_byte_order)
 233
 234
 235
 236 /* XOR endian.
 237
 238    In addition to the above, the simulator can support the's horrible
 239    XOR endian mode (for instance implemented by the PowerPC).  This
 240    feature makes it possible to control the endian mode of a processor
 241    using the MSR. */
 242
 243 /* #define WITH_XOR_ENDIAN              8 */
 244
 245
 246
 247 /* Intel host BSWAP support:
 248
 249    Whether to use bswap on the 486 and pentiums rather than the 386
 250    sequence that uses xchgb/rorl/xchgb */
 251 #ifndef WITH_BSWAP
 252 #define WITH_BSWAP 0
 253 #endif
 254
 255
 256
 257 /* SMP support:
 258
 259    Sets a limit on the number of processors that can be simulated.  If
 260    WITH_SMP is set to zero (0), the simulator is restricted to
 261    suporting only on processor (and as a consequence leaves the SMP
 262    code out of the build process).
 263
 264    The actual number of processors is taken from the device
 265    /options/smp@<nr-cpu> */
 266
 267 #if defined (WITH_SMP)
 268
 269 #if WITH_SMP
 270 #define MAX_NR_PROCESSORS               WITH_SMP
 271 #else
 272 #define MAX_NR_PROCESSORS               1
 273 #endif
 274
 275 #endif
 276
 277
 278
 279 /* Word size of host/target:
 280
 281    Set these according to your host and target requirements.  At this
 282    point in time, I've only compiled (not run) for a 64bit and never
 283    built for a 64bit host.  This will always remain a compile time
 284    option */
 285
 286 #ifndef WITH_TARGET_WORD_BITSIZE
 287 #define WITH_TARGET_WORD_BITSIZE        32 /* compiled only */
 288 #endif
 289
 290 #ifndef WITH_HOST_WORD_BITSIZE
 291 #define WITH_HOST_WORD_BITSIZE          32 /* 64bit ready? */
 292 #endif
 293
 294
 295
 296 /* Most significant bit of target:
 297
 298    Set this according to your target's bit numbering convention.  For
 299    the PowerPC it is zero, for many other targets it is 31 or 63.
 300
 301    For targets that can both have either 32 or 64 bit words and number
 302    MSB as 31, 63.  Define this to be (WITH_TARGET_WORD_BITSIZE - 1) */
 303
 304 #ifndef WITH_TARGET_WORD_MSB
 305 #define WITH_TARGET_WORD_MSB            0
 306 #endif
 307
 308
 309
 310 /* Program environment:
 311
 312    Three environments are available - UEA (user), VEA (virtual) and
 313    OEA (perating).  The former two are environment that users would
 314    expect to see (VEA includes things like coherency and the time
 315    base) while OEA is what an operating system expects to see.  By
 316    setting these to specific values, the build process is able to
 317    eliminate non relevent environment code
 318
 319    CURRENT_ENVIRONMENT specifies which of vea or oea is required for
 320    the current runtime. */
 321
 322 #if defined (WITH_ENVIRONMENT)
 323
 324 #define USER_ENVIRONMENT                1
 325 #define VIRTUAL_ENVIRONMENT             2
 326 #define OPERATING_ENVIRONMENT           3
 327
 328 extern int current_environment;
 329 #define CURRENT_ENVIRONMENT (WITH_ENVIRONMENT \
 330                              ? WITH_ENVIRONMENT \
 331                              : current_environment)
 332
 333 #endif
 334
 335
 336
 337 /* Callback/Default Memory.
 338
 339    Core includes a builtin memory type (raw_memory) that is
 340    implemented using an array.  raw_memory does not require any
 341    additional functions etc.
 342
 343    Callback memory is where the core calls a core device for the data
 344    it requires.
 345
 346    Default memory is an extenstion of this where for addresses that do
 347    not map into either a callback or core memory range a default map
 348    can be used.
 349
 350    The OEA model uses callback memory for devices and default memory
 351    for buses.
 352
 353    The VEA model uses callback memory to capture `page faults'.
 354
 355    While it may be possible to eliminate callback/default memory (and
 356    hence also eliminate an additional test per memory fetch) it
 357    probably is not worth the effort.
 358
 359    BTW, while raw_memory could have been implemented as a callback,
 360    profiling has shown that there is a biger win (at least for the
 361    x86) in eliminating a function call for the most common
 362    (raw_memory) case. */
 363
 364 #ifndef WITH_CALLBACK_MEMORY
 365 #define WITH_CALLBACK_MEMORY            1
 366 #endif
 367
 368
 369
 370 /* Alignment:
 371
 372    The PowerPC may or may not handle miss aligned transfers.  An
 373    implementation normally handles miss aligned transfers in big
 374    endian mode but generates an exception in little endian mode.
 375
 376    This model.  Instead allows both little and big endian modes to
 377    either take exceptions or handle miss aligned transfers.
 378
 379    If 0 is specified then for big-endian mode miss alligned accesses
 380    are permitted (NONSTRICT_ALIGNMENT) while in little-endian mode the
 381    processor will fault on them (STRICT_ALIGNMENT). */
 382
 383 #if defined (WITH_ALIGNMENT)
 384
 385 #define NONSTRICT_ALIGNMENT             1
 386 #define STRICT_ALIGNMENT                2
 387
 388 extern int current_alignment;
 389 #define CURRENT_ALIGNMENT (WITH_ALIGNMENT \
 390                            ? WITH_ALIGNMENT \
 391                            : current_alignment)
 392
 393 #endif
 394
 395
 396
 397 /* Floating point suport:
 398
 399    Should the processor trap for all floating point instructions (as
 400    if the hardware wasn't implemented) or implement the floating point
 401    instructions directly. */
 402
 403 #if defined (WITH_FLOATING_POINT)
 404
 405 #define SOFT_FLOATING_POINT             1
 406 #define HARD_FLOATING_POINT             2
 407
 408 extern int current_floating_point;
 409 #define CURRENT_FLOATING_POINT (WITH_FLOATING_POINT \
 410                                 ? WITH_FLOATING_POINT \
 411                                 : current_floating_point)
 412
 413 #endif
 414
 415
 416
 417 /* Debugging:
 418
 419    Control the inclusion of debugging code.
 420    Debugging is only turned on in rare circumstances [say during development]
 421    and is not intended to be turned on otherwise.  */
 422
 423 #ifndef WITH_DEBUG
 424 #define WITH_DEBUG                      0
 425 #endif
 426
 427 /* Include the tracing code.  Disabling this eliminates all tracing
 428    code */
 429
 430 #ifndef WITH_TRACE
 431 #define WITH_TRACE                      1
 432 #endif
 433
 434
 435 /* include code that checks assertions scattered through out the
 436    program */
 437
 438 #ifndef WITH_ASSERT
 439 #define WITH_ASSERT                     1
 440 #endif
 441
 442
 443 /* Whether to check instructions for reserved bits being set */
 444
 445 /* #define WITH_RESERVED_BITS           1 */
 446
 447
 448
 449 /* include monitoring code */
 450
 451 #define MONITOR_INSTRUCTION_ISSUE       1
 452 #define MONITOR_LOAD_STORE_UNIT         2
 453 /* do not define WITH_MON by default */
 454 #define DEFAULT_WITH_MON                (MONITOR_LOAD_STORE_UNIT \
 455                                          | MONITOR_INSTRUCTION_ISSUE)
 456
 457
 458 /* Current CPU model (models are in the generated models.h include file)  */
 459 #ifndef WITH_MODEL
 460 #define WITH_MODEL                      0
 461 #endif
 462
 463 #define CURRENT_MODEL (WITH_MODEL       \
 464                        ? WITH_MODEL     \
 465                        : current_model)
 466
 467 #ifndef WITH_DEFAULT_MODEL
 468 #define WITH_DEFAULT_MODEL              DEFAULT_MODEL
 469 #endif
 470
 471 #define MODEL_ISSUE_IGNORE              (-1)
 472 #define MODEL_ISSUE_PROCESS             1
 473
 474 #ifndef WITH_MODEL_ISSUE
 475 #define WITH_MODEL_ISSUE                0
 476 #endif
 477
 478 extern int current_model_issue;
 479 #define CURRENT_MODEL_ISSUE (WITH_MODEL_ISSUE   \
 480                              ? WITH_MODEL_ISSUE \
 481                              : current_model_issue)
 482
 483
 484
 485 /* Whether or not input/output just uses stdio, or uses printf_filtered for
 486    output, and polling input for input.  */
 487
 488 #define DONT_USE_STDIO                  2
 489 #define DO_USE_STDIO                    1
 490
 491 #ifndef WITH_STDIO
 492 #define WITH_STDIO                      0
 493 #endif
 494
 495 extern int current_stdio;
 496 #define CURRENT_STDIO (WITH_STDIO       \
 497                        ? WITH_STDIO     \
 498                        : current_stdio)
 499
 500
 501
 502 /* Specify that configured calls pass parameters in registers when the
 503    convention is that they are placed on the stack */
 504
 505 #ifndef WITH_REGPARM
 506 #define WITH_REGPARM                   0
 507 #endif
 508
 509 /* Specify that configured calls use an alternative calling mechanism */
 510
 511 #ifndef WITH_STDCALL
 512 #define WITH_STDCALL                   0
 513 #endif
 514
 515
 516 /* complete/verify/print the simulator configuration */
 517
 518
 519 /* For prefered_target_byte_order arugment */
 520
 521 #if defined (bfd_little_endian)
 522 #define PREFERED_TARGET_BYTE_ORDER(IMAGE) ((IMAGE) == NULL \
 523                                            ? 0 \
 524                                            : bfd_little_endian(IMAGE) \
 525                                            ? LITTLE_ENDIAN \
 526                                            : BIG_ENDIAN)
 527 #else
 528 #define PREFERED_TARGET_BYTE_ORDER(IMAGE) ((IMAGE) == NULL \
 529                                            ? 0 \
 530                                            : !(IMAGE)->xvec->byteorder_big_p \
 531                                            ? LITTLE_ENDIAN \
 532                                            : BIG_ENDIAN)
 533 #endif
 534
 535
 536 extern void sim_config (SIM_DESC sd,
 537                         int prefered_target_byte_order);
 538
 539 extern void print_sim_config (SIM_DESC sd);
 540
 541
 542 #endif /* _PSIM_CONFIG_H */