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

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

   Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
   2010, 2011 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/>.  */

#include "target.h"

#include <signal.h>

/* Structure describing an LWP.  This is public only for the purposes
   of ALL_LWPS; target-specific code should generally not access it
   directly.  */

struct lwp_info
{
  /* The process id of the LWP.  This is a combination of the LWP id
     and overall process id.  */
  ptid_t ptid;

  /* Non-zero if this LWP is cloned.  In this context "cloned" means
     that the LWP is reporting to its parent using a signal other than
     SIGCHLD.  */
  int cloned;

  /* Non-zero if we sent this LWP a SIGSTOP (but the LWP didn't report
     it back yet).  */
  int signalled;

  /* Non-zero if this LWP is stopped.  */
  int stopped;

  /* Non-zero if this LWP will be/has been resumed.  Note that an LWP
     can be marked both as stopped and resumed at the same time.  This
     happens if we try to resume an LWP that has a wait status
     pending.  We shouldn't let the LWP run until that wait status has
     been processed, but we should not report that wait status if GDB
     didn't try to let the LWP run.  */
  int resumed;

  /* If non-zero, a pending wait status.  */
  int status;

  /* Non-zero if we were stepping this LWP.  */
  int step;

  /* Non-zero si_signo if this LWP stopped with a trap.  si_addr may
     be the address of a hardware watchpoint.  */
  struct siginfo siginfo;

  /* STOPPED_BY_WATCHPOINT is non-zero if this LWP stopped with a data
     watchpoint trap.  */
  int stopped_by_watchpoint;

  /* On architectures where it is possible to know the data address of
     a triggered watchpoint, STOPPED_DATA_ADDRESS_P is non-zero, and
     STOPPED_DATA_ADDRESS contains such data address.  Otherwise,
     STOPPED_DATA_ADDRESS_P is false, and STOPPED_DATA_ADDRESS is
     undefined.  Only valid if STOPPED_BY_WATCHPOINT is true.  */
  int stopped_data_address_p;
  CORE_ADDR stopped_data_address;

  /* Non-zero if we expect a duplicated SIGINT.  */
  int ignore_sigint;

  /* If WAITSTATUS->KIND != TARGET_WAITKIND_SPURIOUS, the waitstatus
     for this LWP's last event.  This may correspond to STATUS above,
     or to a local variable in lin_lwp_wait.  */
  struct target_waitstatus waitstatus;

  /* Signal wether we are in a SYSCALL_ENTRY or
     in a SYSCALL_RETURN event.
     Values:
     - TARGET_WAITKIND_SYSCALL_ENTRY
     - TARGET_WAITKIND_SYSCALL_RETURN */
  int syscall_state;

  /* The processor core this LWP was last seen on.  */
  int core;

  /* Next LWP in list.  */
  struct lwp_info *next;
};

/* The global list of LWPs, for ALL_LWPS.  Unlike the threads list,
   there is always at least one LWP on the list while the GNU/Linux
   native target is active.  */
extern struct lwp_info *lwp_list;

/* Iterate over the PTID each active thread (light-weight process).  There
   must be at least one.  */
#define ALL_LWPS(LP, PTID)						\
  for ((LP) = lwp_list, (PTID) = (LP)->ptid;				\
       (LP) != NULL;							\
       (LP) = (LP)->next, (PTID) = (LP) ? (LP)->ptid : (PTID))

#define GET_LWP(ptid)		ptid_get_lwp (ptid)
#define GET_PID(ptid)		ptid_get_pid (ptid)
#define is_lwp(ptid)		(GET_LWP (ptid) != 0)
#define BUILD_LWP(lwp, pid)	ptid_build (pid, lwp, 0)

/* Attempt to initialize libthread_db.  */
void check_for_thread_db (void);

int thread_db_attach_lwp (ptid_t ptid);

/* Return the set of signals used by the threads library.  */
extern void lin_thread_get_thread_signals (sigset_t *mask);

/* Find process PID's pending signal set from /proc/pid/status.  */
void linux_proc_pending_signals (int pid, sigset_t *pending,
				 sigset_t *blocked, sigset_t *ignored);

/* Return the TGID of LWPID from /proc/pid/status.  Returns -1 if not
   found.  */
extern int linux_proc_get_tgid (int lwpid);

/* linux-nat functions for handling fork events.  */
extern void linux_enable_event_reporting (ptid_t ptid);

extern int lin_lwp_attach_lwp (ptid_t ptid);

/* Iterator function for lin-lwp's lwp list.  */
struct lwp_info *iterate_over_lwps (ptid_t filter,
				    int (*callback) (struct lwp_info *,
						     void *), 
				    void *data);

/* Create a prototype generic GNU/Linux target.  The client can
   override it with local methods.  */
struct target_ops * linux_target (void);

/* Create a generic GNU/Linux target using traditional 
   ptrace register access.  */
struct target_ops *
linux_trad_target (CORE_ADDR (*register_u_offset)(struct gdbarch *, int, int));

/* Register the customized GNU/Linux target.  This should be used
   instead of calling add_target directly.  */
void linux_nat_add_target (struct target_ops *);

/* Register a method to call whenever a new thread is attached.  */
void linux_nat_set_new_thread (struct target_ops *, void (*) (ptid_t));

/* Register a method that converts a siginfo object between the layout
   that ptrace returns, and the layout in the architecture of the
   inferior.  */
void linux_nat_set_siginfo_fixup (struct target_ops *,
				  int (*) (struct siginfo *,
					   gdb_byte *,
					   int));

/* Update linux-nat internal state when changing from one fork
   to another.  */
void linux_nat_switch_fork (ptid_t new_ptid);

/* Return the saved siginfo associated with PTID.  */
struct siginfo *linux_nat_get_siginfo (ptid_t ptid);

/* Compute and return the processor core of a given thread.  */
int linux_nat_core_of_thread_1 (ptid_t ptid);

/* Set alternative SIGTRAP-like events recognizer.  */
void linux_nat_set_status_is_event (struct target_ops *t,
				    int (*status_is_event) (int status));
Commit	Line	Data
0274a8ce	1	/* Native debugging support for GNU/Linux (LWP layer).
10d6c8cd	2
4c38e0a4	3	Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
7b6bb8da	4	2010, 2011 Free Software Foundation, Inc.
0274a8ce MS	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
a9762ec7	10	the Free Software Foundation; either version 3 of the License, or
0274a8ce MS	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
a9762ec7	19	along with this program. If not, see <http://www.gnu.org/licenses/>. */
0274a8ce	20
a2f23071 DJ	21	#include "target.h"
a2f23071 DJ	22
9f0bdab8 DJ	23	#include <signal.h>
	24
	25	/* Structure describing an LWP. This is public only for the purposes
	26	of ALL_LWPS; target-specific code should generally not access it
	27	directly. */
0274a8ce MS	28
	29	struct lwp_info
	30	{
	31	/* The process id of the LWP. This is a combination of the LWP id
	32	and overall process id. */
	33	ptid_t ptid;
	34
	35	/* Non-zero if this LWP is cloned. In this context "cloned" means
	36	that the LWP is reporting to its parent using a signal other than
	37	SIGCHLD. */
	38	int cloned;
	39
	40	/* Non-zero if we sent this LWP a SIGSTOP (but the LWP didn't report
	41	it back yet). */
	42	int signalled;
	43
	44	/* Non-zero if this LWP is stopped. */
	45	int stopped;
	46
	47	/* Non-zero if this LWP will be/has been resumed. Note that an LWP
	48	can be marked both as stopped and resumed at the same time. This
	49	happens if we try to resume an LWP that has a wait status
	50	pending. We shouldn't let the LWP run until that wait status has
	51	been processed, but we should not report that wait status if GDB
	52	didn't try to let the LWP run. */
	53	int resumed;
	54
	55	/* If non-zero, a pending wait status. */
	56	int status;
	57
	58	/* Non-zero if we were stepping this LWP. */
	59	int step;
	60
9f0bdab8 DJ	61	/* Non-zero si_signo if this LWP stopped with a trap. si_addr may
	62	be the address of a hardware watchpoint. */
	63	struct siginfo siginfo;
	64
ebec9a0f PA	65	/* STOPPED_BY_WATCHPOINT is non-zero if this LWP stopped with a data
	66	watchpoint trap. */
	67	int stopped_by_watchpoint;
	68
	69	/* On architectures where it is possible to know the data address of
	70	a triggered watchpoint, STOPPED_DATA_ADDRESS_P is non-zero, and
	71	STOPPED_DATA_ADDRESS contains such data address. Otherwise,
	72	STOPPED_DATA_ADDRESS_P is false, and STOPPED_DATA_ADDRESS is
	73	undefined. Only valid if STOPPED_BY_WATCHPOINT is true. */
	74	int stopped_data_address_p;
	75	CORE_ADDR stopped_data_address;
	76
57380f4e DJ	77	/* Non-zero if we expect a duplicated SIGINT. */
	78	int ignore_sigint;
	79
a2f23071 DJ	80	/* If WAITSTATUS->KIND != TARGET_WAITKIND_SPURIOUS, the waitstatus
	81	for this LWP's last event. This may correspond to STATUS above,
	82	or to a local variable in lin_lwp_wait. */
	83	struct target_waitstatus waitstatus;
	84
a96d9b2e SDJ	85	/* Signal wether we are in a SYSCALL_ENTRY or
	86	in a SYSCALL_RETURN event.
	87	Values:
	88	- TARGET_WAITKIND_SYSCALL_ENTRY
	89	- TARGET_WAITKIND_SYSCALL_RETURN */
	90	int syscall_state;
	91
dc146f7c VP	92	/* The processor core this LWP was last seen on. */
	93	int core;
	94
0274a8ce MS	95	/* Next LWP in list. */
	96	struct lwp_info *next;
	97	};
	98
9f0bdab8 DJ	99	/* The global list of LWPs, for ALL_LWPS. Unlike the threads list,
	100	there is always at least one LWP on the list while the GNU/Linux
	101	native target is active. */
	102	extern struct lwp_info *lwp_list;
	103
	104	/* Iterate over the PTID each active thread (light-weight process). There
	105	must be at least one. */
	106	#define ALL_LWPS(LP, PTID) \
	107	for ((LP) = lwp_list, (PTID) = (LP)->ptid; \
	108	(LP) != NULL; \
	109	(LP) = (LP)->next, (PTID) = (LP) ? (LP)->ptid : (PTID))
	110
17faa917 DJ	111	#define GET_LWP(ptid) ptid_get_lwp (ptid)
	112	#define GET_PID(ptid) ptid_get_pid (ptid)
	113	#define is_lwp(ptid) (GET_LWP (ptid) != 0)
	114	#define BUILD_LWP(lwp, pid) ptid_build (pid, lwp, 0)
	115
0ec9a092 DJ	116	/* Attempt to initialize libthread_db. */
0ec9a092 DJ	117	void check_for_thread_db (void);
0274a8ce	118
4c28f408 PA	119	int thread_db_attach_lwp (ptid_t ptid);
4c28f408 PA	120
669211f5 UW	121	/* Return the set of signals used by the threads library. */
	122	extern void lin_thread_get_thread_signals (sigset_t *mask);
	123
bfb39158	124	/* Find process PID's pending signal set from /proc/pid/status. */
3e43a32a MS	125	void linux_proc_pending_signals (int pid, sigset_t *pending,
3e43a32a MS	126	sigset_t blocked, sigset_t ignored);
bfb39158	127
4d062f1a PA	128	/* Return the TGID of LWPID from /proc/pid/status. Returns -1 if not
	129	found. */
	130	extern int linux_proc_get_tgid (int lwpid);
	131
4de4c07c	132	/* linux-nat functions for handling fork events. */
4de4c07c	133	extern void linux_enable_event_reporting (ptid_t ptid);
0274a8ce	134
93815fbf	135	extern int lin_lwp_attach_lwp (ptid_t ptid);
9ee57c33	136
0274a8ce	137	/* Iterator function for lin-lwp's lwp list. */
d90e17a7 PA	138	struct lwp_info *iterate_over_lwps (ptid_t filter,
d90e17a7 PA	139	int (callback) (struct lwp_info ,
0274a8ce MS	140	void *),
0274a8ce MS	141	void *data);
10d6c8cd	142
155bd5d1 AC	143	/* Create a prototype generic GNU/Linux target. The client can
155bd5d1 AC	144	override it with local methods. */
10d6c8cd	145	struct target_ops * linux_target (void);
f973ed9c	146
910122bf UW	147	/* Create a generic GNU/Linux target using traditional
	148	ptrace register access. */
	149	struct target_ops *
7714d83a	150	linux_trad_target (CORE_ADDR (register_u_offset)(struct gdbarch , int, int));
910122bf	151
155bd5d1	152	/* Register the customized GNU/Linux target. This should be used
f973ed9c DJ	153	instead of calling add_target directly. */
	154	void linux_nat_add_target (struct target_ops *);
	155
9f0bdab8 DJ	156	/* Register a method to call whenever a new thread is attached. */
	157	void linux_nat_set_new_thread (struct target_ops , void () (ptid_t));
	158
5b009018 PA	159	/* Register a method that converts a siginfo object between the layout
	160	that ptrace returns, and the layout in the architecture of the
	161	inferior. */
	162	void linux_nat_set_siginfo_fixup (struct target_ops *,
	163	int () (struct siginfo ,
	164	gdb_byte *,
	165	int));
	166
f973ed9c DJ	167	/* Update linux-nat internal state when changing from one fork
	168	to another. */
	169	void linux_nat_switch_fork (ptid_t new_ptid);
9f0bdab8 DJ	170
	171	/* Return the saved siginfo associated with PTID. */
	172	struct siginfo *linux_nat_get_siginfo (ptid_t ptid);
dc146f7c VP	173
	174	/* Compute and return the processor core of a given thread. */
	175	int linux_nat_core_of_thread_1 (ptid_t ptid);
26ab7092 JK	176
	177	/* Set alternative SIGTRAP-like events recognizer. */
	178	void linux_nat_set_status_is_event (struct target_ops *t,
	179	int (*status_is_event) (int status));