1 /* Simulator pseudo baseclass. 2 3 Copyright 1997-2015 Free Software Foundation, Inc. 4 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 11 the Free Software Foundation; either version 3 of the License, or 12 (at your option) any later version. 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 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/>. */ 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" 31 /-* If `sim_cia' is not an integral value (e.g. a struct), define 32 CIA_ADDR to return the integral value. *-/ 33 /-* typedef struct {...} sim_cia; *-/ 34 /-* #define CIA_ADDR(cia) (...) *-/ 35 #include "sim-base.h" 36 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 45 struct sim_state { 46 sim_cpu *cpu[MAX_NR_PROCESSORS]; 47 ... simulator specific members ... 48 sim_state_base base; 49 }; 50 51 Note that `base' appears last. This makes `base.magic' appear last 52 in the entire struct and helps catch miscompilation errors. */ 53 54 55 #ifndef SIM_BASE_H 56 #define SIM_BASE_H 57 58 /* Pre-declare certain types. */ 59 60 /* typedef <target-dependant> sim_cia; */ 61 #ifndef NULL_CIA 62 #define NULL_CIA ((sim_cia) 0) 63 #endif 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). */ 67 #ifndef CIA_ADDR 68 #define CIA_ADDR(cia) (cia) 69 typedef address_word sim_cia; 70 #endif 71 #ifndef INVALID_INSTRUCTION_ADDRESS 72 #define INVALID_INSTRUCTION_ADDRESS ((address_word)0 - 1) 73 #endif 74 75 /* TODO: Probably should just delete SIM_CPU. */ 76 typedef struct _sim_cpu SIM_CPU; 77 typedef struct _sim_cpu sim_cpu; 78 79 #include "sim-module.h" 80 81 #include "sim-trace.h" 82 #include "sim-core.h" 83 #include "sim-events.h" 84 #include "sim-profile.h" 85 #ifdef SIM_HAVE_MODEL 86 #include "sim-model.h" 87 #endif 88 #include "sim-io.h" 89 #include "sim-engine.h" 90 #include "sim-watch.h" 91 #include "sim-memopt.h" 92 #include "sim-cpu.h" 93 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. */ 102 103 104 #ifdef CURRENT_STATE_REG 105 /* FIXME: wip */ 106 #else 107 extern struct sim_state *current_state; 108 #endif 109 110 111 /* The simulator may provide different (and faster) definition. */ 112 #ifndef CURRENT_STATE 113 #define CURRENT_STATE current_state 114 #endif 115 116 117 /* We require all sims to dynamically allocate cpus. See comment up top about 118 struct sim_state. */ 119 #if (WITH_SMP) 120 # define STATE_CPU(sd, n) ((sd)->cpu[n]) 121 #else 122 # define STATE_CPU(sd, n) ((sd)->cpu[0]) 123 #endif 124 125 126 typedef struct { 127 128 /* Simulator's argv[0]. */ 129 const char *my_name; 130 #define STATE_MY_NAME(sd) ((sd)->base.my_name) 131 132 /* Who opened the simulator. */ 133 SIM_OPEN_KIND open_kind; 134 #define STATE_OPEN_KIND(sd) ((sd)->base.open_kind) 135 136 /* The host callbacks. */ 137 struct host_callback_struct *callback; 138 #define STATE_CALLBACK(sd) ((sd)->base.callback) 139 140 /* The type of simulation environment (user/operating). */ 141 enum sim_environment environment; 142 #define STATE_ENVIRONMENT(sd) ((sd)->base.environment) 143 144 #if 0 /* FIXME: Not ready yet. */ 145 /* Stuff defined in sim-config.h. */ 146 struct sim_config config; 147 #define STATE_CONFIG(sd) ((sd)->base.config) 148 #endif 149 150 /* List of installed module `init' handlers. */ 151 struct module_list *modules; 152 #define STATE_MODULES(sd) ((sd)->base.modules) 153 154 /* Supported options. */ 155 struct option_list *options; 156 #define STATE_OPTIONS(sd) ((sd)->base.options) 157 158 /* Non-zero if -v specified. */ 159 int verbose_p; 160 #define STATE_VERBOSE_P(sd) ((sd)->base.verbose_p) 161 162 /* Non cpu-specific trace data. See sim-trace.h. */ 163 TRACE_DATA trace_data; 164 #define STATE_TRACE_DATA(sd) (& (sd)->base.trace_data) 165 166 /* If non NULL, the BFD architecture specified on the command line */ 167 const struct bfd_arch_info *architecture; 168 #define STATE_ARCHITECTURE(sd) ((sd)->base.architecture) 169 170 /* If non NULL, the bfd target specified on the command line */ 171 const char *target; 172 #define STATE_TARGET(sd) ((sd)->base.target) 173 174 /* In standalone simulator, this is the program's arguments passed 175 on the command line. */ 176 char **prog_argv; 177 #define STATE_PROG_ARGV(sd) ((sd)->base.prog_argv) 178 179 /* The program's bfd. */ 180 struct bfd *prog_bfd; 181 #define STATE_PROG_BFD(sd) ((sd)->base.prog_bfd) 182 183 /* Symbol table for prog_bfd */ 184 struct bfd_symbol **prog_syms; 185 #define STATE_PROG_SYMS(sd) ((sd)->base.prog_syms) 186 187 /* The program's text section. */ 188 struct bfd_section *text_section; 189 /* Starting and ending text section addresses from the bfd. */ 190 bfd_vma text_start, text_end; 191 #define STATE_TEXT_SECTION(sd) ((sd)->base.text_section) 192 #define STATE_TEXT_START(sd) ((sd)->base.text_start) 193 #define STATE_TEXT_END(sd) ((sd)->base.text_end) 194 195 /* Start address, set when the program is loaded from the bfd. */ 196 bfd_vma start_addr; 197 #define STATE_START_ADDR(sd) ((sd)->base.start_addr) 198 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) 204 205 /* FIXME: Move to top level sim_state struct (as some struct)? */ 206 #ifdef SIM_HAVE_FLATMEM 207 unsigned int mem_size; 208 #define STATE_MEM_SIZE(sd) ((sd)->base.mem_size) 209 unsigned int mem_base; 210 #define STATE_MEM_BASE(sd) ((sd)->base.mem_base) 211 unsigned char *memory; 212 #define STATE_MEMORY(sd) ((sd)->base.memory) 213 #endif 214 215 /* core memory bus */ 216 #define STATE_CORE(sd) (&(sd)->base.core) 217 sim_core core; 218 219 /* Record of memory sections added via the memory-options interface. */ 220 #define STATE_MEMOPT(sd) ((sd)->base.memopt) 221 sim_memopt *memopt; 222 223 /* event handler */ 224 #define STATE_EVENTS(sd) (&(sd)->base.events) 225 sim_events events; 226 227 /* generic halt/resume engine */ 228 sim_engine engine; 229 #define STATE_ENGINE(sd) (&(sd)->base.engine) 230 231 /* generic watchpoint support */ 232 sim_watchpoints watchpoints; 233 #define STATE_WATCHPOINTS(sd) (&(sd)->base.watchpoints) 234 235 #if WITH_HW 236 struct sim_hw *hw; 237 #define STATE_HW(sd) ((sd)->base.hw) 238 #endif 239 240 /* Should image loads be performed using the LMA or VMA? Older 241 simulators use the VMA while newer simulators prefer the LMA. */ 242 int load_at_lma_p; 243 #define STATE_LOAD_AT_LMA_P(SD) ((SD)->base.load_at_lma_p) 244 245 /* Marker for those wanting to do sanity checks. 246 This should remain the last member of this struct to help catch 247 miscompilation errors. */ 248 int magic; 249 #define SIM_MAGIC_NUMBER 0x4242 250 #define STATE_MAGIC(sd) ((sd)->base.magic) 251 } sim_state_base; 252 253 /* Functions for allocating/freeing a sim_state. */ 254 SIM_DESC sim_state_alloc (SIM_OPEN_KIND kind, host_callback *callback); 255 void sim_state_free (SIM_DESC); 256 257 #endif /* SIM_BASE_H */ 258