blob: 3938e4670b89bcff4ef328e0ccde3daf7df09080 [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);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900564
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900565 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900566 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900567 kick_kprobe_optimizer();
Masami Hiramatsu354fb592020-05-12 17:02:56 +0900568
569 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900570}
571
572/* Wait for completing optimization and unoptimization */
Thomas Gleixnerdd0023d2017-05-17 10:19:49 +0200573void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900574{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800575 mutex_lock(&kprobe_mutex);
576
577 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
578 mutex_unlock(&kprobe_mutex);
579
580 /* this will also make optimizing_work execute immmediately */
581 flush_delayed_work(&optimizing_work);
582 /* @optimizing_work might not have been queued yet, relax */
583 cpu_relax();
584
585 mutex_lock(&kprobe_mutex);
586 }
587
588 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500589}
590
591/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900592static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500593{
594 struct optimized_kprobe *op;
595
596 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500597 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500598 (kprobe_disabled(p) || kprobes_all_disarmed))
599 return;
600
601 /* Both of break_handler and post_handler are not supported. */
602 if (p->break_handler || p->post_handler)
603 return;
604
605 op = container_of(p, struct optimized_kprobe, kp);
606
607 /* Check there is no other kprobes at the optimized instructions */
608 if (arch_check_optimized_kprobe(op) < 0)
609 return;
610
611 /* Check if it is already optimized. */
612 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
613 return;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500614 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900615
616 if (!list_empty(&op->list))
617 /* This is under unoptimizing. Just dequeue the probe */
618 list_del_init(&op->list);
619 else {
620 list_add(&op->list, &optimizing_list);
621 kick_kprobe_optimizer();
622 }
623}
624
625/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900626static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900627{
628 get_online_cpus();
629 arch_unoptimize_kprobe(op);
630 put_online_cpus();
631 if (kprobe_disabled(&op->kp))
632 arch_disarm_kprobe(&op->kp);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500633}
634
635/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900636static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500637{
638 struct optimized_kprobe *op;
639
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900640 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
641 return; /* This is not an optprobe nor optimized */
642
643 op = container_of(p, struct optimized_kprobe, kp);
644 if (!kprobe_optimized(p)) {
645 /* Unoptimized or unoptimizing case */
646 if (force && !list_empty(&op->list)) {
647 /*
648 * Only if this is unoptimizing kprobe and forced,
649 * forcibly unoptimize it. (No need to unoptimize
650 * unoptimized kprobe again :)
651 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500652 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900653 force_unoptimize_kprobe(op);
654 }
655 return;
656 }
657
658 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
659 if (!list_empty(&op->list)) {
660 /* Dequeue from the optimization queue */
661 list_del_init(&op->list);
662 return;
663 }
664 /* Optimized kprobe case */
665 if (force)
666 /* Forcibly update the code: this is a special case */
667 force_unoptimize_kprobe(op);
668 else {
669 list_add(&op->list, &unoptimizing_list);
670 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500671 }
672}
673
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900674/* Cancel unoptimizing for reusing */
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900675static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900676{
677 struct optimized_kprobe *op;
678
679 BUG_ON(!kprobe_unused(ap));
680 /*
681 * Unused kprobe MUST be on the way of delayed unoptimizing (means
682 * there is still a relative jump) and disabled.
683 */
684 op = container_of(ap, struct optimized_kprobe, kp);
685 if (unlikely(list_empty(&op->list)))
686 printk(KERN_WARNING "Warning: found a stray unused "
687 "aggrprobe@%p\n", ap->addr);
688 /* Enable the probe again */
689 ap->flags &= ~KPROBE_FLAG_DISABLED;
690 /* Optimize it again (remove from op->list) */
Masami Hiramatsu8a779c42019-04-15 15:01:25 +0900691 if (!kprobe_optready(ap))
692 return -EINVAL;
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900693
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900694 optimize_kprobe(ap);
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900695 return 0;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900696}
697
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500698/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900699static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500700{
701 struct optimized_kprobe *op;
702
703 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900704 if (!list_empty(&op->list))
705 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500706 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900707 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900708
709 if (kprobe_unused(p)) {
710 /* Enqueue if it is unused */
711 list_add(&op->list, &freeing_list);
712 /*
713 * Remove unused probes from the hash list. After waiting
714 * for synchronization, this probe is reclaimed.
715 * (reclaiming is done by do_free_cleaned_kprobes().)
716 */
717 hlist_del_rcu(&op->kp.hlist);
718 }
719
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900720 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500721 arch_remove_optimized_kprobe(op);
722}
723
724/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900725static void prepare_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500726{
727 struct optimized_kprobe *op;
728
729 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsucbf6ab52015-01-05 19:29:32 +0800730 arch_prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500731}
732
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500733/* Allocate new optimized_kprobe and try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900734static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500735{
736 struct optimized_kprobe *op;
737
738 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
739 if (!op)
740 return NULL;
741
742 INIT_LIST_HEAD(&op->list);
743 op->kp.addr = p->addr;
Masami Hiramatsucbf6ab52015-01-05 19:29:32 +0800744 arch_prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500745
746 return &op->kp;
747}
748
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900749static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500750
751/*
752 * Prepare an optimized_kprobe and optimize it
753 * NOTE: p must be a normal registered kprobe
754 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900755static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500756{
757 struct kprobe *ap;
758 struct optimized_kprobe *op;
759
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900760 /* Impossible to optimize ftrace-based kprobe */
761 if (kprobe_ftrace(p))
762 return;
763
Masami Hiramatsu25764282012-06-05 19:28:26 +0900764 /* For preparing optimization, jump_label_text_reserved() is called */
765 jump_label_lock();
766 mutex_lock(&text_mutex);
767
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500768 ap = alloc_aggr_kprobe(p);
769 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900770 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500771
772 op = container_of(ap, struct optimized_kprobe, kp);
773 if (!arch_prepared_optinsn(&op->optinsn)) {
774 /* If failed to setup optimizing, fallback to kprobe */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900775 arch_remove_optimized_kprobe(op);
776 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900777 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500778 }
779
780 init_aggr_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900781 optimize_kprobe(ap); /* This just kicks optimizer thread */
782
783out:
784 mutex_unlock(&text_mutex);
785 jump_label_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500786}
787
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500788#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900789static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500790{
791 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500792 struct kprobe *p;
793 unsigned int i;
794
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900795 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500796 /* If optimization is already allowed, just return */
797 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900798 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500799
800 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500801 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
802 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800803 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500804 if (!kprobe_disabled(p))
805 optimize_kprobe(p);
806 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500807 printk(KERN_INFO "Kprobes globally optimized\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900808out:
809 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500810}
811
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900812static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500813{
814 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500815 struct kprobe *p;
816 unsigned int i;
817
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900818 mutex_lock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500819 /* If optimization is already prohibited, just return */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900820 if (!kprobes_allow_optimization) {
821 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500822 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900823 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500824
825 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500826 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
827 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -0800828 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500829 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900830 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500831 }
832 }
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900833 mutex_unlock(&kprobe_mutex);
834
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900835 /* Wait for unoptimizing completion */
836 wait_for_kprobe_optimizer();
837 printk(KERN_INFO "Kprobes globally unoptimized\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500838}
839
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900840static DEFINE_MUTEX(kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500841int sysctl_kprobes_optimization;
842int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
843 void __user *buffer, size_t *length,
844 loff_t *ppos)
845{
846 int ret;
847
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900848 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500849 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
850 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
851
852 if (sysctl_kprobes_optimization)
853 optimize_all_kprobes();
854 else
855 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900856 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500857
858 return ret;
859}
860#endif /* CONFIG_SYSCTL */
861
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900862/* Put a breakpoint for a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900863static void __arm_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500864{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900865 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500866
867 /* Check collision with other optimized kprobes */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900868 _p = get_optimized_kprobe((unsigned long)p->addr);
869 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900870 /* Fallback to unoptimized kprobe */
871 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500872
873 arch_arm_kprobe(p);
874 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
875}
876
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900877/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900878static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500879{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900880 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500881
Wang Nan69d54b92015-02-13 14:40:26 -0800882 /* Try to unoptimize */
883 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500884
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900885 if (!kprobe_queued(p)) {
886 arch_disarm_kprobe(p);
887 /* If another kprobe was blocked, optimize it. */
888 _p = get_optimized_kprobe((unsigned long)p->addr);
889 if (unlikely(_p) && reopt)
890 optimize_kprobe(_p);
891 }
892 /* TODO: reoptimize others after unoptimized this probe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500893}
894
895#else /* !CONFIG_OPTPROBES */
896
897#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900898#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500899#define kill_optimized_kprobe(p) do {} while (0)
900#define prepare_optimized_kprobe(p) do {} while (0)
901#define try_to_optimize_kprobe(p) do {} while (0)
902#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900903#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
904#define kprobe_disarmed(p) kprobe_disabled(p)
905#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500906
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900907static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900908{
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900909 /*
910 * If the optimized kprobe is NOT supported, the aggr kprobe is
911 * released at the same time that the last aggregated kprobe is
912 * unregistered.
913 * Thus there should be no chance to reuse unused kprobe.
914 */
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900915 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +0900916 return -EINVAL;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900917}
918
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900919static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500920{
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900921 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500922 kfree(p);
923}
924
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900925static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500926{
927 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
928}
929#endif /* CONFIG_OPTPROBES */
930
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900931#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900932static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +0900933 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -0500934 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900935};
936static int kprobe_ftrace_enabled;
937
938/* Must ensure p->addr is really on ftrace */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900939static int prepare_kprobe(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900940{
941 if (!kprobe_ftrace(p))
942 return arch_prepare_kprobe(p);
943
944 return arch_prepare_kprobe_ftrace(p);
945}
946
947/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900948static void arm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900949{
950 int ret;
951
952 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
953 (unsigned long)p->addr, 0, 0);
954 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
955 kprobe_ftrace_enabled++;
956 if (kprobe_ftrace_enabled == 1) {
957 ret = register_ftrace_function(&kprobe_ftrace_ops);
958 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
959 }
960}
961
962/* Caller must lock kprobe_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900963static void disarm_kprobe_ftrace(struct kprobe *p)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900964{
965 int ret;
966
967 kprobe_ftrace_enabled--;
968 if (kprobe_ftrace_enabled == 0) {
969 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
970 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
971 }
972 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
973 (unsigned long)p->addr, 1, 0);
974 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
975}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +0900976#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900977#define prepare_kprobe(p) arch_prepare_kprobe(p)
978#define arm_kprobe_ftrace(p) do {} while (0)
979#define disarm_kprobe_ftrace(p) do {} while (0)
980#endif
981
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400982/* Arm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900983static void arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400984{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900985 if (unlikely(kprobe_ftrace(kp))) {
986 arm_kprobe_ftrace(kp);
987 return;
988 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500989 /*
990 * Here, since __arm_kprobe() doesn't use stop_machine(),
991 * this doesn't cause deadlock on text_mutex. So, we don't
992 * need get_online_cpus().
993 */
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400994 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500995 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -0400996 mutex_unlock(&text_mutex);
997}
998
999/* Disarm a kprobe with text_mutex */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001000static void disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001001{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001002 if (unlikely(kprobe_ftrace(kp))) {
1003 disarm_kprobe_ftrace(kp);
1004 return;
1005 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001006 /* Ditto */
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001007 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001008 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001009 mutex_unlock(&text_mutex);
1010}
1011
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001012/*
1013 * Aggregate handlers for multiple kprobes support - these handlers
1014 * take care of invoking the individual kprobe handlers on p->list
1015 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001016static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001017{
1018 struct kprobe *kp;
1019
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001020 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001021 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001022 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001023 if (kp->pre_handler(kp, regs))
1024 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001025 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001026 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001027 }
1028 return 0;
1029}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001030NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001031
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001032static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1033 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001034{
1035 struct kprobe *kp;
1036
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001037 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001038 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001039 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001040 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001041 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001042 }
1043 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001044}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001045NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001046
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001047static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1048 int trapnr)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001049{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001050 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001051
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001052 /*
1053 * if we faulted "during" the execution of a user specified
1054 * probe handler, invoke just that probe's fault handler
1055 */
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001056 if (cur && cur->fault_handler) {
1057 if (cur->fault_handler(cur, regs, trapnr))
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001058 return 1;
1059 }
1060 return 0;
1061}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001062NOKPROBE_SYMBOL(aggr_fault_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001063
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001064static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001065{
Christoph Lameterb76834b2010-12-06 11:16:25 -06001066 struct kprobe *cur = __this_cpu_read(kprobe_instance);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001067 int ret = 0;
1068
1069 if (cur && cur->break_handler) {
1070 if (cur->break_handler(cur, regs))
1071 ret = 1;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001072 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001073 reset_kprobe_instance();
1074 return ret;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001075}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001076NOKPROBE_SYMBOL(aggr_break_handler);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001077
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001078/* Walks the list and increments nmissed count for multiprobe case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001079void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001080{
1081 struct kprobe *kp;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001082 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001083 p->nmissed++;
1084 } else {
1085 list_for_each_entry_rcu(kp, &p->list, list)
1086 kp->nmissed++;
1087 }
1088 return;
1089}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001090NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001091
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001092void recycle_rp_inst(struct kretprobe_instance *ri,
1093 struct hlist_head *head)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001094{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001095 struct kretprobe *rp = ri->rp;
1096
Hien Nguyenb94cce92005-06-23 00:09:19 -07001097 /* remove rp inst off the rprobe_inst_table */
1098 hlist_del(&ri->hlist);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001099 INIT_HLIST_NODE(&ri->hlist);
1100 if (likely(rp)) {
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001101 raw_spin_lock(&rp->lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001102 hlist_add_head(&ri->hlist, &rp->free_instances);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001103 raw_spin_unlock(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001104 } else
1105 /* Unregistering */
bibo,mao99219a32006-10-02 02:17:35 -07001106 hlist_add_head(&ri->hlist, head);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001107}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001108NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001109
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001110void kretprobe_hash_lock(struct task_struct *tsk,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001111 struct hlist_head **head, unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001112__acquires(hlist_lock)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001113{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001114 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001115 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001116
1117 *head = &kretprobe_inst_table[hash];
1118 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001119 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001120}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001121NOKPROBE_SYMBOL(kretprobe_hash_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001122
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001123static void kretprobe_table_lock(unsigned long hash,
1124 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001125__acquires(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001126{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001127 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1128 raw_spin_lock_irqsave(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001129}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001130NOKPROBE_SYMBOL(kretprobe_table_lock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001131
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001132void kretprobe_hash_unlock(struct task_struct *tsk,
1133 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001134__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001135{
1136 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001137 raw_spinlock_t *hlist_lock;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001138
1139 hlist_lock = kretprobe_table_lock_ptr(hash);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001140 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001141}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001142NOKPROBE_SYMBOL(kretprobe_hash_unlock);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001143
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001144static void kretprobe_table_unlock(unsigned long hash,
1145 unsigned long *flags)
Namhyung Kim635c17c2010-09-15 10:04:30 +09001146__releases(hlist_lock)
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001147{
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001148 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1149 raw_spin_unlock_irqrestore(hlist_lock, *flags);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001150}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001151NOKPROBE_SYMBOL(kretprobe_table_unlock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001152
Jiri Olsaed61e8c2020-05-12 17:03:18 +09001153struct kprobe kprobe_busy = {
1154 .addr = (void *) get_kprobe,
1155};
1156
1157void kprobe_busy_begin(void)
1158{
1159 struct kprobe_ctlblk *kcb;
1160
1161 preempt_disable();
1162 __this_cpu_write(current_kprobe, &kprobe_busy);
1163 kcb = get_kprobe_ctlblk();
1164 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
1165}
1166
1167void kprobe_busy_end(void)
1168{
1169 __this_cpu_write(current_kprobe, NULL);
1170 preempt_enable();
1171}
1172
Hien Nguyenb94cce92005-06-23 00:09:19 -07001173/*
bibo maoc6fd91f2006-03-26 01:38:20 -08001174 * This function is called from finish_task_switch when task tk becomes dead,
1175 * so that we can recycle any function-return probe instances associated
1176 * with this task. These left over instances represent probed functions
1177 * that have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001178 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001179void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001180{
bibo,mao62c27be2006-10-02 02:17:33 -07001181 struct kretprobe_instance *ri;
bibo,mao99219a32006-10-02 02:17:35 -07001182 struct hlist_head *head, empty_rp;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001183 struct hlist_node *tmp;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001184 unsigned long hash, flags = 0;
Rusty Lynch802eae72005-06-27 15:17:08 -07001185
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001186 if (unlikely(!kprobes_initialized))
1187 /* Early boot. kretprobe_table_locks not yet initialized. */
1188 return;
1189
Jiri Olsaed61e8c2020-05-12 17:03:18 +09001190 kprobe_busy_begin();
1191
Ananth N Mavinakayanahallid496aab2012-01-20 14:34:04 -08001192 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001193 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1194 head = &kretprobe_inst_table[hash];
1195 kretprobe_table_lock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001196 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -07001197 if (ri->task == tk)
bibo,mao99219a32006-10-02 02:17:35 -07001198 recycle_rp_inst(ri, &empty_rp);
bibo,mao62c27be2006-10-02 02:17:33 -07001199 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001200 kretprobe_table_unlock(hash, &flags);
Sasha Levinb67bfe02013-02-27 17:06:00 -08001201 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
bibo,mao99219a32006-10-02 02:17:35 -07001202 hlist_del(&ri->hlist);
1203 kfree(ri);
1204 }
Jiri Olsaed61e8c2020-05-12 17:03:18 +09001205
1206 kprobe_busy_end();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001207}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001208NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001209
Hien Nguyenb94cce92005-06-23 00:09:19 -07001210static inline void free_rp_inst(struct kretprobe *rp)
1211{
1212 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001213 struct hlist_node *next;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001214
Sasha Levinb67bfe02013-02-27 17:06:00 -08001215 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001216 hlist_del(&ri->hlist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001217 kfree(ri);
1218 }
1219}
1220
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001221static void cleanup_rp_inst(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001222{
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001223 unsigned long flags, hash;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001224 struct kretprobe_instance *ri;
Sasha Levinb67bfe02013-02-27 17:06:00 -08001225 struct hlist_node *next;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001226 struct hlist_head *head;
1227
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001228 /* No race here */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001229 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1230 kretprobe_table_lock(hash, &flags);
1231 head = &kretprobe_inst_table[hash];
Sasha Levinb67bfe02013-02-27 17:06:00 -08001232 hlist_for_each_entry_safe(ri, next, head, hlist) {
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001233 if (ri->rp == rp)
1234 ri->rp = NULL;
1235 }
1236 kretprobe_table_unlock(hash, &flags);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001237 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001238 free_rp_inst(rp);
1239}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001240NOKPROBE_SYMBOL(cleanup_rp_inst);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001241
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001242/*
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001243* Add the new probe to ap->list. Fail if this is the
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001244* second jprobe at the address - two jprobes can't coexist
1245*/
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001246static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001247{
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001248 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001249
1250 if (p->break_handler || p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001251 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001252
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001253 if (p->break_handler) {
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001254 if (ap->break_handler)
mao, bibo36721652006-06-26 00:25:22 -07001255 return -EEXIST;
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001256 list_add_tail_rcu(&p->list, &ap->list);
1257 ap->break_handler = aggr_break_handler;
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001258 } else
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001259 list_add_rcu(&p->list, &ap->list);
1260 if (p->post_handler && !ap->post_handler)
1261 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001262
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001263 return 0;
1264}
1265
1266/*
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001267 * Fill in the required fields of the "manager kprobe". Replace the
1268 * earlier kprobe in the hlist with the manager kprobe
1269 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001270static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001271{
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001272 /* Copy p's insn slot to ap */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001273 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001274 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001275 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001276 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001277 ap->pre_handler = aggr_pre_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001278 ap->fault_handler = aggr_fault_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001279 /* We don't care the kprobe which has gone. */
1280 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001281 ap->post_handler = aggr_post_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001282 if (p->break_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001283 ap->break_handler = aggr_break_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001284
1285 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001286 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001287
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001288 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001289 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001290}
1291
1292/*
1293 * This is the second or subsequent kprobe at the address - handle
1294 * the intricacies
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001295 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001296static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001297{
1298 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001299 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001300
Masami Hiramatsu25764282012-06-05 19:28:26 +09001301 /* For preparing optimization, jump_label_text_reserved() is called */
1302 jump_label_lock();
1303 /*
1304 * Get online CPUs to avoid text_mutex deadlock.with stop machine,
1305 * which is invoked by unoptimize_kprobe() in add_new_kprobe()
1306 */
1307 get_online_cpus();
1308 mutex_lock(&text_mutex);
1309
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001310 if (!kprobe_aggrprobe(orig_p)) {
1311 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1312 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001313 if (!ap) {
1314 ret = -ENOMEM;
1315 goto out;
1316 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001317 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +09001318 } else if (kprobe_unused(ap)) {
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001319 /* This probe is going to die. Rescue it */
Masami Hiramatsu6c8b1db2018-09-11 19:20:40 +09001320 ret = reuse_unused_kprobe(ap);
1321 if (ret)
1322 goto out;
1323 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001324
1325 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001326 /*
1327 * Attempting to insert new probe at the same location that
1328 * had a probe in the module vaddr area which already
1329 * freed. So, the instruction slot has already been
1330 * released. We need a new slot for the new probe.
1331 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001332 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001333 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001334 /*
1335 * Even if fail to allocate new slot, don't need to
1336 * free aggr_probe. It will be used next time, or
1337 * freed by unregister_kprobe.
1338 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001339 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001340
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001341 /* Prepare optimized instructions if possible. */
1342 prepare_optimized_kprobe(ap);
1343
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001344 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001345 * Clear gone flag to prevent allocating new slot again, and
1346 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001347 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001348 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1349 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001350 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001351
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001352 /* Copy ap's insn slot to p */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001353 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001354 ret = add_new_kprobe(ap, p);
1355
1356out:
1357 mutex_unlock(&text_mutex);
1358 put_online_cpus();
1359 jump_label_unlock();
1360
1361 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1362 ap->flags &= ~KPROBE_FLAG_DISABLED;
1363 if (!kprobes_all_disarmed)
1364 /* Arm the breakpoint again. */
1365 arm_kprobe(ap);
1366 }
1367 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001368}
1369
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001370bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1371{
1372 /* The __kprobes marked functions and entry code must not be probed */
1373 return addr >= (unsigned long)__kprobes_text_start &&
1374 addr < (unsigned long)__kprobes_text_end;
1375}
1376
Andy Lutomirskie5779e82015-07-30 20:32:40 -07001377bool within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001378{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001379 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001380
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001381 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001382 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001383 /*
1384 * If there exists a kprobe_blacklist, verify and
1385 * fail any probe registration in the prohibited area
1386 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001387 list_for_each_entry(ent, &kprobe_blacklist, list) {
1388 if (addr >= ent->start_addr && addr < ent->end_addr)
1389 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001390 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001391
1392 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001393}
1394
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001395/*
1396 * If we have a symbol_name argument, look it up and add the offset field
1397 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001398 * This returns encoded errors if it fails to look up symbol or invalid
1399 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001400 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001401static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001402{
1403 kprobe_opcode_t *addr = p->addr;
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001404
1405 if ((p->symbol_name && p->addr) ||
1406 (!p->symbol_name && !p->addr))
1407 goto invalid;
1408
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001409 if (p->symbol_name) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001410 kprobe_lookup_name(p->symbol_name, addr);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001411 if (!addr)
1412 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001413 }
1414
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001415 addr = (kprobe_opcode_t *)(((char *)addr) + p->offset);
1416 if (addr)
1417 return addr;
1418
1419invalid:
1420 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001421}
1422
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301423/* Check passed kprobe is valid and return kprobe in kprobe_table. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001424static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301425{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001426 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301427
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001428 ap = get_kprobe(p->addr);
1429 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301430 return NULL;
1431
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001432 if (p != ap) {
1433 list_for_each_entry_rcu(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301434 if (list_p == p)
1435 /* kprobe p is a valid probe */
1436 goto valid;
1437 return NULL;
1438 }
1439valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001440 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301441}
1442
1443/* Return error if the kprobe is being re-registered */
1444static inline int check_kprobe_rereg(struct kprobe *p)
1445{
1446 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301447
1448 mutex_lock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001449 if (__get_valid_kprobe(p))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301450 ret = -EINVAL;
1451 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001452
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301453 return ret;
1454}
1455
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001456int __weak arch_check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001458 unsigned long ftrace_addr;
1459
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001460 ftrace_addr = ftrace_location((unsigned long)p->addr);
1461 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001462#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001463 /* Given address is not on the instruction boundary */
1464 if ((unsigned long)p->addr != ftrace_addr)
1465 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001466 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001467#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001468 return -EINVAL;
1469#endif
1470 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001471 return 0;
1472}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001473
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001474static int check_kprobe_address_safe(struct kprobe *p,
1475 struct module **probed_mod)
1476{
1477 int ret;
1478
1479 ret = arch_check_ftrace_location(p);
1480 if (ret)
1481 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001482 jump_label_lock();
1483 preempt_disable();
1484
1485 /* Ensure it is not in reserved area nor out of text */
1486 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001487 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsud641e702019-09-03 20:08:21 +09001488 jump_label_text_reserved(p->addr, p->addr) ||
1489 find_bug((unsigned long)p->addr)) {
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001490 ret = -EINVAL;
1491 goto out;
1492 }
1493
1494 /* Check if are we probing a module */
1495 *probed_mod = __module_text_address((unsigned long) p->addr);
1496 if (*probed_mod) {
1497 /*
1498 * We must hold a refcount of the probed module while updating
1499 * its code to prohibit unexpected unloading.
1500 */
1501 if (unlikely(!try_module_get(*probed_mod))) {
1502 ret = -ENOENT;
1503 goto out;
1504 }
1505
1506 /*
1507 * If the module freed .init.text, we couldn't insert
1508 * kprobes in there.
1509 */
1510 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1511 (*probed_mod)->state != MODULE_STATE_COMING) {
1512 module_put(*probed_mod);
1513 *probed_mod = NULL;
1514 ret = -ENOENT;
1515 }
1516 }
1517out:
1518 preempt_enable();
1519 jump_label_unlock();
1520
1521 return ret;
1522}
1523
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001524int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001525{
1526 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001527 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001528 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001529 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001531 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001532 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001533 if (IS_ERR(addr))
1534 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001535 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001536
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301537 ret = check_kprobe_rereg(p);
1538 if (ret)
1539 return ret;
1540
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001541 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1542 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001543 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001544 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001545
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001546 ret = check_kprobe_address_safe(p, &probed_mod);
1547 if (ret)
1548 return ret;
1549
1550 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001551
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001552 old_p = get_kprobe(p->addr);
1553 if (old_p) {
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001554 /* Since this may unoptimize old_p, locking text_mutex. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001555 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556 goto out;
1557 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
Masami Hiramatsu25764282012-06-05 19:28:26 +09001559 mutex_lock(&text_mutex); /* Avoiding text modification */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001560 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001561 mutex_unlock(&text_mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001562 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001563 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001564
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001565 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001566 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1568
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001569 if (!kprobes_all_disarmed && !kprobe_disabled(p))
Masami Hiramatsu25764282012-06-05 19:28:26 +09001570 arm_kprobe(p);
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001571
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001572 /* Try to optimize kprobe */
1573 try_to_optimize_kprobe(p);
1574
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001576 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001577
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001578 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001579 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001580
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 return ret;
1582}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001583EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001585/* Check if all probes on the aggrprobe are disabled */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001586static int aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001587{
1588 struct kprobe *kp;
1589
1590 list_for_each_entry_rcu(kp, &ap->list, list)
1591 if (!kprobe_disabled(kp))
1592 /*
1593 * There is an active probe on the list.
1594 * We can't disable this ap.
1595 */
1596 return 0;
1597
1598 return 1;
1599}
1600
1601/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001602static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001603{
1604 struct kprobe *orig_p;
1605
1606 /* Get an original kprobe for return */
1607 orig_p = __get_valid_kprobe(p);
1608 if (unlikely(orig_p == NULL))
1609 return NULL;
1610
1611 if (!kprobe_disabled(p)) {
1612 /* Disable probe if it is a child probe */
1613 if (p != orig_p)
1614 p->flags |= KPROBE_FLAG_DISABLED;
1615
1616 /* Try to disarm and disable this/parent probe */
1617 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001618 /*
1619 * If kprobes_all_disarmed is set, orig_p
1620 * should have already been disarmed, so
1621 * skip unneed disarming process.
1622 */
1623 if (!kprobes_all_disarmed)
1624 disarm_kprobe(orig_p, true);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001625 orig_p->flags |= KPROBE_FLAG_DISABLED;
1626 }
1627 }
1628
1629 return orig_p;
1630}
1631
Masami Hiramatsu98616682008-04-28 02:14:28 -07001632/*
1633 * Unregister a kprobe without a scheduler synchronization.
1634 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001635static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001636{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001637 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001638
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001639 /* Disable kprobe. This will disarm it if needed. */
1640 ap = __disable_kprobe(p);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001641 if (ap == NULL)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001642 return -EINVAL;
1643
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001644 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001645 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001646 * This probe is an independent(and non-optimized) kprobe
1647 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001648 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001649 goto disarmed;
1650
1651 /* Following process expects this probe is an aggrprobe */
1652 WARN_ON(!kprobe_aggrprobe(ap));
1653
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001654 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1655 /*
1656 * !disarmed could be happen if the probe is under delayed
1657 * unoptimizing.
1658 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001659 goto disarmed;
1660 else {
1661 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001662 if (p->break_handler && !kprobe_gone(p))
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001663 ap->break_handler = NULL;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001664 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001665 list_for_each_entry_rcu(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001666 if ((list_p != p) && (list_p->post_handler))
1667 goto noclean;
1668 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001669 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001670 }
1671noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001672 /*
1673 * Remove from the aggrprobe: this path will do nothing in
1674 * __unregister_kprobe_bottom().
1675 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001676 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001677 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1678 /*
1679 * Try to optimize this probe again, because post
1680 * handler may have been changed.
1681 */
1682 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001683 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001684 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001685
1686disarmed:
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001687 BUG_ON(!kprobe_disarmed(ap));
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001688 hlist_del_rcu(&ap->hlist);
1689 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001690}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001691
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001692static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001693{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001694 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001695
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001696 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001697 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001698 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001699 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001700 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001701 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001702 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001703 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001704 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001705 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706}
1707
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001708int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001709{
1710 int i, ret = 0;
1711
1712 if (num <= 0)
1713 return -EINVAL;
1714 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001715 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001716 if (ret < 0) {
1717 if (i > 0)
1718 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001719 break;
1720 }
1721 }
1722 return ret;
1723}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001724EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001725
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001726void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001727{
1728 unregister_kprobes(&p, 1);
1729}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001730EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001731
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001732void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001733{
1734 int i;
1735
1736 if (num <= 0)
1737 return;
1738 mutex_lock(&kprobe_mutex);
1739 for (i = 0; i < num; i++)
1740 if (__unregister_kprobe_top(kps[i]) < 0)
1741 kps[i]->addr = NULL;
1742 mutex_unlock(&kprobe_mutex);
1743
1744 synchronize_sched();
1745 for (i = 0; i < num; i++)
1746 if (kps[i]->addr)
1747 __unregister_kprobe_bottom(kps[i]);
1748}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001749EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001750
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751static struct notifier_block kprobe_exceptions_nb = {
1752 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001753 .priority = 0x7fffffff /* we need to be notified first */
1754};
1755
Michael Ellerman3d7e3382007-07-19 01:48:11 -07001756unsigned long __weak arch_deref_entry_point(void *entry)
1757{
1758 return (unsigned long)entry;
1759}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001761int register_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001762{
1763 struct jprobe *jp;
1764 int ret = 0, i;
1765
1766 if (num <= 0)
1767 return -EINVAL;
1768 for (i = 0; i < num; i++) {
Namhyung Kim05662bd2010-09-15 10:04:27 +09001769 unsigned long addr, offset;
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001770 jp = jps[i];
1771 addr = arch_deref_entry_point(jp->entry);
1772
Namhyung Kim05662bd2010-09-15 10:04:27 +09001773 /* Verify probepoint is a function entry point */
1774 if (kallsyms_lookup_size_offset(addr, NULL, &offset) &&
1775 offset == 0) {
1776 jp->kp.pre_handler = setjmp_pre_handler;
1777 jp->kp.break_handler = longjmp_break_handler;
1778 ret = register_kprobe(&jp->kp);
1779 } else
1780 ret = -EINVAL;
Namhyung Kimedbaadb2010-09-15 10:04:26 +09001781
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001782 if (ret < 0) {
1783 if (i > 0)
1784 unregister_jprobes(jps, i);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001785 break;
1786 }
1787 }
1788 return ret;
1789}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001790EXPORT_SYMBOL_GPL(register_jprobes);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001791
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001792int register_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793{
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001794 return register_jprobes(&jp, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001796EXPORT_SYMBOL_GPL(register_jprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001798void unregister_jprobe(struct jprobe *jp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799{
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001800 unregister_jprobes(&jp, 1);
1801}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001802EXPORT_SYMBOL_GPL(unregister_jprobe);
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001803
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001804void unregister_jprobes(struct jprobe **jps, int num)
Masami Hiramatsu26b31c12008-04-28 02:14:29 -07001805{
1806 int i;
1807
1808 if (num <= 0)
1809 return;
1810 mutex_lock(&kprobe_mutex);
1811 for (i = 0; i < num; i++)
1812 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1813 jps[i]->kp.addr = NULL;
1814 mutex_unlock(&kprobe_mutex);
1815
1816 synchronize_sched();
1817 for (i = 0; i < num; i++) {
1818 if (jps[i]->kp.addr)
1819 __unregister_kprobe_bottom(&jps[i]->kp);
1820 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001822EXPORT_SYMBOL_GPL(unregister_jprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001824#ifdef CONFIG_KRETPROBES
Adrian Bunke65cefe2006-02-03 03:03:42 -08001825/*
1826 * This kprobe pre_handler is registered with every kretprobe. When probe
1827 * hits it will set up the return probe.
1828 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001829static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08001830{
1831 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001832 unsigned long hash, flags = 0;
1833 struct kretprobe_instance *ri;
Adrian Bunke65cefe2006-02-03 03:03:42 -08001834
Masami Hiramatsuf96f5672014-08-04 03:10:16 +00001835 /*
1836 * To avoid deadlocks, prohibit return probing in NMI contexts,
1837 * just skip the probe and increase the (inexact) 'nmissed'
1838 * statistical counter, so that the user is informed that
1839 * something happened:
1840 */
1841 if (unlikely(in_nmi())) {
1842 rp->nmissed++;
1843 return 0;
1844 }
1845
1846 /* TODO: consider to only swap the RA after the last pre_handler fired */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001847 hash = hash_ptr(current, KPROBE_HASH_BITS);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001848 raw_spin_lock_irqsave(&rp->lock, flags);
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001849 if (!hlist_empty(&rp->free_instances)) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001850 ri = hlist_entry(rp->free_instances.first,
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001851 struct kretprobe_instance, hlist);
1852 hlist_del(&ri->hlist);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001853 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001854
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001855 ri->rp = rp;
1856 ri->task = current;
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001857
Jiang Liu55ca6142012-02-03 15:37:16 -08001858 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1859 raw_spin_lock_irqsave(&rp->lock, flags);
1860 hlist_add_head(&ri->hlist, &rp->free_instances);
1861 raw_spin_unlock_irqrestore(&rp->lock, flags);
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001862 return 0;
Jiang Liu55ca6142012-02-03 15:37:16 -08001863 }
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001864
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001865 arch_prepare_kretprobe(ri, regs);
1866
1867 /* XXX(hch): why is there no hlist_move_head? */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001868 INIT_HLIST_NODE(&ri->hlist);
1869 kretprobe_table_lock(hash, &flags);
1870 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1871 kretprobe_table_unlock(hash, &flags);
1872 } else {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001873 rp->nmissed++;
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001874 raw_spin_unlock_irqrestore(&rp->lock, flags);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001875 }
Adrian Bunke65cefe2006-02-03 03:03:42 -08001876 return 0;
1877}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001878NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08001879
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001880int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001881{
1882 int ret = 0;
1883 struct kretprobe_instance *inst;
1884 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001885 void *addr;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001886
1887 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001888 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001889 if (IS_ERR(addr))
1890 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07001891
1892 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1893 if (kretprobe_blacklist[i].addr == addr)
1894 return -EINVAL;
1895 }
1896 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07001897
1898 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07001899 rp->kp.post_handler = NULL;
1900 rp->kp.fault_handler = NULL;
1901 rp->kp.break_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001902
1903 /* Pre-allocate memory for max kretprobe instances */
1904 if (rp->maxactive <= 0) {
1905#ifdef CONFIG_PREEMPT
Heiko Carstensc2ef6662009-12-21 13:02:24 +01001906 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07001907#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05301908 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001909#endif
1910 }
Thomas Gleixnerec4846082009-07-25 16:09:17 +02001911 raw_spin_lock_init(&rp->lock);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001912 INIT_HLIST_HEAD(&rp->free_instances);
1913 for (i = 0; i < rp->maxactive; i++) {
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08001914 inst = kmalloc(sizeof(struct kretprobe_instance) +
1915 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001916 if (inst == NULL) {
1917 free_rp_inst(rp);
1918 return -ENOMEM;
1919 }
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001920 INIT_HLIST_NODE(&inst->hlist);
1921 hlist_add_head(&inst->hlist, &rp->free_instances);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001922 }
1923
1924 rp->nmissed = 0;
1925 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001926 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001927 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001928 free_rp_inst(rp);
1929 return ret;
1930}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001931EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001932
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001933int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001934{
1935 int ret = 0, i;
1936
1937 if (num <= 0)
1938 return -EINVAL;
1939 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001940 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001941 if (ret < 0) {
1942 if (i > 0)
1943 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001944 break;
1945 }
1946 }
1947 return ret;
1948}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001949EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001950
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001951void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001952{
1953 unregister_kretprobes(&rp, 1);
1954}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001955EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001956
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001957void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001958{
1959 int i;
1960
1961 if (num <= 0)
1962 return;
1963 mutex_lock(&kprobe_mutex);
1964 for (i = 0; i < num; i++)
1965 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1966 rps[i]->kp.addr = NULL;
1967 mutex_unlock(&kprobe_mutex);
1968
1969 synchronize_sched();
1970 for (i = 0; i < num; i++) {
1971 if (rps[i]->kp.addr) {
1972 __unregister_kprobe_bottom(&rps[i]->kp);
1973 cleanup_rp_inst(rps[i]);
1974 }
1975 }
1976}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001977EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001978
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001979#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001980int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001981{
1982 return -ENOSYS;
1983}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001984EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001985
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001986int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001987{
1988 return -ENOSYS;
1989}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001990EXPORT_SYMBOL_GPL(register_kretprobes);
1991
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001992void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001993{
1994}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001995EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001996
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001997void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07001998{
1999}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002000EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002001
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002002static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002003{
2004 return 0;
2005}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002006NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002007
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002008#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002009
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002010/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002011static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002012{
2013 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002014
Muchun Song4029fed2020-09-18 21:20:21 -07002015 if (WARN_ON_ONCE(kprobe_gone(p)))
2016 return;
2017
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002018 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002019 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002020 /*
2021 * If this is an aggr_kprobe, we have to list all the
2022 * chained probes and mark them GONE.
2023 */
2024 list_for_each_entry_rcu(kp, &p->list, list)
2025 kp->flags |= KPROBE_FLAG_GONE;
2026 p->post_handler = NULL;
2027 p->break_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002028 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002029 }
2030 /*
2031 * Here, we can remove insn_slot safely, because no thread calls
2032 * the original probed function (which will be freed soon) any more.
2033 */
2034 arch_remove_kprobe(p);
Muchun Songad363ad2020-07-28 14:45:36 +08002035
2036 /*
2037 * The module is going away. We should disarm the kprobe which
Masami Hiramatsu9b55d842020-09-01 00:12:07 +09002038 * is using ftrace, because ftrace framework is still available at
2039 * MODULE_STATE_GOING notification.
Muchun Songad363ad2020-07-28 14:45:36 +08002040 */
Masami Hiramatsu9b55d842020-09-01 00:12:07 +09002041 if (kprobe_ftrace(p) && !kprobe_disabled(p) && !kprobes_all_disarmed)
Muchun Songad363ad2020-07-28 14:45:36 +08002042 disarm_kprobe_ftrace(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002043}
2044
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002045/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002046int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002047{
2048 int ret = 0;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002049
2050 mutex_lock(&kprobe_mutex);
2051
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002052 /* Disable this kprobe */
2053 if (__disable_kprobe(kp) == NULL)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002054 ret = -EINVAL;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002055
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002056 mutex_unlock(&kprobe_mutex);
2057 return ret;
2058}
2059EXPORT_SYMBOL_GPL(disable_kprobe);
2060
2061/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002062int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002063{
2064 int ret = 0;
2065 struct kprobe *p;
2066
2067 mutex_lock(&kprobe_mutex);
2068
2069 /* Check whether specified probe is valid. */
2070 p = __get_valid_kprobe(kp);
2071 if (unlikely(p == NULL)) {
2072 ret = -EINVAL;
2073 goto out;
2074 }
2075
2076 if (kprobe_gone(kp)) {
2077 /* This kprobe has gone, we couldn't enable it. */
2078 ret = -EINVAL;
2079 goto out;
2080 }
2081
2082 if (p != kp)
2083 kp->flags &= ~KPROBE_FLAG_DISABLED;
2084
2085 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2086 p->flags &= ~KPROBE_FLAG_DISABLED;
2087 arm_kprobe(p);
2088 }
2089out:
2090 mutex_unlock(&kprobe_mutex);
2091 return ret;
2092}
2093EXPORT_SYMBOL_GPL(enable_kprobe);
2094
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002095void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002096{
2097 printk(KERN_WARNING "Dumping kprobe:\n");
2098 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2099 kp->symbol_name, kp->addr, kp->offset);
2100}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002101NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002102
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002103/*
2104 * Lookup and populate the kprobe_blacklist.
2105 *
2106 * Unlike the kretprobe blacklist, we'll need to determine
2107 * the range of addresses that belong to the said functions,
2108 * since a kprobe need not necessarily be at the beginning
2109 * of a function.
2110 */
2111static int __init populate_kprobe_blacklist(unsigned long *start,
2112 unsigned long *end)
2113{
2114 unsigned long *iter;
2115 struct kprobe_blacklist_entry *ent;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002116 unsigned long entry, offset = 0, size = 0;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002117
2118 for (iter = start; iter < end; iter++) {
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002119 entry = arch_deref_entry_point((void *)*iter);
2120
2121 if (!kernel_text_address(entry) ||
2122 !kallsyms_lookup_size_offset(entry, &size, &offset)) {
2123 pr_err("Failed to find blacklist at %p\n",
2124 (void *)entry);
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002125 continue;
2126 }
2127
2128 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2129 if (!ent)
2130 return -ENOMEM;
Masami Hiramatsud81b4252014-07-17 11:44:11 +00002131 ent->start_addr = entry;
2132 ent->end_addr = entry + size;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002133 INIT_LIST_HEAD(&ent->list);
2134 list_add_tail(&ent->list, &kprobe_blacklist);
2135 }
2136 return 0;
2137}
2138
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002139/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002140static int kprobes_module_callback(struct notifier_block *nb,
2141 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002142{
2143 struct module *mod = data;
2144 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002145 struct kprobe *p;
2146 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002147 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002148
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002149 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002150 return NOTIFY_DONE;
2151
2152 /*
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002153 * When MODULE_STATE_GOING was notified, both of module .text and
2154 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2155 * notified, only .init.text section would be freed. We need to
2156 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002157 */
2158 mutex_lock(&kprobe_mutex);
2159 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2160 head = &kprobe_table[i];
Muchun Song4029fed2020-09-18 21:20:21 -07002161 hlist_for_each_entry_rcu(p, head, hlist) {
2162 if (kprobe_gone(p))
2163 continue;
2164
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002165 if (within_module_init((unsigned long)p->addr, mod) ||
2166 (checkcore &&
2167 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002168 /*
2169 * The vaddr this probe is installed will soon
2170 * be vfreed buy not synced to disk. Hence,
2171 * disarming the breakpoint isn't needed.
2172 */
2173 kill_kprobe(p);
2174 }
Muchun Song4029fed2020-09-18 21:20:21 -07002175 }
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002176 }
2177 mutex_unlock(&kprobe_mutex);
2178 return NOTIFY_DONE;
2179}
2180
2181static struct notifier_block kprobe_module_nb = {
2182 .notifier_call = kprobes_module_callback,
2183 .priority = 0
2184};
2185
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002186/* Markers of _kprobe_blacklist section */
2187extern unsigned long __start_kprobe_blacklist[];
2188extern unsigned long __stop_kprobe_blacklist[];
2189
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190static int __init init_kprobes(void)
2191{
2192 int i, err = 0;
2193
2194 /* FIXME allocate the probe table, currently defined statically */
2195 /* initialize all list heads */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002196 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 INIT_HLIST_HEAD(&kprobe_table[i]);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002198 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
Thomas Gleixnerec4846082009-07-25 16:09:17 +02002199 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
Hien Nguyenb94cce92005-06-23 00:09:19 -07002200 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002202 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2203 __stop_kprobe_blacklist);
2204 if (err) {
2205 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2206 pr_err("Please take care of using kprobes.\n");
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002207 }
2208
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002209 if (kretprobe_blacklist_size) {
2210 /* lookup the function address from its name */
2211 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2212 kprobe_lookup_name(kretprobe_blacklist[i].name,
2213 kretprobe_blacklist[i].addr);
2214 if (!kretprobe_blacklist[i].addr)
2215 printk("kretprobe: lookup failed: %s\n",
2216 kretprobe_blacklist[i].name);
2217 }
2218 }
2219
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002220#if defined(CONFIG_OPTPROBES)
2221#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002222 /* Init kprobe_optinsn_slots */
2223 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2224#endif
Masami Hiramatsub2be84d2010-02-25 08:34:15 -05002225 /* By default, kprobes can be optimized */
2226 kprobes_allow_optimization = true;
2227#endif
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002228
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002229 /* By default, kprobes are armed */
2230 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002231
Rusty Lynch67729262005-07-05 18:54:50 -07002232 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002233 if (!err)
2234 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002235 if (!err)
2236 err = register_module_notifier(&kprobe_module_nb);
2237
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002238 kprobes_initialized = (err == 0);
Rusty Lynch802eae72005-06-27 15:17:08 -07002239
Ananth N Mavinakayanahalli8c1c9352008-01-30 13:32:53 +01002240 if (!err)
2241 init_test_probes();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 return err;
2243}
2244
Srinivasa Ds346fd592007-02-20 13:57:54 -08002245#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002246static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002247 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002248{
2249 char *kprobe_type;
2250
2251 if (p->pre_handler == pre_handler_kretprobe)
2252 kprobe_type = "r";
2253 else if (p->pre_handler == setjmp_pre_handler)
2254 kprobe_type = "j";
2255 else
2256 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002257
Srinivasa Ds346fd592007-02-20 13:57:54 -08002258 if (sym)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002259 seq_printf(pi, "%p %s %s+0x%x %s ",
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002260 p->addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002261 (modname ? modname : " "));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002262 else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002263 seq_printf(pi, "%p %s %p ",
2264 p->addr, kprobe_type, p->addr);
2265
2266 if (!pp)
2267 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002268 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002269 (kprobe_gone(p) ? "[GONE]" : ""),
2270 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002271 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2272 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002273}
2274
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002275static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002276{
2277 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2278}
2279
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002280static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002281{
2282 (*pos)++;
2283 if (*pos >= KPROBE_TABLE_SIZE)
2284 return NULL;
2285 return pos;
2286}
2287
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002288static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002289{
2290 /* Nothing to do */
2291}
2292
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002293static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002294{
2295 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002296 struct kprobe *p, *kp;
2297 const char *sym = NULL;
2298 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002299 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002300 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002301
2302 head = &kprobe_table[i];
2303 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002304 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002305 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002306 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002307 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002308 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002309 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002310 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002311 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002312 }
2313 preempt_enable();
2314 return 0;
2315}
2316
James Morris88e9d342009-09-22 16:43:43 -07002317static const struct seq_operations kprobes_seq_ops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002318 .start = kprobe_seq_start,
2319 .next = kprobe_seq_next,
2320 .stop = kprobe_seq_stop,
2321 .show = show_kprobe_addr
2322};
2323
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002324static int kprobes_open(struct inode *inode, struct file *filp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002325{
2326 return seq_open(filp, &kprobes_seq_ops);
2327}
2328
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002329static const struct file_operations debugfs_kprobes_operations = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002330 .open = kprobes_open,
2331 .read = seq_read,
2332 .llseek = seq_lseek,
2333 .release = seq_release,
2334};
2335
Masami Hiramatsu63724742014-04-17 17:18:49 +09002336/* kprobes/blacklist -- shows which functions can not be probed */
2337static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2338{
2339 return seq_list_start(&kprobe_blacklist, *pos);
2340}
2341
2342static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2343{
2344 return seq_list_next(v, &kprobe_blacklist, pos);
2345}
2346
2347static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2348{
2349 struct kprobe_blacklist_entry *ent =
2350 list_entry(v, struct kprobe_blacklist_entry, list);
2351
2352 seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
2353 (void *)ent->end_addr, (void *)ent->start_addr);
2354 return 0;
2355}
2356
2357static const struct seq_operations kprobe_blacklist_seq_ops = {
2358 .start = kprobe_blacklist_seq_start,
2359 .next = kprobe_blacklist_seq_next,
2360 .stop = kprobe_seq_stop, /* Reuse void function */
2361 .show = kprobe_blacklist_seq_show,
2362};
2363
2364static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2365{
2366 return seq_open(filp, &kprobe_blacklist_seq_ops);
2367}
2368
2369static const struct file_operations debugfs_kprobe_blacklist_ops = {
2370 .open = kprobe_blacklist_open,
2371 .read = seq_read,
2372 .llseek = seq_lseek,
2373 .release = seq_release,
2374};
2375
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002376static void arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002377{
2378 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002379 struct kprobe *p;
2380 unsigned int i;
2381
2382 mutex_lock(&kprobe_mutex);
2383
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002384 /* If kprobes are armed, just return */
2385 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002386 goto already_enabled;
2387
Wang Nan977ad482015-02-13 14:40:24 -08002388 /*
2389 * optimize_kprobe() called by arm_kprobe() checks
2390 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2391 * arm_kprobe.
2392 */
2393 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002394 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002395 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2396 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002397 hlist_for_each_entry_rcu(p, head, hlist)
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002398 if (!kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002399 arm_kprobe(p);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002400 }
2401
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002402 printk(KERN_INFO "Kprobes globally enabled\n");
2403
2404already_enabled:
2405 mutex_unlock(&kprobe_mutex);
2406 return;
2407}
2408
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002409static void disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002410{
2411 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002412 struct kprobe *p;
2413 unsigned int i;
2414
2415 mutex_lock(&kprobe_mutex);
2416
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002417 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002418 if (kprobes_all_disarmed) {
2419 mutex_unlock(&kprobe_mutex);
2420 return;
2421 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002422
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002423 kprobes_all_disarmed = true;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002424 printk(KERN_INFO "Kprobes globally disabled\n");
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002425
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002426 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2427 head = &kprobe_table[i];
Sasha Levinb67bfe02013-02-27 17:06:00 -08002428 hlist_for_each_entry_rcu(p, head, hlist) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002429 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002430 disarm_kprobe(p, false);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002431 }
2432 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002433 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002434
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002435 /* Wait for disarming all kprobes by optimizer */
2436 wait_for_kprobe_optimizer();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002437}
2438
2439/*
2440 * XXX: The debugfs bool file interface doesn't allow for callbacks
2441 * when the bool state is switched. We can reuse that facility when
2442 * available
2443 */
2444static ssize_t read_enabled_file_bool(struct file *file,
2445 char __user *user_buf, size_t count, loff_t *ppos)
2446{
2447 char buf[3];
2448
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002449 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002450 buf[0] = '1';
2451 else
2452 buf[0] = '0';
2453 buf[1] = '\n';
2454 buf[2] = 0x00;
2455 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2456}
2457
2458static ssize_t write_enabled_file_bool(struct file *file,
2459 const char __user *user_buf, size_t count, loff_t *ppos)
2460{
2461 char buf[32];
Stephen Boydefeb1562012-01-12 17:17:11 -08002462 size_t buf_size;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002463
2464 buf_size = min(count, (sizeof(buf)-1));
2465 if (copy_from_user(buf, user_buf, buf_size))
2466 return -EFAULT;
2467
Mathias Krause10fb46d2013-07-03 15:05:39 -07002468 buf[buf_size] = '\0';
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002469 switch (buf[0]) {
2470 case 'y':
2471 case 'Y':
2472 case '1':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002473 arm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002474 break;
2475 case 'n':
2476 case 'N':
2477 case '0':
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002478 disarm_all_kprobes();
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002479 break;
Mathias Krause10fb46d2013-07-03 15:05:39 -07002480 default:
2481 return -EINVAL;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002482 }
2483
2484 return count;
2485}
2486
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002487static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002488 .read = read_enabled_file_bool,
2489 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002490 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002491};
2492
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002493static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002494{
2495 struct dentry *dir, *file;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002496 unsigned int value = 1;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002497
2498 dir = debugfs_create_dir("kprobes", NULL);
2499 if (!dir)
2500 return -ENOMEM;
2501
Masami Hiramatsu5749cd62018-04-28 21:35:01 +09002502 file = debugfs_create_file("list", 0400, dir, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002503 &debugfs_kprobes_operations);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002504 if (!file)
2505 goto error;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002506
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002507 file = debugfs_create_file("enabled", 0600, dir,
2508 &value, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002509 if (!file)
2510 goto error;
2511
Masami Hiramatsu5749cd62018-04-28 21:35:01 +09002512 file = debugfs_create_file("blacklist", 0400, dir, NULL,
Masami Hiramatsu63724742014-04-17 17:18:49 +09002513 &debugfs_kprobe_blacklist_ops);
2514 if (!file)
2515 goto error;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002516
Srinivasa Ds346fd592007-02-20 13:57:54 -08002517 return 0;
Masami Hiramatsu63724742014-04-17 17:18:49 +09002518
2519error:
2520 debugfs_remove(dir);
2521 return -ENOMEM;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002522}
2523
2524late_initcall(debugfs_kprobe_init);
2525#endif /* CONFIG_DEBUG_FS */
2526
2527module_init(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002529/* defined in arch/.../kernel/kprobes.c */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530EXPORT_SYMBOL_GPL(jprobe_return);