1 /* Simulator pseudo baseclass.
2 Copyright (C) 1997 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 2, or (at your option)
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 along
18 with this program; if not, write to the Free Software Foundation, Inc.,
19 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
22 /* Simulator state pseudo baseclass.
24 Each simulator is required to have the file ``sim-main.h''. That
25 file includes ``sim-basics.h'', defines the base type ``sim_cia''
26 (the data type that contains complete current instruction address
27 information), include ``sim-base.h'':
29 #include "sim-basics.h"
30 typedef address_word sim_cia;
33 finally, two data types ``struct _sim_cpu' and ``struct sim_state'
37 ... simulator specific members ...
42 sim_cpu cpu[MAX_NR_PROCESSORS];
44 #define STATE_CPU(sd,n) (&(sd)->cpu[n])
46 #define STATE_CPU(sd,n) (&(sd)->cpu[0])
48 ... simulator specific members ...
52 Note that `base' appears last. This makes `base.magic' appear last
53 in the entire struct and helps catch miscompilation errors. */
59 /* Pre-declare certain types. */
61 /* typedef <target-dependant> sim_cia; */
63 #define NULL_CIA ((sim_cia) 0)
65 /* Return the current instruction address as a number.
66 Some targets treat the current instruction address as a struct
67 (e.g. for delay slot handling). */
69 #define CIA_ADDR(cia) (cia)
71 #ifndef INVALID_INSTRUCTION_ADDRESS
72 #define INVALID_INSTRUCTION_ADDRESS ((address_word)0 - 1)
75 typedef struct _sim_cpu sim_cpu
;
77 #include "sim-module.h"
79 #include "sim-trace.h"
81 #include "sim-events.h"
82 #include "sim-profile.h"
84 #include "sim-model.h"
87 #include "sim-engine.h"
88 #include "sim-watch.h"
89 #include "sim-memopt.h"
90 #ifdef SIM_HAVE_BREAKPOINTS
91 #include "sim-break.h"
94 /* Global pointer to current state while sim_resume is running.
95 On a machine with lots of registers, it might be possible to reserve
96 one of them for current_state. However on a machine with few registers
97 current_state can't permanently live in one and indirecting through it
98 will be slower [in which case one can have sim_resume set globals from
99 current_state for faster access].
100 If CURRENT_STATE_REG is defined, it means current_state is living in
101 a global register. */
104 #ifdef CURRENT_STATE_REG
107 extern struct sim_state
*current_state
;
111 /* The simulator may provide different (and faster) definition. */
112 #ifndef CURRENT_STATE
113 #define CURRENT_STATE current_state
119 /* Simulator's argv[0]. */
121 #define STATE_MY_NAME(sd) ((sd)->base.my_name)
123 /* Who opened the simulator. */
124 SIM_OPEN_KIND open_kind
;
125 #define STATE_OPEN_KIND(sd) ((sd)->base.open_kind)
127 /* The host callbacks. */
128 struct host_callback_struct
*callback
;
129 #define STATE_CALLBACK(sd) ((sd)->base.callback)
131 #if 0 /* FIXME: Not ready yet. */
132 /* Stuff defined in sim-config.h. */
133 struct sim_config config
;
134 #define STATE_CONFIG(sd) ((sd)->base.config)
137 /* List of installed module `init' handlers. */
138 MODULE_INIT_LIST
*init_list
;
139 #define STATE_INIT_LIST(sd) ((sd)->base.init_list)
140 /* List of installed module `uninstall' handlers. */
141 MODULE_UNINSTALL_LIST
*uninstall_list
;
142 #define STATE_UNINSTALL_LIST(sd) ((sd)->base.uninstall_list)
143 /* List of installed module `resume' handlers. */
144 MODULE_RESUME_LIST
*resume_list
;
145 #define STATE_RESUME_LIST(sd) ((sd)->base.resume_list)
146 /* List of installed module `suspend' handlers. */
147 MODULE_SUSPEND_LIST
*suspend_list
;
148 #define STATE_SUSPEND_LIST(sd) ((sd)->base.suspend_list)
150 #ifdef SIM_HAVE_MODEL
151 /* ??? This might be more appropriate in sim_cpu. */
152 /* Machine tables for this cpu. See sim-model.h. */
154 #define STATE_MODEL(sd) ((sd)->base.model)
157 /* Supported options. */
158 struct option_list
*options
;
159 #define STATE_OPTIONS(sd) ((sd)->base.options)
161 /* Non-zero if -v specified. */
163 #define STATE_VERBOSE_P(sd) ((sd)->base.verbose_p)
165 /* Non cpu-specific trace data. See sim-trace.h. */
166 TRACE_DATA trace_data
;
167 #define STATE_TRACE_DATA(sd) (& (sd)->base.trace_data)
169 /* If non NULL, the BFD architecture specified on the command line */
170 const struct bfd_arch_info
*architecture
;
171 #define STATE_ARCHITECTURE(sd) ((sd)->base.architecture)
173 /* If non NULL, the bfd target specified on the command line */
175 #define STATE_TARGET(sd) ((sd)->base.target)
177 /* In standalone simulator, this is the program's arguments passed
178 on the command line. */
180 #define STATE_PROG_ARGV(sd) ((sd)->base.prog_argv)
182 /* The program's bfd. */
183 struct _bfd
*prog_bfd
;
184 #define STATE_PROG_BFD(sd) ((sd)->base.prog_bfd)
186 /* The program's text section. */
187 struct sec
*text_section
;
188 /* Starting and ending text section addresses from the bfd. */
189 SIM_ADDR text_start
, text_end
;
190 #define STATE_TEXT_SECTION(sd) ((sd)->base.text_section)
191 #define STATE_TEXT_START(sd) ((sd)->base.text_start)
192 #define STATE_TEXT_END(sd) ((sd)->base.text_end)
194 /* Start address, set when the program is loaded from the bfd. */
196 #define STATE_START_ADDR(sd) ((sd)->base.start_addr)
199 /* Size of the simulator's cache, if any.
200 This is not the target's cache. It is the cache the simulator uses
201 to process instructions. */
202 unsigned int scache_size
;
203 #define STATE_SCACHE_SIZE(sd) ((sd)->base.scache_size)
206 /* FIXME: Move to top level sim_state struct (as some struct)? */
207 #ifdef SIM_HAVE_FLATMEM
208 unsigned int mem_size
;
209 #define STATE_MEM_SIZE(sd) ((sd)->base.mem_size)
210 unsigned int mem_base
;
211 #define STATE_MEM_BASE(sd) ((sd)->base.mem_base)
212 unsigned char *memory
;
213 #define STATE_MEMORY(sd) ((sd)->base.memory)
216 /* core memory bus */
217 #define STATE_CORE(sd) (&(sd)->base.core)
220 /* memory-options for managing the core */
221 #define STATE_MEMOPT(sd) ((sd)->base.memopt)
225 #define STATE_EVENTS(sd) (&(sd)->base.events)
228 /* generic halt/resume engine */
230 #define STATE_ENGINE(sd) (&(sd)->base.engine)
232 /* generic watchpoint support */
233 sim_watchpoints watchpoints
;
234 #define STATE_WATCHPOINTS(sd) (&(sd)->base.watchpoints)
236 /* Pointer to list of breakpoints */
237 struct sim_breakpoint
*breakpoints
;
238 #define STATE_BREAKPOINTS(sd) ((sd)->base.breakpoints)
240 /* Marker for those wanting to do sanity checks.
241 This should remain the last member of this struct to help catch
242 miscompilation errors. */
244 #define SIM_MAGIC_NUMBER 0x4242
245 #define STATE_MAGIC(sd) ((sd)->base.magic)
249 /* Pseudo baseclass for each cpu. */
253 /* Backlink to main state struct. */
255 #define CPU_STATE(cpu) ((cpu)->base.state)
257 /* Processor specific core data */
259 #define CPU_CORE(cpu) (& (cpu)->base.core)
261 /* Trace data. See sim-trace.h. */
262 TRACE_DATA trace_data
;
263 #define CPU_TRACE_DATA(cpu) (& (cpu)->base.trace_data)
265 /* Maximum number of debuggable entities.
266 This debugging is not intended for normal use.
267 It is only enabled when the simulator is configured with --with-debug
268 which shouldn't normally be specified. */
269 #ifndef MAX_DEBUG_VALUES
270 #define MAX_DEBUG_VALUES 4
273 /* Boolean array of specified debugging flags. */
274 char debug_flags
[MAX_DEBUG_VALUES
];
275 #define CPU_DEBUG_FLAGS(cpu) ((cpu)->base.debug_flags)
276 /* Standard values. */
277 #define DEBUG_INSN_IDX 0
278 #define DEBUG_NEXT_IDX 2 /* simulator specific debug bits begin here */
280 /* Debugging output goes to this or stderr if NULL.
281 We can't store `stderr' here as stderr goes through a callback. */
283 #define CPU_DEBUG_FILE(cpu) ((cpu)->base.debug_file)
285 /* Profile data. See sim-profile.h. */
286 PROFILE_DATA profile_data
;
287 #define CPU_PROFILE_DATA(cpu) (& (cpu)->base.profile_data)
292 /* Functions for allocating/freeing a sim_state. */
293 SIM_DESC sim_state_alloc
PARAMS ((SIM_OPEN_KIND kind
, host_callback
*callback
));
294 void sim_state_free
PARAMS ((SIM_DESC
));
297 #endif /* SIM_BASE_H */