gdb/gdbserver/mem-break.h

   1 /* Memory breakpoint interfaces for the remote server for GDB.
   2    Copyright (C) 2002-2016 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 MEM_BREAK_H
  22 #define MEM_BREAK_H
  23
  24 #include "break-common.h"
  25
  26 /* Breakpoints are opaque.  */
  27 struct breakpoint;
  28 struct fast_tracepoint_jump;
  29 struct raw_breakpoint;
  30 struct process_info;
  31
  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'
  37
  38 /* The low level breakpoint types.  */
  39
  40 enum raw_bkpt_type
  41   {
  42     /* Software/memory breakpoint.  */
  43     raw_bkpt_type_sw,
  44
  45     /* Hardware-assisted breakpoint.  */
  46     raw_bkpt_type_hw,
  47
  48     /* Hardware-assisted write watchpoint.  */
  49     raw_bkpt_type_write_wp,
  50
  51     /* Hardware-assisted read watchpoint.  */
  52     raw_bkpt_type_read_wp,
  53
  54     /* Hardware-assisted access watchpoint.  */
  55     raw_bkpt_type_access_wp
  56   };
  57
  58 /* Map the protocol breakpoint/watchpoint type Z_TYPE to the internal
  59    raw breakpoint type.  */
  60
  61 enum raw_bkpt_type Z_packet_to_raw_bkpt_type (char z_type);
  62
  63 /* Map a raw breakpoint type to an enum target_hw_bp_type.  */
  64
  65 enum target_hw_bp_type raw_bkpt_type_to_target_hw_bp_type
  66   (enum raw_bkpt_type raw_type);
  67
  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.  */
  72
  73 struct breakpoint *set_gdb_breakpoint (char z_type, CORE_ADDR addr, int kind,
  74                                        int *err);
  75
  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
  79    target.  */
  80
  81 int delete_gdb_breakpoint (char z_type, CORE_ADDR addr, int kind);
  82
  83 /* Returns TRUE if there's a software or hardware (code) breakpoint at
  84    ADDR in our tables, inserted, or not.  */
  85
  86 int breakpoint_here (CORE_ADDR addr);
  87
  88 /* Returns TRUE if there's any inserted software or hardware (code)
  89    breakpoint set at ADDR.  */
  90
  91 int breakpoint_inserted_here (CORE_ADDR addr);
  92
  93 /* Returns TRUE if there's any inserted software breakpoint at
  94    ADDR.  */
  95
  96 int software_breakpoint_inserted_here (CORE_ADDR addr);
  97
  98 /* Returns TRUE if there's any inserted hardware (code) breakpoint at
  99    ADDR.  */
 100
 101 int hardware_breakpoint_inserted_here (CORE_ADDR addr);
 102
 103 /* Returns TRUE if there's any reinsert breakpoint at ADDR.  */
 104
 105 int reinsert_breakpoint_inserted_here (CORE_ADDR addr);
 106
 107 /* Clear all breakpoint conditions and commands associated with a
 108    breakpoint.  */
 109
 110 void clear_breakpoint_conditions_and_commands (struct breakpoint *bp);
 111
 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.  */
 115
 116 int add_breakpoint_condition (struct breakpoint *bp, char **condition);
 117
 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.  */
 122
 123 int add_breakpoint_commands (struct breakpoint *bp, char **commands,
 124                              int persist);
 125
 126 int any_persistent_commands (void);
 127
 128 /* Evaluation condition (if any) at breakpoint BP.  Return 1 if
 129    true and 0 otherwise.  */
 130
 131 int gdb_condition_true_at_breakpoint (CORE_ADDR where);
 132
 133 int gdb_no_commands_at_breakpoint (CORE_ADDR where);
 134
 135 void run_breakpoint_commands (CORE_ADDR where);
 136
 137 /* Returns TRUE if there's a GDB breakpoint (Z0 or Z1) set at
 138    WHERE.  */
 139
 140 int gdb_breakpoint_here (CORE_ADDR where);
 141
 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.  */
 145
 146 struct breakpoint *set_breakpoint_at (CORE_ADDR where,
 147                                       int (*handler) (CORE_ADDR));
 148
 149 /* Delete a breakpoint.  */
 150
 151 int delete_breakpoint (struct breakpoint *bkpt);
 152
 153 /* Set a reinsert breakpoint at STOP_AT.  */
 154
 155 void set_reinsert_breakpoint (CORE_ADDR stop_at);
 156
 157 /* Delete all reinsert breakpoints.  */
 158
 159 void delete_reinsert_breakpoints (void);
 160
 161 /* Reinsert breakpoints at WHERE (and change their status to
 162    inserted).  */
 163
 164 void reinsert_breakpoints_at (CORE_ADDR where);
 165
 166 /* Process PROC has reinsert breakpoints or not.  */
 167
 168 int has_reinsert_breakpoints (struct process_info *proc);
 169
 170 /* Uninsert breakpoints at WHERE (and change their status to
 171    uninserted).  This still leaves the breakpoints in the table.  */
 172
 173 void uninsert_breakpoints_at (CORE_ADDR where);
 174
 175 /* Reinsert all breakpoints of the current process (and change their
 176    status to inserted).  */
 177
 178 void reinsert_all_breakpoints (void);
 179
 180 /* Uninsert all breakpoints of the current process (and change their
 181    status to uninserted).  This still leaves the breakpoints in the
 182    table.  */
 183
 184 void uninsert_all_breakpoints (void);
 185
 186 /* See if any breakpoint claims ownership of STOP_PC.  Call the handler for
 187    the breakpoint, if found.  */
 188
 189 void check_breakpoints (CORE_ADDR stop_pc);
 190
 191 /* See if any breakpoints shadow the target memory area from MEM_ADDR
 192    to MEM_ADDR + MEM_LEN.  Update the data already read from the target
 193    (in BUF) if necessary.  */
 194
 195 void check_mem_read (CORE_ADDR mem_addr, unsigned char *buf, int mem_len);
 196
 197 /* See if any breakpoints shadow the target memory area from MEM_ADDR
 198    to MEM_ADDR + MEM_LEN.  Update the data to be written to the target
 199    (in BUF, a copy of MYADDR on entry) if necessary, as well as the
 200    original data for any breakpoints.  */
 201
 202 void check_mem_write (CORE_ADDR mem_addr,
 203                       unsigned char *buf, const unsigned char *myaddr, int mem_len);
 204
 205 /* Delete all breakpoints.  */
 206
 207 void delete_all_breakpoints (void);
 208
 209 /* Clear the "inserted" flag in all breakpoints of PROC.  */
 210
 211 void mark_breakpoints_out (struct process_info *proc);
 212
 213 /* Delete all breakpoints, but do not try to un-insert them from the
 214    inferior.  */
 215
 216 void free_all_breakpoints (struct process_info *proc);
 217
 218 /* Check if breakpoints still seem to be inserted in the inferior.  */
 219
 220 void validate_breakpoints (void);
 221
 222 /* Insert a fast tracepoint jump at WHERE, using instruction INSN, of
 223    LENGTH bytes.  */
 224
 225 struct fast_tracepoint_jump *set_fast_tracepoint_jump (CORE_ADDR where,
 226                                                        unsigned char *insn,
 227                                                        ULONGEST length);
 228
 229 /* Increment reference counter of JP.  */
 230 void inc_ref_fast_tracepoint_jump (struct fast_tracepoint_jump *jp);
 231
 232 /* Delete fast tracepoint jump TODEL from our tables, and uninsert if
 233    from memory.  */
 234
 235 int delete_fast_tracepoint_jump (struct fast_tracepoint_jump *todel);
 236
 237 /* Returns true if there's fast tracepoint jump set at WHERE.  */
 238
 239 int fast_tracepoint_jump_here (CORE_ADDR);
 240
 241 /* Uninsert fast tracepoint jumps at WHERE (and change their status to
 242    uninserted).  This still leaves the tracepoints in the table.  */
 243
 244 void uninsert_fast_tracepoint_jumps_at (CORE_ADDR pc);
 245
 246 /* Reinsert fast tracepoint jumps at WHERE (and change their status to
 247    inserted).  */
 248
 249 void reinsert_fast_tracepoint_jumps_at (CORE_ADDR where);
 250
 251 /* Insert a memory breakpoint.  */
 252
 253 int insert_memory_breakpoint (struct raw_breakpoint *bp);
 254
 255 /* Remove a previously inserted memory breakpoint.  */
 256
 257 int remove_memory_breakpoint (struct raw_breakpoint *bp);
 258
 259 /* Create a new breakpoint list NEW_BKPT_LIST that is a copy of SRC.  */
 260
 261 void clone_all_breakpoints (struct breakpoint **new_bkpt_list,
 262                             struct raw_breakpoint **new_raw_bkpt_list,
 263                             const struct breakpoint *src);
 264
 265 #endif /* MEM_BREAK_H */