blob: 1f4f9b9d5c899969d393c54bacc7b4c99e1584ea [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Kernel Probes (KProbes)
3 * kernel/kprobes.c
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 *
19 * Copyright (C) IBM Corporation, 2002, 2004
20 *
21 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
22 * Probes initial implementation (includes suggestions from
23 * Rusty Russell).
24 * 2004-Aug Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
25 * hlists and exceptions notifier as suggested by Andi Kleen.
26 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
27 * interface to access function arguments.
28 * 2004-Sep Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
29 * exceptions notifier to be first on the priority list.
Hien Nguyenb94cce92005-06-23 00:09:19 -070030 * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
31 * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
32 * <prasanna@in.ibm.com> added function-return probes.
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 */
34#include <linux/kprobes.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/hash.h>
36#include <linux/init.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080037#include <linux/slab.h>
Randy Dunlape3869792007-05-08 00:27:01 -070038#include <linux/stddef.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <linux/module.h>
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070040#include <linux/moduleloader.h>
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070041#include <linux/kallsyms.h>
Masami Hiramatsub4c6c342006-12-06 20:38:11 -080042#include <linux/freezer.h>
Srinivasa Ds346fd592007-02-20 13:57:54 -080043#include <linux/seq_file.h>
44#include <linux/debugfs.h>
Masami Hiramatsub2be84d2010-02-25 08:34:15 -050045#include <linux/sysctl.h>
Christoph Hellwig1eeb66a2007-05-08 00:27:03 -070046#include <linux/kdebug.h>
Mathieu Desnoyers4460fda2009-03-06 10:36:38 -050047#include <linux/memory.h>
Masami Hiramatsu4554dbc2010-02-02 16:49:18 -050048#include <linux/ftrace.h>
Masami Hiramatsuafd66252010-02-25 08:34:07 -050049#include <linux/cpu.h>
Jason Baronbf5438fc2010-09-17 11:09:00 -040050#include <linux/jump_label.h>
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070051
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -070052#include <asm-generic/sections.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <asm/cacheflush.h>
54#include <asm/errno.h>
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070055#include <asm/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57#define KPROBE_HASH_BITS 6
58#define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
59
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070060
61/*
62 * Some oddball architectures like 64bit powerpc have function descriptors
63 * so this must be overridable.
64 */
65#ifndef kprobe_lookup_name
66#define kprobe_lookup_name(name, addr) \
67 addr = ((kprobe_opcode_t *)(kallsyms_lookup_name(name)))
68#endif
69
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070070static int kprobes_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
Hien Nguyenb94cce92005-06-23 00:09:19 -070072static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070074/* NOTE: change this value only with kprobe_mutex held */
Masami Hiramatsue579abe2009-04-06 19:01:01 -070075static bool kprobes_all_disarmed;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070076
Masami Hiramatsu43948f52010-10-25 22:18:01 +090077/* This protects kprobe_table and optimizing_list */
78static DEFINE_MUTEX(kprobe_mutex);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -080079static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070080static struct {
Andrew Morton7e036d02008-11-12 13:26:57 -080081 spinlock_t lock ____cacheline_aligned_in_smp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070082} kretprobe_table_locks[KPROBE_TABLE_SIZE];
83
84static spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
85{
86 return &(kretprobe_table_locks[hash].lock);
87}
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
Srinivasa Ds3d8d9962008-04-28 02:14:26 -070089/*
90 * Normally, functions that we'd want to prohibit kprobes in, are marked
91 * __kprobes. But, there are cases where such functions already belong to
92 * a different section (__sched for preempt_schedule)
93 *
94 * For such cases, we now have a blacklist
95 */
Daniel Guilak544304b2008-07-10 09:38:19 -070096static struct kprobe_blackpoint kprobe_blacklist[] = {
Srinivasa Ds3d8d9962008-04-28 02:14:26 -070097 {"preempt_schedule",},
Masami Hiramatsu65e234e2009-08-27 13:23:32 -040098 {"native_get_debugreg",},
Masami Hiramatsua00e8172009-09-08 12:47:55 -040099 {"irq_entries_start",},
100 {"common_interrupt",},
Masami Hiramatsu5ecaafd2010-02-05 01:24:34 -0500101 {"mcount",}, /* mcount can be called from everywhere */
Srinivasa Ds3d8d9962008-04-28 02:14:26 -0700102 {NULL} /* Terminator */
103};
104
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800105#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700106/*
107 * kprobe->ainsn.insn points to the copy of the instruction to be
108 * single-stepped. x86_64, POWER4 and above have no-exec support and
109 * stepping on the instruction on a vmalloced/kmalloced/data page
110 * is a recipe for disaster
111 */
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700112struct kprobe_insn_page {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400113 struct list_head list;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700114 kprobe_opcode_t *insns; /* Page of instruction slots */
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700115 int nused;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800116 int ngarbage;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500117 char slot_used[];
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700118};
119
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500120#define KPROBE_INSN_PAGE_SIZE(slots) \
121 (offsetof(struct kprobe_insn_page, slot_used) + \
122 (sizeof(char) * (slots)))
123
124struct kprobe_insn_cache {
125 struct list_head pages; /* list of kprobe_insn_page */
126 size_t insn_size; /* size of instruction slot */
127 int nr_garbage;
128};
129
130static int slots_per_page(struct kprobe_insn_cache *c)
131{
132 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
133}
134
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800135enum kprobe_slot_state {
136 SLOT_CLEAN = 0,
137 SLOT_DIRTY = 1,
138 SLOT_USED = 2,
139};
140
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500141static DEFINE_MUTEX(kprobe_insn_mutex); /* Protects kprobe_insn_slots */
142static struct kprobe_insn_cache kprobe_insn_slots = {
143 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
144 .insn_size = MAX_INSN_SIZE,
145 .nr_garbage = 0,
146};
147static int __kprobes collect_garbage_slots(struct kprobe_insn_cache *c);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800148
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700149/**
Masami Hiramatsu12941562009-01-06 14:41:50 -0800150 * __get_insn_slot() - Find a slot on an executable page for an instruction.
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700151 * We allocate an executable page if there's no room on existing ones.
152 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500153static kprobe_opcode_t __kprobes *__get_insn_slot(struct kprobe_insn_cache *c)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700154{
155 struct kprobe_insn_page *kip;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700156
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700157 retry:
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500158 list_for_each_entry(kip, &c->pages, list) {
159 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700160 int i;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500161 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800162 if (kip->slot_used[i] == SLOT_CLEAN) {
163 kip->slot_used[i] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700164 kip->nused++;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500165 return kip->insns + (i * c->insn_size);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700166 }
167 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500168 /* kip->nused is broken. Fix it. */
169 kip->nused = slots_per_page(c);
170 WARN_ON(1);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700171 }
172 }
173
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800174 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500175 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800176 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500177
178 /* All out of space. Need to allocate a new page. */
179 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700180 if (!kip)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700181 return NULL;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700182
183 /*
184 * Use module_alloc so this page is within +/- 2GB of where the
185 * kernel image and loaded module images reside. This is required
186 * so x86_64 can correctly handle the %rip-relative fixups.
187 */
188 kip->insns = module_alloc(PAGE_SIZE);
189 if (!kip->insns) {
190 kfree(kip);
191 return NULL;
192 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400193 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500194 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800195 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700196 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800197 kip->ngarbage = 0;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500198 list_add(&kip->list, &c->pages);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700199 return kip->insns;
200}
201
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500202
Masami Hiramatsu12941562009-01-06 14:41:50 -0800203kprobe_opcode_t __kprobes *get_insn_slot(void)
204{
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500205 kprobe_opcode_t *ret = NULL;
206
Masami Hiramatsu12941562009-01-06 14:41:50 -0800207 mutex_lock(&kprobe_insn_mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500208 ret = __get_insn_slot(&kprobe_insn_slots);
Masami Hiramatsu12941562009-01-06 14:41:50 -0800209 mutex_unlock(&kprobe_insn_mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500210
Masami Hiramatsu12941562009-01-06 14:41:50 -0800211 return ret;
212}
213
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800214/* Return 1 if all garbages are collected, otherwise 0. */
215static int __kprobes collect_one_slot(struct kprobe_insn_page *kip, int idx)
216{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800217 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800218 kip->nused--;
219 if (kip->nused == 0) {
220 /*
221 * Page is no longer in use. Free it unless
222 * it's the last one. We keep the last one
223 * so as not to have to set it up again the
224 * next time somebody inserts a probe.
225 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500226 if (!list_is_singular(&kip->list)) {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400227 list_del(&kip->list);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800228 module_free(NULL, kip->insns);
229 kfree(kip);
230 }
231 return 1;
232 }
233 return 0;
234}
235
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500236static int __kprobes collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800237{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400238 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800239
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500240 /* Ensure no-one is interrupted on the garbages */
241 synchronize_sched();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800242
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500243 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800244 int i;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800245 if (kip->ngarbage == 0)
246 continue;
247 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500248 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800249 if (kip->slot_used[i] == SLOT_DIRTY &&
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800250 collect_one_slot(kip, i))
251 break;
252 }
253 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500254 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800255 return 0;
256}
257
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500258static void __kprobes __free_insn_slot(struct kprobe_insn_cache *c,
259 kprobe_opcode_t *slot, int dirty)
260{
261 struct kprobe_insn_page *kip;
262
263 list_for_each_entry(kip, &c->pages, list) {
Masami Hiramatsu83ff56f2010-03-09 10:22:19 -0500264 long idx = ((long)slot - (long)kip->insns) /
265 (c->insn_size * sizeof(kprobe_opcode_t));
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500266 if (idx >= 0 && idx < slots_per_page(c)) {
267 WARN_ON(kip->slot_used[idx] != SLOT_USED);
268 if (dirty) {
269 kip->slot_used[idx] = SLOT_DIRTY;
270 kip->ngarbage++;
271 if (++c->nr_garbage > slots_per_page(c))
272 collect_garbage_slots(c);
273 } else
274 collect_one_slot(kip, idx);
275 return;
276 }
277 }
278 /* Could not free this slot. */
279 WARN_ON(1);
280}
281
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800282void __kprobes free_insn_slot(kprobe_opcode_t * slot, int dirty)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700283{
Masami Hiramatsu12941562009-01-06 14:41:50 -0800284 mutex_lock(&kprobe_insn_mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500285 __free_insn_slot(&kprobe_insn_slots, slot, dirty);
Masami Hiramatsu12941562009-01-06 14:41:50 -0800286 mutex_unlock(&kprobe_insn_mutex);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700287}
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500288#ifdef CONFIG_OPTPROBES
289/* For optimized_kprobe buffer */
290static DEFINE_MUTEX(kprobe_optinsn_mutex); /* Protects kprobe_optinsn_slots */
291static struct kprobe_insn_cache kprobe_optinsn_slots = {
292 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
293 /* .insn_size is initialized later */
294 .nr_garbage = 0,
295};
296/* Get a slot for optimized_kprobe buffer */
297kprobe_opcode_t __kprobes *get_optinsn_slot(void)
298{
299 kprobe_opcode_t *ret = NULL;
300
301 mutex_lock(&kprobe_optinsn_mutex);
302 ret = __get_insn_slot(&kprobe_optinsn_slots);
303 mutex_unlock(&kprobe_optinsn_mutex);
304
305 return ret;
306}
307
308void __kprobes free_optinsn_slot(kprobe_opcode_t * slot, int dirty)
309{
310 mutex_lock(&kprobe_optinsn_mutex);
311 __free_insn_slot(&kprobe_optinsn_slots, slot, dirty);
312 mutex_unlock(&kprobe_optinsn_mutex);
313}
314#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800315#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700316
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800317/* We have preemption disabled.. so it is safe to use __ versions */
318static inline void set_kprobe_instance(struct kprobe *kp)
319{
320 __get_cpu_var(kprobe_instance) = kp;
321}
322
323static inline void reset_kprobe_instance(void)
324{
325 __get_cpu_var(kprobe_instance) = NULL;
326}
327
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800328/*
329 * This routine is called either:
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -0800330 * - under the kprobe_mutex - during kprobe_[un]register()
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800331 * OR
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800332 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800333 */
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -0700334struct kprobe __kprobes *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335{
336 struct hlist_head *head;
337 struct hlist_node *node;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800338 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
340 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800341 hlist_for_each_entry_rcu(p, node, head, hlist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 if (p->addr == addr)
343 return p;
344 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500345
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 return NULL;
347}
348
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500349static int __kprobes aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
350
351/* Return true if the kprobe is an aggregator */
352static inline int kprobe_aggrprobe(struct kprobe *p)
353{
354 return p->pre_handler == aggr_pre_handler;
355}
356
357/*
358 * Keep all fields in the kprobe consistent
359 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900360static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500361{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900362 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
363 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500364}
365
366#ifdef CONFIG_OPTPROBES
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500367/* NOTE: change this value only with kprobe_mutex held */
368static bool kprobes_allow_optimization;
369
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500370/*
371 * Call all pre_handler on the list, but ignores its return value.
372 * This must be called from arch-dep optimized caller.
373 */
374void __kprobes opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
375{
376 struct kprobe *kp;
377
378 list_for_each_entry_rcu(kp, &p->list, list) {
379 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
380 set_kprobe_instance(kp);
381 kp->pre_handler(kp, regs);
382 }
383 reset_kprobe_instance();
384 }
385}
386
387/* Return true(!0) if the kprobe is ready for optimization. */
388static inline int kprobe_optready(struct kprobe *p)
389{
390 struct optimized_kprobe *op;
391
392 if (kprobe_aggrprobe(p)) {
393 op = container_of(p, struct optimized_kprobe, kp);
394 return arch_prepared_optinsn(&op->optinsn);
395 }
396
397 return 0;
398}
399
400/*
401 * Return an optimized kprobe whose optimizing code replaces
402 * instructions including addr (exclude breakpoint).
403 */
Namhyung Kim6376b222010-09-15 10:04:28 +0900404static struct kprobe *__kprobes get_optimized_kprobe(unsigned long addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500405{
406 int i;
407 struct kprobe *p = NULL;
408 struct optimized_kprobe *op;
409
410 /* Don't check i == 0, since that is a breakpoint case. */
411 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
412 p = get_kprobe((void *)(addr - i));
413
414 if (p && kprobe_optready(p)) {
415 op = container_of(p, struct optimized_kprobe, kp);
416 if (arch_within_optimized_kprobe(op, addr))
417 return p;
418 }
419
420 return NULL;
421}
422
423/* Optimization staging list, protected by kprobe_mutex */
424static LIST_HEAD(optimizing_list);
425
426static void kprobe_optimizer(struct work_struct *work);
427static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
428#define OPTIMIZE_DELAY 5
429
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900430/*
431 * Optimize (replace a breakpoint with a jump) kprobes listed on
432 * optimizing_list.
433 */
434static __kprobes void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500435{
436 struct optimized_kprobe *op, *tmp;
437
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500438 /*
439 * The optimization/unoptimization refers online_cpus via
440 * stop_machine() and cpu-hotplug modifies online_cpus.
441 * And same time, text_mutex will be held in cpu-hotplug and here.
442 * This combination can cause a deadlock (cpu-hotplug try to lock
443 * text_mutex but stop_machine can not be done because online_cpus
444 * has been changed)
445 * To avoid this deadlock, we need to call get_online_cpus()
446 * for preventing cpu-hotplug outside of text_mutex locking.
447 */
448 get_online_cpus();
449 mutex_lock(&text_mutex);
450 list_for_each_entry_safe(op, tmp, &optimizing_list, list) {
451 WARN_ON(kprobe_disabled(&op->kp));
452 if (arch_optimize_kprobe(op) < 0)
453 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
454 list_del_init(&op->list);
455 }
456 mutex_unlock(&text_mutex);
457 put_online_cpus();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900458}
459
460/* Kprobe jump optimizer */
461static __kprobes void kprobe_optimizer(struct work_struct *work)
462{
463 /* Lock modules while optimizing kprobes */
464 mutex_lock(&module_mutex);
465 mutex_lock(&kprobe_mutex);
466 if (kprobes_all_disarmed || !kprobes_allow_optimization)
467 goto end;
468
469 /*
470 * Wait for quiesence period to ensure all running interrupts
471 * are done. Because optprobe may modify multiple instructions
472 * there is a chance that Nth instruction is interrupted. In that
473 * case, running interrupt can return to 2nd-Nth byte of jump
474 * instruction. This wait is for avoiding it.
475 */
476 synchronize_sched();
477
478 do_optimize_kprobes();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500479end:
480 mutex_unlock(&kprobe_mutex);
481 mutex_unlock(&module_mutex);
482}
483
484/* Optimize kprobe if p is ready to be optimized */
485static __kprobes void optimize_kprobe(struct kprobe *p)
486{
487 struct optimized_kprobe *op;
488
489 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500490 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500491 (kprobe_disabled(p) || kprobes_all_disarmed))
492 return;
493
494 /* Both of break_handler and post_handler are not supported. */
495 if (p->break_handler || p->post_handler)
496 return;
497
498 op = container_of(p, struct optimized_kprobe, kp);
499
500 /* Check there is no other kprobes at the optimized instructions */
501 if (arch_check_optimized_kprobe(op) < 0)
502 return;
503
504 /* Check if it is already optimized. */
505 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
506 return;
507
508 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
509 list_add(&op->list, &optimizing_list);
510 if (!delayed_work_pending(&optimizing_work))
511 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
512}
513
514/* Unoptimize a kprobe if p is optimized */
515static __kprobes void unoptimize_kprobe(struct kprobe *p)
516{
517 struct optimized_kprobe *op;
518
519 if ((p->flags & KPROBE_FLAG_OPTIMIZED) && kprobe_aggrprobe(p)) {
520 op = container_of(p, struct optimized_kprobe, kp);
521 if (!list_empty(&op->list))
522 /* Dequeue from the optimization queue */
523 list_del_init(&op->list);
524 else
525 /* Replace jump with break */
526 arch_unoptimize_kprobe(op);
527 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
528 }
529}
530
531/* Remove optimized instructions */
532static void __kprobes kill_optimized_kprobe(struct kprobe *p)
533{
534 struct optimized_kprobe *op;
535
536 op = container_of(p, struct optimized_kprobe, kp);
537 if (!list_empty(&op->list)) {
538 /* Dequeue from the optimization queue */
539 list_del_init(&op->list);
540 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
541 }
542 /* Don't unoptimize, because the target code will be freed. */
543 arch_remove_optimized_kprobe(op);
544}
545
546/* Try to prepare optimized instructions */
547static __kprobes void prepare_optimized_kprobe(struct kprobe *p)
548{
549 struct optimized_kprobe *op;
550
551 op = container_of(p, struct optimized_kprobe, kp);
552 arch_prepare_optimized_kprobe(op);
553}
554
555/* Free optimized instructions and optimized_kprobe */
556static __kprobes void free_aggr_kprobe(struct kprobe *p)
557{
558 struct optimized_kprobe *op;
559
560 op = container_of(p, struct optimized_kprobe, kp);
561 arch_remove_optimized_kprobe(op);
562 kfree(op);
563}
564
565/* Allocate new optimized_kprobe and try to prepare optimized instructions */
566static __kprobes struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
567{
568 struct optimized_kprobe *op;
569
570 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
571 if (!op)
572 return NULL;
573
574 INIT_LIST_HEAD(&op->list);
575 op->kp.addr = p->addr;
576 arch_prepare_optimized_kprobe(op);
577
578 return &op->kp;
579}
580
581static void __kprobes init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
582
583/*
584 * Prepare an optimized_kprobe and optimize it
585 * NOTE: p must be a normal registered kprobe
586 */
587static __kprobes void try_to_optimize_kprobe(struct kprobe *p)
588{
589 struct kprobe *ap;
590 struct optimized_kprobe *op;
591
592 ap = alloc_aggr_kprobe(p);
593 if (!ap)
594 return;
595
596 op = container_of(ap, struct optimized_kprobe, kp);
597 if (!arch_prepared_optinsn(&op->optinsn)) {
598 /* If failed to setup optimizing, fallback to kprobe */
599 free_aggr_kprobe(ap);
600 return;
601 }
602
603 init_aggr_kprobe(ap, p);
604 optimize_kprobe(ap);
605}
606
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500607#ifdef CONFIG_SYSCTL
Masami Hiramatsu43948f52010-10-25 22:18:01 +0900608/* This should be called with kprobe_mutex locked */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500609static void __kprobes optimize_all_kprobes(void)
610{
611 struct hlist_head *head;
612 struct hlist_node *node;
613 struct kprobe *p;
614 unsigned int i;
615
616 /* If optimization is already allowed, just return */
617 if (kprobes_allow_optimization)
618 return;
619
620 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500621 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
622 head = &kprobe_table[i];
623 hlist_for_each_entry_rcu(p, node, head, hlist)
624 if (!kprobe_disabled(p))
625 optimize_kprobe(p);
626 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500627 printk(KERN_INFO "Kprobes globally optimized\n");
628}
629
Masami Hiramatsu43948f52010-10-25 22:18:01 +0900630/* This should be called with kprobe_mutex locked */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500631static void __kprobes unoptimize_all_kprobes(void)
632{
633 struct hlist_head *head;
634 struct hlist_node *node;
635 struct kprobe *p;
636 unsigned int i;
637
638 /* If optimization is already prohibited, just return */
639 if (!kprobes_allow_optimization)
640 return;
641
642 kprobes_allow_optimization = false;
643 printk(KERN_INFO "Kprobes globally unoptimized\n");
644 get_online_cpus(); /* For avoiding text_mutex deadlock */
645 mutex_lock(&text_mutex);
646 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
647 head = &kprobe_table[i];
648 hlist_for_each_entry_rcu(p, node, head, hlist) {
649 if (!kprobe_disabled(p))
650 unoptimize_kprobe(p);
651 }
652 }
653
654 mutex_unlock(&text_mutex);
655 put_online_cpus();
656 /* Allow all currently running kprobes to complete */
657 synchronize_sched();
658}
659
660int sysctl_kprobes_optimization;
661int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
662 void __user *buffer, size_t *length,
663 loff_t *ppos)
664{
665 int ret;
666
667 mutex_lock(&kprobe_mutex);
668 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
669 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
670
671 if (sysctl_kprobes_optimization)
672 optimize_all_kprobes();
673 else
674 unoptimize_all_kprobes();
675 mutex_unlock(&kprobe_mutex);
676
677 return ret;
678}
679#endif /* CONFIG_SYSCTL */
680
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500681static void __kprobes __arm_kprobe(struct kprobe *p)
682{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900683 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500684
685 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900686 _p = get_optimized_kprobe((unsigned long)p->addr);
687 if (unlikely(_p))
688 unoptimize_kprobe(_p); /* Fallback to unoptimized kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500689
690 arch_arm_kprobe(p);
691 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
692}
693
694static void __kprobes __disarm_kprobe(struct kprobe *p)
695{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900696 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500697
698 unoptimize_kprobe(p); /* Try to unoptimize */
699 arch_disarm_kprobe(p);
700
701 /* If another kprobe was blocked, optimize it. */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900702 _p = get_optimized_kprobe((unsigned long)p->addr);
703 if (unlikely(_p))
704 optimize_kprobe(_p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500705}
706
707#else /* !CONFIG_OPTPROBES */
708
709#define optimize_kprobe(p) do {} while (0)
710#define unoptimize_kprobe(p) do {} while (0)
711#define kill_optimized_kprobe(p) do {} while (0)
712#define prepare_optimized_kprobe(p) do {} while (0)
713#define try_to_optimize_kprobe(p) do {} while (0)
714#define __arm_kprobe(p) arch_arm_kprobe(p)
715#define __disarm_kprobe(p) arch_disarm_kprobe(p)
716
717static __kprobes void free_aggr_kprobe(struct kprobe *p)
718{
719 kfree(p);
720}
721
722static __kprobes struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
723{
724 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
725}
726#endif /* CONFIG_OPTPROBES */
727
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400728/* Arm a kprobe with text_mutex */
729static void __kprobes arm_kprobe(struct kprobe *kp)
730{
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500731 /*
732 * Here, since __arm_kprobe() doesn't use stop_machine(),
733 * this doesn't cause deadlock on text_mutex. So, we don't
734 * need get_online_cpus().
735 */
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400736 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500737 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400738 mutex_unlock(&text_mutex);
739}
740
741/* Disarm a kprobe with text_mutex */
742static void __kprobes disarm_kprobe(struct kprobe *kp)
743{
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500744 get_online_cpus(); /* For avoiding text_mutex deadlock */
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400745 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500746 __disarm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400747 mutex_unlock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500748 put_online_cpus();
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400749}
750
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700751/*
752 * Aggregate handlers for multiple kprobes support - these handlers
753 * take care of invoking the individual kprobe handlers on p->list
754 */
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -0700755static int __kprobes aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700756{
757 struct kprobe *kp;
758
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800759 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -0700760 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800761 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700762 if (kp->pre_handler(kp, regs))
763 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700764 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800765 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700766 }
767 return 0;
768}
769
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -0700770static void __kprobes aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
771 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700772{
773 struct kprobe *kp;
774
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800775 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -0700776 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800777 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700778 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800779 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700780 }
781 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700782}
783
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -0700784static int __kprobes aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
785 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700786{
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800787 struct kprobe *cur = __get_cpu_var(kprobe_instance);
788
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700789 /*
790 * if we faulted "during" the execution of a user specified
791 * probe handler, invoke just that probe's fault handler
792 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800793 if (cur && cur->fault_handler) {
794 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700795 return 1;
796 }
797 return 0;
798}
799
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -0700800static int __kprobes aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700801{
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800802 struct kprobe *cur = __get_cpu_var(kprobe_instance);
803 int ret = 0;
804
805 if (cur && cur->break_handler) {
806 if (cur->break_handler(cur, regs))
807 ret = 1;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700808 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800809 reset_kprobe_instance();
810 return ret;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700811}
812
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -0800813/* Walks the list and increments nmissed count for multiprobe case */
814void __kprobes kprobes_inc_nmissed_count(struct kprobe *p)
815{
816 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500817 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -0800818 p->nmissed++;
819 } else {
820 list_for_each_entry_rcu(kp, &p->list, list)
821 kp->nmissed++;
822 }
823 return;
824}
825
bibo,mao99219a32006-10-02 02:17:35 -0700826void __kprobes recycle_rp_inst(struct kretprobe_instance *ri,
827 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -0700828{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700829 struct kretprobe *rp = ri->rp;
830
Hien Nguyenb94cce92005-06-23 00:09:19 -0700831 /* remove rp inst off the rprobe_inst_table */
832 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700833 INIT_HLIST_NODE(&ri->hlist);
834 if (likely(rp)) {
835 spin_lock(&rp->lock);
836 hlist_add_head(&ri->hlist, &rp->free_instances);
837 spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -0700838 } else
839 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -0700840 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -0700841}
842
Masami Hiramatsu017c39b2009-01-06 14:41:51 -0800843void __kprobes kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700844 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +0900845__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -0700846{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700847 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
848 spinlock_t *hlist_lock;
849
850 *head = &kretprobe_inst_table[hash];
851 hlist_lock = kretprobe_table_lock_ptr(hash);
852 spin_lock_irqsave(hlist_lock, *flags);
853}
854
Masami Hiramatsu017c39b2009-01-06 14:41:51 -0800855static void __kprobes kretprobe_table_lock(unsigned long hash,
856 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +0900857__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700858{
859 spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
860 spin_lock_irqsave(hlist_lock, *flags);
861}
862
Masami Hiramatsu017c39b2009-01-06 14:41:51 -0800863void __kprobes kretprobe_hash_unlock(struct task_struct *tsk,
864 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +0900865__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700866{
867 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
868 spinlock_t *hlist_lock;
869
870 hlist_lock = kretprobe_table_lock_ptr(hash);
871 spin_unlock_irqrestore(hlist_lock, *flags);
872}
873
Namhyung Kim6376b222010-09-15 10:04:28 +0900874static void __kprobes kretprobe_table_unlock(unsigned long hash,
875 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +0900876__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700877{
878 spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
879 spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -0700880}
881
Hien Nguyenb94cce92005-06-23 00:09:19 -0700882/*
bibo maoc6fd91f2006-03-26 01:38:20 -0800883 * This function is called from finish_task_switch when task tk becomes dead,
884 * so that we can recycle any function-return probe instances associated
885 * with this task. These left over instances represent probed functions
886 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -0700887 */
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -0700888void __kprobes kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -0700889{
bibo,mao62c27be2006-10-02 02:17:33 -0700890 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -0700891 struct hlist_head *head, empty_rp;
Rusty Lynch802eae72005-06-27 15:17:08 -0700892 struct hlist_node *node, *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700893 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -0700894
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700895 if (unlikely(!kprobes_initialized))
896 /* Early boot. kretprobe_table_locks not yet initialized. */
897 return;
898
899 hash = hash_ptr(tk, KPROBE_HASH_BITS);
900 head = &kretprobe_inst_table[hash];
901 kretprobe_table_lock(hash, &flags);
bibo,mao62c27be2006-10-02 02:17:33 -0700902 hlist_for_each_entry_safe(ri, node, tmp, head, hlist) {
903 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -0700904 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -0700905 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700906 kretprobe_table_unlock(hash, &flags);
907 INIT_HLIST_HEAD(&empty_rp);
bibo,mao99219a32006-10-02 02:17:35 -0700908 hlist_for_each_entry_safe(ri, node, tmp, &empty_rp, hlist) {
909 hlist_del(&ri->hlist);
910 kfree(ri);
911 }
Hien Nguyenb94cce92005-06-23 00:09:19 -0700912}
913
Hien Nguyenb94cce92005-06-23 00:09:19 -0700914static inline void free_rp_inst(struct kretprobe *rp)
915{
916 struct kretprobe_instance *ri;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -0700917 struct hlist_node *pos, *next;
918
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700919 hlist_for_each_entry_safe(ri, pos, next, &rp->free_instances, hlist) {
920 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -0700921 kfree(ri);
922 }
923}
924
Masami Hiramatsu4a296e02008-04-28 02:14:29 -0700925static void __kprobes cleanup_rp_inst(struct kretprobe *rp)
926{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700927 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -0700928 struct kretprobe_instance *ri;
929 struct hlist_node *pos, *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700930 struct hlist_head *head;
931
Masami Hiramatsu4a296e02008-04-28 02:14:29 -0700932 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700933 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
934 kretprobe_table_lock(hash, &flags);
935 head = &kretprobe_inst_table[hash];
936 hlist_for_each_entry_safe(ri, pos, next, head, hlist) {
937 if (ri->rp == rp)
938 ri->rp = NULL;
939 }
940 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -0700941 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -0700942 free_rp_inst(rp);
943}
944
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700945/*
Masami Hiramatsub918e5e2009-04-06 19:00:58 -0700946* Add the new probe to ap->list. Fail if this is the
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700947* second jprobe at the address - two jprobes can't coexist
948*/
Masami Hiramatsub918e5e2009-04-06 19:00:58 -0700949static int __kprobes add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700950{
Masami Hiramatsude5bd882009-04-06 19:01:02 -0700951 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500952
953 if (p->break_handler || p->post_handler)
954 unoptimize_kprobe(ap); /* Fall back to normal kprobe */
955
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700956 if (p->break_handler) {
Masami Hiramatsub918e5e2009-04-06 19:00:58 -0700957 if (ap->break_handler)
mao, bibo36721652006-06-26 00:25:22 -0700958 return -EEXIST;
Masami Hiramatsub918e5e2009-04-06 19:00:58 -0700959 list_add_tail_rcu(&p->list, &ap->list);
960 ap->break_handler = aggr_break_handler;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700961 } else
Masami Hiramatsub918e5e2009-04-06 19:00:58 -0700962 list_add_rcu(&p->list, &ap->list);
963 if (p->post_handler && !ap->post_handler)
964 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -0700965
966 if (kprobe_disabled(ap) && !kprobe_disabled(p)) {
967 ap->flags &= ~KPROBE_FLAG_DISABLED;
968 if (!kprobes_all_disarmed)
969 /* Arm the breakpoint again. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500970 __arm_kprobe(ap);
Masami Hiramatsude5bd882009-04-06 19:01:02 -0700971 }
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700972 return 0;
973}
974
975/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700976 * Fill in the required fields of the "manager kprobe". Replace the
977 * earlier kprobe in the hlist with the manager kprobe
978 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500979static void __kprobes init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700980{
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500981 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -0700982 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -0700983 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700984 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500985 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700986 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700987 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -0800988 /* We don't care the kprobe which has gone. */
989 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -0700990 ap->post_handler = aggr_post_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -0800991 if (p->break_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -0700992 ap->break_handler = aggr_break_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700993
994 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500995 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700996
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500997 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -0800998 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700999}
1000
1001/*
1002 * This is the second or subsequent kprobe at the address - handle
1003 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001004 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001005static int __kprobes register_aggr_kprobe(struct kprobe *orig_p,
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001006 struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001007{
1008 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001009 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001010
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001011 if (!kprobe_aggrprobe(orig_p)) {
1012 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1013 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001014 if (!ap)
1015 return -ENOMEM;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001016 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001017 }
1018
1019 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001020 /*
1021 * Attempting to insert new probe at the same location that
1022 * had a probe in the module vaddr area which already
1023 * freed. So, the instruction slot has already been
1024 * released. We need a new slot for the new probe.
1025 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001026 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001027 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001028 /*
1029 * Even if fail to allocate new slot, don't need to
1030 * free aggr_probe. It will be used next time, or
1031 * freed by unregister_kprobe.
1032 */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001033 return ret;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001034
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001035 /* Prepare optimized instructions if possible. */
1036 prepare_optimized_kprobe(ap);
1037
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001038 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001039 * Clear gone flag to prevent allocating new slot again, and
1040 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001041 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001042 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1043 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001044 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001045
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001046 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001047 copy_kprobe(ap, p);
1048 return add_new_kprobe(ap, p);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001049}
1050
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001051static int __kprobes in_kprobes_functions(unsigned long addr)
1052{
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001053 struct kprobe_blackpoint *kb;
1054
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001055 if (addr >= (unsigned long)__kprobes_text_start &&
1056 addr < (unsigned long)__kprobes_text_end)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001057 return -EINVAL;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001058 /*
1059 * If there exists a kprobe_blacklist, verify and
1060 * fail any probe registration in the prohibited area
1061 */
1062 for (kb = kprobe_blacklist; kb->name != NULL; kb++) {
1063 if (kb->start_addr) {
1064 if (addr >= kb->start_addr &&
1065 addr < (kb->start_addr + kb->range))
1066 return -EINVAL;
1067 }
1068 }
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001069 return 0;
1070}
1071
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001072/*
1073 * If we have a symbol_name argument, look it up and add the offset field
1074 * to it. This way, we can specify a relative address to a symbol.
1075 */
1076static kprobe_opcode_t __kprobes *kprobe_addr(struct kprobe *p)
1077{
1078 kprobe_opcode_t *addr = p->addr;
1079 if (p->symbol_name) {
1080 if (addr)
1081 return NULL;
1082 kprobe_lookup_name(p->symbol_name, addr);
1083 }
1084
1085 if (!addr)
1086 return NULL;
1087 return (kprobe_opcode_t *)(((char *)addr) + p->offset);
1088}
1089
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301090/* Check passed kprobe is valid and return kprobe in kprobe_table. */
1091static struct kprobe * __kprobes __get_valid_kprobe(struct kprobe *p)
1092{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001093 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301094
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001095 ap = get_kprobe(p->addr);
1096 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301097 return NULL;
1098
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001099 if (p != ap) {
1100 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301101 if (list_p == p)
1102 /* kprobe p is a valid probe */
1103 goto valid;
1104 return NULL;
1105 }
1106valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001107 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301108}
1109
1110/* Return error if the kprobe is being re-registered */
1111static inline int check_kprobe_rereg(struct kprobe *p)
1112{
1113 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301114
1115 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001116 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301117 ret = -EINVAL;
1118 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001119
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301120 return ret;
1121}
1122
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001123int __kprobes register_kprobe(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124{
1125 int ret = 0;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001126 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001127 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001128 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001130 addr = kprobe_addr(p);
1131 if (!addr)
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001132 return -EINVAL;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001133 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001134
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301135 ret = check_kprobe_rereg(p);
1136 if (ret)
1137 return ret;
1138
Jason Baron91bad2f2010-10-01 17:23:48 -04001139 jump_label_lock();
Steven Rostedtde31c3c2010-10-18 10:38:58 -04001140 preempt_disable();
Masami Hiramatsuec30c5f2009-07-28 19:47:23 -04001141 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu4554dbc2010-02-02 16:49:18 -05001142 in_kprobes_functions((unsigned long) p->addr) ||
Jason Baron4c3ef6d2010-09-17 11:09:08 -04001143 ftrace_text_reserved(p->addr, p->addr) ||
Steven Rostedtde31c3c2010-10-18 10:38:58 -04001144 jump_label_text_reserved(p->addr, p->addr))
1145 goto fail_with_jump_label;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001146
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001147 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1148 p->flags &= KPROBE_FLAG_DISABLED;
1149
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001150 /*
1151 * Check if are we probing a module.
1152 */
Masami Hiramatsua189d032008-11-12 13:26:51 -08001153 probed_mod = __module_text_address((unsigned long) p->addr);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001154 if (probed_mod) {
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001155 /*
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001156 * We must hold a refcount of the probed module while updating
1157 * its code to prohibit unexpected unloading.
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001158 */
Steven Rostedtde31c3c2010-10-18 10:38:58 -04001159 if (unlikely(!try_module_get(probed_mod)))
1160 goto fail_with_jump_label;
1161
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08001162 /*
1163 * If the module freed .init.text, we couldn't insert
1164 * kprobes in there.
1165 */
1166 if (within_module_init((unsigned long)p->addr, probed_mod) &&
1167 probed_mod->state != MODULE_STATE_COMING) {
1168 module_put(probed_mod);
Steven Rostedtde31c3c2010-10-18 10:38:58 -04001169 goto fail_with_jump_label;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08001170 }
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001171 }
Masami Hiramatsua189d032008-11-12 13:26:51 -08001172 preempt_enable();
Steven Rostedtde31c3c2010-10-18 10:38:58 -04001173 jump_label_unlock();
Mao, Bibob3e55c72005-12-12 00:37:00 -08001174
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001175 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001176 INIT_LIST_HEAD(&p->list);
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001177 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001178
Jason Baron91bad2f2010-10-01 17:23:48 -04001179 jump_label_lock(); /* needed to call jump_label_text_reserved() */
1180
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001181 get_online_cpus(); /* For avoiding text_mutex deadlock. */
1182 mutex_lock(&text_mutex);
1183
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001184 old_p = get_kprobe(p->addr);
1185 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001186 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001187 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 goto out;
1189 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001191 ret = arch_prepare_kprobe(p);
1192 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001193 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001194
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001195 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001196 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1198
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001199 if (!kprobes_all_disarmed && !kprobe_disabled(p))
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001200 __arm_kprobe(p);
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001201
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001202 /* Try to optimize kprobe */
1203 try_to_optimize_kprobe(p);
1204
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205out:
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001206 mutex_unlock(&text_mutex);
1207 put_online_cpus();
Jason Baron91bad2f2010-10-01 17:23:48 -04001208 jump_label_unlock();
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001209 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001210
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001211 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001212 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001213
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 return ret;
Steven Rostedtde31c3c2010-10-18 10:38:58 -04001215
1216fail_with_jump_label:
1217 preempt_enable();
1218 jump_label_unlock();
1219 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001221EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001223/* Check if all probes on the aggrprobe are disabled */
1224static int __kprobes aggr_kprobe_disabled(struct kprobe *ap)
1225{
1226 struct kprobe *kp;
1227
1228 list_for_each_entry_rcu(kp, &ap->list, list)
1229 if (!kprobe_disabled(kp))
1230 /*
1231 * There is an active probe on the list.
1232 * We can't disable this ap.
1233 */
1234 return 0;
1235
1236 return 1;
1237}
1238
1239/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
1240static struct kprobe *__kprobes __disable_kprobe(struct kprobe *p)
1241{
1242 struct kprobe *orig_p;
1243
1244 /* Get an original kprobe for return */
1245 orig_p = __get_valid_kprobe(p);
1246 if (unlikely(orig_p == NULL))
1247 return NULL;
1248
1249 if (!kprobe_disabled(p)) {
1250 /* Disable probe if it is a child probe */
1251 if (p != orig_p)
1252 p->flags |= KPROBE_FLAG_DISABLED;
1253
1254 /* Try to disarm and disable this/parent probe */
1255 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
1256 disarm_kprobe(orig_p);
1257 orig_p->flags |= KPROBE_FLAG_DISABLED;
1258 }
1259 }
1260
1261 return orig_p;
1262}
1263
Masami Hiramatsu98616682008-04-28 02:14:28 -07001264/*
1265 * Unregister a kprobe without a scheduler synchronization.
1266 */
1267static int __kprobes __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001268{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001269 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001270
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001271 /* Disable kprobe. This will disarm it if needed. */
1272 ap = __disable_kprobe(p);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001273 if (ap == NULL)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001274 return -EINVAL;
1275
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001276 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001277 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001278 * This probe is an independent(and non-optimized) kprobe
1279 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001280 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001281 goto disarmed;
1282
1283 /* Following process expects this probe is an aggrprobe */
1284 WARN_ON(!kprobe_aggrprobe(ap));
1285
1286 if (list_is_singular(&ap->list))
1287 /* This probe is the last child of aggrprobe */
1288 goto disarmed;
1289 else {
1290 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001291 if (p->break_handler && !kprobe_gone(p))
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001292 ap->break_handler = NULL;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001293 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001294 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001295 if ((list_p != p) && (list_p->post_handler))
1296 goto noclean;
1297 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001298 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001299 }
1300noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001301 /*
1302 * Remove from the aggrprobe: this path will do nothing in
1303 * __unregister_kprobe_bottom().
1304 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001305 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001306 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1307 /*
1308 * Try to optimize this probe again, because post
1309 * handler may have been changed.
1310 */
1311 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001312 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001313 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001314
1315disarmed:
1316 hlist_del_rcu(&ap->hlist);
1317 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001318}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001319
Masami Hiramatsu98616682008-04-28 02:14:28 -07001320static void __kprobes __unregister_kprobe_bottom(struct kprobe *p)
1321{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001322 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001323
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001324 if (list_empty(&p->list))
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001325 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001326 else if (list_is_singular(&p->list)) {
1327 /* "p" is the last child of an aggr_kprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001328 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001329 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001330 arch_remove_kprobe(ap);
1331 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001332 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333}
1334
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001335int __kprobes register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001336{
1337 int i, ret = 0;
1338
1339 if (num <= 0)
1340 return -EINVAL;
1341 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001342 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001343 if (ret < 0) {
1344 if (i > 0)
1345 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001346 break;
1347 }
1348 }
1349 return ret;
1350}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001351EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001352
Masami Hiramatsu98616682008-04-28 02:14:28 -07001353void __kprobes unregister_kprobe(struct kprobe *p)
1354{
1355 unregister_kprobes(&p, 1);
1356}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001357EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001358
Masami Hiramatsu98616682008-04-28 02:14:28 -07001359void __kprobes unregister_kprobes(struct kprobe **kps, int num)
1360{
1361 int i;
1362
1363 if (num <= 0)
1364 return;
1365 mutex_lock(&kprobe_mutex);
1366 for (i = 0; i < num; i++)
1367 if (__unregister_kprobe_top(kps[i]) < 0)
1368 kps[i]->addr = NULL;
1369 mutex_unlock(&kprobe_mutex);
1370
1371 synchronize_sched();
1372 for (i = 0; i < num; i++)
1373 if (kps[i]->addr)
1374 __unregister_kprobe_bottom(kps[i]);
1375}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001376EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001377
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378static struct notifier_block kprobe_exceptions_nb = {
1379 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001380 .priority = 0x7fffffff /* we need to be notified first */
1381};
1382
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001383unsigned long __weak arch_deref_entry_point(void *entry)
1384{
1385 return (unsigned long)entry;
1386}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001388int __kprobes register_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001389{
1390 struct jprobe *jp;
1391 int ret = 0, i;
1392
1393 if (num <= 0)
1394 return -EINVAL;
1395 for (i = 0; i < num; i++) {
Namhyung Kim05662bd2010-09-15 10:04:27 +09001396 unsigned long addr, offset;
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001397 jp = jps[i];
1398 addr = arch_deref_entry_point(jp->entry);
1399
Namhyung Kim05662bd2010-09-15 10:04:27 +09001400 /* Verify probepoint is a function entry point */
1401 if (kallsyms_lookup_size_offset(addr, NULL, &offset) &&
1402 offset == 0) {
1403 jp->kp.pre_handler = setjmp_pre_handler;
1404 jp->kp.break_handler = longjmp_break_handler;
1405 ret = register_kprobe(&jp->kp);
1406 } else
1407 ret = -EINVAL;
Namhyung Kimedbaadb2010-09-15 10:04:26 +09001408
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001409 if (ret < 0) {
1410 if (i > 0)
1411 unregister_jprobes(jps, i);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001412 break;
1413 }
1414 }
1415 return ret;
1416}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001417EXPORT_SYMBOL_GPL(register_jprobes);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001418
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001419int __kprobes register_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420{
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001421 return register_jprobes(&jp, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001423EXPORT_SYMBOL_GPL(register_jprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001425void __kprobes unregister_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426{
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001427 unregister_jprobes(&jp, 1);
1428}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001429EXPORT_SYMBOL_GPL(unregister_jprobe);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001430
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001431void __kprobes unregister_jprobes(struct jprobe **jps, int num)
1432{
1433 int i;
1434
1435 if (num <= 0)
1436 return;
1437 mutex_lock(&kprobe_mutex);
1438 for (i = 0; i < num; i++)
1439 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1440 jps[i]->kp.addr = NULL;
1441 mutex_unlock(&kprobe_mutex);
1442
1443 synchronize_sched();
1444 for (i = 0; i < num; i++) {
1445 if (jps[i]->kp.addr)
1446 __unregister_kprobe_bottom(&jps[i]->kp);
1447 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001449EXPORT_SYMBOL_GPL(unregister_jprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001451#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001452/*
1453 * This kprobe pre_handler is registered with every kretprobe. When probe
1454 * hits it will set up the return probe.
1455 */
1456static int __kprobes pre_handler_kretprobe(struct kprobe *p,
1457 struct pt_regs *regs)
1458{
1459 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001460 unsigned long hash, flags = 0;
1461 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001462
1463 /*TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001464 hash = hash_ptr(current, KPROBE_HASH_BITS);
1465 spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001466 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001467 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001468 struct kretprobe_instance, hlist);
1469 hlist_del(&ri->hlist);
1470 spin_unlock_irqrestore(&rp->lock, flags);
1471
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001472 ri->rp = rp;
1473 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001474
Ananth N Mavinakayanahallif02b8622009-03-18 17:06:21 +05301475 if (rp->entry_handler && rp->entry_handler(ri, regs))
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001476 return 0;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001477
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001478 arch_prepare_kretprobe(ri, regs);
1479
1480 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001481 INIT_HLIST_NODE(&ri->hlist);
1482 kretprobe_table_lock(hash, &flags);
1483 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1484 kretprobe_table_unlock(hash, &flags);
1485 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001486 rp->nmissed++;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001487 spin_unlock_irqrestore(&rp->lock, flags);
1488 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001489 return 0;
1490}
1491
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001492int __kprobes register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001493{
1494 int ret = 0;
1495 struct kretprobe_instance *inst;
1496 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001497 void *addr;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001498
1499 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001500 addr = kprobe_addr(&rp->kp);
1501 if (!addr)
1502 return -EINVAL;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001503
1504 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1505 if (kretprobe_blacklist[i].addr == addr)
1506 return -EINVAL;
1507 }
1508 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001509
1510 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001511 rp->kp.post_handler = NULL;
1512 rp->kp.fault_handler = NULL;
1513 rp->kp.break_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001514
1515 /* Pre-allocate memory for max kretprobe instances */
1516 if (rp->maxactive <= 0) {
1517#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001518 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001519#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301520 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001521#endif
1522 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001523 spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001524 INIT_HLIST_HEAD(&rp->free_instances);
1525 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001526 inst = kmalloc(sizeof(struct kretprobe_instance) +
1527 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001528 if (inst == NULL) {
1529 free_rp_inst(rp);
1530 return -ENOMEM;
1531 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001532 INIT_HLIST_NODE(&inst->hlist);
1533 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001534 }
1535
1536 rp->nmissed = 0;
1537 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001538 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001539 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001540 free_rp_inst(rp);
1541 return ret;
1542}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001543EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001544
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001545int __kprobes register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001546{
1547 int ret = 0, i;
1548
1549 if (num <= 0)
1550 return -EINVAL;
1551 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001552 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001553 if (ret < 0) {
1554 if (i > 0)
1555 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001556 break;
1557 }
1558 }
1559 return ret;
1560}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001561EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001562
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001563void __kprobes unregister_kretprobe(struct kretprobe *rp)
1564{
1565 unregister_kretprobes(&rp, 1);
1566}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001567EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001568
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001569void __kprobes unregister_kretprobes(struct kretprobe **rps, int num)
1570{
1571 int i;
1572
1573 if (num <= 0)
1574 return;
1575 mutex_lock(&kprobe_mutex);
1576 for (i = 0; i < num; i++)
1577 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1578 rps[i]->kp.addr = NULL;
1579 mutex_unlock(&kprobe_mutex);
1580
1581 synchronize_sched();
1582 for (i = 0; i < num; i++) {
1583 if (rps[i]->kp.addr) {
1584 __unregister_kprobe_bottom(&rps[i]->kp);
1585 cleanup_rp_inst(rps[i]);
1586 }
1587 }
1588}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001589EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001590
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001591#else /* CONFIG_KRETPROBES */
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001592int __kprobes register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001593{
1594 return -ENOSYS;
1595}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001596EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001597
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001598int __kprobes register_kretprobes(struct kretprobe **rps, int num)
1599{
1600 return -ENOSYS;
1601}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001602EXPORT_SYMBOL_GPL(register_kretprobes);
1603
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001604void __kprobes unregister_kretprobe(struct kretprobe *rp)
1605{
1606}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001607EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001608
1609void __kprobes unregister_kretprobes(struct kretprobe **rps, int num)
1610{
1611}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001612EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001613
Srinivasa Ds346fd592007-02-20 13:57:54 -08001614static int __kprobes pre_handler_kretprobe(struct kprobe *p,
1615 struct pt_regs *regs)
1616{
1617 return 0;
1618}
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001619
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001620#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07001621
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001622/* Set the kprobe gone and remove its instruction buffer. */
1623static void __kprobes kill_kprobe(struct kprobe *p)
1624{
1625 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001626
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001627 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001628 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001629 /*
1630 * If this is an aggr_kprobe, we have to list all the
1631 * chained probes and mark them GONE.
1632 */
1633 list_for_each_entry_rcu(kp, &p->list, list)
1634 kp->flags |= KPROBE_FLAG_GONE;
1635 p->post_handler = NULL;
1636 p->break_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001637 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001638 }
1639 /*
1640 * Here, we can remove insn_slot safely, because no thread calls
1641 * the original probed function (which will be freed soon) any more.
1642 */
1643 arch_remove_kprobe(p);
1644}
1645
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001646/* Disable one kprobe */
1647int __kprobes disable_kprobe(struct kprobe *kp)
1648{
1649 int ret = 0;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001650
1651 mutex_lock(&kprobe_mutex);
1652
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001653 /* Disable this kprobe */
1654 if (__disable_kprobe(kp) == NULL)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001655 ret = -EINVAL;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001656
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001657 mutex_unlock(&kprobe_mutex);
1658 return ret;
1659}
1660EXPORT_SYMBOL_GPL(disable_kprobe);
1661
1662/* Enable one kprobe */
1663int __kprobes enable_kprobe(struct kprobe *kp)
1664{
1665 int ret = 0;
1666 struct kprobe *p;
1667
1668 mutex_lock(&kprobe_mutex);
1669
1670 /* Check whether specified probe is valid. */
1671 p = __get_valid_kprobe(kp);
1672 if (unlikely(p == NULL)) {
1673 ret = -EINVAL;
1674 goto out;
1675 }
1676
1677 if (kprobe_gone(kp)) {
1678 /* This kprobe has gone, we couldn't enable it. */
1679 ret = -EINVAL;
1680 goto out;
1681 }
1682
1683 if (p != kp)
1684 kp->flags &= ~KPROBE_FLAG_DISABLED;
1685
1686 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
1687 p->flags &= ~KPROBE_FLAG_DISABLED;
1688 arm_kprobe(p);
1689 }
1690out:
1691 mutex_unlock(&kprobe_mutex);
1692 return ret;
1693}
1694EXPORT_SYMBOL_GPL(enable_kprobe);
1695
Frederic Weisbecker24851d22009-08-26 23:38:30 +02001696void __kprobes dump_kprobe(struct kprobe *kp)
1697{
1698 printk(KERN_WARNING "Dumping kprobe:\n");
1699 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
1700 kp->symbol_name, kp->addr, kp->offset);
1701}
1702
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001703/* Module notifier call back, checking kprobes on the module */
1704static int __kprobes kprobes_module_callback(struct notifier_block *nb,
1705 unsigned long val, void *data)
1706{
1707 struct module *mod = data;
1708 struct hlist_head *head;
1709 struct hlist_node *node;
1710 struct kprobe *p;
1711 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08001712 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001713
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08001714 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001715 return NOTIFY_DONE;
1716
1717 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08001718 * When MODULE_STATE_GOING was notified, both of module .text and
1719 * .init.text sections would be freed. When MODULE_STATE_LIVE was
1720 * notified, only .init.text section would be freed. We need to
1721 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001722 */
1723 mutex_lock(&kprobe_mutex);
1724 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
1725 head = &kprobe_table[i];
1726 hlist_for_each_entry_rcu(p, node, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08001727 if (within_module_init((unsigned long)p->addr, mod) ||
1728 (checkcore &&
1729 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001730 /*
1731 * The vaddr this probe is installed will soon
1732 * be vfreed buy not synced to disk. Hence,
1733 * disarming the breakpoint isn't needed.
1734 */
1735 kill_kprobe(p);
1736 }
1737 }
1738 mutex_unlock(&kprobe_mutex);
1739 return NOTIFY_DONE;
1740}
1741
1742static struct notifier_block kprobe_module_nb = {
1743 .notifier_call = kprobes_module_callback,
1744 .priority = 0
1745};
1746
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747static int __init init_kprobes(void)
1748{
1749 int i, err = 0;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001750 unsigned long offset = 0, size = 0;
1751 char *modname, namebuf[128];
1752 const char *symbol_name;
1753 void *addr;
1754 struct kprobe_blackpoint *kb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755
1756 /* FIXME allocate the probe table, currently defined statically */
1757 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07001758 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001760 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001761 spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07001762 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001764 /*
1765 * Lookup and populate the kprobe_blacklist.
1766 *
1767 * Unlike the kretprobe blacklist, we'll need to determine
1768 * the range of addresses that belong to the said functions,
1769 * since a kprobe need not necessarily be at the beginning
1770 * of a function.
1771 */
1772 for (kb = kprobe_blacklist; kb->name != NULL; kb++) {
1773 kprobe_lookup_name(kb->name, addr);
1774 if (!addr)
1775 continue;
1776
1777 kb->start_addr = (unsigned long)addr;
1778 symbol_name = kallsyms_lookup(kb->start_addr,
1779 &size, &offset, &modname, namebuf);
1780 if (!symbol_name)
1781 kb->range = 0;
1782 else
1783 kb->range = size;
1784 }
1785
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001786 if (kretprobe_blacklist_size) {
1787 /* lookup the function address from its name */
1788 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1789 kprobe_lookup_name(kretprobe_blacklist[i].name,
1790 kretprobe_blacklist[i].addr);
1791 if (!kretprobe_blacklist[i].addr)
1792 printk("kretprobe: lookup failed: %s\n",
1793 kretprobe_blacklist[i].name);
1794 }
1795 }
1796
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05001797#if defined(CONFIG_OPTPROBES)
1798#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001799 /* Init kprobe_optinsn_slots */
1800 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
1801#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05001802 /* By default, kprobes can be optimized */
1803 kprobes_allow_optimization = true;
1804#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001805
Masami Hiramatsue579abe2009-04-06 19:01:01 -07001806 /* By default, kprobes are armed */
1807 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001808
Rusty Lynch67729262005-07-05 18:54:50 -07001809 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07001810 if (!err)
1811 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001812 if (!err)
1813 err = register_module_notifier(&kprobe_module_nb);
1814
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001815 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07001816
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01001817 if (!err)
1818 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 return err;
1820}
1821
Srinivasa Ds346fd592007-02-20 13:57:54 -08001822#ifdef CONFIG_DEBUG_FS
1823static void __kprobes report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001824 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08001825{
1826 char *kprobe_type;
1827
1828 if (p->pre_handler == pre_handler_kretprobe)
1829 kprobe_type = "r";
1830 else if (p->pre_handler == setjmp_pre_handler)
1831 kprobe_type = "j";
1832 else
1833 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001834
Srinivasa Ds346fd592007-02-20 13:57:54 -08001835 if (sym)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001836 seq_printf(pi, "%p %s %s+0x%x %s ",
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001837 p->addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001838 (modname ? modname : " "));
Srinivasa Ds346fd592007-02-20 13:57:54 -08001839 else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001840 seq_printf(pi, "%p %s %p ",
1841 p->addr, kprobe_type, p->addr);
1842
1843 if (!pp)
1844 pp = p;
1845 seq_printf(pi, "%s%s%s\n",
1846 (kprobe_gone(p) ? "[GONE]" : ""),
1847 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
1848 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08001849}
1850
1851static void __kprobes *kprobe_seq_start(struct seq_file *f, loff_t *pos)
1852{
1853 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
1854}
1855
1856static void __kprobes *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
1857{
1858 (*pos)++;
1859 if (*pos >= KPROBE_TABLE_SIZE)
1860 return NULL;
1861 return pos;
1862}
1863
1864static void __kprobes kprobe_seq_stop(struct seq_file *f, void *v)
1865{
1866 /* Nothing to do */
1867}
1868
1869static int __kprobes show_kprobe_addr(struct seq_file *pi, void *v)
1870{
1871 struct hlist_head *head;
1872 struct hlist_node *node;
1873 struct kprobe *p, *kp;
1874 const char *sym = NULL;
1875 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07001876 unsigned long offset = 0;
Srinivasa Ds346fd592007-02-20 13:57:54 -08001877 char *modname, namebuf[128];
1878
1879 head = &kprobe_table[i];
1880 preempt_disable();
1881 hlist_for_each_entry_rcu(p, node, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07001882 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08001883 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001884 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08001885 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001886 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08001887 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001888 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08001889 }
1890 preempt_enable();
1891 return 0;
1892}
1893
James Morris88e9d342009-09-22 16:43:43 -07001894static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08001895 .start = kprobe_seq_start,
1896 .next = kprobe_seq_next,
1897 .stop = kprobe_seq_stop,
1898 .show = show_kprobe_addr
1899};
1900
1901static int __kprobes kprobes_open(struct inode *inode, struct file *filp)
1902{
1903 return seq_open(filp, &kprobes_seq_ops);
1904}
1905
Alexey Dobriyan828c0952009-10-01 15:43:56 -07001906static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08001907 .open = kprobes_open,
1908 .read = seq_read,
1909 .llseek = seq_lseek,
1910 .release = seq_release,
1911};
1912
Masami Hiramatsue579abe2009-04-06 19:01:01 -07001913static void __kprobes arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001914{
1915 struct hlist_head *head;
1916 struct hlist_node *node;
1917 struct kprobe *p;
1918 unsigned int i;
1919
1920 mutex_lock(&kprobe_mutex);
1921
Masami Hiramatsue579abe2009-04-06 19:01:01 -07001922 /* If kprobes are armed, just return */
1923 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001924 goto already_enabled;
1925
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001926 /* Arming kprobes doesn't optimize kprobe itself */
Mathieu Desnoyers4460fda2009-03-06 10:36:38 -05001927 mutex_lock(&text_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001928 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
1929 head = &kprobe_table[i];
1930 hlist_for_each_entry_rcu(p, node, head, hlist)
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001931 if (!kprobe_disabled(p))
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001932 __arm_kprobe(p);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001933 }
Mathieu Desnoyers4460fda2009-03-06 10:36:38 -05001934 mutex_unlock(&text_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001935
Masami Hiramatsue579abe2009-04-06 19:01:01 -07001936 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001937 printk(KERN_INFO "Kprobes globally enabled\n");
1938
1939already_enabled:
1940 mutex_unlock(&kprobe_mutex);
1941 return;
1942}
1943
Masami Hiramatsue579abe2009-04-06 19:01:01 -07001944static void __kprobes disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001945{
1946 struct hlist_head *head;
1947 struct hlist_node *node;
1948 struct kprobe *p;
1949 unsigned int i;
1950
1951 mutex_lock(&kprobe_mutex);
1952
Masami Hiramatsue579abe2009-04-06 19:01:01 -07001953 /* If kprobes are already disarmed, just return */
1954 if (kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001955 goto already_disabled;
1956
Masami Hiramatsue579abe2009-04-06 19:01:01 -07001957 kprobes_all_disarmed = true;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001958 printk(KERN_INFO "Kprobes globally disabled\n");
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001959
1960 /*
1961 * Here we call get_online_cpus() for avoiding text_mutex deadlock,
1962 * because disarming may also unoptimize kprobes.
1963 */
1964 get_online_cpus();
Mathieu Desnoyers4460fda2009-03-06 10:36:38 -05001965 mutex_lock(&text_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001966 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
1967 head = &kprobe_table[i];
1968 hlist_for_each_entry_rcu(p, node, head, hlist) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001969 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001970 __disarm_kprobe(p);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001971 }
1972 }
1973
Mathieu Desnoyers4460fda2009-03-06 10:36:38 -05001974 mutex_unlock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001975 put_online_cpus();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001976 mutex_unlock(&kprobe_mutex);
1977 /* Allow all currently running kprobes to complete */
1978 synchronize_sched();
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001979 return;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001980
1981already_disabled:
1982 mutex_unlock(&kprobe_mutex);
1983 return;
1984}
1985
1986/*
1987 * XXX: The debugfs bool file interface doesn't allow for callbacks
1988 * when the bool state is switched. We can reuse that facility when
1989 * available
1990 */
1991static ssize_t read_enabled_file_bool(struct file *file,
1992 char __user *user_buf, size_t count, loff_t *ppos)
1993{
1994 char buf[3];
1995
Masami Hiramatsue579abe2009-04-06 19:01:01 -07001996 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001997 buf[0] = '1';
1998 else
1999 buf[0] = '0';
2000 buf[1] = '\n';
2001 buf[2] = 0x00;
2002 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2003}
2004
2005static ssize_t write_enabled_file_bool(struct file *file,
2006 const char __user *user_buf, size_t count, loff_t *ppos)
2007{
2008 char buf[32];
2009 int buf_size;
2010
2011 buf_size = min(count, (sizeof(buf)-1));
2012 if (copy_from_user(buf, user_buf, buf_size))
2013 return -EFAULT;
2014
2015 switch (buf[0]) {
2016 case 'y':
2017 case 'Y':
2018 case '1':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002019 arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002020 break;
2021 case 'n':
2022 case 'N':
2023 case '0':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002024 disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002025 break;
2026 }
2027
2028 return count;
2029}
2030
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002031static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002032 .read = read_enabled_file_bool,
2033 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002034 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002035};
2036
Srinivasa Ds346fd592007-02-20 13:57:54 -08002037static int __kprobes debugfs_kprobe_init(void)
2038{
2039 struct dentry *dir, *file;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002040 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002041
2042 dir = debugfs_create_dir("kprobes", NULL);
2043 if (!dir)
2044 return -ENOMEM;
2045
Randy Dunlape3869792007-05-08 00:27:01 -07002046 file = debugfs_create_file("list", 0444, dir, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002047 &debugfs_kprobes_operations);
2048 if (!file) {
2049 debugfs_remove(dir);
2050 return -ENOMEM;
2051 }
2052
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002053 file = debugfs_create_file("enabled", 0600, dir,
2054 &value, &fops_kp);
2055 if (!file) {
2056 debugfs_remove(dir);
2057 return -ENOMEM;
2058 }
2059
Srinivasa Ds346fd592007-02-20 13:57:54 -08002060 return 0;
2061}
2062
2063late_initcall(debugfs_kprobe_init);
2064#endif /* CONFIG_DEBUG_FS */
2065
2066module_init(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002068/* defined in arch/.../kernel/kprobes.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069EXPORT_SYMBOL_GPL(jprobe_return);