e3866cdf123ff6c6214780a3896d19708427ba94
1 /* Engine header for Cpu tools GENerated simulators.
2 Copyright (C) 1998, 1999, 2007, 2008, 2009 Free Software Foundation, Inc.
3 Contributed by Cygnus Support.
5 This file is part of GDB, the GNU debugger.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 /* This file is included by ${cpu}.h.
21 It needs CGEN_INSN_WORD which is defined by ${cpu}.h.
22 ??? A lot of this could be moved to genmloop.sh to be put in eng.h
23 and thus remove some conditional compilation. We'd still need
24 CGEN_INSN_WORD though. */
26 /* Semantic functions come in six versions on two axes:
27 fast/full-featured, and using one of the simple/scache/compilation engines.
28 A full featured simulator is always provided. --enable-sim-fast includes
29 support for fast execution by duplicating the semantic code but leaving
30 out all features like tracing and profiling.
31 Using the scache is selected with --enable-sim-scache. */
32 /* FIXME: --enable-sim-fast not implemented yet. */
33 /* FIXME: undecided how to handle WITH_SCACHE_PBB. */
35 /* There are several styles of engines, all generally supported by the
38 WITH_SCACHE && WITH_SCACHE_PBB - pseudo-basic-block scaching
39 WITH_SCACHE && !WITH_SCACHE_PBB - scaching on an insn by insn basis
40 !WITH_SCACHE - simple engine: fetch an insn, execute an insn
42 The !WITH_SCACHE case can also be broken up into two flavours:
43 extract the fields of the insn into an ARGBUF struct, or defer the
44 extraction to the semantic handler. The former can be viewed as the
45 WITH_SCACHE case with a cache size of 1 (thus there's no need for a
46 WITH_EXTRACTION macro). The WITH_SCACHE case always extracts the fields
47 into an ARGBUF struct. */
52 /* Instruction field support macros. */
54 #define EXTRACT_MSB0_SINT(val, total, start, length) \
55 (((INT) (val) << ((sizeof (INT) * 8) - (total) + (start))) \
56 >> ((sizeof (INT) * 8) - (length)))
57 #define EXTRACT_MSB0_UINT(val, total, start, length) \
58 (((UINT) (val) << ((sizeof (UINT) * 8) - (total) + (start))) \
59 >> ((sizeof (UINT) * 8) - (length)))
61 #define EXTRACT_LSB0_SINT(val, total, start, length) \
62 (((INT) (val) << ((sizeof (INT) * 8) - (start) - 1)) \
63 >> ((sizeof (INT) * 8) - (length)))
64 #define EXTRACT_LSB0_UINT(val, total, start, length) \
65 (((UINT) (val) << ((sizeof (UINT) * 8) - (start) - 1)) \
66 >> ((sizeof (UINT) * 8) - (length)))
68 #define EXTRACT_MSB0_LGSINT(val, total, start, length) \
69 (((CGEN_INSN_LGSINT) (val) << ((sizeof (CGEN_INSN_LGSINT) * 8) - (total) + (start))) \
70 >> ((sizeof (CGEN_INSN_LGSINT) * 8) - (length)))
71 #define EXTRACT_MSB0_LGUINT(val, total, start, length) \
72 (((CGEN_INSN_UINT) (val) << ((sizeof (CGEN_INSN_LGUINT) * 8) - (total) + (start))) \
73 >> ((sizeof (CGEN_INSN_LGUINT) * 8) - (length)))
75 #define EXTRACT_LSB0_LGSINT(val, total, start, length) \
76 (((CGEN_INSN_LGSINT) (val) << ((sizeof (CGEN_INSN_LGSINT) * 8) - (start) - 1)) \
77 >> ((sizeof (CGEN_INSN_LGSINT) * 8) - (length)))
78 #define EXTRACT_LSB0_LGUINT(val, total, start, length) \
79 (((CGEN_INSN_LGUINT) (val) << ((sizeof (CGEN_INSN_LGUINT) * 8) - (start) - 1)) \
80 >> ((sizeof (CGEN_INSN_LGUINT) * 8) - (length)))
82 /* Semantic routines. */
84 /* Type of the machine generated extraction fns. */
85 /* ??? No longer used. */
86 typedef void (EXTRACT_FN
) (SIM_CPU
*, IADDR
, CGEN_INSN_WORD
, ARGBUF
*);
88 /* Type of the machine generated semantic fns. */
92 /* Instruction fields are extracted into ARGBUF before calling the
94 #if HAVE_PARALLEL_INSNS && ! WITH_PARALLEL_GENWRITE
95 typedef SEM_PC (SEMANTIC_FN
) (SIM_CPU
*, SEM_ARG
, PAREXEC
*);
97 typedef SEM_PC (SEMANTIC_FN
) (SIM_CPU
*, SEM_ARG
);
102 /* Result of semantic routines is a status indicator (wip). */
103 typedef unsigned int SEM_STATUS
;
105 /* Instruction fields are extracted by the semantic routine.
106 ??? TODO: multi word insns. */
107 #if HAVE_PARALLEL_INSNS && ! WITH_PARALLEL_GENWRITE
108 typedef SEM_STATUS (SEMANTIC_FN
) (SIM_CPU
*, SEM_ARG
, PAREXEC
*, CGEN_INSN_WORD
);
110 typedef SEM_STATUS (SEMANTIC_FN
) (SIM_CPU
*, SEM_ARG
, CGEN_INSN_WORD
);
115 /* In the ARGBUF struct, a pointer to the semantic routine for the insn. */
118 #if ! WITH_SEM_SWITCH_FULL
119 SEMANTIC_FN
*sem_full
;
121 #if ! WITH_SEM_SWITCH_FAST
122 SEMANTIC_FN
*sem_fast
;
124 #if WITH_SEM_SWITCH_FULL || WITH_SEM_SWITCH_FAST
133 /* Set the appropriate semantic handler in ABUF. */
135 #if WITH_SEM_SWITCH_FULL
137 #define SEM_SET_FULL_CODE(abuf, idesc) \
138 do { (abuf)->semantic.sem_case = (idesc)->sem_full_lab; } while (0)
140 #define SEM_SET_FULL_CODE(abuf, idesc) \
141 do { (abuf)->semantic.sem_case = (idesc)->num; } while (0)
144 #define SEM_SET_FULL_CODE(abuf, idesc) \
145 do { (abuf)->semantic.sem_full = (idesc)->sem_full; } while (0)
148 #if WITH_SEM_SWITCH_FAST
150 #define SEM_SET_FAST_CODE(abuf, idesc) \
151 do { (abuf)->semantic.sem_case = (idesc)->sem_fast_lab; } while (0)
153 #define SEM_SET_FAST_CODE(abuf, idesc) \
154 do { (abuf)->semantic.sem_case = (idesc)->num; } while (0)
157 #define SEM_SET_FAST_CODE(abuf, idesc) \
158 do { (abuf)->semantic.sem_fast = (idesc)->sem_fast; } while (0)
161 #define SEM_SET_CODE(abuf, idesc, fast_p) \
164 SEM_SET_FAST_CODE ((abuf), (idesc)); \
166 SEM_SET_FULL_CODE ((abuf), (idesc)); \
169 /* Return non-zero if IDESC is a conditional or unconditional CTI. */
171 #define IDESC_CTI_P(idesc) \
172 ((CGEN_ATTR_BOOLS (CGEN_INSN_ATTRS ((idesc)->idata)) \
173 & (CGEN_ATTR_MASK (CGEN_INSN_COND_CTI) \
174 | CGEN_ATTR_MASK (CGEN_INSN_UNCOND_CTI))) \
177 /* Return non-zero if IDESC is a skip insn. */
179 #define IDESC_SKIP_P(idesc) \
180 ((CGEN_ATTR_BOOLS (CGEN_INSN_ATTRS ((idesc)->idata)) \
181 & CGEN_ATTR_MASK (CGEN_INSN_SKIP_CTI)) \
184 /* Return pointer to ARGBUF given ptr to SCACHE. */
185 #define SEM_ARGBUF(sem_arg) (& (sem_arg) -> argbuf)
189 #define CIA_ADDR(cia) (cia)
193 /* Return the scache pointer of the current insn. */
194 #define SEM_SEM_ARG(vpc, sc) (vpc)
196 /* Return the virtual pc of the next insn to execute
197 (assuming this isn't a cti or the branch isn't taken). */
198 #define SEM_NEXT_VPC(sem_arg, pc, len) ((sem_arg) + 1)
200 /* Update the instruction counter. */
201 #define PBB_UPDATE_INSN_COUNT(cpu,sc) \
202 (CPU_INSN_COUNT (cpu) += SEM_ARGBUF (sc) -> fields.chain.insn_count)
204 /* Do not append a `;' to invocations of this.
205 npc,br_type are for communication between the cti insn and cti-chain. */
206 #define SEM_BRANCH_INIT \
207 IADDR npc = 0; /* assign a value for -Wall */ \
208 SEM_BRANCH_TYPE br_type = SEM_BRANCH_UNTAKEN;
210 /* SEM_IN_SWITCH is defined at the top of the mainloop.c files
211 generated by genmloop.sh. It exists so generated semantic code needn't
212 care whether it's being put in a switch or in a function. */
214 #define SEM_BRANCH_FINI(pcvar) \
217 pbb_br_type = br_type; \
219 #else /* 1 semantic function per instruction */
220 #define SEM_BRANCH_FINI(pcvar) \
222 CPU_PBB_BR_NPC (current_cpu) = npc; \
223 CPU_PBB_BR_TYPE (current_cpu) = br_type; \
227 #define SEM_BRANCH_VIA_CACHE(cpu, sc, newval, pcvar) \
230 br_type = SEM_BRANCH_CACHEABLE; \
233 #define SEM_BRANCH_VIA_ADDR(cpu, sc, newval, pcvar) \
236 br_type = SEM_BRANCH_UNCACHEABLE; \
239 #define SEM_SKIP_COMPILE(cpu, sc, skip) \
241 SEM_ARGBUF (sc) -> skip_count = (skip); \
244 #define SEM_SKIP_INSN(cpu, sc, vpcvar) \
246 (vpcvar) += SEM_ARGBUF (sc) -> skip_count; \
249 #else /* ! WITH_SCACHE_PBB */
251 #define SEM_SEM_ARG(vpc, sc) (sc)
253 #define SEM_NEXT_VPC(sem_arg, pc, len) ((pc) + (len))
255 /* ??? May wish to move taken_p out of here and make it explicit. */
256 #define SEM_BRANCH_INIT \
259 #ifndef TARGET_SEM_BRANCH_FINI
260 #define TARGET_SEM_BRANCH_FINI(pcvar, taken_p)
262 #define SEM_BRANCH_FINI(pcvar) \
263 do { TARGET_SEM_BRANCH_FINI (pcvar, taken_p); } while (0)
265 #define SEM_BRANCH_VIA_CACHE(cpu, sc, newval, pcvar) \
267 (pcvar) = (newval); \
271 #define SEM_BRANCH_VIA_ADDR(cpu, sc, newval, pcvar) \
273 (pcvar) = (newval); \
277 #endif /* ! WITH_SCACHE_PBB */
279 #else /* ! WITH_SCACHE */
281 /* This is the "simple" engine case. */
283 #define CIA_ADDR(cia) (cia)
285 #define SEM_SEM_ARG(vpc, sc) (sc)
287 #define SEM_NEXT_VPC(sem_arg, pc, len) ((pc) + (len))
289 #define SEM_BRANCH_INIT \
292 #define SEM_BRANCH_VIA_CACHE(cpu, abuf, newval, pcvar) \
294 (pcvar) = (newval); \
298 #define SEM_BRANCH_VIA_ADDR(cpu, abuf, newval, pcvar) \
300 (pcvar) = (newval); \
304 /* Finish off branch insns.
305 The target must define TARGET_SEM_BRANCH_FINI.
306 ??? This can probably go away when define-execute is finished. */
307 #define SEM_BRANCH_FINI(pcvar, bool_attrs) \
308 do { TARGET_SEM_BRANCH_FINI ((pcvar), (bool_attrs), taken_p); } while (0)
310 /* Finish off non-branch insns.
311 The target must define TARGET_SEM_NBRANCH_FINI.
312 ??? This can probably go away when define-execute is finished. */
313 #define SEM_NBRANCH_FINI(pcvar, bool_attrs) \
314 do { TARGET_SEM_NBRANCH_FINI ((pcvar), (bool_attrs)); } while (0)
316 #endif /* ! WITH_SCACHE */
318 /* Instruction information. */
320 /* Sanity check, at most one of these may be true. */
321 #if WITH_PARALLEL_READ + WITH_PARALLEL_WRITE + WITH_PARALLEL_GENWRITE > 1
322 #error "At most one of WITH_PARALLEL_{READ,WRITE,GENWRITE} can be true."
325 /* Compile time computable instruction data. */
328 /* The instruction type (a number that identifies each insn over the
329 entire architecture). */
332 /* Index in IDESC table. */
335 /* Semantic format number. */
338 #if HAVE_PARALLEL_INSNS && ! WITH_PARALLEL_ONLY
339 /* Index in IDESC table of parallel handler. */
343 #if WITH_PARALLEL_READ
344 /* Index in IDESC table of read handler. */
348 #if WITH_PARALLEL_WRITE
349 /* Index in IDESC table of writeback handler. */
354 /* Entry in semantic function table.
355 This information is copied to the insn descriptor table at run-time. */
358 /* Index in IDESC table. */
361 /* Function to perform the semantics of the insn. */
365 /* Run-time computed instruction descriptor. */
368 #if WITH_SEM_SWITCH_FAST
372 /* nothing needed, switch's on `num' member */
375 SEMANTIC_FN
*sem_fast
;
378 #if WITH_SEM_SWITCH_FULL
382 /* nothing needed, switch's on `num' member */
385 SEMANTIC_FN
*sem_full
;
388 /* Parallel support. */
389 #if HAVE_PARALLEL_INSNS && (! WITH_PARALLEL_ONLY || (WITH_PARALLEL_ONLY && ! WITH_PARALLEL_GENWRITE))
390 /* Pointer to parallel handler if serial insn.
391 Pointer to readahead/writeback handler if parallel insn. */
392 struct idesc
*par_idesc
;
395 /* Instruction number (index in IDESC table, profile table).
396 Also used to switch on in non-gcc semantic switches. */
399 /* Semantic format id. */
402 /* instruction data (name, attributes, size, etc.) */
403 const CGEN_INSN
*idata
;
405 /* instruction attributes, copied from `idata' for speed */
406 const CGEN_INSN_ATTR_TYPE
*attrs
;
408 /* instruction length in bytes, copied from `idata' for speed */
411 /* profiling/modelling support */
412 const INSN_TIMING
*timing
;
415 /* Tracing/profiling. */
417 /* Return non-zero if a before/after handler is needed.
418 When tracing/profiling a selected range there's no need to slow
419 down simulation of the other insns (except to get more accurate data!).
421 ??? May wish to profile all insns if doing insn tracing, or to
422 get more accurate cycle data.
424 First test ANY_P so we avoid a potentially expensive HIT_P call
425 [if there are lots of address ranges]. */
427 #define PC_IN_TRACE_RANGE_P(cpu, pc) \
429 && ADDR_RANGE_HIT_P (TRACE_RANGE (CPU_TRACE_DATA (cpu)), (pc)))
430 #define PC_IN_PROFILE_RANGE_P(cpu, pc) \
431 (PROFILE_ANY_P (cpu) \
432 && ADDR_RANGE_HIT_P (PROFILE_RANGE (CPU_PROFILE_DATA (cpu)), (pc)))
434 #endif /* CGEN_ENGINE_H */
This page took 0.045381 seconds and 4 git commands to generate.