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