1 /* Simulator pseudo baseclass.
3 Copyright 1997, 1998, 2003, 2007 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 2, or (at your option)
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 along
20 with this program; if not, write to the Free Software Foundation, Inc.,
21 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
24 /* Simulator state pseudo baseclass.
26 Each simulator is required to have the file ``sim-main.h''. That
27 file includes ``sim-basics.h'', defines the base type ``sim_cia''
28 (the data type that contains complete current instruction address
29 information), include ``sim-base.h'':
31 #include "sim-basics.h"
32 typedef address_word sim_cia;
33 /-* If `sim_cia' is not an integral value (e.g. a struct), define
34 CIA_ADDR to return the integral value. *-/
35 /-* #define CIA_ADDR(cia) (...) *-/
38 finally, two data types `struct _sim_cpu' and `struct sim_state'
42 ... simulator specific members ...
47 sim_cpu cpu[MAX_NR_PROCESSORS];
49 #define STATE_CPU(sd,n) (&(sd)->cpu[n])
51 #define STATE_CPU(sd,n) (&(sd)->cpu[0])
53 ... simulator specific members ...
57 Note that `base' appears last. This makes `base.magic' appear last
58 in the entire struct and helps catch miscompilation errors. */
64 /* Pre-declare certain types. */
66 /* typedef <target-dependant> sim_cia; */
68 #define NULL_CIA ((sim_cia) 0)
70 /* Return the current instruction address as a number.
71 Some targets treat the current instruction address as a struct
72 (e.g. for delay slot handling). */
74 #define CIA_ADDR(cia) (cia)
76 #ifndef INVALID_INSTRUCTION_ADDRESS
77 #define INVALID_INSTRUCTION_ADDRESS ((address_word)0 - 1)
80 typedef struct _sim_cpu sim_cpu
;
82 #include "sim-module.h"
84 #include "sim-trace.h"
86 #include "sim-events.h"
87 #include "sim-profile.h"
89 #include "sim-model.h"
92 #include "sim-engine.h"
93 #include "sim-watch.h"
94 #include "sim-memopt.h"
97 /* Global pointer to current state while sim_resume is running.
98 On a machine with lots of registers, it might be possible to reserve
99 one of them for current_state. However on a machine with few registers
100 current_state can't permanently live in one and indirecting through it
101 will be slower [in which case one can have sim_resume set globals from
102 current_state for faster access].
103 If CURRENT_STATE_REG is defined, it means current_state is living in
104 a global register. */
107 #ifdef CURRENT_STATE_REG
110 extern struct sim_state
*current_state
;
114 /* The simulator may provide different (and faster) definition. */
115 #ifndef CURRENT_STATE
116 #define CURRENT_STATE current_state
122 /* Simulator's argv[0]. */
124 #define STATE_MY_NAME(sd) ((sd)->base.my_name)
126 /* Who opened the simulator. */
127 SIM_OPEN_KIND open_kind
;
128 #define STATE_OPEN_KIND(sd) ((sd)->base.open_kind)
130 /* The host callbacks. */
131 struct host_callback_struct
*callback
;
132 #define STATE_CALLBACK(sd) ((sd)->base.callback)
134 /* The type of simulation environment (user/operating). */
135 enum sim_environment environment
;
136 #define STATE_ENVIRONMENT(sd) ((sd)->base.environment)
138 #if 0 /* FIXME: Not ready yet. */
139 /* Stuff defined in sim-config.h. */
140 struct sim_config config
;
141 #define STATE_CONFIG(sd) ((sd)->base.config)
144 /* List of installed module `init' handlers. */
145 struct module_list
*modules
;
146 #define STATE_MODULES(sd) ((sd)->base.modules)
148 /* Supported options. */
149 struct option_list
*options
;
150 #define STATE_OPTIONS(sd) ((sd)->base.options)
152 /* Non-zero if -v specified. */
154 #define STATE_VERBOSE_P(sd) ((sd)->base.verbose_p)
156 /* Non cpu-specific trace data. See sim-trace.h. */
157 TRACE_DATA trace_data
;
158 #define STATE_TRACE_DATA(sd) (& (sd)->base.trace_data)
160 /* If non NULL, the BFD architecture specified on the command line */
161 const struct bfd_arch_info
*architecture
;
162 #define STATE_ARCHITECTURE(sd) ((sd)->base.architecture)
164 /* If non NULL, the bfd target specified on the command line */
166 #define STATE_TARGET(sd) ((sd)->base.target)
168 /* In standalone simulator, this is the program's arguments passed
169 on the command line. */
171 #define STATE_PROG_ARGV(sd) ((sd)->base.prog_argv)
173 /* The program's bfd. */
174 struct bfd
*prog_bfd
;
175 #define STATE_PROG_BFD(sd) ((sd)->base.prog_bfd)
177 /* Symbol table for prog_bfd */
178 struct bfd_symbol
**prog_syms
;
179 #define STATE_PROG_SYMS(sd) ((sd)->base.prog_syms)
181 /* The program's text section. */
182 struct bfd_section
*text_section
;
183 /* Starting and ending text section addresses from the bfd. */
184 bfd_vma text_start
, text_end
;
185 #define STATE_TEXT_SECTION(sd) ((sd)->base.text_section)
186 #define STATE_TEXT_START(sd) ((sd)->base.text_start)
187 #define STATE_TEXT_END(sd) ((sd)->base.text_end)
189 /* Start address, set when the program is loaded from the bfd. */
191 #define STATE_START_ADDR(sd) ((sd)->base.start_addr)
193 /* Size of the simulator's cache, if any.
194 This is not the target's cache. It is the cache the simulator uses
195 to process instructions. */
196 unsigned int scache_size
;
197 #define STATE_SCACHE_SIZE(sd) ((sd)->base.scache_size)
199 /* FIXME: Move to top level sim_state struct (as some struct)? */
200 #ifdef SIM_HAVE_FLATMEM
201 unsigned int mem_size
;
202 #define STATE_MEM_SIZE(sd) ((sd)->base.mem_size)
203 unsigned int mem_base
;
204 #define STATE_MEM_BASE(sd) ((sd)->base.mem_base)
205 unsigned char *memory
;
206 #define STATE_MEMORY(sd) ((sd)->base.memory)
209 /* core memory bus */
210 #define STATE_CORE(sd) (&(sd)->base.core)
213 /* Record of memory sections added via the memory-options interface. */
214 #define STATE_MEMOPT(sd) ((sd)->base.memopt)
218 #define STATE_EVENTS(sd) (&(sd)->base.events)
221 /* generic halt/resume engine */
223 #define STATE_ENGINE(sd) (&(sd)->base.engine)
225 /* generic watchpoint support */
226 sim_watchpoints watchpoints
;
227 #define STATE_WATCHPOINTS(sd) (&(sd)->base.watchpoints)
231 #define STATE_HW(sd) ((sd)->base.hw)
234 /* Should image loads be performed using the LMA or VMA? Older
235 simulators use the VMA while newer simulators prefer the LMA. */
237 #define STATE_LOAD_AT_LMA_P(SD) ((SD)->base.load_at_lma_p)
239 /* Marker for those wanting to do sanity checks.
240 This should remain the last member of this struct to help catch
241 miscompilation errors. */
243 #define SIM_MAGIC_NUMBER 0x4242
244 #define STATE_MAGIC(sd) ((sd)->base.magic)
247 /* Functions for allocating/freeing a sim_state. */
248 SIM_DESC sim_state_alloc
PARAMS ((SIM_OPEN_KIND kind
, host_callback
*callback
));
249 void sim_state_free
PARAMS ((SIM_DESC
));
251 #endif /* SIM_BASE_H */