[deliverable/binutils-gdb.git] / gdb / xml-syscall.h

/* Functions that provide the mechanism to parse a syscall XML file
   and get its values.

   Copyright (C) 2009-2020 Free Software Foundation, Inc.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef XML_SYSCALL_H
#define XML_SYSCALL_H 1

/* Function used to set the name of the file which contains
   information about the system calls present in the current
   architecture.
   
   This function *should* be called before anything else, otherwise
   GDB won't be able to find the correct XML file to open and get
   the syscalls definitions.  */

void set_xml_syscall_file_name (struct gdbarch *gdbarch,
				const char *name);

/* Function that retrieves the syscall name corresponding to the given
   number.  It puts the requested information inside 'struct syscall'.  */

void get_syscall_by_number (struct gdbarch *gdbarch,
			    int syscall_number, struct syscall *s);

/* Function that retrieves the syscall numbers corresponding to the
   given name.  The numbers of all syscalls with either a name or
   alias equal to SYSCALL_NAME are appended to SYSCALL_NUMBERS.  If no
   matching syscalls are found, return false.  */

bool get_syscalls_by_name (struct gdbarch *gdbarch, const char *syscall_name,
			   std::vector<int> *syscall_numbers);

/* Function used to retrieve the list of syscalls in the system.  This list
   is returned as an array of strings.  Returns the list of syscalls in the
   system, or NULL otherwise.  */

const char **get_syscall_names (struct gdbarch *gdbarch);

/* Function used to retrieve the list of syscalls of a given group in
   the system.  The syscall numbers are appended to SYSCALL_NUMBERS.
   If the group doesn't exist, return false.  */

bool get_syscalls_by_group (struct gdbarch *gdbarch, const char *group,
			    std::vector<int> *syscall_numbers);

/* Function used to retrieve the list of syscall groups in the system.
   Return an array of strings terminated by a NULL element.  The list
   must be freed by the caller.  Return NULL if there is no syscall
   information available.  */

const char **get_syscall_group_names (struct gdbarch *gdbarch);

#endif /* XML_SYSCALL_H */
Commit	Line	Data
fbbe92c5 SDJ	1	/* Functions that provide the mechanism to parse a syscall XML file
	2	and get its values.
	3
11bc5fe4	4	Copyright (C) 2009-2020 Free Software Foundation, Inc.
fbbe92c5 SDJ	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
458c8db8 SDJ	32	void set_xml_syscall_file_name (struct gdbarch *gdbarch,
458c8db8 SDJ	33	const char *name);
fbbe92c5 SDJ	34
	35	/* Function that retrieves the syscall name corresponding to the given
	36	number. It puts the requested information inside 'struct syscall'. */
	37
458c8db8 SDJ	38	void get_syscall_by_number (struct gdbarch *gdbarch,
458c8db8 SDJ	39	int syscall_number, struct syscall *s);
fbbe92c5	40
e9076973 JB	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. */
fbbe92c5	45
e9076973 JB	46	bool get_syscalls_by_name (struct gdbarch gdbarch, const char syscall_name,
e9076973 JB	47	std::vector<int> *syscall_numbers);
fbbe92c5 SDJ	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
458c8db8	53	const char *get_syscall_names (struct gdbarch gdbarch);
fbbe92c5	54
e3487908	55	/* Function used to retrieve the list of syscalls of a given group in
4794efbf JB	56	the system. The syscall numbers are appended to SYSCALL_NUMBERS.
4794efbf JB	57	If the group doesn't exist, return false. */
e3487908	58
4794efbf JB	59	bool get_syscalls_by_group (struct gdbarch gdbarch, const char group,
4794efbf JB	60	std::vector<int> *syscall_numbers);
e3487908 GKB	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
fbbe92c5	69	#endif /* XML_SYSCALL_H */