Skip to contentSkip to conversation

arm64/ptrace: Make user_hwdebug_state.dbg_regs[] array size as ARM_MAX_BRP

PATCH In review Anshuman Khandual 2 participants 5 messages Apr 21, 2025 – May 30, 2025

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 arm64/ptrace: Make user_hwdebug_state.dbg_regs[] array size as ARM_MAX_BRP

Array elements inside 'struct user_hwdebug_state.dbg_regs[]' are inherently coupled with maximum breakpoints or watchpoints which could be present on a platform and which are defined with macros ARM_MAX_[BRP|WRP].

Rather than explicitly trying to keep the array elements in sync with these macros and then adding a BUILD_BUG_ON() just to ensure continued compliance , move these two macros into the uapi ptrace header itself thus making them available both for user space and kernel.

While here also ensure that ARM_MAX_BRP and ARM_MAX_WRP are always the same via a new BUILD_BUG_ON(). This helps in making sure that user_hwdebug_state structure remains usable both for breakpoint and watchpoint registers set via ptrace() system call interface.

---
This patch applies on v6.15-rc3

 arch/arm64/include/asm/hw_breakpoint.h |  7 -------
 arch/arm64/include/uapi/asm/ptrace.h   | 10 +++++++++-
 arch/arm64/kernel/hw_breakpoint.c      |  9 +++++++++
 3 files changed, 18 insertions(+), 8 deletions(-)
arch/arm64/include/asm/hw_breakpoint.h +0 -7
index bd81cf17744a..63c21b515647 100644
@@ -75,13 +75,6 @@ static inline void decode_ctrl_reg(u32 reg,
 #define ARM_KERNEL_STEP_ACTIVE	1
 #define ARM_KERNEL_STEP_SUSPEND	2
 
-/*
- * Limits.
- * Changing these will require modifications to the register accessors.
- */
-#define ARM_MAX_BRP		16
-#define ARM_MAX_WRP		16
-
 /* Virtual debug register bases. */
 #define AARCH64_DBG_REG_BVR	0
 #define AARCH64_DBG_REG_BCR	(AARCH64_DBG_REG_BVR + ARM_MAX_BRP)
arch/arm64/include/uapi/asm/ptrace.h +9 -1
index 0f39ba4f3efd..8683f541a467 100644
@@ -99,6 +99,14 @@ struct user_fpsimd_state {
 	__u32		__reserved[2];
 };
 
+/*
+ * Maximum number of breakpoint and watchpoint registers
+ * on the platform. These macros get used both in kernel
+ * and user space as well.
+ */
+#define ARM_MAX_BRP		16
+#define ARM_MAX_WRP		16
+
 struct user_hwdebug_state {
 	__u32		dbg_info;
 	__u32		pad;
@@ -106,7 +114,7 @@ struct user_hwdebug_state {
 		__u64	addr;
 		__u32	ctrl;
 		__u32	pad;
-	}		dbg_regs[16];
+	}		dbg_regs[ARM_MAX_BRP];	/* Or ARM_MAX_WRP */
 };
 
 /* SVE/FP/SIMD state (NT_ARM_SVE & NT_ARM_SSVE) */
arch/arm64/kernel/hw_breakpoint.c +9 -0
index 722ac45f9f7b..9bc51682713d 100644
@@ -981,6 +981,15 @@ static int __init arch_hw_breakpoint_init(void)
 {
 	int ret;
 
+	/*
+	 * Maximum supported breakpoint and watchpoint registers must
+	 * always be the same - regardless of actual register numbers
+	 * found on a given platform. This is because the user facing
+	 * ptrace structure 'user_hwdebug_state' actually depends on
+	 * these macros to be the same.
+	 */
+	BUILD_BUG_ON(ARM_MAX_BRP != ARM_MAX_WRP);
+
 	core_num_brps = get_num_brps();
 	core_num_wrps = get_num_wrps();
 
Signature · 1 line
2.25.1
#1 lore raw
Quoted 21 lines · Anshuman Khandual

Array elements inside 'struct user_hwdebug_state.dbg_regs[]' are inherently coupled with maximum breakpoints or watchpoints which could be present on a platform and which are defined with macros ARM_MAX_[BRP|WRP].

Rather than explicitly trying to keep the array elements in sync with these macros and then adding a BUILD_BUG_ON() just to ensure continued compliance , move these two macros into the uapi ptrace header itself thus making them available both for user space and kernel.

While here also ensure that ARM_MAX_BRP and ARM_MAX_WRP are always the same via a new BUILD_BUG_ON(). This helps in making sure that user_hwdebug_state structure remains usable both for breakpoint and watchpoint registers set via ptrace() system call interface.

Quoted 2 lines

---
This patch applies on v6.15-rc3

Gentle ping, any updates on this.

Quoted 72 lines
 arch/arm64/include/asm/hw_breakpoint.h |  7 -------
 arch/arm64/include/uapi/asm/ptrace.h   | 10 +++++++++-
 arch/arm64/kernel/hw_breakpoint.c      |  9 +++++++++
 3 files changed, 18 insertions(+), 8 deletions(-)
arch/arm64/include/asm/hw_breakpoint.h +0 -7
index bd81cf17744a..63c21b515647 100644
@@ -75,13 +75,6 @@ static inline void decode_ctrl_reg(u32 reg,
 #define ARM_KERNEL_STEP_ACTIVE	1
 #define ARM_KERNEL_STEP_SUSPEND	2
 
-/*
- * Limits.
- * Changing these will require modifications to the register accessors.
- */
-#define ARM_MAX_BRP		16
-#define ARM_MAX_WRP		16
-
 /* Virtual debug register bases. */
 #define AARCH64_DBG_REG_BVR	0
 #define AARCH64_DBG_REG_BCR	(AARCH64_DBG_REG_BVR + ARM_MAX_BRP)
arch/arm64/include/uapi/asm/ptrace.h +9 -1
index 0f39ba4f3efd..8683f541a467 100644
@@ -99,6 +99,14 @@ struct user_fpsimd_state {
 	__u32		__reserved[2];
 };
 
+/*
+ * Maximum number of breakpoint and watchpoint registers
+ * on the platform. These macros get used both in kernel
+ * and user space as well.
+ */
+#define ARM_MAX_BRP		16
+#define ARM_MAX_WRP		16
+
 struct user_hwdebug_state {
 	__u32		dbg_info;
 	__u32		pad;
@@ -106,7 +114,7 @@ struct user_hwdebug_state {
 		__u64	addr;
 		__u32	ctrl;
 		__u32	pad;
-	}		dbg_regs[16];
+	}		dbg_regs[ARM_MAX_BRP];	/* Or ARM_MAX_WRP */
 };
 
 /* SVE/FP/SIMD state (NT_ARM_SVE & NT_ARM_SSVE) */
arch/arm64/kernel/hw_breakpoint.c +9 -0
index 722ac45f9f7b..9bc51682713d 100644
@@ -981,6 +981,15 @@ static int __init arch_hw_breakpoint_init(void)
 {
 	int ret;
 
+	/*
+	 * Maximum supported breakpoint and watchpoint registers must
+	 * always be the same - regardless of actual register numbers
+	 * found on a given platform. This is because the user facing
+	 * ptrace structure 'user_hwdebug_state' actually depends on
+	 * these macros to be the same.
+	 */
+	BUILD_BUG_ON(ARM_MAX_BRP != ARM_MAX_WRP);
+
 	core_num_brps = get_num_brps();
 	core_num_wrps = get_num_wrps();
 
maintainer
#2 lore raw
In reply to Anshuman Khandual
Quoted 81 lines · Anshuman Khandual

Array elements inside 'struct user_hwdebug_state.dbg_regs[]' are inherently coupled with maximum breakpoints or watchpoints which could be present on a platform and which are defined with macros ARM_MAX_[BRP|WRP].

Rather than explicitly trying to keep the array elements in sync with these macros and then adding a BUILD_BUG_ON() just to ensure continued compliance , move these two macros into the uapi ptrace header itself thus making them available both for user space and kernel.

While here also ensure that ARM_MAX_BRP and ARM_MAX_WRP are always the same via a new BUILD_BUG_ON(). This helps in making sure that user_hwdebug_state structure remains usable both for breakpoint and watchpoint registers set via ptrace() system call interface.

---
This patch applies on v6.15-rc3

 arch/arm64/include/asm/hw_breakpoint.h |  7 -------
 arch/arm64/include/uapi/asm/ptrace.h   | 10 +++++++++-
 arch/arm64/kernel/hw_breakpoint.c      |  9 +++++++++
 3 files changed, 18 insertions(+), 8 deletions(-)
arch/arm64/include/asm/hw_breakpoint.h +0 -7
index bd81cf17744a..63c21b515647 100644
@@ -75,13 +75,6 @@ static inline void decode_ctrl_reg(u32 reg,
 #define ARM_KERNEL_STEP_ACTIVE	1
 #define ARM_KERNEL_STEP_SUSPEND	2
 
-/*
- * Limits.
- * Changing these will require modifications to the register accessors.
- */
-#define ARM_MAX_BRP		16
-#define ARM_MAX_WRP		16
-
 /* Virtual debug register bases. */
 #define AARCH64_DBG_REG_BVR	0
 #define AARCH64_DBG_REG_BCR	(AARCH64_DBG_REG_BVR + ARM_MAX_BRP)
arch/arm64/include/uapi/asm/ptrace.h +9 -1
index 0f39ba4f3efd..8683f541a467 100644
@@ -99,6 +99,14 @@ struct user_fpsimd_state {
 	__u32		__reserved[2];
 };
 
+/*
+ * Maximum number of breakpoint and watchpoint registers
+ * on the platform. These macros get used both in kernel
+ * and user space as well.
+ */
+#define ARM_MAX_BRP		16
+#define ARM_MAX_WRP		16
+
 struct user_hwdebug_state {
 	__u32		dbg_info;
 	__u32		pad;
@@ -106,7 +114,7 @@ struct user_hwdebug_state {
 		__u64	addr;
 		__u32	ctrl;
 		__u32	pad;
-	}		dbg_regs[16];
+	}		dbg_regs[ARM_MAX_BRP];	/* Or ARM_MAX_WRP */
 };
 
 /* SVE/FP/SIMD state (NT_ARM_SVE & NT_ARM_SSVE) */
arch/arm64/kernel/hw_breakpoint.c +0 -0
index 722ac45f9f7b..9bc51682713d 100644
@@ -981,6 +981,15 @@ static int __init arch_hw_breakpoint_init(void)
 {

arch/arm64/kernel/hw_breakpoint.c static int __init arch_hw_breakpoint_init(void) · line 991

Quoted 10 lines
arch/arm64/kernel/hw_breakpoint.c +8 -0
 	int ret;
 
+	/*
+	 * Maximum supported breakpoint and watchpoint registers must
+	 * always be the same - regardless of actual register numbers
+	 * found on a given platform. This is because the user facing
+	 * ptrace structure 'user_hwdebug_state' actually depends on
+	 * these macros to be the same.
+	 */
+	BUILD_BUG_ON(ARM_MAX_BRP != ARM_MAX_WRP);

Sorry, but I don't understand why this patch is an improvement over what we have.

Will

#3 lore raw
Quoted 84 lines · Will Deacon
Quoted 83 lines · Anshuman Khandual

Array elements inside 'struct user_hwdebug_state.dbg_regs[]' are inherently coupled with maximum breakpoints or watchpoints which could be present on a platform and which are defined with macros ARM_MAX_[BRP|WRP].

Rather than explicitly trying to keep the array elements in sync with these macros and then adding a BUILD_BUG_ON() just to ensure continued compliance , move these two macros into the uapi ptrace header itself thus making them available both for user space and kernel.

While here also ensure that ARM_MAX_BRP and ARM_MAX_WRP are always the same via a new BUILD_BUG_ON(). This helps in making sure that user_hwdebug_state structure remains usable both for breakpoint and watchpoint registers set via ptrace() system call interface.

---
This patch applies on v6.15-rc3

 arch/arm64/include/asm/hw_breakpoint.h |  7 -------
 arch/arm64/include/uapi/asm/ptrace.h   | 10 +++++++++-
 arch/arm64/kernel/hw_breakpoint.c      |  9 +++++++++
 3 files changed, 18 insertions(+), 8 deletions(-)
arch/arm64/include/asm/hw_breakpoint.h +0 -7
index bd81cf17744a..63c21b515647 100644
@@ -75,13 +75,6 @@ static inline void decode_ctrl_reg(u32 reg,
 #define ARM_KERNEL_STEP_ACTIVE	1
 #define ARM_KERNEL_STEP_SUSPEND	2
 
-/*
- * Limits.
- * Changing these will require modifications to the register accessors.
- */
-#define ARM_MAX_BRP		16
-#define ARM_MAX_WRP		16
-
 /* Virtual debug register bases. */
 #define AARCH64_DBG_REG_BVR	0
 #define AARCH64_DBG_REG_BCR	(AARCH64_DBG_REG_BVR + ARM_MAX_BRP)
arch/arm64/include/uapi/asm/ptrace.h +9 -1
index 0f39ba4f3efd..8683f541a467 100644
@@ -99,6 +99,14 @@ struct user_fpsimd_state {
 	__u32		__reserved[2];
 };
 
+/*
+ * Maximum number of breakpoint and watchpoint registers
+ * on the platform. These macros get used both in kernel
+ * and user space as well.
+ */
+#define ARM_MAX_BRP		16
+#define ARM_MAX_WRP		16
+
 struct user_hwdebug_state {
 	__u32		dbg_info;
 	__u32		pad;
@@ -106,7 +114,7 @@ struct user_hwdebug_state {
 		__u64	addr;
 		__u32	ctrl;
 		__u32	pad;
-	}		dbg_regs[16];
+	}		dbg_regs[ARM_MAX_BRP];	/* Or ARM_MAX_WRP */
 };
 
 /* SVE/FP/SIMD state (NT_ARM_SVE & NT_ARM_SSVE) */
arch/arm64/kernel/hw_breakpoint.c +0 -0
index 722ac45f9f7b..9bc51682713d 100644
@@ -981,6 +981,15 @@ static int __init arch_hw_breakpoint_init(void)
 {
 	int ret;
 
Quoted 11 lines

arch/arm64/kernel/hw_breakpoint.c static int __init arch_hw_breakpoint_init(void) · line 991

Quoted 8 lines
arch/arm64/kernel/hw_breakpoint.c +8 -0
+	/*
+	 * Maximum supported breakpoint and watchpoint registers must
+	 * always be the same - regardless of actual register numbers
+	 * found on a given platform. This is because the user facing
+	 * ptrace structure 'user_hwdebug_state' actually depends on
+	 * these macros to be the same.
+	 */
+	BUILD_BUG_ON(ARM_MAX_BRP != ARM_MAX_WRP);

Sorry, but I don't understand why this patch is an improvement over what we have.

This is an improvement because

- user_hwdebug_state.dbg_regs[16] is hard coded for size without context requiring explicit sync up when ARM_MAX_WRP/BRP changes to 64 later on with FEAT_Debugv8p9. Defining the array size in terms of ARM_MAX_WRP/ BRP provides required context and also avoids the need for an explicit hard coded sync up when those macros change.

- user_hwdebug_state.dbg_regs[16] gets used both for breakpoint registers and watchpoint registers. Hence there is an inherent assumption that ARM_MAX_BRP == ARM_MAX_WRP which should be ensured with a corresponding assert.

maintainer
#4 lore raw
Quoted 106 lines · Anshuman Khandual
Quoted 84 lines · Will Deacon
Quoted 83 lines · Anshuman Khandual

Array elements inside 'struct user_hwdebug_state.dbg_regs[]' are inherently coupled with maximum breakpoints or watchpoints which could be present on a platform and which are defined with macros ARM_MAX_[BRP|WRP].

Rather than explicitly trying to keep the array elements in sync with these macros and then adding a BUILD_BUG_ON() just to ensure continued compliance , move these two macros into the uapi ptrace header itself thus making them available both for user space and kernel.

While here also ensure that ARM_MAX_BRP and ARM_MAX_WRP are always the same via a new BUILD_BUG_ON(). This helps in making sure that user_hwdebug_state structure remains usable both for breakpoint and watchpoint registers set via ptrace() system call interface.

---
This patch applies on v6.15-rc3

 arch/arm64/include/asm/hw_breakpoint.h |  7 -------
 arch/arm64/include/uapi/asm/ptrace.h   | 10 +++++++++-
 arch/arm64/kernel/hw_breakpoint.c      |  9 +++++++++
 3 files changed, 18 insertions(+), 8 deletions(-)
arch/arm64/include/asm/hw_breakpoint.h +0 -7
index bd81cf17744a..63c21b515647 100644
@@ -75,13 +75,6 @@ static inline void decode_ctrl_reg(u32 reg,
 #define ARM_KERNEL_STEP_ACTIVE	1
 #define ARM_KERNEL_STEP_SUSPEND	2
 
-/*
- * Limits.
- * Changing these will require modifications to the register accessors.
- */
-#define ARM_MAX_BRP		16
-#define ARM_MAX_WRP		16
-
 /* Virtual debug register bases. */
 #define AARCH64_DBG_REG_BVR	0
 #define AARCH64_DBG_REG_BCR	(AARCH64_DBG_REG_BVR + ARM_MAX_BRP)
arch/arm64/include/uapi/asm/ptrace.h +9 -1
index 0f39ba4f3efd..8683f541a467 100644
@@ -99,6 +99,14 @@ struct user_fpsimd_state {
 	__u32		__reserved[2];
 };
 
+/*
+ * Maximum number of breakpoint and watchpoint registers
+ * on the platform. These macros get used both in kernel
+ * and user space as well.
+ */
+#define ARM_MAX_BRP		16
+#define ARM_MAX_WRP		16
+
 struct user_hwdebug_state {
 	__u32		dbg_info;
 	__u32		pad;
@@ -106,7 +114,7 @@ struct user_hwdebug_state {
 		__u64	addr;
 		__u32	ctrl;
 		__u32	pad;
-	}		dbg_regs[16];
+	}		dbg_regs[ARM_MAX_BRP];	/* Or ARM_MAX_WRP */
 };
 
 /* SVE/FP/SIMD state (NT_ARM_SVE & NT_ARM_SSVE) */
arch/arm64/kernel/hw_breakpoint.c +0 -0
index 722ac45f9f7b..9bc51682713d 100644
@@ -981,6 +981,15 @@ static int __init arch_hw_breakpoint_init(void)
 {
 	int ret;
 
Quoted 11 lines

arch/arm64/kernel/hw_breakpoint.c static int __init arch_hw_breakpoint_init(void) · line 991

Quoted 8 lines
arch/arm64/kernel/hw_breakpoint.c +8 -0
+	/*
+	 * Maximum supported breakpoint and watchpoint registers must
+	 * always be the same - regardless of actual register numbers
+	 * found on a given platform. This is because the user facing
+	 * ptrace structure 'user_hwdebug_state' actually depends on
+	 * these macros to be the same.
+	 */
+	BUILD_BUG_ON(ARM_MAX_BRP != ARM_MAX_WRP);

Sorry, but I don't understand why this patch is an improvement over what we have.

This is an improvement because

- user_hwdebug_state.dbg_regs[16] is hard coded for size without context requiring explicit sync up when ARM_MAX_WRP/BRP changes to 64 later on with FEAT_Debugv8p9. Defining the array size in terms of ARM_MAX_WRP/ BRP provides required context and also avoids the need for an explicit hard coded sync up when those macros change.

Quoted 4 lines

- user_hwdebug_state.dbg_regs[16] gets used both for breakpoint registers and watchpoint registers. Hence there is an inherent assumption that ARM_MAX_BRP == ARM_MAX_WRP which should be ensured with a corresponding assert.

Sorry, but I still don't see it. Plus, this is a UAPI header so I think it's no bad thing to require an "explicit sync up", assuming we can actually change this structure at all.

Let's leave the code as it is, please.

Will