1 /* Data structures associated with tracepoints in GDB. 2 Copyright (C) 1997, 1998, 1999, 2000, 2007, 2008, 2009, 2010, 2011 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 #include "memrange.h" 26 27 /* A trace state variable is a value managed by a target being 28 traced. A trace state variable (or tsv for short) can be accessed 29 and assigned to by tracepoint actions and conditionals, but is not 30 part of the program being traced, and it doesn't have to be 31 collected. Effectively the variables are scratch space for 32 tracepoints. */ 33 34 struct trace_state_variable 35 { 36 /* The variable's name. The user has to prefix with a dollar sign, 37 but we don't store that internally. */ 38 const char *name; 39 40 /* An id number assigned by GDB, and transmitted to targets. */ 41 int number; 42 43 /* The initial value of a variable is a 64-bit signed integer. */ 44 LONGEST initial_value; 45 46 /* 1 if the value is known, else 0. The value is known during a 47 trace run, or in tfind mode if the variable was collected into 48 the current trace frame. */ 49 int value_known; 50 51 /* The value of a variable is a 64-bit signed integer. */ 52 LONGEST value; 53 54 /* This is true for variables that are predefined and built into 55 the target. */ 56 int builtin; 57 }; 58 59 /* The trace status encompasses various info about the general state 60 of the tracing run. */ 61 62 enum trace_stop_reason 63 { 64 trace_stop_reason_unknown, 65 trace_never_run, 66 tstop_command, 67 trace_buffer_full, 68 trace_disconnected, 69 tracepoint_passcount, 70 tracepoint_error 71 }; 72 73 struct trace_status 74 { 75 /* This is true if the status is coming from a file rather 76 than a live target. */ 77 int from_file; 78 79 /* This is true if the value of the running field is known. */ 80 int running_known; 81 82 int running; 83 84 enum trace_stop_reason stop_reason; 85 86 /* If stop_reason is tracepoint_passcount or tracepoint_error, this 87 is the (on-target) number of the tracepoint which caused the 88 stop. */ 89 int stopping_tracepoint; 90 91 /* If stop_reason is tracepoint_error, this is a human-readable 92 string that describes the error that happened on the target. */ 93 char *error_desc; 94 95 /* Number of traceframes currently in the buffer. */ 96 97 int traceframe_count; 98 99 /* Number of traceframes created since start of run. */ 100 101 int traceframes_created; 102 103 /* Total size of the target's trace buffer. */ 104 105 int buffer_size; 106 107 /* Unused bytes left in the target's trace buffer. */ 108 109 int buffer_free; 110 111 /* 1 if the target will continue tracing after disconnection, else 112 0. If the target does not report a value, assume 0. */ 113 114 int disconnected_tracing; 115 116 /* 1 if the target is using a circular trace buffer, else 0. If the 117 target does not report a value, assume 0. */ 118 119 int circular_buffer; 120 }; 121 122 struct trace_status *current_trace_status (void); 123 124 extern char *default_collect; 125 126 /* Struct to collect random info about tracepoints on the target. */ 127 128 DEF_VEC_P (char_ptr); 129 130 struct uploaded_tp 131 { 132 int number; 133 enum bptype type; 134 ULONGEST addr; 135 int enabled; 136 int step; 137 int pass; 138 int orig_size; 139 140 /* String that is the encoded form of the tracepoint's condition. */ 141 char *cond; 142 143 /* Vectors of strings that are the encoded forms of a tracepoint's 144 actions. */ 145 VEC(char_ptr) *actions; 146 VEC(char_ptr) *step_actions; 147 148 /* The original string defining the location of the tracepoint. */ 149 char *at_string; 150 151 /* The original string defining the tracepoint's condition. */ 152 char *cond_string; 153 154 /* List of original strings defining the tracepoint's actions. */ 155 VEC(char_ptr) *cmd_strings; 156 157 struct uploaded_tp *next; 158 }; 159 160 /* Struct recording info about trace state variables on the target. */ 161 162 struct uploaded_tsv 163 { 164 const char *name; 165 int number; 166 LONGEST initial_value; 167 int builtin; 168 struct uploaded_tsv *next; 169 }; 170 171 /* Struct recording info about a target static tracepoint marker. */ 172 173 struct static_tracepoint_marker 174 { 175 struct gdbarch *gdbarch; 176 CORE_ADDR address; 177 178 /* The string ID of the marker. */ 179 char *str_id; 180 181 /* Extra target reported info associated with the marker. */ 182 char *extra; 183 }; 184 185 extern void parse_static_tracepoint_marker_definition 186 (char *line, char **pp, 187 struct static_tracepoint_marker *marker); 188 extern void release_static_tracepoint_marker (struct static_tracepoint_marker *); 189 190 /* A hook used to notify the UI of tracepoint operations. */ 191 192 extern void (*deprecated_trace_find_hook) (char *arg, int from_tty); 193 extern void (*deprecated_trace_start_stop_hook) (int start, int from_tty); 194 195 /* Returns the current traceframe number. */ 196 extern int get_traceframe_number (void); 197 198 /* Make the traceframe NUM be the current GDB trace frame number, and 199 do nothing more. In particular, this does not flush the 200 register/frame caches or notify the target about the trace frame 201 change, so that is can be used when we need to momentarily access 202 live memory. Targets lazily switch their current traceframe to 203 match GDB's traceframe number, at the appropriate times. */ 204 extern void set_traceframe_number (int); 205 206 /* Make the traceframe NUM be the current trace frame, all the way to 207 the target, and flushes all global state (register/frame caches, 208 etc.). */ 209 extern void set_current_traceframe (int num); 210 211 struct cleanup *make_cleanup_restore_current_traceframe (void); 212 struct cleanup *make_cleanup_restore_traceframe_number (void); 213 214 void free_actions (struct breakpoint *); 215 extern void validate_actionline (char **, struct breakpoint *); 216 217 extern void end_actions_pseudocommand (char *args, int from_tty); 218 extern void while_stepping_pseudocommand (char *args, int from_tty); 219 220 extern struct trace_state_variable *find_trace_state_variable (const char *name); 221 extern struct trace_state_variable *create_trace_state_variable (const char *name); 222 223 extern int encode_source_string (int num, ULONGEST addr, 224 char *srctype, char *src, 225 char *buf, int buf_size); 226 227 extern void parse_trace_status (char *line, struct trace_status *ts); 228 229 extern void parse_tracepoint_definition (char *line, 230 struct uploaded_tp **utpp); 231 extern void parse_tsv_definition (char *line, struct uploaded_tsv **utsvp); 232 233 extern struct uploaded_tp *get_uploaded_tp (int num, ULONGEST addr, 234 struct uploaded_tp **utpp); 235 extern struct breakpoint *create_tracepoint_from_upload (struct uploaded_tp *utp); 236 extern void merge_uploaded_tracepoints (struct uploaded_tp **utpp); 237 extern void merge_uploaded_trace_state_variables (struct uploaded_tsv **utsvp); 238 239 extern void disconnect_tracing (int from_tty); 240 241 extern void start_tracing (void); 242 extern void stop_tracing (void); 243 244 extern void trace_status_mi (int on_stop); 245 246 extern void tvariables_info_1 (void); 247 extern void save_trace_state_variables (struct ui_file *fp); 248 249 extern void tfind_1 (enum trace_find_type type, int num, 250 ULONGEST addr1, ULONGEST addr2, 251 int from_tty); 252 253 extern void trace_save (const char *filename, int target_does_save); 254 255 extern struct traceframe_info *parse_traceframe_info (const char *tframe_info); 256 257 extern int traceframe_available_memory (VEC(mem_range_s) **result, 258 CORE_ADDR memaddr, ULONGEST len); 259 260 #endif /* TRACEPOINT_H */ 261