1 /* Functions that provide the mechanism to parse a syscall XML file
4 Copyright (C) 2009-2024 Free Software Foundation, Inc.
6 This file is part of GDB.
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.
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.
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/>. */
23 #include "xml-support.h"
24 #include "xml-syscall.h"
27 /* For the struct syscall definition. */
30 #include "filenames.h"
34 /* Dummy functions to indicate that there's no support for fetching
35 syscalls information. */
38 syscall_warn_user (void)
40 static int have_warned
= 0;
44 warning (_("Can not parse XML syscalls information; XML support was "
45 "disabled at compile time."));
50 set_xml_syscall_file_name (struct gdbarch
*gdbarch
, const char *name
)
56 get_syscall_by_number (struct gdbarch
*gdbarch
,
57 int syscall_number
, struct syscall
*s
)
60 s
->number
= syscall_number
;
65 get_syscalls_by_name (struct gdbarch
*gdbarch
, const char *syscall_name
,
66 std::vector
<int> *syscall_numbers
)
73 get_syscall_names (struct gdbarch
*gdbarch
)
80 get_syscalls_by_group (struct gdbarch
*gdbarch
, const char *group
,
81 std::vector
<int> *syscall_numbers
)
88 get_syscall_group_names (struct gdbarch
*gdbarch
)
94 #else /* ! HAVE_LIBEXPAT */
96 /* Structure which describes a syscall. */
99 syscall_desc (int number_
, std::string name_
, std::string alias_
)
100 : number (number_
), name (name_
), alias (alias_
)
103 /* The syscall number. */
107 /* The syscall name. */
111 /* An optional alias. */
116 typedef std::unique_ptr
<syscall_desc
> syscall_desc_up
;
118 /* Structure of a syscall group. */
119 struct syscall_group_desc
121 syscall_group_desc (const std::string
&name_
)
125 /* The group name. */
129 /* The syscalls that are part of the group. This is a non-owning
132 std::vector
<syscall_desc
*> syscalls
;
135 typedef std::unique_ptr
<syscall_group_desc
> syscall_group_desc_up
;
137 /* Structure that represents syscalls information. */
142 std::vector
<syscall_desc_up
> syscalls
;
144 /* The syscall groups. */
146 std::vector
<syscall_group_desc_up
> groups
;
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
152 std::string my_gdb_datadir
;
155 typedef std::unique_ptr
<syscalls_info
> syscalls_info_up
;
157 /* Callback data for syscall information parsing. */
158 struct syscall_parsing_data
160 /* The syscalls_info we are building. */
162 struct syscalls_info
*syscalls_info
;
165 /* Create a new syscall group. Return pointer to the
166 syscall_group_desc structure that represents the new group. */
168 static struct syscall_group_desc
*
169 syscall_group_create_syscall_group_desc (struct syscalls_info
*syscalls_info
,
172 syscall_group_desc
*groupdesc
= new syscall_group_desc (group
);
174 syscalls_info
->groups
.emplace_back (groupdesc
);
179 /* Add a syscall to the group. If group doesn't exist, create it. */
182 syscall_group_add_syscall (struct syscalls_info
*syscalls_info
,
183 struct syscall_desc
*syscall
,
186 /* Search for an existing group. */
187 std::vector
<syscall_group_desc_up
>::iterator it
188 = syscalls_info
->groups
.begin ();
190 for (; it
!= syscalls_info
->groups
.end (); it
++)
192 if ((*it
)->name
== group
)
196 syscall_group_desc
*groupdesc
;
198 if (it
!= syscalls_info
->groups
.end ())
199 groupdesc
= it
->get ();
202 /* No group was found with this name. We must create a new
204 groupdesc
= syscall_group_create_syscall_group_desc (syscalls_info
,
208 groupdesc
->syscalls
.push_back (syscall
);
212 syscall_create_syscall_desc (struct syscalls_info
*syscalls_info
,
213 const char *name
, int number
, const char *alias
,
216 syscall_desc
*sysdesc
= new syscall_desc (number
, name
,
217 alias
!= NULL
? alias
: "");
219 syscalls_info
->syscalls
.emplace_back (sysdesc
);
221 /* Add syscall to its groups. */
225 for (char *group
= strtok_r (groups
, ",", &saveptr
);
227 group
= strtok_r (NULL
, ",", &saveptr
))
228 syscall_group_add_syscall (syscalls_info
, sysdesc
, group
);
232 /* Handle the start of a <syscall> element. */
234 syscall_start_syscall (struct gdb_xml_parser
*parser
,
235 const struct gdb_xml_element
*element
,
237 std::vector
<gdb_xml_value
> &attributes
)
239 struct syscall_parsing_data
*data
= (struct syscall_parsing_data
*) user_data
;
246 for (const gdb_xml_value
&attr
: attributes
)
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 ();
257 internal_error (_("Unknown attribute name '%s'."), attr
.name
);
261 syscall_create_syscall_desc (data
->syscalls_info
, name
, number
, alias
,
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
}
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
}
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
}
288 static struct syscalls_info
*
289 syscall_parse_xml (const char *document
, xml_fetch_another fetcher
)
291 struct syscall_parsing_data data
;
292 syscalls_info_up
sysinfo (new syscalls_info ());
294 data
.syscalls_info
= sysinfo
.get ();
296 if (gdb_xml_parse_quick (_("syscalls info"), NULL
,
297 syselements
, document
, &data
) == 0)
299 /* Parsed successfully. */
300 return sysinfo
.release ();
304 warning (_("Could not load XML syscalls info; ignoring"));
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.
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
)
317 std::optional
<gdb::char_vector
> full_file
318 = xml_fetch_content_from_file (filename
,
319 const_cast<char *>(gdb_datadir
.c_str ()));
323 const std::string dirname
= ldirname (filename
);
324 auto fetch_another
= [&dirname
] (const char *name
)
326 return xml_fetch_content_from_file (name
, dirname
.c_str ());
329 return syscall_parse_xml (full_file
->data (), fetch_another
);
332 /* Initializes the syscalls_info structure according to the
335 init_syscalls_info (struct gdbarch
*gdbarch
)
337 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
338 const char *xml_syscall_file
= gdbarch_xml_syscall_file (gdbarch
);
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)
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
);
352 /* Did we succeed at initializing this? */
353 if (syscalls_info
!= NULL
)
356 syscalls_info
= xml_init_syscalls_info (xml_syscall_file
);
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 ();
364 if (syscalls_info
->syscalls
.empty ())
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
);
370 warning (_("There is no XML file to open."));
372 warning (_("GDB will not be able to display "
373 "syscall names nor to verify if\n"
374 "any provided syscall numbers are valid."));
377 /* Saving the data-directory used to read this XML info. */
378 syscalls_info
->my_gdb_datadir
.assign (gdb_datadir
);
380 set_gdbarch_syscalls_info (gdbarch
, syscalls_info
);
383 /* Search for a syscall group by its name. Return syscall_group_desc
384 structure for the group if found or NULL otherwise. */
386 static struct syscall_group_desc
*
387 syscall_group_get_group_by_name (const struct syscalls_info
*syscalls_info
,
390 if (syscalls_info
== NULL
)
396 /* Search for existing group. */
397 for (const syscall_group_desc_up
&groupdesc
: syscalls_info
->groups
)
399 if (groupdesc
->name
== group
)
400 return groupdesc
.get ();
407 xml_get_syscalls_by_name (struct gdbarch
*gdbarch
, const char *syscall_name
,
408 std::vector
<int> *syscall_numbers
)
410 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
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
)
417 syscall_numbers
->push_back (sysdesc
->number
);
425 xml_get_syscall_name (struct gdbarch
*gdbarch
,
428 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
430 if (syscalls_info
== NULL
431 || syscall_number
< 0)
434 for (const syscall_desc_up
&sysdesc
: syscalls_info
->syscalls
)
435 if (sysdesc
->number
== syscall_number
)
436 return sysdesc
->name
.c_str ();
442 xml_list_of_syscalls (struct gdbarch
*gdbarch
)
444 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
446 if (syscalls_info
== NULL
)
449 int nsyscalls
= syscalls_info
->syscalls
.size ();
450 const char **names
= XNEWVEC (const char *, nsyscalls
+ 1);
453 for (i
= 0; i
< syscalls_info
->syscalls
.size (); i
++)
454 names
[i
] = syscalls_info
->syscalls
[i
]->name
.c_str ();
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. */
466 xml_list_syscalls_by_group (struct gdbarch
*gdbarch
, const char *group
,
467 std::vector
<int> *syscalls
)
469 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
470 struct syscall_group_desc
*groupdesc
;
472 if (syscalls_info
== NULL
|| syscalls
== NULL
)
475 groupdesc
= syscall_group_get_group_by_name (syscalls_info
, group
);
476 if (groupdesc
== NULL
)
479 for (const syscall_desc
*sysdesc
: groupdesc
->syscalls
)
480 syscalls
->push_back (sysdesc
->number
);
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. */
490 xml_list_of_groups (struct gdbarch
*gdbarch
)
492 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
493 const char **names
= NULL
;
497 if (syscalls_info
== NULL
)
500 ngroups
= syscalls_info
->groups
.size ();
501 names
= (const char**) xmalloc ((ngroups
+ 1) * sizeof (char *));
503 for (i
= 0; i
< syscalls_info
->groups
.size (); i
++)
504 names
[i
] = syscalls_info
->groups
[i
]->name
.c_str ();
512 set_xml_syscall_file_name (struct gdbarch
*gdbarch
, const char *name
)
514 set_gdbarch_xml_syscall_file (gdbarch
, name
);
518 get_syscall_by_number (struct gdbarch
*gdbarch
,
519 int syscall_number
, struct syscall
*s
)
521 init_syscalls_info (gdbarch
);
523 s
->number
= syscall_number
;
524 s
->name
= xml_get_syscall_name (gdbarch
, syscall_number
);
528 get_syscalls_by_name (struct gdbarch
*gdbarch
, const char *syscall_name
,
529 std::vector
<int> *syscall_numbers
)
531 init_syscalls_info (gdbarch
);
533 return xml_get_syscalls_by_name (gdbarch
, syscall_name
, syscall_numbers
);
537 get_syscall_names (struct gdbarch
*gdbarch
)
539 init_syscalls_info (gdbarch
);
541 return xml_list_of_syscalls (gdbarch
);
544 /* See comment in xml-syscall.h. */
547 get_syscalls_by_group (struct gdbarch
*gdbarch
, const char *group
,
548 std::vector
<int> *syscall_numbers
)
550 init_syscalls_info (gdbarch
);
552 return xml_list_syscalls_by_group (gdbarch
, group
, syscall_numbers
);
555 /* See comment in xml-syscall.h. */
558 get_syscall_group_names (struct gdbarch
*gdbarch
)
560 init_syscalls_info (gdbarch
);
562 return xml_list_of_groups (gdbarch
);
565 #endif /* ! HAVE_LIBEXPAT */