gdb/x86-nat.c

   1 /* Native-dependent code for x86 (i386 and x86-64).
   2
   3    Copyright (C) 2001-2014 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #include "defs.h"
  21 #include "x86-nat.h"
  22 #include "gdbcmd.h"
  23 #include "inferior.h"
  24
  25 /* Support for hardware watchpoints and breakpoints using the x86
  26    debug registers.
  27
  28    This provides several functions for inserting and removing
  29    hardware-assisted breakpoints and watchpoints, testing if one or
  30    more of the watchpoints triggered and at what address, checking
  31    whether a given region can be watched, etc.
  32
  33    The functions below implement debug registers sharing by reference
  34    counts, and allow to watch regions up to 16 bytes long.  */
  35
  36 /* Whether or not to print the mirrored debug registers.  */
  37 int debug_hw_points;
  38
  39 /* Low-level function vector.  */
  40 struct x86_dr_low_type x86_dr_low;
  41
  42 /* Per-process data.  We don't bind this to a per-inferior registry
  43    because of targets like x86 GNU/Linux that need to keep track of
  44    processes that aren't bound to any inferior (e.g., fork children,
  45    checkpoints).  */
  46
  47 struct x86_process_info
  48 {
  49   /* Linked list.  */
  50   struct x86_process_info *next;
  51
  52   /* The process identifier.  */
  53   pid_t pid;
  54
  55   /* Copy of x86 hardware debug registers.  */
  56   struct x86_debug_reg_state state;
  57 };
  58
  59 static struct x86_process_info *x86_process_list = NULL;
  60
  61 /* Find process data for process PID.  */
  62
  63 static struct x86_process_info *
  64 x86_find_process_pid (pid_t pid)
  65 {
  66   struct x86_process_info *proc;
  67
  68   for (proc = x86_process_list; proc; proc = proc->next)
  69     if (proc->pid == pid)
  70       return proc;
  71
  72   return NULL;
  73 }
  74
  75 /* Add process data for process PID.  Returns newly allocated info
  76    object.  */
  77
  78 static struct x86_process_info *
  79 x86_add_process (pid_t pid)
  80 {
  81   struct x86_process_info *proc;
  82
  83   proc = xcalloc (1, sizeof (*proc));
  84   proc->pid = pid;
  85
  86   proc->next = x86_process_list;
  87   x86_process_list = proc;
  88
  89   return proc;
  90 }
  91
  92 /* Get data specific info for process PID, creating it if necessary.
  93    Never returns NULL.  */
  94
  95 static struct x86_process_info *
  96 x86_process_info_get (pid_t pid)
  97 {
  98   struct x86_process_info *proc;
  99
 100   proc = x86_find_process_pid (pid);
 101   if (proc == NULL)
 102     proc = x86_add_process (pid);
 103
 104   return proc;
 105 }
 106
 107 /* Get debug registers state for process PID.  */
 108
 109 struct x86_debug_reg_state *
 110 x86_debug_reg_state (pid_t pid)
 111 {
 112   return &x86_process_info_get (pid)->state;
 113 }
 114
 115 /* See declaration in i386-nat.h.  */
 116
 117 void
 118 x86_forget_process (pid_t pid)
 119 {
 120   struct x86_process_info *proc, **proc_link;
 121
 122   proc = x86_process_list;
 123   proc_link = &x86_process_list;
 124
 125   while (proc != NULL)
 126     {
 127       if (proc->pid == pid)
 128         {
 129           *proc_link = proc->next;
 130
 131           xfree (proc);
 132           return;
 133         }
 134
 135       proc_link = &proc->next;
 136       proc = *proc_link;
 137     }
 138 }
 139
 140 /* Clear the reference counts and forget everything we knew about the
 141    debug registers.  */
 142
 143 void
 144 x86_cleanup_dregs (void)
 145 {
 146   /* Starting from scratch has the same effect.  */
 147   x86_forget_process (ptid_get_pid (inferior_ptid));
 148 }
 149
 150 /* Insert a watchpoint to watch a memory region which starts at
 151    address ADDR and whose length is LEN bytes.  Watch memory accesses
 152    of the type TYPE.  Return 0 on success, -1 on failure.  */
 153
 154 static int
 155 x86_insert_watchpoint (struct target_ops *self,
 156                        CORE_ADDR addr, int len, int type,
 157                        struct expression *cond)
 158 {
 159   struct x86_debug_reg_state *state
 160     = x86_debug_reg_state (ptid_get_pid (inferior_ptid));
 161
 162   return x86_dr_insert_watchpoint (state, type, addr, len);
 163 }
 164
 165 /* Remove a watchpoint that watched the memory region which starts at
 166    address ADDR, whose length is LEN bytes, and for accesses of the
 167    type TYPE.  Return 0 on success, -1 on failure.  */
 168 static int
 169 x86_remove_watchpoint (struct target_ops *self,
 170                        CORE_ADDR addr, int len, int type,
 171                        struct expression *cond)
 172 {
 173   struct x86_debug_reg_state *state
 174     = x86_debug_reg_state (ptid_get_pid (inferior_ptid));
 175
 176   return x86_dr_remove_watchpoint (state, type, addr, len);
 177 }
 178
 179 /* Return non-zero if we can watch a memory region that starts at
 180    address ADDR and whose length is LEN bytes.  */
 181
 182 static int
 183 x86_region_ok_for_watchpoint (struct target_ops *self,
 184                               CORE_ADDR addr, int len)
 185 {
 186   struct x86_debug_reg_state *state
 187     = x86_debug_reg_state (ptid_get_pid (inferior_ptid));
 188
 189   return x86_dr_region_ok_for_watchpoint (state, addr, len);
 190 }
 191
 192 /* If the inferior has some break/watchpoint that triggered, set the
 193    address associated with that break/watchpoint and return non-zero.
 194    Otherwise, return zero.  */
 195
 196 static int
 197 x86_stopped_data_address (struct target_ops *ops, CORE_ADDR *addr_p)
 198 {
 199   struct x86_debug_reg_state *state
 200     = x86_debug_reg_state (ptid_get_pid (inferior_ptid));
 201
 202   return x86_dr_stopped_data_address (state, addr_p);
 203 }
 204
 205 /* Return non-zero if the inferior has some watchpoint that triggered.
 206    Otherwise return zero.  */
 207
 208 static int
 209 x86_stopped_by_watchpoint (struct target_ops *ops)
 210 {
 211   struct x86_debug_reg_state *state
 212     = x86_debug_reg_state (ptid_get_pid (inferior_ptid));
 213
 214   return x86_dr_stopped_by_watchpoint (state);
 215 }
 216
 217 /* Insert a hardware-assisted breakpoint at BP_TGT->placed_address.
 218    Return 0 on success, EBUSY on failure.  */
 219
 220 static int
 221 x86_insert_hw_breakpoint (struct target_ops *self, struct gdbarch *gdbarch,
 222                           struct bp_target_info *bp_tgt)
 223 {
 224   struct x86_debug_reg_state *state
 225     = x86_debug_reg_state (ptid_get_pid (inferior_ptid));
 226
 227   return x86_dr_insert_watchpoint (state, hw_execute,
 228                                    bp_tgt->placed_address, 1) ? EBUSY : 0;
 229 }
 230
 231 /* Remove a hardware-assisted breakpoint at BP_TGT->placed_address.
 232    Return 0 on success, -1 on failure.  */
 233
 234 static int
 235 x86_remove_hw_breakpoint (struct target_ops *self, struct gdbarch *gdbarch,
 236                           struct bp_target_info *bp_tgt)
 237 {
 238   struct x86_debug_reg_state *state
 239     = x86_debug_reg_state (ptid_get_pid (inferior_ptid));
 240
 241   return x86_dr_remove_watchpoint (state, hw_execute,
 242                                    bp_tgt->placed_address, 1);
 243 }
 244
 245 /* Returns the number of hardware watchpoints of type TYPE that we can
 246    set.  Value is positive if we can set CNT watchpoints, zero if
 247    setting watchpoints of type TYPE is not supported, and negative if
 248    CNT is more than the maximum number of watchpoints of type TYPE
 249    that we can support.  TYPE is one of bp_hardware_watchpoint,
 250    bp_read_watchpoint, bp_write_watchpoint, or bp_hardware_breakpoint.
 251    CNT is the number of such watchpoints used so far (including this
 252    one).  OTHERTYPE is non-zero if other types of watchpoints are
 253    currently enabled.
 254
 255    We always return 1 here because we don't have enough information
 256    about possible overlap of addresses that they want to watch.  As an
 257    extreme example, consider the case where all the watchpoints watch
 258    the same address and the same region length: then we can handle a
 259    virtually unlimited number of watchpoints, due to debug register
 260    sharing implemented via reference counts in i386-nat.c.  */
 261
 262 static int
 263 x86_can_use_hw_breakpoint (struct target_ops *self,
 264                            int type, int cnt, int othertype)
 265 {
 266   return 1;
 267 }
 268
 269 static void
 270 add_show_debug_regs_command (void)
 271 {
 272   /* A maintenance command to enable printing the internal DRi mirror
 273      variables.  */
 274   add_setshow_boolean_cmd ("show-debug-regs", class_maintenance,
 275                            &debug_hw_points, _("\
 276 Set whether to show variables that mirror the x86 debug registers."), _("\
 277 Show whether to show variables that mirror the x86 debug registers."), _("\
 278 Use \"on\" to enable, \"off\" to disable.\n\
 279 If enabled, the debug registers values are shown when GDB inserts\n\
 280 or removes a hardware breakpoint or watchpoint, and when the inferior\n\
 281 triggers a breakpoint or watchpoint."),
 282                            NULL,
 283                            NULL,
 284                            &maintenance_set_cmdlist,
 285                            &maintenance_show_cmdlist);
 286 }
 287
 288 /* There are only two global functions left.  */
 289
 290 void
 291 x86_use_watchpoints (struct target_ops *t)
 292 {
 293   /* After a watchpoint trap, the PC points to the instruction after the
 294      one that caused the trap.  Therefore we don't need to step over it.
 295      But we do need to reset the status register to avoid another trap.  */
 296   t->to_have_continuable_watchpoint = 1;
 297
 298   t->to_can_use_hw_breakpoint = x86_can_use_hw_breakpoint;
 299   t->to_region_ok_for_hw_watchpoint = x86_region_ok_for_watchpoint;
 300   t->to_stopped_by_watchpoint = x86_stopped_by_watchpoint;
 301   t->to_stopped_data_address = x86_stopped_data_address;
 302   t->to_insert_watchpoint = x86_insert_watchpoint;
 303   t->to_remove_watchpoint = x86_remove_watchpoint;
 304   t->to_insert_hw_breakpoint = x86_insert_hw_breakpoint;
 305   t->to_remove_hw_breakpoint = x86_remove_hw_breakpoint;
 306 }
 307
 308 void
 309 x86_set_debug_register_length (int len)
 310 {
 311   /* This function should be called only once for each native target.  */
 312   gdb_assert (x86_dr_low.debug_register_length == 0);
 313   gdb_assert (len == 4 || len == 8);
 314   x86_dr_low.debug_register_length = len;
 315   add_show_debug_regs_command ();
 316 }