sim/common/sim-config.h

   1 /* The common simulator framework for GDB, the GNU Debugger.
   2
   3    Copyright 2002-2016 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 3 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, see <http://www.gnu.org/licenses/>.  */
  21
  22
  23 #ifndef SIM_CONFIG_H
  24 #define SIM_CONFIG_H
  25
  26
  27 /* Host dependant:
  28
  29    The CPP below defines information about the compilation host.  In
  30    particular it defines the macro's:
  31
  32         WITH_HOST_BYTE_ORDER    The byte order of the host. Could
  33                                 be any of BFD_ENDIAN_LITTLE, BFD_ENDIAN_BIG,
  34                                 or BFD_ENDIAN_UNKNOWN.  Those macro's also
  35                                 need to be defined.
  36
  37  */
  38
  39
  40 #if (defined (__i486__) || defined (__i586__) || defined (__i686__)) && defined(__GNUC__) && WITH_BSWAP
  41 #undef  htonl
  42 #undef  ntohl
  43 #define htonl(IN) __extension__ ({ int _out; __asm__ ("bswap %0" : "=r" (_out) : "0" (IN)); _out; })
  44 #define ntohl(IN) __extension__ ({ int _out; __asm__ ("bswap %0" : "=r" (_out) : "0" (IN)); _out; })
  45 #endif
  46 \f
  47 /* Until devices and tree properties are sorted out, tell sim-config.c
  48    not to call the tree_find_foo fns.  */
  49 #define WITH_TREE_PROPERTIES 0
  50
  51
  52 /* endianness of the host/target:
  53
  54    If the build process is aware (at compile time) of the endianness
  55    of the host/target it is able to eliminate slower generic endian
  56    handling code.
  57
  58    Possible values are BFD_ENDIAN_UNKNOWN, BFD_ENDIAN_LITTLE, BFD_ENDIAN_BIG.  */
  59
  60 #ifndef WITH_HOST_BYTE_ORDER
  61 #define WITH_HOST_BYTE_ORDER            BFD_ENDIAN_UNKNOWN
  62 #endif
  63
  64 #ifndef WITH_TARGET_BYTE_ORDER
  65 #define WITH_TARGET_BYTE_ORDER          BFD_ENDIAN_UNKNOWN
  66 #endif
  67
  68 #ifndef WITH_DEFAULT_TARGET_BYTE_ORDER
  69 #define WITH_DEFAULT_TARGET_BYTE_ORDER  BFD_ENDIAN_UNKNOWN
  70 #endif
  71
  72 extern enum bfd_endian current_host_byte_order;
  73 #define CURRENT_HOST_BYTE_ORDER \
  74   (WITH_HOST_BYTE_ORDER != BFD_ENDIAN_UNKNOWN \
  75    ? WITH_HOST_BYTE_ORDER : current_host_byte_order)
  76 extern enum bfd_endian current_target_byte_order;
  77 #define CURRENT_TARGET_BYTE_ORDER \
  78   (WITH_TARGET_BYTE_ORDER != BFD_ENDIAN_UNKNOWN \
  79    ? WITH_TARGET_BYTE_ORDER : current_target_byte_order)
  80
  81
  82
  83 /* XOR endian.
  84
  85    In addition to the above, the simulator can support the horrible
  86    XOR endian mode (as found in the PowerPC and MIPS ISA).  See
  87    sim-core for more information.
  88
  89    If WITH_XOR_ENDIAN is non-zero, it specifies the number of bytes
  90    potentially involved in the XOR munge. A typical value is 8. */
  91
  92 #ifndef WITH_XOR_ENDIAN
  93 #define WITH_XOR_ENDIAN         0
  94 #endif
  95
  96
  97
  98 /* Intel host BSWAP support:
  99
 100    Whether to use bswap on the 486 and pentiums rather than the 386
 101    sequence that uses xchgb/rorl/xchgb */
 102 #ifndef WITH_BSWAP
 103 #define WITH_BSWAP 0
 104 #endif
 105
 106
 107
 108 /* SMP support:
 109
 110    Sets a limit on the number of processors that can be simulated.  If
 111    WITH_SMP is set to zero (0), the simulator is restricted to
 112    suporting only one processor (and as a consequence leaves the SMP
 113    code out of the build process).
 114
 115    The actual number of processors is taken from the device
 116    /options/smp@<nr-cpu> */
 117
 118 #if defined (WITH_SMP) && (WITH_SMP > 0)
 119 #define MAX_NR_PROCESSORS               WITH_SMP
 120 #endif
 121
 122 #ifndef MAX_NR_PROCESSORS
 123 #define MAX_NR_PROCESSORS               1
 124 #endif
 125
 126
 127 /* Size of target word, address and OpenFirmware Cell:
 128
 129    The target word size is determined by the natural size of its
 130    reginsters.
 131
 132    On most hosts, the address and cell are the same size as a target
 133    word.  */
 134
 135 #ifndef WITH_TARGET_WORD_BITSIZE
 136 #define WITH_TARGET_WORD_BITSIZE        32
 137 #endif
 138
 139 #ifndef WITH_TARGET_ADDRESS_BITSIZE
 140 #define WITH_TARGET_ADDRESS_BITSIZE     WITH_TARGET_WORD_BITSIZE
 141 #endif
 142
 143 #ifndef WITH_TARGET_CELL_BITSIZE
 144 #define WITH_TARGET_CELL_BITSIZE        WITH_TARGET_WORD_BITSIZE
 145 #endif
 146
 147 #ifndef WITH_TARGET_FLOATING_POINT_BITSIZE
 148 #define WITH_TARGET_FLOATING_POINT_BITSIZE 64
 149 #endif
 150
 151
 152
 153 /* Most significant bit of target:
 154
 155    Set this according to your target's bit numbering convention.  For
 156    the PowerPC it is zero, for many other targets it is 31 or 63.
 157
 158    For targets that can both have either 32 or 64 bit words and number
 159    MSB as 31, 63.  Define this to be (WITH_TARGET_WORD_BITSIZE - 1) */
 160
 161 #ifndef WITH_TARGET_WORD_MSB
 162 #define WITH_TARGET_WORD_MSB            0
 163 #endif
 164
 165
 166
 167 /* Program environment:
 168
 169    Three environments are available - UEA (user), VEA (virtual) and
 170    OEA (perating).  The former two are environment that users would
 171    expect to see (VEA includes things like coherency and the time
 172    base) while OEA is what an operating system expects to see.  By
 173    setting these to specific values, the build process is able to
 174    eliminate non relevent environment code.
 175
 176    STATE_ENVIRONMENT(sd) specifies which of vea or oea is required for
 177    the current runtime.
 178
 179    ALL_ENVIRONMENT is used during configuration as a value for
 180    WITH_ENVIRONMENT to indicate the choice is runtime selectable.
 181    The default is then USER_ENVIRONMENT [since allowing the user to choose
 182    the default at configure time seems like featuritis and since people using
 183    OPERATING_ENVIRONMENT have more to worry about than selecting the
 184    default].
 185    ALL_ENVIRONMENT is also used to set STATE_ENVIRONMENT to the
 186    "uninitialized" state.  */
 187
 188 enum sim_environment {
 189   ALL_ENVIRONMENT,
 190   USER_ENVIRONMENT,
 191   VIRTUAL_ENVIRONMENT,
 192   OPERATING_ENVIRONMENT
 193 };
 194
 195 /* If the simulator specified SIM_AC_OPTION_ENVIRONMENT, indicate so.  */
 196 #ifdef WITH_ENVIRONMENT
 197 #define SIM_HAVE_ENVIRONMENT
 198 #endif
 199
 200 /* If the simulator doesn't specify SIM_AC_OPTION_ENVIRONMENT in its
 201    configure.ac, the only supported environment is the user environment.  */
 202 #ifndef WITH_ENVIRONMENT
 203 #define WITH_ENVIRONMENT USER_ENVIRONMENT
 204 #endif
 205
 206 #define DEFAULT_ENVIRONMENT (WITH_ENVIRONMENT != ALL_ENVIRONMENT \
 207                              ? WITH_ENVIRONMENT \
 208                              : USER_ENVIRONMENT)
 209
 210 /* To be prepended to simulator calls with absolute file paths and
 211    chdir:ed at startup.  */
 212 extern char *simulator_sysroot;
 213
 214 /* Callback & Modulo Memory.
 215
 216    Core includes a builtin memory type (raw_memory) that is
 217    implemented using an array.  raw_memory does not require any
 218    additional functions etc.
 219
 220    Callback memory is where the core calls a core device for the data
 221    it requires.  Callback memory can be layered using priorities.
 222
 223    Modulo memory is a variation on raw_memory where ADDRESS & (MODULO
 224    - 1) is used as the index into the memory array.
 225
 226    The OEA model uses callback memory for devices.
 227
 228    The VEA model uses callback memory to capture `page faults'.
 229
 230    BTW, while raw_memory could have been implemented as a callback,
 231    profiling has shown that there is a biger win (at least for the
 232    x86) in eliminating a function call for the most common
 233    (raw_memory) case. */
 234
 235
 236 /* Alignment:
 237
 238    A processor architecture may or may not handle miss aligned
 239    transfers.
 240
 241    As alternatives: both little and big endian modes take an exception
 242    (STRICT_ALIGNMENT); big and little endian models handle mis aligned
 243    transfers (NONSTRICT_ALIGNMENT); or the address is forced into
 244    alignment using a mask (FORCED_ALIGNMENT).
 245
 246    Mixed alignment should be specified when the simulator needs to be
 247    able to change the alignment requirements on the fly (eg for
 248    bi-endian support). */
 249
 250 enum sim_alignments {
 251   MIXED_ALIGNMENT,
 252   NONSTRICT_ALIGNMENT,
 253   STRICT_ALIGNMENT,
 254   FORCED_ALIGNMENT,
 255 };
 256
 257 extern enum sim_alignments current_alignment;
 258
 259 #if !defined (WITH_ALIGNMENT)
 260 #define WITH_ALIGNMENT 0
 261 #endif
 262
 263 #if !defined (WITH_DEFAULT_ALIGNMENT)
 264 #define WITH_DEFAULT_ALIGNMENT 0 /* fatal */
 265 #endif
 266
 267
 268
 269
 270 #define CURRENT_ALIGNMENT (WITH_ALIGNMENT \
 271                            ? WITH_ALIGNMENT \
 272                            : current_alignment)
 273
 274
 275
 276 /* Floating point suport:
 277
 278    Should the processor trap for all floating point instructions (as
 279    if the hardware wasn't implemented) or implement the floating point
 280    instructions directly. */
 281
 282 #if defined (WITH_FLOATING_POINT)
 283
 284 #define SOFT_FLOATING_POINT             1
 285 #define HARD_FLOATING_POINT             2
 286
 287 extern int current_floating_point;
 288 #define CURRENT_FLOATING_POINT (WITH_FLOATING_POINT \
 289                                 ? WITH_FLOATING_POINT \
 290                                 : current_floating_point)
 291
 292 #endif
 293
 294
 295 /* Debugging:
 296
 297    Control the inclusion of debugging code.
 298    Debugging is only turned on in rare circumstances [say during development]
 299    and is not intended to be turned on otherwise.  */
 300
 301 #ifndef WITH_DEBUG
 302 #define WITH_DEBUG                      0
 303 #endif
 304
 305 /* Include the tracing code.  Disabling this eliminates all tracing
 306    code.  Default to all tracing but internal debug.  */
 307
 308 #ifndef WITH_TRACE
 309 #define WITH_TRACE                      (~TRACE_debug)
 310 #endif
 311
 312 /* Include the profiling code.  Disabling this eliminates all profiling
 313    code.  */
 314
 315 #ifndef WITH_PROFILE
 316 #define WITH_PROFILE                    (-1)
 317 #endif
 318
 319
 320 /* include code that checks assertions scattered through out the
 321    program */
 322
 323 #ifndef WITH_ASSERT
 324 #define WITH_ASSERT                     1
 325 #endif
 326
 327
 328 /* Whether to check instructions for reserved bits being set */
 329
 330 /* #define WITH_RESERVED_BITS           1 */
 331
 332
 333
 334 /* include monitoring code */
 335
 336 #define MONITOR_INSTRUCTION_ISSUE       1
 337 #define MONITOR_LOAD_STORE_UNIT         2
 338 /* do not define WITH_MON by default */
 339 #define DEFAULT_WITH_MON                (MONITOR_LOAD_STORE_UNIT \
 340                                          | MONITOR_INSTRUCTION_ISSUE)
 341
 342
 343 /* Current CPU model (models are in the generated models.h include file)  */
 344 #ifndef WITH_MODEL
 345 #define WITH_MODEL                      0
 346 #endif
 347
 348 #define CURRENT_MODEL (WITH_MODEL       \
 349                        ? WITH_MODEL     \
 350                        : current_model)
 351
 352 #define MODEL_ISSUE_IGNORE              (-1)
 353 #define MODEL_ISSUE_PROCESS             1
 354
 355 #ifndef WITH_MODEL_ISSUE
 356 #define WITH_MODEL_ISSUE                0
 357 #endif
 358
 359 extern int current_model_issue;
 360 #define CURRENT_MODEL_ISSUE (WITH_MODEL_ISSUE   \
 361                              ? WITH_MODEL_ISSUE \
 362                              : current_model_issue)
 363
 364
 365
 366 /* Whether or not input/output just uses stdio, or uses printf_filtered for
 367    output, and polling input for input.  */
 368
 369 #define DONT_USE_STDIO                  2
 370 #define DO_USE_STDIO                    1
 371
 372 #ifndef WITH_STDIO
 373 #define WITH_STDIO                      0
 374 #endif
 375
 376 extern int current_stdio;
 377 #define CURRENT_STDIO (WITH_STDIO       \
 378                        ? WITH_STDIO     \
 379                        : current_stdio)
 380
 381
 382
 383 /* Specify that configured calls pass parameters in registers when the
 384    convention is that they are placed on the stack */
 385
 386 #ifndef WITH_REGPARM
 387 #define WITH_REGPARM                   0
 388 #endif
 389
 390 /* Specify that configured calls use an alternative calling mechanism */
 391
 392 #ifndef WITH_STDCALL
 393 #define WITH_STDCALL                   0
 394 #endif
 395
 396
 397 /* Set the default state configuration, before parsing argv.  */
 398
 399 extern void sim_config_default (SIM_DESC sd);
 400
 401 /* Complete and verify the simulator configuration.  */
 402
 403 extern SIM_RC sim_config (SIM_DESC sd);
 404
 405 /* Print the simulator configuration.  */
 406
 407 extern void print_sim_config (SIM_DESC sd);
 408
 409
 410 #endif