[deliverable/binutils-gdb.git] / gdb / btrace.h

/* Branch trace support for GDB, the GNU debugger.

   Copyright (C) 2013-2015 Free Software Foundation, Inc.

   Contributed by Intel Corp. <markus.t.metzger@intel.com>.

   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 BTRACE_H
#define BTRACE_H

/* Branch tracing (btrace) is a per-thread control-flow execution trace of the
   inferior.  For presentation purposes, the branch trace is represented as a
   list of sequential control-flow blocks, one such list per thread.  */

#include "btrace-common.h"

struct thread_info;
struct btrace_function;

/* A coarse instruction classification.  */
enum btrace_insn_class
{
  /* The instruction is something not listed below.  */
  BTRACE_INSN_OTHER,

  /* The instruction is a function call.  */
  BTRACE_INSN_CALL,

  /* The instruction is a function return.  */
  BTRACE_INSN_RETURN,

  /* The instruction is an unconditional jump.  */
  BTRACE_INSN_JUMP
};

/* A branch trace instruction.

   This represents a single instruction in a branch trace.  */
struct btrace_insn
{
  /* The address of this instruction.  */
  CORE_ADDR pc;

  /* The size of this instruction in bytes.  */
  gdb_byte size;

  /* The instruction class of this instruction.  */
  enum btrace_insn_class iclass;
};

/* A vector of branch trace instructions.  */
typedef struct btrace_insn btrace_insn_s;
DEF_VEC_O (btrace_insn_s);

/* A doubly-linked list of branch trace function segments.  */
struct btrace_func_link
{
  struct btrace_function *prev;
  struct btrace_function *next;
};

/* Flags for btrace function segments.  */
enum btrace_function_flag
{
  /* The 'up' link interpretation.
     If set, it points to the function segment we returned to.
     If clear, it points to the function segment we called from.  */
  BFUN_UP_LINKS_TO_RET = (1 << 0),

  /* The 'up' link points to a tail call.  This obviously only makes sense
     if bfun_up_links_to_ret is clear.  */
  BFUN_UP_LINKS_TO_TAILCALL = (1 << 1)
};

/* Decode errors for the BTS recording format.  */
enum btrace_bts_error
{
  /* The instruction trace overflowed the end of the trace block.  */
  BDE_BTS_OVERFLOW = 1,

  /* The instruction size could not be determined.  */
  BDE_BTS_INSN_SIZE
};

/* A branch trace function segment.

   This represents a function segment in a branch trace, i.e. a consecutive
   number of instructions belonging to the same function.

   In case of decode errors, we add an empty function segment to indicate
   the gap in the trace.

   We do not allow function segments without instructions otherwise.  */
struct btrace_function
{
  /* The full and minimal symbol for the function.  Both may be NULL.  */
  struct minimal_symbol *msym;
  struct symbol *sym;

  /* The previous and next segment belonging to the same function.
     If a function calls another function, the former will have at least
     two segments: one before the call and another after the return.  */
  struct btrace_func_link segment;

  /* The previous and next function in control flow order.  */
  struct btrace_func_link flow;

  /* The directly preceding function segment in a (fake) call stack.  */
  struct btrace_function *up;

  /* The instructions in this function segment.
     The instruction vector will be empty if the function segment
     represents a decode error.  */
  VEC (btrace_insn_s) *insn;

  /* The error code of a decode error that led to a gap.
     Must be zero unless INSN is empty; non-zero otherwise.  */
  int errcode;

  /* The instruction number offset for the first instruction in this
     function segment.
     If INSN is empty this is the insn_offset of the succeding function
     segment in control-flow order.  */
  unsigned int insn_offset;

  /* The function number in control-flow order.
     If INSN is empty indicating a gap in the trace due to a decode error,
     we still count the gap as a function.  */
  unsigned int number;

  /* The function level in a back trace across the entire branch trace.
     A caller's level is one lower than the level of its callee.

     Levels can be negative if we see returns for which we have not seen
     the corresponding calls.  The branch trace thread information provides
     a fixup to normalize function levels so the smallest level is zero.  */
  int level;

  /* A bit-vector of btrace_function_flag.  */
  enum btrace_function_flag flags;
};

/* A branch trace instruction iterator.  */
struct btrace_insn_iterator
{
  /* The branch trace function segment containing the instruction.
     Will never be NULL.  */
  const struct btrace_function *function;

  /* The index into the function segment's instruction vector.  */
  unsigned int index;
};

/* A branch trace function call iterator.  */
struct btrace_call_iterator
{
  /* The branch trace information for this thread.  Will never be NULL.  */
  const struct btrace_thread_info *btinfo;

  /* The branch trace function segment.
     This will be NULL for the iterator pointing to the end of the trace.  */
  const struct btrace_function *function;
};

/* Branch trace iteration state for "record instruction-history".  */
struct btrace_insn_history
{
  /* The branch trace instruction range from BEGIN (inclusive) to
     END (exclusive) that has been covered last time.  */
  struct btrace_insn_iterator begin;
  struct btrace_insn_iterator end;
};

/* Branch trace iteration state for "record function-call-history".  */
struct btrace_call_history
{
  /* The branch trace function range from BEGIN (inclusive) to END (exclusive)
     that has been covered last time.  */
  struct btrace_call_iterator begin;
  struct btrace_call_iterator end;
};

/* Branch trace thread flags.  */
enum btrace_thread_flag
{
  /* The thread is to be stepped forwards.  */
  BTHR_STEP = (1 << 0),

  /* The thread is to be stepped backwards.  */
  BTHR_RSTEP = (1 << 1),

  /* The thread is to be continued forwards.  */
  BTHR_CONT = (1 << 2),

  /* The thread is to be continued backwards.  */
  BTHR_RCONT = (1 << 3),

  /* The thread is to be moved.  */
  BTHR_MOVE = (BTHR_STEP | BTHR_RSTEP | BTHR_CONT | BTHR_RCONT)
};

/* Branch trace information per thread.

   This represents the branch trace configuration as well as the entry point
   into the branch trace data.  For the latter, it also contains the index into
   an array of branch trace blocks used for iterating though the branch trace
   blocks of a thread.  */
struct btrace_thread_info
{
  /* The target branch trace information for this thread.

     This contains the branch trace configuration as well as any
     target-specific information necessary for implementing branch tracing on
     the underlying architecture.  */
  struct btrace_target_info *target;

  /* The current branch trace for this thread (both inclusive).

     The last instruction of END is the current instruction, which is not
     part of the execution history.
     Both will be NULL if there is no branch trace available.  If there is
     branch trace available, both will be non-NULL.  */
  struct btrace_function *begin;
  struct btrace_function *end;

  /* The function level offset.  When added to each function's LEVEL,
     this normalizes the function levels such that the smallest level
     becomes zero.  */
  int level;

  /* The number of gaps in the trace.  */
  unsigned int ngaps;

  /* A bit-vector of btrace_thread_flag.  */
  enum btrace_thread_flag flags;

  /* The instruction history iterator.  */
  struct btrace_insn_history *insn_history;

  /* The function call history iterator.  */
  struct btrace_call_history *call_history;

  /* The current replay position.  NULL if not replaying.
     Gaps are skipped during replay, so REPLAY always points to a valid
     instruction.  */
  struct btrace_insn_iterator *replay;
};

/* Enable branch tracing for a thread.  */
extern void btrace_enable (struct thread_info *tp,
			   const struct btrace_config *conf);

/* Get the branch trace configuration for a thread.
   Return NULL if branch tracing is not enabled for that thread.  */
extern const struct btrace_config *
  btrace_conf (const struct btrace_thread_info *);

/* Disable branch tracing for a thread.
   This will also delete the current branch trace data.  */
extern void btrace_disable (struct thread_info *);

/* Disable branch tracing for a thread during teardown.
   This is similar to btrace_disable, except that it will use
   target_teardown_btrace instead of target_disable_btrace.  */
extern void btrace_teardown (struct thread_info *);

/* Fetch the branch trace for a single thread.  */
extern void btrace_fetch (struct thread_info *);

/* Clear the branch trace for a single thread.  */
extern void btrace_clear (struct thread_info *);

/* Clear the branch trace for all threads when an object file goes away.  */
extern void btrace_free_objfile (struct objfile *);

/* Parse a branch trace xml document XML into DATA.  */
extern void parse_xml_btrace (struct btrace_data *data, const char *xml);

/* Parse a branch trace configuration xml document XML into CONF.  */
extern void parse_xml_btrace_conf (struct btrace_config *conf, const char *xml);

/* Dereference a branch trace instruction iterator.  Return a pointer to the
   instruction the iterator points to.
   May return NULL if the iterator points to a gap in the trace.  */
extern const struct btrace_insn *
  btrace_insn_get (const struct btrace_insn_iterator *);

/* Return the instruction number for a branch trace iterator.
   Returns one past the maximum instruction number for the end iterator.
   Returns zero if the iterator does not point to a valid instruction.  */
extern unsigned int btrace_insn_number (const struct btrace_insn_iterator *);

/* Initialize a branch trace instruction iterator to point to the begin/end of
   the branch trace.  Throws an error if there is no branch trace.  */
extern void btrace_insn_begin (struct btrace_insn_iterator *,
			       const struct btrace_thread_info *);
extern void btrace_insn_end (struct btrace_insn_iterator *,
			     const struct btrace_thread_info *);

/* Increment/decrement a branch trace instruction iterator by at most STRIDE
   instructions.  Return the number of instructions by which the instruction
   iterator has been advanced.
   Returns zero, if the operation failed or STRIDE had been zero.  */
extern unsigned int btrace_insn_next (struct btrace_insn_iterator *,
				      unsigned int stride);
extern unsigned int btrace_insn_prev (struct btrace_insn_iterator *,
				      unsigned int stride);

/* Compare two branch trace instruction iterators.
   Return a negative number if LHS < RHS.
   Return zero if LHS == RHS.
   Return a positive number if LHS > RHS.  */
extern int btrace_insn_cmp (const struct btrace_insn_iterator *lhs,
			    const struct btrace_insn_iterator *rhs);

/* Find an instruction in the function branch trace by its number.
   If the instruction is found, initialize the branch trace instruction
   iterator to point to this instruction and return non-zero.
   Return zero otherwise.  */
extern int btrace_find_insn_by_number (struct btrace_insn_iterator *,
				       const struct btrace_thread_info *,
				       unsigned int number);

/* Dereference a branch trace call iterator.  Return a pointer to the
   function the iterator points to or NULL if the interator points past
   the end of the branch trace.  */
extern const struct btrace_function *
  btrace_call_get (const struct btrace_call_iterator *);

/* Return the function number for a branch trace call iterator.
   Returns one past the maximum function number for the end iterator.
   Returns zero if the iterator does not point to a valid function.  */
extern unsigned int btrace_call_number (const struct btrace_call_iterator *);

/* Initialize a branch trace call iterator to point to the begin/end of
   the branch trace.  Throws an error if there is no branch trace.  */
extern void btrace_call_begin (struct btrace_call_iterator *,
			       const struct btrace_thread_info *);
extern void btrace_call_end (struct btrace_call_iterator *,
			     const struct btrace_thread_info *);

/* Increment/decrement a branch trace call iterator by at most STRIDE function
   segments.  Return the number of function segments by which the call
   iterator has been advanced.
   Returns zero, if the operation failed or STRIDE had been zero.  */
extern unsigned int btrace_call_next (struct btrace_call_iterator *,
				      unsigned int stride);
extern unsigned int btrace_call_prev (struct btrace_call_iterator *,
				      unsigned int stride);

/* Compare two branch trace call iterators.
   Return a negative number if LHS < RHS.
   Return zero if LHS == RHS.
   Return a positive number if LHS > RHS.  */
extern int btrace_call_cmp (const struct btrace_call_iterator *lhs,
			    const struct btrace_call_iterator *rhs);

/* Find a function in the function branch trace by its NUMBER.
   If the function is found, initialize the branch trace call
   iterator to point to this function and return non-zero.
   Return zero otherwise.  */
extern int btrace_find_call_by_number (struct btrace_call_iterator *,
				       const struct btrace_thread_info *,
				       unsigned int number);

/* Set the branch trace instruction history from BEGIN (inclusive) to
   END (exclusive).  */
extern void btrace_set_insn_history (struct btrace_thread_info *,
				     const struct btrace_insn_iterator *begin,
				     const struct btrace_insn_iterator *end);

/* Set the branch trace function call history from BEGIN (inclusive) to
   END (exclusive).  */
extern void btrace_set_call_history (struct btrace_thread_info *,
				     const struct btrace_call_iterator *begin,
				     const struct btrace_call_iterator *end);

/* Determine if branch tracing is currently replaying TP.  */
extern int btrace_is_replaying (struct thread_info *tp);

/* Return non-zero if the branch trace for TP is empty; zero otherwise.  */
extern int btrace_is_empty (struct thread_info *tp);

/* Create a cleanup for DATA.  */
extern struct cleanup *make_cleanup_btrace_data (struct btrace_data *data);

#endif /* BTRACE_H */
Commit	Line	Data
02d27625 MM	1	/* Branch trace support for GDB, the GNU debugger.
02d27625 MM	2
32d0add0	3	Copyright (C) 2013-2015 Free Software Foundation, Inc.
02d27625 MM	4
	5	Contributed by Intel Corp. <markus.t.metzger@intel.com>.
	6
	7	This file is part of GDB.
	8
	9	This program is free software; you can redistribute it and/or modify
	10	it under the terms of the GNU General Public License as published by
	11	the Free Software Foundation; either version 3 of the License, or
	12	(at your option) any later version.
	13
	14	This program is distributed in the hope that it will be useful,
	15	but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	GNU General Public License for more details.
	18
	19	You should have received a copy of the GNU General Public License
	20	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	21
	22	#ifndef BTRACE_H
	23	#define BTRACE_H
	24
	25	/* Branch tracing (btrace) is a per-thread control-flow execution trace of the
	26	inferior. For presentation purposes, the branch trace is represented as a
	27	list of sequential control-flow blocks, one such list per thread. */
	28
	29	#include "btrace-common.h"
	30
	31	struct thread_info;
23a7fe75	32	struct btrace_function;
02d27625	33
7d5c24b3 MM	34	/* A coarse instruction classification. */
	35	enum btrace_insn_class
	36	{
	37	/* The instruction is something not listed below. */
	38	BTRACE_INSN_OTHER,
	39
	40	/* The instruction is a function call. */
	41	BTRACE_INSN_CALL,
	42
	43	/* The instruction is a function return. */
	44	BTRACE_INSN_RETURN,
	45
	46	/* The instruction is an unconditional jump. */
	47	BTRACE_INSN_JUMP
	48	};
	49
02d27625 MM	50	/* A branch trace instruction.
	51
	52	This represents a single instruction in a branch trace. */
23a7fe75	53	struct btrace_insn
02d27625 MM	54	{
	55	/* The address of this instruction. */
	56	CORE_ADDR pc;
7d5c24b3 MM	57
	58	/* The size of this instruction in bytes. */
	59	gdb_byte size;
	60
	61	/* The instruction class of this instruction. */
	62	enum btrace_insn_class iclass;
02d27625 MM	63	};
02d27625 MM	64
23a7fe75 MM	65	/* A vector of branch trace instructions. */
	66	typedef struct btrace_insn btrace_insn_s;
	67	DEF_VEC_O (btrace_insn_s);
	68
	69	/* A doubly-linked list of branch trace function segments. */
	70	struct btrace_func_link
	71	{
	72	struct btrace_function *prev;
	73	struct btrace_function *next;
	74	};
	75
	76	/* Flags for btrace function segments. */
	77	enum btrace_function_flag
	78	{
	79	/* The 'up' link interpretation.
	80	If set, it points to the function segment we returned to.
	81	If clear, it points to the function segment we called from. */
	82	BFUN_UP_LINKS_TO_RET = (1 << 0),
	83
	84	/* The 'up' link points to a tail call. This obviously only makes sense
	85	if bfun_up_links_to_ret is clear. */
	86	BFUN_UP_LINKS_TO_TAILCALL = (1 << 1)
	87	};
	88
31fd9caa MM	89	/* Decode errors for the BTS recording format. */
	90	enum btrace_bts_error
	91	{
	92	/* The instruction trace overflowed the end of the trace block. */
	93	BDE_BTS_OVERFLOW = 1,
	94
	95	/* The instruction size could not be determined. */
	96	BDE_BTS_INSN_SIZE
	97	};
	98
23a7fe75	99	/* A branch trace function segment.
02d27625 MM	100
02d27625 MM	101	This represents a function segment in a branch trace, i.e. a consecutive
23a7fe75 MM	102	number of instructions belonging to the same function.
23a7fe75 MM	103
31fd9caa MM	104	In case of decode errors, we add an empty function segment to indicate
	105	the gap in the trace.
	106
	107	We do not allow function segments without instructions otherwise. */
23a7fe75	108	struct btrace_function
02d27625	109	{
23a7fe75	110	/* The full and minimal symbol for the function. Both may be NULL. */
02d27625 MM	111	struct minimal_symbol *msym;
	112	struct symbol *sym;
	113
23a7fe75 MM	114	/* The previous and next segment belonging to the same function.
	115	If a function calls another function, the former will have at least
	116	two segments: one before the call and another after the return. */
	117	struct btrace_func_link segment;
	118
	119	/* The previous and next function in control flow order. */
	120	struct btrace_func_link flow;
	121
	122	/* The directly preceding function segment in a (fake) call stack. */
	123	struct btrace_function *up;
	124
	125	/* The instructions in this function segment.
31fd9caa MM	126	The instruction vector will be empty if the function segment
31fd9caa MM	127	represents a decode error. */
23a7fe75 MM	128	VEC (btrace_insn_s) *insn;
23a7fe75 MM	129
31fd9caa MM	130	/* The error code of a decode error that led to a gap.
	131	Must be zero unless INSN is empty; non-zero otherwise. */
	132	int errcode;
	133
23a7fe75	134	/* The instruction number offset for the first instruction in this
31fd9caa MM	135	function segment.
	136	If INSN is empty this is the insn_offset of the succeding function
	137	segment in control-flow order. */
23a7fe75 MM	138	unsigned int insn_offset;
23a7fe75 MM	139
31fd9caa MM	140	/* The function number in control-flow order.
	141	If INSN is empty indicating a gap in the trace due to a decode error,
	142	we still count the gap as a function. */
23a7fe75 MM	143	unsigned int number;
	144
	145	/* The function level in a back trace across the entire branch trace.
	146	A caller's level is one lower than the level of its callee.
	147
	148	Levels can be negative if we see returns for which we have not seen
	149	the corresponding calls. The branch trace thread information provides
	150	a fixup to normalize function levels so the smallest level is zero. */
	151	int level;
	152
23a7fe75 MM	153	/* A bit-vector of btrace_function_flag. */
23a7fe75 MM	154	enum btrace_function_flag flags;
02d27625 MM	155	};
02d27625 MM	156
23a7fe75 MM	157	/* A branch trace instruction iterator. */
	158	struct btrace_insn_iterator
	159	{
	160	/* The branch trace function segment containing the instruction.
	161	Will never be NULL. */
	162	const struct btrace_function *function;
02d27625	163
23a7fe75 MM	164	/* The index into the function segment's instruction vector. */
	165	unsigned int index;
	166	};
02d27625	167
23a7fe75 MM	168	/* A branch trace function call iterator. */
	169	struct btrace_call_iterator
	170	{
	171	/* The branch trace information for this thread. Will never be NULL. */
	172	const struct btrace_thread_info *btinfo;
	173
	174	/* The branch trace function segment.
	175	This will be NULL for the iterator pointing to the end of the trace. */
	176	const struct btrace_function *function;
	177	};
02d27625 MM	178
02d27625 MM	179	/* Branch trace iteration state for "record instruction-history". */
23a7fe75	180	struct btrace_insn_history
02d27625	181	{
23a7fe75 MM	182	/* The branch trace instruction range from BEGIN (inclusive) to
	183	END (exclusive) that has been covered last time. */
	184	struct btrace_insn_iterator begin;
	185	struct btrace_insn_iterator end;
02d27625 MM	186	};
	187
	188	/* Branch trace iteration state for "record function-call-history". */
23a7fe75	189	struct btrace_call_history
02d27625	190	{
23a7fe75 MM	191	/* The branch trace function range from BEGIN (inclusive) to END (exclusive)
	192	that has been covered last time. */
	193	struct btrace_call_iterator begin;
	194	struct btrace_call_iterator end;
02d27625 MM	195	};
02d27625 MM	196
52834460 MM	197	/* Branch trace thread flags. */
	198	enum btrace_thread_flag
	199	{
	200	/* The thread is to be stepped forwards. */
	201	BTHR_STEP = (1 << 0),
	202
	203	/* The thread is to be stepped backwards. */
	204	BTHR_RSTEP = (1 << 1),
	205
	206	/* The thread is to be continued forwards. */
	207	BTHR_CONT = (1 << 2),
	208
	209	/* The thread is to be continued backwards. */
	210	BTHR_RCONT = (1 << 3),
	211
	212	/* The thread is to be moved. */
	213	BTHR_MOVE = (BTHR_STEP \| BTHR_RSTEP \| BTHR_CONT \| BTHR_RCONT)
	214	};
	215
02d27625 MM	216	/* Branch trace information per thread.
	217
	218	This represents the branch trace configuration as well as the entry point
	219	into the branch trace data. For the latter, it also contains the index into
	220	an array of branch trace blocks used for iterating though the branch trace
	221	blocks of a thread. */
	222	struct btrace_thread_info
	223	{
	224	/* The target branch trace information for this thread.
	225
	226	This contains the branch trace configuration as well as any
	227	target-specific information necessary for implementing branch tracing on
	228	the underlying architecture. */
	229	struct btrace_target_info *target;
	230
23a7fe75 MM	231	/* The current branch trace for this thread (both inclusive).
	232
	233	The last instruction of END is the current instruction, which is not
	234	part of the execution history.
	235	Both will be NULL if there is no branch trace available. If there is
	236	branch trace available, both will be non-NULL. */
	237	struct btrace_function *begin;
	238	struct btrace_function *end;
	239
	240	/* The function level offset. When added to each function's LEVEL,
	241	this normalizes the function levels such that the smallest level
	242	becomes zero. */
	243	int level;
02d27625	244
31fd9caa MM	245	/* The number of gaps in the trace. */
	246	unsigned int ngaps;
	247
52834460 MM	248	/* A bit-vector of btrace_thread_flag. */
	249	enum btrace_thread_flag flags;
	250
02d27625	251	/* The instruction history iterator. */
23a7fe75	252	struct btrace_insn_history *insn_history;
02d27625 MM	253
02d27625 MM	254	/* The function call history iterator. */
23a7fe75	255	struct btrace_call_history *call_history;
07bbe694	256
31fd9caa MM	257	/* The current replay position. NULL if not replaying.
	258	Gaps are skipped during replay, so REPLAY always points to a valid
	259	instruction. */
07bbe694	260	struct btrace_insn_iterator *replay;
02d27625 MM	261	};
	262
	263	/* Enable branch tracing for a thread. */
f4abbc16 MM	264	extern void btrace_enable (struct thread_info *tp,
	265	const struct btrace_config *conf);
	266
	267	/* Get the branch trace configuration for a thread.
	268	Return NULL if branch tracing is not enabled for that thread. */
	269	extern const struct btrace_config *
	270	btrace_conf (const struct btrace_thread_info *);
02d27625 MM	271
	272	/* Disable branch tracing for a thread.
	273	This will also delete the current branch trace data. */
	274	extern void btrace_disable (struct thread_info *);
	275
	276	/* Disable branch tracing for a thread during teardown.
	277	This is similar to btrace_disable, except that it will use
	278	target_teardown_btrace instead of target_disable_btrace. */
	279	extern void btrace_teardown (struct thread_info *);
	280
	281	/* Fetch the branch trace for a single thread. */
	282	extern void btrace_fetch (struct thread_info *);
	283
	284	/* Clear the branch trace for a single thread. */
	285	extern void btrace_clear (struct thread_info *);
	286
	287	/* Clear the branch trace for all threads when an object file goes away. */
	288	extern void btrace_free_objfile (struct objfile *);
	289
734b0e4b MM	290	/* Parse a branch trace xml document XML into DATA. */
734b0e4b MM	291	extern void parse_xml_btrace (struct btrace_data data, const char xml);
c12a2917	292
f4abbc16 MM	293	/* Parse a branch trace configuration xml document XML into CONF. */
	294	extern void parse_xml_btrace_conf (struct btrace_config conf, const char xml);
	295
23a7fe75	296	/* Dereference a branch trace instruction iterator. Return a pointer to the
31fd9caa MM	297	instruction the iterator points to.
31fd9caa MM	298	May return NULL if the iterator points to a gap in the trace. */
23a7fe75 MM	299	extern const struct btrace_insn *
	300	btrace_insn_get (const struct btrace_insn_iterator *);
	301
	302	/* Return the instruction number for a branch trace iterator.
	303	Returns one past the maximum instruction number for the end iterator.
	304	Returns zero if the iterator does not point to a valid instruction. */
	305	extern unsigned int btrace_insn_number (const struct btrace_insn_iterator *);
	306
	307	/* Initialize a branch trace instruction iterator to point to the begin/end of
	308	the branch trace. Throws an error if there is no branch trace. */
	309	extern void btrace_insn_begin (struct btrace_insn_iterator *,
	310	const struct btrace_thread_info *);
	311	extern void btrace_insn_end (struct btrace_insn_iterator *,
	312	const struct btrace_thread_info *);
	313
	314	/* Increment/decrement a branch trace instruction iterator by at most STRIDE
	315	instructions. Return the number of instructions by which the instruction
	316	iterator has been advanced.
	317	Returns zero, if the operation failed or STRIDE had been zero. */
	318	extern unsigned int btrace_insn_next (struct btrace_insn_iterator *,
	319	unsigned int stride);
	320	extern unsigned int btrace_insn_prev (struct btrace_insn_iterator *,
	321	unsigned int stride);
	322
	323	/* Compare two branch trace instruction iterators.
	324	Return a negative number if LHS < RHS.
	325	Return zero if LHS == RHS.
	326	Return a positive number if LHS > RHS. */
	327	extern int btrace_insn_cmp (const struct btrace_insn_iterator *lhs,
	328	const struct btrace_insn_iterator *rhs);
	329
	330	/* Find an instruction in the function branch trace by its number.
	331	If the instruction is found, initialize the branch trace instruction
	332	iterator to point to this instruction and return non-zero.
	333	Return zero otherwise. */
	334	extern int btrace_find_insn_by_number (struct btrace_insn_iterator *,
	335	const struct btrace_thread_info *,
	336	unsigned int number);
	337
	338	/* Dereference a branch trace call iterator. Return a pointer to the
	339	function the iterator points to or NULL if the interator points past
	340	the end of the branch trace. */
	341	extern const struct btrace_function *
	342	btrace_call_get (const struct btrace_call_iterator *);
	343
	344	/* Return the function number for a branch trace call iterator.
	345	Returns one past the maximum function number for the end iterator.
	346	Returns zero if the iterator does not point to a valid function. */
	347	extern unsigned int btrace_call_number (const struct btrace_call_iterator *);
	348
	349	/* Initialize a branch trace call iterator to point to the begin/end of
	350	the branch trace. Throws an error if there is no branch trace. */
	351	extern void btrace_call_begin (struct btrace_call_iterator *,
	352	const struct btrace_thread_info *);
	353	extern void btrace_call_end (struct btrace_call_iterator *,
	354	const struct btrace_thread_info *);
	355
	356	/* Increment/decrement a branch trace call iterator by at most STRIDE function
	357	segments. Return the number of function segments by which the call
	358	iterator has been advanced.
	359	Returns zero, if the operation failed or STRIDE had been zero. */
	360	extern unsigned int btrace_call_next (struct btrace_call_iterator *,
	361	unsigned int stride);
	362	extern unsigned int btrace_call_prev (struct btrace_call_iterator *,
363	unsigned int stride);
364
365	/* Compare two branch trace call iterators.
366	Return a negative number if LHS < RHS.
367	Return zero if LHS == RHS.
368	Return a positive number if LHS > RHS. */
369	extern int btrace_call_cmp (const struct btrace_call_iterator *lhs,
370	const struct btrace_call_iterator *rhs);
371
372	/* Find a function in the function branch trace by its NUMBER.
373	If the function is found, initialize the branch trace call
374	iterator to point to this function and return non-zero.
375	Return zero otherwise. */
376	extern int btrace_find_call_by_number (struct btrace_call_iterator *,
377	const struct btrace_thread_info *,
378	unsigned int number);
379
380	/* Set the branch trace instruction history from BEGIN (inclusive) to
381	END (exclusive). */
382	extern void btrace_set_insn_history (struct btrace_thread_info *,
383	const struct btrace_insn_iterator *begin,
384	const struct btrace_insn_iterator *end);
385
386	/* Set the branch trace function call history from BEGIN (inclusive) to
387	END (exclusive). */
388	extern void btrace_set_call_history (struct btrace_thread_info *,
389	const struct btrace_call_iterator *begin,
390	const struct btrace_call_iterator *end);
391
07bbe694 MM	392	/* Determine if branch tracing is currently replaying TP. */
	393	extern int btrace_is_replaying (struct thread_info *tp);
	394
6e07b1d2 MM	395	/* Return non-zero if the branch trace for TP is empty; zero otherwise. */
	396	extern int btrace_is_empty (struct thread_info *tp);
	397
734b0e4b MM	398	/* Create a cleanup for DATA. */
734b0e4b MM	399	extern struct cleanup make_cleanup_btrace_data (struct btrace_data data);
6e07b1d2	400
02d27625	401	#endif /* BTRACE_H */