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

/* Data structures associated with tracepoints in GDB.
   Copyright (C) 1997, 1998, 1999, 2000, 2007, 2008, 2009, 2010
   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 (TRACEPOINT_H)
#define TRACEPOINT_H 1

#include "breakpoint.h"
#include "target.h"

enum actionline_type
  {
    BADLINE = -1,
    GENERIC = 0,
    END = 1,
    STEPPING = 2
  };

/* A trace state variable is a value managed by a target being
   traced. A trace state variable (or tsv for short) can be accessed
   and assigned to by tracepoint actions and conditionals, but is not
   part of the program being traced, and it doesn't have to be
   collected. Effectively the variables are scratch space for
   tracepoints.  */

struct trace_state_variable
  {
    /* The variable's name.  The user has to prefix with a dollar sign,
       but we don't store that internally.  */
    const char *name;

    /* An id number assigned by GDB, and transmitted to targets.  */
    int number;

    /* The initial value of a variable is a 64-bit signed integer.  */
    LONGEST initial_value;

    /* 1 if the value is known, else 0.  The value is known during a
       trace run, or in tfind mode if the variable was collected into
       the current trace frame.  */
    int value_known;

    /* The value of a variable is a 64-bit signed integer.  */
    LONGEST value;

    /* This is true for variables that are predefined and built into
       the target.  */
    int builtin;
   };

/* The trace status encompasses various info about the general state
   of the tracing run.  */

enum trace_stop_reason
  {
    trace_stop_reason_unknown,
    trace_never_run,
    tstop_command,
    trace_buffer_full,
    trace_disconnected,
    tracepoint_passcount,
    tracepoint_error
  };

struct trace_status
{
  /* This is true if the status is coming from a file rather
     than a live target.  */
  int from_file;

  /* This is true if the value of the running field is known.  */
  int running_known;

  int running;

  enum trace_stop_reason stop_reason;

  /* If stop_reason is tracepoint_passcount or tracepoint_error, this
     is the (on-target) number of the tracepoint which caused the
     stop.  */
  int stopping_tracepoint;

  /* If stop_reason is tracepoint_error, this is a human-readable
     string that describes the error that happened on the target.  */
  char *error_desc;

  /* Number of traceframes currently in the buffer.  */

  int traceframe_count;

  /* Number of traceframes created since start of run.  */

  int traceframes_created;

  /* Total size of the target's trace buffer.  */

  int buffer_size;

  /* Unused bytes left in the target's trace buffer.  */

  int buffer_free;
};

struct trace_status *current_trace_status (void);

extern char *default_collect;

/* Struct to collect random info about tracepoints on the target.  */

struct uploaded_string
{
  char *str;
  struct uploaded_string *next;
};

struct uploaded_tp
{
  int number;
  enum bptype type;
  ULONGEST addr;
  int enabled;
  int step;
  int pass;
  int orig_size;
  char *cond;
  int numactions;
  char *actions[100];
  int num_step_actions;
  char *step_actions[100];

  /* The original string defining the location of the tracepoint.  */
  char *at_string;

  /* The original string defining the tracepoint's condition.  */
  char *cond_string;

  /* List of original strings defining the tracepoint's actions.  */
  struct uploaded_string *cmd_strings;

  struct uploaded_tp *next;
};

/* Struct recording info about trace state variables on the target.  */

struct uploaded_tsv
{
  const char *name;
  int number;
  LONGEST initial_value;
  int builtin;
  struct uploaded_tsv *next;
};

/* A hook used to notify the UI of tracepoint operations.  */

extern void (*deprecated_trace_find_hook) (char *arg, int from_tty);
extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty);

int get_traceframe_number (void);
void set_traceframe_number (int);
struct cleanup *make_cleanup_restore_current_traceframe (void);

void free_actions (struct breakpoint *);
enum actionline_type validate_actionline (char **, struct breakpoint *);

extern void end_actions_pseudocommand (char *args, int from_tty);
extern void while_stepping_pseudocommand (char *args, int from_tty);

extern struct trace_state_variable *find_trace_state_variable (const char *name);
extern struct trace_state_variable *create_trace_state_variable (const char *name);

extern int encode_source_string (int num, ULONGEST addr,
				 char *srctype, char *src,
				 char *buf, int buf_size);

extern void parse_trace_status (char *line, struct trace_status *ts);

extern void parse_tracepoint_definition (char *line, struct uploaded_tp **utpp);
extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp);

extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
					    struct uploaded_tp **utpp);
extern struct breakpoint *create_tracepoint_from_upload (struct uploaded_tp *utp);
extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);

extern void disconnect_or_stop_tracing (int from_tty);

extern void start_tracing (void);
extern void stop_tracing (void);

extern void trace_status_mi (int on_stop);

extern void tvariables_info_1 (void);
extern void save_trace_state_variables (struct ui_file *fp);

extern void tfind_1 (enum trace_find_type type, int num,
		     ULONGEST addr1, ULONGEST addr2,
		     int from_tty);

extern void trace_save (const char *filename, int target_does_save);

#endif	/* TRACEPOINT_H */
Commit	Line	Data
	1	/* Data structures associated with tracepoints in GDB.
	2	Copyright (C) 1997, 1998, 1999, 2000, 2007, 2008, 2009, 2010
	3	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	#if !defined (TRACEPOINT_H)
	21	#define TRACEPOINT_H 1
	22
	23	#include "breakpoint.h"
	24	#include "target.h"
	25
	26	enum actionline_type
	27	{
	28	BADLINE = -1,
	29	GENERIC = 0,
	30	END = 1,
	31	STEPPING = 2
	32	};
	33
	34	/* A trace state variable is a value managed by a target being
	35	traced. A trace state variable (or tsv for short) can be accessed
	36	and assigned to by tracepoint actions and conditionals, but is not
	37	part of the program being traced, and it doesn't have to be
	38	collected. Effectively the variables are scratch space for
	39	tracepoints. */
	40
	41	struct trace_state_variable
	42	{
	43	/* The variable's name. The user has to prefix with a dollar sign,
	44	but we don't store that internally. */
	45	const char *name;
	46
	47	/* An id number assigned by GDB, and transmitted to targets. */
	48	int number;
	49
	50	/* The initial value of a variable is a 64-bit signed integer. */
	51	LONGEST initial_value;
	52
	53	/* 1 if the value is known, else 0. The value is known during a
	54	trace run, or in tfind mode if the variable was collected into
	55	the current trace frame. */
	56	int value_known;
	57
	58	/* The value of a variable is a 64-bit signed integer. */
	59	LONGEST value;
	60
	61	/* This is true for variables that are predefined and built into
	62	the target. */
	63	int builtin;
	64	};
	65
	66	/* The trace status encompasses various info about the general state
	67	of the tracing run. */
	68
	69	enum trace_stop_reason
	70	{
	71	trace_stop_reason_unknown,
	72	trace_never_run,
	73	tstop_command,
	74	trace_buffer_full,
	75	trace_disconnected,
	76	tracepoint_passcount,
	77	tracepoint_error
	78	};
	79
	80	struct trace_status
	81	{
	82	/* This is true if the status is coming from a file rather
	83	than a live target. */
	84	int from_file;
	85
	86	/* This is true if the value of the running field is known. */
	87	int running_known;
	88
	89	int running;
	90
	91	enum trace_stop_reason stop_reason;
	92
	93	/* If stop_reason is tracepoint_passcount or tracepoint_error, this
	94	is the (on-target) number of the tracepoint which caused the
	95	stop. */
	96	int stopping_tracepoint;
	97
	98	/* If stop_reason is tracepoint_error, this is a human-readable
	99	string that describes the error that happened on the target. */
	100	char *error_desc;
	101
	102	/* Number of traceframes currently in the buffer. */
	103
	104	int traceframe_count;
	105
	106	/* Number of traceframes created since start of run. */
	107
	108	int traceframes_created;
	109
	110	/* Total size of the target's trace buffer. */
	111
	112	int buffer_size;
	113
	114	/* Unused bytes left in the target's trace buffer. */
	115
	116	int buffer_free;
	117	};
	118
	119	struct trace_status *current_trace_status (void);
	120
	121	extern char *default_collect;
	122
	123	/* Struct to collect random info about tracepoints on the target. */
	124
	125	struct uploaded_string
	126	{
	127	char *str;
	128	struct uploaded_string *next;
	129	};
	130
	131	struct uploaded_tp
	132	{
	133	int number;
	134	enum bptype type;
	135	ULONGEST addr;
	136	int enabled;
	137	int step;
	138	int pass;
	139	int orig_size;
	140	char *cond;
	141	int numactions;
	142	char *actions[100];
	143	int num_step_actions;
	144	char *step_actions[100];
	145
	146	/* The original string defining the location of the tracepoint. */
	147	char *at_string;
	148
	149	/* The original string defining the tracepoint's condition. */
	150	char *cond_string;
	151
	152	/* List of original strings defining the tracepoint's actions. */
	153	struct uploaded_string *cmd_strings;
	154
	155	struct uploaded_tp *next;
	156	};
	157
	158	/* Struct recording info about trace state variables on the target. */
	159
	160	struct uploaded_tsv
	161	{
	162	const char *name;
	163	int number;
	164	LONGEST initial_value;
	165	int builtin;
	166	struct uploaded_tsv *next;
	167	};
	168
	169	/* A hook used to notify the UI of tracepoint operations. */
	170
	171	extern void (deprecated_trace_find_hook) (char arg, int from_tty);
	172	extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty);
	173
	174	int get_traceframe_number (void);
	175	void set_traceframe_number (int);
	176	struct cleanup *make_cleanup_restore_current_traceframe (void);
	177
	178	void free_actions (struct breakpoint *);
	179	enum actionline_type validate_actionline (char *, struct breakpoint );
	180
	181	extern void end_actions_pseudocommand (char *args, int from_tty);
	182	extern void while_stepping_pseudocommand (char *args, int from_tty);
	183
	184	extern struct trace_state_variable find_trace_state_variable (const char name);
	185	extern struct trace_state_variable create_trace_state_variable (const char name);
	186
	187	extern int encode_source_string (int num, ULONGEST addr,
	188	char srctype, char src,
	189	char *buf, int buf_size);
	190
	191	extern void parse_trace_status (char line, struct trace_status ts);
	192
	193	extern void parse_tracepoint_definition (char line, struct uploaded_tp *utpp);
	194	extern void parse_tsv_definition (char line, struct uploaded_tsv *utsvp);
	195
	196	extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
	197	struct uploaded_tp **utpp);
	198	extern struct breakpoint create_tracepoint_from_upload (struct uploaded_tp utp);
	199	extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
	200	extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);
	201
	202	extern void disconnect_or_stop_tracing (int from_tty);
	203
	204	extern void start_tracing (void);
	205	extern void stop_tracing (void);
	206
	207	extern void trace_status_mi (int on_stop);
	208
	209	extern void tvariables_info_1 (void);
	210	extern void save_trace_state_variables (struct ui_file *fp);
	211
	212	extern void tfind_1 (enum trace_find_type type, int num,
	213	ULONGEST addr1, ULONGEST addr2,
	214	int from_tty);
	215
	216	extern void trace_save (const char *filename, int target_does_save);
	217
	218	#endif /* TRACEPOINT_H */