1 /* Simulator pseudo baseclass.
3 Copyright 1997-2015 Free Software Foundation, Inc.
5 Contributed by Cygnus Support.
7 This file is part of GDB, the GNU debugger.
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/>. */
23 /* Simulator state pseudo baseclass.
25 Each simulator is required to have the file ``sim-main.h''. That
26 file includes ``sim-basics.h'', defines the base type ``sim_cia''
27 (the data type that contains complete current instruction address
28 information), include ``sim-base.h'':
30 #include "sim-basics.h"
31 typedef address_word sim_cia;
32 /-* If `sim_cia' is not an integral value (e.g. a struct), define
33 CIA_ADDR to return the integral value. *-/
34 /-* #define CIA_ADDR(cia) (...) *-/
37 finally, two data types `struct _sim_cpu' and `struct sim_state'
41 ... simulator specific members ...
46 sim_cpu *cpu[MAX_NR_PROCESSORS];
47 ... simulator specific members ...
51 Note that `base' appears last. This makes `base.magic' appear last
52 in the entire struct and helps catch miscompilation errors. */
58 /* Pre-declare certain types. */
60 /* typedef <target-dependant> sim_cia; */
62 #define NULL_CIA ((sim_cia) 0)
64 /* Return the current instruction address as a number.
65 Some targets treat the current instruction address as a struct
66 (e.g. for delay slot handling). */
68 #define CIA_ADDR(cia) (cia)
70 #ifndef INVALID_INSTRUCTION_ADDRESS
71 #define INVALID_INSTRUCTION_ADDRESS ((address_word)0 - 1)
74 typedef struct _sim_cpu sim_cpu
;
76 #include "sim-module.h"
78 #include "sim-trace.h"
80 #include "sim-events.h"
81 #include "sim-profile.h"
83 #include "sim-model.h"
86 #include "sim-engine.h"
87 #include "sim-watch.h"
88 #include "sim-memopt.h"
91 /* Global pointer to current state while sim_resume is running.
92 On a machine with lots of registers, it might be possible to reserve
93 one of them for current_state. However on a machine with few registers
94 current_state can't permanently live in one and indirecting through it
95 will be slower [in which case one can have sim_resume set globals from
96 current_state for faster access].
97 If CURRENT_STATE_REG is defined, it means current_state is living in
101 #ifdef CURRENT_STATE_REG
104 extern struct sim_state
*current_state
;
108 /* The simulator may provide different (and faster) definition. */
109 #ifndef CURRENT_STATE
110 #define CURRENT_STATE current_state
114 /* We require all sims to dynamically allocate cpus. See comment up top about
117 # define STATE_CPU(sd, n) ((sd)->cpu[n])
119 # define STATE_CPU(sd, n) ((sd)->cpu[0])
125 /* Simulator's argv[0]. */
127 #define STATE_MY_NAME(sd) ((sd)->base.my_name)
129 /* Who opened the simulator. */
130 SIM_OPEN_KIND open_kind
;
131 #define STATE_OPEN_KIND(sd) ((sd)->base.open_kind)
133 /* The host callbacks. */
134 struct host_callback_struct
*callback
;
135 #define STATE_CALLBACK(sd) ((sd)->base.callback)
137 /* The type of simulation environment (user/operating). */
138 enum sim_environment environment
;
139 #define STATE_ENVIRONMENT(sd) ((sd)->base.environment)
141 #if 0 /* FIXME: Not ready yet. */
142 /* Stuff defined in sim-config.h. */
143 struct sim_config config
;
144 #define STATE_CONFIG(sd) ((sd)->base.config)
147 /* List of installed module `init' handlers. */
148 struct module_list
*modules
;
149 #define STATE_MODULES(sd) ((sd)->base.modules)
151 /* Supported options. */
152 struct option_list
*options
;
153 #define STATE_OPTIONS(sd) ((sd)->base.options)
155 /* Non-zero if -v specified. */
157 #define STATE_VERBOSE_P(sd) ((sd)->base.verbose_p)
159 /* Non cpu-specific trace data. See sim-trace.h. */
160 TRACE_DATA trace_data
;
161 #define STATE_TRACE_DATA(sd) (& (sd)->base.trace_data)
163 /* If non NULL, the BFD architecture specified on the command line */
164 const struct bfd_arch_info
*architecture
;
165 #define STATE_ARCHITECTURE(sd) ((sd)->base.architecture)
167 /* If non NULL, the bfd target specified on the command line */
169 #define STATE_TARGET(sd) ((sd)->base.target)
171 /* In standalone simulator, this is the program's arguments passed
172 on the command line. */
174 #define STATE_PROG_ARGV(sd) ((sd)->base.prog_argv)
176 /* The program's bfd. */
177 struct bfd
*prog_bfd
;
178 #define STATE_PROG_BFD(sd) ((sd)->base.prog_bfd)
180 /* Symbol table for prog_bfd */
181 struct bfd_symbol
**prog_syms
;
182 #define STATE_PROG_SYMS(sd) ((sd)->base.prog_syms)
184 /* The program's text section. */
185 struct bfd_section
*text_section
;
186 /* Starting and ending text section addresses from the bfd. */
187 bfd_vma text_start
, text_end
;
188 #define STATE_TEXT_SECTION(sd) ((sd)->base.text_section)
189 #define STATE_TEXT_START(sd) ((sd)->base.text_start)
190 #define STATE_TEXT_END(sd) ((sd)->base.text_end)
192 /* Start address, set when the program is loaded from the bfd. */
194 #define STATE_START_ADDR(sd) ((sd)->base.start_addr)
196 /* Size of the simulator's cache, if any.
197 This is not the target's cache. It is the cache the simulator uses
198 to process instructions. */
199 unsigned int scache_size
;
200 #define STATE_SCACHE_SIZE(sd) ((sd)->base.scache_size)
202 /* FIXME: Move to top level sim_state struct (as some struct)? */
203 #ifdef SIM_HAVE_FLATMEM
204 unsigned int mem_size
;
205 #define STATE_MEM_SIZE(sd) ((sd)->base.mem_size)
206 unsigned int mem_base
;
207 #define STATE_MEM_BASE(sd) ((sd)->base.mem_base)
208 unsigned char *memory
;
209 #define STATE_MEMORY(sd) ((sd)->base.memory)
212 /* core memory bus */
213 #define STATE_CORE(sd) (&(sd)->base.core)
216 /* Record of memory sections added via the memory-options interface. */
217 #define STATE_MEMOPT(sd) ((sd)->base.memopt)
221 #define STATE_EVENTS(sd) (&(sd)->base.events)
224 /* generic halt/resume engine */
226 #define STATE_ENGINE(sd) (&(sd)->base.engine)
228 /* generic watchpoint support */
229 sim_watchpoints watchpoints
;
230 #define STATE_WATCHPOINTS(sd) (&(sd)->base.watchpoints)
234 #define STATE_HW(sd) ((sd)->base.hw)
237 /* Should image loads be performed using the LMA or VMA? Older
238 simulators use the VMA while newer simulators prefer the LMA. */
240 #define STATE_LOAD_AT_LMA_P(SD) ((SD)->base.load_at_lma_p)
242 /* Marker for those wanting to do sanity checks.
243 This should remain the last member of this struct to help catch
244 miscompilation errors. */
246 #define SIM_MAGIC_NUMBER 0x4242
247 #define STATE_MAGIC(sd) ((sd)->base.magic)
250 /* Functions for allocating/freeing a sim_state. */
251 SIM_DESC
sim_state_alloc (SIM_OPEN_KIND kind
, host_callback
*callback
);
252 void sim_state_free (SIM_DESC
);
254 #endif /* SIM_BASE_H */