blob: 1b75fb8c7735e55de3e457f20fa385c01fe44e67 [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>
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070055#include <asm/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57#define KPROBE_HASH_BITS 6
58#define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
59
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070060
61/*
62 * Some oddball architectures like 64bit powerpc have function descriptors
63 * so this must be overridable.
64 */
65#ifndef kprobe_lookup_name
66#define kprobe_lookup_name(name, addr) \
67 addr = ((kprobe_opcode_t *)(kallsyms_lookup_name(name)))
68#endif
69
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070070static int kprobes_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
Hien Nguyenb94cce92005-06-23 00:09:19 -070072static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070074/* NOTE: change this value only with kprobe_mutex held */
Masami Hiramatsue579abe2009-04-06 19:01:01 -070075static bool kprobes_all_disarmed;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070076
Masami Hiramatsu43948f52010-10-25 22:18:01 +090077/* This protects kprobe_table and optimizing_list */
78static DEFINE_MUTEX(kprobe_mutex);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -080079static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070080static struct {
Thomas Gleixnerec4846082009-07-25 16:09:17 +020081 raw_spinlock_t lock ____cacheline_aligned_in_smp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070082} kretprobe_table_locks[KPROBE_TABLE_SIZE];
83
Thomas Gleixnerec4846082009-07-25 16:09:17 +020084static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070085{
86 return &(kretprobe_table_locks[hash].lock);
87}
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
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
Masami Hiramatsufd2f0702017-05-25 19:38:17 +0900128void __weak free_insn_page(void *page)
Heiko Carstensaf963972013-09-11 14:24:13 -0700129{
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
Heiko Carstensc802d642013-09-11 14:24:11 -0700152 mutex_lock(&c->mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700153 retry:
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500154 list_for_each_entry(kip, &c->pages, list) {
155 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700156 int i;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500157 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800158 if (kip->slot_used[i] == SLOT_CLEAN) {
159 kip->slot_used[i] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700160 kip->nused++;
Heiko Carstensc802d642013-09-11 14:24:11 -0700161 slot = kip->insns + (i * c->insn_size);
162 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700163 }
164 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500165 /* kip->nused is broken. Fix it. */
166 kip->nused = slots_per_page(c);
167 WARN_ON(1);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700168 }
169 }
170
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800171 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500172 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800173 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500174
175 /* All out of space. Need to allocate a new page. */
176 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700177 if (!kip)
Heiko Carstensc802d642013-09-11 14:24:11 -0700178 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700179
180 /*
181 * Use module_alloc so this page is within +/- 2GB of where the
182 * kernel image and loaded module images reside. This is required
183 * so x86_64 can correctly handle the %rip-relative fixups.
184 */
Heiko Carstensaf963972013-09-11 14:24:13 -0700185 kip->insns = c->alloc();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700186 if (!kip->insns) {
187 kfree(kip);
Heiko Carstensc802d642013-09-11 14:24:11 -0700188 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700189 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400190 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500191 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800192 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700193 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800194 kip->ngarbage = 0;
Heiko Carstensaf963972013-09-11 14:24:13 -0700195 kip->cache = c;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500196 list_add(&kip->list, &c->pages);
Heiko Carstensc802d642013-09-11 14:24:11 -0700197 slot = kip->insns;
198out:
199 mutex_unlock(&c->mutex);
200 return slot;
Masami Hiramatsu12941562009-01-06 14:41:50 -0800201}
202
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800203/* Return 1 if all garbages are collected, otherwise 0. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900204static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800205{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800206 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800207 kip->nused--;
208 if (kip->nused == 0) {
209 /*
210 * Page is no longer in use. Free it unless
211 * it's the last one. We keep the last one
212 * so as not to have to set it up again the
213 * next time somebody inserts a probe.
214 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500215 if (!list_is_singular(&kip->list)) {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400216 list_del(&kip->list);
Heiko Carstensaf963972013-09-11 14:24:13 -0700217 kip->cache->free(kip->insns);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800218 kfree(kip);
219 }
220 return 1;
221 }
222 return 0;
223}
224
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900225static int collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800226{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400227 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800228
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500229 /* Ensure no-one is interrupted on the garbages */
230 synchronize_sched();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800231
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500232 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800233 int i;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800234 if (kip->ngarbage == 0)
235 continue;
236 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500237 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800238 if (kip->slot_used[i] == SLOT_DIRTY &&
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800239 collect_one_slot(kip, i))
240 break;
241 }
242 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500243 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800244 return 0;
245}
246
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900247void __free_insn_slot(struct kprobe_insn_cache *c,
248 kprobe_opcode_t *slot, int dirty)
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500249{
250 struct kprobe_insn_page *kip;
251
Heiko Carstensc802d642013-09-11 14:24:11 -0700252 mutex_lock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500253 list_for_each_entry(kip, &c->pages, list) {
Masami Hiramatsu83ff56f2010-03-09 10:22:19 -0500254 long idx = ((long)slot - (long)kip->insns) /
255 (c->insn_size * sizeof(kprobe_opcode_t));
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500256 if (idx >= 0 && idx < slots_per_page(c)) {
257 WARN_ON(kip->slot_used[idx] != SLOT_USED);
258 if (dirty) {
259 kip->slot_used[idx] = SLOT_DIRTY;
260 kip->ngarbage++;
261 if (++c->nr_garbage > slots_per_page(c))
262 collect_garbage_slots(c);
263 } else
264 collect_one_slot(kip, idx);
Heiko Carstensc802d642013-09-11 14:24:11 -0700265 goto out;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500266 }
267 }
268 /* Could not free this slot. */
269 WARN_ON(1);
Heiko Carstensc802d642013-09-11 14:24:11 -0700270out:
271 mutex_unlock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500272}
273
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500274#ifdef CONFIG_OPTPROBES
275/* For optimized_kprobe buffer */
Heiko Carstensc802d642013-09-11 14:24:11 -0700276struct kprobe_insn_cache kprobe_optinsn_slots = {
277 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700278 .alloc = alloc_insn_page,
279 .free = free_insn_page,
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500280 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
281 /* .insn_size is initialized later */
282 .nr_garbage = 0,
283};
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500284#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800285#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700286
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800287/* We have preemption disabled.. so it is safe to use __ versions */
288static inline void set_kprobe_instance(struct kprobe *kp)
289{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600290 __this_cpu_write(kprobe_instance, kp);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800291}
292
293static inline void reset_kprobe_instance(void)
294{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600295 __this_cpu_write(kprobe_instance, NULL);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800296}
297
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800298/*
299 * This routine is called either:
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -0800300 * - under the kprobe_mutex - during kprobe_[un]register()
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800301 * OR
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800302 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800303 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900304struct kprobe *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{
306 struct hlist_head *head;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800307 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800310 hlist_for_each_entry_rcu(p, head, hlist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 if (p->addr == addr)
312 return p;
313 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 return NULL;
316}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900317NOKPROBE_SYMBOL(get_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900319static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500320
321/* Return true if the kprobe is an aggregator */
322static inline int kprobe_aggrprobe(struct kprobe *p)
323{
324 return p->pre_handler == aggr_pre_handler;
325}
326
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900327/* Return true(!0) if the kprobe is unused */
328static inline int kprobe_unused(struct kprobe *p)
329{
330 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
331 list_empty(&p->list);
332}
333
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500334/*
335 * Keep all fields in the kprobe consistent
336 */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900337static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500338{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900339 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
340 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500341}
342
343#ifdef CONFIG_OPTPROBES
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500344/* NOTE: change this value only with kprobe_mutex held */
345static bool kprobes_allow_optimization;
346
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500347/*
348 * Call all pre_handler on the list, but ignores its return value.
349 * This must be called from arch-dep optimized caller.
350 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900351void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500352{
353 struct kprobe *kp;
354
355 list_for_each_entry_rcu(kp, &p->list, list) {
356 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
357 set_kprobe_instance(kp);
358 kp->pre_handler(kp, regs);
359 }
360 reset_kprobe_instance();
361 }
362}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900363NOKPROBE_SYMBOL(opt_pre_handler);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500364
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900365/* Free optimized instructions and optimized_kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900366static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900367{
368 struct optimized_kprobe *op;
369
370 op = container_of(p, struct optimized_kprobe, kp);
371 arch_remove_optimized_kprobe(op);
372 arch_remove_kprobe(p);
373 kfree(op);
374}
375
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500376/* Return true(!0) if the kprobe is ready for optimization. */
377static inline int kprobe_optready(struct kprobe *p)
378{
379 struct optimized_kprobe *op;
380
381 if (kprobe_aggrprobe(p)) {
382 op = container_of(p, struct optimized_kprobe, kp);
383 return arch_prepared_optinsn(&op->optinsn);
384 }
385
386 return 0;
387}
388
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900389/* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
390static inline int kprobe_disarmed(struct kprobe *p)
391{
392 struct optimized_kprobe *op;
393
394 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
395 if (!kprobe_aggrprobe(p))
396 return kprobe_disabled(p);
397
398 op = container_of(p, struct optimized_kprobe, kp);
399
400 return kprobe_disabled(p) && list_empty(&op->list);
401}
402
403/* Return true(!0) if the probe is queued on (un)optimizing lists */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900404static int kprobe_queued(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900405{
406 struct optimized_kprobe *op;
407
408 if (kprobe_aggrprobe(p)) {
409 op = container_of(p, struct optimized_kprobe, kp);
410 if (!list_empty(&op->list))
411 return 1;
412 }
413 return 0;
414}
415
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500416/*
417 * Return an optimized kprobe whose optimizing code replaces
418 * instructions including addr (exclude breakpoint).
419 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900420static struct kprobe *get_optimized_kprobe(unsigned long addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500421{
422 int i;
423 struct kprobe *p = NULL;
424 struct optimized_kprobe *op;
425
426 /* Don't check i == 0, since that is a breakpoint case. */
427 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
428 p = get_kprobe((void *)(addr - i));
429
430 if (p && kprobe_optready(p)) {
431 op = container_of(p, struct optimized_kprobe, kp);
432 if (arch_within_optimized_kprobe(op, addr))
433 return p;
434 }
435
436 return NULL;
437}
438
439/* Optimization staging list, protected by kprobe_mutex */
440static LIST_HEAD(optimizing_list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900441static LIST_HEAD(unoptimizing_list);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900442static LIST_HEAD(freeing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500443
444static void kprobe_optimizer(struct work_struct *work);
445static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
446#define OPTIMIZE_DELAY 5
447
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900448/*
449 * Optimize (replace a breakpoint with a jump) kprobes listed on
450 * optimizing_list.
451 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900452static void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500453{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900454 /* Optimization never be done when disarmed */
455 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
456 list_empty(&optimizing_list))
457 return;
458
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500459 /*
460 * The optimization/unoptimization refers online_cpus via
461 * stop_machine() and cpu-hotplug modifies online_cpus.
462 * And same time, text_mutex will be held in cpu-hotplug and here.
463 * This combination can cause a deadlock (cpu-hotplug try to lock
464 * text_mutex but stop_machine can not be done because online_cpus
465 * has been changed)
466 * To avoid this deadlock, we need to call get_online_cpus()
467 * for preventing cpu-hotplug outside of text_mutex locking.
468 */
469 get_online_cpus();
470 mutex_lock(&text_mutex);
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900471 arch_optimize_kprobes(&optimizing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500472 mutex_unlock(&text_mutex);
473 put_online_cpus();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900474}
475
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900476/*
477 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
478 * if need) kprobes listed on unoptimizing_list.
479 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900480static void do_unoptimize_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900481{
482 struct optimized_kprobe *op, *tmp;
483
484 /* Unoptimization must be done anytime */
485 if (list_empty(&unoptimizing_list))
486 return;
487
488 /* Ditto to do_optimize_kprobes */
489 get_online_cpus();
490 mutex_lock(&text_mutex);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900491 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900492 /* Loop free_list for disarming */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900493 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900494 /* Disarm probes if marked disabled */
495 if (kprobe_disabled(&op->kp))
496 arch_disarm_kprobe(&op->kp);
497 if (kprobe_unused(&op->kp)) {
498 /*
499 * Remove unused probes from hash list. After waiting
500 * for synchronization, these probes are reclaimed.
501 * (reclaiming is done by do_free_cleaned_kprobes.)
502 */
503 hlist_del_rcu(&op->kp.hlist);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900504 } else
505 list_del_init(&op->list);
506 }
507 mutex_unlock(&text_mutex);
508 put_online_cpus();
509}
510
511/* Reclaim all kprobes on the free_list */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900512static void do_free_cleaned_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900513{
514 struct optimized_kprobe *op, *tmp;
515
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900516 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900517 list_del_init(&op->list);
Masami Hiramatsu679791f2018-09-11 19:21:09 +0900518 if (WARN_ON_ONCE(!kprobe_unused(&op->kp))) {
519 /*
520 * This must not happen, but if there is a kprobe
521 * still in use, keep it on kprobes hash list.
522 */
523 continue;
524 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900525 free_aggr_kprobe(&op->kp);
526 }
527}
528
529/* Start optimizer after OPTIMIZE_DELAY passed */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900530static void kick_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900531{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800532 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900533}
534
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900535/* Kprobe jump optimizer */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900536static void kprobe_optimizer(struct work_struct *work)
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900537{
Steven Rostedt72ef3792012-06-05 19:28:14 +0900538 mutex_lock(&kprobe_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900539 /* Lock modules while optimizing kprobes */
540 mutex_lock(&module_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900541
542 /*
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900543 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
544 * kprobes before waiting for quiesence period.
545 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900546 do_unoptimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900547
548 /*
549 * Step 2: Wait for quiesence period to ensure all running interrupts
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900550 * are done. Because optprobe may modify multiple instructions
551 * there is a chance that Nth instruction is interrupted. In that
552 * case, running interrupt can return to 2nd-Nth byte of jump
553 * instruction. This wait is for avoiding it.
554 */
555 synchronize_sched();
556
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900557 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900558 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900559
560 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900561 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900562
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500563 mutex_unlock(&module_mutex);
Steven Rostedt72ef3792012-06-05 19:28:14 +0900564 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900565
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900566 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900567 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900568 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900569}
570
571/* Wait for completing optimization and unoptimization */
Thomas Gleixnerdd0023d2017-05-17 10:19:49 +0200572void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900573{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800574 mutex_lock(&kprobe_mutex);
575
576 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
577 mutex_unlock(&kprobe_mutex);
578
579 /* this will also make optimizing_work execute immmediately */
580 flush_delayed_work(&optimizing_work);
581 /* @optimizing_work might not have been queued yet, relax */
582 cpu_relax();
583
584 mutex_lock(&kprobe_mutex);
585 }
586
587 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500588}
589
590/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900591static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500592{
593 struct optimized_kprobe *op;
594
595 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500596 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500597 (kprobe_disabled(p) || kprobes_all_disarmed))
598 return;
599
600 /* Both of break_handler and post_handler are not supported. */
601 if (p->break_handler || p->post_handler)
602 return;
603
604 op = container_of(p, struct optimized_kprobe, kp);
605
606 /* Check there is no other kprobes at the optimized instructions */
607 if (arch_check_optimized_kprobe(op) < 0)
608 return;
609
610 /* Check if it is already optimized. */
611 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
612 return;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500613 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900614
615 if (!list_empty(&op->list))
616 /* This is under unoptimizing. Just dequeue the probe */
617 list_del_init(&op->list);
618 else {
619 list_add(&op->list, &optimizing_list);
620 kick_kprobe_optimizer();
621 }
622}
623
624/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900625static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900626{
627 get_online_cpus();
628 arch_unoptimize_kprobe(op);
629 put_online_cpus();
630 if (kprobe_disabled(&op->kp))
631 arch_disarm_kprobe(&op->kp);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500632}
633
634/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900635static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500636{
637 struct optimized_kprobe *op;
638
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900639 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
640 return; /* This is not an optprobe nor optimized */
641
642 op = container_of(p, struct optimized_kprobe, kp);
643 if (!kprobe_optimized(p)) {
644 /* Unoptimized or unoptimizing case */
645 if (force && !list_empty(&op->list)) {
646 /*
647 * Only if this is unoptimizing kprobe and forced,
648 * forcibly unoptimize it. (No need to unoptimize
649 * unoptimized kprobe again :)
650 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500651 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900652 force_unoptimize_kprobe(op);
653 }
654 return;
655 }
656
657 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
658 if (!list_empty(&op->list)) {
659 /* Dequeue from the optimization queue */
660 list_del_init(&op->list);
661 return;
662 }
663 /* Optimized kprobe case */
664 if (force)
665 /* Forcibly update the code: this is a special case */
666 force_unoptimize_kprobe(op);
667 else {
668 list_add(&op->list, &unoptimizing_list);
669 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500670 }
671}
672
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900673/* Cancel unoptimizing for reusing */
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900674static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900675{
676 struct optimized_kprobe *op;
677
678 BUG_ON(!kprobe_unused(ap));
679 /*
680 * Unused kprobe MUST be on the way of delayed unoptimizing (means
681 * there is still a relative jump) and disabled.
682 */
683 op = container_of(ap, struct optimized_kprobe, kp);
684 if (unlikely(list_empty(&op->list)))
685 printk(KERN_WARNING "Warning: found a stray unused "
686 "aggrprobe@%p\n", ap->addr);
687 /* Enable the probe again */
688 ap->flags &= ~KPROBE_FLAG_DISABLED;
689 /* Optimize it again (remove from op->list) */
Masami Hiramatsu8a779c42019-04-15 15:01:25 +0900690 if (!kprobe_optready(ap))
691 return -EINVAL;
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900692
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900693 optimize_kprobe(ap);
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900694 return 0;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900695}
696
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500697/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900698static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500699{
700 struct optimized_kprobe *op;
701
702 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900703 if (!list_empty(&op->list))
704 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500705 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900706 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900707
708 if (kprobe_unused(p)) {
709 /* Enqueue if it is unused */
710 list_add(&op->list, &freeing_list);
711 /*
712 * Remove unused probes from the hash list. After waiting
713 * for synchronization, this probe is reclaimed.
714 * (reclaiming is done by do_free_cleaned_kprobes().)
715 */
716 hlist_del_rcu(&op->kp.hlist);
717 }
718
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900719 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500720 arch_remove_optimized_kprobe(op);
721}
722
723/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900724static void prepare_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 Hiramatsucbf6ab52015-01-05 19:29:32 +0800729 arch_prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500730}
731
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500732/* Allocate new optimized_kprobe and try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900733static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500734{
735 struct optimized_kprobe *op;
736
737 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
738 if (!op)
739 return NULL;
740
741 INIT_LIST_HEAD(&op->list);
742 op->kp.addr = p->addr;
Masami Hiramatsucbf6ab52015-01-05 19:29:32 +0800743 arch_prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500744
745 return &op->kp;
746}
747
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900748static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500749
750/*
751 * Prepare an optimized_kprobe and optimize it
752 * NOTE: p must be a normal registered kprobe
753 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900754static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500755{
756 struct kprobe *ap;
757 struct optimized_kprobe *op;
758
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900759 /* Impossible to optimize ftrace-based kprobe */
760 if (kprobe_ftrace(p))
761 return;
762
Masami Hiramatsu25764282012-06-05 19:28:26 +0900763 /* For preparing optimization, jump_label_text_reserved() is called */
764 jump_label_lock();
765 mutex_lock(&text_mutex);
766
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500767 ap = alloc_aggr_kprobe(p);
768 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900769 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500770
771 op = container_of(ap, struct optimized_kprobe, kp);
772 if (!arch_prepared_optinsn(&op->optinsn)) {
773 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900774 arch_remove_optimized_kprobe(op);
775 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900776 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500777 }
778
779 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900780 optimize_kprobe(ap); /* This just kicks optimizer thread */
781
782out:
783 mutex_unlock(&text_mutex);
784 jump_label_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500785}
786
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500787#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900788static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500789{
790 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500791 struct kprobe *p;
792 unsigned int i;
793
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900794 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500795 /* If optimization is already allowed, just return */
796 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900797 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500798
799 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500800 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
801 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800802 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500803 if (!kprobe_disabled(p))
804 optimize_kprobe(p);
805 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500806 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900807out:
808 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500809}
810
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900811static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500812{
813 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500814 struct kprobe *p;
815 unsigned int i;
816
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900817 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500818 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900819 if (!kprobes_allow_optimization) {
820 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500821 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900822 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500823
824 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500825 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
826 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800827 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500828 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900829 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500830 }
831 }
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900832 mutex_unlock(&kprobe_mutex);
833
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900834 /* Wait for unoptimizing completion */
835 wait_for_kprobe_optimizer();
836 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500837}
838
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900839static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500840int sysctl_kprobes_optimization;
841int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
842 void __user *buffer, size_t *length,
843 loff_t *ppos)
844{
845 int ret;
846
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900847 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500848 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
849 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
850
851 if (sysctl_kprobes_optimization)
852 optimize_all_kprobes();
853 else
854 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900855 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500856
857 return ret;
858}
859#endif /* CONFIG_SYSCTL */
860
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900861/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900862static void __arm_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500863{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900864 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500865
866 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900867 _p = get_optimized_kprobe((unsigned long)p->addr);
868 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900869 /* Fallback to unoptimized kprobe */
870 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500871
872 arch_arm_kprobe(p);
873 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
874}
875
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900876/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900877static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500878{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900879 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500880
Wang Nan69d54b92015-02-13 14:40:26 -0800881 /* Try to unoptimize */
882 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500883
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900884 if (!kprobe_queued(p)) {
885 arch_disarm_kprobe(p);
886 /* If another kprobe was blocked, optimize it. */
887 _p = get_optimized_kprobe((unsigned long)p->addr);
888 if (unlikely(_p) && reopt)
889 optimize_kprobe(_p);
890 }
891 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500892}
893
894#else /* !CONFIG_OPTPROBES */
895
896#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900897#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500898#define kill_optimized_kprobe(p) do {} while (0)
899#define prepare_optimized_kprobe(p) do {} while (0)
900#define try_to_optimize_kprobe(p) do {} while (0)
901#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900902#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
903#define kprobe_disarmed(p) kprobe_disabled(p)
904#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500905
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900906static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900907{
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900908 /*
909 * If the optimized kprobe is NOT supported, the aggr kprobe is
910 * released at the same time that the last aggregated kprobe is
911 * unregistered.
912 * Thus there should be no chance to reuse unused kprobe.
913 */
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900914 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900915 return -EINVAL;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900916}
917
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900918static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500919{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900920 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500921 kfree(p);
922}
923
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900924static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500925{
926 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
927}
928#endif /* CONFIG_OPTPROBES */
929
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900930#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900931static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +0900932 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -0500933 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900934};
935static int kprobe_ftrace_enabled;
936
937/* Must ensure p->addr is really on ftrace */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900938static int prepare_kprobe(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900939{
940 if (!kprobe_ftrace(p))
941 return arch_prepare_kprobe(p);
942
943 return arch_prepare_kprobe_ftrace(p);
944}
945
946/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900947static void arm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900948{
949 int ret;
950
951 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
952 (unsigned long)p->addr, 0, 0);
953 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
954 kprobe_ftrace_enabled++;
955 if (kprobe_ftrace_enabled == 1) {
956 ret = register_ftrace_function(&kprobe_ftrace_ops);
957 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
958 }
959}
960
961/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900962static void disarm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900963{
964 int ret;
965
966 kprobe_ftrace_enabled--;
967 if (kprobe_ftrace_enabled == 0) {
968 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
969 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
970 }
971 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
972 (unsigned long)p->addr, 1, 0);
973 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
974}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900975#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900976#define prepare_kprobe(p) arch_prepare_kprobe(p)
977#define arm_kprobe_ftrace(p) do {} while (0)
978#define disarm_kprobe_ftrace(p) do {} while (0)
979#endif
980
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400981/* Arm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900982static void arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400983{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900984 if (unlikely(kprobe_ftrace(kp))) {
985 arm_kprobe_ftrace(kp);
986 return;
987 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500988 /*
989 * Here, since __arm_kprobe() doesn't use stop_machine(),
990 * this doesn't cause deadlock on text_mutex. So, we don't
991 * need get_online_cpus().
992 */
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400993 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500994 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400995 mutex_unlock(&text_mutex);
996}
997
998/* Disarm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900999static void disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001000{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001001 if (unlikely(kprobe_ftrace(kp))) {
1002 disarm_kprobe_ftrace(kp);
1003 return;
1004 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001005 /* Ditto */
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001006 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001007 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001008 mutex_unlock(&text_mutex);
1009}
1010
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001011/*
1012 * Aggregate handlers for multiple kprobes support - these handlers
1013 * take care of invoking the individual kprobe handlers on p->list
1014 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001015static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001016{
1017 struct kprobe *kp;
1018
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001019 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001020 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001021 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001022 if (kp->pre_handler(kp, regs))
1023 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001024 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001025 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001026 }
1027 return 0;
1028}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001029NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001030
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001031static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1032 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001033{
1034 struct kprobe *kp;
1035
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001036 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001037 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001038 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001039 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001040 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001041 }
1042 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001043}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001044NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001045
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001046static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1047 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001048{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001049 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001050
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001051 /*
1052 * if we faulted "during" the execution of a user specified
1053 * probe handler, invoke just that probe's fault handler
1054 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001055 if (cur && cur->fault_handler) {
1056 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001057 return 1;
1058 }
1059 return 0;
1060}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001061NOKPROBE_SYMBOL(aggr_fault_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001062
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001063static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001064{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001065 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001066 int ret = 0;
1067
1068 if (cur && cur->break_handler) {
1069 if (cur->break_handler(cur, regs))
1070 ret = 1;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001071 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001072 reset_kprobe_instance();
1073 return ret;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001074}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001075NOKPROBE_SYMBOL(aggr_break_handler);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001076
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001077/* Walks the list and increments nmissed count for multiprobe case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001078void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001079{
1080 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001081 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001082 p->nmissed++;
1083 } else {
1084 list_for_each_entry_rcu(kp, &p->list, list)
1085 kp->nmissed++;
1086 }
1087 return;
1088}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001089NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001090
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001091void recycle_rp_inst(struct kretprobe_instance *ri,
1092 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001093{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001094 struct kretprobe *rp = ri->rp;
1095
Hien Nguyenb94cce92005-06-23 00:09:19 -07001096 /* remove rp inst off the rprobe_inst_table */
1097 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001098 INIT_HLIST_NODE(&ri->hlist);
1099 if (likely(rp)) {
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001100 raw_spin_lock(&rp->lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001101 hlist_add_head(&ri->hlist, &rp->free_instances);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001102 raw_spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001103 } else
1104 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -07001105 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001106}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001107NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001108
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001109void kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001110 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001111__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001112{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001113 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001114 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001115
1116 *head = &kretprobe_inst_table[hash];
1117 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001118 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001119}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001120NOKPROBE_SYMBOL(kretprobe_hash_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001121
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001122static void kretprobe_table_lock(unsigned long hash,
1123 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001124__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001125{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001126 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1127 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001128}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001129NOKPROBE_SYMBOL(kretprobe_table_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001130
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001131void kretprobe_hash_unlock(struct task_struct *tsk,
1132 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001133__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001134{
1135 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001136 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001137
1138 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001139 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001140}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001141NOKPROBE_SYMBOL(kretprobe_hash_unlock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001142
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001143static void kretprobe_table_unlock(unsigned long hash,
1144 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001145__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001146{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001147 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1148 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001149}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001150NOKPROBE_SYMBOL(kretprobe_table_unlock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001151
Hien Nguyenb94cce92005-06-23 00:09:19 -07001152/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001153 * This function is called from finish_task_switch when task tk becomes dead,
1154 * so that we can recycle any function-return probe instances associated
1155 * with this task. These left over instances represent probed functions
1156 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001157 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001158void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001159{
bibo,mao62c27be2006-10-02 02:17:33 -07001160 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -07001161 struct hlist_head *head, empty_rp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001162 struct hlist_node *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001163 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -07001164
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001165 if (unlikely(!kprobes_initialized))
1166 /* Early boot. kretprobe_table_locks not yet initialized. */
1167 return;
1168
Ananth N Mavinakayanahallid496aab2012-01-20 14:34:04 -08001169 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001170 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1171 head = &kretprobe_inst_table[hash];
1172 kretprobe_table_lock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001173 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -07001174 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -07001175 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -07001176 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001177 kretprobe_table_unlock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001178 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
bibo,mao99219a32006-10-02 02:17:35 -07001179 hlist_del(&ri->hlist);
1180 kfree(ri);
1181 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001182}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001183NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001184
Hien Nguyenb94cce92005-06-23 00:09:19 -07001185static inline void free_rp_inst(struct kretprobe *rp)
1186{
1187 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001188 struct hlist_node *next;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001189
Sasha Levinb67bfe02013-02-27 17:06:00 -08001190 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001191 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001192 kfree(ri);
1193 }
1194}
1195
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001196static void cleanup_rp_inst(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001197{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001198 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001199 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001200 struct hlist_node *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001201 struct hlist_head *head;
1202
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001203 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001204 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1205 kretprobe_table_lock(hash, &flags);
1206 head = &kretprobe_inst_table[hash];
Sasha Levinb67bfe02013-02-27 17:06:00 -08001207 hlist_for_each_entry_safe(ri, next, head, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001208 if (ri->rp == rp)
1209 ri->rp = NULL;
1210 }
1211 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001212 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001213 free_rp_inst(rp);
1214}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001215NOKPROBE_SYMBOL(cleanup_rp_inst);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001216
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001217/*
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001218* Add the new probe to ap->list. Fail if this is the
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001219* second jprobe at the address - two jprobes can't coexist
1220*/
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001221static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001222{
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001223 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001224
1225 if (p->break_handler || p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001226 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001227
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001228 if (p->break_handler) {
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001229 if (ap->break_handler)
mao, bibo36721652006-06-26 00:25:22 -07001230 return -EEXIST;
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001231 list_add_tail_rcu(&p->list, &ap->list);
1232 ap->break_handler = aggr_break_handler;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001233 } else
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001234 list_add_rcu(&p->list, &ap->list);
1235 if (p->post_handler && !ap->post_handler)
1236 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001237
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001238 return 0;
1239}
1240
1241/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001242 * Fill in the required fields of the "manager kprobe". Replace the
1243 * earlier kprobe in the hlist with the manager kprobe
1244 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001245static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001246{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001247 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001248 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001249 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001250 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001251 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001252 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001253 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001254 /* We don't care the kprobe which has gone. */
1255 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001256 ap->post_handler = aggr_post_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001257 if (p->break_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001258 ap->break_handler = aggr_break_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001259
1260 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001261 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001262
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001263 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001264 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001265}
1266
1267/*
1268 * This is the second or subsequent kprobe at the address - handle
1269 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001270 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001271static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001272{
1273 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001274 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001275
Masami Hiramatsu25764282012-06-05 19:28:26 +09001276 /* For preparing optimization, jump_label_text_reserved() is called */
1277 jump_label_lock();
1278 /*
1279 * Get online CPUs to avoid text_mutex deadlock.with stop machine,
1280 * which is invoked by unoptimize_kprobe() in add_new_kprobe()
1281 */
1282 get_online_cpus();
1283 mutex_lock(&text_mutex);
1284
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001285 if (!kprobe_aggrprobe(orig_p)) {
1286 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1287 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001288 if (!ap) {
1289 ret = -ENOMEM;
1290 goto out;
1291 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001292 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +09001293 } else if (kprobe_unused(ap)) {
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001294 /* This probe is going to die. Rescue it */
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +09001295 ret = reuse_unused_kprobe(ap);
1296 if (ret)
1297 goto out;
1298 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001299
1300 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001301 /*
1302 * Attempting to insert new probe at the same location that
1303 * had a probe in the module vaddr area which already
1304 * freed. So, the instruction slot has already been
1305 * released. We need a new slot for the new probe.
1306 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001307 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001308 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001309 /*
1310 * Even if fail to allocate new slot, don't need to
1311 * free aggr_probe. It will be used next time, or
1312 * freed by unregister_kprobe.
1313 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001314 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001315
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001316 /* Prepare optimized instructions if possible. */
1317 prepare_optimized_kprobe(ap);
1318
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001319 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001320 * Clear gone flag to prevent allocating new slot again, and
1321 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001322 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001323 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1324 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001325 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001326
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001327 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001328 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001329 ret = add_new_kprobe(ap, p);
1330
1331out:
1332 mutex_unlock(&text_mutex);
1333 put_online_cpus();
1334 jump_label_unlock();
1335
1336 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1337 ap->flags &= ~KPROBE_FLAG_DISABLED;
1338 if (!kprobes_all_disarmed)
1339 /* Arm the breakpoint again. */
1340 arm_kprobe(ap);
1341 }
1342 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001343}
1344
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001345bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1346{
1347 /* The __kprobes marked functions and entry code must not be probed */
1348 return addr >= (unsigned long)__kprobes_text_start &&
1349 addr < (unsigned long)__kprobes_text_end;
1350}
1351
Andy Lutomirskie5779e82015-07-30 20:32:40 -07001352bool within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001353{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001354 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001355
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001356 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001357 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001358 /*
1359 * If there exists a kprobe_blacklist, verify and
1360 * fail any probe registration in the prohibited area
1361 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001362 list_for_each_entry(ent, &kprobe_blacklist, list) {
1363 if (addr >= ent->start_addr && addr < ent->end_addr)
1364 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001365 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001366
1367 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001368}
1369
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001370/*
1371 * If we have a symbol_name argument, look it up and add the offset field
1372 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001373 * This returns encoded errors if it fails to look up symbol or invalid
1374 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001375 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001376static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001377{
1378 kprobe_opcode_t *addr = p->addr;
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001379
1380 if ((p->symbol_name && p->addr) ||
1381 (!p->symbol_name && !p->addr))
1382 goto invalid;
1383
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001384 if (p->symbol_name) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001385 kprobe_lookup_name(p->symbol_name, addr);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001386 if (!addr)
1387 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001388 }
1389
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001390 addr = (kprobe_opcode_t *)(((char *)addr) + p->offset);
1391 if (addr)
1392 return addr;
1393
1394invalid:
1395 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001396}
1397
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301398/* Check passed kprobe is valid and return kprobe in kprobe_table. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001399static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301400{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001401 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301402
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001403 ap = get_kprobe(p->addr);
1404 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301405 return NULL;
1406
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001407 if (p != ap) {
1408 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301409 if (list_p == p)
1410 /* kprobe p is a valid probe */
1411 goto valid;
1412 return NULL;
1413 }
1414valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001415 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301416}
1417
1418/* Return error if the kprobe is being re-registered */
1419static inline int check_kprobe_rereg(struct kprobe *p)
1420{
1421 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301422
1423 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001424 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301425 ret = -EINVAL;
1426 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001427
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301428 return ret;
1429}
1430
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001431int __weak arch_check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001433 unsigned long ftrace_addr;
1434
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001435 ftrace_addr = ftrace_location((unsigned long)p->addr);
1436 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001437#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001438 /* Given address is not on the instruction boundary */
1439 if ((unsigned long)p->addr != ftrace_addr)
1440 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001441 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001442#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001443 return -EINVAL;
1444#endif
1445 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001446 return 0;
1447}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001448
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001449static int check_kprobe_address_safe(struct kprobe *p,
1450 struct module **probed_mod)
1451{
1452 int ret;
1453
1454 ret = arch_check_ftrace_location(p);
1455 if (ret)
1456 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001457 jump_label_lock();
1458 preempt_disable();
1459
1460 /* Ensure it is not in reserved area nor out of text */
1461 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001462 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsud641e702019-09-03 20:08:21 +09001463 jump_label_text_reserved(p->addr, p->addr) ||
1464 find_bug((unsigned long)p->addr)) {
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001465 ret = -EINVAL;
1466 goto out;
1467 }
1468
1469 /* Check if are we probing a module */
1470 *probed_mod = __module_text_address((unsigned long) p->addr);
1471 if (*probed_mod) {
1472 /*
1473 * We must hold a refcount of the probed module while updating
1474 * its code to prohibit unexpected unloading.
1475 */
1476 if (unlikely(!try_module_get(*probed_mod))) {
1477 ret = -ENOENT;
1478 goto out;
1479 }
1480
1481 /*
1482 * If the module freed .init.text, we couldn't insert
1483 * kprobes in there.
1484 */
1485 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1486 (*probed_mod)->state != MODULE_STATE_COMING) {
1487 module_put(*probed_mod);
1488 *probed_mod = NULL;
1489 ret = -ENOENT;
1490 }
1491 }
1492out:
1493 preempt_enable();
1494 jump_label_unlock();
1495
1496 return ret;
1497}
1498
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001499int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001500{
1501 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001502 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001503 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001504 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001506 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001507 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001508 if (IS_ERR(addr))
1509 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001510 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001511
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301512 ret = check_kprobe_rereg(p);
1513 if (ret)
1514 return ret;
1515
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001516 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1517 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001518 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001519 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001520
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001521 ret = check_kprobe_address_safe(p, &probed_mod);
1522 if (ret)
1523 return ret;
1524
1525 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001526
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001527 old_p = get_kprobe(p->addr);
1528 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001529 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001530 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531 goto out;
1532 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Masami Hiramatsu25764282012-06-05 19:28:26 +09001534 mutex_lock(&text_mutex); /* Avoiding text modification */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001535 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001536 mutex_unlock(&text_mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001537 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001538 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001539
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001540 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001541 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1543
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001544 if (!kprobes_all_disarmed && !kprobe_disabled(p))
Masami Hiramatsu25764282012-06-05 19:28:26 +09001545 arm_kprobe(p);
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001546
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001547 /* Try to optimize kprobe */
1548 try_to_optimize_kprobe(p);
1549
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001551 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001552
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001553 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001554 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001555
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 return ret;
1557}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001558EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001560/* Check if all probes on the aggrprobe are disabled */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001561static int aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001562{
1563 struct kprobe *kp;
1564
1565 list_for_each_entry_rcu(kp, &ap->list, list)
1566 if (!kprobe_disabled(kp))
1567 /*
1568 * There is an active probe on the list.
1569 * We can't disable this ap.
1570 */
1571 return 0;
1572
1573 return 1;
1574}
1575
1576/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001577static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001578{
1579 struct kprobe *orig_p;
1580
1581 /* Get an original kprobe for return */
1582 orig_p = __get_valid_kprobe(p);
1583 if (unlikely(orig_p == NULL))
1584 return NULL;
1585
1586 if (!kprobe_disabled(p)) {
1587 /* Disable probe if it is a child probe */
1588 if (p != orig_p)
1589 p->flags |= KPROBE_FLAG_DISABLED;
1590
1591 /* Try to disarm and disable this/parent probe */
1592 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001593 /*
1594 * If kprobes_all_disarmed is set, orig_p
1595 * should have already been disarmed, so
1596 * skip unneed disarming process.
1597 */
1598 if (!kprobes_all_disarmed)
1599 disarm_kprobe(orig_p, true);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001600 orig_p->flags |= KPROBE_FLAG_DISABLED;
1601 }
1602 }
1603
1604 return orig_p;
1605}
1606
Masami Hiramatsu98616682008-04-28 02:14:28 -07001607/*
1608 * Unregister a kprobe without a scheduler synchronization.
1609 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001610static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001611{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001612 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001613
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001614 /* Disable kprobe. This will disarm it if needed. */
1615 ap = __disable_kprobe(p);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001616 if (ap == NULL)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001617 return -EINVAL;
1618
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001619 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001620 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001621 * This probe is an independent(and non-optimized) kprobe
1622 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001623 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001624 goto disarmed;
1625
1626 /* Following process expects this probe is an aggrprobe */
1627 WARN_ON(!kprobe_aggrprobe(ap));
1628
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001629 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1630 /*
1631 * !disarmed could be happen if the probe is under delayed
1632 * unoptimizing.
1633 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001634 goto disarmed;
1635 else {
1636 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001637 if (p->break_handler && !kprobe_gone(p))
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001638 ap->break_handler = NULL;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001639 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001640 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001641 if ((list_p != p) && (list_p->post_handler))
1642 goto noclean;
1643 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001644 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001645 }
1646noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001647 /*
1648 * Remove from the aggrprobe: this path will do nothing in
1649 * __unregister_kprobe_bottom().
1650 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001651 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001652 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1653 /*
1654 * Try to optimize this probe again, because post
1655 * handler may have been changed.
1656 */
1657 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001658 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001659 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001660
1661disarmed:
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001662 BUG_ON(!kprobe_disarmed(ap));
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001663 hlist_del_rcu(&ap->hlist);
1664 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001665}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001666
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001667static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001668{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001669 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001670
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001671 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001672 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001673 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001674 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001675 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001676 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001677 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001678 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001679 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001680 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681}
1682
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001683int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001684{
1685 int i, ret = 0;
1686
1687 if (num <= 0)
1688 return -EINVAL;
1689 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001690 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001691 if (ret < 0) {
1692 if (i > 0)
1693 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001694 break;
1695 }
1696 }
1697 return ret;
1698}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001699EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001700
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001701void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001702{
1703 unregister_kprobes(&p, 1);
1704}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001705EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001706
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001707void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001708{
1709 int i;
1710
1711 if (num <= 0)
1712 return;
1713 mutex_lock(&kprobe_mutex);
1714 for (i = 0; i < num; i++)
1715 if (__unregister_kprobe_top(kps[i]) < 0)
1716 kps[i]->addr = NULL;
1717 mutex_unlock(&kprobe_mutex);
1718
1719 synchronize_sched();
1720 for (i = 0; i < num; i++)
1721 if (kps[i]->addr)
1722 __unregister_kprobe_bottom(kps[i]);
1723}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001724EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001725
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726static struct notifier_block kprobe_exceptions_nb = {
1727 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001728 .priority = 0x7fffffff /* we need to be notified first */
1729};
1730
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001731unsigned long __weak arch_deref_entry_point(void *entry)
1732{
1733 return (unsigned long)entry;
1734}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001736int register_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001737{
1738 struct jprobe *jp;
1739 int ret = 0, i;
1740
1741 if (num <= 0)
1742 return -EINVAL;
1743 for (i = 0; i < num; i++) {
Namhyung Kim05662bd2010-09-15 10:04:27 +09001744 unsigned long addr, offset;
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001745 jp = jps[i];
1746 addr = arch_deref_entry_point(jp->entry);
1747
Namhyung Kim05662bd2010-09-15 10:04:27 +09001748 /* Verify probepoint is a function entry point */
1749 if (kallsyms_lookup_size_offset(addr, NULL, &offset) &&
1750 offset == 0) {
1751 jp->kp.pre_handler = setjmp_pre_handler;
1752 jp->kp.break_handler = longjmp_break_handler;
1753 ret = register_kprobe(&jp->kp);
1754 } else
1755 ret = -EINVAL;
Namhyung Kimedbaadb2010-09-15 10:04:26 +09001756
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001757 if (ret < 0) {
1758 if (i > 0)
1759 unregister_jprobes(jps, i);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001760 break;
1761 }
1762 }
1763 return ret;
1764}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001765EXPORT_SYMBOL_GPL(register_jprobes);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001766
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001767int register_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768{
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001769 return register_jprobes(&jp, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001771EXPORT_SYMBOL_GPL(register_jprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001773void unregister_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774{
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001775 unregister_jprobes(&jp, 1);
1776}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001777EXPORT_SYMBOL_GPL(unregister_jprobe);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001778
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001779void unregister_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001780{
1781 int i;
1782
1783 if (num <= 0)
1784 return;
1785 mutex_lock(&kprobe_mutex);
1786 for (i = 0; i < num; i++)
1787 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1788 jps[i]->kp.addr = NULL;
1789 mutex_unlock(&kprobe_mutex);
1790
1791 synchronize_sched();
1792 for (i = 0; i < num; i++) {
1793 if (jps[i]->kp.addr)
1794 __unregister_kprobe_bottom(&jps[i]->kp);
1795 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001797EXPORT_SYMBOL_GPL(unregister_jprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001799#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001800/*
1801 * This kprobe pre_handler is registered with every kretprobe. When probe
1802 * hits it will set up the return probe.
1803 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001804static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08001805{
1806 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001807 unsigned long hash, flags = 0;
1808 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001809
Masami Hiramatsuf96f5672014-08-04 03:10:16 +00001810 /*
1811 * To avoid deadlocks, prohibit return probing in NMI contexts,
1812 * just skip the probe and increase the (inexact) 'nmissed'
1813 * statistical counter, so that the user is informed that
1814 * something happened:
1815 */
1816 if (unlikely(in_nmi())) {
1817 rp->nmissed++;
1818 return 0;
1819 }
1820
1821 /* TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001822 hash = hash_ptr(current, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001823 raw_spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001824 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001825 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001826 struct kretprobe_instance, hlist);
1827 hlist_del(&ri->hlist);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001828 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001829
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001830 ri->rp = rp;
1831 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001832
Jiang Liu55ca6142012-02-03 15:37:16 -08001833 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1834 raw_spin_lock_irqsave(&rp->lock, flags);
1835 hlist_add_head(&ri->hlist, &rp->free_instances);
1836 raw_spin_unlock_irqrestore(&rp->lock, flags);
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001837 return 0;
Jiang Liu55ca6142012-02-03 15:37:16 -08001838 }
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001839
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001840 arch_prepare_kretprobe(ri, regs);
1841
1842 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001843 INIT_HLIST_NODE(&ri->hlist);
1844 kretprobe_table_lock(hash, &flags);
1845 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1846 kretprobe_table_unlock(hash, &flags);
1847 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001848 rp->nmissed++;
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001849 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001850 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001851 return 0;
1852}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001853NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08001854
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001855int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001856{
1857 int ret = 0;
1858 struct kretprobe_instance *inst;
1859 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001860 void *addr;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001861
1862 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001863 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001864 if (IS_ERR(addr))
1865 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001866
1867 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1868 if (kretprobe_blacklist[i].addr == addr)
1869 return -EINVAL;
1870 }
1871 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001872
1873 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001874 rp->kp.post_handler = NULL;
1875 rp->kp.fault_handler = NULL;
1876 rp->kp.break_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001877
1878 /* Pre-allocate memory for max kretprobe instances */
1879 if (rp->maxactive <= 0) {
1880#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001881 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001882#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301883 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001884#endif
1885 }
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001886 raw_spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001887 INIT_HLIST_HEAD(&rp->free_instances);
1888 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001889 inst = kmalloc(sizeof(struct kretprobe_instance) +
1890 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001891 if (inst == NULL) {
1892 free_rp_inst(rp);
1893 return -ENOMEM;
1894 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001895 INIT_HLIST_NODE(&inst->hlist);
1896 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001897 }
1898
1899 rp->nmissed = 0;
1900 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001901 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001902 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001903 free_rp_inst(rp);
1904 return ret;
1905}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001906EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001907
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001908int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001909{
1910 int ret = 0, i;
1911
1912 if (num <= 0)
1913 return -EINVAL;
1914 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001915 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001916 if (ret < 0) {
1917 if (i > 0)
1918 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001919 break;
1920 }
1921 }
1922 return ret;
1923}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001924EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001925
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001926void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001927{
1928 unregister_kretprobes(&rp, 1);
1929}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001930EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001931
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001932void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001933{
1934 int i;
1935
1936 if (num <= 0)
1937 return;
1938 mutex_lock(&kprobe_mutex);
1939 for (i = 0; i < num; i++)
1940 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1941 rps[i]->kp.addr = NULL;
1942 mutex_unlock(&kprobe_mutex);
1943
1944 synchronize_sched();
1945 for (i = 0; i < num; i++) {
1946 if (rps[i]->kp.addr) {
1947 __unregister_kprobe_bottom(&rps[i]->kp);
1948 cleanup_rp_inst(rps[i]);
1949 }
1950 }
1951}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001952EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001953
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001954#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001955int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001956{
1957 return -ENOSYS;
1958}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001959EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001960
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001961int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001962{
1963 return -ENOSYS;
1964}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001965EXPORT_SYMBOL_GPL(register_kretprobes);
1966
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001967void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001968{
1969}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001970EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001971
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001972void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001973{
1974}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001975EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001976
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001977static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08001978{
1979 return 0;
1980}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001981NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001982
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001983#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07001984
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001985/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001986static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001987{
1988 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001989
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001990 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001991 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001992 /*
1993 * If this is an aggr_kprobe, we have to list all the
1994 * chained probes and mark them GONE.
1995 */
1996 list_for_each_entry_rcu(kp, &p->list, list)
1997 kp->flags |= KPROBE_FLAG_GONE;
1998 p->post_handler = NULL;
1999 p->break_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002000 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002001 }
2002 /*
2003 * Here, we can remove insn_slot safely, because no thread calls
2004 * the original probed function (which will be freed soon) any more.
2005 */
2006 arch_remove_kprobe(p);
2007}
2008
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002009/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002010int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002011{
2012 int ret = 0;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002013
2014 mutex_lock(&kprobe_mutex);
2015
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002016 /* Disable this kprobe */
2017 if (__disable_kprobe(kp) == NULL)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002018 ret = -EINVAL;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002019
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002020 mutex_unlock(&kprobe_mutex);
2021 return ret;
2022}
2023EXPORT_SYMBOL_GPL(disable_kprobe);
2024
2025/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002026int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002027{
2028 int ret = 0;
2029 struct kprobe *p;
2030
2031 mutex_lock(&kprobe_mutex);
2032
2033 /* Check whether specified probe is valid. */
2034 p = __get_valid_kprobe(kp);
2035 if (unlikely(p == NULL)) {
2036 ret = -EINVAL;
2037 goto out;
2038 }
2039
2040 if (kprobe_gone(kp)) {
2041 /* This kprobe has gone, we couldn't enable it. */
2042 ret = -EINVAL;
2043 goto out;
2044 }
2045
2046 if (p != kp)
2047 kp->flags &= ~KPROBE_FLAG_DISABLED;
2048
2049 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2050 p->flags &= ~KPROBE_FLAG_DISABLED;
2051 arm_kprobe(p);
2052 }
2053out:
2054 mutex_unlock(&kprobe_mutex);
2055 return ret;
2056}
2057EXPORT_SYMBOL_GPL(enable_kprobe);
2058
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002059void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002060{
2061 printk(KERN_WARNING "Dumping kprobe:\n");
2062 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2063 kp->symbol_name, kp->addr, kp->offset);
2064}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002065NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002066
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002067/*
2068 * Lookup and populate the kprobe_blacklist.
2069 *
2070 * Unlike the kretprobe blacklist, we'll need to determine
2071 * the range of addresses that belong to the said functions,
2072 * since a kprobe need not necessarily be at the beginning
2073 * of a function.
2074 */
2075static int __init populate_kprobe_blacklist(unsigned long *start,
2076 unsigned long *end)
2077{
2078 unsigned long *iter;
2079 struct kprobe_blacklist_entry *ent;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002080 unsigned long entry, offset = 0, size = 0;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002081
2082 for (iter = start; iter < end; iter++) {
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002083 entry = arch_deref_entry_point((void *)*iter);
2084
2085 if (!kernel_text_address(entry) ||
2086 !kallsyms_lookup_size_offset(entry, &size, &offset)) {
2087 pr_err("Failed to find blacklist at %p\n",
2088 (void *)entry);
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002089 continue;
2090 }
2091
2092 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2093 if (!ent)
2094 return -ENOMEM;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002095 ent->start_addr = entry;
2096 ent->end_addr = entry + size;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002097 INIT_LIST_HEAD(&ent->list);
2098 list_add_tail(&ent->list, &kprobe_blacklist);
2099 }
2100 return 0;
2101}
2102
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002103/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002104static int kprobes_module_callback(struct notifier_block *nb,
2105 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002106{
2107 struct module *mod = data;
2108 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002109 struct kprobe *p;
2110 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002111 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002112
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002113 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002114 return NOTIFY_DONE;
2115
2116 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002117 * When MODULE_STATE_GOING was notified, both of module .text and
2118 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2119 * notified, only .init.text section would be freed. We need to
2120 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002121 */
2122 mutex_lock(&kprobe_mutex);
2123 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2124 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002125 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002126 if (within_module_init((unsigned long)p->addr, mod) ||
2127 (checkcore &&
2128 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002129 /*
2130 * The vaddr this probe is installed will soon
2131 * be vfreed buy not synced to disk. Hence,
2132 * disarming the breakpoint isn't needed.
2133 */
2134 kill_kprobe(p);
2135 }
2136 }
2137 mutex_unlock(&kprobe_mutex);
2138 return NOTIFY_DONE;
2139}
2140
2141static struct notifier_block kprobe_module_nb = {
2142 .notifier_call = kprobes_module_callback,
2143 .priority = 0
2144};
2145
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002146/* Markers of _kprobe_blacklist section */
2147extern unsigned long __start_kprobe_blacklist[];
2148extern unsigned long __stop_kprobe_blacklist[];
2149
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150static int __init init_kprobes(void)
2151{
2152 int i, err = 0;
2153
2154 /* FIXME allocate the probe table, currently defined statically */
2155 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002156 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002158 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02002159 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07002160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002162 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2163 __stop_kprobe_blacklist);
2164 if (err) {
2165 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2166 pr_err("Please take care of using kprobes.\n");
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002167 }
2168
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002169 if (kretprobe_blacklist_size) {
2170 /* lookup the function address from its name */
2171 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2172 kprobe_lookup_name(kretprobe_blacklist[i].name,
2173 kretprobe_blacklist[i].addr);
2174 if (!kretprobe_blacklist[i].addr)
2175 printk("kretprobe: lookup failed: %s\n",
2176 kretprobe_blacklist[i].name);
2177 }
2178 }
2179
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002180#if defined(CONFIG_OPTPROBES)
2181#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002182 /* Init kprobe_optinsn_slots */
2183 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2184#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002185 /* By default, kprobes can be optimized */
2186 kprobes_allow_optimization = true;
2187#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002188
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002189 /* By default, kprobes are armed */
2190 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002191
Rusty Lynch67729262005-07-05 18:54:50 -07002192 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002193 if (!err)
2194 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002195 if (!err)
2196 err = register_module_notifier(&kprobe_module_nb);
2197
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002198 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002199
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002200 if (!err)
2201 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002202 return err;
2203}
2204
Srinivasa Ds346fd592007-02-20 13:57:54 -08002205#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002206static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002207 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002208{
2209 char *kprobe_type;
2210
2211 if (p->pre_handler == pre_handler_kretprobe)
2212 kprobe_type = "r";
2213 else if (p->pre_handler == setjmp_pre_handler)
2214 kprobe_type = "j";
2215 else
2216 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002217
Srinivasa Ds346fd592007-02-20 13:57:54 -08002218 if (sym)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002219 seq_printf(pi, "%p %s %s+0x%x %s ",
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002220 p->addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002221 (modname ? modname : " "));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002222 else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002223 seq_printf(pi, "%p %s %p ",
2224 p->addr, kprobe_type, p->addr);
2225
2226 if (!pp)
2227 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002228 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002229 (kprobe_gone(p) ? "[GONE]" : ""),
2230 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002231 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2232 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002233}
2234
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002235static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002236{
2237 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2238}
2239
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002240static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002241{
2242 (*pos)++;
2243 if (*pos >= KPROBE_TABLE_SIZE)
2244 return NULL;
2245 return pos;
2246}
2247
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002248static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002249{
2250 /* Nothing to do */
2251}
2252
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002253static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002254{
2255 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002256 struct kprobe *p, *kp;
2257 const char *sym = NULL;
2258 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002259 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002260 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002261
2262 head = &kprobe_table[i];
2263 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002264 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002265 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002266 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002267 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002268 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002269 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002270 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002271 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002272 }
2273 preempt_enable();
2274 return 0;
2275}
2276
James Morris88e9d342009-09-22 16:43:43 -07002277static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002278 .start = kprobe_seq_start,
2279 .next = kprobe_seq_next,
2280 .stop = kprobe_seq_stop,
2281 .show = show_kprobe_addr
2282};
2283
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002284static int kprobes_open(struct inode *inode, struct file *filp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002285{
2286 return seq_open(filp, &kprobes_seq_ops);
2287}
2288
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002289static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002290 .open = kprobes_open,
2291 .read = seq_read,
2292 .llseek = seq_lseek,
2293 .release = seq_release,
2294};
2295
Masami Hiramatsu63724742014-04-17 17:18:49 +09002296/* kprobes/blacklist -- shows which functions can not be probed */
2297static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2298{
2299 return seq_list_start(&kprobe_blacklist, *pos);
2300}
2301
2302static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2303{
2304 return seq_list_next(v, &kprobe_blacklist, pos);
2305}
2306
2307static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2308{
2309 struct kprobe_blacklist_entry *ent =
2310 list_entry(v, struct kprobe_blacklist_entry, list);
2311
2312 seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
2313 (void *)ent->end_addr, (void *)ent->start_addr);
2314 return 0;
2315}
2316
2317static const struct seq_operations kprobe_blacklist_seq_ops = {
2318 .start = kprobe_blacklist_seq_start,
2319 .next = kprobe_blacklist_seq_next,
2320 .stop = kprobe_seq_stop, /* Reuse void function */
2321 .show = kprobe_blacklist_seq_show,
2322};
2323
2324static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2325{
2326 return seq_open(filp, &kprobe_blacklist_seq_ops);
2327}
2328
2329static const struct file_operations debugfs_kprobe_blacklist_ops = {
2330 .open = kprobe_blacklist_open,
2331 .read = seq_read,
2332 .llseek = seq_lseek,
2333 .release = seq_release,
2334};
2335
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002336static void arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002337{
2338 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002339 struct kprobe *p;
2340 unsigned int i;
2341
2342 mutex_lock(&kprobe_mutex);
2343
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002344 /* If kprobes are armed, just return */
2345 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002346 goto already_enabled;
2347
Wang Nan977ad482015-02-13 14:40:24 -08002348 /*
2349 * optimize_kprobe() called by arm_kprobe() checks
2350 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2351 * arm_kprobe.
2352 */
2353 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002354 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002355 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2356 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002357 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002358 if (!kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002359 arm_kprobe(p);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002360 }
2361
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002362 printk(KERN_INFO "Kprobes globally enabled\n");
2363
2364already_enabled:
2365 mutex_unlock(&kprobe_mutex);
2366 return;
2367}
2368
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002369static void disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002370{
2371 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002372 struct kprobe *p;
2373 unsigned int i;
2374
2375 mutex_lock(&kprobe_mutex);
2376
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002377 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002378 if (kprobes_all_disarmed) {
2379 mutex_unlock(&kprobe_mutex);
2380 return;
2381 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002382
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002383 kprobes_all_disarmed = true;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002384 printk(KERN_INFO "Kprobes globally disabled\n");
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002385
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002386 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2387 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002388 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002389 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002390 disarm_kprobe(p, false);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002391 }
2392 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002393 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002394
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002395 /* Wait for disarming all kprobes by optimizer */
2396 wait_for_kprobe_optimizer();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002397}
2398
2399/*
2400 * XXX: The debugfs bool file interface doesn't allow for callbacks
2401 * when the bool state is switched. We can reuse that facility when
2402 * available
2403 */
2404static ssize_t read_enabled_file_bool(struct file *file,
2405 char __user *user_buf, size_t count, loff_t *ppos)
2406{
2407 char buf[3];
2408
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002409 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002410 buf[0] = '1';
2411 else
2412 buf[0] = '0';
2413 buf[1] = '\n';
2414 buf[2] = 0x00;
2415 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2416}
2417
2418static ssize_t write_enabled_file_bool(struct file *file,
2419 const char __user *user_buf, size_t count, loff_t *ppos)
2420{
2421 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002422 size_t buf_size;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002423
2424 buf_size = min(count, (sizeof(buf)-1));
2425 if (copy_from_user(buf, user_buf, buf_size))
2426 return -EFAULT;
2427
Mathias Krause10fb46d2013-07-03 15:05:39 -07002428 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002429 switch (buf[0]) {
2430 case 'y':
2431 case 'Y':
2432 case '1':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002433 arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002434 break;
2435 case 'n':
2436 case 'N':
2437 case '0':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002438 disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002439 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002440 default:
2441 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002442 }
2443
2444 return count;
2445}
2446
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002447static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002448 .read = read_enabled_file_bool,
2449 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002450 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002451};
2452
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002453static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002454{
2455 struct dentry *dir, *file;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002456 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002457
2458 dir = debugfs_create_dir("kprobes", NULL);
2459 if (!dir)
2460 return -ENOMEM;
2461
Masami Hiramatsu5749cd62018-04-28 21:35:01 +09002462 file = debugfs_create_file("list", 0400, dir, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002463 &debugfs_kprobes_operations);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002464 if (!file)
2465 goto error;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002466
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002467 file = debugfs_create_file("enabled", 0600, dir,
2468 &value, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002469 if (!file)
2470 goto error;
2471
Masami Hiramatsu5749cd62018-04-28 21:35:01 +09002472 file = debugfs_create_file("blacklist", 0400, dir, NULL,
Masami Hiramatsu63724742014-04-17 17:18:49 +09002473 &debugfs_kprobe_blacklist_ops);
2474 if (!file)
2475 goto error;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002476
Srinivasa Ds346fd592007-02-20 13:57:54 -08002477 return 0;
Masami Hiramatsu63724742014-04-17 17:18:49 +09002478
2479error:
2480 debugfs_remove(dir);
2481 return -ENOMEM;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002482}
2483
2484late_initcall(debugfs_kprobe_init);
2485#endif /* CONFIG_DEBUG_FS */
2486
2487module_init(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002489/* defined in arch/.../kernel/kprobes.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490EXPORT_SYMBOL_GPL(jprobe_return);