gdbserver/tdesc.cc

   1 /* Copyright (C) 2012-2023 Free Software Foundation, Inc.
   2
   3    This file is part of GDB.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #include "server.h"
  19 #include "tdesc.h"
  20 #include "regdef.h"
  21
  22 #ifndef IN_PROCESS_AGENT
  23
  24 target_desc::~target_desc ()
  25 {
  26   xfree ((char *) arch);
  27   xfree ((char *) osabi);
  28 }
  29
  30 bool target_desc::operator== (const target_desc &other) const
  31 {
  32   if (reg_defs != other.reg_defs)
  33     return false;
  34
  35   /* Compare the two vectors of expedited registers.  They will only match
  36      if the following conditions are met:
  37
  38      - Both vectors have the same number of elements.
  39      - Both vectors contain the same elements.
  40      - The elements of both vectors appear in the same order.  */
  41   if (expedite_regs != other.expedite_regs)
  42     return false;
  43
  44   return true;
  45 }
  46
  47 #endif
  48
  49 void target_desc::accept (tdesc_element_visitor &v) const
  50 {
  51 #ifndef IN_PROCESS_AGENT
  52   v.visit_pre (this);
  53
  54   for (const tdesc_feature_up &feature : features)
  55     feature->accept (v);
  56
  57   v.visit_post (this);
  58 #endif
  59 }
  60
  61 void
  62 init_target_desc (struct target_desc *tdesc,
  63                   const char **expedite_regs)
  64 {
  65   int offset = 0;
  66
  67   /* Go through all the features and populate reg_defs.  */
  68   for (const tdesc_feature_up &feature : tdesc->features)
  69     for (const tdesc_reg_up &treg : feature->registers)
  70       {
  71         int regnum = treg->target_regnum;
  72
  73         /* Register number will increase (possibly with gaps) or be zero.  */
  74         gdb_assert (regnum == 0 || regnum >= tdesc->reg_defs.size ());
  75
  76         if (regnum != 0)
  77           tdesc->reg_defs.resize (regnum, gdb::reg (offset));
  78
  79         tdesc->reg_defs.emplace_back (treg->name.c_str (), offset,
  80                                       treg->bitsize);
  81         offset += treg->bitsize;
  82       }
  83
  84   tdesc->registers_size = offset / 8;
  85
  86   /* Make sure PBUFSIZ is large enough to hold a full register
  87      packet.  */
  88   gdb_assert (2 * tdesc->registers_size + 32 <= PBUFSIZ);
  89
  90 #ifndef IN_PROCESS_AGENT
  91   /* Drop the contents of the previous vector, if any.  */
  92   tdesc->expedite_regs.clear ();
  93
  94   /* Initialize the vector with new expedite registers contents.  */
  95   int expedite_count = 0;
  96   while (expedite_regs[expedite_count] != nullptr)
  97     tdesc->expedite_regs.push_back (expedite_regs[expedite_count++]);
  98 #endif
  99 }
 100
 101 /* See gdbsupport/tdesc.h.  */
 102
 103 target_desc_up
 104 allocate_target_description (void)
 105 {
 106   return target_desc_up (new target_desc ());
 107 }
 108
 109 /* See gdbsupport/tdesc.h.  */
 110
 111 void
 112 target_desc_deleter::operator() (struct target_desc *target_desc) const
 113 {
 114   delete target_desc;
 115 }
 116
 117 #ifndef IN_PROCESS_AGENT
 118
 119 static const struct target_desc default_description {};
 120
 121 void
 122 copy_target_description (struct target_desc *dest,
 123                          const struct target_desc *src)
 124 {
 125   dest->reg_defs = src->reg_defs;
 126   dest->expedite_regs = src->expedite_regs;
 127   dest->registers_size = src->registers_size;
 128   dest->xmltarget = src->xmltarget;
 129 }
 130
 131 const struct target_desc *
 132 current_target_desc (void)
 133 {
 134   if (current_thread == NULL)
 135     return &default_description;
 136
 137   return current_process ()->tdesc;
 138 }
 139
 140 /* An empty structure.  */
 141
 142 struct tdesc_compatible_info { };
 143
 144 /* See gdbsupport/tdesc.h.  */
 145
 146 const std::vector<tdesc_compatible_info_up> &
 147 tdesc_compatible_info_list (const target_desc *target_desc)
 148 {
 149   static std::vector<tdesc_compatible_info_up> empty;
 150   return empty;
 151 }
 152
 153 /* See gdbsupport/tdesc.h.  */
 154
 155 const char *
 156 tdesc_compatible_info_arch_name (const tdesc_compatible_info_up &c_info)
 157 {
 158   return nullptr;
 159 }
 160
 161 /* See gdbsupport/tdesc.h.  */
 162
 163 const char *
 164 tdesc_architecture_name (const struct target_desc *target_desc)
 165 {
 166   return target_desc->arch;
 167 }
 168
 169 /* See gdbsupport/tdesc.h.  */
 170
 171 void
 172 set_tdesc_architecture (struct target_desc *target_desc,
 173                         const char *name)
 174 {
 175   target_desc->arch = xstrdup (name);
 176 }
 177
 178 /* See gdbsupport/tdesc.h.  */
 179
 180 const char *
 181 tdesc_osabi_name (const struct target_desc *target_desc)
 182 {
 183   return target_desc->osabi;
 184 }
 185
 186 /* See gdbsupport/tdesc.h.  */
 187
 188 void
 189 set_tdesc_osabi (struct target_desc *target_desc, const char *name)
 190 {
 191   target_desc->osabi = xstrdup (name);
 192 }
 193
 194 /* See gdbsupport/tdesc.h.  */
 195
 196 const char *
 197 tdesc_get_features_xml (const target_desc *tdesc)
 198 {
 199   /* Either .xmltarget or .features is not NULL.  */
 200   gdb_assert (tdesc->xmltarget != NULL
 201               || (!tdesc->features.empty ()
 202                   && tdesc->arch != NULL));
 203
 204   if (tdesc->xmltarget == NULL)
 205     {
 206       std::string buffer ("@");
 207       print_xml_feature v (&buffer);
 208       tdesc->accept (v);
 209       tdesc->xmltarget = xstrdup (buffer.c_str ());
 210     }
 211
 212   return tdesc->xmltarget;
 213 }
 214 #endif
 215
 216 /* See gdbsupport/tdesc.h.  */
 217
 218 struct tdesc_feature *
 219 tdesc_create_feature (struct target_desc *tdesc, const char *name)
 220 {
 221   struct tdesc_feature *new_feature = new tdesc_feature (name);
 222   tdesc->features.emplace_back (new_feature);
 223   return new_feature;
 224 }
 225
 226 /* See gdbsupport/tdesc.h.  */
 227
 228 bool
 229 tdesc_contains_feature (const target_desc *tdesc, const std::string &feature)
 230 {
 231   gdb_assert (tdesc != nullptr);
 232
 233   for (const tdesc_feature_up &f : tdesc->features)
 234     {
 235       if (f->name == feature)
 236         return true;
 237     }
 238
 239   return false;
 240 }