blob: 94cab8c9ce56ccd012343e974d09e5d456281b3c [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * Kernel Probes (KProbes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Copyright (C) IBM Corporation, 2002, 2004
6 *
7 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
8 * Probes initial implementation (includes suggestions from
9 * Rusty Russell).
10 * 2004-Aug Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
11 * hlists and exceptions notifier as suggested by Andi Kleen.
12 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
13 * interface to access function arguments.
14 * 2004-Sep Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
15 * exceptions notifier to be first on the priority list.
Hien Nguyenb94cce92005-06-23 00:09:19 -070016 * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
17 * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
18 * <prasanna@in.ibm.com> added function-return probes.
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 */
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +090020
21#define pr_fmt(fmt) "kprobes: " fmt
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/kprobes.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/hash.h>
25#include <linux/init.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080026#include <linux/slab.h>
Randy Dunlape3869792007-05-08 00:27:01 -070027#include <linux/stddef.h>
Paul Gortmaker9984de12011-05-23 14:51:41 -040028#include <linux/export.h>
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070029#include <linux/moduleloader.h>
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070030#include <linux/kallsyms.h>
Masami Hiramatsub4c6c342006-12-06 20:38:11 -080031#include <linux/freezer.h>
Srinivasa Ds346fd592007-02-20 13:57:54 -080032#include <linux/seq_file.h>
33#include <linux/debugfs.h>
Masami Hiramatsub2be84d2010-02-25 08:34:15 -050034#include <linux/sysctl.h>
Christoph Hellwig1eeb66a2007-05-08 00:27:03 -070035#include <linux/kdebug.h>
Mathieu Desnoyers4460fda2009-03-06 10:36:38 -050036#include <linux/memory.h>
Masami Hiramatsu4554dbc2010-02-02 16:49:18 -050037#include <linux/ftrace.h>
Masami Hiramatsuafd66252010-02-25 08:34:07 -050038#include <linux/cpu.h>
Jason Baronbf5438fc2010-09-17 11:09:00 -040039#include <linux/jump_label.h>
Peter Zijlstrafa68bd02021-06-28 13:24:12 +020040#include <linux/static_call.h>
Adrian Hunter69e49082020-05-12 15:19:11 +030041#include <linux/perf_event.h>
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070042
Christoph Hellwigbfd45be2016-10-11 13:52:22 -070043#include <asm/sections.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <asm/cacheflush.h>
45#include <asm/errno.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080046#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48#define KPROBE_HASH_BITS 6
49#define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
50
Xiaoming Nia737a3c2022-01-21 22:13:41 -080051#if !defined(CONFIG_OPTPROBES) || !defined(CONFIG_SYSCTL)
52#define kprobe_sysctls_init() do { } while (0)
53#endif
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -070054
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070055static int kprobes_initialized;
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +090056/* kprobe_table can be accessed by
Masami Hiramatsu223a76b2021-09-14 23:39:34 +090057 * - Normal hlist traversal and RCU add/del under 'kprobe_mutex' is held.
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +090058 * Or
59 * - RCU hlist traversal under disabling preempt (breakpoint handlers)
60 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070061static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
62
Masami Hiramatsu223a76b2021-09-14 23:39:34 +090063/* NOTE: change this value only with 'kprobe_mutex' held */
Masami Hiramatsue579abe2009-04-06 19:01:01 -070064static bool kprobes_all_disarmed;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -070065
Masami Hiramatsu223a76b2021-09-14 23:39:34 +090066/* This protects 'kprobe_table' and 'optimizing_list' */
Masami Hiramatsu43948f52010-10-25 22:18:01 +090067static DEFINE_MUTEX(kprobe_mutex);
Masami Hiramatsu223a76b2021-09-14 23:39:34 +090068static DEFINE_PER_CPU(struct kprobe *, kprobe_instance);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -070069
Naveen N. Rao290e3072017-04-19 18:21:01 +053070kprobe_opcode_t * __weak kprobe_lookup_name(const char *name,
71 unsigned int __unused)
Naveen N. Rao49e0b462017-04-19 18:21:00 +053072{
73 return ((kprobe_opcode_t *)(kallsyms_lookup_name(name)));
74}
75
Masami Hiramatsu223a76b2021-09-14 23:39:34 +090076/*
77 * Blacklist -- list of 'struct kprobe_blacklist_entry' to store info where
78 * kprobes can not probe.
79 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +090080static LIST_HEAD(kprobe_blacklist);
Srinivasa Ds3d8d9962008-04-28 02:14:26 -070081
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -080082#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070083/*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +090084 * 'kprobe::ainsn.insn' points to the copy of the instruction to be
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070085 * single-stepped. x86_64, POWER4 and above have no-exec support and
86 * stepping on the instruction on a vmalloced/kmalloced/data page
87 * is a recipe for disaster
88 */
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070089struct kprobe_insn_page {
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -040090 struct list_head list;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070091 kprobe_opcode_t *insns; /* Page of instruction slots */
Heiko Carstensaf963972013-09-11 14:24:13 -070092 struct kprobe_insn_cache *cache;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070093 int nused;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -080094 int ngarbage;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -050095 char slot_used[];
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070096};
97
Masami Hiramatsu4610ee12010-02-25 08:33:59 -050098#define KPROBE_INSN_PAGE_SIZE(slots) \
99 (offsetof(struct kprobe_insn_page, slot_used) + \
100 (sizeof(char) * (slots)))
101
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500102static int slots_per_page(struct kprobe_insn_cache *c)
103{
104 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
105}
106
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800107enum kprobe_slot_state {
108 SLOT_CLEAN = 0,
109 SLOT_DIRTY = 1,
110 SLOT_USED = 2,
111};
112
Masami Hiramatsu63fef142017-08-18 17:24:00 +0900113void __weak *alloc_insn_page(void)
Heiko Carstensaf963972013-09-11 14:24:13 -0700114{
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900115 /*
116 * Use module_alloc() so this page is within +/- 2GB of where the
117 * kernel image and loaded module images reside. This is required
118 * for most of the architectures.
119 * (e.g. x86-64 needs this to handle the %rip-relative fixups.)
120 */
Heiko Carstensaf963972013-09-11 14:24:13 -0700121 return module_alloc(PAGE_SIZE);
122}
123
Barry Song66ce7512021-06-30 18:56:31 -0700124static void free_insn_page(void *page)
Heiko Carstensaf963972013-09-11 14:24:13 -0700125{
Rusty Russellbe1f2212015-01-20 09:07:05 +1030126 module_memfree(page);
Heiko Carstensaf963972013-09-11 14:24:13 -0700127}
128
Heiko Carstensc802d642013-09-11 14:24:11 -0700129struct kprobe_insn_cache kprobe_insn_slots = {
130 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
Heiko Carstensaf963972013-09-11 14:24:13 -0700131 .alloc = alloc_insn_page,
132 .free = free_insn_page,
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300133 .sym = KPROBE_INSN_PAGE_SYM,
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500134 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
135 .insn_size = MAX_INSN_SIZE,
136 .nr_garbage = 0,
137};
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900138static int collect_garbage_slots(struct kprobe_insn_cache *c);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800139
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700140/**
Masami Hiramatsu12941562009-01-06 14:41:50 -0800141 * __get_insn_slot() - Find a slot on an executable page for an instruction.
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700142 * We allocate an executable page if there's no room on existing ones.
143 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900144kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700145{
146 struct kprobe_insn_page *kip;
Heiko Carstensc802d642013-09-11 14:24:11 -0700147 kprobe_opcode_t *slot = NULL;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700148
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900149 /* Since the slot array is not protected by rcu, we need a mutex */
Heiko Carstensc802d642013-09-11 14:24:11 -0700150 mutex_lock(&c->mutex);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700151 retry:
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900152 rcu_read_lock();
153 list_for_each_entry_rcu(kip, &c->pages, list) {
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500154 if (kip->nused < slots_per_page(c)) {
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700155 int i;
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900156
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);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900162 rcu_read_unlock();
Heiko Carstensc802d642013-09-11 14:24:11 -0700163 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700164 }
165 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500166 /* kip->nused is broken. Fix it. */
167 kip->nused = slots_per_page(c);
168 WARN_ON(1);
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700169 }
170 }
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900171 rcu_read_unlock();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700172
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800173 /* If there are any garbage slots, collect it and try again. */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500174 if (c->nr_garbage && collect_garbage_slots(c) == 0)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800175 goto retry;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500176
177 /* All out of space. Need to allocate a new page. */
178 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
Christoph Hellwig6f716ac2007-05-08 00:34:13 -0700179 if (!kip)
Heiko Carstensc802d642013-09-11 14:24:11 -0700180 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700181
Heiko Carstensaf963972013-09-11 14:24:13 -0700182 kip->insns = c->alloc();
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700183 if (!kip->insns) {
184 kfree(kip);
Heiko Carstensc802d642013-09-11 14:24:11 -0700185 goto out;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700186 }
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400187 INIT_LIST_HEAD(&kip->list);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500188 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800189 kip->slot_used[0] = SLOT_USED;
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700190 kip->nused = 1;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800191 kip->ngarbage = 0;
Heiko Carstensaf963972013-09-11 14:24:13 -0700192 kip->cache = c;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900193 list_add_rcu(&kip->list, &c->pages);
Heiko Carstensc802d642013-09-11 14:24:11 -0700194 slot = kip->insns;
Adrian Hunter69e49082020-05-12 15:19:11 +0300195
196 /* Record the perf ksymbol register event after adding the page */
197 perf_event_ksymbol(PERF_RECORD_KSYMBOL_TYPE_OOL, (unsigned long)kip->insns,
198 PAGE_SIZE, false, c->sym);
Heiko Carstensc802d642013-09-11 14:24:11 -0700199out:
200 mutex_unlock(&c->mutex);
201 return slot;
Masami Hiramatsu12941562009-01-06 14:41:50 -0800202}
203
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +0900204/* Return true if all garbages are collected, otherwise false. */
205static bool collect_one_slot(struct kprobe_insn_page *kip, int idx)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800206{
Masami Hiramatsuab40c5c2007-01-30 14:36:06 -0800207 kip->slot_used[idx] = SLOT_CLEAN;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800208 kip->nused--;
209 if (kip->nused == 0) {
210 /*
211 * Page is no longer in use. Free it unless
212 * it's the last one. We keep the last one
213 * so as not to have to set it up again the
214 * next time somebody inserts a probe.
215 */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500216 if (!list_is_singular(&kip->list)) {
Adrian Hunter69e49082020-05-12 15:19:11 +0300217 /*
218 * Record perf ksymbol unregister event before removing
219 * the page.
220 */
221 perf_event_ksymbol(PERF_RECORD_KSYMBOL_TYPE_OOL,
222 (unsigned long)kip->insns, PAGE_SIZE, true,
223 kip->cache->sym);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900224 list_del_rcu(&kip->list);
225 synchronize_rcu();
Heiko Carstensaf963972013-09-11 14:24:13 -0700226 kip->cache->free(kip->insns);
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800227 kfree(kip);
228 }
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +0900229 return true;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800230 }
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +0900231 return false;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800232}
233
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900234static int collect_garbage_slots(struct kprobe_insn_cache *c)
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800235{
Masami Hiramatsuc5cb5a22009-06-30 17:08:14 -0400236 struct kprobe_insn_page *kip, *next;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800237
Masami Hiramatsu615d0eb2010-02-02 16:49:04 -0500238 /* Ensure no-one is interrupted on the garbages */
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -0800239 synchronize_rcu();
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800240
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500241 list_for_each_entry_safe(kip, next, &c->pages, list) {
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800242 int i;
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900243
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800244 if (kip->ngarbage == 0)
245 continue;
246 kip->ngarbage = 0; /* we will collect all garbages */
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500247 for (i = 0; i < slots_per_page(c); i++) {
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900248 if (kip->slot_used[i] == SLOT_DIRTY && collect_one_slot(kip, i))
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800249 break;
250 }
251 }
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500252 c->nr_garbage = 0;
Masami Hiramatsub4c6c342006-12-06 20:38:11 -0800253 return 0;
254}
255
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900256void __free_insn_slot(struct kprobe_insn_cache *c,
257 kprobe_opcode_t *slot, int dirty)
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500258{
259 struct kprobe_insn_page *kip;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900260 long idx;
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500261
Heiko Carstensc802d642013-09-11 14:24:11 -0700262 mutex_lock(&c->mutex);
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900263 rcu_read_lock();
264 list_for_each_entry_rcu(kip, &c->pages, list) {
265 idx = ((long)slot - (long)kip->insns) /
266 (c->insn_size * sizeof(kprobe_opcode_t));
267 if (idx >= 0 && idx < slots_per_page(c))
Heiko Carstensc802d642013-09-11 14:24:11 -0700268 goto out;
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900269 }
270 /* Could not find this slot. */
271 WARN_ON(1);
272 kip = NULL;
273out:
274 rcu_read_unlock();
275 /* Mark and sweep: this may sleep */
276 if (kip) {
277 /* Check double free */
278 WARN_ON(kip->slot_used[idx] != SLOT_USED);
279 if (dirty) {
280 kip->slot_used[idx] = SLOT_DIRTY;
281 kip->ngarbage++;
282 if (++c->nr_garbage > slots_per_page(c))
283 collect_garbage_slots(c);
284 } else {
285 collect_one_slot(kip, idx);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500286 }
287 }
Heiko Carstensc802d642013-09-11 14:24:11 -0700288 mutex_unlock(&c->mutex);
Masami Hiramatsu4610ee12010-02-25 08:33:59 -0500289}
290
Masami Hiramatsu5b485622017-01-08 23:58:09 +0900291/*
292 * Check given address is on the page of kprobe instruction slots.
293 * This will be used for checking whether the address on a stack
294 * is on a text area or not.
295 */
296bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr)
297{
298 struct kprobe_insn_page *kip;
299 bool ret = false;
300
301 rcu_read_lock();
302 list_for_each_entry_rcu(kip, &c->pages, list) {
303 if (addr >= (unsigned long)kip->insns &&
304 addr < (unsigned long)kip->insns + PAGE_SIZE) {
305 ret = true;
306 break;
307 }
308 }
309 rcu_read_unlock();
310
311 return ret;
312}
313
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300314int kprobe_cache_get_kallsym(struct kprobe_insn_cache *c, unsigned int *symnum,
315 unsigned long *value, char *type, char *sym)
316{
317 struct kprobe_insn_page *kip;
318 int ret = -ERANGE;
319
320 rcu_read_lock();
321 list_for_each_entry_rcu(kip, &c->pages, list) {
322 if ((*symnum)--)
323 continue;
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900324 strscpy(sym, c->sym, KSYM_NAME_LEN);
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300325 *type = 't';
326 *value = (unsigned long)kip->insns;
327 ret = 0;
328 break;
329 }
330 rcu_read_unlock();
331
332 return ret;
333}
334
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500335#ifdef CONFIG_OPTPROBES
Christophe Leroy7ee3e972021-05-13 09:07:51 +0000336void __weak *alloc_optinsn_page(void)
337{
338 return alloc_insn_page();
339}
340
341void __weak free_optinsn_page(void *page)
342{
343 free_insn_page(page);
344}
345
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500346/* For optimized_kprobe buffer */
Heiko Carstensc802d642013-09-11 14:24:11 -0700347struct kprobe_insn_cache kprobe_optinsn_slots = {
348 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
Christophe Leroy7ee3e972021-05-13 09:07:51 +0000349 .alloc = alloc_optinsn_page,
350 .free = free_optinsn_page,
Adrian Hunterd002b8b2020-05-28 11:00:58 +0300351 .sym = KPROBE_OPTINSN_PAGE_SYM,
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500352 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
353 /* .insn_size is initialized later */
354 .nr_garbage = 0,
355};
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500356#endif
Anil S Keshavamurthy2d14e392006-01-09 20:52:41 -0800357#endif
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -0700358
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800359/* We have preemption disabled.. so it is safe to use __ versions */
360static inline void set_kprobe_instance(struct kprobe *kp)
361{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600362 __this_cpu_write(kprobe_instance, kp);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800363}
364
365static inline void reset_kprobe_instance(void)
366{
Christoph Lameterb76834b2010-12-06 11:16:25 -0600367 __this_cpu_write(kprobe_instance, NULL);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -0800368}
369
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800370/*
371 * This routine is called either:
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900372 * - under the 'kprobe_mutex' - during kprobe_[un]register().
373 * OR
374 * - with preemption disabled - from architecture specific code.
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800375 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900376struct kprobe *get_kprobe(void *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377{
378 struct hlist_head *head;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -0800379 struct kprobe *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
Masami Hiramatsu6743ad42020-05-12 17:02:33 +0900382 hlist_for_each_entry_rcu(p, head, hlist,
383 lockdep_is_held(&kprobe_mutex)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 if (p->addr == addr)
385 return p;
386 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 return NULL;
389}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900390NOKPROBE_SYMBOL(get_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900392static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500393
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900394/* Return true if 'p' is an aggregator */
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +0900395static inline bool kprobe_aggrprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500396{
397 return p->pre_handler == aggr_pre_handler;
398}
399
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900400/* Return true if 'p' is unused */
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +0900401static inline bool kprobe_unused(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900402{
403 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
404 list_empty(&p->list);
405}
406
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900407/* Keep all fields in the kprobe consistent. */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900408static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500409{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900410 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
411 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500412}
413
414#ifdef CONFIG_OPTPROBES
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900415/* NOTE: This is protected by 'kprobe_mutex'. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500416static bool kprobes_allow_optimization;
417
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500418/*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900419 * Call all 'kprobe::pre_handler' on the list, but ignores its return value.
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500420 * This must be called from arch-dep optimized caller.
421 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900422void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500423{
424 struct kprobe *kp;
425
426 list_for_each_entry_rcu(kp, &p->list, list) {
427 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
428 set_kprobe_instance(kp);
Naveen N. Rao4f3a8712017-10-17 13:48:34 +0530429 kp->pre_handler(kp, regs);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500430 }
431 reset_kprobe_instance();
432 }
433}
Masami Hiramatsu820aede2014-04-17 17:18:21 +0900434NOKPROBE_SYMBOL(opt_pre_handler);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500435
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900436/* Free optimized instructions and optimized_kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900437static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900438{
439 struct optimized_kprobe *op;
440
441 op = container_of(p, struct optimized_kprobe, kp);
442 arch_remove_optimized_kprobe(op);
443 arch_remove_kprobe(p);
444 kfree(op);
445}
446
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900447/* Return true if the kprobe is ready for optimization. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500448static inline int kprobe_optready(struct kprobe *p)
449{
450 struct optimized_kprobe *op;
451
452 if (kprobe_aggrprobe(p)) {
453 op = container_of(p, struct optimized_kprobe, kp);
454 return arch_prepared_optinsn(&op->optinsn);
455 }
456
457 return 0;
458}
459
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900460/* Return true if the kprobe is disarmed. Note: p must be on hash list */
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +0900461static inline bool kprobe_disarmed(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900462{
463 struct optimized_kprobe *op;
464
465 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
466 if (!kprobe_aggrprobe(p))
467 return kprobe_disabled(p);
468
469 op = container_of(p, struct optimized_kprobe, kp);
470
471 return kprobe_disabled(p) && list_empty(&op->list);
472}
473
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900474/* Return true if the probe is queued on (un)optimizing lists */
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +0900475static bool kprobe_queued(struct kprobe *p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900476{
477 struct optimized_kprobe *op;
478
479 if (kprobe_aggrprobe(p)) {
480 op = container_of(p, struct optimized_kprobe, kp);
481 if (!list_empty(&op->list))
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +0900482 return true;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900483 }
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +0900484 return false;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900485}
486
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500487/*
488 * Return an optimized kprobe whose optimizing code replaces
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900489 * instructions including 'addr' (exclude breakpoint).
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500490 */
Masami Hiramatsuc42421e2021-09-14 23:40:07 +0900491static struct kprobe *get_optimized_kprobe(kprobe_opcode_t *addr)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500492{
493 int i;
494 struct kprobe *p = NULL;
495 struct optimized_kprobe *op;
496
497 /* Don't check i == 0, since that is a breakpoint case. */
Masami Hiramatsuc42421e2021-09-14 23:40:07 +0900498 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH / sizeof(kprobe_opcode_t); i++)
499 p = get_kprobe(addr - i);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500500
501 if (p && kprobe_optready(p)) {
502 op = container_of(p, struct optimized_kprobe, kp);
503 if (arch_within_optimized_kprobe(op, addr))
504 return p;
505 }
506
507 return NULL;
508}
509
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900510/* Optimization staging list, protected by 'kprobe_mutex' */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500511static LIST_HEAD(optimizing_list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900512static LIST_HEAD(unoptimizing_list);
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900513static LIST_HEAD(freeing_list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500514
515static void kprobe_optimizer(struct work_struct *work);
516static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
517#define OPTIMIZE_DELAY 5
518
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900519/*
520 * Optimize (replace a breakpoint with a jump) kprobes listed on
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900521 * 'optimizing_list'.
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900522 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900523static void do_optimize_kprobes(void)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500524{
Andrea Righif1c6ece2019-08-12 20:43:02 +0200525 lockdep_assert_held(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500526 /*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900527 * The optimization/unoptimization refers 'online_cpus' via
528 * stop_machine() and cpu-hotplug modifies the 'online_cpus'.
529 * And same time, 'text_mutex' will be held in cpu-hotplug and here.
530 * This combination can cause a deadlock (cpu-hotplug tries to lock
531 * 'text_mutex' but stop_machine() can not be done because
532 * the 'online_cpus' has been changed)
533 * To avoid this deadlock, caller must have locked cpu-hotplug
534 * for preventing cpu-hotplug outside of 'text_mutex' locking.
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500535 */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200536 lockdep_assert_cpus_held();
537
538 /* Optimization never be done when disarmed */
539 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
540 list_empty(&optimizing_list))
541 return;
542
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900543 arch_optimize_kprobes(&optimizing_list);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900544}
545
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900546/*
547 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900548 * if need) kprobes listed on 'unoptimizing_list'.
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900549 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900550static void do_unoptimize_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900551{
552 struct optimized_kprobe *op, *tmp;
553
Andrea Righif1c6ece2019-08-12 20:43:02 +0200554 lockdep_assert_held(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200555 /* See comment in do_optimize_kprobes() */
556 lockdep_assert_cpus_held();
557
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900558 /* Unoptimization must be done anytime */
559 if (list_empty(&unoptimizing_list))
560 return;
561
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900562 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900563 /* Loop on 'freeing_list' for disarming */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900564 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsuf66c0442019-11-27 14:57:04 +0900565 /* Switching from detour code to origin */
566 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900567 /* Disarm probes if marked disabled */
568 if (kprobe_disabled(&op->kp))
569 arch_disarm_kprobe(&op->kp);
570 if (kprobe_unused(&op->kp)) {
571 /*
572 * Remove unused probes from hash list. After waiting
573 * for synchronization, these probes are reclaimed.
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900574 * (reclaiming is done by do_free_cleaned_kprobes().)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900575 */
576 hlist_del_rcu(&op->kp.hlist);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900577 } else
578 list_del_init(&op->list);
579 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900580}
581
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900582/* Reclaim all kprobes on the 'freeing_list' */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900583static void do_free_cleaned_kprobes(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900584{
585 struct optimized_kprobe *op, *tmp;
586
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900587 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900588 list_del_init(&op->list);
Masami Hiramatsucbdd96f2018-09-11 19:21:09 +0900589 if (WARN_ON_ONCE(!kprobe_unused(&op->kp))) {
590 /*
591 * This must not happen, but if there is a kprobe
592 * still in use, keep it on kprobes hash list.
593 */
594 continue;
595 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900596 free_aggr_kprobe(&op->kp);
597 }
598}
599
600/* Start optimizer after OPTIMIZE_DELAY passed */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900601static void kick_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900602{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800603 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900604}
605
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900606/* Kprobe jump optimizer */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900607static void kprobe_optimizer(struct work_struct *work)
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900608{
Steven Rostedt72ef3792012-06-05 19:28:14 +0900609 mutex_lock(&kprobe_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200610 cpus_read_lock();
Andrea Righif1c6ece2019-08-12 20:43:02 +0200611 mutex_lock(&text_mutex);
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900612
613 /*
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900614 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
615 * kprobes before waiting for quiesence period.
616 */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900617 do_unoptimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900618
619 /*
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900620 * Step 2: Wait for quiesence period to ensure all potentially
621 * preempted tasks to have normally scheduled. Because optprobe
622 * may modify multiple instructions, there is a chance that Nth
623 * instruction is preempted. In that case, such tasks can return
624 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
625 * Note that on non-preemptive kernel, this is transparently converted
626 * to synchronoze_sched() to wait for all interrupts to have completed.
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900627 */
Masami Hiramatsua30b85d2017-10-20 08:43:39 +0900628 synchronize_rcu_tasks();
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900629
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900630 /* Step 3: Optimize kprobes after quiesence period */
Masami Hiramatsu61f4e132010-12-03 18:54:03 +0900631 do_optimize_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900632
633 /* Step 4: Free cleaned kprobes after quiesence period */
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900634 do_free_cleaned_kprobes();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900635
Andrea Righif1c6ece2019-08-12 20:43:02 +0200636 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200637 cpus_read_unlock();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900638
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900639 /* Step 5: Kick optimizer again if needed */
Masami Hiramatsuf984ba42010-12-03 18:54:34 +0900640 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
Masami Hiramatsucd7ebe22010-12-03 18:54:28 +0900641 kick_kprobe_optimizer();
Masami Hiramatsu1a0aa992020-05-12 17:02:56 +0900642
643 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900644}
645
646/* Wait for completing optimization and unoptimization */
Thomas Gleixner30e7d8942017-05-17 10:19:49 +0200647void wait_for_kprobe_optimizer(void)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900648{
Tejun Heoad72b3b2012-12-21 17:57:00 -0800649 mutex_lock(&kprobe_mutex);
650
651 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
652 mutex_unlock(&kprobe_mutex);
653
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900654 /* This will also make 'optimizing_work' execute immmediately */
Tejun Heoad72b3b2012-12-21 17:57:00 -0800655 flush_delayed_work(&optimizing_work);
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900656 /* 'optimizing_work' might not have been queued yet, relax */
Tejun Heoad72b3b2012-12-21 17:57:00 -0800657 cpu_relax();
658
659 mutex_lock(&kprobe_mutex);
660 }
661
662 mutex_unlock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500663}
664
Masami Hiramatsue4add242020-01-07 23:42:24 +0900665static bool optprobe_queued_unopt(struct optimized_kprobe *op)
666{
667 struct optimized_kprobe *_op;
668
669 list_for_each_entry(_op, &unoptimizing_list, list) {
670 if (op == _op)
671 return true;
672 }
673
674 return false;
675}
676
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500677/* Optimize kprobe if p is ready to be optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900678static void optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500679{
680 struct optimized_kprobe *op;
681
682 /* Check if the kprobe is disabled or not ready for optimization. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500683 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500684 (kprobe_disabled(p) || kprobes_all_disarmed))
685 return;
686
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900687 /* kprobes with 'post_handler' can not be optimized */
Masami Hiramatsu059053a2018-06-20 01:10:27 +0900688 if (p->post_handler)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500689 return;
690
691 op = container_of(p, struct optimized_kprobe, kp);
692
693 /* Check there is no other kprobes at the optimized instructions */
694 if (arch_check_optimized_kprobe(op) < 0)
695 return;
696
697 /* Check if it is already optimized. */
Masami Hiramatsue4add242020-01-07 23:42:24 +0900698 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED) {
699 if (optprobe_queued_unopt(op)) {
700 /* This is under unoptimizing. Just dequeue the probe */
701 list_del_init(&op->list);
702 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500703 return;
Masami Hiramatsue4add242020-01-07 23:42:24 +0900704 }
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500705 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900706
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900707 /*
708 * On the 'unoptimizing_list' and 'optimizing_list',
709 * 'op' must have OPTIMIZED flag
710 */
Masami Hiramatsue4add242020-01-07 23:42:24 +0900711 if (WARN_ON_ONCE(!list_empty(&op->list)))
712 return;
713
714 list_add(&op->list, &optimizing_list);
715 kick_kprobe_optimizer();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900716}
717
718/* Short cut to direct unoptimizing */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900719static void force_unoptimize_kprobe(struct optimized_kprobe *op)
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900720{
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200721 lockdep_assert_cpus_held();
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900722 arch_unoptimize_kprobe(op);
Masami Hiramatsuf66c0442019-11-27 14:57:04 +0900723 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500724}
725
726/* Unoptimize a kprobe if p is optimized */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900727static void unoptimize_kprobe(struct kprobe *p, bool force)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500728{
729 struct optimized_kprobe *op;
730
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900731 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
732 return; /* This is not an optprobe nor optimized */
733
734 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsue4add242020-01-07 23:42:24 +0900735 if (!kprobe_optimized(p))
736 return;
737
738 if (!list_empty(&op->list)) {
739 if (optprobe_queued_unopt(op)) {
740 /* Queued in unoptimizing queue */
741 if (force) {
742 /*
743 * Forcibly unoptimize the kprobe here, and queue it
744 * in the freeing list for release afterwards.
745 */
746 force_unoptimize_kprobe(op);
747 list_move(&op->list, &freeing_list);
748 }
749 } else {
750 /* Dequeue from the optimizing queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500751 list_del_init(&op->list);
Masami Hiramatsue4add242020-01-07 23:42:24 +0900752 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900753 }
754 return;
755 }
756
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900757 /* Optimized kprobe case */
Masami Hiramatsue4add242020-01-07 23:42:24 +0900758 if (force) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900759 /* Forcibly update the code: this is a special case */
760 force_unoptimize_kprobe(op);
Masami Hiramatsue4add242020-01-07 23:42:24 +0900761 } else {
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900762 list_add(&op->list, &unoptimizing_list);
763 kick_kprobe_optimizer();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500764 }
765}
766
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900767/* Cancel unoptimizing for reusing */
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900768static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900769{
770 struct optimized_kprobe *op;
771
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900772 /*
773 * Unused kprobe MUST be on the way of delayed unoptimizing (means
774 * there is still a relative jump) and disabled.
775 */
776 op = container_of(ap, struct optimized_kprobe, kp);
Masami Hiramatsu44585152018-04-28 21:36:33 +0900777 WARN_ON_ONCE(list_empty(&op->list));
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900778 /* Enable the probe again */
779 ap->flags &= ~KPROBE_FLAG_DISABLED;
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900780 /* Optimize it again. (remove from 'op->list') */
Masami Hiramatsu5f843ed2019-04-15 15:01:25 +0900781 if (!kprobe_optready(ap))
782 return -EINVAL;
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900783
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900784 optimize_kprobe(ap);
Masami Hiramatsu819319f2018-09-11 19:20:40 +0900785 return 0;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +0900786}
787
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500788/* Remove optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900789static void kill_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500790{
791 struct optimized_kprobe *op;
792
793 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900794 if (!list_empty(&op->list))
795 /* Dequeue from the (un)optimization queue */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500796 list_del_init(&op->list);
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900797 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
Masami Hiramatsu7b959fc2013-05-22 18:34:09 +0900798
799 if (kprobe_unused(p)) {
800 /* Enqueue if it is unused */
801 list_add(&op->list, &freeing_list);
802 /*
803 * Remove unused probes from the hash list. After waiting
804 * for synchronization, this probe is reclaimed.
805 * (reclaiming is done by do_free_cleaned_kprobes().)
806 */
807 hlist_del_rcu(&op->kp.hlist);
808 }
809
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900810 /* Don't touch the code, because it is already freed. */
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500811 arch_remove_optimized_kprobe(op);
812}
813
Masami Hiramatsua4602462017-04-19 18:22:25 +0530814static inline
815void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
816{
817 if (!kprobe_ftrace(p))
818 arch_prepare_optimized_kprobe(op, p);
819}
820
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500821/* Try to prepare optimized instructions */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900822static void prepare_optimized_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500823{
824 struct optimized_kprobe *op;
825
826 op = container_of(p, struct optimized_kprobe, kp);
Masami Hiramatsua4602462017-04-19 18:22:25 +0530827 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500828}
829
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900830/* Allocate new optimized_kprobe and try to prepare optimized instructions. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900831static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500832{
833 struct optimized_kprobe *op;
834
835 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
836 if (!op)
837 return NULL;
838
839 INIT_LIST_HEAD(&op->list);
840 op->kp.addr = p->addr;
Masami Hiramatsua4602462017-04-19 18:22:25 +0530841 __prepare_optimized_kprobe(op, p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500842
843 return &op->kp;
844}
845
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900846static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500847
848/*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900849 * Prepare an optimized_kprobe and optimize it.
850 * NOTE: 'p' must be a normal registered kprobe.
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500851 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900852static void try_to_optimize_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500853{
854 struct kprobe *ap;
855 struct optimized_kprobe *op;
856
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900857 /* Impossible to optimize ftrace-based kprobe. */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +0900858 if (kprobe_ftrace(p))
859 return;
860
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900861 /* For preparing optimization, jump_label_text_reserved() is called. */
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200862 cpus_read_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +0900863 jump_label_lock();
864 mutex_lock(&text_mutex);
865
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500866 ap = alloc_aggr_kprobe(p);
867 if (!ap)
Masami Hiramatsu25764282012-06-05 19:28:26 +0900868 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500869
870 op = container_of(ap, struct optimized_kprobe, kp);
871 if (!arch_prepared_optinsn(&op->optinsn)) {
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900872 /* If failed to setup optimizing, fallback to kprobe. */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900873 arch_remove_optimized_kprobe(op);
874 kfree(op);
Masami Hiramatsu25764282012-06-05 19:28:26 +0900875 goto out;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500876 }
877
878 init_aggr_kprobe(ap, p);
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900879 optimize_kprobe(ap); /* This just kicks optimizer thread. */
Masami Hiramatsu25764282012-06-05 19:28:26 +0900880
881out:
882 mutex_unlock(&text_mutex);
883 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200884 cpus_read_unlock();
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500885}
886
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900887static void optimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500888{
889 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500890 struct kprobe *p;
891 unsigned int i;
892
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900893 mutex_lock(&kprobe_mutex);
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900894 /* If optimization is already allowed, just return. */
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500895 if (kprobes_allow_optimization)
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900896 goto out;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500897
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200898 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500899 kprobes_allow_optimization = true;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500900 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
901 head = &kprobe_table[i];
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +0900902 hlist_for_each_entry(p, head, hlist)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500903 if (!kprobe_disabled(p))
904 optimize_kprobe(p);
905 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200906 cpus_read_unlock();
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +0900907 pr_info("kprobe jump-optimization is enabled. All kprobes are optimized if possible.\n");
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900908out:
909 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500910}
911
Masami Hiramatsuc85c9a22021-02-18 23:29:23 +0900912#ifdef CONFIG_SYSCTL
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900913static void unoptimize_all_kprobes(void)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500914{
915 struct hlist_head *head;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500916 struct kprobe *p;
917 unsigned int i;
918
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900919 mutex_lock(&kprobe_mutex);
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900920 /* If optimization is already prohibited, just return. */
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900921 if (!kprobes_allow_optimization) {
922 mutex_unlock(&kprobe_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500923 return;
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900924 }
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500925
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200926 cpus_read_lock();
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500927 kprobes_allow_optimization = false;
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500928 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
929 head = &kprobe_table[i];
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +0900930 hlist_for_each_entry(p, head, hlist) {
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500931 if (!kprobe_disabled(p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900932 unoptimize_kprobe(p, false);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500933 }
934 }
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +0200935 cpus_read_unlock();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900936 mutex_unlock(&kprobe_mutex);
937
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900938 /* Wait for unoptimizing completion. */
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900939 wait_for_kprobe_optimizer();
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +0900940 pr_info("kprobe jump-optimization is disabled. All kprobes are based on software breakpoint.\n");
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500941}
942
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900943static DEFINE_MUTEX(kprobe_sysctl_mutex);
Xiaoming Nia737a3c2022-01-21 22:13:41 -0800944static int sysctl_kprobes_optimization;
945static int proc_kprobes_optimization_handler(struct ctl_table *table,
946 int write, void *buffer,
947 size_t *length, loff_t *ppos)
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500948{
949 int ret;
950
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900951 mutex_lock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500952 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
953 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
954
955 if (sysctl_kprobes_optimization)
956 optimize_all_kprobes();
957 else
958 unoptimize_all_kprobes();
Masami Hiramatsu5c515432013-04-18 18:33:18 +0900959 mutex_unlock(&kprobe_sysctl_mutex);
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500960
961 return ret;
962}
Xiaoming Nia737a3c2022-01-21 22:13:41 -0800963
964static struct ctl_table kprobe_sysctls[] = {
965 {
966 .procname = "kprobes-optimization",
967 .data = &sysctl_kprobes_optimization,
968 .maxlen = sizeof(int),
969 .mode = 0644,
970 .proc_handler = proc_kprobes_optimization_handler,
971 .extra1 = SYSCTL_ZERO,
972 .extra2 = SYSCTL_ONE,
973 },
974 {}
975};
976
977static void __init kprobe_sysctls_init(void)
978{
979 register_sysctl_init("debug", kprobe_sysctls);
980}
Masami Hiramatsub2be84d2010-02-25 08:34:15 -0500981#endif /* CONFIG_SYSCTL */
982
Masami Hiramatsu57d4e312021-09-14 23:39:55 +0900983/* Put a breakpoint for a probe. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +0900984static void __arm_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500985{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900986 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500987
Masami Hiramatsu57d4e312021-09-14 23:39:55 +0900988 lockdep_assert_held(&text_mutex);
989
Masami Hiramatsu223a76b2021-09-14 23:39:34 +0900990 /* Find the overlapping optimized kprobes. */
Masami Hiramatsuc42421e2021-09-14 23:40:07 +0900991 _p = get_optimized_kprobe(p->addr);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +0900992 if (unlikely(_p))
Masami Hiramatsu6274de42010-12-03 18:54:09 +0900993 /* Fallback to unoptimized kprobe */
994 unoptimize_kprobe(_p, true);
Masami Hiramatsuafd66252010-02-25 08:34:07 -0500995
996 arch_arm_kprobe(p);
997 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
998}
999
Masami Hiramatsu57d4e312021-09-14 23:39:55 +09001000/* Remove the breakpoint of a probe. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001001static void __disarm_kprobe(struct kprobe *p, bool reopt)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001002{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001003 struct kprobe *_p;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001004
Masami Hiramatsu57d4e312021-09-14 23:39:55 +09001005 lockdep_assert_held(&text_mutex);
1006
Wang Nan69d54b92015-02-13 14:40:26 -08001007 /* Try to unoptimize */
1008 unoptimize_kprobe(p, kprobes_all_disarmed);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001009
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001010 if (!kprobe_queued(p)) {
1011 arch_disarm_kprobe(p);
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001012 /* If another kprobe was blocked, re-optimize it. */
Masami Hiramatsuc42421e2021-09-14 23:40:07 +09001013 _p = get_optimized_kprobe(p->addr);
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001014 if (unlikely(_p) && reopt)
1015 optimize_kprobe(_p);
1016 }
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001017 /*
1018 * TODO: Since unoptimization and real disarming will be done by
1019 * the worker thread, we can not check whether another probe are
1020 * unoptimized because of this probe here. It should be re-optimized
1021 * by the worker thread.
1022 */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001023}
1024
1025#else /* !CONFIG_OPTPROBES */
1026
1027#define optimize_kprobe(p) do {} while (0)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001028#define unoptimize_kprobe(p, f) do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001029#define kill_optimized_kprobe(p) do {} while (0)
1030#define prepare_optimized_kprobe(p) do {} while (0)
1031#define try_to_optimize_kprobe(p) do {} while (0)
1032#define __arm_kprobe(p) arch_arm_kprobe(p)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001033#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
1034#define kprobe_disarmed(p) kprobe_disabled(p)
1035#define wait_for_kprobe_optimizer() do {} while (0)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001036
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001037static int reuse_unused_kprobe(struct kprobe *ap)
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001038{
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001039 /*
1040 * If the optimized kprobe is NOT supported, the aggr kprobe is
1041 * released at the same time that the last aggregated kprobe is
1042 * unregistered.
1043 * Thus there should be no chance to reuse unused kprobe.
1044 */
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09001045 WARN_ON_ONCE(1);
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001046 return -EINVAL;
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001047}
1048
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001049static void free_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001050{
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001051 arch_remove_kprobe(p);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001052 kfree(p);
1053}
1054
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001055static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001056{
1057 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
1058}
1059#endif /* CONFIG_OPTPROBES */
1060
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001061#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001062static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
Masami Hiramatsue5253892012-06-05 19:28:38 +09001063 .func = kprobe_ftrace_handler,
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001064 .flags = FTRACE_OPS_FL_SAVE_REGS,
1065};
1066
1067static struct ftrace_ops kprobe_ipmodify_ops __read_mostly = {
1068 .func = kprobe_ftrace_handler,
Masami Hiramatsu1d70be32014-11-21 05:25:23 -05001069 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001070};
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001071
1072static int kprobe_ipmodify_enabled;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001073static int kprobe_ftrace_enabled;
1074
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001075static int __arm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
1076 int *cnt)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001077{
Jessica Yu12310e342018-01-10 00:51:23 +01001078 int ret = 0;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001079
Masami Hiramatsu57d4e312021-09-14 23:39:55 +09001080 lockdep_assert_held(&kprobe_mutex);
1081
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001082 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 0, 0);
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09001083 if (WARN_ONCE(ret < 0, "Failed to arm kprobe-ftrace at %pS (error %d)\n", p->addr, ret))
Jessica Yu12310e342018-01-10 00:51:23 +01001084 return ret;
Jessica Yu12310e342018-01-10 00:51:23 +01001085
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001086 if (*cnt == 0) {
1087 ret = register_ftrace_function(ops);
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09001088 if (WARN(ret < 0, "Failed to register kprobe-ftrace (error %d)\n", ret))
Jessica Yu12310e342018-01-10 00:51:23 +01001089 goto err_ftrace;
Jessica Yu12310e342018-01-10 00:51:23 +01001090 }
1091
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001092 (*cnt)++;
Jessica Yu12310e342018-01-10 00:51:23 +01001093 return ret;
1094
1095err_ftrace:
1096 /*
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001097 * At this point, sinec ops is not registered, we should be sefe from
1098 * registering empty filter.
Jessica Yu12310e342018-01-10 00:51:23 +01001099 */
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001100 ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
Jessica Yu12310e342018-01-10 00:51:23 +01001101 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001102}
1103
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001104static int arm_kprobe_ftrace(struct kprobe *p)
1105{
1106 bool ipmodify = (p->post_handler != NULL);
1107
1108 return __arm_kprobe_ftrace(p,
1109 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1110 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1111}
1112
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001113static int __disarm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
1114 int *cnt)
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001115{
Jessica Yu297f9232018-01-10 00:51:24 +01001116 int ret = 0;
1117
Masami Hiramatsu57d4e312021-09-14 23:39:55 +09001118 lockdep_assert_held(&kprobe_mutex);
1119
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001120 if (*cnt == 1) {
1121 ret = unregister_ftrace_function(ops);
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09001122 if (WARN(ret < 0, "Failed to unregister kprobe-ftrace (error %d)\n", ret))
Jessica Yu297f9232018-01-10 00:51:24 +01001123 return ret;
1124 }
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001125
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001126 (*cnt)--;
Jessica Yu297f9232018-01-10 00:51:24 +01001127
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001128 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09001129 WARN_ONCE(ret < 0, "Failed to disarm kprobe-ftrace at %pS (error %d)\n",
Masami Hiramatsu44585152018-04-28 21:36:33 +09001130 p->addr, ret);
Jessica Yu297f9232018-01-10 00:51:24 +01001131 return ret;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001132}
Masami Hiramatsu0bc11ed2019-07-25 15:24:37 +09001133
1134static int disarm_kprobe_ftrace(struct kprobe *p)
1135{
1136 bool ipmodify = (p->post_handler != NULL);
1137
1138 return __disarm_kprobe_ftrace(p,
1139 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1140 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1141}
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001142#else /* !CONFIG_KPROBES_ON_FTRACE */
Muchun Song10de7952020-08-06 01:20:46 +08001143static inline int arm_kprobe_ftrace(struct kprobe *p)
1144{
1145 return -ENODEV;
1146}
1147
1148static inline int disarm_kprobe_ftrace(struct kprobe *p)
1149{
1150 return -ENODEV;
1151}
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001152#endif
1153
Punit Agrawal02afb8d2021-09-14 23:38:57 +09001154static int prepare_kprobe(struct kprobe *p)
1155{
1156 /* Must ensure p->addr is really on ftrace */
1157 if (kprobe_ftrace(p))
1158 return arch_prepare_kprobe_ftrace(p);
1159
1160 return arch_prepare_kprobe(p);
1161}
1162
Jessica Yu12310e342018-01-10 00:51:23 +01001163static int arm_kprobe(struct kprobe *kp)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001164{
Jessica Yu12310e342018-01-10 00:51:23 +01001165 if (unlikely(kprobe_ftrace(kp)))
1166 return arm_kprobe_ftrace(kp);
1167
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001168 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001169 mutex_lock(&text_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001170 __arm_kprobe(kp);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001171 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001172 cpus_read_unlock();
Jessica Yu12310e342018-01-10 00:51:23 +01001173
1174 return 0;
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001175}
1176
Jessica Yu297f9232018-01-10 00:51:24 +01001177static int disarm_kprobe(struct kprobe *kp, bool reopt)
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001178{
Jessica Yu297f9232018-01-10 00:51:24 +01001179 if (unlikely(kprobe_ftrace(kp)))
1180 return disarm_kprobe_ftrace(kp);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001181
1182 cpus_read_lock();
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001183 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001184 __disarm_kprobe(kp, reopt);
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001185 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001186 cpus_read_unlock();
Jessica Yu297f9232018-01-10 00:51:24 +01001187
1188 return 0;
Masami Hiramatsu201517a2009-05-07 16:31:26 -04001189}
1190
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001191/*
1192 * Aggregate handlers for multiple kprobes support - these handlers
1193 * take care of invoking the individual kprobe handlers on p->list
1194 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001195static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001196{
1197 struct kprobe *kp;
1198
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001199 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001200 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001201 set_kprobe_instance(kp);
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001202 if (kp->pre_handler(kp, regs))
1203 return 1;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001204 }
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001205 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001206 }
1207 return 0;
1208}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001209NOKPROBE_SYMBOL(aggr_pre_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001210
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001211static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1212 unsigned long flags)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001213{
1214 struct kprobe *kp;
1215
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001216 list_for_each_entry_rcu(kp, &p->list, list) {
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001217 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001218 set_kprobe_instance(kp);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001219 kp->post_handler(kp, regs, flags);
Ananth N Mavinakayanahallie6584522005-11-07 01:00:07 -08001220 reset_kprobe_instance();
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001221 }
1222 }
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001223}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001224NOKPROBE_SYMBOL(aggr_post_handler);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001225
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001226/* Walks the list and increments 'nmissed' if 'p' has child probes. */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001227void kprobes_inc_nmissed_count(struct kprobe *p)
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001228{
1229 struct kprobe *kp;
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001230
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001231 if (!kprobe_aggrprobe(p)) {
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001232 p->nmissed++;
1233 } else {
1234 list_for_each_entry_rcu(kp, &p->list, list)
1235 kp->nmissed++;
1236 }
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001237}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001238NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -08001239
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001240static void free_rp_inst_rcu(struct rcu_head *head)
1241{
1242 struct kretprobe_instance *ri = container_of(head, struct kretprobe_instance, rcu);
1243
1244 if (refcount_dec_and_test(&ri->rph->ref))
1245 kfree(ri->rph);
1246 kfree(ri);
1247}
1248NOKPROBE_SYMBOL(free_rp_inst_rcu);
1249
Masami Hiramatsub3388172020-08-29 22:02:47 +09001250static void recycle_rp_inst(struct kretprobe_instance *ri)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001251{
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001252 struct kretprobe *rp = get_kretprobe(ri);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001253
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001254 if (likely(rp))
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001255 freelist_add(&ri->freelist, &rp->freelist);
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001256 else
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001257 call_rcu(&ri->rcu, free_rp_inst_rcu);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001258}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001259NOKPROBE_SYMBOL(recycle_rp_inst);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001260
Masami Hiramatsu319f0ce2020-08-29 22:03:02 +09001261static struct kprobe kprobe_busy = {
Jiri Olsa9b38cc72020-05-12 17:03:18 +09001262 .addr = (void *) get_kprobe,
1263};
1264
1265void kprobe_busy_begin(void)
1266{
1267 struct kprobe_ctlblk *kcb;
1268
1269 preempt_disable();
1270 __this_cpu_write(current_kprobe, &kprobe_busy);
1271 kcb = get_kprobe_ctlblk();
1272 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
1273}
1274
1275void kprobe_busy_end(void)
1276{
1277 __this_cpu_write(current_kprobe, NULL);
1278 preempt_enable();
1279}
1280
Hien Nguyenb94cce92005-06-23 00:09:19 -07001281/*
Thomas Gleixner670721c2021-09-28 14:24:28 +02001282 * This function is called from delayed_put_task_struct() when a task is
Linus Torvalds79ef0c02021-11-01 20:05:19 -07001283 * dead and cleaned up to recycle any kretprobe instances associated with
1284 * this task. These left over instances represent probed functions that
1285 * have been called but will never return.
Hien Nguyenb94cce92005-06-23 00:09:19 -07001286 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001287void kprobe_flush_task(struct task_struct *tk)
Hien Nguyenb94cce92005-06-23 00:09:19 -07001288{
bibo,mao62c27be2006-10-02 02:17:33 -07001289 struct kretprobe_instance *ri;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001290 struct llist_node *node;
Rusty Lynch802eae72005-06-27 15:17:08 -07001291
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001292 /* Early boot, not yet initialized. */
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001293 if (unlikely(!kprobes_initialized))
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07001294 return;
1295
Jiri Olsa9b38cc72020-05-12 17:03:18 +09001296 kprobe_busy_begin();
1297
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001298 node = __llist_del_all(&tk->kretprobe_instances);
1299 while (node) {
1300 ri = container_of(node, struct kretprobe_instance, llist);
1301 node = node->next;
1302
1303 recycle_rp_inst(ri);
bibo,mao62c27be2006-10-02 02:17:33 -07001304 }
Jiri Olsa9b38cc72020-05-12 17:03:18 +09001305
1306 kprobe_busy_end();
Hien Nguyenb94cce92005-06-23 00:09:19 -07001307}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09001308NOKPROBE_SYMBOL(kprobe_flush_task);
Hien Nguyenb94cce92005-06-23 00:09:19 -07001309
Hien Nguyenb94cce92005-06-23 00:09:19 -07001310static inline void free_rp_inst(struct kretprobe *rp)
1311{
1312 struct kretprobe_instance *ri;
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001313 struct freelist_node *node;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001314 int count = 0;
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07001315
Peter Zijlstra6e426e02020-08-29 22:03:56 +09001316 node = rp->freelist.head;
1317 while (node) {
1318 ri = container_of(node, struct kretprobe_instance, freelist);
1319 node = node->next;
1320
Hien Nguyenb94cce92005-06-23 00:09:19 -07001321 kfree(ri);
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001322 count++;
1323 }
1324
1325 if (refcount_sub_and_test(count, &rp->rph->ref)) {
1326 kfree(rp->rph);
1327 rp->rph = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07001328 }
1329}
1330
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001331/* Add the new probe to 'ap->list'. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001332static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001333{
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001334 if (p->post_handler)
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001335 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001336
Masami Hiramatsu059053a2018-06-20 01:10:27 +09001337 list_add_rcu(&p->list, &ap->list);
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001338 if (p->post_handler && !ap->post_handler)
1339 ap->post_handler = aggr_post_handler;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001340
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001341 return 0;
1342}
1343
1344/*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001345 * Fill in the required fields of the aggregator kprobe. Replace the
1346 * earlier kprobe in the hlist with the aggregator kprobe.
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001347 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001348static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001349{
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001350 /* Copy the insn slot of 'p' to 'ap'. */
Prasanna S Panchamukhi8b0914e2005-06-23 00:09:41 -07001351 copy_kprobe(p, ap);
bibo, maoa9ad9652006-07-30 03:03:26 -07001352 flush_insn_slot(ap);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001353 ap->addr = p->addr;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001354 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001355 ap->pre_handler = aggr_pre_handler;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001356 /* We don't care the kprobe which has gone. */
1357 if (p->post_handler && !kprobe_gone(p))
mao, bibo36721652006-06-26 00:25:22 -07001358 ap->post_handler = aggr_post_handler;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001359
1360 INIT_LIST_HEAD(&ap->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001361 INIT_HLIST_NODE(&ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001362
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001363 list_add_rcu(&p->list, &ap->list);
Keshavamurthy Anil Sadad0f32005-12-12 00:37:12 -08001364 hlist_replace_rcu(&p->hlist, &ap->hlist);
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001365}
1366
1367/*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001368 * This registers the second or subsequent kprobe at the same address.
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001369 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001370static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001371{
1372 int ret = 0;
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001373 struct kprobe *ap = orig_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001374
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001375 cpus_read_lock();
1376
Masami Hiramatsu25764282012-06-05 19:28:26 +09001377 /* For preparing optimization, jump_label_text_reserved() is called */
1378 jump_label_lock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001379 mutex_lock(&text_mutex);
1380
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001381 if (!kprobe_aggrprobe(orig_p)) {
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001382 /* If 'orig_p' is not an 'aggr_kprobe', create new one. */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001383 ap = alloc_aggr_kprobe(orig_p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001384 if (!ap) {
1385 ret = -ENOMEM;
1386 goto out;
1387 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001388 init_aggr_kprobe(ap, orig_p);
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001389 } else if (kprobe_unused(ap)) {
Masami Hiramatsu0490cd12010-12-03 18:54:16 +09001390 /* This probe is going to die. Rescue it */
Masami Hiramatsu819319f2018-09-11 19:20:40 +09001391 ret = reuse_unused_kprobe(ap);
1392 if (ret)
1393 goto out;
1394 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001395
1396 if (kprobe_gone(ap)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001397 /*
1398 * Attempting to insert new probe at the same location that
1399 * had a probe in the module vaddr area which already
1400 * freed. So, the instruction slot has already been
1401 * released. We need a new slot for the new probe.
1402 */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001403 ret = arch_prepare_kprobe(ap);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001404 if (ret)
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001405 /*
1406 * Even if fail to allocate new slot, don't need to
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001407 * free the 'ap'. It will be used next time, or
1408 * freed by unregister_kprobe().
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001409 */
Masami Hiramatsu25764282012-06-05 19:28:26 +09001410 goto out;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001411
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001412 /* Prepare optimized instructions if possible. */
1413 prepare_optimized_kprobe(ap);
1414
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001415 /*
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001416 * Clear gone flag to prevent allocating new slot again, and
1417 * set disabled flag because it is not armed yet.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001418 */
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001419 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1420 | KPROBE_FLAG_DISABLED;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001421 }
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001422
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001423 /* Copy the insn slot of 'p' to 'ap'. */
Masami Hiramatsub918e5e2009-04-06 19:00:58 -07001424 copy_kprobe(ap, p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001425 ret = add_new_kprobe(ap, p);
1426
1427out:
1428 mutex_unlock(&text_mutex);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001429 jump_label_unlock();
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001430 cpus_read_unlock();
Masami Hiramatsu25764282012-06-05 19:28:26 +09001431
1432 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1433 ap->flags &= ~KPROBE_FLAG_DISABLED;
Jessica Yu12310e342018-01-10 00:51:23 +01001434 if (!kprobes_all_disarmed) {
Masami Hiramatsu25764282012-06-05 19:28:26 +09001435 /* Arm the breakpoint again. */
Jessica Yu12310e342018-01-10 00:51:23 +01001436 ret = arm_kprobe(ap);
1437 if (ret) {
1438 ap->flags |= KPROBE_FLAG_DISABLED;
1439 list_del_rcu(&p->list);
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001440 synchronize_rcu();
Jessica Yu12310e342018-01-10 00:51:23 +01001441 }
1442 }
Masami Hiramatsu25764282012-06-05 19:28:26 +09001443 }
1444 return ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001445}
1446
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001447bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1448{
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001449 /* The '__kprobes' functions and entry code must not be probed. */
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001450 return addr >= (unsigned long)__kprobes_text_start &&
1451 addr < (unsigned long)__kprobes_text_end;
1452}
1453
Masami Hiramatsu6143c6f2019-02-13 01:13:12 +09001454static bool __within_kprobe_blacklist(unsigned long addr)
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001455{
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001456 struct kprobe_blacklist_entry *ent;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001457
Masami Hiramatsube8f2742014-04-17 17:16:58 +09001458 if (arch_within_kprobe_blacklist(addr))
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001459 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001460 /*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001461 * If 'kprobe_blacklist' is defined, check the address and
1462 * reject any probe registration in the prohibited area.
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001463 */
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001464 list_for_each_entry(ent, &kprobe_blacklist, list) {
1465 if (addr >= ent->start_addr && addr < ent->end_addr)
1466 return true;
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07001467 }
Masami Hiramatsu6143c6f2019-02-13 01:13:12 +09001468 return false;
1469}
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001470
Masami Hiramatsu6143c6f2019-02-13 01:13:12 +09001471bool within_kprobe_blacklist(unsigned long addr)
1472{
1473 char symname[KSYM_NAME_LEN], *p;
1474
1475 if (__within_kprobe_blacklist(addr))
1476 return true;
1477
1478 /* Check if the address is on a suffixed-symbol */
1479 if (!lookup_symbol_name(addr, symname)) {
1480 p = strchr(symname, '.');
1481 if (!p)
1482 return false;
1483 *p = '\0';
1484 addr = (unsigned long)kprobe_lookup_name(symname, 0);
1485 if (addr)
1486 return __within_kprobe_blacklist(addr);
1487 }
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001488 return false;
Prasanna S Panchamukhid0aaff92005-09-06 15:19:26 -07001489}
1490
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001491/*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001492 * If 'symbol_name' is specified, look it up and add the 'offset'
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001493 * to it. This way, we can specify a relative address to a symbol.
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001494 * This returns encoded errors if it fails to look up symbol or invalid
1495 * combination of parameters.
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001496 */
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301497static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1498 const char *symbol_name, unsigned int offset)
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001499{
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301500 if ((symbol_name && addr) || (!symbol_name && !addr))
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001501 goto invalid;
1502
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301503 if (symbol_name) {
Linus Torvalds7246f602017-05-05 11:36:44 -07001504 addr = kprobe_lookup_name(symbol_name, offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001505 if (!addr)
1506 return ERR_PTR(-ENOENT);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001507 }
1508
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301509 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001510 if (addr)
1511 return addr;
1512
1513invalid:
1514 return ERR_PTR(-EINVAL);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001515}
1516
Naveen N. Rao1d585e72017-03-08 13:56:06 +05301517static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1518{
1519 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1520}
1521
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001522/*
1523 * Check the 'p' is valid and return the aggregator kprobe
1524 * at the same address.
1525 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001526static struct kprobe *__get_valid_kprobe(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301527{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001528 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301529
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09001530 lockdep_assert_held(&kprobe_mutex);
1531
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001532 ap = get_kprobe(p->addr);
1533 if (unlikely(!ap))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301534 return NULL;
1535
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001536 if (p != ap) {
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09001537 list_for_each_entry(list_p, &ap->list, list)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301538 if (list_p == p)
1539 /* kprobe p is a valid probe */
1540 goto valid;
1541 return NULL;
1542 }
1543valid:
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001544 return ap;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301545}
1546
Masami Hiramatsu33b1d142021-02-03 23:59:27 +09001547/*
1548 * Warn and return error if the kprobe is being re-registered since
1549 * there must be a software bug.
1550 */
1551static inline int warn_kprobe_rereg(struct kprobe *p)
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301552{
1553 int ret = 0;
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301554
1555 mutex_lock(&kprobe_mutex);
Masami Hiramatsu33b1d142021-02-03 23:59:27 +09001556 if (WARN_ON_ONCE(__get_valid_kprobe(p)))
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301557 ret = -EINVAL;
1558 mutex_unlock(&kprobe_mutex);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001559
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301560 return ret;
1561}
1562
Punit Agrawal4402dea2021-09-14 23:39:16 +09001563static int check_ftrace_location(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564{
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001565 unsigned long ftrace_addr;
1566
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001567 ftrace_addr = ftrace_location((unsigned long)p->addr);
1568 if (ftrace_addr) {
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001569#ifdef CONFIG_KPROBES_ON_FTRACE
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001570 /* Given address is not on the instruction boundary */
1571 if ((unsigned long)p->addr != ftrace_addr)
1572 return -EILSEQ;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001573 p->flags |= KPROBE_FLAG_FTRACE;
Masami Hiramatsue7dbfe32012-09-28 17:15:20 +09001574#else /* !CONFIG_KPROBES_ON_FTRACE */
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001575 return -EINVAL;
1576#endif
1577 }
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001578 return 0;
1579}
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001580
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001581static int check_kprobe_address_safe(struct kprobe *p,
1582 struct module **probed_mod)
1583{
1584 int ret;
1585
Punit Agrawal4402dea2021-09-14 23:39:16 +09001586 ret = check_ftrace_location(p);
Heiko Carstensf7f242f2014-10-15 12:17:34 +02001587 if (ret)
1588 return ret;
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001589 jump_label_lock();
1590 preempt_disable();
1591
1592 /* Ensure it is not in reserved area nor out of text */
1593 if (!kernel_text_address((unsigned long) p->addr) ||
Masami Hiramatsu376e2422014-04-17 17:17:05 +09001594 within_kprobe_blacklist((unsigned long) p->addr) ||
Masami Hiramatsue336b402019-09-03 20:08:21 +09001595 jump_label_text_reserved(p->addr, p->addr) ||
Peter Zijlstrafa68bd02021-06-28 13:24:12 +02001596 static_call_text_reserved(p->addr, p->addr) ||
Masami Hiramatsue336b402019-09-03 20:08:21 +09001597 find_bug((unsigned long)p->addr)) {
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001598 ret = -EINVAL;
1599 goto out;
1600 }
1601
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001602 /* Check if 'p' is probing a module. */
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001603 *probed_mod = __module_text_address((unsigned long) p->addr);
1604 if (*probed_mod) {
1605 /*
1606 * We must hold a refcount of the probed module while updating
1607 * its code to prohibit unexpected unloading.
1608 */
1609 if (unlikely(!try_module_get(*probed_mod))) {
1610 ret = -ENOENT;
1611 goto out;
1612 }
1613
1614 /*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001615 * If the module freed '.init.text', we couldn't insert
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001616 * kprobes in there.
1617 */
1618 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1619 (*probed_mod)->state != MODULE_STATE_COMING) {
1620 module_put(*probed_mod);
1621 *probed_mod = NULL;
1622 ret = -ENOENT;
1623 }
1624 }
1625out:
1626 preempt_enable();
1627 jump_label_unlock();
1628
1629 return ret;
1630}
1631
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001632int register_kprobe(struct kprobe *p)
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001633{
1634 int ret;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001635 struct kprobe *old_p;
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001636 struct module *probed_mod;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001637 kprobe_opcode_t *addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001639 /* Adjust probe address from symbol */
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001640 addr = kprobe_addr(p);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09001641 if (IS_ERR(addr))
1642 return PTR_ERR(addr);
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08001643 p->addr = addr;
Ananth N Mavinakayanahalli3a872d82006-10-02 02:17:30 -07001644
Masami Hiramatsu33b1d142021-02-03 23:59:27 +09001645 ret = warn_kprobe_rereg(p);
Ananth N Mavinakayanahalli1f0ab402009-09-15 10:43:07 +05301646 if (ret)
1647 return ret;
1648
Masami Hiramatsude5bd882009-04-06 19:01:02 -07001649 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1650 p->flags &= KPROBE_FLAG_DISABLED;
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001651 p->nmissed = 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001652 INIT_LIST_HEAD(&p->list);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001653
Masami Hiramatsuf7fa6ef02012-06-05 19:28:20 +09001654 ret = check_kprobe_address_safe(p, &probed_mod);
1655 if (ret)
1656 return ret;
1657
1658 mutex_lock(&kprobe_mutex);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001659
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001660 old_p = get_kprobe(p->addr);
1661 if (old_p) {
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001662 /* Since this may unoptimize 'old_p', locking 'text_mutex'. */
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001663 ret = register_aggr_kprobe(old_p, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 goto out;
1665 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001667 cpus_read_lock();
1668 /* Prevent text modification */
1669 mutex_lock(&text_mutex);
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09001670 ret = prepare_kprobe(p);
Masami Hiramatsu25764282012-06-05 19:28:26 +09001671 mutex_unlock(&text_mutex);
Thomas Gleixner2d1e38f2017-05-24 10:15:36 +02001672 cpus_read_unlock();
Christoph Hellwig6f716ac2007-05-08 00:34:13 -07001673 if (ret)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001674 goto out;
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001675
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001676 INIT_HLIST_NODE(&p->hlist);
Ananth N Mavinakayanahalli3516a462005-11-07 01:00:13 -08001677 hlist_add_head_rcu(&p->hlist,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1679
Jessica Yu12310e342018-01-10 00:51:23 +01001680 if (!kprobes_all_disarmed && !kprobe_disabled(p)) {
1681 ret = arm_kprobe(p);
1682 if (ret) {
1683 hlist_del_rcu(&p->hlist);
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001684 synchronize_rcu();
Jessica Yu12310e342018-01-10 00:51:23 +01001685 goto out;
1686 }
1687 }
Christoph Hellwig74a0b572007-10-16 01:24:07 -07001688
Masami Hiramatsuafd66252010-02-25 08:34:07 -05001689 /* Try to optimize kprobe */
1690 try_to_optimize_kprobe(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691out:
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -08001692 mutex_unlock(&kprobe_mutex);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001693
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001694 if (probed_mod)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001695 module_put(probed_mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001696
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 return ret;
1698}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001699EXPORT_SYMBOL_GPL(register_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001701/* Check if all probes on the 'ap' are disabled. */
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +09001702static bool aggr_kprobe_disabled(struct kprobe *ap)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001703{
1704 struct kprobe *kp;
1705
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09001706 lockdep_assert_held(&kprobe_mutex);
1707
1708 list_for_each_entry(kp, &ap->list, list)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001709 if (!kprobe_disabled(kp))
1710 /*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001711 * Since there is an active probe on the list,
1712 * we can't disable this 'ap'.
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001713 */
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +09001714 return false;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001715
Masami Hiramatsu29e8077a2021-09-14 23:40:16 +09001716 return true;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001717}
1718
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001719static struct kprobe *__disable_kprobe(struct kprobe *p)
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001720{
1721 struct kprobe *orig_p;
Jessica Yu297f9232018-01-10 00:51:24 +01001722 int ret;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001723
Masami Hiramatsu57d4e312021-09-14 23:39:55 +09001724 lockdep_assert_held(&kprobe_mutex);
1725
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001726 /* Get an original kprobe for return */
1727 orig_p = __get_valid_kprobe(p);
1728 if (unlikely(orig_p == NULL))
Jessica Yu297f9232018-01-10 00:51:24 +01001729 return ERR_PTR(-EINVAL);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001730
1731 if (!kprobe_disabled(p)) {
1732 /* Disable probe if it is a child probe */
1733 if (p != orig_p)
1734 p->flags |= KPROBE_FLAG_DISABLED;
1735
1736 /* Try to disarm and disable this/parent probe */
1737 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
Wang Nan69d54b92015-02-13 14:40:26 -08001738 /*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09001739 * If 'kprobes_all_disarmed' is set, 'orig_p'
Wang Nan69d54b92015-02-13 14:40:26 -08001740 * should have already been disarmed, so
1741 * skip unneed disarming process.
1742 */
Jessica Yu297f9232018-01-10 00:51:24 +01001743 if (!kprobes_all_disarmed) {
1744 ret = disarm_kprobe(orig_p, true);
1745 if (ret) {
1746 p->flags &= ~KPROBE_FLAG_DISABLED;
1747 return ERR_PTR(ret);
1748 }
1749 }
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001750 orig_p->flags |= KPROBE_FLAG_DISABLED;
1751 }
1752 }
1753
1754 return orig_p;
1755}
1756
Masami Hiramatsu98616682008-04-28 02:14:28 -07001757/*
1758 * Unregister a kprobe without a scheduler synchronization.
1759 */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001760static int __unregister_kprobe_top(struct kprobe *p)
Keshavamurthy Anil Sdf019b12006-01-11 12:17:41 -08001761{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001762 struct kprobe *ap, *list_p;
Ananth N Mavinakayanahalli64f562c2005-05-05 16:15:42 -07001763
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001764 /* Disable kprobe. This will disarm it if needed. */
1765 ap = __disable_kprobe(p);
Jessica Yu297f9232018-01-10 00:51:24 +01001766 if (IS_ERR(ap))
1767 return PTR_ERR(ap);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001768
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001769 if (ap == p)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001770 /*
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001771 * This probe is an independent(and non-optimized) kprobe
1772 * (not an aggrprobe). Remove from the hash list.
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001773 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001774 goto disarmed;
1775
1776 /* Following process expects this probe is an aggrprobe */
1777 WARN_ON(!kprobe_aggrprobe(ap));
1778
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001779 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1780 /*
1781 * !disarmed could be happen if the probe is under delayed
1782 * unoptimizing.
1783 */
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001784 goto disarmed;
1785 else {
1786 /* If disabling probe has special handlers, update aggrprobe */
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001787 if (p->post_handler && !kprobe_gone(p)) {
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09001788 list_for_each_entry(list_p, &ap->list, list) {
Masami Hiramatsu98616682008-04-28 02:14:28 -07001789 if ((list_p != p) && (list_p->post_handler))
1790 goto noclean;
1791 }
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001792 ap->post_handler = NULL;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001793 }
1794noclean:
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001795 /*
1796 * Remove from the aggrprobe: this path will do nothing in
1797 * __unregister_kprobe_bottom().
1798 */
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001799 list_del_rcu(&p->list);
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001800 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1801 /*
1802 * Try to optimize this probe again, because post
1803 * handler may have been changed.
1804 */
1805 optimize_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001806 }
Masami Hiramatsu98616682008-04-28 02:14:28 -07001807 return 0;
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09001808
1809disarmed:
1810 hlist_del_rcu(&ap->hlist);
1811 return 0;
Masami Hiramatsu98616682008-04-28 02:14:28 -07001812}
Mao, Bibob3e55c72005-12-12 00:37:00 -08001813
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001814static void __unregister_kprobe_bottom(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001815{
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001816 struct kprobe *ap;
Mao, Bibob3e55c72005-12-12 00:37:00 -08001817
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001818 if (list_empty(&p->list))
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001819 /* This is an independent kprobe */
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -08001820 arch_remove_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001821 else if (list_is_singular(&p->list)) {
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001822 /* This is the last child of an aggrprobe */
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001823 ap = list_entry(p->list.next, struct kprobe, list);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08001824 list_del(&p->list);
Masami Hiramatsu6d8e40a2010-12-03 18:53:50 +09001825 free_aggr_kprobe(ap);
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -08001826 }
Masami Hiramatsu6274de42010-12-03 18:54:09 +09001827 /* Otherwise, do nothing. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828}
1829
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001830int register_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001831{
1832 int i, ret = 0;
1833
1834 if (num <= 0)
1835 return -EINVAL;
1836 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08001837 ret = register_kprobe(kps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07001838 if (ret < 0) {
1839 if (i > 0)
1840 unregister_kprobes(kps, i);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001841 break;
1842 }
1843 }
1844 return ret;
1845}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001846EXPORT_SYMBOL_GPL(register_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001847
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001848void unregister_kprobe(struct kprobe *p)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001849{
1850 unregister_kprobes(&p, 1);
1851}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001852EXPORT_SYMBOL_GPL(unregister_kprobe);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001853
Masami Hiramatsu55479f62014-04-17 17:17:54 +09001854void unregister_kprobes(struct kprobe **kps, int num)
Masami Hiramatsu98616682008-04-28 02:14:28 -07001855{
1856 int i;
1857
1858 if (num <= 0)
1859 return;
1860 mutex_lock(&kprobe_mutex);
1861 for (i = 0; i < num; i++)
1862 if (__unregister_kprobe_top(kps[i]) < 0)
1863 kps[i]->addr = NULL;
1864 mutex_unlock(&kprobe_mutex);
1865
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08001866 synchronize_rcu();
Masami Hiramatsu98616682008-04-28 02:14:28 -07001867 for (i = 0; i < num; i++)
1868 if (kps[i]->addr)
1869 __unregister_kprobe_bottom(kps[i]);
1870}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07001871EXPORT_SYMBOL_GPL(unregister_kprobes);
Masami Hiramatsu98616682008-04-28 02:14:28 -07001872
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301873int __weak kprobe_exceptions_notify(struct notifier_block *self,
1874 unsigned long val, void *data)
Naveen N. Raofc62d022017-02-08 01:24:14 +05301875{
1876 return NOTIFY_DONE;
1877}
Naveen N. Rao5f6bee32017-03-08 22:34:15 +05301878NOKPROBE_SYMBOL(kprobe_exceptions_notify);
Naveen N. Raofc62d022017-02-08 01:24:14 +05301879
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880static struct notifier_block kprobe_exceptions_nb = {
1881 .notifier_call = kprobe_exceptions_notify,
Anil S Keshavamurthy3d5631e2006-06-26 00:25:28 -07001882 .priority = 0x7fffffff /* we need to be notified first */
1883};
1884
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08001885#ifdef CONFIG_KRETPROBES
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001886
Masami Hiramatsu03bac0d2021-09-14 23:41:04 +09001887/* This assumes the 'tsk' is the current task or the is not running. */
1888static kprobe_opcode_t *__kretprobe_find_ret_addr(struct task_struct *tsk,
1889 struct llist_node **cur)
1890{
1891 struct kretprobe_instance *ri = NULL;
1892 struct llist_node *node = *cur;
1893
1894 if (!node)
1895 node = tsk->kretprobe_instances.first;
1896 else
1897 node = node->next;
1898
1899 while (node) {
1900 ri = container_of(node, struct kretprobe_instance, llist);
1901 if (ri->ret_addr != kretprobe_trampoline_addr()) {
1902 *cur = node;
1903 return ri->ret_addr;
1904 }
1905 node = node->next;
1906 }
1907 return NULL;
1908}
1909NOKPROBE_SYMBOL(__kretprobe_find_ret_addr);
1910
1911/**
1912 * kretprobe_find_ret_addr -- Find correct return address modified by kretprobe
1913 * @tsk: Target task
1914 * @fp: A frame pointer
1915 * @cur: a storage of the loop cursor llist_node pointer for next call
1916 *
1917 * Find the correct return address modified by a kretprobe on @tsk in unsigned
1918 * long type. If it finds the return address, this returns that address value,
1919 * or this returns 0.
1920 * The @tsk must be 'current' or a task which is not running. @fp is a hint
1921 * to get the currect return address - which is compared with the
1922 * kretprobe_instance::fp field. The @cur is a loop cursor for searching the
1923 * kretprobe return addresses on the @tsk. The '*@cur' should be NULL at the
1924 * first call, but '@cur' itself must NOT NULL.
1925 */
1926unsigned long kretprobe_find_ret_addr(struct task_struct *tsk, void *fp,
1927 struct llist_node **cur)
1928{
1929 struct kretprobe_instance *ri = NULL;
1930 kprobe_opcode_t *ret;
1931
1932 if (WARN_ON_ONCE(!cur))
1933 return 0;
1934
1935 do {
1936 ret = __kretprobe_find_ret_addr(tsk, cur);
1937 if (!ret)
1938 break;
1939 ri = container_of(*cur, struct kretprobe_instance, llist);
1940 } while (ri->fp != fp);
1941
1942 return (unsigned long)ret;
1943}
1944NOKPROBE_SYMBOL(kretprobe_find_ret_addr);
1945
Masami Hiramatsubf094cf2021-09-14 23:42:51 +09001946void __weak arch_kretprobe_fixup_return(struct pt_regs *regs,
1947 kprobe_opcode_t *correct_ret_addr)
1948{
1949 /*
1950 * Do nothing by default. Please fill this to update the fake return
1951 * address on the stack with the correct one on each arch if possible.
1952 */
1953}
1954
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001955unsigned long __kretprobe_trampoline_handler(struct pt_regs *regs,
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001956 void *frame_pointer)
1957{
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001958 kprobe_opcode_t *correct_ret_addr = NULL;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001959 struct kretprobe_instance *ri = NULL;
Masami Hiramatsu03bac0d2021-09-14 23:41:04 +09001960 struct llist_node *first, *node = NULL;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001961 struct kretprobe *rp;
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001962
Masami Hiramatsu03bac0d2021-09-14 23:41:04 +09001963 /* Find correct address and all nodes for this frame. */
1964 correct_ret_addr = __kretprobe_find_ret_addr(current, &node);
1965 if (!correct_ret_addr) {
1966 pr_err("kretprobe: Return address not found, not execute handler. Maybe there is a bug in the kernel.\n");
1967 BUG_ON(1);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001968 }
1969
Masami Hiramatsudf91c5b2021-09-14 23:42:12 +09001970 /*
1971 * Set the return address as the instruction pointer, because if the
1972 * user handler calls stack_trace_save_regs() with this 'regs',
1973 * the stack trace will start from the instruction pointer.
1974 */
1975 instruction_pointer_set(regs, (unsigned long)correct_ret_addr);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001976
Masami Hiramatsu03bac0d2021-09-14 23:41:04 +09001977 /* Run the user handler of the nodes. */
1978 first = current->kretprobe_instances.first;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001979 while (first) {
1980 ri = container_of(first, struct kretprobe_instance, llist);
Masami Hiramatsu03bac0d2021-09-14 23:41:04 +09001981
1982 if (WARN_ON_ONCE(ri->fp != frame_pointer))
1983 break;
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001984
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001985 rp = get_kretprobe(ri);
1986 if (rp && rp->handler) {
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001987 struct kprobe *prev = kprobe_running();
1988
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001989 __this_cpu_write(current_kprobe, &rp->kp);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001990 ri->ret_addr = correct_ret_addr;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09001991 rp->handler(ri, regs);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09001992 __this_cpu_write(current_kprobe, prev);
1993 }
Masami Hiramatsu03bac0d2021-09-14 23:41:04 +09001994 if (first == node)
1995 break;
1996
1997 first = first->next;
1998 }
1999
Masami Hiramatsubf094cf2021-09-14 23:42:51 +09002000 arch_kretprobe_fixup_return(regs, correct_ret_addr);
2001
Masami Hiramatsu03bac0d2021-09-14 23:41:04 +09002002 /* Unlink all nodes for this frame. */
2003 first = current->kretprobe_instances.first;
2004 current->kretprobe_instances.first = node->next;
2005 node->next = NULL;
2006
2007 /* Recycle free instances. */
2008 while (first) {
2009 ri = container_of(first, struct kretprobe_instance, llist);
2010 first = first->next;
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09002011
Masami Hiramatsub3388172020-08-29 22:02:47 +09002012 recycle_rp_inst(ri);
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09002013 }
2014
Masami Hiramatsu66ada2c2020-08-29 22:00:01 +09002015 return (unsigned long)correct_ret_addr;
2016}
2017NOKPROBE_SYMBOL(__kretprobe_trampoline_handler)
2018
Adrian Bunke65cefe2006-02-03 03:03:42 -08002019/*
2020 * This kprobe pre_handler is registered with every kretprobe. When probe
2021 * hits it will set up the return probe.
2022 */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002023static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Adrian Bunke65cefe2006-02-03 03:03:42 -08002024{
2025 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002026 struct kretprobe_instance *ri;
Peter Zijlstra6e426e02020-08-29 22:03:56 +09002027 struct freelist_node *fn;
Adrian Bunke65cefe2006-02-03 03:03:42 -08002028
Peter Zijlstra6e426e02020-08-29 22:03:56 +09002029 fn = freelist_try_get(&rp->freelist);
2030 if (!fn) {
Christoph Hellwig4c4308c2007-05-08 00:34:14 -07002031 rp->nmissed++;
Peter Zijlstra6e426e02020-08-29 22:03:56 +09002032 return 0;
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002033 }
Peter Zijlstra6e426e02020-08-29 22:03:56 +09002034
2035 ri = container_of(fn, struct kretprobe_instance, freelist);
2036
2037 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
2038 freelist_add(&ri->freelist, &rp->freelist);
2039 return 0;
2040 }
2041
2042 arch_prepare_kretprobe(ri, regs);
2043
2044 __llist_add(&ri->llist, &current->kretprobe_instances);
2045
Adrian Bunke65cefe2006-02-03 03:03:42 -08002046 return 0;
2047}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002048NOKPROBE_SYMBOL(pre_handler_kretprobe);
Adrian Bunke65cefe2006-02-03 03:03:42 -08002049
Naveen N. Rao659b9572017-07-07 22:37:24 +05302050bool __weak arch_kprobe_on_func_entry(unsigned long offset)
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05302051{
2052 return !offset;
2053}
2054
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09002055/**
2056 * kprobe_on_func_entry() -- check whether given address is function entry
2057 * @addr: Target address
2058 * @sym: Target symbol name
2059 * @offset: The offset from the symbol or the address
2060 *
2061 * This checks whether the given @addr+@offset or @sym+@offset is on the
2062 * function entry address or not.
2063 * This returns 0 if it is the function entry, or -EINVAL if it is not.
2064 * And also it returns -ENOENT if it fails the symbol or address lookup.
2065 * Caller must pass @addr or @sym (either one must be NULL), or this
2066 * returns -EINVAL.
2067 */
2068int kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
Naveen N. Rao1d585e72017-03-08 13:56:06 +05302069{
2070 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
2071
2072 if (IS_ERR(kp_addr))
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09002073 return PTR_ERR(kp_addr);
Naveen N. Rao1d585e72017-03-08 13:56:06 +05302074
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09002075 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset))
2076 return -ENOENT;
Naveen N. Rao1d585e72017-03-08 13:56:06 +05302077
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09002078 if (!arch_kprobe_on_func_entry(offset))
2079 return -EINVAL;
2080
2081 return 0;
Naveen N. Rao1d585e72017-03-08 13:56:06 +05302082}
2083
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002084int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07002085{
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09002086 int ret;
Hien Nguyenb94cce92005-06-23 00:09:19 -07002087 struct kretprobe_instance *inst;
2088 int i;
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08002089 void *addr;
Naveen N. Rao90ec5e82017-02-22 19:23:37 +05302090
Masami Hiramatsu97c753e2021-01-28 00:37:51 +09002091 ret = kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset);
2092 if (ret)
2093 return ret;
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002094
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002095 /* If only 'rp->kp.addr' is specified, check reregistering kprobes */
Masami Hiramatsu33b1d142021-02-03 23:59:27 +09002096 if (rp->kp.addr && warn_kprobe_rereg(&rp->kp))
Wang ShaoBo0188b872021-01-28 20:44:27 +08002097 return -EINVAL;
2098
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002099 if (kretprobe_blacklist_size) {
Masami Hiramatsub2a5cd62008-03-04 14:29:44 -08002100 addr = kprobe_addr(&rp->kp);
Masami Hiramatsubc81d482011-06-27 16:26:50 +09002101 if (IS_ERR(addr))
2102 return PTR_ERR(addr);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002103
2104 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2105 if (kretprobe_blacklist[i].addr == addr)
2106 return -EINVAL;
2107 }
2108 }
Hien Nguyenb94cce92005-06-23 00:09:19 -07002109
Masami Hiramatsu6bbfa442021-12-01 23:45:50 +09002110 if (rp->data_size > KRETPROBE_MAX_DATA_SIZE)
2111 return -E2BIG;
2112
Hien Nguyenb94cce92005-06-23 00:09:19 -07002113 rp->kp.pre_handler = pre_handler_kretprobe;
Ananth N Mavinakayanahalli7522a842006-04-20 02:43:11 -07002114 rp->kp.post_handler = NULL;
Hien Nguyenb94cce92005-06-23 00:09:19 -07002115
2116 /* Pre-allocate memory for max kretprobe instances */
2117 if (rp->maxactive <= 0) {
Thomas Gleixner92616602019-07-26 23:19:41 +02002118#ifdef CONFIG_PREEMPTION
Heiko Carstensc2ef6662009-12-21 13:02:24 +01002119 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
Hien Nguyenb94cce92005-06-23 00:09:19 -07002120#else
Ananth N Mavinakayanahalli4dae5602009-10-30 19:23:10 +05302121 rp->maxactive = num_possible_cpus();
Hien Nguyenb94cce92005-06-23 00:09:19 -07002122#endif
2123 }
Peter Zijlstra6e426e02020-08-29 22:03:56 +09002124 rp->freelist.head = NULL;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002125 rp->rph = kzalloc(sizeof(struct kretprobe_holder), GFP_KERNEL);
2126 if (!rp->rph)
2127 return -ENOMEM;
2128
2129 rp->rph->rp = rp;
Hien Nguyenb94cce92005-06-23 00:09:19 -07002130 for (i = 0; i < rp->maxactive; i++) {
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002131 inst = kzalloc(sizeof(struct kretprobe_instance) +
Abhishek Sagarf47cd9b2008-02-06 01:38:22 -08002132 rp->data_size, GFP_KERNEL);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002133 if (inst == NULL) {
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002134 refcount_set(&rp->rph->ref, i);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002135 free_rp_inst(rp);
2136 return -ENOMEM;
2137 }
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002138 inst->rph = rp->rph;
Peter Zijlstra6e426e02020-08-29 22:03:56 +09002139 freelist_add(&inst->freelist, &rp->freelist);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002140 }
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002141 refcount_set(&rp->rph->ref, i);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002142
2143 rp->nmissed = 0;
2144 /* Establish function entry probe point */
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08002145 ret = register_kprobe(&rp->kp);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002146 if (ret != 0)
Hien Nguyenb94cce92005-06-23 00:09:19 -07002147 free_rp_inst(rp);
2148 return ret;
2149}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002150EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002151
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002152int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002153{
2154 int ret = 0, i;
2155
2156 if (num <= 0)
2157 return -EINVAL;
2158 for (i = 0; i < num; i++) {
Masami Hiramatsu49ad2fd2009-01-06 14:41:53 -08002159 ret = register_kretprobe(rps[i]);
Masami Hiramatsu67dddaa2008-06-12 15:21:35 -07002160 if (ret < 0) {
2161 if (i > 0)
2162 unregister_kretprobes(rps, i);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002163 break;
2164 }
2165 }
2166 return ret;
2167}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002168EXPORT_SYMBOL_GPL(register_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002169
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002170void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002171{
2172 unregister_kretprobes(&rp, 1);
2173}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002174EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002175
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002176void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002177{
2178 int i;
2179
2180 if (num <= 0)
2181 return;
2182 mutex_lock(&kprobe_mutex);
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002183 for (i = 0; i < num; i++) {
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002184 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
2185 rps[i]->kp.addr = NULL;
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002186 rps[i]->rph->rp = NULL;
2187 }
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002188 mutex_unlock(&kprobe_mutex);
2189
Paul E. McKenneyae8b7ce2018-11-06 19:04:39 -08002190 synchronize_rcu();
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002191 for (i = 0; i < num; i++) {
2192 if (rps[i]->kp.addr) {
2193 __unregister_kprobe_bottom(&rps[i]->kp);
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002194 free_rp_inst(rps[i]);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002195 }
2196 }
2197}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002198EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002199
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002200#else /* CONFIG_KRETPROBES */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002201int register_kretprobe(struct kretprobe *rp)
Hien Nguyenb94cce92005-06-23 00:09:19 -07002202{
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002203 return -EOPNOTSUPP;
Hien Nguyenb94cce92005-06-23 00:09:19 -07002204}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002205EXPORT_SYMBOL_GPL(register_kretprobe);
Hien Nguyenb94cce92005-06-23 00:09:19 -07002206
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002207int register_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002208{
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002209 return -EOPNOTSUPP;
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002210}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002211EXPORT_SYMBOL_GPL(register_kretprobes);
2212
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002213void unregister_kretprobe(struct kretprobe *rp)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002214{
2215}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002216EXPORT_SYMBOL_GPL(unregister_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002217
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002218void unregister_kretprobes(struct kretprobe **rps, int num)
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002219{
2220}
Masami Hiramatsu99081ab2009-04-06 19:00:59 -07002221EXPORT_SYMBOL_GPL(unregister_kretprobes);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002222
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002223static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002224{
2225 return 0;
2226}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002227NOKPROBE_SYMBOL(pre_handler_kretprobe);
Masami Hiramatsu4a296e02008-04-28 02:14:29 -07002228
Ananth N Mavinakayanahalli9edddaa2008-03-04 14:28:37 -08002229#endif /* CONFIG_KRETPROBES */
Hien Nguyenb94cce92005-06-23 00:09:19 -07002230
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002231/* Set the kprobe gone and remove its instruction buffer. */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002232static void kill_kprobe(struct kprobe *p)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002233{
2234 struct kprobe *kp;
Masami Hiramatsude5bd882009-04-06 19:01:02 -07002235
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002236 lockdep_assert_held(&kprobe_mutex);
2237
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002238 p->flags |= KPROBE_FLAG_GONE;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002239 if (kprobe_aggrprobe(p)) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002240 /*
2241 * If this is an aggr_kprobe, we have to list all the
2242 * chained probes and mark them GONE.
2243 */
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002244 list_for_each_entry(kp, &p->list, list)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002245 kp->flags |= KPROBE_FLAG_GONE;
2246 p->post_handler = NULL;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002247 kill_optimized_kprobe(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002248 }
2249 /*
2250 * Here, we can remove insn_slot safely, because no thread calls
2251 * the original probed function (which will be freed soon) any more.
2252 */
2253 arch_remove_kprobe(p);
Muchun Song0cb2f132020-07-28 14:45:36 +08002254
2255 /*
2256 * The module is going away. We should disarm the kprobe which
Masami Hiramatsubcb53202020-09-01 00:12:07 +09002257 * is using ftrace, because ftrace framework is still available at
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002258 * 'MODULE_STATE_GOING' notification.
Muchun Song0cb2f132020-07-28 14:45:36 +08002259 */
Masami Hiramatsubcb53202020-09-01 00:12:07 +09002260 if (kprobe_ftrace(p) && !kprobe_disabled(p) && !kprobes_all_disarmed)
Muchun Song0cb2f132020-07-28 14:45:36 +08002261 disarm_kprobe_ftrace(p);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002262}
2263
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002264/* Disable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002265int disable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002266{
2267 int ret = 0;
Jessica Yu297f9232018-01-10 00:51:24 +01002268 struct kprobe *p;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002269
2270 mutex_lock(&kprobe_mutex);
2271
Masami Hiramatsu6f0f1dd2010-12-03 18:53:57 +09002272 /* Disable this kprobe */
Jessica Yu297f9232018-01-10 00:51:24 +01002273 p = __disable_kprobe(kp);
2274 if (IS_ERR(p))
2275 ret = PTR_ERR(p);
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002276
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002277 mutex_unlock(&kprobe_mutex);
2278 return ret;
2279}
2280EXPORT_SYMBOL_GPL(disable_kprobe);
2281
2282/* Enable one kprobe */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002283int enable_kprobe(struct kprobe *kp)
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002284{
2285 int ret = 0;
2286 struct kprobe *p;
2287
2288 mutex_lock(&kprobe_mutex);
2289
2290 /* Check whether specified probe is valid. */
2291 p = __get_valid_kprobe(kp);
2292 if (unlikely(p == NULL)) {
2293 ret = -EINVAL;
2294 goto out;
2295 }
2296
2297 if (kprobe_gone(kp)) {
2298 /* This kprobe has gone, we couldn't enable it. */
2299 ret = -EINVAL;
2300 goto out;
2301 }
2302
2303 if (p != kp)
2304 kp->flags &= ~KPROBE_FLAG_DISABLED;
2305
2306 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2307 p->flags &= ~KPROBE_FLAG_DISABLED;
Jessica Yu12310e342018-01-10 00:51:23 +01002308 ret = arm_kprobe(p);
2309 if (ret)
2310 p->flags |= KPROBE_FLAG_DISABLED;
Masami Hiramatsuc0614822010-04-27 18:33:12 -04002311 }
2312out:
2313 mutex_unlock(&kprobe_mutex);
2314 return ret;
2315}
2316EXPORT_SYMBOL_GPL(enable_kprobe);
2317
Masami Hiramatsu44585152018-04-28 21:36:33 +09002318/* Caller must NOT call this in usual path. This is only for critical case */
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002319void dump_kprobe(struct kprobe *kp)
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002320{
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09002321 pr_err("Dump kprobe:\n.symbol_name = %s, .offset = %x, .addr = %pS\n",
Masami Hiramatsu44585152018-04-28 21:36:33 +09002322 kp->symbol_name, kp->offset, kp->addr);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002323}
Masami Hiramatsu820aede2014-04-17 17:18:21 +09002324NOKPROBE_SYMBOL(dump_kprobe);
Frederic Weisbecker24851d22009-08-26 23:38:30 +02002325
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002326int kprobe_add_ksym_blacklist(unsigned long entry)
2327{
2328 struct kprobe_blacklist_entry *ent;
2329 unsigned long offset = 0, size = 0;
2330
2331 if (!kernel_text_address(entry) ||
2332 !kallsyms_lookup_size_offset(entry, &size, &offset))
2333 return -EINVAL;
2334
2335 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2336 if (!ent)
2337 return -ENOMEM;
2338 ent->start_addr = entry;
2339 ent->end_addr = entry + size;
2340 INIT_LIST_HEAD(&ent->list);
2341 list_add_tail(&ent->list, &kprobe_blacklist);
2342
2343 return (int)size;
2344}
2345
2346/* Add all symbols in given area into kprobe blacklist */
2347int kprobe_add_area_blacklist(unsigned long start, unsigned long end)
2348{
2349 unsigned long entry;
2350 int ret = 0;
2351
2352 for (entry = start; entry < end; entry += ret) {
2353 ret = kprobe_add_ksym_blacklist(entry);
2354 if (ret < 0)
2355 return ret;
2356 if (ret == 0) /* In case of alias symbol */
2357 ret = 1;
2358 }
2359 return 0;
2360}
2361
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002362/* Remove all symbols in given area from kprobe blacklist */
2363static void kprobe_remove_area_blacklist(unsigned long start, unsigned long end)
2364{
2365 struct kprobe_blacklist_entry *ent, *n;
2366
2367 list_for_each_entry_safe(ent, n, &kprobe_blacklist, list) {
2368 if (ent->start_addr < start || ent->start_addr >= end)
2369 continue;
2370 list_del(&ent->list);
2371 kfree(ent);
2372 }
2373}
2374
Masami Hiramatsu16db6262020-03-26 23:50:00 +09002375static void kprobe_remove_ksym_blacklist(unsigned long entry)
2376{
2377 kprobe_remove_area_blacklist(entry, entry + 1);
2378}
2379
Adrian Hunterd002b8b2020-05-28 11:00:58 +03002380int __weak arch_kprobe_get_kallsym(unsigned int *symnum, unsigned long *value,
2381 char *type, char *sym)
2382{
2383 return -ERANGE;
2384}
2385
2386int kprobe_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
2387 char *sym)
2388{
2389#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
2390 if (!kprobe_cache_get_kallsym(&kprobe_insn_slots, &symnum, value, type, sym))
2391 return 0;
2392#ifdef CONFIG_OPTPROBES
2393 if (!kprobe_cache_get_kallsym(&kprobe_optinsn_slots, &symnum, value, type, sym))
2394 return 0;
2395#endif
2396#endif
2397 if (!arch_kprobe_get_kallsym(&symnum, value, type, sym))
2398 return 0;
2399 return -ERANGE;
2400}
2401
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002402int __init __weak arch_populate_kprobe_blacklist(void)
2403{
2404 return 0;
2405}
2406
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002407/*
2408 * Lookup and populate the kprobe_blacklist.
2409 *
2410 * Unlike the kretprobe blacklist, we'll need to determine
2411 * the range of addresses that belong to the said functions,
2412 * since a kprobe need not necessarily be at the beginning
2413 * of a function.
2414 */
2415static int __init populate_kprobe_blacklist(unsigned long *start,
2416 unsigned long *end)
2417{
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002418 unsigned long entry;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002419 unsigned long *iter;
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002420 int ret;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002421
2422 for (iter = start; iter < end; iter++) {
Masami Hiramatsuf2ec8d92021-09-14 23:40:36 +09002423 entry = (unsigned long)dereference_symbol_descriptor((void *)*iter);
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002424 ret = kprobe_add_ksym_blacklist(entry);
2425 if (ret == -EINVAL)
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002426 continue;
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002427 if (ret < 0)
2428 return ret;
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002429 }
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002430
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002431 /* Symbols in '__kprobes_text' are blacklisted */
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002432 ret = kprobe_add_area_blacklist((unsigned long)__kprobes_text_start,
2433 (unsigned long)__kprobes_text_end);
Thomas Gleixner66e9b072020-03-10 14:04:34 +01002434 if (ret)
2435 return ret;
2436
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002437 /* Symbols in 'noinstr' section are blacklisted */
Thomas Gleixner66e9b072020-03-10 14:04:34 +01002438 ret = kprobe_add_area_blacklist((unsigned long)__noinstr_text_start,
2439 (unsigned long)__noinstr_text_end);
Masami Hiramatsufb1a59f2018-12-17 17:20:55 +09002440
2441 return ret ? : arch_populate_kprobe_blacklist();
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002442}
2443
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002444static void add_module_kprobe_blacklist(struct module *mod)
2445{
2446 unsigned long start, end;
Masami Hiramatsu16db6262020-03-26 23:50:00 +09002447 int i;
2448
2449 if (mod->kprobe_blacklist) {
2450 for (i = 0; i < mod->num_kprobe_blacklist; i++)
2451 kprobe_add_ksym_blacklist(mod->kprobe_blacklist[i]);
2452 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002453
2454 start = (unsigned long)mod->kprobes_text_start;
2455 if (start) {
2456 end = start + mod->kprobes_text_size;
2457 kprobe_add_area_blacklist(start, end);
2458 }
Thomas Gleixner66e9b072020-03-10 14:04:34 +01002459
2460 start = (unsigned long)mod->noinstr_text_start;
2461 if (start) {
2462 end = start + mod->noinstr_text_size;
2463 kprobe_add_area_blacklist(start, end);
2464 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002465}
2466
2467static void remove_module_kprobe_blacklist(struct module *mod)
2468{
2469 unsigned long start, end;
Masami Hiramatsu16db6262020-03-26 23:50:00 +09002470 int i;
2471
2472 if (mod->kprobe_blacklist) {
2473 for (i = 0; i < mod->num_kprobe_blacklist; i++)
2474 kprobe_remove_ksym_blacklist(mod->kprobe_blacklist[i]);
2475 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002476
2477 start = (unsigned long)mod->kprobes_text_start;
2478 if (start) {
2479 end = start + mod->kprobes_text_size;
2480 kprobe_remove_area_blacklist(start, end);
2481 }
Thomas Gleixner66e9b072020-03-10 14:04:34 +01002482
2483 start = (unsigned long)mod->noinstr_text_start;
2484 if (start) {
2485 end = start + mod->noinstr_text_size;
2486 kprobe_remove_area_blacklist(start, end);
2487 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002488}
2489
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002490/* Module notifier call back, checking kprobes on the module */
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002491static int kprobes_module_callback(struct notifier_block *nb,
2492 unsigned long val, void *data)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002493{
2494 struct module *mod = data;
2495 struct hlist_head *head;
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002496 struct kprobe *p;
2497 unsigned int i;
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002498 int checkcore = (val == MODULE_STATE_GOING);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002499
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002500 if (val == MODULE_STATE_COMING) {
2501 mutex_lock(&kprobe_mutex);
2502 add_module_kprobe_blacklist(mod);
2503 mutex_unlock(&kprobe_mutex);
2504 }
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002505 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002506 return NOTIFY_DONE;
2507
2508 /*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002509 * When 'MODULE_STATE_GOING' was notified, both of module '.text' and
2510 * '.init.text' sections would be freed. When 'MODULE_STATE_LIVE' was
2511 * notified, only '.init.text' section would be freed. We need to
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002512 * disable kprobes which have been inserted in the sections.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002513 */
2514 mutex_lock(&kprobe_mutex);
2515 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2516 head = &kprobe_table[i];
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002517 hlist_for_each_entry(p, head, hlist)
Masami Hiramatsuf24659d2009-01-06 14:41:55 -08002518 if (within_module_init((unsigned long)p->addr, mod) ||
2519 (checkcore &&
2520 within_module_core((unsigned long)p->addr, mod))) {
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002521 /*
2522 * The vaddr this probe is installed will soon
2523 * be vfreed buy not synced to disk. Hence,
2524 * disarming the breakpoint isn't needed.
Steven Rostedt (VMware)545a0282017-05-16 14:58:35 -04002525 *
2526 * Note, this will also move any optimized probes
2527 * that are pending to be removed from their
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002528 * corresponding lists to the 'freeing_list' and
Steven Rostedt (VMware)545a0282017-05-16 14:58:35 -04002529 * will not be touched by the delayed
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002530 * kprobe_optimizer() work handler.
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002531 */
2532 kill_kprobe(p);
2533 }
2534 }
Masami Hiramatsu1e6769b2020-03-26 23:49:48 +09002535 if (val == MODULE_STATE_GOING)
2536 remove_module_kprobe_blacklist(mod);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002537 mutex_unlock(&kprobe_mutex);
2538 return NOTIFY_DONE;
2539}
2540
2541static struct notifier_block kprobe_module_nb = {
2542 .notifier_call = kprobes_module_callback,
2543 .priority = 0
2544};
2545
Masami Hiramatsu82d083a2020-09-10 17:55:05 +09002546void kprobe_free_init_mem(void)
2547{
2548 void *start = (void *)(&__init_begin);
2549 void *end = (void *)(&__init_end);
2550 struct hlist_head *head;
2551 struct kprobe *p;
2552 int i;
2553
2554 mutex_lock(&kprobe_mutex);
2555
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002556 /* Kill all kprobes on initmem because the target code has been freed. */
Masami Hiramatsu82d083a2020-09-10 17:55:05 +09002557 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2558 head = &kprobe_table[i];
2559 hlist_for_each_entry(p, head, hlist) {
2560 if (start <= (void *)p->addr && (void *)p->addr < end)
2561 kill_kprobe(p);
2562 }
2563 }
2564
2565 mutex_unlock(&kprobe_mutex);
2566}
2567
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568static int __init init_kprobes(void)
2569{
2570 int i, err = 0;
2571
2572 /* FIXME allocate the probe table, currently defined statically */
2573 /* initialize all list heads */
Peter Zijlstrad741bf42020-08-29 22:03:24 +09002574 for (i = 0; i < KPROBE_TABLE_SIZE; i++)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002575 INIT_HLIST_HEAD(&kprobe_table[i]);
2576
Masami Hiramatsu376e2422014-04-17 17:17:05 +09002577 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2578 __stop_kprobe_blacklist);
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002579 if (err)
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09002580 pr_err("Failed to populate blacklist (error %d), kprobes not restricted, be careful using them!\n", err);
Srinivasa Ds3d8d9962008-04-28 02:14:26 -07002581
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002582 if (kretprobe_blacklist_size) {
2583 /* lookup the function address from its name */
2584 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
Naveen N. Rao49e0b462017-04-19 18:21:00 +05302585 kretprobe_blacklist[i].addr =
Naveen N. Rao290e3072017-04-19 18:21:01 +05302586 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002587 if (!kretprobe_blacklist[i].addr)
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09002588 pr_err("Failed to lookup symbol '%s' for kretprobe blacklist. Maybe the target function is removed or renamed.\n",
Masami Hiramatsuf438d912007-10-16 01:27:49 -07002589 kretprobe_blacklist[i].name);
2590 }
2591 }
2592
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002593 /* By default, kprobes are armed */
2594 kprobes_all_disarmed = false;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002595
Masami Hiramatsuc85c9a22021-02-18 23:29:23 +09002596#if defined(CONFIG_OPTPROBES) && defined(__ARCH_WANT_KPROBES_INSN_SLOT)
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002597 /* Init 'kprobe_optinsn_slots' for allocation */
Masami Hiramatsuc85c9a22021-02-18 23:29:23 +09002598 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2599#endif
2600
Rusty Lynch67729262005-07-05 18:54:50 -07002601 err = arch_init_kprobes();
Rusty Lynch802eae72005-06-27 15:17:08 -07002602 if (!err)
2603 err = register_die_notifier(&kprobe_exceptions_nb);
Masami Hiramatsue8386a02009-01-06 14:41:52 -08002604 if (!err)
2605 err = register_module_notifier(&kprobe_module_nb);
2606
Srinivasa D Sef53d9c2008-07-25 01:46:04 -07002607 kprobes_initialized = (err == 0);
Xiaoming Nia737a3c2022-01-21 22:13:41 -08002608 kprobe_sysctls_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609 return err;
2610}
Masami Hiramatsu36dadef2020-09-10 21:38:39 +09002611early_initcall(init_kprobes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612
Masami Hiramatsuc85c9a22021-02-18 23:29:23 +09002613#if defined(CONFIG_OPTPROBES)
2614static int __init init_optprobes(void)
2615{
2616 /*
2617 * Enable kprobe optimization - this kicks the optimizer which
2618 * depends on synchronize_rcu_tasks() and ksoftirqd, that is
2619 * not spawned in early initcall. So delay the optimization.
2620 */
2621 optimize_all_kprobes();
2622
2623 return 0;
2624}
2625subsys_initcall(init_optprobes);
2626#endif
2627
Srinivasa Ds346fd592007-02-20 13:57:54 -08002628#ifdef CONFIG_DEBUG_FS
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002629static void report_probe(struct seq_file *pi, struct kprobe *p,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002630 const char *sym, int offset, char *modname, struct kprobe *pp)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002631{
2632 char *kprobe_type;
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002633 void *addr = p->addr;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002634
2635 if (p->pre_handler == pre_handler_kretprobe)
2636 kprobe_type = "r";
Srinivasa Ds346fd592007-02-20 13:57:54 -08002637 else
2638 kprobe_type = "k";
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002639
Kees Cook60f7bb62020-07-02 15:20:22 -07002640 if (!kallsyms_show_value(pi->file->f_cred))
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002641 addr = NULL;
2642
Srinivasa Ds346fd592007-02-20 13:57:54 -08002643 if (sym)
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002644 seq_printf(pi, "%px %s %s+0x%x %s ",
2645 addr, kprobe_type, sym, offset,
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002646 (modname ? modname : " "));
Masami Hiramatsu81365a92018-04-28 21:36:02 +09002647 else /* try to use %pS */
2648 seq_printf(pi, "%px %s %pS ",
2649 addr, kprobe_type, p->addr);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002650
2651 if (!pp)
2652 pp = p;
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002653 seq_printf(pi, "%s%s%s%s\n",
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002654 (kprobe_gone(p) ? "[GONE]" : ""),
2655 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
Masami Hiramatsuae6aa162012-06-05 19:28:32 +09002656 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2657 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
Srinivasa Ds346fd592007-02-20 13:57:54 -08002658}
2659
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002660static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002661{
2662 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2663}
2664
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002665static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002666{
2667 (*pos)++;
2668 if (*pos >= KPROBE_TABLE_SIZE)
2669 return NULL;
2670 return pos;
2671}
2672
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002673static void kprobe_seq_stop(struct seq_file *f, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002674{
2675 /* Nothing to do */
2676}
2677
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002678static int show_kprobe_addr(struct seq_file *pi, void *v)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002679{
2680 struct hlist_head *head;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002681 struct kprobe *p, *kp;
2682 const char *sym = NULL;
2683 unsigned int i = *(loff_t *) v;
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002684 unsigned long offset = 0;
Joe Marioab767862013-11-12 15:10:23 -08002685 char *modname, namebuf[KSYM_NAME_LEN];
Srinivasa Ds346fd592007-02-20 13:57:54 -08002686
2687 head = &kprobe_table[i];
2688 preempt_disable();
Sasha Levinb67bfe02013-02-27 17:06:00 -08002689 hlist_for_each_entry_rcu(p, head, hlist) {
Alexey Dobriyanffb45122007-05-08 00:28:41 -07002690 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
Srinivasa Ds346fd592007-02-20 13:57:54 -08002691 &offset, &modname, namebuf);
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002692 if (kprobe_aggrprobe(p)) {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002693 list_for_each_entry_rcu(kp, &p->list, list)
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002694 report_probe(pi, kp, sym, offset, modname, p);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002695 } else
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002696 report_probe(pi, p, sym, offset, modname, NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002697 }
2698 preempt_enable();
2699 return 0;
2700}
2701
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002702static const struct seq_operations kprobes_sops = {
Srinivasa Ds346fd592007-02-20 13:57:54 -08002703 .start = kprobe_seq_start,
2704 .next = kprobe_seq_next,
2705 .stop = kprobe_seq_stop,
2706 .show = show_kprobe_addr
2707};
2708
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002709DEFINE_SEQ_ATTRIBUTE(kprobes);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002710
Masami Hiramatsu63724742014-04-17 17:18:49 +09002711/* kprobes/blacklist -- shows which functions can not be probed */
2712static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2713{
Masami Hiramatsu4fdd8882020-03-26 23:49:36 +09002714 mutex_lock(&kprobe_mutex);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002715 return seq_list_start(&kprobe_blacklist, *pos);
2716}
2717
2718static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2719{
2720 return seq_list_next(v, &kprobe_blacklist, pos);
2721}
2722
2723static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2724{
2725 struct kprobe_blacklist_entry *ent =
2726 list_entry(v, struct kprobe_blacklist_entry, list);
2727
Masami Hiramatsuffb9bd62018-04-28 21:35:32 +09002728 /*
Masami Hiramatsu223a76b2021-09-14 23:39:34 +09002729 * If '/proc/kallsyms' is not showing kernel address, we won't
Masami Hiramatsuffb9bd62018-04-28 21:35:32 +09002730 * show them here either.
2731 */
Kees Cook60f7bb62020-07-02 15:20:22 -07002732 if (!kallsyms_show_value(m->file->f_cred))
Masami Hiramatsuffb9bd62018-04-28 21:35:32 +09002733 seq_printf(m, "0x%px-0x%px\t%ps\n", NULL, NULL,
2734 (void *)ent->start_addr);
2735 else
2736 seq_printf(m, "0x%px-0x%px\t%ps\n", (void *)ent->start_addr,
2737 (void *)ent->end_addr, (void *)ent->start_addr);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002738 return 0;
2739}
2740
Masami Hiramatsu4fdd8882020-03-26 23:49:36 +09002741static void kprobe_blacklist_seq_stop(struct seq_file *f, void *v)
2742{
2743 mutex_unlock(&kprobe_mutex);
2744}
2745
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002746static const struct seq_operations kprobe_blacklist_sops = {
Masami Hiramatsu63724742014-04-17 17:18:49 +09002747 .start = kprobe_blacklist_seq_start,
2748 .next = kprobe_blacklist_seq_next,
Masami Hiramatsu4fdd8882020-03-26 23:49:36 +09002749 .stop = kprobe_blacklist_seq_stop,
Masami Hiramatsu63724742014-04-17 17:18:49 +09002750 .show = kprobe_blacklist_seq_show,
2751};
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002752DEFINE_SEQ_ATTRIBUTE(kprobe_blacklist);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002753
Jessica Yu12310e342018-01-10 00:51:23 +01002754static int arm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002755{
2756 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002757 struct kprobe *p;
Jessica Yu12310e342018-01-10 00:51:23 +01002758 unsigned int i, total = 0, errors = 0;
2759 int err, ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002760
2761 mutex_lock(&kprobe_mutex);
2762
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002763 /* If kprobes are armed, just return */
2764 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002765 goto already_enabled;
2766
Wang Nan977ad482015-02-13 14:40:24 -08002767 /*
2768 * optimize_kprobe() called by arm_kprobe() checks
2769 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2770 * arm_kprobe.
2771 */
2772 kprobes_all_disarmed = false;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002773 /* Arming kprobes doesn't optimize kprobe itself */
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002774 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2775 head = &kprobe_table[i];
Jessica Yu12310e342018-01-10 00:51:23 +01002776 /* Arm all kprobes on a best-effort basis */
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002777 hlist_for_each_entry(p, head, hlist) {
Jessica Yu12310e342018-01-10 00:51:23 +01002778 if (!kprobe_disabled(p)) {
2779 err = arm_kprobe(p);
2780 if (err) {
2781 errors++;
2782 ret = err;
2783 }
2784 total++;
2785 }
2786 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002787 }
2788
Jessica Yu12310e342018-01-10 00:51:23 +01002789 if (errors)
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09002790 pr_warn("Kprobes globally enabled, but failed to enable %d out of %d probes. Please check which kprobes are kept disabled via debugfs.\n",
Jessica Yu12310e342018-01-10 00:51:23 +01002791 errors, total);
2792 else
2793 pr_info("Kprobes globally enabled\n");
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002794
2795already_enabled:
2796 mutex_unlock(&kprobe_mutex);
Jessica Yu12310e342018-01-10 00:51:23 +01002797 return ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002798}
2799
Jessica Yu297f9232018-01-10 00:51:24 +01002800static int disarm_all_kprobes(void)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002801{
2802 struct hlist_head *head;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002803 struct kprobe *p;
Jessica Yu297f9232018-01-10 00:51:24 +01002804 unsigned int i, total = 0, errors = 0;
2805 int err, ret = 0;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002806
2807 mutex_lock(&kprobe_mutex);
2808
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002809 /* If kprobes are already disarmed, just return */
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002810 if (kprobes_all_disarmed) {
2811 mutex_unlock(&kprobe_mutex);
Jessica Yu297f9232018-01-10 00:51:24 +01002812 return 0;
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002813 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002814
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002815 kprobes_all_disarmed = true;
Masami Hiramatsuafd66252010-02-25 08:34:07 -05002816
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002817 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2818 head = &kprobe_table[i];
Jessica Yu297f9232018-01-10 00:51:24 +01002819 /* Disarm all kprobes on a best-effort basis */
Masami Hiramatsu7e6a71d2020-05-12 17:02:44 +09002820 hlist_for_each_entry(p, head, hlist) {
Jessica Yu297f9232018-01-10 00:51:24 +01002821 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p)) {
2822 err = disarm_kprobe(p, false);
2823 if (err) {
2824 errors++;
2825 ret = err;
2826 }
2827 total++;
2828 }
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002829 }
2830 }
Jessica Yu297f9232018-01-10 00:51:24 +01002831
2832 if (errors)
Masami Hiramatsu9c89bb82021-09-14 23:39:25 +09002833 pr_warn("Kprobes globally disabled, but failed to disable %d out of %d probes. Please check which kprobes are kept enabled via debugfs.\n",
Jessica Yu297f9232018-01-10 00:51:24 +01002834 errors, total);
2835 else
2836 pr_info("Kprobes globally disabled\n");
2837
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002838 mutex_unlock(&kprobe_mutex);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002839
Masami Hiramatsu6274de42010-12-03 18:54:09 +09002840 /* Wait for disarming all kprobes by optimizer */
2841 wait_for_kprobe_optimizer();
Jessica Yu297f9232018-01-10 00:51:24 +01002842
2843 return ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002844}
2845
2846/*
2847 * XXX: The debugfs bool file interface doesn't allow for callbacks
2848 * when the bool state is switched. We can reuse that facility when
2849 * available
2850 */
2851static ssize_t read_enabled_file_bool(struct file *file,
2852 char __user *user_buf, size_t count, loff_t *ppos)
2853{
2854 char buf[3];
2855
Masami Hiramatsue579abe2009-04-06 19:01:01 -07002856 if (!kprobes_all_disarmed)
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002857 buf[0] = '1';
2858 else
2859 buf[0] = '0';
2860 buf[1] = '\n';
2861 buf[2] = 0x00;
2862 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2863}
2864
2865static ssize_t write_enabled_file_bool(struct file *file,
2866 const char __user *user_buf, size_t count, loff_t *ppos)
2867{
Punit Agrawal5d6de7d2021-09-14 23:38:46 +09002868 bool enable;
2869 int ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002870
Punit Agrawal5d6de7d2021-09-14 23:38:46 +09002871 ret = kstrtobool_from_user(user_buf, count, &enable);
2872 if (ret)
2873 return ret;
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002874
Punit Agrawal5d6de7d2021-09-14 23:38:46 +09002875 ret = enable ? arm_all_kprobes() : disarm_all_kprobes();
Jessica Yu12310e342018-01-10 00:51:23 +01002876 if (ret)
2877 return ret;
2878
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002879 return count;
2880}
2881
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002882static const struct file_operations fops_kp = {
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002883 .read = read_enabled_file_bool,
2884 .write = write_enabled_file_bool,
Arnd Bergmann6038f372010-08-15 18:52:59 +02002885 .llseek = default_llseek,
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002886};
2887
Masami Hiramatsu55479f62014-04-17 17:17:54 +09002888static int __init debugfs_kprobe_init(void)
Srinivasa Ds346fd592007-02-20 13:57:54 -08002889{
Greg Kroah-Hartman8c0fd1f2019-01-22 16:21:46 +01002890 struct dentry *dir;
Srinivasa Ds346fd592007-02-20 13:57:54 -08002891
2892 dir = debugfs_create_dir("kprobes", NULL);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002893
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002894 debugfs_create_file("list", 0400, dir, NULL, &kprobes_fops);
Srinivasa Ds346fd592007-02-20 13:57:54 -08002895
Punit Agrawal8f7262c2021-09-14 23:38:37 +09002896 debugfs_create_file("enabled", 0600, dir, NULL, &fops_kp);
Masami Hiramatsu63724742014-04-17 17:18:49 +09002897
Greg Kroah-Hartman8c0fd1f2019-01-22 16:21:46 +01002898 debugfs_create_file("blacklist", 0400, dir, NULL,
Kefeng Wangeac2cece2020-06-04 16:51:11 -07002899 &kprobe_blacklist_fops);
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07002900
Srinivasa Ds346fd592007-02-20 13:57:54 -08002901 return 0;
2902}
2903
2904late_initcall(debugfs_kprobe_init);
2905#endif /* CONFIG_DEBUG_FS */