[deliverable/binutils-gdb.git] / gdb / nat / linux-nat.h

/* Code for native debugging support for GNU/Linux (LWP layer).

   Copyright (C) 2000-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 NAT_LINUX_NAT_H
#define NAT_LINUX_NAT_H

#include "gdbsupport/function-view.h"
#include "target/waitstatus.h"

struct lwp_info;
struct arch_lwp_info;

/* This is the kernel's hard limit.  Not to be confused with SIGRTMIN.  */
#ifndef __SIGRTMIN
#define __SIGRTMIN 32
#endif

/* Unlike other extended result codes, WSTOPSIG (status) on
   PTRACE_O_TRACESYSGOOD syscall events doesn't return SIGTRAP, but
   instead SIGTRAP with bit 7 set.  */
#define SYSCALL_SIGTRAP (SIGTRAP | 0x80)

/* Return the ptid of the current lightweight process.  With NPTL
   threads and LWPs map 1:1, so this is equivalent to returning the
   ptid of the current thread.  This function must be provided by
   the client. */

extern ptid_t current_lwp_ptid (void);

/* Function type for the CALLBACK argument of iterate_over_lwps.  */
typedef int (iterate_over_lwps_ftype) (struct lwp_info *lwp);

/* Iterate over all LWPs.  Calls CALLBACK with its second argument set
   to DATA for every LWP in the list.  If CALLBACK returns nonzero for
   a particular LWP, return a pointer to the structure describing that
   LWP immediately.  Otherwise return NULL.  This function must be
   provided by the client.  */

extern struct lwp_info *iterate_over_lwps
    (ptid_t filter,
     gdb::function_view<iterate_over_lwps_ftype> callback);

/* Return the ptid of LWP.  */

extern ptid_t ptid_of_lwp (struct lwp_info *lwp);

/* Set the architecture-specific data of LWP.  This function must be
   provided by the client. */

extern void lwp_set_arch_private_info (struct lwp_info *lwp,
				       struct arch_lwp_info *info);

/* Return the architecture-specific data of LWP.  This function must
   be provided by the client. */

extern struct arch_lwp_info *lwp_arch_private_info (struct lwp_info *lwp);

/* Return nonzero if LWP is stopped, zero otherwise.  This function
   must be provided by the client.  */

extern int lwp_is_stopped (struct lwp_info *lwp);

/* Return the reason the LWP last stopped.  This function must be
   provided by the client.  */

extern enum target_stop_reason lwp_stop_reason (struct lwp_info *lwp);

/* Cause LWP to stop.  This function must be provided by the
   client.  */

extern void linux_stop_lwp (struct lwp_info *lwp);

/* Return nonzero if we are single-stepping this LWP at the ptrace
   level.  */

extern int lwp_is_stepping (struct lwp_info *lwp);

#endif /* NAT_LINUX_NAT_H */
Commit	Line	Data
	1	/* Code for native debugging support for GNU/Linux (LWP layer).
	2
	3	Copyright (C) 2000-2020 Free Software Foundation, Inc.
	4
	5	This file is part of GDB.
	6
	7	This program is free software; you can redistribute it and/or modify
	8	it under the terms of the GNU General Public License as published by
	9	the Free Software Foundation; either version 3 of the License, or
	10	(at your option) any later version.
	11
	12	This program is distributed in the hope that it will be useful,
	13	but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	GNU General Public License for more details.
	16
	17	You should have received a copy of the GNU General Public License
	18	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	19
	20	#ifndef NAT_LINUX_NAT_H
	21	#define NAT_LINUX_NAT_H
	22
	23	#include "gdbsupport/function-view.h"
	24	#include "target/waitstatus.h"
	25
	26	struct lwp_info;
	27	struct arch_lwp_info;
	28
	29	/* This is the kernel's hard limit. Not to be confused with SIGRTMIN. */
	30	#ifndef __SIGRTMIN
	31	#define __SIGRTMIN 32
	32	#endif
	33
	34	/* Unlike other extended result codes, WSTOPSIG (status) on
	35	PTRACE_O_TRACESYSGOOD syscall events doesn't return SIGTRAP, but
	36	instead SIGTRAP with bit 7 set. */
	37	#define SYSCALL_SIGTRAP (SIGTRAP \| 0x80)
	38
	39	/* Return the ptid of the current lightweight process. With NPTL
	40	threads and LWPs map 1:1, so this is equivalent to returning the
	41	ptid of the current thread. This function must be provided by
	42	the client. */
	43
	44	extern ptid_t current_lwp_ptid (void);
	45
	46	/* Function type for the CALLBACK argument of iterate_over_lwps. */
	47	typedef int (iterate_over_lwps_ftype) (struct lwp_info *lwp);
	48
	49	/* Iterate over all LWPs. Calls CALLBACK with its second argument set
	50	to DATA for every LWP in the list. If CALLBACK returns nonzero for
	51	a particular LWP, return a pointer to the structure describing that
	52	LWP immediately. Otherwise return NULL. This function must be
	53	provided by the client. */
	54
	55	extern struct lwp_info *iterate_over_lwps
	56	(ptid_t filter,
	57	gdb::function_view<iterate_over_lwps_ftype> callback);
	58
	59	/* Return the ptid of LWP. */
	60
	61	extern ptid_t ptid_of_lwp (struct lwp_info *lwp);
	62
	63	/* Set the architecture-specific data of LWP. This function must be
	64	provided by the client. */
	65
	66	extern void lwp_set_arch_private_info (struct lwp_info *lwp,
	67	struct arch_lwp_info *info);
	68
	69	/* Return the architecture-specific data of LWP. This function must
	70	be provided by the client. */
	71
	72	extern struct arch_lwp_info lwp_arch_private_info (struct lwp_info lwp);
	73
	74	/* Return nonzero if LWP is stopped, zero otherwise. This function
	75	must be provided by the client. */
	76
	77	extern int lwp_is_stopped (struct lwp_info *lwp);
	78
	79	/* Return the reason the LWP last stopped. This function must be
	80	provided by the client. */
	81
	82	extern enum target_stop_reason lwp_stop_reason (struct lwp_info *lwp);
	83
	84	/* Cause LWP to stop. This function must be provided by the
	85	client. */
	86
	87	extern void linux_stop_lwp (struct lwp_info *lwp);
	88
	89	/* Return nonzero if we are single-stepping this LWP at the ptrace
	90	level. */
	91
	92	extern int lwp_is_stepping (struct lwp_info *lwp);
	93
	94	#endif /* NAT_LINUX_NAT_H */