95063818bcf4969fd8087a35b2b21729cf6ef2f8
[linux-3.10.git] / samples / hw_breakpoint / data_breakpoint.c
1 /*
2  * data_breakpoint.c - Sample HW Breakpoint file to watch kernel data address
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program 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
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17  *
18  * usage: insmod data_breakpoint.ko ksym=<ksym_name>
19  *
20  * This file is a kernel module that places a breakpoint over ksym_name kernel
21  * variable using Hardware Breakpoint register. The corresponding handler which
22  * prints a backtrace is invoked everytime a write operation is performed on
23  * that variable.
24  *
25  * Copyright (C) IBM Corporation, 2009
26  *
27  * Author: K.Prasad <prasad@linux.vnet.ibm.com>
28  */
29 #include <linux/module.h>       /* Needed by all modules */
30 #include <linux/kernel.h>       /* Needed for KERN_INFO */
31 #include <linux/init.h>         /* Needed for the macros */
32 #include <linux/kallsyms.h>
33
34 #include <linux/perf_event.h>
35 #include <linux/hw_breakpoint.h>
36
37 struct perf_event **sample_hbp;
38
39 static char ksym_name[KSYM_NAME_LEN] = "pid_max";
40 module_param_string(ksym, ksym_name, KSYM_NAME_LEN, S_IRUGO);
41 MODULE_PARM_DESC(ksym, "Kernel symbol to monitor; this module will report any"
42                         " write operations on the kernel symbol");
43
44 static void sample_hbp_handler(struct perf_event *temp, void *data)
45 {
46         printk(KERN_INFO "%s value is changed\n", ksym_name);
47         dump_stack();
48         printk(KERN_INFO "Dump stack from sample_hbp_handler\n");
49 }
50
51 static int __init hw_break_module_init(void)
52 {
53         int ret;
54         unsigned long addr;
55
56         addr = kallsyms_lookup_name(ksym_name);
57
58         sample_hbp = register_wide_hw_breakpoint(addr, HW_BREAKPOINT_LEN_4,
59                                                  HW_BREAKPOINT_W | HW_BREAKPOINT_R,
60                                                  sample_hbp_handler, true);
61         if (IS_ERR(sample_hbp)) {
62                 ret = PTR_ERR(sample_hbp);
63                 goto fail;
64         } else if (!sample_hbp) {
65                 ret = -EINVAL;
66                 goto fail;
67         }
68
69         printk(KERN_INFO "HW Breakpoint for %s write installed\n", ksym_name);
70
71         return 0;
72
73 fail:
74         printk(KERN_INFO "Breakpoint registration failed\n");
75
76         return ret;
77 }
78
79 static void __exit hw_break_module_exit(void)
80 {
81         unregister_wide_hw_breakpoint(sample_hbp);
82         printk(KERN_INFO "HW Breakpoint for %s write uninstalled\n", ksym_name);
83 }
84
85 module_init(hw_break_module_init);
86 module_exit(hw_break_module_exit);
87
88 MODULE_LICENSE("GPL");
89 MODULE_AUTHOR("K.Prasad");
90 MODULE_DESCRIPTION("ksym breakpoint");