blob: ed0ca0c072427faeedaae38a0e21531a18d91db4 [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 Shijieea9b5012016-05-20 17:04:36 -070030 printk(KERN_INFO "<%s> pre_handler: p->addr = 0x%p, ip = %lx,"
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080031 " flags = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070032 p->symbol_name, p->addr, regs->ip, regs->flags);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080033#endif
34#ifdef CONFIG_PPC
Huang Shijieea9b5012016-05-20 17:04:36 -070035 printk(KERN_INFO "<%s> pre_handler: p->addr = 0x%p, nip = 0x%lx,"
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080036 " msr = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070037 p->symbol_name, p->addr, regs->nip, regs->msr);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080038#endif
David Daney8a149232010-08-03 11:22:21 -070039#ifdef CONFIG_MIPS
Huang Shijieea9b5012016-05-20 17:04:36 -070040 printk(KERN_INFO "<%s> pre_handler: p->addr = 0x%p, epc = 0x%lx,"
David Daney8a149232010-08-03 11:22:21 -070041 " status = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070042 p->symbol_name, p->addr, regs->cp0_epc, regs->cp0_status);
David Daney8a149232010-08-03 11:22:21 -070043#endif
Tony Lu3fa17c32013-08-09 15:08:57 -040044#ifdef CONFIG_TILEGX
Huang Shijieea9b5012016-05-20 17:04:36 -070045 printk(KERN_INFO "<%s> pre_handler: p->addr = 0x%p, pc = 0x%lx,"
Tony Lu3fa17c32013-08-09 15:08:57 -040046 " ex1 = 0x%lx\n",
Huang Shijieea9b5012016-05-20 17:04:36 -070047 p->symbol_name, p->addr, regs->pc, regs->ex1);
Tony Lu3fa17c32013-08-09 15:08:57 -040048#endif
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080049
50 /* A dump_stack() here will give a stack backtrace */
51 return 0;
52}
53
54/* kprobe post_handler: called after the probed instruction is executed */
55static void handler_post(struct kprobe *p, struct pt_regs *regs,
56 unsigned long flags)
57{
58#ifdef CONFIG_X86
Huang Shijieea9b5012016-05-20 17:04:36 -070059 printk(KERN_INFO "<%s> post_handler: p->addr = 0x%p, flags = 0x%lx\n",
60 p->symbol_name, p->addr, regs->flags);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080061#endif
62#ifdef CONFIG_PPC
Huang Shijieea9b5012016-05-20 17:04:36 -070063 printk(KERN_INFO "<%s> post_handler: p->addr = 0x%p, msr = 0x%lx\n",
64 p->symbol_name, p->addr, regs->msr);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080065#endif
David Daney8a149232010-08-03 11:22:21 -070066#ifdef CONFIG_MIPS
Huang Shijieea9b5012016-05-20 17:04:36 -070067 printk(KERN_INFO "<%s> post_handler: p->addr = 0x%p, status = 0x%lx\n",
68 p->symbol_name, p->addr, regs->cp0_status);
David Daney8a149232010-08-03 11:22:21 -070069#endif
Tony Lu3fa17c32013-08-09 15:08:57 -040070#ifdef CONFIG_TILEGX
Huang Shijieea9b5012016-05-20 17:04:36 -070071 printk(KERN_INFO "<%s> post_handler: p->addr = 0x%p, ex1 = 0x%lx\n",
72 p->symbol_name, p->addr, regs->ex1);
Tony Lu3fa17c32013-08-09 15:08:57 -040073#endif
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080074}
75
76/*
77 * fault_handler: this is called if an exception is generated for any
78 * instruction within the pre- or post-handler, or when Kprobes
79 * single-steps the probed instruction.
80 */
81static int handler_fault(struct kprobe *p, struct pt_regs *regs, int trapnr)
82{
83 printk(KERN_INFO "fault_handler: p->addr = 0x%p, trap #%dn",
84 p->addr, trapnr);
85 /* Return 0 because we don't handle the fault. */
86 return 0;
87}
88
89static int __init kprobe_init(void)
90{
91 int ret;
92 kp.pre_handler = handler_pre;
93 kp.post_handler = handler_post;
94 kp.fault_handler = handler_fault;
95
96 ret = register_kprobe(&kp);
97 if (ret < 0) {
98 printk(KERN_INFO "register_kprobe failed, returned %d\n", ret);
99 return ret;
100 }
101 printk(KERN_INFO "Planted kprobe at %p\n", kp.addr);
102 return 0;
103}
104
105static void __exit kprobe_exit(void)
106{
107 unregister_kprobe(&kp);
108 printk(KERN_INFO "kprobe at %p unregistered\n", kp.addr);
109}
110
111module_init(kprobe_init)
112module_exit(kprobe_exit)
113MODULE_LICENSE("GPL");