sim/common/sim-model.h

   1 /* Architecture, machine, and model support.
   2    Copyright (C) 1997-2024 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support.
   4
   5 This file is part of GDB, the GNU debugger.
   6
   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 3 of the License, or
  10 (at your option) any later version.
  11
  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.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 /* Nomenclature:
  21    architecture = one of sparc, mips, sh, etc.
  22    in the sparc architecture, mach = one of v6, v7, v8, sparclite, etc.
  23    in the v8 mach, model = one of supersparc, etc.
  24
  25    To use the model framework, your arch needs to do a few things:
  26    (1) Call SIM_AC_OPTION_DEFAULT_MODEL() in configure.ac.
  27    (2) Define enum mach_attr in sim-main.h.
  28    (3) Define sim_machs array (and all the callbacks it uses).
  29 */
  30
  31 /* This file is intended to be included by sim-basics.h.  */
  32
  33 #ifndef SIM_MODEL_H
  34 #define SIM_MODEL_H
  35
  36 /* Function unit and instruction timing support.
  37    ??? This is obviously insufficiently general.
  38    It's useful but it needs elaborating upon.  */
  39
  40 typedef struct {
  41   unsigned char name; /* actually a UNIT_TYPE enum */
  42   unsigned char issue;
  43   unsigned char done;
  44 } UNIT;
  45
  46 #ifndef MAX_UNITS
  47 #define MAX_UNITS 1
  48 #endif
  49
  50 typedef int (MODEL_FN) (sim_cpu *, void *);
  51
  52 typedef struct {
  53   /* This is an integer that identifies this insn.
  54      How this works is up to the target.  */
  55   int num;
  56
  57   /* Function to handle insn-specific profiling.  */
  58   MODEL_FN *model_fn;
  59
  60   /* Array of function units used by this insn.  */
  61   UNIT units[MAX_UNITS];
  62 } INSN_TIMING;
  63
  64 /* Struct to describe various implementation properties of a cpu.
  65    When multiple cpu variants are supported, the sizes of some structs
  66    can vary.  */
  67
  68 typedef struct {
  69   /* The size of the SIM_CPU struct.  */
  70   int sim_cpu_size;
  71 #define IMP_PROPS_SIM_CPU_SIZE(cpu_props) ((cpu_props)->sim_cpu_size)
  72   /* An SCACHE element can vary in size, depending on the selected cpu.
  73      This is zero if the SCACHE isn't in use for this variant.  */
  74   int scache_elm_size;
  75 #define IMP_PROPS_SCACHE_ELM_SIZE(cpu_props) ((cpu_props)->scache_elm_size)
  76 } SIM_MACH_IMP_PROPERTIES;
  77
  78 /* A machine variant.  */
  79
  80 typedef struct {
  81   const char *name;
  82 #define MACH_NAME(m) ((m)->name)
  83   /* This is the argument to bfd_scan_arch.  */
  84   const char *bfd_name;
  85 #define MACH_BFD_NAME(m) ((m)->bfd_name)
  86   int num;
  87 #define MACH_NUM(m) ((m)->num)
  88
  89   int word_bitsize;
  90 #define MACH_WORD_BITSIZE(m) ((m)->word_bitsize)
  91   int addr_bitsize;
  92 #define MACH_ADDR_BITSIZE(m) ((m)->addr_bitsize)
  93
  94   /* Pointer to null-entry terminated table of models of this mach.
  95      The default is the first one.  */
  96   const struct model *models;
  97 #define MACH_MODELS(m) ((m)->models)
  98
  99   /* Pointer to the implementation properties of this mach.  */
 100   const SIM_MACH_IMP_PROPERTIES *imp_props;
 101 #define MACH_IMP_PROPS(m) ((m)->imp_props)
 102
 103   /* Called by sim_model_set when the model of a cpu is set.  */
 104   void (* init_cpu) (sim_cpu *);
 105 #define MACH_INIT_CPU(m) ((m)->init_cpu)
 106
 107   /* Initialize the simulator engine for this cpu.
 108      Used by cgen simulators to initialize the insn descriptor table.  */
 109   void (* prepare_run) (sim_cpu *);
 110 #define MACH_PREPARE_RUN(m) ((m)->prepare_run)
 111 } SIM_MACH;
 112
 113 /* A model (implementation) of a machine.  */
 114
 115 typedef struct model {
 116   const char *name;
 117 #define MODEL_NAME(m) ((m)->name)
 118   const SIM_MACH *mach;
 119 #define MODEL_MACH(m) ((m)->mach)
 120   /* An enum that distinguished the model.  */
 121   int num;
 122 #define MODEL_NUM(m) ((m)->num)
 123   /* Pointer to timing table for this model.  */
 124   const INSN_TIMING *timing;
 125 #define MODEL_TIMING(m) ((m)->timing)
 126   void (* init) (sim_cpu *);
 127 #define MODEL_INIT(m) ((m)->init)
 128 } SIM_MODEL;
 129
 130 /* Model module handlers.  */
 131 extern MODULE_INSTALL_FN sim_model_install;
 132
 133 /* Support routines.  */
 134 extern void sim_model_set (SIM_DESC sd_, sim_cpu *cpu_, const SIM_MODEL *model_);
 135 extern const SIM_MODEL *sim_model_lookup (SIM_DESC, const char *name_);
 136 extern const SIM_MACH *sim_mach_lookup (SIM_DESC, const char *name_);
 137 extern const SIM_MACH *sim_mach_lookup_bfd_name (SIM_DESC, const char *bfd_name_);
 138
 139 #endif /* SIM_MODEL_H */