[deliverable/binutils-gdb.git] / gdb / inline-frame.h

/* Definitions for inline frame support.

   Copyright (C) 2008-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/>.  */

#if !defined (INLINE_FRAME_H)
#define INLINE_FRAME_H 1

struct frame_info;
struct frame_unwind;
struct bpstats;

/* The inline frame unwinder.  */

extern const struct frame_unwind inline_frame_unwind;

/* Skip all inlined functions whose call sites are at the current PC.

   If non-NULL, STOP_CHAIN is used to determine whether a stop was caused by
   a user breakpoint.  In that case, do not skip that inlined frame.  This
   allows the inlined frame to be treated as if it were non-inlined from the
   user's perspective.  GDB will stop "in" the inlined frame instead of
   the caller.  */

void skip_inline_frames (thread_info *thread, struct bpstats *stop_chain);

/* Forget about any hidden inlined functions in PTID, which is new or
   about to be resumed.  If PTID is minus_one_ptid, forget about all
   hidden inlined functions.  */

void clear_inline_frame_state (ptid_t ptid);

/* Step into an inlined function by unhiding it.  */

void step_into_inline_frame (thread_info *thread);

/* Return the number of hidden functions inlined into the current
   frame.  */

int inline_skipped_frames (thread_info *thread);

/* If one or more inlined functions are hidden, return the symbol for
   the function inlined into the current frame.  */

struct symbol *inline_skipped_symbol (thread_info *thread);

/* Return the number of functions inlined into THIS_FRAME.  Some of
   the callees may not have associated frames (see
   skip_inline_frames).  */

int frame_inlined_callees (struct frame_info *this_frame);

#endif /* !defined (INLINE_FRAME_H) */
Commit	Line	Data
edb3359d DJ	1	/* Definitions for inline frame support.
edb3359d DJ	2
b811d2c2	3	Copyright (C) 2008-2020 Free Software Foundation, Inc.
edb3359d DJ	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	#if !defined (INLINE_FRAME_H)
	21	#define INLINE_FRAME_H 1
	22
	23	struct frame_info;
	24	struct frame_unwind;
ddfe970e	25	struct bpstats;
edb3359d DJ	26
	27	/* The inline frame unwinder. */
	28
39d7b0e2	29	extern const struct frame_unwind inline_frame_unwind;
edb3359d DJ	30
edb3359d DJ	31	/* Skip all inlined functions whose call sites are at the current PC.
edb3359d	32
ddfe970e KS	33	If non-NULL, STOP_CHAIN is used to determine whether a stop was caused by
	34	a user breakpoint. In that case, do not skip that inlined frame. This
	35	allows the inlined frame to be treated as if it were non-inlined from the
	36	user's perspective. GDB will stop "in" the inlined frame instead of
	37	the caller. */
	38
00431a78	39	void skip_inline_frames (thread_info thread, struct bpstats stop_chain);
edb3359d DJ	40
	41	/* Forget about any hidden inlined functions in PTID, which is new or
	42	about to be resumed. If PTID is minus_one_ptid, forget about all
	43	hidden inlined functions. */
	44
	45	void clear_inline_frame_state (ptid_t ptid);
	46
	47	/* Step into an inlined function by unhiding it. */
	48
00431a78	49	void step_into_inline_frame (thread_info *thread);
edb3359d DJ	50
	51	/* Return the number of hidden functions inlined into the current
	52	frame. */
	53
00431a78	54	int inline_skipped_frames (thread_info *thread);
edb3359d DJ	55
	56	/* If one or more inlined functions are hidden, return the symbol for
	57	the function inlined into the current frame. */
	58
00431a78	59	struct symbol inline_skipped_symbol (thread_info thread);
edb3359d DJ	60
	61	/* Return the number of functions inlined into THIS_FRAME. Some of
	62	the callees may not have associated frames (see
	63	skip_inline_frames). */
	64
	65	int frame_inlined_callees (struct frame_info *this_frame);
	66
	67	#endif /* !defined (INLINE_FRAME_H) */