blob: d179839e1b706a5f25f70056e6b4e82fabadac19 [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
Christoph Hellwigbfd45be2016-10-11 13:52:22 -070052#include <asm/sections.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <asm/cacheflush.h>
54#include <asm/errno.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080055#include <linux/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
Masami Hiramatsu376e2422014-04-17 17:17:05 +090089/* Blacklist -- list of struct kprobe_blacklist_entry */
90static LIST_HEAD(kprobe_blacklist);
Srinivasa Ds3d8d9962008-04-28 02:14:26 -070091
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -080092#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070093/*
94 * kprobe->ainsn.insn points to the copy of the instruction to be
95 * single-stepped. x86_64, POWER4 and above have no-exec support and
96 * stepping on the instruction on a vmalloced/kmalloced/data page
97 * is a recipe for disaster
98 */
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070099struct kprobe_insn_page {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400100 struct list_head list;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700101 kprobe_opcode_t *insns; /* Page of instruction slots */
Heiko Carstensaf963972013-09-11 14:24:13 -0700102 struct kprobe_insn_cache *cache;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700103 int nused;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800104 int ngarbage;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500105 char slot_used[];
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700106};
107
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500108#define KPROBE_INSN_PAGE_SIZE(slots) \
109 (offsetof(struct kprobe_insn_page, slot_used) + \
110 (sizeof(char) * (slots)))
111
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500112static int slots_per_page(struct kprobe_insn_cache *c)
113{
114 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
115}
116
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800117enum kprobe_slot_state {
118 SLOT_CLEAN = 0,
119 SLOT_DIRTY = 1,
120 SLOT_USED = 2,
121};
122
Heiko Carstensaf963972013-09-11 14:24:13 -0700123static void *alloc_insn_page(void)
124{
125 return module_alloc(PAGE_SIZE);
126}
127
128static void free_insn_page(void *page)
129{
Rusty Russellbe1f2212015-01-20 09:07:05 +1030130 module_memfree(page);
Heiko Carstensaf963972013-09-11 14:24:13 -0700131}
132
Heiko Carstensc802d642013-09-11 14:24:11 -0700133struct kprobe_insn_cache kprobe_insn_slots = {
134 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700135 .alloc = alloc_insn_page,
136 .free = free_insn_page,
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};
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900141static int 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 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900147kprobe_opcode_t *__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
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900152 /* Since the slot array is not protected by rcu, we need a mutex */
Heiko Carstensc802d642013-09-11 14:24:11 -0700153 mutex_lock(&c->mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700154 retry:
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900155 rcu_read_lock();
156 list_for_each_entry_rcu(kip, &c->pages, list) {
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500157 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700158 int i;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500159 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800160 if (kip->slot_used[i] == SLOT_CLEAN) {
161 kip->slot_used[i] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700162 kip->nused++;
Heiko Carstensc802d642013-09-11 14:24:11 -0700163 slot = kip->insns + (i * c->insn_size);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900164 rcu_read_unlock();
Heiko Carstensc802d642013-09-11 14:24:11 -0700165 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700166 }
167 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500168 /* kip->nused is broken. Fix it. */
169 kip->nused = slots_per_page(c);
170 WARN_ON(1);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700171 }
172 }
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900173 rcu_read_unlock();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700174
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800175 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500176 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800177 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500178
179 /* All out of space. Need to allocate a new page. */
180 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700181 if (!kip)
Heiko Carstensc802d642013-09-11 14:24:11 -0700182 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700183
184 /*
185 * Use module_alloc so this page is within +/- 2GB of where the
186 * kernel image and loaded module images reside. This is required
187 * so x86_64 can correctly handle the %rip-relative fixups.
188 */
Heiko Carstensaf963972013-09-11 14:24:13 -0700189 kip->insns = c->alloc();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700190 if (!kip->insns) {
191 kfree(kip);
Heiko Carstensc802d642013-09-11 14:24:11 -0700192 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700193 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400194 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500195 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800196 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700197 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800198 kip->ngarbage = 0;
Heiko Carstensaf963972013-09-11 14:24:13 -0700199 kip->cache = c;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900200 list_add_rcu(&kip->list, &c->pages);
Heiko Carstensc802d642013-09-11 14:24:11 -0700201 slot = kip->insns;
202out:
203 mutex_unlock(&c->mutex);
204 return slot;
Masami Hiramatsu12941562009-01-06 14:41:50 -0800205}
206
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800207/* Return 1 if all garbages are collected, otherwise 0. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900208static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800209{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800210 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800211 kip->nused--;
212 if (kip->nused == 0) {
213 /*
214 * Page is no longer in use. Free it unless
215 * it's the last one. We keep the last one
216 * so as not to have to set it up again the
217 * next time somebody inserts a probe.
218 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500219 if (!list_is_singular(&kip->list)) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900220 list_del_rcu(&kip->list);
221 synchronize_rcu();
Heiko Carstensaf963972013-09-11 14:24:13 -0700222 kip->cache->free(kip->insns);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800223 kfree(kip);
224 }
225 return 1;
226 }
227 return 0;
228}
229
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900230static int collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800231{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400232 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800233
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500234 /* Ensure no-one is interrupted on the garbages */
235 synchronize_sched();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800236
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500237 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800238 int i;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800239 if (kip->ngarbage == 0)
240 continue;
241 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500242 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900243 if (kip->slot_used[i] == SLOT_DIRTY && collect_one_slot(kip, i))
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800244 break;
245 }
246 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500247 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800248 return 0;
249}
250
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900251void __free_insn_slot(struct kprobe_insn_cache *c,
252 kprobe_opcode_t *slot, int dirty)
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500253{
254 struct kprobe_insn_page *kip;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900255 long idx;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500256
Heiko Carstensc802d642013-09-11 14:24:11 -0700257 mutex_lock(&c->mutex);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900258 rcu_read_lock();
259 list_for_each_entry_rcu(kip, &c->pages, list) {
260 idx = ((long)slot - (long)kip->insns) /
261 (c->insn_size * sizeof(kprobe_opcode_t));
262 if (idx >= 0 && idx < slots_per_page(c))
Heiko Carstensc802d642013-09-11 14:24:11 -0700263 goto out;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900264 }
265 /* Could not find this slot. */
266 WARN_ON(1);
267 kip = NULL;
268out:
269 rcu_read_unlock();
270 /* Mark and sweep: this may sleep */
271 if (kip) {
272 /* Check double free */
273 WARN_ON(kip->slot_used[idx] != SLOT_USED);
274 if (dirty) {
275 kip->slot_used[idx] = SLOT_DIRTY;
276 kip->ngarbage++;
277 if (++c->nr_garbage > slots_per_page(c))
278 collect_garbage_slots(c);
279 } else {
280 collect_one_slot(kip, idx);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500281 }
282 }
Heiko Carstensc802d642013-09-11 14:24:11 -0700283 mutex_unlock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500284}
285
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900286/*
287 * Check given address is on the page of kprobe instruction slots.
288 * This will be used for checking whether the address on a stack
289 * is on a text area or not.
290 */
291bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr)
292{
293 struct kprobe_insn_page *kip;
294 bool ret = false;
295
296 rcu_read_lock();
297 list_for_each_entry_rcu(kip, &c->pages, list) {
298 if (addr >= (unsigned long)kip->insns &&
299 addr < (unsigned long)kip->insns + PAGE_SIZE) {
300 ret = true;
301 break;
302 }
303 }
304 rcu_read_unlock();
305
306 return ret;
307}
308
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500309#ifdef CONFIG_OPTPROBES
310/* For optimized_kprobe buffer */
Heiko Carstensc802d642013-09-11 14:24:11 -0700311struct kprobe_insn_cache kprobe_optinsn_slots = {
312 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700313 .alloc = alloc_insn_page,
314 .free = free_insn_page,
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500315 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
316 /* .insn_size is initialized later */
317 .nr_garbage = 0,
318};
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500319#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800320#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700321
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800322/* We have preemption disabled.. so it is safe to use __ versions */
323static inline void set_kprobe_instance(struct kprobe *kp)
324{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600325 __this_cpu_write(kprobe_instance, kp);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800326}
327
328static inline void reset_kprobe_instance(void)
329{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600330 __this_cpu_write(kprobe_instance, NULL);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800331}
332
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800333/*
334 * This routine is called either:
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -0800335 * - under the kprobe_mutex - during kprobe_[un]register()
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800336 * OR
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800337 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800338 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900339struct kprobe *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340{
341 struct hlist_head *head;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800342 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800345 hlist_for_each_entry_rcu(p, head, hlist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 if (p->addr == addr)
347 return p;
348 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 return NULL;
351}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900352NOKPROBE_SYMBOL(get_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900354static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500355
356/* Return true if the kprobe is an aggregator */
357static inline int kprobe_aggrprobe(struct kprobe *p)
358{
359 return p->pre_handler == aggr_pre_handler;
360}
361
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900362/* Return true(!0) if the kprobe is unused */
363static inline int kprobe_unused(struct kprobe *p)
364{
365 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
366 list_empty(&p->list);
367}
368
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500369/*
370 * Keep all fields in the kprobe consistent
371 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900372static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500373{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900374 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
375 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500376}
377
378#ifdef CONFIG_OPTPROBES
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500379/* NOTE: change this value only with kprobe_mutex held */
380static bool kprobes_allow_optimization;
381
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500382/*
383 * Call all pre_handler on the list, but ignores its return value.
384 * This must be called from arch-dep optimized caller.
385 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900386void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500387{
388 struct kprobe *kp;
389
390 list_for_each_entry_rcu(kp, &p->list, list) {
391 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
392 set_kprobe_instance(kp);
393 kp->pre_handler(kp, regs);
394 }
395 reset_kprobe_instance();
396 }
397}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900398NOKPROBE_SYMBOL(opt_pre_handler);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500399
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900400/* Free optimized instructions and optimized_kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900401static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900402{
403 struct optimized_kprobe *op;
404
405 op = container_of(p, struct optimized_kprobe, kp);
406 arch_remove_optimized_kprobe(op);
407 arch_remove_kprobe(p);
408 kfree(op);
409}
410
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500411/* Return true(!0) if the kprobe is ready for optimization. */
412static inline int kprobe_optready(struct kprobe *p)
413{
414 struct optimized_kprobe *op;
415
416 if (kprobe_aggrprobe(p)) {
417 op = container_of(p, struct optimized_kprobe, kp);
418 return arch_prepared_optinsn(&op->optinsn);
419 }
420
421 return 0;
422}
423
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900424/* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
425static inline int kprobe_disarmed(struct kprobe *p)
426{
427 struct optimized_kprobe *op;
428
429 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
430 if (!kprobe_aggrprobe(p))
431 return kprobe_disabled(p);
432
433 op = container_of(p, struct optimized_kprobe, kp);
434
435 return kprobe_disabled(p) && list_empty(&op->list);
436}
437
438/* Return true(!0) if the probe is queued on (un)optimizing lists */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900439static int kprobe_queued(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900440{
441 struct optimized_kprobe *op;
442
443 if (kprobe_aggrprobe(p)) {
444 op = container_of(p, struct optimized_kprobe, kp);
445 if (!list_empty(&op->list))
446 return 1;
447 }
448 return 0;
449}
450
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500451/*
452 * Return an optimized kprobe whose optimizing code replaces
453 * instructions including addr (exclude breakpoint).
454 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900455static struct kprobe *get_optimized_kprobe(unsigned long addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500456{
457 int i;
458 struct kprobe *p = NULL;
459 struct optimized_kprobe *op;
460
461 /* Don't check i == 0, since that is a breakpoint case. */
462 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
463 p = get_kprobe((void *)(addr - i));
464
465 if (p && kprobe_optready(p)) {
466 op = container_of(p, struct optimized_kprobe, kp);
467 if (arch_within_optimized_kprobe(op, addr))
468 return p;
469 }
470
471 return NULL;
472}
473
474/* Optimization staging list, protected by kprobe_mutex */
475static LIST_HEAD(optimizing_list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900476static LIST_HEAD(unoptimizing_list);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900477static LIST_HEAD(freeing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500478
479static void kprobe_optimizer(struct work_struct *work);
480static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
481#define OPTIMIZE_DELAY 5
482
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900483/*
484 * Optimize (replace a breakpoint with a jump) kprobes listed on
485 * optimizing_list.
486 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900487static void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500488{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900489 /* Optimization never be done when disarmed */
490 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
491 list_empty(&optimizing_list))
492 return;
493
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500494 /*
495 * The optimization/unoptimization refers online_cpus via
496 * stop_machine() and cpu-hotplug modifies online_cpus.
497 * And same time, text_mutex will be held in cpu-hotplug and here.
498 * This combination can cause a deadlock (cpu-hotplug try to lock
499 * text_mutex but stop_machine can not be done because online_cpus
500 * has been changed)
501 * To avoid this deadlock, we need to call get_online_cpus()
502 * for preventing cpu-hotplug outside of text_mutex locking.
503 */
504 get_online_cpus();
505 mutex_lock(&text_mutex);
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900506 arch_optimize_kprobes(&optimizing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500507 mutex_unlock(&text_mutex);
508 put_online_cpus();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900509}
510
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900511/*
512 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
513 * if need) kprobes listed on unoptimizing_list.
514 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900515static void do_unoptimize_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900516{
517 struct optimized_kprobe *op, *tmp;
518
519 /* Unoptimization must be done anytime */
520 if (list_empty(&unoptimizing_list))
521 return;
522
523 /* Ditto to do_optimize_kprobes */
524 get_online_cpus();
525 mutex_lock(&text_mutex);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900526 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900527 /* Loop free_list for disarming */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900528 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900529 /* Disarm probes if marked disabled */
530 if (kprobe_disabled(&op->kp))
531 arch_disarm_kprobe(&op->kp);
532 if (kprobe_unused(&op->kp)) {
533 /*
534 * Remove unused probes from hash list. After waiting
535 * for synchronization, these probes are reclaimed.
536 * (reclaiming is done by do_free_cleaned_kprobes.)
537 */
538 hlist_del_rcu(&op->kp.hlist);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900539 } else
540 list_del_init(&op->list);
541 }
542 mutex_unlock(&text_mutex);
543 put_online_cpus();
544}
545
546/* Reclaim all kprobes on the free_list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900547static void do_free_cleaned_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900548{
549 struct optimized_kprobe *op, *tmp;
550
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900551 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900552 BUG_ON(!kprobe_unused(&op->kp));
553 list_del_init(&op->list);
554 free_aggr_kprobe(&op->kp);
555 }
556}
557
558/* Start optimizer after OPTIMIZE_DELAY passed */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900559static void kick_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900560{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800561 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900562}
563
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900564/* Kprobe jump optimizer */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900565static void kprobe_optimizer(struct work_struct *work)
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900566{
Steven Rostedt72ef3792012-06-05 19:28:14 +0900567 mutex_lock(&kprobe_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900568 /* Lock modules while optimizing kprobes */
569 mutex_lock(&module_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900570
571 /*
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900572 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
573 * kprobes before waiting for quiesence period.
574 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900575 do_unoptimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900576
577 /*
578 * Step 2: Wait for quiesence period to ensure all running interrupts
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900579 * are done. Because optprobe may modify multiple instructions
580 * there is a chance that Nth instruction is interrupted. In that
581 * case, running interrupt can return to 2nd-Nth byte of jump
582 * instruction. This wait is for avoiding it.
583 */
584 synchronize_sched();
585
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900586 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900587 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900588
589 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900590 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900591
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500592 mutex_unlock(&module_mutex);
Steven Rostedt72ef3792012-06-05 19:28:14 +0900593 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900594
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900595 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900596 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900597 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900598}
599
600/* Wait for completing optimization and unoptimization */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900601static void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900602{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800603 mutex_lock(&kprobe_mutex);
604
605 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
606 mutex_unlock(&kprobe_mutex);
607
608 /* this will also make optimizing_work execute immmediately */
609 flush_delayed_work(&optimizing_work);
610 /* @optimizing_work might not have been queued yet, relax */
611 cpu_relax();
612
613 mutex_lock(&kprobe_mutex);
614 }
615
616 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500617}
618
619/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900620static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500621{
622 struct optimized_kprobe *op;
623
624 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500625 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500626 (kprobe_disabled(p) || kprobes_all_disarmed))
627 return;
628
629 /* Both of break_handler and post_handler are not supported. */
630 if (p->break_handler || p->post_handler)
631 return;
632
633 op = container_of(p, struct optimized_kprobe, kp);
634
635 /* Check there is no other kprobes at the optimized instructions */
636 if (arch_check_optimized_kprobe(op) < 0)
637 return;
638
639 /* Check if it is already optimized. */
640 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
641 return;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500642 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900643
644 if (!list_empty(&op->list))
645 /* This is under unoptimizing. Just dequeue the probe */
646 list_del_init(&op->list);
647 else {
648 list_add(&op->list, &optimizing_list);
649 kick_kprobe_optimizer();
650 }
651}
652
653/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900654static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900655{
656 get_online_cpus();
657 arch_unoptimize_kprobe(op);
658 put_online_cpus();
659 if (kprobe_disabled(&op->kp))
660 arch_disarm_kprobe(&op->kp);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500661}
662
663/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900664static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500665{
666 struct optimized_kprobe *op;
667
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900668 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
669 return; /* This is not an optprobe nor optimized */
670
671 op = container_of(p, struct optimized_kprobe, kp);
672 if (!kprobe_optimized(p)) {
673 /* Unoptimized or unoptimizing case */
674 if (force && !list_empty(&op->list)) {
675 /*
676 * Only if this is unoptimizing kprobe and forced,
677 * forcibly unoptimize it. (No need to unoptimize
678 * unoptimized kprobe again :)
679 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500680 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900681 force_unoptimize_kprobe(op);
682 }
683 return;
684 }
685
686 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
687 if (!list_empty(&op->list)) {
688 /* Dequeue from the optimization queue */
689 list_del_init(&op->list);
690 return;
691 }
692 /* Optimized kprobe case */
693 if (force)
694 /* Forcibly update the code: this is a special case */
695 force_unoptimize_kprobe(op);
696 else {
697 list_add(&op->list, &unoptimizing_list);
698 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500699 }
700}
701
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900702/* Cancel unoptimizing for reusing */
703static void reuse_unused_kprobe(struct kprobe *ap)
704{
705 struct optimized_kprobe *op;
706
707 BUG_ON(!kprobe_unused(ap));
708 /*
709 * Unused kprobe MUST be on the way of delayed unoptimizing (means
710 * there is still a relative jump) and disabled.
711 */
712 op = container_of(ap, struct optimized_kprobe, kp);
713 if (unlikely(list_empty(&op->list)))
714 printk(KERN_WARNING "Warning: found a stray unused "
715 "aggrprobe@%p\n", ap->addr);
716 /* Enable the probe again */
717 ap->flags &= ~KPROBE_FLAG_DISABLED;
718 /* Optimize it again (remove from op->list) */
719 BUG_ON(!kprobe_optready(ap));
720 optimize_kprobe(ap);
721}
722
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500723/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900724static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500725{
726 struct optimized_kprobe *op;
727
728 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900729 if (!list_empty(&op->list))
730 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500731 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900732 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900733
734 if (kprobe_unused(p)) {
735 /* Enqueue if it is unused */
736 list_add(&op->list, &freeing_list);
737 /*
738 * Remove unused probes from the hash list. After waiting
739 * for synchronization, this probe is reclaimed.
740 * (reclaiming is done by do_free_cleaned_kprobes().)
741 */
742 hlist_del_rcu(&op->kp.hlist);
743 }
744
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900745 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500746 arch_remove_optimized_kprobe(op);
747}
748
Masami Hiramatsua4602462017-04-19 18:22:25 +0530749static inline
750void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
751{
752 if (!kprobe_ftrace(p))
753 arch_prepare_optimized_kprobe(op, p);
754}
755
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500756/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900757static void prepare_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500758{
759 struct optimized_kprobe *op;
760
761 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsua4602462017-04-19 18:22:25 +0530762 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500763}
764
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500765/* Allocate new optimized_kprobe and try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900766static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500767{
768 struct optimized_kprobe *op;
769
770 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
771 if (!op)
772 return NULL;
773
774 INIT_LIST_HEAD(&op->list);
775 op->kp.addr = p->addr;
Masami Hiramatsua4602462017-04-19 18:22:25 +0530776 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500777
778 return &op->kp;
779}
780
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900781static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500782
783/*
784 * Prepare an optimized_kprobe and optimize it
785 * NOTE: p must be a normal registered kprobe
786 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900787static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500788{
789 struct kprobe *ap;
790 struct optimized_kprobe *op;
791
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900792 /* Impossible to optimize ftrace-based kprobe */
793 if (kprobe_ftrace(p))
794 return;
795
Masami Hiramatsu25764282012-06-05 19:28:26 +0900796 /* For preparing optimization, jump_label_text_reserved() is called */
797 jump_label_lock();
798 mutex_lock(&text_mutex);
799
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500800 ap = alloc_aggr_kprobe(p);
801 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900802 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500803
804 op = container_of(ap, struct optimized_kprobe, kp);
805 if (!arch_prepared_optinsn(&op->optinsn)) {
806 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900807 arch_remove_optimized_kprobe(op);
808 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900809 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500810 }
811
812 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900813 optimize_kprobe(ap); /* This just kicks optimizer thread */
814
815out:
816 mutex_unlock(&text_mutex);
817 jump_label_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500818}
819
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500820#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900821static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500822{
823 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500824 struct kprobe *p;
825 unsigned int i;
826
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900827 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500828 /* If optimization is already allowed, just return */
829 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900830 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500831
832 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500833 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
834 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800835 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500836 if (!kprobe_disabled(p))
837 optimize_kprobe(p);
838 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500839 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900840out:
841 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500842}
843
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900844static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500845{
846 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500847 struct kprobe *p;
848 unsigned int i;
849
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900850 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500851 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900852 if (!kprobes_allow_optimization) {
853 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500854 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900855 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500856
857 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500858 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
859 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800860 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500861 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900862 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500863 }
864 }
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900865 mutex_unlock(&kprobe_mutex);
866
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900867 /* Wait for unoptimizing completion */
868 wait_for_kprobe_optimizer();
869 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500870}
871
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900872static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500873int sysctl_kprobes_optimization;
874int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
875 void __user *buffer, size_t *length,
876 loff_t *ppos)
877{
878 int ret;
879
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900880 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500881 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
882 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
883
884 if (sysctl_kprobes_optimization)
885 optimize_all_kprobes();
886 else
887 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900888 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500889
890 return ret;
891}
892#endif /* CONFIG_SYSCTL */
893
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900894/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900895static void __arm_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500896{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900897 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500898
899 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900900 _p = get_optimized_kprobe((unsigned long)p->addr);
901 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900902 /* Fallback to unoptimized kprobe */
903 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500904
905 arch_arm_kprobe(p);
906 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
907}
908
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900909/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900910static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500911{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900912 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500913
Wang Nan69d54b92015-02-13 14:40:26 -0800914 /* Try to unoptimize */
915 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500916
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900917 if (!kprobe_queued(p)) {
918 arch_disarm_kprobe(p);
919 /* If another kprobe was blocked, optimize it. */
920 _p = get_optimized_kprobe((unsigned long)p->addr);
921 if (unlikely(_p) && reopt)
922 optimize_kprobe(_p);
923 }
924 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500925}
926
927#else /* !CONFIG_OPTPROBES */
928
929#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900930#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500931#define kill_optimized_kprobe(p) do {} while (0)
932#define prepare_optimized_kprobe(p) do {} while (0)
933#define try_to_optimize_kprobe(p) do {} while (0)
934#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900935#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
936#define kprobe_disarmed(p) kprobe_disabled(p)
937#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500938
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900939/* There should be no unused kprobes can be reused without optimization */
940static void reuse_unused_kprobe(struct kprobe *ap)
941{
942 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
943 BUG_ON(kprobe_unused(ap));
944}
945
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900946static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500947{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900948 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500949 kfree(p);
950}
951
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900952static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500953{
954 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
955}
956#endif /* CONFIG_OPTPROBES */
957
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900958#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900959static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +0900960 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -0500961 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900962};
963static int kprobe_ftrace_enabled;
964
965/* Must ensure p->addr is really on ftrace */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900966static int prepare_kprobe(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900967{
968 if (!kprobe_ftrace(p))
969 return arch_prepare_kprobe(p);
970
971 return arch_prepare_kprobe_ftrace(p);
972}
973
974/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900975static void arm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900976{
977 int ret;
978
979 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
980 (unsigned long)p->addr, 0, 0);
981 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
982 kprobe_ftrace_enabled++;
983 if (kprobe_ftrace_enabled == 1) {
984 ret = register_ftrace_function(&kprobe_ftrace_ops);
985 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
986 }
987}
988
989/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900990static void disarm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900991{
992 int ret;
993
994 kprobe_ftrace_enabled--;
995 if (kprobe_ftrace_enabled == 0) {
996 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
997 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
998 }
999 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
1000 (unsigned long)p->addr, 1, 0);
1001 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
1002}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001003#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001004#define prepare_kprobe(p) arch_prepare_kprobe(p)
1005#define arm_kprobe_ftrace(p) do {} while (0)
1006#define disarm_kprobe_ftrace(p) do {} while (0)
1007#endif
1008
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001009/* Arm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001010static void arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001011{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001012 if (unlikely(kprobe_ftrace(kp))) {
1013 arm_kprobe_ftrace(kp);
1014 return;
1015 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001016 /*
1017 * Here, since __arm_kprobe() doesn't use stop_machine(),
1018 * this doesn't cause deadlock on text_mutex. So, we don't
1019 * need get_online_cpus().
1020 */
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001021 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001022 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001023 mutex_unlock(&text_mutex);
1024}
1025
1026/* Disarm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001027static void disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001028{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001029 if (unlikely(kprobe_ftrace(kp))) {
1030 disarm_kprobe_ftrace(kp);
1031 return;
1032 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001033 /* Ditto */
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001034 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001035 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001036 mutex_unlock(&text_mutex);
1037}
1038
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001039/*
1040 * Aggregate handlers for multiple kprobes support - these handlers
1041 * take care of invoking the individual kprobe handlers on p->list
1042 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001043static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001044{
1045 struct kprobe *kp;
1046
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001047 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001048 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001049 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001050 if (kp->pre_handler(kp, regs))
1051 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001052 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001053 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001054 }
1055 return 0;
1056}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001057NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001058
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001059static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1060 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001061{
1062 struct kprobe *kp;
1063
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001064 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001065 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001066 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001067 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001068 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001069 }
1070 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001071}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001072NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001073
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001074static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1075 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001076{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001077 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001078
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001079 /*
1080 * if we faulted "during" the execution of a user specified
1081 * probe handler, invoke just that probe's fault handler
1082 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001083 if (cur && cur->fault_handler) {
1084 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001085 return 1;
1086 }
1087 return 0;
1088}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001089NOKPROBE_SYMBOL(aggr_fault_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001090
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001091static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001092{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001093 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001094 int ret = 0;
1095
1096 if (cur && cur->break_handler) {
1097 if (cur->break_handler(cur, regs))
1098 ret = 1;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001099 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001100 reset_kprobe_instance();
1101 return ret;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001102}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001103NOKPROBE_SYMBOL(aggr_break_handler);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001104
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001105/* Walks the list and increments nmissed count for multiprobe case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001106void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001107{
1108 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001109 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001110 p->nmissed++;
1111 } else {
1112 list_for_each_entry_rcu(kp, &p->list, list)
1113 kp->nmissed++;
1114 }
1115 return;
1116}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001117NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001118
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001119void recycle_rp_inst(struct kretprobe_instance *ri,
1120 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001121{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001122 struct kretprobe *rp = ri->rp;
1123
Hien Nguyenb94cce92005-06-23 00:09:19 -07001124 /* remove rp inst off the rprobe_inst_table */
1125 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001126 INIT_HLIST_NODE(&ri->hlist);
1127 if (likely(rp)) {
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001128 raw_spin_lock(&rp->lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001129 hlist_add_head(&ri->hlist, &rp->free_instances);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001130 raw_spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001131 } else
1132 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -07001133 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001134}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001135NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001136
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001137void kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001138 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001139__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001140{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001141 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001142 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001143
1144 *head = &kretprobe_inst_table[hash];
1145 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001146 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001147}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001148NOKPROBE_SYMBOL(kretprobe_hash_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001149
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001150static void kretprobe_table_lock(unsigned long hash,
1151 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001152__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001153{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001154 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1155 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001156}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001157NOKPROBE_SYMBOL(kretprobe_table_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001158
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001159void kretprobe_hash_unlock(struct task_struct *tsk,
1160 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001161__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001162{
1163 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001164 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001165
1166 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001167 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001168}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001169NOKPROBE_SYMBOL(kretprobe_hash_unlock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001170
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001171static void kretprobe_table_unlock(unsigned long hash,
1172 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001173__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001174{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001175 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1176 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001177}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001178NOKPROBE_SYMBOL(kretprobe_table_unlock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001179
Hien Nguyenb94cce92005-06-23 00:09:19 -07001180/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001181 * This function is called from finish_task_switch when task tk becomes dead,
1182 * so that we can recycle any function-return probe instances associated
1183 * with this task. These left over instances represent probed functions
1184 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001185 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001186void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001187{
bibo,mao62c27be2006-10-02 02:17:33 -07001188 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -07001189 struct hlist_head *head, empty_rp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001190 struct hlist_node *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001191 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -07001192
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001193 if (unlikely(!kprobes_initialized))
1194 /* Early boot. kretprobe_table_locks not yet initialized. */
1195 return;
1196
Ananth N Mavinakayanahallid496aab2012-01-20 14:34:04 -08001197 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001198 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1199 head = &kretprobe_inst_table[hash];
1200 kretprobe_table_lock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001201 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -07001202 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -07001203 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -07001204 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001205 kretprobe_table_unlock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001206 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
bibo,mao99219a32006-10-02 02:17:35 -07001207 hlist_del(&ri->hlist);
1208 kfree(ri);
1209 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001210}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001211NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001212
Hien Nguyenb94cce92005-06-23 00:09:19 -07001213static inline void free_rp_inst(struct kretprobe *rp)
1214{
1215 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001216 struct hlist_node *next;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001217
Sasha Levinb67bfe02013-02-27 17:06:00 -08001218 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001219 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001220 kfree(ri);
1221 }
1222}
1223
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001224static void cleanup_rp_inst(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001225{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001226 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001227 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001228 struct hlist_node *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001229 struct hlist_head *head;
1230
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001231 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001232 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1233 kretprobe_table_lock(hash, &flags);
1234 head = &kretprobe_inst_table[hash];
Sasha Levinb67bfe02013-02-27 17:06:00 -08001235 hlist_for_each_entry_safe(ri, next, head, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001236 if (ri->rp == rp)
1237 ri->rp = NULL;
1238 }
1239 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001240 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001241 free_rp_inst(rp);
1242}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001243NOKPROBE_SYMBOL(cleanup_rp_inst);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001244
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001245/*
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001246* Add the new probe to ap->list. Fail if this is the
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001247* second jprobe at the address - two jprobes can't coexist
1248*/
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001249static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001250{
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001251 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001252
1253 if (p->break_handler || p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001254 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001255
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001256 if (p->break_handler) {
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001257 if (ap->break_handler)
mao, bibo36721652006-06-26 00:25:22 -07001258 return -EEXIST;
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001259 list_add_tail_rcu(&p->list, &ap->list);
1260 ap->break_handler = aggr_break_handler;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001261 } else
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001262 list_add_rcu(&p->list, &ap->list);
1263 if (p->post_handler && !ap->post_handler)
1264 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001265
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001266 return 0;
1267}
1268
1269/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001270 * Fill in the required fields of the "manager kprobe". Replace the
1271 * earlier kprobe in the hlist with the manager kprobe
1272 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001273static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001274{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001275 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001276 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001277 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001278 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001279 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001280 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001281 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001282 /* We don't care the kprobe which has gone. */
1283 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001284 ap->post_handler = aggr_post_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001285 if (p->break_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001286 ap->break_handler = aggr_break_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001287
1288 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001289 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001290
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001291 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001292 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001293}
1294
1295/*
1296 * This is the second or subsequent kprobe at the address - handle
1297 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001298 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001299static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001300{
1301 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001302 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001303
Masami Hiramatsu25764282012-06-05 19:28:26 +09001304 /* For preparing optimization, jump_label_text_reserved() is called */
1305 jump_label_lock();
1306 /*
1307 * Get online CPUs to avoid text_mutex deadlock.with stop machine,
1308 * which is invoked by unoptimize_kprobe() in add_new_kprobe()
1309 */
1310 get_online_cpus();
1311 mutex_lock(&text_mutex);
1312
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001313 if (!kprobe_aggrprobe(orig_p)) {
1314 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1315 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001316 if (!ap) {
1317 ret = -ENOMEM;
1318 goto out;
1319 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001320 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001321 } else if (kprobe_unused(ap))
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001322 /* This probe is going to die. Rescue it */
1323 reuse_unused_kprobe(ap);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001324
1325 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001326 /*
1327 * Attempting to insert new probe at the same location that
1328 * had a probe in the module vaddr area which already
1329 * freed. So, the instruction slot has already been
1330 * released. We need a new slot for the new probe.
1331 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001332 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001333 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001334 /*
1335 * Even if fail to allocate new slot, don't need to
1336 * free aggr_probe. It will be used next time, or
1337 * freed by unregister_kprobe.
1338 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001339 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001340
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001341 /* Prepare optimized instructions if possible. */
1342 prepare_optimized_kprobe(ap);
1343
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001344 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001345 * Clear gone flag to prevent allocating new slot again, and
1346 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001347 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001348 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1349 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001350 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001351
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001352 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001353 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001354 ret = add_new_kprobe(ap, p);
1355
1356out:
1357 mutex_unlock(&text_mutex);
1358 put_online_cpus();
1359 jump_label_unlock();
1360
1361 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1362 ap->flags &= ~KPROBE_FLAG_DISABLED;
1363 if (!kprobes_all_disarmed)
1364 /* Arm the breakpoint again. */
1365 arm_kprobe(ap);
1366 }
1367 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001368}
1369
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001370bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1371{
1372 /* The __kprobes marked functions and entry code must not be probed */
1373 return addr >= (unsigned long)__kprobes_text_start &&
1374 addr < (unsigned long)__kprobes_text_end;
1375}
1376
Andy Lutomirskie5779e82015-07-30 20:32:40 -07001377bool within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001378{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001379 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001380
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001381 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001382 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001383 /*
1384 * If there exists a kprobe_blacklist, verify and
1385 * fail any probe registration in the prohibited area
1386 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001387 list_for_each_entry(ent, &kprobe_blacklist, list) {
1388 if (addr >= ent->start_addr && addr < ent->end_addr)
1389 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001390 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001391
1392 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001393}
1394
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001395/*
1396 * If we have a symbol_name argument, look it up and add the offset field
1397 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001398 * This returns encoded errors if it fails to look up symbol or invalid
1399 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001400 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001401static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001402{
1403 kprobe_opcode_t *addr = p->addr;
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001404
1405 if ((p->symbol_name && p->addr) ||
1406 (!p->symbol_name && !p->addr))
1407 goto invalid;
1408
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001409 if (p->symbol_name) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001410 kprobe_lookup_name(p->symbol_name, addr);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001411 if (!addr)
1412 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001413 }
1414
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001415 addr = (kprobe_opcode_t *)(((char *)addr) + p->offset);
1416 if (addr)
1417 return addr;
1418
1419invalid:
1420 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001421}
1422
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301423/* Check passed kprobe is valid and return kprobe in kprobe_table. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001424static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301425{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001426 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301427
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001428 ap = get_kprobe(p->addr);
1429 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301430 return NULL;
1431
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001432 if (p != ap) {
1433 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301434 if (list_p == p)
1435 /* kprobe p is a valid probe */
1436 goto valid;
1437 return NULL;
1438 }
1439valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001440 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301441}
1442
1443/* Return error if the kprobe is being re-registered */
1444static inline int check_kprobe_rereg(struct kprobe *p)
1445{
1446 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301447
1448 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001449 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301450 ret = -EINVAL;
1451 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001452
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301453 return ret;
1454}
1455
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001456int __weak arch_check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001458 unsigned long ftrace_addr;
1459
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001460 ftrace_addr = ftrace_location((unsigned long)p->addr);
1461 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001462#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001463 /* Given address is not on the instruction boundary */
1464 if ((unsigned long)p->addr != ftrace_addr)
1465 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001466 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001467#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001468 return -EINVAL;
1469#endif
1470 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001471 return 0;
1472}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001473
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001474static int check_kprobe_address_safe(struct kprobe *p,
1475 struct module **probed_mod)
1476{
1477 int ret;
1478
1479 ret = arch_check_ftrace_location(p);
1480 if (ret)
1481 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001482 jump_label_lock();
1483 preempt_disable();
1484
1485 /* Ensure it is not in reserved area nor out of text */
1486 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001487 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001488 jump_label_text_reserved(p->addr, p->addr)) {
1489 ret = -EINVAL;
1490 goto out;
1491 }
1492
1493 /* Check if are we probing a module */
1494 *probed_mod = __module_text_address((unsigned long) p->addr);
1495 if (*probed_mod) {
1496 /*
1497 * We must hold a refcount of the probed module while updating
1498 * its code to prohibit unexpected unloading.
1499 */
1500 if (unlikely(!try_module_get(*probed_mod))) {
1501 ret = -ENOENT;
1502 goto out;
1503 }
1504
1505 /*
1506 * If the module freed .init.text, we couldn't insert
1507 * kprobes in there.
1508 */
1509 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1510 (*probed_mod)->state != MODULE_STATE_COMING) {
1511 module_put(*probed_mod);
1512 *probed_mod = NULL;
1513 ret = -ENOENT;
1514 }
1515 }
1516out:
1517 preempt_enable();
1518 jump_label_unlock();
1519
1520 return ret;
1521}
1522
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001523int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001524{
1525 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001526 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001527 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001528 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001530 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001531 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001532 if (IS_ERR(addr))
1533 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001534 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001535
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301536 ret = check_kprobe_rereg(p);
1537 if (ret)
1538 return ret;
1539
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001540 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1541 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001542 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001543 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001544
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001545 ret = check_kprobe_address_safe(p, &probed_mod);
1546 if (ret)
1547 return ret;
1548
1549 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001550
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001551 old_p = get_kprobe(p->addr);
1552 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001553 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001554 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 goto out;
1556 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
Masami Hiramatsu25764282012-06-05 19:28:26 +09001558 mutex_lock(&text_mutex); /* Avoiding text modification */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001559 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001560 mutex_unlock(&text_mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001561 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001562 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001563
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001564 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001565 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001566 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1567
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001568 if (!kprobes_all_disarmed && !kprobe_disabled(p))
Masami Hiramatsu25764282012-06-05 19:28:26 +09001569 arm_kprobe(p);
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001570
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001571 /* Try to optimize kprobe */
1572 try_to_optimize_kprobe(p);
1573
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001575 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001576
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001577 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001578 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001579
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 return ret;
1581}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001582EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001584/* Check if all probes on the aggrprobe are disabled */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001585static int aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001586{
1587 struct kprobe *kp;
1588
1589 list_for_each_entry_rcu(kp, &ap->list, list)
1590 if (!kprobe_disabled(kp))
1591 /*
1592 * There is an active probe on the list.
1593 * We can't disable this ap.
1594 */
1595 return 0;
1596
1597 return 1;
1598}
1599
1600/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001601static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001602{
1603 struct kprobe *orig_p;
1604
1605 /* Get an original kprobe for return */
1606 orig_p = __get_valid_kprobe(p);
1607 if (unlikely(orig_p == NULL))
1608 return NULL;
1609
1610 if (!kprobe_disabled(p)) {
1611 /* Disable probe if it is a child probe */
1612 if (p != orig_p)
1613 p->flags |= KPROBE_FLAG_DISABLED;
1614
1615 /* Try to disarm and disable this/parent probe */
1616 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001617 /*
1618 * If kprobes_all_disarmed is set, orig_p
1619 * should have already been disarmed, so
1620 * skip unneed disarming process.
1621 */
1622 if (!kprobes_all_disarmed)
1623 disarm_kprobe(orig_p, true);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001624 orig_p->flags |= KPROBE_FLAG_DISABLED;
1625 }
1626 }
1627
1628 return orig_p;
1629}
1630
Masami Hiramatsu98616682008-04-28 02:14:28 -07001631/*
1632 * Unregister a kprobe without a scheduler synchronization.
1633 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001634static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001635{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001636 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001637
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001638 /* Disable kprobe. This will disarm it if needed. */
1639 ap = __disable_kprobe(p);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001640 if (ap == NULL)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001641 return -EINVAL;
1642
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001643 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001644 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001645 * This probe is an independent(and non-optimized) kprobe
1646 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001647 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001648 goto disarmed;
1649
1650 /* Following process expects this probe is an aggrprobe */
1651 WARN_ON(!kprobe_aggrprobe(ap));
1652
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001653 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1654 /*
1655 * !disarmed could be happen if the probe is under delayed
1656 * unoptimizing.
1657 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001658 goto disarmed;
1659 else {
1660 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001661 if (p->break_handler && !kprobe_gone(p))
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001662 ap->break_handler = NULL;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001663 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001664 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001665 if ((list_p != p) && (list_p->post_handler))
1666 goto noclean;
1667 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001668 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001669 }
1670noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001671 /*
1672 * Remove from the aggrprobe: this path will do nothing in
1673 * __unregister_kprobe_bottom().
1674 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001675 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001676 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1677 /*
1678 * Try to optimize this probe again, because post
1679 * handler may have been changed.
1680 */
1681 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001682 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001683 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001684
1685disarmed:
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001686 BUG_ON(!kprobe_disarmed(ap));
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001687 hlist_del_rcu(&ap->hlist);
1688 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001689}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001690
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001691static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001692{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001693 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001694
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001695 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001696 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001697 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001698 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001699 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001700 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001701 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001702 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001703 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001704 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705}
1706
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001707int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001708{
1709 int i, ret = 0;
1710
1711 if (num <= 0)
1712 return -EINVAL;
1713 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001714 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001715 if (ret < 0) {
1716 if (i > 0)
1717 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001718 break;
1719 }
1720 }
1721 return ret;
1722}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001723EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001724
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001725void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001726{
1727 unregister_kprobes(&p, 1);
1728}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001729EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001730
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001731void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001732{
1733 int i;
1734
1735 if (num <= 0)
1736 return;
1737 mutex_lock(&kprobe_mutex);
1738 for (i = 0; i < num; i++)
1739 if (__unregister_kprobe_top(kps[i]) < 0)
1740 kps[i]->addr = NULL;
1741 mutex_unlock(&kprobe_mutex);
1742
1743 synchronize_sched();
1744 for (i = 0; i < num; i++)
1745 if (kps[i]->addr)
1746 __unregister_kprobe_bottom(kps[i]);
1747}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001748EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001749
Naveen N. Raofc62d022017-02-08 01:24:14 +05301750int __weak __kprobes kprobe_exceptions_notify(struct notifier_block *self,
1751 unsigned long val, void *data)
1752{
1753 return NOTIFY_DONE;
1754}
1755
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756static struct notifier_block kprobe_exceptions_nb = {
1757 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001758 .priority = 0x7fffffff /* we need to be notified first */
1759};
1760
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001761unsigned long __weak arch_deref_entry_point(void *entry)
1762{
1763 return (unsigned long)entry;
1764}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001766int register_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001767{
1768 struct jprobe *jp;
1769 int ret = 0, i;
1770
1771 if (num <= 0)
1772 return -EINVAL;
1773 for (i = 0; i < num; i++) {
Namhyung Kim05662bd2010-09-15 10:04:27 +09001774 unsigned long addr, offset;
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001775 jp = jps[i];
1776 addr = arch_deref_entry_point(jp->entry);
1777
Namhyung Kim05662bd2010-09-15 10:04:27 +09001778 /* Verify probepoint is a function entry point */
1779 if (kallsyms_lookup_size_offset(addr, NULL, &offset) &&
1780 offset == 0) {
1781 jp->kp.pre_handler = setjmp_pre_handler;
1782 jp->kp.break_handler = longjmp_break_handler;
1783 ret = register_kprobe(&jp->kp);
1784 } else
1785 ret = -EINVAL;
Namhyung Kimedbaadb2010-09-15 10:04:26 +09001786
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001787 if (ret < 0) {
1788 if (i > 0)
1789 unregister_jprobes(jps, i);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001790 break;
1791 }
1792 }
1793 return ret;
1794}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001795EXPORT_SYMBOL_GPL(register_jprobes);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001796
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001797int register_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798{
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001799 return register_jprobes(&jp, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001801EXPORT_SYMBOL_GPL(register_jprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001803void unregister_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804{
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001805 unregister_jprobes(&jp, 1);
1806}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001807EXPORT_SYMBOL_GPL(unregister_jprobe);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001808
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001809void unregister_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001810{
1811 int i;
1812
1813 if (num <= 0)
1814 return;
1815 mutex_lock(&kprobe_mutex);
1816 for (i = 0; i < num; i++)
1817 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1818 jps[i]->kp.addr = NULL;
1819 mutex_unlock(&kprobe_mutex);
1820
1821 synchronize_sched();
1822 for (i = 0; i < num; i++) {
1823 if (jps[i]->kp.addr)
1824 __unregister_kprobe_bottom(&jps[i]->kp);
1825 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001827EXPORT_SYMBOL_GPL(unregister_jprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001829#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001830/*
1831 * This kprobe pre_handler is registered with every kretprobe. When probe
1832 * hits it will set up the return probe.
1833 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001834static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08001835{
1836 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001837 unsigned long hash, flags = 0;
1838 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001839
Masami Hiramatsuf96f5672014-08-04 03:10:16 +00001840 /*
1841 * To avoid deadlocks, prohibit return probing in NMI contexts,
1842 * just skip the probe and increase the (inexact) 'nmissed'
1843 * statistical counter, so that the user is informed that
1844 * something happened:
1845 */
1846 if (unlikely(in_nmi())) {
1847 rp->nmissed++;
1848 return 0;
1849 }
1850
1851 /* TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001852 hash = hash_ptr(current, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001853 raw_spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001854 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001855 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001856 struct kretprobe_instance, hlist);
1857 hlist_del(&ri->hlist);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001858 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001859
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001860 ri->rp = rp;
1861 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001862
Jiang Liu55ca6142012-02-03 15:37:16 -08001863 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1864 raw_spin_lock_irqsave(&rp->lock, flags);
1865 hlist_add_head(&ri->hlist, &rp->free_instances);
1866 raw_spin_unlock_irqrestore(&rp->lock, flags);
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001867 return 0;
Jiang Liu55ca6142012-02-03 15:37:16 -08001868 }
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001869
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001870 arch_prepare_kretprobe(ri, regs);
1871
1872 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001873 INIT_HLIST_NODE(&ri->hlist);
1874 kretprobe_table_lock(hash, &flags);
1875 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1876 kretprobe_table_unlock(hash, &flags);
1877 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001878 rp->nmissed++;
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001879 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001880 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001881 return 0;
1882}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001883NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08001884
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001885int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001886{
1887 int ret = 0;
1888 struct kretprobe_instance *inst;
1889 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001890 void *addr;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001891
1892 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001893 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001894 if (IS_ERR(addr))
1895 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001896
1897 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1898 if (kretprobe_blacklist[i].addr == addr)
1899 return -EINVAL;
1900 }
1901 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001902
1903 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001904 rp->kp.post_handler = NULL;
1905 rp->kp.fault_handler = NULL;
1906 rp->kp.break_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001907
1908 /* Pre-allocate memory for max kretprobe instances */
1909 if (rp->maxactive <= 0) {
1910#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001911 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001912#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301913 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001914#endif
1915 }
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001916 raw_spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001917 INIT_HLIST_HEAD(&rp->free_instances);
1918 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001919 inst = kmalloc(sizeof(struct kretprobe_instance) +
1920 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001921 if (inst == NULL) {
1922 free_rp_inst(rp);
1923 return -ENOMEM;
1924 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001925 INIT_HLIST_NODE(&inst->hlist);
1926 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001927 }
1928
1929 rp->nmissed = 0;
1930 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001931 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001932 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001933 free_rp_inst(rp);
1934 return ret;
1935}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001936EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001937
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001938int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001939{
1940 int ret = 0, i;
1941
1942 if (num <= 0)
1943 return -EINVAL;
1944 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001945 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001946 if (ret < 0) {
1947 if (i > 0)
1948 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001949 break;
1950 }
1951 }
1952 return ret;
1953}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001954EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001955
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001956void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001957{
1958 unregister_kretprobes(&rp, 1);
1959}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001960EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001961
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001962void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001963{
1964 int i;
1965
1966 if (num <= 0)
1967 return;
1968 mutex_lock(&kprobe_mutex);
1969 for (i = 0; i < num; i++)
1970 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1971 rps[i]->kp.addr = NULL;
1972 mutex_unlock(&kprobe_mutex);
1973
1974 synchronize_sched();
1975 for (i = 0; i < num; i++) {
1976 if (rps[i]->kp.addr) {
1977 __unregister_kprobe_bottom(&rps[i]->kp);
1978 cleanup_rp_inst(rps[i]);
1979 }
1980 }
1981}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001982EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001983
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001984#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001985int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001986{
1987 return -ENOSYS;
1988}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001989EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001990
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001991int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001992{
1993 return -ENOSYS;
1994}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001995EXPORT_SYMBOL_GPL(register_kretprobes);
1996
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001997void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001998{
1999}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002000EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002001
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002002void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002003{
2004}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002005EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002006
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002007static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002008{
2009 return 0;
2010}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002011NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002012
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002013#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002014
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002015/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002016static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002017{
2018 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002019
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002020 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002021 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002022 /*
2023 * If this is an aggr_kprobe, we have to list all the
2024 * chained probes and mark them GONE.
2025 */
2026 list_for_each_entry_rcu(kp, &p->list, list)
2027 kp->flags |= KPROBE_FLAG_GONE;
2028 p->post_handler = NULL;
2029 p->break_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002030 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002031 }
2032 /*
2033 * Here, we can remove insn_slot safely, because no thread calls
2034 * the original probed function (which will be freed soon) any more.
2035 */
2036 arch_remove_kprobe(p);
2037}
2038
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002039/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002040int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002041{
2042 int ret = 0;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002043
2044 mutex_lock(&kprobe_mutex);
2045
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002046 /* Disable this kprobe */
2047 if (__disable_kprobe(kp) == NULL)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002048 ret = -EINVAL;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002049
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002050 mutex_unlock(&kprobe_mutex);
2051 return ret;
2052}
2053EXPORT_SYMBOL_GPL(disable_kprobe);
2054
2055/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002056int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002057{
2058 int ret = 0;
2059 struct kprobe *p;
2060
2061 mutex_lock(&kprobe_mutex);
2062
2063 /* Check whether specified probe is valid. */
2064 p = __get_valid_kprobe(kp);
2065 if (unlikely(p == NULL)) {
2066 ret = -EINVAL;
2067 goto out;
2068 }
2069
2070 if (kprobe_gone(kp)) {
2071 /* This kprobe has gone, we couldn't enable it. */
2072 ret = -EINVAL;
2073 goto out;
2074 }
2075
2076 if (p != kp)
2077 kp->flags &= ~KPROBE_FLAG_DISABLED;
2078
2079 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2080 p->flags &= ~KPROBE_FLAG_DISABLED;
2081 arm_kprobe(p);
2082 }
2083out:
2084 mutex_unlock(&kprobe_mutex);
2085 return ret;
2086}
2087EXPORT_SYMBOL_GPL(enable_kprobe);
2088
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002089void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002090{
2091 printk(KERN_WARNING "Dumping kprobe:\n");
2092 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2093 kp->symbol_name, kp->addr, kp->offset);
2094}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002095NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002096
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002097/*
2098 * Lookup and populate the kprobe_blacklist.
2099 *
2100 * Unlike the kretprobe blacklist, we'll need to determine
2101 * the range of addresses that belong to the said functions,
2102 * since a kprobe need not necessarily be at the beginning
2103 * of a function.
2104 */
2105static int __init populate_kprobe_blacklist(unsigned long *start,
2106 unsigned long *end)
2107{
2108 unsigned long *iter;
2109 struct kprobe_blacklist_entry *ent;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002110 unsigned long entry, offset = 0, size = 0;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002111
2112 for (iter = start; iter < end; iter++) {
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002113 entry = arch_deref_entry_point((void *)*iter);
2114
2115 if (!kernel_text_address(entry) ||
2116 !kallsyms_lookup_size_offset(entry, &size, &offset)) {
2117 pr_err("Failed to find blacklist at %p\n",
2118 (void *)entry);
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002119 continue;
2120 }
2121
2122 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2123 if (!ent)
2124 return -ENOMEM;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002125 ent->start_addr = entry;
2126 ent->end_addr = entry + size;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002127 INIT_LIST_HEAD(&ent->list);
2128 list_add_tail(&ent->list, &kprobe_blacklist);
2129 }
2130 return 0;
2131}
2132
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002133/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002134static int kprobes_module_callback(struct notifier_block *nb,
2135 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002136{
2137 struct module *mod = data;
2138 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002139 struct kprobe *p;
2140 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002141 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002142
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002143 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002144 return NOTIFY_DONE;
2145
2146 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002147 * When MODULE_STATE_GOING was notified, both of module .text and
2148 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2149 * notified, only .init.text section would be freed. We need to
2150 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002151 */
2152 mutex_lock(&kprobe_mutex);
2153 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2154 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002155 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002156 if (within_module_init((unsigned long)p->addr, mod) ||
2157 (checkcore &&
2158 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002159 /*
2160 * The vaddr this probe is installed will soon
2161 * be vfreed buy not synced to disk. Hence,
2162 * disarming the breakpoint isn't needed.
2163 */
2164 kill_kprobe(p);
2165 }
2166 }
2167 mutex_unlock(&kprobe_mutex);
2168 return NOTIFY_DONE;
2169}
2170
2171static struct notifier_block kprobe_module_nb = {
2172 .notifier_call = kprobes_module_callback,
2173 .priority = 0
2174};
2175
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002176/* Markers of _kprobe_blacklist section */
2177extern unsigned long __start_kprobe_blacklist[];
2178extern unsigned long __stop_kprobe_blacklist[];
2179
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180static int __init init_kprobes(void)
2181{
2182 int i, err = 0;
2183
2184 /* FIXME allocate the probe table, currently defined statically */
2185 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002186 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002188 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02002189 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07002190 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002192 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2193 __stop_kprobe_blacklist);
2194 if (err) {
2195 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2196 pr_err("Please take care of using kprobes.\n");
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002197 }
2198
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002199 if (kretprobe_blacklist_size) {
2200 /* lookup the function address from its name */
2201 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2202 kprobe_lookup_name(kretprobe_blacklist[i].name,
2203 kretprobe_blacklist[i].addr);
2204 if (!kretprobe_blacklist[i].addr)
2205 printk("kretprobe: lookup failed: %s\n",
2206 kretprobe_blacklist[i].name);
2207 }
2208 }
2209
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002210#if defined(CONFIG_OPTPROBES)
2211#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002212 /* Init kprobe_optinsn_slots */
2213 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2214#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002215 /* By default, kprobes can be optimized */
2216 kprobes_allow_optimization = true;
2217#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002218
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002219 /* By default, kprobes are armed */
2220 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002221
Rusty Lynch67729262005-07-05 18:54:50 -07002222 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002223 if (!err)
2224 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002225 if (!err)
2226 err = register_module_notifier(&kprobe_module_nb);
2227
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002228 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002229
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002230 if (!err)
2231 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 return err;
2233}
2234
Srinivasa Ds346fd592007-02-20 13:57:54 -08002235#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002236static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002237 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002238{
2239 char *kprobe_type;
2240
2241 if (p->pre_handler == pre_handler_kretprobe)
2242 kprobe_type = "r";
2243 else if (p->pre_handler == setjmp_pre_handler)
2244 kprobe_type = "j";
2245 else
2246 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002247
Srinivasa Ds346fd592007-02-20 13:57:54 -08002248 if (sym)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002249 seq_printf(pi, "%p %s %s+0x%x %s ",
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002250 p->addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002251 (modname ? modname : " "));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002252 else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002253 seq_printf(pi, "%p %s %p ",
2254 p->addr, kprobe_type, p->addr);
2255
2256 if (!pp)
2257 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002258 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002259 (kprobe_gone(p) ? "[GONE]" : ""),
2260 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002261 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2262 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002263}
2264
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002265static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002266{
2267 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2268}
2269
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002270static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002271{
2272 (*pos)++;
2273 if (*pos >= KPROBE_TABLE_SIZE)
2274 return NULL;
2275 return pos;
2276}
2277
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002278static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002279{
2280 /* Nothing to do */
2281}
2282
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002283static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002284{
2285 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002286 struct kprobe *p, *kp;
2287 const char *sym = NULL;
2288 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002289 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002290 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002291
2292 head = &kprobe_table[i];
2293 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002294 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002295 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002296 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002297 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002298 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002299 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002300 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002301 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002302 }
2303 preempt_enable();
2304 return 0;
2305}
2306
James Morris88e9d342009-09-22 16:43:43 -07002307static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002308 .start = kprobe_seq_start,
2309 .next = kprobe_seq_next,
2310 .stop = kprobe_seq_stop,
2311 .show = show_kprobe_addr
2312};
2313
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002314static int kprobes_open(struct inode *inode, struct file *filp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002315{
2316 return seq_open(filp, &kprobes_seq_ops);
2317}
2318
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002319static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002320 .open = kprobes_open,
2321 .read = seq_read,
2322 .llseek = seq_lseek,
2323 .release = seq_release,
2324};
2325
Masami Hiramatsu63724742014-04-17 17:18:49 +09002326/* kprobes/blacklist -- shows which functions can not be probed */
2327static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2328{
2329 return seq_list_start(&kprobe_blacklist, *pos);
2330}
2331
2332static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2333{
2334 return seq_list_next(v, &kprobe_blacklist, pos);
2335}
2336
2337static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2338{
2339 struct kprobe_blacklist_entry *ent =
2340 list_entry(v, struct kprobe_blacklist_entry, list);
2341
2342 seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
2343 (void *)ent->end_addr, (void *)ent->start_addr);
2344 return 0;
2345}
2346
2347static const struct seq_operations kprobe_blacklist_seq_ops = {
2348 .start = kprobe_blacklist_seq_start,
2349 .next = kprobe_blacklist_seq_next,
2350 .stop = kprobe_seq_stop, /* Reuse void function */
2351 .show = kprobe_blacklist_seq_show,
2352};
2353
2354static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2355{
2356 return seq_open(filp, &kprobe_blacklist_seq_ops);
2357}
2358
2359static const struct file_operations debugfs_kprobe_blacklist_ops = {
2360 .open = kprobe_blacklist_open,
2361 .read = seq_read,
2362 .llseek = seq_lseek,
2363 .release = seq_release,
2364};
2365
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002366static void arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002367{
2368 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002369 struct kprobe *p;
2370 unsigned int i;
2371
2372 mutex_lock(&kprobe_mutex);
2373
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002374 /* If kprobes are armed, just return */
2375 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002376 goto already_enabled;
2377
Wang Nan977ad482015-02-13 14:40:24 -08002378 /*
2379 * optimize_kprobe() called by arm_kprobe() checks
2380 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2381 * arm_kprobe.
2382 */
2383 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002384 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002385 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2386 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002387 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002388 if (!kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002389 arm_kprobe(p);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002390 }
2391
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002392 printk(KERN_INFO "Kprobes globally enabled\n");
2393
2394already_enabled:
2395 mutex_unlock(&kprobe_mutex);
2396 return;
2397}
2398
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002399static void disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002400{
2401 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002402 struct kprobe *p;
2403 unsigned int i;
2404
2405 mutex_lock(&kprobe_mutex);
2406
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002407 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002408 if (kprobes_all_disarmed) {
2409 mutex_unlock(&kprobe_mutex);
2410 return;
2411 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002412
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002413 kprobes_all_disarmed = true;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002414 printk(KERN_INFO "Kprobes globally disabled\n");
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002415
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002416 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2417 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002418 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002419 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002420 disarm_kprobe(p, false);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002421 }
2422 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002423 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002424
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002425 /* Wait for disarming all kprobes by optimizer */
2426 wait_for_kprobe_optimizer();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002427}
2428
2429/*
2430 * XXX: The debugfs bool file interface doesn't allow for callbacks
2431 * when the bool state is switched. We can reuse that facility when
2432 * available
2433 */
2434static ssize_t read_enabled_file_bool(struct file *file,
2435 char __user *user_buf, size_t count, loff_t *ppos)
2436{
2437 char buf[3];
2438
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002439 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002440 buf[0] = '1';
2441 else
2442 buf[0] = '0';
2443 buf[1] = '\n';
2444 buf[2] = 0x00;
2445 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2446}
2447
2448static ssize_t write_enabled_file_bool(struct file *file,
2449 const char __user *user_buf, size_t count, loff_t *ppos)
2450{
2451 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002452 size_t buf_size;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002453
2454 buf_size = min(count, (sizeof(buf)-1));
2455 if (copy_from_user(buf, user_buf, buf_size))
2456 return -EFAULT;
2457
Mathias Krause10fb46d2013-07-03 15:05:39 -07002458 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002459 switch (buf[0]) {
2460 case 'y':
2461 case 'Y':
2462 case '1':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002463 arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002464 break;
2465 case 'n':
2466 case 'N':
2467 case '0':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002468 disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002469 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002470 default:
2471 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002472 }
2473
2474 return count;
2475}
2476
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002477static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002478 .read = read_enabled_file_bool,
2479 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002480 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002481};
2482
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002483static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002484{
2485 struct dentry *dir, *file;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002486 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002487
2488 dir = debugfs_create_dir("kprobes", NULL);
2489 if (!dir)
2490 return -ENOMEM;
2491
Randy Dunlape3869792007-05-08 00:27:01 -07002492 file = debugfs_create_file("list", 0444, dir, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002493 &debugfs_kprobes_operations);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002494 if (!file)
2495 goto error;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002496
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002497 file = debugfs_create_file("enabled", 0600, dir,
2498 &value, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002499 if (!file)
2500 goto error;
2501
2502 file = debugfs_create_file("blacklist", 0444, dir, NULL,
2503 &debugfs_kprobe_blacklist_ops);
2504 if (!file)
2505 goto error;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002506
Srinivasa Ds346fd592007-02-20 13:57:54 -08002507 return 0;
Masami Hiramatsu63724742014-04-17 17:18:49 +09002508
2509error:
2510 debugfs_remove(dir);
2511 return -ENOMEM;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002512}
2513
2514late_initcall(debugfs_kprobe_init);
2515#endif /* CONFIG_DEBUG_FS */
2516
2517module_init(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002519/* defined in arch/.../kernel/kprobes.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520EXPORT_SYMBOL_GPL(jprobe_return);