sim/common/sim-base.h

   1 /* Simulator pseudo baseclass.
   2
   3    Copyright 1997-2019 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 #ifdef __cplusplus
  59 extern "C" {
  60 #endif
  61
  62 /* Pre-declare certain types. */
  63
  64 /* typedef <target-dependant> sim_cia; */
  65 #ifndef NULL_CIA
  66 #define NULL_CIA ((sim_cia) 0)
  67 #endif
  68 /* Return the current instruction address as a number.
  69    Some targets treat the current instruction address as a struct
  70    (e.g. for delay slot handling).  */
  71 #ifndef CIA_ADDR
  72 #define CIA_ADDR(cia) (cia)
  73 typedef address_word sim_cia;
  74 #endif
  75 #ifndef INVALID_INSTRUCTION_ADDRESS
  76 #define INVALID_INSTRUCTION_ADDRESS ((address_word)0 - 1)
  77 #endif
  78
  79 /* TODO: Probably should just delete SIM_CPU.  */
  80 typedef struct _sim_cpu SIM_CPU;
  81 typedef struct _sim_cpu sim_cpu;
  82
  83 #include "sim-module.h"
  84
  85 #include "sim-arange.h"
  86 #include "sim-trace.h"
  87 #include "sim-core.h"
  88 #include "sim-events.h"
  89 #include "sim-profile.h"
  90 #include "sim-model.h"
  91 #include "sim-io.h"
  92 #include "sim-engine.h"
  93 #include "sim-watch.h"
  94 #include "sim-memopt.h"
  95 #include "sim-cpu.h"
  96
  97
  98 /* We require all sims to dynamically allocate cpus.  See comment up top about
  99    struct sim_state.  */
 100 #if (WITH_SMP)
 101 # define STATE_CPU(sd, n) ((sd)->cpu[n])
 102 #else
 103 # define STATE_CPU(sd, n) ((sd)->cpu[0])
 104 #endif
 105
 106
 107 typedef struct {
 108
 109   /* Simulator's argv[0].  */
 110   const char *my_name;
 111 #define STATE_MY_NAME(sd) ((sd)->base.my_name)
 112
 113   /* Who opened the simulator.  */
 114   SIM_OPEN_KIND open_kind;
 115 #define STATE_OPEN_KIND(sd) ((sd)->base.open_kind)
 116
 117   /* The host callbacks.  */
 118   struct host_callback_struct *callback;
 119 #define STATE_CALLBACK(sd) ((sd)->base.callback)
 120
 121   /* The type of simulation environment (user/operating).  */
 122   enum sim_environment environment;
 123 #define STATE_ENVIRONMENT(sd) ((sd)->base.environment)
 124
 125 #if 0 /* FIXME: Not ready yet.  */
 126   /* Stuff defined in sim-config.h.  */
 127   struct sim_config config;
 128 #define STATE_CONFIG(sd) ((sd)->base.config)
 129 #endif
 130
 131   /* List of installed module `init' handlers.  */
 132   struct module_list *modules;
 133 #define STATE_MODULES(sd) ((sd)->base.modules)
 134
 135   /* Supported options.  */
 136   struct option_list *options;
 137 #define STATE_OPTIONS(sd) ((sd)->base.options)
 138
 139   /* Non-zero if -v specified.  */
 140   int verbose_p;
 141 #define STATE_VERBOSE_P(sd) ((sd)->base.verbose_p)
 142
 143   /* Non cpu-specific trace data.  See sim-trace.h.  */
 144   TRACE_DATA trace_data;
 145 #define STATE_TRACE_DATA(sd) (& (sd)->base.trace_data)
 146
 147   /* If non NULL, the BFD architecture specified on the command line */
 148   const struct bfd_arch_info *architecture;
 149 #define STATE_ARCHITECTURE(sd) ((sd)->base.architecture)
 150
 151   /* If non NULL, the bfd target specified on the command line */
 152   const char *target;
 153 #define STATE_TARGET(sd) ((sd)->base.target)
 154
 155   /* In standalone simulator, this is the program's arguments passed
 156      on the command line.  */
 157   char **prog_argv;
 158 #define STATE_PROG_ARGV(sd) ((sd)->base.prog_argv)
 159
 160   /* The program's bfd.  */
 161   struct bfd *prog_bfd;
 162 #define STATE_PROG_BFD(sd) ((sd)->base.prog_bfd)
 163
 164   /* Symbol table for prog_bfd */
 165   struct bfd_symbol **prog_syms;
 166 #define STATE_PROG_SYMS(sd) ((sd)->base.prog_syms)
 167
 168   /* Number of prog_syms symbols.  */
 169   long prog_syms_count;
 170 #define STATE_PROG_SYMS_COUNT(sd) ((sd)->base.prog_syms_count)
 171
 172   /* The program's text section.  */
 173   struct bfd_section *text_section;
 174   /* Starting and ending text section addresses from the bfd.  */
 175   bfd_vma text_start, text_end;
 176 #define STATE_TEXT_SECTION(sd) ((sd)->base.text_section)
 177 #define STATE_TEXT_START(sd) ((sd)->base.text_start)
 178 #define STATE_TEXT_END(sd) ((sd)->base.text_end)
 179
 180   /* Start address, set when the program is loaded from the bfd.  */
 181   bfd_vma start_addr;
 182 #define STATE_START_ADDR(sd) ((sd)->base.start_addr)
 183
 184   /* Size of the simulator's cache, if any.
 185      This is not the target's cache.  It is the cache the simulator uses
 186      to process instructions.  */
 187   unsigned int scache_size;
 188 #define STATE_SCACHE_SIZE(sd) ((sd)->base.scache_size)
 189
 190   /* core memory bus */
 191 #define STATE_CORE(sd) (&(sd)->base.core)
 192   sim_core core;
 193
 194   /* Record of memory sections added via the memory-options interface.  */
 195 #define STATE_MEMOPT(sd) ((sd)->base.memopt)
 196   sim_memopt *memopt;
 197
 198   /* event handler */
 199 #define STATE_EVENTS(sd) (&(sd)->base.events)
 200   sim_events events;
 201
 202   /* generic halt/resume engine */
 203   sim_engine engine;
 204 #define STATE_ENGINE(sd) (&(sd)->base.engine)
 205
 206   /* generic watchpoint support */
 207   sim_watchpoints watchpoints;
 208 #define STATE_WATCHPOINTS(sd) (&(sd)->base.watchpoints)
 209
 210 #if WITH_HW
 211   struct sim_hw *hw;
 212 #define STATE_HW(sd) ((sd)->base.hw)
 213 #endif
 214
 215   /* Should image loads be performed using the LMA or VMA?  Older
 216      simulators use the VMA while newer simulators prefer the LMA. */
 217   int load_at_lma_p;
 218 #define STATE_LOAD_AT_LMA_P(SD) ((SD)->base.load_at_lma_p)
 219
 220   /* Marker for those wanting to do sanity checks.
 221      This should remain the last member of this struct to help catch
 222      miscompilation errors.  */
 223   int magic;
 224 #define SIM_MAGIC_NUMBER 0x4242
 225 #define STATE_MAGIC(sd) ((sd)->base.magic)
 226 } sim_state_base;
 227
 228 /* Functions for allocating/freeing a sim_state.  */
 229 SIM_DESC sim_state_alloc (SIM_OPEN_KIND kind, host_callback *callback);
 230 void sim_state_free (SIM_DESC);
 231
 232 #ifdef __cplusplus
 233 }
 234 #endif
 235
 236 #endif /* SIM_BASE_H */