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   int stopping_tracepoint;
  90
  91   /* Number of traceframes currently in the buffer.  */
  92
  93   int traceframe_count;
  94
  95   /* Number of traceframes created since start of run.  */
  96
  97   int traceframes_created;
  98
  99   /* Total size of the target's trace buffer.  */
 100
 101   int buffer_size;
 102
 103   /* Unused bytes left in the target's trace buffer.  */
 104
 105   int buffer_free;
 106 };
 107
 108 struct trace_status *current_trace_status (void);
 109
 110 extern char *default_collect;
 111
 112 /* Struct to collect random info about tracepoints on the target.  */
 113
 114 struct uploaded_tp {
 115   int number;
 116   enum bptype type;
 117   ULONGEST addr;
 118   int enabled;
 119   int step;
 120   int pass;
 121   int orig_size;
 122   char *cond;
 123   int numactions;
 124   char *actions[100];
 125   int num_step_actions;
 126   char *step_actions[100];
 127   struct uploaded_tp *next;
 128 };
 129
 130 /* Struct recording info about trace state variables on the target.  */
 131
 132 struct uploaded_tsv {
 133   const char *name;
 134   int number;
 135   LONGEST initial_value;
 136   int builtin;
 137   struct uploaded_tsv *next;
 138 };
 139
 140 /* A hook used to notify the UI of tracepoint operations.  */
 141
 142 extern void (*deprecated_trace_find_hook) (char *arg, int from_tty);
 143 extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty);
 144
 145 int get_traceframe_number (void);
 146 void set_traceframe_number (int);
 147 struct cleanup *make_cleanup_restore_current_traceframe (void);
 148
 149 void free_actions (struct breakpoint *);
 150 enum actionline_type validate_actionline (char **, struct breakpoint *);
 151
 152 extern void end_actions_pseudocommand (char *args, int from_tty);
 153 extern void while_stepping_pseudocommand (char *args, int from_tty);
 154
 155 extern struct trace_state_variable *find_trace_state_variable (const char *name);
 156
 157 extern void parse_trace_status (char *line, struct trace_status *ts);
 158
 159 extern void parse_tracepoint_definition (char *line, struct uploaded_tp **utpp);
 160 extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp);
 161
 162 extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
 163                                             struct uploaded_tp **utpp);
 164 extern struct breakpoint *create_tracepoint_from_upload (struct uploaded_tp *utp);
 165 extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
 166 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);
 167
 168 extern void disconnect_or_stop_tracing (int from_tty);
 169
 170 #endif  /* TRACEPOINT_H */