gdb/tracepoint.h

   1 /* Data structures associated with tracepoints in GDB.
   2    Copyright (C) 1997-2017 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #if !defined (TRACEPOINT_H)
  20 #define TRACEPOINT_H 1
  21
  22 #include "breakpoint.h"
  23 #include "target.h"
  24 #include "memrange.h"
  25 #include "gdb_vecs.h"
  26
  27 #include <vector>
  28 #include <string>
  29
  30 /* An object describing the contents of a traceframe.  */
  31
  32 struct traceframe_info
  33 {
  34   /* Collected memory.  */
  35   VEC(mem_range_s) *memory;
  36
  37   /* Collected trace state variables.  */
  38   VEC(int) *tvars;
  39 };
  40
  41 /* A trace state variable is a value managed by a target being
  42    traced.  A trace state variable (or tsv for short) can be accessed
  43    and assigned to by tracepoint actions and conditionals, but is not
  44    part of the program being traced, and it doesn't have to be
  45    collected.  Effectively the variables are scratch space for
  46    tracepoints.  */
  47
  48 struct trace_state_variable
  49   {
  50     /* The variable's name.  The user has to prefix with a dollar sign,
  51        but we don't store that internally.  */
  52     const char *name;
  53
  54     /* An id number assigned by GDB, and transmitted to targets.  */
  55     int number;
  56
  57     /* The initial value of a variable is a 64-bit signed integer.  */
  58     LONGEST initial_value;
  59
  60     /* 1 if the value is known, else 0.  The value is known during a
  61        trace run, or in tfind mode if the variable was collected into
  62        the current trace frame.  */
  63     int value_known;
  64
  65     /* The value of a variable is a 64-bit signed integer.  */
  66     LONGEST value;
  67
  68     /* This is true for variables that are predefined and built into
  69        the target.  */
  70     int builtin;
  71    };
  72
  73 /* The trace status encompasses various info about the general state
  74    of the tracing run.  */
  75
  76 enum trace_stop_reason
  77   {
  78     trace_stop_reason_unknown,
  79     trace_never_run,
  80     trace_stop_command,
  81     trace_buffer_full,
  82     trace_disconnected,
  83     tracepoint_passcount,
  84     tracepoint_error
  85   };
  86
  87 struct trace_status
  88 {
  89   /* If the status is coming from a file rather than a live target,
  90      this points at the file's filename.  Otherwise, this is NULL.  */
  91   const char *filename;
  92
  93   /* This is true if the value of the running field is known.  */
  94   int running_known;
  95
  96   /* This is true when the trace experiment is actually running.  */
  97   int running;
  98
  99   enum trace_stop_reason stop_reason;
 100
 101   /* If stop_reason is tracepoint_passcount or tracepoint_error, this
 102      is the (on-target) number of the tracepoint which caused the
 103      stop.  */
 104   int stopping_tracepoint;
 105
 106   /* If stop_reason is tstop_command or tracepoint_error, this is an
 107      arbitrary string that may describe the reason for the stop in
 108      more detail.  */
 109
 110   char *stop_desc;
 111
 112   /* Number of traceframes currently in the buffer.  */
 113
 114   int traceframe_count;
 115
 116   /* Number of traceframes created since start of run.  */
 117
 118   int traceframes_created;
 119
 120   /* Total size of the target's trace buffer.  */
 121
 122   int buffer_size;
 123
 124   /* Unused bytes left in the target's trace buffer.  */
 125
 126   int buffer_free;
 127
 128   /* 1 if the target will continue tracing after disconnection, else
 129      0.  If the target does not report a value, assume 0.  */
 130
 131   int disconnected_tracing;
 132
 133   /* 1 if the target is using a circular trace buffer, else 0.  If the
 134      target does not report a value, assume 0.  */
 135
 136   int circular_buffer;
 137
 138   /* The "name" of the person running the trace.  This is an
 139      arbitrary string.  */
 140
 141   char *user_name;
 142
 143   /* "Notes" about the trace.  This is an arbitrary string not
 144      interpreted by GDBserver in any special way.  */
 145
 146   char *notes;
 147
 148   /* The calendar times at which the trace run started and stopped,
 149      both expressed in microseconds of Unix time.  */
 150
 151   LONGEST start_time;
 152   LONGEST stop_time;
 153 };
 154
 155 struct trace_status *current_trace_status (void);
 156
 157 extern char *default_collect;
 158
 159 extern int trace_regblock_size;
 160
 161 extern const char *stop_reason_names[];
 162
 163 /* Struct to collect random info about tracepoints on the target.  */
 164
 165 struct uploaded_tp
 166 {
 167   int number;
 168   enum bptype type;
 169   ULONGEST addr;
 170   int enabled;
 171   int step;
 172   int pass;
 173   int orig_size;
 174
 175   /* String that is the encoded form of the tracepoint's condition.  */
 176   char *cond;
 177
 178   /* Vectors of strings that are the encoded forms of a tracepoint's
 179      actions.  */
 180   VEC(char_ptr) *actions;
 181   VEC(char_ptr) *step_actions;
 182
 183   /* The original string defining the location of the tracepoint.  */
 184   char *at_string;
 185
 186   /* The original string defining the tracepoint's condition.  */
 187   char *cond_string;
 188
 189   /* List of original strings defining the tracepoint's actions.  */
 190   VEC(char_ptr) *cmd_strings;
 191
 192   /* The tracepoint's current hit count.  */
 193   int hit_count;
 194
 195   /* The tracepoint's current traceframe usage.  */
 196   ULONGEST traceframe_usage;
 197
 198   struct uploaded_tp *next;
 199 };
 200
 201 /* Struct recording info about trace state variables on the target.  */
 202
 203 struct uploaded_tsv
 204 {
 205   const char *name;
 206   int number;
 207   LONGEST initial_value;
 208   int builtin;
 209   struct uploaded_tsv *next;
 210 };
 211
 212 /* Struct recording info about a target static tracepoint marker.  */
 213
 214 struct static_tracepoint_marker
 215 {
 216   struct gdbarch *gdbarch;
 217   CORE_ADDR address;
 218
 219   /* The string ID of the marker.  */
 220   char *str_id;
 221
 222   /* Extra target reported info associated with the marker.  */
 223   char *extra;
 224 };
 225
 226 struct memrange
 227 {
 228   memrange (int type_, bfd_signed_vma start_, bfd_signed_vma end_)
 229     : type (type_), start (start_), end (end_)
 230   {}
 231
 232   memrange ()
 233   {}
 234
 235   /* memrange_absolute for absolute memory range, else basereg
 236      number.  */
 237   int type;
 238   bfd_signed_vma start;
 239   bfd_signed_vma end;
 240 };
 241
 242 class collection_list
 243 {
 244 public:
 245   collection_list ();
 246
 247   void add_wholly_collected (const char *print_name);
 248
 249   void append_exp (struct expression *exp);
 250
 251   /* Add AEXPR to the list, taking ownership.  */
 252   void add_aexpr (agent_expr_up aexpr);
 253
 254   void add_register (unsigned int regno);
 255   void add_memrange (struct gdbarch *gdbarch,
 256                      int type, bfd_signed_vma base,
 257                      unsigned long len);
 258   void collect_symbol (struct symbol *sym,
 259                        struct gdbarch *gdbarch,
 260                        long frame_regno, long frame_offset,
 261                        CORE_ADDR scope,
 262                        int trace_string);
 263
 264   void add_local_symbols (struct gdbarch *gdbarch, CORE_ADDR pc,
 265                           long frame_regno, long frame_offset, int type,
 266                           int trace_string);
 267   void add_static_trace_data ();
 268
 269   void finish ();
 270
 271   char **stringify ();
 272
 273   const std::vector<std::string> &wholly_collected ()
 274   { return m_wholly_collected; }
 275
 276   const std::vector<std::string> &computed ()
 277   { return m_computed; }
 278
 279 private:
 280   /* room for up to 256 regs */
 281   unsigned char m_regs_mask[32];
 282
 283   std::vector<memrange> m_memranges;
 284
 285   std::vector<agent_expr_up> m_aexprs;
 286
 287   /* True is the user requested a collection of "$_sdata", "static
 288      tracepoint data".  */
 289   bool m_strace_data;
 290
 291   /* A set of names of wholly collected objects.  */
 292   std::vector<std::string> m_wholly_collected;
 293   /* A set of computed expressions.  */
 294   std::vector<std::string> m_computed;
 295 };
 296
 297 extern void parse_static_tracepoint_marker_definition
 298   (char *line, char **pp,
 299    struct static_tracepoint_marker *marker);
 300 extern void release_static_tracepoint_marker (struct static_tracepoint_marker *);
 301 extern void free_current_marker (void *arg);
 302
 303 /* A hook used to notify the UI of tracepoint operations.  */
 304
 305 extern void (*deprecated_trace_find_hook) (char *arg, int from_tty);
 306 extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty);
 307
 308 /* Returns the current traceframe number.  */
 309 extern int get_traceframe_number (void);
 310
 311 /* Returns the tracepoint number for current traceframe.  */
 312 extern int get_tracepoint_number (void);
 313
 314 /* Make the traceframe NUM be the current trace frame, all the way to
 315    the target, and flushes all global state (register/frame caches,
 316    etc.).  */
 317 extern void set_current_traceframe (int num);
 318
 319 struct cleanup *make_cleanup_restore_current_traceframe (void);
 320
 321 void free_actions (struct breakpoint *);
 322
 323 extern const char *decode_agent_options (const char *exp, int *trace_string);
 324
 325 extern void encode_actions (struct bp_location *tloc,
 326                             struct collection_list *tracepoint_list,
 327                             struct collection_list *stepping_list);
 328
 329 extern void encode_actions_rsp (struct bp_location *tloc,
 330                                 char ***tdp_actions, char ***stepping_actions);
 331
 332 extern void validate_actionline (const char *, struct breakpoint *);
 333 extern void validate_trace_state_variable_name (const char *name);
 334
 335 extern struct trace_state_variable *find_trace_state_variable (const char *name);
 336 extern struct trace_state_variable *
 337   find_trace_state_variable_by_number (int number);
 338
 339 extern struct trace_state_variable *create_trace_state_variable (const char *name);
 340
 341 extern int encode_source_string (int num, ULONGEST addr,
 342                                  char *srctype, const char *src,
 343                                  char *buf, int buf_size);
 344
 345 extern void parse_trace_status (char *line, struct trace_status *ts);
 346
 347 extern void parse_tracepoint_status (char *p, struct breakpoint *tp,
 348                                      struct uploaded_tp *utp);
 349
 350 extern void parse_tracepoint_definition (char *line,
 351                                          struct uploaded_tp **utpp);
 352 extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp);
 353
 354 extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr,
 355                                             struct uploaded_tp **utpp);
 356 extern void free_uploaded_tps (struct uploaded_tp **utpp);
 357
 358 extern struct uploaded_tsv *get_uploaded_tsv (int num,
 359                                               struct uploaded_tsv **utsvp);
 360 extern void free_uploaded_tsvs (struct uploaded_tsv **utsvp);
 361 extern struct tracepoint *create_tracepoint_from_upload (struct uploaded_tp *utp);
 362 extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp);
 363 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp);
 364
 365 extern void query_if_trace_running (int from_tty);
 366 extern void disconnect_tracing (void);
 367 extern void trace_reset_local_state (void);
 368
 369 extern void check_trace_running (struct trace_status *);
 370
 371 extern void start_tracing (char *notes);
 372 extern void stop_tracing (char *notes);
 373
 374 extern void trace_status_mi (int on_stop);
 375
 376 extern void tvariables_info_1 (void);
 377 extern void save_trace_state_variables (struct ui_file *fp);
 378
 379 extern void tfind_1 (enum trace_find_type type, int num,
 380                      CORE_ADDR addr1, CORE_ADDR addr2,
 381                      int from_tty);
 382
 383 extern void trace_save_tfile (const char *filename,
 384                               int target_does_save);
 385 extern void trace_save_ctf (const char *dirname,
 386                             int target_does_save);
 387
 388 extern struct traceframe_info *parse_traceframe_info (const char *tframe_info);
 389
 390 extern int traceframe_available_memory (VEC(mem_range_s) **result,
 391                                         CORE_ADDR memaddr, ULONGEST len);
 392
 393 extern struct traceframe_info *get_traceframe_info (void);
 394
 395 extern struct bp_location *get_traceframe_location (int *stepping_frame_p);
 396
 397 #endif  /* TRACEPOINT_H */