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 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   };
  78
  79 struct trace_status
  80 {
  81   /* This is true if the status is coming from a file rather
  82      than a live target.  */
  83   int from_file;
  84
  85   /* This is true if the value of the running field is known.  */
  86   int running_known;
  87
  88   int running;
  89
  90   enum trace_stop_reason stop_reason;
  91
  92   /* If stop_reason == tracepoint_passcount, the on-target number
  93      of the tracepoint which caused the stop.  */
  94   int stopping_tracepoint;
  95
  96   /* Number of traceframes currently in the buffer.  */
  97
  98   int traceframe_count;
  99
 100   /* Number of traceframes created since start of run.  */
 101
 102   int traceframes_created;
 103
 104   /* Total size of the target's trace buffer.  */
 105
 106   int buffer_size;
 107
 108   /* Unused bytes left in the target's trace buffer.  */
 109
 110   int buffer_free;
 111 };
 112
 113 struct trace_status *current_trace_status (void);
 114
 115 extern char *default_collect;
 116
 117 /* Struct to collect random info about tracepoints on the target.  */
 118
 119 struct uploaded_tp {
 120   int number;
 121   enum bptype type;
 122   ULONGEST addr;
 123   int enabled;
 124   int step;
 125   int pass;
 126   int orig_size;
 127   char *cond;
 128   int numactions;
 129   char *actions[100];
 130   int num_step_actions;
 131   char *step_actions[100];
 132   struct uploaded_tp *next;
 133 };
 134
 135 /* Struct recording info about trace state variables on the target.  */
 136
 137 struct uploaded_tsv {
 138   const char *name;
 139   int number;
 140   LONGEST initial_value;
 141   int builtin;
 142   struct uploaded_tsv *next;
 143 };
 144
 145 /* A hook used to notify the UI of tracepoint operations.  */
 146
 147 extern void (*deprecated_trace_find_hook) (char *arg, int from_tty);
 148 extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty);
 149
 150 int get_traceframe_number (void);
 151 void set_traceframe_number (int);
 152 struct cleanup *make_cleanup_restore_current_traceframe (void);
 153
 154 void free_actions (struct breakpoint *);
 155 enum actionline_type validate_actionline (char **, struct breakpoint *);
 156
 157 extern void end_actions_pseudocommand (char *args, int from_tty);
 158 extern void while_stepping_pseudocommand (char *args, int from_tty);
 159
 160 extern struct trace_state_variable *find_trace_state_variable (const char *name);
 161 extern struct trace_state_variable *create_trace_state_variable (const char *name);
 162
 163 extern void parse_trace_status (char *line, struct trace_status *ts);
 164
 165 extern void parse_tracepoint_definition (char *line, struct uploaded_tp **utpp);
 166 extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp);
 167
 168 extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
 169                                             struct uploaded_tp **utpp);
 170 extern struct breakpoint *create_tracepoint_from_upload (struct uploaded_tp *utp);
 171 extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
 172 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);
 173
 174 extern void disconnect_or_stop_tracing (int from_tty);
 175
 176 extern void start_tracing (void);
 177 extern void stop_tracing (void);
 178
 179 extern void trace_status_mi (int on_stop);
 180
 181 extern void tvariables_info_1 (void);
 182
 183 extern void tfind_1 (enum trace_find_type type, int num,
 184                      ULONGEST addr1, ULONGEST addr2,
 185                      int from_tty);
 186
 187 extern void trace_save (const char *filename, int target_does_save);
 188
 189 #endif  /* TRACEPOINT_H */