[deliverable/binutils-gdb.git] / gdb / gdbserver / tracepoint.h

/* Tracepoint code for remote server for GDB.
   Copyright (C) 1993-2017 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 TRACEPOINT_H
#define TRACEPOINT_H

/* Size for a small buffer to report problems from the in-process
   agent back to GDBserver.  */
#define IPA_BUFSIZ 100

void initialize_tracepoint (void);

#if defined(__GNUC__)
# define ATTR_USED __attribute__((used))
# define ATTR_NOINLINE __attribute__((noinline))
#else
# define ATTR_USED
# define ATTR_NOINLINE
#endif

/* How to make symbol public/exported.  */

#if defined _WIN32 || defined __CYGWIN__
# define EXPORTED_SYMBOL __declspec (dllexport)
#else
# if __GNUC__ >= 4
#  define EXPORTED_SYMBOL __attribute__ ((visibility ("default")))
# else
#  define EXPORTED_SYMBOL
# endif
#endif

/* Use these to make sure the functions and variables the IPA needs to
   export (symbols GDBserver needs to query GDB about) are visible and
   have C linkage.

   Tag exported functions with IP_AGENT_EXPORT_FUNC, tag the
   definitions of exported variables with IP_AGENT_EXPORT_VAR, and
   variable declarations with IP_AGENT_EXPORT_VAR_DECL.  Variables
   must also be exported with C linkage.  As we can't both use extern
   "C" and initialize a variable in the same statement, variables that
   don't have a separate declaration must use
   EXTERN_C_PUSH/EXTERN_C_POP around their definition.  */

#ifdef IN_PROCESS_AGENT
# define IP_AGENT_EXPORT_FUNC EXTERN_C EXPORTED_SYMBOL ATTR_NOINLINE ATTR_USED
# define IP_AGENT_EXPORT_VAR EXPORTED_SYMBOL ATTR_USED
# define IP_AGENT_EXPORT_VAR_DECL EXTERN_C EXPORTED_SYMBOL
#else
# define IP_AGENT_EXPORT_FUNC
# define IP_AGENT_EXPORT_VAR
# define IP_AGENT_EXPORT_VAR_DECL extern
#endif

IP_AGENT_EXPORT_VAR_DECL int tracing;

extern int disconnected_tracing;

void tracepoint_look_up_symbols (void);

void stop_tracing (void);

int handle_tracepoint_general_set (char *own_buf);
int handle_tracepoint_query (char *own_buf);

int tracepoint_finished_step (struct thread_info *tinfo, CORE_ADDR stop_pc);
int tracepoint_was_hit (struct thread_info *tinfo, CORE_ADDR stop_pc);

void release_while_stepping_state_list (struct thread_info *tinfo);

extern int current_traceframe;

int in_readonly_region (CORE_ADDR addr, ULONGEST length);
int traceframe_read_mem (int tfnum, CORE_ADDR addr,
			 unsigned char *buf, ULONGEST length,
			 ULONGEST *nbytes);
int fetch_traceframe_registers (int tfnum,
				struct regcache *regcache,
				int regnum);

int traceframe_read_sdata (int tfnum, ULONGEST offset,
			   unsigned char *buf, ULONGEST length,
			   ULONGEST *nbytes);

int traceframe_read_info (int tfnum, struct buffer *buffer);

/* If a thread is determined to be collecting a fast tracepoint, this
   structure holds the collect status.  */

struct fast_tpoint_collect_status
{
  /* The tracepoint that is presently being collected.  */
  int tpoint_num;
  CORE_ADDR tpoint_addr;

  /* The address range in the jump pad of where the original
     instruction the tracepoint jump was inserted was relocated
     to.  */
  CORE_ADDR adjusted_insn_addr;
  CORE_ADDR adjusted_insn_addr_end;
};

/* The possible states a thread can be in, related to the collection of fast
   tracepoint.  */

enum class fast_tpoint_collect_result
{
  /* Not collecting a fast tracepoint.  */
  not_collecting,

  /* In the jump pad, but before the relocated instruction.  */
  before_insn,

  /* In the jump pad, but at (or after) the relocated instruction.  */
  at_insn,
};

fast_tpoint_collect_result fast_tracepoint_collecting
  (CORE_ADDR thread_area, CORE_ADDR stop_pc,
   struct fast_tpoint_collect_status *status);

void force_unlock_trace_buffer (void);

int handle_tracepoint_bkpts (struct thread_info *tinfo, CORE_ADDR stop_pc);

#ifdef IN_PROCESS_AGENT
void initialize_low_tracepoint (void);
const struct target_desc *get_ipa_tdesc (int idx);
void supply_fast_tracepoint_registers (struct regcache *regcache,
				       const unsigned char *regs);
void supply_static_tracepoint_registers (struct regcache *regcache,
					 const unsigned char *regs,
					 CORE_ADDR pc);
void set_trampoline_buffer_space (CORE_ADDR begin, CORE_ADDR end,
				  char *errmsg);
void *alloc_jump_pad_buffer (size_t size);
#ifndef HAVE_GETAUXVAL
unsigned long getauxval (unsigned long type);
#endif
#else
void stop_tracing (void);

int claim_trampoline_space (ULONGEST used, CORE_ADDR *trampoline);
int have_fast_tracepoint_trampoline_buffer (char *msgbuf);
void gdb_agent_about_to_close (int pid);
#endif

struct traceframe;
struct eval_agent_expr_context;

/* Do memory copies for bytecodes.  */
/* Do the recording of memory blocks for actions and bytecodes.  */

int agent_mem_read (struct eval_agent_expr_context *ctx,
		    unsigned char *to, CORE_ADDR from,
		    ULONGEST len);

LONGEST agent_get_trace_state_variable_value (int num);
void agent_set_trace_state_variable_value (int num, LONGEST val);

/* Record the value of a trace state variable.  */

int agent_tsv_read (struct eval_agent_expr_context *ctx, int n);
int agent_mem_read_string (struct eval_agent_expr_context *ctx,
			   unsigned char *to,
			   CORE_ADDR from,
			   ULONGEST len);

/* The prototype the get_raw_reg function in the IPA.  Each arch's
   bytecode compiler emits calls to this function.  */
ULONGEST get_raw_reg (const unsigned char *raw_regs, int regnum);

/* Returns the address of the get_raw_reg function in the IPA.  */
CORE_ADDR get_raw_reg_func_addr (void);
/* Returns the address of the get_trace_state_variable_value
   function in the IPA.  */
CORE_ADDR get_get_tsv_func_addr (void);
/* Returns the address of the set_trace_state_variable_value
   function in the IPA.  */
CORE_ADDR get_set_tsv_func_addr (void);

#endif /* TRACEPOINT_H */
Commit	Line	Data
270c6aea	1	/* Tracepoint code for remote server for GDB.
61baf725	2	Copyright (C) 1993-2017 Free Software Foundation, Inc.
270c6aea PA	3
	4	This file is part of GDB.
	5
	6	This program is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
	8	the Free Software Foundation; either version 3 of the License, or
	9	(at your option) any later version.
	10
	11	This program is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
	15
	16	You should have received a copy of the GNU General Public License
	17	along with this program. If not, see <http://www.gnu.org/licenses/>. */
	18
	19	#ifndef TRACEPOINT_H
	20	#define TRACEPOINT_H
	21
	22	/* Size for a small buffer to report problems from the in-process
	23	agent back to GDBserver. */
	24	#define IPA_BUFSIZ 100
	25
	26	void initialize_tracepoint (void);
	27
3c14e5a3 PA	28	#if defined(__GNUC__)
	29	# define ATTR_USED __attribute__((used))
	30	# define ATTR_NOINLINE __attribute__((noinline))
	31	#else
	32	# define ATTR_USED
	33	# define ATTR_NOINLINE
	34	#endif
	35
	36	/* How to make symbol public/exported. */
	37
	38	#if defined _WIN32 \|\| defined __CYGWIN__
	39	# define EXPORTED_SYMBOL __declspec (dllexport)
	40	#else
	41	# if __GNUC__ >= 4
	42	# define EXPORTED_SYMBOL __attribute__ ((visibility ("default")))
	43	# else
	44	# define EXPORTED_SYMBOL
	45	# endif
	46	#endif
	47
	48	/* Use these to make sure the functions and variables the IPA needs to
	49	export (symbols GDBserver needs to query GDB about) are visible and
	50	have C linkage.
	51
	52	Tag exported functions with IP_AGENT_EXPORT_FUNC, tag the
	53	definitions of exported variables with IP_AGENT_EXPORT_VAR, and
	54	variable declarations with IP_AGENT_EXPORT_VAR_DECL. Variables
	55	must also be exported with C linkage. As we can't both use extern
	56	"C" and initialize a variable in the same statement, variables that
	57	don't have a separate declaration must use
	58	EXTERN_C_PUSH/EXTERN_C_POP around their definition. */
	59
	60	#ifdef IN_PROCESS_AGENT
	61	# define IP_AGENT_EXPORT_FUNC EXTERN_C EXPORTED_SYMBOL ATTR_NOINLINE ATTR_USED
	62	# define IP_AGENT_EXPORT_VAR EXPORTED_SYMBOL ATTR_USED
	63	# define IP_AGENT_EXPORT_VAR_DECL EXTERN_C EXPORTED_SYMBOL
	64	#else
	65	# define IP_AGENT_EXPORT_FUNC
	66	# define IP_AGENT_EXPORT_VAR
	67	# define IP_AGENT_EXPORT_VAR_DECL extern
	68	#endif
	69
	70	IP_AGENT_EXPORT_VAR_DECL int tracing;
	71
270c6aea PA	72	extern int disconnected_tracing;
	73
	74	void tracepoint_look_up_symbols (void);
	75
	76	void stop_tracing (void);
	77
	78	int handle_tracepoint_general_set (char *own_buf);
	79	int handle_tracepoint_query (char *own_buf);
	80
	81	int tracepoint_finished_step (struct thread_info *tinfo, CORE_ADDR stop_pc);
	82	int tracepoint_was_hit (struct thread_info *tinfo, CORE_ADDR stop_pc);
	83
	84	void release_while_stepping_state_list (struct thread_info *tinfo);
	85
	86	extern int current_traceframe;
	87
	88	int in_readonly_region (CORE_ADDR addr, ULONGEST length);
	89	int traceframe_read_mem (int tfnum, CORE_ADDR addr,
	90	unsigned char *buf, ULONGEST length,
	91	ULONGEST *nbytes);
	92	int fetch_traceframe_registers (int tfnum,
	93	struct regcache *regcache,
	94	int regnum);
	95
	96	int traceframe_read_sdata (int tfnum, ULONGEST offset,
	97	unsigned char *buf, ULONGEST length,
	98	ULONGEST *nbytes);
	99
	100	int traceframe_read_info (int tfnum, struct buffer *buffer);
	101
	102	/* If a thread is determined to be collecting a fast tracepoint, this
	103	structure holds the collect status. */
	104
	105	struct fast_tpoint_collect_status
	106	{
	107	/* The tracepoint that is presently being collected. */
	108	int tpoint_num;
	109	CORE_ADDR tpoint_addr;
	110
	111	/* The address range in the jump pad of where the original
	112	instruction the tracepoint jump was inserted was relocated
	113	to. */
	114	CORE_ADDR adjusted_insn_addr;
	115	CORE_ADDR adjusted_insn_addr_end;
	116	};
	117
229d26fc SM	118	/* The possible states a thread can be in, related to the collection of fast
	119	tracepoint. */
	120
	121	enum class fast_tpoint_collect_result
	122	{
	123	/* Not collecting a fast tracepoint. */
	124	not_collecting,
	125
	126	/* In the jump pad, but before the relocated instruction. */
	127	before_insn,
	128
	129	/* In the jump pad, but at (or after) the relocated instruction. */
	130	at_insn,
	131	};
	132
	133	fast_tpoint_collect_result fast_tracepoint_collecting
	134	(CORE_ADDR thread_area, CORE_ADDR stop_pc,
	135	struct fast_tpoint_collect_status *status);
	136
270c6aea PA	137	void force_unlock_trace_buffer (void);
	138
	139	int handle_tracepoint_bkpts (struct thread_info *tinfo, CORE_ADDR stop_pc);
	140
	141	#ifdef IN_PROCESS_AGENT
	142	void initialize_low_tracepoint (void);
ae91f625	143	const struct target_desc *get_ipa_tdesc (int idx);
270c6aea PA	144	void supply_fast_tracepoint_registers (struct regcache *regcache,
	145	const unsigned char *regs);
	146	void supply_static_tracepoint_registers (struct regcache *regcache,
	147	const unsigned char *regs,
	148	CORE_ADDR pc);
	149	void set_trampoline_buffer_space (CORE_ADDR begin, CORE_ADDR end,
	150	char *errmsg);
a13c4696 MK	151	void *alloc_jump_pad_buffer (size_t size);
	152	#ifndef HAVE_GETAUXVAL
	153	unsigned long getauxval (unsigned long type);
	154	#endif
270c6aea PA	155	#else
	156	void stop_tracing (void);
	157
	158	int claim_trampoline_space (ULONGEST used, CORE_ADDR *trampoline);
	159	int have_fast_tracepoint_trampoline_buffer (char *msgbuf);
	160	void gdb_agent_about_to_close (int pid);
	161	#endif
	162
	163	struct traceframe;
	164	struct eval_agent_expr_context;
	165
	166	/* Do memory copies for bytecodes. */
	167	/* Do the recording of memory blocks for actions and bytecodes. */
	168
	169	int agent_mem_read (struct eval_agent_expr_context *ctx,
	170	unsigned char *to, CORE_ADDR from,
	171	ULONGEST len);
	172
	173	LONGEST agent_get_trace_state_variable_value (int num);
	174	void agent_set_trace_state_variable_value (int num, LONGEST val);
	175
	176	/* Record the value of a trace state variable. */
	177
	178	int agent_tsv_read (struct eval_agent_expr_context *ctx, int n);
	179	int agent_mem_read_string (struct eval_agent_expr_context *ctx,
	180	unsigned char *to,
	181	CORE_ADDR from,
	182	ULONGEST len);
	183
3c14e5a3 PA	184	/* The prototype the get_raw_reg function in the IPA. Each arch's
3c14e5a3 PA	185	bytecode compiler emits calls to this function. */
1cda1512	186	ULONGEST get_raw_reg (const unsigned char *raw_regs, int regnum);
3c14e5a3	187
270c6aea PA	188	/* Returns the address of the get_raw_reg function in the IPA. */
	189	CORE_ADDR get_raw_reg_func_addr (void);
	190	/* Returns the address of the get_trace_state_variable_value
	191	function in the IPA. */
	192	CORE_ADDR get_get_tsv_func_addr (void);
	193	/* Returns the address of the set_trace_state_variable_value
	194	function in the IPA. */
	195	CORE_ADDR get_set_tsv_func_addr (void);
	196
	197	#endif /* TRACEPOINT_H */