Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Simulator pseudo baseclass. |
836cc9f4 | 2 | |
3666a048 | 3 | Copyright 1997-2021 Free Software Foundation, Inc. |
836cc9f4 | 4 | |
c906108c SS |
5 | Contributed by Cygnus Support. |
6 | ||
7 | This file is part of GDB, the GNU debugger. | |
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 JB |
11 | the Free Software Foundation; either version 3 of the License, or |
12 | (at your option) any later version. | |
c906108c SS |
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 | ||
4744ac1b JB |
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/>. */ | |
c906108c SS |
21 | |
22 | ||
23 | /* Simulator state pseudo baseclass. | |
24 | ||
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'': | |
29 | ||
30 | #include "sim-basics.h" | |
c906108c SS |
31 | /-* If `sim_cia' is not an integral value (e.g. a struct), define |
32 | CIA_ADDR to return the integral value. *-/ | |
7e83aa92 | 33 | /-* typedef struct {...} sim_cia; *-/ |
c906108c SS |
34 | /-* #define CIA_ADDR(cia) (...) *-/ |
35 | #include "sim-base.h" | |
028f6515 | 36 | |
c906108c SS |
37 | finally, two data types `struct _sim_cpu' and `struct sim_state' |
38 | are defined: | |
39 | ||
40 | struct _sim_cpu { | |
41 | ... simulator specific members ... | |
42 | sim_cpu_base base; | |
43 | }; | |
44 | ||
383861bd | 45 | If your sim needs to allocate sim-wide state, use STATE_ARCH_DATA. */ |
c906108c SS |
46 | |
47 | ||
48 | #ifndef SIM_BASE_H | |
49 | #define SIM_BASE_H | |
50 | ||
444b3fae ПК |
51 | #ifdef __cplusplus |
52 | extern "C" { | |
53 | #endif | |
54 | ||
c906108c SS |
55 | /* Pre-declare certain types. */ |
56 | ||
57 | /* typedef <target-dependant> sim_cia; */ | |
58 | #ifndef NULL_CIA | |
59 | #define NULL_CIA ((sim_cia) 0) | |
60 | #endif | |
61 | /* Return the current instruction address as a number. | |
62 | Some targets treat the current instruction address as a struct | |
63 | (e.g. for delay slot handling). */ | |
64 | #ifndef CIA_ADDR | |
65 | #define CIA_ADDR(cia) (cia) | |
7e83aa92 | 66 | typedef address_word sim_cia; |
c906108c SS |
67 | #endif |
68 | #ifndef INVALID_INSTRUCTION_ADDRESS | |
69 | #define INVALID_INSTRUCTION_ADDRESS ((address_word)0 - 1) | |
70 | #endif | |
71 | ||
20bca71d MF |
72 | /* TODO: Probably should just delete SIM_CPU. */ |
73 | typedef struct _sim_cpu SIM_CPU; | |
c906108c SS |
74 | typedef struct _sim_cpu sim_cpu; |
75 | ||
76 | #include "sim-module.h" | |
77 | ||
ef986697 | 78 | #include "sim-arange.h" |
c906108c SS |
79 | #include "sim-trace.h" |
80 | #include "sim-core.h" | |
81 | #include "sim-events.h" | |
82 | #include "sim-profile.h" | |
c906108c | 83 | #include "sim-model.h" |
c906108c SS |
84 | #include "sim-io.h" |
85 | #include "sim-engine.h" | |
86 | #include "sim-watch.h" | |
87 | #include "sim-memopt.h" | |
c906108c | 88 | #include "sim-cpu.h" |
d3fe0d7b | 89 | #include "sim-assert.h" |
c906108c | 90 | |
f4fdd845 MF |
91 | struct sim_state { |
92 | /* All the cpus for this instance. */ | |
93 | sim_cpu *cpu[MAX_NR_PROCESSORS]; | |
78e9aa70 MF |
94 | #if (WITH_SMP) |
95 | # define STATE_CPU(sd, n) ((sd)->cpu[n]) | |
96 | #else | |
97 | # define STATE_CPU(sd, n) ((sd)->cpu[0]) | |
98 | #endif | |
99 | ||
c906108c SS |
100 | /* Simulator's argv[0]. */ |
101 | const char *my_name; | |
f4fdd845 | 102 | #define STATE_MY_NAME(sd) ((sd)->my_name) |
c906108c SS |
103 | |
104 | /* Who opened the simulator. */ | |
105 | SIM_OPEN_KIND open_kind; | |
f4fdd845 | 106 | #define STATE_OPEN_KIND(sd) ((sd)->open_kind) |
c906108c SS |
107 | |
108 | /* The host callbacks. */ | |
109 | struct host_callback_struct *callback; | |
f4fdd845 | 110 | #define STATE_CALLBACK(sd) ((sd)->callback) |
c906108c SS |
111 | |
112 | /* The type of simulation environment (user/operating). */ | |
113 | enum sim_environment environment; | |
f4fdd845 | 114 | #define STATE_ENVIRONMENT(sd) ((sd)->environment) |
c906108c SS |
115 | |
116 | #if 0 /* FIXME: Not ready yet. */ | |
117 | /* Stuff defined in sim-config.h. */ | |
118 | struct sim_config config; | |
f4fdd845 | 119 | #define STATE_CONFIG(sd) ((sd)->config) |
c906108c SS |
120 | #endif |
121 | ||
122 | /* List of installed module `init' handlers. */ | |
123 | struct module_list *modules; | |
f4fdd845 | 124 | #define STATE_MODULES(sd) ((sd)->modules) |
c906108c SS |
125 | |
126 | /* Supported options. */ | |
127 | struct option_list *options; | |
f4fdd845 | 128 | #define STATE_OPTIONS(sd) ((sd)->options) |
c906108c SS |
129 | |
130 | /* Non-zero if -v specified. */ | |
131 | int verbose_p; | |
f4fdd845 | 132 | #define STATE_VERBOSE_P(sd) ((sd)->verbose_p) |
c906108c SS |
133 | |
134 | /* Non cpu-specific trace data. See sim-trace.h. */ | |
135 | TRACE_DATA trace_data; | |
f4fdd845 | 136 | #define STATE_TRACE_DATA(sd) (& (sd)->trace_data) |
c906108c SS |
137 | |
138 | /* If non NULL, the BFD architecture specified on the command line */ | |
139 | const struct bfd_arch_info *architecture; | |
f4fdd845 | 140 | #define STATE_ARCHITECTURE(sd) ((sd)->architecture) |
c906108c SS |
141 | |
142 | /* If non NULL, the bfd target specified on the command line */ | |
143 | const char *target; | |
f4fdd845 | 144 | #define STATE_TARGET(sd) ((sd)->target) |
c906108c SS |
145 | |
146 | /* In standalone simulator, this is the program's arguments passed | |
147 | on the command line. */ | |
148 | char **prog_argv; | |
f4fdd845 | 149 | #define STATE_PROG_ARGV(sd) ((sd)->prog_argv) |
c906108c SS |
150 | |
151 | /* The program's bfd. */ | |
6b4a8935 | 152 | struct bfd *prog_bfd; |
f4fdd845 | 153 | #define STATE_PROG_BFD(sd) ((sd)->prog_bfd) |
c906108c SS |
154 | |
155 | /* Symbol table for prog_bfd */ | |
fc0a2244 | 156 | struct bfd_symbol **prog_syms; |
f4fdd845 | 157 | #define STATE_PROG_SYMS(sd) ((sd)->prog_syms) |
c906108c | 158 | |
5357150c MF |
159 | /* Number of prog_syms symbols. */ |
160 | long prog_syms_count; | |
f4fdd845 | 161 | #define STATE_PROG_SYMS_COUNT(sd) ((sd)->prog_syms_count) |
5357150c | 162 | |
c906108c | 163 | /* The program's text section. */ |
198beae2 | 164 | struct bfd_section *text_section; |
c906108c | 165 | /* Starting and ending text section addresses from the bfd. */ |
7e129781 | 166 | bfd_vma text_start, text_end; |
f4fdd845 MF |
167 | #define STATE_TEXT_SECTION(sd) ((sd)->text_section) |
168 | #define STATE_TEXT_START(sd) ((sd)->text_start) | |
169 | #define STATE_TEXT_END(sd) ((sd)->text_end) | |
c906108c SS |
170 | |
171 | /* Start address, set when the program is loaded from the bfd. */ | |
7e129781 | 172 | bfd_vma start_addr; |
f4fdd845 | 173 | #define STATE_START_ADDR(sd) ((sd)->start_addr) |
c906108c SS |
174 | |
175 | /* Size of the simulator's cache, if any. | |
176 | This is not the target's cache. It is the cache the simulator uses | |
177 | to process instructions. */ | |
178 | unsigned int scache_size; | |
f4fdd845 | 179 | #define STATE_SCACHE_SIZE(sd) ((sd)->scache_size) |
c906108c | 180 | |
c906108c | 181 | /* core memory bus */ |
f4fdd845 | 182 | #define STATE_CORE(sd) (&(sd)->core) |
c906108c SS |
183 | sim_core core; |
184 | ||
185 | /* Record of memory sections added via the memory-options interface. */ | |
f4fdd845 | 186 | #define STATE_MEMOPT(sd) ((sd)->memopt) |
c906108c SS |
187 | sim_memopt *memopt; |
188 | ||
189 | /* event handler */ | |
f4fdd845 | 190 | #define STATE_EVENTS(sd) (&(sd)->events) |
c906108c SS |
191 | sim_events events; |
192 | ||
193 | /* generic halt/resume engine */ | |
194 | sim_engine engine; | |
f4fdd845 | 195 | #define STATE_ENGINE(sd) (&(sd)->engine) |
c906108c SS |
196 | |
197 | /* generic watchpoint support */ | |
198 | sim_watchpoints watchpoints; | |
f4fdd845 | 199 | #define STATE_WATCHPOINTS(sd) (&(sd)->watchpoints) |
c906108c | 200 | |
c906108c SS |
201 | #if WITH_HW |
202 | struct sim_hw *hw; | |
f4fdd845 | 203 | #define STATE_HW(sd) ((sd)->hw) |
c906108c SS |
204 | #endif |
205 | ||
43e526b9 JM |
206 | /* Should image loads be performed using the LMA or VMA? Older |
207 | simulators use the VMA while newer simulators prefer the LMA. */ | |
208 | int load_at_lma_p; | |
f4fdd845 | 209 | #define STATE_LOAD_AT_LMA_P(SD) ((SD)->load_at_lma_p) |
383861bd MF |
210 | |
211 | /* Pointer for sim target to store arbitrary state data. Normally the | |
212 | target should define a struct and use it here. */ | |
213 | void *arch_data; | |
214 | #define STATE_ARCH_DATA(sd) ((sd)->arch_data) | |
e106fc35 | 215 | |
f4fdd845 MF |
216 | /* Marker for those wanting to do sanity checks. |
217 | This should remain the last member of this struct to help catch | |
218 | miscompilation errors. */ | |
219 | int magic; | |
220 | #define SIM_MAGIC_NUMBER 0x4242 | |
221 | #define STATE_MAGIC(sd) ((sd)->magic) | |
383861bd | 222 | }; |
383861bd | 223 | |
c906108c | 224 | /* Functions for allocating/freeing a sim_state. */ |
383861bd MF |
225 | SIM_DESC sim_state_alloc_extra (SIM_OPEN_KIND kind, host_callback *callback, |
226 | size_t extra_bytes); | |
227 | #define sim_state_alloc(kind, callback) sim_state_alloc_extra(kind, callback, 0) | |
228 | ||
bdca5ee4 | 229 | void sim_state_free (SIM_DESC); |
c906108c | 230 | |
444b3fae ПК |
231 | #ifdef __cplusplus |
232 | } | |
233 | #endif | |
234 | ||
c906108c | 235 | #endif /* SIM_BASE_H */ |