[deliverable/binutils-gdb.git] / sim / common / sim-config.h

/* The common simulator framework for GDB, the GNU Debugger.

   Copyright 2002-2020 Free Software Foundation, Inc.

   Contributed by Andrew Cagney and Red Hat.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */


#ifndef SIM_CONFIG_H
#define SIM_CONFIG_H


/* Host dependant:

   The CPP below defines information about the compilation host.  In
   particular it defines the macro's:

   HOST_BYTE_ORDER	The byte order of the host. Could be BFD_ENDIAN_LITTLE
			or BFD_ENDIAN_BIG.

 */

#ifdef WORDS_BIGENDIAN
# define HOST_BYTE_ORDER BFD_ENDIAN_BIG
#else
# define HOST_BYTE_ORDER BFD_ENDIAN_LITTLE
#endif


/* Until devices and tree properties are sorted out, tell sim-config.c
   not to call the tree_find_foo fns.  */
#define WITH_TREE_PROPERTIES 0


/* Endianness of the target.

   Possible values are BFD_ENDIAN_UNKNOWN, BFD_ENDIAN_LITTLE, or BFD_ENDIAN_BIG.  */

#ifndef WITH_TARGET_BYTE_ORDER
#define WITH_TARGET_BYTE_ORDER		BFD_ENDIAN_UNKNOWN
#endif

#ifndef WITH_DEFAULT_TARGET_BYTE_ORDER
#define WITH_DEFAULT_TARGET_BYTE_ORDER	BFD_ENDIAN_UNKNOWN
#endif

extern enum bfd_endian current_target_byte_order;
#define CURRENT_TARGET_BYTE_ORDER \
  (WITH_TARGET_BYTE_ORDER != BFD_ENDIAN_UNKNOWN \
   ? WITH_TARGET_BYTE_ORDER : current_target_byte_order)


/* XOR endian.

   In addition to the above, the simulator can support the horrible
   XOR endian mode (as found in the PowerPC and MIPS ISA).  See
   sim-core for more information.

   If WITH_XOR_ENDIAN is non-zero, it specifies the number of bytes
   potentially involved in the XOR munge. A typical value is 8. */

#ifndef WITH_XOR_ENDIAN
#define WITH_XOR_ENDIAN		0
#endif


/* SMP support:

   Sets a limit on the number of processors that can be simulated.  If
   WITH_SMP is set to zero (0), the simulator is restricted to
   suporting only one processor (and as a consequence leaves the SMP
   code out of the build process).

   The actual number of processors is taken from the device
   /options/smp@<nr-cpu> */

#if defined (WITH_SMP) && (WITH_SMP > 0)
#define MAX_NR_PROCESSORS		WITH_SMP
#endif

#ifndef MAX_NR_PROCESSORS
#define MAX_NR_PROCESSORS		1
#endif


/* Size of target word, address and OpenFirmware Cell:

   The target word size is determined by the natural size of its
   reginsters.

   On most hosts, the address and cell are the same size as a target
   word.  */

#ifndef WITH_TARGET_WORD_BITSIZE
#define WITH_TARGET_WORD_BITSIZE        32
#endif

#ifndef WITH_TARGET_ADDRESS_BITSIZE
#define WITH_TARGET_ADDRESS_BITSIZE	WITH_TARGET_WORD_BITSIZE
#endif

#ifndef WITH_TARGET_CELL_BITSIZE
#define WITH_TARGET_CELL_BITSIZE	WITH_TARGET_WORD_BITSIZE
#endif

#ifndef WITH_TARGET_FLOATING_POINT_BITSIZE
#define WITH_TARGET_FLOATING_POINT_BITSIZE 64
#endif


/* Most significant bit of target:

   Set this according to your target's bit numbering convention.  For
   the PowerPC it is zero, for many other targets it is 31 or 63.

   For targets that can both have either 32 or 64 bit words and number
   MSB as 31, 63.  Define this to be (WITH_TARGET_WORD_BITSIZE - 1) */

#ifndef WITH_TARGET_WORD_MSB
#define WITH_TARGET_WORD_MSB            0
#endif


/* Program environment:

   Three environments are available - UEA (user), VEA (virtual) and
   OEA (perating).  The former two are environment that users would
   expect to see (VEA includes things like coherency and the time
   base) while OEA is what an operating system expects to see.  By
   setting these to specific values, the build process is able to
   eliminate non relevent environment code.

   STATE_ENVIRONMENT(sd) specifies which of vea or oea is required for
   the current runtime.

   ALL_ENVIRONMENT is used during configuration as a value for
   WITH_ENVIRONMENT to indicate the choice is runtime selectable.
   The default is then USER_ENVIRONMENT [since allowing the user to choose
   the default at configure time seems like featuritis and since people using
   OPERATING_ENVIRONMENT have more to worry about than selecting the
   default].
   ALL_ENVIRONMENT is also used to set STATE_ENVIRONMENT to the
   "uninitialized" state.  */

enum sim_environment {
  ALL_ENVIRONMENT,
  USER_ENVIRONMENT,
  VIRTUAL_ENVIRONMENT,
  OPERATING_ENVIRONMENT
};

/* To be prepended to simulator calls with absolute file paths and
   chdir:ed at startup.  */
extern char *simulator_sysroot;

/* Callback & Modulo Memory.

   Core includes a builtin memory type (raw_memory) that is
   implemented using an array.  raw_memory does not require any
   additional functions etc.

   Callback memory is where the core calls a core device for the data
   it requires.  Callback memory can be layered using priorities.

   Modulo memory is a variation on raw_memory where ADDRESS & (MODULO
   - 1) is used as the index into the memory array.

   The OEA model uses callback memory for devices.

   The VEA model uses callback memory to capture `page faults'.

   BTW, while raw_memory could have been implemented as a callback,
   profiling has shown that there is a biger win (at least for the
   x86) in eliminating a function call for the most common
   (raw_memory) case. */


/* Alignment:

   A processor architecture may or may not handle miss aligned
   transfers.

   As alternatives: both little and big endian modes take an exception
   (STRICT_ALIGNMENT); big and little endian models handle mis aligned
   transfers (NONSTRICT_ALIGNMENT); or the address is forced into
   alignment using a mask (FORCED_ALIGNMENT).

   Mixed alignment should be specified when the simulator needs to be
   able to change the alignment requirements on the fly (eg for
   bi-endian support). */

enum sim_alignments {
  MIXED_ALIGNMENT,
  NONSTRICT_ALIGNMENT,
  STRICT_ALIGNMENT,
  FORCED_ALIGNMENT,
};

extern enum sim_alignments current_alignment;

#if !defined (WITH_ALIGNMENT)
#define WITH_ALIGNMENT 0
#endif

#if !defined (WITH_DEFAULT_ALIGNMENT)
#define WITH_DEFAULT_ALIGNMENT 0 /* fatal */
#endif


#define CURRENT_ALIGNMENT (WITH_ALIGNMENT \
			   ? WITH_ALIGNMENT \
			   : current_alignment)


/* Floating point suport:

   Should the processor trap for all floating point instructions (as
   if the hardware wasn't implemented) or implement the floating point
   instructions directly. */

#if defined (WITH_FLOATING_POINT)

#define SOFT_FLOATING_POINT		1
#define HARD_FLOATING_POINT		2

extern int current_floating_point;
#define CURRENT_FLOATING_POINT (WITH_FLOATING_POINT \
				? WITH_FLOATING_POINT \
				: current_floating_point)

#endif


/* Whether to check instructions for reserved bits being set */

/* #define WITH_RESERVED_BITS		1 */


/* include monitoring code */

#define MONITOR_INSTRUCTION_ISSUE	1
#define MONITOR_LOAD_STORE_UNIT		2
/* do not define WITH_MON by default */
#define DEFAULT_WITH_MON		(MONITOR_LOAD_STORE_UNIT \
					 | MONITOR_INSTRUCTION_ISSUE)


/* Current CPU model (models are in the generated models.h include file)  */
#ifndef WITH_MODEL
#define WITH_MODEL			0
#endif

#define CURRENT_MODEL (WITH_MODEL	\
		       ? WITH_MODEL	\
		       : current_model)

#define MODEL_ISSUE_IGNORE		(-1)
#define MODEL_ISSUE_PROCESS		1

#ifndef WITH_MODEL_ISSUE
#define WITH_MODEL_ISSUE		0
#endif

extern int current_model_issue;
#define CURRENT_MODEL_ISSUE (WITH_MODEL_ISSUE	\
			     ? WITH_MODEL_ISSUE	\
			     : current_model_issue)


/* Whether or not input/output just uses stdio, or uses printf_filtered for
   output, and polling input for input.  */

#define DONT_USE_STDIO			2
#define DO_USE_STDIO			1

extern int current_stdio;
#define CURRENT_STDIO (WITH_STDIO	\
		       ? WITH_STDIO     \
		       : current_stdio)


/* Set the default state configuration, before parsing argv.  */

extern void sim_config_default (SIM_DESC sd);

/* Complete and verify the simulator configuration.  */

extern SIM_RC sim_config (SIM_DESC sd);

/* Print the simulator configuration.  */

extern void print_sim_config (SIM_DESC sd);


#endif
Commit	Line	Data
b85e4829 AC	1	/* The common simulator framework for GDB, the GNU Debugger.
b85e4829 AC	2
b811d2c2	3	Copyright 2002-2020 Free Software Foundation, Inc.
b85e4829 AC	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
4744ac1b	11	the Free Software Foundation; either version 3 of the License, or
b85e4829 AC	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
4744ac1b	20	along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c SS	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
0cb8d851 MF	32	HOST_BYTE_ORDER The byte order of the host. Could be BFD_ENDIAN_LITTLE
0cb8d851 MF	33	or BFD_ENDIAN_BIG.
c906108c SS	34
	35	*/
	36
0cb8d851 MF	37	#ifdef WORDS_BIGENDIAN
	38	# define HOST_BYTE_ORDER BFD_ENDIAN_BIG
	39	#else
	40	# define HOST_BYTE_ORDER BFD_ENDIAN_LITTLE
	41	#endif
c906108c	42
9bbf6f91	43
c906108c SS	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
0cb8d851	49	/* Endianness of the target.
c906108c	50
0cb8d851	51	Possible values are BFD_ENDIAN_UNKNOWN, BFD_ENDIAN_LITTLE, or BFD_ENDIAN_BIG. */
c906108c SS	52
c906108c SS	53	#ifndef WITH_TARGET_BYTE_ORDER
1ac72f06	54	#define WITH_TARGET_BYTE_ORDER BFD_ENDIAN_UNKNOWN
c906108c SS	55	#endif
	56
	57	#ifndef WITH_DEFAULT_TARGET_BYTE_ORDER
1ac72f06	58	#define WITH_DEFAULT_TARGET_BYTE_ORDER BFD_ENDIAN_UNKNOWN
c906108c SS	59	#endif
c906108c SS	60
1ac72f06 MF	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)
c906108c SS	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
c906108c SS	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
027e2a04 HPN	170	/* To be prepended to simulator calls with absolute file paths and
	171	chdir:ed at startup. */
	172	extern char *simulator_sysroot;
c906108c SS	173
	174	/* Callback & Modulo Memory.
	175
	176	Core includes a builtin memory type (raw_memory) that is
	177	implemented using an array. raw_memory does not require any
	178	additional functions etc.
	179
	180	Callback memory is where the core calls a core device for the data
	181	it requires. Callback memory can be layered using priorities.
	182
	183	Modulo memory is a variation on raw_memory where ADDRESS & (MODULO
	184	- 1) is used as the index into the memory array.
	185
	186	The OEA model uses callback memory for devices.
	187
	188	The VEA model uses callback memory to capture `page faults'.
	189
	190	BTW, while raw_memory could have been implemented as a callback,
	191	profiling has shown that there is a biger win (at least for the
	192	x86) in eliminating a function call for the most common
	193	(raw_memory) case. */
	194
c906108c SS	195
	196	/* Alignment:
	197
	198	A processor architecture may or may not handle miss aligned
	199	transfers.
	200
	201	As alternatives: both little and big endian modes take an exception
	202	(STRICT_ALIGNMENT); big and little endian models handle mis aligned
	203	transfers (NONSTRICT_ALIGNMENT); or the address is forced into
	204	alignment using a mask (FORCED_ALIGNMENT).
	205
	206	Mixed alignment should be specified when the simulator needs to be
	207	able to change the alignment requirements on the fly (eg for
	208	bi-endian support). */
	209
	210	enum sim_alignments {
	211	MIXED_ALIGNMENT,
	212	NONSTRICT_ALIGNMENT,
	213	STRICT_ALIGNMENT,
	214	FORCED_ALIGNMENT,
	215	};
	216
	217	extern enum sim_alignments current_alignment;
	218
	219	#if !defined (WITH_ALIGNMENT)
	220	#define WITH_ALIGNMENT 0
	221	#endif
	222
	223	#if !defined (WITH_DEFAULT_ALIGNMENT)
	224	#define WITH_DEFAULT_ALIGNMENT 0 /* fatal */
	225	#endif
	226
	227
	228
	229
	230	#define CURRENT_ALIGNMENT (WITH_ALIGNMENT \
	231	? WITH_ALIGNMENT \
	232	: current_alignment)
	233
	234
	235
	236	/* Floating point suport:
	237
	238	Should the processor trap for all floating point instructions (as
	239	if the hardware wasn't implemented) or implement the floating point
	240	instructions directly. */
	241
	242	#if defined (WITH_FLOATING_POINT)
	243
	244	#define SOFT_FLOATING_POINT 1
	245	#define HARD_FLOATING_POINT 2
	246
	247	extern int current_floating_point;
	248	#define CURRENT_FLOATING_POINT (WITH_FLOATING_POINT \
	249	? WITH_FLOATING_POINT \
	250	: current_floating_point)
	251
	252	#endif
	253
	254
c906108c SS	255	/* Whether to check instructions for reserved bits being set */
	256
	257	/* #define WITH_RESERVED_BITS 1 */
	258
	259
	260
	261	/* include monitoring code */
	262
	263	#define MONITOR_INSTRUCTION_ISSUE 1
	264	#define MONITOR_LOAD_STORE_UNIT 2
	265	/* do not define WITH_MON by default */
	266	#define DEFAULT_WITH_MON (MONITOR_LOAD_STORE_UNIT \
	267	\| MONITOR_INSTRUCTION_ISSUE)
	268
	269
	270	/* Current CPU model (models are in the generated models.h include file) */
	271	#ifndef WITH_MODEL
	272	#define WITH_MODEL 0
	273	#endif
	274
	275	#define CURRENT_MODEL (WITH_MODEL \
	276	? WITH_MODEL \
	277	: current_model)
	278
c906108c SS	279	#define MODEL_ISSUE_IGNORE (-1)
	280	#define MODEL_ISSUE_PROCESS 1
	281
	282	#ifndef WITH_MODEL_ISSUE
	283	#define WITH_MODEL_ISSUE 0
	284	#endif
	285
	286	extern int current_model_issue;
	287	#define CURRENT_MODEL_ISSUE (WITH_MODEL_ISSUE \
	288	? WITH_MODEL_ISSUE \
	289	: current_model_issue)
	290
	291
	292
	293	/* Whether or not input/output just uses stdio, or uses printf_filtered for
	294	output, and polling input for input. */
	295
	296	#define DONT_USE_STDIO 2
	297	#define DO_USE_STDIO 1
	298
c906108c SS	299	extern int current_stdio;
	300	#define CURRENT_STDIO (WITH_STDIO \
	301	? WITH_STDIO \
	302	: current_stdio)
	303
	304
	305
c906108c SS	306	/* Set the default state configuration, before parsing argv. */
	307
	308	extern void sim_config_default (SIM_DESC sd);
	309
	310	/* Complete and verify the simulator configuration. */
	311
	312	extern SIM_RC sim_config (SIM_DESC sd);
	313
	314	/* Print the simulator configuration. */
	315
	316	extern void print_sim_config (SIM_DESC sd);
	317
	318
	319	#endif