blob: f3b61b4ee09cf45429f23a05c3aff4dc72950fff [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
Sandeepa Prabhuaf78ced2016-07-08 12:35:54 -040049#ifdef CONFIG_ARM64
50 pr_info("<%s> pre_handler: p->addr = 0x%p, pc = 0x%lx,"
51 " pstate = 0x%lx\n",
52 p->symbol_name, p->addr, (long)regs->pc, (long)regs->pstate);
53#endif
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080054
55 /* A dump_stack() here will give a stack backtrace */
56 return 0;
57}
58
59/* kprobe post_handler: called after the probed instruction is executed */
60static void handler_post(struct kprobe *p, struct pt_regs *regs,
61 unsigned long flags)
62{
63#ifdef CONFIG_X86
Huang Shijieea9b5012016-05-20 17:04:36 -070064 printk(KERN_INFO "<%s> post_handler: p->addr = 0x%p, flags = 0x%lx\n",
65 p->symbol_name, p->addr, regs->flags);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080066#endif
67#ifdef CONFIG_PPC
Huang Shijieea9b5012016-05-20 17:04:36 -070068 printk(KERN_INFO "<%s> post_handler: p->addr = 0x%p, msr = 0x%lx\n",
69 p->symbol_name, p->addr, regs->msr);
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080070#endif
David Daney8a149232010-08-03 11:22:21 -070071#ifdef CONFIG_MIPS
Huang Shijieea9b5012016-05-20 17:04:36 -070072 printk(KERN_INFO "<%s> post_handler: p->addr = 0x%p, status = 0x%lx\n",
73 p->symbol_name, p->addr, regs->cp0_status);
David Daney8a149232010-08-03 11:22:21 -070074#endif
Tony Lu3fa17c32013-08-09 15:08:57 -040075#ifdef CONFIG_TILEGX
Huang Shijieea9b5012016-05-20 17:04:36 -070076 printk(KERN_INFO "<%s> post_handler: p->addr = 0x%p, ex1 = 0x%lx\n",
77 p->symbol_name, p->addr, regs->ex1);
Tony Lu3fa17c32013-08-09 15:08:57 -040078#endif
Sandeepa Prabhuaf78ced2016-07-08 12:35:54 -040079#ifdef CONFIG_ARM64
80 pr_info("<%s> post_handler: p->addr = 0x%p, pstate = 0x%lx\n",
81 p->symbol_name, p->addr, (long)regs->pstate);
82#endif
Ananth N Mavinakayanahalli804defe2008-03-04 14:28:38 -080083}
84
85/*
86 * fault_handler: this is called if an exception is generated for any
87 * instruction within the pre- or post-handler, or when Kprobes
88 * single-steps the probed instruction.
89 */
90static int handler_fault(struct kprobe *p, struct pt_regs *regs, int trapnr)
91{
92 printk(KERN_INFO "fault_handler: p->addr = 0x%p, trap #%dn",
93 p->addr, trapnr);
94 /* Return 0 because we don't handle the fault. */
95 return 0;
96}
97
98static int __init kprobe_init(void)
99{
100 int ret;
101 kp.pre_handler = handler_pre;
102 kp.post_handler = handler_post;
103 kp.fault_handler = handler_fault;
104
105 ret = register_kprobe(&kp);
106 if (ret < 0) {
107 printk(KERN_INFO "register_kprobe failed, returned %d\n", ret);
108 return ret;
109 }
110 printk(KERN_INFO "Planted kprobe at %p\n", kp.addr);
111 return 0;
112}
113
114static void __exit kprobe_exit(void)
115{
116 unregister_kprobe(&kp);
117 printk(KERN_INFO "kprobe at %p unregistered\n", kp.addr);
118}
119
120module_init(kprobe_init)
121module_exit(kprobe_exit)
122MODULE_LICENSE("GPL");