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