gdb/tracepoint.h

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