gdb/xml-syscall.h

   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 #ifndef XML_SYSCALL_H
  22 #define XML_SYSCALL_H 1
  23
  24 /* Function used to set the name of the file which contains
  25    information about the system calls present in the current
  26    architecture.
  27
  28    This function *should* be called before anything else, otherwise
  29    GDB won't be able to find the correct XML file to open and get
  30    the syscalls definitions.  */
  31
  32 void set_xml_syscall_file_name (struct gdbarch *gdbarch,
  33                                 const char *name);
  34
  35 /* Function that retrieves the syscall name corresponding to the given
  36    number.  It puts the requested information inside 'struct syscall'.  */
  37
  38 void get_syscall_by_number (struct gdbarch *gdbarch,
  39                             int syscall_number, struct syscall *s);
  40
  41 /* Function that retrieves the syscall numbers corresponding to the
  42    given name.  The numbers of all syscalls with either a name or
  43    alias equal to SYSCALL_NAME are appended to SYSCALL_NUMBERS.  If no
  44    matching syscalls are found, return false.  */
  45
  46 bool get_syscalls_by_name (struct gdbarch *gdbarch, const char *syscall_name,
  47                            std::vector<int> *syscall_numbers);
  48
  49 /* Function used to retrieve the list of syscalls in the system.  This list
  50    is returned as an array of strings.  Returns the list of syscalls in the
  51    system, or NULL otherwise.  */
  52
  53 const char **get_syscall_names (struct gdbarch *gdbarch);
  54
  55 /* Function used to retrieve the list of syscalls of a given group in
  56    the system.  The syscall numbers are appended to SYSCALL_NUMBERS.
  57    If the group doesn't exist, return false.  */
  58
  59 bool get_syscalls_by_group (struct gdbarch *gdbarch, const char *group,
  60                             std::vector<int> *syscall_numbers);
  61
  62 /* Function used to retrieve the list of syscall groups in the system.
  63    Return an array of strings terminated by a NULL element.  The list
  64    must be freed by the caller.  Return NULL if there is no syscall
  65    information available.  */
  66
  67 const char **get_syscall_group_names (struct gdbarch *gdbarch);
  68
  69 #endif /* XML_SYSCALL_H */