1/* Copyright (C) 2001-2026 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
8
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Lesser General Public License for more details.
13
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, see
16 <https://www.gnu.org/licenses/>. */
17
18#ifndef _SYS_DEBUGREG_H
19#define _SYS_DEBUGREG_H 1
20
21/* Indicate the register numbers for a number of the specific
22 debug registers. Registers 0-3 contain the addresses we wish to trap on */
23#define DR_FIRSTADDR 0 /* u_debugreg[DR_FIRSTADDR] */
24#define DR_LASTADDR 3 /* u_debugreg[DR_LASTADDR] */
25
26#define DR_STATUS 6 /* u_debugreg[DR_STATUS] */
27#define DR_CONTROL 7 /* u_debugreg[DR_CONTROL] */
28
29/* Define a few things for the status register. We can use this to determine
30 which debugging register was responsible for the trap. The other bits
31 are either reserved or not of interest to us. */
32
33#define DR_TRAP0 (0x1) /* db0 */
34#define DR_TRAP1 (0x2) /* db1 */
35#define DR_TRAP2 (0x4) /* db2 */
36#define DR_TRAP3 (0x8) /* db3 */
37
38#define DR_STEP (0x4000) /* single-step */
39#define DR_SWITCH (0x8000) /* task switch */
40
41/* Now define a bunch of things for manipulating the control register.
42 The top two bytes of the control register consist of 4 fields of 4
43 bits - each field corresponds to one of the four debug registers,
44 and indicates what types of access we trap on, and how large the data
45 field is that we are looking at */
46
47#define DR_CONTROL_SHIFT 16 /* Skip this many bits in ctl register */
48#define DR_CONTROL_SIZE 4 /* 4 control bits per register */
49
50#define DR_RW_EXECUTE (0x0) /* Settings for the access types to trap on */
51#define DR_RW_WRITE (0x1)
52#define DR_RW_READ (0x3)
53
54#define DR_LEN_1 (0x0) /* Settings for data length to trap on */
55#define DR_LEN_2 (0x4)
56#define DR_LEN_4 (0xC)
57#ifdef __x86_64__
58# define DR_LEN_8 (0x8)
59#endif
60
61/* The low byte to the control register determine which registers are
62 enabled. There are 4 fields of two bits. One bit is "local", meaning
63 that the processor will reset the bit after a task switch and the other
64 is global meaning that we have to explicitly reset the bit. With linux,
65 you can use either one, since we explicitly zero the register when we enter
66 kernel mode. */
67
68#define DR_LOCAL_ENABLE_SHIFT 0 /* Extra shift to the local enable bit */
69#define DR_GLOBAL_ENABLE_SHIFT 1 /* Extra shift to the global enable bit */
70#define DR_ENABLE_SIZE 2 /* 2 enable bits per register */
71
72#define DR_LOCAL_ENABLE_MASK (0x55) /* Set local bits for all 4 regs */
73#define DR_GLOBAL_ENABLE_MASK (0xAA) /* Set global bits for all 4 regs */
74
75/* The second byte to the control register has a few special
76 things. */
77
78
79
80#ifdef __x86_64__
81# define DR_CONTROL_RESERVED (0xFFFFFFFF0000FC00ULL) /* Reserved */
82#else
83# define DR_CONTROL_RESERVED (0x00FC00U) /* Reserved */
84#endif
85#define DR_LOCAL_SLOWDOWN (0x100) /* Local slow the pipeline */
86#define DR_GLOBAL_SLOWDOWN (0x200) /* Global slow the pipeline */
87
88#endif /* sys/debugreg.h */