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