gdb/gdbserver/mem-break.h

   1 /* Memory breakpoint interfaces for the remote server for GDB.
   2    Copyright (C) 2002-2014 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 size SIZE.
  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 size,
  74                                        int *err);
  75
  76 /* Delete a GDB breakpoint of type Z_TYPE and size SIZE 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 size);
  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 /* Clear all breakpoint conditions associated with this address.  */
  94
  95 void clear_breakpoint_conditions (struct breakpoint *bp);
  96
  97 /* Set target-side condition CONDITION to the breakpoint at ADDR.
  98    Returns false on failure.  On success, advances CONDITION pointer
  99    past the condition and returns true.  */
 100
 101 int add_breakpoint_condition (struct breakpoint *bp, char **condition);
 102
 103 /* Set target-side commands COMMANDS to the breakpoint at ADDR.
 104    Returns false on failure.  On success, advances COMMANDS past the
 105    commands and returns true.  If PERSIST, the commands should run
 106    even while GDB is disconnected.  */
 107
 108 int add_breakpoint_commands (struct breakpoint *bp, char **commands,
 109                              int persist);
 110
 111 int any_persistent_commands (void);
 112
 113 /* Evaluation condition (if any) at breakpoint BP.  Return 1 if
 114    true and 0 otherwise.  */
 115
 116 int gdb_condition_true_at_breakpoint (CORE_ADDR where);
 117
 118 int gdb_no_commands_at_breakpoint (CORE_ADDR where);
 119
 120 void run_breakpoint_commands (CORE_ADDR where);
 121
 122 /* Returns TRUE if there's a GDB breakpoint (Z0 or Z1) set at
 123    WHERE.  */
 124
 125 int gdb_breakpoint_here (CORE_ADDR where);
 126
 127 /* Create a new breakpoint at WHERE, and call HANDLER when
 128    it is hit.  HANDLER should return 1 if the breakpoint
 129    should be deleted, 0 otherwise.  */
 130
 131 struct breakpoint *set_breakpoint_at (CORE_ADDR where,
 132                                       int (*handler) (CORE_ADDR));
 133
 134 /* Delete a breakpoint.  */
 135
 136 int delete_breakpoint (struct breakpoint *bkpt);
 137
 138 /* Set a reinsert breakpoint at STOP_AT.  */
 139
 140 void set_reinsert_breakpoint (CORE_ADDR stop_at);
 141
 142 /* Delete all reinsert breakpoints.  */
 143
 144 void delete_reinsert_breakpoints (void);
 145
 146 /* Reinsert breakpoints at WHERE (and change their status to
 147    inserted).  */
 148
 149 void reinsert_breakpoints_at (CORE_ADDR where);
 150
 151 /* Uninsert breakpoints at WHERE (and change their status to
 152    uninserted).  This still leaves the breakpoints in the table.  */
 153
 154 void uninsert_breakpoints_at (CORE_ADDR where);
 155
 156 /* Reinsert all breakpoints of the current process (and change their
 157    status to inserted).  */
 158
 159 void reinsert_all_breakpoints (void);
 160
 161 /* Uninsert all breakpoints of the current process (and change their
 162    status to uninserted).  This still leaves the breakpoints in the
 163    table.  */
 164
 165 void uninsert_all_breakpoints (void);
 166
 167 /* See if any breakpoint claims ownership of STOP_PC.  Call the handler for
 168    the breakpoint, if found.  */
 169
 170 void check_breakpoints (CORE_ADDR stop_pc);
 171
 172 /* See if any breakpoints shadow the target memory area from MEM_ADDR
 173    to MEM_ADDR + MEM_LEN.  Update the data already read from the target
 174    (in BUF) if necessary.  */
 175
 176 void check_mem_read (CORE_ADDR mem_addr, unsigned char *buf, int mem_len);
 177
 178 /* See if any breakpoints shadow the target memory area from MEM_ADDR
 179    to MEM_ADDR + MEM_LEN.  Update the data to be written to the target
 180    (in BUF, a copy of MYADDR on entry) if necessary, as well as the
 181    original data for any breakpoints.  */
 182
 183 void check_mem_write (CORE_ADDR mem_addr,
 184                       unsigned char *buf, const unsigned char *myaddr, int mem_len);
 185
 186 /* Set the byte pattern to insert for memory breakpoints.  This function
 187    must be called before any breakpoints are set.  */
 188
 189 void set_breakpoint_data (const unsigned char *bp_data, int bp_len);
 190
 191 /* Delete all breakpoints.  */
 192
 193 void delete_all_breakpoints (void);
 194
 195 /* Clear the "inserted" flag in all breakpoints of PROC.  */
 196
 197 void mark_breakpoints_out (struct process_info *proc);
 198
 199 /* Delete all breakpoints, but do not try to un-insert them from the
 200    inferior.  */
 201
 202 void free_all_breakpoints (struct process_info *proc);
 203
 204 /* Check if breakpoints still seem to be inserted in the inferior.  */
 205
 206 void validate_breakpoints (void);
 207
 208 /* Insert a fast tracepoint jump at WHERE, using instruction INSN, of
 209    LENGTH bytes.  */
 210
 211 struct fast_tracepoint_jump *set_fast_tracepoint_jump (CORE_ADDR where,
 212                                                        unsigned char *insn,
 213                                                        ULONGEST length);
 214
 215 /* Increment reference counter of JP.  */
 216 void inc_ref_fast_tracepoint_jump (struct fast_tracepoint_jump *jp);
 217
 218 /* Delete fast tracepoint jump TODEL from our tables, and uninsert if
 219    from memory.  */
 220
 221 int delete_fast_tracepoint_jump (struct fast_tracepoint_jump *todel);
 222
 223 /* Returns true if there's fast tracepoint jump set at WHERE.  */
 224
 225 int fast_tracepoint_jump_here (CORE_ADDR);
 226
 227 /* Uninsert fast tracepoint jumps at WHERE (and change their status to
 228    uninserted).  This still leaves the tracepoints in the table.  */
 229
 230 void uninsert_fast_tracepoint_jumps_at (CORE_ADDR pc);
 231
 232 /* Reinsert fast tracepoint jumps at WHERE (and change their status to
 233    inserted).  */
 234
 235 void reinsert_fast_tracepoint_jumps_at (CORE_ADDR where);
 236
 237 /* Insert a memory breakpoint.  */
 238
 239 int insert_memory_breakpoint (struct raw_breakpoint *bp);
 240
 241 /* Remove a previously inserted memory breakpoint.  */
 242
 243 int remove_memory_breakpoint (struct raw_breakpoint *bp);
 244
 245 #endif /* MEM_BREAK_H */