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