Skip to contentSkip to conversation

hw_breakpoint: remove sample code from hw_breakpoint.h

PATCH In review Li Zefan 2 participants 3 messages Jul 7, 2009 – Jul 13, 2009 Generic include/asm header files

lore
Share & tools
lore

Li Zefan

author
#0 lore raw

PATCH 1/1 hw_breakpoint: remove sample code from hw_breakpoint.h

The sample code is a bit out-dated, and there's already a sample in sample/hw_breakpoint/.

---
 include/asm-generic/hw_breakpoint.h |   41 +---------------------------------
 1 files changed, 2 insertions(+), 39 deletions(-)
include/asm-generic/hw_breakpoint.h +2 -39
index 9bf2d12..30ab37c 100644
@@ -60,45 +60,8 @@
  * Breakpoints are disabled during execution @triggered, to avoid
  * recursive traps and allow unhindered access to breakpointed memory.
  *
- * This sample code sets a breakpoint on pid_max and registers a callback
- * function for writes to that variable.  Note that it is not portable
- * as written, because not all architectures support HW_BREAKPOINT_LEN_4.
- *
- * ----------------------------------------------------------------------
- *
- * #include <asm/hw_breakpoint.h>
- *
- * struct hw_breakpoint my_bp;
- *
- * static void my_triggered(struct hw_breakpoint *bp, struct pt_regs *regs)
- * {
- * 	printk(KERN_DEBUG "Inside triggered routine of breakpoint exception\n");
- * 	dump_stack();
- *  	.......<more debugging output>........
- * }
- *
- * static struct hw_breakpoint my_bp;
- *
- * static int init_module(void)
- * {
- *	..........<do anything>............
- *	my_bp.info.type = HW_BREAKPOINT_WRITE;
- *	my_bp.info.len = HW_BREAKPOINT_LEN_4;
- *
- *	my_bp.installed = (void *)my_bp_installed;
- *
- *	rc = register_kernel_hw_breakpoint(&my_bp);
- *	..........<do anything>............
- * }
- *
- * static void cleanup_module(void)
- * {
- *	..........<do anything>............
- *	unregister_kernel_hw_breakpoint(&my_bp);
- *	..........<do anything>............
- * }
- *
- * ----------------------------------------------------------------------
+ * See sample/hw_breakpoint/ for a sample that sets a breakpoint on
+ * a specified kernel symbol.
  */
 struct hw_breakpoint {
 	void (*triggered)(struct hw_breakpoint *, struct pt_regs *);
Signature · 1 line
1.5.4.rc3
#1 lore raw
Quoted 2 lines · Li Zefan

The sample code is a bit out-dated, and there's already a sample in sample/hw_breakpoint/.

IMHO these bits of comments are useful and don't overlap the role of the samples in sample/
They only stand there as a quick summup.

No?

Quoted 59 lines
---
 include/asm-generic/hw_breakpoint.h |   41 +---------------------------------
 1 files changed, 2 insertions(+), 39 deletions(-)
include/asm-generic/hw_breakpoint.h +2 -39
index 9bf2d12..30ab37c 100644
@@ -60,45 +60,8 @@
  * Breakpoints are disabled during execution @triggered, to avoid
  * recursive traps and allow unhindered access to breakpointed memory.
  *
- * This sample code sets a breakpoint on pid_max and registers a callback
- * function for writes to that variable.  Note that it is not portable
- * as written, because not all architectures support HW_BREAKPOINT_LEN_4.
- *
- * ----------------------------------------------------------------------
- *
- * #include <asm/hw_breakpoint.h>
- *
- * struct hw_breakpoint my_bp;
- *
- * static void my_triggered(struct hw_breakpoint *bp, struct pt_regs *regs)
- * {
- * 	printk(KERN_DEBUG "Inside triggered routine of breakpoint exception\n");
- * 	dump_stack();
- *  	.......<more debugging output>........
- * }
- *
- * static struct hw_breakpoint my_bp;
- *
- * static int init_module(void)
- * {
- *	..........<do anything>............
- *	my_bp.info.type = HW_BREAKPOINT_WRITE;
- *	my_bp.info.len = HW_BREAKPOINT_LEN_4;
- *
- *	my_bp.installed = (void *)my_bp_installed;
- *
- *	rc = register_kernel_hw_breakpoint(&my_bp);
- *	..........<do anything>............
- * }
- *
- * static void cleanup_module(void)
- * {
- *	..........<do anything>............
- *	unregister_kernel_hw_breakpoint(&my_bp);
- *	..........<do anything>............
- * }
- *
- * ----------------------------------------------------------------------
+ * See sample/hw_breakpoint/ for a sample that sets a breakpoint on
+ * a specified kernel symbol.
  */
 struct hw_breakpoint {
 	void (*triggered)(struct hw_breakpoint *, struct pt_regs *);
Signature · 1 line
1.5.4.rc3
author
#2 lore raw

(sorry for the late reply, I didn't see this mail..)

Quoted 11 lines · Frederic Weisbecker
Quoted 2 lines · Li Zefan

The sample code is a bit out-dated, and there's already a sample in sample/hw_breakpoint/.

IMHO these bits of comments are useful and don't overlap the role of the samples in sample/
They only stand there as a quick summup.

No?

The sample here sets a breakpoint on pid_max, which is what the sample in sample/ does.

And the code here is out-dated (and incomplete). We can fix it, but whenver someone changes the APIs, he may forget to update the comments. We know comments never catch up with code.

So I inclined to delete it, and add a link to sample/.