blob: 9e4912dc55594d8ae4aed7c56d67bb4f585f7210 [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>
Paul Gortmaker9984de12011-05-23 14:51:41 -040039#include <linux/export.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 {
Thomas Gleixnerec4846082009-07-25 16:09:17 +020081 raw_spinlock_t lock ____cacheline_aligned_in_smp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070082} kretprobe_table_locks[KPROBE_TABLE_SIZE];
83
Thomas Gleixnerec4846082009-07-25 16:09:17 +020084static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070085{
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
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500124static int slots_per_page(struct kprobe_insn_cache *c)
125{
126 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
127}
128
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800129enum kprobe_slot_state {
130 SLOT_CLEAN = 0,
131 SLOT_DIRTY = 1,
132 SLOT_USED = 2,
133};
134
Heiko Carstensc802d642013-09-11 14:24:11 -0700135struct kprobe_insn_cache kprobe_insn_slots = {
136 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500137 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
138 .insn_size = MAX_INSN_SIZE,
139 .nr_garbage = 0,
140};
141static int __kprobes collect_garbage_slots(struct kprobe_insn_cache *c);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800142
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700143/**
Masami Hiramatsu12941562009-01-06 14:41:50 -0800144 * __get_insn_slot() - Find a slot on an executable page for an instruction.
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700145 * We allocate an executable page if there's no room on existing ones.
146 */
Heiko Carstensc802d642013-09-11 14:24:11 -0700147kprobe_opcode_t __kprobes *__get_insn_slot(struct kprobe_insn_cache *c)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700148{
149 struct kprobe_insn_page *kip;
Heiko Carstensc802d642013-09-11 14:24:11 -0700150 kprobe_opcode_t *slot = NULL;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700151
Heiko Carstensc802d642013-09-11 14:24:11 -0700152 mutex_lock(&c->mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700153 retry:
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500154 list_for_each_entry(kip, &c->pages, list) {
155 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700156 int i;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500157 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800158 if (kip->slot_used[i] == SLOT_CLEAN) {
159 kip->slot_used[i] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700160 kip->nused++;
Heiko Carstensc802d642013-09-11 14:24:11 -0700161 slot = kip->insns + (i * c->insn_size);
162 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700163 }
164 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500165 /* kip->nused is broken. Fix it. */
166 kip->nused = slots_per_page(c);
167 WARN_ON(1);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700168 }
169 }
170
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800171 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500172 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800173 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500174
175 /* All out of space. Need to allocate a new page. */
176 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700177 if (!kip)
Heiko Carstensc802d642013-09-11 14:24:11 -0700178 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700179
180 /*
181 * Use module_alloc so this page is within +/- 2GB of where the
182 * kernel image and loaded module images reside. This is required
183 * so x86_64 can correctly handle the %rip-relative fixups.
184 */
185 kip->insns = module_alloc(PAGE_SIZE);
186 if (!kip->insns) {
187 kfree(kip);
Heiko Carstensc802d642013-09-11 14:24:11 -0700188 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700189 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400190 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500191 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800192 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700193 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800194 kip->ngarbage = 0;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500195 list_add(&kip->list, &c->pages);
Heiko Carstensc802d642013-09-11 14:24:11 -0700196 slot = kip->insns;
197out:
198 mutex_unlock(&c->mutex);
199 return slot;
Masami Hiramatsu12941562009-01-06 14:41:50 -0800200}
201
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800202/* Return 1 if all garbages are collected, otherwise 0. */
203static int __kprobes collect_one_slot(struct kprobe_insn_page *kip, int idx)
204{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800205 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800206 kip->nused--;
207 if (kip->nused == 0) {
208 /*
209 * Page is no longer in use. Free it unless
210 * it's the last one. We keep the last one
211 * so as not to have to set it up again the
212 * next time somebody inserts a probe.
213 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500214 if (!list_is_singular(&kip->list)) {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400215 list_del(&kip->list);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800216 module_free(NULL, kip->insns);
217 kfree(kip);
218 }
219 return 1;
220 }
221 return 0;
222}
223
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500224static int __kprobes collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800225{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400226 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800227
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500228 /* Ensure no-one is interrupted on the garbages */
229 synchronize_sched();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800230
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500231 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800232 int i;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800233 if (kip->ngarbage == 0)
234 continue;
235 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500236 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800237 if (kip->slot_used[i] == SLOT_DIRTY &&
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800238 collect_one_slot(kip, i))
239 break;
240 }
241 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500242 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800243 return 0;
244}
245
Heiko Carstensc802d642013-09-11 14:24:11 -0700246void __kprobes __free_insn_slot(struct kprobe_insn_cache *c,
247 kprobe_opcode_t *slot, int dirty)
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500248{
249 struct kprobe_insn_page *kip;
250
Heiko Carstensc802d642013-09-11 14:24:11 -0700251 mutex_lock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500252 list_for_each_entry(kip, &c->pages, list) {
Masami Hiramatsu83ff56f2010-03-09 10:22:19 -0500253 long idx = ((long)slot - (long)kip->insns) /
254 (c->insn_size * sizeof(kprobe_opcode_t));
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500255 if (idx >= 0 && idx < slots_per_page(c)) {
256 WARN_ON(kip->slot_used[idx] != SLOT_USED);
257 if (dirty) {
258 kip->slot_used[idx] = SLOT_DIRTY;
259 kip->ngarbage++;
260 if (++c->nr_garbage > slots_per_page(c))
261 collect_garbage_slots(c);
262 } else
263 collect_one_slot(kip, idx);
Heiko Carstensc802d642013-09-11 14:24:11 -0700264 goto out;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500265 }
266 }
267 /* Could not free this slot. */
268 WARN_ON(1);
Heiko Carstensc802d642013-09-11 14:24:11 -0700269out:
270 mutex_unlock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500271}
272
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500273#ifdef CONFIG_OPTPROBES
274/* For optimized_kprobe buffer */
Heiko Carstensc802d642013-09-11 14:24:11 -0700275struct kprobe_insn_cache kprobe_optinsn_slots = {
276 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500277 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
278 /* .insn_size is initialized later */
279 .nr_garbage = 0,
280};
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500281#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800282#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700283
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800284/* We have preemption disabled.. so it is safe to use __ versions */
285static inline void set_kprobe_instance(struct kprobe *kp)
286{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600287 __this_cpu_write(kprobe_instance, kp);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800288}
289
290static inline void reset_kprobe_instance(void)
291{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600292 __this_cpu_write(kprobe_instance, NULL);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800293}
294
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800295/*
296 * This routine is called either:
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -0800297 * - under the kprobe_mutex - during kprobe_[un]register()
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800298 * OR
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800299 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800300 */
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -0700301struct kprobe __kprobes *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302{
303 struct hlist_head *head;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800304 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800307 hlist_for_each_entry_rcu(p, head, hlist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 if (p->addr == addr)
309 return p;
310 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500311
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 return NULL;
313}
314
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500315static int __kprobes aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
316
317/* Return true if the kprobe is an aggregator */
318static inline int kprobe_aggrprobe(struct kprobe *p)
319{
320 return p->pre_handler == aggr_pre_handler;
321}
322
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900323/* Return true(!0) if the kprobe is unused */
324static inline int kprobe_unused(struct kprobe *p)
325{
326 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
327 list_empty(&p->list);
328}
329
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500330/*
331 * Keep all fields in the kprobe consistent
332 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900333static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500334{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900335 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
336 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500337}
338
339#ifdef CONFIG_OPTPROBES
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500340/* NOTE: change this value only with kprobe_mutex held */
341static bool kprobes_allow_optimization;
342
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500343/*
344 * Call all pre_handler on the list, but ignores its return value.
345 * This must be called from arch-dep optimized caller.
346 */
347void __kprobes opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
348{
349 struct kprobe *kp;
350
351 list_for_each_entry_rcu(kp, &p->list, list) {
352 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
353 set_kprobe_instance(kp);
354 kp->pre_handler(kp, regs);
355 }
356 reset_kprobe_instance();
357 }
358}
359
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900360/* Free optimized instructions and optimized_kprobe */
361static __kprobes void free_aggr_kprobe(struct kprobe *p)
362{
363 struct optimized_kprobe *op;
364
365 op = container_of(p, struct optimized_kprobe, kp);
366 arch_remove_optimized_kprobe(op);
367 arch_remove_kprobe(p);
368 kfree(op);
369}
370
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500371/* Return true(!0) if the kprobe is ready for optimization. */
372static inline int kprobe_optready(struct kprobe *p)
373{
374 struct optimized_kprobe *op;
375
376 if (kprobe_aggrprobe(p)) {
377 op = container_of(p, struct optimized_kprobe, kp);
378 return arch_prepared_optinsn(&op->optinsn);
379 }
380
381 return 0;
382}
383
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900384/* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
385static inline int kprobe_disarmed(struct kprobe *p)
386{
387 struct optimized_kprobe *op;
388
389 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
390 if (!kprobe_aggrprobe(p))
391 return kprobe_disabled(p);
392
393 op = container_of(p, struct optimized_kprobe, kp);
394
395 return kprobe_disabled(p) && list_empty(&op->list);
396}
397
398/* Return true(!0) if the probe is queued on (un)optimizing lists */
399static int __kprobes kprobe_queued(struct kprobe *p)
400{
401 struct optimized_kprobe *op;
402
403 if (kprobe_aggrprobe(p)) {
404 op = container_of(p, struct optimized_kprobe, kp);
405 if (!list_empty(&op->list))
406 return 1;
407 }
408 return 0;
409}
410
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500411/*
412 * Return an optimized kprobe whose optimizing code replaces
413 * instructions including addr (exclude breakpoint).
414 */
Namhyung Kim6376b222010-09-15 10:04:28 +0900415static struct kprobe *__kprobes get_optimized_kprobe(unsigned long addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500416{
417 int i;
418 struct kprobe *p = NULL;
419 struct optimized_kprobe *op;
420
421 /* Don't check i == 0, since that is a breakpoint case. */
422 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
423 p = get_kprobe((void *)(addr - i));
424
425 if (p && kprobe_optready(p)) {
426 op = container_of(p, struct optimized_kprobe, kp);
427 if (arch_within_optimized_kprobe(op, addr))
428 return p;
429 }
430
431 return NULL;
432}
433
434/* Optimization staging list, protected by kprobe_mutex */
435static LIST_HEAD(optimizing_list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900436static LIST_HEAD(unoptimizing_list);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900437static LIST_HEAD(freeing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500438
439static void kprobe_optimizer(struct work_struct *work);
440static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
441#define OPTIMIZE_DELAY 5
442
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900443/*
444 * Optimize (replace a breakpoint with a jump) kprobes listed on
445 * optimizing_list.
446 */
447static __kprobes void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500448{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900449 /* Optimization never be done when disarmed */
450 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
451 list_empty(&optimizing_list))
452 return;
453
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500454 /*
455 * The optimization/unoptimization refers online_cpus via
456 * stop_machine() and cpu-hotplug modifies online_cpus.
457 * And same time, text_mutex will be held in cpu-hotplug and here.
458 * This combination can cause a deadlock (cpu-hotplug try to lock
459 * text_mutex but stop_machine can not be done because online_cpus
460 * has been changed)
461 * To avoid this deadlock, we need to call get_online_cpus()
462 * for preventing cpu-hotplug outside of text_mutex locking.
463 */
464 get_online_cpus();
465 mutex_lock(&text_mutex);
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900466 arch_optimize_kprobes(&optimizing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500467 mutex_unlock(&text_mutex);
468 put_online_cpus();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900469}
470
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900471/*
472 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
473 * if need) kprobes listed on unoptimizing_list.
474 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900475static __kprobes void do_unoptimize_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900476{
477 struct optimized_kprobe *op, *tmp;
478
479 /* Unoptimization must be done anytime */
480 if (list_empty(&unoptimizing_list))
481 return;
482
483 /* Ditto to do_optimize_kprobes */
484 get_online_cpus();
485 mutex_lock(&text_mutex);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900486 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900487 /* Loop free_list for disarming */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900488 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900489 /* Disarm probes if marked disabled */
490 if (kprobe_disabled(&op->kp))
491 arch_disarm_kprobe(&op->kp);
492 if (kprobe_unused(&op->kp)) {
493 /*
494 * Remove unused probes from hash list. After waiting
495 * for synchronization, these probes are reclaimed.
496 * (reclaiming is done by do_free_cleaned_kprobes.)
497 */
498 hlist_del_rcu(&op->kp.hlist);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900499 } else
500 list_del_init(&op->list);
501 }
502 mutex_unlock(&text_mutex);
503 put_online_cpus();
504}
505
506/* Reclaim all kprobes on the free_list */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900507static __kprobes void do_free_cleaned_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900508{
509 struct optimized_kprobe *op, *tmp;
510
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900511 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900512 BUG_ON(!kprobe_unused(&op->kp));
513 list_del_init(&op->list);
514 free_aggr_kprobe(&op->kp);
515 }
516}
517
518/* Start optimizer after OPTIMIZE_DELAY passed */
519static __kprobes void kick_kprobe_optimizer(void)
520{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800521 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900522}
523
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900524/* Kprobe jump optimizer */
525static __kprobes void kprobe_optimizer(struct work_struct *work)
526{
Steven Rostedt72ef3792012-06-05 19:28:14 +0900527 mutex_lock(&kprobe_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900528 /* Lock modules while optimizing kprobes */
529 mutex_lock(&module_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900530
531 /*
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900532 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
533 * kprobes before waiting for quiesence period.
534 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900535 do_unoptimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900536
537 /*
538 * Step 2: Wait for quiesence period to ensure all running interrupts
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900539 * are done. Because optprobe may modify multiple instructions
540 * there is a chance that Nth instruction is interrupted. In that
541 * case, running interrupt can return to 2nd-Nth byte of jump
542 * instruction. This wait is for avoiding it.
543 */
544 synchronize_sched();
545
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900546 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900547 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900548
549 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900550 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900551
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500552 mutex_unlock(&module_mutex);
Steven Rostedt72ef3792012-06-05 19:28:14 +0900553 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900554
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900555 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900556 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900557 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900558}
559
560/* Wait for completing optimization and unoptimization */
561static __kprobes void wait_for_kprobe_optimizer(void)
562{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800563 mutex_lock(&kprobe_mutex);
564
565 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
566 mutex_unlock(&kprobe_mutex);
567
568 /* this will also make optimizing_work execute immmediately */
569 flush_delayed_work(&optimizing_work);
570 /* @optimizing_work might not have been queued yet, relax */
571 cpu_relax();
572
573 mutex_lock(&kprobe_mutex);
574 }
575
576 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500577}
578
579/* Optimize kprobe if p is ready to be optimized */
580static __kprobes void optimize_kprobe(struct kprobe *p)
581{
582 struct optimized_kprobe *op;
583
584 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500585 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500586 (kprobe_disabled(p) || kprobes_all_disarmed))
587 return;
588
589 /* Both of break_handler and post_handler are not supported. */
590 if (p->break_handler || p->post_handler)
591 return;
592
593 op = container_of(p, struct optimized_kprobe, kp);
594
595 /* Check there is no other kprobes at the optimized instructions */
596 if (arch_check_optimized_kprobe(op) < 0)
597 return;
598
599 /* Check if it is already optimized. */
600 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
601 return;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500602 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900603
604 if (!list_empty(&op->list))
605 /* This is under unoptimizing. Just dequeue the probe */
606 list_del_init(&op->list);
607 else {
608 list_add(&op->list, &optimizing_list);
609 kick_kprobe_optimizer();
610 }
611}
612
613/* Short cut to direct unoptimizing */
614static __kprobes void force_unoptimize_kprobe(struct optimized_kprobe *op)
615{
616 get_online_cpus();
617 arch_unoptimize_kprobe(op);
618 put_online_cpus();
619 if (kprobe_disabled(&op->kp))
620 arch_disarm_kprobe(&op->kp);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500621}
622
623/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900624static __kprobes void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500625{
626 struct optimized_kprobe *op;
627
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900628 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
629 return; /* This is not an optprobe nor optimized */
630
631 op = container_of(p, struct optimized_kprobe, kp);
632 if (!kprobe_optimized(p)) {
633 /* Unoptimized or unoptimizing case */
634 if (force && !list_empty(&op->list)) {
635 /*
636 * Only if this is unoptimizing kprobe and forced,
637 * forcibly unoptimize it. (No need to unoptimize
638 * unoptimized kprobe again :)
639 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500640 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900641 force_unoptimize_kprobe(op);
642 }
643 return;
644 }
645
646 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
647 if (!list_empty(&op->list)) {
648 /* Dequeue from the optimization queue */
649 list_del_init(&op->list);
650 return;
651 }
652 /* Optimized kprobe case */
653 if (force)
654 /* Forcibly update the code: this is a special case */
655 force_unoptimize_kprobe(op);
656 else {
657 list_add(&op->list, &unoptimizing_list);
658 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500659 }
660}
661
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900662/* Cancel unoptimizing for reusing */
663static void reuse_unused_kprobe(struct kprobe *ap)
664{
665 struct optimized_kprobe *op;
666
667 BUG_ON(!kprobe_unused(ap));
668 /*
669 * Unused kprobe MUST be on the way of delayed unoptimizing (means
670 * there is still a relative jump) and disabled.
671 */
672 op = container_of(ap, struct optimized_kprobe, kp);
673 if (unlikely(list_empty(&op->list)))
674 printk(KERN_WARNING "Warning: found a stray unused "
675 "aggrprobe@%p\n", ap->addr);
676 /* Enable the probe again */
677 ap->flags &= ~KPROBE_FLAG_DISABLED;
678 /* Optimize it again (remove from op->list) */
679 BUG_ON(!kprobe_optready(ap));
680 optimize_kprobe(ap);
681}
682
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500683/* Remove optimized instructions */
684static void __kprobes kill_optimized_kprobe(struct kprobe *p)
685{
686 struct optimized_kprobe *op;
687
688 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900689 if (!list_empty(&op->list))
690 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500691 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900692 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900693
694 if (kprobe_unused(p)) {
695 /* Enqueue if it is unused */
696 list_add(&op->list, &freeing_list);
697 /*
698 * Remove unused probes from the hash list. After waiting
699 * for synchronization, this probe is reclaimed.
700 * (reclaiming is done by do_free_cleaned_kprobes().)
701 */
702 hlist_del_rcu(&op->kp.hlist);
703 }
704
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900705 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500706 arch_remove_optimized_kprobe(op);
707}
708
709/* Try to prepare optimized instructions */
710static __kprobes void prepare_optimized_kprobe(struct kprobe *p)
711{
712 struct optimized_kprobe *op;
713
714 op = container_of(p, struct optimized_kprobe, kp);
715 arch_prepare_optimized_kprobe(op);
716}
717
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500718/* Allocate new optimized_kprobe and try to prepare optimized instructions */
719static __kprobes struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
720{
721 struct optimized_kprobe *op;
722
723 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
724 if (!op)
725 return NULL;
726
727 INIT_LIST_HEAD(&op->list);
728 op->kp.addr = p->addr;
729 arch_prepare_optimized_kprobe(op);
730
731 return &op->kp;
732}
733
734static void __kprobes init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
735
736/*
737 * Prepare an optimized_kprobe and optimize it
738 * NOTE: p must be a normal registered kprobe
739 */
740static __kprobes void try_to_optimize_kprobe(struct kprobe *p)
741{
742 struct kprobe *ap;
743 struct optimized_kprobe *op;
744
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900745 /* Impossible to optimize ftrace-based kprobe */
746 if (kprobe_ftrace(p))
747 return;
748
Masami Hiramatsu25764282012-06-05 19:28:26 +0900749 /* For preparing optimization, jump_label_text_reserved() is called */
750 jump_label_lock();
751 mutex_lock(&text_mutex);
752
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500753 ap = alloc_aggr_kprobe(p);
754 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900755 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500756
757 op = container_of(ap, struct optimized_kprobe, kp);
758 if (!arch_prepared_optinsn(&op->optinsn)) {
759 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900760 arch_remove_optimized_kprobe(op);
761 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900762 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500763 }
764
765 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900766 optimize_kprobe(ap); /* This just kicks optimizer thread */
767
768out:
769 mutex_unlock(&text_mutex);
770 jump_label_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500771}
772
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500773#ifdef CONFIG_SYSCTL
774static void __kprobes optimize_all_kprobes(void)
775{
776 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500777 struct kprobe *p;
778 unsigned int i;
779
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900780 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500781 /* If optimization is already allowed, just return */
782 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900783 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500784
785 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500786 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
787 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800788 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500789 if (!kprobe_disabled(p))
790 optimize_kprobe(p);
791 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500792 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900793out:
794 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500795}
796
797static void __kprobes unoptimize_all_kprobes(void)
798{
799 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500800 struct kprobe *p;
801 unsigned int i;
802
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900803 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500804 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900805 if (!kprobes_allow_optimization) {
806 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500807 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900808 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500809
810 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500811 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
812 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800813 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500814 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900815 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500816 }
817 }
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900818 mutex_unlock(&kprobe_mutex);
819
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900820 /* Wait for unoptimizing completion */
821 wait_for_kprobe_optimizer();
822 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500823}
824
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900825static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500826int sysctl_kprobes_optimization;
827int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
828 void __user *buffer, size_t *length,
829 loff_t *ppos)
830{
831 int ret;
832
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900833 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500834 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
835 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
836
837 if (sysctl_kprobes_optimization)
838 optimize_all_kprobes();
839 else
840 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900841 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500842
843 return ret;
844}
845#endif /* CONFIG_SYSCTL */
846
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900847/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500848static void __kprobes __arm_kprobe(struct kprobe *p)
849{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900850 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500851
852 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900853 _p = get_optimized_kprobe((unsigned long)p->addr);
854 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900855 /* Fallback to unoptimized kprobe */
856 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500857
858 arch_arm_kprobe(p);
859 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
860}
861
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900862/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
863static void __kprobes __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500864{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900865 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500866
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900867 unoptimize_kprobe(p, false); /* Try to unoptimize */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500868
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900869 if (!kprobe_queued(p)) {
870 arch_disarm_kprobe(p);
871 /* If another kprobe was blocked, optimize it. */
872 _p = get_optimized_kprobe((unsigned long)p->addr);
873 if (unlikely(_p) && reopt)
874 optimize_kprobe(_p);
875 }
876 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500877}
878
879#else /* !CONFIG_OPTPROBES */
880
881#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900882#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500883#define kill_optimized_kprobe(p) do {} while (0)
884#define prepare_optimized_kprobe(p) do {} while (0)
885#define try_to_optimize_kprobe(p) do {} while (0)
886#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900887#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
888#define kprobe_disarmed(p) kprobe_disabled(p)
889#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500890
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900891/* There should be no unused kprobes can be reused without optimization */
892static void reuse_unused_kprobe(struct kprobe *ap)
893{
894 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
895 BUG_ON(kprobe_unused(ap));
896}
897
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500898static __kprobes void free_aggr_kprobe(struct kprobe *p)
899{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900900 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500901 kfree(p);
902}
903
904static __kprobes struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
905{
906 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
907}
908#endif /* CONFIG_OPTPROBES */
909
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900910#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900911static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +0900912 .func = kprobe_ftrace_handler,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900913 .flags = FTRACE_OPS_FL_SAVE_REGS,
914};
915static int kprobe_ftrace_enabled;
916
917/* Must ensure p->addr is really on ftrace */
918static int __kprobes prepare_kprobe(struct kprobe *p)
919{
920 if (!kprobe_ftrace(p))
921 return arch_prepare_kprobe(p);
922
923 return arch_prepare_kprobe_ftrace(p);
924}
925
926/* Caller must lock kprobe_mutex */
927static void __kprobes arm_kprobe_ftrace(struct kprobe *p)
928{
929 int ret;
930
931 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
932 (unsigned long)p->addr, 0, 0);
933 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
934 kprobe_ftrace_enabled++;
935 if (kprobe_ftrace_enabled == 1) {
936 ret = register_ftrace_function(&kprobe_ftrace_ops);
937 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
938 }
939}
940
941/* Caller must lock kprobe_mutex */
942static void __kprobes disarm_kprobe_ftrace(struct kprobe *p)
943{
944 int ret;
945
946 kprobe_ftrace_enabled--;
947 if (kprobe_ftrace_enabled == 0) {
948 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
949 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
950 }
951 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
952 (unsigned long)p->addr, 1, 0);
953 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
954}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900955#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900956#define prepare_kprobe(p) arch_prepare_kprobe(p)
957#define arm_kprobe_ftrace(p) do {} while (0)
958#define disarm_kprobe_ftrace(p) do {} while (0)
959#endif
960
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400961/* Arm a kprobe with text_mutex */
962static void __kprobes arm_kprobe(struct kprobe *kp)
963{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900964 if (unlikely(kprobe_ftrace(kp))) {
965 arm_kprobe_ftrace(kp);
966 return;
967 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500968 /*
969 * Here, since __arm_kprobe() doesn't use stop_machine(),
970 * this doesn't cause deadlock on text_mutex. So, we don't
971 * need get_online_cpus().
972 */
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400973 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500974 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400975 mutex_unlock(&text_mutex);
976}
977
978/* Disarm a kprobe with text_mutex */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900979static void __kprobes disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400980{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900981 if (unlikely(kprobe_ftrace(kp))) {
982 disarm_kprobe_ftrace(kp);
983 return;
984 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900985 /* Ditto */
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400986 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900987 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400988 mutex_unlock(&text_mutex);
989}
990
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700991/*
992 * Aggregate handlers for multiple kprobes support - these handlers
993 * take care of invoking the individual kprobe handlers on p->list
994 */
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -0700995static int __kprobes aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -0700996{
997 struct kprobe *kp;
998
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800999 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001000 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001001 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001002 if (kp->pre_handler(kp, regs))
1003 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001004 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001005 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001006 }
1007 return 0;
1008}
1009
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001010static void __kprobes aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1011 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001012{
1013 struct kprobe *kp;
1014
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001015 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001016 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001017 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001018 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001019 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001020 }
1021 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001022}
1023
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001024static int __kprobes aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1025 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001026{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001027 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001028
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001029 /*
1030 * if we faulted "during" the execution of a user specified
1031 * probe handler, invoke just that probe's fault handler
1032 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001033 if (cur && cur->fault_handler) {
1034 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001035 return 1;
1036 }
1037 return 0;
1038}
1039
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001040static int __kprobes aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001041{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001042 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001043 int ret = 0;
1044
1045 if (cur && cur->break_handler) {
1046 if (cur->break_handler(cur, regs))
1047 ret = 1;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001048 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001049 reset_kprobe_instance();
1050 return ret;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001051}
1052
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001053/* Walks the list and increments nmissed count for multiprobe case */
1054void __kprobes kprobes_inc_nmissed_count(struct kprobe *p)
1055{
1056 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001057 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001058 p->nmissed++;
1059 } else {
1060 list_for_each_entry_rcu(kp, &p->list, list)
1061 kp->nmissed++;
1062 }
1063 return;
1064}
1065
bibo,mao99219a32006-10-02 02:17:35 -07001066void __kprobes recycle_rp_inst(struct kretprobe_instance *ri,
1067 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001068{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001069 struct kretprobe *rp = ri->rp;
1070
Hien Nguyenb94cce92005-06-23 00:09:19 -07001071 /* remove rp inst off the rprobe_inst_table */
1072 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001073 INIT_HLIST_NODE(&ri->hlist);
1074 if (likely(rp)) {
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001075 raw_spin_lock(&rp->lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001076 hlist_add_head(&ri->hlist, &rp->free_instances);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001077 raw_spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001078 } else
1079 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -07001080 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001081}
1082
Masami Hiramatsu017c39b2009-01-06 14:41:51 -08001083void __kprobes kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001084 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001085__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001086{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001087 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001088 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001089
1090 *head = &kretprobe_inst_table[hash];
1091 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001092 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001093}
1094
Masami Hiramatsu017c39b2009-01-06 14:41:51 -08001095static void __kprobes kretprobe_table_lock(unsigned long hash,
1096 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001097__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001098{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001099 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1100 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001101}
1102
Masami Hiramatsu017c39b2009-01-06 14:41:51 -08001103void __kprobes kretprobe_hash_unlock(struct task_struct *tsk,
1104 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001105__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001106{
1107 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001108 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001109
1110 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001111 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001112}
1113
Namhyung Kim6376b222010-09-15 10:04:28 +09001114static void __kprobes kretprobe_table_unlock(unsigned long hash,
1115 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001116__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001117{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001118 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1119 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001120}
1121
Hien Nguyenb94cce92005-06-23 00:09:19 -07001122/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001123 * This function is called from finish_task_switch when task tk becomes dead,
1124 * so that we can recycle any function-return probe instances associated
1125 * with this task. These left over instances represent probed functions
1126 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001127 */
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001128void __kprobes kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001129{
bibo,mao62c27be2006-10-02 02:17:33 -07001130 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -07001131 struct hlist_head *head, empty_rp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001132 struct hlist_node *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001133 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -07001134
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001135 if (unlikely(!kprobes_initialized))
1136 /* Early boot. kretprobe_table_locks not yet initialized. */
1137 return;
1138
Ananth N Mavinakayanahallid496aab2012-01-20 14:34:04 -08001139 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001140 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1141 head = &kretprobe_inst_table[hash];
1142 kretprobe_table_lock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001143 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -07001144 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -07001145 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -07001146 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001147 kretprobe_table_unlock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001148 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
bibo,mao99219a32006-10-02 02:17:35 -07001149 hlist_del(&ri->hlist);
1150 kfree(ri);
1151 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001152}
1153
Hien Nguyenb94cce92005-06-23 00:09:19 -07001154static inline void free_rp_inst(struct kretprobe *rp)
1155{
1156 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001157 struct hlist_node *next;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001158
Sasha Levinb67bfe02013-02-27 17:06:00 -08001159 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001160 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001161 kfree(ri);
1162 }
1163}
1164
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001165static void __kprobes cleanup_rp_inst(struct kretprobe *rp)
1166{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001167 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001168 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001169 struct hlist_node *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001170 struct hlist_head *head;
1171
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001172 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001173 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1174 kretprobe_table_lock(hash, &flags);
1175 head = &kretprobe_inst_table[hash];
Sasha Levinb67bfe02013-02-27 17:06:00 -08001176 hlist_for_each_entry_safe(ri, next, head, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001177 if (ri->rp == rp)
1178 ri->rp = NULL;
1179 }
1180 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001181 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001182 free_rp_inst(rp);
1183}
1184
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001185/*
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001186* Add the new probe to ap->list. Fail if this is the
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001187* second jprobe at the address - two jprobes can't coexist
1188*/
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001189static int __kprobes add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001190{
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001191 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001192
1193 if (p->break_handler || p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001194 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001195
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001196 if (p->break_handler) {
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001197 if (ap->break_handler)
mao, bibo36721652006-06-26 00:25:22 -07001198 return -EEXIST;
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001199 list_add_tail_rcu(&p->list, &ap->list);
1200 ap->break_handler = aggr_break_handler;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001201 } else
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001202 list_add_rcu(&p->list, &ap->list);
1203 if (p->post_handler && !ap->post_handler)
1204 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001205
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001206 return 0;
1207}
1208
1209/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001210 * Fill in the required fields of the "manager kprobe". Replace the
1211 * earlier kprobe in the hlist with the manager kprobe
1212 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001213static void __kprobes init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001214{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001215 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001216 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001217 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001218 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001219 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001220 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001221 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001222 /* We don't care the kprobe which has gone. */
1223 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001224 ap->post_handler = aggr_post_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001225 if (p->break_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001226 ap->break_handler = aggr_break_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001227
1228 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001229 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001230
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001231 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001232 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001233}
1234
1235/*
1236 * This is the second or subsequent kprobe at the address - handle
1237 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001238 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001239static int __kprobes register_aggr_kprobe(struct kprobe *orig_p,
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001240 struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001241{
1242 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001243 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001244
Masami Hiramatsu25764282012-06-05 19:28:26 +09001245 /* For preparing optimization, jump_label_text_reserved() is called */
1246 jump_label_lock();
1247 /*
1248 * Get online CPUs to avoid text_mutex deadlock.with stop machine,
1249 * which is invoked by unoptimize_kprobe() in add_new_kprobe()
1250 */
1251 get_online_cpus();
1252 mutex_lock(&text_mutex);
1253
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001254 if (!kprobe_aggrprobe(orig_p)) {
1255 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1256 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001257 if (!ap) {
1258 ret = -ENOMEM;
1259 goto out;
1260 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001261 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001262 } else if (kprobe_unused(ap))
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001263 /* This probe is going to die. Rescue it */
1264 reuse_unused_kprobe(ap);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001265
1266 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001267 /*
1268 * Attempting to insert new probe at the same location that
1269 * had a probe in the module vaddr area which already
1270 * freed. So, the instruction slot has already been
1271 * released. We need a new slot for the new probe.
1272 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001273 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001274 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001275 /*
1276 * Even if fail to allocate new slot, don't need to
1277 * free aggr_probe. It will be used next time, or
1278 * freed by unregister_kprobe.
1279 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001280 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001281
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001282 /* Prepare optimized instructions if possible. */
1283 prepare_optimized_kprobe(ap);
1284
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001285 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001286 * Clear gone flag to prevent allocating new slot again, and
1287 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001288 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001289 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1290 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001291 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001292
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001293 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001294 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001295 ret = add_new_kprobe(ap, p);
1296
1297out:
1298 mutex_unlock(&text_mutex);
1299 put_online_cpus();
1300 jump_label_unlock();
1301
1302 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1303 ap->flags &= ~KPROBE_FLAG_DISABLED;
1304 if (!kprobes_all_disarmed)
1305 /* Arm the breakpoint again. */
1306 arm_kprobe(ap);
1307 }
1308 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001309}
1310
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001311static int __kprobes in_kprobes_functions(unsigned long addr)
1312{
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001313 struct kprobe_blackpoint *kb;
1314
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001315 if (addr >= (unsigned long)__kprobes_text_start &&
1316 addr < (unsigned long)__kprobes_text_end)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001317 return -EINVAL;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001318 /*
1319 * If there exists a kprobe_blacklist, verify and
1320 * fail any probe registration in the prohibited area
1321 */
1322 for (kb = kprobe_blacklist; kb->name != NULL; kb++) {
1323 if (kb->start_addr) {
1324 if (addr >= kb->start_addr &&
1325 addr < (kb->start_addr + kb->range))
1326 return -EINVAL;
1327 }
1328 }
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001329 return 0;
1330}
1331
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001332/*
1333 * If we have a symbol_name argument, look it up and add the offset field
1334 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001335 * This returns encoded errors if it fails to look up symbol or invalid
1336 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001337 */
1338static kprobe_opcode_t __kprobes *kprobe_addr(struct kprobe *p)
1339{
1340 kprobe_opcode_t *addr = p->addr;
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001341
1342 if ((p->symbol_name && p->addr) ||
1343 (!p->symbol_name && !p->addr))
1344 goto invalid;
1345
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001346 if (p->symbol_name) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001347 kprobe_lookup_name(p->symbol_name, addr);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001348 if (!addr)
1349 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001350 }
1351
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001352 addr = (kprobe_opcode_t *)(((char *)addr) + p->offset);
1353 if (addr)
1354 return addr;
1355
1356invalid:
1357 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001358}
1359
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301360/* Check passed kprobe is valid and return kprobe in kprobe_table. */
1361static struct kprobe * __kprobes __get_valid_kprobe(struct kprobe *p)
1362{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001363 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301364
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001365 ap = get_kprobe(p->addr);
1366 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301367 return NULL;
1368
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001369 if (p != ap) {
1370 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301371 if (list_p == p)
1372 /* kprobe p is a valid probe */
1373 goto valid;
1374 return NULL;
1375 }
1376valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001377 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301378}
1379
1380/* Return error if the kprobe is being re-registered */
1381static inline int check_kprobe_rereg(struct kprobe *p)
1382{
1383 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301384
1385 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001386 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301387 ret = -EINVAL;
1388 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001389
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301390 return ret;
1391}
1392
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001393static __kprobes int check_kprobe_address_safe(struct kprobe *p,
1394 struct module **probed_mod)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395{
1396 int ret = 0;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001397 unsigned long ftrace_addr;
1398
1399 /*
1400 * If the address is located on a ftrace nop, set the
1401 * breakpoint to the following instruction.
1402 */
1403 ftrace_addr = ftrace_location((unsigned long)p->addr);
1404 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001405#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001406 /* Given address is not on the instruction boundary */
1407 if ((unsigned long)p->addr != ftrace_addr)
1408 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001409 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001410#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001411 return -EINVAL;
1412#endif
1413 }
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001414
1415 jump_label_lock();
1416 preempt_disable();
1417
1418 /* Ensure it is not in reserved area nor out of text */
1419 if (!kernel_text_address((unsigned long) p->addr) ||
1420 in_kprobes_functions((unsigned long) p->addr) ||
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001421 jump_label_text_reserved(p->addr, p->addr)) {
1422 ret = -EINVAL;
1423 goto out;
1424 }
1425
1426 /* Check if are we probing a module */
1427 *probed_mod = __module_text_address((unsigned long) p->addr);
1428 if (*probed_mod) {
1429 /*
1430 * We must hold a refcount of the probed module while updating
1431 * its code to prohibit unexpected unloading.
1432 */
1433 if (unlikely(!try_module_get(*probed_mod))) {
1434 ret = -ENOENT;
1435 goto out;
1436 }
1437
1438 /*
1439 * If the module freed .init.text, we couldn't insert
1440 * kprobes in there.
1441 */
1442 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1443 (*probed_mod)->state != MODULE_STATE_COMING) {
1444 module_put(*probed_mod);
1445 *probed_mod = NULL;
1446 ret = -ENOENT;
1447 }
1448 }
1449out:
1450 preempt_enable();
1451 jump_label_unlock();
1452
1453 return ret;
1454}
1455
1456int __kprobes register_kprobe(struct kprobe *p)
1457{
1458 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001459 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001460 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001461 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001463 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001464 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001465 if (IS_ERR(addr))
1466 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001467 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001468
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301469 ret = check_kprobe_rereg(p);
1470 if (ret)
1471 return ret;
1472
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001473 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1474 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001475 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001476 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001477
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001478 ret = check_kprobe_address_safe(p, &probed_mod);
1479 if (ret)
1480 return ret;
1481
1482 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001483
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001484 old_p = get_kprobe(p->addr);
1485 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001486 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001487 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 goto out;
1489 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490
Masami Hiramatsu25764282012-06-05 19:28:26 +09001491 mutex_lock(&text_mutex); /* Avoiding text modification */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001492 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001493 mutex_unlock(&text_mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001494 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001495 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001496
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001497 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001498 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1500
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001501 if (!kprobes_all_disarmed && !kprobe_disabled(p))
Masami Hiramatsu25764282012-06-05 19:28:26 +09001502 arm_kprobe(p);
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001503
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001504 /* Try to optimize kprobe */
1505 try_to_optimize_kprobe(p);
1506
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001508 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001509
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001510 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001511 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001512
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 return ret;
1514}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001515EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001517/* Check if all probes on the aggrprobe are disabled */
1518static int __kprobes aggr_kprobe_disabled(struct kprobe *ap)
1519{
1520 struct kprobe *kp;
1521
1522 list_for_each_entry_rcu(kp, &ap->list, list)
1523 if (!kprobe_disabled(kp))
1524 /*
1525 * There is an active probe on the list.
1526 * We can't disable this ap.
1527 */
1528 return 0;
1529
1530 return 1;
1531}
1532
1533/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
1534static struct kprobe *__kprobes __disable_kprobe(struct kprobe *p)
1535{
1536 struct kprobe *orig_p;
1537
1538 /* Get an original kprobe for return */
1539 orig_p = __get_valid_kprobe(p);
1540 if (unlikely(orig_p == NULL))
1541 return NULL;
1542
1543 if (!kprobe_disabled(p)) {
1544 /* Disable probe if it is a child probe */
1545 if (p != orig_p)
1546 p->flags |= KPROBE_FLAG_DISABLED;
1547
1548 /* Try to disarm and disable this/parent probe */
1549 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001550 disarm_kprobe(orig_p, true);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001551 orig_p->flags |= KPROBE_FLAG_DISABLED;
1552 }
1553 }
1554
1555 return orig_p;
1556}
1557
Masami Hiramatsu98616682008-04-28 02:14:28 -07001558/*
1559 * Unregister a kprobe without a scheduler synchronization.
1560 */
1561static int __kprobes __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001562{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001563 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001564
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001565 /* Disable kprobe. This will disarm it if needed. */
1566 ap = __disable_kprobe(p);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001567 if (ap == NULL)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001568 return -EINVAL;
1569
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001570 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001571 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001572 * This probe is an independent(and non-optimized) kprobe
1573 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001574 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001575 goto disarmed;
1576
1577 /* Following process expects this probe is an aggrprobe */
1578 WARN_ON(!kprobe_aggrprobe(ap));
1579
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001580 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1581 /*
1582 * !disarmed could be happen if the probe is under delayed
1583 * unoptimizing.
1584 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001585 goto disarmed;
1586 else {
1587 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001588 if (p->break_handler && !kprobe_gone(p))
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001589 ap->break_handler = NULL;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001590 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001591 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001592 if ((list_p != p) && (list_p->post_handler))
1593 goto noclean;
1594 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001595 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001596 }
1597noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001598 /*
1599 * Remove from the aggrprobe: this path will do nothing in
1600 * __unregister_kprobe_bottom().
1601 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001602 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001603 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1604 /*
1605 * Try to optimize this probe again, because post
1606 * handler may have been changed.
1607 */
1608 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001609 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001610 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001611
1612disarmed:
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001613 BUG_ON(!kprobe_disarmed(ap));
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001614 hlist_del_rcu(&ap->hlist);
1615 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001616}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001617
Masami Hiramatsu98616682008-04-28 02:14:28 -07001618static void __kprobes __unregister_kprobe_bottom(struct kprobe *p)
1619{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001620 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001621
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001622 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001623 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001624 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001625 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001626 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001627 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001628 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001629 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001630 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001631 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632}
1633
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001634int __kprobes register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001635{
1636 int i, ret = 0;
1637
1638 if (num <= 0)
1639 return -EINVAL;
1640 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001641 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001642 if (ret < 0) {
1643 if (i > 0)
1644 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001645 break;
1646 }
1647 }
1648 return ret;
1649}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001650EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001651
Masami Hiramatsu98616682008-04-28 02:14:28 -07001652void __kprobes unregister_kprobe(struct kprobe *p)
1653{
1654 unregister_kprobes(&p, 1);
1655}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001656EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001657
Masami Hiramatsu98616682008-04-28 02:14:28 -07001658void __kprobes unregister_kprobes(struct kprobe **kps, int num)
1659{
1660 int i;
1661
1662 if (num <= 0)
1663 return;
1664 mutex_lock(&kprobe_mutex);
1665 for (i = 0; i < num; i++)
1666 if (__unregister_kprobe_top(kps[i]) < 0)
1667 kps[i]->addr = NULL;
1668 mutex_unlock(&kprobe_mutex);
1669
1670 synchronize_sched();
1671 for (i = 0; i < num; i++)
1672 if (kps[i]->addr)
1673 __unregister_kprobe_bottom(kps[i]);
1674}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001675EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001676
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677static struct notifier_block kprobe_exceptions_nb = {
1678 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001679 .priority = 0x7fffffff /* we need to be notified first */
1680};
1681
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001682unsigned long __weak arch_deref_entry_point(void *entry)
1683{
1684 return (unsigned long)entry;
1685}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001687int __kprobes register_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001688{
1689 struct jprobe *jp;
1690 int ret = 0, i;
1691
1692 if (num <= 0)
1693 return -EINVAL;
1694 for (i = 0; i < num; i++) {
Namhyung Kim05662bd2010-09-15 10:04:27 +09001695 unsigned long addr, offset;
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001696 jp = jps[i];
1697 addr = arch_deref_entry_point(jp->entry);
1698
Namhyung Kim05662bd2010-09-15 10:04:27 +09001699 /* Verify probepoint is a function entry point */
1700 if (kallsyms_lookup_size_offset(addr, NULL, &offset) &&
1701 offset == 0) {
1702 jp->kp.pre_handler = setjmp_pre_handler;
1703 jp->kp.break_handler = longjmp_break_handler;
1704 ret = register_kprobe(&jp->kp);
1705 } else
1706 ret = -EINVAL;
Namhyung Kimedbaadb2010-09-15 10:04:26 +09001707
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001708 if (ret < 0) {
1709 if (i > 0)
1710 unregister_jprobes(jps, i);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001711 break;
1712 }
1713 }
1714 return ret;
1715}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001716EXPORT_SYMBOL_GPL(register_jprobes);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001717
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001718int __kprobes register_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719{
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001720 return register_jprobes(&jp, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001722EXPORT_SYMBOL_GPL(register_jprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001724void __kprobes unregister_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725{
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001726 unregister_jprobes(&jp, 1);
1727}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001728EXPORT_SYMBOL_GPL(unregister_jprobe);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001729
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001730void __kprobes unregister_jprobes(struct jprobe **jps, int num)
1731{
1732 int i;
1733
1734 if (num <= 0)
1735 return;
1736 mutex_lock(&kprobe_mutex);
1737 for (i = 0; i < num; i++)
1738 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1739 jps[i]->kp.addr = NULL;
1740 mutex_unlock(&kprobe_mutex);
1741
1742 synchronize_sched();
1743 for (i = 0; i < num; i++) {
1744 if (jps[i]->kp.addr)
1745 __unregister_kprobe_bottom(&jps[i]->kp);
1746 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001748EXPORT_SYMBOL_GPL(unregister_jprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001750#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001751/*
1752 * This kprobe pre_handler is registered with every kretprobe. When probe
1753 * hits it will set up the return probe.
1754 */
1755static int __kprobes pre_handler_kretprobe(struct kprobe *p,
1756 struct pt_regs *regs)
1757{
1758 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001759 unsigned long hash, flags = 0;
1760 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001761
1762 /*TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001763 hash = hash_ptr(current, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001764 raw_spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001765 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001766 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001767 struct kretprobe_instance, hlist);
1768 hlist_del(&ri->hlist);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001769 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001770
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001771 ri->rp = rp;
1772 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001773
Jiang Liu55ca6142012-02-03 15:37:16 -08001774 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1775 raw_spin_lock_irqsave(&rp->lock, flags);
1776 hlist_add_head(&ri->hlist, &rp->free_instances);
1777 raw_spin_unlock_irqrestore(&rp->lock, flags);
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001778 return 0;
Jiang Liu55ca6142012-02-03 15:37:16 -08001779 }
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001780
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001781 arch_prepare_kretprobe(ri, regs);
1782
1783 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001784 INIT_HLIST_NODE(&ri->hlist);
1785 kretprobe_table_lock(hash, &flags);
1786 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1787 kretprobe_table_unlock(hash, &flags);
1788 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001789 rp->nmissed++;
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001790 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001791 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001792 return 0;
1793}
1794
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001795int __kprobes register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001796{
1797 int ret = 0;
1798 struct kretprobe_instance *inst;
1799 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001800 void *addr;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001801
1802 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001803 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001804 if (IS_ERR(addr))
1805 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001806
1807 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1808 if (kretprobe_blacklist[i].addr == addr)
1809 return -EINVAL;
1810 }
1811 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001812
1813 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001814 rp->kp.post_handler = NULL;
1815 rp->kp.fault_handler = NULL;
1816 rp->kp.break_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001817
1818 /* Pre-allocate memory for max kretprobe instances */
1819 if (rp->maxactive <= 0) {
1820#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001821 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001822#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301823 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001824#endif
1825 }
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001826 raw_spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001827 INIT_HLIST_HEAD(&rp->free_instances);
1828 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001829 inst = kmalloc(sizeof(struct kretprobe_instance) +
1830 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001831 if (inst == NULL) {
1832 free_rp_inst(rp);
1833 return -ENOMEM;
1834 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001835 INIT_HLIST_NODE(&inst->hlist);
1836 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001837 }
1838
1839 rp->nmissed = 0;
1840 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001841 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001842 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001843 free_rp_inst(rp);
1844 return ret;
1845}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001846EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001847
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001848int __kprobes register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001849{
1850 int ret = 0, i;
1851
1852 if (num <= 0)
1853 return -EINVAL;
1854 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001855 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001856 if (ret < 0) {
1857 if (i > 0)
1858 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001859 break;
1860 }
1861 }
1862 return ret;
1863}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001864EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001865
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001866void __kprobes unregister_kretprobe(struct kretprobe *rp)
1867{
1868 unregister_kretprobes(&rp, 1);
1869}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001870EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001871
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001872void __kprobes unregister_kretprobes(struct kretprobe **rps, int num)
1873{
1874 int i;
1875
1876 if (num <= 0)
1877 return;
1878 mutex_lock(&kprobe_mutex);
1879 for (i = 0; i < num; i++)
1880 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1881 rps[i]->kp.addr = NULL;
1882 mutex_unlock(&kprobe_mutex);
1883
1884 synchronize_sched();
1885 for (i = 0; i < num; i++) {
1886 if (rps[i]->kp.addr) {
1887 __unregister_kprobe_bottom(&rps[i]->kp);
1888 cleanup_rp_inst(rps[i]);
1889 }
1890 }
1891}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001892EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001893
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001894#else /* CONFIG_KRETPROBES */
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001895int __kprobes register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001896{
1897 return -ENOSYS;
1898}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001899EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001900
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001901int __kprobes register_kretprobes(struct kretprobe **rps, int num)
1902{
1903 return -ENOSYS;
1904}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001905EXPORT_SYMBOL_GPL(register_kretprobes);
1906
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001907void __kprobes unregister_kretprobe(struct kretprobe *rp)
1908{
1909}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001910EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001911
1912void __kprobes unregister_kretprobes(struct kretprobe **rps, int num)
1913{
1914}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001915EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001916
Srinivasa Ds346fd592007-02-20 13:57:54 -08001917static int __kprobes pre_handler_kretprobe(struct kprobe *p,
1918 struct pt_regs *regs)
1919{
1920 return 0;
1921}
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001922
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001923#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07001924
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001925/* Set the kprobe gone and remove its instruction buffer. */
1926static void __kprobes kill_kprobe(struct kprobe *p)
1927{
1928 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001929
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001930 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001931 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001932 /*
1933 * If this is an aggr_kprobe, we have to list all the
1934 * chained probes and mark them GONE.
1935 */
1936 list_for_each_entry_rcu(kp, &p->list, list)
1937 kp->flags |= KPROBE_FLAG_GONE;
1938 p->post_handler = NULL;
1939 p->break_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001940 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001941 }
1942 /*
1943 * Here, we can remove insn_slot safely, because no thread calls
1944 * the original probed function (which will be freed soon) any more.
1945 */
1946 arch_remove_kprobe(p);
1947}
1948
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001949/* Disable one kprobe */
1950int __kprobes disable_kprobe(struct kprobe *kp)
1951{
1952 int ret = 0;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001953
1954 mutex_lock(&kprobe_mutex);
1955
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001956 /* Disable this kprobe */
1957 if (__disable_kprobe(kp) == NULL)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001958 ret = -EINVAL;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001959
Masami Hiramatsuc0614822010-04-27 18:33:12 -04001960 mutex_unlock(&kprobe_mutex);
1961 return ret;
1962}
1963EXPORT_SYMBOL_GPL(disable_kprobe);
1964
1965/* Enable one kprobe */
1966int __kprobes enable_kprobe(struct kprobe *kp)
1967{
1968 int ret = 0;
1969 struct kprobe *p;
1970
1971 mutex_lock(&kprobe_mutex);
1972
1973 /* Check whether specified probe is valid. */
1974 p = __get_valid_kprobe(kp);
1975 if (unlikely(p == NULL)) {
1976 ret = -EINVAL;
1977 goto out;
1978 }
1979
1980 if (kprobe_gone(kp)) {
1981 /* This kprobe has gone, we couldn't enable it. */
1982 ret = -EINVAL;
1983 goto out;
1984 }
1985
1986 if (p != kp)
1987 kp->flags &= ~KPROBE_FLAG_DISABLED;
1988
1989 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
1990 p->flags &= ~KPROBE_FLAG_DISABLED;
1991 arm_kprobe(p);
1992 }
1993out:
1994 mutex_unlock(&kprobe_mutex);
1995 return ret;
1996}
1997EXPORT_SYMBOL_GPL(enable_kprobe);
1998
Frederic Weisbecker24851d22009-08-26 23:38:30 +02001999void __kprobes dump_kprobe(struct kprobe *kp)
2000{
2001 printk(KERN_WARNING "Dumping kprobe:\n");
2002 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2003 kp->symbol_name, kp->addr, kp->offset);
2004}
2005
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002006/* Module notifier call back, checking kprobes on the module */
2007static int __kprobes kprobes_module_callback(struct notifier_block *nb,
2008 unsigned long val, void *data)
2009{
2010 struct module *mod = data;
2011 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002012 struct kprobe *p;
2013 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002014 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002015
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002016 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002017 return NOTIFY_DONE;
2018
2019 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002020 * When MODULE_STATE_GOING was notified, both of module .text and
2021 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2022 * notified, only .init.text section would be freed. We need to
2023 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002024 */
2025 mutex_lock(&kprobe_mutex);
2026 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2027 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002028 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002029 if (within_module_init((unsigned long)p->addr, mod) ||
2030 (checkcore &&
2031 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002032 /*
2033 * The vaddr this probe is installed will soon
2034 * be vfreed buy not synced to disk. Hence,
2035 * disarming the breakpoint isn't needed.
2036 */
2037 kill_kprobe(p);
2038 }
2039 }
2040 mutex_unlock(&kprobe_mutex);
2041 return NOTIFY_DONE;
2042}
2043
2044static struct notifier_block kprobe_module_nb = {
2045 .notifier_call = kprobes_module_callback,
2046 .priority = 0
2047};
2048
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049static int __init init_kprobes(void)
2050{
2051 int i, err = 0;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002052 unsigned long offset = 0, size = 0;
2053 char *modname, namebuf[128];
2054 const char *symbol_name;
2055 void *addr;
2056 struct kprobe_blackpoint *kb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057
2058 /* FIXME allocate the probe table, currently defined statically */
2059 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002060 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002062 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02002063 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07002064 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002066 /*
2067 * Lookup and populate the kprobe_blacklist.
2068 *
2069 * Unlike the kretprobe blacklist, we'll need to determine
2070 * the range of addresses that belong to the said functions,
2071 * since a kprobe need not necessarily be at the beginning
2072 * of a function.
2073 */
2074 for (kb = kprobe_blacklist; kb->name != NULL; kb++) {
2075 kprobe_lookup_name(kb->name, addr);
2076 if (!addr)
2077 continue;
2078
2079 kb->start_addr = (unsigned long)addr;
2080 symbol_name = kallsyms_lookup(kb->start_addr,
2081 &size, &offset, &modname, namebuf);
2082 if (!symbol_name)
2083 kb->range = 0;
2084 else
2085 kb->range = size;
2086 }
2087
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002088 if (kretprobe_blacklist_size) {
2089 /* lookup the function address from its name */
2090 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2091 kprobe_lookup_name(kretprobe_blacklist[i].name,
2092 kretprobe_blacklist[i].addr);
2093 if (!kretprobe_blacklist[i].addr)
2094 printk("kretprobe: lookup failed: %s\n",
2095 kretprobe_blacklist[i].name);
2096 }
2097 }
2098
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002099#if defined(CONFIG_OPTPROBES)
2100#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002101 /* Init kprobe_optinsn_slots */
2102 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2103#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002104 /* By default, kprobes can be optimized */
2105 kprobes_allow_optimization = true;
2106#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002107
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002108 /* By default, kprobes are armed */
2109 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002110
Rusty Lynch67729262005-07-05 18:54:50 -07002111 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002112 if (!err)
2113 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002114 if (!err)
2115 err = register_module_notifier(&kprobe_module_nb);
2116
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002117 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002118
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002119 if (!err)
2120 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 return err;
2122}
2123
Srinivasa Ds346fd592007-02-20 13:57:54 -08002124#ifdef CONFIG_DEBUG_FS
2125static void __kprobes report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002126 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002127{
2128 char *kprobe_type;
2129
2130 if (p->pre_handler == pre_handler_kretprobe)
2131 kprobe_type = "r";
2132 else if (p->pre_handler == setjmp_pre_handler)
2133 kprobe_type = "j";
2134 else
2135 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002136
Srinivasa Ds346fd592007-02-20 13:57:54 -08002137 if (sym)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002138 seq_printf(pi, "%p %s %s+0x%x %s ",
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002139 p->addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002140 (modname ? modname : " "));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002141 else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002142 seq_printf(pi, "%p %s %p ",
2143 p->addr, kprobe_type, p->addr);
2144
2145 if (!pp)
2146 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002147 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002148 (kprobe_gone(p) ? "[GONE]" : ""),
2149 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002150 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2151 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002152}
2153
2154static void __kprobes *kprobe_seq_start(struct seq_file *f, loff_t *pos)
2155{
2156 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2157}
2158
2159static void __kprobes *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
2160{
2161 (*pos)++;
2162 if (*pos >= KPROBE_TABLE_SIZE)
2163 return NULL;
2164 return pos;
2165}
2166
2167static void __kprobes kprobe_seq_stop(struct seq_file *f, void *v)
2168{
2169 /* Nothing to do */
2170}
2171
2172static int __kprobes show_kprobe_addr(struct seq_file *pi, void *v)
2173{
2174 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002175 struct kprobe *p, *kp;
2176 const char *sym = NULL;
2177 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002178 unsigned long offset = 0;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002179 char *modname, namebuf[128];
2180
2181 head = &kprobe_table[i];
2182 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002183 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002184 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002185 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002186 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002187 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002188 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002189 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002190 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002191 }
2192 preempt_enable();
2193 return 0;
2194}
2195
James Morris88e9d342009-09-22 16:43:43 -07002196static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002197 .start = kprobe_seq_start,
2198 .next = kprobe_seq_next,
2199 .stop = kprobe_seq_stop,
2200 .show = show_kprobe_addr
2201};
2202
2203static int __kprobes kprobes_open(struct inode *inode, struct file *filp)
2204{
2205 return seq_open(filp, &kprobes_seq_ops);
2206}
2207
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002208static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002209 .open = kprobes_open,
2210 .read = seq_read,
2211 .llseek = seq_lseek,
2212 .release = seq_release,
2213};
2214
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002215static void __kprobes arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002216{
2217 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002218 struct kprobe *p;
2219 unsigned int i;
2220
2221 mutex_lock(&kprobe_mutex);
2222
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002223 /* If kprobes are armed, just return */
2224 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002225 goto already_enabled;
2226
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002227 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002228 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2229 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002230 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002231 if (!kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002232 arm_kprobe(p);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002233 }
2234
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002235 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002236 printk(KERN_INFO "Kprobes globally enabled\n");
2237
2238already_enabled:
2239 mutex_unlock(&kprobe_mutex);
2240 return;
2241}
2242
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002243static void __kprobes disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002244{
2245 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002246 struct kprobe *p;
2247 unsigned int i;
2248
2249 mutex_lock(&kprobe_mutex);
2250
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002251 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002252 if (kprobes_all_disarmed) {
2253 mutex_unlock(&kprobe_mutex);
2254 return;
2255 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002256
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002257 kprobes_all_disarmed = true;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002258 printk(KERN_INFO "Kprobes globally disabled\n");
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002259
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002260 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2261 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002262 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002263 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002264 disarm_kprobe(p, false);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002265 }
2266 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002267 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002268
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002269 /* Wait for disarming all kprobes by optimizer */
2270 wait_for_kprobe_optimizer();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002271}
2272
2273/*
2274 * XXX: The debugfs bool file interface doesn't allow for callbacks
2275 * when the bool state is switched. We can reuse that facility when
2276 * available
2277 */
2278static ssize_t read_enabled_file_bool(struct file *file,
2279 char __user *user_buf, size_t count, loff_t *ppos)
2280{
2281 char buf[3];
2282
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002283 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002284 buf[0] = '1';
2285 else
2286 buf[0] = '0';
2287 buf[1] = '\n';
2288 buf[2] = 0x00;
2289 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2290}
2291
2292static ssize_t write_enabled_file_bool(struct file *file,
2293 const char __user *user_buf, size_t count, loff_t *ppos)
2294{
2295 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002296 size_t buf_size;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002297
2298 buf_size = min(count, (sizeof(buf)-1));
2299 if (copy_from_user(buf, user_buf, buf_size))
2300 return -EFAULT;
2301
Mathias Krause10fb46d2013-07-03 15:05:39 -07002302 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002303 switch (buf[0]) {
2304 case 'y':
2305 case 'Y':
2306 case '1':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002307 arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002308 break;
2309 case 'n':
2310 case 'N':
2311 case '0':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002312 disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002313 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002314 default:
2315 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002316 }
2317
2318 return count;
2319}
2320
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002321static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002322 .read = read_enabled_file_bool,
2323 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002324 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002325};
2326
Srinivasa Ds346fd592007-02-20 13:57:54 -08002327static int __kprobes debugfs_kprobe_init(void)
2328{
2329 struct dentry *dir, *file;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002330 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002331
2332 dir = debugfs_create_dir("kprobes", NULL);
2333 if (!dir)
2334 return -ENOMEM;
2335
Randy Dunlape3869792007-05-08 00:27:01 -07002336 file = debugfs_create_file("list", 0444, dir, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002337 &debugfs_kprobes_operations);
2338 if (!file) {
2339 debugfs_remove(dir);
2340 return -ENOMEM;
2341 }
2342
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002343 file = debugfs_create_file("enabled", 0600, dir,
2344 &value, &fops_kp);
2345 if (!file) {
2346 debugfs_remove(dir);
2347 return -ENOMEM;
2348 }
2349
Srinivasa Ds346fd592007-02-20 13:57:54 -08002350 return 0;
2351}
2352
2353late_initcall(debugfs_kprobe_init);
2354#endif /* CONFIG_DEBUG_FS */
2355
2356module_init(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002357
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002358/* defined in arch/.../kernel/kprobes.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359EXPORT_SYMBOL_GPL(jprobe_return);