1 /* Memory breakpoint interfaces for the remote server for GDB.
2 Copyright (C) 2002-2016 Free Software Foundation, Inc.
4 Contributed by MontaVista Software.
6 This file is part of GDB.
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.
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.
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/>. */
24 #include "break-common.h"
26 /* Breakpoints are opaque. */
28 struct fast_tracepoint_jump;
29 struct raw_breakpoint;
32 #define Z_PACKET_SW_BP '0'
33 #define Z_PACKET_HW_BP '1'
34 #define Z_PACKET_WRITE_WP '2'
35 #define Z_PACKET_READ_WP '3'
36 #define Z_PACKET_ACCESS_WP '4'
38 /* The low level breakpoint types. */
42 /* Software/memory breakpoint. */
45 /* Hardware-assisted breakpoint. */
48 /* Hardware-assisted write watchpoint. */
49 raw_bkpt_type_write_wp,
51 /* Hardware-assisted read watchpoint. */
52 raw_bkpt_type_read_wp,
54 /* Hardware-assisted access watchpoint. */
55 raw_bkpt_type_access_wp
58 /* Map the protocol breakpoint/watchpoint type Z_TYPE to the internal
59 raw breakpoint type. */
61 enum raw_bkpt_type Z_packet_to_raw_bkpt_type (char z_type);
63 /* Map a raw breakpoint type to an enum target_hw_bp_type. */
65 enum target_hw_bp_type raw_bkpt_type_to_target_hw_bp_type
66 (enum raw_bkpt_type raw_type);
68 /* Create a new GDB breakpoint of type Z_TYPE at ADDR with kind KIND.
69 Returns a pointer to the newly created breakpoint on success. On
70 failure returns NULL and sets *ERR to either -1 for error, or 1 if
71 Z_TYPE breakpoints are not supported on this target. */
73 struct breakpoint *set_gdb_breakpoint (char z_type, CORE_ADDR addr, int kind,
76 /* Delete a GDB breakpoint of type Z_TYPE and kind KIND previously
77 inserted at ADDR with set_gdb_breakpoint_at. Returns 0 on success,
78 -1 on error, and 1 if Z_TYPE breakpoints are not supported on this
81 int delete_gdb_breakpoint (char z_type, CORE_ADDR addr, int kind);
83 /* Returns TRUE if there's a software or hardware (code) breakpoint at
84 ADDR in our tables, inserted, or not. */
86 int breakpoint_here (CORE_ADDR addr);
88 /* Returns TRUE if there's any inserted software or hardware (code)
89 breakpoint set at ADDR. */
91 int breakpoint_inserted_here (CORE_ADDR addr);
93 /* Returns TRUE if there's any inserted software breakpoint at
96 int software_breakpoint_inserted_here (CORE_ADDR addr);
98 /* Returns TRUE if there's any inserted hardware (code) breakpoint at
101 int hardware_breakpoint_inserted_here (CORE_ADDR addr);
103 /* Returns TRUE if there's any reinsert breakpoint at ADDR. */
105 int reinsert_breakpoint_inserted_here (CORE_ADDR addr);
107 /* Clear all breakpoint conditions and commands associated with a
110 void clear_breakpoint_conditions_and_commands (struct breakpoint *bp);
112 /* Set target-side condition CONDITION to the breakpoint at ADDR.
113 Returns false on failure. On success, advances CONDITION pointer
114 past the condition and returns true. */
116 int add_breakpoint_condition (struct breakpoint *bp, char **condition);
118 /* Set target-side commands COMMANDS to the breakpoint at ADDR.
119 Returns false on failure. On success, advances COMMANDS past the
120 commands and returns true. If PERSIST, the commands should run
121 even while GDB is disconnected. */
123 int add_breakpoint_commands (struct breakpoint *bp, char **commands,
126 int any_persistent_commands (void);
128 /* Evaluation condition (if any) at breakpoint BP. Return 1 if
129 true and 0 otherwise. */
131 int gdb_condition_true_at_breakpoint (CORE_ADDR where);
133 int gdb_no_commands_at_breakpoint (CORE_ADDR where);
135 void run_breakpoint_commands (CORE_ADDR where);
137 /* Returns TRUE if there's a GDB breakpoint (Z0 or Z1) set at
140 int gdb_breakpoint_here (CORE_ADDR where);
142 /* Create a new breakpoint at WHERE, and call HANDLER when
143 it is hit. HANDLER should return 1 if the breakpoint
144 should be deleted, 0 otherwise. */
146 struct breakpoint *set_breakpoint_at (CORE_ADDR where,
147 int (*handler) (CORE_ADDR));
149 /* Delete a breakpoint. */
151 int delete_breakpoint (struct breakpoint *bkpt);
153 /* Set a reinsert breakpoint at STOP_AT. */
155 void set_reinsert_breakpoint (CORE_ADDR stop_at);
157 /* Delete all reinsert breakpoints. */
159 void delete_reinsert_breakpoints (void);
161 /* Reinsert breakpoints at WHERE (and change their status to
164 void reinsert_breakpoints_at (CORE_ADDR where);
166 /* Uninsert breakpoints at WHERE (and change their status to
167 uninserted). This still leaves the breakpoints in the table. */
169 void uninsert_breakpoints_at (CORE_ADDR where);
171 /* Reinsert all breakpoints of the current process (and change their
172 status to inserted). */
174 void reinsert_all_breakpoints (void);
176 /* Uninsert all breakpoints of the current process (and change their
177 status to uninserted). This still leaves the breakpoints in the
180 void uninsert_all_breakpoints (void);
182 /* See if any breakpoint claims ownership of STOP_PC. Call the handler for
183 the breakpoint, if found. */
185 void check_breakpoints (CORE_ADDR stop_pc);
187 /* See if any breakpoints shadow the target memory area from MEM_ADDR
188 to MEM_ADDR + MEM_LEN. Update the data already read from the target
189 (in BUF) if necessary. */
191 void check_mem_read (CORE_ADDR mem_addr, unsigned char *buf, int mem_len);
193 /* See if any breakpoints shadow the target memory area from MEM_ADDR
194 to MEM_ADDR + MEM_LEN. Update the data to be written to the target
195 (in BUF, a copy of MYADDR on entry) if necessary, as well as the
196 original data for any breakpoints. */
198 void check_mem_write (CORE_ADDR mem_addr,
199 unsigned char *buf, const unsigned char *myaddr, int mem_len);
201 /* Delete all breakpoints. */
203 void delete_all_breakpoints (void);
205 /* Clear the "inserted" flag in all breakpoints of PROC. */
207 void mark_breakpoints_out (struct process_info *proc);
209 /* Delete all breakpoints, but do not try to un-insert them from the
212 void free_all_breakpoints (struct process_info *proc);
214 /* Check if breakpoints still seem to be inserted in the inferior. */
216 void validate_breakpoints (void);
218 /* Insert a fast tracepoint jump at WHERE, using instruction INSN, of
221 struct fast_tracepoint_jump *set_fast_tracepoint_jump (CORE_ADDR where,
225 /* Increment reference counter of JP. */
226 void inc_ref_fast_tracepoint_jump (struct fast_tracepoint_jump *jp);
228 /* Delete fast tracepoint jump TODEL from our tables, and uninsert if
231 int delete_fast_tracepoint_jump (struct fast_tracepoint_jump *todel);
233 /* Returns true if there's fast tracepoint jump set at WHERE. */
235 int fast_tracepoint_jump_here (CORE_ADDR);
237 /* Uninsert fast tracepoint jumps at WHERE (and change their status to
238 uninserted). This still leaves the tracepoints in the table. */
240 void uninsert_fast_tracepoint_jumps_at (CORE_ADDR pc);
242 /* Reinsert fast tracepoint jumps at WHERE (and change their status to
245 void reinsert_fast_tracepoint_jumps_at (CORE_ADDR where);
247 /* Insert a memory breakpoint. */
249 int insert_memory_breakpoint (struct raw_breakpoint *bp);
251 /* Remove a previously inserted memory breakpoint. */
253 int remove_memory_breakpoint (struct raw_breakpoint *bp);
255 /* Create a new breakpoint list NEW_BKPT_LIST that is a copy of SRC. */
257 void clone_all_breakpoints (struct breakpoint **new_bkpt_list,
258 struct raw_breakpoint **new_raw_bkpt_list,
259 const struct breakpoint *src);
261 #endif /* MEM_BREAK_H */