| 1 | /* Memory breakpoint interfaces for the remote server for GDB. |
| 2 | Copyright (C) 2002-2020 Free Software Foundation, Inc. |
| 3 | |
| 4 | Contributed by MontaVista Software. |
| 5 | |
| 6 | This file is part of GDB. |
| 7 | |
| 8 | This program is free software; you can redistribute it and/or modify |
| 9 | it under the terms of the GNU General Public License as published by |
| 10 | the Free Software Foundation; either version 3 of the License, or |
| 11 | (at your option) any later version. |
| 12 | |
| 13 | This program is distributed in the hope that it will be useful, |
| 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | GNU General Public License for more details. |
| 17 | |
| 18 | You should have received a copy of the GNU General Public License |
| 19 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
| 20 | |
| 21 | #ifndef GDBSERVER_MEM_BREAK_H |
| 22 | #define GDBSERVER_MEM_BREAK_H |
| 23 | |
| 24 | #include "gdbsupport/break-common.h" |
| 25 | |
| 26 | /* Breakpoints are opaque. */ |
| 27 | struct breakpoint; |
| 28 | struct gdb_breakpoint; |
| 29 | struct fast_tracepoint_jump; |
| 30 | struct raw_breakpoint; |
| 31 | struct process_info; |
| 32 | |
| 33 | #define Z_PACKET_SW_BP '0' |
| 34 | #define Z_PACKET_HW_BP '1' |
| 35 | #define Z_PACKET_WRITE_WP '2' |
| 36 | #define Z_PACKET_READ_WP '3' |
| 37 | #define Z_PACKET_ACCESS_WP '4' |
| 38 | |
| 39 | /* The low level breakpoint types. */ |
| 40 | |
| 41 | enum raw_bkpt_type |
| 42 | { |
| 43 | /* Software/memory breakpoint. */ |
| 44 | raw_bkpt_type_sw, |
| 45 | |
| 46 | /* Hardware-assisted breakpoint. */ |
| 47 | raw_bkpt_type_hw, |
| 48 | |
| 49 | /* Hardware-assisted write watchpoint. */ |
| 50 | raw_bkpt_type_write_wp, |
| 51 | |
| 52 | /* Hardware-assisted read watchpoint. */ |
| 53 | raw_bkpt_type_read_wp, |
| 54 | |
| 55 | /* Hardware-assisted access watchpoint. */ |
| 56 | raw_bkpt_type_access_wp |
| 57 | }; |
| 58 | |
| 59 | /* Map the protocol breakpoint/watchpoint type Z_TYPE to the internal |
| 60 | raw breakpoint type. */ |
| 61 | |
| 62 | enum raw_bkpt_type Z_packet_to_raw_bkpt_type (char z_type); |
| 63 | |
| 64 | /* Map a raw breakpoint type to an enum target_hw_bp_type. */ |
| 65 | |
| 66 | enum target_hw_bp_type raw_bkpt_type_to_target_hw_bp_type |
| 67 | (enum raw_bkpt_type raw_type); |
| 68 | |
| 69 | /* Create a new GDB breakpoint of type Z_TYPE at ADDR with kind KIND. |
| 70 | Returns a pointer to the newly created breakpoint on success. On |
| 71 | failure returns NULL and sets *ERR to either -1 for error, or 1 if |
| 72 | Z_TYPE breakpoints are not supported on this target. */ |
| 73 | |
| 74 | struct gdb_breakpoint *set_gdb_breakpoint (char z_type, CORE_ADDR addr, |
| 75 | int kind, int *err); |
| 76 | |
| 77 | /* Delete a GDB breakpoint of type Z_TYPE and kind KIND previously |
| 78 | inserted at ADDR with set_gdb_breakpoint_at. Returns 0 on success, |
| 79 | -1 on error, and 1 if Z_TYPE breakpoints are not supported on this |
| 80 | target. */ |
| 81 | |
| 82 | int delete_gdb_breakpoint (char z_type, CORE_ADDR addr, int kind); |
| 83 | |
| 84 | /* Returns TRUE if there's a software or hardware (code) breakpoint at |
| 85 | ADDR in our tables, inserted, or not. */ |
| 86 | |
| 87 | int breakpoint_here (CORE_ADDR addr); |
| 88 | |
| 89 | /* Returns TRUE if there's any inserted software or hardware (code) |
| 90 | breakpoint set at ADDR. */ |
| 91 | |
| 92 | int breakpoint_inserted_here (CORE_ADDR addr); |
| 93 | |
| 94 | /* Returns TRUE if there's any inserted software breakpoint at |
| 95 | ADDR. */ |
| 96 | |
| 97 | int software_breakpoint_inserted_here (CORE_ADDR addr); |
| 98 | |
| 99 | /* Returns TRUE if there's any inserted hardware (code) breakpoint at |
| 100 | ADDR. */ |
| 101 | |
| 102 | int hardware_breakpoint_inserted_here (CORE_ADDR addr); |
| 103 | |
| 104 | /* Returns TRUE if there's any single-step breakpoint at ADDR. */ |
| 105 | |
| 106 | int single_step_breakpoint_inserted_here (CORE_ADDR addr); |
| 107 | |
| 108 | /* Clear all breakpoint conditions and commands associated with a |
| 109 | breakpoint. */ |
| 110 | |
| 111 | void clear_breakpoint_conditions_and_commands (struct gdb_breakpoint *bp); |
| 112 | |
| 113 | /* Set target-side condition CONDITION to the breakpoint at ADDR. |
| 114 | Returns false on failure. On success, advances CONDITION pointer |
| 115 | past the condition and returns true. */ |
| 116 | |
| 117 | int add_breakpoint_condition (struct gdb_breakpoint *bp, |
| 118 | const char **condition); |
| 119 | |
| 120 | /* Set target-side commands COMMANDS to the breakpoint at ADDR. |
| 121 | Returns false on failure. On success, advances COMMANDS past the |
| 122 | commands and returns true. If PERSIST, the commands should run |
| 123 | even while GDB is disconnected. */ |
| 124 | |
| 125 | int add_breakpoint_commands (struct gdb_breakpoint *bp, const char **commands, |
| 126 | int persist); |
| 127 | |
| 128 | /* Return true if PROC has any persistent command. */ |
| 129 | bool any_persistent_commands (process_info *proc); |
| 130 | |
| 131 | /* Evaluation condition (if any) at breakpoint BP. Return 1 if |
| 132 | true and 0 otherwise. */ |
| 133 | |
| 134 | int gdb_condition_true_at_breakpoint (CORE_ADDR where); |
| 135 | |
| 136 | int gdb_no_commands_at_breakpoint (CORE_ADDR where); |
| 137 | |
| 138 | void run_breakpoint_commands (CORE_ADDR where); |
| 139 | |
| 140 | /* Returns TRUE if there's a GDB breakpoint (Z0 or Z1) set at |
| 141 | WHERE. */ |
| 142 | |
| 143 | int gdb_breakpoint_here (CORE_ADDR where); |
| 144 | |
| 145 | /* Create a new breakpoint at WHERE, and call HANDLER when |
| 146 | it is hit. HANDLER should return 1 if the breakpoint |
| 147 | should be deleted, 0 otherwise. The type of the created |
| 148 | breakpoint is other_breakpoint. */ |
| 149 | |
| 150 | struct breakpoint *set_breakpoint_at (CORE_ADDR where, |
| 151 | int (*handler) (CORE_ADDR)); |
| 152 | |
| 153 | /* Delete a breakpoint. */ |
| 154 | |
| 155 | int delete_breakpoint (struct breakpoint *bkpt); |
| 156 | |
| 157 | /* Set a single-step breakpoint at STOP_AT for thread represented by |
| 158 | PTID. */ |
| 159 | |
| 160 | void set_single_step_breakpoint (CORE_ADDR stop_at, ptid_t ptid); |
| 161 | |
| 162 | /* Delete all single-step breakpoints of THREAD. */ |
| 163 | |
| 164 | void delete_single_step_breakpoints (struct thread_info *thread); |
| 165 | |
| 166 | /* Reinsert all single-step breakpoints of THREAD. */ |
| 167 | |
| 168 | void reinsert_single_step_breakpoints (struct thread_info *thread); |
| 169 | |
| 170 | /* Uninsert all single-step breakpoints of THREAD. This still leaves |
| 171 | the single-step breakpoints in the table. */ |
| 172 | |
| 173 | void uninsert_single_step_breakpoints (struct thread_info *thread); |
| 174 | |
| 175 | /* Reinsert breakpoints at WHERE (and change their status to |
| 176 | inserted). */ |
| 177 | |
| 178 | void reinsert_breakpoints_at (CORE_ADDR where); |
| 179 | |
| 180 | /* The THREAD has single-step breakpoints or not. */ |
| 181 | |
| 182 | int has_single_step_breakpoints (struct thread_info *thread); |
| 183 | |
| 184 | /* Uninsert breakpoints at WHERE (and change their status to |
| 185 | uninserted). This still leaves the breakpoints in the table. */ |
| 186 | |
| 187 | void uninsert_breakpoints_at (CORE_ADDR where); |
| 188 | |
| 189 | /* Reinsert all breakpoints of the current process (and change their |
| 190 | status to inserted). */ |
| 191 | |
| 192 | void reinsert_all_breakpoints (void); |
| 193 | |
| 194 | /* Uninsert all breakpoints of the current process (and change their |
| 195 | status to uninserted). This still leaves the breakpoints in the |
| 196 | table. */ |
| 197 | |
| 198 | void uninsert_all_breakpoints (void); |
| 199 | |
| 200 | /* See if any breakpoint claims ownership of STOP_PC. Call the handler for |
| 201 | the breakpoint, if found. */ |
| 202 | |
| 203 | void check_breakpoints (CORE_ADDR stop_pc); |
| 204 | |
| 205 | /* See if any breakpoints shadow the target memory area from MEM_ADDR |
| 206 | to MEM_ADDR + MEM_LEN. Update the data already read from the target |
| 207 | (in BUF) if necessary. */ |
| 208 | |
| 209 | void check_mem_read (CORE_ADDR mem_addr, unsigned char *buf, int mem_len); |
| 210 | |
| 211 | /* See if any breakpoints shadow the target memory area from MEM_ADDR |
| 212 | to MEM_ADDR + MEM_LEN. Update the data to be written to the target |
| 213 | (in BUF, a copy of MYADDR on entry) if necessary, as well as the |
| 214 | original data for any breakpoints. */ |
| 215 | |
| 216 | void check_mem_write (CORE_ADDR mem_addr, |
| 217 | unsigned char *buf, const unsigned char *myaddr, int mem_len); |
| 218 | |
| 219 | /* Delete all breakpoints. */ |
| 220 | |
| 221 | void delete_all_breakpoints (void); |
| 222 | |
| 223 | /* Clear the "inserted" flag in all breakpoints of PROC. */ |
| 224 | |
| 225 | void mark_breakpoints_out (struct process_info *proc); |
| 226 | |
| 227 | /* Delete all breakpoints, but do not try to un-insert them from the |
| 228 | inferior. */ |
| 229 | |
| 230 | void free_all_breakpoints (struct process_info *proc); |
| 231 | |
| 232 | /* Check if breakpoints still seem to be inserted in the inferior. */ |
| 233 | |
| 234 | void validate_breakpoints (void); |
| 235 | |
| 236 | /* Insert a fast tracepoint jump at WHERE, using instruction INSN, of |
| 237 | LENGTH bytes. */ |
| 238 | |
| 239 | struct fast_tracepoint_jump *set_fast_tracepoint_jump (CORE_ADDR where, |
| 240 | unsigned char *insn, |
| 241 | ULONGEST length); |
| 242 | |
| 243 | /* Increment reference counter of JP. */ |
| 244 | void inc_ref_fast_tracepoint_jump (struct fast_tracepoint_jump *jp); |
| 245 | |
| 246 | /* Delete fast tracepoint jump TODEL from our tables, and uninsert if |
| 247 | from memory. */ |
| 248 | |
| 249 | int delete_fast_tracepoint_jump (struct fast_tracepoint_jump *todel); |
| 250 | |
| 251 | /* Returns true if there's fast tracepoint jump set at WHERE. */ |
| 252 | |
| 253 | int fast_tracepoint_jump_here (CORE_ADDR); |
| 254 | |
| 255 | /* Uninsert fast tracepoint jumps at WHERE (and change their status to |
| 256 | uninserted). This still leaves the tracepoints in the table. */ |
| 257 | |
| 258 | void uninsert_fast_tracepoint_jumps_at (CORE_ADDR pc); |
| 259 | |
| 260 | /* Reinsert fast tracepoint jumps at WHERE (and change their status to |
| 261 | inserted). */ |
| 262 | |
| 263 | void reinsert_fast_tracepoint_jumps_at (CORE_ADDR where); |
| 264 | |
| 265 | /* Insert a memory breakpoint. */ |
| 266 | |
| 267 | int insert_memory_breakpoint (struct raw_breakpoint *bp); |
| 268 | |
| 269 | /* Remove a previously inserted memory breakpoint. */ |
| 270 | |
| 271 | int remove_memory_breakpoint (struct raw_breakpoint *bp); |
| 272 | |
| 273 | /* Create a new breakpoint list in CHILD_THREAD's process that is a |
| 274 | copy of breakpoint list in PARENT_THREAD's process. */ |
| 275 | |
| 276 | void clone_all_breakpoints (struct thread_info *child_thread, |
| 277 | const struct thread_info *parent_thread); |
| 278 | |
| 279 | #endif /* GDBSERVER_MEM_BREAK_H */ |