1 /* Native-dependent code for the i386.
3 Copyright (C) 2001, 2004, 2005, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
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/>. */
23 #include "breakpoint.h"
27 #include "gdb_assert.h"
29 /* Support for hardware watchpoints and breakpoints using the i386
32 This provides several functions for inserting and removing
33 hardware-assisted breakpoints and watchpoints, testing if one or
34 more of the watchpoints triggered and at what address, checking
35 whether a given region can be watched, etc.
37 The functions below implement debug registers sharing by reference
38 counts, and allow to watch regions up to 16 bytes long. */
40 struct i386_dr_low_type i386_dr_low;
43 /* Support for 8-byte wide hw watchpoints. */
44 #define TARGET_HAS_DR_LEN_8 (i386_dr_low.debug_register_length == 8)
46 /* Debug registers' indices. */
47 #define DR_NADDR 4 /* The number of debug address registers. */
48 #define DR_STATUS 6 /* Index of debug status register (DR6). */
49 #define DR_CONTROL 7 /* Index of debug control register (DR7). */
51 /* DR7 Debug Control register fields. */
53 /* How many bits to skip in DR7 to get to R/W and LEN fields. */
54 #define DR_CONTROL_SHIFT 16
55 /* How many bits in DR7 per R/W and LEN field for each watchpoint. */
56 #define DR_CONTROL_SIZE 4
58 /* Watchpoint/breakpoint read/write fields in DR7. */
59 #define DR_RW_EXECUTE (0x0) /* Break on instruction execution. */
60 #define DR_RW_WRITE (0x1) /* Break on data writes. */
61 #define DR_RW_READ (0x3) /* Break on data reads or writes. */
63 /* This is here for completeness. No platform supports this
64 functionality yet (as of March 2001). Note that the DE flag in the
65 CR4 register needs to be set to support this. */
67 #define DR_RW_IORW (0x2) /* Break on I/O reads or writes. */
70 /* Watchpoint/breakpoint length fields in DR7. The 2-bit left shift
71 is so we could OR this with the read/write field defined above. */
72 #define DR_LEN_1 (0x0 << 2) /* 1-byte region watch or breakpoint. */
73 #define DR_LEN_2 (0x1 << 2) /* 2-byte region watch. */
74 #define DR_LEN_4 (0x3 << 2) /* 4-byte region watch. */
75 #define DR_LEN_8 (0x2 << 2) /* 8-byte region watch (AMD64). */
77 /* Local and Global Enable flags in DR7.
79 When the Local Enable flag is set, the breakpoint/watchpoint is
80 enabled only for the current task; the processor automatically
81 clears this flag on every task switch. When the Global Enable flag
82 is set, the breakpoint/watchpoint is enabled for all tasks; the
83 processor never clears this flag.
85 Currently, all watchpoint are locally enabled. If you need to
86 enable them globally, read the comment which pertains to this in
87 i386_insert_aligned_watchpoint below. */
88 #define DR_LOCAL_ENABLE_SHIFT 0 /* Extra shift to the local enable bit. */
89 #define DR_GLOBAL_ENABLE_SHIFT 1 /* Extra shift to the global enable bit. */
90 #define DR_ENABLE_SIZE 2 /* Two enable bits per debug register. */
92 /* Local and global exact breakpoint enable flags (a.k.a. slowdown
93 flags). These are only required on i386, to allow detection of the
94 exact instruction which caused a watchpoint to break; i486 and
95 later processors do that automatically. We set these flags for
96 backwards compatibility. */
97 #define DR_LOCAL_SLOWDOWN (0x100)
98 #define DR_GLOBAL_SLOWDOWN (0x200)
100 /* Fields reserved by Intel. This includes the GD (General Detect
101 Enable) flag, which causes a debug exception to be generated when a
102 MOV instruction accesses one of the debug registers.
104 FIXME: My Intel manual says we should use 0xF800, not 0xFC00. */
105 #define DR_CONTROL_RESERVED (0xFC00)
107 /* Auxiliary helper macros. */
109 /* A value that masks all fields in DR7 that are reserved by Intel. */
110 #define I386_DR_CONTROL_MASK (~DR_CONTROL_RESERVED)
112 /* The I'th debug register is vacant if its Local and Global Enable
113 bits are reset in the Debug Control register. */
114 #define I386_DR_VACANT(i) \
115 ((dr_control_mirror & (3 << (DR_ENABLE_SIZE * (i)))) == 0)
117 /* Locally enable the break/watchpoint in the I'th debug register. */
118 #define I386_DR_LOCAL_ENABLE(i) \
119 dr_control_mirror |= (1 << (DR_LOCAL_ENABLE_SHIFT + DR_ENABLE_SIZE * (i)))
121 /* Globally enable the break/watchpoint in the I'th debug register. */
122 #define I386_DR_GLOBAL_ENABLE(i) \
123 dr_control_mirror |= (1 << (DR_GLOBAL_ENABLE_SHIFT + DR_ENABLE_SIZE * (i)))
125 /* Disable the break/watchpoint in the I'th debug register. */
126 #define I386_DR_DISABLE(i) \
127 dr_control_mirror &= ~(3 << (DR_ENABLE_SIZE * (i)))
129 /* Set in DR7 the RW and LEN fields for the I'th debug register. */
130 #define I386_DR_SET_RW_LEN(i,rwlen) \
132 dr_control_mirror &= ~(0x0f << (DR_CONTROL_SHIFT+DR_CONTROL_SIZE*(i))); \
133 dr_control_mirror |= ((rwlen) << (DR_CONTROL_SHIFT+DR_CONTROL_SIZE*(i))); \
136 /* Get from DR7 the RW and LEN fields for the I'th debug register. */
137 #define I386_DR_GET_RW_LEN(i) \
138 ((dr_control_mirror >> (DR_CONTROL_SHIFT + DR_CONTROL_SIZE * (i))) & 0x0f)
140 /* Mask that this I'th watchpoint has triggered. */
141 #define I386_DR_WATCH_MASK(i) (1 << (i))
143 /* Did the watchpoint whose address is in the I'th register break? */
144 #define I386_DR_WATCH_HIT(i) (dr_status_mirror & I386_DR_WATCH_MASK (i))
146 /* A macro to loop over all debug registers. */
147 #define ALL_DEBUG_REGISTERS(i) for (i = 0; i < DR_NADDR; i++)
149 /* Mirror the inferior's DRi registers. We keep the status and
150 control registers separated because they don't hold addresses. */
151 static CORE_ADDR dr_mirror[DR_NADDR];
152 static unsigned long dr_status_mirror, dr_control_mirror;
154 /* Reference counts for each debug register. */
155 static int dr_ref_count[DR_NADDR];
157 /* Whether or not to print the mirrored debug registers. */
158 static int maint_show_dr;
160 /* Types of operations supported by i386_handle_nonaligned_watchpoint. */
161 typedef enum { WP_INSERT, WP_REMOVE, WP_COUNT } i386_wp_op_t;
163 /* Internal functions. */
165 /* Return the value of a 4-bit field for DR7 suitable for watching a
166 region of LEN bytes for accesses of type TYPE. LEN is assumed to
167 have the value of 1, 2, or 4. */
168 static unsigned i386_length_and_rw_bits (int len, enum target_hw_bp_type type);
170 /* Insert a watchpoint at address ADDR, which is assumed to be aligned
171 according to the length of the region to watch. LEN_RW_BITS is the
172 value of the bit-field from DR7 which describes the length and
173 access type of the region to be watched by this watchpoint. Return
174 0 on success, -1 on failure. */
175 static int i386_insert_aligned_watchpoint (CORE_ADDR addr,
176 unsigned len_rw_bits);
178 /* Remove a watchpoint at address ADDR, which is assumed to be aligned
179 according to the length of the region to watch. LEN_RW_BITS is the
180 value of the bits from DR7 which describes the length and access
181 type of the region watched by this watchpoint. Return 0 on
182 success, -1 on failure. */
183 static int i386_remove_aligned_watchpoint (CORE_ADDR addr,
184 unsigned len_rw_bits);
186 /* Insert or remove a (possibly non-aligned) watchpoint, or count the
187 number of debug registers required to watch a region at address
188 ADDR whose length is LEN for accesses of type TYPE. Return 0 on
189 successful insertion or removal, a positive number when queried
190 about the number of registers, or -1 on failure. If WHAT is not a
191 valid value, bombs through internal_error. */
192 static int i386_handle_nonaligned_watchpoint (i386_wp_op_t what,
193 CORE_ADDR addr, int len,
194 enum target_hw_bp_type type);
196 /* Implementation. */
198 /* Clear the reference counts and forget everything we knew about the
202 i386_cleanup_dregs (void)
206 ALL_DEBUG_REGISTERS(i)
211 dr_control_mirror = 0;
212 dr_status_mirror = 0;
215 /* Print the values of the mirrored debug registers. This is called
216 when maint_show_dr is non-zero. To set that up, type "maint
217 show-debug-regs" at GDB's prompt. */
220 i386_show_dr (const char *func, CORE_ADDR addr,
221 int len, enum target_hw_bp_type type)
223 int addr_size = gdbarch_addr_bit (target_gdbarch) / 8;
226 puts_unfiltered (func);
228 printf_unfiltered (" (addr=%lx, len=%d, type=%s)",
229 /* This code is for ia32, so casting CORE_ADDR
230 to unsigned long should be okay. */
231 (unsigned long)addr, len,
232 type == hw_write ? "data-write"
233 : (type == hw_read ? "data-read"
234 : (type == hw_access ? "data-read/write"
235 : (type == hw_execute ? "instruction-execute"
236 /* FIXME: if/when I/O read/write
237 watchpoints are supported, add them
240 puts_unfiltered (":\n");
241 printf_unfiltered ("\tCONTROL (DR7): %s STATUS (DR6): %s\n",
242 phex (dr_control_mirror, 8), phex (dr_status_mirror, 8));
243 ALL_DEBUG_REGISTERS(i)
245 printf_unfiltered ("\
246 \tDR%d: addr=0x%s, ref.count=%d DR%d: addr=0x%s, ref.count=%d\n",
247 i, phex (dr_mirror[i], addr_size), dr_ref_count[i],
248 i+1, phex (dr_mirror[i+1], addr_size), dr_ref_count[i+1]);
253 /* Return the value of a 4-bit field for DR7 suitable for watching a
254 region of LEN bytes for accesses of type TYPE. LEN is assumed to
255 have the value of 1, 2, or 4. */
258 i386_length_and_rw_bits (int len, enum target_hw_bp_type type)
271 internal_error (__FILE__, __LINE__,
272 _("The i386 doesn't support "
273 "data-read watchpoints.\n"));
278 /* Not yet supported. */
284 internal_error (__FILE__, __LINE__, _("\
285 Invalid hardware breakpoint type %d in i386_length_and_rw_bits.\n"),
292 return (DR_LEN_1 | rw);
294 return (DR_LEN_2 | rw);
296 return (DR_LEN_4 | rw);
298 if (TARGET_HAS_DR_LEN_8)
299 return (DR_LEN_8 | rw);
301 internal_error (__FILE__, __LINE__, _("\
302 Invalid hardware breakpoint length %d in i386_length_and_rw_bits.\n"), len);
306 /* Insert a watchpoint at address ADDR, which is assumed to be aligned
307 according to the length of the region to watch. LEN_RW_BITS is the
308 value of the bits from DR7 which describes the length and access
309 type of the region to be watched by this watchpoint. Return 0 on
310 success, -1 on failure. */
313 i386_insert_aligned_watchpoint (CORE_ADDR addr, unsigned len_rw_bits)
317 if (!i386_dr_low.set_addr || !i386_dr_low.set_control)
320 /* First, look for an occupied debug register with the same address
321 and the same RW and LEN definitions. If we find one, we can
322 reuse it for this watchpoint as well (and save a register). */
323 ALL_DEBUG_REGISTERS(i)
325 if (!I386_DR_VACANT (i)
326 && dr_mirror[i] == addr
327 && I386_DR_GET_RW_LEN (i) == len_rw_bits)
334 /* Next, look for a vacant debug register. */
335 ALL_DEBUG_REGISTERS(i)
337 if (I386_DR_VACANT (i))
341 /* No more debug registers! */
345 /* Now set up the register I to watch our region. */
347 /* Record the info in our local mirrored array. */
350 I386_DR_SET_RW_LEN (i, len_rw_bits);
351 /* Note: we only enable the watchpoint locally, i.e. in the current
352 task. Currently, no i386 target allows or supports global
353 watchpoints; however, if any target would want that in the
354 future, GDB should probably provide a command to control whether
355 to enable watchpoints globally or locally, and the code below
356 should use global or local enable and slow-down flags as
358 I386_DR_LOCAL_ENABLE (i);
359 dr_control_mirror |= DR_LOCAL_SLOWDOWN;
360 dr_control_mirror &= I386_DR_CONTROL_MASK;
362 /* Finally, actually pass the info to the inferior. */
363 i386_dr_low.set_addr (i, addr);
364 i386_dr_low.set_control (dr_control_mirror);
366 /* Only a sanity check for leftover bits (set possibly only by inferior). */
367 if (i386_dr_low.unset_status)
368 i386_dr_low.unset_status (I386_DR_WATCH_MASK (i));
373 /* Remove a watchpoint at address ADDR, which is assumed to be aligned
374 according to the length of the region to watch. LEN_RW_BITS is the
375 value of the bits from DR7 which describes the length and access
376 type of the region watched by this watchpoint. Return 0 on
377 success, -1 on failure. */
380 i386_remove_aligned_watchpoint (CORE_ADDR addr, unsigned len_rw_bits)
384 ALL_DEBUG_REGISTERS(i)
386 if (!I386_DR_VACANT (i)
387 && dr_mirror[i] == addr
388 && I386_DR_GET_RW_LEN (i) == len_rw_bits)
390 if (--dr_ref_count[i] == 0) /* no longer in use? */
392 /* Reset our mirror. */
395 /* Reset it in the inferior. */
396 i386_dr_low.set_control (dr_control_mirror);
397 if (i386_dr_low.reset_addr)
398 i386_dr_low.reset_addr (i);
407 /* Insert or remove a (possibly non-aligned) watchpoint, or count the
408 number of debug registers required to watch a region at address
409 ADDR whose length is LEN for accesses of type TYPE. Return 0 on
410 successful insertion or removal, a positive number when queried
411 about the number of registers, or -1 on failure. If WHAT is not a
412 valid value, bombs through internal_error. */
415 i386_handle_nonaligned_watchpoint (i386_wp_op_t what, CORE_ADDR addr, int len,
416 enum target_hw_bp_type type)
418 int retval = 0, status = 0;
419 int max_wp_len = TARGET_HAS_DR_LEN_8 ? 8 : 4;
421 static int size_try_array[8][8] =
423 {1, 1, 1, 1, 1, 1, 1, 1}, /* Trying size one. */
424 {2, 1, 2, 1, 2, 1, 2, 1}, /* Trying size two. */
425 {2, 1, 2, 1, 2, 1, 2, 1}, /* Trying size three. */
426 {4, 1, 2, 1, 4, 1, 2, 1}, /* Trying size four. */
427 {4, 1, 2, 1, 4, 1, 2, 1}, /* Trying size five. */
428 {4, 1, 2, 1, 4, 1, 2, 1}, /* Trying size six. */
429 {4, 1, 2, 1, 4, 1, 2, 1}, /* Trying size seven. */
430 {8, 1, 2, 1, 4, 1, 2, 1}, /* Trying size eight. */
435 int align = addr % max_wp_len;
436 /* Four (eight on AMD64) is the maximum length a debug register
438 int try = (len > max_wp_len ? (max_wp_len - 1) : len - 1);
439 int size = size_try_array[try][align];
441 if (what == WP_COUNT)
443 /* size_try_array[] is defined such that each iteration
444 through the loop is guaranteed to produce an address and a
445 size that can be watched with a single debug register.
446 Thus, for counting the registers required to watch a
447 region, we simply need to increment the count on each
453 unsigned len_rw = i386_length_and_rw_bits (size, type);
455 if (what == WP_INSERT)
456 status = i386_insert_aligned_watchpoint (addr, len_rw);
457 else if (what == WP_REMOVE)
458 status = i386_remove_aligned_watchpoint (addr, len_rw);
460 internal_error (__FILE__, __LINE__, _("\
461 Invalid value %d of operation in i386_handle_nonaligned_watchpoint.\n"),
463 /* We keep the loop going even after a failure, because some
464 of the other aligned watchpoints might still succeed
465 (e.g. if they watch addresses that are already watched,
466 in which case we just increment the reference counts of
467 occupied debug registers). If we break out of the loop
468 too early, we could cause those addresses watched by
469 other watchpoints to be disabled when breakpoint.c reacts
470 to our failure to insert this watchpoint and tries to
483 /* Insert a watchpoint to watch a memory region which starts at
484 address ADDR and whose length is LEN bytes. Watch memory accesses
485 of the type TYPE. Return 0 on success, -1 on failure. */
488 i386_insert_watchpoint (CORE_ADDR addr, int len, int type,
489 struct expression *cond)
494 return 1; /* unsupported */
496 if (((len != 1 && len !=2 && len !=4) && !(TARGET_HAS_DR_LEN_8 && len == 8))
498 retval = i386_handle_nonaligned_watchpoint (WP_INSERT, addr, len, type);
501 unsigned len_rw = i386_length_and_rw_bits (len, type);
503 retval = i386_insert_aligned_watchpoint (addr, len_rw);
507 i386_show_dr ("insert_watchpoint", addr, len, type);
512 /* Remove a watchpoint that watched the memory region which starts at
513 address ADDR, whose length is LEN bytes, and for accesses of the
514 type TYPE. Return 0 on success, -1 on failure. */
516 i386_remove_watchpoint (CORE_ADDR addr, int len, int type,
517 struct expression *cond)
521 if (((len != 1 && len !=2 && len !=4) && !(TARGET_HAS_DR_LEN_8 && len == 8))
523 retval = i386_handle_nonaligned_watchpoint (WP_REMOVE, addr, len, type);
526 unsigned len_rw = i386_length_and_rw_bits (len, type);
528 retval = i386_remove_aligned_watchpoint (addr, len_rw);
532 i386_show_dr ("remove_watchpoint", addr, len, type);
537 /* Return non-zero if we can watch a memory region that starts at
538 address ADDR and whose length is LEN bytes. */
541 i386_region_ok_for_watchpoint (CORE_ADDR addr, int len)
545 /* Compute how many aligned watchpoints we would need to cover this
547 nregs = i386_handle_nonaligned_watchpoint (WP_COUNT, addr, len, hw_write);
548 return nregs <= DR_NADDR ? 1 : 0;
551 /* If the inferior has some watchpoint that triggered, set the
552 address associated with that watchpoint and return non-zero.
553 Otherwise, return zero. */
556 i386_stopped_data_address (struct target_ops *ops, CORE_ADDR *addr_p)
562 dr_status_mirror = i386_dr_low.get_status ();
564 ALL_DEBUG_REGISTERS(i)
566 if (I386_DR_WATCH_HIT (i)
567 /* This second condition makes sure DRi is set up for a data
568 watchpoint, not a hardware breakpoint. The reason is
569 that GDB doesn't call the target_stopped_data_address
570 method except for data watchpoints. In other words, I'm
572 && I386_DR_GET_RW_LEN (i) != 0
573 /* This third condition makes sure DRi is not vacant, this
574 avoids false positives in windows-nat.c. */
575 && !I386_DR_VACANT (i))
580 i386_show_dr ("watchpoint_hit", addr, -1, hw_write);
583 if (maint_show_dr && addr == 0)
584 i386_show_dr ("stopped_data_addr", 0, 0, hw_write);
592 i386_stopped_by_watchpoint (void)
595 return i386_stopped_data_address (¤t_target, &addr);
598 /* Insert a hardware-assisted breakpoint at BP_TGT->placed_address.
599 Return 0 on success, EBUSY on failure. */
601 i386_insert_hw_breakpoint (struct gdbarch *gdbarch,
602 struct bp_target_info *bp_tgt)
604 unsigned len_rw = i386_length_and_rw_bits (1, hw_execute);
605 CORE_ADDR addr = bp_tgt->placed_address;
606 int retval = i386_insert_aligned_watchpoint (addr, len_rw) ? EBUSY : 0;
609 i386_show_dr ("insert_hwbp", addr, 1, hw_execute);
614 /* Remove a hardware-assisted breakpoint at BP_TGT->placed_address.
615 Return 0 on success, -1 on failure. */
618 i386_remove_hw_breakpoint (struct gdbarch *gdbarch,
619 struct bp_target_info *bp_tgt)
621 unsigned len_rw = i386_length_and_rw_bits (1, hw_execute);
622 CORE_ADDR addr = bp_tgt->placed_address;
623 int retval = i386_remove_aligned_watchpoint (addr, len_rw);
626 i386_show_dr ("remove_hwbp", addr, 1, hw_execute);
631 /* Returns the number of hardware watchpoints of type TYPE that we can
632 set. Value is positive if we can set CNT watchpoints, zero if
633 setting watchpoints of type TYPE is not supported, and negative if
634 CNT is more than the maximum number of watchpoints of type TYPE
635 that we can support. TYPE is one of bp_hardware_watchpoint,
636 bp_read_watchpoint, bp_write_watchpoint, or bp_hardware_breakpoint.
637 CNT is the number of such watchpoints used so far (including this
638 one). OTHERTYPE is non-zero if other types of watchpoints are
641 We always return 1 here because we don't have enough information
642 about possible overlap of addresses that they want to watch. As an
643 extreme example, consider the case where all the watchpoints watch
644 the same address and the same region length: then we can handle a
645 virtually unlimited number of watchpoints, due to debug register
646 sharing implemented via reference counts in i386-nat.c. */
649 i386_can_use_hw_breakpoint (int type, int cnt, int othertype)
655 add_show_debug_regs_command (void)
657 /* A maintenance command to enable printing the internal DRi mirror
659 add_setshow_boolean_cmd ("show-debug-regs", class_maintenance,
661 Set whether to show variables that mirror the x86 debug registers."), _("\
662 Show whether to show variables that mirror the x86 debug registers."), _("\
663 Use \"on\" to enable, \"off\" to disable.\n\
664 If enabled, the debug registers values are shown when GDB inserts\n\
665 or removes a hardware breakpoint or watchpoint, and when the inferior\n\
666 triggers a breakpoint or watchpoint."),
669 &maintenance_set_cmdlist,
670 &maintenance_show_cmdlist);
673 /* There are only two global functions left. */
676 i386_use_watchpoints (struct target_ops *t)
678 /* After a watchpoint trap, the PC points to the instruction after the
679 one that caused the trap. Therefore we don't need to step over it.
680 But we do need to reset the status register to avoid another trap. */
681 t->to_have_continuable_watchpoint = 1;
683 t->to_can_use_hw_breakpoint = i386_can_use_hw_breakpoint;
684 t->to_region_ok_for_hw_watchpoint = i386_region_ok_for_watchpoint;
685 t->to_stopped_by_watchpoint = i386_stopped_by_watchpoint;
686 t->to_stopped_data_address = i386_stopped_data_address;
687 t->to_insert_watchpoint = i386_insert_watchpoint;
688 t->to_remove_watchpoint = i386_remove_watchpoint;
689 t->to_insert_hw_breakpoint = i386_insert_hw_breakpoint;
690 t->to_remove_hw_breakpoint = i386_remove_hw_breakpoint;
694 i386_set_debug_register_length (int len)
696 /* This function should be called only once for each native target. */
697 gdb_assert (i386_dr_low.debug_register_length == 0);
698 gdb_assert (len == 4 || len == 8);
699 i386_dr_low.debug_register_length = len;
700 add_show_debug_regs_command ();