gdb/tracepoint.h

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