blob: 88b3e2d227ae3bc1534fc8146fa66ac14887ecc1 [file] [log] [blame]
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -08001/*
2 * NOTE: This example is works on x86 and powerpc.
3 * Here's a sample kernel module showing the use of kprobes to dump a
Petr Mladek54aea452015-10-01 15:37:11 -07004 * stack trace and selected registers when _do_fork() is called.
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -08005 *
6 * For more information on theory of operation of kprobes, see
7 * Documentation/kprobes.txt
8 *
9 * You will see the trace data in /var/log/messages and on the console
Petr Mladek54aea452015-10-01 15:37:11 -070010 * whenever _do_fork() is invoked to create a new process.
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080011 */
12
13#include <linux/kernel.h>
14#include <linux/module.h>
15#include <linux/kprobes.h>
16
Huang Shijied04659a2016-05-20 17:04:33 -070017#define MAX_SYMBOL_LEN 64
18static char symbol[MAX_SYMBOL_LEN] = "_do_fork";
19module_param_string(symbol, symbol, sizeof(symbol), 0644);
20
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080021/* For each probe you need to allocate a kprobe structure */
22static struct kprobe kp = {
Huang Shijied04659a2016-05-20 17:04:33 -070023 .symbol_name = symbol,
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080024};
25
26/* kprobe pre_handler: called just before the probed instruction is executed */
27static int handler_pre(struct kprobe *p, struct pt_regs *regs)
28{
29#ifdef CONFIG_X86
Huang Shijiee708c142016-08-03 13:46:03 -070030 pr_info("<%s> pre_handler: p->addr = 0x%p, ip = %lx, flags = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070031 p->symbol_name, p->addr, regs->ip, regs->flags);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080032#endif
33#ifdef CONFIG_PPC
Huang Shijiee708c142016-08-03 13:46:03 -070034 pr_info("<%s> pre_handler: p->addr = 0x%p, nip = 0x%lx, msr = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070035 p->symbol_name, p->addr, regs->nip, regs->msr);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080036#endif
David Daney8a149232010-08-03 11:22:21 -070037#ifdef CONFIG_MIPS
Huang Shijiee708c142016-08-03 13:46:03 -070038 pr_info("<%s> pre_handler: p->addr = 0x%p, epc = 0x%lx, status = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070039 p->symbol_name, p->addr, regs->cp0_epc, regs->cp0_status);
David Daney8a149232010-08-03 11:22:21 -070040#endif
Tony Lu3fa17c32013-08-09 15:08:57 -040041#ifdef CONFIG_TILEGX
Huang Shijiee708c142016-08-03 13:46:03 -070042 pr_info("<%s> pre_handler: p->addr = 0x%p, pc = 0x%lx, ex1 = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070043 p->symbol_name, p->addr, regs->pc, regs->ex1);
Tony Lu3fa17c32013-08-09 15:08:57 -040044#endif
Sandeepa Prabhuaf78ced2016-07-08 12:35:54 -040045#ifdef CONFIG_ARM64
46 pr_info("<%s> pre_handler: p->addr = 0x%p, pc = 0x%lx,"
47 " pstate = 0x%lx\n",
48 p->symbol_name, p->addr, (long)regs->pc, (long)regs->pstate);
49#endif
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080050
51 /* A dump_stack() here will give a stack backtrace */
52 return 0;
53}
54
55/* kprobe post_handler: called after the probed instruction is executed */
56static void handler_post(struct kprobe *p, struct pt_regs *regs,
57 unsigned long flags)
58{
59#ifdef CONFIG_X86
Huang Shijiee708c142016-08-03 13:46:03 -070060 pr_info("<%s> post_handler: p->addr = 0x%p, flags = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070061 p->symbol_name, p->addr, regs->flags);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080062#endif
63#ifdef CONFIG_PPC
Huang Shijiee708c142016-08-03 13:46:03 -070064 pr_info("<%s> post_handler: p->addr = 0x%p, msr = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070065 p->symbol_name, p->addr, regs->msr);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080066#endif
David Daney8a149232010-08-03 11:22:21 -070067#ifdef CONFIG_MIPS
Huang Shijiee708c142016-08-03 13:46:03 -070068 pr_info("<%s> post_handler: p->addr = 0x%p, status = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070069 p->symbol_name, p->addr, regs->cp0_status);
David Daney8a149232010-08-03 11:22:21 -070070#endif
Tony Lu3fa17c32013-08-09 15:08:57 -040071#ifdef CONFIG_TILEGX
Huang Shijiee708c142016-08-03 13:46:03 -070072 pr_info("<%s> post_handler: p->addr = 0x%p, ex1 = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070073 p->symbol_name, p->addr, regs->ex1);
Tony Lu3fa17c32013-08-09 15:08:57 -040074#endif
Sandeepa Prabhuaf78ced2016-07-08 12:35:54 -040075#ifdef CONFIG_ARM64
76 pr_info("<%s> post_handler: p->addr = 0x%p, pstate = 0x%lx\n",
77 p->symbol_name, p->addr, (long)regs->pstate);
78#endif
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080079}
80
81/*
82 * fault_handler: this is called if an exception is generated for any
83 * instruction within the pre- or post-handler, or when Kprobes
84 * single-steps the probed instruction.
85 */
86static int handler_fault(struct kprobe *p, struct pt_regs *regs, int trapnr)
87{
Huang Shijiee708c142016-08-03 13:46:03 -070088 pr_info("fault_handler: p->addr = 0x%p, trap #%dn", p->addr, trapnr);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080089 /* Return 0 because we don't handle the fault. */
90 return 0;
91}
92
93static int __init kprobe_init(void)
94{
95 int ret;
96 kp.pre_handler = handler_pre;
97 kp.post_handler = handler_post;
98 kp.fault_handler = handler_fault;
99
100 ret = register_kprobe(&kp);
101 if (ret < 0) {
Huang Shijiee708c142016-08-03 13:46:03 -0700102 pr_err("register_kprobe failed, returned %d\n", ret);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -0800103 return ret;
104 }
Huang Shijiee708c142016-08-03 13:46:03 -0700105 pr_info("Planted kprobe at %p\n", kp.addr);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -0800106 return 0;
107}
108
109static void __exit kprobe_exit(void)
110{
111 unregister_kprobe(&kp);
Huang Shijiee708c142016-08-03 13:46:03 -0700112 pr_info("kprobe at %p unregistered\n", kp.addr);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -0800113}
114
115module_init(kprobe_init)
116module_exit(kprobe_exit)
117MODULE_LICENSE("GPL");