gdb/xml-syscall.c

   1 /* Functions that provide the mechanism to parse a syscall XML file
   2    and get its values.
   3
   4    Copyright (C) 2009-2024 Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #include "defs.h"
  22 #include "gdbtypes.h"
  23 #include "xml-support.h"
  24 #include "xml-syscall.h"
  25 #include "gdbarch.h"
  26
  27 /* For the struct syscall definition.  */
  28 #include "target.h"
  29
  30 #include "filenames.h"
  31
  32 #ifndef HAVE_LIBEXPAT
  33
  34 /* Dummy functions to indicate that there's no support for fetching
  35    syscalls information.  */
  36
  37 static void
  38 syscall_warn_user (void)
  39 {
  40   static int have_warned = 0;
  41   if (!have_warned)
  42     {
  43       have_warned = 1;
  44       warning (_("Can not parse XML syscalls information; XML support was "
  45                  "disabled at compile time."));
  46     }
  47 }
  48
  49 void
  50 set_xml_syscall_file_name (struct gdbarch *gdbarch, const char *name)
  51 {
  52   return;
  53 }
  54
  55 void
  56 get_syscall_by_number (struct gdbarch *gdbarch,
  57                        int syscall_number, struct syscall *s)
  58 {
  59   syscall_warn_user ();
  60   s->number = syscall_number;
  61   s->name = NULL;
  62 }
  63
  64 bool
  65 get_syscalls_by_name (struct gdbarch *gdbarch, const char *syscall_name,
  66                       std::vector<int> *syscall_numbers)
  67 {
  68   syscall_warn_user ();
  69   return false;
  70 }
  71
  72 const char **
  73 get_syscall_names (struct gdbarch *gdbarch)
  74 {
  75   syscall_warn_user ();
  76   return NULL;
  77 }
  78
  79 bool
  80 get_syscalls_by_group (struct gdbarch *gdbarch, const char *group,
  81                        std::vector<int> *syscall_numbers)
  82 {
  83   syscall_warn_user ();
  84   return false;
  85 }
  86
  87 const char **
  88 get_syscall_group_names (struct gdbarch *gdbarch)
  89 {
  90   syscall_warn_user ();
  91   return NULL;
  92 }
  93
  94 #else /* ! HAVE_LIBEXPAT */
  95
  96 /* Structure which describes a syscall.  */
  97 struct syscall_desc
  98 {
  99   syscall_desc (int number_, std::string name_, std::string alias_)
 100   : number (number_), name (name_), alias (alias_)
 101   {}
 102
 103   /* The syscall number.  */
 104
 105   int number;
 106
 107   /* The syscall name.  */
 108
 109   std::string name;
 110
 111   /* An optional alias.  */
 112
 113   std::string alias;
 114 };
 115
 116 typedef std::unique_ptr<syscall_desc> syscall_desc_up;
 117
 118 /* Structure of a syscall group.  */
 119 struct syscall_group_desc
 120 {
 121   syscall_group_desc (const std::string &name_)
 122   : name (name_)
 123   {}
 124
 125   /* The group name.  */
 126
 127   std::string name;
 128
 129   /* The syscalls that are part of the group.  This is a non-owning
 130      reference.  */
 131
 132   std::vector<syscall_desc *> syscalls;
 133 };
 134
 135 typedef std::unique_ptr<syscall_group_desc> syscall_group_desc_up;
 136
 137 /* Structure that represents syscalls information.  */
 138 struct syscalls_info
 139 {
 140   /* The syscalls.  */
 141
 142   std::vector<syscall_desc_up> syscalls;
 143
 144   /* The syscall groups.  */
 145
 146   std::vector<syscall_group_desc_up> groups;
 147
 148   /* Variable that will hold the last known data-directory.  This is
 149      useful to know whether we should re-read the XML info for the
 150      target.  */
 151
 152   std::string my_gdb_datadir;
 153 };
 154
 155 typedef std::unique_ptr<syscalls_info> syscalls_info_up;
 156
 157 /* Callback data for syscall information parsing.  */
 158 struct syscall_parsing_data
 159 {
 160   /* The syscalls_info we are building.  */
 161
 162   struct syscalls_info *syscalls_info;
 163 };
 164
 165 /* Create a new syscall group.  Return pointer to the
 166    syscall_group_desc structure that represents the new group.  */
 167
 168 static struct syscall_group_desc *
 169 syscall_group_create_syscall_group_desc (struct syscalls_info *syscalls_info,
 170                                          const char *group)
 171 {
 172   syscall_group_desc *groupdesc = new syscall_group_desc (group);
 173
 174   syscalls_info->groups.emplace_back (groupdesc);
 175
 176   return groupdesc;
 177 }
 178
 179 /* Add a syscall to the group.  If group doesn't exist, create it.  */
 180
 181 static void
 182 syscall_group_add_syscall (struct syscalls_info *syscalls_info,
 183                            struct syscall_desc *syscall,
 184                            const char *group)
 185 {
 186   /* Search for an existing group.  */
 187   std::vector<syscall_group_desc_up>::iterator it
 188     = syscalls_info->groups.begin ();
 189
 190   for (; it != syscalls_info->groups.end (); it++)
 191     {
 192       if ((*it)->name == group)
 193         break;
 194     }
 195
 196   syscall_group_desc *groupdesc;
 197
 198   if (it != syscalls_info->groups.end ())
 199     groupdesc = it->get ();
 200   else
 201     {
 202       /* No group was found with this name.  We must create a new
 203          one.  */
 204       groupdesc = syscall_group_create_syscall_group_desc (syscalls_info,
 205                                                            group);
 206     }
 207
 208   groupdesc->syscalls.push_back (syscall);
 209 }
 210
 211 static void
 212 syscall_create_syscall_desc (struct syscalls_info *syscalls_info,
 213                              const char *name, int number, const char *alias,
 214                              char *groups)
 215 {
 216   syscall_desc *sysdesc = new syscall_desc (number, name,
 217                                             alias != NULL ? alias : "");
 218
 219   syscalls_info->syscalls.emplace_back (sysdesc);
 220
 221   /*  Add syscall to its groups.  */
 222   if (groups != NULL)
 223     {
 224       char *saveptr;
 225       for (char *group = strtok_r (groups, ",", &saveptr);
 226            group != NULL;
 227            group = strtok_r (NULL, ",", &saveptr))
 228         syscall_group_add_syscall (syscalls_info, sysdesc, group);
 229     }
 230 }
 231
 232 /* Handle the start of a <syscall> element.  */
 233 static void
 234 syscall_start_syscall (struct gdb_xml_parser *parser,
 235                        const struct gdb_xml_element *element,
 236                        void *user_data,
 237                        std::vector<gdb_xml_value> &attributes)
 238 {
 239   struct syscall_parsing_data *data = (struct syscall_parsing_data *) user_data;
 240   /* syscall info.  */
 241   char *name = NULL;
 242   int number = 0;
 243   char *alias = NULL;
 244   char *groups = NULL;
 245
 246   for (const gdb_xml_value &attr : attributes)
 247     {
 248       if (strcmp (attr.name, "name") == 0)
 249         name = (char *) attr.value.get ();
 250       else if (strcmp (attr.name, "number") == 0)
 251         number = * (ULONGEST *) attr.value.get ();
 252       else if (strcmp (attr.name, "alias") == 0)
 253         alias = (char *) attr.value.get ();
 254       else if (strcmp (attr.name, "groups") == 0)
 255         groups = (char *) attr.value.get ();
 256       else
 257         internal_error (_("Unknown attribute name '%s'."), attr.name);
 258     }
 259
 260   gdb_assert (name);
 261   syscall_create_syscall_desc (data->syscalls_info, name, number, alias,
 262                                groups);
 263 }
 264
 265
 266 /* The elements and attributes of an XML syscall document.  */
 267 static const struct gdb_xml_attribute syscall_attr[] = {
 268   { "number", GDB_XML_AF_NONE, gdb_xml_parse_attr_ulongest, NULL },
 269   { "name", GDB_XML_AF_NONE, NULL, NULL },
 270   { "alias", GDB_XML_AF_OPTIONAL, NULL, NULL },
 271   { "groups", GDB_XML_AF_OPTIONAL, NULL, NULL },
 272   { NULL, GDB_XML_AF_NONE, NULL, NULL }
 273 };
 274
 275 static const struct gdb_xml_element syscalls_info_children[] = {
 276   { "syscall", syscall_attr, NULL,
 277     GDB_XML_EF_OPTIONAL | GDB_XML_EF_REPEATABLE,
 278     syscall_start_syscall, NULL },
 279   { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
 280 };
 281
 282 static const struct gdb_xml_element syselements[] = {
 283   { "syscalls_info", NULL, syscalls_info_children,
 284     GDB_XML_EF_NONE, NULL, NULL },
 285   { NULL, NULL, NULL, GDB_XML_EF_NONE, NULL, NULL }
 286 };
 287
 288 static struct syscalls_info *
 289 syscall_parse_xml (const char *document, xml_fetch_another fetcher)
 290 {
 291   struct syscall_parsing_data data;
 292   syscalls_info_up sysinfo (new syscalls_info ());
 293
 294   data.syscalls_info = sysinfo.get ();
 295
 296   if (gdb_xml_parse_quick (_("syscalls info"), NULL,
 297                            syselements, document, &data) == 0)
 298     {
 299       /* Parsed successfully.  */
 300       return sysinfo.release ();
 301     }
 302   else
 303     {
 304       warning (_("Could not load XML syscalls info; ignoring"));
 305       return NULL;
 306     }
 307 }
 308
 309 /* Function responsible for initializing the information
 310    about the syscalls.  It reads the XML file and fills the
 311    struct syscalls_info with the values.
 312
 313    Returns the struct syscalls_info if the file is valid, NULL otherwise.  */
 314 static struct syscalls_info *
 315 xml_init_syscalls_info (const char *filename)
 316 {
 317   std::optional<gdb::char_vector> full_file
 318     = xml_fetch_content_from_file (filename,
 319                                    const_cast<char *>(gdb_datadir.c_str ()));
 320   if (!full_file)
 321     return NULL;
 322
 323   const std::string dirname = ldirname (filename);
 324   auto fetch_another = [&dirname] (const char *name)
 325     {
 326       return xml_fetch_content_from_file (name, dirname.c_str ());
 327     };
 328
 329   return syscall_parse_xml (full_file->data (), fetch_another);
 330 }
 331
 332 /* Initializes the syscalls_info structure according to the
 333    architecture.  */
 334 static void
 335 init_syscalls_info (struct gdbarch *gdbarch)
 336 {
 337   struct syscalls_info *syscalls_info = gdbarch_syscalls_info (gdbarch);
 338   const char *xml_syscall_file = gdbarch_xml_syscall_file (gdbarch);
 339
 340   /* Should we re-read the XML info for this target?  */
 341   if (syscalls_info != NULL && !syscalls_info->my_gdb_datadir.empty ()
 342       && filename_cmp (syscalls_info->my_gdb_datadir.c_str (),
 343                        gdb_datadir.c_str ()) != 0)
 344     {
 345       /* The data-directory changed from the last time we used it.
 346          It means that we have to re-read the XML info.  */
 347       delete syscalls_info;
 348       syscalls_info = NULL;
 349       set_gdbarch_syscalls_info (gdbarch, NULL);
 350     }
 351
 352   /* Did we succeed at initializing this?  */
 353   if (syscalls_info != NULL)
 354     return;
 355
 356   syscalls_info = xml_init_syscalls_info (xml_syscall_file);
 357
 358   /* If there was some error reading the XML file, we initialize
 359      gdbarch->syscalls_info anyway, in order to store information
 360      about our attempt.  */
 361   if (syscalls_info == NULL)
 362     syscalls_info = new struct syscalls_info ();
 363
 364   if (syscalls_info->syscalls.empty ())
 365     {
 366       if (xml_syscall_file != NULL)
 367         warning (_("Could not load the syscall XML file `%s/%s'."),
 368                  gdb_datadir.c_str (), xml_syscall_file);
 369       else
 370         warning (_("There is no XML file to open."));
 371
 372       warning (_("GDB will not be able to display "
 373                  "syscall names nor to verify if\n"
 374                  "any provided syscall numbers are valid."));
 375     }
 376
 377   /* Saving the data-directory used to read this XML info.  */
 378   syscalls_info->my_gdb_datadir.assign (gdb_datadir);
 379
 380   set_gdbarch_syscalls_info (gdbarch, syscalls_info);
 381 }
 382
 383 /* Search for a syscall group by its name.  Return syscall_group_desc
 384    structure for the group if found or NULL otherwise.  */
 385
 386 static struct syscall_group_desc *
 387 syscall_group_get_group_by_name (const struct syscalls_info *syscalls_info,
 388                                  const char *group)
 389 {
 390   if (syscalls_info == NULL)
 391     return NULL;
 392
 393   if (group == NULL)
 394     return NULL;
 395
 396   /* Search for existing group.  */
 397   for (const syscall_group_desc_up &groupdesc : syscalls_info->groups)
 398     {
 399       if (groupdesc->name == group)
 400         return groupdesc.get ();
 401     }
 402
 403   return NULL;
 404 }
 405
 406 static bool
 407 xml_get_syscalls_by_name (struct gdbarch *gdbarch, const char *syscall_name,
 408                           std::vector<int> *syscall_numbers)
 409 {
 410   struct syscalls_info *syscalls_info = gdbarch_syscalls_info (gdbarch);
 411
 412   bool found = false;
 413   if (syscalls_info != NULL && syscall_name != NULL && syscall_numbers != NULL)
 414     for (const syscall_desc_up &sysdesc : syscalls_info->syscalls)
 415       if (sysdesc->name == syscall_name || sysdesc->alias == syscall_name)
 416         {
 417           syscall_numbers->push_back (sysdesc->number);
 418           found = true;
 419         }
 420
 421   return found;
 422 }
 423
 424 static const char *
 425 xml_get_syscall_name (struct gdbarch *gdbarch,
 426                       int syscall_number)
 427 {
 428   struct syscalls_info *syscalls_info = gdbarch_syscalls_info (gdbarch);
 429
 430   if (syscalls_info == NULL
 431       || syscall_number < 0)
 432     return NULL;
 433
 434   for (const syscall_desc_up &sysdesc : syscalls_info->syscalls)
 435     if (sysdesc->number == syscall_number)
 436       return sysdesc->name.c_str ();
 437
 438   return NULL;
 439 }
 440
 441 static const char **
 442 xml_list_of_syscalls (struct gdbarch *gdbarch)
 443 {
 444   struct syscalls_info *syscalls_info = gdbarch_syscalls_info (gdbarch);
 445
 446   if (syscalls_info == NULL)
 447     return NULL;
 448
 449   int nsyscalls = syscalls_info->syscalls.size ();
 450   const char **names = XNEWVEC (const char *, nsyscalls + 1);
 451
 452   int i;
 453   for (i = 0; i < syscalls_info->syscalls.size (); i++)
 454     names[i] = syscalls_info->syscalls[i]->name.c_str ();
 455
 456   names[i] = NULL;
 457
 458   return names;
 459 }
 460
 461 /* Iterate over the syscall_group_desc element to return a list of
 462    syscalls that are part of the given group.  If the syscall group
 463    doesn't exist, return false.  */
 464
 465 static bool
 466 xml_list_syscalls_by_group (struct gdbarch *gdbarch, const char *group,
 467                             std::vector<int> *syscalls)
 468 {
 469   struct syscalls_info *syscalls_info = gdbarch_syscalls_info (gdbarch);
 470   struct syscall_group_desc *groupdesc;
 471
 472   if (syscalls_info == NULL || syscalls == NULL)
 473     return false;
 474
 475   groupdesc = syscall_group_get_group_by_name (syscalls_info, group);
 476   if (groupdesc == NULL)
 477     return false;
 478
 479   for (const syscall_desc *sysdesc : groupdesc->syscalls)
 480     syscalls->push_back (sysdesc->number);
 481
 482   return true;
 483 }
 484
 485 /* Return a NULL terminated list of syscall groups or an empty list, if
 486    no syscall group is available.  Return NULL, if there is no syscall
 487    information available.  */
 488
 489 static const char **
 490 xml_list_of_groups (struct gdbarch *gdbarch)
 491 {
 492   struct syscalls_info *syscalls_info = gdbarch_syscalls_info (gdbarch);
 493   const char **names = NULL;
 494   int ngroups;
 495   int i;
 496
 497   if (syscalls_info == NULL)
 498     return NULL;
 499
 500   ngroups = syscalls_info->groups.size ();
 501   names = (const char**) xmalloc ((ngroups + 1) * sizeof (char *));
 502
 503   for (i = 0; i < syscalls_info->groups.size (); i++)
 504     names[i] = syscalls_info->groups[i]->name.c_str ();
 505
 506   names[i] = NULL;
 507
 508   return names;
 509 }
 510
 511 void
 512 set_xml_syscall_file_name (struct gdbarch *gdbarch, const char *name)
 513 {
 514   set_gdbarch_xml_syscall_file (gdbarch, name);
 515 }
 516
 517 void
 518 get_syscall_by_number (struct gdbarch *gdbarch,
 519                        int syscall_number, struct syscall *s)
 520 {
 521   init_syscalls_info (gdbarch);
 522
 523   s->number = syscall_number;
 524   s->name = xml_get_syscall_name (gdbarch, syscall_number);
 525 }
 526
 527 bool
 528 get_syscalls_by_name (struct gdbarch *gdbarch, const char *syscall_name,
 529                       std::vector<int> *syscall_numbers)
 530 {
 531   init_syscalls_info (gdbarch);
 532
 533   return xml_get_syscalls_by_name (gdbarch, syscall_name, syscall_numbers);
 534 }
 535
 536 const char **
 537 get_syscall_names (struct gdbarch *gdbarch)
 538 {
 539   init_syscalls_info (gdbarch);
 540
 541   return xml_list_of_syscalls (gdbarch);
 542 }
 543
 544 /* See comment in xml-syscall.h.  */
 545
 546 bool
 547 get_syscalls_by_group (struct gdbarch *gdbarch, const char *group,
 548                        std::vector<int> *syscall_numbers)
 549 {
 550   init_syscalls_info (gdbarch);
 551
 552   return xml_list_syscalls_by_group (gdbarch, group, syscall_numbers);
 553 }
 554
 555 /* See comment in xml-syscall.h.  */
 556
 557 const char **
 558 get_syscall_group_names (struct gdbarch *gdbarch)
 559 {
 560   init_syscalls_info (gdbarch);
 561
 562   return xml_list_of_groups (gdbarch);
 563 }
 564
 565 #endif /* ! HAVE_LIBEXPAT */