1 /* The common simulator framework for GDB, the GNU Debugger.
3 Copyright 2002-2016 Free Software Foundation, Inc.
5 Contributed by Andrew Cagney and Red Hat.
7 This file is part of GDB.
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.
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.
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/>. */
29 The CPP below defines information about the compilation host. In
30 particular it defines the macro's:
32 WITH_HOST_BYTE_ORDER The byte order of the host. Could
33 be any of LITTLE_ENDIAN, BIG_ENDIAN
34 or 0 (unknown). Those macro's also
42 NetBSD is easy, everything you could ever want is in a header file
45 #if defined(__NetBSD__)
46 # include <machine/endian.h>
47 # if (WITH_HOST_BYTE_ORDER == 0)
48 # undef WITH_HOST_BYTE_ORDER
49 # define WITH_HOST_BYTE_ORDER BYTE_ORDER
51 # if (BYTE_ORDER != WITH_HOST_BYTE_ORDER)
52 # error "host endian incorrectly configured, check config.h"
56 /* Linux is similarly easy. */
58 #if defined(__linux__)
60 # if defined(__LITTLE_ENDIAN) && !defined(LITTLE_ENDIAN)
61 # define LITTLE_ENDIAN __LITTLE_ENDIAN
63 # if defined(__BIG_ENDIAN) && !defined(BIG_ENDIAN)
64 # define BIG_ENDIAN __BIG_ENDIAN
66 # if defined(__BYTE_ORDER) && !defined(BYTE_ORDER)
67 # define BYTE_ORDER __BYTE_ORDER
69 # if (WITH_HOST_BYTE_ORDER == 0)
70 # undef WITH_HOST_BYTE_ORDER
71 # define WITH_HOST_BYTE_ORDER BYTE_ORDER
73 # if (BYTE_ORDER != WITH_HOST_BYTE_ORDER)
74 # error "host endian incorrectly configured, check config.h"
78 /* INSERT HERE - hosts that have available LITTLE_ENDIAN and
82 /* Some hosts don't define LITTLE_ENDIAN or BIG_ENDIAN, help them out */
85 #define LITTLE_ENDIAN 1234
88 #define BIG_ENDIAN 4321
94 Big endian last time I looked */
96 #if defined(sparc) || defined(__sparc__)
97 # if (WITH_HOST_BYTE_ORDER == 0)
98 # undef WITH_HOST_BYTE_ORDER
99 # define WITH_HOST_BYTE_ORDER BIG_ENDIAN
101 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
102 # error "sun was big endian last time I looked ..."
109 Little endian last time I looked */
111 #if defined(i386) || defined(i486) || defined(i586) || defined (i686) || defined(__i386__) || defined(__i486__) || defined(__i586__) || defined (__i686__)
112 # if (WITH_HOST_BYTE_ORDER == 0)
113 # undef WITH_HOST_BYTE_ORDER
114 # define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
116 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
117 # error "x86 was little endian last time I looked ..."
121 #if (defined (__i486__) || defined (__i586__) || defined (__i686__)) && defined(__GNUC__) && WITH_BSWAP
124 #define htonl(IN) __extension__ ({ int _out; __asm__ ("bswap %0" : "=r" (_out) : "0" (IN)); _out; })
125 #define ntohl(IN) __extension__ ({ int _out; __asm__ ("bswap %0" : "=r" (_out) : "0" (IN)); _out; })
128 /* Power or PowerPC running AIX */
129 #if defined(_POWER) && defined(_AIX)
130 # if (WITH_HOST_BYTE_ORDER == 0)
131 # undef WITH_HOST_BYTE_ORDER
132 # define WITH_HOST_BYTE_ORDER BIG_ENDIAN
134 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
135 # error "Power/PowerPC AIX was big endian last time I looked ..."
139 /* Solaris running PowerPC */
140 #if defined(__PPC) && defined(__sun__)
141 # if (WITH_HOST_BYTE_ORDER == 0)
142 # undef WITH_HOST_BYTE_ORDER
143 # define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
145 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
146 # error "Solaris on PowerPCs was little endian last time I looked ..."
151 #if defined(__hppa__)
152 # if (WITH_HOST_BYTE_ORDER == 0)
153 # undef WITH_HOST_BYTE_ORDER
154 # define WITH_HOST_BYTE_ORDER BIG_ENDIAN
156 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
157 # error "HP/PA was big endian last time I looked ..."
161 /* Big endian MIPS */
162 #if defined(__MIPSEB__)
163 # if (WITH_HOST_BYTE_ORDER == 0)
164 # undef WITH_HOST_BYTE_ORDER
165 # define WITH_HOST_BYTE_ORDER BIG_ENDIAN
167 # if (WITH_HOST_BYTE_ORDER != BIG_ENDIAN)
168 # error "MIPSEB was big endian last time I looked ..."
172 /* Little endian MIPS */
173 #if defined(__MIPSEL__)
174 # if (WITH_HOST_BYTE_ORDER == 0)
175 # undef WITH_HOST_BYTE_ORDER
176 # define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
178 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
179 # error "MIPSEL was little endian last time I looked ..."
184 #if defined(__WIN32__)
185 # if (WITH_HOST_BYTE_ORDER == 0)
186 # undef WITH_HOST_BYTE_ORDER
187 # define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
189 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
190 # error "Windows NT was little endian last time I looked ..."
194 /* Alpha running DEC unix */
195 #if defined(__osf__) && defined(__alpha__)
196 # if (WITH_HOST_BYTE_ORDER == 0)
197 # undef WITH_HOST_BYTE_ORDER
198 # define WITH_HOST_BYTE_ORDER LITTLE_ENDIAN
200 # if (WITH_HOST_BYTE_ORDER != LITTLE_ENDIAN)
201 # error "AXP running DEC unix was little endian last time I looked ..."
206 /* INSERT HERE - additional hosts that do not have LITTLE_ENDIAN and
207 BIG_ENDIAN definitions available. */
209 /* Until devices and tree properties are sorted out, tell sim-config.c
210 not to call the tree_find_foo fns. */
211 #define WITH_TREE_PROPERTIES 0
214 /* endianness of the host/target:
216 If the build process is aware (at compile time) of the endianness
217 of the host/target it is able to eliminate slower generic endian
220 Possible values are 0 (unknown), LITTLE_ENDIAN, BIG_ENDIAN */
222 #ifndef WITH_HOST_BYTE_ORDER
223 #define WITH_HOST_BYTE_ORDER 0 /*unknown*/
226 #ifndef WITH_TARGET_BYTE_ORDER
227 #define WITH_TARGET_BYTE_ORDER 0 /*unknown*/
230 #ifndef WITH_DEFAULT_TARGET_BYTE_ORDER
231 #define WITH_DEFAULT_TARGET_BYTE_ORDER 0 /* fatal */
234 extern int current_host_byte_order;
235 #define CURRENT_HOST_BYTE_ORDER (WITH_HOST_BYTE_ORDER \
236 ? WITH_HOST_BYTE_ORDER \
237 : current_host_byte_order)
238 extern int current_target_byte_order;
239 #define CURRENT_TARGET_BYTE_ORDER (WITH_TARGET_BYTE_ORDER \
240 ? WITH_TARGET_BYTE_ORDER \
241 : current_target_byte_order)
247 In addition to the above, the simulator can support the horrible
248 XOR endian mode (as found in the PowerPC and MIPS ISA). See
249 sim-core for more information.
251 If WITH_XOR_ENDIAN is non-zero, it specifies the number of bytes
252 potentially involved in the XOR munge. A typical value is 8. */
254 #ifndef WITH_XOR_ENDIAN
255 #define WITH_XOR_ENDIAN 0
260 /* Intel host BSWAP support:
262 Whether to use bswap on the 486 and pentiums rather than the 386
263 sequence that uses xchgb/rorl/xchgb */
272 Sets a limit on the number of processors that can be simulated. If
273 WITH_SMP is set to zero (0), the simulator is restricted to
274 suporting only one processor (and as a consequence leaves the SMP
275 code out of the build process).
277 The actual number of processors is taken from the device
278 /options/smp@<nr-cpu> */
280 #if defined (WITH_SMP) && (WITH_SMP > 0)
281 #define MAX_NR_PROCESSORS WITH_SMP
284 #ifndef MAX_NR_PROCESSORS
285 #define MAX_NR_PROCESSORS 1
289 /* Size of target word, address and OpenFirmware Cell:
291 The target word size is determined by the natural size of its
294 On most hosts, the address and cell are the same size as a target
297 #ifndef WITH_TARGET_WORD_BITSIZE
298 #define WITH_TARGET_WORD_BITSIZE 32
301 #ifndef WITH_TARGET_ADDRESS_BITSIZE
302 #define WITH_TARGET_ADDRESS_BITSIZE WITH_TARGET_WORD_BITSIZE
305 #ifndef WITH_TARGET_CELL_BITSIZE
306 #define WITH_TARGET_CELL_BITSIZE WITH_TARGET_WORD_BITSIZE
309 #ifndef WITH_TARGET_FLOATING_POINT_BITSIZE
310 #define WITH_TARGET_FLOATING_POINT_BITSIZE 64
315 /* Most significant bit of target:
317 Set this according to your target's bit numbering convention. For
318 the PowerPC it is zero, for many other targets it is 31 or 63.
320 For targets that can both have either 32 or 64 bit words and number
321 MSB as 31, 63. Define this to be (WITH_TARGET_WORD_BITSIZE - 1) */
323 #ifndef WITH_TARGET_WORD_MSB
324 #define WITH_TARGET_WORD_MSB 0
329 /* Program environment:
331 Three environments are available - UEA (user), VEA (virtual) and
332 OEA (perating). The former two are environment that users would
333 expect to see (VEA includes things like coherency and the time
334 base) while OEA is what an operating system expects to see. By
335 setting these to specific values, the build process is able to
336 eliminate non relevent environment code.
338 STATE_ENVIRONMENT(sd) specifies which of vea or oea is required for
341 ALL_ENVIRONMENT is used during configuration as a value for
342 WITH_ENVIRONMENT to indicate the choice is runtime selectable.
343 The default is then USER_ENVIRONMENT [since allowing the user to choose
344 the default at configure time seems like featuritis and since people using
345 OPERATING_ENVIRONMENT have more to worry about than selecting the
347 ALL_ENVIRONMENT is also used to set STATE_ENVIRONMENT to the
348 "uninitialized" state. */
350 enum sim_environment {
354 OPERATING_ENVIRONMENT
357 /* If the simulator specified SIM_AC_OPTION_ENVIRONMENT, indicate so. */
358 #ifdef WITH_ENVIRONMENT
359 #define SIM_HAVE_ENVIRONMENT
362 /* If the simulator doesn't specify SIM_AC_OPTION_ENVIRONMENT in its
363 configure.ac, the only supported environment is the user environment. */
364 #ifndef WITH_ENVIRONMENT
365 #define WITH_ENVIRONMENT USER_ENVIRONMENT
368 #define DEFAULT_ENVIRONMENT (WITH_ENVIRONMENT != ALL_ENVIRONMENT \
372 /* To be prepended to simulator calls with absolute file paths and
373 chdir:ed at startup. */
374 extern char *simulator_sysroot;
376 /* Callback & Modulo Memory.
378 Core includes a builtin memory type (raw_memory) that is
379 implemented using an array. raw_memory does not require any
380 additional functions etc.
382 Callback memory is where the core calls a core device for the data
383 it requires. Callback memory can be layered using priorities.
385 Modulo memory is a variation on raw_memory where ADDRESS & (MODULO
386 - 1) is used as the index into the memory array.
388 The OEA model uses callback memory for devices.
390 The VEA model uses callback memory to capture `page faults'.
392 BTW, while raw_memory could have been implemented as a callback,
393 profiling has shown that there is a biger win (at least for the
394 x86) in eliminating a function call for the most common
395 (raw_memory) case. */
400 A processor architecture may or may not handle miss aligned
403 As alternatives: both little and big endian modes take an exception
404 (STRICT_ALIGNMENT); big and little endian models handle mis aligned
405 transfers (NONSTRICT_ALIGNMENT); or the address is forced into
406 alignment using a mask (FORCED_ALIGNMENT).
408 Mixed alignment should be specified when the simulator needs to be
409 able to change the alignment requirements on the fly (eg for
410 bi-endian support). */
412 enum sim_alignments {
419 extern enum sim_alignments current_alignment;
421 #if !defined (WITH_ALIGNMENT)
422 #define WITH_ALIGNMENT 0
425 #if !defined (WITH_DEFAULT_ALIGNMENT)
426 #define WITH_DEFAULT_ALIGNMENT 0 /* fatal */
432 #define CURRENT_ALIGNMENT (WITH_ALIGNMENT \
438 /* Floating point suport:
440 Should the processor trap for all floating point instructions (as
441 if the hardware wasn't implemented) or implement the floating point
442 instructions directly. */
444 #if defined (WITH_FLOATING_POINT)
446 #define SOFT_FLOATING_POINT 1
447 #define HARD_FLOATING_POINT 2
449 extern int current_floating_point;
450 #define CURRENT_FLOATING_POINT (WITH_FLOATING_POINT \
451 ? WITH_FLOATING_POINT \
452 : current_floating_point)
459 Control the inclusion of debugging code.
460 Debugging is only turned on in rare circumstances [say during development]
461 and is not intended to be turned on otherwise. */
467 /* Include the tracing code. Disabling this eliminates all tracing
468 code. Default to all tracing but internal debug. */
471 #define WITH_TRACE (~TRACE_debug)
474 /* Include the profiling code. Disabling this eliminates all profiling
478 #define WITH_PROFILE (-1)
482 /* include code that checks assertions scattered through out the
486 #define WITH_ASSERT 1
490 /* Whether to check instructions for reserved bits being set */
492 /* #define WITH_RESERVED_BITS 1 */
496 /* include monitoring code */
498 #define MONITOR_INSTRUCTION_ISSUE 1
499 #define MONITOR_LOAD_STORE_UNIT 2
500 /* do not define WITH_MON by default */
501 #define DEFAULT_WITH_MON (MONITOR_LOAD_STORE_UNIT \
502 | MONITOR_INSTRUCTION_ISSUE)
505 /* Current CPU model (models are in the generated models.h include file) */
510 #define CURRENT_MODEL (WITH_MODEL \
514 #define MODEL_ISSUE_IGNORE (-1)
515 #define MODEL_ISSUE_PROCESS 1
517 #ifndef WITH_MODEL_ISSUE
518 #define WITH_MODEL_ISSUE 0
521 extern int current_model_issue;
522 #define CURRENT_MODEL_ISSUE (WITH_MODEL_ISSUE \
524 : current_model_issue)
528 /* Whether or not input/output just uses stdio, or uses printf_filtered for
529 output, and polling input for input. */
531 #define DONT_USE_STDIO 2
532 #define DO_USE_STDIO 1
538 extern int current_stdio;
539 #define CURRENT_STDIO (WITH_STDIO \
545 /* Specify that configured calls pass parameters in registers when the
546 convention is that they are placed on the stack */
549 #define WITH_REGPARM 0
552 /* Specify that configured calls use an alternative calling mechanism */
555 #define WITH_STDCALL 0
559 /* Set the default state configuration, before parsing argv. */
561 extern void sim_config_default (SIM_DESC sd);
563 /* Complete and verify the simulator configuration. */
565 extern SIM_RC sim_config (SIM_DESC sd);
567 /* Print the simulator configuration. */
569 extern void print_sim_config (SIM_DESC sd);