1 /* Functions that provide the mechanism to parse a syscall XML file
4 Copyright (C) 2009-2017 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_syscall_by_name (struct gdbarch
*gdbarch
, const char *syscall_name
,
69 s
->number
= UNKNOWN_SYSCALL
;
70 s
->name
= syscall_name
;
74 get_syscall_names (struct gdbarch
*gdbarch
)
81 get_syscalls_by_group (struct gdbarch
*gdbarch
, const char *group
)
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_
)
100 : number (number_
), name (name_
)
103 /* The syscall number. */
107 /* The syscall name. */
112 typedef std::unique_ptr
<syscall_desc
> syscall_desc_up
;
114 /* Structure of a syscall group. */
115 struct syscall_group_desc
117 syscall_group_desc (const std::string
&name_
)
121 /* The group name. */
125 /* The syscalls that are part of the group. This is a non-owning
128 std::vector
<syscall_desc
*> syscalls
;
131 typedef std::unique_ptr
<syscall_group_desc
> syscall_group_desc_up
;
133 /* Structure that represents syscalls information. */
138 std::vector
<syscall_desc_up
> syscalls
;
140 /* The syscall groups. */
142 std::vector
<syscall_group_desc_up
> groups
;
144 /* Variable that will hold the last known data-directory. This is
145 useful to know whether we should re-read the XML info for the
148 std::string my_gdb_datadir
;
151 typedef std::unique_ptr
<syscalls_info
> syscalls_info_up
;
153 /* Callback data for syscall information parsing. */
154 struct syscall_parsing_data
156 /* The syscalls_info we are building. */
158 struct syscalls_info
*syscalls_info
;
161 /* Create a new syscall group. Return pointer to the
162 syscall_group_desc structure that represents the new group. */
164 static struct syscall_group_desc
*
165 syscall_group_create_syscall_group_desc (struct syscalls_info
*syscalls_info
,
168 syscall_group_desc
*groupdesc
= new syscall_group_desc (group
);
170 syscalls_info
->groups
.emplace_back (groupdesc
);
175 /* Add a syscall to the group. If group doesn't exist, create it. */
178 syscall_group_add_syscall (struct syscalls_info
*syscalls_info
,
179 struct syscall_desc
*syscall
,
182 /* Search for an existing group. */
183 std::vector
<syscall_group_desc_up
>::iterator it
184 = syscalls_info
->groups
.begin ();
186 for (; it
!= syscalls_info
->groups
.end (); it
++)
188 if ((*it
)->name
== group
)
192 syscall_group_desc
*groupdesc
;
194 if (it
!= syscalls_info
->groups
.end ())
195 groupdesc
= it
->get ();
198 /* No group was found with this name. We must create a new
200 groupdesc
= syscall_group_create_syscall_group_desc (syscalls_info
,
204 groupdesc
->syscalls
.push_back (syscall
);
208 syscall_create_syscall_desc (struct syscalls_info
*syscalls_info
,
209 const char *name
, int number
,
212 syscall_desc
*sysdesc
= new syscall_desc (number
, name
);
214 syscalls_info
->syscalls
.emplace_back (sysdesc
);
216 /* Add syscall to its groups. */
219 for (char *group
= strtok (groups
, ",");
221 group
= strtok (NULL
, ","))
222 syscall_group_add_syscall (syscalls_info
, sysdesc
, group
);
226 /* Handle the start of a <syscall> element. */
228 syscall_start_syscall (struct gdb_xml_parser
*parser
,
229 const struct gdb_xml_element
*element
,
230 void *user_data
, VEC(gdb_xml_value_s
) *attributes
)
232 struct syscall_parsing_data
*data
= (struct syscall_parsing_data
*) user_data
;
233 struct gdb_xml_value
*attrs
= VEC_address (gdb_xml_value_s
, attributes
);
240 len
= VEC_length (gdb_xml_value_s
, attributes
);
242 for (i
= 0; i
< len
; i
++)
244 if (strcmp (attrs
[i
].name
, "name") == 0)
245 name
= (char *) attrs
[i
].value
;
246 else if (strcmp (attrs
[i
].name
, "number") == 0)
247 number
= * (ULONGEST
*) attrs
[i
].value
;
248 else if (strcmp (attrs
[i
].name
, "groups") == 0)
249 groups
= (char *) attrs
[i
].value
;
251 internal_error (__FILE__
, __LINE__
,
252 _("Unknown attribute name '%s'."), attrs
[i
].name
);
256 syscall_create_syscall_desc (data
->syscalls_info
, name
, number
, groups
);
260 /* The elements and attributes of an XML syscall document. */
261 static const struct gdb_xml_attribute syscall_attr
[] = {
262 { "number", GDB_XML_AF_NONE
, gdb_xml_parse_attr_ulongest
, NULL
},
263 { "name", GDB_XML_AF_NONE
, NULL
, NULL
},
264 { "groups", GDB_XML_AF_OPTIONAL
, NULL
, NULL
},
265 { NULL
, GDB_XML_AF_NONE
, NULL
, NULL
}
268 static const struct gdb_xml_element syscalls_info_children
[] = {
269 { "syscall", syscall_attr
, NULL
,
270 GDB_XML_EF_OPTIONAL
| GDB_XML_EF_REPEATABLE
,
271 syscall_start_syscall
, NULL
},
272 { NULL
, NULL
, NULL
, GDB_XML_EF_NONE
, NULL
, NULL
}
275 static const struct gdb_xml_element syselements
[] = {
276 { "syscalls_info", NULL
, syscalls_info_children
,
277 GDB_XML_EF_NONE
, NULL
, NULL
},
278 { NULL
, NULL
, NULL
, GDB_XML_EF_NONE
, NULL
, NULL
}
281 static struct syscalls_info
*
282 syscall_parse_xml (const char *document
, xml_fetch_another fetcher
,
285 struct syscall_parsing_data data
;
286 syscalls_info_up
sysinfo (new syscalls_info ());
288 data
.syscalls_info
= sysinfo
.get ();
290 if (gdb_xml_parse_quick (_("syscalls info"), NULL
,
291 syselements
, document
, &data
) == 0)
293 /* Parsed successfully. */
294 return sysinfo
.release ();
298 warning (_("Could not load XML syscalls info; ignoring"));
303 /* Function responsible for initializing the information
304 about the syscalls. It reads the XML file and fills the
305 struct syscalls_info with the values.
307 Returns the struct syscalls_info if the file is valid, NULL otherwise. */
308 static struct syscalls_info
*
309 xml_init_syscalls_info (const char *filename
)
311 gdb::unique_xmalloc_ptr
<char> full_file
312 = xml_fetch_content_from_file (filename
, gdb_datadir
);
313 if (full_file
== NULL
)
316 return syscall_parse_xml (full_file
.get (),
317 xml_fetch_content_from_file
,
318 (void *) ldirname (filename
).c_str ());
321 /* Initializes the syscalls_info structure according to the
324 init_syscalls_info (struct gdbarch
*gdbarch
)
326 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
327 const char *xml_syscall_file
= gdbarch_xml_syscall_file (gdbarch
);
329 /* Should we re-read the XML info for this target? */
330 if (syscalls_info
!= NULL
&& !syscalls_info
->my_gdb_datadir
.empty ()
331 && filename_cmp (syscalls_info
->my_gdb_datadir
.c_str (),
334 /* The data-directory changed from the last time we used it.
335 It means that we have to re-read the XML info. */
336 delete syscalls_info
;
337 syscalls_info
= NULL
;
338 set_gdbarch_syscalls_info (gdbarch
, NULL
);
341 /* Did we succeed at initializing this? */
342 if (syscalls_info
!= NULL
)
345 syscalls_info
= xml_init_syscalls_info (xml_syscall_file
);
347 /* If there was some error reading the XML file, we initialize
348 gdbarch->syscalls_info anyway, in order to store information
349 about our attempt. */
350 if (syscalls_info
== NULL
)
351 syscalls_info
= new struct syscalls_info ();
353 if (syscalls_info
->syscalls
.empty ())
355 if (xml_syscall_file
!= NULL
)
356 warning (_("Could not load the syscall XML file `%s/%s'."),
357 gdb_datadir
, xml_syscall_file
);
359 warning (_("There is no XML file to open."));
361 warning (_("GDB will not be able to display "
362 "syscall names nor to verify if\n"
363 "any provided syscall numbers are valid."));
366 /* Saving the data-directory used to read this XML info. */
367 syscalls_info
->my_gdb_datadir
.assign (gdb_datadir
);
369 set_gdbarch_syscalls_info (gdbarch
, syscalls_info
);
372 /* Search for a syscall group by its name. Return syscall_group_desc
373 structure for the group if found or NULL otherwise. */
375 static struct syscall_group_desc
*
376 syscall_group_get_group_by_name (const struct syscalls_info
*syscalls_info
,
379 if (syscalls_info
== NULL
)
385 /* Search for existing group. */
386 for (const syscall_group_desc_up
&groupdesc
: syscalls_info
->groups
)
388 if (groupdesc
->name
== group
)
389 return groupdesc
.get ();
396 xml_get_syscall_number (struct gdbarch
*gdbarch
,
397 const char *syscall_name
)
399 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
401 if (syscalls_info
== NULL
402 || syscall_name
== NULL
)
403 return UNKNOWN_SYSCALL
;
405 for (const syscall_desc_up
&sysdesc
: syscalls_info
->syscalls
)
406 if (sysdesc
->name
== syscall_name
)
407 return sysdesc
->number
;
409 return UNKNOWN_SYSCALL
;
413 xml_get_syscall_name (struct gdbarch
*gdbarch
,
416 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
418 if (syscalls_info
== NULL
419 || syscall_number
< 0)
422 for (const syscall_desc_up
&sysdesc
: syscalls_info
->syscalls
)
423 if (sysdesc
->number
== syscall_number
)
424 return sysdesc
->name
.c_str ();
430 xml_list_of_syscalls (struct gdbarch
*gdbarch
)
432 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
434 if (syscalls_info
== NULL
)
437 int nsyscalls
= syscalls_info
->syscalls
.size ();
438 const char **names
= XNEWVEC (const char *, nsyscalls
+ 1);
441 for (i
= 0; i
< syscalls_info
->syscalls
.size (); i
++)
442 names
[i
] = syscalls_info
->syscalls
[i
]->name
.c_str ();
449 /* Iterate over the syscall_group_desc element to return a list of
450 syscalls that are part of the given group, terminated by an empty
451 element. If the syscall group doesn't exist, return NULL. */
453 static struct syscall
*
454 xml_list_syscalls_by_group (struct gdbarch
*gdbarch
, const char *group
)
456 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
457 struct syscall_group_desc
*groupdesc
;
458 struct syscall
*syscalls
= NULL
;
462 if (syscalls_info
== NULL
)
465 groupdesc
= syscall_group_get_group_by_name (syscalls_info
, group
);
466 if (groupdesc
== NULL
)
469 nsyscalls
= groupdesc
->syscalls
.size ();
470 syscalls
= (struct syscall
*) xmalloc ((nsyscalls
+ 1)
471 * sizeof (struct syscall
));
473 for (i
= 0; i
< groupdesc
->syscalls
.size (); i
++)
475 syscalls
[i
].name
= groupdesc
->syscalls
[i
]->name
.c_str ();
476 syscalls
[i
].number
= groupdesc
->syscalls
[i
]->number
;
479 /* Add final element marker. */
480 syscalls
[i
].name
= NULL
;
481 syscalls
[i
].number
= 0;
486 /* Return a NULL terminated list of syscall groups or an empty list, if
487 no syscall group is available. Return NULL, if there is no syscall
488 information available. */
491 xml_list_of_groups (struct gdbarch
*gdbarch
)
493 struct syscalls_info
*syscalls_info
= gdbarch_syscalls_info (gdbarch
);
494 const char **names
= NULL
;
498 if (syscalls_info
== NULL
)
501 ngroups
= syscalls_info
->groups
.size ();
502 names
= (const char**) xmalloc ((ngroups
+ 1) * sizeof (char *));
504 for (i
= 0; i
< syscalls_info
->groups
.size (); i
++)
505 names
[i
] = syscalls_info
->groups
[i
]->name
.c_str ();
513 set_xml_syscall_file_name (struct gdbarch
*gdbarch
, const char *name
)
515 set_gdbarch_xml_syscall_file (gdbarch
, name
);
519 get_syscall_by_number (struct gdbarch
*gdbarch
,
520 int syscall_number
, struct syscall
*s
)
522 init_syscalls_info (gdbarch
);
524 s
->number
= syscall_number
;
525 s
->name
= xml_get_syscall_name (gdbarch
, syscall_number
);
529 get_syscall_by_name (struct gdbarch
*gdbarch
,
530 const char *syscall_name
, struct syscall
*s
)
532 init_syscalls_info (gdbarch
);
534 s
->number
= xml_get_syscall_number (gdbarch
, syscall_name
);
535 s
->name
= syscall_name
;
539 get_syscall_names (struct gdbarch
*gdbarch
)
541 init_syscalls_info (gdbarch
);
543 return xml_list_of_syscalls (gdbarch
);
546 /* See comment in xml-syscall.h. */
549 get_syscalls_by_group (struct gdbarch
*gdbarch
, const char *group
)
551 init_syscalls_info (gdbarch
);
553 return xml_list_syscalls_by_group (gdbarch
, group
);
556 /* See comment in xml-syscall.h. */
559 get_syscall_group_names (struct gdbarch
*gdbarch
)
561 init_syscalls_info (gdbarch
);
563 return xml_list_of_groups (gdbarch
);
566 #endif /* ! HAVE_LIBEXPAT */