gdb/tracepoint.h

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